#!/bin/bash #============================================================================== # Copyright and license info is available in the LICENSE file included with # the Server Deployment Package (SDP), and also available online: # https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/LICENSE #------------------------------------------------------------------------------ set -u # p4login generates a login ticket for the SDP super user. It is called # from cron scripts, and so does not normally generate output to stdout or # stderr. # # Normally output (stdout and stderr) is logged in $LOGS/p4login.log, # unless unless SDP_INSTANCE isn't defined, in which case it bails # immediately. # # An exit code of 0 indicates a valid login ticket exists, while a # non-zero exit code indicates a failure to login. export SDP_INSTANCE=${SDP_INSTANCE:-Undefined} export SDP_INSTANCE=${1:-$SDP_INSTANCE} if [[ $SDP_INSTANCE == Undefined ]]; then echo "Instance parameter not supplied." echo "You must supply the Perforce instance as a parameter to this script." exit 1 fi . /p4/common/bin/p4_vars $SDP_INSTANCE declare -i SDP_ALWAYS_LOGIN=${SDP_ALWAYS_LOGIN:-1} declare DateFormat='%a %Y-%m-%d %H:%M:%S %Z' declare Cmd= function bail () { echo -e "\nError: ${1:-Unknown Error}"; exit ${2:-1}; } [[ $SDP_INSTANCE == Undefined ]] && bail "Error: SDP_INSTANCE not defined." declare TicketExpiration=$($P4BIN -ztag -F %TicketExpiration% -p $P4PORT -u $P4USER login -s 2>/dev/null) declare Log=$LOGS/p4login.log echo "$(date +'%a %Y-%m-%d %H:%M:%S %Z'): Checking login status." > $Log if [[ $TicketExpiration =~ [0-9]+ ]]; then # A 'long-term' ticket is one that expires more than a month (31 days + 1 second) from now. if [[ $TicketExpiration -ge 2678401 ]]; then echo "$(date +'%a %Y-%m-%d %H:%M:%S %Z'): Verified: User $P4USER logged into $P4PORT with a long-term ticket. Login not required." >> $Log if [[ $SDP_ALWAYS_LOGIN -eq 1 ]]; then echo "Doing login anyway as SDP_ALWAYS_LOGIN is enabled." >> $Log Cmd="$P4BIN -p $P4PORT -u $P4USER -s login -a" echo Running: $Cmd >> $Log $Cmd < /p4/common/bin/adminpass >> $Log 2>&1 fi exit 0 else echo "$(date +'%a %Y-%m-%d %H:%M:%S %Z'): Warning: User $P4USER logged into $P4PORT with a short-term ticket. Attempting to extend." >> $Log Cmd="$P4BIN -p $P4PORT -u $P4USER -s login -a" echo Running: $Cmd >> $Log $Cmd < /p4/common/bin/adminpass >> $Log 2>&1 exit $? fi else echo "$(date +'%a %Y-%m-%d %H:%M:%S %Z'): Warning: User $P4USER is not logged into $P4PORT. Attempting to login." >> $Log Cmd="$P4BIN -p $P4PORT -u $P4USER -s login -a" echo Running: $Cmd >> $Log $Cmd < /p4/common/bin/adminpass >> $Log 2>&1 exit $? fi
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#5 | 25113 | Robert Cowham | Merge latest changes from dev | ||
#4 | 23205 | Robert Cowham | Merged all changes from dev to test | ||
#3 | 22142 | Robert Cowham | Merge in latest changes from Dev | ||
#2 | 20726 | Robert Cowham | Catch up from dev | ||
#1 | 18586 | Robert Cowham | Branching using cowhamr.sdp.dev | ||
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/p4login | |||||
#7 | 18209 | Russell C. Jackson (Rusty) |
Added missing auto source of p4_vars to eliminate the need to use p4master_run. Missed in early changes to support that behavior. |
||
#6 | 16029 | C. Thomas Tyler |
Routine merge to dev from main using: p4 merge -b perforce_software-sdp-dev |
||
#5 | 15605 | C. Thomas Tyler |
Per review, Rusty noted a preference for the current behvaior, i.e. always doing a login if p4login is called. This version introduces SDP_ALWAYS_LOGIN, which defaults to 1 (enabled), which preserves the traditional 'always login each time the script is run' behavior, while allowing the new 'login only if a ticket is not available' behavior. (An advantage of the traditional behavior is that it fixes the case where a human admin does a 'p4 login' but forgets the '-a' on a server a network card configuration setup such that 'p4 login -a' is required). Customers desiring the 'login only if required' can set SDP_ALWAYS_LOGIN=0 in p4_vars. Also includes style improvements. #review-15606 |
||
#4 | 15559 | C. Thomas Tyler |
Enhancements to p4login: * Enhanced handling for the cose where p4login is run with no environment defined. * Now checks login status first, and only does a login if ticket expires in less than a month. * Enhanced auditability. * Added comments. #review-15560 |
||
#3 | 13906 | C. Thomas Tyler |
Normalized P4INSTANCE to SDP_INSTANCE to get Unix/Windows implementations in sync. Reasons: 1. Things that interact with SDP in both Unix and Windows environments shoudn't have to account for this obscure SDP difference between Unix and Windows. (I came across this doing CBD work). 2. The Windows and Unix scripts have different variable names for defining the same concept, the SDP instance. Unix uses P4INSTANCE, while Windows uses SDP_INSTANCE. 3. This instance tag, a data set identifier, is an SDP concept. I prefer the SDP_INSTANCE name over P4INSTANCE, so I prpose to normalize to SDP_INSTANCE. 4. The P4INSTANCE name makes it look like a setting that might be recognized by the p4d itself, which it is not. (There are other such things such as P4SERVER that could perhaps be renamed as a separate task; but I'm not sure we want to totally disallow the P4 prefix for variable names. It looks too right to be wrong in same cases, like P4BIN and P4DBIN. That's a discussion for another day, outside the scope of this task). Meanwhile: * Fixed a bug in the Windows 2013.3 upgrade script that was referencing undefined P4INSTANCE, as the Windows environment defined only SDP_INSTANCE. * Had P4INSTANCE been removed completely, this change would likely cause trouble for users doing updates for existing SDP installations. So, though it involves slight technical debt, I opted to keep a redundant definition of P4INSTANCE in p4_vars.template, with comments indicating SDP_INSTANCE should be used in favor of P4INSTANCE, with a warning that P4INSTANCE may go away in a future release. This should avoid unnecessary upgrade pain. * In mkdirs.sh, the varialbe name was INSTANCE rather than SDP_INSTANCE. I changed that as well. That required manual change rather than sub/replace to avoid corrupting other similar varialbe names (e.g. MASTERINSTANCE). This is a trivial change technically (a substitute/replace, plus tweaks in p4_vars.template), but impacts many files. |
||
#2 | 12169 | Russell C. Jackson (Rusty) |
Updated copyright date to 2015 Updated shell scripts to require an instance parameter to eliminate the need for calling p4master_run. Python and Perl still need it since you have to set the environment for them to run in. Incorporated comments from reviewers. Left the . instead of source as that seems more common in the field and has the same functionality. |
||
#1 | 10638 | C. Thomas Tyler | Populate perforce_software-sdp-dev. | ||
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/p4login | |||||
#1 | 10148 | C. Thomas Tyler | Promoted the Perforce Server Deployment Package to The Workshop. |