Media changelog added

There is a new media changelog now, with the flag RECENTS_MEDIA_CHANGES media changes can be requested from the getRecents()-function or the new getRecentsSince()-function, that returns all changes since a given timestamp and optionally before a given timestamp. The media upload and the XML-RPC-server have been changed to use these functions.

Additionally, the event MEDIA_UPLOAD_FINISH has been extended, it has a new $data-attribute (the 5th), that contains a boolean if the file does already exist and will be overwritten.

darcs-hash:20090118154345-074e0-5d9a90d269e86d8c6a156ecce5cf63115c827433.gz

2 files changed, 91 insertions, 70 deletions

diff --git a/lib/exe/indexer.php b/lib/exe/indexer.php
index 908bbe86a..6380f8f9d 100644
--- a/lib/exe/indexer.php
+++ b/lib/exe/indexer.php
@@ -40,6 +40,7 @@ if ($evt->advise_before()) {
   metaUpdate() or
   runSitemapper() or
   runTrimRecentChanges() or
+  runTrimRecentChanges(true) or
   $evt->advise_after();
 }
 if($defer) sendGIF();
@@ -52,15 +53,18 @@ exit;
 /**
  * Trims the recent changes cache (or imports the old changelog) as needed.
  *
+ * @param media_changes If the media changelog shall be trimmed instead of
+ * the page changelog
+ *
  * @author Ben Coburn <btcoburn@silicodon.net>
  */
-function runTrimRecentChanges() {
+function runTrimRecentChanges($media_changes = false) {
     global $conf;
 
     // Import old changelog (if needed)
     // Uses the imporoldchangelog plugin to upgrade the changelog automaticaly.
     // FIXME: Remove this from runTrimRecentChanges when it is no longer needed.
-    if (isset($conf['changelog_old']) &&
+    if (!$media_changes && isset($conf['changelog_old']) &&
         @file_exists($conf['changelog_old']) && !@file_exists($conf['changelog']) &&
         !@file_exists($conf['changelog'].'_importing') && !@file_exists($conf['changelog'].'_tmp')) {
             $tmp = array(); // no event data
@@ -68,22 +72,24 @@ function runTrimRecentChanges() {
             return true;
     }
 
+    $fn = ($media_changes ? $conf['media_changelog'] : $conf['changelog']);
+
     // Trim the Recent Changes
     // Trims the recent changes cache to the last $conf['changes_days'] recent
     // changes or $conf['recent'] items, which ever is larger.
     // The trimming is only done once a day.
-    if (@file_exists($conf['changelog']) &&
-        (filectime($conf['changelog'])+86400)<time() &&
-        !@file_exists($conf['changelog'].'_tmp')) {
-            io_lock($conf['changelog']);
-            $lines = file($conf['changelog']);
+    if (@file_exists($fn) &&
+        (filectime($fn)+86400)<time() &&
+        !@file_exists($fn.'_tmp')) {
+            io_lock($fn);
+            $lines = file($fn);
             if (count($lines)<=$conf['recent']) {
                 // nothing to trim
-                io_unlock($conf['changelog']);
+                io_unlock($fn);
                 return false;
             }
 
-            io_saveFile($conf['changelog'].'_tmp', '');          // presave tmp as 2nd lock
+            io_saveFile($fn.'_tmp', '');          // presave tmp as 2nd lock
             $trim_time = time() - $conf['recent_days']*86400;
             $out_lines = array();
 
@@ -107,15 +113,15 @@ function runTrimRecentChanges() {
             }
 
             // save trimmed changelog
-            io_saveFile($conf['changelog'].'_tmp', implode('', $out_lines));
-            @unlink($conf['changelog']);
-            if (!rename($conf['changelog'].'_tmp', $conf['changelog'])) {
+            io_saveFile($fn.'_tmp', implode('', $out_lines));
+            @unlink($fn);
+            if (!rename($fn.'_tmp', $fn)) {
                 // rename failed so try another way...
-                io_unlock($conf['changelog']);
-                io_saveFile($conf['changelog'], implode('', $out_lines));
-                @unlink($conf['changelog'].'_tmp');
+                io_unlock($fn);
+                io_saveFile($fn, implode('', $out_lines));
+                @unlink($fn.'_tmp');
             } else {
-                io_unlock($conf['changelog']);
+                io_unlock($fn);
             }
             return true;
     }
diff --git a/lib/exe/xmlrpc.php b/lib/exe/xmlrpc.php
index 97e473d7e..070586c3b 100644
--- a/lib/exe/xmlrpc.php
+++ b/lib/exe/xmlrpc.php
@@ -122,7 +122,13 @@ class dokuwiki_xmlrpc_server extends IXR_IntrospectionServer {
             'wiki.getRecentChanges',
             'this:getRecentChanges',
             array('struct','int'),
-            'Returns a strukt about all recent changes since given timestamp.'
+            'Returns a struct about all recent changes since given timestamp.'
+        );
+        $this->addCallback(
+            'wiki.getRecentMediaChanges',
+            'this:getRecentMediaChanges',
+            array('struct','int'),
+            'Returns a struct about all recent media changes since given timestamp.'
         );
         $this->addCallback(
             'wiki.aclCheck',
@@ -464,7 +470,8 @@ class dokuwiki_xmlrpc_server extends IXR_IntrospectionServer {
             // because a temp file was created already
             if(preg_match('/\.('.$regex.')$/i',$fn)) {
                 //check for overwrite
-                if(@file_exists($fn) && (!$params['ow'] || $auth < AUTH_DELETE)) {
+                $overwrite = @file_exists($fn);
+                if($overwrite && (!$params['ow'] || $auth < AUTH_DELETE)) {
                     return new IXR_ERROR(1, $lang['uploadexist']);
                 }
                 // check for valid content
@@ -483,6 +490,7 @@ class dokuwiki_xmlrpc_server extends IXR_IntrospectionServer {
                 $data[1] = $fn;
                 $data[2] = $id;
                 $data[3] = $imime;
+                $data[4] = $overwrite;
 
                 // trigger event
                 require_once(DOKU_INC.'inc/events.php');
@@ -517,7 +525,8 @@ class dokuwiki_xmlrpc_server extends IXR_IntrospectionServer {
         if(!count($mediareferences)){
             $file = mediaFN($id);
             if(@unlink($file)){
-                msg(str_replace('%s',noNS($id),$lang['deletesucc']),1);
+                require_once(DOKU_INC.'inc/changelog.php');
+                addMediaLogEntry(time(), $id, DOKU_CHANGE_TYPE_DELETE);
                 io_sweepNS($id,'mediadir');
                 return 0;
             }
@@ -536,11 +545,18 @@ class dokuwiki_xmlrpc_server extends IXR_IntrospectionServer {
     function _media_upload_action($data) {
         global $conf;
 
-        if(is_array($data) && count($data)===4) {
+        if(is_array($data) && count($data)===5) {
             io_createNamespace($data[2], 'media');
             if(rename($data[0], $data[1])) {
                 chmod($data[1], $conf['fmode']);
                 media_notify($data[2], $data[1], $data[3]);
+                // add a log entry to the media changelog
+                require_once(DOKU_INC.'inc/changelog.php');
+                if ($data[4]) {
+                    addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_EDIT);
+                } else {
+                    addMediaLogEntry(time(), $data[2], DOKU_CHANGE_TYPE_CREATE);
+                }
                 return $data[2];
             } else {
                 return new IXR_ERROR(1, 'Upload failed.');
@@ -608,74 +624,73 @@ class dokuwiki_xmlrpc_server extends IXR_IntrospectionServer {
     /**
      * Returns a list of recent changes since give timestamp
      *
+     * @author Michael Hamann <michael@content-space.de>
      * @author Michael Klier <chi@chimeric.de>
      */
     function getRecentChanges($timestamp) {
-        global $conf;
-
         if(strlen($timestamp) != 10)
             return new IXR_Error(20, 'The provided value is not a valid timestamp');
 
-        $changes = array();
-
         require_once(DOKU_INC.'inc/changelog.php');
         require_once(DOKU_INC.'inc/pageutils.php');
 
-        // read changes
-        $lines = @file($conf['changelog']);
+        $recents = getRecentsSince($timestamp);
 
-        if(empty($lines)) 
-            return new IXR_Error(10, 'The changelog could not be read');
-
-        // we start searching at the end of the list
-        $lines = array_reverse($lines);
-
-        // cache seen pages and skip them
-        $seen = array(); 
-
-        foreach($lines as $line) {
-
-            if(empty($line)) continue; // skip empty lines
-
-            $logline = parseChangelogLine($line);
-
-            if($logline === false) continue;
+        $changes = array();
 
-            // skip seen ones
-            if(isset($seen[$logline['id']])) continue;
+        foreach ($recents as $recent) {
+            $change = array();
+            $change['name']         = $recent['id'];
+            $change['lastModified'] = new IXR_Date($recent['date']);
+            $change['author']       = $recent['user'];
+            $change['version']      = $recent['date'];
+            $change['perms']        = $recent['perms'];
+            $change['size']         = @filesize(wikiFN($recent['id']));
+            array_push($changes, $change);
+        }
 
-            // skip minors
-            if($logline['type'] === DOKU_CHANGE_TYPE_MINOR_EDIT && ($flags & RECENTS_SKIP_MINORS)) continue;
+        if (!empty($changes)) {
+            return $changes;
+        } else {
+            // in case we still have nothing at this point
+            return new IXR_Error(30, 'There are no changes in the specified timeframe');
+        } 
+    }
 
-            // remember in seen to skip additional sights
-            $seen[$logline['id']] = 1;
+    /**
+     * Returns a list of recent media changes since give timestamp
+     *
+     * @author Michael Hamann <michael@content-space.de>
+     * @author Michael Klier <chi@chimeric.de>
+     */
+    function getRecentMediaChanges($timestamp) {
+        if(strlen($timestamp) != 10)
+            return new IXR_Error(20, 'The provided value is not a valid timestamp');
 
-            // check if it's a hidden page
-            if(isHiddenPage($logline['id'])) continue;
+        require_once(DOKU_INC.'inc/changelog.php');
+        require_once(DOKU_INC.'inc/pageutils.php');
 
-            // check ACL
-            $perms = auth_quickaclcheck($logline['id']);
-            if($perms < AUTH_READ) continue;
+        $recents = getRecentsSince($timestamp, null, '', RECENTS_MEDIA_CHANGES);
 
-            // check existance
-            if((!@file_exists(wikiFN($logline['id']))) && ($flags & RECENTS_SKIP_DELETED)) continue;
+        $changes = array();
 
-            // check if logline is still in the queried time frame
-            if($logline['date'] >= $timestamp) {
-                $change['name']         = $logline['id'];
-                $change['lastModified'] = new IXR_Date($logline['date']);
-                $change['author']       = $logline['user'];
-                $change['version']      = $logline['date'];
-                $change['perms']        = $perms;
-                $change['size']         = @filesize(wikiFN($logline['id']));
-                array_push($changes, $change);
-            } else {
-                $changes = array_reverse($changes);
-                return ($changes);
-            }
+        foreach ($recents as $recent) {
+            $change = array();
+            $change['name']         = $recent['id'];
+            $change['lastModified'] = new IXR_Date($recent['date']);
+            $change['author']       = $recent['user'];
+            $change['version']      = $recent['date'];
+            $change['perms']        = $recent['perms'];
+            $change['size']         = @filesize(wikiFN($recent['id']));
+            array_push($changes, $change);
         }
-        // in case we still have nothing at this point
-        return new IXR_Error(30, 'There are no changes in the specified timeframe');
+
+        if (!empty($changes)) {
+            return $changes;
+        } else {
+            // in case we still have nothing at this point
+            return new IXR_Error(30, 'There are no changes in the specified timeframe');
+        } 
     }
 
     /**