manuelcillero/suitedesk
manuelcillero/suitedesk
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

New module path_alias_xt

Browse source
This commit is contained in:
Manuel Cillero 2017-07-25 12:31:48 +02:00
parent 4824608a33
commit d3aeafdc7e
6 changed files with 824 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
modules/path_alias_xt/CHANGELOG.txt Normal file
View file

@ -0,0 +1,33 @@
Changelog for Extended Path Aliases module for drupal 6.
6.x-1.0-alpha1
==============
Initial release
6.x-1.0-alpha2
==============
Remove reliance on custom_url_rewrite_outbound(), so that the module will work
with Domain Access.
6.x-1.0-alpha3
==============
Added line to admin/reports/status showing whether PECL runkit library is installed.
6.x-1.0-alpha4
==============
Updated code comments and README.txt
6.x-1.0-beta1
=============
More comments to code and README.txt
Feature request [#766876]
6.x-1.0-beta2
=============
Updated README [#787418] (thanks: Ken Hawkins)
6.x-1.1
=======
Feature request [#808438]
Feature request [#791950]

339
modules/path_alias_xt/LICENSE.txt Normal file
View file

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

173
modules/path_alias_xt/README.txt Normal file
View file

@ -0,0 +1,173 @@
DESCRIPTION
===========
This module completes the job left unfinished by Drupal's Path module.
The module extends Drupal's path alias system by automatically applying
user-friendly page aliases not only to the base URL, e.g. "about-us" (for
"node/123"), but also to any of the common extensions of the base URL, e.g.
"about-us/edit", "about-us/track", "about-us/revisions*" etc.
The extended aliases may also be used when specifying visibility control for
blocks (e.g. "about-us*"), or in fact anywhere where you are prompted to
specify pages to include or exclude.
NOTE: It is for this feature that you need to follow the INSTALLATION
instructions below. If don't care about this feature just enable the module at
Administer >> Site building >> Modules and you're away.
Requiring no configuration, the module then makes sure that these user-friendly
(and SEO-friendly) aliases are shown everywhere, replacing their system-
generated equivalents, whether it's in the browser address bar or on
the page itself. Examples are the Edit, Track, Revisions etc. tabs, the page
statistics pages as well as any other links on your pages. No more ugly URLs
like node/123/revisons/456/view or user/7/track.
All of this makes everyone's user experience just that little more convenient
across all pages of your site.
INSTALLATION
============
0 If you have a compiled PECL runkit extension file (see notes at the bottom
of this file), put it in the appropriate /extension directory.
The runkit is not mandatory, so if you don't have a runkit.so or
php_runkit.dll file, simply continue at step 1.
With your runkit in place proceed with either step a) or b) (preferred).
a) In file path_alias_xt, find the line //dl('runkit.so'). Remove the
leading double slashes.
Or
b) Edit your php.ini. You can use drupal page /admin/reports/status/php to
locate the "Configuration File Path". It's near the top of the page and
usually equals something like /etc/php5/apache2.
Add this line to the other extension lines in your php.ini:
extension = runkit.so
Note: for Windows the correct line is "extension = php_runkit.dll".
By the way, while you're down there, check that your php.ini has:
error_reporting = E_ALL
display_errors = On
This ensures that if any "white screens of death" occur, these will at
least display a clue as to what's going on.
1. As with any other module, uncompress the tar-ball, path_alias_xt.tar.gz, into
the "sites/all/modules" subdirectory.
2. Just in case, if you are installing to a live site, put the site off-line at
Site configuration >> Site maintenance. You will only need about 60 seconds.
3. Visit Site building >> Modules to enable the path_alias_xt module. Press
"Save configuration".
At this point your extended path aliases should have started to work for
the majority of pages.
However to get block visibility wildcards to work you need to complete
either step 4a or 4b.
4a.If you have placed the runkit extension in the /extension directory and have
edited your php.ini as per step 0b, you now restart your Drupal stack (or
just Apache). If you did step 0a, no restart should be necessary.
In either case, verify the runkit has been loaded at /admin/reports/status or
at /admin/reports/status/php.
When you scroll down the page you should see a section on runkit.
4b.If you did not install the runkit extension file, you need to edit file
"inlcudes/path.inc" using any plain text editor. In this file find the
following line (#109 ?):
function drupal_get_path_alias($path, $path_language = '') {
Immediately below this line insert:
if (module_exists('path_alias_xt')) {
return path_alias_xt_get_path_alias($path, $path_language);
}
5. Put your site back on line at Site configuration >> Site maintenance.
CONFIGURATION
=============
None, you're done.
USAGE
======
Users create and use aliases for nodes as per normal, i.e. via the
"URL path settings" fieldset on the Edit form. Or if you have PathAuto enabled
URL aliases for the base page are created automatically.
Let's say someone introduced "about-us" as an alias for some node, say the
system assigned node/123 to it. Whenever specifying page filters, for instance
on the page-specific visibility settings of a block's configuration page,
Site building >> Blocks >> configure, users may now type "about-us/edit",
"*about-us*" etc. rather than node/123/edit, node/123* etc.
When the system displays pages of the form "node/123/..", "about-us/.." will
be shown in the address bar instead. Plus all tabs and links on your pages are
human-readable and SEO-friendly to boot!
UNINSTALL
=========
You may disable path_alias_xt at any time, without reverting the change you've
made to path.inc, as that code auto-detects whether path_alias_xt is enabled or
not.
If you used the PECL runkit, you may want to put a semi-colon in front of the
"extension = runkit.so" line in your php.ini, so that the kit will no longer be
loaded.
CAVEATS
=======
You may run into difficulties when using this module in combination with a
module that also implements custom_url_rewrite_inbound(). There aren't many
around though, so on the vast majority of systems everything should be fine.
A generic solution would probably involve the url_alter module, which means an
extra dependency as well as more complex code. I like to keep things simple.
You should be able to use Extended Path Aliases with Domain Access, as this
module only implements custom_url_rewrite_outbound(), which is not required by
path_alias_xt.
HOW TO OBTAIN THE PECL RUNKIT EXTENSION LIBRARY
===============================================
There are some copies of runkit.so and php_runkit.dll lying about on the
internet, but most of them are old (i.e. version 0.9) and will NOT work with
PHP 5.2.x or 5.3.x. You're likely to get a white screen of death.
Check this issue for a PECL runkit library for your OS: http://drupal.org/node/760758
If there isn't one suitable for your system, you may have to compile the PECL
runkit (version 1.0) yourself, see below.
Mac/Unix/Linux
--------------
Mac users, in order for the following commands to work sign up as an Apple
Developer (free at http://developer.apple.com/programs/register), then download
and install the Xcode developer package comptabile with your OS. In addition, if
you use a MAMP stack, you may also want to point it to the Xcode header files:
$ ln -s /Developer/SDKs/MacOSX10.5.sdk/usr/include /Applications/MAMP/bin/php5/include
If not on a Mac make sure that the following commands exist on your system:
svn, php, phpize.
If not, you can install them with a command like the following (for Ubuntu) or
similar:
$ sudo apt-get install subversion php5-cli php5-dev
Now make sure you're machine is connected to the internet. Then:
$ svn co http://svn.php.net/repository/pecl/runkit/trunk runkit
$ cd runkit
$ phpize
$ ./configure
$ make
For the final step, on MAMP:
$ cp modules/runkit.so /Applications/MAMP/bin/php5/lib/php/extensions/no-debug-non-zts-20060613 (or similar number)
Whereas on most other flavours of Unix/Linux you'd go:
$ sudo make install
This *should* place runkit.so in the correct extension directory, usually
something like /usr/lib/php5/20060613. The "extension_dir" directive
should match this by default. You can verify the active "extension_dir" on the
/admin/reports/status/php page. If it doesn't match, edit your php.ini.
Windows
-------
To compile a PECL extension on Windows see for instance:
http://blog.renangoncalves.com/2010/01/15/how-to-compile-a-pecl-extension-on-windows

13
modules/path_alias_xt/path_alias_xt.info Normal file
View file

@ -0,0 +1,13 @@
name = Extended Path Aliases
description = Automatically extend path aliases to include tabs, like "about-us/edit" for "node/123/edit". Allow these aliases to be entered in page specification wild-cards ("about-us*"), e.g for block visibility.
core = "6.x"
; While you will need to enable the core Path module to enter aliases,
; programmatically path_alias_xt has no dependency on it. Existing aliases
; will continue to be auto-extended, even if Path is disabled later on.
; Information added by drupal.org packaging script on 2013-10-23
version = "6.x-1.3"
core = "6.x"
project = "path_alias_xt"
datestamp = "1382565626"

39
modules/path_alias_xt/path_alias_xt.install Normal file
View file

@ -0,0 +1,39 @@
<?php
/**
* @file
* Install and uninstall hooks for path_alias_xt module.
*/
/**
* Implementation of hook_requirements().
*/
function path_alias_xt_requirements($phase) {
$t = get_t();
$has_runkit = function_exists('runkit_function_redefine');
$requirements['path_alias_xt'] = array(
'title' => $t('PECL runkit (for Extended Path Aliases)'),
'value' => $has_runkit ? $t('Installed') : $t('Not installed'),
);
if (!$has_runkit) {
$requirements['path_alias_xt']['severity'] = REQUIREMENT_INFO;
$requirements['path_alias_xt']['description'] = $t('Reminder: as the PECL runkit is not installed, please edit file %path-inc if you have not done so already. See the !README file for details.',
array('%path-inc' => 'include/path.inc',
'!README' => '<a href=/'. drupal_get_path('module', 'path_alias_xt') .'/README.txt>README</a>'));
}
return $requirements;
}
/**
* Implementation of hook_install().
*/
function path_alias_xt_install() {
return;
}
/**
* Implementation of hook_uninstall().
*
function path_alias_xt_uninstall() {
}
*/

227
modules/path_alias_xt/path_alias_xt.module Normal file
View file

@ -0,0 +1,227 @@
<?php
/**
* @file
* Extended Path Aliases.
*
* Automatically generates and recognises aliases beyond the base path, e.g.
* generates and accepts "about-us/edit" for "node/123/edit" and "user/rik/track"
* for "user/7/track".
* These aliases may be used anywhere where you are prompted to enter page
* specifications, including wildcards, like "about-us*".
* Examples of modules and pages that particularly benefit are:
* o any page displaying a revision or links to revisions
* o any page with View, Edit, Track etc tabs
* o the tabs on the "My account" page, Edit, Track etc.
* o Statistics on top visited pages etc.
* o the page-specific block visibility settings at Site building >> Blocks >> configure
* o same for any other module that has an include/exclude pages input box, e.g
* the Smart menus, Smart tabs modules
*/
define('PATH_ALIAS_XT_DEFAULT_NODE_OR_USER_MATCH', '{(^node|^user)/([0-9]+)/(.*)}');
/**
* Implementation of hook_boot().
*
* The mere presence of this empty-bodied hook, guarantees that the functions
* in this module, in particular custom_url_rewrite_inbound, are known to core
* just in time. Important for path.inc/drupal_get_normal_path().
*/
function path_alias_xt_boot() {
return;
}
/**
* Implementation of hook_help().
*/
function path_alias_xt_help($path, $arg) {
switch ($path) {
case 'admin/help#path_alias_xt':
$s = t('Installation instructions are in the README.txt file. Further documentation is on the <a href="@path_alias_xt">Extended Path Aliases</a> project page.',
array('@path_alias_xt' => url('http://drupal.org/project/path_alias_xt')));
break;
}
return empty($s) ? '' : '<p>'. $s .'</p>';
}
/**
* Implementation of hook_menu().
*
* Define configuration options for Extended Path Aliases.
*/
function path_alias_xt_menu() {
$items['admin/settings/path_alias_xt'] = array(
'title' => 'Extended path aliases',
'description' => 'Advanced settings',
'page callback' => 'drupal_get_form',
'page arguments' => array('_path_alias_xt_admin_settings'),
'access arguments' => array('administer site configuration'),
);
return $items;
}
/**
* Menu callback for admin settings.
*/
function _path_alias_xt_admin_settings() {
$form['path_alias_xt_regex_pattern'] = array(
'#type' => 'textfield',
'#title' => t('Regular expression to match node and user internal paths'),
'#default_value' => variable_get('path_alias_xt_regex_pattern', PATH_ALIAS_XT_DEFAULT_NODE_OR_USER_MATCH),
'#description' => t("While you can always reset this configuration without permanent damage to your site, a change to this expression may break all extended aliases. Change only when you know what you're doing.")
);
return system_settings_form($form);
}
/**
* This is used to override the call drupal_get_path_alias(), which occurs
* for instance in the block.module. There is no hook available for this.
*
* @param $path
* @param $path_language
* @return string
* The alias for $path or $path if no alias was found.
*/
function path_alias_xt_get_path_alias($path, $path_language = '') {
global $user;
if (preg_match('{^user/([0-9]+)\z}', $path, $matches) && $matches[1] == $user->uid) {
// For logged-in user rather than applying 'user/%' alias, return 'user'
// alias, if it exists.
if ($user_alias = drupal_lookup_path('alias', 'user', $path_language)) {
return $user_alias;
}
}
if ($alias = drupal_lookup_path('alias', $path, $path_language)) {
return $alias;
}
$pattern = variable_get('path_alias_xt_regex_pattern', PATH_ALIAS_XT_DEFAULT_NODE_OR_USER_MATCH);
if (preg_match($pattern, $path, $matches)) {
// $matches[0] equals $path, eg 'node/123/edit'
// $matches[1] will equal either 'node' or 'user'
// $matches[2] will be either the node or user id, e.g '123'
// $matches[3] is the path extension, e.g. 'edit'
if ($matches[1] == 'user' && $matches[2] == $user->uid) {
// For logged-in user rather than applying 'user/%' alias, return 'user'
// alias, if it exists.
if ($user_alias = drupal_lookup_path('alias', 'user', $path_language)) {
return "$user_alias/$matches[3]";
}
}
if ($alias = drupal_lookup_path('alias', "$matches[1]/$matches[2]", $path_language)) {
return "$alias/$matches[3]";
}
}
return $path;
}
/**
* Implementation of pseudo-hook custom_url_rewrite_inbound().
*
* Because we modify drupal_get_path_alias(), we also have to implement the
* complimentary action in drupal_get_normal_path().
* Fortunately, while drupal_get_path_alias() can't be overridden,
* drupal_get_normal_path() does let us override its behaviour by implementing
* custom_url_rewrite_inbound().
*
* @param $result
* The internal path as calculated and passed to us by drupal_get_normal_path().
* When no alternative internal path was found by that function, we apply our
* algorithm to create an internal (aka normal) path.
* @param $path
* The original path or its alias.
* @param $path_language
*
* @see includes/path.inc
*/
function custom_url_rewrite_inbound(&$result, $path, $path_language) {
if (!empty($path) && $result == $path) { // drupal_get_normal_path() did not find an alias
// If the path exists as a menu item (incl. paged views), abort.
if (_path_alias_xt_get_menu_item($path)) {
return;
}
$candidate_alias = $path;
while ($pos = strrpos($candidate_alias, '/')) {
$candidate_alias = substr($candidate_alias, 0, $pos);
if ($src = drupal_lookup_path('source', $candidate_alias, $path_language)) {
if ($src == 'user') {
global $user;
// Insert uid into path
$src .= '/'. $user->uid;
}
$result = $src . substr($path, $pos);
return;
}
}
}
}
function _path_alias_xt_get_menu_item($path) {
return db_result(db_query("SELECT path FROM {menu_router} WHERE path='%s'", $path));
}
/**
* Implementation of pseudo-hook custom_url_rewrite_outbound().
*
* This gets called from url($path). If path_alias_xt has been properly
* installed, i.e. the body of drupal_get_path_alias() has been manually or
* programmatically (PECL runkit) overridden, then this function is effectively
* a NO-OP, as drupal_get_path_alias will have done the work already.
* If Domain Access (or another module implementing it) is enabled, we make sure
* not to implement it here, to avoid a clash. This means that with Domain
* Access enabled, the body of drupal_get_path_alias() should definitely be
* overridden, as described in the README.
*
* @see includes/common.inc
*
* @param $path
* The path as calculated and passed to us by the function url().
* If no alias was found by that function, using drupal_get_path_alias(),
* which we override with a call to path_alias_xt_get_path_alias(), we apply
* our algorithm for assembly of the extended path alias.
* @param $options
* @param $original_path
*/
if (!function_exists('custom_url_rewrite_outbound')) {
function custom_url_rewrite_outbound(&$path, &$options, $original_path) {
if ($path == $original_path) {
$pattern = variable_get('path_alias_xt_regex_pattern', PATH_ALIAS_XT_DEFAULT_NODE_OR_USER_MATCH);
if (preg_match($pattern, $path, $matches)) {
// Provided drupal_get_path_alias() has been overridden to call
// path_alias_xt_get_path_alias() (manually or via the runkit), this code
// won't be reached. It's here just in case the override is omitted.
if ($alias = drupal_lookup_path('alias', "$matches[1]/$matches[2]")) {
// E.g 'node/1/edit' becomes 'about-us/edit', if 'about-us' is an
// alias for 'node/1'.
$path = "$alias/$matches[3]";
}
}
}
}
}
// Purists look away...
// There is no suitable hook to override core's drupal_get_path_alias()
// behaviour. So we either take on the impossible task of rewriting all modules
// that call it, or we redefine its body to make a simple call back to this
// module. We can do this programmatically by taking advantage of the PECL
// runkit extension. The runkit needs to be compiled and placed in the
// /extensions (or /ext) directory pointed to by the extension_dir directive in
// php.ini
// Dynamically load the runkit. This may not be supported on multi-threaded web
// servers.
// If the line below produces an error on your system, comment it out and make
// sure that you have "extension=runkit.so" in your php.ini. Alternatively,
// apply the simple edit to includes/path.inc as described in the README file.
//dl('runkit.so');
function path_alias_xt_init() {
if (function_exists('runkit_function_redefine') /* && function_exists('drupal_get_path_alias')*/) {
$args = '$path, $path_language=""';
$body = 'return path_alias_xt_get_path_alias($path, $path_language);';
runkit_function_redefine('drupal_get_path_alias', $args, $body);
}
}