WB 2.08.x

19 Oct-2013 Build 1985 Dietmar Woellbrink (Luisehahne)

! /modules/news/Reorg.php completely recoded using class AccessFile()

! /modules/news/upgrade.php  add accessfile report to output details in upgrade-script.php

! /modules/news/save_post.php search for missing accessfile folder and create missing one

if(!defined('REVISION')) define('REVISION', '1985');

 * @category     Addon

 * @package      news_package

 * @copyright    Manuela v.d.Decken <manuela@isteam.de>

 * @author       Manuela v.d.Decken <manuela@isteam.de>

 * @since        File available since 15.10.2013

 * @description  reorganisize all accessfiles of the addon 'news'

/** registry object */

	protected $oReg = null;

/** database object */

	protected $oDb  = null;

/** root directory for accessfiles */

	protected $sAccessFilesRoot = '';

/** sub directory for accessfiles

 * @description  This is needed to correct db::x_mod_news_posts::link entries of former versions<br />

 *               It can be removed after <b>all</b> modules accessing news are modified to access

 *               without a hardcoded subdirectory name.

 */

	protected $sAccessFilesSubdir = 'posts/';

/** collector of return values */

	protected $aReport = null;

/** set kind of return values */

	protected $bDetailedLog = false;

/** show extended log entries */

	const LOG_EXTENDED = true;

/** show minimal log entries */

	const LOG_SHORT    = false;

 * constructor

 * @param int $bDetailedLog  can be LOG_EXTENDED or LOG_SHORT

	public function __construct($bDetailedLog = self::LOG_SHORT)

		$this->bDetailedLog     = $bDetailedLog;

		$this->oDb              = WbDatabase::getInstance();

		$this->oReg             = WbAdaptor::getInstance();

		$this->sAccessFilesRoot = $this->oReg->AppPath.$this->oReg->PagesDir.$this->sAccessFilesSubdir;

 * execute reorganisation

 * @return boolean

	public function execute()

	// reset areport

		$this->aReport = array( 'FilesDeleted'=>0,

		                        'FilesCreated'=>0,

		                        'Success'=>array(),

		                        'Failed'=>array()

		                      );

	// delete old accessfiles

		$this->deleteAll();

	// recreate new accessfiles

		$this->rebuildAll();

	// return true if all is successful done

		return (sizeof($this->aReport['Failed']) == 0);

	}

/**

 * getReport

 * @return array

 * @description a report about the whoole reorganisation<br />

 *              returns an array including<br />

 *              (int) number of 'FilesDeleted'<br />

 *              (int) number of 'FilesCreated'<br />

 *              (array) 'Success'<br />

 *              (array) 'Failed'

 */

	public function getReport()

	{

		return $this->aReport;

	}

/**

 * deleteAll

 * @throws AccessFileException

 * @description delete all accessfiles and its children in $sAccessFilesRoot

 */

	protected function deleteAll()

	{

	// scan start directory for access files

		foreach (glob($this->sAccessFilesRoot . '*'.$this->oReg->PageExtension, GLOB_MARK) as $sItem)

		{

		// sanitize itempath

            $sItem = str_replace('\\', '/', $sItem);

			if(AccessFileHelper::isAccessFile($sItem))

			// delete accessfiles only

				if(is_writable($sItem) && @unlink($sItem))

				{

				// if file is successful deleted

					if($this->bDetailedLog)

					{

						$this->aReport['Success'][] = 'File successful removed : '.str_replace($this->oReg->AppPath, '', $sItem);

					}

				// increment successful counter

					$this->aReport['FilesDeleted']++;

				}else

				{

				// if failed

					$this->aReport['Failed'][] = 'Delete file failed : '.str_replace($this->oReg->AppPath, '', $sItem);

				}

			} // endif

		} // endforeach

	} // end of function deleteAll()

/**

 * rebuildAll

 * @return integer  number of successful deleted files

 * @throws AccessFileException

 * @description rebuild all accessfiles from database

 */

	protected function rebuildAll()

	{

		$sql = 'SELECT `page_id`, `post_id`, `section_id`, `link`, `title` '

		     . 'FROM `'.$this->oDb->TablePrefix.'mod_news_posts` '

		     . 'WHERE `link`!=\'\'';

		if(($oPosts = $this->oDb->query($sql)))

		{

			while(($aPost = $oPosts->fetchRow(MYSQL_ASSOC)))

			{

			// sanitize link if there is an old value in database from former versions

				$aPost['link'] = trim( str_replace('\\', '/', $aPost['link']), '/');

				$aPost['link'] = preg_replace( '/^'.preg_quote($this->sAccessFilesSubdir, '/').'/',

				                               '',

				                               trim( str_replace('\\', '/', $aPost['link']), '/')

				                             );

			// compose name of accessfile

				$sAccFileName = $this->sAccessFilesRoot.$aPost['link'].$this->oReg->PageExtension;

				try

				{

				// create new object

					$oAccFile = new AccessFile($sAccFileName, $aPost['page_id']);

					$oAccFile->addVar('section_id',   $aPost['section_id'], AccessFile::VAR_INT);

					$oAccFile->addVar('post_id',      $aPost['post_id'],    AccessFile::VAR_INT);

					$oAccFile->addVar('post_section', $aPost['section_id'], AccessFile::VAR_INT);

					$oAccFile->write();

				// destroy object if its file is written

					unset($oAccFile);

					if($this->bDetailedLog)

					{

						$this->aReport['Success'][] = 'File successful created : '.str_replace($this->oReg->AppPath, '', $sAccFileName);

					}

				// increment successful counter

					$this->aReport['FilesCreated']++;

				}catch(AccessFileException $e)

				{

				// if failed

					$this->aReport['Failed'][] = ($this->bDetailedLog ? $e : $e->getMessage());

				}

			} // endwhile

		} // endif

	} // end of function rebuildAll()

} // end of class m_news_Reorg

			$aReport = array('FilesDeleted'=>0,'FilesCreated'=>0,);

        	$sModulReorg = 'm_news_Reorg';

        	if( !$globalStarted && class_exists($sModulReorg) ) {

        		$oReorg = new $sModulReorg($sModulReorg::LOG_EXTENDED);

				$aReturnMsg = $oReorg->execute(); // show details

                $aReport = $oReorg->getReport();

                unset($oReorg);

        	}

//		$msg[] = '<strong>'.$aReport['FilesDeleted'].' Files successful deleted</strong>';

		$msg[] = '<strong>Number of new formated access files: '.$aReport['FilesCreated'].'</strong>';

		$msg[] = "<strong>News upgrade successfull finished</strong>";

// Don't show the messages twice

// only show if manuell upgrade

	echo ''.implode('<br />',$msg).'<br />';

// try to create the whole path to the accessfile

    	$sAccessPath = dirname($sNewFilename).'/';

    	if(!($bRetval = is_dir($sAccessPath))) {

    		$iOldUmask = umask(0) ;

    		// sanitize directory mode to 'o+rwx/g+x/u+x' and create path

    		$bRetval = mkdir($sAccessPath, (OCTAL_DIR_MODE |0711), true); 

    		umask($iOldUmask);

    	}