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