include/update_function.php
<?php declare(strict_types=1);
/**
* News functions
*
* You may not change or alter any portion of this comment or credits
* of supporting developers from this source code or any supporting source code
* which is considered copyrighted (c) material of the original comment or credit authors.
* 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.
*
* @copyright {@link https://xoops.org/ XOOPS Project}
* @license GNU GPL 2 (https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
* @author Voltan
*/
use XoopsModules\News;
/**
* @return bool
*/
function xoops_module_update_news()
{
global $xoopsDB;
$errors = 0;
//0) Rename all tables
if (News\Utility::existTable($xoopsDB->prefix('stories_files'))) {
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('stories_files') . ' RENAME ' . $xoopsDB->prefix('news_stories_files');
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
} elseif (!News\Utility::existTable($xoopsDB->prefix('news_stories_files'))) {
// 1) Create, if it does not exists, the stories_files table
$sql = 'CREATE TABLE ' . $xoopsDB->prefix('news_stories_files') . " (
fileid INT(8) UNSIGNED NOT NULL AUTO_INCREMENT,
filerealname VARCHAR(255) NOT NULL DEFAULT '',
storyid INT(8) UNSIGNED NOT NULL DEFAULT '0',
date INT(10) NOT NULL DEFAULT '0',
mimetype VARCHAR(64) NOT NULL DEFAULT '',
downloadname VARCHAR(255) NOT NULL DEFAULT '',
counter INT(8) UNSIGNED NOT NULL DEFAULT '0',
PRIMARY KEY (fileid),
KEY storyid (storyid)
) ENGINE=MyISAM;";
if (!$xoopsDB->queryF($sql)) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED1;
++$errors;
}
}
if (News\Utility::existTable($xoopsDB->prefix('stories'))) {
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('stories') . ' RENAME ' . $xoopsDB->prefix('news_stories');
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
}
if (News\Utility::existTable($xoopsDB->prefix('topics'))) {
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('topics') . ' RENAME ' . $xoopsDB->prefix('news_topics');
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
}
if (News\Utility::existTable($xoopsDB->prefix('stories_files'))) {
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('stories_files') . ' RENAME ' . $xoopsDB->prefix('news_stories_files');
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
}
// 2) Change the topic title's length, in the topics table
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('news_topics') . ' CHANGE topic_title topic_title VARCHAR( 255 ) NOT NULL;';
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
// 2.0a) change column size for IP address from varchar(16) to varchar(45) for IPv6
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('news_stories') . ' MODIFY hostname VARCHAR( 45 ) NOT NULL DEFAULT \'\';';
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
// 2.0b) change column size for Picture from varchar(50) to varchar(255) for SEO
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('news_stories') . ' MODIFY picture VARCHAR( 255 ) NOT NULL DEFAULT \'\';';
$result = $xoopsDB->queryF($sql);
if (!$result) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED2;
++$errors;
}
// 2.1) Add the new fields to the topic table
if (!News\Utility::existField('menu', $xoopsDB->prefix('news_topics'))) {
News\Utility::addField("menu TINYINT( 1 ) DEFAULT '0' NOT NULL", $xoopsDB->prefix('news_topics'));
}
if (!News\Utility::existField('topic_frontpage', $xoopsDB->prefix('news_topics'))) {
News\Utility::addField("topic_frontpage TINYINT( 1 ) DEFAULT '1' NOT NULL", $xoopsDB->prefix('news_topics'));
}
if (!News\Utility::existField('topic_rssurl', $xoopsDB->prefix('news_topics'))) {
News\Utility::addField('topic_rssurl VARCHAR( 255 ) NOT NULL', $xoopsDB->prefix('news_topics'));
}
if (!News\Utility::existField('topic_description', $xoopsDB->prefix('news_topics'))) {
News\Utility::addField('topic_description TEXT NOT NULL', $xoopsDB->prefix('news_topics'));
}
if (!News\Utility::existField('topic_color', $xoopsDB->prefix('news_topics'))) {
News\Utility::addField("topic_color varchar(6) NOT NULL default '000000'", $xoopsDB->prefix('news_topics'));
}
// 3) If it does not exists, create the table stories_votedata
if (!News\Utility::existTable($xoopsDB->prefix('news_stories_votedata'))) {
$sql = 'CREATE TABLE ' . $xoopsDB->prefix('news_stories_votedata') . " (
ratingid INT(11) UNSIGNED NOT NULL AUTO_INCREMENT,
storyid INT(8) UNSIGNED NOT NULL DEFAULT '0',
ratinguser INT(11) NOT NULL DEFAULT '0',
rating TINYINT(3) UNSIGNED NOT NULL DEFAULT '0',
ratinghostname VARCHAR(60) NOT NULL DEFAULT '',
ratingtimestamp INT(10) NOT NULL DEFAULT '0',
PRIMARY KEY (ratingid),
KEY ratinguser (ratinguser),
KEY ratinghostname (ratinghostname),
KEY storyid (storyid)
) ENGINE=MyISAM;";
if (!$xoopsDB->queryF($sql)) {
echo '<br>' . _AM_NEWS_UPGRADEFAILED . ' ' . _AM_NEWS_UPGRADEFAILED3;
++$errors;
}
}
// 4) Create the four new fields for the votes in the story table
if (!News\Utility::existField('rating', $xoopsDB->prefix('news_stories'))) {
News\Utility::addField("rating DOUBLE( 6, 4 ) DEFAULT '0.0000' NOT NULL", $xoopsDB->prefix('news_stories'));
}
if (!News\Utility::existField('votes', $xoopsDB->prefix('news_stories'))) {
News\Utility::addField("votes INT( 11 ) UNSIGNED DEFAULT '0' NOT NULL", $xoopsDB->prefix('news_stories'));
}
if (!News\Utility::existField('keywords', $xoopsDB->prefix('news_stories'))) {
News\Utility::addField('keywords VARCHAR(255) NOT NULL', $xoopsDB->prefix('news_stories'));
}
if (!News\Utility::existField('description', $xoopsDB->prefix('news_stories'))) {
News\Utility::addField('description VARCHAR(255) NOT NULL', $xoopsDB->prefix('news_stories'));
}
if (!News\Utility::existField('pictureinfo', $xoopsDB->prefix('news_stories'))) {
News\Utility::addField('pictureinfo VARCHAR(255) NOT NULL', $xoopsDB->prefix('news_stories'));
}
if (!News\Utility::existField('subtitle', $xoopsDB->prefix('news_stories'))) {
News\Utility::addField('subtitle VARCHAR(255) NOT NULL', $xoopsDB->prefix('news_stories'));
}
// 5) Add some indexes to the topics table
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('news_topics') . ' ADD INDEX ( `topic_title` );';
$result = $xoopsDB->queryF($sql);
$sql = 'ALTER TABLE ' . $xoopsDB->prefix('news_topics') . ' ADD INDEX ( `menu` );';
$result = $xoopsDB->queryF($sql);
// 6) Make files and folders
$dir = XOOPS_ROOT_PATH . '/uploads/news';
if (!@mkdir($dir) && !is_dir($dir)) {
throw new \RuntimeException('The directory ' . $dir . ' could not be created.');
}
if (!is_writable($dir)) {
chmod($dir, 0777);
}
$dir = XOOPS_ROOT_PATH . '/uploads/news/file';
if (!@mkdir($dir) && !is_dir($dir)) {
throw new \RuntimeException('The directory ' . $dir . ' could not be created.');
}
if (!is_writable($dir)) {
chmod($dir, 0777);
}
$dir = XOOPS_ROOT_PATH . '/uploads/news/image';
if (!@mkdir($dir) && !is_dir($dir)) {
throw new \RuntimeException('The directory ' . $dir . ' could not be created.');
}
if (!is_writable($dir)) {
chmod($dir, 0777);
}
// Copy index.html files on uploads folders
$indexFile = XOOPS_ROOT_PATH . '/modules/news/include/index.php';
copy($indexFile, XOOPS_ROOT_PATH . '/uploads/news/index.php');
copy($indexFile, XOOPS_ROOT_PATH . '/uploads/news/file/index.php');
copy($indexFile, XOOPS_ROOT_PATH . '/uploads/news/image/index.php');
return true;
}