<?php
/**
* This file implements ther UI controler for chapters management.
*
* This file is part of the evoCore framework - {@link http://evocore.net/}
* See also {@link https://github.com/b2evolution/b2evolution}.
*
* @license GNU GPL v2 - {@link http://b2evolution.net/about/gnu-gpl-license}
*
* @copyright (c)2003-2020 by Francois Planque - {@link http://fplanque.com/}
*
* @package admin
*/
if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
// We should activate toolbar menu items for this controller
$activate_collection_toolbar = true;
if( valid_blog_requested() )
{
check_user_perm( 'blog_cats', 'edit', true, $blog );
$edited_Blog = & $Blog;
}
else
{
$action = 'nil';
}
load_class( 'chapters/model/_chaptercache.class.php', 'ChapterCache' );
$ChapterCache = new ChapterCache();
// Restrict to chapters of the specific blog:
$subset_ID = $blog;
$permission_to_edit = check_user_perm( 'blog_cats', '', false, $blog );
// ---- Below is a modified generic category list editor: -----
// fp> this is an example of where we could benefit from controler classes which could be derived
// fp> we basically need to add a "move" action.
/*
class Controler
{
method get_params() // and init object
method do_action()
method display_payload()
}
the $AdminUI->foo() structural calls would move to the dispatcher.
*/
// fp> TODO: find 4 other cases before refactoring this way. (fp)
param( 'action', 'string', 'list' );
// Init fadeout result array:
$result_fadeout = array();
if( param( $ChapterCache->dbIDname, 'integer', NULL, true, false, false ) )
{
if( ($edited_Chapter = & $ChapterCache->get_by_ID( ${$ChapterCache->dbIDname}, false, true, $subset_ID )) === false )
{ // We could not find the element to edit:
unset( $edited_Chapter );
$Messages->add( sprintf( TB_('Requested «%s» object does not exist any longer.'), TB_('Category') ), 'error' );
$action = 'nil';
}
}
if( !is_null( param( $ChapterCache->dbprefix.'parent_ID', 'integer', NULL ) ) )
{
$edited_parent_Chapter = & $ChapterCache->get_by_ID( ${$ChapterCache->dbprefix.'parent_ID'}, false, true, $subset_ID );
if( $edited_parent_Chapter === false )
{ // Parent chapter doesn't exist any longer.
unset( $ChapterCache->dbIDname );
$Messages->add( sprintf( TB_('Requested «%s» object does not exist any longer.'), TB_('Category') ), 'error' );
$action = 'nil';
}
}
// Init fadeout result array of IDs:
$result_fadeout = array();
/**
* Check locked elements
*/
if( !empty( $locked_IDs )
&& in_array( $action, array( 'edit', 'update', 'delete' ) )
&& in_array( $$ChapterCache->dbIDname, $locked_IDs ) )
{
$Messages->add( TB_('This element is locked and cannot be edited!') );
$action = 'list';
}
// Check that action request is not a CSRF hacked request and user has permission for the action
switch( $action )
{
case 'create':
case 'update':
case 'delete':
case 'make_default':
case 'set_meta':
case 'unset_meta':
case 'lock':
case 'unlock':
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'element' );
/* NO BREAK */
case 'new':
case 'move':
case 'edit':
if( ! $permission_to_edit )
{
debug_die( 'No permission to edit' );
}
break;
}
/**
* Get url to redirect after chapter editing
*
* @param string Redirect Page: 'front', 'manual', 'list'
* @param integer Parent ID
* @param integer Chapter ID
* @return string URL
*/
function get_chapter_redirect_url( $redirect_page, $parent_ID, $chapter_ID = 0 )
{
global $admin_url, $blog;
if( $redirect_page == 'front' || $redirect_page == 'parent' )
{ // Get Chapter for front page redirect
if( empty( $chapter_ID ) )
{ // Chapter ID is invalid, redirect to chapters list
$redirect_page = 'list';
}
else
{
$ChapterCache = & get_ChapterCache();
$Chapter = & $ChapterCache->get_by_ID( $chapter_ID, false, false );
if( $Chapter === false )
{ // Chapter doesn't exist anymore, redirect to chapters list
$redirect_page = 'list';
}
}
}
switch( $redirect_page )
{
case 'parent':
// Redirect to parent chapter on front-office:
if( $parent_Chapter = & $Chapter->get_parent_Chapter() )
{ // If
$redirect_url = $parent_Chapter->get_permanent_url( NULL, NULL, 1, NULL, '&' );
break;
}
// else redirect to permanent url of current chapter:
case 'front':
// Redirect to front-office
$redirect_url = $Chapter->get_permanent_url( NULL, NULL, 1, NULL, '&' );
break;
case 'manual':
// Redirect to manual pages
$redirect_url = $admin_url.'?ctrl=items&blog='.$blog.'&tab=manual';
if( !empty( $parent_ID ) )
{ // Open parent category to display new created category
$redirect_url .= '&cat_ID='.$parent_ID;
}
break;
default: // 'list'
// Redirect to chapters list
$redirect_url = $admin_url.'?ctrl=chapters&blog='.$blog;
break;
}
return $redirect_url;
}
/**
* Perform action:
*/
switch( $action )
{
case 'new':
// New action
$edited_Chapter = & $ChapterCache->new_obj( NULL, $subset_ID );
$edited_Chapter->blog_ID = $edited_Blog->ID;
if( isset( $edited_parent_Chapter ) )
{
$edited_Chapter->parent_ID = $edited_parent_Chapter->ID;
$edited_Chapter->parent_name = $edited_parent_Chapter->name;
}
else
{
$edited_Chapter->parent_name = TB_('Root');
}
break;
case 'move': // EXTENSION
if( ! $Settings->get('allow_moving_chapters') )
{
debug_die( 'Moving of chapters is disabled' );
}
/* NO BREAK */
case 'edit':
// Edit element form...:
// Make sure we got an ID:
param( $ChapterCache->dbIDname, 'integer', true );
// Get the page number we come from:
$previous_page = param( 'results'.$ChapterCache->dbprefix.'page', 'integer', 1, true );
break;
case 'create':
// Insert new element...:
$edited_Chapter = & $ChapterCache->new_obj( NULL, $subset_ID );
// load data from request
if( $edited_Chapter->load_from_Request() )
{ // We could load data from form without errors:
// Insert in DB:
if( $edited_Chapter->dbinsert() !== false )
{
$Messages->add( TB_('New chapter created.'), 'success' );
// Add the ID of the new element to the result fadeout
$result_fadeout[$edited_Chapter->dbIDname][] = $edited_Chapter->ID;
$action = 'list';
// We want to highlight the edited object on next list display:
$Session->set( 'fadeout_array', array($edited_Chapter->ID) );
// Redirect so that a reload doesn't write to the DB twice:
$redirect_to = get_chapter_redirect_url( param( 'redirect_page', 'string', '' ), $edited_Chapter->parent_ID, $edited_Chapter->ID );
header_redirect( $redirect_to, 303 ); // Will EXIT
// We have EXITed already at this point!!
}
}
break;
case 'update':
// Make sure we got an ID:
param( $ChapterCache->dbIDname, 'integer', true );
// LOAD FORM DATA:
if( $edited_Chapter->load_from_Request() )
{ // We could load data from form without errors:
// Update in DB:
if( $edited_Chapter->dbupdate() !== false )
{
$Messages->add( TB_('Chapter updated.'), 'success' ); //ToDO change htis
}
// Add the ID of the updated element to the result fadeout
$result_fadeout[$edited_Chapter->dbIDname][] = $edited_Chapter->ID;
// We want to highlight the edited object on next list display:
$Session->set( 'fadeout_array', array($edited_Chapter->ID));
// Redirect so that a reload doesn't write to the DB twice:
$redirect_to = get_chapter_redirect_url( param( 'redirect_page', 'string', '' ), $edited_Chapter->parent_ID, $edited_Chapter->ID );
header_redirect( $redirect_to, 303 ); // Will EXIT
// We have EXITed already at this point!!
}
else
{
// Get the page number we come from:
$previous_page = param( 'results'.$ChapterCache->dbprefix.'page', 'integer', 1, true );
}
break;
case 'update_move':
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'element' );
// EXTENSION
if( ! $Settings->get('allow_moving_chapters') )
{
debug_die( 'Moving of chapters is disabled' );
}
// Make sure we got an ID:
param( $ChapterCache->dbIDname, 'integer', true );
// Control permission to edit source blog:
$edited_Blog = & $edited_Chapter->get_Blog();
if( ! check_user_perm( 'blog_cats', '', false, $edited_Blog->ID ) )
{
debug_die( 'No permission to edit source collection.' );
/* die */
}
// Control permission to edit destination blog:
param( 'cat_coll_ID', 'integer', true );
if( ! check_user_perm( 'blog_cats', '', false, $cat_coll_ID ) )
{
// fp> TODO: prevent move in UI.
$Messages->add( 'No permission to edit destination blog.', 'error' ); // NO TRANS b/c temporary
break;
}
if( $cat_coll_ID == $edited_Blog->ID )
{
$Messages->add( TB_('Category has not been moved.'), 'note' );
break;
}
// Do the actual move! (This WILL reset the cache!)
$ChapterCache->move_Chapter_subtree( $edited_Chapter->ID, $subset_ID, $cat_coll_ID );
$dest_Blog = & $BlogCache->get_by_ID( $cat_coll_ID );
$Messages->add( /* TRANS: first %s is the moved category's name, the second one the new parent category */ sprintf( TB_('The category «%s» has been moved (with children) to «%s»\'s root. You may want to nest it in another parent category below...'), $edited_Chapter->dget('name'), $dest_Blog->dget( 'shortname' ) ), 'success' );
header_redirect( url_add_param( $admin_url, 'ctrl=chapters&action=edit&blog='.$cat_coll_ID.'&cat_ID='.$cat_ID, '&' ) ); // will save $Messages
/* EXIT */
// In case we changed the redirect someday:
unset($edited_Chapter);
$cat_ID = NULL;
$action = 'list';
break;
case 'delete':
// Delete entry:
param( $ChapterCache->dbIDname, 'integer', true );
if( param( 'confirm', 'integer', 0 ) )
{ // confirmed, Delete from DB:
$parent_ID = $edited_Chapter->parent_ID;
$msg = sprintf( TB_('Chapter «%s» deleted.'), $edited_Chapter->dget( 'name' ) );
$ChapterCache->dbdelete_by_ID( $edited_Chapter->ID );
unset($edited_Chapter);
forget_param( $ChapterCache->dbIDname );
$Messages->add( $msg, 'success' );
// Redirect so that a reload doesn't write to the DB twice:
$redirect_to = get_chapter_redirect_url( param( 'redirect_page', 'string', '' ), $parent_ID );
header_redirect( $redirect_to, 303 ); // Will EXIT
// We have EXITed already at this point!!
}
else
{ // not confirmed, Check for restrictions:
// TODO: dh> allow to delete a category which has links (and unbreak those after confirmation).
// Get the page number we come from:
$previous_page = param( 'results_'.$ChapterCache->dbprefix.'page', 'integer', 1, true );
if( ! $edited_Chapter->check_delete( sprintf( TB_('Cannot delete element «%s»'), $edited_Chapter->dget( 'name' ) ) ) )
{ // There are restrictions:
$action = 'edit';
}
}
break;
case 'make_default':
// Make category as default:
if( $edited_Chapter->get( 'meta' ) )
{ // If category is meta:
$Messages->add( TB_('Meta category cannot be used as default!'), 'error' );
break;
}
if( $edited_Chapter->get( 'ityp_ID' ) === '0' )
{ // Force "No default type" of default category to "Same as collection default":
$edited_Chapter->set( 'ityp_ID', NULL, true );
if( $edited_Chapter->dbupdate() )
{ // Inform user about this modification:
$Messages->add( sprintf( TB_('The default Item Type of the default category must be defined. Therefore it has been set to "%s".'), TB_('Same as collection default') ), 'note' );
}
}
if( $edited_Blog->get_setting( 'default_cat_ID' ) != $edited_Chapter->ID )
{ // Move all "content-block" items from previous main Category to new:
// (we need to do this because impossible delete a category with items,
// but "content-block" items have no possibility to change category from edit form)
$moved_items_num = $DB->query( 'UPDATE T_items__item
INNER JOIN T_items__type ON post_ityp_ID = ityp_ID
SET post_main_cat_ID = '.$DB->quote( $edited_Chapter->ID ).'
WHERE post_main_cat_ID = '.$DB->quote( $edited_Blog->get_setting( 'default_cat_ID' ) ).'
AND ityp_usage = "content-block"' );
$DB->query( 'UPDATE T_postcats
INNER JOIN T_items__item ON post_ID = postcat_post_ID
INNER JOIN T_items__type ON post_ityp_ID = ityp_ID
SET postcat_cat_ID = '.$DB->quote( $edited_Chapter->ID ).'
WHERE postcat_cat_ID = '.$DB->quote( $edited_Blog->get_setting( 'default_cat_ID' ) ).'
AND ityp_usage = "content-block"' );
}
$edited_Blog->set_setting( 'default_cat_ID', $edited_Chapter->ID );
$edited_Blog->dbsave();
$Messages->add( sprintf( TB_('Default category of this collection has been updated to "%s".'), $edited_Chapter->get( 'name' ) ), 'success' );
if( ! empty( $moved_items_num ) )
{ // Inform about moved items:
$Messages->add( sprintf( TB_('Please note %d "content-block" items have been moved to new default category.'), $moved_items_num ), 'note' );
}
// We want to highlight the edited object on next list display:
$Session->set( 'fadeout_array', array( $edited_Chapter->ID ) );
header_redirect( $admin_url.'?ctrl=chapters&blog='.$blog );
break;
case 'set_meta':
// Make category as meta category
if( $edited_Blog->get_default_cat_ID() == $edited_Chapter->ID )
{ // If category is default:
$Messages->add( TB_('Meta category cannot be used as default!'), 'error' );
header_redirect( '?ctrl=chapters&blog='.$blog, 303 ); // Will EXIT
// We have EXITed already at this point!!
}
// Start serializable transaction because a category can be meta only if it has no posts
$DB->begin( 'SERIALIZABLE' );
// Category can be set as meta if it has no posts
$result = !$edited_Chapter->has_posts();
$edited_Chapter->set( 'meta', '1' );
// Save category
if( $result && $edited_Chapter->dbsave() )
{ // Category has no posts and it was saved successful
$Messages->add( sprintf( TB_('The category «%s» was made as meta category.'), $edited_Chapter->dget('name') ), 'success' );
$DB->commit();
}
else
{
$Messages->add( sprintf( TB_('The category «%s» cannot be set as meta category. You must remove the posts it contains first.'), $edited_Chapter->dget('name') ) );
$DB->rollback();
}
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=chapters&blog='.$blog, 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'unset_meta':
// Revert to simple category
$edited_Chapter->set( 'meta', '0' );
if( $edited_Chapter->dbsave() )
{
$Messages->add( sprintf( TB_('The category «%s» was reverted from meta category.'), $edited_Chapter->dget('name') ), 'success' );
}
else
{
$Messages->add( sprintf( TB_('The category «%s» couldn\'t be reverted from meta category.'), $edited_Chapter->dget('name') ), 'error' );
}
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=chapters&blog='.$blog, 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'lock':
// Lock category
$edited_Chapter->set( 'lock', '1' );
if( $edited_Chapter->dbsave() )
{
$Messages->add( sprintf( TB_('The category «%s» was locked.'), $edited_Chapter->dget('name') ), 'success' );
}
else
{
$Messages->add( sprintf( TB_('The category «%s» couldn\'t be locked.'), $edited_Chapter->dget('name') ), 'error' );
}
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=chapters&blog='.$blog, 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'unlock':
// Unlock category
$edited_Chapter->set( 'lock', '0' );
if( $edited_Chapter->dbsave() )
{
$Messages->add( sprintf( TB_('The category «%s» was unlocked.'), $edited_Chapter->dget('name') ), 'success' );
}
else
{
$Messages->add( sprintf( TB_('The category «%s» couldn\'t be unlocked.'), $edited_Chapter->dget('name') ), 'error' );
}
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=chapters&blog='.$blog, 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
}
if( $action == 'list' )
{ // Load JS to edit chapter order inline
require_js_defer( 'customized:jquery/jeditable/jquery.jeditable.js', 'rsc_url' );
}
if( in_array( $action, array( 'list', 'edit', 'move' ) ) )
{ // Initialize Hotkeys:
init_hotkeys_js();
}
/**
* Display page header, menus & messages:
*/
$AdminUI->set_coll_list_params( 'blog_cats', 'edit', array( 'ctrl' => $ctrl ) );
$AdminUI->set_path( 'collections', 'categories' );
$AdminUI->breadcrumbpath_init( true, array( 'text' => TB_('Collections'), 'url' => $admin_url.'?ctrl=colls_settings&tab=dashboard&blog=$blog$' ) );
$AdminUI->breadcrumbpath_add( TB_('Categories'), $admin_url.'?ctrl=chapters&blog=$blog$' );
if( in_array( $action, array( 'new', 'edit', 'copy', 'create', 'update' ) ) )
{
$AdminUI->set_page_manual_link( 'category-edit-form' );
}
else
{
$AdminUI->set_page_manual_link( 'categories-tab' );
}
// Display <html><head>...</head> section! (Note: should be done early if actions do not redirect)
$AdminUI->disp_html_head();
// Display title, menu, messages, etc. (Note: messages MUST be displayed AFTER the actions)
$AdminUI->disp_body_top();
/**
* Display payload:
*/
switch( $action )
{
case 'nil':
// Do nothing
break;
case 'move':
// EXTENSION TO GENERIC:
// Move to another blog:
// Begin payload block:
$AdminUI->disp_payload_begin();
$AdminUI->disp_view( 'chapters/views/_chapter_move.form.php' );
// End payload block:
$AdminUI->disp_payload_end();
break;
case 'new':
case 'copy':
case 'create':
case 'edit':
case 'update':
case 'delete':
// Begin payload block:
$AdminUI->disp_payload_begin();
param( 'redirect_page', 'string', '', true );
if( $action == 'delete' )
{ // We need to ask for confirmation:
$edited_Chapter->confirm_delete(
sprintf( TB_('Delete element «%s»?'), $edited_Chapter->dget( 'name' ) ),
'element', $action, get_memorized( 'action' ) );
}
// Display category edit form:
$AdminUI->disp_view( 'chapters/views/_chapter.form.php' );
// End payload block:
$AdminUI->disp_payload_end();
break;
case 'list':
default:
// Begin payload block:
$AdminUI->disp_payload_begin();
// Display list VIEW:
$AdminUI->disp_view( 'chapters/views/_chapter_list.view.php' );
// End payload block:
$AdminUI->disp_payload_end();
break;
}
// Display body bottom, debug info and close </html>:
$AdminUI->disp_global_footer();
?>