better translations on errors

Author: splitbrain

Client.php

@@ -6,6 +6,8 @@ class Client extends \IXR_Client {
 
     const MIN_API = 7;
 
+    protected $filecontext = '';
+
     /**
      * Client constructor.
      *
@@ -21,9 +23,18 @@ public function __construct($server, $user, $pass, $timeout = 15) {
     }
 
     /** @inheritdoc */
-    function query() {
+    public function query() {
         $ok = call_user_func_array('parent::query', func_get_args());
-        if(!$ok) throw new SyncException($this->getErrorMessage(), $this->getErrorCode());
+        $code = $this->getErrorCode();
+        if($code === -32300) $code = -1 * $this->status; // use http status on transport errors
+        if(!$ok) {
+            // when a file context is given include it in the exception
+            if($this->filecontext) {
+                throw new SyncFileException($this->getErrorMessage(), $this->filecontext, $code);
+            } else {
+                throw new SyncException($this->getErrorMessage(), $code);
+            }
+        }
         return $ok;
     }
 
@@ -54,4 +65,13 @@ protected function ensureAPIversionOk() {
             throw new SyncException('versionerr');
         }
     }
+
+    /**
+     * Set the file ID this query is running under
+     *
+     * @param string $file
+     */
+    public function setFileContext($file) {
+        $this->filecontext = $file;
+    }
 }

Profile.php

@@ -130,6 +130,7 @@ public function getSyncList() {
      * @param string $summary the editing summary
      */
     public function syncFile($type, $id, $dir, $summary) {
+        $this->client->setFileContext($id);
         switch($dir) {
             case self::DIR_PULL:
                 $this->syncPull($type, $id, $summary);
@@ -146,6 +147,7 @@ public function syncFile($type, $id, $dir, $summary) {
             default:
                 // skip
         }
+        $this->client->setFileContext('');
     }
 
     /**
@@ -154,11 +156,11 @@ public function syncFile($type, $id, $dir, $summary) {
      * @param int $type pages|media
      * @param string $id the ID of the page or media
      * @param string $summary the editing summary
-     * @throws SyncException
+     * @throws SyncFileException
      */
     protected function syncPull($type, $id, $summary) {
         if($type === self::TYPE_PAGES) {
-            if(checklock($id)) throw new SyncException('Local file is locked');
+            if(checklock($id)) throw new SyncFileException('lockfail', $id);
             $this->client->query('wiki.getPage', $id);
         } else {
             $this->client->query('wiki.getAttachment', $id);
@@ -179,14 +181,14 @@ protected function syncPull($type, $id, $summary) {
      * @param int $type pages|media
      * @param string $id the ID of the page or media
      * @param string $summary the editing summary
-     * @throws SyncException
+     * @throws SyncFileException
      */
     protected function syncPullDelete($type, $id, $summary) {
         if($type === self::TYPE_PAGES) {
-            if(checklock($id)) throw new SyncException('Local file is locked');
+            if(checklock($id)) throw new SyncFileException('lockfail', $id);
             saveWikiText($id, '', $summary, false);
         } else {
-            if(!unlink(mediaFN($id))) throw new SyncException('File deletion failed');
+            if(!unlink(mediaFN($id))) throw new SyncFileException('localdelfail', $id);
         }
     }
 
@@ -196,7 +198,7 @@ protected function syncPullDelete($type, $id, $summary) {
      * @param int $type pages|media
      * @param string $id the ID of the page or media
      * @param string $summary the editing summary
-     * @throws SyncException
+     * @throws SyncFileException
      */
     protected function syncPush($type, $id, $summary) {
         if($type === self::TYPE_PAGES) {
@@ -217,7 +219,7 @@ protected function syncPush($type, $id, $summary) {
      * @param int $type pages|media
      * @param string $id the ID of the page or media
      * @param string $summary the editing summary
-     * @throws SyncException
+     * @throws SyncFileException
      */
     protected function syncPushDelete($type, $id, $summary) {
         if($type === self::TYPE_PAGES) {
@@ -234,7 +236,7 @@ protected function syncPushDelete($type, $id, $summary) {
      *
      * @param string $id
      * @param bool $state is this a lock (true) or unlock (false)
-     * @throws SyncException
+     * @throws SyncFileException
      */
     protected function setRemoteLock($id, $state) {
         if($state) {
@@ -248,7 +250,7 @@ protected function setRemoteLock($id, $state) {
         $this->client->query('dokuwiki.setLocks', array('lock' => $lock, 'unlock' => $unlock));
         $data = $this->client->getResponse();
         if(count((array) $data['lockfail'])) {
-            throw new SyncException('Locking at the remote wiki failed');
+            throw new SyncFileException('lockfail', $id);
         }
     }
 

SyncException.php

@@ -21,6 +21,8 @@ public function __construct($message = '', $code = 0, $previous = null) {
         $msg = $plugin->getLang($message);
         if($msg) $message = $msg;
 
+        if($code === -403) $message = $plugin->getLang('autherr');
+
         parent::__construct($message, $code, $previous);
     }
 }

SyncFileException.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace dokuwiki\plugin\sync;
+
+/**
+ * Class SyncFileException
+ *
+ * This exception is thrown in the context of syncing one particular file
+ *
+ * @package dokuwiki\plugin\sync
+ */
+class SyncFileException extends SyncException {
+
+    /**
+     * SyncFileException constructor.
+     *
+     * @param string $message
+     * @param int $id
+     * @param int $code
+     */
+    public function __construct($message, $id, $code = 0) {
+        // translate error messages
+        $plugin = plugin_load('admin', 'sync');
+        $msg = $plugin->getLang($message);
+        if($msg) $message = $msg;
+
+        if(substr($message, -1) != ':') $message .= ':';
+
+        // append file name
+        $message = $message . ' ' . $id;
+        parent::__construct($message, $code);
+    }
+}

lang/en/lang.php

@@ -6,7 +6,7 @@
 $lang['lastsync']  = 'Last Synchronization:';
 $lang['remotever'] = 'Remote Wiki Version:';
 
-$lang['xmlerr']   = 'Failed to talk to remote wiki. Make sure the remote wiki allows XMLRPC requests and that you set up the endpoint URL correctly.';
+$lang['autherr']  = 'The provided user is not allowed to access the XMLRPC API at the remote wiki.';
 $lang['loginerr'] = 'Failed to login at remote wiki. Make sure supplied credentials are valid at the remote wiki.';
 $lang['versionerr'] = 'The remote wiki XMLRPC API version is too old. You need to upgrade the remote wiki to use the sync plugin.';
 
@@ -38,15 +38,7 @@
 
 $lang['noconnect']     = 'Could not connect to remote wiki:';
 $lang['lockfail']      = 'couldn\'t lock and will skip:';
-$lang['pullfail']      = 'pull failed:';
-$lang['pullok']        = 'pull succeded:';
-$lang['localdelok']    = 'local delete succeeded:';
 $lang['localdelfail']  = 'local delete failed:';
-$lang['pushfail']      = 'push failed:';
-$lang['pushok']        = 'push succeded:';
-$lang['remotedelok']   = 'remote delete succeeded:';
-$lang['remotedelfail'] = 'remote delete failed:';
-$lang['skipped']       = 'skipped:';
 
 $lang['js']['list']   = 'A list of files that differ between your local and the remote wiki is shown below. You need to decide which revisions you want to keep.'; #from list.txt