EGroupware / egroupware

calendar/sitemgr/class.module_calendar_month.inc.php

<?php
/**************************************************************************\
 * eGroupWare SiteMgr - Web Content Management                              *
 * http://www.egroupware.org                                                *
 * --------------------------------------------                             *
 *  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.                                              *
 \**************************************************************************/

use EGroupware\Api;
use EGroupware\Api\Framework;
use EGroupware\Api\Acl;

/* $Id$ */

class module_calendar_month extends Module
{
	/**
	 * Instance of the business object of calendar
	 *
	 * @var bo
	 */
	var $bo;
	/**
	 * Instance of the user interface object of calendar
	 *
	 * @var ui
	 */
	var $ui;
	/**
	 * Instance of the user interface object of calendar
	 *
	 * @var ui
	 */
	var $uiviews;
	/**
	 * Instance of the Api\Accounts object
	 *
	 * @var Api\Accounts
	 */
	var $accounts;
	/**
	 * Default CSS style
	 *
	 * @var default_css

The type default_css was not found. Maybe you did not declare it correctly or list all dependencies?

	 */
	var $default_css = '/calendar/templates/default/app.css';

	function __construct()
	{
		$this->bo = new calendar_bo();

It seems like new calendar_bo() of type calendar_bo is incompatible with the declared type bo of property $bo.

		$this->arguments = array(

The property arguments does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

			'category' => array(
				'type' => 'select',
				'label' => lang('Choose a category'),
				'options' => array(),	// specification of options is postponed into the get_user_interface function
				'multiple' => true,
			),
			'numWeeks' => array(
				'type' => 'textfield',
				'label' => lang('Number of weeks to show'),
				'default' => 2,
				'params' => array('size' => 1)
			),
			'showWeeks' => array(
				'type' => 'checkbox',
				'label' => lang('Should the number of weeks be shown on top of the calendar'),
				'default' => false,
			),
			'showTitle' => array(
				'type' => 'checkbox',
				'label' => lang('Show a calendar title'),
				'default' => false,
			),
			'search' => array(
				'type' => 'textfield',
				'label' => lang('Search string for the events'),
			),
			'users' => array(
				'type' => 'select',
				'options' => array(),
				'label' => lang('Group(s) or user(s) whose calendars to show (if ACL exists)'),
				// 'multiple' => true, is set in the get_user_interface function.
			),
			'grid' => array(
				'type' => 'checkbox',
				'label' => lang('Should the grid be shown in the calendar'),
				'default' => false,
			),
			'css' => array(
				'type' => 'textfield',
				'label' => lang('User selectable CSS file for the calendar setup'),
				'default' => $this->default_css,
			),
			'acceptDateParam' => array(
				'type' => 'checkbox',
				'label' => lang('Shall the date parameter be accepted (e.g. from calendar module)?'),
				'default' => false,
			),
		);
		$this->title = lang('Calendar - Multi-Weekly');

The property title does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		$this->description = lang("This module displays a user's calendar as multiple weeks. Don't give calendar application access to the anon user!");

The property description does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

	}

	function get_user_interface()
	{
		// copied from bookmarks module.
		$cat = createobject('phpgwapi.categories','','calendar');

The function CreateObject() has been deprecated: use autoloadable class-names and new

		$cats = $cat->return_array('all',0,False,'','cat_name','',True);
		$cat_ids = array();
		foreach($cats as $category)
		{
			$cat_ids[$category['id']] = $GLOBALS['egw']->strip_html($category['name']);
		}
		$this->arguments['category']['options'] = $cat_ids;

The property arguments does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		if (count($cat_ids) > 5) {
			$this->arguments['category']['multiple'] = 5;
		}

		if (! isset($GLOBALS['egw']->accounts))
		{
			$GLOBALS['egw']->accounts = new Api\Accounts();
		}
		$this->accounts =& $GLOBALS['egw']->accounts;
		$search_params=array(
			'type' => 'both',
			'app' => 'calendar',
		);
		$accounts = $this->accounts->search($search_params);
		$users = array();
		$groups = array();
		// sort users and groups separately.
		if (isset($GLOBALS['sitemgr_info']['anonymous_user']))
		{
			$anon_user = $this->accounts->name2id($GLOBALS['sitemgr_info']['anonymous_user'],'account_lid','u');
		}
		else
		{
			// sitemgr is not in global variables. Get it.
			/*
			 * Get possible sitemgr paths from the HTTP_REFERRER in order to unreveal the
			 * anonymous user for the correct site.
			 */
			$sitemgr_path = preg_replace('/^[^\/]+:\/\/[^\/]+\/([^\?]*)(\?.*)*$/',"/\${1}",$_SERVER['HTTP_REFERER']);
			// Remove the trailing file- / pathname if any
			$sitemgr_path = preg_replace('/[^\/]*$/', '', $sitemgr_path);
			// Add leading slash if it has been lost.
			if (strncmp('/', $sitemgr_path, 1) != 0)
			{
				$sitemgr_path = '/'.$sitemgr_path;
			}

			// Code adapted from sitemgr-site/index.php
			$site_urls = array();
			$site_urls[] = $sitemgr_path;
			$site_urls[] = ($_SERVER['HTTPS'] ? 'https://' : 'http://') . $_SERVER['SERVER_ADDR'] . $sitemgr_path;
			$site_urls[] = $site_url = ($_SERVER['HTTPS'] ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'] . $sitemgr_path;

The assignment to $site_url is dead and can be removed.

			$anon_user = $this->accounts->name2id($GLOBALS['egw']->db->select('egw_sitemgr_sites','anonymous_user,anonymous_passwd,site_id',
				array('site_url' => $site_urls),__LINE__,__FILE__,false,'','sitemgr')->fetchColumn(),'account_lid','u');
		}

		$anon_groups = $this->accounts->memberships($anon_user,true);
		foreach ($accounts as $entry)
		{
			$is_group = false;
			$has_read_permissions = false;
			$acl = new Acl($entry['account_id']);
			$acl->read_repository();
			// get the rights for each account to check whether the anon user has read permissions.
			$rights = $acl->get_rights($anon_user,'calendar');
			// also add the anon user if it's his own calendar.
			if (($rights & Acl::READ) || ($entry['account_id'] == $anon_user))
			{
				$has_read_permissions = true;
			}
			else
			{
				// scan the groups which pass on permissions to the anon user group member
				// or ass permissions if this is the anon group's calendar.
				foreach ($anon_groups as $parent_group)
				{
					$rights = $acl->get_rights($parent_group,'calendar');
					if (($rights & Acl::READ) || ($entry['account_id'] == $parent_group))
					{
						$has_read_permissions = true;
						break;
					}
				}
			}
			if ($has_read_permissions)
			{
				// Separate groups from users for improved readability.
				if ($is_group)
				{
					$groups[$entry['account_id']] = $entry['account_lid'];
				}
				else
				{
					$users[$entry['account_id']] = Api\Accounts::format_username($entry['account_lid'],$entry['account_firstname'],$entry['account_lastname']);
				}
			}
		}
		asort($groups);
		asort($users);
		// concat users and groups to the option array.
		$this->arguments['users']['options'] = $groups + $users;
		if (count($this->arguments['users']['options']) > 10)
		{
			$this->arguments['users']['multiple'] = 10;
		}
		else if (count($this->arguments['users']['options']) > 0)
		{
			$this->arguments['users']['multiple'] = true;
		}

		return parent::get_user_interface();
	}

	function get_content(&$arguments,$properties)
	{
		$html = "";
		Api\Translation::add_app('calendar');
		$this->ui = new calendar_uiviews();

It seems like new calendar_uiviews() of type calendar_uiviews is incompatible with the declared type ui of property $ui.

		$this->ui->allowEdit = false;
		$this->ui->use_time_grid = isset($arguments['grid']) ? $arguments['grid'] : false;

		$weeks = $arguments['numWeeks'] ? (int) $arguments['numWeeks'] : 2;

		if (($arguments['acceptDateParam']) && (get_var('date',array('POST','GET'))))

The function get_var was not found. Maybe you did not declare it correctly or list all dependencies?

		{
			$start = (int) (strtotime(get_var('date',array('POST','GET'))) +
					(60 * 60 * 24 * 7 * $dateOffset));

The variable $dateOffset seems to be never defined.

		}
		else
		{
			$start = (int) ($this->bo->now_su +
					(60 * 60 * 24 * 7 * $dateOffset));
		}
		$start = new Api\DateTime($start);
		$start->setWeekstart();
		$first = $start->format('ts');
		$last = strtotime("+$weeks weeks",$first) - 1;

		if ($arguments['showTitle'])
		{
			$html .= '<div id="divAppboxHeader">'.$GLOBALS['egw_info']['apps']['calendar']['title'].' - '.lang('Weekview').": ";
			$html .= lang('After %1',$this->bo->long_date($first));

The call to lang() has too many arguments starting with $this->bo->long_date($first).

			$html .= "</div>";
		}

		// set the search parameters
		$search_params = Array
		(
			'offset' => false,
			'order' => 'cal_start ASC',
			'start' => $first,
			'end' => $last,
			'daywise' => true,
		);
		$search_string = trim($arguments['search']);
		if ($search_string != "")
		{
			$search_params['query'] = $search_string;
		}
		if (count($arguments['category']) > 0)
		{
			$search_params['cat_id'] = $arguments['category'];
		}
		if ((is_array($arguments['users'])) && (count($arguments['users']) > 0))
		{
			$search_params['users'] = $arguments['users'];
		}
		$rows = $this->bo->search($search_params);
		if ($arguments['showWeeks'])
		{
			$html .= "<div>".lang('Next')." ".lang('%1 weeks', $weeks).":</div>\n";
		}
		$css_file = isset($arguments['css']) ? $arguments['css'] : $this->default_css;
		$html .= '<!-- BEGIN Calendar info -->'."\n";
		$html .= '<style type="text/css">'."\n";
		$html .= '<!--'."\n";
		$html .= '@import url('.$GLOBALS['egw_info']['server']['webserver_url'].$css_file.");\n";
		$html .= '-->'."\n";
		$html .= '</style>'."\n";
		$html .= '<!-- END Calendar info -->'."\n";
		unset($css_file);
		// we add DAY_s/2 to $this->first (using 12h), to deal with daylight saving changes
		for ($week_start = $first; $week_start < $last; $week_start = strtotime("+1 week",$week_start))
		{
			$week = array();
			for ($i = 0; $i < 7; ++$i)
			{
				$day_ymd = $this->bo->date2string($i ? strtotime("+$i days",$week_start) : $week_start);
				$week[$day_ymd] = array_shift($rows);
			}
			$week_view = array(

The assignment to $week_view is dead and can be removed.

				'menuaction' => false,
				'date' => $this->bo->date2string($week_start),
			);
			$title = lang('Wk').' '.adodb_date('W',$week_start);

The assignment to $title is dead and can be removed.

			if (!isset($GLOBALS['egw']->template))
			{
				$GLOBALS['egw']->template = new Framework\Template;
			}
		}
		// Initialize Tooltips
		$html .= '<script language="JavaScript" type="text/javascript" src="'.$GLOBALS['egw_info']['server']['webserver_url'].'/phpgwapi/js/wz_tooltip/wz_tooltip.js"></script>'."\n";

		return $html;
	}
}