File Source for BitArticleTopic.php

<?php
/**
* @version $Header$
* @package articles
*
* @copyright Copyright (c) 2004-2006, bitweaver.org
* All Rights Reserved. See below for details and a complete list of authors.
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See http://www.gnu.org/copyleft/lesser.html for details.
*/
/**
* Required setup
*/
global $gBitSystem;
require_once( KERNEL_PKG_PATH."BitBase.php" );
require_once( ARTICLES_PKG_PATH.'BitArticle.php' );
/**
* @package articles
*/
class BitArticleTopic extends BitBase
{
public $mTopicId;
public function __construct($iTopicId = NULL, $iTopicName = NULL)
{
$this->mTopicId = NULL;
parent::__construct();
if ($iTopicId || $iTopicName) {
$this->loadTopic(array('topic_id'=>$iTopicId, 'topic_name'=>$iTopicName));
}
}
public function isValid()
{
return ($this->verifyId($this->mTopicId));
}
public function loadTopic($iParamHash = NULL)
{
$whereSQL = ' WHERE artt.';
$ret = NULL;
if (@$this->verifyId($iParamHash['topic_id']) || !empty($iParamHash['topic_name'])) {
$whereSQL .= "`".((@$this->verifyId($iParamHash['topic_id']) || $this->mTopicId) ? 'topic_id' : 'topic_name')."` = ?";
$bindVars = array((@$this->verifyId($iParamHash['topic_id']) ? (int) $iParamHash['topic_id'] : ($this->mTopicId ? $this->mTopicId : $iParamHash['topic_name'])) );
$sql = "SELECT artt.*".
"FROM `".BIT_DB_PREFIX."article_topics` artt ".
$whereSQL;
$this->mInfo = $this->mDb->getRow($sql, $bindVars);
if( !empty( $this->mInfo['topic_id'] ) ) {
$this->mTopicId = $this->mInfo['topic_id'];
if ($this->mInfo['has_topic_image']) {
$this->mInfo['topic_image_url'] = $this->getTopicImageStorageUrl(NULL, FALSE, TRUE);
} else {
$this->mInfo['topic_image_url'] = NULL;
}
}
}
return $ret;
}
public function verify(&$iParamHash)
{
// Validate the (optional) topic_id parameter
if (@$this->verifyId($iParamHash['topic_id'])) {
$cleanHash['topic_id'] = (int) $iParamHash['topic_id'];
} else {
$cleanHash['topic_id'] = NULL;
}
// Was an acceptable name given?
if (empty($iParamHash['topic_name']) || ($iParamHash['topic_name'] == '')) {
$this->mErrors['topic_name'] = tra("Invalid or blank topic name supplied");
} elseif (empty($iParamHash['topic_id'])) {
$ret = $this->getTopicList( array( 'topic_name' => $iParamHash['topic_name'] ) );
if ( sizeof( $ret ) ) {
$this->mErrors['topic_name'] = 'Topic "'.$iParamHash['topic_name'].'" already exists. Please choose a different name.';
} else {
$cleanHash['topic_name'] = $iParamHash['topic_name'];
}
} else {
$cleanHash['topic_name'] = $iParamHash['topic_name'];
}
// Whether the topic is active or not
if ( empty($iParamHash['active_topic']) || (strtoupper($iParamHash['active_topic']) != 'CHECKED' && strtoupper($iParamHash['active_topic']) != 'ON' && strtoupper($iParamHash['active_topic']) != 'Y')) {
if (@$this->verifyId($cleanHash['topic_id'])) {
$cleanHash['active_topic'] = 'n';
} else {
// Probably a new topic so lets go ahead and enable it
$cleanHash['active_topic'] = 'y';
}
} else {
$cleanHash['active_topic'] = 'y';
}
if (empty($iParamHash['created'])) {
global $gBitSystem;
$cleanHash['created'] = $gBitSystem->getUTCTime();
}
$iParamHash = $cleanHash;
return(count($this->mErrors) == 0);
}
public function storeTopic($iParamHash = NULL)
{
global $gLibertySystem;
global $gBitUser;
if ($this->verify($iParamHash)) {
if (!$iParamHash['topic_id']) {
$topicId = $this->mDb->GenID('article_topics_id_seq');
} else {
$topicId = $this->mTopicId;
}
if( !empty( $_FILES['upload'] ) && $_FILES['upload']['tmp_name'] ) {
$checkFunc = liberty_get_function( 'can_thumbnail' );
if( $checkFunc( $_FILES['upload']['type'] )) {
$fileHash = $_FILES['upload'];
$fileHash['dest_branch'] = $this->getTopicImageBaseUrl( $topicId );
$fileHash['source_file'] = $fileHash['tmp_name'];
liberty_clear_thumbnails( $fileHash );
liberty_generate_thumbnails( $fileHash );
$iParamHash['has_topic_image'] = 'y';
} else {
$this->mErrors = tra( "The file you uploaded doesn't appear to be a valid image. The reported mime type is" ).": ".$_FILES['upload']['type'];
}
}
if( $iParamHash['topic_id'] ) {
$this->mDb->associateUpdate( BIT_DB_PREFIX."article_topics", $iParamHash, array( 'topic_id' => $iParamHash['topic_id'] ) );
} else {
$iParamHash['topic_id'] = $topicId;
$this->mDb->associateInsert( BIT_DB_PREFIX."article_topics", $iParamHash );
}
}
$this->mTopicId = $iParamHash['topic_id'];
}
/**
* Work out the path to the image for this article
* @param $pTopicId id of the article we need the image path for
* @param $pBasePathOnly bool TRUE / FALSE - specify whether you want full path or just base path
* @return path on success, FALSE on failure
* @access public
***/
public function getTopicImageBaseUrl($pTopicId = NULL)
{
$ret = FALSE;
if ( !@BitBase::verifyId( $pTopicId ) && $this->isValid() ) {
$pTopicId = $this->mTopicId;
}
if( @BitBase::verifyId( $pTopicId )) {
$ret = LibertyMime::getStorageUrl( 'topics/'.$pTopicId );
}
return $ret;
}
/**
* Get the full URL to the needed thumbnail
*
* @param numeric $pTopicId Topic ID of topic in question
* @access public
* @return Path to thumbnail, FALSE on failure
*/
public function getTopicImageThumbUrl($pTopicId = NULL)
{
global $gBitSystem;
$ret = FALSE;
if ( !@BitBase::verifyId( $pTopicId ) && $this->isValid() ) {
$pTopicId = $this->mTopicId;
}
if ( @BitBase::verifyId( $pTopicId )) {
$ret = liberty_fetch_thumbnail_url( array(
'source_file' => BitArticleTopic::getTopicImageBaseUrl( $pTopicId ),
'default_image' => $gBitSystem->getConfig( 'articles_image_size', 'small' )
));
}
return $ret;
}
public static function getTopicList($pOptionHash=NULL)
{
global $gBitSystem;
$where = '';
$bindVars = array();
if ( !empty( $pOptionHash['active_topic'] ) ) {
$where = " WHERE artt.`active_topic` = 'y' ";
}
if ( !empty( $pOptionHash['topic_name'] ) ) {
$where = " WHERE artt.`topic_name` = ? ";
$bindVars[] = $pOptionHash['topic_name'];
}
$query = "SELECT artt.*
FROM `".BIT_DB_PREFIX."article_topics` artt
$where ORDER BY artt.`topic_name`";
$result = $gBitSystem->mDb->query( $query, $bindVars );
$ret = array();
while ( $res = $result->fetchRow() ) {
$res["num_articles"] = $gBitSystem->mDb->getOne( "SELECT COUNT(*) FROM `".BIT_DB_PREFIX."articles` WHERE `topic_id`= ?", array( $res["topic_id"] ) );
if ( empty( $res['topic_image_url'] ) && $res['has_topic_image'] == 'y' ) {
$res['topic_image_url'] = BitArticleTopic::getTopicImageStorageUrl( $res['topic_id'] );
}
$ret[] = $res;
}
return $ret;
}
public function removeTopicImage()
{
if ($this->mTopicId) {
if ( file_exists($this->getTopicImageStoragePath() ) ) {
@unlink( $this->getTopicImageStoragePath() );
}
$sql = "UPDATE `".BIT_DB_PREFIX."article_topics` SET `has_topic_image` = 'n' WHERE `topic_id` = ?";
$rs = $this->mDb->query($sql, array($this->mTopicId));
$this->mInfo['has_topic_image'] = 'n';
}
}
public function activateTopic()
{
$this->setActivation(TRUE);
}
public function deactivateTopic()
{
$this->setActivation(FALSE);
}
public function setActivation($iIsActive = FALSE)
{
$sql = "UPDATE `".BIT_DB_PREFIX."article_topics` SET `active_topic` = '".($iIsActive ? 'y' : 'n')."' WHERE `topic_id` = ?";
$rs = $this->mDb->query($sql, array($this->mTopicId));
$this->mInfo['active_topic'] = ($iIsActive ? 'y' : 'n');
}
public function getTopicArticles()
{
if (!$this->mTopicId) {
return NULL;
}
$sql = "SELECT `article_id` FROM `".BIT_DB_PREFIX."articles` WHERE `topic_id` = ?";
$rs = $this->mDb->query($sql, array($this->mTopicId));
$ret = array();
while ($row = $rs->fetchRow()) {
$tmpArticle = new BitArticle($row['article_id']);
$tmpArticle->load();
$ret[] = $tmpArticle;
}
}
public function removeTopic($iRemoveArticles = FALSE)
{
if (!$this->mTopicId) {
return NULL;
}
$this->removeTopicImage();
if ($iRemoveArticles == TRUE) {
$topicArticles = $this->getTopicArticles();
for ($articleCount = 0; $articleCount < count($topicArticles); $articleCount++) {
$topicArticles[$articleCount]->expunge();
}
} else {
$sql = "UPDATE `".BIT_DB_PREFIX."articles` SET `topic_id` = ? WHERE `topic_id` = ?";
$rs = $this->mDb->query($sql, array(NULL, $this->mTopicId));
}
$sql = "DELETE FROM `".BIT_DB_PREFIX."article_topics` WHERE `topic_id` = ?";
$rs = $this->mDb->query($sql, array($this->mTopicId));
}
/*****************************************************************************
* Image functions needed for backward compatability - these are needed to *
* handle old article image style images that are not attachments. generally *
* these functions are deprecated but needed for legacy code *
****************************************************************************/
/**
* Get the name of the article image file
*
* @param array $pTopicId article id
* @access public
* @return TRUE on success, FALSE on failure
*/
public function getTopicImageStorageName($pTopicId = NULL)
{
if ( !@BitBase::verifyId( $pTopicId ) ) {
if ( $this->isValid() ) {
$pTopicId = $this->mTopicId;
} else {
return NULL;
}
}
global $gBitSystem;
return "topic_$pTopicId.".$gBitSystem->getConfig( 'liberty_thumbnail_format', 'jpg' );
}
/**
* Work out the path to the image for this article
* @param $pTopicId id of the article we need the image path for
* @param $pBasePathOnly bool TRUE / FALSE - specify whether you want full path or just base path
* @return path on success, FALSE on failure
* @access public
***/
public function getTopicImageStoragePath($pTopicId = NULL, $pBasePathOnly = FALSE)
{
$path = BitArticleTopic::getArticleImageStoragePath( NULL, TRUE );
if ($pBasePathOnly) {
return $path;
}
if ( !@BitBase::verifyId( $pTopicId ) ) {
if( $this->isValid() ) {
$pTopicId = $this->mTopicId;
} else {
return NULL;
}
}
if ( !empty( $pTopicId ) ) {
return $path.BitArticleTopic::getTopicImageStorageName( $pTopicId );
} else {
return FALSE;
}
}
/**
* Work out the URL to the image for this article
* @param $pTopicId id of the article we need the image path for
* @param $pBasePathOnly bool TRUE / FALSE - specify whether you want full path or just base path
* @return URL on success, FALSE on failure
* @access public
***/
public function getTopicImageStorageUrl($pTopicId = NULL, $pBasePathOnly = FALSE, $pForceRefresh = FALSE)
{
global $gBitSystem;
$ret = FALSE;
// first we check to see if this is a new type thumbnail. if that fails we'll use the old method
if ( !( $ret = BitArticleTopic::getTopicImageThumbUrl( $pTopicId ))) {
$url = BitArticleTopic::getArticleImageStorageUrl( NULL, TRUE );
if ($pBasePathOnly) {
return $url;
}
if ( !@BitBase::verifyId( $pTopicId ) ) {
if ( $this->isValid() ) {
$pTopicId = $this->mTopicId;
} else {
return NULL;
}
}
if ( is_file( BitArticleTopic::getTopicImageStoragePath( NULL, TRUE ).BitArticleTopic::getTopicImageStorageName( $pTopicId ))) {
$ret = $url.BitArticleTopic::getTopicImageStorageName( $pTopicId ).( $pForceRefresh ? "?".$gBitSystem->getUTCTime() : '' );
}
}
return str_replace( "//", "/", $ret );
}
/*****************************************************************************
* Image functions needed for backward compatability - these are needed to *
* handle old article image style images that are not attachments. generally *
* these functions are deprecated but needed for legacy code *
* *
* the legacy code below here should go at some point. this code is old and *
* fugly. In fact, a lot of the code in here is fugly. we should use *
* pigoenholes to do this topic thing, now that pigoenholes can have primary *
* attachments. *
****************************************************************************/
/**
* Get the name of the article image file
*
* @param array $pArticleId article id
* @access public
* @return TRUE on success, FALSE on failure
*/
public function getArticleImageStorageName($pArticleId = NULL)
{
if ( !@BitBase::verifyId( $pArticleId ) ) {
if ( $this->isValid() ) {
$pArticleId = $this->mArticleId;
} else {
return NULL;
}
}
return "article_$pArticleId.jpg";
}
/**
* Work out the path to the image for this article
* @param $pArticleId id of the article we need the image path for
* @param $pBasePathOnly bool TRUE / FALSE - specify whether you want full path or just base path
* @return path on success, FALSE on failure
* @access public
***/
public function getArticleImageStoragePath($pArticleId = NULL, $pBasePathOnly = FALSE)
{
$path = STORAGE_PKG_PATH.ARTICLES_PKG_NAME.'/';
if ( !is_dir( $path ) ) {
mkdir_p( $path );
}
if ($pBasePathOnly) {
return $path;
}
if( !@BitBase::verifyId( $pArticleId ) ) {
if( $this->isValid() ) {
$pArticleId = $this->mArticleId;
} else {
return NULL;
}
}
if ( !empty( $pArticleId ) ) {
return $path.BitArticleTopic::getArticleImageStorageName( $pArticleId );
} else {
return FALSE;
}
}
/**
* Work out the URL to the image for this article
* @param $pArticleId id of the article we need the image path for
* @param $pBasePathOnly bool TRUE / FALSE - specify whether you want full path or just base path
* @return URL on success, FALSE on failure
* @access public
***/
public function getArticleImageStorageUrl($pArticleId = NULL, $pBasePathOnly = FALSE, $pForceRefresh = FALSE)
{
global $gBitSystem;
$url = STORAGE_PKG_URL.ARTICLES_PKG_NAME.'/';
if ($pBasePathOnly) {
return $url;
}
if( !@BitBase::verifyId( $pArticleId ) ) {
if( $this->isValid() ) {
$pArticleId = $this->mArticleId;
} else {
return NULL;
}
}
if ( is_file( BitArticleTopic::getArticleImageStoragePath( NULL, TRUE ).BitArticleTopic::getArticleImageStorageName( $pArticleId ) ) ) {
return $url.BitArticleTopic::getArticleImageStorageName( $pArticleId ).( $pForceRefresh ? "?".$gBitSystem->getUTCTime() : '' );
} else {
return FALSE;
}
}
}

Source for file BitArticleTopic.php