The rolesdebug.php roles debugging script - Revision history

Jisner: /* Essential roles and capabilities concepts */

2008-05-13T15:19:50Z

Essential roles and capabilities concepts

← Older revision		Revision as of 15:19, 13 May 2008
Line 24:		Line 24:
	==Essential roles and capabilities concepts==		==Essential roles and capabilities concepts==

	Interpreting the output from rolesdebug.php requires ~~at least~~ a ~~basic~~ understanding of the concepts listed below. If any of these concepts are unfamiliar to you, stop and follow the documentation link.		Interpreting the output from rolesdebug.php requires a solid understanding of the concepts listed below. If any of these concepts are unfamiliar to you, stop and follow the documentation link.

	* [[Assign_roles#Contexts \| Context]]		* [[Assign_roles#Contexts \| Context]]

Jisner: /* The use case for rolesdebug.php */

2008-05-13T15:19:02Z

The use case for rolesdebug.php

← Older revision		Revision as of 15:19, 13 May 2008
Line 14:		Line 14:
	The main use case for rolesdebug.php is a ''roles expert helping a roles novice troubleshoot a roles-related problem''. A ''roles expert'' is anyone with a solid understanding of the [[#Essential roles and capabilities concepts \| essential roles concepts]] listed in the next section. A ''roles novice'' is any Moodle user with the ability to follow simple instructions from the expert. While the expert and novice may occasionally share the same physical location and have accounts on the same Moodle site, it is not required that they do so. The expert must be able to help the novice without logging in to the novice's site, and by communicating with the novice only by e-mail, messaging, forum posts, etc.. For example, the novice may be a user posting to a moodle.org forum and the expert may be a moodler wanting to be helpful. Even when expert and novice share a physical location and have accounts on the same Moodle site, the expert may not be in a position to give direct help, e.g., by "logging in as" the novice or meeting with the novice. For example, the expert may be a Moodle administrator with an extremely busy schedule.		The main use case for rolesdebug.php is a ''roles expert helping a roles novice troubleshoot a roles-related problem''. A ''roles expert'' is anyone with a solid understanding of the [[#Essential roles and capabilities concepts \| essential roles concepts]] listed in the next section. A ''roles novice'' is any Moodle user with the ability to follow simple instructions from the expert. While the expert and novice may occasionally share the same physical location and have accounts on the same Moodle site, it is not required that they do so. The expert must be able to help the novice without logging in to the novice's site, and by communicating with the novice only by e-mail, messaging, forum posts, etc.. For example, the novice may be a user posting to a moodle.org forum and the expert may be a moodler wanting to be helpful. Even when expert and novice share a physical location and have accounts on the same Moodle site, the expert may not be in a position to give direct help, e.g., by "logging in as" the novice or meeting with the novice. For example, the expert may be a Moodle administrator with an extremely busy schedule.

	Here's a typical scenario. Supposed the novice is a teacher who has created a quiz, but is being prevented from previewing the quiz for some unknown reason. The novice reports the problem to moodle.org in a forum post. The expert (a helpful moodler) suspects a roles problem and replies by asking the novice to (1) log in to Moodle, reproduce the problem (2) browse to rolesdebug.php (3) enter two or three parameters as specified by the expert (4) paste the output from rolesdebug.php into a reply to this forum post. The expert ~~reviews~~ the output and ~~(hopefully)~~ diagnoses the problem.		Here's a typical scenario. Supposed the novice is a teacher who has created a quiz, but is being prevented from previewing the quiz for some unknown reason. The novice reports the problem to moodle.org in a forum post. The expert (a helpful moodler) suspects a roles problem and replies by asking the novice to (1) log in to Moodle, reproduce the problem (2) browse to rolesdebug.php (3) enter two or three parameters as specified by the expert (4) paste the output from rolesdebug.php into a reply to this forum post. The expert views the output and immediately diagnoses the problem.

	Secondary use cases for rolesdebug.php include		Secondary use cases for rolesdebug.php include

Jisner: /* The use case for rolesdebug.php */

2008-05-13T15:17:55Z

The use case for rolesdebug.php

← Older revision		Revision as of 15:17, 13 May 2008
Line 12:		Line 12:
	==The use case for rolesdebug.php==		==The use case for rolesdebug.php==

	The main use case for rolesdebug.php is a ''roles expert helping a roles novice troubleshoot a roles-related problem''. A ''roles expert'' is anyone with a solid understanding of the [[#Essential roles and capabilities concepts \| essential roles concepts]] listed in the next section. A ''roles novice'' is any Moodle user with the ability to follow simple instructions from the expert. While the expert and novice may occasionally share the same physical location and have accounts on the same Moodle site, it is not required. The expert must be able to help the novice without logging in to the novice's site, and by communicating with the novice only by e-mail, messaging, forum posts, etc.. For example, the novice may be a user posting to a moodle.org forum and the expert may be a moodler wanting to be helpful. Even when expert and novice share a physical location and have accounts on the same Moodle site, the expert may not be in a position to give direct help, e.g., by "logging in as" the novice or meeting with the novice. For example, the expert may be a Moodle administrator with an extremely busy schedule.		The main use case for rolesdebug.php is a ''roles expert helping a roles novice troubleshoot a roles-related problem''. A ''roles expert'' is anyone with a solid understanding of the [[#Essential roles and capabilities concepts \| essential roles concepts]] listed in the next section. A ''roles novice'' is any Moodle user with the ability to follow simple instructions from the expert. While the expert and novice may occasionally share the same physical location and have accounts on the same Moodle site, it is not required that they do so. The expert must be able to help the novice without logging in to the novice's site, and by communicating with the novice only by e-mail, messaging, forum posts, etc.. For example, the novice may be a user posting to a moodle.org forum and the expert may be a moodler wanting to be helpful. Even when expert and novice share a physical location and have accounts on the same Moodle site, the expert may not be in a position to give direct help, e.g., by "logging in as" the novice or meeting with the novice. For example, the expert may be a Moodle administrator with an extremely busy schedule.

	Here's a typical scenario. Supposed the novice is a teacher who has created a quiz, but is being prevented from previewing the quiz for some unknown reason. The novice reports the problem to moodle.org in a forum post. The expert (a helpful moodler) suspects a roles problem and replies by asking the novice to (1) log in to Moodle, reproduce the problem (2) browse to rolesdebug.php (3) enter two or three parameters as specified by the expert (4) paste the output from rolesdebug.php into a reply to this forum post. The expert reviews the output and (hopefully) diagnoses the problem.		Here's a typical scenario. Supposed the novice is a teacher who has created a quiz, but is being prevented from previewing the quiz for some unknown reason. The novice reports the problem to moodle.org in a forum post. The expert (a helpful moodler) suspects a roles problem and replies by asking the novice to (1) log in to Moodle, reproduce the problem (2) browse to rolesdebug.php (3) enter two or three parameters as specified by the expert (4) paste the output from rolesdebug.php into a reply to this forum post. The expert reviews the output and (hopefully) diagnoses the problem.

Jisner: /* The use case for rolesdebug.php */

2008-05-13T15:16:47Z

The use case for rolesdebug.php

← Older revision		Revision as of 15:16, 13 May 2008
Line 12:		Line 12:
	==The use case for rolesdebug.php==		==The use case for rolesdebug.php==

	The main use case for rolesdebug.php is a ''roles expert helping a roles novice troubleshoot a roles-related problem''. A ''roles expert'' is anyone with a ~~basic~~ understanding of the [[#Essential roles and capabilities concepts \| essential roles concepts]] listed in the next section. A ''roles novice'' is any Moodle user with the ability to follow simple instructions from the expert. While the expert and novice may occasionally share the same physical location and have accounts on the same Moodle site, it is not required. The expert must be able to help the novice without logging in to the novice's site, and by communicating with the novice only by e-mail, messaging, forum posts, etc.. For example, the novice may be a user posting to a moodle.org forum and the expert may be a moodler wanting to be helpful. Even when expert and novice share a physical location and have accounts on the same Moodle site, the expert may not be in a position to give direct help, e.g., by "logging in as" the novice or meeting with the novice. For example, the expert may be a Moodle administrator with an extremely busy schedule.		The main use case for rolesdebug.php is a ''roles expert helping a roles novice troubleshoot a roles-related problem''. A ''roles expert'' is anyone with a solid understanding of the [[#Essential roles and capabilities concepts \| essential roles concepts]] listed in the next section. A ''roles novice'' is any Moodle user with the ability to follow simple instructions from the expert. While the expert and novice may occasionally share the same physical location and have accounts on the same Moodle site, it is not required. The expert must be able to help the novice without logging in to the novice's site, and by communicating with the novice only by e-mail, messaging, forum posts, etc.. For example, the novice may be a user posting to a moodle.org forum and the expert may be a moodler wanting to be helpful. Even when expert and novice share a physical location and have accounts on the same Moodle site, the expert may not be in a position to give direct help, e.g., by "logging in as" the novice or meeting with the novice. For example, the expert may be a Moodle administrator with an extremely busy schedule.

	Here's a typical scenario. Supposed the novice is a teacher who has created a quiz, but is being prevented from previewing the quiz for some unknown reason. The novice reports the problem to moodle.org in a forum post. The expert (a helpful moodler) suspects a roles problem and replies by asking the novice to (1) log in to Moodle, reproduce the problem (2) browse to rolesdebug.php (3) enter two or three parameters as specified by the expert (4) paste the output from rolesdebug.php into a reply to this forum post. The expert reviews the output and (hopefully) diagnoses the problem.		Here's a typical scenario. Supposed the novice is a teacher who has created a quiz, but is being prevented from previewing the quiz for some unknown reason. The novice reports the problem to moodle.org in a forum post. The expert (a helpful moodler) suspects a roles problem and replies by asking the novice to (1) log in to Moodle, reproduce the problem (2) browse to rolesdebug.php (3) enter two or three parameters as specified by the expert (4) paste the output from rolesdebug.php into a reply to this forum post. The expert reviews the output and (hopefully) diagnoses the problem.

Jisner: /* Rolesdebug says I should be able do this, but Moodle won't let me! */

2008-05-10T22:14:48Z

Rolesdebug says I should be able do this, but Moodle won't let me!

← Older revision		Revision as of 22:14, 10 May 2008
Line 203:		Line 203:

	==Rolesdebug says I should be able do this, but Moodle won't let me!==		==Rolesdebug says I should be able do this, but Moodle won't let me!==
	When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are ~~several~~ possibilities ~~to consider.~~		When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are three possibilities:
	* Moodle may be calculating the permission in a ''different context'' than the one you specified (Moodle calculates some permissions explicitly in System or User contexts).		* Moodle may be calculating the permission in a ''different context'' than the one you specified (Moodle calculates some permissions explicitly in System or User contexts).
	* If you are assigned any legacy roles (particularly Guest), Moodle may be ignoring the calculated permission. For example, ~~if you allow~~ Guest it to post to ~~a Forum~~, Rolesdebug will report that you can post, but Moodle will simply ignore the permission. If you ask a developer why, they will tell you "because guests can never post."		* If you are assigned any legacy roles (particularly Guest), Moodle may be ignoring the calculated permission. For example, Guest has been edited, allowing it to post to Forums, Rolesdebug will report that you can post, but Moodle will simply ignore the permission. If you ask a developer why, they will tell you "because guests can never post."
	* The action you are attempting requires two or more permissions.		* The action you are attempting requires two or more permissions.

	When such a disagreement occurs, further research will be needed to debug the problem. Sometimes you can find the answer in documentation ~~(e.g~~., when a permission is calculated in a different context, the documentation usually says so~~), and other~~ times you will need to read the code.		When such a disagreement occurs, further research will be needed to debug the problem. Sometimes you can find the answer in documentation. For example, when a permission is calculated in a different context, the documentation usually says so. Other times you will just need to read the code.


	[[Category:Contributed code]]		[[Category:Contributed code]]

Jisner: /* Rolesdebug says I can do this, but Moodle says I can't! */

2008-05-10T22:11:56Z

Rolesdebug says I can do this, but Moodle says I can't!

← Older revision		Revision as of 22:11, 10 May 2008
Line 202:		Line 202:
	There is only one SYSTEM context. Its id is 1.		There is only one SYSTEM context. Its id is 1.

	==Rolesdebug says I ~~can~~ do this, but Moodle ~~says I can~~'t!==		==Rolesdebug says I should be able do this, but Moodle won't let me!==
	When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are several possibilities to consider.		When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are several possibilities to consider.
	* Moodle may be calculating the permission in a ''different context'' than the one you specified (Moodle calculates some permissions explicitly in System or User contexts).		* Moodle may be calculating the permission in a ''different context'' than the one you specified (Moodle calculates some permissions explicitly in System or User contexts).

Jisner: /* Rolesdebug says I can do this, but Moodle says I can't! */

2008-05-10T22:11:29Z

Rolesdebug says I can do this, but Moodle says I can't!

← Older revision		Revision as of 22:11, 10 May 2008
Line 204:		Line 204:
	==Rolesdebug says I can do this, but Moodle says I can't!==		==Rolesdebug says I can do this, but Moodle says I can't!==
	When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are several possibilities to consider.		When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are several possibilities to consider.
	* Moodle may be calculating the permission in a ''different context'' than the one you specified. Moodle ~~tests~~ some ~~Systems~~ explicitly in System or User contexts.		* Moodle may be calculating the permission in a ''different context'' than the one you specified (Moodle calculates some permissions explicitly in System or User contexts).
	* If you are assigned any legacy roles (particularly Guest), Moodle may be ignoring the calculated permission ~~in favor of preserving legacy behavior~~. For example, if you allow Guest it to post to a Forum, Rolesdebug will report that you can post, but Moodle will simply ignore the permission.		* If you are assigned any legacy roles (particularly Guest), Moodle may be ignoring the calculated permission. For example, if you allow Guest it to post to a Forum, Rolesdebug will report that you can post, but Moodle will simply ignore the permission. If you ask a developer why, they will tell you "because guests can never post."
	* The action you are attempting requires two or more permissions.		* The action you are attempting requires two or more permissions.

	When ~~there is~~ a disagreement, further research will be needed to debug the problem. Sometimes you can find the answer in documentation (e.g., when a permission is calculated in a different context, the documentation usually says so), and other times you will need to read the code.		When such a disagreement occurs, further research will be needed to debug the problem. Sometimes you can find the answer in documentation (e.g., when a permission is calculated in a different context, the documentation usually says so), and other times you will need to read the code.


	[[Category:Contributed code]]		[[Category:Contributed code]]

Jisner at 22:07, 10 May 2008

2008-05-10T22:07:55Z

← Older revision		Revision as of 22:07, 10 May 2008
Line 1:		Line 1:
	{{Roles}}{{Moodle 1.9}}		{{Roles}}{{Moodle 1.9}}
	Rolesdebug.php is a stand-alone script that is extremely useful for debugging problems related to roles and permissions. The output can be interpreted by anyone with a good understanding of Moodle's [[Roles and capabilities]] system. If you're a "roles novice" and you need help with a roles-related problem, ~~you can~~ ask a roles expert to help you with running the script and interpreting the output. If you don't have access to an expert, post a request for help to the [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum]. After using the script a few times, you'll be an expert too!		Rolesdebug.php is a stand-alone script that is extremely useful for debugging problems related to roles and permissions. The output can be interpreted by anyone with a good understanding of Moodle's [[Roles and capabilities]] system. If you're a "roles novice" and you need help with a roles-related problem, ask a roles expert to help you with running the script and interpreting the output. If you don't have access to an expert, post a request for help to the [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum]. After using the script a few times, you'll be an expert too!

	You can download rolesdebug.php from the [http://moodle.org/mod/data/view.php?d=13&rid=1204 Modules and Plugins database]. To install the script, simply drop it into the Moodle root directory or any directory under the root directory.		You can download rolesdebug.php from the [http://moodle.org/mod/data/view.php?d=13&rid=1204 Modules and Plugins database]. To install the script, simply drop it into the Moodle root directory or any directory under the root directory.

	Rolesdebug.php requires a login, so only someone with a Moodle user account who is currently logged in can use it. Since it is a php script, you will see the output in your browser. No one else will see it unless they're looking over your shoulder. Furthermore, rolesdebug.php ~~gives~~ you information about YOUR permissions. You cannot use it to get information about another user's permissions, unless you can login as them.		Rolesdebug.php requires a login, so only someone with a Moodle user account who is currently logged in can use it. Since it is a php script, you will see the output in your browser. No one else will see it unless they're looking over your shoulder. Furthermore, rolesdebug.php will only give you information about YOUR permissions. You cannot use it to get information about another user's permissions (unless you can login as them).

	Rolesdebug.php ~~returns~~ a table ~~that gives~~ a spatial view of the role assignments and overrides that affect you in a specified context. From the table, you will be able to see how Moodle calculates a specified permission. The table format is explained (and several examples are given) in the article [[How permissions are calculated]].		Rolesdebug.php outputs a table giving a spatial view of the role assignments and overrides that affect you in a specified context. From the table, you will be able to see how Moodle calculates a specified permission. The table format is explained (and several examples are given) in the article [[How permissions are calculated]].

	Rolesdebug.php reads permission data from the Moodle database but does not modify the database in any way. In this respect, it is similar to other debug scripts in the standard distribution, like the [[TeX_notation_filter#Debugging_TeX_filter \| TeX notation debugger]].		Rolesdebug.php reads permission data from the Moodle database but does not modify the database in any way. In this respect, it is similar to other debug scripts in the standard distribution, like the [[TeX_notation_filter#Debugging_TeX_filter \| TeX notation debugger]].
Line 201:		Line 201:
	===SYSTEM===		===SYSTEM===
	There is only one SYSTEM context. Its id is 1.		There is only one SYSTEM context. Its id is 1.

			==Rolesdebug says I can do this, but Moodle says I can't!==
			When this happens it is because Moodle is calculating your permission differently from the way you think it is. Here are several possibilities to consider.
			* Moodle may be calculating the permission in a ''different context'' than the one you specified. Moodle tests some Systems explicitly in System or User contexts.
			* If you are assigned any legacy roles (particularly Guest), Moodle may be ignoring the calculated permission in favor of preserving legacy behavior. For example, if you allow Guest it to post to a Forum, Rolesdebug will report that you can post, but Moodle will simply ignore the permission.
			* The action you are attempting requires two or more permissions.

			When there is a disagreement, further research will be needed to debug the problem. Sometimes you can find the answer in documentation (e.g., when a permission is calculated in a different context, the documentation usually says so), and other times you will need to read the code.


	[[Category:Contributed code]]		[[Category:Contributed code]]

Jisner at 12:50, 1 May 2008

2008-05-01T12:50:06Z

← Older revision		Revision as of 12:50, 1 May 2008
Line 1:		Line 1:
	{{Roles}}{{Moodle 1.9}}		{{Roles}}{{Moodle 1.9}}
	Rolesdebug.php is a stand-alone script that is extremely useful for debugging problems related to roles and permissions. The output can be interpreted by anyone with a good understanding of Moodle's [[Roles and capabilities]] system. If you're a "roles novice" and you need help with a roles-related problem, you can ask a roles expert to help you with running the script and interpreting the output. If you don't have access to an expert, post a request for help to the [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum]. After using the script a few times, you'll be an expert too.		Rolesdebug.php is a stand-alone script that is extremely useful for debugging problems related to roles and permissions. The output can be interpreted by anyone with a good understanding of Moodle's [[Roles and capabilities]] system. If you're a "roles novice" and you need help with a roles-related problem, you can ask a roles expert to help you with running the script and interpreting the output. If you don't have access to an expert, post a request for help to the [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum]. After using the script a few times, you'll be an expert too!

	You can download rolesdebug.php from the [http://moodle.org/mod/data/view.php?d=13&rid=1204 Modules and Plugins database]. To install the script, simply drop it into the Moodle root directory or any directory under the root directory.		You can download rolesdebug.php from the [http://moodle.org/mod/data/view.php?d=13&rid=1204 Modules and Plugins database]. To install the script, simply drop it into the Moodle root directory or any directory under the root directory.

Jisner at 12:49, 1 May 2008

2008-05-01T12:49:49Z

← Older revision		Revision as of 12:49, 1 May 2008
Line 1:		Line 1:
	{{Roles}}{{Moodle 1.9}}		{{Roles}}{{Moodle 1.9}}
	Rolesdebug.php is a stand-alone script that is extremely useful for debugging problems related to roles and permissions. The output can be interpreted by anyone with a good understanding of Moodle's [[Roles and capabilities]] system. If you're a "roles novice" and you need help with a roles-related problem, you can ask a roles expert to help you with running the script and interpreting the output. ~~Simply~~ post a request for help to the [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum].		Rolesdebug.php is a stand-alone script that is extremely useful for debugging problems related to roles and permissions. The output can be interpreted by anyone with a good understanding of Moodle's [[Roles and capabilities]] system. If you're a "roles novice" and you need help with a roles-related problem, you can ask a roles expert to help you with running the script and interpreting the output. If you don't have access to an expert, post a request for help to the [http://moodle.org/mod/forum/view.php?id=6826 Roles and Capabilities forum]. After using the script a few times, you'll be an expert too.

	You can download rolesdebug.php from the [http://moodle.org/mod/data/view.php?d=13&rid=1204 Modules and Plugins database]. To install the script, simply drop it into the Moodle root directory or any directory under the root directory.		You can download rolesdebug.php from the [http://moodle.org/mod/data/view.php?d=13&rid=1204 Modules and Plugins database]. To install the script, simply drop it into the Moodle root directory or any directory under the root directory.