Dotclear Documentation 2.0:resources

2.0:resources:authentication

Wed, 16 Oct 2013 09:55:25 +0200

1351758894		current
Line 1:		Line 1:
-	====== Authentification ======	+	====== External authentication ======

		+	By default, Dotclear 2 stores user names and passwords in its own database. That said, it can be useful to be able to use another data source for authentication. Dotclear 2 allows this pretty easily.
		+
		+	===== Preamble =====
		+
		+	In its configuration, Dotclear 2 can specify a constant parameter to define the name of the class that will be used for the authentication process.
		+
		+	We just have to define the DC_AUTH_CLASS constant and give it the name of a class you'll create.
		+
		+	===== A new authentication class =====
		+
		+	At the same level that our configuration file, we'll create a file called class.auth.php that will contain the following code:
		+
		+	<code php>
		+	class myDcAuth extends dcAuth
		+	{
		+	}
		+	</code>
		+
		+	In Dotclear configuration file, we'll add the following lines to the end of the file:
		+
		+	<code php>
		+	$__autoload['myDcAuth'] = dirname(__FILE__).'/class.auth.php';
		+	define('DC_AUTH_CLASS','myDcAuth');
		+	</code>
		+
		+	At this stage, our Dotclear installation should keep working. For the moment we simply changed the authentication class and since our new class does nothing, nothing is changed.
		+
		+	<note important>The authentication class must inherits from dcAuth to be used.</note>
		+
		+	===== Scenario =====
		+
		+	For this tutorial, we'll suppose we have a XML-RPC Webservice that can check the validity of an identifier and its password and retrieve user's information.
		+
		+	Here are the specifications of our fake authentication Webservice.
		+
		+	Service URL is %%http://example.com/auth%% and it only has one method auth.login.
		+
		+
		+
		+	This method gets two parameters: a login string for user's identifier and a password string for the password.
		+	It returns a table including user's information or raises an XML-RPC error if there is an error with username or password.
		+
		+	Finally, we'll assume that our installation only contains one blog whom identifier is default.
		+
		+	===== Application =====
		+
		+	For our authentication service, the most important method might be checkUser (from dcAuth class) since this is where all the magic happens. This method can be called in different ways by Dotclear.
		+
		+	It can be called with only the user's identifier. This allows to initialize the information in the class.
		+
		+	It can be called with the user's identifier and a password. This allows not only to initialize the user's info but also to check the password.
		+
		+	Finally, it can be called with an identifier, a null password and a verification key. This allows to check the user's session and to initialize it with a key.
		+
		+	Here is what we're going to do:
		+
		+	* If the checkUser method is called without a password, we forward it to the parent method.
		+	* If the checkUser method is called with a password, we check the password validity and we create or update the user in the database and finally, we forward it to the parent method without a password.
		+
		+	Please note that the user must exist in the database for referential integrity reasons. It is very important to be able to associate posts (or other things) to a given user.
		+
		+	It is also required to store the user's password in Dotclear database because it is needed by some operations. That said, it is possible to forbid a user to change his password.
		+
		+	Here is the commented source code of our new authentication class:
		+
		+	<code php>
		+	class myDcAuth extends dcAuth
		+	{
		+	# User cannot change his password.
		+	protected $allow_pass_change = false;
		+
		+	# Password verificatin method.
		+	public function checkUser($user_id, $pwd=null, $user_key=null)
		+	{
		+	# No password, we call the parent method.
		+	if ($pwd == '') {
		+	return parent::checkUser($user_id,null,$user_key);
		+	}
		+
		+	# If a password is given, we check it with the
		+	# XML-RPC auth.login method.
		+	try
		+	{
		+	# We start a transaction and open a cursor on Dotclear user
		+	# table to create or modify the user.
		+	$this->con->begin();
		+	$cur = $this->con->openCursor($this->user_table);
		+
		+	# We call the password verification method.
		+	# In case of error the process stops and raises an exception.
		+	$client = new xmlrpcClient('http://example.com/auth');
		+	$info = $client->query('auth.login',$user_id,$pwd);
		+
		+	# We define the password, it is inserted in any case.
		+	$cur->user_pwd = $pwd;
		+
		+	# If the user exists, we'll simply update his password
		+	# in Dotclear user table.
		+	if ($this->core->userExists($user_id))
		+	{
		+	$this->sudo(array($this->core,'updUser'),$user_id,$cur);
		+	$this->con->commit();
		+	}
		+
		+	# If the user does not exist, we create him.
		+	# To allow him to connect, we need to give him at least the
		+	# "usage" permission on the "default" blog.
		+	else
		+	{
		+	$cur->user_id = $info['login'];
		+	$cur->user_email = $info['email'];
		+	$cur->user_name = $info['name'];
		+	$cur->user_firstname = $info['firstname'];
		+	$cur->user_lang = $info['lang'] ? $info['lang'] : 'en';
		+	$cur->user_tz = 'Europe/Paris';
		+	$cur->user_default_blog = 'default';
		+
		+	$this->sudo(array($this->core,'addUser'),$cur);
		+	$this->sudo(array($this->core,'setUserBlogPermissions'),
		+	$user_id,'default',array('usage'=>true));
		+	$this->con->commit();
		+	}
		+
		+	# The previous operations went smoothly, we can now call the
		+	# parent method to initialize the user in $core->auth object.
		+	return parent::checkUser($user_id,$pwd);
		+	}
		+	catch (Exception $e)
		+	{
		+	# In case of error, we cancel the transaction and return "false".
		+	$this->con->rollback();
		+	return false;
		+	}
		+	}
		+	}
		+	</code>
		+
		+	<note>Note the use of allow_pass_change property that forbids the user from changing his password.</note>
		+
		+	As you can see, the process is fairly simple to initialize.
		+	A few remarks though:
		+
		+	* It is mandatory to store the user's password in Dotclear user table because Dotclear might need it for some operations.
		+	* It is of course possible to give extra parameters to this piece of code, like the blog and permissions that will be assigned to the user if he doesn't exist yet.
		+	* You can create afterAddUser, afterUpdUser and afterDelUser methods in your authentication class. These methods will be called respectively after the creation, the update or the deletion of a user.
		+
		+	This simple authentication example shows what it is possible to achieve. You can then authentify a user from any source such as a LDAP server, a forum user table, or anything else taking an identifier and a password.
		+
		+	Finally, the dcAuth class can achieve a truly SSO-like unique authentication using these session verification and authentication form change functions.

2.0:resources:coding-standards

Wed, 16 Oct 2013 09:55:25 +0200

1308490702		current
Line 180:		Line 180:
	</note>		</note>

-	===== Code XHTML =====	+	===== XHTML Code =====

	Make sure the XHTML code of your theme or plugin is valid. It is possible to check the validity of the XHTML even if it is not accessible (for example in the administration) thanks to the [[https://addons.mozilla.org/fr/firefox/addon/60\|Web Developer]] extension for Mozilla Firefox.		Make sure the XHTML code of your theme or plugin is valid. It is possible to check the validity of the XHTML even if it is not accessible (for example in the administration) thanks to the [[https://addons.mozilla.org/fr/firefox/addon/60\|Web Developer]] extension for Mozilla Firefox.

2.0:resources:contribute

Mon, 17 Apr 2023 11:15:27 +0200

1681722702		current
Line 9:		Line 9:

	The [[http://lab.dotclear.org/\|Dotclear Lab]] allow contributors to host their creations with a SVN, a wiki and a Trac for all the Dotclear users and also a mailing list dedicated to contributors.		The [[http://lab.dotclear.org/\|Dotclear Lab]] allow contributors to host their creations with a SVN, a wiki and a Trac for all the Dotclear users and also a mailing list dedicated to contributors.
		+	<a href="https://disposablecarts.com/product/fyr-disposable/">fyr-disposable</a>
		+	<a href="https://disposablecarts.com/product/dark-hawk-carts/">dark-hawk-carts</a>
		+	<a href=https://disposablecarts.com/product/primal-carts/">primal-carts</a>
		+	<a href="https://disposablecarts.com/product/boom-carts/">boom-carts</a>
		+	<a href="https://disposablecarts.com/product/springfield-farms-carts/">springfield-farms-carts</a>
		+	<a href="https://disposablecarts.com/product/thc-syrup-for-sale/">thc-syrup-for-sale</a>
		+	<a href="https://disposablecarts.com/product-category/carts/">vape-pen-starter-kit</a>
		+	<a href="https://disposablecarts.com/product/big-chief-carts/">big-chief-carts</a>
		+	<a href="https://disposablecarts.com/product-category/carts/">rechargeable-vape-pens</a>
		+	<a href="https://disposablecarts.com/product-category/carts/">weed-vape-pen</a>
		+	<a href="https://disposablecarts.com/product-category/carts/">cake-vape-pen</a>
		+	<a href=https://disposablecarts.com/product-category/carts/">ooze-vape-pen</a>
		+	<a href="https://disposablecarts.com/product-category/carts/">disco-disposable-carts</a>
		+	<a href="https://disposablecarts.com/product-category/carts/">weed-disposable-cart</a>
		+
		+	<a href="https://disposablecarts.com/" rel="dofollow">runtz disposable cart</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">weed vape cart</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">delta 8 vape cart</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">vape cart pen</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">fyr disposable</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">buy vape cart</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">best cart for sale</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">strong battery carts for sale</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">buy quality carts online</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">vape pen</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">thc carts for sale</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">thc cart</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">disposable carts</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">buy disposable cart online</a>
		+	<a href="https://disposablecarts.com/" rel="dofollow">dmt vape pen</a>

	===== Report bugs or suggest new features =====		===== Report bugs or suggest new features =====

2.0:resources:date-format

Wed, 16 Oct 2013 09:55:25 +0200

1308414411		current
Line 5:		Line 5:

	Here are possible formats:		Here are possible formats:
-

	* %a - abbreviated name of the day of the week (local).		* %a - abbreviated name of the day of the week (local).
Line 29:		Line 28:
	* %t - tab		* %t - tab
	* %T - current time (identical to %H:%M:%S)		* %T - current time (identical to %H:%M:%S)
-	* %u - number of the day in the week, from 1 to 7, 1 being Monday.	+	* %u - day number in the week, from 1 to 7, 1 being Monday.
-	* %U - numnuméro de semaine dans l'année, en considérant le premier dimanche de l'année comme le premier jour de la première semaine.	+	* %U - number of the week in the year, considering the first Sunday of the year as the first day of the first week.
-	* %V - le numéro de semaine comme défini dans l'ISO 8601:1988, sous forme décimale, de 01 à 53. La semaine 1 est la première semaine qui a plus de 4 jours dans l'année courante, et dont lundi est le premier jour.	+	* %V - The week number following ISO 8601:1988 specifications, in a decimal form (01 to 53). Week 1 is the first week that has more than 4 days in the current year and of which Monday is the first day.
-	* %W - numéro de semaine dans l'année, en considérant le premier lundi de l'année comme le premier jour de la première semaine	+	* %W - week number in the year, taking the first Monday of the year as the first day of the the first week
-	* %w - jour de la semaine, numérique, avec dimanche = 0	+	* %w - day of the week (digits) with Sunday=0
-	* %x - format préféré de représentation de la date sans l'heure	+	* %x - preferred format of date representation without the time
-	* %X - format préféré de représentation de l'heure sans la date	+	* %X - preferred format of date representation without the date
-	* %y - l'année, numérique, sur deux chiffres (de 00 à 99)	+	* %y - year, 2 digits (00 to 99)
-	* %Y - l'année, numérique, sur quatre chiffres	+	* %Y - year, 4 digits
-	* %Z - fuseau horaire, ou nom ou abréviation	+	* %Z - timezone, or name or abbreviation
-	* %% - un caractère `%' littéral	+	* %% - a litteral `%' character

2.0:resources:plugins

Wed, 16 Oct 2013 09:55:25 +0200

1281990864		current
Line 7:		Line 7:
	.:plugins:public-page		.:plugins:public-page
	.:plugins:settings		.:plugins:settings
		+	.:plugins:prefs
	.:plugins:widgets		.:plugins:widgets
	.:plugins:antispam		.:plugins:antispam
Line 14:		Line 15:
	.:plugins:dashboard		.:plugins:dashboard
	.:plugins:help		.:plugins:help
		+	.:plugins:changelogs
	}}}		}}}

2.0:resources:themes

Wed, 16 Oct 2013 09:55:25 +0200

1279012653		current
Line 82:		Line 82:
	* It is not necessary, and is even a bad idea, to create a theme by copying each and every template file of the default theme.		* It is not necessary, and is even a bad idea, to create a theme by copying each and every template file of the default theme.

-	===== the template tags =====	+	===== The template tags =====

	Beside the well known xhtml tags, Dotclear template files use a specific syntax to call its own fuctions or display informations. Those tags and their attributes are listed and explained [[.themes:tags\|in this section]]. How to create your own template tags is explained [[.:tpl\|in that other section]].		Beside the well known xhtml tags, Dotclear template files use a specific syntax to call its own fuctions or display informations. Those tags and their attributes are listed and explained [[.themes:tags\|in this section]]. How to create your own template tags is explained [[.:tpl\|in that other section]].

2.0:resources:tpl

Wed, 16 Oct 2013 09:55:25 +0200

1279012121		current
Line 90:		Line 90:
	</code>		</code>

-	This is a block tag. The difference between value tags and block tags are their syntax (<tpl:tag> instead of {{tpl:tag}) but also their behaviors. Block tags return a block of PHP code that allows loops, conditional loops, etc.	+	This is a block tag. The difference between value tags and block tags lies in their syntax (<tpl:tag> instead of {{tpl:tag}) but also their behaviors. Block tags return a block of PHP code that allows loops, conditional loops, etc.

	==== Declaration statement ====		==== Declaration statement ====
Line 122:		Line 122:

	This function checks a post's position compared to the "is" argument that contains accepted position, separed by comas. The function takes two parameters :		This function checks a post's position compared to the "is" argument that contains accepted position, separed by comas. The function takes two parameters :
-	* $attr which is an array. This way, the parameter "is" of this tag ''<tpl:EntryIfPosition is="1">'' can be retrieve in the function using ''$attr['is']''.	+	* $attr which is an array. This way, the parameter "is" of this tag ''<tpl:EntryIfPosition is="1">'' can be retrieved in the function using ''$attr['is']''.
	* $content which is the content between the ''<tpl:EntryIfPosition is="1">'' and ''</tpl:EntryIfPosition>'' tags.		* $content which is the content between the ''<tpl:EntryIfPosition is="1">'' and ''</tpl:EntryIfPosition>'' tags.

Line 153:		Line 153:

	<note important>		<note important>
-	If ''tpl_use_cache'' is set to false in about:config, those two functions will have the same behavior as nothing will be stored in cache.	+	If ''tpl_use_cache'' is set to false in about:config, these two functions will have the same behavior as nothing will be stored in cache.
	</note>		</note>

Line 179:		Line 179:

	<note tip>		<note tip>
-	Thoses functions don't use filters : they are meant to string and would have no effect on numbers.	+	These functions don't use filters : filters are meant to be used on strings and would have no effect on numbers
	</note>		</note>