documentation/ext.php at main · phpbbmodders/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php
/**
 *
 * Documentation extension for the phpBB Forum Software package
 *
 * @copyright (c) 2026, phpBB Modders, https://www.phpbbmodders.com/
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace phpbbmodders\documentation;

class ext extends \phpbb\extension\base
{
	/**
	 * Check whether the extension can be enabled.
	 * The current phpBB and PHP version should meet or
	 * exceed the minimum version required by this extension:
	 *
	 * @return bool|array
	 * @access public
	 */
	public function is_enableable()
	{
		$enableable = $this->check_phpbb_version() && $this->check_php_version();

		if (!$enableable)
		{
			$language = $this->container->get('language');
			$language->add_lang('install_documentation', 'phpbbmodders/documentation');

			return $language->lang('DOCUMENTATION_NOT_ENABLEABLE');
		}

		return $enableable;
	}

	/**
	 * Require phpBB 3.3.19 due to several security fixes in the phpBB software.
	 * Retain the existing upper limit excluding phpBB 4.0.
	 *
	 * @return bool
	 */
	public function check_phpbb_version()
	{
		return phpbb_version_compare(PHPBB_VERSION, '3.3.19', '>=')
			&& phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '<');
	}

	/**
	 * Requires PHP 8.3.36 due to security fixes.
	 *
	 * @return bool
	 */
	public function check_php_version()
	{
		return PHP_VERSION_ID >= 80336;
	}

	/**
	 * @param mixed $old_state
	 * @return mixed
	 */
	public function enable_step($old_state)
	{
		if ($old_state === false)
		{
			$this->container->get('notification_manager')
				->enable_notifications('notification.type.phpbbmodders_documentation_no_build');

			return 'notification';
		}

		return parent::enable_step($old_state);
	}

	/**
	 * @param mixed $old_state
	 * @return mixed
	 */
	public function disable_step($old_state)
	{
		if ($old_state === false)
		{
			$this->container->get('notification_manager')
				->disable_notifications('notification.type.phpbbmodders_documentation_no_build');

			return 'notification';
		}

		return parent::disable_step($old_state);
	}

	/**
	 * @param mixed $old_state
	 * @return mixed
	 */
	public function purge_step($old_state)
	{
		if ($old_state === false)
		{
			$this->container->get('notification_manager')
				->purge_notifications('notification.type.phpbbmodders_documentation_no_build');

			$this->purge_permissions();
			$this->container->get('config')->delete('phpbbmodders_documentation_sync_pending');

			return 'notification';
		}

		return parent::purge_step($old_state);
	}

	/** Remove owned ACL options even when their build sections no longer exist. */
	protected function purge_permissions()
	{
		$db = $this->container->get('dbal.conn');
		$result = $db->sql_query('SELECT auth_option FROM ' . ACL_OPTIONS_TABLE . '
			WHERE auth_option ' . $db->sql_like_expression('u_phpbbmodders_documentation_' . $db->get_any_char()));
		$permissions = array();
		while ($row = $db->sql_fetchrow($result))
		{
			$permissions[] = $row['auth_option'];
		}
		$db->sql_freeresult($result);

		$tool = new \phpbb\db\migration\tool\permission(
			$db,
			$this->container->get('cache'),
			$this->container->get('auth'),
			$this->container->getParameter('core.root_path'),
			$this->container->getParameter('core.php_ext')
		);
		foreach ($permissions as $permission)
		{
			$tool->remove($permission);
			$tool->remove($permission, false);
		}
	}
}