GPMSWiki/DeveloperDocumentation/MigrationHelp/SessionManagementChanges - Revision history

Admin: 13 revisions

2011-10-26T06:18:51Z

13 revisions

← Older revision	Revision as of 08:18, 26 October 2011
(No difference)

imported>BurkhardLinke at 12:53, 11 November 2008

2008-11-11T12:53:31Z

@@ Line 145: / Line 145: @@
      if ($q->param('project')) {
          if (ref($session)) {
-             # ensure that the session is for the same project
+             # we have a request to set a project and an active GenDB session
-             # otherwise this is an error
+            # there may be another GenDB window open, so we cannot change to
              if ($session->param('project_name')) {
                  if ($session->param('project_name') ne $q->param('project')) {
-                     print error_page($q->p("Requested to use project ".
-                                           $q->b($q->param('project')).
+                     # print some error message about the concurrent project
-                                           ", but there's already an active session for project ".
                      return;
+                 }
@@ Line 160: / Line 160: @@
+         }
          else {
-             # no session yet, initialize a new one
+             # no session yet, create a new one
              $session = Session::GENDB->create($master_session);
+         }
@@ Line 173: / Line 173: @@
      if (ref($session) && $session->param('project_name')) {
-         if ($q->param('region')) {
+         # session is initialized and project is set, show the main window
-            $session->param('region', $q->param('region'));
+         # of your application
+     }
      else {
-         ## no project selected yet, display project selection
-        my $projects = get_project_list($master_session->getGPMSSubSession());
+         # no project selected yet, display project selection
-        unless (scalar @$projects) {
+     }

imported>BurkhardLinke at 12:48, 11 November 2008

2008-11-11T12:48:02Z

Show changes

imported>BurkhardLinke: updated API changes section

2008-11-11T12:32:47Z

updated API changes section

← Older revision		Revision as of 14:32, 11 November 2008
Line 212:		Line 212:
	== API ==		== API ==

	The API ~~is completely different from the old one, especially when it come~~ to ~~initialization of sessions. The only function that is unchanged is '''param''', fortunately ;-) It can~~ be ~~used~~ to ~~get and set session parameters~~.		The API has been rewritten to be consistent and easy to use.

	* ~~The function~~ '''~~params~~''' ~~delivered all~~ parameter ~~values as key value pairs. This function does no longer exist. To replace it:~~		=== Session parameter ===
	** get all session parameters by using function ''~~getParams~~'' ~~to get all~~ parameter ~~names~~
	** use ''~~param~~'' ~~on each name and store~~ the ~~value~~		Session parameters are handled by a number of functions:
	* ~~Missing: No:~~ '''~~param_permanent~~''' ~~any more, because you don't want it~~ :~~-\| If you do, blame Burkhard and suffer~~
	* ~~Missing:~~ '''query''' ~~used~~ to ~~return the~~ CGI object of ~~the session management~~, ~~should be re-implemented in Extension class~~		* '''param(name, [value])''' gets or sets a session parameter
	* ~~Missing:~~ '''master''' ~~returned~~ the ~~gpms master of~~ the session, was removed. ~~This function is required by many /!\~~		* '''hasParam(name)''' returns true if a session parameter with the given name exists
	* Missing: '''~~login_name~~'''~~, now has~~ to ~~be handles via~~ the ~~appframe or so~~		* '''deleteParam(name)''' removed the session parameter
	* ~~New:~~ '''~~deleteParam~~''' ~~removes~~ the ~~param value, which was before done by setting~~ the ~~param~~ to ~~undef~~		* '''getParams()''' returns a list of all session parameter names

			Certain functions of the old API are not supported anymore; they can be easily substituted by short chunks of code. Permanent session parameters are also not implemented in the new session management due to its limited use and added maintance overhead.

			=== Other discontinued methods ===

			These methods were specific for GPMS based sessions in the former session management; they counterparts (if existing) are implemented for Session::GPMS::Application sub classes only.

			* '''query''' use CGI->new() to get a CGI object. The CGI module stores an internal copy of an initialized object during page processing, so calling new several times has only very little to no overhead
			* '''master''' used to return the /!\ application frame /!\ in the previous session management and was removed for the obvious reason. If you are using a sub class of Session::GPMS::Application, use ''getApplicationFrame()'' to get the application frame of the session and use the ''application_master()'' and ''gpms_master()'' methods to get the master objects.
			* '''login_name''','''password''' etc. Also use the application frame to get these values. Keep in mind that the new sessionmanagement uses role accounts. You have to use the ''real_login()'' method of the application frame to get the name of the user. Passwords are only stored as hashes. Clear text passwords '''ARE NOT AVAILABLE ANYMORE'''.

imported>MichaelDondrup at 10:07, 11 November 2008

2008-11-11T10:07:37Z

← Older revision		Revision as of 12:07, 11 November 2008
Line 4:		Line 4:
	The new Sessionmanagement module is completely new and build from scratch. It supports hierarchical sessions,		The new Sessionmanagement module is completely new and build from scratch. It supports hierarchical sessions,
	and also anonymous sessions.		and also anonymous sessions.
	Complete redesign implies vast changes throughout the API. So ~~expect some work~~.		Complete redesign implies vast changes throughout the API. Most functions do no longer exist or have changes.
			So this thing is still a real pain in the ass.

	== Classes ==		== Classes ==
Line 216:		Line 217:
	** get all session parameters by using function ''getParams'' to get all parameter names		** get all session parameters by using function ''getParams'' to get all parameter names
	** use ''param'' on each name and store the value		** use ''param'' on each name and store the value
	* ~~Deleted~~: '''param_permanent''' any more, because you don't want it :-\| If you do, blame Burkhard and suffer		* Missing: No: '''param_permanent''' any more, because you don't want it :-\| If you do, blame Burkhard and suffer
	* ~~Deleted~~: '''query''' used to return the CGI object of the session management, should be re-implemented in Extension class		* Missing: '''query''' used to return the CGI object of the session management, should be re-implemented in Extension class
	* ~~Deleted~~: '''master''' returned the gpms master of the session, was removed. This function is required, it has to be ~~implemented in~~ the		* Missing: '''master''' returned the gpms master of the session, was removed. This function is required by many /!\
	~~Subsession class.~~		* Missing: '''login_name''', now has to be handles via the appframe or so
	* ~~the function~~ '''~~delete_param~~''' removes the param value, which was before done by setting the param to undef		* New: '''deleteParam''' removes the param value, which was before done by setting the param to undef

imported>MichaelDondrup at 20:04, 10 November 2008

2008-11-10T20:04:36Z

← Older revision		Revision as of 22:04, 10 November 2008
Line 218:		Line 218:
	* Deleted: '''param_permanent''' any more, because you don't want it :-\| If you do, blame Burkhard and suffer		* Deleted: '''param_permanent''' any more, because you don't want it :-\| If you do, blame Burkhard and suffer
	* Deleted: '''query''' used to return the CGI object of the session management, should be re-implemented in Extension class		* Deleted: '''query''' used to return the CGI object of the session management, should be re-implemented in Extension class
	* Deleted: '''master''' returned the gpms master of the session, was removed		* Deleted: '''master''' returned the gpms master of the session, was removed. This function is required, it has to be implemented in the
			Subsession class.
	* the function '''delete_param''' removes the param value, which was before done by setting the param to undef		* the function '''delete_param''' removes the param value, which was before done by setting the param to undef

imported>MichaelDondrup at 19:47, 10 November 2008

2008-11-10T19:47:49Z

← Older revision		Revision as of 21:47, 10 November 2008
Line 220:		Line 220:
	* Deleted: '''master''' returned the gpms master of the session, was removed		* Deleted: '''master''' returned the gpms master of the session, was removed
	* the function '''delete_param''' removes the param value, which was before done by setting the param to undef		* the function '''delete_param''' removes the param value, which was before done by setting the param to undef
	*

imported>MichaelDondrup at 19:46, 10 November 2008

2008-11-10T19:46:45Z

← Older revision		Revision as of 21:46, 10 November 2008
Line 216:		Line 216:
	** get all session parameters by using function ''getParams'' to get all parameter names		** get all session parameters by using function ''getParams'' to get all parameter names
	** use ''param'' on each name and store the value		** use ''param'' on each name and store the value
	* ~~There is no~~ '''param_permanent''' any more, because you don't want it :-\| If you do, blame Burkhard and suffer		* Deleted: '''param_permanent''' any more, because you don't want it :-\| If you do, blame Burkhard and suffer
			* Deleted: '''query''' used to return the CGI object of the session management, should be re-implemented in Extension class
			* Deleted: '''master''' returned the gpms master of the session, was removed
	* the function '''delete_param''' removes the param value, which was before done by setting the param to undef		* the function '''delete_param''' removes the param value, which was before done by setting the param to undef
			*

imported>MichaelDondrup at 11:04, 7 November 2008

2008-11-07T11:04:49Z

← Older revision		Revision as of 13:04, 7 November 2008
Line 74:		Line 74:

	once you have and authenticated Session::GPMS::<[[YourApp]]> the session can be resumed using <code><nowiki>Session::GPMS::<[[YourApp]]>->loadSingleton($masterSession);</nowiki></code> if it is a singleton session.		once you have and authenticated Session::GPMS::<[[YourApp]]> the session can be resumed using <code><nowiki>Session::GPMS::<[[YourApp]]>->loadSingleton($masterSession);</nowiki></code> if it is a singleton session.

			Here is a lengthy stub for a login script:

			<pre><nowiki>
			sub login {
			my $cgi = CGI->new();
			# get your parameters, or however they are named in your login page
			# ICICIC: to your needs
			my $login = $cgi->param('login');
			my $pass = $cgi->param('pass');
			my $changeproject = $cgi->param('changeproject'); # did we receive a change request
			my $projectname = $cgi->param('project');

			my $masterSession = undef; # this is the Master session
			my $myAppSession = undef; # this is the application specific session
			eval {
			# can we resume a session?
			$session = new Session::Master;
			print $session->header();
			};
			# errors are now raised by die-ing
			# if not:
			if (UNIVERSAL::isa($@, 'Session::NoActiveSessionException')) {
			# First time login, nothing is there
			### Check for cookies?
			if ($cgi->param('cookietest')) {
			#### TODO: ERROR: Your browser doesnt accept cookies

			} else {
			$session = new Session::Master (1); # initialize real-new session
			print $session->header(); # got a cookie with that
			my $url = $cgi->url().'?cookietest=1';
			# ICICIC: other parameters must beadded here, probably
			print $cgi->start_html(-head=>$cgi->meta({-http_equiv=>'refresh',
			-content=>"2;$url"}));
			# print checking for cookies for the user
			print $cgi->p("Checking cookies, please wait...");
			print $cgi->end_html();
			return;
			}
			} elsif ($@) {
			### something else went wrong, error handling
			## TODO: confess ...
			}
			# if somebody wants to change the project, throw some
			# data away:

			if ( $cgi->param('changeproject') ) {
			$session->deleteParam('project_name');
			$session->getApplicationFrame->release_project;

			}

			### we got a Master session now, are we authenticated?
			unless ($session->isAuthenticated) {

			### we must retrieve uname pw from cgiparam:
			# it's done at the top already

			# we must display the form first, if there is nothing!
			unless ($login && $pass) { # also prevents passwordless accounts!
			### TODO: show your login page
			return;
			}

			### get an Application specific session:
			eval {
			$myAppSession = Session::GPMS::<YourAPP>-> # ICICIC:
			create_with_gpms($masterSession, $login, $pass);
			};
			if ($@) {
			# something's wrong, $@ tells what
			# TODO: output error $@, most likely wrong credentials
			return;
			}

			### I'm authenticated now, show project selection page
			### ICICIC: if your page does not support it
			my @projects = @{$myAppSession
			-> getApplicationFrame ->
			get_available_projects_by_project_class()};
			# must also go here, if a project change is requested
			if (@projects) {

			my @prjnames = map {{name=>$_->name}} @projects;
			@prjnames = sort { lc($a->{name}) cmp lc($b->{name}) } @prjnames;
			### TODO: show the list


			} else {
			### TODO: ERROR no projects found
			}


			} else {
			unless ($projectname) {
			### I'm authenticated now, show project selection page
			### Got no project name, so show the project selection page
			return;
			}

			# got project information from the CGI->param
			$myAppSession = Session::GPMS::<MyApp>->loadSingleton($masterSession); #ICICIC:
			# can we resume the session?
			unless (defined $myAppSession) {
			# NO! this time no exception, but undef returned (sic!)
			$myAppSession = Session::GPMS::<MyApp>->create($masterSession) #ICICIC:
			}
			# lookup the proect:
			my $project = $masterSession # only the GPMS-Session knows projects, a gpms session is
			-> getGPMSSubSession # silently hidden in the masterSession
			-> getApplicationFrame
			-> gpms_master->Project
			-> init_arg($projectname);
			unless ($project) {
			# there is no such project or so
			# ICICIC: ERROR: no such project

			} else {
			# finally:
			$myAppSession->setProject($project);
			}
			}


			print more page output .... # ICICIC:

			}




			</nowiki></pre>


	== API ==		== API ==

imported>MichaelDondrup at 10:35, 7 November 2008

2008-11-07T10:35:32Z

@@ Line 31: / Line 31: @@
 use base qw(Session::GPMS::Application);
 ;
@@ Line 53: / Line 54: @@
 </nowiki></pre>
 == API ==
-The API is completely different from the old one, especially when it come to initialization of sessions. The only function that is unchanged is '''param''', fortunately ;-) It can be used to get and set session parameters
+The API is completely different from the old one, especially when it come to initialization of sessions. The only function that is unchanged is '''param''', fortunately ;-) It can be used to get and set session parameters.
 * The function '''params''' delivered all parameter values as key value pairs. This function does no longer exist. To replace it:
@@ Line 62: / Line 83: @@
 ** use ''param'' on each name and store the value
 * There is no '''param_permanent''' any more, because you don't want it :-| If you do, blame Burkhard and suffer