<?php

// (c) Copyright by authors of the Tiki Wiki CMS Groupware Project
//
// All Rights Reserved. See copyright.txt for details and a complete list of authors.
// Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details.
// $Id$


namespace Tiki;

use TikiLib;

class Sections
{
    protected static $sections = [
        // tra('Wiki Page') -- tra() comments are there for get_strings.php
        'wiki page' => [
            'feature' => 'feature_wiki',
            'key' => 'page',
            'itemkey' => '',
            'objectType' => 'wiki page',
            'commentsFeature' => 'feature_wiki_comments',
        ],
        // tra('Blog')
        // tra('Blog Post')
        'blogs' => [
            'feature' => 'feature_blogs',
            'key' => 'blogId',
            'itemkey' => 'postId',
            'objectType' => 'blog',
            'itemObjectType' => 'blog post',
            'itemCommentsFeature' => 'feature_blogposts_comments'
        ],
        // tra('File Gallery')
        // tra('File')
        'file_galleries' => [
            'feature' => 'feature_file_galleries',
            'key' => 'galleryId',
            'itemkey' => 'fileId',
            'objectType' => 'file gallery',
            'itemObjectType' => 'file',
            'commentsFeature' => 'feature_file_galleries_comments',
        ],
        // tra('Forum')
        // tra('Forum Post')
        'forums' => [
            'feature' => 'feature_forums',
            'key' => 'forumId',
            'itemkey' => 'comments_parentId',
            'objectType' => 'forum',
            'itemObjectType' => 'forum post',
        ],
        // tra('Article')
        'cms' => [
            'feature' => 'feature_articles',
            'key' => 'articleId',
            'itemkey' => '',
            'objectType' => 'article',
            'commentsFeature' => 'feature_article_comments'
        ],
        // tra('Tracker')
        'trackers' => [
            'feature' => 'feature_trackers',
            'key' => 'trackerId',
            'itemkey' => 'itemId',
            'objectType' => 'tracker',
            'itemObjectType' => 'tracker %d',
        ],
        'mytiki' => [
            'feature' => '',
            'key' => 'user',
            'itemkey' => '',
        ],
        'user_messages' => [
            'feature' => 'feature_messages',
            'key' => 'msgId',
            'itemkey' => '',
        ],
        'webmail' => [
            'feature' => 'feature_webmail',
            'key' => 'msgId',
            'itemkey' => '',
        ],
        'contacts' => [
            'feature' => 'feature_contacts',
            'key' => 'contactId',
            'itemkey' => '',
        ],
        // tra('Faq')
        'faqs' => [
            'feature' => 'feature_faqs',
            'key' => 'faqId',
            'itemkey' => '',
            'objectType' => 'faq',
            'commentsFeature' => 'feature_faq_comments',
        ],
        // tra('Quizz')
        'quizzes' => [
            'feature' => 'feature_quizzes',
            'key' => 'quizId',
            'itemkey' => '',
            'objectType' => 'quiz',
        ],
        // tra('Poll')
        'poll' => [
            'feature' => 'feature_polls',
            'key' => 'pollId',
            'itemkey' => '',
            'objectType' => 'poll',
            'commentsFeature' => 'feature_poll_comments',
        ],
        // tra('Survey')
        'surveys' => [
            'feature' => 'feature_surveys',
            'key' => 'surveyId',
            'itemkey' => '',
            'objectType' => 'survey',
        ],
        'featured_links' => [
            'feature' => 'feature_featuredLinks',
            'key' => 'url',
            'itemkey' => '',
        ],
        // tra('Directory')
        'directory' => [
            'feature' => 'feature_directory',
            'key' => 'directoryId',
            'itemkey' => '',
            'objectType' => 'directory',
        ],
        // tra('Calendar')
        'calendar' => [
            'feature' => 'feature_calendar',
            'key' => 'calendarId',
            'itemkey' => 'viewcalitemId',
            'objectType' => 'calendar',
            'itemObjectType' => 'event',
        ],
        'categories' => [
            'feature' => 'feature_categories',
            'key' => 'categId',
            'itemkey' => '',
        ],
        // tra('Html Page')
        'html_pages' => [
            'feature' => 'feature_html_pages',
            'key' => 'pageId',
            'itemkey' => '',
            'objectType' => 'html page',
        ],
        // tra('Newsletter')
        'newsletters' => [
            'feature' => 'feature_newsletters',
            'key' => 'nlId',
            'objectType' => 'newsletter',
        ],
    ];

    /**
     * Retrieves the list of sections
     *
     * @return array
     */
    public static function getSections()
    {
        return self::$sections;
    }

    /**
     * Attempts to guess the object being processed based on the request parameters
     *
     * @param array|null $request An array with the request parameters (if not provided will default to $_REQUEST)
     * @return null|array Array with the type and object being requested, null/empty if not successful
     * @throws \Exception
     */
    public static function currentObject($request = null)
    {
        global $section, $cat_type, $cat_objid, $postId, $prefs;

        if (! is_array($request)) {
            $request = $_REQUEST; // use the global request object
        }

        if ($section == 'blogs' && ! empty($postId)) { // blog post check the category on the blog - but freetags are on blog post
            return [
                'type' => 'blog post',
                'object' => $postId,
            ];
        }

        if ($section == 'forums' && ! empty($request['comments_parentId'])) {
            return [
                'type' => 'forum post',
                'object' => $request['comments_parentId'],
            ];
        }

        // Pretty tracker pages
        if ($section == 'wiki page' && isset($request['itemId'])) {
            return [
                'type' => 'trackeritem',
                'object' => (int)$request['itemId'],
            ];
        }

        if ($cat_type && $cat_objid) {
            return [
                'type' => $cat_type,
                'object' => $cat_objid,
            ];
        }

        if ($section == 'trackers' && ! empty($request['itemId'])) {
            return [
                'type' => 'trackeritem',
                'object' => $request['itemId'],
            ];
        }

        $sections = self::getSections();

        if (isset($sections[$section])) {
            $info = $sections[$section];

            if (isset($info['itemkey'], $info['itemObjectType'], $request[$info['itemkey']])) {
                $type = isset($request[$info['key']]) ? $info['key'] : '';
                return [
                    'type' => sprintf($info['itemObjectType'], $type),
                    'object' => $request[$info['itemkey']],
                ];
            } elseif (isset($info['key'], $info['objectType'], $request[$info['key']])) {
                if (is_array($request[$info['key']])) {    // galleryId is an array here when in tiki-upload_file.php
                    $k = $request[$info['key']][0];
                } else {
                    $k = $request[$info['key']];
                    // when using wiki_url_scheme the page request var is the page slug, not the page/object name
                    if ($prefs['wiki_url_scheme'] !== 'urlencode' && $info['objectType'] === 'wiki page') {
                        $k = TikiLib::lib('wiki')->get_page_by_slug($k);
                    }
                }
                return [
                    'type' => $info['objectType'],
                    'object' => $k,
                ];
            }
        }
    }
}