[ticket/14487] Try to handle connection timeouts

PHPBB3-14487

phpBB/assets/javascript/installer.js

@@ -13,6 +13,9 @@
 	var currentProgress = 0;
 	var refreshRequested = false;
 	var transmissionOver = false;
+	var status = '';
+	var statusCount = 0;
+	var statusTimeout = null;
 
 	// Template related variables
 	var $contentWrapper = $('.install-body').find('.main');
@@ -372,12 +375,45 @@
 			}
 
 			if (timeoutDetected) {
-				addMessage('error',
-					[{
-						title: installLang.title,
-						description: installLang.msg
-					}]
-				);
+				status = queryInstallerStatus();
+				statusCount = 0;
+
+				if (status === 'continue') {
+					refreshRequested = false;
+					doRefresh();
+				} else if (status === 'running')	{
+					statusTimeout = setTimeout(function() {
+						var s = queryInstallerStatus();
+						if (statusCount === 12) { // 1 minute hard cap
+							s = 'fail';
+						}
+
+						if (s === 'continue') {
+							refreshRequested = false;
+							doRefresh();
+							clearTimeout(statusTimeout);
+						} else if (s === 'fail') {
+							addMessage('error',
+								[{
+									title: installLang.title,
+									description: installLang.msg
+								}]
+							);
+							clearTimeout(statusTimeout);
+						}
+
+						statusCount++;
+						},
+						5000
+					);
+				} else {
+					addMessage('error',
+						[{
+							title: installLang.title,
+							description: installLang.msg
+						}]
+					);
+				}
 			}
 		}
 	}
@@ -564,4 +600,18 @@
 			submitForm($form, $(this));
 		});
 	}
+
+	/**
+	 * Queries the installer's status
+	 */
+	function queryInstallerStatus()
+	{
+		var data = null;
+		$.ajax({url: "../installer/status", dataType: "json"})
+		.done(function(d) {
+			data = d;
+		});
+
+		return data.status;
+	}
 })(jQuery); // Avoid conflicts with other libraries

phpBB/config/installer/container/services_install_controller.yml

@@ -65,3 +65,9 @@ services:
             - '@template'
             - '%core.root_path%'
             - '%core.php_ext%'
+
+    phpbb.installer.controller.status:
+        class: phpbb\install\controller\timeout_check
+        arguments:
+            - '@phpbb.installer.controller.helper'
+            - '%core.root_path%'

phpBB/config/installer/container/services_install_finish.yml

@@ -26,7 +26,7 @@ services:
             - { name: service_collection, tag: install_finish, class_name_aware: true }
 
     installer.module.finish_install:
-        class: phpbb\install\module\install_filesystem\module
+        class: phpbb\install\module\install_finish\module
         parent: installer.module_base
         arguments:
             - '@installer.module.install_finish_collection'

phpBB/config/installer/container/services_installer.yml

@@ -47,6 +47,7 @@ services:
             - '@request'
             - '@template'
             - '@router'
+            - '%core.root_path%'
 
     installer.helper.iohandler_cli:
         class: phpbb\install\helper\iohandler\cli_iohandler

phpBB/config/installer/routing/installer.yml

@@ -60,3 +60,8 @@ phpbb_convert_finish:
     path: /convert/finished
     defaults:
         _controller: phpbb.installer.controller.convert:finish
+
+phpbb_installer_status:
+    path: /installer/status
+    defaults:
+        _controller: phpbb.installer.controller.status:status

phpBB/phpbb/install/controller/timeout_check.php

@@ -0,0 +1,80 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\install\controller;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class timeout_check
+{
+	/**
+	 * @var helper
+	 */
+	protected $helper;
+
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
+	/**
+	 * Constructor
+	 *
+	 * @param helper	$helper
+	 * @param string	$phpbb_root_path
+	 */
+	public function __construct(helper $helper, $phpbb_root_path)
+	{
+		$this->helper = $helper;
+		$this->phpbb_root_path = $phpbb_root_path;
+	}
+
+	/**
+	 * Controller for querying installer status
+	 */
+	public function status()
+	{
+		$lock_file = $this->phpbb_root_path . 'store/io_lock.lock';
+		$response = new JsonResponse();
+
+		if (!file_exists($lock_file))
+		{
+			$response->setData(array(
+				'status' => 'fail',
+			));
+		}
+		else
+		{
+			$fp = @fopen($lock_file, 'r');
+
+			if ($fp && flock($fp, LOCK_EX | LOCK_NB))
+			{
+				$status = (filesize($lock_file) >= 2 && fread($fp, 2) === 'ok') ? 'continue' : 'fail';
+
+				$response->setData(array(
+					'status' => $status,
+				));
+				flock($fp, LOCK_UN);
+				fclose($fp);
+			}
+			else
+			{
+				$response->setData(array(
+					'status' => 'running',
+				));
+			}
+		}
+
+		return $response;
+	}
+}

phpBB/phpbb/install/helper/iohandler/ajax_iohandler.php

@@ -41,6 +41,11 @@ class ajax_iohandler extends iohandler_base
 	 */
 	protected $router;
 
+	/**
+	 * @var string
+	 */
+	protected $phpbb_root_path;
+
 	/**
 	 * @var string
 	 */
@@ -76,6 +81,11 @@ class ajax_iohandler extends iohandler_base
 	 */
 	protected $redirect_url;
 
+	/**
+	 * @var resource
+	 */
+	protected $file_lock_pointer;
+
 	/**
 	 * Constructor
 	 *
@@ -83,8 +93,9 @@ class ajax_iohandler extends iohandler_base
 	 * @param \phpbb\request\request_interface	$request	HTTP request interface
 	 * @param \phpbb\template\template			$template	Template engine
 	 * @param router 							$router		Router
+	 * @param string 							$root_path	Path to phpBB's root
 	 */
-	public function __construct(path_helper $path_helper, \phpbb\request\request_interface $request, \phpbb\template\template $template, router $router)
+	public function __construct(path_helper $path_helper, \phpbb\request\request_interface $request, \phpbb\template\template $template, router $router, $root_path)
 	{
 		$this->path_helper = $path_helper;
 		$this->request	= $request;
@@ -96,6 +107,7 @@ class ajax_iohandler extends iohandler_base
 		$this->download	= array();
 		$this->redirect_url = array();
 		$this->file_status = '';
+		$this->phpbb_root_path = $root_path;
 
 		parent::__construct();
 	}
@@ -432,6 +444,33 @@ class ajax_iohandler extends iohandler_base
 		$this->send_response(true);
 	}
 
+	/**
+	 * Acquires a file lock
+	 */
+	public function acquire_lock()
+	{
+		$lock_file = $this->phpbb_root_path . 'store/io_lock.lock';
+		$this->file_lock_pointer = @fopen($lock_file, 'w+');
+
+		if ($this->file_lock_pointer)
+		{
+			flock($this->file_lock_pointer, LOCK_EX);
+		}
+	}
+
+	/**
+	 * Release file lock
+	 */
+	public function release_lock()
+	{
+		if ($this->file_lock_pointer)
+		{
+			fwrite($this->file_lock_pointer, 'ok');
+			flock($this->file_lock_pointer, LOCK_UN);
+			fclose($this->file_lock_pointer);
+		}
+	}
+
 	/**
 	 * Callback function for language replacing
 	 *

phpBB/phpbb/install/installer.php

@@ -22,6 +22,7 @@ use phpbb\install\exception\resource_limit_reached_exception;
 use phpbb\install\exception\user_interaction_required_exception;
 use phpbb\install\helper\config;
 use phpbb\install\helper\container_factory;
+use phpbb\install\helper\iohandler\ajax_iohandler;
 use phpbb\install\helper\iohandler\cli_iohandler;
 use phpbb\install\helper\iohandler\iohandler_interface;
 use phpbb\path_helper;
@@ -126,6 +127,11 @@ class installer
 	 */
 	public function run()
 	{
+		if ($this->iohandler instanceof ajax_iohandler)
+		{
+			$this->iohandler->acquire_lock();
+		}
+
 		// Load install progress
 		$this->install_config->load_config();
 
@@ -174,7 +180,16 @@ class installer
 		try
 		{
 			$iterator = $this->installer_modules->getIterator();
-			$iterator->seek($module_index);
+
+			if ($module_index < $iterator->count())
+			{
+				$iterator->seek($module_index);
+			}
+			else
+			{
+				$iterator->seek($module_index - 1);
+				$iterator->next();
+			}
 
 			while ($iterator->valid())
 			{
@@ -256,6 +271,11 @@ class installer
 			$fail_cleanup = true;
 		}
 
+		if ($this->iohandler instanceof ajax_iohandler)
+		{
+			$this->iohandler->release_lock();
+		}
+
 		if ($install_finished)
 		{
 			// Send install finished message