P4Transfer.py #4

#!/usr/bin/python
#
# Copyright (c) 2011 Sven Erik Knop, Perforce Software Ltd
#
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are 
# met:
# 
# 1.  Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
# 
# 2.  Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the 
#     distribution.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE 
# SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#
# P4Transfer.py
#
# This python script will provide the means to update a local server 
# with the data of a master server and allow users to work against
# their local server offline (hence the name). 
# When reconnecting, use this script to update the master server
# with all changes including their history.
#
# In order to work without conflicts, users will need a private 
# branch on the master server. It is also necessary that changes 
# on the master server whilst online are replicated to the local 
# server, for example via a trigger. If both master and local server
# are out of sync, this script will cease to function and needs to be 
# reset.
#
# The script requires a config file, normally called transfer.cfg, 
# that provides the Perforce connection information for both master
# and local server. The script also needs a directory in which
# it can place the mapped files. This directory has to be the root
# of both the master and the local workspace (this will be verified).
#
# The config file has two sections: [main] and [local].
# Each section takes the following parameters:
#    P4PORT
#    P4CLIENT
#    P4USER
#    COUNTER
#    P4PASSWD (optional)
#
# The counter represents the last transferred change number and must
# be initialized with a base change.
#
# usage: 
#
# python P4Transfer.py [options]
#
#   options:
#             -c configfile
#             --config configfile
#                             specifies the configfile to use (default offline.cfg)
#
#             -n
#                             do not replicate, only show what would happen
#
#             -i
#             --ignore        replace integrations by adds and edits
#
#             -v
#             --verbose
#                             verbose mode
#
# (more too follow, undoubtedly)
#
# $Id: //guest/sven_erik_knop/P4Pythonlib/scripts/P4Transfer.py#4 $

import sys
from P4 import P4, P4Exception

if sys.version_info[0] >= 3:
  from configparser import ConfigParser
else:
  from ConfigParser import ConfigParser
  
from getopt import getopt, GetoptError
import os.path

class Options:
  configfile = 'transfer.cfg'
  preview = ''
  verbose = False
  ignore = False

  def __init__(self):
    pass
    
class ChangeRevision:
  def __init__(self, r, a, t, d):
    self.rev = r
    self.action = a
    self.type = t
    self.depotFile = d
    self.localFile = None
    
  def setIntegrationInfo(self, integ):
    self.integration = integ
  
  def setLocalFile(self, localFile):
    self.localFile = localFile

  def __str__(self):
    return "rev = %s action = %s type = %s depotFile = %s" % (self.rev, self.action, self.type, self.depotFile)
  
class P4Config:
  section = None
  P4PORT = None
  P4CLIENT = None
  P4USER = None
  P4PASSWD = None
  COUNTER = None
  counter = 0
  
  def __init__(self, section, options):
    self.section = section
    self.myOptions = options
    
  def __str__(self):
    return "[section = %s P4PORT = %s P4CLIENT = %s P4USER = %s P4PASSWD = %s COUNTER = %s]" % \
        (self.section, self.P4PORT, self.P4CLIENT, self.P4USER, self.P4PASSWD, self.COUNTER)
  
  def connect(self, progname):
    self.p4 = P4()
    
    self.p4.port = self.P4PORT
    self.p4.client = self.P4CLIENT
    self.p4.user = self.P4USER
    self.p4.prog = progname
    self.p4.exception_level = P4.RAISE_ERROR
    
    self.p4.connect()
    if not self.P4PASSWD == None:
      self.p4.password = self.P4PASSWD
      self.p4.run_login()

    clientspec = self.p4.fetch_client(self.p4.client)
    self.root = clientspec._root
    self.p4.cwd = self.root
    
  def disconnect(self):
    self.p4.disconnect()

  def verifyCounter(self):    
    change = self.p4.run_changes("-m1", "...")
    self.changeNumber = int(change[0]['change']) if change else 0
    return self.counter < self.changeNumber
  
  def missingChanges(self):
    changes = self.p4.run_changes("-l", "...@%d,#head" % (self.counter + 1))
    changes.reverse()
    return changes

  def resetWorkspace(self):
    self.p4.run_sync("...#none")
  
  def getChange(self, change):
    """Expects change number as a string"""
    
    self.p4.run_sync("-f", "...@%s,%s" % (change, change))
    change = self.p4.run_describe(change)[0]
    files = []
    for n, rev in enumerate(change['rev']):
      # 'p4 where' tests if the file is mapped to this workspace
      where = self.p4.run_where(change['depotFile'][n])
      if len(where) > 0:
        chRev = ChangeRevision(rev, change['action'][n], change['type'][n], change['depotFile'][n])
        files.append(chRev)
        
        localFile = where[0]['path']
        chRev.setLocalFile(localFile)
        
        if( chRev.action in ('branch', 'integrate', 'add' ) ):
          depotFile = self.p4.run_filelog( "-m1", "%s#%s" % (chRev.depotFile, chRev.rev) )[0]
          revision = depotFile.revisions[0]
          if len(revision.integrations) > 0:
            integration = revision.integrations[0]
            chRev.setIntegrationInfo( integration )
            
            where = self.p4.run_where( integration.file )
            integration.localFile = where[0]['path'] if len(where) > 0 else None

        if( chRev.action == 'move/add' ):
          depotFile = self.p4.run_filelog( "-m1", "%s#%s" % (chRev.depotFile, chRev.rev) )[0]
          revision = depotFile.revisions[0]
          integration = revision.integrations[0]
          chRev.setIntegrationInfo( integration )

          where = self.p4.run_where( integration.file )
          integration.localFile = where[0]['path'] if len(where) > 0 else None
    
    return files
    
  
  def checkWarnings(self, where):
    if (self.p4.warnings):
          print( "warning in ", where, " : ", self.p4.warnings )
          
  def replicateChange(self, files, change, sourcePort):
    """This is the heart of it all. Replicate all changes according to their description"""
    
    for f in files:
      print( f )
      
      if self.myOptions.preview == '':
          if f.action == 'edit':
            self.p4.run_sync('-k', f.localFile)
            self.p4.run_edit('-t', f.type, f.localFile)
            self.checkWarnings('edit')
            
          elif f.action == 'add':
            if 'integration' in f.__dict__:
              self.replicateBranch( f, True ) # dirty branch
            else:
              self.p4.run_add('-t', f.type, f.localFile)
              self.checkWarnings('add')
            
          elif f.action == 'delete':
            self.p4.run_delete('-v', f.localFile)
            self.checkWarnings('delete')
            
          elif f.action == 'purge':
            
            # special case. Type of file is +S, and source.sync removed the file
            # create a temporary file, it will be overwritten again later
            
            dummy = open(f.localFile, 'w')
            dummy.write('purged file')
            dummy.close()
            self.p4.run_sync('-k', f.localFile)
            self.p4.run_edit('-t', f.type, f.localFile)
            if self.p4.warnings:
              self.p4.run_add('-t', f.type, f.localFile)
              self.checkWarnings('purge -add')
              
          elif f.action == 'branch':
            self.replicateBranch( f, False )
            self.checkWarnings('branch')
            
          elif f.action == 'integrate':
            self.replicateIntegration( f )
            self.checkWarnings('integrate')
    
          elif f.action == 'move/add':
            self.move( f )
    
    opened = self.p4.run_opened()
    if len(opened) > 0:
      description = change['desc'] + "\n\nTransferred from p4://%s@%s" % ( sourcePort, change["change"] ) 
      result = self.p4.run_submit('-d', description)
      # the submit information can be followed by resfreshFile lines
      # need to go backwards to find submittedChange
      a = -1
      while 'submittedChange' not in result[a]:
        a -= 1
      return result[a]['submittedChange']
    else:
      return None	
      
  def replicateBranch( self, file, dirty ):
    if self.myOptions.ignore == False and file.integration.localFile:
      self.p4.run_integrate('-v', file.integration.localFile, file.localFile)
      if dirty:
        self.p4.run_edit( file.localFile )
    else:
      self.p4.run_add('-t', file.type, file.localFile)
      
    
  def replicateIntegration( self, file ):
    if file.integration.how in ('copy from', 'ignored', 'merge from'):
      if self.myOptions.ignore == False and file.integration.localFile:
        self.p4.run_integrate(file.integration.localFile, file.localFile)
        if file.integration.how == 'copy from':
          self.p4.run_resolve("-at")
        elif file.integration.how == 'ignored':
          self.p4.run_resolve('-ay')
        elif file.integration.how == 'merge from':
          self.p4.run_edit(file.localFile) # to overcome tamper check
          self.p4.run_resolve('-am')
        else:
          print( "Cannot deal with ", file.integration )
      else:
        self.p4.run_edit(file.localFile)
        
    else:
      print( "not working yet : ", file.integration )
    
  def move( self, file ):
    source = file.integration.localFile
    self.p4.run_sync( '-f', source )
    self.p4.run_edit( source )
    self.p4.run_move( '-k', source, file.localFile )

class P4Transfer:
  myOptions = Options()
  
    
  def usage(self):
    print( """
    Usage:
      -c --config       Specify Configfile
      -n                Report mode
      -v --verbose  
      -h --help         This output
      -i --ignore       Ignores integration and replaces it by adds or edits
    """ )
    
  def __init__(self, *argv):
    try:
      options, args = getopt(argv, "c:nvhi", ["help", "ignore", "verbose", "config="])
      for option, argument in options:
        if option == '-n':
          self.myOptions.preview = '-n'
        elif option in ('-c', '--config') :
          self.myOptions.configfile = argument
        elif option in ('-v', '--verbose'):
          self.myOptions.verbose = True
        elif option in ('-i', '--ignore'):
          self.myOptions.ignore = True
        elif option in ('-h', '--help'):
          self.usage()
          sys.exit()
    except GetoptError:
          self.usage()
          sys.exit(1)

  def readConfig( self ):
    self.parser = ConfigParser()
    self.myOptions.parser = self.parser # for later use
    try:
      self.parser.readfp( open( self.myOptions.configfile) )
    except:
      print( "Could not read %s" % self.myOptions.configfile )
      sys.exit(2)
    
    self.master = P4Config('master', self.myOptions)
    self.local = P4Config('local', self.myOptions)
    
    self.readSection(self.master)
    self.readSection(self.local)
    
    print( "master = %s" % self.master )
    print( "local = %s" % self.local )
    
  def writeConfig( self ):
  	with open(self.myOptions.configfile, 'w') as f:
  		self.parser.write( f )
  
  def readSection( self, p4config ):
    if self.parser.has_section(p4config.section):
      self.readOptions(p4config)
    else:
      print( "Config file needs section %s" % p4config.section )
      sys.exit(3)
  
  def readOptions(self, p4config):
    self.readOption("P4CLIENT", p4config)
    self.readOption("P4USER", p4config)
    self.readOption("P4PORT", p4config)
    self.readOption("COUNTER", p4config)
    self.readOption("P4PASSWD", p4config, optional = True)
    
  def readOption(self, option, p4config, optional = False):
    if self.parser.has_option(p4config.section, option):
      p4config.__dict__[option] = self.parser.get(p4config.section, option)
    elif not optional:
      print( "Required option %s not found in section %s" % (option, p4config.section) )
      sys.exit(1)
  
  def setCounter( self, section, value ):
    """Sets the counter to value. Value must be a string"""
    self.parser.set( section, 'COUNTER', value )
    
  #
  # This is the central method
  # It provides the replication process
  # Algorithm:
  #   Read the config file
  #   Connect to master and server
  #   Determine if counter is there
  
  def replicate(self):
    """Central method that performs the replication between master and local"""
    
    print( "Configfile = %s" % (self.myOptions.configfile) )
    self.readConfig()
    
    self.master.connect("master replicate")
    self.local.connect("local replicate")
    
    print( "master = %s" % self.master.p4 )
    print( "local = %s" % self.local.p4 )
    
    # determine which version is newer
    
    self.master.counter = int( self.master.COUNTER )
    self.local.counter = int( self.local.COUNTER )
    
    mv = self.master.verifyCounter()
    lv = self.local.verifyCounter()
    
    source = None
    target = None
    
    if mv and not lv:
      print( "Replicate from master to local." )
      source = self.master
      target = self.local
    elif lv and not mv:
      print( "Replicate from local to master." )
      source = self.local
      target = self.master
    elif lv and mv:
      print( "Both sides out of sync. Giving up." )
      sys.exit(4)
    else:
      print( "Nothing to do." )
      sys.exit(0)
    
    if not source.root == target.root:
      print( "master and local workspace root directories must be the same" )
      sys.exit(5)
    
    source.resetWorkspace()
    
    for change in source.missingChanges():
      print( "Processing : ", change['change'], change['desc'] )
      files = source.getChange(change['change'])
      resultedChange = target.replicateChange(files, change, source.p4.port)
      if resultedChange:
        self.setCounter(source.section, (change['change']))
        self.setCounter(target.section, resultedChange)
        self.writeConfig()
    
    source.disconnect()
    target.disconnect()
  
if __name__ == '__main__':
  prog = P4Transfer(*sys.argv[1:])
  prog.replicate()