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 string The email address to send all new posts to.
158 * @param int Pass (1) if a welcome message should be created (0) for no welcome message.
159 * @return boolean success.
161 function create($forum_name,$description,$send_all_posts_to='',$create_default_message=1) {
162 if (!$this->is_news && strlen($forum_name) < 3) {
163 $this->setError(_('Forum Name Must Be At Least 3 Characters'));
166 if (!$this->is_news && strlen($description) < 10) {
167 $this->setError(_('Forum Description Must Be At Least 10 Characters'));
170 if (!preg_match('/^([_\.0-9a-z-])*$/i',$forum_name)) {
171 $this->setError(_('Illegal Characters in Forum Name'));
174 if ($send_all_posts_to) {
175 $send_all_posts_to = str_replace(';', ',', $send_all_posts_to);
176 $invalid_mails = validate_emails($send_all_posts_to);
177 if (count($invalid_mails) > 0) {
178 $this->setInvalidEmailError($send_all_posts_to);
183 $project_name = $this->Group->getUnixName();
184 $result_list_samename = db_query_params('SELECT 1 FROM mail_group_list WHERE list_name=$1 AND group_id=$2',
186 array($project_name.'-'.strtolower($forum_name),
187 $this->Group->getID()));
189 if (db_numrows($result_list_samename) > 0){
190 $this->setError(_('Mailing List Exists with same name'));
195 // This is a hack to allow non-site-wide-admins to post
196 // news. The news/submit.php checks for proper permissions.
197 // This needs to be revisited.
199 if ($this->Group->getID() == forge_get_config('news_group')) {
200 // Future check will be added.
203 // Current permissions check.
205 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
206 $this->setPermissionDeniedError();
212 $result = db_query_params('INSERT INTO forum_group_list (group_id,forum_name,description,send_all_posts_to) VALUES ($1,$2,$3,$4)',
213 array($this->Group->getID(),
214 strtolower($forum_name),
215 htmlspecialchars($description),
216 $send_all_posts_to));
218 $this->setError(_('Error Adding Forum:').' '.db_error());
222 $this->group_forum_id=db_insertid($result,'forum_group_list','group_forum_id');
223 $this->fetchData($this->group_forum_id);
225 if ($create_default_message) {
226 $fm=new ForumMessage($this);
227 // Use the system side default language
228 setup_gettext_from_sys_lang();
229 $string = sprintf(_('Welcome to %1$s'), $forum_name);
230 // and switch back to the user preference
231 setup_gettext_from_context();
232 if (!$fm->create($string, $string)) {
233 $this->setError($fm->getErrorMessage());
238 $this->Group->normalizeAllRoles () ;
244 * fetchData - re-fetch the data for this forum from the database.
246 * @param int The forum_id.
247 * @return boolean success.
249 function fetchData($group_forum_id) {
250 $res=db_query_params('SELECT * FROM forum_group_list_vw WHERE group_forum_id=$1 AND group_id=$2',
251 array($group_forum_id, $this->Group->getID()));
252 if (!$res || db_numrows($res) < 1) {
253 $this->setError(_('Invalid forum group identifier'));
256 $this->data_array = db_fetch_array($res);
257 db_free_result($res);
262 * getGroup - get the Group object this ArtifactType is associated with.
264 * @return object The Group object.
266 function &getGroup() {
271 * getID - The id of this forum.
273 * @return int The group_forum_id #.
276 return $this->data_array['group_forum_id'];
280 * getNextThreadID - The next thread_id for a new top in this forum.
282 * @return int The next thread_id #.
284 function getNextThreadID() {
285 $result = db_query_params('SELECT nextval($1)',
286 array('forum_thread_seq'));
287 if (!$result || db_numrows($result) < 1) {
291 return db_result($result, 0, 0);
295 * getUnixName - returns the name used by email gateway
297 * @return string unix name
299 function getUnixName() {
300 return $this->Group->getUnixName().'-'.$this->getName();
304 * getSavedDate - The unix time when the person last hit "save my place".
306 * @return int The unix time.
308 function getSavedDate() {
309 if (isset($this->save_date)) {
310 return $this->save_date;
312 if (session_loggedin()) {
313 $result = db_query_params('SELECT save_date FROM forum_saved_place WHERE user_id=$1 AND forum_id=$2',
316 if ($result && db_numrows($result) > 0) {
317 $this->save_date=db_result($result, 0, 'save_date');
318 return $this->save_date;
320 //highlight new messages from the past week only
321 $this->save_date=(time()-604800);
322 return $this->save_date;
325 //highlight new messages from the past week only
326 $this->save_date=(time()-604800);
327 return $this->save_date;
333 * getName - get the name of this forum.
335 * @return string The name of this forum.
338 return $this->data_array['forum_name'];
342 * getSendAllPostsTo - an optional email address to send all forum posts to.
344 * @return string The email address.
346 function getSendAllPostsTo() {
347 return $this->data_array['send_all_posts_to'];
351 * getDescription - the description of this forum.
353 * @return string The description.
355 function getDescription() {
356 return $this->data_array['description'];
360 * getMessageCount - the total number of messages in this forum.
362 * @return int The count.
364 function getMessageCount() {
365 return $this->data_array['total'];
369 * getThreadCount - the total number of threads in this forum.
371 * @return int The count.
373 function getThreadCount() {
374 return $this->data_array['threads'];
378 * getMostRecentDate - the most recent date of a post to this board.
380 * @return int The most recent date.
382 function getMostRecentDate() {
383 return $this->data_array['recent'];
387 * getMonitoringIDs - return an array of user_id's for those monitoring this forum.
389 * @return array The array of user_id's.
391 function getMonitoringIDs() {
392 $result = db_query_params('SELECT user_id FROM forum_monitored_forums WHERE forum_id=$1',
393 array($this->getID()));
394 return util_result_column_to_array($result);
398 * getReturnEmailAddress() - return the return email address for notification emails
400 * @return string return email address
402 function getReturnEmailAddress() {
404 if(forge_get_config('use_gateways')) {
405 $address = $this->getUnixName();
407 $address = 'noreply';
410 if(forge_get_config('use_gateways') && forge_get_config('forum_return_domain')) {
411 $address .= forge_get_config('forum_return_domain');
413 $address .= forge_get_config('web_host');
419 * setMonitor - Add the current user to the list of people monitoring the forum.
421 * @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.
422 * @return boolean success.
424 function setMonitor($u = -1) {
426 if (!session_loggedin()) {
427 $this->setError(_('You can only monitor if you are logged in'));
432 $result = db_query_params('SELECT * FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
435 if (!$result || db_numrows($result) < 1) {
437 User is not already monitoring thread, so
438 insert a row so monitoring can begin
440 $result = db_query_params('INSERT INTO forum_monitored_forums (forum_id,user_id) VALUES ($1,$2)',
441 array($this->getID(),
445 $this->setError(_('Unable To Add Monitor').' : '.db_error());
454 * stopMonitor - Remove the current user from the list of people monitoring the forum.
456 * @return boolean success.
458 function stopMonitor($u = -1) {
460 if (!session_loggedin()) {
461 $this->setError(_('You can only monitor if you are logged in'));
466 return db_query_params('DELETE FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
472 * isMonitoring - See if the current user is in the list of people monitoring the forum.
474 * @return boolean is_monitoring.
476 function isMonitoring() {
477 if (!session_loggedin()) {
480 $result = db_query_params('SELECT count(*) AS count FROM forum_monitored_forums WHERE user_id=$1 AND forum_id=$2',
483 $row_count = db_fetch_array($result);
484 return $result && $row_count['count'] > 0;
488 * savePlace - set a unix time into the database for this user, so future messages can be highlighted.
490 * @return boolean success.
492 function savePlace() {
493 if (!session_loggedin()) {
494 $this->setError(_('You Can Only Save Your Place If You Are Logged In'));
497 $result = db_query_params('SELECT * FROM forum_saved_place WHERE user_id=$1 AND forum_id=$2',
501 if (!$result || db_numrows($result) < 1) {
503 User is not already monitoring thread, so
504 insert a row so monitoring can begin
506 $result = db_query_params('INSERT INTO forum_saved_place (forum_id,user_id,save_date) VALUES ($1,$2,$3)',
507 array($this->getID(),
512 $this->setError(_('Forum::savePlace()').': '.db_error());
517 $result = db_query_params('UPDATE forum_saved_place SET save_date=$1 WHERE user_id=$2 AND forum_id=$3',
523 $this->setError('Forum::savePlace() '.db_error());
531 * update - use this function to update an entry in the database.
533 * @param string The name of the forum.
534 * @param string The description of the forum.
535 * @param string The email address to send all new posts to.
536 * @return boolean success.
538 function update($forum_name, $description, $send_all_posts_to = '') {
539 if (strlen($forum_name) < 3) {
540 $this->setError(_('Forum Name Must Be At Least 3 Characters'));
543 if (strlen($description) < 10) {
544 $this->setError(_('Forum Description Must Be At Least 10 Characters'));
547 if (!preg_match('/^([_\.0-9a-z-])*$/i',$forum_name)) {
548 $this->setError(_('Illegal Characters in Forum Name'));
551 if ($send_all_posts_to) {
552 $send_all_posts_to = str_replace(';', ',', $send_all_posts_to);
553 $invalid_mails = validate_emails($send_all_posts_to);
554 if (count($invalid_mails) > 0) {
555 $this->setInvalidEmailError($send_all_posts_to);
560 if (!forge_check_perm('forum_admin', $this->Group->getID())) {
561 $this->setPermissionDeniedError();
565 $res = db_query_params('UPDATE forum_group_list SET
570 AND group_forum_id=$5',
571 array(strtolower($forum_name),
572 htmlspecialchars($description),
574 $this->Group->getID(),
577 if (!$res || db_affected_rows($res) < 1) {
578 $this->setError(_('Error On Update:').': '.db_error());
585 * delete - delete this forum and all its related data.
587 * @param bool I'm Sure.
588 * @param bool I'm REALLY sure.
589 * @return bool true/false;
591 function delete($sure, $really_sure) {
592 if (!$sure || !$really_sure) {
593 $this->setMissingParamsError(_('Please tick all checkboxes.'));
596 if (!forge_check_perm ('forum_admin', $this->Group->getID())) {
597 $this->setPermissionDeniedError();
601 $result = db_query_params('DELETE FROM forum_agg_msg_count WHERE group_forum_id=$1',
602 array($this->getID()));
604 $this->setError(_('Error Deleting Forum:').' '.db_error());
609 $result = db_query_params('DELETE FROM forum_monitored_forums WHERE forum_id=$1',
610 array($this->getID()));
612 $this->setError(_('Error Deleting Forum:').' '.db_error());
617 $result = db_query_params('DELETE FROM forum_saved_place WHERE forum_id=$1',
618 array($this->getID()));
620 $this->setError(_('Error Deleting Forum:').' '.db_error());
625 $result = db_query_params('DELETE FROM forum_attachment WHERE msg_id IN (SELECT msg_id from forum where group_forum_id=$1)',
626 array($this->getID()));
628 $this->setError(_('Error Deleting Forum:').' '.db_error());
633 $result = db_query_params('DELETE FROM forum WHERE group_forum_id=$1',
634 array($this->getID()));
636 $this->setError(_('Error Deleting Forum:').' '.db_error());
641 $result = db_query_params('DELETE FROM forum_group_list WHERE group_forum_id=$1',
642 array($this->getID()));
644 $this->setError(_('Error Deleting Forum:').' '.db_error());
651 $this->Group->normalizeAllRoles();
660 // c-file-style: "bsd"