Show Latest Comments

Hi,

I tried to extend the comment module so that it can show all latest comments on one page. I am quite of new to the gallery coding stuff but in the end it worked.

Your can see the result here: http://www.schmittat.com/gallery2/main.php?g2_view=comment.ShowAllComments

Only the comments and photos are shown, the user has the permission to see.

This is just a first version, still missing:

- Option, how many comments are shown [right now: 5]
- Show only comments for a specific album and its subalbums
- better design

Looking forward to your feedback!
Johannes

Good idea to use the latest version

I updated my files and also added the possibility to set the number of shown comments in the admin menue.

Diff of module.inc

see below for latest changes

Diff of GalleryCommentHelper.class

see below for latest changes

Ok, i worked a bit more on this feature:

- Now, the ShowAllComments page shows only the comments that are children and grandchildren of the current item. That means, if you click on the "Newest Comments" link on the main page, you will see all comments you have the permission to. If you open this view from within an album you just see the comments of that album.

- There is now an option to turn this feature on and off

- I included the captcha feature for anonymous users (http://gallery.menalto.com/node/38933#comment-146386) in a slightly modified version into my comments module. This includes the option to decide in the Admin area whether to use this captcha feature or not.

Ok, here are the diffs:

Index: module.inc
===================================================================
RCS file: /cvsroot/gallery/gallery2/modules/comment/module.inc,v
retrieving revision 1.82
diff -c -r1.82 module.inc
*** module.inc	4 Nov 2005 21:56:41 -0000	1.82
--- module.inc	14 Nov 2005 17:31:45 -0000
***************
*** 21,27 ****
   */
  /**
   * @package Comment
!  * @version $Revision: 1.82 $ $Date: 2005/11/04 21:56:41 $
   * @author Bharat Mediratta <bharat@menalto.com>
   */
  
--- 21,27 ----
   */
  /**
   * @package Comment
!  * @version $Revision: 1.83 $ $Date: 2005/11/11 02:13:41 $
   * @author Bharat Mediratta <bharat@menalto.com>
   */
  
***************
*** 40,49 ****
  	$this->setId('comment');
  	$this->setName($gallery->i18n('Comments'));
  	$this->setDescription($gallery->i18n('User commenting system'));
! 	$this->setVersion('1.0.4'); /* Update upgrade() function below too */
  	$this->setGroup('data', $gallery->i18n('Extra Data'));
! 	$this->setCallbacks('registerEventListeners|getItemLinks|getItemSummaries|' .
! 			    'getItemAdminViews');
  	$this->setRequiredCoreApi(array(6, 0));
  	$this->setRequiredModuleApi(array(2, 2));
      }
--- 40,49 ----
  	$this->setId('comment');
  	$this->setName($gallery->i18n('Comments'));
  	$this->setDescription($gallery->i18n('User commenting system'));
! 	$this->setVersion('1.0.6'); /* Update upgrade() function below too */
  	$this->setGroup('data', $gallery->i18n('Extra Data'));
! 	$this->setCallbacks('registerEventListeners|getItemLinks|getSiteAdminViews|' .
! 			    'getItemAdminViews|getItemSummaries');
  	$this->setRequiredCoreApi(array(6, 0));
  	$this->setRequiredModuleApi(array(2, 2));
      }
***************
*** 80,85 ****
--- 80,101 ----
  	 	    return $ret->wrap(__FILE__, __LINE__);
  	 	}
  	     }
+ 	     
+             $def = array( 'comments.show' => 10,
+                           'default.comments.show' => 10,
+                           'comments.captcha' => 0,
+                           'default.comments.captcha' =>0,
+                           'comments.latest' => 0,
+                           'default.comments.latest' =>0
+                           );
+ 
+             while ( list( $key, $val ) = each( $def ) ) {
+         	  $ret = $this->setParameter( $key, $val );
+         	  if ($ret->isError()) {
+         	    return $ret->wrap(__FILE__, __LINE__);
+         	  }
+             }
+ 
  	     break;
  	     
  	case '0.9.6':
***************
*** 100,106 ****
  	case '1.0.1':
  	case '1.0.2':
  	case '1.0.3':
! 	    
  	case 'end of upgrade path':
  	    /*
  	     * Leave this bogus case at the end of the legitimate case statements so that we
--- 116,122 ----
  	case '1.0.1':
  	case '1.0.2':
  	case '1.0.3':
! 
  	case 'end of upgrade path':
  	    /*
  	     * Leave this bogus case at the end of the legitimate case statements so that we
***************
*** 183,188 ****
--- 199,224 ----
  			array('text' => $this->translate('Add Comment'),
  			      'params' => $params);
  		}
+ 
+ 
+                 /* Show Latest Comments? */
+                 foreach (array('comments.latest') as $key) {
+                     list ($ret, $value) = GalleryCoreApi::getPluginParameter('module', 'comment', $key);
+ 	            if ($ret->isError()) {
+ 	                return array($ret->wrap(__FILE__, __LINE__), null);
+ 	            }
+                 }
+ 
+                 If ($value==on) {
+ 
+                     $links[$item->getId()][] =
+           		    array('text'   => $this->translate('View Latest Comments'),
+            			  'params' => array(
+        			                            'view' => 'comment.ShowAllComments',
+                                                     'itemId' => $item->getId()
+                                                     )
+                             );
+ 		}
  	    }
  	}
  
***************
*** 260,264 ****
--- 296,309 ----
  
  	return $rules;
      }
+     
+         /**
+      * @see GalleryModule::getSiteAdminViews()
+      */
+     function getSiteAdminViews() {
+ 	    return array(GalleryStatus::success(),
+ 		     array(array('name' => 'Comments',
+ 				 'view' => 'comment.CommentSiteAdmin')));
+     }
  }
  ?>

Index: AddComment.inc
===================================================================
RCS file: /cvsroot/gallery/gallery2/modules/comment/AddComment.inc,v
retrieving revision 1.37
diff -c -r1.37 AddComment.inc
*** AddComment.inc	23 Aug 2005 03:49:01 -0000	1.37
--- AddComment.inc	14 Nov 2005 17:42:44 -0000
***************
*** 28,33 ****
--- 28,36 ----
   */
  
  /**
+   * require necessary classes
+   */
+ /**
   * Add a comment to an item.
   *
   * @package Comment
***************
*** 63,68 ****
--- 66,101 ----
  		$error[] = 'form[error][comment][missing]';
  	    }
  
+             if (empty($error)) {
+                 /* Get all the login plugins */
+                 list ($ret, $pluginInstances) =
+                      GalleryCoreApi::getAllFactoryImplementationIds('GalleryValidationPlugin');
+                 if ($ret->isError()) {
+                     return array($ret->wrap(__FILE__, __LINE__), null);
+                 }
+ 
+                 foreach (array_keys($pluginInstances) as $pluginId) {
+                    list ($ret, $pluginInstances[$pluginId]) =
+                        GalleryCoreApi::newFactoryInstanceById('GalleryValidationPlugin', $pluginId);
+                    if ($ret->isError()) {
+                        return array($ret->wrap(__FILE__, __LINE__), null);
+                    }
+                 }
+ 
+                 /* Let each plugin do its verification */
+                 foreach ($pluginInstances as $pluginId => $plugin) {
+                     list ($ret, $pluginErrors, $continue) = $plugin->performValidation($form);
+                     if ($ret->isError()) {
+                         return array($ret->wrap(__FILE__, __LINE__), null);
+                     }
+ 
+                     $error = array_merge($error, $pluginErrors);
+                     if (!$continue) {
+                         break;
+                     }
+                 }
+             }
+ 
  	    if (empty($error)) {
  		/* Add the comment */
  		list ($ret, $comment) =
***************
*** 140,145 ****
--- 173,180 ----
       * @see GalleryView::loadTemplate
       */
      function loadTemplate(&$template, &$form) {
+         global $gallery;
+ 
  	/* Load our item */
  	list ($ret, $item) = $this->_getItem();
  	if ($ret->isError()) {
***************
*** 152,157 ****
--- 187,204 ----
  	    return array($ret->wrap(__FILE__, __LINE__), null);
  	}
  
+         /* Load Variables */
+         $CommentsVar = array();
+         foreach (array('comments.captcha') as $key) {
+        	    list ($ret, $value) = GalleryCoreApi::getPluginParameter('module', 'comment', $key);
+ 	    if ($ret->isError()) {
+ 	        return array($ret->wrap(__FILE__, __LINE__), null);
+             }
+             $key = explode('.', $key);
+             $CommentsVar[$key[0]][$key[1]] = $value;
+ 
+         }
+ 
  	if ($form['formName'] != 'AddComment') {
  	    $form['formName'] = 'AddComment';
  	    $form['subject'] = '';
***************
*** 168,174 ****
  	$AddComment['host'] = GalleryUtilities::getRemoteHostAddress();
  	$AddComment['itemId'] = $item->getId();
  
- 	$template->setVariable('AddComment', $AddComment);
  	$template->setVariable('controller', 'comment.AddComment');
  
  	list($ret, $module) = GalleryCoreApi::loadPlugin('module', 'comment');
--- 215,220 ----
***************
*** 177,182 ****
--- 223,278 ----
  	}
  
  	$template->title($module->translate('Add Comment'));
+ 	
+ 	       /* Check if we are the anonymous user. If so, load up captcha */
+        $activeUserId = $gallery->getActiveUserId();
+ 
+        $userId = GalleryUtilities::getRequestVariables('userId');
+        if (empty($userId)) {
+            $userId = $activeUserId;
+        }
+ 
+        list ($ret, $anonymousUserId) =
+            GalleryCoreApi::getPluginParameter('module', 'core', 'id.anonymousUser');
+        if ($ret->isError()) {
+            return array($ret->wrap(__FILE__, __LINE__), null);
+        }
+ 
+        if (($userId == $anonymousUserId) and ($CommentsVar[comments][captcha]==on)) {
+            /* See if the CaptchaValidationPlugin is installed */
+            /* Get all the login plugins */
+            list ($ret, $allPluginIds) =
+                GalleryCoreApi::getAllFactoryImplementationIds('GalleryValidationPlugin');
+ 
+            if ( $ret->isError()) {
+                 return array($ret->wrap(__FILE__, __LINE__), null);
+            }
+            /* Let Captcha load it's template data. Set security to HIGH so
+            * Captcha will display immediately */
+            /* Let each plugin load its template data */
+ 
+            $AddComment['plugins'] = array();
+            /* If No ValidationPlugins are installed, allPluginIds array is empty and foreach will
+             * no load the ValidationPlugin
+             */
+            foreach (array_keys($allPluginIds) as $pluginId) {
+                list ($ret, $plugin) =
+                    GalleryCoreApi::newFactoryInstanceById('GalleryValidationPlugin', $pluginId);
+                if ($ret->isError()) {
+                    return array($ret->wrap(__FILE__, __LINE__), null);
+                }
+                list ($ret, $data['file'], $data['l10Domain']) =
+                    $plugin->loadTemplate($template, $form, 'HIGH');
+                if ($ret->isError()) {
+                    return array($ret->wrap(__FILE__, __LINE__), null);
+                }
+                if (isset($data['file'])) {
+                    $AddComment['plugins'][] = $data;
+                }
+            }
+ 
+        }
+        $template->setVariable('AddComment', $AddComment);
  
  	return array(GalleryStatus::success(),
  		     array('body' => 'modules/comment/templates/AddComment.tpl'));

Index: GalleryCommentHelper.class
===================================================================
RCS file: /cvsroot/gallery/gallery2/modules/comment/classes/GalleryCommentHelper.class,v
retrieving revision 1.15
diff -c -r1.15 GalleryCommentHelper.class
*** GalleryCommentHelper.class	4 Nov 2005 21:56:41 -0000	1.15
--- GalleryCommentHelper.class	11 Nov 2005 14:59:51 -0000
***************
*** 22,28 ****
  
  /**
   * @package Comment
!  * @version $Revision: 1.15 $ $Date: 2005/11/04 21:56:41 $
   * @author Bharat Mediratta <bharat@menalto.com>
   */
  
--- 22,28 ----
  
  /**
   * @package Comment
!  * @version $Revision: 1.16 $ $Date: 2005/11/11 00:18:41 $
   * @author Bharat Mediratta <bharat@menalto.com>
   */
  
***************
*** 107,112 ****
--- 107,178 ----
      }
  
      /**
+      * Return all comments
+      *
+      * @param array int GalleryItem id
+      * @return array (object GalleryStatus a status code,
+      *                array (entityId => GalleryComment, ...)
+      * @access private
+      * @static
+      */
+     function fetchAllComments($itemId, $count=null, $orderDirection=ORDER_ASCENDING) {
+ 	global $gallery;
+ 
+ 	switch($orderDirection) {
+ 	case ORDER_ASCENDING:
+ 	    $direction = 'ASC';
+ 	    break;
+ 
+ 	case ORDER_DESCENDING:
+ 	    $direction = 'DESC';
+ 	    break;
+ 
+ 	default:
+ 	    return array(GalleryStatus::error(ERROR_BAD_PARAMETER, __FILE__, __LINE__),
+ 			 null);
+ 	}
+ 
+ 	$query = '
+         SELECT
+           [GalleryComment::id]
+         FROM
+           [GalleryComment]
+         ORDER BY
+           [GalleryComment::date] ' . $direction . '
+         ';
+ 
+ 	list($ret, $searchResults) = $gallery->search($query,
+ 						       array($itemId),
+ 						       array('limit' => array('count' => $count)));
+ 
+ 	if ($ret->isError()) {
+ 	    return array($ret->wrap(__FILE__, __LINE__), null);
+ 	}
+ 
+ 	/* Get all of our ids */
+ 	$allIds = array();
+ 	while ($result = $searchResults->nextResult()) {
+ 	    $allIds[] = $result[0];
+ 
+ 	}
+ 
+ 
+ 	/* Load all the comments at once */
+ 	$comments = array();
+ 	if (!empty($allIds)) {
+ 	    list ($ret, $comments) = GalleryCoreApi::loadEntitiesById($allIds);
+ 	    if ($ret->isError()) {
+ 		return array($ret->wrap(__FILE__, __LINE__), null);
+ 	    }
+ 	}
+ 
+ 	return array(GalleryStatus::success(), $comments);
+     }
+ 
+ 
+ 
+ 
+     /**
       * Return the number of comments associated with the given item ids
       *
       * @param array int GalleryItem ids

Index: AddComment.tpl
===================================================================
RCS file: /cvsroot/gallery/gallery2/modules/comment/templates/AddComment.tpl,v
retrieving revision 1.26
diff -c -r1.26 AddComment.tpl
*** AddComment.tpl	12 Jul 2005 10:07:38 -0000	1.26
--- AddComment.tpl	11 Nov 2005 16:26:59 -0000
***************
*** 71,76 ****
--- 71,81 ----
      {/if}
    </div>
  
+   {* Include our extra ItemAddOptions *}
+   {foreach from=$AddComment.plugins item=plugin}
+      {include file="gallery:`$plugin.file`" l10Domain=$plugin.l10Domain}
+   {/foreach}
+ 
    <div class="gbBlock gcBackground1">
      <input type="submit" class="inputTypeSubmit"
        name="{g->formVar var="form[action][preview]"}" value="{g->text text="Preview"}"/>

The files
CommentSiteAdmin.inc
ShowAllComments.inc
AllComments.tpl
CommentSiteAdmin.tpl
and
ShowAllComments.tpl are new

nope, not like that.

cd modues/comment/classes/
open GalleryComment.class in an edit
add commenterName or something like that as a new member. see commenterId etc.
the php comments above the commenterId is more than just a comment, it's XML. add such XML also above your commenterName and change it accordingly.
at the top of the class, change the schema version from 1.1 to 1.2

cd modules/comment/classes/GalleryStorage/DatabaseStorage/schema/xml-src/
copy A_GalleryComment_1_0.xml to A_GalleryComment_1_1.xml
change the file according to your change, there are other examples in modules/core/classes/GalleryStorage/DatabaseStorage/schema/xml-src/

cd modues/comment/classes/
gmake
modules/core/classes/GalleryStorage/DatabaseStorage/schema/
gmake

get the latest nightly snapshot.
downloadpage -> g2 nightly snapshots from jmullan

you better should upload all files.
and your modifications shouldn't be in any official .tpl file. move your customizations into templates/local/ folders or into your own themes.
and if you need to customize .inc / .class files, make a list of your changes such that you don't forget to reapply them. or better move them into your own modules.

Hi SanderT,

sorry, my fault. Please change the following in the file modules/comment/module.inc beginning at line 118:

  case '1.0.2':
  case '1.0.3':
!             $def = array( 'comments.show' => 10,

to

  case '1.0.2':
  case '1.0.3':
  case '1.0.4':

!             $def = array( 'comments.show' => 10,

This happend because I was not using the latest CVS when starting my modifications. Hope this works.

Edit: Updated the diffs and files above.

Sorry, no idea. I don't get the same error. I installed a new, clean version of the latest CVS and uploaded my changed files to see if there is a problem but it works and I don't get your error. Did you try cleaning the template cache?

Did someone else try my modifications and got it running?

Got it working now!

TablePrefix (g2_) and columnPrefix (g_) needed to be gallery defaults. I had customized prefixes and that didn't work out. Now its up and running and i'm already receiving positive feedback from users. It was a kind of let down, that this feature was missing, when i migrated Gallery 1 to Gallery 2.
Of course credits go to jschmittat for his work on this feature, and valiant thanks for all the help.

Thank you, mindless! I am very happy that you reviewed the code and integrated it into the comments module.

About the loading of the comments: I am very curious to see how you solved it, as I was not able to do it. Well, that's the difference to a gallery professional

Looking forward to the next CVS files...

Forgot to mention, I went ahead and added pagination so you can access all the comments on multiple pages now.

there are gnu utils and binutils for windows.
or you could get cygwin (a linux emulator for windows) and in the cygwin installer, make sure to select make etc.

just extract the new nightly snapshot of g2 over your existing g2 and upgrade.

if you just want to upgrade a specific module, extract the new module over the old and upgrade the module in site admin -> modules.
sometimes a module depends on the latest g2 (core module) version, then it will show a message and you can't upgrade until you upgraded g2.

FAQ: How to upgrade Gallery2?

check permissions on your root album. sounds like Everybody group doesn't have view comments permission.

current CVS or nightly snapshot has this feature.