start.php

<?php
/**
* Kaltura video client
* @package ElggKalturaVideo
* @license http://www.gnu.org/licenses/gpl.html GNU Public License version 3
* @author Ivan Vergés <ivan@microstudi.net>
* @copyright Ivan Vergés 2010
* @link http://microstudi.net/elgg/
**/

function kaltura_video_init() {
	// Load system configuration
	global $CONFIG;
	
	//Add the javascript
	elgg_extend_view('page/elements/head', 'kaltura/jscripts');
	
	// This enables the videojs player
	elgg_register_js("videojs-player", "http://vjs.zencdn.net/c/video.js", 'head', 100);
	elgg_register_css("videojs-css", "http://vjs.zencdn.net/c/video-js.css");
	
	$kaltura_video_js = elgg_get_simplecache_url('js', 'kaltura_video/kaltura_video');
	elgg_register_simplecache_view('js/kaltura_video/kaltura_video');
	elgg_register_js('elgg.kaltura_video', $kaltura_video_js);
	
	elgg_register_js('swfobject', 'http://ajax.googleapis.com/ajax/libs/swfobject/2.2/swfobject.js');
	
	elgg_register_library('kaltura_video', $CONFIG->pluginspath . 'kaltura_video/lib/kaltura_video.php');
	
	// Add plugin settings to configuration
	$settings = elgg_get_plugin_from_id('kaltura_video');
	elgg_set_config('kaltura_server_url', $settings->kaltura_server_url);
	elgg_set_config('kaltura_partner_id', $settings->partner_id);

	// Extend system CSS with our own styles, which are defined in the blog/css view
	elgg_extend_view('css','kaltura/css');

	// Add group option
	add_group_tool_option('kaltura_video', elgg_echo('kalturavideo:enablevideo'), true);
	elgg_extend_view('groups/tool_latest', 'kaltura/group_module');

	// Register a page handler, so we can have nice URLs
	elgg_register_page_handler('kaltura_video','kaltura_video_page_handler');

	// Register a url handler
	elgg_register_entity_url_handler('object', 'kaltura_video', 'kaltura_video_url');

	// Register granular notification for this type
	if (is_callable('register_notification_object')) {
		register_notification_object('object', 'kaltura_video', elgg_echo('kalturavideo:newvideo'));
	}

	// Listen to notification events and supply a more useful message
	elgg_register_plugin_hook_handler('notify:entity:message', 'object', 'kaltura_notify_message');
	
	// entity menu
	elgg_register_plugin_hook_handler('register', 'menu:entity', 'kaltura_video_entity_menu');
	elgg_register_plugin_hook_handler('register', 'menu:owner_block', 'kaltura_video_owner_block_menu');
	elgg_register_plugin_hook_handler('entity:icon:url', 'object', 'kaltura_video_thumbnail_url');

	// Add profile widget
    elgg_register_widget_type('kaltura_video',elgg_echo('kalturavideo:label:latest'),elgg_echo('kalturavideo:text:widgetdesc'));

	// Add index widget
	$enableindexwidget = elgg_get_plugin_setting('enableindexwidget', 'kaltura_video');
	if (!$enableindexwidget) {
		$enableindexwidget = 'single';
	}

	if (in_array($enableindexwidget , array('single', 'multi'))) {
		elgg_extend_view('index/righthandside', 'kaltura/customindex.videos');
	}

	// Register entity type
	elgg_register_entity_type('object', 'kaltura_video');

	$actionspath = elgg_get_plugins_path() . 'kaltura_video/actions/kaltura_video';
	elgg_register_action("kaltura_video/delete", "$actionspath/delete.php");
	elgg_register_action("kaltura_video/update", "$actionspath/update.php");
	elgg_register_action("kaltura_video/rate", "$actionspath/rate.php");
	//elgg_register_action("kaltura_video/save", "$actionspath/update.php"); // @todo Should we use this or "save.php"?
	elgg_register_action("kaltura_video/save", "$actionspath/save.php");

	if (elgg_is_admin_logged_in()) {
		$path = $CONFIG->pluginspath . "kaltura_video/actions/admin/kaltura_video";
		elgg_register_action("admin/kaltura_video/server", "$path/server.php", 'admin');
		elgg_register_action("admin/kaltura_video/behavior", "$path/behavior.php", 'admin');
		elgg_register_action("admin/kaltura_video/custom", "$path/custom.php", 'admin');
		elgg_register_action("admin/kaltura_video/wizard", "$path/wizard.php", 'admin');
	}
}

/**
 * Returns a more meaningful message
 *
 * @param unknown_type $hook
 * @param unknown_type $entity_type
 * @param unknown_type $returnvalue
 * @param unknown_type $params
 */
function kaltura_video_notify_message($hook, $entity_type, $returnvalue, $params) {
	$entity = $params['entity'];
	$to_entity = $params['to_entity'];
	$method = $params['method'];
	if (($entity instanceof ElggEntity) && ($entity->getSubtype() == 'kaltura_video')) {
		$descr = $entity->description;
		$title = $entity->title;
		if ($method == 'sms') {
			$owner = $entity->getOwnerEntity();
			return $owner->username . ' via video: ' . $title;
		}
		if ($method == 'email') {
			$owner = $entity->getOwnerEntity();
			return $owner->username . ' via video: ' . $title . "\n\n" . $descr . "\n\n" . $entity->getURL();
		}
	}
	return null;
}

/**
 * Format and return the URL for videos.
 *
 * @param ElggObject $entity Kaltura video object
 * @return string URL of video.
 */
function kaltura_video_url($entity) {
	if (!$entity->getOwnerEntity()) {
		// default to a standard view if no owner.
		return FALSE;
	}
	
	$title = elgg_get_friendly_title($entity->title);
	
	return "kaltura_video/view/{$entity->guid}/$title";
}

/**
* Post init gumph.
*/
function kaltura_video_page_setup() {
	// Show menu only if plugin is configured
	if (elgg_get_plugin_setting("password", "kaltura_video")) {
		// Add site menu item
		elgg_register_menu_item('site', array(
			'name' => 'kaltura_video',
			'href' => 'kaltura_video/all',
			'text' => elgg_echo('kaltura_video'),
		));
	}
	
	// Admin links to plugin configuration pages
	elgg_register_admin_menu_item('configure', 'server', 'kaltura_video');
	elgg_register_admin_menu_item('configure', 'custom', 'kaltura_video');
	elgg_register_admin_menu_item('configure', 'wizard', 'kaltura_video');
	elgg_register_admin_menu_item('configure', 'advanced', 'kaltura_video');
	elgg_register_admin_menu_item('configure', 'behavior', 'kaltura_video');
	elgg_register_admin_menu_item('configure', 'credits', 'kaltura_video');
	//elgg_register_admin_menu_item('configure', 'develop', 'kaltura_video');
}

/**
 * Register title button that opens kcw inside a lightbox.
 * 
 * @todo This is propably using some custom javascript. How about
 * using Elgg's default lightbox functionalities instead?
 */
function kaltura_video_register_title_button() {
	if (elgg_is_logged_in()) {
		$owner = elgg_get_page_owner_entity();
		if (!$owner) {
			// no owns the page so this is probably an all site list page
			$owner = elgg_get_logged_in_user_entity();
		}
		
		if ($owner && $owner->canWriteToContainer()) {
			// Allow the view to be called via ajax
			elgg_register_ajax_view('kaltura/kcw');
			
			elgg_register_menu_item('title', array(
				'name' => 'kaltura_video_create2',
				'href' => 'mod/kaltura_video/views/default/kaltura/kcw.php',
				'text' => elgg_echo('kalturavideo:label:newvideo'),
				'class' => array('elgg-button', 'elgg-button-action', 'elgg-lightbox'),
				'rel' => 'lightbox',
			));
			
			elgg_load_js('lightbox');
			elgg_load_css('lightbox');
			
			/*
			elgg_register_menu_item('title', array(
				'name' => 'kaltura_video_create',
				'href' => '#kaltura_create',
				'text' => elgg_echo('kalturavideo:label:newvideo'),
				'class' => array('elgg-button', 'elgg-button-action'),
			));
			*/
		}
	}
}

/**
 * Add a menu item to an ownerblock
 */
function kaltura_video_owner_block_menu($hook, $type, $return, $params) {
	if (elgg_instanceof($params['entity'], 'user')) {
		$url = "kaltura_video/owner/{$params['entity']->username}";
		$item = new ElggMenuItem('kaltura_video', elgg_echo('kaltura_video'), $url);
		$return[] = $item;
	} else {
		if ($params['entity']->kaltura_video_enable != "no") {
			$url = "kaltura_video/group/{$params['entity']->guid}/all";
			$item = new ElggMenuItem('kaltura_video', elgg_echo('kaltura_video:group'), $url);
			$return[] = $item;
		}
	}

	return $return;
}

/**
 * Add particular links/info to entity menu
 */
function kaltura_video_entity_menu($hook, $type, $return, $params) {
	if (elgg_in_context('widgets')) {
		return $return;
	}

	$entity = $params['entity'];
	$handler = elgg_extract('handler', $params, false);
	if ($handler != 'kaltura_video') {
		return $return;
	}

	// Link for editing the video
	if ($entity->canEdit()) {
		$status_text = elgg_echo("kalturavideo:label:edit");
		$options = array(
			'name' => 'kaltura_video_edit',
			'id' => 'kaltura-video-edit',
			'text' => "<span>$status_text</span>",
			'href' => "#",
			'priority' => 150,
			'class' => 'edit',
			'rel' => $entity->kaltura_video_id,
		);
		$return[] = ElggMenuItem::factory($options);
	}

	return $return;
}

/**
 * Adds a toggle to extra menu for switching between list and gallery views
 */
function kaltura_video_register_toggle() {
	$url = elgg_http_remove_url_query_element(current_page_url(), 'list_type');

	if (get_input('list_type', 'list') == 'list') {
		$list_type = "gallery";
		$icon = elgg_view_icon('grid');
	} else {
		$list_type = "list";
		$icon = elgg_view_icon('list');
	}

	if (substr_count($url, '?')) {
		$url .= "&list_type=" . $list_type;
	} else {
		$url .= "?list_type=" . $list_type;
	}

	elgg_register_menu_item('extras', array(
		'name' => 'file_list',
		'text' => $icon,
		'href' => $url,
		'title' => elgg_echo("file:list:$list_type"),
		'priority' => 1000,
	));
}

/**
 * Dispatches video pages.
 * URLs take the form of
 *  All videos:      kaltura_video/all
 *  User's videos:   kaltura_video/owner/<username>
 *  Friends' videos: kaltura_video/friends/<username>
 *  Single video:    kaltura_video/view/<guid>/<title>
 *  Edit video:      kaltura_video/edit/<guid>/<revision>
 *  Group videos:    kaltura_video/group/<guid>/all
 *
 * @param array $page
 * @return NULL
 */
function kaltura_video_page_handler($page) {	
	$file_dir = elgg_get_plugins_path() . 'kaltura_video/pages/kaltura_video';

	// @todo How about checking CONFIG instead of plugin settings?
	if (!elgg_get_plugin_setting("password", "kaltura_video")) {
		// If the URL is just 'feeds/username', or just 'feeds/', load the standard feeds index
		include("$file_dir/missconfigured.php");
		return true;
	}

	elgg_load_library('kaltura_video');
	elgg_load_css('videojs-css');
	elgg_load_js('videojs-player');
	elgg_load_js('elgg.kaltura_video');
	elgg_load_js('swfobject');

	// push all blogs breadcrumb
	elgg_push_breadcrumb(elgg_echo('kaltura_video:allvideos'), "kaltura_video/all");
	
	if (!isset($page[0])) {
		$page[0] = 'all';
	}

	$page_type = $page[0];
	$view_params = null;
	switch ($page_type) {
		case 'owner':
			kaltura_video_register_toggle();
			include "$file_dir/index.php";
			break;
		case 'friends':
			kaltura_video_register_toggle();
			include "$file_dir/friends.php";
			break;
		case 'add':
			gatekeeper();
			set_input('entry_id', $page[1]);
			$view_params = kaltura_video_get_page_content_edit();
			//include "$file_dir/edit.php";
			break;			
		case 'edit':
			gatekeeper();
			set_input('guid', $page[1]);
			$view_params = kaltura_video_get_page_content_edit('edit', $page[1]);
			//include "$file_dir/edit.php";
			break;
		case 'view':
			set_input('guid', $page[1]);
			$view_params = kaltura_video_get_page_content_read($page[1]);
			//include("$file_dir/show.php");
			break;
		case 'group':
			kaltura_video_register_toggle();
			$view_params = kaltura_video_get_page_content_list($page[1]);
			break;
		case 'all':
		default:
			kaltura_video_register_toggle();
			$view_params = kaltura_video_get_page_content_list();
			//include "$file_dir/everyone.php";
			break;
	}
	
	if (!empty($view_params)) {
		//var_dump($view_params);
		$body = elgg_view_layout('content', $view_params);
	
		echo elgg_view_page($view_params['title'], $body);
		return true;
	}
}

/**
 * Generate url that gets the correct size thumbnail through Kaltura API
 *
 * @param string $hook
 * @param string $entity_type
 * @param string $return_value
 * @param array  $params
 * @return string
 */
function kaltura_video_thumbnail_url($hook, $entity_type, $return_value, $params) {	
	// if someone already set this, quit
	if ($return_value) {
		return null;
	}

	$video = $params['entity'];
	$size = $params['size'];
	
	if (!elgg_instanceof($video, 'object', 'kaltura_video')) {
		return null;
	}
	
	// Get image pixel dimensions from icon size configuration
	$icon_sizes = elgg_get_config('icon_sizes');
	$width = $icon_sizes[$size]['w'];
	$height = $icon_sizes[$size]['h'];
	
	$url = $video->thumbnail_url . "/width/{$width}/height/{$height}/";
	
	return $url;
}

// @todo The plugin was initialized last (9999) to be able to hack the htmlawed
// and allow <object> tags. But couldn't we use a plugin hook instead?
elgg_register_event_handler('init', 'system', 'kaltura_video_init');
elgg_register_event_handler('pagesetup', 'system', 'kaltura_video_page_setup');