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) {
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 $this->Group =& $Group;
107 if ($group_forum_id) {
108 if (!$arr || !is_array($arr)) {
109 if (!$this->fetchData($group_forum_id)) {
113 $this->data_array =& $arr;
114 if ($this->data_array['group_id'] != $this->Group->getID()) {
115 $this->setError(_('Group_id in db result does not match Group Object'));
116 $this->data_array = null;
121 // Make sure they can even access this object
123 if (!forge_check_perm ('forum', $this->getID(), 'read')) {
124 $this->setPermissionDeniedError();
125 $this->data_array = null;
129 $this->view_types[] = 'ultimate';
130 $this->view_types[] = 'flat';
131 $this->view_types[] = 'nested';
132 $this->view_types[] = 'threaded';
137 * create - use this function to create a new entry in the database.
139 * @param string The name of the forum.
140 * @param string The description of the forum.
141 * @param int Pass (1) if it should be public (0) for private.
142 * @param string The email address to send all new posts to.
143 * @param int Pass (1) if a welcome message should be created (0) for no welcome message.
144 * @param int Pass (1) if we should allow non-logged-in users to post (0) for mandatory login.
145 * @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
146 * @return boolean success.
148 function create($forum_name,$description,$is_public=1,$send_all_posts_to='',$create_default_message=1,$allow_anonymous=1,$moderation_level=0) {
149 if (strlen($forum_name) < 3) {
150 $this->setError(_('Forum Name Must Be At Least 3 Characters'));
153 if (strlen($description) < 10) {
154 $this->setError(_('Forum Description Must Be At Least 10 Characters'));
157 if (!preg_match('/^([_\.0-9a-z-])*$/i',$forum_name)) {
158 $this->setError(_('Illegal Characters in Forum Name'));
161 if ($send_all_posts_to) {
162 $send_all_posts_to = str_replace(';', ',', $send_all_posts_to);
163 $invalid_mails = validate_emails($send_all_posts_to);
164 if (count($invalid_mails) > 0) {
165 $this->setInvalidEmailError($send_all_posts_to);
170 $project_name = $this->Group->getUnixName();
171 $result_list_samename = db_query_params('SELECT 1 FROM mail_group_list WHERE list_name=$1 AND group_id=$2',
173 array($project_name.'-'.strtolower($forum_name),
174 $this->Group->getID()));
176 if (db_numrows($result_list_samename) > 0){
177 $this->setError(_('Mailing List Exists with same name'));
182 // This is a hack to allow non-site-wide-admins to post
183 // news. The news/submit.php checks for proper permissions.
184 // This needs to be revisited.
186 if ($this->Group->getID() == forge_get_config('news_group')) {
187 // Future check will be added.
190 // Current permissions check.
192 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
193 $this->setPermissionDeniedError();
199 $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)',
200 array($this->Group->getID(),
201 strtolower($forum_name),
203 htmlspecialchars($description),
208 $this->setError(_('Error Adding Forum:').' '.db_error());
212 $this->group_forum_id=db_insertid($result,'forum_group_list','group_forum_id');
213 $this->fetchData($this->group_forum_id);
215 if ($create_default_message) {
216 $fm=new ForumMessage($this);
217 // Use the system side default language
218 setup_gettext_from_sys_lang();
219 $string = sprintf(_('Welcome to %1$s'), $forum_name);
220 // and switch back to the user preference
221 setup_gettext_from_context();
222 if (!$fm->create($string, $string)) {
223 $this->setError($fm->getErrorMessage());
233 * fetchData - re-fetch the data for this forum from the database.
235 * @param int The forum_id.
236 * @return boolean success.
238 function fetchData($group_forum_id) {
239 $res=db_query_params('SELECT * FROM forum_group_list_vw WHERE group_forum_id=$1 AND group_id=$2',
240 array($group_forum_id, $this->Group->getID()));
241 if (!$res || db_numrows($res) < 1) {
242 $this->setError(_('Invalid forum group identifier'));
245 $this->data_array = db_fetch_array($res);
246 db_free_result($res);
251 * getGroup - get the Group object this ArtifactType is associated with.
253 * @return object The Group object.
255 function &getGroup() {
260 * getID - The id of this forum.
262 * @return int The group_forum_id #.
265 return $this->data_array['group_forum_id'];
269 * getNextThreadID - The next thread_id for a new top in this forum.
271 * @return int The next thread_id #.
273 function getNextThreadID() {
274 $result = db_query_params('SELECT nextval($1)',
275 array('forum_thread_seq'));
276 if (!$result || db_numrows($result) < 1) {
280 return db_result($result, 0, 0);
284 * getUnixName - returns the name used by email gateway
286 * @return string unix name
288 function getUnixName() {
289 return $this->Group->getUnixName().'-'.$this->getName();
293 * getSavedDate - The unix time when the person last hit "save my place".
295 * @return int The unix time.
297 function getSavedDate() {
298 if (isset($this->save_date)) {
299 return $this->save_date;
301 if (session_loggedin()) {
302 $result = db_query_params('SELECT save_date FROM forum_saved_place WHERE user_id=$1 AND forum_id=$2',
305 if ($result && db_numrows($result) > 0) {
306 $this->save_date=db_result($result, 0, 'save_date');
307 return $this->save_date;
309 //highlight new messages from the past week only
310 $this->save_date=(time()-604800);
311 return $this->save_date;
314 //highlight new messages from the past week only
315 $this->save_date=(time()-604800);
316 return $this->save_date;
322 * allowAnonymous - does this forum allow non-logged in users to post.
324 * @return boolean allow_anonymous.
326 function allowAnonymous() {
327 return $this->data_array['allow_anonymous'];
331 * isPublic - Is this forum open to the general public.
333 * @return boolean is_public.
335 function isPublic() {
336 return $this->data_array['is_public'];
340 * getName - get the name of this forum.
342 * @return string The name of this forum.
345 return $this->data_array['forum_name'];
349 * getSendAllPostsTo - an optional email address to send all forum posts to.
351 * @return string The email address.
353 function getSendAllPostsTo() {
354 return $this->data_array['send_all_posts_to'];
358 * getDescription - the description of this forum.
360 * @return string The description.
362 function getDescription() {
363 return $this->data_array['description'];
367 * getModerationLevel - the moderation level of the forum
369 * @return int The moderation level.
371 function getModerationLevel() {
372 return $this->data_array['moderation_level'];
376 * getMessageCount - the total number of messages in this forum.
378 * @return int The count.
380 function getMessageCount() {
381 return $this->data_array['total'];
385 * getThreadCount - the total number of threads in this forum.
387 * @return int The count.
389 function getThreadCount() {
390 return $this->data_array['threads'];
394 * getMostRecentDate - the most recent date of a post to this board.
396 * @return int The most recent date.
398 function getMostRecentDate() {
399 return $this->data_array['recent'];
403 * getMonitoringIDs - return an array of user_id's for those monitoring this forum.
405 * @return array The array of user_id's.
407 function getMonitoringIDs() {
408 $result = db_query_params('SELECT user_id FROM forum_monitored_forums WHERE forum_id=$1',
409 array($this->getID()));
410 return util_result_column_to_array($result);
414 * getReturnEmailAddress() - return the return email address for notification emails
416 * @return string return email address
418 function getReturnEmailAddress() {
420 if(forge_get_config('use_gateways')) {
421 $address = $this->getUnixName();
423 $address = 'noreply';
426 if(forge_get_config('use_gateways') && forge_get_config('forum_return_domain')) {
427 $address .= forge_get_config('forum_return_domain');
429 $address .= forge_get_config('web_host');
435 * setMonitor - Add the current user to the list of people monitoring the forum.
437 * @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.
438 * @return boolean success.
440 function setMonitor($u = -1) {
442 if (!session_loggedin()) {
443 $this->setError(_('You can only monitor if you are logged in'));
448 $result = db_query_params('SELECT * FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
451 if (!$result || db_numrows($result) < 1) {
453 User is not already monitoring thread, so
454 insert a row so monitoring can begin
456 $result = db_query_params('INSERT INTO forum_monitored_forums (forum_id,user_id) VALUES ($1,$2)',
457 array($this->getID(),
461 $this->setError(_('Unable To Add Monitor').' : '.db_error());
470 * stopMonitor - Remove the current user from the list of people monitoring the forum.
472 * @return boolean success.
474 function stopMonitor($u = -1) {
476 if (!session_loggedin()) {
477 $this->setError(_('You can only monitor if you are logged in'));
482 return db_query_params('DELETE FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
488 * isMonitoring - See if the current user is in the list of people monitoring the forum.
490 * @return boolean is_monitoring.
492 function isMonitoring() {
493 if (!session_loggedin()) {
496 $result = db_query_params('SELECT count(*) AS count FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
499 $row_count = db_fetch_array($result);
500 return $result && $row_count['count'] > 0;
504 * savePlace - set a unix time into the database for this user, so future messages can be highlighted.
506 * @return boolean success.
508 function savePlace() {
509 if (!session_loggedin()) {
510 $this->setError(_('You Can Only Save Your Place If You Are Logged In'));
513 $result = db_query_params('SELECT * FROM forum_saved_place WHERE user_id=$1 AND forum_id=$2',
517 if (!$result || db_numrows($result) < 1) {
519 User is not already monitoring thread, so
520 insert a row so monitoring can begin
522 $result = db_query_params('INSERT INTO forum_saved_place (forum_id,user_id,save_date) VALUES ($1,$2,$3)',
523 array($this->getID(),
528 $this->setError(_('Forum::savePlace()').': '.db_error());
533 $result = db_query_params('UPDATE forum_saved_place SET save_date=$1 WHERE user_id=$2 AND forum_id=$3',
539 $this->setError('Forum::savePlace() '.db_error());
547 * update - use this function to update an entry in the database.
549 * @param string The name of the forum.
550 * @param string The description of the forum.
551 * @param int if it should be public (0) for private.
552 * @param int if we should allow non-logged-in users to post (0) for mandatory login.
553 * @param string The email address to send all new posts to.
554 * @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
555 * @return boolean success.
557 function update($forum_name, $description, $allow_anonymous, $is_public, $send_all_posts_to = '', $moderation_level = 0) {
558 if (strlen($forum_name) < 3) {
559 $this->setError(_('Forum Name Must Be At Least 3 Characters'));
562 if (strlen($description) < 10) {
563 $this->setError(_('Forum Description Must Be At Least 10 Characters'));
566 if (!preg_match('/^([_\.0-9a-z-])*$/i',$forum_name)) {
567 $this->setError(_('Illegal Characters in Forum Name'));
570 if ($send_all_posts_to) {
571 $send_all_posts_to = str_replace(';', ',', $send_all_posts_to);
572 $invalid_mails = validate_emails($send_all_posts_to);
573 if (count($invalid_mails) > 0) {
574 $this->setInvalidEmailError($send_all_posts_to);
579 if (!forge_check_perm('forum_admin', $this->Group->getID())) {
580 $this->setPermissionDeniedError();
584 $res = db_query_params('UPDATE forum_group_list SET
587 send_all_posts_to=$3,
592 AND group_forum_id=$8',
593 array(strtolower($forum_name),
594 htmlspecialchars($description),
599 $this->Group->getID(),
602 if (!$res || db_affected_rows($res) < 1) {
603 $this->setError(_('Error On Update:').': '.db_error());
610 * delete - delete this forum and all its related data.
612 * @param bool I'm Sure.
613 * @param bool I'm REALLY sure.
614 * @return bool true/false;
616 function delete($sure, $really_sure) {
617 if (!$sure || !$really_sure) {
618 $this->setMissingParamsError(_('Please tick all checkboxes.'));
621 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
622 $this->setPermissionDeniedError();
626 $result = db_query_params('DELETE FROM forum_agg_msg_count WHERE group_forum_id=$1',
627 array($this->getID()));
629 $this->setError(_('Error Deleting Forum:').' '.db_error());
634 $result = db_query_params('DELETE FROM forum_monitored_forums WHERE forum_id=$1',
635 array($this->getID()));
637 $this->setError(_('Error Deleting Forum:').' '.db_error());
642 $result = db_query_params('DELETE FROM forum_saved_place WHERE forum_id=$1',
643 array($this->getID()));
645 $this->setError(_('Error Deleting Forum:').' '.db_error());
650 $result = db_query_params('DELETE FROM forum_attachment WHERE msg_id IN (SELECT msg_id from forum where group_forum_id=$1)',
651 array($this->getID()));
653 $this->setError(_('Error Deleting Forum:').' '.db_error());
658 $result = db_query_params('DELETE FROM forum WHERE group_forum_id=$1',
659 array($this->getID()));
661 $this->setError(_('Error Deleting Forum:').' '.db_error());
666 $result = db_query_params('DELETE FROM forum_group_list WHERE group_forum_id=$1',
667 array($this->getID()));
669 $this->setError(_('Error Deleting Forum:').' '.db_error());
676 $this->Group->normalizeAllRoles();
685 // c-file-style: "bsd"