Commit graph

160 commits

Author SHA1 Message Date
Oleg Pudeyev
7d911e0bc1 [feature/template-engine] Delete @version everywhere.
This is not used since the switch to git.

PHPBB3-9726
2011-05-14 15:30:20 -04:00
Oleg Pudeyev
b04f0a5f70 [feature/template-engine] Delete @access everywhere.
Access specification in php 5 is done directly on functions/properties.

PHPBB3-9726
2011-05-14 15:30:20 -04:00
Oleg Pudeyev
94560d7086 [feature/template-engine] Make INCLUDEPHP relative to board root.
PHPBB3-9726
2011-05-12 20:13:32 -04:00
Oleg Pudeyev
d2ac05aa74 [feature/template-engine] Replaced globals with dependency injection.
PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
345852d240 [feature/template-engine] Clarify cache directory path for set_custom_template
Even if the template may be outside of phpBB, phpBB's cache directory
is still going to be used for storing compiled template code.

PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
d2daaf0317 [feature/template-engine] Try to handle failed template includes.
PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
7638bcb560 [feature/template-engine] Rename $filename to $compiled_path for clarity.
PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
7778771819 [feature/template-engine] Move DEBUG_EXTRA check for $recompile up.
PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
504acaba6b [feature/template-engine] Deleted useless assignment.
PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
169c4377e9 [feature/template-engine] Disposed of underscores in property names.
PHPBB3-9726
2011-05-12 20:13:31 -04:00
Oleg Pudeyev
97d2a6527e [feature/template-engine] Remove commented out error reporting logic.
PHPBB3-9726
2011-05-12 20:13:30 -04:00
Oleg Pudeyev
0ca7ad66dc [feature/template-engine] Refactor hook logic into a separate function.
PHPBB3-9726
2011-05-12 20:13:30 -04:00
Oleg Pudeyev
df76885b11 [feature/template-engine] Reinstate phpbb_template#destroy function.
PHPBB3-9726
2011-05-12 20:13:30 -04:00
Oleg Pudeyev
84bc485ccc [feature/template-engine] Renamed template executor and friends to renderer.
PHPBB3-9726
2011-05-08 04:03:41 -04:00
Oleg Pudeyev
b5444a7d7d [feature/template-engine] Removed more dead code.
PHPBB3-9726
2011-05-07 17:50:48 -04:00
Oleg Pudeyev
0501640d5d [feature/template-engine] Added phpbb_template_context class.
Objects of this class hold variables assigned to templates.

PHPBB3-9726
2011-05-07 17:47:02 -04:00
Oleg Pudeyev
d8122df332 [feature/template-engine] Always call ob_end_clean.
We have to stop output buffering even when rendering fails.

PHPBB3-9726
2011-05-05 19:03:46 -04:00
Oleg Pudeyev
d06e59f63b [feature/template-engine] Split template execution logic into classes.
Template executor interface defines a template executor object.
It is an object which can execute (i.e. display/render) a template.
Currently there are two implementations:

 * phpbb_template_executor_include includes php code from a file.
 * phpbb_template_executor_eval eval's php code.

PHPBB3-9726
2011-05-04 01:21:44 -04:00
Oleg Pudeyev
237deb12ce [feature/template-engine] Removed storedb-related logic.
phpBB 3.1 will not provide the option to store templates in the database.

This commit removes code that handles templates stored in database
from the template engine.

PHPBB3-9726
2011-05-04 00:09:39 -04:00
Oleg Pudeyev
87832d06cc [feature/template-engine] Delete template class, use phpbb_template instead.
PHPBB3-9726
2011-05-04 00:08:20 -04:00
Oleg Pudeyev
48691b53a6 [feature/template-engine] Rename template_compile methods for clarity.
PHPBB3-9726
2011-05-04 00:07:58 -04:00
Oleg Pudeyev
234b891a4b [feature/template-engine] Fixed description of assign_display().
This function returns false on failure, which can happen if
display() failed. Document the failure return value.

PHPBB3-9726
2011-05-01 03:14:11 -04:00
Oleg Pudeyev
c844a277b2 [feature/template-engine] Check return value of display() in assign_display().
If display() failed, propagate the failure out of assign_display().

PHPBB3-9726
2011-05-01 03:09:49 -04:00
Oleg Pudeyev
909ee59871 [feature/template-engine] Removed $this from new phpbb_template_compile calls.
The compile class no longer takes template as a parameter.

PHPBB3-9726
2011-04-26 22:19:04 -04:00
Oleg Pudeyev
5c3ebb3465 [feature/template-engine] Deleted silencing of notices.
The code is now supposed to be notice-free, therefore there is no need
to have the notices silenced.

PHPBB3-9726
2011-04-24 21:22:43 -04:00
Oleg Pudeyev
a2c75f6053 [feature/template-engine] Deleted $template from phpbb_template_compile class.
phpbb_template_compile is now much simpler. It takes complete file paths
as inputs, either source template path or source template path and output
compiled template path. The number of methods also went down to two -
compile template and returned compiled text or compile and write to file.

phpbb_compile class is responsible for determining source and compiled
paths. It already had all the data necessary for this, now the code is
in the same place as the data it uses.

PHPBB3-9726
2011-04-24 21:18:18 -04:00
Igor Wiedler
81962d1d8f [ticket/9924] Pass template instance into $template->display hook
This is a cherry-pick of 053cf790a9
which appears to have been partially reverted here.

PHPBB3-9924
2011-04-24 11:23:46 -04:00
Oleg Pudeyev
c8db531fcb [feature/template-engine] Removed a useless space.
PHPBB3-9726
2011-04-24 01:59:40 -04:00
Oleg Pudeyev
321ecf4273 [feature/template-engine] Delete class_exists checks, rely on autoloading.
PHPBB3-9726
2011-04-24 01:18:58 -04:00
Oleg Pudeyev
203187a841 [feature/template-engine] Fix recompilation logic.
Do not change $recompile from true to false - any recompilation
condition alone is sufficient to force recompilation.

Also uncomment the nonexistent file test which passes with this fix.

PHPBB3-9726
2011-04-24 01:08:48 -04:00
Oleg Pudeyev
4f3e966fdc [feature/template-engine] Delete ?>, add newline at EOF.
PHPBB3-9726
2011-04-23 22:49:08 -04:00
Marek A. Ruszczynski
2d11e1c095 [feature/template-engine] Improved template engine.
PHPBB3-9726
2011-04-23 22:49:02 -04:00
Nils Adermann
8b9b1f1187 Merge branch 'develop-olympus' into develop
* develop-olympus:
  [ticket/9924] Pass template instance into $template->display hook
2010-12-13 17:22:05 +01:00
Igor Wiedler
053cf790a9 [ticket/9924] Pass template instance into $template->display hook
PHPBB3-9924
2010-11-23 16:09:09 +01:00
Igor Wiedler
af5b9a9640 [ticket/9556] Drop php closing tags, add trailing newline
Closing tags converted using Oleg's script.
remove-php-end-tags.py -a .

Trailing newlines added using the following where $ext is file extension.
find . -type f -name "*.$ext" -print | xargs printf "e %s\nw\n" | ed -s;

Extensions: php, css, html, js, xml.

PHPBB3-9556
2010-11-11 19:10:55 +01:00
Nils Adermann
6e31ce8573 Do not store email templates in database. [Bug #54505]
To explain what this is about, first a short phpBB code history lesson: ;-)

r9823 originally introduced the usage of our template class for emails. The
messenger class uses set_custom_template() to initialise the template object
which neither disables storedb nor inheritance. These two values are set in
$user->theme rather than inside a particular template instance (quite a design
failure if I may add). Thus the html page that is displayed to the user also
determines these settings for the email templates. This obviously causes
problems because both emails and other custom templates can quite simply not
be stored in the database because the db table only stores the filename, not
the path and requires a template id.

r9839 then generally disabled storedb and template inheritance for custom
templates to fix Bug #40515. This works for custom templates, but not for
emails where lots of template objects are created. In such a situation the
last call to set(_custom)_template() would now determine the values of storedb
and inheritance in _tpl_load. So any page sending emails would neither load
its template from the database nor use template inheritance. The same revision
also introduced orig_tpl_* variables in set_template() which on their own are
very much pointless, but could allow resetting the storedb and inheritance
values if they were used to reset $user->theme just before template execution
in _tpl_load.

In r10150 these orig_tpl_* variables are correctly used to access information
about the template of the page being displayed - contrary to the last template
used - from within the bbcode, fixing Bug #51285. However r10150 also introduces
a pointless $template_mode parameter for set_custom_template(). $template_mode
is really just a boolean flag (value you can be 'template' or an arbitrary other
value) that if it set circumvents the unsetting of storedb and template
inheritance. The very code that had been added to prevent issues with emails and
custom templates. Fixing the problem introduced by r8839 but at the same time
reintroducing the much greater problem from the original implementation of email
templates.

And now an explanation of what I did:

Based on this I have now changed the set_custom_template method to always
disable storedb. It can now properly use inheritance, you simply tell it the
path where the parent template can be found, by default the path is false which
will turn inheritance off. To make this work the template class now always
overwrites $user->theme storedb and inheritance variabbles with orig_tpl_* just
before rendering a template in _tpl_load. This way they are guaranteed to always
contain the value they had at the time set_template/set_custom_template were
called. This fixes [Bug #54505].

In summary, using global state is simply a horrible idea in object oriented
programming. Always Pass values, that an object depends on, as parameters - never
through magic global variables. Following this principle will safe you from a lot
of headaches.

Please test this patch as much as possible to make sure templates still work
properly for you, focus on multiple languages, missing language files, and
custom templates in systems that make use of the template class outside of
phpBB itself.


git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@10460 89ea8834-ac86-4346-8a33-228a782c2dd0
2010-01-26 16:52:46 +00:00
Meik Sievertsen
9ccd209930 fix bug #52605 - regression from r9811
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@10217 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-10-09 11:12:37 +00:00
Meik Sievertsen
d5fe2e7db7 bugfix for non-existent handles and theme data (we really need to clean this up, template_files feels quite furry)
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@10213 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-10-05 16:22:21 +00:00
Joas Schilling
697fd5a134 Fix #51285 and more issues with template inherence on set_custom_template
Conflict introduced with r9839 and r9823

Authorised by: AcydBurn

git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@10150 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-09-16 08:11:52 +00:00
Meik Sievertsen
edc5061f1d Check for valid $template_path in includes/template.php - Bug #50055
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@10036 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-08-20 14:53:25 +00:00
Chris Smith
b902fc20ae Small change to r9839
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@9847 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-07-25 10:16:13 +00:00
Joas Schilling
89332c00b7 Fix Bug #40515 - Fix set_custom_template for database-stored styles
Authorised by: AcydBurn



git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@9839 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-07-24 08:47:10 +00:00
Meik Sievertsen
b613781d3a Preserve newlines in template files (one newline had been always dropped after a template variable due to PHP's handling of closing tags)
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@9811 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-07-21 10:58:31 +00:00
Joas Schilling
7d605da65b Fix bug #45805 - INCLUDEPHP not depending on phpbb_root_path
Authorised by: acydburn

git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@9633 89ea8834-ac86-4346-8a33-228a782c2dd0
2009-06-19 22:07:27 +00:00
Meik Sievertsen
2bf9ea373b Fix problems with styles using an underscore within the filename. (Bug #34315)
- Also display inheriting template on style installation (previously, it was only displayed on template installs)
- Fixes undefined variable in error message if inheriting style does not work
- Fixes export of styles/templates and correctly set inherit_from variable

git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@8943 89ea8834-ac86-4346-8a33-228a782c2dd0
2008-09-26 13:09:56 +00:00
Henry Sudhof
eda1d40861 Okay. Frozen, we never said anything about it being permafrost. Also, this is not 100% tested, expect troubel with store_db (I'm waiting for the bug reports)
git-svn-id: file:///svn/phpbb/branches/phpBB-3_0_0@8697 89ea8834-ac86-4346-8a33-228a782c2dd0
2008-07-28 14:24:37 +00:00
Meik Sievertsen
07f6a6b5f3 - fixed database updater
- fixed hook function call in database updater
- fixed bot agent detection (we used a wildcard within the w3c-agent, therefore we should really support this. ;))


git-svn-id: file:///svn/phpbb/trunk@8131 89ea8834-ac86-4346-8a33-228a782c2dd0
2007-10-04 12:03:05 +00:00
Meik Sievertsen
8d2bfa5c10 ok... i seem to have overlooked the handy __CLASS__ constant. ;)
git-svn-id: file:///svn/phpbb/trunk@8106 89ea8834-ac86-4346-8a33-228a782c2dd0
2007-09-23 14:14:49 +00:00
Meik Sievertsen
91f5af494b PHP4 compatibility
git-svn-id: file:///svn/phpbb/trunk@8104 89ea8834-ac86-4346-8a33-228a782c2dd0
2007-09-23 13:14:28 +00:00
Meik Sievertsen
7f65bc98ad new hook system (do not get it confused with events or plugins please)
- introducing two new hookable functions too


git-svn-id: file:///svn/phpbb/trunk@8100 89ea8834-ac86-4346-8a33-228a782c2dd0
2007-09-22 19:18:13 +00:00