source: trunk/prototype/modules/filters/interceptors/FilterMapping.php @ 5601

Revision 5601, 15.0 KB checked in by airton, 12 years ago (diff)

Ticket #2088 - Melhorias no editor de regras de filtro de mensagens do Expresso - Pequenas correcoes
Line 
1<?php
2/**
3*
4* Copyright (C) 2011 Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
5*
6* This program is free software; you can redistribute it and/or modify it under
7* the terms of the GNU Affero General Public License version 3 as published by
8* the Free Software Foundation with the addition of the following permission
9* added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
10* WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
11* WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
12*
13* This program is distributed in the hope that it will be useful, but WITHOUT
14* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15* FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
16* details.
17*
18* You should have received a copy of the GNU Affero General Public License
19* along with this program; if not, see www.gnu.org/licenses or write to
20* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
21* MA 02110-1301 USA.
22*
23* This code is based on the OpenXchange Connector and on the Prognus pSync
24* Connector both developed by the community and licensed under the GPL
25* version 2 or above as published by the Free Software Foundation.
26*
27* You can contact Prognus Software Livre headquarters at Av. Tancredo Neves,
28* 6731, PTI, Bl. 05, Esp. 02, Sl. 10, Foz do Iguaçu - PR - Brasil or at
29* e-mail address prognus@prognus.com.br.
30*
31* Descrição rápida do arquivo
32*
33* Arquivo responsável pela manipulação dos filtros
34*
35* @package    filters
36* @license    http://www.gnu.org/copyleft/gpl.html GPL
37* @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
38* @version    1.0
39* @sponsor    Caixa EconÃŽmica Federal
40* @since      Arquivo disponibilizado na versão 2.4
41*/
42
43
44
45/**
46* Classe responsável pela manipulação dos filtros.
47*
48*
49* @package    prototype
50* @license    http://www.gnu.org/copyleft/gpl.html GPL
51* @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
52* @author     Airton Bordin Junior
53* @author     Gustavo Pereira dos Santos
54* @version    1.0
55* @since      Classe disponibilizada na versão 2.4
56*/
57class FilterMapping
58{
59       
60        var $service;
61       
62       
63        /**
64        * Método que formata o Script de acordo com a sintaxe do Sieve.
65        *
66        * @license    http://www.gnu.org/copyleft/gpl.html GPL
67        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
68        * @sponsor    Caixa EconÃŽmica Federal
69        * @author     Airton Bordin Junior
70        * @author         Gustavo Pereira dos Santos   
71        * @param      <Array> <$rules> <Array com as regras do usuário>
72        * @return     <Regra de acordo com a sintaxe do Sieve>
73        * @access     <public>
74        */
75        public function formatSieveScript( $rules )
76    {
77                $require_fileinto = $require_flag = $require_reject = $require_vacation = $require_body = $require_imapflag = $vacation = $startswith = $endswith = false;
78
79                $script_rules = $script_header = $script_criteria = "";
80                $i = 0;
81                foreach( $rules as $name => $data )
82                {
83                        if( !$data['enabled'] )
84                                continue;
85
86                        $criteria = $data['criteria'];
87                        $action   = $data['actions'];
88                       
89                        ($i >0) ? $script_match = 'els' : $script_match = '';
90                        $data['isExact'] == 'false' ?  $script_match .= 'if anyof (' : $script_match .= 'if allof (';
91
92                        for ($j=0; $j<count($criteria); $j++)
93                        {                                       
94                                switch($criteria[$j]['field']) {
95                                        case 'To':   
96                                        case 'to':   
97                                        case 'CC':
98                                        case 'Cc':
99                                                $criteria[$j]['field'] = "[\"To\", \"TO\", \"Cc\", \"CC\"]";
100                                                $script_criteria .= "address :";
101                                                break;
102                                        case 'from':
103                                                $criteria[$j]['field'] = "\"" . $criteria[$j]['field'] . "\"";
104                                                $script_criteria .= "address :";
105                                                break;
106                                        case 'size':   
107                                                $criteria[$j]['field'] = '';
108                                                $script_criteria .= "size :";
109                                                break;
110                                        case 'subject':
111                                                $criteria[$j]['field'] = "\"" . $criteria[$j]['field'] . "\"";
112                                                $criteria[$j]['value'] = "" . imap_8bit($criteria[$j]['value']) . "\", \"" . base64_encode($criteria[$j]['value']) . "";
113                                                $script_criteria .= "header :";
114                                                break;
115                                        case 'body':
116                                                $criteria[$j]['field'] = '';
117                                                $script_criteria .= "body :";
118                                                $require_body = true;
119                                                break;
120                                        case 'vacation':
121                                                $require_vacation = true;
122                                                $vacation = true;
123                                                //$script_match = "vacation";
124                                                continue;
125                                        default:
126                                                $script_criteria .= "header :";
127                                                break;
128                                }
129                               
130                                switch ($criteria[$j]['operator']) {
131                                        case '>':
132                                                $criteria[$j]['operator'] = "over";
133                                                break;
134                                        case '<':
135                                                $criteria[$j]['operator'] = "under";
136                                                break;
137                                        case '=':
138                                                $criteria[$j]['operator'] = "is";
139                                                $criteria[$j]['value'] = "[\"" . $criteria[$j]['value'] . "\"]";
140                                                break;
141                                        case '*':
142                                                $criteria[$j]['operator'] = "contains";
143                                                $criteria[$j]['value'] = "[\"" . $criteria[$j]['value'] . "\"]";
144                                                break;                                         
145                                        case '^':
146                                                $criteria[$j]['operator'] = "matches";
147                                                $criteria[$j]['value'] = "[\"" . $criteria[$j]['value'] . "*\"]";
148                                                $startswith = true;
149                                                break;
150                                        case '$':
151                                                $criteria[$j]['operator'] = "matches";
152                                                $criteria[$j]['value'] = "[\"*" . $criteria[$j]['value'] . "\"]";
153                                                $endswith = true;
154                                                break;
155                                        /*
156                                           TO-DO:
157                                           Arrrumar regra do "não contém".
158                                        */
159                                        case '!*':
160                                                $criteria[$j]['operator'] = "contains";
161                                                $criteria[$j]['value'] = "[\"" . $criteria[$j]['value'] . "\"]";
162                                                break;
163                                }
164                               
165                                if ($criteria[$j]['field'] == "" || $criteria[$j]['field'] == "\"subject\"" || $startswith || $endswith)
166                                {
167                                        $script_criteria .= $criteria[$j]['operator'] . " " . $criteria[$j]['field'] . " " . $criteria[$j]['value'] . ", ";
168                                        $startswith = $endswith = false;
169                                }
170                                else
171                                        $script_criteria .= $criteria[$j]['operator'] . " " . $criteria[$j]['field'] . " " . $criteria[$j]['value'] . ", ";
172                        }
173                        $script_criteria = substr($script_criteria,0,-2);
174                        if ($vacation == false)
175                                $script_criteria .= ")";
176                        else
177                                $script_criteria = "";
178                        $script_action = " {\r\n ";
179                        for ($k=0; $k<count($action); $k++)
180                        {
181                                switch ($action[$k]['type']) {
182                                        case 'redirect':
183                                                break;
184                                        case 'reject':
185                                                $require_reject = true;
186                                                break;
187                                        case 'fileinto':
188                                                $require_fileinto = true;
189                                                break;
190                                        case 'vacation':
191                                                $require_vacation = true;
192                                                $action[$k]['parameter'] = "\"" . $action[$k]['parameter'] . "\"";
193                                                $vacation_action = " :subject \"Fora do Escritório\" " . $action[$k]['parameter'] . ";";
194                                                $vacation = true;
195                                                continue;
196                                        case 'setflag':
197                                                $require_flag = true;
198                                                $action[$k]['parameter'] = "\\\\" . $action[$k]['parameter'];
199                                                break;
200                                        case 'discard':
201                                                break;
202                                }
203                                /*if ($vacation == false)*/ $script_action .= $action[$k]['type'] . " \"" . $action[$k]['parameter'] . "\";\r\n ";
204                        }
205
206                        /*if ($vacation == false)*/ $script_action .= "}";
207
208                        $script_rules .= $script_match . $script_criteria . $script_action . "\r\n";
209                        $script_match = "";
210                        $script_criteria = "";
211                        $i++;
212                }
213
214                if($require_reject || $require_fileinto || $require_vacation || $require_body || $require_flag)
215                {
216                        $script_header .= "require [";
217                        $require_reject ? $script_header .= "\"reject\", " : "";
218                        $require_fileinto ? $script_header .= "\"fileinto\", " : "";
219                        $require_vacation? $script_header .= "\"vacation\", " : ""; 
220                        $require_flag ? $script_header .= "\"imapflags\", " : ""; 
221                        $require_body ? $script_header .= "\"body\", " : "";  /* tem que instalar as extensões no Cyrus */
222                        $script_header = substr($script_header,0,-2);
223                        $script_header .= "];\r\n";
224                }
225
226                if( $vacation )
227                {
228                  $script_rules .= "vacation" . $vacation_action . "\r\n";
229                }
230
231                $json_data = json_encode($rules);
232               
233                $script_begin = "#Filtro gerado por Expresso Livre versão 2.4\r\n\r\n";
234
235                $content = $script_begin . $script_header . $script_rules . "\r\n\r\n#PseudoScript#" . "\r\n#" . $json_data;
236               
237                /* $content = "";  //fill script! */
238                return( $content );
239        }
240       
241
242        /**
243        * Método que faz o parsing do Script Sieve, transformando em Array.
244        *
245        * @license    http://www.gnu.org/copyleft/gpl.html GPL
246        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
247        * @sponsor    Caixa EconÃŽmica Federal
248        * @author     Airton Bordin Junior
249        * @author         Gustavo Pereira dos Santos   
250        * @param      <String> <$script> <Script Sieve com as regras do usuário>
251        * @return     <Regras do usuário em Array>
252        * @access     <public>
253        */
254        public function parseSieveScript( $script )
255        {
256                $pos = strripos($script, "#PseudoScript#");
257                $pseudo_script = substr( $script, $pos+17 );
258
259                $return = json_decode( $pseudo_script, true );
260
261                return $return;
262        }
263
264        var $rules = false;
265
266        /**
267        * Construtor da classe.
268        *
269        * @license    http://www.gnu.org/copyleft/gpl.html GPL
270        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
271        * @sponsor    Caixa EconÃŽmica Federal
272        * @author     Airton Bordin Junior
273        * @author         Gustavo Pereira dos Santos   
274        * @access     <public>
275        */
276        public function __construct()
277        {
278                $this->service = Controller::service("Sieve");
279        }
280
281       
282        /**
283        * Método que recupera as regras do usuário.
284        *
285        * @license    http://www.gnu.org/copyleft/gpl.html GPL
286        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
287        * @sponsor    Caixa EconÃŽmica Federal
288        * @author     Airton Bordin Junior
289        * @author         Gustavo Pereira dos Santos   
290        * @return     <Regras do usuário>
291        * @access     <public>
292        */
293        public function getRules()
294        {
295                $this->rules = Controller::find( array( 'concept' => 'filter' ) );
296
297                if( !$this->rules ) {
298                        $this->rules = array();
299                }
300                return( $this->rules );
301        }
302
303       
304        /**
305        * Método que aplica o filtro para as mensagens do usuário.
306        *
307        * @license    http://www.gnu.org/copyleft/gpl.html GPL
308        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
309        * @sponsor    Caixa EconÃŽmica Federal
310        * @author     Airton Bordin Junior
311        * @author         Gustavo Pereira dos Santos   
312        * @param      <$uri>
313        * @param      <$result>
314        * @param      <$criteria>
315        * @param      <$original>
316        * @access     <public>
317        */
318        public function applySieveFilter( &$uri , &$result , &$criteria , $original  )
319        {
320                 $result['id'] = $uri['id'];
321
322                 if( $original['properties']['applyMessages'] )
323                 {
324                      $filter = Controller::read($uri);
325
326                      $proc = array();
327                      $proc['keep'] = false;
328                     
329                      foreach ($filter['actions'] as $v){
330                              if($v['type'] == 'keep')
331                                      $proc['keep'] = true;
332                              else{
333                                      $proc['type'] = $v['type'];
334                                      $proc['parameter'] = $v['parameter'];
335                              }
336                      }
337
338                      $imap = Controller::service( 'Imap' );
339                      $imap->apliSieveFilter($original['properties']['applyMessages'] , $proc );
340                      return $result;
341                  }
342        }
343
344       
345        /**
346        * Método que lê o script do usuário.
347        *
348        * @license    http://www.gnu.org/copyleft/gpl.html GPL
349        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
350        * @sponsor    Caixa EconÃŽmica Federal
351        * @author     Airton Bordin Junior
352        * @author         Gustavo Pereira dos Santos   
353        * @param      <$uri>
354        * @param      <$result>
355        * @param      <$criteria>
356        * @param      <$original>
357        * @return     <Script do usuário>
358        * @access     <public>
359        */
360        public function readUserScript( &$uri , &$params , &$criteria , $original )
361        { 
362                $uri['id'] = $this->service->config['user'];
363        }
364 
365 
366        /**
367        * Método que seta o script do usuário.
368        *
369        * @license    http://www.gnu.org/copyleft/gpl.html GPL
370        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
371        * @sponsor    Caixa EconÃŽmica Federal
372        * @author     Airton Bordin Junior
373        * @author         Gustavo Pereira dos Santos   
374        * @param      <$uri>
375        * @param      <$result>
376        * @param      <$criteria>
377        * @param      <$original>
378        * @return     <Script do usuário>
379        * @access     <public>
380        */
381        public function setRule( &$uri , &$params , &$criteria , $original  )
382        {
383            if( !$this->rules )
384                $this->rules = $this->getRules();
385
386            $uri['id'] = $params['id'] = isset($params['id']) ? $params['id'] : urlencode($params['name']);
387
388            $i = 0;
389
390            for( ;$this->rules[$i] && $this->rules[$i]['id'] !== $params['id']; $i++ );
391
392            $this->rules[$i] = $params;
393
394            $params = array( 'name' => $this->service->config['user'],
395                             'content' => $this->formatSieveScript( $this->rules ),
396                             'active' => true );
397        }
398
399       
400        /**
401        * Método que deleta o script do usuário.
402        *
403        * @license    http://www.gnu.org/copyleft/gpl.html GPL
404        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
405        * @sponsor    Caixa EconÃŽmica Federal
406        * @author     Airton Bordin Junior
407        * @author         Gustavo Pereira dos Santos   
408        * @param      <$uri>
409        * @param      <$result>
410        * @param      <$criteria>
411        * @param      <$original>
412        * @access     <public>
413        */
414        public function deleteRule( &$uri, &$params, &$criteria, $original )
415        {
416                if( !$this->rules ) {   
417                        $this->rules = $this->getRules();
418                }         
419                $params['id'] = $uri['id'];
420
421                $update = false;
422               
423                $rules = array();
424
425                foreach( $this->rules as $i => $rule )
426                        if( $rule['id'] !== $uri['id'] )
427                                $rules[] = $this->rules[$i];
428
429                $this->rules = $rules;
430               
431                $uri['id'] = '';
432
433                $params = array( 'name' => $this->service->config['user'],
434                           'content' => $this->formatSieveScript( $this->rules ),
435                           'active' => true );
436
437                $URI = Controller::URI( $uri['concept'], $this->service->config['user'] );
438                $this->service->update( $URI, $params );
439       
440                return( false );
441        }
442
443       
444        /**
445        * Método que pega o script do usuário.
446        *
447        * @license    http://www.gnu.org/copyleft/gpl.html GPL
448        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
449        * @sponsor    Caixa EconÃŽmica Federal
450        * @author     Airton Bordin Junior
451        * @author         Gustavo Pereira dos Santos   
452        * @param      <$uri>
453        * @param      <$result>
454        * @param      <$criteria>
455        * @param      <$original>
456        * @return     <Script do usuário>
457        * @access     <public>
458        */
459        public function getSieveRule( &$uri , &$params , &$criteria , $original )
460        {         
461                $script = $this->parseSieveScript( $params['content'] );
462
463                foreach( $script as $i => $rule )
464                        if( $rule['name'] === $original['id'] )
465                                return( $params = $rule );
466        }
467
468       
469        /**
470        * Método que lista as regras do usuário.
471        *
472        * @license    http://www.gnu.org/copyleft/gpl.html GPL
473        * @author     Consórcio Expresso Livre - 4Linux (www.4linux.com.br) e Prognus Software Livre (www.prognus.com.br)
474        * @sponsor    Caixa EconÃŽmica Federal
475        * @author     Airton Bordin Junior
476        * @author         Gustavo Pereira dos Santos   
477        * @param      <$uri>
478        * @param      <$result>
479        * @param      <$criteria>
480        * @param      <$original>
481        * @return     <Regras do usuário>
482        * @access     <public>
483        */
484        public function listSieveRules( &$uri , &$params , &$criteria , $original  )
485        {               
486                $return = $params = $this->parseSieveScript( $params[0]['content'] );
487                return( $return );
488        }
489}
Note: See TracBrowser for help on using the repository browser.