egroupware/calendar/inc/class.calendar_export_ical.inc.php

153 lines
4.0 KiB
PHP

<?php
/**
* EGroupware: iCal export plugin of calendar
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package calendar
* @subpackage importexport
* @link http://www.egroupware.org
* @author Nathan Gray
* @copyright Nathan Gray
* @version $Id$
*/
use EGroupware\Api;
/**
* iCal export plugin of calendar
*/
class calendar_export_ical extends calendar_export_csv {
/**
* Exports records as defined in $_definition
*
* @param egw_record $_definition
*/
public function export( $_stream, importexport_definition $_definition) {
$options = $_definition->plugin_options;
$this->bo = new calendar_bo();
$boical = new calendar_ical();
// Custom fields need to be specifically requested
$cfs = array();
$limit_exception = Api\Storage\Merge::is_export_limit_excepted();
if (!$limit_exception) $export_limit = Api\Storage\Merge::getExportLimit('calendar');
if($options['selection'] == 'criteria')
{
$query = array(
'start' => $options['criteria']['start'],
'end' => strtotime('+1 day',$options['criteria']['end'])-1,
'categories' => $options['categories'],
'daywise' => false,
'users' => $options['criteria']['owner'],
'cfs' => $cfs // Otherwise we shouldn't get any custom fields
);
if(Api\Storage\Merge::hasExportLimit($export_limit) && !$limit_exception) {
$query['offset'] = 0;
$query['num_rows'] = (int)$export_limit; // ! int of 'no' is 0
}
$events =& $this->bo->search($query);
}
// Scheduled export will use 'all', which we don't allow through UI
elseif ($options['selection'] == 'search_results' || $options['selection'] == 'all')
{
$states = $this->bo->cal_prefs['saved_states'];
$query = Api\Cache::getSession('calendar', 'calendar_list');
$query['num_rows'] = -1; // all
$query['start'] = 0;
$query['cfs'] = $cfs;
if(Api\Storage\Merge::hasExportLimit($export_limit) && !$limit_exception) {
$query['num_rows'] = (int)$export_limit; // ! int of 'no' is 0
}
$ui = new calendar_uilist();
if($states['view'] == 'listview')
{
$unused = null;
$ui->get_rows($query, $events, $unused);
}
else
{
$query = Api\Cache::getSession('calendar', 'session_data');
$query['users'] = explode(',', $query['owner']);
$query['num_rows'] = -1;
$query['filter'] = 'custom';
$events = array();
$ui->get_rows($query, $events, $unused);
}
}
// compile list of unique cal_id's, as iCal should contain whole series, not recurrences
// calendar_ical->exportVCal needs to read events again, to get them in server-time
$ids = array();
foreach($events as $event)
{
$id = is_array($event) ? $event['id'] : $event;
if (($id = (int)$id)) $ids[$id] = $id;
}
$ical =& $boical->exportVCal($ids,'2.0','PUBLISH',false);
fwrite($_stream, $ical);
}
/**
* returns translated name of plugin
*
* @return string name
*/
public static function get_name() {
return lang('Calendar iCal export');
}
/**
* returns translated (user) description of plugin
*
* @return string descriprion
*/
public static function get_description() {
return lang("Exports events from your Calendar in iCal format.");
}
/**
* retruns file suffix for exported file
*
* @return string suffix
*/
public static function get_filesuffix() {
return 'ics';
}
public static function get_mimetype() {
return 'text/calendar';
}
/**
* return html for options.
*
*/
public function get_options_etpl($definition = null) {
unset($definition); // not used, but required by function signature
}
/**
* returns selectors of this plugin
*
*/
public function get_selectors_etpl($definition = null) {
$data = parent::get_selectors_etpl($definition);
$data['content']['no_filter'] = true;
return $data;
}
/**
* Get the class name for the egw_record to use while exporting
*
* @return string;
*/
public static function get_egw_record_class()
{
return 'calendar_egw_record';
}
}