#!/usr/bin/ruby #-- #------------------------------------------------------------------------------- #++ # #= Introduction # #== Name: checktype.rb # #== Author: Tony Smith <tony@perforce.com> # #== Description # # Example trigger to enforce a rule "files of suffix .x need # to be added as type Z". (For example, ".jpg" files must # always be "binary" and ".sh" files should always be "text".) # # This script is mostly a reimplentation of Jeff Bowles # and Wed Peters' Perl binary.pl using P4Ruby but it uses # a more generalised trigger execution framework to make # it easier to concentrate on the nuts and bolts of what # your trigger does. # #== Requires # Ruby # P4Ruby # P4Triggers module # #== Example 'triggers' section: # # Note: since this is applicable to only filenames with certain suffixes, # you might want to restrict the trigger to run when those files are # submitted. So, if this is looking at .cpp/.h/.txt/.html lines, you might # want to have it run only on those files.) # # Triggers: # exampleA change-submit //.../*.jpg "ruby checktype.rb %changelist%" # exampleB change-submit //.../*.bmp "ruby checktype.rb %changelist%" # exampleC change-submit //.../*.sh "ruby checktype.rb %changelist%" # #== Note # # For triggers I recommend you use a P4CONFIG file rather than hard coding # username/password in the script itself. This script assumes you've taken # that advice. # # == License # # Copyright (c) 1997-2008, Perforce Software, Inc. All rights reserved. # # 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. # #-- #------------------------------------------------------------------------------- #++ $:.unshift( File.dirname( __FILE__ ) ) require "P4" require "P4Triggers" # # These are the file extensions and the Perforce types we want to # enforce. For each one we specify a regular expression for matching # the valid filetypes for the extension and a corresponding textual # description of the match (so we can tell the user what we're looking # for. # TYPEMAP = Hash.new TYPEMAP[ "bmp" ] = FileType.new( /.*binary/, "binary/ubinary" ) TYPEMAP[ "doc" ] = FileType.new( /.*binary/, "binary/ubinary" ) TYPEMAP[ "exe" ] = FileType.new( /.*binary/, "binary/ubinary" ) TYPEMAP[ "gif" ] = FileType.new( /.*binary/, "binary/ubinary" ) TYPEMAP[ "html"] = FileType.new( /ktext/, "ktext" ) TYPEMAP[ "jpg" ] = FileType.new( /.*binary/, "binary/ubinary" ) TYPEMAP[ "ppt" ] = FileType.new( /.*binary/, "binary/ubinary" ) TYPEMAP[ "sh" ] = FileType.new( /k?xtext/, "xtext/kxtext" ) # # The trigger class itself. The main method in here is validate() which # is invoked from the super-class' parse_change() method. # class TypeTrigger < P4Trigger def initialize( max_errors ) @max_errors = max_errors super() end # # The error message we give to the user # @@USER_MESSAGE = "\n\n" + "Your submission has been rejected because the following files\n" + "had incorrect types\n\n" # The printf() style format string used for each of the bad file # entries @@BADFILE_FORMAT= " %s: was %s, should be %s\n" # Method to return the expected filetype given a filename. Returns # nil if no specific filetype has been mandated. def filetype( depot_file ) ext = depot_file.sub( /.*\.(.*)/, '\1' ) ext = ext.downcase TYPEMAP[ ext ] end # Enforce type checking. Basic algorithm is that we iterate over # the typemap and match each extension against the depot file. If # they match, we check the type. def validate() # First gather the list of bad files badlist = Array.new change.each_file do |file| # Ignore files not open for add next unless ( file.revisions[ 0 ].action == "add" ) type = filetype( file.depot_file ) next unless type basetype = file.revisions[ 0 ].type.sub( /\+.*/, "" ) if ( ! type.match( basetype ) ) badlist.push( file ) end end # Now report any problems to the user report( badlist ) if ( ! badlist.empty? ) return badlist.empty? end # Method to report the error to the user. Just formats the error # message and sends it. We only report the first @max_errors # bad files. On a large changelist they'll be grateful for that. def report( badfiles ) errors = 0 msg = @@USER_MESSAGE badfiles.each do |file| type = filetype( file.depot_file ) msg += sprintf( @@BADFILE_FORMAT, file.depot_file, file.revisions[ 0 ].type, type.msg ) errors += 1 break if ( errors >= @max_errors ) end message( msg ) end end #-- #------------------------------------------------------------------------------- # Start of main script execution #------------------------------------------------------------------------------- #++ # By this stage it's pretty simple. Even argument validation is handled by # the p4Trigger class so we don't even need to check that we were passed # a changelist number. tt = TypeTrigger.new( 10 ) exit( tt.parse_change( ARGV.shift ) )
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#3 | 6437 | Tony Smith |
Update P4Ruby Library scripts to support Perforce P4Ruby 2007.3 rather than my old public depot P4Ruby. |
||
#2 | 3637 | Tony Smith | Add RDoc documentation to the sample triggers. | ||
#1 | 3634 | Tony Smith |
Kick off a library of P4Ruby resources with some sample trigger implementations based on Jeff Bowles and Wes Peters' scripts. These are not strict ports of their scripts to P4Ruby, but are roughly in the same area. |