5 * Copyright 1999-2000, Tim Perdue/Sourceforge
6 * Copyright 2002, Tim Perdue/GForge, LLC
7 * Copyright 2009, Roland Mas
8 * Copyright (C) 2011 Alain Peyrat - Alcatel-Lucent
10 * This file is part of FusionForge. FusionForge is free software;
11 * you can redistribute it and/or modify it under the terms of the
12 * GNU General Public License as published by the Free Software
13 * Foundation; either version 2 of the Licence, or (at your option)
16 * FusionForge is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with FusionForge; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 require_once $gfcommon.'include/Error.class.php';
27 require_once $gfcommon.'forum/ForumMessage.class.php';
28 // This string is used when sending the notification mail for identifying the
30 define('FORUM_MAIL_MARKER', '#+#+#+#+#+#+#+#+#+#+#+#+#+#+#+#+#+');
33 * Gets a Forum object from its id
35 * @param int the Forum id
36 * @return object the Forum object
38 function &forum_get_object($forum_id) {
39 $res = db_query_params ('SELECT group_id FROM forum_group_list WHERE group_forum_id=$1',
41 if (!$res || db_numrows($res) < 1) {
45 $data = db_fetch_array($res);
46 $Group = group_get_object($data["group_id"]);
47 $f = new Forum ($Group, $forum_id);
49 $f->fetchData ($forum_id) ;
54 function forum_get_groupid ($forum_id) {
55 $res = db_query_params ('SELECT group_id FROM forum_group_list WHERE group_forum_id=$1',
57 if (!$res || db_numrows($res) < 1) {
60 $arr = db_fetch_array ($res);
61 return $arr['group_id'] ;
64 class Forum extends Error {
67 * Associative array of data from db.
69 * @var array $data_array.
78 var $Group; //group object
81 * An array of 'types' for this forum - nested, flat, ultimate, etc.
83 * @var array view_types.
90 * @param object The Group object to which this forum is associated.
91 * @param int The group_forum_id.
92 * @param array The associative array of data.
93 * @return boolean success.
95 function Forum(&$Group, $group_forum_id=false, $arr=false, $is_news=false) {
97 if (!$Group || !is_object($Group)) {
98 $this->setError(_('Forums: No Valid Group Object'));
101 if ($Group->isError()) {
102 $this->setError('Forums: '.$Group->getErrorMessage());
105 if (!$is_news && $group_forum_id) {
107 // Is this a news posting (or a real forum)?
109 $res = db_query_params('SELECT forum_id FROM news_bytes
111 array($group_forum_id));
112 $is_news = $res && db_numrows($res) >= 1;
114 if (!$is_news && !$Group->usesForum()) {
115 $this->setError(sprintf(_('%s does not use the Forum tool'),
116 $Group->getPublicName()));
119 $this->Group =& $Group;
121 if ($group_forum_id) {
122 if (!$arr || !is_array($arr)) {
123 if (!$this->fetchData($group_forum_id)) {
127 $this->data_array =& $arr;
128 if ($this->data_array['group_id'] != $this->Group->getID()) {
129 $this->setError(_('Group_id in db result does not match Group Object'));
130 $this->data_array = null;
135 // Make sure they can even access this object
138 !forge_check_perm ('forum', $this->getID(), 'read')) {
139 $this->setPermissionDeniedError();
140 $this->data_array = null;
144 $this->view_types[]='ultimate';
145 $this->view_types[]='flat';
146 $this->view_types[]='nested';
147 $this->view_types[]='threaded';
148 $this->is_news = $is_news;
153 * create - use this function to create a new entry in the database.
155 * @param string The name of the forum.
156 * @param string The description of the forum.
157 * @param int Pass (1) if it should be public (0) for private.
158 * @param string The email address to send all new posts to.
159 * @param int Pass (1) if a welcome message should be created (0) for no welcome message.
160 * @param int Pass (1) if we should allow non-logged-in users to post (0) for mandatory login.
161 * @param int Pass (0) if the messages that are posted in the forum should go to moderation before available. 0-> no moderation 1-> moderation for anonymous and non-project members 2-> moderation for everyone
162 * @return boolean success.
164 function create($forum_name,$description,$is_public=1,$send_all_posts_to='',$create_default_message=1,$allow_anonymous=1,$moderation_level=0) {
165 if (!$this->is_news && strlen($forum_name) < 3) {
166 $this->setError(_('Forum Name Must Be At Least 3 Characters'));
169 if (!$this->is_news && strlen($description) < 10) {
170 $this->setError(_('Forum Description Must Be At Least 10 Characters'));
173 if (!preg_match('/^([_\.0-9a-z-])*$/i',$forum_name)) {
174 $this->setError(_('Illegal Characters in Forum Name'));
177 if ($send_all_posts_to) {
178 $send_all_posts_to = str_replace(';', ',', $send_all_posts_to);
179 $invalid_mails = validate_emails($send_all_posts_to);
180 if (count($invalid_mails) > 0) {
181 $this->setInvalidEmailError($send_all_posts_to);
186 $project_name = $this->Group->getUnixName();
187 $result_list_samename = db_query_params ('SELECT 1 FROM mail_group_list WHERE list_name=$1 AND group_id=$2',
189 array ($project_name.'-'.strtolower($forum_name),
190 $this->Group->getID())) ;
192 if (db_numrows($result_list_samename) > 0){
193 $this->setError(_('Mailing List Exists with same name'));
198 // This is a hack to allow non-site-wide-admins to post
199 // news. The news/submit.php checks for proper permissions.
200 // This needs to be revisited.
202 if ($this->Group->getID() == forge_get_config('news_group')) {
203 // Future check will be added.
206 // Current permissions check.
208 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
209 $this->setPermissionDeniedError();
215 $result = db_query_params('INSERT INTO forum_group_list (group_id,forum_name,is_public,description,send_all_posts_to,allow_anonymous,moderation_level) VALUES ($1,$2,$3,$4,$5,$6,$7)',
216 array ($this->Group->getID(),
217 strtolower($forum_name),
219 htmlspecialchars($description),
222 $moderation_level)) ;
224 $this->setError(_('Error Adding Forum').db_error());
228 $this->group_forum_id=db_insertid($result,'forum_group_list','group_forum_id');
229 $this->fetchData($this->group_forum_id);
231 if ($create_default_message) {
232 $fm=new ForumMessage($this);
233 // Use the system side default language
234 setup_gettext_from_sys_lang ();
235 $string=sprintf(_('Welcome to %1$s'), $forum_name);
236 // and switch back to the user preference
237 setup_gettext_from_context();
238 if (!$fm->create($string, $string)) {
239 $this->setError($fm->getErrorMessage());
244 $this->Group->normalizeAllRoles () ;
250 * fetchData - re-fetch the data for this forum from the database.
252 * @param int The forum_id.
253 * @return boolean success.
255 function fetchData($group_forum_id) {
256 $res=db_query_params('SELECT * FROM forum_group_list_vw WHERE group_forum_id=$1 AND group_id=$2',
257 array($group_forum_id, $this->Group->getID()));
258 if (!$res || db_numrows($res) < 1) {
259 $this->setError(_('Invalid forum group identifier'));
262 $this->data_array = db_fetch_array($res);
263 db_free_result($res);
268 * getGroup - get the Group object this ArtifactType is associated with.
270 * @return object The Group object.
272 function &getGroup() {
277 * getID - The id of this forum.
279 * @return int The group_forum_id #.
282 return $this->data_array['group_forum_id'];
286 * getNextThreadID - The next thread_id for a new top in this forum.
288 * @return int The next thread_id #.
290 function getNextThreadID() {
291 $result = db_query_params ('SELECT nextval($1)',
292 array ('forum_thread_seq')) ;
293 if (!$result || db_numrows($result) < 1) {
297 return db_result($result,0,0);
301 * getUnixName - returns the name used by email gateway
303 * @return string unix name
305 function getUnixName() {
306 return $this->Group->getUnixName().'-'.$this->getName();
310 * getSavedDate - The unix time when the person last hit "save my place".
312 * @return int The unix time.
314 function getSavedDate() {
315 if (isset($this->save_date)) {
316 return $this->save_date;
318 if (session_loggedin()) {
319 $result = db_query_params ('SELECT save_date FROM forum_saved_place WHERE user_id=$1 AND forum_id=$2',
322 if ($result && db_numrows($result) > 0) {
323 $this->save_date=db_result($result,0,'save_date');
324 return $this->save_date;
326 //highlight new messages from the past week only
327 $this->save_date=(time()-604800);
328 return $this->save_date;
331 //highlight new messages from the past week only
332 $this->save_date=(time()-604800);
333 return $this->save_date;
339 * allowAnonymous - does this forum allow non-logged in users to post.
341 * @return boolean allow_anonymous.
343 function allowAnonymous() {
344 return $this->data_array['allow_anonymous'];
348 * isPublic - Is this forum open to the general public.
350 * @return boolean is_public.
352 function isPublic() {
353 return $this->data_array['is_public'];
357 * getName - get the name of this forum.
359 * @return string The name of this forum.
362 return $this->data_array['forum_name'];
366 * getSendAllPostsTo - an optional email address to send all forum posts to.
368 * @return string The email address.
370 function getSendAllPostsTo() {
371 return $this->data_array['send_all_posts_to'];
375 * getDescription - the description of this forum.
377 * @return string The description.
379 function getDescription() {
380 return $this->data_array['description'];
384 * getModerationLevel - the moderation level of the forum
386 * @return int The moderation level.
388 function getModerationLevel() {
389 return $this->data_array['moderation_level'];
393 * getMessageCount - the total number of messages in this forum.
395 * @return int The count.
397 function getMessageCount() {
398 return $this->data_array['total'];
402 * getThreadCount - the total number of threads in this forum.
404 * @return int The count.
406 function getThreadCount() {
407 return $this->data_array['threads'];
411 * getMostRecentDate - the most recent date of a post to this board.
413 * @return int The most recent date.
415 function getMostRecentDate() {
416 return $this->data_array['recent'];
420 * getMonitoringIDs - return an array of user_id's for those monitoring this forum.
422 * @return array The array of user_id's.
424 function getMonitoringIDs() {
425 $result = db_query_params ('SELECT user_id FROM forum_monitored_forums WHERE forum_id=$1',
426 array ($this->getID())) ;
427 return util_result_column_to_array($result);
431 * getReturnEmailAddress() - return the return email address for notification emails
433 * @return string return email address
435 function getReturnEmailAddress() {
438 if(forge_get_config('use_gateways')) {
439 $address .= $this->getUnixName();
441 $address .= 'noreply';
444 if(forge_get_config('use_gateways') && forge_get_config('forum_return_domain')) {
445 $address .= forge_get_config('forum_return_domain');
447 $address .= forge_get_config('web_host');
453 * setMonitor - Add the current user to the list of people monitoring the forum.
455 * @param int user id of the user which will be set to monitor this forum. Defaults to 0, meaning the current logged in user will be used.
456 * @return boolean success.
458 function setMonitor ($u = -1) {
460 if (!session_loggedin()) {
461 $this->setError(_('You can only monitor if you are logged in'));
467 $result = db_query_params ('SELECT * FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
470 if (!$result || db_numrows($result) < 1) {
472 User is not already monitoring thread, so
473 insert a row so monitoring can begin
475 $result = db_query_params ('INSERT INTO forum_monitored_forums (forum_id,user_id) VALUES ($1,$2)',
476 array ($this->getID(),
480 $this->setError(_('Unable To Add Monitor').' : '.db_error());
489 * stopMonitor - Remove the current user from the list of people monitoring the forum.
491 * @return boolean success.
493 function stopMonitor ($u = -1) {
495 if (!session_loggedin()) {
496 $this->setError(_('You can only monitor if you are logged in'));
501 return db_query_params ('DELETE FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
507 * isMonitoring - See if the current user is in the list of people monitoring the forum.
509 * @return boolean is_monitoring.
511 function isMonitoring() {
512 if (!session_loggedin()) {
515 $result = db_query_params ('SELECT count(*) AS count FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
518 $row_count = db_fetch_array($result);
519 return $result && $row_count['count'] > 0;
523 * savePlace - set a unix time into the database for this user, so future messages can be highlighted.
525 * @return boolean success.
527 function savePlace() {
528 if (!session_loggedin()) {
529 $this->setError(_('You Can Only Save Your Place If You Are Logged In'));
532 $result = db_query_params ('SELECT * FROM forum_saved_place WHERE user_id=$1 AND forum_id=$2',
536 if (!$result || db_numrows($result) < 1) {
538 User is not already monitoring thread, so
539 insert a row so monitoring can begin
541 $result = db_query_params ('INSERT INTO forum_saved_place (forum_id,user_id,save_date) VALUES ($1,$2,$3)',
542 array ($this->getID(),
547 $this->setError(_('Forum::savePlace()').': '.db_error());
552 $result = db_query_params ('UPDATE forum_saved_place SET save_date=$1 WHERE user_id=$2 AND forum_id=$3',
558 $this->setError('Forum::savePlace() '.db_error());
566 * update - use this function to update an entry in the database.
568 * @param string The name of the forum.
569 * @param string The description of the forum.
570 * @param int if it should be public (0) for private.
571 * @param int if we should allow non-logged-in users to post (0) for mandatory login.
572 * @param string The email address to send all new posts to.
573 * @param int if the messages that are posted in the forum should go to moderation before available. 0-> no moderation 1-> moderation for anonymous and non-project members 2-> moderation for everyone
574 * @return boolean success.
576 function update($forum_name,$description,$allow_anonymous,$is_public,$send_all_posts_to='',$moderation_level=0) {
577 if (strlen($forum_name) < 3) {
578 $this->setError(_('Forum Name Must Be At Least 3 Characters'));
581 if (strlen($description) < 10) {
582 $this->setError(_('Forum Description Must Be At Least 10 Characters'));
585 if (!preg_match('/^([_\.0-9a-z-])*$/i',$forum_name)) {
586 $this->setError(_('Illegal Characters in Forum Name'));
589 if ($send_all_posts_to) {
590 $send_all_posts_to = str_replace(';', ',', $send_all_posts_to);
591 $invalid_mails = validate_emails($send_all_posts_to);
592 if (count($invalid_mails) > 0) {
593 $this->setInvalidEmailError($send_all_posts_to);
598 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
599 $this->setPermissionDeniedError();
603 $res = db_query_params ('UPDATE forum_group_list SET
606 send_all_posts_to=$3,
611 AND group_forum_id=$8',
612 array (strtolower($forum_name),
613 htmlspecialchars($description),
618 $this->Group->getID(),
621 if (!$res || db_affected_rows($res) < 1) {
622 $this->setError(_('Error On Update:').': '.db_error());
629 * delete - delete this forum and all its related data.
631 * @param bool I'm Sure.
632 * @param bool I'm REALLY sure.
633 * @return bool true/false;
635 function delete($sure, $really_sure) {
636 if (!$sure || !$really_sure) {
637 $this->setMissingParamsError(_('Please tick all checkboxes.'));
640 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
641 $this->setPermissionDeniedError();
645 $result = db_query_params ('DELETE FROM forum_agg_msg_count WHERE group_forum_id=$1',
646 array ($this->getID())) ;
648 $this->setError(_('Error Deleting Forum').db_error());
653 $result = db_query_params ('DELETE FROM forum_monitored_forums WHERE forum_id=$1',
654 array ($this->getID())) ;
656 $this->setError(_('Error Deleting Forum').db_error());
661 $result = db_query_params ('DELETE FROM forum_saved_place WHERE forum_id=$1',
662 array ($this->getID())) ;
664 $this->setError(_('Error Deleting Forum').db_error());
669 $result = db_query_params ('DELETE FROM forum_attachment WHERE msg_id IN (SELECT msg_id from forum where group_forum_id=$1)',
670 array ($this->getID())) ;
671 db_query_params ('DELETE FROM forum WHERE group_forum_id=$1',
672 array ($this->getID())) ;
673 //echo '4'.db_error();
674 db_query_params ('DELETE FROM forum_group_list WHERE group_forum_id=$1',
675 array ($this->getID())) ;
676 //echo '5'.db_error();
679 $this->Group->normalizeAllRoles () ;
688 // c-file-style: "bsd"
projects / fusionforge / fusionforge.git / blob