Developing Log Module

I'm developing a log module and in the upgrade function I need to add a onloadhandler to all Albuns and all Photos so I do something like this:

function upgrade( $currentVersion ) {
 global $gallery;
 if( ! isset( $currentVersion ) ) {
  $query = '
   SELECT [GalleryEntity::id]
   FROM [GalleryEntity]
   WHERE [GalleryEntity::entityType] = \'GalleryAlbumItem\' OR
         [GalleryEntity::entityType] = \'GalleryPhotoItem\'
  ';
  list( $ret, $searchResults ) = $gallery->search( $query );
  if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
  while( $result = $searchResults->nextResult() ) $itemIds[] = $result[0];
  while( ! empty( $itemIds ) ) {
   list( $ret, $items ) = GalleryCoreApi::loadEntitiesById( array_splice( $itemIds, 0, 100 ) );
   if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
   $gallery->guaranteeTimeLimit( 60 );
   foreach( $items as $item ) {
    if( $item->hasOnLoadHandler( 'LogAccess') ) continue;
    list( $ret, $lockId ) = GalleryCoreApi::acquireWriteLock( $item->getId() );
    if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
    list( $ret, $item ) = $item->refresh();
    if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
    $item->addOnLoadHandler( 'LogAccess' );
    if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
    $ret = $item->save();
    if( $ret ) {
     GalleryCoreApi::releaseLocks( $lockId );
     if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
    }
    $ret = GalleryCoreApi::releaseLocks( $lockId );
    if( $ret ) return $ret->wrap( __FILE__, __LINE__ );
   }
  }
 }
 return null;
}

Now I have two problems:
- First this process takes to long (I have about 5000 photos) and there is no progress bar indicator in the admin activate module.
- Second, for this to work, I have to change to use databases lock, because using files locks, I receive an error: "failed to open stream: Too many open files" as it tries to open more than 1024 file descriptors.

For thinks like what I want to do, wasn't much easier if exists the GalleryEntity:load event? Or I'm not seeing the think in the best way?

You have a very good understanding of our codebase. Yes, when reading your code I too thought that a GalleryEntity::load event would probably make more sense than our current onLoad handlers.
Anyway, so you have the problem that we don't have a progress bar when activating modules in the site admin page.

even more so, we recently switched to using AJAX for the "activate module" UI. so the general assumption is that this takes a very short time.

your upgrade / activate method takes a long time though. so maybe we should introduce an optional progress bar for the upgrade method of plugins.

as to a short term solution:
- what kind of logging information do you aggregate there?
- maybe add a maintenance task that adds the logging handler to existing entities instead of doing this during module activation time.

events are currently too expensive to add them for each entity load.
once the events framework is more lightweight, we could do something like that.

what are the storage error details? you should get details, if logged in as admin.
for more error details, you can enable buffered debug mode.

FAQ: How to set/use Gallery in debug mode?

I'm calling a save function of an item that is already inside a save function (because I'm inside a save event handler), can't I do that? If I can't do that, how can I test if it has and add if it is the case an item onLoadHandler?

I read a lot of the Gallery and Modules source code, and I don't find a way to change an AlbumItem (example: to add a onLoadHandler) as soon as the Album is created.

I found 2 ways that gallery give a module to process items as soon as they are added/edited: postEvents and the handleRequestAfterAdd/handleRequestAfterEdit methods.

To add a onLoadHandler to an album as soon the album is created: I can't use the handleEvent with GalleryEntity:save because when this event is posted within an album creation I can't use the item->save method inside an already save method (problem in the previous posts).
The handleRequestAfterAdd in the ItemAddOption don't apply to AlbumItems.

So, how should I do? Any help?

I already had tried that way with this code:

function handleEvent( $event ) {

 if( $event->getEventName() == 'GalleryEntity::save' ) {

  $item =& $event->getEntity();

  if( GalleryUtilities::isA( $item, 'GalleryAlbumItem' ) &&
      $item->testPersistentFlag( STORAGE_FLAG_NEWLY_CREATED ) ) {
					
   $ret = $item->addOnLoadHandler( 'LogAccess' );
   if( $ret ) return array( $ret->wrap(__FILE__, __LINE__), null );
  }			

 }

}

But the handler is not added to the entity...

If in the GalleryEvent::setEntity I change from:

function setEntity($entity)

to:

function setEntity(&$entity)

The Event constructor will fail as you cannot pass null by reference...

function GalleryEvent() {
 $this->setEventName(null);
 $this->setEntity(null);
 $this->setData(null);
}

In GalleryCoreApi I changed

function postEvent($event)

to:

function postEvent(&$event)

In GalleryEventHelper_simple.class I changed

function postEvent($event)

to:

function postEvent(&$event)

In GalleryEvent.class I changed

function setEntity($entity) and
function getEntity()

to:

function setEntity(&$entity) and
function &getEntity()

and removed the setEntity(null) in the GalleryEvent constructer

But continues to not work... I dont know what to do any more...