<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 encoding=utf-8: */
// +----------------------------------------------------------------------+
// | Eventum - Issue Tracking System |
// +----------------------------------------------------------------------+
// | Copyright (c) 2003 - 2008 MySQL AB |
// | Copyright (c) 2008 - 2009 Sun Microsystem Inc. |
// | |
// | 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. |
// | |
// | This program is distributed in the hope that it will be useful, |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
// | GNU General Public License for more details. |
// | |
// | You should have received a copy of the GNU General Public License |
// | along with this program; if not, write to: |
// | |
// | Free Software Foundation, Inc. |
// | 59 Temple Place - Suite 330 |
// | Boston, MA 02111-1307, USA. |
// +----------------------------------------------------------------------+
// | Authors: João Prado Maia <hide@address.com> |
// +----------------------------------------------------------------------+
//
// @(#) $Id: class.release.php 3797 2009-01-12 20:14:39Z balsdorf $
//
require_once(APP_INC_PATH . "class.error_handler.php");
require_once(APP_INC_PATH . "class.misc.php");
require_once(APP_INC_PATH . "class.validation.php");
/**
* Class to handle the business logic related to the administration
* of releases in the system.
*
* @version 1.0
* @author João Prado Maia <hide@address.com>
*/
class Release
{
/**
* Method used to check whether a release is assignable or not.
*
* @access public
* @param integer $pre_id The release ID
* @return boolean
*/
function isAssignable($pre_id)
{
$stmt = "SELECT
COUNT(*)
FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_id=" . Misc::escapeInteger($pre_id) . " AND
pre_status='available'";
$res = $GLOBALS["db_api"]->dbh->getOne($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return false;
} else {
if ($res == 0) {
return false;
} else {
return true;
}
}
}
/**
* Method used to get the details of a specific release.
*
* @access public
* @param integer $pre_id The release ID
* @return array The details of the release
*/
function getDetails($pre_id)
{
$stmt = "SELECT
*,
MONTH(pre_scheduled_date) AS scheduled_month,
YEAR(pre_scheduled_date) AS scheduled_year
FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_id=" . Misc::escapeInteger($pre_id);
$res = $GLOBALS["db_api"]->dbh->getRow($stmt, DB_FETCHMODE_ASSOC);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return "";
} else {
return $res;
}
}
/**
* Method used to get the title of a specific release.
*
* @access public
* @param integer $pre_id The release ID
* @return string The title of the release
*/
function getTitle($pre_id)
{
$stmt = "SELECT
pre_title
FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_id=" . Misc::escapeInteger($pre_id);
$res = $GLOBALS["db_api"]->dbh->getOne($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return "";
} else {
return $res;
}
}
/**
* Method used to remove all releases associated with a specific
* set of projects.
*
* @access public
* @param array $ids The list of projects
* @return boolean
*/
function removeByProjects($ids)
{
$items = @implode(", ", Misc::escapeInteger($ids));
$stmt = "DELETE FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_prj_id IN ($items)";
$res = $GLOBALS["db_api"]->dbh->query($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return false;
} else {
return true;
}
}
/**
* Method used to remove releases by using the administrative
* interface of the system.
*
* @access public
* @return boolean
*/
function remove()
{
$items = @implode(", ", Misc::escapeInteger($_POST["items"]));
// gotta fix the issues that are using this release
$stmt = "UPDATE
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "issue
SET
iss_pre_id=0
WHERE
iss_pre_id IN ($items)";
$res = $GLOBALS["db_api"]->dbh->query($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return false;
} else {
$stmt = "DELETE FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_id IN ($items)";
$res = $GLOBALS["db_api"]->dbh->query($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return false;
} else {
return true;
}
}
}
/**
* Method used to update the release by using the administrative
* interface of the system.
*
* @access public
* @return integer 1 if the update worked, -1 or -2 otherwise
*/
function update()
{
if (Validation::isWhitespace($_POST["title"])) {
return -2;
}
$scheduled_date = $_POST["scheduled_date"]["Year"] . "-" . $_POST["scheduled_date"]["Month"] . "-" . $_POST["scheduled_date"]["Day"];
$stmt = "UPDATE
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
SET
pre_title='" . Misc::escapeString($_POST["title"]) . "',
pre_scheduled_date='" . Misc::escapeString($scheduled_date) . "',
pre_status='" . Misc::escapeString($_POST["status"]) . "'
WHERE
pre_prj_id=" . Misc::escapeInteger($_POST["prj_id"]) . " AND
pre_id=" . Misc::escapeInteger($_POST["id"]);
$res = $GLOBALS["db_api"]->dbh->query($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return -1;
} else {
return 1;
}
}
/**
* Method used to add a new release by using the administrative
* interface of the system.
*
* @access public
* @return integer 1 if the update worked, -1 or -2 otherwise
*/
function insert()
{
if (Validation::isWhitespace($_POST["title"])) {
return -2;
}
$scheduled_date = $_POST["scheduled_date"]["Year"] . "-" . $_POST["scheduled_date"]["Month"] . "-" . $_POST["scheduled_date"]["Day"];
$stmt = "INSERT INTO
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
(
pre_prj_id,
pre_title,
pre_scheduled_date,
pre_status
) VALUES (
" . Misc::escapeInteger($_POST["prj_id"]) . ",
'" . Misc::escapeString($_POST["title"]) . "',
'" . Misc::escapeString($scheduled_date) . "',
'" . Misc::escapeString($_POST["status"]) . "'
)";
$res = $GLOBALS["db_api"]->dbh->query($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return -1;
} else {
return 1;
}
}
/**
* Method used to get the list of releases associated with a
* specific project.
*
* @access public
* @param integer $prj_id The project ID
* @return array The list of releases
*/
function getList($prj_id)
{
$stmt = "SELECT
pre_id,
pre_title,
pre_scheduled_date,
pre_status
FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_prj_id=" . Misc::escapeInteger($prj_id) . "
ORDER BY
pre_scheduled_date ASC";
$res = $GLOBALS["db_api"]->dbh->getAll($stmt, DB_FETCHMODE_ASSOC);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return "";
} else {
return $res;
}
}
/**
* Method used to get a list as an associative array of the
* releases.
*
* @access public
* @param integer $prj_id The project ID
* @param boolean $show_all_dates If true all releases, not just those with future dates will be returned
* @return array The list of releases
*/
function getAssocList($prj_id, $show_all_dates = false)
{
$stmt = "SELECT
pre_id,
pre_title
FROM
" . APP_DEFAULT_DB . "." . APP_TABLE_PREFIX . "project_release
WHERE
pre_prj_id=" . Misc::escapeInteger($prj_id) . " AND
(
pre_status='available'";
if ($show_all_dates != true) {
$stmt .= " AND
pre_scheduled_date >= '" . gmdate('Y-m-d') . "'";
}
$stmt .= "
)
ORDER BY
pre_scheduled_date ASC";
$res = $GLOBALS["db_api"]->dbh->getAssoc($stmt);
if (PEAR::isError($res)) {
Error_Handler::logError(array($res->getMessage(), $res->getDebugInfo()), __FILE__, __LINE__);
return "";
} else {
return $res;
}
}
}
// benchmarking the included file (aka setup time)
if (APP_BENCHMARK) {
$GLOBALS['bench']->setMarker('Included Release Class');
}