File: Skel.php

package info (click to toggle)
diogenes 0.9.20-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,976 kB
  • ctags: 3,271
  • sloc: php: 12,285; sh: 828; perl: 258; makefile: 137; sql: 85
file content (155 lines) | stat: -rw-r--r-- 3,622 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<?php
/*
 * Copyright (C) 2003-2004 Polytechnique.org
 * http://opensource.polytechnique.org/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

// dependency on PEAR
require_once 'System.php';

/** Recursive stripslashes.
 *
 * @param $value
 */
function stripslashes_recurse($value)
{
   $value = is_array($value) ?
               array_map('stripslashes_recurse', $value) :
               stripslashes($value);
   return $value;
}


/** This class describes a Diogenes plugin. 
 */
class Diogenes_Plugin_Skel {
  /** Plugin type (object, filter) */
  var $type;
  
  /** Array of plugin parameters */
  var $params = array();
  
  /** Plugin name */
  var $name = "Plugin_Skel";
  
  /** Plugin description */  
  var $description = "Plugin skeleton";
  
  /** Plugin version */
  var $version = "0.1";

  /** Position of the plugin */
  var $pos;
  
  /** Is the plugin active ? */
  var $active = 0;
  
  
  /** Is the plugin allowed with respect to a given write permission on a page ?
   *
   * @param $wperms
   */
  function allow_wperms($wperms) 
  {
    return ($wperms != 'public');
  }
   

  /** Set plugin parameters.
   *
   * @param $params
   */
  function setParams($params)
  {
    $bits = explode("\0", $params);      
    foreach ($bits as $bit)
    {
      $frags = explode("=", $bit, 2);
      $key = $frags[0];
      $val = isset($frags[1]) ? $frags[1] : '';
      if (isset($this->params[$key])) {
        $this->params[$key] = $val;
      }
    }
  }
  
  
  /** Erase parameters from database.
   *
   * @param $barrel
   * @param $page
   */
  function eraseParams($barrel = '', $page = 0)
  {
    global $globals;
    
    //echo $this->name . " : deleteParams($barrel, $page)<br/>\n";
    $globals->db->query("delete from diogenes_plugin where plugin='{$this->name}' and barrel='$barrel' and page='$page'");
    
    $this->active = 0;
    unset($this->pos);
    foreach ($this->params as $key => $val)
    {
      $this->params[$key] = '';
    }
  }
   
    
  /** Store parameters to database.
   *
   * @param $barrel
   * @param $page
   * @param $pos   
   */
  function writeParams($barrel = '', $page = 0, $pos = 0)
  {
    global $globals;

    $this->pos = $pos;
    $this->active = 1;
    
    $params = '';
    foreach ($this->params as $key => $val)
    { 
      //echo $this->name . " $key=$val<br/>";
      $params .= "$key=$val\0";     
    }        
    $globals->db->query("replace into diogenes_plugin set plugin='{$this->name}', barrel='$barrel', page='$page', pos='$pos', params='$params'");
  }
  
  
  /** Dump parameters to a table.
   */
  function dump()
  {
    $plugentr = array();

    // copy over properties
    $props = array('active', 'name', 'params', 'description', 'version', 'type', 'pos');
    foreach ($props as $prop)
    {
      if (isset($this->$prop))
      {
        $plugentr[$prop] =  stripslashes_recurse($this->$prop);
      }
    }    
    return $plugentr;
  }
  
}
  
?>