Moodle

3/ The logout button seems to only cause a change in the $action variable, which the plugin needs to inspect. Again could this not be done by a function of the plugin rather than the module creator needing to examine $action?

Dongsheng, can you address these? I guess there must be some cleaning up to do still.

And thanks Dan!!

Hi, Dan,
1/
I agree, but currently, I couldn't find a graceful way to replace with it, when user click the repository name on file picker, repository module doesn't know whether the user is logged in (some plugins don't need to login, for example, local and upload plugin) until plugin class has been initialized (in __construct function), if the user is not logged in, we must change the action to tell repository api: print a login form for user, print_login will be called.

2/

• when action == login
• print_login will return some login information, which tell file picker what elements the login form should be contained, the most simple print_login should be like this:
  public function print_login($ajax = true)
  Unknown macro: { global $SESSION; if($ajax){ $ret = array(); $popup_btn = new stdclass; $popup_btn->type = 'popup'; $popup_btn->url = "http://moodlesite.com/login.php"; $ret['login'] = array($popup_btn); return $ret; } }
  
  This will create a link which can open a popup window, or you can tell file picker to create login form with username and password:
  public function print_login($ajax = true)
  Unknown macro: { global $SESSION; if($ajax){ $ret = array(); $username->label = get_string('username', 'repository_boxnet').': '; $username->id = 'box_username'; $username->type = 'text'; $username->name = 'boxusername'; $username->value = $ret->username; $password->label = get_string('password', 'repository_boxnet').': '; $password->id = 'box_password'; $password->type = 'password'; $password->name = 'boxpassword'; $ret['login'] = array($username, $password); return $ret; } }

label is the text before the username input element, type is the attribute of input element, name is the name of input element
it will create a form:
<label>username</label><br/>
<input type="text" name="boxusername' id="box_username" />
<label>Password</label><br/>
<input type="password" name="boxpassword' id="box_password" />

• we will develop a non-javascript file picker later, so we use ajax flag here to tell plugin print a login form for ajax file picker instead of non-javascript file picker
• Not anymore, I just found another way to store repository in javascript object.

3/ That's reasonable, we need to create a function called logout in base class.

Any suggestions are welcomed, dan, please let me know if you know better way to implement the file picker. Thanks

Hi Dongsheng,

Thanks for your comments (I have not looked into the internals of how this works yet, just how I would write a plugin for it)

1) What possible actions can happen with this?

Could we not do this sort of thing in methods of the base class, e.g. check_login() function which defaults to true. So when we want to display a list of files we do:

$foo = new repo();

if( $foo->check_login() ){
$foo->display_files();
}else{
$foo->print_login();
}

Or something like that - the same for checking the result of the login, rather than putting it all in the constructor?

2) What is the format of the returned object - what interprets it? Why is it indexed by 'login'?

1) That's reasonable, the original Repository API specification don't have this function, we need to add it.

2) returned object will be encoded as JSON string, javascript interprets the JSON string (repository/lib.php line 1526)
> Why is it indexed by 'login'?
Because the Javascript Ajax request will be processed by a callback object (repository/lib.php line 1998)
the response json may be files list ($ret['list']) , login form ($ret['login']) or error report ($ret['e']).

Dan, I added logout() and check_login() according your suggestion, we don't need $action anymore, let me know if you find more problem.

Dan, Repository API started to support popup now, you can have a look "Flickr plug-in".

See MDL-16545