Replace "operator/agent.php" with a controller

src/mibew/libs/chat.php

@@ -569,7 +569,7 @@ function setup_chatview_for_operator(Thread $thread, $operator)
     // Set SSL link
     if (Settings::get('enablessl') == "1" && !is_secure_request()) {
         $data['chat']['links']['ssl'] = get_app_location(true, true)
-            . "/operator/agent.php?thread="
+            . "/operator/chat?thread="
             . $thread->id
             . "&token="
             . $thread->lastToken;
@@ -614,9 +614,9 @@ function setup_chatview_for_operator(Thread $thread, $operator)
     }
     // Set link to user redirection page
     $params = "thread=" . $thread->id . "&token=" . $thread->lastToken;
-    $data['chat']['links']['redirect'] = MIBEW_WEB_ROOT . "/operator/agent.php?"
+    $data['chat']['links']['redirect'] = MIBEW_WEB_ROOT . "/operator/chat?"
         . $params
-        . "&act=redirect";
+        . "&redirect=1";
 
     $data['namePostfix'] = "";
 

src/mibew/libs/classes/Mibew/Controller/Chat/AbstractController.php

@@ -0,0 +1,69 @@
+<?php
+/*
+ * Copyright 2005-2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Mibew\Controller\Chat;
+
+use Mibew\Controller\AbstractController as BaseAbstractController;
+use Mibew\Settings;
+use Mibew\Style\ChatStyle;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Contains base actions which are related with operator's and user's chat
+ * windows.
+ */
+abstract class AbstractController extends BaseAbstractController
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function getStyle()
+    {
+        if (is_null($this->style)) {
+            $this->style = new ChatStyle(ChatStyle::getDefaultStyle());
+        }
+
+        return $this->style;
+    }
+
+    /**
+     * Checks if the user should be forced to use SSL connections.
+     *
+     * @param Request $request Request to check.
+     * @return boolean|\Symfony\Component\HttpFoundation\RedirectResponse False
+     *   if the redirect is not needed and redirect response object otherwise.
+     */
+    protected function sslRedirect(Request $request)
+    {
+        $need_redirect = Settings::get('enablessl') == '1'
+            && Settings::get('forcessl') == '1'
+            && !$request->isSecure();
+
+        if (!$need_redirect) {
+            return false;
+        }
+
+        if (null !== ($qs = $request->getQueryString())) {
+            $qs = '?'.$qs;
+        }
+
+        $path = 'https://' . $request->getHttpHost() . $request->getBasePath()
+            . $request->getPathInfo() . $qs;
+
+        return $this->redirect($path);
+    }
+}

src/mibew/libs/classes/Mibew/Controller/Chat/Operator/ChatController.php

@@ -0,0 +1,189 @@
+<?php
+/*
+ * Copyright 2005-2014 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Mibew\Controller\Chat\Operator;
+
+use Mibew\Controller\Chat\AbstractController;
+use Mibew\Http\Exception\BadRequestException;
+use Mibew\Style\PageStyle;
+use Mibew\Thread;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Contains all actions which are related with operator's chat window.
+ */
+class ChatController extends AbstractController
+{
+    /**
+     * Process chat pages.
+     *
+     * @param Request $request Incoming request.
+     * @return string|\Symfony\Component\HttpFoundation\RedirectResponse Rendered
+     *   page content or a redirect response.
+     * @throws BadRequestException If the thread cannot be loaded by some
+     * reasons.
+     */
+    public function indexAction(Request $request)
+    {
+        // Check if we should force the user to use SSL
+        $ssl_redirect = $this->sslRedirect($request);
+        if ($ssl_redirect !== false) {
+            return $ssl_redirect;
+        }
+
+        $operator = $this->getOperator();
+
+        // Get and validate thread id
+        $thread_id = $request->query->get('thread');
+        if (!preg_match("/^\d{1,10}$/", $thread_id)) {
+            throw new BadRequestException('Wrong value of "thread" argument.');
+        }
+
+        if (!$request->query->has('token')) {
+            // There is no token in the request so we need to start the chat
+            return $this->startChat($request);
+        }
+
+        // Get token and verify it
+        $token = $request->query->get('token');
+        if (!preg_match("/^\d{1,10}$/", $token)) {
+            throw new BadRequestException('Wrong value of "token" argument.');
+        }
+
+        $thread = Thread::load($thread_id, $token);
+        if (!$thread) {
+            throw new BadRequestException('Wrong thread.');
+        }
+
+        // Check if the current operator has enough permissions to use the thread
+        if ($thread->agentId != $operator['operatorid'] && !is_capable(CAN_VIEWTHREADS, $operator)) {
+            return $this->showErrors(array('Cannot view threads'));
+        }
+
+        $page = setup_chatview_for_operator($thread, $operator);
+
+        if ($request->query->get('redirect')) {
+            $page = array_merge_recursive(
+                $page,
+                setup_redirect_links($thread_id, $operator, $token)
+            );
+
+            // Render the page with redirection links.
+            return $this->render('redirect', $page);
+        } else {
+            // Build js application options
+            $page['chatOptions'] = json_encode($page['chat']);
+
+            // Render the page with chat.
+            return $this->render('chat', $page);
+        }
+    }
+
+    /**
+     * Starts chat process.
+     *
+     * @param Request $request Incoming request.
+     * @return string|\Symfony\Component\HttpFoundation\RedirectResponse Rendered
+     *   page content or a redirect response.
+     * @throws BadRequestException If the thread cannot be loaded by some
+     * reasons.
+     */
+    protected function startChat(Request $request)
+    {
+        $operator = $this->getOperator();
+        $thread_id = $request->query->getInt('thread');
+
+        // Check operator's browser level because old browsers aren't supported.
+        $remote_level = get_remote_level($request->headers->get('User-Agent'));
+        if ($remote_level != 'ajaxed') {
+            return $this->showErrors(array(getlocal('thread.error.old_browser')));
+        }
+
+        // Check if the thread can be loaded.
+        $thread = Thread::load($thread_id);
+        if (!$thread || !isset($thread->lastToken)) {
+            return $this->showErrors(array(getlocal('thread.error.wrong_thread')));
+        }
+
+        $view_only = ($request->query->get('viewonly') == 'true');
+        $force_take = ($request->query->get('force') == 'true');
+
+        $try_take_over = !$view_only
+            && $thread->state == Thread::STATE_CHATTING
+            && $operator['operatorid'] != $thread->agentId;
+        if ($try_take_over) {
+            if (!is_capable(CAN_TAKEOVER, $operator)) {
+                return $this->showErrors(array(getlocal('thread.error.cannot_take_over')));
+            }
+
+            if ($force_take == false) {
+                $link = $this->generateUrl(
+                    'chat_operator_start',
+                    array(
+                        'thread' => $thread_id,
+                        'force' => true,
+                    )
+                );
+                $page = array(
+                    'user' => $thread->userName,
+                    'agent' => $thread->agentName,
+                    'link' => $link,
+                    'title' => getlocal('confirm.take.head'),
+                );
+                $page_style = new PageStyle(PageStyle::getCurrentStyle());
+
+                // Show confirmation page.
+                // TODO: Move this template to chat style.
+                return $page_style->render('confirm', $page);
+            }
+        }
+
+        if (!$view_only) {
+            if (!$thread->take($operator)) {
+                return $this->showErrors(array(getlocal('thread.error.cannot_take')));
+            }
+        } elseif (!is_capable(CAN_VIEWTHREADS, $operator)) {
+            return $this->showErrors(array(getlocal('thread.error.cannot_view')));
+        }
+
+        // Redrect the operator to initialized chat page
+        $redirect_to = $this->generateUrl(
+            'chat_operator',
+            array(
+                'thread' => intval($thread_id),
+                'token' => urlencode($thread->lastToken),
+            )
+        );
+
+        return $this->redirect($redirect_to);
+    }
+
+    /**
+     * Displays error page.
+     *
+     * @param array $errors List of erorr messages to display.
+     * @return string Rendered content of chat's error page.
+     */
+    protected function showErrors($errors)
+    {
+        $page = array(
+            'errors' => $errors,
+        );
+
+        return $this->render('error', $page);
+    }
+}

src/mibew/libs/classes/Mibew/Controller/InvitationController.php

@@ -49,9 +49,13 @@ class InvitationController extends AbstractController
         }
 
         // Open chat window for operator
-        $redirect_to = $request->getBasePath()
+        $redirect_to = $this->generateUrl(
-            . '/operator/agent.php?thread=' . intval($thread->id)
+            'chat_operator',
-            . '&token=' . urlencode($thread->lastToken);
+            array(
+                'thread' => intval($thread->id),
+                'token' => urlencode($thread->lastToken),
+            )
+        );
 
         return $this->redirect($redirect_to);
     }

src/mibew/libs/routing.yml

@@ -1,3 +1,12 @@
+# Chat actions
+
+## Operator's chat
+chat_operator:
+    path: /operator/chat
+    defaults:
+        _controller: Mibew\Controller\Chat\Operator\ChatController::indexAction
+        _access_check: Mibew\AccessControl\Check\LoggedInCheck
+
 # Pages that are available for all users
 button:
     path: /b

src/mibew/operator/agent.php

@@ -1,141 +0,0 @@
-<?php
-/*
- * Copyright 2005-2014 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// Import namespaces and classes of the core
-use Mibew\Settings;
-use Mibew\Thread;
-use Mibew\Style\ChatStyle;
-use Mibew\Style\PageStyle;
-
-// Initialize libraries
-require_once(dirname(dirname(__FILE__)) . '/libs/init.php');
-
-$operator = check_login();
-
-if (Settings::get('enablessl') == "1" && Settings::get('forcessl') == "1") {
-    if (!is_secure_request()) {
-        $requested = $_SERVER['PHP_SELF'];
-        if ($_SERVER['REQUEST_METHOD'] == 'GET' && $_SERVER['QUERY_STRING']) {
-            header("Location: " . get_app_location(true, true) . "/operator/agent.php?" . $_SERVER['QUERY_STRING']);
-        } else {
-            die("only https connections are handled");
-        }
-        exit;
-    }
-}
-
-$thread_id = verify_param("thread", "/^\d{1,8}$/");
-$page = array(
-    'errors' => array(),
-);
-
-// Initialize chat style which is currently used in system
-$chat_style = new ChatStyle(ChatStyle::getCurrentStyle());
-
-$page_style = new PageStyle(PageStyle::getCurrentStyle());
-
-if (!isset($_GET['token'])) {
-
-    $remote_level = get_remote_level($_SERVER['HTTP_USER_AGENT']);
-    if ($remote_level != "ajaxed") {
-        $page['errors'][] = getlocal("thread.error.old_browser");
-        $chat_style->render('error', $page);
-        exit;
-    }
-
-    $thread = Thread::load($thread_id);
-    if (!$thread || !isset($thread->lastToken)) {
-        $page['errors'][] = getlocal("thread.error.wrong_thread");
-        $chat_style->render('error', $page);
-        exit;
-    }
-
-    $view_only = verify_param("viewonly", "/^true$/", false);
-
-    $force_take = verify_param("force", "/^true$/", false);
-    if (!$view_only && $thread->state == Thread::STATE_CHATTING && $operator['operatorid'] != $thread->agentId) {
-
-        if (!is_capable(CAN_TAKEOVER, $operator)) {
-            $page['errors'][] = getlocal("thread.error.cannot_take_over");
-            $chat_style->render('error', $page);
-            exit;
-        }
-
-        if ($force_take == false) {
-            $page = array(
-                'user' => $thread->userName,
-                'agent' => $thread->agentName,
-                'link' => $_SERVER['PHP_SELF'] . "?thread=$thread_id&force=true",
-                'title' => getlocal("confirm.take.head"),
-            );
-            $page_style->render('confirm', $page);
-            exit;
-        }
-    }
-
-    if (!$view_only) {
-        if (!$thread->take($operator)) {
-            $page['errors'][] = getlocal("thread.error.cannot_take");
-            $chat_style->render('error', $page);
-            exit;
-        }
-    } elseif (!is_capable(CAN_VIEWTHREADS, $operator)) {
-        $page['errors'][] = getlocal("thread.error.cannot_view");
-        $chat_style->render('error', $page);
-        exit;
-    }
-
-    $token = $thread->lastToken;
-    $redirect_to = MIBEW_WEB_ROOT . "/operator/agent.php?thread="
-        . intval($thread_id) . "&token=" . urlencode($token);
-    header("Location: " . $redirect_to);
-    exit;
-}
-
-$token = verify_param("token", "/^\d{1,8}$/");
-
-$thread = Thread::load($thread_id, $token);
-if (!$thread) {
-    die("wrong thread");
-}
-
-if ($thread->agentId != $operator['operatorid'] && !is_capable(CAN_VIEWTHREADS, $operator)) {
-    $page['errors'][] = "Cannot view threads";
-    $chat_style->render('error', $page);
-    exit;
-}
-
-$page = array_merge_recursive(
-    $page,
-    setup_chatview_for_operator($thread, $operator)
-);
-
-start_html_output();
-
-$pparam = verify_param("act", "/^(redirect)$/", "default");
-if ($pparam == "redirect") {
-    $page = array_merge_recursive(
-        $page,
-        setup_redirect_links($thread_id, $operator, $token)
-    );
-    $chat_style->render('redirect', $page);
-} else {
-    // Build js application options
-    $page['chatOptions'] = json_encode($page['chat']);
-    // Render the page
-    $chat_style->render('chat', $page);
-}

src/mibew/styles/pages/default/templates_src/server_side/users.handlebars

@@ -98,7 +98,7 @@
                         threadTag: "{{[coreStyles.threadTag]}}",
                         visitorTag: "{{[coreStyles.visitorTag]}}",
 
-                        agentLink: "{{mibewRoot}}/operator/agent.php",
+                        agentLink: "{{mibewRoot}}/operator/chat",
                         geoLink: "{{geoLink}}",
                         trackedLink: "{{mibewRoot}}/operator/history/user-track",
                         banLink: "{{mibewRoot}}/operator/ban",