Joomla! Documentation - User contributions [en]

Enabling Search Engine Friendly (SEF) URLs on IIS

2010-08-23T03:03:19Z

Petergeier: /* Helicon ISAPI Rewrite */

Under IIS7, a native URL Rewite module is available. It stores rules in a site's web.config file, expressed in XML format. .htaccess rules can be converted to the web.config format.

Under IIS6, a third-party add-on must be used. Helicon provides one which directly supports .htaccess rules.

==IIS 7 URL Rewriting==
If you have a server running IIS 7 and PHP, you can take advantage of IIS's own internal URL rewriting by using a web.config file similar to the one listed below.

You can create the file yourself or use the GUI in the IIS7 Manager. You can import .htaccess rules using the GUI/wizard.

This functionality depends on the presence of the '''IIS URL Rewrite Module''', which does not come with Windows. It is a free download and a Microsoft product.

===GUI===
If the IIS URL Rewrite module is installed, your website manager will have a tool for "URL Rewrite", visible in the IIS Manager's view of your site's configurable IIS modules. The interface is largely self-explanatory. Regular expressions, wildcards or exact matches are all supported.

===web.config===
This has been tested on Joomla 1.5 with IIS 7 on Windows Server 2008 with no problems so far. For more information on converting .htaccess to web.config, check out http://learn.iis.net/page.aspx/557/translate-htaccess-content-to-iis-webconfig/

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<rewrite>
<rules>
<clear />
<rule name="Common Exploit Blocking" stopProcessing="true">
<match url="^(.*)$" />
<conditions logicalGrouping="MatchAny">
<add input="{QUERY_STRING}" pattern="mosConfig_[a-zA-Z_]{1,21}(=|\%3D)" />
<add input="{QUERY_STRING}" pattern="base64_encode.*$.*$" />
<add input="{QUERY_STRING}" pattern="(\<|%3C).*script.*(\>|%3E)" />
<add input="{QUERY_STRING}" pattern="GLOBALS(=|\[|\%[0-9A-Z]{0,2})" />
<add input="{QUERY_STRING}" pattern="_REQUEST(=|\[|\%[0-9A-Z]{0,2})" />
</conditions>
<action type="Redirect" url="index.php" appendQueryString="false" redirectType="SeeOther" />
</rule>
<rule name="Joomla Search Rule" stopProcessing="true">
<match url="(.*)" ignoreCase="true" />
<conditions logicalGrouping="MatchAll">
<add input="{URL}" pattern="^/search.php" ignoreCase="true" />
</conditions>
<action type="Rewrite" url="/index.php?option=com_content&view=article&id=4" />
</rule>
<rule name="Joomla Main Rewrite Rule" stopProcessing="true">
<match url="(.*)" ignoreCase="true" />
<conditions logicalGrouping="MatchAll">
<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
<add input="{URL}" pattern="(/|\.php|\.html|\.htm|\.feed|\.pdf|\.raw|/[^.]*)$" />
</conditions>
<action type="Rewrite" url="index.php/" />
</rule>
</rules>
</rewrite>
<caching>
<profiles>
<add extension=".php" policy="DisableCache" kernelCachePolicy="DisableCache" />
</profiles>
</caching>
</system.webServer>
</configuration>

</source>

==Helicon ISAPI Rewrite==
Helicon ISAPI Rewrite 3 located at http://www.helicontech.com/isapi_rewrite/ now provides near identical mod_rewrite functionality.

IIS 7 has its own rewrite module now, the URL Rewrite which works excellent and doesn't require third party installs. It can be enabled
through the Web Platform Installer. In the Joomla config turn on both the SEF and Apache mod_rewrite, next create a rule under IIS URL Rewrite:
Pattern field: '''^([^/]+)/?$'''
Ignore case '''ON'''
Action type: '''Rewrite'''
Rewrite URL: '''index.php/'''

The default rewrite rules can be used and the following code inserted to the top of the index.php file:

<source lang="php">
if (isset($_SERVER['HTTP_X_REWRITE_URL']))
{
$_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
}
</source>

----

First job is to install ISAPI rewriter of your choice
http://www.isapirewrite.com/ or http://cheeso.members.winisp.net/IIRF.aspx

ISAPI ReWrite has a lite version (limited) and IIRF (IonicIsapiRewriter) is freeware always updated and the source is free!

Both are configured via file IsapiRewrite4.ini (you dont need to worry about .htaccess.txt ignore it). (if you are using IIRF IonicIsapiRewriter 2.x see below for a change in filename).

The following entries for ISAPI REWRITE:

<source lang="apache">
RewriteLog D:\temp\iirfLog.out
RewriteLogLevel 3

IterationLimit 10

# Joomla/Mambo rewrite rules
RewriteRule ^/$ /index.php
RewriteRule ^/content/blogsection/([^/]+)/([^/]+)/ /index.php?option=com_content&task=blogsection&id=$1&Itemid=$2
RewriteRule ^/content/blogcategory/([^/]+)/([^/]+)/ /index.php?option=com_content&task=blogcategory&id=$1&Itemid=$2
RewriteRule ^/content/section/([^/]+)/([^/]+)/ /index.php?option=com_content&task=section&id=$1&Itemid=$2
RewriteRule ^/component/option,([^/]+)/([^/]+),([^/]+)/([^/]+),([^/]+)/([^/]+),([^/]+) /index.php?option=$1&$2=$3&$4=$5&$6=$7
RewriteRule ^/component/option,([^/]+)/([^/]+),([^/]+)/([^/]+),([^/]+) /index.php?option=$1&$2=$3&$4=$5
RewriteRule ^/component/option,([^/]+)/([^/]+),([^/]+)/ /index.php?option=$1&$2=$3
RewriteRule ^/content/category/([^/]+)/([^/]+)/([^/]+)/ /index.php?option=com_content&task=category&sectionid=$1=&id=$2&Itemid=$3
RewriteRule ^/content/view/([^/]+)/([^/]+)/([^/]+)/([^/]+)/ /index.php?option=com_content&task=view&id=$1&Itemid=$2&limit=$3&limitstart=$4
RewriteRule ^/content/view/([^/]+)/([^/]+)/ /index.php?option=com_content&task=view&id=$1&Itemid=$2
</source>

The following is for IIRF IonicIsapiRewriter 1.x:

<source lang="apache">
IterationLimit 10
</source>

Remark: If you are using IIRF IonicIsapiRewriter Version 2.x you must have a "global" configuration file in the directory where the DLL is and a site specific file (see Artio JoomSEF below as example) in the Joomla root. The filename for 2.x is no longer IsapiRewrite4.ini but changed to Iirf.ini (!)

Example for IirGlobal.ini:
<source lang="apache">
RewriteEngine On
RewriteFilterPriority MEDIUM
StatusUrl /iirfStatus RemoteOk
# Turn NotifyLog off if you can to optimize speed. If you need to log the original URL turn it on.
NotifyLog Off
</source>

Tested and working with ARTIO JoomSEF:

<source lang="apache">
RewriteCond %{HTTP_URL} (/|\.htm|\.php|\.html|/[^.]*)$ [I]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule (.*) /index.php [U,L]
# only use the U of the [U,L] if you have turned "NotifyLog ON" specified in your IirGlobal.ini
MaxMatchCount 10

</source>

Tested and working with default Joomla SEO:

<source lang="apache">
RewriteRule ^/$ /index.php
RewriteRule ^/content/([^/]+)/([^/]+)/([^/]+)/([^/]+)/([^/]+)/ /index.php?option=com_content&task=$1&id=$2&Itemid=$3&limit=$4&limitstart=$5
RewriteRule ^/content/([^/]+)/([^/]+)/([^/]+)/ /index.php?option=com_content&task=$1&id=$2&Itemid=$3
RewriteRule ^/component/option,([^/]+)/([^/]+),([^/]+)/([^/]+),([^/]+)/([^/]+),([^/]+) /index.php?option=$1&$2=$3&$4=$5&$6=$7
RewriteRule ^/component/option,([^/]+)/([^/]+),([^/]+)/ /index.php?option=$1&$2=$3
</source>

Tested and working with sh404SEF:
<source lang="apache">
RewriteLogLevel 4 #Make it 0 in to turn debugging off
RewriteLog c:\IIRfLogfile.log #Write the absolute path of your file here

MaxMatchCount 10

# don't rewrite any request that goes to administrator
RewriteRule ^/administrator - [L]

RewriteCond %{HTTP_URL} (/|\.htm|\.php|\.html|!administrator|/[^.]*)$
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule (.*) /index.php [U,L]
</source>

Other Third party SEO should work once to follow there rewrite conditions/rules.
I run IonicIsapiRewriter-1.2.12b the betas are rock solid and I use it on my production servers with no issues.
Please follow vendors installation instructions to get the ISAPI filter working on your IIS server.

<noinclude>[[Category:IIS]][[Category:Tips and tricks]][[Category:Tips and tricks 1.0]][[Category:Tips and tricks 1.5]]</noinclude>

J1.5 talk:Triggering content plugins in your extension

2010-07-15T17:34:06Z

Petergeier:

== Problem with PHP 5.3 when using this example: ==
PHP Warning: Parameter 2 to plgContent<MostPlugins>::onPrepareContent() expected to be a reference,
value given in <whichever plugin cause that> on line <xx>

As of PHP 5.3.0, you will get a warning saying that "call-time pass-by-reference" is deprecated when you use & in foo(&$a);
See http://php.net/manual/en/language.references.pass.php

The Example.php in content shows (now wrongly and deprecated in PHP 5.3):

<source lang="php">
$dispatcher->trigger('onPrepareContent', array (& $item, & $item->params, 0));
or could be: function onPrepareContent( &$article, '''&'''$params, $limitstart );
</source>

SHOULD now be:

<source lang="php">
$dispatcher->trigger('onPrepareContent', array (& $item, $item->params, 0));
or could be: function onPrepareContent( &$article, $params, $limitstart );
</source>

'''FIX:'''
-> Going into JOOMLA root and do a global replace through all PHP files will fix this issue.

Furthermore (somewhat related) if you getting the following error:
Warning: Missing argument 3 for plgContent<PluginName>::onPrepareContent()
in JOOMLA\plugins\content\<PluginName.php> on line xx''

you may also want to change in file JOOMLA\modules\mod_customcontent\helper.php:
<source lang="php">
line 36, change the array to: array (& $item, & $params, $limitstart ))
</source>

Ref: joomlacode.org/gf/project/ianstools/tracker/?action=TrackerItemEdit&tracker_item_id=10578

Not sure why this did not make the 1.5.15 ... 1.5.18 releases.

J3.x:Triggering content plugins in your extension

2010-07-15T17:30:20Z

Petergeier:

[[Category:Development]]
[[Category:Plugins]]

Using the plugin system in your addon is fairly simple. The most important part is good planning because, to some degree, you're defining an interface for other people to use.

To activate the plugins for your addon, you just have to use the following code:
<source lang="php">
$dispatcher =& JDispatcher::getInstance();
$results = $dispatcher->trigger('onSomething', $params);
</source>
This function calls everyplugin that has registered itself for the event 'onSomething' and hands over the array $param as parameter.

As a return value you get an array of results from these plugins. All this is of course optional, you could also use the system without parameters and/or a result.

You can also pass arguments by reference to allow plugins to edit the passed data. For example:
<source lang="php">
$dispatcher =& JDispatcher::getInstance();
$dispatcher->trigger('onSomething', &$params);
</source>

A common usage might be to use the content plugins if you have an editable field. This is the code that will do that:

<source lang="php">
$dispatcher =& JDispatcher::getInstance();
$item->text = & your_text_area_item;
$item->params = clone($params);
JPluginHelper::importPlugin('content');
$dispatcher->trigger('onPrepareContent', array (& $item, & $item->params, 0));
</source>

You might want to look at core components (for example com_content) for an example.

Also for PHP5.3 compliance please look at the discussion page.

J3.x:Triggering content plugins in your extension

2010-07-15T17:29:52Z

Petergeier:

[[Category:Development]]
[[Category:Plugins]]

Using the plugin system in your addon is fairly simple. The most important part is good planning because, to some degree, you're defining an interface for other people to use.

To activate the plugins for your addon, you just have to use the following code:
<source lang="php">
$dispatcher =& JDispatcher::getInstance();
$results = $dispatcher->trigger('onSomething', $params);
</source>
This function calls everyplugin that has registered itself for the event 'onSomething' and hands over the array $param as parameter.

As a return value you get an array of results from these plugins. All this is of course optional, you could also use the system without parameters and/or a result.

You can also pass arguments by reference to allow plugins to edit the passed data. For example:
<source lang="php">
$dispatcher =& JDispatcher::getInstance();
$dispatcher->trigger('onSomething', &$params);
</source>

A common usage might be to use the content plugins if you have an editable field. This is the code that will do that:

<source lang="php">
$dispatcher =& JDispatcher::getInstance();
$item->text = & your_text_area_item;
$item->params = clone($params);
JPluginHelper::importPlugin('content');
$dispatcher->trigger('onPrepareContent', array (& $item, & $item->params, 0));
</source>

You might want to look at core components (for example com_content) for an example.
Also for PHP5.3 compliance please look at the discussion page.

J1.5 talk:Triggering content plugins in your extension

2010-07-15T17:27:44Z

Petergeier:

== Problem with PHP 5.3 when using this example: ==
PHP Warning: Parameter 2 to plgContent<MostPlugins>::onPrepareContent() expected to be a reference,
value given in <whichever plugin cause that> on line <xx>

As of PHP 5.3.0, you will get a warning saying that "call-time pass-by-reference" is deprecated when you use & in foo(&$a);
See http://php.net/manual/en/language.references.pass.php

The Example.php in content shows (now wrongly and deprecated in PHP 5.3):

''function onPrepareContent( &$article, '''&'''$params, $limitstart )''

but it SHOULD be:

''function onPrepareContent( &$article, $params, $limitstart )''

'''FIX:'''
-> Going into JOOMLA root and do a global replace through all PHP files will fix this issue.

Furthermore (somewhat related) if you getting the following error:
Warning: Missing argument 3 for plgContent<PluginName>::onPrepareContent()
in JOOMLA\plugins\content\<PluginName.php> on line xx''

you may also want to change in file JOOMLA\modules\mod_customcontent\helper.php:
line 36, change the array to: array (& $item, & $params, $limitstart ))

Ref: joomlacode.org/gf/project/ianstools/tracker/?action=TrackerItemEdit&tracker_item_id=10578

Not sure why this did not make the 1.5.15 ... 1.5.18 releases.

J1.5 talk:Triggering content plugins in your extension

2010-07-15T17:13:40Z

Petergeier: onPrepareContent() example problem: "call-time pass-by-reference" is deprecated for second parameter

== Problem with PHP 5.3 when using this example: ==
PHP Warning: Parameter 2 to plgContent<MostPlugins>::onPrepareContent() expected to be a reference,
value given in <whichever plugin cause that> on line <xx>

As of PHP 5.3.0, you will get a warning saying that "call-time pass-by-reference" is deprecated when you use & in foo(&$a);
See http://php.net/manual/en/language.references.pass.php

The Example.php in content shows (now wrongly and deprecated in PHP 5.3):

''function onPrepareContent( &$article, '''&'''$params, $limitstart )''

but it SHOULD be:

''function onPrepareContent( &$article, $params, $limitstart )'

'''FIX:'''
-> Going into JOOMLA root and do a global replace through all PHP files will fix this issue.

Furthermore (somewhat related) if you getting the following error:
Warning: Missing argument 3 for plgContent<PluginName>::onPrepareContent()
in JOOMLA\plugins\content\<PluginName.php> on line xx''

you may also want to change in file JOOMLA\modules\mod_customcontent\helper.php:
line 36, change the array to: array (& $item, & $params, $limitstart ))

Ref: joomlacode.org/gf/project/ianstools/tracker/?action=TrackerItemEdit&tracker_item_id=10578

Not sure why this did not make the 1.5.15 ... 1.5.18 releases.