aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/event/md_exporter.php
blob: f7021875f3e6460b4ec0d02d20b02ad4da94d580 (plain) 
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
p4DOE1On..?b\	~LcƙYH<#SV46iORt('Y{iyI뿦Qۓ?mV$B26 i)*B"`lve(Ҕ"ݯU:J*T,-T]{^yʃۦb*	i#8nRvOI`|wKXudܷW9+@ļ<|4Bu"^PWvuZ:
;s1Tbt
h4
ovgM>%Rқkf?vD^* c'WϿJC~С[cs'l163LmV-_I~E5'%#WSŝU@M
A\@(d;g\o>(@;] pH
O=J竪7[ބnylͦnhwnԣʇ* kp6KPj<>?YO%\ԩ{r`롍ʘd]nȉ,edjrHkDU+LYZZla*hljJ?u58E	ڐl'j
(
+
v`.1M
k0	̀B36?i3YhUHmXc#M-\AGIx6$4SzCDtyX
M̓oBk%\BV)%~ֈ%m*
zwΝ=:s^'P9۱Zt4x
&`#rB<7g ;2
>1ʆ~v(LI#G/_2ɸvŮ/DC*nL&
1>Ly}TE@2NQRtFI@K.; mI6gni.H@!-kZ3k}p5#4:Uݐb64}.lev'H/B"
Jُydxb76T^EBk'_lY9Z/	":;L.?U5,nPͻ
eNN14-1_w:ТTBN2GOO?@ *L2o&}a,|s
%wA{d]MX(\	sM¡^~Xhe*@g$ө85P1gkVyӕOWBoZjDΖ+μR_\ȯATsG1GYӖ"YŹY+7؀Tөvlƫߣ䁭
"Q14;D|DE;:t0XAE
 NwZWn
4dJ7#Y"ja6K9ͽKJq$`0!	+/S|UnNpl$5ɬf~g2w/QnnII@e2ƖNxǶ]Q9RuP X辎:@)VGr<2uƐ-cj<ǶߤMuskZ
bЅЈp=Aƥ	Dq>"(nA%u7<2eDvh㉅HKkE:,/ZWȉZN4xgMټKFuUk]_+tGPs-5
iHFWnt0ю,{v=ϱ@He@pKZ	,*.C}uh6cO<hԣ5>Ltk0M
UoGf1JLy
 X-HD+fˋn;[AkS!rK>I-jnl:56Ư<}Hmr]^6߮HYje?[<&Y,Pq1MHÎ٥5z!.ڣDz/ _u/M<^7C\NY)ULN7RHkCuʁl{ZUs>oN|N@/	xs{!U>4aهCD vL4T<ϚJ 7r!B7B]Ċķn⣘'>gNiHgVE^`e|5>N>2)tŭ-ED_	@=
<f)CQW&/ni'إ8*9'"!uy.Aբ+R)j#Va#W{8gO0$PCL=5F3calm/5pI͡xhj$3E3ߏ!m~~ݴAIm¾oƙC~aKO[DV72-3H2(CiPoJ=UߺhP#Ul8_YoxQpq
65g- LPe˥ޟe.5Յ/ud\kSG ]@aMUM˾Vuio&ykl`VMÜ^i!1+=[R+3/
/\EN[k!D鐏:+:{,|v2Y\;]m*ka#VSIAzW`WA|aԱ5@
i.*agG;xnmC&N ,+}yB-{XiFGv'eI6ҨMsjЧ>;HGE%ӛD0E!B{AP8B߿H,*@~j2e-ΚqnSC^\vc}ƨoɨD?ٛSt!`mǪFj~._[jvڹ1~)~kvЌW]BnyX@VO=T .SڻUbr[(˓kSCqgCx:.Uƭ>QMOY+ϫȭN(x-<{}YsdX,\o9i8['|۵6#"jPgJ0Э7{7# Kؿ:WV<Ӕ21)rˤZ|!XA4q&ߦIc\\v4kUt2@耓Ll3qz;}6^y*7tf߰[#@7^Ә
1ltU
)u~ZbTg85Y{{xJÿPO빦V;
{r
-^Ns9z
\\vԡ8Կ[fϞS2nSvŏH'k-(t3FJJ"G%:$T9@LºxeYFT?dQa]Ptܵw4!y7.z
ֺ
@Wf9~\FK/x`ֿ=?ڤ›[U2Kmt»W<q FA
ȴ:wƪ
ҝj	8%wZұ0Yk"νU՜[2y߱e>qmO^xg7vwu|	81byt;*ps.yW]Y\V<$XBWT'rP4jƔ՟ѱen.NF?Z%N"
"u]=WXI(
fA~^/m첬<'6[@n$$ PM
+ejP0p;iN}t0:[;G@AS!޼M6!%ؐ9~h^\2#Jɗ)Af Q:q?nv3ye(-&A,YSlX87prP{6w3`U'O][셪`Z>AŒB&UYC'|X 45^!i-n8HЦ[p}@	e6H
|	-"7ŋp+#[>v}>G	Łf"^5h `*
Ix-zXGUo0LDx	NVFmQ]Jo81ټ)]qi,=whYsBKb9.'LQ_q	C+F
L1lpxGkJud[O\jlH];Vqhug
epZGa\D<:>Aɂ'Ԋ=ސnO3
.'vC5h{N%v"1'P|b\is_+
ֹ;^rZccJ+	>l7c{3i2`C9}kټHb
"tw|~zi5neؑࢤGl|S9'ΎnHOڰytJ6ZV}ɫ_v cX;61JY6*wqLK(e^3(=кeZ[w"Ξ_eK8+R[rnNHxۼ,M6_W՞{mwˀ&ki ƶ[2)=!ª.z |X.Xa.3\rYmI7xinw  &7\;8	(bj!҆Hau(?V1c# ܾҿw^ړ؞ yPWPei~!;rFt腠32Tra1PbOl(iSQ
VD+S6oqج]|p'\S$GNWSo_1_&?mjV~IkiS71yFuۣbrδr4ڳ.@:LwG=G&٨HcmB^n@%PjM?PyWc; 
pSM*zPƦȮlWx]̈,{dapWԭW5'[|tF_DVJE:vWy#u-ϩ6M)H 	J%se@[5H;cBƿ1Ɯ\N5%zm0ީ78N4GuLuA'ľ Xe6&ڸc%Ӎk?냆42T+h#lB?ڤ~;lcc@0=$g{ų|*HXBL.o	 6l=y>4x-e=M*@('[n"J/*CywiPE6!5iM^xϻ
^ӵo݆/Ȧy!oHѰh_pn%.6Z+I	&.)SG~='gBELȗ OQF7Z5než$CflA6-_Tb+w)eӶ	xHuh>C	:dfK#NTk#%x$
䯉Xە&,(h/9Mc1FaWӾ<	dNgEu~lq
1x3`i^ZaB#&=4*
I
'XfeRtƑdv+8(o#?څAtg408
ac1N"+Gl}k&e1X
ׇlV'`.ЋIQu2Z	?D^~dh	-n1Q,/3}莩1&/3ޥ5
B*j{	$+wT8勉dVk~D0bJ3CE
C	{XόDK+Ay[/^\7'4OOV`wMͮM~Y06h@!l`x`1>p̘“WBؖ0f) YA`*'&F$HN\S!EFRrLf2M6E/5:X{N[=XO׋f3	uQ™ڨTz2ΰ	3)grC	8;p
<?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\event;

/**
* Crawls through a markdown file and grabs all events
*/
class md_exporter
{
	/** @var string Path where we look for files*/
	protected $path;

	/** @var string phpBB Root Path */
	protected $root_path;

	/** @var string */
	protected $filter;

	/** @var string */
	protected $current_event;

	/** @var array */
	protected $events;

	/**
	* @param string $phpbb_root_path
	* @param mixed $extension	String 'vendor/ext' to filter, null for phpBB core
	*/
	public function __construct($phpbb_root_path, $extension = null)
	{
		$this->root_path = $phpbb_root_path;
		$this->path = $this->root_path;
		if ($extension)
		{
			$this->path .= 'ext/' . $extension . '/';
		}

		$this->events = array();
		$this->events_by_file = array();
		$this->filter = $this->current_event = '';
	}

	/**
	* Get the list of all events
	*
	* @return array		Array with events: name => details
	*/
	public function get_events()
	{
		return $this->events;
	}

	/**
	* @param string $md_file	Relative from phpBB root
	* @return int		Number of events found
	* @throws \LogicException
	*/
	public function crawl_phpbb_directory_adm($md_file)
	{
		$this->crawl_eventsmd($md_file, 'adm');

		$file_list = $this->get_recursive_file_list($this->path  . 'adm/style/');
		foreach ($file_list as $file)
		{
			$file_name = 'adm/style/' . $file;
			$this->validate_events_from_file($file_name, $this->crawl_file_for_events($file_name));
		}

		return sizeof($this->events);
	}

	/**
	* @param string $md_file	Relative from phpBB root
	* @return int		Number of events found
	* @throws \LogicException
	*/
	public function crawl_phpbb_directory_styles($md_file)
	{
		$this->crawl_eventsmd($md_file, 'styles');

		$styles = array('prosilver', 'subsilver2');
		foreach ($styles as $style)
		{
			$file_list = $this->get_recursive_file_list(
				$this->path . 'styles/' . $style . '/template/'
			);

			foreach ($file_list as $file)
			{
				$file_name = 'styles/' . $style . '/template/' . $file;
				$this->validate_events_from_file($file_name, $this->crawl_file_for_events($file_name));
			}
		}

		return sizeof($this->events);
	}

	/**
	* @param string $md_file	Relative from phpBB root
	* @param string $filter		Should be 'styles' or 'adm'
	* @return int		Number of events found
	* @throws \LogicException
	*/
	public function crawl_eventsmd($md_file, $filter)
	{
		if (!file_exists($this->path . $md_file))
		{
			throw new \LogicException("The event docs file '{$md_file}' could not be found");
		}

		$file_content = file_get_contents($this->path . $md_file);
		$this->filter = $filter;

		$events = explode("\n\n", $file_content);
		foreach ($events as $event)
		{
			// Last row of the file
			if (strpos($event, "\n===\n") === false)
			{
				continue;
			}

			list($event_name, $details) = explode("\n===\n", $event, 2);
			$this->validate_event_name($event_name);
			$this->current_event = $event_name;

			if (isset($this->events[$this->current_event]))
			{
				throw new \LogicException("The event '{$this->current_event}' is defined multiple times");
			}

			if (($this->filter == 'adm' && strpos($this->current_event, 'acp_') !== 0)
				|| ($this->filter == 'styles' && strpos($this->current_event, 'acp_') === 0))
			{
				continue;
			}

			list($file_details, $details) = explode("\n* Since: ", $details, 2);
			list($since, $description) = explode("\n* Purpose: ", $details, 2);

			$files = $this->validate_file_list($file_details);
			$since = $this->validate_since($since);

			$this->events[$event_name] = array(
				'event'			=> $this->current_event,
				'files'			=> $files,
				'since'			=> $since,
				'description'	=> $description,
			);
		}

		return sizeof($this->events);
	}

	/**
	* Format the php events as a wiki table
	* @return string		Number of events found
	*/
	public function export_events_for_wiki()
	{
		if ($this->filter === 'adm')
		{
			$wiki_page = '= ACP Template Events =' . "\n";
			$wiki_page .= '{| class="zebra sortable" cellspacing="0" cellpadding="5"' . "\n";
			$wiki_page .= '! Identifier !! Placement !! Added in Release !! Explanation' . "\n";
		}
		else
		{
			$wiki_page = '= Template Events =' . "\n";
			$wiki_page .= '{| class="zebra sortable" cellspacing="0" cellpadding="5"' . "\n";
			$wiki_page .= '! Identifier !! Prosilver Placement (If applicable) !! Subsilver Placement (If applicable) !! Added in Release !! Explanation' . "\n";
		}

		foreach ($this->events as $event_name => $event)
		{
			$wiki_page .= "|- id=\"{$event_name}\"\n";
			$wiki_page .= "| [[#{$event_name}|{$event_name}]] || ";

			if ($this->filter === 'adm')
			{
				$wiki_page .= implode(', ', $event['files']['adm']);
			}
			else
			{
				$wiki_page .= implode(', ', $event['files']['prosilver']) . ' || ' . implode(', ', $event['files']['subsilver2']);
			}

			$wiki_page .= " || {$event['since']} || " . str_replace("\n", ' ', $event['description']) . "\n";
		}
		$wiki_page .= '|}' . "\n";

		return $wiki_page;
	}

	/**
	* Validates a template event name
	*
	* @param $event_name
	* @return null
	* @throws \LogicException
	*/
	public function validate_event_name($event_name)
	{
		if (!preg_match('#^([a-z][a-z0-9]*(?:_[a-z][a-z0-9]*)+)$#', $event_name))
		{
			throw new \LogicException("Invalid event name '{$event_name}'");
		}
	}

	/**
	* Validate "Since" Information
	*
	* @param string $since
	* @return string
	* @throws \LogicException
	*/
	public function validate_since($since)
	{
		if (!preg_match('#^\d+\.\d+\.\d+(?:-(?:a|b|RC|pl)\d+)?$#', $since))
		{
			throw new \LogicException("Invalid since information found for event '{$this->current_event}'");
		}

		return $since;
	}

	/**
	* Validate the files list
	*
	* @param string $file_details
	* @return array
	* @throws \LogicException
	*/
	public function validate_file_list($file_details)
	{
		$files_list = array(
			'prosilver'		=> array(),
			'subsilver2'	=> array(),
			'adm'			=> array(),
		);

		// Multi file list
		if (strpos($file_details, "* Locations:\n    + ") === 0)
		{
			$file_details = substr($file_details, strlen("* Locations:\n    + "));
			$files = explode("\n    + ", $file_details);
			foreach ($files as $file)
			{
				if (!file_exists($this->path . $file) || substr($file, -5) !== '.html')
				{
					throw new \LogicException("Invalid file '{$file}' not found for event '{$this->current_event}'", 1);
				}

				if (($this->filter !== 'adm') && strpos($file, 'styles/prosilver/template/') === 0)
				{
					$files_list['prosilver'][] = substr($file, strlen('styles/prosilver/template/'));
				}
				else if (($this->filter !== 'adm') && strpos($file, 'styles/subsilver2/template/') === 0)
				{
					$files_list['subsilver2'][] = substr($file, strlen('styles/subsilver2/template/'));
				}
				else if (($this->filter === 'adm') && strpos($file, 'adm/style/') === 0)
				{
					$files_list['adm'][] = substr($file, strlen('adm/style/'));
				}
				else
				{
					throw new \LogicException("Invalid file '{$file}' not found for event '{$this->current_event}'", 2);
				}

				$this->events_by_file[$file][] = $this->current_event;
			}
		}
		else if ($this->filter == 'adm')
		{
			$file = substr($file_details, strlen('* Location: '));
			if (!file_exists($this->path . $file) || substr($file, -5) !== '.html')
			{
				throw new \LogicException("Invalid file '{$file}' not found for event '{$this->current_event}'", 1);
			}

			$files_list['adm'][] =  substr($file, strlen('adm/style/'));

			$this->events_by_file[$file][] = $this->current_event;
		}
		else
		{
			throw new \LogicException("Invalid file list found for event '{$this->current_event}'", 2);
		}

		return $files_list;
	}

	/**
	* Get all template events in a template file
	*
	* @param string $file
	* @return array
	* @throws \LogicException
	*/
	public function crawl_file_for_events($file)
	{
		if (!file_exists($this->path . $file))
		{
			throw new \LogicException("File '{$file}' does not exist", 1);
		}

		$event_list = array();
		$file_content = file_get_contents($this->path . $file);

		$events = explode('<!-- EVENT ', $file_content);
		// Remove the code before the first event
		array_shift($events);
		foreach ($events as $event)
		{
			$event = explode(' -->', $event, 2);
			$event_list[] = array_shift($event);
		}

		return $event_list;
	}

	/**
	* Validates whether all events from $file are in the md file and vice-versa
	*
	* @param string $file
	* @param array $events
	* @return true
	* @throws \LogicException
	*/
	public function validate_events_from_file($file, array $events)
	{
		if (empty($this->events_by_file[$file]) && empty($events))
		{
			return true;
		}
		else if (empty($this->events_by_file[$file]))
		{
			$event_list = implode("', '", $events);
			throw new \LogicException("File '{$file}' should not contain events, but contains: "
				. "'{$event_list}'", 1);
		}
		else if (empty($events))
		{
			$event_list = implode("', '", $this->events_by_file[$file]);
			throw new \LogicException("File '{$file}' contains no events, but should contain: "
				. "'{$event_list}'", 1);
		}

		$missing_events_from_file = array();
		foreach ($this->events_by_file[$file] as $event)
		{
			if (!in_array($event, $events))
			{
				$missing_events_from_file[] = $event;
			}
		}

		if (!empty($missing_events_from_file))
		{
			$event_list = implode("', '", $missing_events_from_file);
			throw new \LogicException("File '{$file}' does not contain events: '{$event_list}'", 2);
		}

		$missing_events_from_md = array();
		foreach ($events as $event)
		{
			if (!in_array($event, $this->events_by_file[$file]))
			{
				$missing_events_from_md[] = $event;
			}
		}

		if (!empty($missing_events_from_md))
		{
			$event_list = implode("', '", $missing_events_from_md);
			throw new \LogicException("File '{$file}' contains additional events: '{$event_list}'", 3);
		}

		return true;
	}

	/**
	* Returns a list of files in $dir
	*
	* Works recursive with any depth
	*
	* @param	string	$dir	Directory to go through
	* @return	array	List of files (including directories)
	*/
	public function get_recursive_file_list($dir)
	{
		try
		{
			$iterator = new \RecursiveIteratorIterator(
				new \phpbb\recursive_dot_prefix_filter_iterator(
					new \RecursiveDirectoryIterator(
						$dir,
						\FilesystemIterator::SKIP_DOTS
					)
				),
				\RecursiveIteratorIterator::SELF_FIRST
			);
		}
		catch (\Exception $e)
		{
			return array();
		}

		$files = array();
		foreach ($iterator as $file_info)
		{
			/** @var \RecursiveDirectoryIterator $file_info */
			if ($file_info->isDir())
			{
				continue;
			}

			$relative_path = $iterator->getInnerIterator()->getSubPathname();

			if (substr($relative_path, -5) == '.html')
			{
				$files[] = str_replace(DIRECTORY_SEPARATOR, '/', $relative_path);
			}
		}

		return $files;
	}
}
generated by cgit v1.2.1 (git 2.21.0) at 2026-04-19 23:05:52 +0000