From d07b4c2e8ccaf7acc0ddd5be14da12216bf6d538 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <machniak@kolabsys.com>
Date: Tue, 6 Oct 2015 12:04:44 +0200
Subject: [PATCH] Implement folders searching and subscriptions support (T163)

---
 plugins/kolab_files/kolab_files.js            | 308 +++++++++++++++++-
 .../kolab_files/lib/kolab_files_engine.php    |  26 +-
 plugins/kolab_files/localization/en_US.inc    |   2 +
 .../skins/larry/images/listicons.png          | Bin 0 -> 2582 bytes
 4 files changed, 329 insertions(+), 7 deletions(-)
 create mode 100644 plugins/kolab_files/skins/larry/images/listicons.png

diff --git a/plugins/kolab_files/kolab_files.js b/plugins/kolab_files/kolab_files.js
index 3044d6e8..1759ee47 100644
--- a/plugins/kolab_files/kolab_files.js
+++ b/plugins/kolab_files/kolab_files.js
@@ -141,6 +141,7 @@ function kolab_files_init()
     sort_reverse: false,
     search_threads: rcmail.env.search_threads,
     resources_dir: rcmail.assets_path('program/resources'),
+    caps: rcmail.env.files_caps,
     supported_mimetypes: rcmail.env.file_mimetypes
   });
 
@@ -1188,7 +1189,7 @@ function kolab_files_ui()
       searchbox = $('#foldersearch', body);
     }
 
-    elem.html('').append(list);
+    elem.html('');
 
     this.env.folders = this.folder_list_parse(response.result && response.result.list ? response.result.list : response.result);
 
@@ -1211,7 +1212,15 @@ function kolab_files_ui()
       rows.push(row);
     });
 
-    list.append(rows);
+    list.append(rows).appendTo(elem)
+      .on('click', 'a.subscription', function(e) {
+        return file_api.folder_list_subscription_button_click(this);
+      });
+
+    if (rcmail.folder_list) {
+      rcmail.folder_list.reset();
+      this.search_results_widget = null;
+    }
 
     // init treelist widget
     rcmail.folder_list = new rcube_treelist_widget(list, {
@@ -1232,7 +1241,12 @@ function kolab_files_ui()
       .addEventListener('collapse', function(node) { file_api.folder_collapsed(node); })
       .addEventListener('expand', function(node) { file_api.folder_collapsed(node); })
       .addEventListener('beforeselect', function(node) { return !rcmail.busy; })
-      .addEventListener('select', function(node) { file_api.folder_select(node.id); });
+      .addEventListener('search', function(search) { file_api.folder_search(search); })
+      .addEventListener('select', function(node) {
+        if (file_api.search_results_widget)
+          file_api.search_results_widget.select();
+        file_api.folder_select(node.id);
+      });
 
     // select first folder?
     if (response.result.auth_errors) { }
@@ -1312,10 +1326,12 @@ function kolab_files_ui()
       row = $('<li class="mailbox"></li>'),
       id = 'rcmli' + rcmail.html_identifier_encode(i);
 
-    row.attr('id', id).append($('<a></a>').text(folder.name));
+    row.attr('id', id).append($('<a>').text(folder.name));
 
     if (folder.virtual)
       row.addClass('virtual');
+    else if (folder.subscribed !== undefined)
+      row.append(this.folder_list_subscription_button(folder.subscribed));
 
     folder.ref = row;
 
@@ -1346,6 +1362,290 @@ function kolab_files_ui()
     }
   };
 
+  // create subscription button element
+  this.folder_list_subscription_button = function(subscribed)
+  {
+    return $('<a>').attr({
+        title: rcmail.gettext('kolab_files.listpermanent'),
+        class: 'subscription' + (subscribed ? ' subscribed' : ''),
+        'aria-checked': subscribed,
+        role: 'checkbox'
+    });
+  };
+
+  // subscription button handler
+  this.folder_list_subscription_button_click = function(elem)
+  {
+    var folder = $(elem).parent('li').prop('id').replace(/^rcmli/, ''),
+      selected = $(elem).hasClass('subscribed');
+
+    folder = folder.replace(/--xsR$/, ''); // this might be a search result
+    folder = rcmail.html_identifier_decode(folder);
+    file_api['folder_' + (selected ? 'unsubscribe' : 'subscribe')](folder);
+    return false;
+  };
+
+  // sets subscription button status
+  this.folder_list_subscription_state = function(elem, status)
+  {
+    $(elem).children('a.subscription')
+      .prop('aria-checked', status)[status ? 'addClass' : 'removeClass']('subscribed');
+  };
+
+  // Folder searching handler (for unsubscribed folders)
+  this.folder_search = function(search)
+  {
+    // hide search results
+    if (this.search_results_widget) {
+      this.search_results_container.hide();
+      this.search_results_widget.reset();
+    }
+    this.search_results = {};
+
+    // send search request to the server
+    if (search.query && search.execute) {
+      // cancel previous search request
+      if (this.listsearch_request) {
+        this.listsearch_request.abort();
+        this.listsearch_request = null;
+      }
+
+      var params = {search: search.query, unsubscribed: 1};
+
+      this.req = this.set_busy(true, rcmail.gettext('searching'));
+      this.listsearch_request = this.request('folder_list', params, 'folder_search_response');
+    }
+    else if (!search.query) {
+      if (this.listsearch_request) {
+        this.listsearch_request.abort();
+        this.listsearch_request = null;
+      }
+
+      // any subscription changed, make sure the newly added records
+      // are listed before collections not after
+      if (this.folder_subscribe) {
+        var r, last, move = [], rows = $(rcmail.folder_list.container).children('li');
+
+        if (rows.length && !$(rows[rows.length-1]).hasClass('collection')) {
+          // collect all folders to move
+          while (rows.length--) {
+            r = $(rows[rows.length]);
+            if (r.hasClass('collection'))
+              last = r;
+            else if (last)
+              break;
+            else
+              move.push(r);
+          }
+
+          if (last)
+            $.each(move, function() {
+              this.remove();
+              last.before(this);
+            });
+        }
+      }
+    }
+  };
+
+  // folder search response handler
+  this.folder_search_response = function(response)
+  {
+    if (!this.response(response))
+      return;
+
+    var folders = response.result && response.result.list ? response.result.list : response.result;
+
+    if (!folders.length)
+      return;
+
+    folders = this.folder_list_parse(folders, 10000, false);
+
+    if (!this.search_results_widget) {
+      var list = rcmail.folder_list.container,
+        title = rcmail.gettext('kolab_files.additionalfolders'),
+        list_id = list.attr('id') || '0';
+
+      this.search_results_container = $('<div class="searchresults"></div>')
+          .append($('<h2 class="boxtitle" id="st:' + list_id + '"></h2>').text(title))
+          .insertAfter(list);
+
+      this.search_results_widget = new rcube_treelist_widget('<ul>', {
+          id_prefix: 'rcmli',
+          id_encode: rcmail.html_identifier_encode,
+          id_decode: rcmail.html_identifier_decode,
+          selectable: true
+      });
+
+      this.search_results_widget
+        .addEventListener('beforeselect', function(node) { return !rcmail.busy; })
+        .addEventListener('select', function(node) {
+          rcmail.folder_list.select();
+          file_api.folder_select(node.id);
+        });
+
+      this.search_results_widget.container
+        // copy classes from main list
+        .addClass(list.attr('class')).attr('aria-labelledby', 'st:' + list_id)
+        .appendTo(this.search_results_container)
+        .on('click', 'a.subscription', function(e) {
+          return file_api.folder_list_subscription_button_click(this);
+        });
+    }
+
+    // add results to the list
+    $.each(folders, function(i, folder) {
+      var node, separator = file_api.env.directory_separator,
+        path = i.split(separator),
+        html = [$('<a>').text(folder.name)];
+
+      // add subscription button
+      if (!folder.virtual)
+        html.push(file_api.folder_list_subscription_button(false));
+
+      path.pop();
+
+      file_api.search_results_widget.insert({
+          id: i,
+          classes: ['mailbox'],
+          text: folder.name,
+          html: html,
+          collapsed: false,
+          virtual: folder.virtual
+        }, path.length ? path.join(separator) : null);
+    });
+
+    this.search_results = folders;
+    this.search_results_container.show();
+  };
+
+  // folder subscribe request
+  this.folder_subscribe = function(folder)
+  {
+    this.env.folder_subscribe = folder;
+    this.req = this.set_busy(true, 'foldersubscribing');
+    this.request('folder_subscribe', {folder: folder}, 'folder_subscribe_response');
+  }
+
+  // folder subscribe response handler
+  this.folder_subscribe_response = function(response)
+  {
+    if (!this.response(response))
+      return;
+
+    this.display_message('foldersubscribed', 'confirmation');
+
+    var item, node = rcmail.folder_list.get_item(this.env.folder_subscribe);
+
+    if (this.search_results && this.search_results[this.env.folder_subscribe]) {
+      item = this.search_results_widget.get_item(this.env.folder_subscribe);
+      this.folder_list_subscription_state(item, true);
+      if (item = $(item).attr('id'))
+        this.folder_list_subscription_state($('#' + item.replace(/--xsR$/, '')), true);
+    }
+
+    // search result, move from search to main list widget
+    if (!node && this.search_results && this.search_results[this.env.folder_subscribe]) {
+      var i, html, dir, folder, separator = this.env.directory_separator,
+        path = this.env.folder_subscribe.split(separator);
+
+      // add all folders in a path to the main list if needed
+      // including the subscribed folder
+      for (i=0; i<path.length; i++) {
+        dir = path.slice(0, i + 1).join(separator);
+        node = rcmail.folder_list.get_node(dir);
+
+        if (!node) {
+          node = this.search_results_widget.get_node(dir);
+          if (!node) {
+            // sanity check
+            return;
+          }
+
+          if (i == path.length - 1) {
+            item = this.search_results_widget.get_item(dir);
+            this.folder_list_subscription_state(item, true);
+          }
+
+          folder = this.search_results[dir];
+          html = [$('<a>').text(folder.name)];
+          if (!folder.virtual)
+            html.push(this.folder_list_subscription_button(true));
+
+          node.html = html;
+          delete node.children;
+
+          rcmail.folder_list.insert(node, i > 0 ? path.slice(0, i).join(separator) : null);
+          // we're in search result, so there will be two records,
+          // add subscription button to the visible one, it was not cloned
+          if (!folder.virtual) {
+            node = rcmail.folder_list.get_item(dir);
+            $(node).append(file_api.folder_list_subscription_button(true));
+          }
+
+          this.env.folders[dir] = folder;
+        }
+      }
+
+      // now remove them from the search widget
+      while (path.length) {
+        dir = path.join(separator);
+        node = this.search_results_widget.get_item(dir);
+
+        if ($('ul[role="group"] > li', node).length)
+          break;
+
+        this.search_results_widget.remove(dir);
+
+        path.pop();
+      }
+
+      node = null;
+    }
+
+    if (node)
+      this.folder_list_subscription_state(node, true);
+
+    this.env.folders[this.env.folder_subscribe].subscribed = true;
+  };
+
+  // folder unsubscribe request
+  this.folder_unsubscribe = function(folder)
+  {
+    this.env.folder_subscribe = folder;
+    this.req = this.set_busy(true, 'folderunsubscribing');
+    this.request('folder_unsubscribe', {folder: folder}, 'folder_unsubscribe_response');
+  }
+
+  // folder unsubscribe response handler
+  this.folder_unsubscribe_response = function(response)
+  {
+    if (!this.response(response))
+      return;
+
+    this.display_message('folderunsubscribed', 'confirmation');
+
+    var folder = this.env.folders[this.env.folder_subscribe],
+      node = rcmail.folder_list.get_item(this.env.folder_subscribe);
+
+    if (this.search_results && this.search_results[this.env.folder_subscribe]) {
+      item = this.search_results_widget.get_item(this.env.folder_subscribe);
+
+      if (item) {
+        this.folder_list_subscription_state(item, false);
+        item = $('#' + $(item).attr('id').replace(/--xsR$/, ''));
+      }
+      else
+        item = $('#rcmli' + rcmail.html_identifier_encode(this.env.folder_subscribe), rcmail.folder_list.container);
+
+      this.folder_list_subscription_state(item, false);
+    }
+
+    this.folder_list_subscription_state(node, false);
+
+    folder.subscribed = false;
+  };
+
   // folder create request
   this.folder_create = function(folder)
   {
diff --git a/plugins/kolab_files/lib/kolab_files_engine.php b/plugins/kolab_files/lib/kolab_files_engine.php
index b367a217..15e3a999 100644
--- a/plugins/kolab_files/lib/kolab_files_engine.php
+++ b/plugins/kolab_files/lib/kolab_files_engine.php
@@ -87,6 +87,8 @@ class kolab_files_engine
                 }
             }
 
+            $this->folder_list_env();
+
             $this->plugin->add_label('save', 'cancel', 'saveto',
                 'saveall', 'fromcloud', 'attachsel', 'selectfiles', 'attaching',
                 'collection_audio', 'collection_video', 'collection_image', 'collection_document',
@@ -768,14 +770,14 @@ class kolab_files_engine
     protected function action_index()
     {
         $this->plugin->add_label(
-            'folderdeleting', 'folderdeleteconfirm', 'folderdeletenotice',
-            'uploading', 'attaching', 'uploadsizeerror',
+            'uploading', 'attaching', 'searching', 'uploadsizeerror',
             'filedeleting', 'filedeletenotice', 'filedeleteconfirm',
             'filemoving', 'filemovenotice', 'filemoveconfirm', 'filecopying', 'filecopynotice',
-            'collection_audio', 'collection_video', 'collection_image', 'collection_document',
             'fileskip', 'fileskipall', 'fileoverwrite', 'fileoverwriteall'
         );
 
+        $this->folder_list_env();
+
         $this->rc->output->add_label('uploadprogress', 'GB', 'MB', 'KB', 'B');
         $this->rc->output->set_pagetitle($this->plugin->gettext('files'));
         $this->rc->output->set_env('file_mimetypes', $this->get_mimetypes());
@@ -1187,4 +1189,22 @@ class kolab_files_engine
 
         $this->rc->output->set_env('external_sources', $sources);
     }
+
+    /**
+     * Registers translation labels for folder lists in UI
+     */
+    protected function folder_list_env()
+    {
+        // folder list and actions
+        $this->plugin->add_label(
+            'folderdeleting', 'folderdeleteconfirm', 'folderdeletenotice',
+            'collection_audio', 'collection_video', 'collection_image', 'collection_document',
+            'additionalfolders', 'listpermanent'
+        );
+        $this->rc->output->add_label('foldersubscribing', 'foldersubscribed',
+            'folderunsubscribing', 'folderunsubscribed', 'searching'
+        );
+
+        $this->rc->output->set_env('files_caps', $_SESSION['kolab_files_caps']);
+    }
 }
diff --git a/plugins/kolab_files/localization/en_US.inc b/plugins/kolab_files/localization/en_US.inc
index 50675288..d3f1a308 100644
--- a/plugins/kolab_files/localization/en_US.inc
+++ b/plugins/kolab_files/localization/en_US.inc
@@ -76,6 +76,8 @@ $labels['filemovenotice'] = 'File(s) moved successfully.';
 $labels['filecopynotice'] = 'File(s) copied successfully.';
 $labels['uploadsizeerror'] = 'Maximum file size ($size) exceeded!';
 
+$labels['listpermanent'] = 'List permanently';
+$labels['additionalfolders'] = 'Additional folders';
 $labels['allfolders'] = 'search in all folders';
 $labels['fileskip'] = 'Skip';
 $labels['fileskipall'] = 'Skip all';
diff --git a/plugins/kolab_files/skins/larry/images/listicons.png b/plugins/kolab_files/skins/larry/images/listicons.png
new file mode 100644
index 0000000000000000000000000000000000000000..5b5ca85b2b95110ae2193769b04e6c17a6248d8b
GIT binary patch
literal 2582
zcmY*a2T&917Dl*$A|ekFK~RB<s8J9^QNU{e2}LhRLN9^PB1H+k1_($=DAGa+5Q<dk
z{SpB~?-Ha7niwD;T?kbvZ|`;9y!Xz`{=46P=X~coXLe?Bx;h$XxGr+Bu&|ub(o};1
zcTwPacajY__e{vMEG(?Mx_|0J09adFdw6*0_&Qb16mk4dL{v5H?CrS`@=^**ffwfJ
zP&-^=Xjy|tdVzg(l5P0wp9cpo6Ec1!8+xFfQ{Dj2Rv}S3&rv>Uc_se|H$3s^=t$Mb
z+%hD}(A8I6-w26BLf|&W?tT!cfu<$0q`YEvb+xIfX_7wos<<w&pwisj+`=zJ2l>L>
zFT~0_u&b*JhVrUuY}Pijv=6}nU3B4ATRS^%o7=GY<v<@_e1=D4Ty=GIVRc<$b?p;t
zhwa_n5>oRs2iL;Va$O7Ss;a8y4@0i5uGBfkFJFL&p{ZG2UERUK0hLZqDX)E%RWS2y
z(JTnNyT1>x<eq-GR{$_$_vnP4i_hx%_vGYc+prj*1YqHCI3g%~W@cu5e0+6nZU5)b
z)T+N)28SzJyTdZ`fdn9ojEvl{uK_b=J{WB~r?=I$Q}kIV6bevD74-#;t-dLl*xX_Y
zg<>8UPG4MRFc|ry_f*D0$KVj$)hj(c-PYFjms?F62NH=?)Y8>8GTz<Y4Va|Pe`74I
zP-o@<HP?88Lsa6E=gwFx)-5h2C@9F;*%{aXKv{)GhlhvLW@a@INMNg9=rc%cT-2Mw
zt?g|<`8#t<+Y}x^$OcL}hen*7oTjFxNZoxv`TqWXF}Wl6T?=z(cZ0bF>?9;Lv$eH#
zZEbDjGu0Lov9kU>`b}Y4TAHt~ubL&&#KXU^xy>(`2sC|S>j*eBKzYT*#TgnJCYDsK
zeBX$Ujy5$l1r!uv#(n(*1Og#7HPtFKCMhWi8HJCHjm6<`K#qA3wx_4ZEiErNIN06Y
zold8F5Q`EL5<){mfkvp59H;nnG#c%lQyQ34{E0pTOlRUBs%7g0jN?lzK%r0zi;G>O
zlf%Qqjg5`bMV0z){vibwIXO9&mX<9;BbDtvot>RoSy_2`d7z@{KH$^;=mFEwV<DWx
zaQ?=N!C)XV!0}HYf&($i7);PQLI!h%ZRdsP5dti8otKdEH|uA8N1A}~a&gv`83v%Y
z=S$dw2RE;Z3iBTBZZT;TGC3hW9!Nu&D9DNLZZkL5m#JA<83aNE1`~+(cC|;qP4qM&
zYRZyFhd%&*b8~_5Ww5uYA}b5`3ghGQ60R$_wY3S9EzoH++9ZY2-`UYluB|A*M`8cg
z@I^UVn;RP$>OE6a+uzt=(1s}#a&1Xg0@hepUHOcapo0nv3;Us#nu@-0`wD*giLi=D
zL<I3(dYxS27w1o2-nZqgqQt@^B+kSe^WlrDZf9F>pL$pet9u_B60ytsFeJiT@6-=6
zf#xIJN!#uoFh?`1cAM8@N^Mh8t#*t>x@|bVHm1@ndCzlu?9n6Gj?S_@qEy+S_`t2R
z?v@L4c`+D)vub88<S-0$jpLz9GnAYEa<}YP(pfp8C>X4xijW6S-eOfRZB?IKrp6*`
zOk_`-xgB@u9Pg;(Hds>BRU|1DLw(xv)@}6NsfKc;I{3MviZ!Vnp^QI9zCO3G;m|aj
zI(2yW20sk^`Qs5esi*9wfnM>N`b|ZIB6JV|B8;Et9E*KsCbbmfPpwqYfQsiT<9n|2
zUcJMmhKpwXe>kjmN)Q5NRfpm+Q2wh3e#oMy5ah=<Bb<$UZt^p~zy>>;>;tA=-37b2
z%4zY&=@oS$*7s!<`_}%}QXsbM?Vz`5k(;n7mK0m7hNjd=OW{WktkGgzKZTDzl&^d{
z=jlm}sYfyNrN`#IN-iNa-1?SY*N{^bMe(q?;tMPNr~(?ASEAHjwgHC@OcZ)<@<I@q
zqMX}v9iAHp9leg=zsDsAiBVOD=3@Q}0k{7PFM8#!HQq=Zl5CUV4kAaG&p=X@<MK2$
z>+UL?<hxa`TWawlu|WG=Ww}Agc&6If;dd2qh|1^PfD6rwodGntr^sO>ZDOj~ne&)n
zoAI02{o4W3?cK+B<Y)u!B^G!vWpthb0U1Eo%oEV230E`?=C2A!@O3l!CK^><4r+-Y
zeh^8xK1I5$S%<Hm^({d+Nis%xY}?u3#{2Ox11|SZotbKtVC=bNxrKRl&w~$*ji9Gt
zOz5@q(K8+6SIR!IkG5sb!+0CcEnUD`==CT+;Xj0{zE`@q;n%zvaA)!N{L!H?cJa-m
zc+HMR1D+t+68$Au&D{#zYe<tuJ_(dB4WmOKeML!)xzttI2GSx2mQmt;hHvxBVzWZl
z`OUa836{B={OqROlGjczh=&#nFa-T&34c=g!$6(g9Iq~meZ00>0tG3yNhH{{H58p#
z^xR!rlo!q8$lR0!U79{dkDYa_<&3rTk5_?)>9+q)yeu^r)G3FY8<2{evWp5+cl9<D
zJA8HHB(w5M_{B<nRB9EM(D^o1P>g<}z?LSMop+vBM8#gHrT6I49fY{WJV?YgBRwZ6
zsP+WsWqQh|As&}j;iceziBu-tmz~DT<g(|GqRiyKJ-RR2&S%lkn$2ustanWwNP-;M
zG5Jz{=;O!DJ`<cRkGTtk7NSa=_(nC^S+ZJ$t+%9vYd)x!P6=3Fm;A%{c0WkX*i(_H
z3aS%wGU~9V4e}|JjZz=|ZmE<H<4MGHF?8b;(%|mdyr(m!?<(N5QzRuND_`*$)q|oJ
zIzo4bl_wt!azyqk+b(^qQ(hSv=)*g@Vs=(g7TY7>N**5`vPA{`c$T#KSE%BH)r(-J
zyhxxm^TFrzJ?6ci&&K;$#@8o*o{%9*`-k0XaVwwhBf2IE{3Wt|lrOUGyP{se&~b^i
z`zo$g&gQ2up;4+|RuE6qdqFzQbF3(MZI#E2gcCO092O$RxY$LQ-)a_<cKPZ?dqzPg
z9;e(Jal;pEbjk9Hg`>-rHM-wozy|T3+8j#9{!BFGQF<`&10LvheHKwSuM|vsY_HI(
z63eM%oXzmzycW=Z_*BcxOe=U+{;6!&Fo(iGy)o4R@;HjkH93Ye^1jx>G6$=b_js>k
zB28mzHIITS7NCGh3RhNp6n!Tk)9m&Wa9NkMtG#LO`IqO{T{D;a+lUd|46C#QPi^QG
zcWyjeDe}C@<X9YC{^{_&$uM948AlN;ElbJ;Ed5(;@}M4%QotK``FaH9F$O8WB5<<i
zLx|J|tJn1-8T~D%BTI_M7Tiznq03ros=_5VV0CWLOyZ1yQq4@oq4w0GSpHm5VfZo6
zz00iC`jfp@tP=QbT4nC`lir>`+6{XiODlo~4flc$POO~=KRlZ`=@0znShOHIYUQek
GkbeWq3{k)U

literal 0
HcmV?d00001