1: <?php
  2: /**
  3:  * The IMP_Tree_Flist class provides an IMP dropdown folder list.
  4:  *
  5:  * Copyright 2010-2012 Horde LLC (http://www.horde.org/)
  6:  *
  7:  * See the enclosed file COPYING for license information (GPL). If you
  8:  * did not receive this file, see http://www.horde.org/licenses/gpl.
  9:  *
 10:  * @author   Michael Slusarz <slusarz@horde.org>
 11:  * @category Horde
 12:  * @license  http://www.horde.org/licenses/lgpl21 GPL
 13:  * @package  IMP
 14:  */
 15: class IMP_Tree_Flist extends Horde_Tree_Select
 16: {
 17:     /**
 18:      * Allowed parameters for nodes.
 19:      *
 20:      * @var array
 21:      */
 22:     protected $_allowed = array(
 23:         'container',
 24:         'orig_label',
 25:         'selected',
 26:         'vfolder'
 27:     );
 28: 
 29:     /**
 30:      * Filter list.
 31:      *
 32:      * @var array
 33:      */
 34:     protected $_filter = array();
 35: 
 36:     /**
 37:      * Constructor.
 38:      *
 39:      * @param string $name   The name of this tree instance.
 40:      * @param array $params  Additional parameters.
 41:      *   - abbrev: (integer) Abbreviate long mailbox names by replacing the
 42:      *             middle of the name with '...'? Value is the total length
 43:      *             of the string.
 44:      *             DEFAULT: 30
 45:      *   - container_select: (boolean) Allow containers to be selected?
 46:      *                       DEFAULT: false
 47:      *   - customhtml: (string) Custom HTML to add to the beginning of the HTML
 48:      *                 SELECT tag.
 49:      *                 DEFAULT: ''
 50:      *   - filter: (array) An array of mailboxes to ignore.
 51:      *             DEFAULT: Display all
 52:      *   - heading: (string) The label for an empty-value option at the top of
 53:      *              the list.
 54:      *              DEFAULT: ''
 55:      *   - inc_notepads: (boolean) Include user's editable notepads in list?
 56:      *                   DEFAULT: No
 57:      *   - inc_tasklists: (boolean) Include user's editable tasklists in list?
 58:      *                    DEFAULT: No
 59:      *   - inc_vfolder: (boolean) Include user's virtual folders in list?
 60:      *                  DEFAULT: No
 61:      *   - new_folder: (boolean) Display an option to create a new folder?
 62:      *                 DEFAULT: No
 63:      */
 64:     public function __construct($name, array $params = array())
 65:     {
 66:         $params = array_merge(array(
 67:             'abbrev' => 30
 68:         ), $params);
 69: 
 70:         parent::__construct($name, $params);
 71:     }
 72: 
 73:     /**
 74:      * @param boolean $static  Ignored in this driver.
 75:      */
 76:     public function getTree($static = false)
 77:     {
 78:         global $conf, $injector, $registry;
 79: 
 80:         $this->_buildIndents($this->_root_nodes);
 81: 
 82:         $filter = $injector->createInstance('Horde_Text_Filter');
 83:         $t = $injector->createInstance('Horde_Template');
 84:         $t->setOption('gettext', true);
 85: 
 86:         /* Custom HTML. */
 87:         if ($customhtml = $this->getOption('customhtml')) {
 88:             $t->set('customhtml', $customhtml);
 89:         }
 90: 
 91:         /* Heading. */
 92:         if (($heading = $this->getOption('heading')) &&
 93:             (strlen($heading) > 0)) {
 94:             $t->set('heading', $heading);
 95:         }
 96: 
 97:         /* New folder entry. */
 98:         if ($this->getOption('new_folder') &&
 99:             ($injector->getInstance('Horde_Core_Perms')->hasAppPermission('create_folders') &&
100:              $injector->getInstance('Horde_Core_Perms')->hasAppPermission('max_folders'))) {
101:             $t->set('new_mbox', true);
102:         }
103: 
104:         /* Virtual folders. */
105:         if ($this->getOption('inc_vfolder')) {
106:             $imp_search = $injector->getInstance('IMP_Search');
107:             $vfolder_list = array();
108: 
109:             $imp_search->setIteratorFilter(IMP_Search::LIST_VFOLDER);
110:             foreach ($imp_search as $val) {
111:                 $form_to = IMP_Mailbox::formTo($val);
112:                 $vfolder_list[] = array(
113:                     'l' => $filter->filter($val->label, 'space2html', array('encode' => true)),
114:                     'sel' => !empty($this->_nodes[$form_to]['selected']),
115:                     'v' => $form_to
116:                 );
117:             }
118: 
119:             if (!empty($vfolder_list)) {
120:                 $t->set('vfolder', $vfolder_list);
121:             }
122:         }
123: 
124:         /* Add the list of editable tasklists to the list. */
125:         if ($this->getOption('inc_tasklists') &&
126:             $GLOBALS['session']->get('imp', 'tasklistavail')) {
127:             try {
128:                 $tasklists = $registry->call('tasks/listTasklists', array(false, Horde_Perms::EDIT));
129: 
130:                 if (count($tasklists)) {
131:                     $tasklist_list = array();
132:                     foreach ($tasklists as $id => $tasklist) {
133:                         $tasklist_list[] = array(
134:                             'l' => $filter->filter($tasklist->get('name'), 'space2html', array('encode' => true)),
135:                             'v' => IMP_Mailbox::formTo(IMP::TASKLIST_EDIT . $id)
136:                         );
137:                     }
138:                     $t->set('tasklist', $tasklist_list);
139:                 }
140:             } catch (Horde_Exception $e) {}
141:         }
142: 
143:         /* Add the list of editable notepads to the list. */
144:         if ($this->getOption('inc_notepads') &&
145:             $GLOBALS['session']->get('imp', 'notepadavail')) {
146:             try {
147:                 $notepads = $registry->call('notes/listNotepads', array(false, Horde_Perms::EDIT));
148: 
149:                 if (count($notepads)) {
150:                     foreach ($notepads as $id => $notepad) {
151:                         $notepad_list[] = array(
152:                             'l' => $filter->filter($notepad->get('name'), 'space2html', array('encode' => true)),
153:                             'v' => IMP_Mailbox::formTo(IMP::NOTEPAD_EDIT . $id)
154:                         );
155:                     }
156:                     $t->set('notepad', $notepad_list);
157:                 }
158:             } catch (Horde_Exception $e) {}
159:         }
160: 
161:         /* Prepare filter list. */
162:         $this->_filter = ($filter = $this->getOption('filter'))
163:             ? array_flip($filter)
164:             : array();
165: 
166:         $tree = '';
167:         foreach ($this->_root_nodes as $node_id) {
168:             $tree .= $this->_buildTree($node_id);
169:         }
170:         $t->set('tree', $tree);
171: 
172:         return $t->fetch(IMP_TEMPLATES . '/imp/flist/flist.html');
173:     }
174: 
175:     /**
176:      */
177:     protected function _buildTree($node_id)
178:     {
179:         if (isset($this->_filter[$node_id])) {
180:             return '';
181:         }
182: 
183:         $node = &$this->_nodes[$node_id];
184: 
185:         if ($abbrev = $this->getOption('abbrev')) {
186:             $orig_label = $node['label'];
187:             $node['label'] = Horde_String::abbreviate($node['orig_label'], $abbrev - ($node['indent'] * 2));
188:         } else {
189:             $orig_label = null;
190:         }
191: 
192:         /* Ignore container elements. */
193:         if (!$this->getOption('container_select') &&
194:             !empty($node['container'])) {
195:             if (!empty($node['vfolder'])) {
196:                 return '';
197:             }
198:             $node_id = '';
199:             $this->_nodes[$node_id] = $node;
200:         }
201: 
202:         $out = parent::_buildTree($node_id);
203: 
204:         if ($orig_label) {
205:             $node['label'] = $orig_label;
206:         }
207: 
208:         return $out;
209:     }
210: 
211: }
212: