Use router to generate url, add language keys and improve migration

Author: rubencm

config/services.yml

@@ -54,6 +54,7 @@ services:
     phpbb.ads.admin.input:
         class: phpbb\ads\controller\admin_input
         arguments:
+            - '@controller.helper'
             - '@user'
             - '@user_loader'
             - '@language'

controller/admin_input.php

@@ -17,6 +17,9 @@
  */
 class admin_input
 {
+	/** @var \phpbb\controller\helper */
+	protected $controller_helper;
+
 	/** @var \phpbb\user */
 	protected $user;
 
@@ -44,8 +47,9 @@ class admin_input
 	 * @param \phpbb\request\request   $request     Request object
 	 * @param \phpbb\ads\banner\banner $banner      Banner upload object
 	 */
-	public function __construct(\phpbb\user $user, \phpbb\user_loader $user_loader, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\banner\banner $banner)
+	public function __construct(\phpbb\controller\helper $controller_helper, \phpbb\user $user, \phpbb\user_loader $user_loader, \phpbb\language\language $language, \phpbb\request\request $request, \phpbb\ads\banner\banner $banner)
 	{
+		$this->controller_helper = $controller_helper;
 		$this->user = $user;
 		$this->user_loader = $user_loader;
 		$this->language = $language;
@@ -136,7 +140,7 @@ public function banner_upload($ad_code)
 		{
 			$realname = $this->banner->upload();
 
-			$banner_html = '<img src="' . generate_board_url() . '/ads_download/' . $realname . '" />';
+			$banner_html = '<img src="' . generate_board_url() . $this->controller_helper->route('phpbb_ads_storage_banner', ['file' => $realname]) . '" />';
 
 			if ($this->request->is_ajax())
 			{

language/en/common.php

@@ -66,4 +66,7 @@
 	'AD_SLIDE_UP_DESC'				=> 'Displays on every page after user scrolls below main content. Slides up from the bottom.',
 	'AD_SCRIPTS'					=> 'Scripts',
 	'AD_SCRIPTS_DESC'				=> 'This location is for specialty JavaScript code like AdSense Auto ads, tracking codes, etc. The code entered here will be inserted into the page’s HEAD tag and is not intended for ad placement, but only for helper scripts.',
+
+	// Storage
+	'STORAGE_PHPBB_ADS_TITLE' => 'phpBB Ads',
 ));

migrations/v30x/m1_storage.php

@@ -10,10 +10,24 @@
 
 namespace phpbb\ads\migrations\v30x;
 
+use phpbb\filesystem\filesystem;
 use phpbb\storage\provider\local;
 
 class m1_storage extends \phpbb\db\migration\container_aware_migration
 {
+	/**
+	 * {@inheritdoc}
+	 */
+	public function effectively_installed()
+	{
+		/** @var filesystem $filesystem_interface */
+		$filesystem = $this->container->get('filesystem');
+
+		return $this->config->offsetExists('storage\\phpbb_ads\\provider') &&
+			$this->config->offsetExists('storage\\phpbb_ads\\config\\path') &&
+			$filesystem->exists($this->phpbb_root_path . 'images/phpbb_ads');
+	}
+
 	/**
 	 * {@inheritDoc}
 	 */
@@ -29,15 +43,54 @@ public function update_data()
 	{
 		return array(
 			['config.add', ['storage\\phpbb_ads\\provider', local::class]],
-			['config.add', ['storage\\phpbb_ads\\config\\path', 'images/phpbb_ads']], // todo: make sure this exists in migration if is a new installation
+			['config.add', ['storage\\phpbb_ads\\config\\path', 'images/phpbb_ads']],
+			['custom', [[$this, 'migrate_ads_storage']]],
 		);
 	}
 
+	public function migrate_ads_storage()
+	{
+		/** @var filesystem $filesystem_interface */
+		$filesystem = $this->container->get('filesystem');
+
+		/** @var file_tracker $file_tracker */
+		$file_tracker = $this->container->get('storage.file_tracker');
+
+		if (!$filesystem->exists($this->phpbb_root_path . 'images/phpbb_ads'))
+		{
+			$filesystem->mkdir($this->phpbb_root_path . 'images/phpbb_ads');
+		}
+
+		$dir = $this->phpbb_root_path . 'images/phpbb_ads';
+		$handle = @opendir($dir);
+
+		if ($handle)
+		{
+			while (($file = readdir($handle)) !== false)
+			{
+				if ($file === '.' || $file === '..')
+				{
+					continue;
+				}
+
+				$file_tracker->track_file('phpbb_ads', $file, filesize($this->phpbb_root_path . 'images/phpbb_ads/' . $file));
+			}
+
+			closedir($handle);
+		}
+	}
+
 	public function revert_data()
 	{
 		return [
 			['config.remove', ['storage\\phpbb_ads\\provider']],
 			['config.remove', ['storage\\phpbb_ads\\config\\path']],
+			['custom', [[$this, 'revert_ads_storage']]],
 		];
 	}
+
+	public function revert_ads_storage()
+	{
+		$this->sql_query('DELETE FROM ' . $this->tables['storage'] . ' WHERE storage = "phpbb_ads"');
+	}
 }