* @copyright (c) 2004-13 by RalfBecker-At-outdoor-training.de
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
/**
* Class to generate the calendar views and the necesary widgets
*
* The listview is in a separate class calendar_uilist!
*
* The new UI, BO and SO classes have a strikt definition, in which time-zone they operate:
* UI only operates in user-time, so there have to be no conversation at all !!!
* BO's functions take and return user-time only (!), they convert internaly everything to servertime, because
* SO operates only on server-time
*
* The state of the UI elements is managed in the uical class, which all UI classes extend.
*
* All permanent debug messages of the calendar-code should done via the debug-message method of the calendar_bo class !!!
*/
class calendar_uiviews extends calendar_ui
{
var $public_functions = array(
'day' => True,
'day4' => True,
'week' => True,
'weekN' => True,
'month' => True,
'year' => True,
'planner' => True,
'index' => True,
);
/**
* integer level or string function- or widget-name
*
* @var mixed
*/
var $debug=false;
/**
* minimum width for an event
*
* @var int
*/
var $eventCol_min_width = 80;
/**
* extra rows above and below the workday
*
* @var int
*/
var $extraRows = 2;
/**
* removes n extra rows below the workday
*
* @var int
*/
var $remBotExtraRows = 0;
/**
* extra rows original (save original value even if it gets changed in the class)
*
* @var int
*/
var $extraRowsOriginal;
var $timeRow_width = 40;
/**
* how many rows per day get displayed, gets set by the timeGridWidget
*
* @var int
*/
var $rowsToDisplay;
/**
* height in percent of one row, gets set by the timeGridWidget
*
* @var int
*/
var $rowHeight;
/**
* standard params for calling bocal::search for all views, set by the constructor
*
* @var array
*/
var $search_params;
/**
* should we use a time grid, can be set for week- and month-view to false by the cal_pref no_time_grid
*
* @var boolean
*/
var $use_time_grid=true;
/**
* Pref value of use_time_grid preference
* @var string
*/
var $use_time_grid_pref = '';
/**
* Can we display the whole day in a timeGrid of the size of the workday and just scroll to workday start
*
* @var boolean
*/
var $scroll_to_wdstart=false;
/**
* counter for the current whole day event of a single day
*
* @var int
*/
var $wholeDayPosCounter=1;
/**
* Switch to disable private data and possibility to view and edit events
* in case of a public view (sitemgr)
*/
var $allowEdit = true;
/**
* Display holidays as event, currenlty only used in day-view
*
* @var array
*/
var $display_holiday_event_types = array(
'bdays' => false,
'hdays' => false
);
/**
* Constructor
*
* @param array $set_states = null to manualy set / change one of the states, default NULL = use $_REQUEST
*/
function __construct($set_states=null)
{
parent::__construct(false,$set_states); // call the parent's constructor
$this->extraRowsOriginal = $this->extraRows; //save original extraRows value
$GLOBALS['egw_info']['flags']['nonavbar'] = False;
$app_header = array(
'day' => lang('Dayview'),
'4day' => lang('Four days view'),
'week' => lang('Weekview'),
'month' => lang('Monthview'),
'year' => lang('yearview'),
'planner' => lang('Group planner'),
);
$GLOBALS['egw_info']['flags']['app_header'] = $GLOBALS['egw_info']['apps']['calendar']['title'].
(isset($app_header[$this->view]) ? ' - '.$app_header[$this->view] : '').
// for a single owner we add it's name to the app-header
(count(explode(',',$this->owner)) == 1 ? ': '.$this->bo->participant_name($this->owner) : '');
// standard params for calling bocal::search for all views
$this->owner = str_replace('%2C',',',$this->owner);
$this->search_params = array(
'start' => $this->date,
'cat_id' => $this->cat_id ? (is_array($this->cat_id)?$this->cat_id:explode(',',$this->cat_id)) : 0,
'users' => explode(',',$this->owner),
'filter' => $this->filter,
'daywise' => True,
);
$this->holidays = $this->bo->read_holidays($this->year);
$this->check_owners_access();
//ATM: Forces use_time_grid preference to use all views by ignoring the preference value
//@TODO: the whole use_time_grid preference should be removed (including dependent vars)
// after we decided that is not neccessary to have it at all
$this->use_time_grid_pref = 'all'; //$this->cal_prefs['use_time_grid'];
}
/**
* Calculate iso8601 week-number, which is defined for Monday as first day of week only
*
* We addjust the day, if user prefs want a different week-start-day
*
* @param int|string|DateTime $time
* @return string
*/
public function week_number($time)
{
if (!is_a($time,'DateTime')) $time = new egw_time($time);
// if week does not start Monday and $time is Sunday --> add one day
if ($this->cal_prefs['weekdaystarts'] != 'Monday' && !($wday = $time->format('w')))
{
$time->modify('+1day');
}
// if week does start Saturday and $time is Saturday --> add two days
elseif ($this->cal_prefs['weekdaystarts'] == 'Saturday' && $wday == 6)
{
$time->modify('+2days');
}
return $time->format('W');
}
/**
* Show the last view or the default one, if no last
*/
function index()
{
if (!$this->view) $this->view = 'week';
// handle views in other files
if (!isset($this->public_functions[$this->view]))
{
$GLOBALS['egw']->redirect_link('/index.php',array('menuaction'=>$this->view_menuaction,'ajax'=>'true'),'calendar');
}
// get manual to load the right page
$GLOBALS['egw_info']['flags']['params']['manual'] = array('page' => 'ManualCalendar'.ucfirst($this->view));
$this->{$this->view}();
}
/**
* Show the calendar on the home page
*
* @return string with content
*/
function &home()
{
// set some stuff for the home-page
$this->__construct(array(
'date' => $this->bo->date2string($this->bo->now_su),
'cat_id' => 0,
'filter' => 'default',
'owner' => substr($this->cal_prefs['mainscreen_showevents'],0,7) == 'planner' && $this->cal_prefs['planner_start_with_group'] ?
$this->cal_prefs['planner_start_with_group'] : $this->user,
'multiple' => 0,
'view' => $this->bo->cal_prefs['mainscreen_showevents'],
));
if (($error = $this->check_owners_access()))
{
return $error;
}
if ($this->group_warning)
{
$group_warning = ''.$this->group_warning."
\n";
}
switch($this->cal_prefs['mainscreen_showevents'])
{
case 'planner_user':
case 'planner_cat':
case 'planner':
return $group_warning.$this->planner(true);
case 'year':
return $group_warning.$this->year(true);
case 'month':
return $group_warning.$this->month(0,true);
case 'weekN':
return $group_warning.$this->weekN(true);
default:
case 'week':
return $group_warning.$this->week(0,true);
case 'day':
return $group_warning.$this->day(true);
case 'day4':
return $group_warning.$this->week(4,true);
}
}
/**
* Displays the planner view
*
* @param boolean $home = false if true return content suitable for home-page
*/
function &planner($home=false)
{
if ($this->sortby == 'month') // yearly planner with month rows
{
$this->first = $this->bo->date2array($this->date);
$this->first['day'] = 1;
unset($this->first['raw']);
$this->last = $this->first;
$this->last['year']++;
$this->last = $this->bo->date2ts($this->last)-1;
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.lang('yearly planner').' '.
lang(egw_time::to($this->first,'F')).' '.egw_time::to($this->first,'Y').' - '.
lang(egw_time::to($this->last,'F')).' '.egw_time::to($this->last,'Y');
}
elseif (!$this->planner_days) // planner monthview
{
if ($this->day < 15) // show one complete month
{
$this->_week_align_month($this->first,$this->last);
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.lang(adodb_date('F',$this->bo->date2ts($this->date))).' '.$this->year;
}
else // show 2 half month
{
$this->_week_align_month($this->first,$this->last,15);
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.lang(adodb_date('F',$this->first)).' / '.lang(adodb_date('F',$this->last)).' '.$this->year;
}
}
elseif ($this->planner_days >= 5) // weeekview
{
$this->first = $this->datetime->get_weekday_start($this->year,$this->month,$this->day);
$this->last = $this->bo->date2array($this->first);
$this->last['day'] += (int) $this->planner_days - 1;
$this->last['hour'] = 23; $this->last['minute'] = $this->last['sec'] = 59;
unset($this->last['raw']);
$this->last = $this->bo->date2ts($this->last);
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.lang('Week').' '.$this->week_number($this->first).': '.$this->bo->long_date($this->first,$this->last);
}
else // dayview
{
$this->first = $this->bo->date2ts($this->date);
$this->last = $this->bo->date2array($this->first);
$this->last['day'] += (int) $this->planner_days - 1;
$this->last['hour'] = 23; $this->last['minute'] = $this->last['sec'] = 59;
unset($this->last['raw']);
$this->last = $this->bo->date2ts($this->last);
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.($this->planner_days == 1 ? lang(date('l',$this->first)).', ' : '').
$this->bo->long_date($this->first,$this->planner_days > 1 ? $this->last : 0);
}
$merge = $this->merge();
if($merge)
{
egw::redirect_link('/index.php',array(
'menuaction' => 'calendar.calendar_uiviews.index',
'msg' => $merge,
));
}
$search_params = $this->search_params;
$search_params['daywise'] = false;
$search_params['start'] = $this->first;
$search_params['end'] = $this->last;
$search_params['enum_groups'] = $this->sortby == 'user';
$events =& $this->bo->search($search_params);
if ($this->debug > 0) $this->bo->debug_message('uiviews::planner() date=%1: first=%2, last=%3',False,$this->date,$this->bo->date2string($this->first),$this->bo->date2string($this->last));
$content =& $this->plannerWidget($events,$this->first,$this->last,$this->sortby != 'category' ? $this->sortby : (int) $this->cat_id);
if (!$home)
{
$this->do_header();
echo $content;
}
return $content;
}
/**
* Displays a multiple week-view
*
* @param boolean $home = false if true return content suitable for home-page
*/
function &weekN($home=false)
{
if (($num = (int)$this->cal_prefs['multiple_weeks']) < 2) $num = 3; // default 3 weeks
return $this->month($num,$home);
}
/** Month column width (usually 3 or 4) in year view */
const YEARVIEW_COLS = 3;
/**
* Displays a year view
*
* @param boolean $home = false if true return content suitable for home-page
*/
function &year($home=false)
{
if ($this->debug > 0) $this->bo->debug_message('uiviews::year date=%2',True,$this->date);
$this->_month_align_year($this->first,$this->last);
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.$this->year;
$merge = $this->merge();
if($merge)
{
egw::redirect_link('/index.php',array(
'menuaction' => 'calendar.calendar_uiviews.index',
'msg' => $merge,
));
}
$days =& $this->bo->search(array(
'start' => $this->first,
'end' => $this->last,
) + $this->search_params);
/* Loop through the week-aligned months. */
for ($month = 1; $month <= 12; $month++)
{
// The first date entry in the view may be in the last month.
if (($month - 1) % self::YEARVIEW_COLS == 0)
{
$content .= ''."\n";
$content .= "\t".'
'."\n";
}
$month_start = $this->datetime->get_weekday_start($this->year,$month,1);
// Beginning of the last week in the month
$month_end = $this->datetime->get_weekday_start(
$this->year,
$month,
$this->datetime->days_in_month($month,$this->year));
// End of the last week in month
$month_end = strtotime("+6 days",$month_end);
$content .= "\t\t".'
'."\n";
// Year Header
$content .= "\t\t\t".''."\n";
$content .= "\t\t\t".'
'."\n";
$content .= "\t\t\t\t".''.lang('Wk').'
'."\n";
// Day Columns, Legend
for ($i = 0; $i <= 6; $i++)
{
$day_date = ($i ? strtotime("+$i days",$month_start) : $month_start);
if (adodb_date('w',$day_date) % 6 == 0)
{
$style = 'calendar_cal_year_legend_weekend';
}
else
{
$style = 'calendar_cal_year_legend';
}
$content .= "\t\t\t\t".''.
lang(adodb_date('D',$day_date)).'
'."\n";
}
$content .= "\t\t\t".''."\n";
// Week rows in month
$week_start = $month_start;
for ($week_in_month = 1; $week_in_month <= 6; $week_in_month ++)
{
$content .= "\t\t\t".'
'."\n";
$content .= "\t\t\t\t".''."\n";
// Day columns in week row
for ($i = 0; $i <= 6; $i++)
{
$day_date = $i ? strtotime("+$i days",$week_start) : $week_start;
$day_ymd = $this->bo->date2string($day_date);
$eventcount = count($days[$day_ymd]);
$in_month = true;
$css_class = "";
$this->_day_class_holiday($day_ymd,$class,$holidays,false,false);
if (adodb_date('n',$day_date) != $month)
{
$css_class .= 'calendar_cal_year_legend';
$in_month = false;
}
else
{
$css_class .= 'calendar_calEvent calendar_calEventAllAccepted';
if (adodb_date('w',$day_date) % 6 == 0)
{
$css_class .= ' calendar_cal_year_weekend';
}
else
{
if ($holidays)
{
$css_class .= ' calendar_calHoliday';
}
else
{
$css_class .= ' calendar_cal_year_legend';
}
}
if ($day_ymd == $this->bo->date2string($this->bo->now_su))
{
$css_class .= ' calendar_cal_year_today';
}
}
$content .= "\t\t\t\t".''."\n";
$content .= "\t\t\t\t".''."\n";
if (($in_month) && (count($days[$day_ymd])))
{
$eventCols = $this->getEventCols($day_ymd,$days[$day_ymd]);
// displaying all event columns of the day
$row_height = 100 / count($eventCols);
$space_left = 4; //%
$space_right = 1; //%
$row_width = 11.5 - $space_left - $space_right;
// settings for time2pos
$this->scroll_to_wdstart = false;
$this->wd_start = 0;
$this->wd_end = 24*60;
$this->granularity_m = 24 * 60;
$this->extraRows = -1;
$this->remBotExtraRows = 0;
$this->rowHeight = $row_width;
foreach($eventCols as $n => $eventCol)
{
foreach ($eventCol as $event)
{
$indent = "\t\t\t\t";
// some fields set by the dayColWidget for the other views
unset($event['whole_day_on_top']);
$data = $this->eventWidget($event,25,$indent,$this->owner,true,'planner_event');
$left = ((($i + 1) * 12.5) + 0.5 + $space_left + $this->time2pos($event['start_m']));
$width = $this->time2pos($event['end_m'] - $event['start_m']);
$color = $data['color'] ? $data['color'] : 'gray';
$tooltip = html::htmlspecialchars($data['tooltip'], true); // true=need double-encoding, as it is transported as attribute!
$content .= $indent.'
'."\n".$data['html'].$indent."
\n";
}
}
}
}
$week_start = strtotime("+1 week",$week_start);
$content .= "\t\t\t".'
'."\n";
if (($month) % self::YEARVIEW_COLS == 0)
{
$content .= "\t
weekdaystarts='".$this->cal_prefs['weekdaystarts']."', get_weekday_start($this->year,$this->month,$this->day)=".date('l Y-m-d',$wd_start).", first=".date('l Y-m-d',$this->first)."
\n";
$navHeader = '';
$merge = $this->merge();
if($merge)
{
egw::redirect_link('/index.php',array(
'menuaction' => 'calendar.calendar_uiviews.index',
'msg' => $merge,
));
}
$search_params = array(
'start' => $this->first,
'end' => $this->last,
) + $this->search_params;
$users = $this->search_params['users'];
if (!is_array($users)) $users = array($users);
if (count($users) == 1 || count($users) > $this->bo->calview_no_consolidate) // for more then X users, show all in one row
{
$content = $this->timeGridWidget($this->tagWholeDayOnTop($this->bo->search($search_params)),$this->cal_prefs['interval']);
}
else
{
$content = '';
$headerCounter = 0;
foreach($this->_get_planner_users(false) as $uid => $label)
{
$content .= '';
$search_params['users'] = $uid;
$content .= ''.$label."\n";
$content .= $this->close_button($uid);
$content .= $this->timeGridWidget($this->tagWholeDayOnTop($this->bo->search($search_params)),
count($users) * $this->cal_prefs['interval'],400 / count($users),'','',$uid);
++$headerCounter;
if (count($users) > $headerCounter)
{
$content .= $navHeader;
}
$content .= '
';
}
$content = ''.$content.'
';
}
$content = $navHeader.$content;
if (!$home)
{
$this->do_header();
echo $content;
}
return $content;
}
/**
* Displays the dayview
*
* @param boolean $home = false if true return content suitable for home-page
*/
function &day($home=false)
{
if ($this->debug > 0) $this->bo->debug_message('uiviews::day() date=%1',True,$this->date);
$this->last = $this->first = $this->bo->date2ts((string)$this->date);
$GLOBALS['egw_info']['flags']['app_header'] .= ': '.$this->bo->long_date($this->first,0,false,true);
$this->use_time_grid = true; // day-view always uses a time-grid, independent what's set in the prefs!
$this->search_params['end'] = $this->last = $this->first+DAY_s-1;
$merge = $this->merge();
if($merge)
{
egw::redirect_link('/index.php',array(
'menuaction' => 'calendar.calendar_uiviews.index',
'msg' => $merge,
));
}
if (!$home)
{
$this->do_header();
$users = $this->search_params['users'];
if (!is_array($users)) $users = array($users);
// for more then X users, show all in one row
if (count($users) == 1 || count($users) > $this->bo->calview_no_consolidate)
{
$dayEvents =& $this->bo->search($this->search_params);
$owner = 0;
}
else
{
$dayEvents = $owner = array();
$search_params = $this->search_params;
foreach($this->_get_planner_users(false) as $uid => $label)
{
$search_params['users'] = $uid;
list(,$dayEvents[''.$label.''.$this->close_button($uid)]) = each($this->bo->search($search_params));
$owner[] = $uid;
}
}
$cols = array();
//Load the ""show holiday as event" preference here and set the event
//types mask accordingly.
$display_holidays_event = $GLOBALS['egw_info']['user']['preferences']['calendar']['display_holidays_event'];
$this->display_holiday_event_types = array(
'bdays' => ((int)$display_holidays_event & 1) != 0,
'hdays' => ((int)$display_holidays_event & 2) != 0
);
//Add the holiday events
$holidays = $this->_get_holiday_events($this->date, $this->display_holiday_event_types);
foreach($dayEvents as &$events)
{
$events = array_merge($events,$holidays);
}
unset($events);
unset($holidays);
$cols[0] =& $this->timeGridWidget($this->tagWholeDayOnTop($dayEvents),$this->cal_prefs['interval'],450,'','',$owner);
if (count($users) > 1)
{
$navHeader = '';
}
// only show todo's for a single user
if (count($users) == 1 && ($todos = $this->get_todos($todo_label)) !== false)
{
if ($GLOBALS['egw_info']['user']['apps']['infolog'])
{
foreach(array('task','phone','note') as $type)
{
$todo_label .= ' '.html::a_href( html::image('infolog',$type,lang('Add')),'infolog.infolog_ui.edit',array(
'type' => $type,
'start_time' => $ts,
),' data-todo="app|750x590"');
}
}
$cols[1] = html::div(
html::div($todo_label,'','calendar_calDayTodosHeader th')."\n".
html::div($todos,'','calendar_calDayTodosTable'),'','calendar_calDayTodos');
$cols['.1'] = 'width=30%';
echo html::table(array(
0 => $cols,
'.0' => 'valign="top"'
),'class="calendar_calDayView"');
}
else
{
$cols[0] = $navHeader . $cols[0];
echo $cols[0];
}
}
else
{
$content = $this->timeGridWidget($this->bo->search($this->search_params),$this->cal_prefs['interval'],300);
return $content;
}
}
/**
* Query the open ToDo's via a hook from InfoLog or any other 'calendar_include_todos' provider
*
* @param array/string $todo_label label for the todo-box or array with 2 values: the label and a boolean show_all
* On return $todo_label contains the label for the todo-box
* @return string/boolean html with a table of open todo's or false if no hook availible
*/
function get_todos(&$todo_label)
{
$todos_from_hook = $GLOBALS['egw']->hooks->process(array(
'location' => 'calendar_include_todos',
'year' => $this->year,
'month' => $this->month,
'day' => $this->day,
'owner' => $this->owner // num. id of the user, not necessary current user
));
if(is_array($todo_label))
{
list($label,$showall)=$todo_label;
}
else
{
$label=$todo_label;
$showall=true;
}
$maxshow = (int)$GLOBALS['egw_info']['user']['preferences']['infolog']['mainscreen_maxshow'];
if($maxshow <= 0)
{
$maxshow=10;
}
//print_debug("get_todos(): label=$label; showall=$showall; max=$maxshow");
$content = $todo_label = '';
if (is_array($todos_from_hook) && count($todos_from_hook))
{
foreach($todos_from_hook as $todos)
{
$i = 0;
if (is_array($todos))
{
$todo_label = !empty($label) ? $label : lang("open ToDo's:");
foreach($todos as $todo)
{
if(!$showall && ($i++ > $maxshow))
{
break;
}
$icons = '';
foreach($todo['icons'] as $name => $app)
{
$icons .= ($icons?' ':'').$GLOBALS['egw']->html->image($app,$name,lang($name),'border="0" width="15" height="15"');
}
$class = $class == 'row_on' ? 'row_off' : 'row_on';
if($todo['edit']) {
list($width, $height) = explode('x', $todo['edit']['size']);
unset($todo['edit']['size']);
$edit_icon_href = html::a_href( $icons, $todo['edit'],'',' data-todo="app|'.$width.'x'.$height.'" ');
$edit_href = html::a_href( $todo['title'], $todo['edit'],'',' data-todo="app|750x590" ');
}
$icon_href = html::a_href($icons,$todo['view']);
$href = html::a_href($todo['title'], $todo['view']);
$content .= " \n | ".
($this->bo->printer_friendly?$icons:($edit_icon_href ? $edit_icon_href : $icon_href)).
" | \n ".($this->printer_friendly?$todo['title']:
$edit_href)." | \n
\n";
/**
* ToDo: add delete and closing action
*/
}
}
}
}
if (!empty($content))
{
return "\n";
}
return $todo_label ? '' : false;
}
/**
* Calculates the vertical position based on the time
*
* workday start- and end-time, is taken into account, as well as timeGrids px_m - minutes per pixel param
*
* @param int $time in minutes
* @return float position in percent
*/
function time2pos($time)
{
if ($this->scroll_to_wdstart) // we display the complete day - thought only workday is visible without scrolling
{
return $this->rowHeight * (1 + $this->extraRows + $time/$this->granularity_m);
}
// time before workday => condensed in the first $this->extraRows rows
if ($this->wd_start > 0 && $time < $this->wd_start)
{
$pos = (($this->extraRows - $this->extraRowsOriginal + 1) + ($time / $this->wd_start * ($this->extraRowsOriginal - 1))) * $this->rowHeight;
}
// time after workday => condensed in the last row
elseif ($this->wd_end < 24*60 && $time > $this->wd_end+1*$this->granularity_m)
{
$pos = 100 - (($this->extraRows - $this->remBotExtraRows) * $this->rowHeight * (1 - ($time - $this->wd_end) / (24*60 - $this->wd_end)));
}
// time during the workday => 2. row on (= + granularity)
else
{
$pos = $this->rowHeight * (1+$this->extraRows+($time-$this->wd_start)/$this->granularity_m);
}
$pos = round($pos,1);
if ($this->debug > 3) $this->bo->debug_message('uiviews::time2pos(%1)=%2',False,$time,$pos);
return $pos;
}
/**
* Calculates the height of a difference between 2 times
*
* workday start- and end-time, is taken into account, as well as timeGrids px_m - minutes per pixel param
*
* @param int $start time in minutes
* @param int $end time in minutes
* @param int $minimum = 0 minimum height
* @return float height in percent
*/
function times2height($start,$end,$minimum=0)
{
$minimum = $this->rowHeight;
$height = $this->time2pos($end) - $this->time2pos($start);
if ($this->debug > 3) $this->bo->debug_message('uiviews::times2height(%1,%2,min=%3)=%4',False,$start,$end,$minimum,$height);
return $height >= $minimum ? $height : $minimum;
}
/**
* Creates a grid with rows for the time, columns for (multiple) days containing events
*
* Uses the dayColWidget to display each day.
*
* @param $daysEvents array with subarrays of events for each day to show, day as YYYYMMDD as key
* @param int $granularity_m = 30 granularity in minutes of the rows
* @param int $height = 400 height of the widget
* @param string $indent = '' string for correct indention
* @param string $title = '' title of the time-grid
* @param int/array $owner = 0 owner of the calendar (default 0 = $this->owner) or array with owner for each column
* @param boolean $last = true last timeGrid displayed, default true
*/
function &timeGridWidget($daysEvents,$granularity_m=30,$height=400,$indent='',$title='',$owner=0,$last=true)
{
if ($this->debug > 1 || $this->debug==='timeGridWidget') $this->bo->debug_message('uiviews::timeGridWidget(events=%1,granularity_m=%2,height=%3,,title=%4)',True,$daysEvents,$granularity_m,$height,$title);
// determine if the browser supports scrollIntoView: IE4+, firefox1.0+ and safari2.0+ does
// then show all hours in a div of the size of the workday and scroll to the workday start
// still disabled, as things need to be re-aranged first, to that the column headers are not scrolled
$this->scroll_to_wdstart = false;/*$this->use_time_grid && (html::$user_agent == 'msie' ||
html::$user_agent == 'mozilla' && html::ua_version >= 5.0 ||
html::$user_agent == 'safari' && html::ua_version >= 2.0);*/
if ($this->scroll_to_wdstart)
{
$this->extraRows = 0; // no extra rows necessary
$this->remBotExtraRows = 0;
$overflow = 'overflow: scroll;';
}
$this->granularity_m = $granularity_m;
$this->display_start = $this->wd_start - ($this->extraRows * $this->granularity_m);
$this->display_end = $this->wd_end + (($this->extraRows - $this->remBotExtraRows) * $this->granularity_m);
if (!$this->wd_end) $this->wd_end = 1440;
$totalDisplayMinutes = $this->wd_end - $this->wd_start;
$this->rowsToDisplay = ($totalDisplayMinutes/$granularity_m)+2+2*$this->extraRows - $this->remBotExtraRows;
$this->rowHeight = round(100/$this->rowsToDisplay,1);
// ensure a minimum height of each row
if ($height < ($this->rowsToDisplay+1) * 12)
{
$height = ($this->rowsToDisplay+1) * 12;
}
$html = $indent.''."\n";
$html .= $indent."\t".'\n";
if ($this->use_time_grid)
{
$off = false; // Off-row means a different bgcolor
$add_links = count($daysEvents) == 1;
// the hour rows
for($t = $this->scroll_to_wdstart ? 0 : $this->wd_start,$i = 1+$this->extraRows;
$t <= $this->wd_end || $this->scroll_to_wdstart && $t < 24*60;
$t += $this->granularity_m,++$i)
{
$set_id = '';
if ($t == $this->wd_start)
{
list($id) = @each($daysEvents);
if (is_numeric($id))
{
$id = 'wd_start_'.$id;
$set_id = ' id="'.$id.'"';
}
}
$html .= $indent."\t".'
'."\n";
// show time for full hours, allways for 45min interval and at least on every 3 row
$time = '';
static $show = array(
5 => array(0,15,30,45),
10 => array(0,30),
15 => array(0,30),
45 => array(0,15,30,45),
);
if (!isset($show[$this->granularity_m]) ? $t % 60 == 0 : in_array($t % 60,$show[$this->granularity_m]))
{
$time = $GLOBALS['egw']->common->formattime(sprintf('%02d',$t/60),sprintf('%02d',$t%60));
}
if ($add_links) $time = $this->add_link($time,$this->date,(int) ($t/60),$t%60);
$html .= $indent."\t\t".''.$time."
\n";
$html .= $indent."\t'."\n";
// Creation of the header-column with date, evtl. holiday-names and a matching background-color
$ts = $this->bo->date2ts((string)$day_ymd);
$title = !is_bool($short_title) ? $short_title :
($short_title ? lang(adodb_date('l',$ts)).' '.adodb_date('d.',$ts) : $this->bo->long_date($ts,0,false,true));
$day_view = array(
'menuaction' => 'calendar.calendar_uiviews.day',
'date' => $day_ymd,
);
$this->_day_class_holiday($day_ymd,$class,$holidays);
// the weekday and date
if (!$short_title && $holidays) $title .= html::htmlspecialchars(': '.$holidays);
if ($short_title === true)
{
if ($this->allowEdit)
{
$title = html::a_href($title,$day_view,'',
!isset($this->holidays[$day_ymd])?' title="'.$this->bo->long_date($ts,0,false,true).'"':'');
}
}
elseif ($short_title === false)
{
// add arrows to go to the previous and next day (dayview only)
$day_view['date'] = $this->bo->date2string($ts -= 12*HOUR_s);
if ($this->allowEdit)
{
$title = html::a_href(html::image('phpgwapi','left',$this->bo->long_date($ts)),$day_view).'
'.$title;
}
else
{
$title = $day_view.' '.$title;
}
$day_view['date'] = $this->bo->date2string($ts += 48*HOUR_s);
if ($this->allowEdit)
{
$title .= ' '.html::a_href(html::image('phpgwapi','right',$this->bo->long_date($ts)),$day_view);
}
else
{
$title .= ' '.$day_view;
}
}
if (is_bool($short_title) || ($short_title != "")) {
$html .= $indent."\t".'\n";
}
if ($this->use_time_grid)
{
// drag and drop: check if the current user has EDIT permissions on the grid
if($owner)
{
$dropPermission = $this->bo->check_perms(EGW_ACL_EDIT,0,$owner);
}
else
{
$dropPermission = true;
}
// adding divs to click on for each row / time-span
for($t = $this->scroll_to_wdstart ? 0 : $this->wd_start,$i = 1 + $this->extraRows;
$t <= $this->wd_end || $this->scroll_to_wdstart && $t < 24*60;
$t += $this->granularity_m,++$i)
{
$linkData = array(
'menuaction' =>'calendar.calendar_uiforms.edit',
'date' => $day_ymd,
'hour' => sprintf("%02d",floor($t / 60)),
'minute' => sprintf("%02d",floor($t % 60)),
);
if ($owner) $linkData['owner'] = $owner;
$droppableDateTime = $linkData['date'] . "T" . $linkData['hour'] . $linkData['minute'];
$droppableID='drop_'.$droppableDateTime.'_O'.($owner<0?str_replace('-','group',$owner):$owner);
$html .= $indent."\t".'
allowEdit)
{
$html .= ' data-date=' .$linkData['date'].'|'.$linkData['hour'].'|'.$linkData['minute'];
}
if($dropPermission && $owner)
{
$html .= ' data-owner ='.$owner;
}
$html .= '>
'."\n";
}
}
$eventCols = $this->getEventCols($day_ymd,$events);
// displaying all event columns of the day
foreach($eventCols as $n => $eventCol)
{
// equal sized columns
//$width = 95.0 / count($eventCols);
//$left = 2.5 + $n * $width;
// alternative overlapping columns
$left = 2.5 + (1.5 * 100 / $pwidth);
if (count($eventCols) == 1)
{
$width = 100 - $left;
}
else
{
$width = !$n ? 70 : 50;
$left += $n * (100.0-$left) / count($eventCols);
}
if ($left + $width > 100.0) $width = 100.0 - $left;
//echo "
count(\$eventCols)=".count($eventCols).", n=$n, pWidth=$pwidth, pLeft=$pleft, width=$width, left=$left
\n";
$html .= $this->eventColWidget($eventCol,$left,$width,$indent."\t",
$owner ? $owner : $this->user, 20+10*$n);
}
$html .= $indent."
use_time_grid ? ' top: '.$this->rowHeight.'%;' : '').'">'."\n";
foreach($events as $event)
{
$html .= $this->eventWidget($event,$width,$indent."\t",$owner,false,'event_widget',$z_index);
}
$html .= $indent."
\n";
return $html;
}
/**
* Shows one event
*
* The display of the event and it's tooltip is done via the event_widget.tpl template
*
* @param $event array with the data of event to show
* @param $width int width of the widget
* @param string $indent string for correct indention
* @param int $owner owner of the calendar the event is in
* @param boolean $return_array = false should an array with keys(tooltip,popup,html) be returned or the complete widget as string
* @param string $block = 'event_widget' template used the render the widget
* @param int $z_index is the z-index of the drag-drobable outer box of the event.
* @return string/array
*/
function eventWidget($event,$width,$indent,$owner,$return_array=false,$block='event_widget',$z_index=null)
{
if ($this->debug > 1 || $this->debug==='eventWidget') $this->bo->debug_message('uiviews::eventWidget(%1,width=%2)',False,$event,$width);
if($this->use_time_grid && $event['whole_day_on_top']) $block = 'event_widget_wholeday_on_top';
static $tpl = False;
if (!$tpl)
{
$tpl = new Template(common::get_tpl_dir('calendar'));
$tpl->set_file('event_widget_t','event_widget.tpl');
$tpl->set_block('event_widget_t','event_widget');
$tpl->set_block('event_widget_t','event_widget_wholeday_on_top');
$tpl->set_block('event_widget_t','event_tooltip');
$tpl->set_block('event_widget_t','planner_event');
}
if (($return_array || $event['start_m'] == 0) && $event['end_m'] >= 24*60-1)
{
if ($return_array && $event['end_m'] > 24*60)
{
$timespan = $this->bo->format_date($event['start'],false).' - '.$this->bo->format_date($event['end']);
}
else
{
$timespan = lang('all day');
}
}
else
{
$timespan = $this->bo->timespan($event['start_m'],$event['end_m']);
}
$icons = array();
if(!(int)$event['id'] && preg_match('/^([a-z_-]+)([0-9]+)$/i',$event['id'],$matches))
{
$app = $matches[1];
$app_id = $matches[2];
if (($is_private = calendar_bo::integration_get_private($app,$app_id,$event)))
{
$icons[] = html::image('calendar','private');
}
else
{
$icons = self::integration_get_icons($app,$app_id,$event);
}
}
elseif($event['id'])
{
if (($is_private = !$this->bo->check_perms(EGW_ACL_READ,$event)))
{
$icons = array(html::image('calendar','private'));
}
else
{
$icons = $this->event_icons($event);
}
}
$cats = $this->bo->categories($this->categories->check_list(EGW_ACL_READ, $event['category']),$color);
// these values control varius aspects of the geometry of the eventWidget
$small_trigger_width = 120 + 20*count($icons);
$corner_radius=$width > $small_trigger_width ? 10 : 5;
$header_height=$width > $small_trigger_width ? 19 : 12; // multi_3 icon has a height of 19=16+2*1padding+1border !
if (!$return_array)
{
$height = $this->times2height($event['start_m'],$event['end_m'],$header_height);
}
//$body_height = max(0,$height - $header_height - $corner_radius);
$border=1;
$headerbgcolor = $color ? $color : '#808080';
$headercolor = self::brightness($headerbgcolor) > 128 ? 'black' : 'white';
// the body-colors (gradient) are calculated from the headercolor, which depends on the cat of an event
$bodybgcolor1 = $this->brighter($headerbgcolor,$headerbgcolor == '#808080' ? 100 : 170);
$bodybgcolor2 = $this->brighter($headerbgcolor,220);
// mark event as invitation, by NOT using category based background color, but plain white
if ($event['participants'][$this->user][0] == 'U')
{
$bodybgcolor1 = $bodybgcolor2 = 'white';
}
// get status class of event: calendar_calEventAllAccepted, calendar_calEventAllAnswered or calendar_calEventSomeUnknown
$status_class = 'calendar_calEventAllAccepted';
foreach($event['participants'] as $id => $status)
{
if ($id < 0) continue; // as we cant accept/reject groups, we dont care about them here
calendar_so::split_status($status,$quantity,$role);
switch ($status)
{
case 'A':
case '': // app without status
break;
case 'U':
$status_class = 'calendar_calEventSomeUnknown';
break 2; // break foreach
default:
$status_class = 'calendar_calEventAllAnswered';
break;
}
}
// seperate each participant types
$part_array = array();
if ($this->allowEdit)
{
foreach($this->bo->participants($event) as $part_key => $participant)
{
if(is_numeric($part_key))
{
$part_array[lang('Participants')][$part_key] = $participant;
}
elseif(isset($this->bo->resources[$part_key[0]]))
{
$part_array[((isset($this->bo->resources[$part_key[0]]['participants_header'])) ? $this->bo->resources[$part_key[0]]['participants_header'] : lang($this->bo->resources[$part_key[0]]['app']))][$part_key] = $participant;
}
}
foreach($part_array as $part_group => $participant)
{
$participants .= $this->add_nonempty($participant,$part_group,True,False,false);
}
}
// as we only deal with percentual widht, we consider only the full dayview (1 colum) as NOT small
$small = $this->view != 'day' || $width < 50;
// $small = $width <= $small_trigger_width
$small_height = $this->use_time_grid && ( $event['end_m']-$event['start_m'] < 2*$this->granularity_m ||
$event['end_m'] <= $this->wd_start || $event['start_m'] >= $this->wd_end);
$tpl->set_var(array(
// event-content, some of it displays only if it really has content or is needed
'owner' => $GLOBALS['egw']->common->grab_owner_name($event['owner']),
'header_icons' => $small ? '' : implode("",$icons),
'body_icons' => $small ? implode("\n",$icons) : '',
'icons' => implode('',$icons),
'timespan' => $timespan,
'title' => ($title = !$is_private ? html::htmlspecialchars($event['title']) : lang('private')),
'header' => $small_height ? $title : $timespan,
'description' => !$is_private ? nl2br(html::htmlspecialchars($event['description'])) : '',
'location' => !$is_private ? $this->add_nonempty($event['location'],lang('Location')) : '',
'participants' => $participants,
'times' => !$event['multiday'] ? $this->add_nonempty($this->bo->timespan($event['start_m'],$event['end_m'],true),lang('Time')) :
$this->add_nonempty($this->bo->format_date($event['start']),lang('Start')).
$this->add_nonempty($this->bo->format_date($event['end']),lang('End')),
'multidaytimes' => !$event['multiday'] ? '' :
$this->add_nonempty($this->bo->format_date($event['start']),lang('Start')).
$this->add_nonempty($this->bo->format_date($event['end']),lang('End')),
'category' => !$is_private ? $this->add_nonempty($cats,lang('Category')) : '',
// the tooltip is based on the content of the actual widget, this way it takes no extra bandwidth/volum
// 'tooltip' => html::tooltip(False,False,array('BorderWidth'=>0,'Padding'=>0)),
// various aspects of the geometry or style
'corner_radius' => $corner_radius.'px',
'header_height' => $header_height.'px',
//'body_height' => $body_height.'px',
'height' => $height,
'width' => ($width-20).'px',
'border' => $border,
'bordercolor' => $headerbgcolor,
'headerbgcolor' => $headerbgcolor,
'headercolor' => $headercolor,
'bodybackground' => ($background = 'url('.$GLOBALS['egw_info']['server']['webserver_url'].
'/calendar/inc/gradient.php?color1='.urlencode($bodybgcolor1).'&color2='.urlencode($bodybgcolor2).
'&width='.$width.') repeat-y '.$bodybgcolor2),
'Small' => $small ? 'Small' : '', // to use in css class-names
'indent' => $indent."\t",
'status_class' => $status_class,
));
/* not used at the moment
foreach(array(
'upper_left'=>array('width'=>-$corner_radius,'height'=>$header_height,'border'=>0,'bgcolor'=>$headerbgcolor),
'upper_right'=>array('width'=>$corner_radius,'height'=>$header_height,'border'=>0,'bgcolor'=>$headerbgcolor),
'lower_left'=>array('width'=>-$corner_radius,'height'=>-$corner_radius,'border'=>$border,'color'=>$headerbgcolor,'bgcolor'=>$bodybgcolor1),
'lower_right'=>array('width'=>$corner_radius,'height'=>-$corner_radius,'border'=>$border,'color'=>$headerbgcolor,'bgcolor'=>$bodybgcolor2),
) as $name => $data)
{
$tpl->set_var($name.'_corner',$GLOBALS['egw_info']['server']['webserver_url'].
'/calendar/inc/round_corners.php?width='.$data['width'].'&height='.$data['height'].
'&bgcolor='.urlencode($data['bgcolor']).
(isset($data['color']) ? '&color='.urlencode($data['color']) : '').
(isset($data['border']) ? '&border='.urlencode($data['border']) : ''));
}
*/
// Add event description to cal event view body if the event is long enough (ATM 3 times longer than interval)
// to be able to show some lines of description text
if ($event['whole_day'] || ($event['end'] - $event['start']) > ($this->cal_prefs['interval'] * 3 * 60))
{
$tpl->set_var('bodydescription', !$is_private ? nl2br(html::htmlspecialchars($event['description'])) : '');
}
// set the bodydescription to empty if it is not visible
else
{
$tpl->set_var('bodydescription', '');
}
$tooltip = $tpl->fp('tooltip','event_tooltip');
$html = $tpl->fp('out',$block);
if ($is_private || !$this->allowEdit)
{
$popup = '';
}
elseif($app && $app_id)
{
$popup = $this->integration_get_popup($app,$app_id);
}
else
{
if ($event['recur_type'] != MCAL_RECUR_NONE)
{
$popup = $event['id']."|r";
}
else
{
$popup = $event['id']."|n";
}
}
$tooltip = html::htmlspecialchars($tooltip, true); // true=need double-encoding, as it is transported as attribute!
//_debug_array($event);
if ($return_array)
{
return array(
'tooltip' => $tooltip,
'popup' => $popup,
'html' => $html,
'private' => $is_private,
'color' => $color,
);
}
$draggableID = $event['id'].'_O'.$event['owner'].'_C'.($owner<0?str_replace('-','group',$owner):$owner);
if ($this->use_time_grid)
{
if($event['whole_day_on_top'])
{
$style = 'top: '.($this->rowHeight*$this->wholeDayPosCounter).'%; height: '.$this->rowHeight.'%;';
$this->wholeDayPosCounter++;
}
else
{ $view_link = $GLOBALS['egw']->link('/index.php',array('menuaction'=>'calendar.calendar_uiforms.edit','cal_id'=>$event['id'],'date'=>$this->bo->date2string($event['start'])));
$style = 'top: '.$this->time2pos($event['start_m']).'%; height: '.$height.'%;';
}
}
else
{
$style = 'position: relative; margin-top: 3px;';
}
$prefix_icon = isset($event['prepend_icon']) ? $event['prepend_icon'] : '';
$z_index = is_null($z_index) ? 20 : (int)$z_index;
if ($this->use_time_grid &&
((int)$event['id'] || substr($event['id'],0,7) == 'infolog') && $this->bo->check_perms(EGW_ACL_EDIT,$event))
{
if (!$event['whole_day_on_top'] &&
!$event['whole_day'] &&
!$event['recur_type'])
{
$draggableID = 'drag_'.$event['id'].'_O'.$event['owner'].'_C'.($owner<0?str_replace('-','group',$owner):$owner);
}
else
{
$draggableID = 'drag_'.$event['id'].'_O'.$event['owner'].'_C'.($owner<0?str_replace('-','group',$owner):$owner);
}
}
if (!$event['whole_day_on_top'] &&
!$event['whole_day'])
{
// S represents Series
// '' represents Single
$eventTypeTag = $event['recur_type']?'S':'';
}
else if (!$event['recur_type'])
{
// WD represents Whole Day
$eventTypeTag = 'WD';
}
else
{
// WDS represents Whole Day Series (recurrent whole day event)
$eventTypeTag = 'WDS';
}
// Helps client-side to bind handler to events with specific types tag
$resizableHelper = $this->bo->date2string($event['start']). '|' .$this->bo->format_date($event['start'],false) . '|' . $this->cal_prefs['interval'].'|'.$eventTypeTag;
$html = $indent.''.$prefix_icon."\n".$html."\n".
$indent."
"."\n";
return $html;
}
/**
* Get onclick attribute to open integration item for edit
*
* Name of the attribute is 'edit_link' and it should be an array with values for keys:
* - 'edit' => array('menuaction' => 'app.class.method')
* - 'edit_id' => 'app_id'
* - 'edit_popup' => '400x300' (optional)
*
* @param string $app
* @param int|string $id
* @return string
*/
function integration_get_popup($app,$id)
{
$app_data = calendar_bo::integration_get_data($app,'edit_link');
if (is_array($app_data) && isset($app_data['edit']))
{
$popup_size = $app_data['edit_popup'];
$edit = $app_data['edit'];
$edit[$app_data['edit_id']] = $id;
}
else
{
$edit = egw_link::edit($app,$id,$popup_size);
}
if ($edit)
{
$view_link = egw::link('/index.php',$edit);
if ($popup_size)
{
$popup = ' data-app="app|'.$popup_size.'"';
}
else
{
$popup = ' data-app="app|'.$app.'|'.'"';
}
}
return $popup;
}
/**
* Get icons for an integration event
*
* Attribute 'icons' is either null (--> navbar icon), false (--> no icon)
* or a callback with parameters $id,$event
*
* Icons specified in $events['icons'] are always displayed!
*
* @param string $app
* @param int|string $id
* @param array $event
* @return array
*/
static function integration_get_icons($app,$id,$event)
{
$icons = array();
if ($event['icons'])
{
foreach(explode(',',$event['icons']) as $icon)
{
list($icon_app,$icon) = explode(':',$icon);
if (common::find_image($icon_app,$icon))
{
$icons[] = html::image($icon_app,$icon);
}
}
}
$app_data = calendar_bo::integration_get_data($app,'icons');
if (is_null($app_data))
{
$icons[] = html::image($app,'navbar'); // use navbar icon
}
elseif ($app_data)
{
$icons += (array)ExecMethod2($app_data,$id,$event);
}
return $icons;
}
function add_nonempty($content,$label,$one_per_line=False,$space = True,$htmlspecialchars=true)
{
if (is_array($content))
{
if($space)
{
$content = implode($one_per_line ? ",\n" : ', ',$content);
}
else
{
$content = implode($one_per_line ? "\n" : ', ',$content);
}
}
if (!empty($content))
{
return ''.$label.':'.
($one_per_line ? '
' : ' ').
nl2br($htmlspecialchars?html::htmlspecialchars($content):$content).'
';
}
return '';
}
/**
* Calculates a brighter color for a given color
*
* @param $rgb string color as #rrggbb value
* @param $decr int value to add to each component, default 64
* @return string the brighter color
*/
static function brighter($rgb,$decr=64)
{
if (!preg_match('/^#?([0-9A-Fa-f]{2})([0-9A-Fa-f]{2})([0-9A-Fa-f]{2})$/',$rgb,$components))
{
return '#ffffff';
}
$brighter = '#';
for ($i = 1; $i <=3; ++$i)
{
$val = hexdec($components[$i]) + $decr;
if ($val > 255) $val = 255;
$brighter .= sprintf('%02x',$val);
}
//echo "brighter($rgb=".print_r($components,True).")=$brighter\n";
return $brighter;
}
/**
* Calculates the brightness of a hexadecimal rgb color (median of the r, g and b components)
*
* @param string $rgb eg. #808080
* @return int between 0 and 255
*/
static function brightness($rgb)
{
if ($rgb[0] != '#' || strlen($rgb) != 7)
{
return 128; // no rgb color, return some default
}
$dec = hexdec(substr($rgb,1));
for($i = 0; $i < 24; $i += 8)
{
$sum += ($dec >> $i) & 255;
}
return (int)round($sum / 3.0, 0);
}
/**
* Number of month to display in yearly planner
*/
const YEARLY_PLANNER_NUM_MONTH = 12;
/**
* Creates a planner view: grid with columns for the time and rows for categories or users
*
* Uses the plannerRowWidget to display rows
*
* @param array $events events to show
* @param mixed $start start-time of the grid
* @param mixed $end end-time of the grid
* @param string|int $by_cat rows by sub-categories of $by_cat (cat_id or 0 for upmost level) or by 'user' or 'month'
* @param string $indent = '' string for correct indention
* @return string with widget
*/
function &plannerWidget(&$events,$start,$end,$by_cat=0,$indent='')
{
$content = $indent.''."\n";
// display the header, containing a headerTitle and multiple headerRows with the scales
$content .= $indent."\t".'\n"; // end of the plannerHeader
// sort the events after user or category
$rows = array();
if (!is_array($events)) $events = array();
if ($by_cat === 'user') // planner by user
{
// convert filter to allowed status
switch($this->filter)
{
case 'unknown':
$status_to_show = array('U','G'); break;
case 'accepted':
$status_to_show = array('A'); break;
case 'tentative':
$status_to_show = array('T'); break;
case 'rejected':
$status_to_show = array('R'); break;
case 'delegated':
$status_to_show = array('D'); break;
case 'all':
$status_to_show = array('U','A','T','D','G','R'); break;
default:
$status_to_show = array('U','A','T','D','G'); break;
}
}
foreach($events as $key => $event)
{
if ($by_cat === 'user') // planner by user
{
foreach($event['participants'] as $sort => $status)
{
calendar_so::split_status($status,$nul,$nul);
// only show if participant with status visible with current filter
if (isset($sort2label[$sort]) && (in_array($status,$status_to_show) ||
$this->filter == 'owner' && $event['owner'] == $sort)) // owner too additionally uses owner
{
$rows[$sort][] =& $events[$key];
}
}
}
elseif ($by_cat === 'month') // planner by month / yearly planner
{
$sort = date('Y-m',$event['start']);
$rows[$sort][] =& $events[$key];
// end in a different month?
if ($sort != ($end_sort = date('Y-m',$event['end'])))
{
while($sort != $end_sort)
{
list($y,$m) = explode('-',$sort);
if (++$m > 12)
{
++$y;
$m = 1;
}
$sort = sprintf('%04d-%02d',$y,$m);
$rows[$sort][] =& $events[$key];
}
}
}
else // planner by cat
{
foreach($this->_get_planner_cats($event['category'],$sort2label,$sort2color) as $sort)
{
if (!is_array($rows[$sort])) $rows[$sort] = array();
$rows[$sort][] =& $events[$key];
}
}
}
$owners = explode(',',$this->owner);
// display a plannerRowWidget for each row (user or category)
foreach($sort2label as $sort => $label)
{
if (!isset($rows[$sort]) && (!$this->cal_prefs['planner_show_empty_rows'] ||
$by_cat === 'user' && $this->cal_prefs['planner_show_empty_rows'] == 'cat' ||
is_int($by_cat) && $this->cal_prefs['planner_show_empty_rows'] == 'user'))
{
continue; // dont show empty categories or user rows
}
$class = $class == 'row_on' ? 'row_off' : 'row_on';
if ($by_cat === 'month')
{
$time = new egw_time($sort.'-01');
$start = $time->format('ts');
$time->modify('+1month -1second');
$end = $time->format('ts');
}
// display close button only for directly set users, eg. not group-members (as we cant unset them!)
if ($by_cat === 'user' && in_array($sort, $owners))
{
$label .= $this->close_button($sort);
}
$content .= $this->plannerRowWidget(isset($rows[$sort]) ? $rows[$sort] : array(),$start,$end,$label,$class,$indent."\t");
}
$content .= $indent."
\n"; // end of the plannerWidget
return $content;
}
/**
* get all users to display in the planner_by_user
*
* @param boolean $enum_groups = true should groups be returned as there members (eg. planner) or not (day & week)
* @return array with uid => label pairs, first all users alphabetically sorted, then all resources
*/
function _get_planner_users($enum_groups=true)
{
$users = $resources = array();
foreach(explode(',',$this->owner) as $user)
{
if (!is_numeric($user)) // resources
{
$resources[$user] = $this->bo->participant_name($user);
}
elseif ($enum_groups && $GLOBALS['egw']->accounts->get_type($user) == 'g') // groups
{
foreach((array) $GLOBALS['egw']->accounts->member($user) as $data)
{
$user = $data['account_id'];
if ($this->bo->check_perms(EGW_ACL_READ | EGW_ACL_FREEBUSY,0,$user))
{
$users[$user] = $this->bo->participant_name($user);
}
}
}
else // users
{
$users[$user] = $this->bo->participant_name($user);
}
}
// Only sort users in planner views
if ($enum_groups)
{
asort($users);
asort($resources);
}
return $users+$resources;
}
/**
* get all categories used as sort criteria for the planner by category
*
* the returned cat is as direct sub-category of $this->cat_id or a main (level 1) category if !$this->cat_id
*
* @param string $cats comma-delimited cat_id's or empty for no cat
* @param array &$sort2label labels for the returned cats
* @return array with cat_id's
*/
function _get_planner_cats($cats,&$sort2label)
{
static $cat2sort;
if (!is_array($cat2sort))
{
$cat2sort = array();
$cat_filter = $this->cat_id ? (array)$this->cat_id : array();
foreach((array)$this->categories->return_sorted_array(0,false,'','','',true) as $data)
{
if (in_array($data['parent'], $cat_filter) || in_array($data['id'], $cat_filter) ||
!$data['parent'] && !$cat_filter) // cat is a direct sub of $this->cat_id
{
$cat2sort[$data['id']] = $data['id'];
$sort2label[$data['id']] = stripslashes($data['name']);
}
elseif(isset($cat2sort[$data['parent']])) // parent is already in the array => add us with same target
{
$cat2sort[$data['id']] = $cat2sort[$data['parent']];
}
}
}
$ret = array();
foreach(!is_array($cats) ? explode(',',$cats) : $cats as $cat)
{
if (isset($cat2sort[$cat]) && !in_array($cat2sort[$cat],$ret))
{
$ret[] = $cat2sort[$cat];
}
}
if (!count($ret))
{
$sort2label[0] = lang('none');
$ret[] = 0;
}
//echo "uiviews::_get_planner_cats($cats=".$this->categories->id2name($cats).") (this->cat_id=$this->cat_id) = ".print_r($ret,true).'='.$this->categories->id2name($ret[0])."
\n";
return $ret;
}
/**
* Creates month scale for the planner
*
* @param int $start start-time (12h) of the scale
* @param int $days number of days to display
* @param string $indent = '' string for correct indention
* @return string with scale
*/
function plannerMonthScale($start,$days,$indent)
{
$day_width = round(100 / $days,2);
$content .= $indent.''."\n";
for($t = $start,$left = 0,$i = 0; $i < $days; $t += $days_in_month*DAY_s,$left += $days_in_month*$day_width,$i += $days_in_month)
{
$t_arr = $this->bo->date2array($t);
unset($t_arr['raw']); // force recalculation
unset($t_arr['full']);
$days_in_month = $this->datetime->days_in_month($t_arr['month'],$t_arr['year']) - ($t_arr['day']-1);
if ($i + $days_in_month > $days)
{
$days_in_month = $days - $i;
}
if ($days_in_month > 10)
{
$title = lang(date('F',$t)).' '.$t_arr['year'];
// previous links
$prev = $t_arr;
$prev['day'] = 1;
if ($prev['month']-- <= 1)
{
$prev['month'] = 12;
$prev['year']--;
}
if ($this->bo->date2ts($prev) < $start-20*DAY_s)
{
$prev['day'] = $this->day;
$full = $this->bo->date2string($prev);
if ($this->day >= 15) $prev = $t_arr; // we stay in the same month
$prev['day'] = $this->day < 15 ? 15 : 1;
$half = $this->bo->date2string($prev);
$title = html::a_href(html::image('phpgwapi','first',lang('back one month'),$options=' alt="<<"'),array(
'menuaction' => $this->view_menuaction,
'date' => $full,
)) . ' '.
html::a_href(html::image('phpgwapi','left',lang('back half a month'),$options=' alt="<"'),array(
'menuaction' => $this->view_menuaction,
'date' => $half,
)) . ' '.$title;
}
// next links
$next = $t_arr;
if ($next['month']++ >= 12)
{
$next['month'] = 1;
$next['year']++;
}
// dont show next scales, if there are more then 10 days in the next month or there is no next month
$days_in_next_month = (int) date('d',$end = $start+$days*DAY_s);
if ($days_in_next_month <= 10 || date('m',$end) == date('m',$t))
{
if ($this->day >= 15) $next = $t_arr; // we stay in the same month
$next['day'] = $this->day;
$full = $this->bo->date2string($next);
if ($this->day < 15) $next = $t_arr; // we stay in the same month
$next['day'] = $this->day < 15 ? 15 : 1;
$half = $this->bo->date2string($next);
$title .= ' '.html::a_href(html::image('phpgwapi','right',lang('forward half a month'),$options=' alt=">>"'),array(
'menuaction' => $this->view_menuaction,
'date' => $half,
)). ' '.
html::a_href(html::image('phpgwapi','last',lang('forward one month'),$options=' alt=">>"'),array(
'menuaction' => $this->view_menuaction,
'date' => $full,
));
}
}
else
{
$title = ' ';
}
$class = $class == 'row_on' ? 'th' : 'row_on';
$content .= $indent."\t".'
'.
$title."
\n";
}
$content .= $indent."
'."\n";
for($t = $start,$left = 0,$i = 0; $i < $days; $t += 7*DAY_s,$left += $week_width,$i += 7)
{
$title = lang('Week').' '.$this->week_number($t);
if ($days > 7)
{
$title = html::a_href($title,array(
'menuaction' => 'calendar.calendar_uiviews.planner',
'planner_days' => 7,
'date' => date('Ymd',$t),
),false,' title="'.html::htmlspecialchars(lang('Weekview')).'"');
}
else
{
// prev. week
$title = html::a_href(html::image('phpgwapi','first',lang('previous'),$options=' alt="<<"'),array(
'menuaction' => $this->view_menuaction,
'date' => date('Ymd',$t-7*DAY_s),
)) . '
'.$title;
// next week
$title .= ' '.html::a_href(html::image('phpgwapi','last',lang('next'),$options=' alt=">>"'),array(
'menuaction' => $this->view_menuaction,
'date' => date('Ymd',$t+7*DAY_s),
));
}
$class = $class == 'row_on' ? 'th' : 'row_on';
$content .= $indent."\t".'
'.$title."
\n";
}
$content .= $indent."
'."\n";
for($t = $start,$left = 0,$i = 0; $i < $days; $t += DAY_s,$left += $day_width,++$i)
{
$this->_day_class_holiday($this->bo->date2string($t),$class,$holidays,$days > 7);
if ($days <= 3)
{
$title = '
'.lang(date('l',$t)).', '.date('j',$t).'. '.lang(date('F',$t)).'';
}
elseif ($days <= 7)
{
$title = lang(date('l',$t)).'
'.date('j',$t).'. '.lang(date('F',$t));
}
else
{
$title = substr(lang(date('D',$t)),0,2).'
'.date('j',$t);
}
if ($days > 1)
{
$title = html::a_href($title,array(
'menuaction' => 'calendar.calendar_uiviews.planner',
'planner_days' => 1,
'date' => date('Ymd',$t),
),false,strpos($class,'calendar_calHoliday') !== false || strpos($class,'calendar_calBirthday') !== false ? '' : ' title="'.html::htmlspecialchars(lang('Dayview')).'"');
}
if ($days < 5)
{
if (!$i) // prev. day only for the first day
{
$title = html::a_href(html::image('phpgwapi','first',lang('previous'),$options=' alt="<<"'),array(
'menuaction' => $this->view_menuaction,
'date' => date('Ymd',$start-DAY_s),
)) . ' '.$title;
}
if ($i == $days-1) // next day only for the last day
{
$title .= ' '.html::a_href(html::image('phpgwapi','last',lang('next'),$options=' alt=">>"'),array(
'menuaction' => $this->view_menuaction,
'date' => date('Ymd',$start+DAY_s),
));
}
}
$content .= $indent."\t".'
'.$title."
\n";
}
$content .= $indent."
'."\n";
$title = lang(egw_time::to($this->first,'F')).' '.egw_time::to($this->first,'Y').' - '.
lang(egw_time::to($this->last,'F')).' '.egw_time::to($this->last,'Y');
// calculate date for navigation links
$time = new egw_time($this->first);
$time->modify('-1year');
$last_year = $time->format('Ymd');
$time->modify('+11month');
$last_month = $time->format('Ymd');
$time->modify('+2month');
$next_month = $time->format('Ymd');
$time->modify('+11month');
$next_year = $time->format('Ymd');
$title = html::a_href(html::image('phpgwapi','first',lang('back one year'),$options=' alt="<<"'),array(
'menuaction' => $this->view_menuaction,
'date' => $last_year,
)) . ' '.
html::a_href(html::image('phpgwapi','left',lang('back one month'),$options=' alt="<"'),array(
'menuaction' => $this->view_menuaction,
'date' => $last_month,
)) . ' '.$title;
$title .= ' '.html::a_href(html::image('phpgwapi','right',lang('forward one month'),$options=' alt=">>"'),array(
'menuaction' => $this->view_menuaction,
'date' => $next_month,
)). ' '.
html::a_href(html::image('phpgwapi','last',lang('forward one year'),$options=' alt=">>"'),array(
'menuaction' => $this->view_menuaction,
'date' => $next_year,
));
$content .= $indent."\t".'
'.
$title."
\n";
$content .= $indent."
'."\n";
$today = egw_time::to('now','d');
for($left = 0,$i = 0; $i < 31; $left += $day_width,++$i)
{
$class = $i & 1 ? 'row_on' : 'row_off';
$content .= $indent."\t".'
'.
(1+$i)."
\n";
}
$content .= $indent."
'."\n";
for($t = $start,$left = 0,$i = 0; $i < $hours; $t += $decr*HOUR_s,$left += $cell_width,$i += $decr)
{
$title = date($this->cal_prefs['timeformat'] == 12 ? 'ha' : 'H',$t);
$class = $class == 'row_on' ? 'th' : 'row_on';
$content .= $indent."\t".'
'.$title."
\n";
}
$content .= $indent."
'."\n";
foreach($events as $event)
{
$content .= $this->plannerEventWidget($event,$start,$end,$indent."\t");
}
$content .= $indent."
\n";
return $content;
}
/**
* Calculate a time-dependent position in the planner
*
* We use a non-linear scale in the planner monthview, which shows the workday start or end
* as start or end of the whole day. This improves the resolution a bit.
*
* @param int $time
* @param int $start start-time of the planner
* @param int $end end-time of the planner
* @return float percentage position between 0-100
*/
function _planner_pos($time,$start,$end)
{
if ($time <= $start) return 0; // we are left of our scale
if ($time >= $end) return 100; // we are right of our scale
if ($this->planner_days || $this->sortby == 'month')
{
$percent = ($time - $start) / ($end - $start);
}
else // monthview
{
$t_arr = $this->bo->date2array($time);
$day_start = $this->bo->date2ts((string)$t_arr['full']);
$percent = ($day_start - $start) / ($end - $start);
$time_of_day = 60 * $t_arr['hour'] + $t_arr['minute'];
if ($time_of_day >= $this->wd_start)
{
if ($time_of_day > $this->wd_end)
{
$day_percentage = 1;
}
else
{
$wd_lenght = $this->wd_end - $this->wd_start;
if ($wd_lenght <= 0) $wd_lenght = 24*60;
$day_percentage = ($time_of_day-$this->wd_start) / $wd_lenght; // between 0 and 1
}
$days = ($end - $start) / DAY_s;
$percent += $day_percentage / $days;
}
}
$percent = round(100 * $percent,2);
//echo "_planner_pos(".date('Y-m-d H:i',$time).', '.date('Y-m-d H:i',$start).', '.date('Y-m-d H:i',$end).") = $percent
\n";
return $percent;
}
/**
* Displays one event for the planner, using the eventWidget of the other views
*
* @param array $event
* @param int $start start-time of the planner
* @param int $end end-time of the planner
* @return string with widget
*/
function plannerEventWidget($event,$start,$end,$indent='')
{
// some fields set by the dayColWidget for the other views
$day_start = $this->bo->date2ts((string)$this->bo->date2string($event['start']));
$event['start_m'] = ($event['start'] - $day_start) / 60;
$event['end_m'] = round(($event['end'] - $day_start) / 60);
$event['multiday'] = true;
unset($event['whole_day_on_top']);
$data = $this->eventWidget($event,200,$indent,$this->owner,true,'planner_event');
$left = $this->_planner_pos($event['start'],$start,$end);
$width = $this->_planner_pos($event['end'],$start,$end) - $left;
$color = $data['color'] ? $data['color'] : 'gray';
$tooltip = html::htmlspecialchars(str_replace(array("\n","\r","'",'"'),array('','',"\\'",'"'),$data['tooltip']));
return $indent.''."\n".$data['html'].$indent."
\n";
}
/**
* Marks whole day events for later usage and increments extraRows
*
* @param array $dayEvents
* @return array $dayEvents
*/
function tagWholeDayOnTop($dayEvents)
{
$this->extraRows = $this->extraRowsOriginal;
$this->remBotExtraRows = 0;
if (is_array($dayEvents))
{
foreach ($dayEvents as $day=>$oneDayEvents)
{
$extraRowsToAdd = 0;
foreach ($oneDayEvents as $num => $event)
{
$start = $this->bo->date2array($event['start']);
$end = $this->bo->date2array($event['end']);
if(!$start['hour'] && !$start['minute'] && $end['hour'] == 23 && $end['minute'] == 59)
{
if($event['non_blocking'])
{
$dayEvents[$day][$num]['whole_day_on_top']=true;
$this->whole_day_positions[$num]=($this->rowHeight*($num+2));
$extraRowsToAdd++;
}
else
{
$dayEvents[$day][$num]['whole_day']=true;
}
}
}
// check after every day if we have to increase $this->extraRows
if(($this->extraRowsOriginal+$extraRowsToAdd) > $this->extraRows)
{
$this->remBotExtraRows = $extraRowsToAdd;
$this->extraRows = ($this->extraRowsOriginal+$extraRowsToAdd);
}
}
}
return $dayEvents;
}
/**
*
* Returns the special icon html code for holidays
*
* @param string $type is the type of the holiday, currently either 'hday' or
* 'bday'
*/
function _get_holiday_icon($type)
{
//Set the special icon which will be prepended to the event
switch ($type) {
case "bday":
return html::image('calendar', 'cake', '', "style=\"float:left; padding: 1px 2px 0px 2px;\"");
case "hday":
return html::image('calendar', 'date', '', "style=\"float:left; padding: 1px 2px 0px 2px;\"");
}
}
/**
*
* Creates a dummy holiday event. This event is shown in the day view, when
* added to the event list.
*
* @param int $day_start is a unix timestamp which contains the start of the day
* when the event occurs.
* @param string $title is the title of the dummy event which will be shown
* @param string $description is the long description of the event which will
* be shown in the event tooltip
*/
function _make_holiday_event($day_start, $title, $description, $type = 'bday')
{
//Calculate the end of the day by adding 23h:59min seconds
$day_end = $day_start + 24 * 3600 - 60;
//Setup the event data
$event = array(
'title' => $title,
'description' => $description,
'participants' => array(
),
'whole_day_on_top' => true,
'start' => $day_start,
'end' => $day_end,
'non_blocking' => true,
'prepend_icon' => $this->_get_holiday_icon($type)
);
return $event;
}
/**
*
* Collects all holidays/birthdays corresponding to the given day and creates
* an array containing all this events.
*
* @param string $day_ymd contains the Ymd of the day
* @param array $types is an array which determines which types of events should
* be added to the holiday list. May contain the indices "bdays" and "hdays".
* The default is "bdays => true"
*/
function _get_holiday_events($day_ymd, $types = array("bdays" => true, "hdays" => false))
{
//Check whether there are any holidays set for the current day_ymd
$events = array();
if (isset($this->holidays[$day_ymd]))
{
//Translate the day_ymd to a timestamp
$day_start = $this->bo->date2ts((string)$day_ymd);
//Iterate over the holidays array and add those the the events list
foreach($this->holidays[$day_ymd] as $holiday)
{
if (isset($holiday['birthyear']))
{
if (array_key_exists("bdays", $types) && $types['bdays'])
{
$events[] = $this->_make_holiday_event(
$day_start, $holiday['name'],
lang('Age:').(date('Y') - $holiday['birthyear']));
}
}
else
{
if (array_key_exists("hdays", $types) && $types['hdays'])
{
$events[] = $this->_make_holiday_event($day_start, $holiday['name'], '', 'hday');
}
}
}
}
return $events;
}
}