source: extensions/event_cats/include/evntcats_main_funcs.inc.php @ 4421

Last change on this file since 4421 was 4421, checked in by LucMorizur, 14 years ago

[Event Cats] Add character "é" in all files so to keep them coded in UTF-8 w/o BOM
File size: 18.6 KB
Line 
1<?php
2
3// +-----------------------------------------------------------------------+
4// | Piwigo - a PHP based picture gallery                                  |
5// +-----------------------------------------------------------------------+
6// | Copyright(C) 2008-2009 Piwigo Team                  http://piwigo.org |
7// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
8// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
9// +-----------------------------------------------------------------------+
10// | This program is free software; you can redistribute it and/or modify  |
11// | it under the terms of the GNU General Public License as published by  |
12// | the Free Software Foundation                                          |
13// |                                                                       |
14// | This program is distributed in the hope that it will be useful, but   |
15// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
16// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
17// | General Public License for more details.                              |
18// |                                                                       |
19// | You should have received a copy of the GNU General Public License     |
20// | along with this program; if not, write to the Free Software           |
21// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
22// | USA.                                                                  |
23// +-----------------------------------------------------------------------+
24
25// Look out, do sit before reading that :
26// keeps file coded in UTF-8 without BOM in Notepad++ : é
27// !!!
28
29if (!defined('PHPWG_ROOT_PATH')) die('Hacking attempt!');
30
31// ***************************************************************************
32// ** evntcats_admin_funcs.php : Main functions (include)                   **
33// ** for Piwigo plugin Event Cats                                          **
34// ***************************************************************************
35
36// +-----------------------------------------------------------------------+
37// | Header                                                                |
38// +-----------------------------------------------------------------------+
39
40include_once(EVNTCATS_PATH.'include/ec_conf.inc.php');
41
42if (!isset($ec_lists)) {
43  $ec_lists               = array();
44  $ec_lists['add_pages']  = array();
45  $ec_lists['categories'] = array();
46  $ec_lists['user_ids']   = array();
47  $ec_lists['ec_table']   = array();
48}
49
50// +-----------------------------------------------------------------------+
51// | Utilities functions                                                   |
52// +-----------------------------------------------------------------------+
53
54/*
55 * is_in($haystack, $needle)
56 * returns true or false whether $needle is a string found in string $haystack
57 *
58 * @param
59 *   $haystack : the string in which to search
60 *   $needle   : the string looked for
61 * @return
62 *   true if $needle is found in $haystack ; false if not
63 */
64function is_in($haystack, $needle) {
65  return (strpos($haystack, $needle) !== false);
66}
67
68/*
69 * ec_image_exists($cat, $img)
70 * returns true or false whether the image is associated with the category.
71 *
72 * @param
73 *   $cat : the category
74 *   $img : the image
75 * @return
76 *   treu or false whether the image is associated with the category.
77 */
78function ec_image_exists($cat, $img) {
79  return (mysql_fetch_row(pwg_query("
80    SELECT *
81    FROM `".IMAGE_CATEGORY_TABLE."`
82    WHERE `category_id` = ".$cat."
83     AND `image_id` = ".$img
84  )) !== false);
85}
86
87/*
88 * str_from_var($var)
89 * returns a string easing array var informations displaying in Piwigo :
90 *   _ the string return value starts with"<p align="left">" ;
91 *   _ all "TAB" characters (chr(10)) are replaced by "<br>" ;
92 *   _ all spaces are replaced by "&nbsp;".
93 *
94 * @param
95 *   $var : variable to display
96 * @return
97 *   string easy to display in Piwigo
98 */
99function str_from_var($var) {
100  return
101   '<p align="left">'.
102   str_replace(
103    chr(10),'<br>',
104    str_replace(' ','&nbsp;', print_r /* var_dump */ ($var,true))
105   ).
106   '</p>';
107}
108
109/*
110 * ec_inspect()
111 * goes through ec_lists['ec_table'] to check errors on (multiple) entries
112 * using the same code. Cannot really be used elsewhere than here in
113 * build_ec_table() .
114 *
115 * @param
116 *   
117 * @return
118 *   (no return value)
119 */
120function ec_inspect($checked_item, $new_action, $check_ec_nok = true) {
121  global $ec_lists;
122  $first = array();
123  $to_correct = array();
124 
125  /*
126  // $to_correct is needed cause following code would not work everywhere :
127  foreach ($table as $value) {
128    if ($value == $value_to_check and $value == $problem) {
129      foreach ($table as &$value2) { // key index of $table can be reset
130        if ($value2 == $value_to_check) {
131          $value2 = $better_value;
132        }
133      }
134    }
135  }
136  // It works with WinAmp Server, but not on Apache server of Free (french
137  // Internet provider).
138  */
139 
140  foreach ($ec_lists['ec_table'] as $ec_entry) {
141    $ec_current_code = $ec_entry['code'];
142    if (
143     $ec_entry['action'] == 'ec_ok' or
144     ($check_ec_nok and $ec_entry['action'] == 'ec_nok')
145    ) {
146      if (isset($first[$ec_current_code])) {
147        // $first[$ec_current_code] is set <=> code has already been met.
148        // Checked item MUST be equal to the first item (thus all items) for
149        // this code.
150        if (
151         $first[$ec_current_code] != $ec_entry[$checked_item] or
152         ($new_action == '' and $ec_entry[$checked_item] == 'true')
153        ) $to_correct[$ec_current_code] = true; // value not used in fact
154        // but using $ec_current_code as a key makes a smaller table
155      } // if the error comes back several times
156      else $first[$ec_current_code] = $ec_entry[$checked_item];
157    }
158  }
159  foreach ($ec_lists['ec_table'] as &$ec_entry) { // & is needed here
160    if (isset($to_correct[$ec_entry['code']])) {
161      if ($new_action == '') {
162        if (!pwg_query("
163          UPDATE `".EVNTCATS_TABLE."`
164          SET `forced` = 'false'
165          WHERE `id` = ".$ec_entry['id']
166        )) die('Could not fix a "_f_pb"');
167        $ec_entry['forced'] = 'false';
168      }
169      else $ec_entry['action'] = $new_action;
170    }
171  }
172}
173
174// +-----------------------------------------------------------------------+
175// | Tables building functions                                             |
176// +-----------------------------------------------------------------------+
177
178/*
179 * build_ec_addp()
180 * builds $ec_lists['add_pages'].
181 *
182 * @param
183 *   (no parameter)
184 * @return
185 *   (no return value)
186 */
187function build_ec_addp() {
188  global $ec_lists;
189  if (defined('ADD_PAGES_TABLE')) {
190    $res = pwg_query("SELECT `id`, `title` FROM `".ADD_PAGES_TABLE."`");
191    while ($r = mysql_fetch_assoc($res)) {
192      $c = (is_in($r['title'], '/user_id=')) ? '/user_id=' : '/group_id=';
193      $a = explode($c ,$r['title']);
194      $ec_lists['add_pages'][$r['id']] = $a[0];
195    }
196  }
197}
198
199/*
200 * build_ec_categories($dsp)
201 * builds $ec_lists['categories'].
202 *
203 * @param
204 *   whether $ec_lists['categories'] must be of type "cat / sub-cat" or
205 *   or "cat <CR LF> - sub-cat".
206 * @return
207 *   (no return value)
208 */
209function build_ec_categories($dsp) {
210  global $template, $ec_lists;
211  $c = array();
212  display_select_cat_wrapper("
213     SELECT `id`, `name`, `uppercats`, `global_rank`
214     FROM `".CATEGORIES_TABLE."`
215   ", $c, 'category_options', $dsp);
216  $ec_lists['categories'] = $template->smarty->_tpl_vars['category_options'];
217}
218
219/*
220 * build_ec_userids()
221 * builds $ec_lists['user_ids'].
222 *
223 * @param
224 *   (no parameter)
225 * @return
226 *   (no return value)
227 */
228function build_ec_userids() {
229  global $ec_lists, $conf;
230  $ec_lists['user_ids'] = simple_hash_from_query("
231    SELECT
232      ".$conf['user_fields']['id']." AS id,
233      ".$conf['user_fields']['username']." AS username
234    FROM `".USERS_TABLE."`
235    WHERE id > 2;",
236    'id', 'username'
237  );
238}
239
240/*
241 * build_ec_table()
242 * builds a table showing the content of the <pwg>_event_cats database table,
243 * and a table showing the eventual errors.
244 *
245 * @param
246 *   no parameters passed ; the main material on which works the function, is
247 *   the global array variable $ec_lists.
248 * @return
249 *   (no return value)
250 */
251function build_ec_table() {
252  global $ec_lists;
253 
254  $q = pwg_query("
255    SELECT * FROM `".EVNTCATS_TABLE."`
256    WHERE `code` IS NOT NULL
257    ORDER BY `id`
258  ");
259  while ($r = mysql_fetch_assoc($q))
260   $ec_lists['ec_table'][intval($r['id'])] = $r;
261 
262  // Construction of behaviour
263 
264  // Multiple action params for a single code check
265  ec_inspect('action', 'ec_nok_action_pb');
266 
267  // Multiple user_ids for a single code check
268  ec_inspect('user_id', 'ec_nok_userid_pb', false);
269 
270  // Multiple "forced" params for a single code check
271  ec_inspect('forced', '');
272 
273  // User id and associated page validities checks
274  foreach ($ec_lists['ec_table'] as &$ec_entry) {
275   
276    // Check if associated user_id exists
277    if (
278     is_in($ec_entry['action'], 'ec_ok') and
279     !array_key_exists($ec_entry['user_id'], $ec_lists['user_ids'])
280    ) $ec_entry['action'] = 'ec_nok_userid_miss';
281   
282    // Check if associated displayed page exists
283    $a = 0;
284    if (
285      !empty($ec_entry['arg1']) and
286      // (Only arg2 is significant if action is ec_nok[_xxx] .)
287      is_in($ec_entry['action'], 'ec_ok')
288    ) $a++;
289    if (!empty($ec_entry['arg2'])) $a+= 2;
290    switch ($a) {
291      // case 0 : home, nothing to check
292     
293      case 2: // Additional Page
294        if (
295          defined('ADD_PAGES_TABLE') and (
296            is_in($ec_entry['action'], 'ec_ok') or
297            $ec_entry['action'] == 'ec_nok'
298          ) and
299          !array_key_exists($ec_entry['arg2'], $ec_lists['add_pages'])
300        ) $ec_entry['action'].= '_ap_pb';
301      break;
302     
303      case 1: // Category
304      case 3: // Image
305        if (is_in($ec_entry['action'], 'ec_ok')) {
306          if (array_key_exists($ec_entry['arg1'], $ec_lists['categories'])) {
307           if ($a == 3) // case 3: // Image
308            if (!ec_image_exists($ec_entry['arg1'], $ec_entry['arg2']))
309             $ec_entry['action'].= '_img_pb';
310          }
311          else $ec_entry['action'].= '_cat_pb';
312        }
313      break;
314    }
315  }
316}
317
318/*
319 * build_dup_groups()
320 * builds the information telling who is allowed to duplicate
321 *
322 * @param
323 *   no parameter passed, the main material on which works the function, is
324 *   the global array variable $ec_lists.
325 * @return
326 *   (no return value)
327 */
328function build_dup_groups() {
329  global $ec_lists;
330 
331  if (count($ec_lists['user_ids']) == 0) build_ec_userids();
332 
333  // Existing groups (needed later)
334  $ec_lists['groups'] = simple_hash_from_query("
335    SELECT `id`, `name`
336      FROM `".GROUPS_TABLE."`
337      ORDER BY `name` ASC;
338    ",
339    'id', 'name'
340  );
341 
342  // groups granted to duplication
343  $ec_lists['groups_granted_ids'] = order_by_name(
344    array_from_query("
345      SELECT `arg2`
346        FROM ".EVNTCATS_TABLE."
347        WHERE `code` IS NULL
348          AND `arg1` = 1
349          AND `arg2` IS NOT NULL
350      ;",
351      'arg2'
352    ),
353    $ec_lists['groups']
354  );
355 
356  // users directly granted to duplication
357  $ec_lists['users_granted_direct_ids'] = order_by_name(
358    array_from_query("
359      SELECT `arg2`
360        FROM `".EVNTCATS_TABLE."`
361        WHERE `code` IS NULL
362          AND `arg1` = 2
363          AND `arg2` IS NOT NULL
364      ;",
365      'arg2'
366    ),
367    $ec_lists['user_ids']
368  );
369 
370  // Calculate users granted to duplication thanks to belonging to a
371  // certain group (in groups, level (friends, family, contacts),
372  // or user status (generic))
373  $types_entry_exists = (($t = mysql_fetch_row(pwg_query("
374    SELECT `arg2`
375    FROM `".EVNTCATS_TABLE."`
376    WHERE `code` IS NULL
377      AND `arg1` = 3
378      AND `arg2` IS NOT NULL
379    LIMIT 1;
380  "))) !== false);
381  $ec_lists['types_granted'] = ($types_entry_exists) ? $t[0] : 0;
382 
383  return $types_entry_exists;
384}
385
386/*
387 * build_ec_lists()
388 * builds the main array variable contaning all informations for the plugin
389 *
390 * @param
391 *   no parameter passed, the main material on which works the function, is
392 *   the global array variable $ec_lists.
393 * @return
394 *   (no return value)
395 */
396function build_ec_lists() {
397 
398  // Construction of $ec_lists['add_pages'] array var
399  build_ec_addp();
400 
401  // Construction of $ec_lists['categories'] array var
402  build_ec_categories(true);
403 
404  // Construction of $ec_lists['user_ids'] array var
405  build_ec_userids();
406 
407  // Construction of $ec_lists['ec_table'] array var
408  build_ec_table();
409}
410
411// +-----------------------------------------------------------------------+
412// | Duplication analysis functions                                        |
413// +-----------------------------------------------------------------------+
414
415/*
416 * build_dup_arrays($append_tpl = false)
417 * builds arrays telling which accounts are allowed to display a duplicate
418 * account link. Returns an array of all the user ids allowed to duplicate.
419 *
420 * @param
421 *   $append_tpl : tells if $template must be appended with built arrays
422 * @return
423 *   array of all the user ids allowed to duplicate
424 */
425function build_dup_arrays($append_tpl = false) {
426  global $template, $ec_lists, $conf;
427 
428  // A lot of below code has simply been copied from file cat_perm.php .
429  // Many thanks to people who wrote it !
430 
431  build_dup_groups();
432 
433  $users_granted_ids = array();
434 
435  $users_granted_thks_gen_ids = array();
436  if ($ec_gen_granted = (($ec_lists['types_granted'] & 8) != 0)) {
437    $users_granted_thks_gen_ids = order_by_name(
438      array_diff(
439        array_from_query("
440          SELECT `user_id`
441          FROM `".USER_INFOS_TABLE."`
442          WHERE `status` = 'generic';",
443          'user_id'
444        ),
445        $ec_lists['users_granted_direct_ids']
446      ),
447      $ec_lists['user_ids']
448    );
449    foreach ($users_granted_thks_gen_ids as $user_id)
450     $users_granted_ids[$user_id] = l10n('user_status_generic');
451  }
452
453  $types = array(
454    '1' => l10n('Level 1'),
455    '2' => l10n('Level 2'),
456    '4' => l10n('Level 4'),
457  );
458  $types_granted_ids = array();
459  $users_granted_thks_types_ids = array();
460  if (($ec_lists['types_granted'] & 7) != 0) {
461    if (($ec_lists['types_granted'] & 1) != 0) $types_granted_ids[] = '1';
462    if (($ec_lists['types_granted'] & 2) != 0) $types_granted_ids[] = '2';
463    if (($ec_lists['types_granted'] & 4) != 0) $types_granted_ids[] = '4';
464    if (count($types_granted_ids) > 0) {
465      $user_granted_from_type = array();
466      $result = pwg_query("
467        SELECT `user_id`, `level`
468        FROM `".USER_INFOS_TABLE."`
469        WHERE `level` IN (".implode(',', $types_granted_ids).");
470      ");
471      while ($row = mysql_fetch_array($result)) {
472        if (!isset($user_granted_from_type[$row['level']])) {
473          $user_granted_from_type[$row['level']] = array();
474        }
475        $user_granted_from_type[$row['level']][] = $row['user_id'];
476      }
477      $user_granted_by_type_ids = array();
478      foreach ($user_granted_from_type as $type_users)
479       $user_granted_by_type_ids = array_merge(
480        $user_granted_by_type_ids,
481        $type_users
482       );
483      $users_granted_thks_types_ids = order_by_name(
484        array_diff(
485          array_unique($user_granted_by_type_ids),
486          $ec_lists['users_granted_direct_ids']
487        ),
488        $ec_lists['user_ids']
489      );
490      foreach ($users_granted_thks_types_ids as $user_id)
491       foreach ($user_granted_from_type as $type_id => $type_users) {
492        if (in_array($user_id, $type_users)) {
493          $users_granted_ids[$user_id]= $types[$type_id];
494          break;
495        }
496       }
497    }
498  }
499
500  $users_granted_thks_groups_ids = array();
501  if (count($ec_lists['groups_granted_ids']) > 0) {
502    $granted_groups = array();
503
504    $result = pwg_query("
505      SELECT `user_id`, `group_id`
506      FROM `".USER_GROUP_TABLE."`
507      WHERE `group_id` IN (".implode(',', $ec_lists['groups_granted_ids']).");
508    ");
509    while ($row = mysql_fetch_array($result)) {
510      if (!isset($granted_groups[$row['group_id']])) {
511        $granted_groups[$row['group_id']] = array();
512      }
513      $granted_groups[$row['group_id']][] = $row['user_id'];
514    }
515   
516    $user_granted_by_group_ids = array();
517   
518    foreach ($granted_groups as $group_users)
519     $user_granted_by_group_ids = array_merge(
520      $user_granted_by_group_ids,
521      $group_users
522     );
523    $users_granted_thks_groups_ids = order_by_name(
524      array_diff(
525        array_unique($user_granted_by_group_ids),
526        $ec_lists['users_granted_direct_ids']
527      ),
528      $ec_lists['user_ids']
529    );
530    foreach ($users_granted_thks_groups_ids as $user_id)
531     foreach ($granted_groups as $group_id => $group_users)
532      if (in_array($user_id, $group_users)) {
533        $users_granted_ids[$user_id]= $ec_lists['groups'][$group_id];
534        break;
535      }
536   
537  }
538
539  if ($append_tpl) {
540    $users_denied_ids = order_by_name(
541      array_diff(
542        array_keys($ec_lists['user_ids']),
543        $users_granted_thks_gen_ids,
544        $users_granted_thks_types_ids,
545        $users_granted_thks_groups_ids,
546        $ec_lists['users_granted_direct_ids']
547      ),
548      $ec_lists['user_ids']
549    );
550   
551    foreach ($users_granted_ids as $u => $g) $template->append(
552      'user_granted_indirects',
553      array(
554        'USER'  => $ec_lists['user_ids'][$u],
555        'GROUP' => $g
556      )
557    );
558   
559    $template->assign('all_groups', $ec_lists['groups']);
560    $template->assign('groups_granted_ids', $ec_lists['groups_granted_ids']);
561    $template->assign('groups_denied_ids', order_by_name(
562      array_diff(
563        array_keys($ec_lists['groups']),
564        $ec_lists['groups_granted_ids']
565      ),
566      $ec_lists['groups']
567    ));
568    $template->assign('ec_gen_granted', $ec_gen_granted);
569    $template->assign('all_types', $types);
570    $template->assign('types_granted_ids', $types_granted_ids);
571    $template->assign('types_denied_ids', order_by_name(
572      array_diff(array_keys($types), $types_granted_ids), $types
573    ));
574    $template->assign('all_users', $ec_lists['user_ids']);
575    $template->assign(
576      'users_granted_direct_ids',
577      $ec_lists['users_granted_direct_ids']
578    );
579    $template->assign('users_denied_ids', $users_denied_ids);
580  }
581  $users_granted_ids = array_merge(
582    array_keys($users_granted_ids),
583    $ec_lists['users_granted_direct_ids']
584  );
585 
586  // Returns an array which values are all the user_ids allowed to display a
587  // "duplicate" link. The keys of this array are strange (for direct allowed
588  // users, keys are usernames), but should not used
589  return $users_granted_ids;
590}
591
592/*
593 * dup_allowed($user_id)
594 * returns true if the user_id is allowed to display a duplicate link
595 *
596 * @param
597 *   $user_id : the user_id
598 * @return
599 *   true if the user_id is allowed to display a duplicate link
600 */
601function dup_allowed($user_id) {
602  return in_array($user_id, build_dup_arrays());
603}
604
605?>
Note: See TracBrowser for help on using the repository browser.