1: <?php
  2: /**
  3:  * XOOPS user handler
  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: 
 19: defined('XOOPS_ROOT_PATH') || exit('Restricted access');
 20: 
 21: /**
 22:  * Class for users
 23:  * @author              Kazumi Ono <onokazu@xoops.org>
 24:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 25:  * @package             kernel
 26:  */
 27: class XoopsUser extends XoopsObject
 28: {
 29:     /**
 30:      * Array of groups that user belongs to
 31:      * @var array
 32:      * @access private
 33:      */
 34:     public $_groups = array();
 35:     /**
 36:      * @var bool is the user admin?
 37:      * @access private
 38:      */
 39:     public $_isAdmin;
 40:     /**
 41:      * @var string user's rank
 42:      * @access private
 43:      */
 44:     public $_rank;
 45:     /**
 46:      * @var bool is the user online?
 47:      * @access private
 48:      */
 49:     public $_isOnline;
 50: 
 51:     /**
 52:      * constructor
 53:      * @param array|null $id ID of the user to be loaded from the database.
 54:      */
 55:     public function __construct($id = null)
 56:     {
 57:         $this->initVar('uid', XOBJ_DTYPE_INT, null, false);
 58:         $this->initVar('name', XOBJ_DTYPE_TXTBOX, null, false, 60);
 59:         $this->initVar('uname', XOBJ_DTYPE_TXTBOX, null, true, 25);
 60:         $this->initVar('email', XOBJ_DTYPE_TXTBOX, null, true, 60);
 61:         $this->initVar('url', XOBJ_DTYPE_TXTBOX, null, false, 100);
 62:         $this->initVar('user_avatar', XOBJ_DTYPE_TXTBOX, null, false, 30);
 63:         $this->initVar('user_regdate', XOBJ_DTYPE_INT, null, false);
 64:         $this->initVar('user_icq', XOBJ_DTYPE_TXTBOX, null, false, 15);
 65:         $this->initVar('user_from', XOBJ_DTYPE_TXTBOX, null, false, 100);
 66:         $this->initVar('user_sig', XOBJ_DTYPE_TXTAREA, null, false, null);
 67:         $this->initVar('user_viewemail', XOBJ_DTYPE_INT, 0, false);
 68:         $this->initVar('actkey', XOBJ_DTYPE_OTHER, null, false);
 69:         $this->initVar('user_aim', XOBJ_DTYPE_TXTBOX, null, false, 18);
 70:         $this->initVar('user_yim', XOBJ_DTYPE_TXTBOX, null, false, 25);
 71:         $this->initVar('user_msnm', XOBJ_DTYPE_TXTBOX, null, false, 100);
 72:         $this->initVar('pass', XOBJ_DTYPE_TXTBOX, null, false, 255);
 73:         $this->initVar('posts', XOBJ_DTYPE_INT, null, false);
 74:         $this->initVar('attachsig', XOBJ_DTYPE_INT, 0, false);
 75:         $this->initVar('rank', XOBJ_DTYPE_INT, 0, false);
 76:         $this->initVar('level', XOBJ_DTYPE_INT, 0, false);
 77:         $this->initVar('theme', XOBJ_DTYPE_OTHER, null, false);
 78:         $this->initVar('timezone_offset', XOBJ_DTYPE_OTHER, '0.0', false);
 79:         $this->initVar('last_login', XOBJ_DTYPE_INT, 0, false);
 80:         $this->initVar('umode', XOBJ_DTYPE_OTHER, null, false);
 81:         $this->initVar('uorder', XOBJ_DTYPE_INT, 1, false);
 82:         // RMV-NOTIFY
 83:         $this->initVar('notify_method', XOBJ_DTYPE_OTHER, 1, false);
 84:         $this->initVar('notify_mode', XOBJ_DTYPE_OTHER, 0, false);
 85:         $this->initVar('user_occ', XOBJ_DTYPE_TXTBOX, null, false, 100);
 86:         $this->initVar('bio', XOBJ_DTYPE_TXTAREA, null, false, null);
 87:         $this->initVar('user_intrest', XOBJ_DTYPE_TXTBOX, null, false, 150);
 88:         $this->initVar('user_mailok', XOBJ_DTYPE_INT, 1, false);
 89:         // for backward compatibility
 90:         if (isset($id)) {
 91:             if (is_array($id)) {
 92:                 $this->assignVars($id);
 93:             } else {
 94:                 /* @var $member_handler XoopsMemberHandler */
 95:                 $member_handler = xoops_getHandler('member');
 96:                 $user           = $member_handler->getUser($id);
 97:                 foreach ($user->vars as $k => $v) {
 98:                     $this->assignVar($k, $v['value']);
 99:                 }
100:             }
101:         }
102:     }
103: 
104:     /**
105:      * check if the user is a guest user
106:      *
107:      * @return bool returns false
108:      *
109:      */
110:     public function isGuest()
111:     {
112:         return false;
113:     }
114: 
115:     /**
116:      * Updated by Catzwolf 11 Jan 2004
117:      * find the username for a given ID
118:      *
119:      * @param  int $userid  ID of the user to find
120:      * @param  int $usereal switch for usename or realname
121:      * @return string name of the user. name for 'anonymous' if not found.
122:      */
123:     public static function getUnameFromId($userid, $usereal = 0)
124:     {
125:         $userid  = (int)$userid;
126:         $usereal = (int)$usereal;
127:         if ($userid > 0) {
128:             /* @var $member_handler XoopsMemberHandler */
129:             $member_handler = xoops_getHandler('member');
130:             $user           = $member_handler->getUser($userid);
131:             if (is_object($user)) {
132:                 $ts = MyTextSanitizer::getInstance();
133:                 if ($usereal) {
134:                     $name = $user->getVar('name');
135:                     if ($name != '') {
136:                         return $ts->htmlSpecialChars($name);
137:                     } else {
138:                         return $ts->htmlSpecialChars($user->getVar('uname'));
139:                     }
140:                 } else {
141:                     return $ts->htmlSpecialChars($user->getVar('uname'));
142:                 }
143:             }
144:         }
145: 
146:         return $GLOBALS['xoopsConfig']['anonymous'];
147:     }
148: 
149:     /**
150:      * increase the number of posts for the user
151:      *
152:      * @deprecated
153:      */
154:     public function incrementPost()
155:     {
156:         /* @var $member_handler XoopsMemberHandler */
157:         $member_handler = xoops_getHandler('member');
158: 
159:         return $member_handler->updateUserByField($this, 'posts', $this->getVar('posts') + 1);
160:     }
161: 
162:     /**
163:      * set the groups for the user
164:      *
165:      * @param array $groupsArr Array of groups that user belongs to
166:      */
167:     public function setGroups($groupsArr)
168:     {
169:         if (is_array($groupsArr)) {
170:             $this->_groups =& $groupsArr;
171:         }
172:     }
173: 
174:     /**
175:      * get the groups that the user belongs to
176:      *
177:      * @return array array of groups
178:      */
179:     public function &getGroups()
180:     {
181:         if (empty($this->_groups)) {
182:             /* @var $member_handler XoopsMemberHandler */
183:             $member_handler = xoops_getHandler('member');
184:             $this->_groups  = $member_handler->getGroupsByUser($this->getVar('uid'));
185:         }
186: 
187:         return $this->_groups;
188:     }
189: 
190:     /**
191:      * alias for {@link getGroups()}
192:      * @see getGroups()
193:      * @return array array of groups
194:      * @deprecated
195:      */
196:     public function &groups()
197:     {
198:         $groups =& $this->getGroups();
199: 
200:         return $groups;
201:     }
202: 
203:     /**
204:      * Is the user admin ?
205:      *
206:      * This method will return true if this user has admin rights for the specified module.<br>
207:      * - If you don't specify any module ID, the current module will be checked.<br>
208:      * - If you set the module_id to -1, it will return true if the user has admin rights for at least one module
209:      *
210:      * @param  int $module_id check if user is admin of this module
211:      * @return bool is the user admin of that module?
212:      */
213:     public function isAdmin($module_id = null)
214:     {
215:         if (null === $module_id) {
216:             $module_id = (isset($GLOBALS['xoopsModule']) && is_object($GLOBALS['xoopsModule'])) ? $GLOBALS['xoopsModule']->getVar('mid', 'n') : 1;
217:         } elseif ((int)$module_id < 1) {
218:             $module_id = 0;
219:         }
220:         /* @var $moduleperm_handler XoopsGroupPermHandler  */
221:         $moduleperm_handler = xoops_getHandler('groupperm');
222: 
223:         return $moduleperm_handler->checkRight('module_admin', $module_id, $this->getGroups());
224:     }
225: 
226:     /**
227:      * get the user's rank
228:      * @return array array of rank ID and title
229:      */
230:     public function rank()
231:     {
232:         if (!isset($this->_rank)) {
233:             $this->_rank = xoops_getrank($this->getVar('rank'), $this->getVar('posts'));
234:         }
235: 
236:         return $this->_rank;
237:     }
238: 
239:     /**
240:      * is the user activated?
241:      * @return bool
242:      */
243:     public function isActive()
244:     {
245:         return !($this->getVar('level') == 0);
246:     }
247: 
248:     /**
249:      * is the user currently logged in?
250:      * @return bool
251:      */
252:     public function isOnline()
253:     {
254:         if (!isset($this->_isOnline)) {
255:             /* @var $online_handler XoopsOnlineHandler  */
256:             $onlinehandler   = xoops_getHandler('online');
257:             $this->_isOnline = ($onlinehandler->getCount(new Criteria('online_uid', $this->getVar('uid'))) > 0);// ? true : false;
258:         }
259: 
260:         return $this->_isOnline;
261:     }
262: 
263:     /**
264:      * get the users UID
265:      * @param  string $format
266:      * @return int
267:      */
268:     public function uid($format = '')
269:     {
270:         return $this->getVar('uid', $format);
271:     }
272: 
273:     /**
274:      * get the users UID
275:      * @param  string $format
276:      * @return int
277:      */
278:     public function id($format = 'N')
279:     {
280:         return $this->getVar('uid', $format);
281:     }
282: 
283:     /**
284:      * get the users name
285:      * @param  string $format format for the output, see {@link XoopsObject::getVar($format = '')}
286:      * @return string
287:      */
288:     public function name($format = 'S')
289:     {
290:         return $this->getVar('name', $format);
291:     }
292: 
293:     /**
294:      * get the user's uname
295:      * @param  string $format format for the output, see {@link XoopsObject::getVar($format = '')}
296:      * @return string
297:      */
298:     public function uname($format = 'S')
299:     {
300:         return $this->getVar('uname', $format);
301:     }
302: 
303:     /**
304:      * get the user's email
305:      *
306:      * @param  string $format format for the output, see {@link XoopsObject::getVar($format = '')}
307:      * @return string
308:      */
309:     public function email($format = 'S')
310:     {
311:         return $this->getVar('email', $format);
312:     }
313: 
314:     /**
315:      * @param string $format
316:      *
317:      * @return mixed
318:      */
319:     public function url($format = 'S')
320:     {
321:         return $this->getVar('url', $format);
322:     }
323: 
324:     /**
325:      * @param string $format
326:      *
327:      * @return mixed
328:      */
329:     public function user_avatar($format = 'S')
330:     {
331:         return $this->getVar('user_avatar', $format);
332:     }
333: 
334:     /**
335:      * @param string $format
336:      *
337:      * @return mixed
338:      */
339:     public function user_regdate($format = '')
340:     {
341:         return $this->getVar('user_regdate', $format);
342:     }
343: 
344:     /**
345:      * @param string $format
346:      *
347:      * @return mixed
348:      */
349:     public function user_icq($format = 'S')
350:     {
351:         return $this->getVar('user_icq', $format);
352:     }
353: 
354:     /**
355:      * @param string $format
356:      *
357:      * @return mixed
358:      */
359:     public function user_from($format = 'S')
360:     {
361:         return $this->getVar('user_from', $format);
362:     }
363: 
364:     /**
365:      * @param string $format
366:      *
367:      * @return mixed
368:      */
369:     public function user_sig($format = 'S')
370:     {
371:         return $this->getVar('user_sig', $format);
372:     }
373: 
374:     /**
375:      * @param string $format
376:      *
377:      * @return mixed
378:      */
379:     public function user_viewemail($format = '')
380:     {
381:         return $this->getVar('user_viewemail', $format);
382:     }
383: 
384:     /**
385:      * @param string $format
386:      *
387:      * @return mixed
388:      */
389:     public function actkey($format = '')
390:     {
391:         return $this->getVar('actkey', $format);
392:     }
393: 
394:     /**
395:      * @param string $format
396:      *
397:      * @return mixed
398:      */
399:     public function user_aim($format = 'S')
400:     {
401:         return $this->getVar('user_aim', $format);
402:     }
403: 
404:     /**
405:      * @param string $format
406:      *
407:      * @return mixed
408:      */
409:     public function user_yim($format = 'S')
410:     {
411:         return $this->getVar('user_yim', $format);
412:     }
413: 
414:     /**
415:      * @param string $format
416:      *
417:      * @return mixed
418:      */
419:     public function user_msnm($format = 'S')
420:     {
421:         return $this->getVar('user_msnm', $format);
422:     }
423: 
424:     /**
425:      * @param string $format
426:      *
427:      * @return mixed
428:      */
429:     public function pass($format = '')
430:     {
431:         return $this->getVar('pass', $format);
432:     }
433: 
434:     /**
435:      * @param string $format
436:      *
437:      * @return mixed
438:      */
439:     public function posts($format = '')
440:     {
441:         return $this->getVar('posts', $format);
442:     }
443: 
444:     /**
445:      * @param string $format
446:      *
447:      * @return mixed
448:      */
449:     public function attachsig($format = '')
450:     {
451:         return $this->getVar('attachsig', $format);
452:     }
453: 
454:     /**
455:      * @param string $format
456:      *
457:      * @return mixed
458:      */
459:     public function level($format = '')
460:     {
461:         return $this->getVar('level', $format);
462:     }
463: 
464:     /**
465:      * @param string $format
466:      *
467:      * @return mixed
468:      */
469:     public function theme($format = '')
470:     {
471:         return $this->getVar('theme', $format);
472:     }
473: 
474:     /**
475:      * @param string $format
476:      *
477:      * @return mixed
478:      */
479:     public function timezone($format = '')
480:     {
481:         return $this->getVar('timezone_offset', $format);
482:     }
483: 
484:     /**
485:      * @param string $format
486:      *
487:      * @return mixed
488:      */
489:     public function umode($format = '')
490:     {
491:         return $this->getVar('umode', $format);
492:     }
493: 
494:     /**
495:      * @param string $format
496:      *
497:      * @return mixed
498:      */
499:     public function uorder($format = '')
500:     {
501:         return $this->getVar('uorder', $format);
502:     }
503: 
504:     // RMV-NOTIFY
505:     /**
506:      * @param string $format
507:      *
508:      * @return mixed
509:      */
510:     public function notify_method($format = '')
511:     {
512:         return $this->getVar('notify_method', $format);
513:     }
514: 
515:     /**
516:      * @param string $format
517:      *
518:      * @return mixed
519:      */
520:     public function notify_mode($format = '')
521:     {
522:         return $this->getVar('notify_mode', $format);
523:     }
524: 
525:     /**
526:      * @param string $format
527:      *
528:      * @return mixed
529:      */
530:     public function user_occ($format = 'S')
531:     {
532:         return $this->getVar('user_occ', $format);
533:     }
534: 
535:     /**
536:      * @param string $format
537:      *
538:      * @return mixed
539:      */
540:     public function bio($format = 'S')
541:     {
542:         return $this->getVar('bio', $format);
543:     }
544: 
545:     /**
546:      * @param string $format
547:      *
548:      * @return mixed
549:      */
550:     public function user_intrest($format = 'S')
551:     {
552:         return $this->getVar('user_intrest', $format);
553:     }
554:     /**#@-*/
555: 
556:     /**#@+
557:      * @deprecated
558:      */
559:     public function getProfile()
560:     {
561:         trigger_error(__CLASS__ . '::' . __FUNCTION__ . ' is deprecated', E_USER_WARNING);
562: 
563:         return false;
564:     }
565:     /**#@-*/
566: }
567: 
568: /**
569:  * Class that represents a guest user
570:  * @author              Kazumi Ono <onokazu@xoops.org>
571:  * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
572:  * @package             kernel
573:  */
574: class XoopsGuestUser extends XoopsUser
575: {
576:     /**
577:      * check if the user is a guest user
578:      *
579:      * @return bool returns true
580:      *
581:      */
582:     public function isGuest()
583:     {
584:         return true;
585:     }
586: }
587: 
588: /**
589:  * XOOPS user handler class.
590:  * This class is responsible for providing data access mechanisms to the data source
591:  * of XOOPS user class objects.
592:  *
593:  * @author  Kazumi Ono <onokazu@xoops.org>
594:  * @author  Taiwen Jiang <phppp@users.sourceforge.net>
595:  * @package kernel
596:  */
597: class XoopsUserHandler extends XoopsPersistableObjectHandler
598: {
599:     /**
600:      * @param XoopsDatabase|null| $db
601:      */
602:     public function __construct(XoopsDatabase $db)
603:     {
604:         parent::__construct($db, 'users', 'XoopsUser', 'uid', 'uname');
605:     }
606: 
607:     /**#@+
608:      * @deprecated
609:      * @param bool $uname
610:      * @param      $pwd
611:      * @param bool $md5
612:      * @return bool|object
613:      */
614:     public function &loginUser($uname, $pwd, $md5 = false)
615:     {
616:         trigger_error(__CLASS__ . '::' . __FUNCTION__ . ' is deprecated', E_USER_WARNING);
617: 
618:         return false;
619:     }
620: 
621:     /**
622:      * @param $fieldName
623:      * @param $fieldValue
624:      * @param $uid
625:      *
626:      * @return bool
627:      */
628:     public function updateUserByField($fieldName, $fieldValue, $uid)
629:     {
630:         trigger_error(__CLASS__ . '::' . __FUNCTION__ . ' is deprecated', E_USER_WARNING);
631: 
632:         return false;
633:     }
634:     /**#@-*/
635: }
636: