Merge branch '2.5.x' of github.com:sourcefabric/Airtime into 2.5.x

This commit is contained in:
drigato 2013-12-11 14:45:28 -05:00
commit 8aa838bb34
4 changed files with 180 additions and 115 deletions

View File

@ -46,17 +46,54 @@ class Application_Common_DateHelper
} }
/** /**
* Get the week start date of this week in the format
* YYYY-MM-DD
* *
* @return String - week start date * @return DateTime - YYYY-MM-DD 00:00 in station timezone of today
*/ */
function getWeekStartDate() public static function getTodayStationStartDateTime()
{ {
$stationTimezone = new DateTimeZone(Application_Model_Preference::GetDefaultTimezone());
$now = new DateTime("now", $stationTimezone);
$now->setTime(0, 0, 0);
return $now;
}
/**
*
* @return DateTime - YYYY-MM-DD 00:00 in station timezone of tomorrow
*/
public static function getTodayStationEndDateTime()
{
$stationTimezone = new DateTimeZone(Application_Model_Preference::GetDefaultTimezone());
$now = new DateTime("now", $stationTimezone);
$now->add(new DateInterval("P1D"));
$now->setTime(0, 0, 0);
return $now;
}
/**
*
* @return DateTime - YYYY-MM-DD 00:00 in station timezone
*/
public static function getWeekStartDateTime()
{
$now = self::getTodayStationStartDateTime();
// our week starts on monday, but php week starts on sunday. // our week starts on monday, but php week starts on sunday.
$startDate = date('w') == 0 ? date('Y-m-d', strtotime('monday last week')) : date('Y-m-d', strtotime('monday this week')); $day = $now->format('w');
$startDateTime = new DateTime($startDate); if ($day == 0) {
return $startDateTime->format('Y-m-d H:i:s'); $day = 7;
}
$dayDiff = $day - 1;
if ($dayDiff > 0) {
$now->sub(new DateInterval("P{$dayDiff}D"));
}
return $now;
} }
/** /**
@ -234,24 +271,6 @@ class Application_Common_DateHelper
return $dateTime; return $dateTime;
} }
/* Convenience method to return a date formatted into a String rather than a
* DateTime object. Note that if an empty string is provided for $p_dateString
* then the current time is provided.
*
* @param $p_dateString
* Date string in UTC timezone.
* @param $p_format
* Format which the string should be returned in.
*
* @return string
* Date String in localtime
* */
public static function ConvertToLocalDateTimeString($p_dateString, $p_format="Y-m-d H:i:s"){
if (is_null($p_dateString) || strlen($p_dateString) == 0)
return $p_dateString;
return self::ConvertToLocalDateTime($p_dateString)->format($p_format);
}
public static function ConvertToUtcDateTimeString($p_dateString, $p_format="Y-m-d H:i:s"){ public static function ConvertToUtcDateTimeString($p_dateString, $p_format="Y-m-d H:i:s"){
if (is_null($p_dateString) || strlen($p_dateString) == 0) if (is_null($p_dateString) || strlen($p_dateString) == 0)
return $p_dateString; return $p_dateString;
@ -325,6 +344,59 @@ class Application_Common_DateHelper
return $retVal; return $retVal;
} }
/*
* @param $datetime string Y-m-d H:i:s in UTC timezone
*
* @return string in $format default Y-m-d H:i:s in station timezone
*/
public static function UTCStringToStationTimezoneString($datetime, $format="Y-m-d H:i:s") {
$stationTimezone = new DateTimeZone(Application_Model_Preference::GetDefaultTimezone());
$utcTimezone = new DateTimeZone("UTC");
$d = new DateTime($datetime, $utcTimezone);
$d->setTimezone($stationTimezone);
return $d->format($format);
}
/*
* @param $datetime string Y-m-d H:i:s in UTC timezone
*
* @return string Y-m-d H:i:s in user's timezone
*/
public static function UTCStringToUserTimezoneString($datetime, $format="Y-m-d H:i:s") {
$userTimezone = new DateTimeZone(Application_Model_Preference::GetUserTimezone());
$utcTimezone = new DateTimeZone("UTC");
$d = new DateTime($datetime, $utcTimezone);
$d->setTimezone($userTimezone);
return $d->format($format);
}
/**
* Convert the columns given in the array $columnsToConvert in the
* database result $rows to local timezone.
*
* @param array $rows arrays of arrays containing database query result
* @param array $columnsToConvert array of column names to convert
* @param string (station|user) convert to either station or user timezone.
*/
public static function convertTimestamps(&$rows, $columnsToConvert, $domain="station")
{
if (!is_array($rows)) {
return;
}
$converter = "UTCStringTo".ucfirst($domain)."TimezoneString";
foreach ($rows as &$row) {
foreach ($columnsToConvert as $column) {
$row[$column] = self::$converter($row[$column]);
}
}
}
/** /**
* This function is used for calculations! Don't modify for display purposes! * This function is used for calculations! Don't modify for display purposes!
* *

View File

@ -80,13 +80,16 @@ class ApiController extends Zend_Controller_Action
return; return;
} }
$tz = new DateTimeZone(Application_Model_Preference::GetUserTimezone());
$now = new DateTime("now", $tz);
$this->view->calendarInit = array( $this->view->calendarInit = array(
"timestamp" => time(), "timestamp" => time(),
"timezoneOffset" => date("Z"), "timezoneOffset" => $now->format("Z"),
"timeScale" => Application_Model_Preference::GetCalendarTimeScale(), "timeScale" => Application_Model_Preference::GetCalendarTimeScale(),
"timeInterval" => Application_Model_Preference::GetCalendarTimeInterval(), "timeInterval" => Application_Model_Preference::GetCalendarTimeInterval(),
"weekStartDay" => Application_Model_Preference::GetWeekStartDay() "weekStartDay" => Application_Model_Preference::GetWeekStartDay()
); );
$this->_helper->json->sendJson(array()); $this->_helper->json->sendJson(array());
@ -267,9 +270,8 @@ class ApiController extends Zend_Controller_Action
// disable the view and the layout // disable the view and the layout
$this->view->layout()->disableLayout(); $this->view->layout()->disableLayout();
$this->_helper->viewRenderer->setNoRender(true); $this->_helper->viewRenderer->setNoRender(true);
$date = new Application_Common_DateHelper; $utcTimeNow = gmdate("Y-m-d H:i:s");
$utcTimeNow = $date->getUtcTimestamp();
$utcTimeEnd = ""; // if empty, getNextShows will use interval instead of end of day $utcTimeEnd = ""; // if empty, getNextShows will use interval instead of end of day
$request = $this->getRequest(); $request = $this->getRequest();
@ -284,44 +286,40 @@ class ApiController extends Zend_Controller_Action
} }
// make getNextShows use end of day // make getNextShows use end of day
$utcTimeEnd = Application_Common_DateHelper::GetDayEndTimestampInUtc(); $end = Application_Common_DateHelper::getTodayStationEndDateTime();
$result = array("env"=>APPLICATION_ENV, $end->setTimezone(new DateTimeZone("UTC"));
"schedulerTime"=>gmdate("Y-m-d H:i:s"), $utcTimeEnd = $end->format("Y-m-d H:i:s");
"currentShow"=>Application_Model_Show::getCurrentShow($utcTimeNow), $result = array(
"nextShow"=>Application_Model_Show::getNextShows($utcTimeNow, $limit, $utcTimeEnd) "env" => APPLICATION_ENV,
); "schedulerTime" => $utcTimeNow,
// XSS exploit prevention "currentShow" => Application_Model_Show::getCurrentShow($utcTimeNow),
foreach ($result["currentShow"] as &$current) { "nextShow" => Application_Model_Show::getNextShows($utcTimeNow, $limit, $utcTimeEnd)
$current["name"] = htmlspecialchars($current["name"]); );
} }
foreach ($result["nextShow"] as &$next) { else {
$next["name"] = htmlspecialchars($next["name"]);
}
Application_Model_Show::convertToLocalTimeZone($result["currentShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"));
Application_Model_Show::convertToLocalTimeZone($result["nextShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"));
} else {
$result = Application_Model_Schedule::GetPlayOrderRange(); $result = Application_Model_Schedule::GetPlayOrderRange();
// XSS exploit prevention // XSS exploit prevention
$result["previous"]["name"] = htmlspecialchars($result["previous"]["name"]); $result["previous"]["name"] = htmlspecialchars($result["previous"]["name"]);
$result["current"]["name"] = htmlspecialchars($result["current"]["name"]); $result["current"]["name"] = htmlspecialchars($result["current"]["name"]);
$result["next"]["name"] = htmlspecialchars($result["next"]["name"]); $result["next"]["name"] = htmlspecialchars($result["next"]["name"]);
foreach ($result["currentShow"] as &$current) {
$current["name"] = htmlspecialchars($current["name"]);
}
foreach ($result["nextShow"] as &$next) {
$next["name"] = htmlspecialchars($next["name"]);
}
//Convert from UTC to localtime for Web Browser.
Application_Model_Show::ConvertToLocalTimeZone($result["currentShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"));
Application_Model_Show::ConvertToLocalTimeZone($result["nextShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"));
} }
// XSS exploit prevention
foreach ($result["currentShow"] as &$current) {
$current["name"] = htmlspecialchars($current["name"]);
}
foreach ($result["nextShow"] as &$next) {
$next["name"] = htmlspecialchars($next["name"]);
}
//Convert from UTC to station time for Web Browser.
Application_Common_DateHelper::convertTimestamps($result["currentShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"),
"station");
Application_Common_DateHelper::convertTimestamps($result["nextShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"),
"station");
//used by caller to determine if the airtime they are running or widgets in use is out of date. //used by caller to determine if the airtime they are running or widgets in use is out of date.
$result['AIRTIME_API_VERSION'] = AIRTIME_API_VERSION; $result['AIRTIME_API_VERSION'] = AIRTIME_API_VERSION;
@ -343,23 +341,37 @@ class ApiController extends Zend_Controller_Action
$this->view->layout()->disableLayout(); $this->view->layout()->disableLayout();
$this->_helper->viewRenderer->setNoRender(true); $this->_helper->viewRenderer->setNoRender(true);
$date = new Application_Common_DateHelper; //weekStart is in station time.
$dayStart = $date->getWeekStartDate(); $weekStartDateTime = Application_Common_DateHelper::getWeekStartDateTime();
$utcDayStart = Application_Common_DateHelper::ConvertToUtcDateTimeString($dayStart);
$dow = array("monday", "tuesday", "wednesday", "thursday", "friday", $dow = array("monday", "tuesday", "wednesday", "thursday", "friday",
"saturday", "sunday", "nextmonday", "nexttuesday", "nextwednesday", "saturday", "sunday", "nextmonday", "nexttuesday", "nextwednesday",
"nextthursday", "nextfriday", "nextsaturday", "nextsunday"); "nextthursday", "nextfriday", "nextsaturday", "nextsunday");
$result = array(); $result = array();
for ($i=0; $i<14; $i++) { $utcTimezone = new DateTimeZone("UTC");
$utcDayEnd = Application_Common_DateHelper::GetDayEndTimestamp($utcDayStart); $stationTimezone = new DateTimeZone(Application_Model_Preference::GetDefaultTimezone());
$weekStartDateTime->setTimezone($utcTimezone);
$utcDayStart = $weekStartDateTime->format("Y-m-d H:i:s");
for ($i = 0; $i < 14; $i++) {
//have to be in station timezone when adding 1 day for daylight savings.
$weekStartDateTime->setTimezone($stationTimezone);
$weekStartDateTime->add(new DateInterval('P1D'));
//convert back to UTC to get the actual timestamp used for search.
$weekStartDateTime->setTimezone($utcTimezone);
$utcDayEnd = $weekStartDateTime->format("Y-m-d H:i:s");
$shows = Application_Model_Show::getNextShows($utcDayStart, "ALL", $utcDayEnd); $shows = Application_Model_Show::getNextShows($utcDayStart, "ALL", $utcDayEnd);
$utcDayStart = $utcDayEnd; $utcDayStart = $utcDayEnd;
Application_Model_Show::convertToLocalTimeZone($shows, Application_Common_DateHelper::convertTimestamps(
array("starts", "ends", "start_timestamp", $shows,
"end_timestamp")); array("starts", "ends", "start_timestamp","end_timestamp"),
"station"
);
$result[$dow[$i]] = $shows; $result[$dow[$i]] = $shows;
} }
@ -493,9 +505,8 @@ class ApiController extends Zend_Controller_Action
try { try {
$show_inst = new Application_Model_ShowInstance($show_instance_id); $show_inst = new Application_Model_ShowInstance($show_instance_id);
$show_inst->setRecordedFile($file_id); $show_inst->setRecordedFile($file_id);
//$show_start_time = Application_Common_DateHelper::ConvertToLocalDateTimeString($show_inst->getShowInstanceStart()); }
catch (Exception $e) {
} catch (Exception $e) {
//we've reached here probably because the show was //we've reached here probably because the show was
//cancelled, and therefore the show instance does not exist //cancelled, and therefore the show instance does not exist
//anymore (ShowInstance constructor threw this error). We've //anymore (ShowInstance constructor threw this error). We've

View File

@ -263,20 +263,28 @@ class ScheduleController extends Zend_Controller_Action
/* Convert all UTC times to localtime before sending back to user. */ /* Convert all UTC times to localtime before sending back to user. */
if (isset($range["previous"])) { if (isset($range["previous"])) {
$range["previous"]["starts"] = Application_Common_DateHelper::ConvertToLocalDateTimeString($range["previous"]["starts"]); $range["previous"]["starts"] = Application_Common_DateHelper::UTCStringToUserTimezoneString($range["previous"]["starts"]);
$range["previous"]["ends"] = Application_Common_DateHelper::ConvertToLocalDateTimeString($range["previous"]["ends"]); $range["previous"]["ends"] = Application_Common_DateHelper::UTCStringToUserTimezoneString($range["previous"]["ends"]);
} }
if (isset($range["current"])) { if (isset($range["current"])) {
$range["current"]["starts"] = Application_Common_DateHelper::ConvertToLocalDateTimeString($range["current"]["starts"]); $range["current"]["starts"] = Application_Common_DateHelper::UTCStringToUserTimezoneString($range["current"]["starts"]);
$range["current"]["ends"] = Application_Common_DateHelper::ConvertToLocalDateTimeString($range["current"]["ends"]); $range["current"]["ends"] = Application_Common_DateHelper::UTCStringToUserTimezoneString($range["current"]["ends"]);
} }
if (isset($range["next"])) { if (isset($range["next"])) {
$range["next"]["starts"] = Application_Common_DateHelper::ConvertToLocalDateTimeString($range["next"]["starts"]); $range["next"]["starts"] = Application_Common_DateHelper::UTCStringToUserTimezoneString($range["next"]["starts"]);
$range["next"]["ends"] = Application_Common_DateHelper::ConvertToLocalDateTimeString($range["next"]["ends"]); $range["next"]["ends"] = Application_Common_DateHelper::UTCStringToUserTimezoneString($range["next"]["ends"]);
} }
Application_Model_Show::convertToLocalTimeZone($range["currentShow"], array("starts", "ends", "start_timestamp", "end_timestamp")); Application_Common_DateHelper::convertTimestamps(
Application_Model_Show::convertToLocalTimeZone($range["nextShow"], array("starts", "ends", "start_timestamp", "end_timestamp")); $range["currentShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"),
"user"
);
Application_Common_DateHelper::convertTimestamps(
$range["nextShow"],
array("starts", "ends", "start_timestamp", "end_timestamp"),
"user"
);
$source_status = array(); $source_status = array();
$switch_status = array(); $switch_status = array();

View File

@ -658,10 +658,7 @@ SQL;
*/ */
public function isStartDateTimeInPast() public function isStartDateTimeInPast()
{ {
$date = new Application_Common_DateHelper; return (gmdate("Y-m-d H:i:s") > ($this->getStartDate()." ".$this->getStartTime()));
$current_timestamp = $date->getUtcTimestamp();
return ($current_timestamp > ($this->getStartDate()." ".$this->getStartTime()));
} }
/** /**
@ -702,9 +699,7 @@ SQL;
{ {
//need to update cc_show_instances, cc_show_days //need to update cc_show_instances, cc_show_days
$con = Propel::getConnection(); $con = Propel::getConnection();
$timestamp = gmdate("Y-m-d H:i:s");
$date = new Application_Common_DateHelper;
$timestamp = $date->getUtcTimestamp();
$stmt = $con->prepare("UPDATE cc_show_days " $stmt = $con->prepare("UPDATE cc_show_days "
."SET duration = :add_show_duration " ."SET duration = :add_show_duration "
@ -1080,11 +1075,9 @@ SQL;
*/ */
public static function getCurrentShow($timeNow=null) public static function getCurrentShow($timeNow=null)
{ {
$CC_CONFIG = Config::getConfig();
$con = Propel::getConnection(); $con = Propel::getConnection();
if ($timeNow == null) { if ($timeNow == null) {
$date = new Application_Common_DateHelper; $timeNow = gmdate("Y-m-d H:i:s");
$timeNow = $date->getUtcTimestamp();
} }
//TODO, returning starts + ends twice (once with an alias). Unify this after the 2.0 release. --Martin //TODO, returning starts + ends twice (once with an alias). Unify this after the 2.0 release. --Martin
$sql = <<<SQL $sql = <<<SQL
@ -1302,25 +1295,6 @@ SQL;
return Application_Common_Database::prepareAndExecute( $sql, $params, 'all'); return Application_Common_Database::prepareAndExecute( $sql, $params, 'all');
} }
/**
* Convert the columns given in the array $columnsToConvert in the
* database result $rows to local timezone.
*
* @param type $rows arrays of arrays containing database query result
* @param type $columnsToConvert array of column names to convert
*/
public static function convertToLocalTimeZone(&$rows, $columnsToConvert)
{
if (!is_array($rows)) {
return;
}
foreach ($rows as &$row) {
foreach ($columnsToConvert as $column) {
$row[$column] = Application_Common_DateHelper::ConvertToLocalDateTimeString($row[$column]);
}
}
}
public static function getMaxLengths() public static function getMaxLengths()
{ {
$sql = <<<SQL $sql = <<<SQL