AMH: implemented version tag modes as site settings, removed autoRequestCommit setting

lib/WebGUI/Auth.pm

@@ -760,6 +760,8 @@ sub isVisitor {
 Superclass method that performs standard login routines.  This is what should happen after a user has been authenticated.
 Authentication should always happen in the subclass routine.
 
+AMH: open version tag is reclaimed if user is in site wide or singlePerUser mode.
+
 =cut
 
 sub login {
@@ -803,7 +805,12 @@ sub login {
 		$self->session->http->setRedirect($self->session->scratch->get("redirectAfterLogin"));
 	  	$self->session->scratch->delete("redirectAfterLogin");
 	}
-	
+
+        #AMH: get open version tag. This is needed if we want
+        # to reclaim a version right after login (singlePerUser and siteWide mode)
+        # and to have the correct version displayed.
+        WebGUI::VersionTag->getWorking($self->session(), q{noCreate});
+
 	return undef;
 }
 

lib/WebGUI/Operation/Settings.pm

@@ -81,16 +81,38 @@ sub definition {
 		hoverHelp=>$i18n->get('default version tag workflow help'),
 		});
 
-        #AMH: Todo add versionTagMode
+        #AMH: Support for versionTagMode. We'll have:
+        # - multi version tag per user
+        # - one version tag per user (SwiftySite mode)
+        # - one site wide version tag
+        # - auto commit
+        push (
+            @fields,
+            {   tab          => q{content},
+		fieldType    => q{selectBox},
+                name         => q{versionTagMode},
+                defaultValue => [ $setting->get(q{versionTagMode}) ],
+                options      => {
+                    multiPerUser  => $i18n->get(q{versionTagMode multiPerUser}),
+                    singlePerUser => $i18n->get(q{versionTagMode singlePerUser}),
+                    siteWide      => $i18n->get(q{versionTagMode siteWide}),
+                    autoCommit    => $i18n->get(q{versionTagMode autoCommit}),
+                },
+                label        => $i18n->get(q{version tag mode}),
+                hoverHelp    => $i18n->get(q{version tag mode help}),
+            },
+        );
+
+#AMH: autoRequestCommit no long needed
+#	push(@fields, {
+#		tab=>"content",
+#		fieldType=>"yesNo",
+#        name=>"autoRequestCommit",
+#        label=>$i18n->get("auto request commit"),
+#        hoverHelp=>$i18n->get("auto request commit help"),
+#        defaultValue=>$setting->get("autoRequestCommit")
+#		});
 
-	push(@fields, {
-		tab=>"content",
-		fieldType=>"yesNo",
-        name=>"autoRequestCommit",
-        label=>$i18n->get("auto request commit"),
-        hoverHelp=>$i18n->get("auto request commit help"),
-        defaultValue=>$setting->get("autoRequestCommit")
-		});
 	push(@fields, {
 		tab=>"content",
 		fieldType=>"yesNo",

lib/WebGUI/VersionTag.pm

@@ -73,11 +73,16 @@ sub autoCommitWorkingIfEnabled {
     my $versionTag = $class->getWorking($session, "nocreate");
     return undef
         unless $versionTag;
+
+    #AMH: auto commit is no longer determined from autoRequestCommit
+
     # auto commit assets
     # save and commit button and site wide auto commit work the same
     if (
+#        $options->{override}
+#        || $session->setting->get("autoRequestCommit")
         $options->{override}
-        || $session->setting->get("autoRequestCommit")
+        || $class->getVersionTagMode($session) eq q{autoCommit}
     ) {
         if ($session->setting->get("skipCommitComments") || !$options->{allowComments}) {
             $versionTag->requestCommit;
@@ -358,6 +363,32 @@ sub getRevisionCount {
 }
 
 
+#-------------------------------------------------------------------
+
+#AMH: Support for versionTagMode.
+
+=head2 getVersionTagMode ( session )
+
+Return version tag mode for current session
+
+=cut
+
+sub getVersionTagMode {
+    my $class   = shift;
+    my $session = shift;
+
+    my $mode = q{};
+
+    #AMH: to do get user settings
+
+    #Get mode from settings
+    if ($mode eq q{}) {
+        $mode = $session->setting()->get(q{versionTagMode});
+    }
+
+    return $mode;
+} #getVersionTagMode
+
 #-------------------------------------------------------------------
 
 =head2 getWorkflowInstance ( )
@@ -388,26 +419,93 @@ A boolean that if set to true, will prevent this method from creating an autotag
 =cut
 
 sub getWorking {
-	my $class = shift;
+    #AMH: Support for versionTagMode.
-	my $session = shift;
+    my $class    = shift;
-	my $noCreate = shift;
+    my $session  = shift;
-	if ($session->stow->get("versionTag")) {
+    my $noCreate = shift;
-		return $session->stow->get("versionTag");
+
-	} else {
+    my $stow = $session->stow();
-		my $tagId = $session->scratch->get("versionTag");
+    my $mode = $class->getVersionTagMode($session);
-		if ($tagId) {
+    my $tag;
-			my $tag = $class->new($session, $tagId);
+    my $tagId;
-			$session->stow->set("versionTag",$tag);
+
-			return $tag;
+    #First see if there is already a version tag
-		} elsif ($noCreate) {
+    $tag = $stow->get(q{versionTag});
-			return undef;
+
-		} else {
+    return $tag if $tag;
-			my $tag = $class->create($session);
+
-			$tag->setWorking;
+    $tagId = $session->scratch()->get(q{versionTag});
-			return $tag;	
+    if ($tagId) {
-		}
+        $tag = $class->new($session, $tagId);
-	}
+
-}
+        $stow->set(q{versionTag}, $tag);
+
+        return $tag;
+    }
+
+    #No tag found. Create or reclaim one?
+    # multiPerUser / autoCommit: no reclaim, create if not noCreate
+    # singlePerUser: try to reclaim previous if only 1 open tag
+    # siteWide: try to claim site-wide version tag
+    # autoCommit: 
+
+    if ($mode eq q{singlePerUser}) {
+        # Get all open tags for user. If only 1 tag open then reclaim
+        # it.
+        my @openTags = ();
+        my $userId = $session->user()->userId();
+
+      OPENTAG:
+        foreach my $openTag (@{WebGUI::VersionTag->getOpenTags($session)}) {
+
+            # Do not reclaim site wide tag in singlePerUser mode
+            next OPENTAG if $openTag->get(q{isSiteWide});
+
+            if ($openTag->get(q{createdBy}) eq $userId) {
+
+                push @openTags, $openTag;
+            }
+        }
+        # For now, we only reclaim if 1 tag open.
+        if (scalar @openTags == 1) {
+            $tag = $openTags[0];
+
+            $tag->setWorking();
+
+            return $tag;
+        }
+    }
+    elsif ($mode eq q{siteWide}) {
+        # Check for site wide version tag. Reclaim if available
+
+      OPENTAG:
+        foreach my $openTag (@{WebGUI::VersionTag->getOpenTags($session)}) {
+            if ($openTag->get(q{isSiteWide})) {
+
+                $tag = $openTag;
+
+                $tag->setWorking();
+
+                return $tag;
+            }
+        }
+    }
+
+    return undef if $noCreate;
+
+    # Create new tag.
+    my %properties = ();
+
+    if ($mode eq q{siteWide}) {
+        $properties{isSiteWide} = 1;
+    }
+
+    $tag = $class->create($session, \%properties);
+
+    $tag->setWorking();
+
+    return $tag;
+} #getWorking
 
 #-------------------------------------------------------------------
 
@@ -553,17 +651,20 @@ The time that a version tag shoudl stop displaying on the website.
 =cut
 
 sub set {
-	my $self = shift;
+    my $self = shift;
-	my $properties = shift;
+    my $properties = shift;
-    
+
     my $now        = $self->session->datetime->time();
     my $startTime  = WebGUI::DateTime->new($self->session,$now)->toDatabase;
     my $endTime    = WebGUI::DateTime->new($self->session,'2036-01-01 00:00:00')->toDatabase;
-    
+
-	$self->{_data}{'name'      } = $properties->{name} || $self->{_data}{name} || $self->session->user->username." / ".$self->session->datetime->epochToHuman()." (Autotag)";
+    #AMH: In case of site wide version tag, mark it as Site wide autotag instead
-	$self->{_data}{'workflowId'} = $properties->{workflowId} || $self->{_data}{workflowId} || $self->session->setting->get("defaultVersionTagWorkflow");
+    my $isSiteWide = $properties->{isSiteWide} || $self->{_data}{isSiteWide} || 0;
-	$self->{_data}{'groupToUse'} = $properties->{groupToUse} || $self->{_data}{groupToUse} || "12";
+
-    
+    $self->{_data}{'name'      } = $properties->{name} || $self->{_data}{name} || $self->session->user->username." / ".$self->session->datetime->epochToHuman().($isSiteWide ? q{ (Site wide autotag)} : q{ (Autotag)});
+    $self->{_data}{'workflowId'} = $properties->{workflowId} || $self->{_data}{workflowId} || $self->session->setting->get("defaultVersionTagWorkflow");
+    $self->{_data}{'groupToUse'} = $properties->{groupToUse} || $self->{_data}{groupToUse} || "12";
+
     #This is necessary for upgrade prior to 7.5.11 in order to ensure that this field exists.
     #The if() blocks should be removd once the next branch point is reached.
     my $assetVersionTagDesc = $self->session->db->buildHashRef('describe assetVersionTag');
@@ -572,15 +673,22 @@ sub set {
         $self->{_data}{'startTime' } = $properties->{startTime} || $self->{_data}{startTime} || $startTime;
         $self->{_data}{'endTime'   } = $properties->{endTime} || $self->{_data}{endTime} || $endTime;
     }
-	if (exists $properties->{comments}) {
+
-		$self->{_data}{comments}=$self->session->datetime->epochToHuman.' - '.$self->session->user->username
+    #AMH: new field isSiteWide is added. Check if field exists. This is needed to let upgrades work
-                                ."\n"
+    if (grep { $_ =~ /^isSiteWide/ } keys %{$assetVersionTagDesc}) {
-                                .$properties->{comments}
+
-                                ."\n\n"
+        $self->{_data}{'isSiteWide'} = $isSiteWide;
-				.$self->{_data}{comments};
+    }
-	}
+
-	$self->session->db->setRow("assetVersionTag","tagId",$self->{_data});
+    if (exists $properties->{comments}) {
-}
+        $self->{_data}{comments}=$self->session->datetime->epochToHuman.' - '.$self->session->user->username
+            ."\n"
+            .$properties->{comments}
+            ."\n\n"
+            .$self->{_data}{comments};
+    }
+    $self->session->db->setRow("assetVersionTag","tagId",$self->{_data});
+} #set
 
 #-------------------------------------------------------------------
 

lib/WebGUI/i18n/English/WebGUI.pm

@@ -4141,6 +4141,30 @@ LongTruncOk=1</p>
         context     => q{Column heading for the total logged in time for the user},
     },
 
+
+        #AMH: Support for versionTagMode.
+        'version tag mode' => {
+            message => q{Version tag mode},
+        },
+        'version tag mode help' => {
+            message => q{Version tag mode help...TODO},
+        },
+        'versionTagMode multiPerUser' => {
+            message => q{Multi version tags per user},
+        },
+        'versionTagMode singlePerUser' => {
+            message => q{Single version tag per user},
+        },
+        'versionTagMode siteWide' => {
+            message => q{One site wide version tag},
+        },
+        'versionTagMode autoCommit' => {
+            message => q{Commit automatically},
+        },
+        'versionTagMode inherited' => {
+            message => q{Inherit from site settings},
+        },
+
 };
 
 1;