1: <?php
  2: /**
  3:  * XOOPS Kernel Class
  4:  *
  5:  * You may not change or alter any portion of this comment or credits
  6:  * of supporting developers from this source code or any supporting source code
  7:  * which is considered copyrighted (c) material of the original comment or credit authors.
  8:  * This program is distributed in the hope that it will be useful,
  9:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 11:  *
 12:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 13:  * @license             GNU GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
 14:  * @package             kernel
 15:  * @since               2.0.0
 16:  * @author              Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
 17:  */
 18: defined('XOOPS_ROOT_PATH') || exit('Restricted access');
 19: 
 20: /**#@+
 21:  * Config type
 22:  */
 23: define('XOOPS_CONF', 1);
 24: define('XOOPS_CONF_USER', 2);
 25: define('XOOPS_CONF_METAFOOTER', 3);
 26: define('XOOPS_CONF_CENSOR', 4);
 27: define('XOOPS_CONF_SEARCH', 5);
 28: define('XOOPS_CONF_MAILER', 6);
 29: define('XOOPS_CONF_AUTH', 7);
 30: /**#@-*/
 31: 
 32: /**
 33:  *
 34:  *
 35:  * @author              Kazumi Ono    <onokazu@xoops.org>
 36:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 37:  */
 38: class XoopsConfigItem extends XoopsObject
 39: {
 40:     /**
 41:      * Config options
 42:      *
 43:      * @var array
 44:      * @access    private
 45:      */
 46:     public $_confOptions = array();
 47: 
 48:     /**
 49:      * Constructor
 50:      */
 51:     public function __construct()
 52:     {
 53:         $this->initVar('conf_id', XOBJ_DTYPE_INT, null, false);
 54:         $this->initVar('conf_modid', XOBJ_DTYPE_INT, null, false);
 55:         $this->initVar('conf_catid', XOBJ_DTYPE_INT, null, false);
 56:         $this->initVar('conf_name', XOBJ_DTYPE_OTHER);
 57:         $this->initVar('conf_title', XOBJ_DTYPE_TXTBOX);
 58:         $this->initVar('conf_value', XOBJ_DTYPE_TXTAREA);
 59:         $this->initVar('conf_desc', XOBJ_DTYPE_OTHER);
 60:         $this->initVar('conf_formtype', XOBJ_DTYPE_OTHER);
 61:         $this->initVar('conf_valuetype', XOBJ_DTYPE_OTHER);
 62:         $this->initVar('conf_order', XOBJ_DTYPE_INT);
 63:     }
 64: 
 65:     /**
 66:      * Returns Class Base Variable conf_id
 67:      * @param  string $format
 68:      * @return mixed
 69:      */
 70:     public function id($format = 'N')
 71:     {
 72:         return $this->getVar('conf_id', $format);
 73:     }
 74: 
 75:     /**
 76:      * Returns Class Base Variable conf_id
 77:      * @param  string $format
 78:      * @return mixed
 79:      */
 80:     public function conf_id($format = '')
 81:     {
 82:         return $this->getVar('conf_id', $format);
 83:     }
 84: 
 85:     /**
 86:      * Returns Class Base Variable conf_modid
 87:      * @param  string $format
 88:      * @return mixed
 89:      */
 90:     public function conf_modid($format = '')
 91:     {
 92:         return $this->getVar('conf_modid', $format);
 93:     }
 94: 
 95:     /**
 96:      * Returns Class Base Variable conf_catid
 97:      * @param  string $format
 98:      * @return mixed
 99:      */
100:     public function conf_catid($format = '')
101:     {
102:         return $this->getVar('conf_catid', $format);
103:     }
104: 
105:     /**
106:      * Returns Class Base Variable conf_name
107:      * @param  string $format
108:      * @return mixed
109:      */
110:     public function conf_name($format = '')
111:     {
112:         return $this->getVar('conf_name', $format);
113:     }
114: 
115:     /**
116:      * Returns Class Base Variable conf_title
117:      * @param  string $format
118:      * @return mixed
119:      */
120:     public function conf_title($format = '')
121:     {
122:         return $this->getVar('conf_title', $format);
123:     }
124: 
125:     /**
126:      * Returns Class Base Variable conf_value
127:      * @param  string $format
128:      * @return mixed
129:      */
130:     public function conf_value($format = '')
131:     {
132:         return $this->getVar('conf_value', $format);
133:     }
134: 
135:     /**
136:      * Returns Class Base Variable conf_desc
137:      * @param  string $format
138:      * @return mixed
139:      */
140:     public function conf_desc($format = '')
141:     {
142:         return $this->getVar('conf_desc', $format);
143:     }
144: 
145:     /**
146:      * Returns Class Base Variable conf_formtype
147:      * @param  string $format
148:      * @return mixed
149:      */
150:     public function conf_formtype($format = '')
151:     {
152:         return $this->getVar('conf_formtype', $format);
153:     }
154: 
155:     /**
156:      * Returns Class Base Variable conf_valuetype
157:      * @param  string $format
158:      * @return mixed
159:      */
160:     public function conf_valuetype($format = '')
161:     {
162:         return $this->getVar('conf_valuetype', $format);
163:     }
164: 
165:     /**
166:      * Returns Class Base Variable conf_order
167:      * @param  string $format
168:      * @return mixed
169:      */
170:     public function conf_order($format = '')
171:     {
172:         return $this->getVar('conf_order', $format);
173:     }
174: 
175:     /**
176:      * Get a config value in a format ready for output
177:      *
178:      * @return string
179:      */
180:     public function getConfValueForOutput()
181:     {
182:         switch ($this->getVar('conf_valuetype')) {
183:             case 'int':
184:                 return (int)$this->getVar('conf_value', 'N');
185:                 break;
186:             case 'array':
187:                 $value = @unserialize($this->getVar('conf_value', 'N'));
188: 
189:                 return $value ?: array();
190:             case 'float':
191:                 $value = $this->getVar('conf_value', 'N');
192: 
193:                 return (float)$value;
194:                 break;
195:             case 'textarea':
196:                 return $this->getVar('conf_value');
197:             default:
198:                 return $this->getVar('conf_value', 'N');
199:                 break;
200:         }
201:     }
202: 
203:     /**
204:      * Set a config value
205:      *
206:      * @param mixed &$value Value
207:      * @param bool  $force_slash
208:      */
209:     public function setConfValueForInput(&$value, $force_slash = false)
210:     {
211:         switch ($this->getVar('conf_valuetype')) {
212:             case 'array':
213:                 if (!is_array($value)) {
214:                     $value = explode('|', trim($value));
215:                 }
216:                 $this->setVar('conf_value', serialize($value), $force_slash);
217:                 break;
218:             case 'text':
219:                 $this->setVar('conf_value', trim($value), $force_slash);
220:                 break;
221:             default:
222:                 $this->setVar('conf_value', $value, $force_slash);
223:                 break;
224:         }
225:     }
226: 
227:     /**
228:      * Assign one or more {@link XoopsConfigItemOption}s
229:      *
230:      * @param mixed $option either a {@link XoopsConfigItemOption} object or an array of them
231:      */
232:     public function setConfOptions($option)
233:     {
234:         if (is_array($option)) {
235:             $count = count($option);
236:             for ($i = 0; $i < $count; ++$i) {
237:                 $this->setConfOptions($option[$i]);
238:             }
239:         } else {
240:             if (is_object($option)) {
241:                 $this->_confOptions[] =& $option;
242:             }
243:         }
244:     }
245: 
246:     /**
247:      * Get the {@link XoopsConfigItemOption}s of this Config
248:      *
249:      * @return array array of {@link XoopsConfigItemOption}
250:      */
251:     public function &getConfOptions()
252:     {
253:         return $this->_confOptions;
254:     }
255: 
256:     /**
257:      * Clear options from this item
258:      *
259:      * @return void
260:      **/
261:     public function clearConfOptions()
262:     {
263:         $this->_confOptions = array();
264:     }
265: }
266: 
267: /**
268:  * XOOPS configuration handler class.
269:  *
270:  * This class is responsible for providing data access mechanisms to the data source
271:  * of XOOPS configuration class objects.
272:  *
273:  * @author              Kazumi Ono <onokazu@xoops.org>
274:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
275:  */
276: class XoopsConfigItemHandler extends XoopsObjectHandler
277: {
278:     /**
279:      * Create a new {@link XoopsConfigItem}
280:      *
281:      * @see     XoopsConfigItem
282:      * @param  bool $isNew Flag the config as "new"?
283:      * @return XoopsConfigItem reference to the new config
284:      */
285:     public function create($isNew = true)
286:     {
287:         $config = new XoopsConfigItem();
288:         if ($isNew) {
289:             $config->setNew();
290:         }
291: 
292:         return $config;
293:     }
294: 
295:     /**
296:      * Load a config from the database
297:      *
298:      * @param  int $id ID of the config
299:      * @return XoopsConfigItem reference to the config, FALSE on fail
300:      */
301:     public function get($id)
302:     {
303:         $config = false;
304:         $id     = (int)$id;
305:         if ($id > 0) {
306:             $sql = 'SELECT * FROM ' . $this->db->prefix('config') . ' WHERE conf_id=' . $id;
307:             if (!$result = $this->db->query($sql)) {
308:                 return $config;
309:             }
310:             $numrows = $this->db->getRowsNum($result);
311:             if ($numrows == 1) {
312:                 $myrow  = $this->db->fetchArray($result);
313:                 $config = new XoopsConfigItem();
314:                 $config->assignVars($myrow);
315:             }
316:         }
317: 
318:         return $config;
319:     }
320: 
321:     /**
322:      * Write a config to the database
323:      *
324:      * @param XoopsObject|XoopsConfigItem $config a XoopsConfigCategory object
325:      *
326:      * @return bool true on success, otherwise false
327:      */
328:     public function insert(XoopsObject $config)
329:     {
330:         $className = 'XoopsConfigItem';
331:         if (!($config instanceof $className)) {
332:             return false;
333:         }
334:         if (!$config->isDirty()) {
335:             return true;
336:         }
337:         if (!$config->cleanVars()) {
338:             return false;
339:         }
340: 
341:         $conf_id = $config->getVar('conf_id', 'n');
342:         $conf_modid = $config->getVar('conf_modid', 'n');
343:         $conf_catid = $config->getVar('conf_catid', 'n');
344:         $conf_name = $config->getVar('conf_name', 'n');
345:         $conf_title = $config->getVar('conf_title', 'n');
346:         $conf_value = $config->getVar('conf_value', 'n');
347:         $conf_desc = $config->getVar('conf_desc', 'n');
348:         $conf_formtype = $config->getVar('conf_formtype', 'n');
349:         $conf_valuetype = $config->getVar('conf_valuetype', 'n');
350:         $conf_order = $config->getVar('conf_order', 'n');
351: 
352:         if ($config->isNew()) {
353:             $conf_id = $this->db->genId('config_conf_id_seq');
354:             $sql     = sprintf('INSERT INTO %s (conf_id, conf_modid, conf_catid, conf_name, conf_title, conf_value, conf_desc, conf_formtype, conf_valuetype, conf_order) VALUES (%u, %u, %u, %s, %s, %s, %s, %s, %s, %u)', $this->db->prefix('config'), $conf_id, $conf_modid, $conf_catid, $this->db->quoteString($conf_name), $this->db->quoteString($conf_title), $this->db->quoteString($conf_value), $this->db->quoteString($conf_desc), $this->db->quoteString($conf_formtype), $this->db->quoteString($conf_valuetype), $conf_order);
355:         } else {
356:             $sql = sprintf('UPDATE %s SET conf_modid = %u, conf_catid = %u, conf_name = %s, conf_title = %s, conf_value = %s, conf_desc = %s, conf_formtype = %s, conf_valuetype = %s, conf_order = %u WHERE conf_id = %u', $this->db->prefix('config'), $conf_modid, $conf_catid, $this->db->quoteString($conf_name), $this->db->quoteString($conf_title), $this->db->quoteString($conf_value), $this->db->quoteString($conf_desc), $this->db->quoteString($conf_formtype), $this->db->quoteString($conf_valuetype), $conf_order, $conf_id);
357:         }
358:         if (!$result = $this->db->query($sql)) {
359:             return false;
360:         }
361:         if (empty($conf_id)) {
362:             $conf_id = $this->db->getInsertId();
363:         }
364:         $config->assignVar('conf_id', $conf_id);
365: 
366:         return true;
367:     }
368: 
369:     /**
370:      * Delete a config from the database
371:      *
372:      * @param XoopsObject|XoopsConfigItem $config a XoopsConfigCategory object
373:      *
374:      * @return bool true on success, otherwise false
375:      */
376:     public function delete(XoopsObject $config)
377:     {
378:         $className = 'XoopsConfigItem';
379:         if (!($config instanceof $className)) {
380:             return false;
381:         }
382:         $sql = sprintf('DELETE FROM %s WHERE conf_id = %u', $this->db->prefix('config'), $config->getVar('conf_id'));
383:         if (!$result = $this->db->query($sql)) {
384:             return false;
385:         }
386: 
387:         return true;
388:     }
389: 
390:     /**
391:      * Get configs from the database
392:      *
393:      * @param  CriteriaElement|CriteriaCompo $criteria  {@link CriteriaElement}
394:      * @param  bool            $id_as_key return the config's id as key?
395:      * @return array           Array of {@link XoopsConfigItem} objects
396:      */
397:     public function getObjects(CriteriaElement $criteria = null, $id_as_key = false)
398:     {
399:         $ret   = array();
400:         $limit = $start = 0;
401:         $sql   = 'SELECT * FROM ' . $this->db->prefix('config');
402:         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
403:             $sql .= ' ' . $criteria->renderWhere();
404:             $sql .= ' ORDER BY conf_order ASC';
405:             $limit = $criteria->getLimit();
406:             $start = $criteria->getStart();
407:         }
408:         $result = $this->db->query($sql, $limit, $start);
409:         if (!$result) {
410:             return false;
411:         }
412:         while ($myrow = $this->db->fetchArray($result)) {
413:             $config = new XoopsConfigItem();
414:             $config->assignVars($myrow);
415:             if (!$id_as_key) {
416:                 $ret[] =& $config;
417:             } else {
418:                 $ret[$myrow['conf_id']] = &$config;
419:             }
420:             unset($config);
421:         }
422: 
423:         return $ret;
424:     }
425: 
426:     /**
427:      * Count configs
428:      *
429:      * @param  CriteriaElement|CriteriaCompo $criteria {@link CriteriaElement}
430:      * @return int             Count of configs matching $criteria
431:      */
432:     public function getCount(CriteriaElement $criteria = null)
433:     {
434:         $sql   = 'SELECT * FROM ' . $this->db->prefix('config');
435:         if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) {
436:             $sql .= ' ' . $criteria->renderWhere();
437:         }
438:         $result = $this->db->query($sql);
439:         if (!$result) {
440:             return false;
441:         }
442:         list($count) = $this->db->fetchRow($result);
443: 
444:         return $count;
445:     }
446: }
447: