File Source for announcements.inc.php

<?php //$Id: announcements.inc.php 15247 2008-05-08 19:07:01Z juliomontoya $
/*
==============================================================================
Dokeos - elearning and course management software
Copyright (c) 2004-2008 Dokeos SPRL
Copyright (c) various contributors
For a full list of contributors, see "credits.txt".
The full license can be read in "license.txt".
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
See the GNU General Public License for more details.
Contact address: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium
Mail: info@dokeos.com
==============================================================================
*/
/**
==============================================================================
* Include file with functions for the announcements module.
* @package dokeos.announcements
==============================================================================
*/
/*
==============================================================================
DISPLAY FUNCTIONS
==============================================================================
*/
/**
* displays one specific announcement
* @param $announcement_id, the id of the announcement you want to display
* @todo remove globals
* @todo more security checking
*/
function display_announcement($announcement_id)
{
global $_user, $dateFormatLong;
$tbl_announcement = Database::get_course_table('announcement');
$tbl_item_property = Database::get_course_table('item_property');
if ($_user['user_id'])
{
$sql_query = " SELECT announcement.*, toolitemproperties.*
FROM $tbl_announcement announcement, $tbl_item_property toolitemproperties
WHERE announcement.id = toolitemproperties.ref
AND announcement.id = '$announcement_id'
AND toolitemproperties.tool='announcement'
AND (toolitemproperties.to_user_id='".$_user['user_id']."' OR toolitemproperties.to_group_id='0')
AND toolitemproperties.visibility='1'
ORDER BY display_order DESC";
}
else
{
$sql_query = " SELECT announcement.*, toolitemproperties.*
FROM $tbl_announcement announcement, $tbl_item_property toolitemproperties
WHERE announcement.id = toolitemproperties.ref
AND announcement.id = '$announcement_id'
AND toolitemproperties.tool='announcement'
AND toolitemproperties.to_group_id='0'
AND toolitemproperties.visibility='1'";
}
$sql_result = api_sql_query($sql_query,__FILE__,__LINE__);
$result = Database::fetch_array($sql_result);
$title = $result['title'];
$content = $result['content'];
$content = make_clickable($content);
$content = text_filter($content);
$last_post_datetime = $result['insert_date'];// post time format datetime de mysql
list($last_post_date, $last_post_time) = split(" ", $last_post_datetime);
echo "<table height=\"100\" width=\"100%\" border=\"1\" cellpadding=\"5\" cellspacing=\"0\" id=\"agenda_list\">\n";
echo "<tr class=\"data\"><td>" . $title . "</td></tr>\n";
echo "<tr><td class=\"announcements_datum\">" . get_lang('AnnouncementPublishedOn') . " : " . ucfirst(format_locale_date($dateFormatLong,strtotime($last_post_date) ) ) . "</td></tr>\n";
echo "<tr class=\"text\"><td>$content</td></tr>\n";
echo "</table>";
}
/*======================================
SHOW_TO_FORM
======================================*/
/**
* this function shows the form for sending a message to a specific group or user.
*/
function show_to_form($to_already_selected)
{
$user_list=get_course_users();
$group_list=get_course_groups();
echo "\n<table id=\"recipient_list\" style=\"display: none;\">\n";
echo "\t<tr>\n";
// the form containing all the groups and all the users of the course
echo "\t\t<td>\n";
construct_not_selected_select_form($group_list,$user_list,$to_already_selected);
echo "\t\t</td>\n";
// the buttons for adding or removing groups/users
echo "\n\t\t<td valign=\"middle\">\n";
echo "\t\t<input type=\"button\" ",
"onClick=\"move(this.form.elements[0],this.form.elements[3])\" ",// 7 & 4 : fonts
"value=\" >> \">",
"\n\t\t<p> </p>",
"\n\t\t<input type=\"button\"",
"onClick=\"move(this.form.elements[3],this.form.elements[0])\" ",
"value=\" << \">";
echo "\t\t</td>\n";
echo "\n\t\t<td>\n";
// the form containing the selected groups and users
construct_selected_select_form($group_list,$user_list,$to_already_selected);
echo "\t\t</td>\n";
echo "\t</tr>\n";
echo "</table>";
}
/*===========================================
CONSTRUCT_NOT_SELECT_SELECT_FORM
===========================================*/
/**
* this function shows the form for sending a message to a specific group or user.
*/
function construct_not_selected_select_form($group_list=null, $user_list=null,$to_already_selected)
{
echo "\t\t<select name=\"not_selected_form[]\" size=5 style=\"width:200px\" multiple>\n";
// adding the groups to the select form
if ($group_list)
{
foreach($group_list as $this_group)
{
if (is_array($to_already_selected))
{
if (!in_array("GROUP:".$this_group['id'],$to_already_selected)) // $to_already_selected is the array containing the groups (and users) that are already selected
{
echo "\t\t<option value=\"GROUP:".$this_group['id']."\">",
"G: ",$this_group['name']," - " . $this_group['userNb'] . " " . get_lang('Users') .
"</option>\n";
}
}
}
// a divider
echo "\t\t<option value=\"\">---------------------------------------------------------</option>\n";
}
// adding the individual users to the select form
foreach($user_list as $this_user)
{
if (!in_array("USER:".$this_user["user_id"],$to_already_selected)) // $to_already_selected is the array containing the users (and groups) that are already selected
{
echo "\t\t<option value=\"USER:",$this_user["user_id"],"\">",
"",$this_user['lastName']," ",$this_user['firstName'],
"</option>\n";
}
}
echo "\t\t</select>\n";
}
/*==========================================
CONSTRUCT_SELECTED_SELECT_FORM
==========================================*/
/**
* this function shows the form for sending a message to a specific group or user.
*/
function construct_selected_select_form($group_list=null, $user_list=null,$to_already_selected)
{
// we separate the $to_already_selected array (containing groups AND users into
// two separate arrays
$groupuser = array();
if (is_array($to_already_selected))
{
$groupuser=separate_users_groups($to_already_selected);
}
$groups_to_already_selected=$groupuser['groups'];
$users_to_already_selected=$groupuser['users'];
// we load all the groups and all the users into a reference array that we use to search the name of the group / user
$ref_array_groups=get_course_groups();
$ref_array_users=get_course_users();
// we construct the form of the already selected groups / users
echo "\t\t<select name=\"selectedform[]\" size=\"5\" multiple style=\"width:200px\" width=\"200px\">";
foreach($to_already_selected as $groupuser)
{
list($type,$id)=explode(":",$groupuser);
if ($type=="GROUP")
{
echo "\t\t<option value=\"".$groupuser."\">G: ".$ref_array_groups[$id]['name']."</option>";
}
else
{
foreach($ref_array_users as $key=>$value){
if($value['user_id']==$id){
echo "\t\t<option value=\"".$groupuser."\">".$value['lastName']." ".$value['firstName']."</option>";
break;
}
}
}
}
echo "</select>\n";
}
/**
* this function shows the form for sending a message to a specific group or user.
*/
function show_to_form_group($group_id)
{
echo "\n<table id=\"recipient_list\" style=\"display: none;\">\n";
echo "\t<tr>\n";
echo "\t\t<td>\n";
echo "\t\t<select name=\"not_selected_form[]\" size=5 style=\"width:200px\" multiple>\n";
$group_users = GroupManager::get_subscribed_users($group_id);
foreach($group_users as $user){
echo '<option value="'.$user['user_id'].'">'.$user['lastname'].' '.$user['firstname'].'</option>';
}
echo '</select>';
echo "\t\t</td>\n";
// the buttons for adding or removing groups/users
echo "\n\t\t<td valign=\"middle\">\n";
echo "\t\t<input type=\"button\" ",
"onClick=\"move(this.form.elements[1],this.form.elements[4])\" ",// 7 & 4 : fonts
"value=\" >> \">",
"\n\t\t<p> </p>",
"\n\t\t<input type=\"button\"",
"onClick=\"move(this.form.elements[4],this.form.elements[1])\" ",
"value=\" << \">";
echo "\t\t</td>\n";
echo "\n\t\t<td>\n";
echo "\t\t<select name=\"selectedform[]\" size=5 style=\"width:200px\" multiple>\n";
echo '</select>';
echo "\t\t</td>\n";
echo "\t</tr>\n";
echo "</table>";
}
/*
==============================================================================
DATA FUNCTIONS
==============================================================================
*/
/**
* this function gets all the users of the course,
* including users from linked courses
*/
function get_course_users()
{
//this would return only the users from real courses:
//$user_list = CourseManager::get_user_list_from_course_code(api_get_course_id());
$user_list = CourseManager::get_real_and_linked_user_list(api_get_course_id(), true, $_SESSION['id_session']);
return $user_list;
}
/**
* this function gets all the groups of the course,
* not including linked courses
*/
function get_course_groups()
{
$new_group_list = CourseManager::get_group_list_of_course(api_get_course_id());
return $new_group_list;
}
/*======================================
LOAD_EDIT_USERS
======================================*/
/**
* This tools loads all the users and all the groups who have received
* a specific item (in this case an announcement item)
*/
function load_edit_users($tool, $id)
{
global $_course;
global $tbl_item_property;
$sql="SELECT * FROM $tbl_item_property WHERE tool='$tool' AND ref='$id'";
$result=api_sql_query($sql,__FILE__,__LINE__) or die (mysql_error());
while ($row=Database::fetch_array($result))
{
$to_group=$row['to_group_id'];
switch ($to_group)
{
// it was send to one specific user
case null:
$to[]="USER:".$row['to_user_id'];
break;
// it was sent to everyone
case 0:
return "everyone";
exit;
break;
default:
$to[]="GROUP:".$row['to_group_id'];
}
}
return $to;
}
/*======================================
USER_GROUP_FILTER_JAVASCRIPT
======================================*/
/**
* returns the javascript for setting a filter
* this goes into the $htmlHeadXtra[] array
*/
function user_group_filter_javascript()
{
return "<script language=\"JavaScript\" type=\"text/JavaScript\">
<!--
function jumpMenu(targ,selObj,restore)
{
eval(targ+\".location='\"+selObj.options[selObj.selectedIndex].value+\"'\");
if (restore) selObj.selectedIndex=0;
}
//-->
</script>
";
}
/*======================================
TO_JAVASCRIPT
========================================*/
/**
* returns all the javascript that is required for easily
* setting the target people/groups
* this goes into the $htmlHeadXtra[] array
*/
function to_javascript()
{
return "<script type=\"text/javascript\" language=\"JavaScript\">
<!-- Begin javascript menu swapper
function move(fbox, tbox)
{
var arrFbox = new Array();
var arrTbox = new Array();
var arrLookup = new Array();
var i;
for (i = 0; i < tbox.options.length; i++)
{
arrLookup[tbox.options[i].text] = tbox.options[i].value;
arrTbox[i] = tbox.options[i].text;
}
var fLength = 0;
var tLength = arrTbox.length;
for(i = 0; i < fbox.options.length; i++)
{
arrLookup[fbox.options[i].text] = fbox.options[i].value;
if (fbox.options[i].selected && fbox.options[i].value != \"\")
{
arrTbox[tLength] = fbox.options[i].text;
tLength++;
}
else
{
arrFbox[fLength] = fbox.options[i].text;
fLength++;
}
}
arrFbox.sort();
arrTbox.sort();
fbox.length = 0;
tbox.length = 0;
var c;
for(c = 0; c < arrFbox.length; c++)
{
var no = new Option();
no.value = arrLookup[arrFbox[c]];
no.text = arrFbox[c];
fbox[c] = no;
}
for(c = 0; c < arrTbox.length; c++)
{
var no = new Option();
no.value = arrLookup[arrTbox[c]];
no.text = arrTbox[c];
tbox[c] = no;
}
}
function validate()
{
var f = document.new_calendar_item;
f.submit();
return true;
}
function selectAll(cbList,bSelect,showwarning)
{
if (cbList.length < 1) {
alert(\"".get_lang('Send2All')."\");
return;
}
for (var i=0; i<cbList.length; i++)
cbList[i].selected = cbList[i].checked = bSelect
}
function reverseAll(cbList)
{
for (var i=0; i<cbList.length; i++)
{
cbList[i].checked = !(cbList[i].checked)
cbList[i].selected = !(cbList[i].selected)
}
}
// End -->
</script>";
}
/*======================================
SENT_TO_FORM
======================================*/
/**
* constructs the form to display all the groups and users the message has been sent to
* input: $sent_to_array is a 2 dimensional array containing the groups and the users
* the first level is a distinction between groups and users:
* $sent_to_array['groups'] * and $sent_to_array['users']
* $sent_to_array['groups'] (resp. $sent_to_array['users']) is also an array
* containing all the id's of the groups (resp. users) who have received this message.
* @author Patrick Cool <patrick.cool@>
*/
function sent_to_form($sent_to_array)
{
// we find all the names of the groups
$group_names=get_course_groups();
count($sent_to_array);
// we count the number of users and the number of groups
if (isset($sent_to_array['users']))
{
$number_users=count($sent_to_array['users']);
}
else
{
$number_users=0;
}
if (isset($sent_to_array['groups']))
{
$number_groups=count($sent_to_array['groups']);
}
else
{
$number_groups=0;
}
$total_numbers=$number_users+$number_groups;
// starting the form if there is more than one user/group
if ($total_numbers >1)
{
$output="<select name=\"sent to\">\n";
$output.="<option>".get_lang("SentTo")."</option>";
// outputting the name of the groups
if (is_array($sent_to_array['groups']))
{
foreach ($sent_to_array['groups'] as $group_id)
{
$output.="\t<option value=\"\">G: ".$group_names[$group_id]['name']."</option>\n";
}
}
if (isset($sent_to_array['users']))
{
if (is_array($sent_to_array['users']))
{
foreach ($sent_to_array['users'] as $user_id)
{
$user_info=api_get_user_info($user_id);
$output.="\t<option value=\"\">".$user_info['lastName']." ".$user_info['firstName']."</option>\n";
}
}
}
// ending the form
$output.="</select>\n";
}
else // there is only one user/group
{
if (isset($sent_to_array['users']) and is_array($sent_to_array['users']))
{
$user_info=api_get_user_info($sent_to_array['users'][0]);
echo $user_info['lastName']." ".$user_info['firstName'];
}
if (isset($sent_to_array['groups']) and is_array($sent_to_array['groups']) and $sent_to_array['groups'][0]!==0)
{
$group_id=$sent_to_array['groups'][0];
echo $group_names[$group_id]['name'];
}
if (isset($sent_to_array['groups']) and is_array($sent_to_array['groups']) and $sent_to_array['groups'][0]==0)
{
echo get_lang("Everybody");
}
}
if(!empty($output))
{
echo $output;
}
}
/*======================================
SEPARATE_USERS_GROUPS
======================================*/
/**
* This function separates the users from the groups
* users have a value USER:XXX (with XXX the dokeos id
* groups have a value GROUP:YYY (with YYY the group id)
*/
function separate_users_groups($to)
{
foreach($to as $to_item)
{
list($type, $id) = explode(':', $to_item);
switch($type)
{
case 'GROUP':
$grouplist[] =$id;
break;
case 'USER':
$userlist[] =$id;
break;
}
}
$send_to['groups']=$grouplist;
$send_to['users']=$userlist;
return $send_to;
}
/*======================================
SENT_TO()
======================================*/
/**
* returns all the users and all the groups a specific announcement item
* has been sent to
*/
function sent_to($tool, $id)
{
global $_course;
global $tbl_item_property;
$sql="SELECT * FROM $tbl_item_property WHERE tool='$tool' AND ref='".$id."'";
$result = api_sql_query($sql,__FILE__,__LINE__);
while ($row=Database::fetch_array($result))
{
// if to_group_id is null then it is sent to a specific user
// if to_group_id = 0 then it is sent to everybody
if (!is_null($row['to_group_id']))
{
$sent_to_group[]=$row['to_group_id'];
}
// if to_user_id <> 0 then it is sent to a specific user
if ($row['to_user_id'] <> 0)
{
$sent_to_user[]=$row['to_user_id'];
}
}
if (isset($sent_to_group))
{
$sent_to['groups']=$sent_to_group;
}
if (isset($sent_to_user))
{
$sent_to['users']=$sent_to_user;
}
return $sent_to;
}
/*===================================================
CHANGE_VISIBILITY($tool,$id)
=================================================*/
/**
* This functions swithes the visibility a course resource
* using the visibility field in 'item_property'
* values: 0 = invisibility for
*/
function change_visibility($tool,$id)
{
global $_course;
global $tbl_item_property;
$sql="SELECT * FROM $tbl_item_property WHERE tool='$tool' AND ref='$id'";
$result=api_sql_query($sql,__FILE__,__LINE__) or die (mysql_error());
$row=Database::fetch_array($result);
if ($row['visibility']=='1')
{
$sql_visibility="UPDATE $tbl_item_property SET visibility='0' WHERE tool='$tool' AND ref='$id'";
}
else
{
$sql_visibility="UPDATE $tbl_item_property SET visibility='1' WHERE tool='$tool' AND ref='$id'";
}
$result=api_sql_query($sql_visibility,__FILE__,__LINE__) or die (mysql_error());
}
/*====================================================
STORE_ADVALVAS_ITEM
====================================================*/
function store_advalvas_item($emailTitle,$newContent, $order, $to)
{
global $_course;
global $nameTools;
global $_user;
global $tbl_announcement;
global $tbl_item_property;
// store in the table announcement
$sql = "INSERT INTO $tbl_announcement SET content = '$newContent', title = '$emailTitle', end_date = NOW(), display_order ='$order'";
$result = api_sql_query($sql,__FILE__,__LINE__) or die (mysql_error());
$last_id= Database::get_last_insert_id();
// store in item_property (first the groups, then the users
if (!is_null($to)) // !is_null($to): when no user is selected we send it to everyone
{
$send_to=separate_users_groups($to);
// storing the selected groups
if (is_array($send_to['groups']))
{
foreach ($send_to['groups'] as $group)
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $last_id, "AnnouncementAdded", $_user['user_id'], $group);
}
}
// storing the selected users
if (is_array($send_to['users']))
{
foreach ($send_to['users'] as $user)
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $last_id, "AnnouncementAdded", $_user['user_id'], '', $user);
}
}
}
else // the message is sent to everyone, so we set the group to 0
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $last_id, "AnnouncementAdded", $_user['user_id'], '0');
}
return $last_id;
}
function store_advalvas_group_item($emailTitle,$newContent, $order, $to, $to_users)
{
global $_course;
global $nameTools;
global $_user;
global $tbl_announcement;
global $tbl_item_property;
// store in the table announcement
$sql = "INSERT INTO $tbl_announcement SET content = '$newContent', title = '$emailTitle', end_date = NOW(), display_order ='$order'";
$result = api_sql_query($sql,__FILE__,__LINE__) or die (mysql_error());
$last_id= Database::get_last_insert_id();
// store in item_property (first the groups, then the users
if (!isset($to_users)) // !isset($to): when no user is selected we send it to everyone
{
$send_to=separate_users_groups($to);
// storing the selected groups
if (is_array($send_to['groups']))
{
foreach ($send_to['groups'] as $group)
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $last_id, "AnnouncementAdded", $_user['user_id'], $group);
}
}
}
else // the message is sent to everyone, so we set the group to 0
{
// storing the selected users
if (is_array($to_users))
{
foreach ($to_users as $user)
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $last_id, "AnnouncementAdded", $_user['user_id'], '', $user);
}
}
}
return $last_id;
}
/*==================================================
EDIT_VALVAS_ITEM
==================================================*/
/**
* This function stores the announcement Item in the table announcement
* and updates the item_property also
*/
function edit_advalvas_item($id,$emailTitle,$newContent,$to)
{
global $_course;
global $nameTools;
global $_user;
global $tbl_announcement;
global $tbl_item_property;
// store the modifications in the table announcement
$sql = "UPDATE $tbl_announcement SET content='$newContent', title = '$emailTitle' WHERE id='$id'";
$result = api_sql_query($sql,__FILE__,__LINE__) or die (mysql_error());
// we remove everything from item_property for this
$sql_delete="DELETE FROM $tbl_item_property WHERE ref='$id' AND tool='announcement'";
$result = api_sql_query($sql_delete,__FILE__,__LINE__) or die (mysql_error());
// store in item_property (first the groups, then the users
if (!is_null($to)) // !is_null($to): when no user is selected we send it to everyone
{
$send_to=separate_users_groups($to);
// storing the selected groups
if (is_array($send_to['groups']))
{
foreach ($send_to['groups'] as $group)
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $id, "AnnouncementUpdated", $_user['user_id'], $group);
}
}
// storing the selected users
if (is_array($send_to['users']))
{
foreach ($send_to['users'] as $user)
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $id, "AnnouncementUpdated", $_user['user_id'], '', $user);
}
}
}
else // the message is sent to everyone, so we set the group to 0
{
api_item_property_update($_course, TOOL_ANNOUNCEMENT, $id, "AnnouncementUpdated", $_user['user_id'], '0');
}
}
/*
==============================================================================
MAIL FUNCTIONS
==============================================================================
*/
/**
* Sends an announcement by email to a list of users.
* Emails are sent one by one to try to avoid antispam.
*/
function send_announcement_email($user_list, $course_code, $_course, $mail_title, $mail_content)
{
global $_user;
foreach ($user_list as $this_user)
{
/* Header : Bericht van uw lesgever - GES ($course_code) - Morgen geen les! ($mail_title)
Body : John Doe (prenom + nom) <john_doe@hotmail.com> (email)
Morgen geen les! ($mail_title)
Morgen is er geen les, de les wordt geschrapt wegens vergadering (newContent)
*/
$mail_subject = get_lang('professorMessage').' - '.$_course['official_code'].' - '.$mail_title;
$mail_body = '['.$_course['official_code'].'] - ['.$_course['name']."]\n";
$mail_body .= $this_user['lastname'].' '.$this_user['firstname'].' <'.$this_user["email"]."> \n\n".stripslashes($mail_title)."\n\n".trim(stripslashes(html_entity_decode(strip_tags(str_replace(array('<p>','</p>','<br />'),array('',"\n","\n"),$mail_content)))))." \n\n-- \n";
$mail_body .= $_user['firstName'].' '.$_user['lastName'].' ';
$mail_body .= '<'.$_user['mail'].">\n";
$mail_body .= $_course['official_code'].' '.$_course['name'];
//set the charset and use it for the encoding of the email - small fix, not really clean (should check the content encoding origin first)
//here we use the encoding used for the webpage where the text is encoded (ISO-8859-1 in this case)
if(empty($charset)){$charset='ISO-8859-1';}
$encoding = 'Content-Type: text/plain; charset='. $charset;
$newmail = api_mail($this_user['lastname'].' '.$this_user['firstname'], $this_user['email'], $mail_subject, $mail_body, $_SESSION['_user']['lastName'].' '.$_SESSION['_user']['firstName'], $_SESSION['_user']['mail'], $encoding);
}
}
function update_mail_sent($insert_id)
{
global $_course;
global $tbl_announcement;
// store the modifications in the table tbl_annoucement
$sql = "UPDATE $tbl_announcement SET email_sent='1' WHERE id='$insert_id'";
api_sql_query($sql,__FILE__,__LINE__);
}

Source for file announcements.inc.php