user-access-manager / src / File / ApacheFileProtection.php

ApacheFileProtection.php in User Access Manager 2.1.8, at src/File/ApacheFileProtection.php

194 lines 5.4 KB

Raw Download Zip

1	<?php
2	/**
3	* ApacheFileProtection.php
4	*
5	* The ApacheFileProtection class file.
6	*
7	* PHP versions 5
8	*
9	* @author Alexander Schneider <alexanderschneider85@gmail.com>
10	* @copyright 2008-2017 Alexander Schneider
11	* @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2
12	* @version SVN: $id$
13	* @link http://wordpress.org/extend/plugins/user-access-manager/
14	*/
15	namespace UserAccessManager\File;
16
17	use UserAccessManager\Object\ObjectHandler;
18
19	/**
20	* Class ApacheFileProtection
21	*
22	* @package UserAccessManager\FileHandler
23	*/
24	class ApacheFileProtection extends FileProtection implements FileProtectionInterface
25	{
26	const FILE_NAME = '.htaccess';
27
28	/**
29	* Returns the file types.
30	*
31	* @return null\|string
32	*/
33	private function getFileTypes()
34	{
35	$fileTypes = null;
36	$lockedFileTypes = $this->mainConfig->getLockedFileType();
37
38	if ($lockedFileTypes === 'selected') {
39	$fileTypes = $this->cleanUpFileTypes($this->mainConfig->getLockedFiles());
40	$fileTypes = ($fileTypes !== '') ? "\.({$fileTypes})" : null;
41	} elseif ($lockedFileTypes === 'not_selected') {
42	$fileTypes = $this->cleanUpFileTypes($this->mainConfig->getNotLockedFiles());
43	$fileTypes = ($fileTypes !== '') ? "^\.({$fileTypes})" : null;
44	}
45
46	return $fileTypes;
47	}
48
49	/**
50	* Returns the directory match.
51	*
52	* @return null\|string
53	*/
54	protected function getDirectoryMatch()
55	{
56	if ($this->mainConfig->getLockedDirectoryType() === 'wordpress') {
57	return '^.'.DIRECTORY_SEPARATOR.parent::getDirectoryMatch().'.$';
58	}
59
60	return parent::getDirectoryMatch();
61	}
62
63	/**
64	* @param string $content
65	*
66	* @return string
67	*/
68	private function applyFilters($content)
69	{
70	$fileTypes = $this->getFileTypes();
71
72	if ($fileTypes !== null) {
73	/** @noinspection */
74	$content = "<FilesMatch '{$fileTypes}'>\n{$content}</FilesMatch>\n";
75	}
76
77	return $content;
78	}
79
80	/**
81	* Creates the file content if no permalinks are active.
82	*
83	* @param string $directory
84	*
85	* @return string
86	*/
87	private function getFileContent($directory)
88	{
89	$areaName = 'WP-Files';
90	// make .htaccess and .htpasswd
91	$content = "AuthType Basic"."\n";
92	$content .= "AuthName \"{$areaName}\""."\n";
93	$content .= "AuthUserFile {$directory}.htpasswd"."\n";
94	$content .= "require valid-user"."\n";
95
96	return $this->applyFilters($content);
97	}
98
99	/**
100	* Creates the file content if permalinks are active.
101	*
102	* @param string $objectType
103	*
104	* @return string
105	*/
106	private function getPermalinkFileContent($objectType)
107	{
108	if ($objectType === null) {
109	$objectType = ObjectHandler::ATTACHMENT_OBJECT_TYPE;
110	}
111
112	$homeRoot = parse_url($this->wordpress->getSiteUrl());
113	$homeRoot = (isset($homeRoot['path']) === true) ? '/'.trim($homeRoot['path'], '/\\').'/' : '/';
114
115	$content = "RewriteEngine On\n";
116	$content .= "RewriteBase {$homeRoot}\n";
117	$content .= "RewriteRule ^index\\.php$ - [L]\n";
118	$content .= "RewriteCond %{REQUEST_URI} !.\/sites\/[0-9]+\/.\n";
119
120	$directoryMatch = $this->getDirectoryMatch();
121
122	if ($directoryMatch !== null) {
123	$content .= "RewriteCond %{REQUEST_URI} {$directoryMatch}\n";
124	}
125
126	$content .= "RewriteRule ^([^?]*)$ {$homeRoot}index.php?uamfiletype={$objectType}&uamgetfile=$1 [QSA,L]\n";
127	$content .= "RewriteRule ^(.)\\?(((?!uamfiletype).))$ ";
128	$content .= "{$homeRoot}index.php?uamfiletype={$objectType}&uamgetfile=$1&$2 [QSA,L]\n";
129	$content .= "RewriteRule ^(.)\\?(.)$ {$homeRoot}index.php?uamgetfile=$1&$2 [QSA,L]\n";
130	$content = $this->applyFilters($content);
131
132	$content = "<IfModule mod_rewrite.c>\n$content</IfModule>\n";
133
134	return $content;
135	}
136
137	/**
138	* Returns the htaccess file name with path.
139	*
140	* @param null\|string $directory
141	*
142	* @return string
143	*/
144	public function getFileNameWithPath($directory = null)
145	{
146	return $directory.self::FILE_NAME;
147	}
148
149	/**
150	* Generates the htaccess file.
151	*
152	* @param string $directory
153	* @param string $objectType
154	*
155	* @return bool
156	*/
157	public function create($directory, $objectType = null)
158	{
159	$directory = rtrim($directory, '/').'/';
160
161	if ($this->wordpress->gotModRewrite() === false) {
162	$content = $this->getFileContent($directory);
163	$this->createPasswordFile(true, $directory);
164	} else {
165	$content = $this->getPermalinkFileContent($objectType);
166	}
167
168	// save files
169	$fileWithPath = $this->getFileNameWithPath($directory);
170
171	try {
172	file_put_contents($fileWithPath, $content);
173	return true;
174	} catch (\Exception $exception) {
175	// Because file_put_contents can throw exceptions we use this try catch block
176	// to return the success result instead of an exception
177	}
178
179	return false;
180	}
181
182	/**
183	* Deletes the htaccess files.
184	*
185	* @param string $directory
186	*
187	* @return bool
188	*/
189	public function delete($directory)
190	{
191	return $this->deleteFiles($directory);
192	}
193	}
194