Release Notes for P4Ruby, Perforce's script API for Ruby Version 2024.1 Introduction This document lists all user-visible changes to P4Ruby from release 2007.3, the first supported P4Ruby release. Perforce numbers releases YYYY.R/CCCCC, e.g. 2002.1/30547. YYYY is the year; R is the release of that year; CCCCC is the bug fix change level. Each bug fix in these release notes is marked by its change number. Any build includes (1) all bug fixes of all previous releases and (2) all bug fixes of the current release up to the bug fix change level. Precompiled versions of P4Ruby are built against a corresponding version of the Perforce C++ API, e.g., P4Ruby 2024.1 will be compiled using a 2024.1 version of the P4API. You can always install P4Ruby using a source-only variation, selecting a specific version of the P4API. To determine the version of your P4Ruby, and which version of the P4API it has been built with, issue the following command: ruby -rP4 -e "puts P4.identify" -------------------------------------------------------------------------- Installation The recommended method of installing P4Ruby is via gems. Outside of Windows, p4ruby gem installs must be compiled locally against your installation of Ruby. If you can build the core Ruby distribution locally, you likely can install P4Ruby without incident. On Windows, precompiled gems will be made available. The main command to install P4Ruby is via gem or bundle. gem install p4ruby Alternatively, you can use Bundler (http://bundler.io). In your Gemfile, specify gem 'p4ruby', '~> 2020.1' And then execute: bundle --with-p4api-dir=DIR -------------------------------------------------------------------------- Building P4Ruby from Source The official version of P4Ruby exists as source on: https://github.com/perforce/p4ruby Instructions for building are in the BUILD.md file which can be found here - https://github.com/perforce/p4ruby/blob/master/build.md -------------------------------------------------------------------------- Compatibility Statements Server Compatibility This release of P4Ruby supports the 2024.1 Perforce Server. Older releases might work but are not supported. API Compatibility This release of P4Ruby supports the 2024.1 Perforce API (2024.1/2625008). Older releases might work but are not supported. Ruby Compatibility This release of P4Ruby is supported on Ruby versions 3.0, 3.1 and 3.2 For detailed compatibility, please check the following table: Ruby Release | P4Ruby Release =================================== 3.0 | 2021.1 or later 3.1 | 2022.1 or later 3.2 | 2023.1 or later OpenSSL Compatibility To build P4Ruby with encrypted communication support, you must use the version of OpenSSL that Perforce C/C++ API has been built against. Beginning with the 2017.1 release of the Helix C/C++ API, the dependency on OpenSSL is now enforced and the SSL stub library has been removed. Executables linked against the P4API libraries must also be linked against real OpenSSL libraries: The latest 3.0.x or 1.1.1 patch is recommended Platform Compatibility While P4Ruby is generally portable, this release is certified only on the following platforms: Linux kernel 2.6+ (glibc 2.6+) for Intel(x86_64) Linux kernel 2.6+ (glibc 2.17+) for ARM(aarch64) Windows 10 for Intel(x64) Windows 11 for Intel(x64) Windows Server 2016 for Intel(x64) Windows Server 2019 for Intel(x64) Windows Server 2022 for Intel(x64) Compiler Compatibility To build P4Ruby from source, you must use a version of Ruby that has been compiled with the same compiler used to build the Perforce C++ API: for most platforms, use gcc/g++. Attempting to use a different compiler or a different version of the compiler causes linker errors due to differences in name handling between compilers. Known Limitations The Perforce client-server protocol is not designed to support multiple concurrent queries over the same connection. For this reason, multi-threaded applications using the C++ API or the script APIs (P4Perl, P4Ruby, etc.) should ensure that a separate connection is used for each thread or that only one thread may use a shared connection at a time. -------------------------------------------------------------------------- Key to symbols used in change notes below. * -- requires new P4Ruby ** -- requires P4Ruby built with new P4API *** -- requires new p4d server program -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2024.1 Patch 1 (2024.1/2660526) (2024/10/01) #2655534 (Job #121771) ** Added support for mingw64x86. #2648361 (Job #121772) * ** Added build support for Linux ARM64/AARCH64 architecture. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2024.1 (2024.1/2627586) (2024/07/22) #2599293 (Job #120161) * ** *** This release of P4Ruby supports P4API 2024.1 (2024.1/2625008) Bugs fixed in 2024.1 (2024.1/2627586) (2024/07/22) #2585619 (Job #119223) * ** The condition in the set_attribute function has been corrected to return the expected data type. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2023.2 (2023.2/2548030) (2024/01/26) #2545341 (Job #118227) * ** *** This release of P4Ruby supports P4API 2023.2 (2023.2/2519561) -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2023.1 Patch 1 (2023.1/2544327) (2024/01/19) (Job #118834) * ** This release is built against P4API (2023.1/2513900) to address possible vulnerability: CVE-2023-5759. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2023.1 (2023.1/2446234) (2023/05/25) #2443839 (Job #115709) * ** *** This release of P4Ruby supports P4API 2023.1 (2023.1/2442900). #2443217, #2438303 (Job #115281) * Added support for Ruby 3.2. #2439606 (Job #2439606) * ** Windows gems for P4Ruby are now shipped with OpenSSL 3.0.8 -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2022.1 Patch 2 (2022.1/2405581) (2023/02/10) Important security note This version addresses vulnerabilities in OpenSSL (CVE-2023-0286, CVE-2023-0215, CVE-2022-4450, CVE-2022-4304) by linking in version 1.1.1t of the library. -------------------------------------------------------------------------- -------------------------------------------------------------------------- Bugs fixed in 2022.1 Patch 1 (2022.1/2368511) (2022/11/10) (Job #113209) * ** Correct the handling of untranslated text left in the compression buffer on Close(). Build only change. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2022.1 (2022.1/2359956) (2022/10/26) #2356959 (Job #111079) * ** Added support for Ruby 3.1. #2299589 (Job #111080) * ** *** Updated the stored spec templates to match the 2022.1 Helix Server specs. Bugs fixed in 2022.1 (2022.1/2359956) (2022/10/26) (Job #110752) * ** Obliterating multiple streams no longer fails with locking error. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2021.1 Patch 2 (Job #109913 ) * *** Windows and Mac builds have updated version of OpenSSL(1.1.1n), to address possible vulnerability: CVE-2022-0778. Linux builds are not affected. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2021.1 Patch 1 #2187837 (Job #108007) * ** Added callback based SSO handler. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2021.1 #2148269 #2148274 (Job #107105) * ** Added support for Ruby 3.0. #2150156 (Job #107245) * ** *** Updated the stored spec templates to match the 2021.1 Helix Server specs. #2152769 (Job #102878) * ** Added support for source gems build on MacOS #2152247 (Job #107205) * ** *** Added support for Stream comments. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2020.1 Patch 1 (Job #104855) * *** Windows builds have updated version of OpenSSL(1.1.1i), to address possible vulnerability: CVE-2015-0288. Linux builds are not affected. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2020.1 #1966018 (Job #102615) * ** Added support for Ruby 2.7. #1956729 (Job #102178) * ** *** Updated the stored spec templates to match the 2020.1 Helix Server specs. #1950587 (Job #101453) * ** Added detection of OpenSSL version during gem install, for fetching correct P4API from Perforce FTP site. Bugs fixed in 2020.1 #1948116 (Job #101594) * ** Fixed compilation error for P4Ruby on Ubuntu 16.04. #1958940 (Job #101595) * ** Fixed issue when calling reset on Centos8 build would crash P4Ruby. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2019.1 #1863109 (Job #100275) ** Added support for ruby 2.5 & 2.6. #1849815 (Job #100274) *** The 2019.1 release of P4Ruby supports the 2019.1 Perforce API. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2017.1 # (SIR#96305/ P4RUBY-214) Add get/set trust file location to api # (SIR#93993 / P4RUBY-206) Add a reset() method for resetting p4 client data (messages, output, etc.) between calls to run # (SIR#92235 / P4RUBY-204) Support graph depot commands -------------------------------------------------------------------------- -------------------------------------------------------------------------- Issues addressed in 2015.2.1313860 #1313860 Update to OpenSSL 1.0.1q. Only affects the precompiled gems, which are only available to the Windows gems. New functionality in 2015.2 # (SIR#78548 / P4RUBY-193) Release native P4Ruby gems for x86-mingw32 and x64-mingw32. Until this point, the only source gems have been available. These gems will allow Windows users for 32 or 64-bit Ruby 2.0, 2.1 or 2.2 to easily install P4Ruby. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2014.2 # (SIR#28879 / P4RUBY-25) Release P4Ruby as Gem. Until this point, the gems available on rubygems.org were unofficial builds, and prone to fail in non-interactive environments like bundler. # (SIR#75097 / P4RUBY-169) Add `enviro_file` property to P4 object, which underneath, uses the new `SetEnviroFile`/`GetEnviroFile` mechanism from the 14.2 C++ API. Changes in 2014.2.0.pre6 * Documented workarounds to installation failures on the OS X default Ruby installation. Changes in 2014.2.0.pre5 * Fixed an issue where using the --with-p4api-dir option to gem install would not actually set up the include and lib compilation directory correctly. * No longer distributing precompiled builds for linux or OS X due to inadequate information from gem to match the Ruby distribution correctly. * No longer embedding the C++ P4API to keep the total file size down to allow the gem to be distributed via RubyGems.org. * Changed logic to call p4.charset=nil if charset is already nil or resolves to 'none'. Internally, this will trigger a call to ClientApi::SetTrans(0), which should disable character set autodetection. Bugs fixed in 2014.2.0.pre4 * (JOB#77207 / P4RUBY-176) If the user has specified 'P4CHARSET=none' in a configuration file, or has not set p4.charset='auto' (and it's default value was initialized to 'none' by the C++ API), automatically disable character set detection. This can cause the API to break when connecting to non-unicode servers even though it appears to be configured to not be a unicode client. * The default C++ API version should be included with the gem source, to avoid calls to ftp.perforce.com. Bugs fixed in 2014.2.0.pre3 * (JOB#75096 / P4RUBY-168) Spec mappings updated to 14.2 definitions. * (TASK#76795 / P4RUBY-176) Configuring pre-compiled gems for Linux and OS X, for supported Ruby versions (2.0, 2.1, 2.2). Bugs fixed in 2014.2.0.pre2 # (JOB#76321 / P4RUBY-171) `gem install` fails using source gem distribution inside of a Docker environment due to passive FTP mode not enabled early enough. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2014.1 # 807216 (SIR#70070) * *** P4Ruby now supports the P4IGNORE file feature introduced in the 2013.2 server. Three new methods have been added to support this functionality: P4#ignore_file - Report current file P4#ignore_file= - Set ignore file P4#ignored?( ) - Test if is ignored # 807216, 750979 (SIR#70093) * P4Ruby now supports the Ruby 2.0 series of rubies. Bugs fixed in 2013.1 #733921 (Job#63887) * P4Ruby no longer crashes when an exception is raised from the block passed to P4#run_resolve. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2012.2 #525301 (Job #59803) * P4Ruby now supports Apple Mountain Lion (10.8). #509253 (Job #56480) * Added P4#run_tickets() method to list local tickets. Note that P4.run('tickets') still gives the old error message "Must upgrade to 2004.2 p4 to access tickets." #505980 (Job #56514) * ** *** Support for the new progress indicator API. P4Ruby supplies a new progress attribute, which can take an instance of P4::Progress class or subclass. Progress information is currently only supported for submits and 'sync -q'. Details can be found in the documentation. #499586 (Job #56520) * New convenience method P4#each_() that allows easy iteration through some or all spec objects such as clients or changes. Details can be found in the documentation. Bugs fixed in 2012.2 #525097 (Job #59786) * Building P4Ruby with MinGW could generate the link error. g++: unrecognized option '-static-libstdc++' This has been fixed. #505548 (Job #58649) * P4#parse_client could raise the exception "Unknown field name 'StreamAtChange'." when parsing a stream client workspace. Internal spec definition has been updated to resolve this. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2012.1 #419591 (Job #51895) * ** *** P4Ruby supports SSL connections if compiled with SSL support. Instructions on how to compile with SSL support can be found at the top of this document under "Building P4Ruby from Source" and in the documentation. P4.identify will report the version of the OpenSSL library used to build the Perforce C++ API (not the version P4Ruby is linked against). #415643 * P4Ruby will now only build a 64-bit version of the library on Darwin. #413362 (Job #51899) * ** Enable "action resolve" to support resolves of branches, deletes and file types. The existing P4::MergeData class has been extended and the additional attributes will be populated for an 'action resolve'. Details of the additional attributes can be found in the documentation. Bugs fixed in 2012.1 #420839 (Job #52952) * Accessing the base_name attribute of a P4::MergeData object resulted in a segmentation fault when resolving binary files. This has now been fixed and all empty fields will return Nil. #410916 #410702 (Job #52320) * Exceptions thrown during P4.run_resolve are now raised up to the user. If an exception is encountered during the block's execution, P4Ruby will skip the remaining files. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2011.1 #405913 * New method P4#messages() returns all messages from the server as objects. Script writers can test the severity of the messages to know if they are output messages (E_INFO), warnings (E_WARN), or errors (E_FAILED/E_FATAL). P4#errors() and P4#warnings still return the errors and warnings as strings for backwards compatibility. P4::Message objects have the following methods: P4::Message#severity - Returns the severity of the message, which may be one of the following values: E_EMPTY # nothing yet E_INFO # something good happened E_WARN # something not good happened E_FAILED # user did something wrong E_FATAL # system broken -- nothing can continue P4::Message#generic - Returns the generic class of the error, which may be one of the following values: EV_NONE # misc EV_USAGE # request not consistent with dox EV_UNKNOWN # using unknown entity EV_CONTEXT # using entity in wrong context EV_ILLEGAL # trying to do something you can't EV_NOTYET # something must be corrected first EV_PROTECT # protections prevented operation EV_EMPTY # action returned empty results EV_FAULT # inexplicable program fault EV_CLIENT # client side program errors EV_ADMIN # server administrative action required EV_CONFIG # client configuration inadequate EV_UPGRADE # client or server too old to interact EV_COMM # communications error EV_TOOBIG # not even Perforce can handle this much P4::Message#msgid - Return the unique ID of the message. P4::Message#to_s - Convert the object to a string P4::Message#inspect - Debugging support #338410 (Job #47374) * P4Ruby supports setting values in the registry (on those platforms that support it). The command P4#set_env( var, val ) will set a registry variable on platforms that support this action or raise a P4Exception for those that don't. The command P4#set_env( var, "" ) unsets a registry variable. #333292 (Job #36121) * P4Ruby now supports Ruby 1.9 #331384 * P4Ruby can now be compiled with the Mingw compiler using the MinGW P4Api build. #328203 (Job #45861) * ** Enable streams in P4Ruby by default. With this change, streams specific specs such as streams depots are listed. Disable the listing of streams specific specs by either setting the api_level to a value below 70 or by disabling stream handling explicitly through the P4.streams attribute: p4.streams = false #322353 (Job #42250) * P4Ruby supports a callback interface by providing a P4#handler attribute. Set P4#handler to an instance of a subclass of P4::OutputHandler to enable callbacks. When a handler is defined, P4Ruby will invoke the handler for every response it receives from the Perforce Server immediately instead of collecting all results together in an array first. This can be used to make applications more scalable and more responsive if large results are expected. See the documentation for details on the OutputHandler class. Bugs fixed in 2011.1 #405913 (Job #43426) * Running 'print' on a file that started with '---' would cause an exception in Ruby. This is now fixed. There is still an oddity when p4.track = 1 and a user runs p4.run_print() on a file that only has lines starting with '--- '. In that case, the output of the print is lost. Disable tracking by setting p4.track = 0 (the default) will solve this problem. #405913 (Job #41350) * Info messages now shown in P4#Messages. #385159 (Job #49324) ** On Windows Vista, Windows 7, or Windows 2008, a client running as Administrator would fail to properly process file names in non-ASCII character sets (such as Shift-JIS). #338903 (Job #44589) * Extra dot at the end of the extracted directory path has been removed. #338437 (Job #39580) * P4#identify() reports the platform on AMD64 as X86_64 in line with all other Perforce products. #332453 * Updated the stored spec templates for client, change, group, spec and user. Added spec template for new spec type streams. These are required, for example, for form-triggers that do not connect to the server first. #329351 (Job #41271) * Include 'extraTag' fields in P4::Spec objects #328578 (Job #39264) * P4#identify() now reports P4Ruby as P4RUBY in line with all other Perforce products. It will also include the build number of the Perforce C/C++ API that it is built with. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2010.2 #260859 * Added new SetTrack() and GetTrack() methods. For more details about server performance tracking see: http://kb.perforce.com/article/883 #255945 * #255949 * #269012 * New method P4#messages() returns all messages from the server as objects. Script writers can test the severity of the messages to know if they are output messages (E_INFO), warnings (E_WARN), or errors (E_FAILED/E_FATAL). P4#errors() and P4#warnings still return the errors and warnings as strings for backwards compatibility. P4::Message objects have the following methods: P4::Message#severity - Returns the severity of the message, which may be one of the following values: E_EMPTY # nothing yet E_INFO # something good happened E_WARN # something not good happened E_FAILED # user did something wrong E_FATAL # system broken -- nothing can continue P4::Message#generic - Returns the generic class of the error, which may be one of the following values: EV_NONE # misc EV_USAGE # request not consistent with dox EV_UNKNOWN # using unknown entity EV_CONTEXT # using entity in wrong context EV_ILLEGAL # trying to do something you can't EV_NOTYET # something must be corrected first EV_PROTECT # protections prevented operation EV_EMPTY # action returned empty results EV_FAULT # inexplicable program fault EV_CLIENT # client side program errors EV_ADMIN # server administrative action required EV_CONFIG # client configuration inadequate EV_UPGRADE # client or server too old to interact EV_COMM # communications error EV_TOOBIG # not even Perforce can handle this much P4::Message#msgid - Return the unique ID of the message. P4::Message#to_s - Convert the object to a string P4::Message#inspect - Debugging support Bugs fixed in 2010.2 #287185 (Job #43426) Running 'print' on a file that started with '---' would cause an exception in Ruby. This is now fixed. There is still an oddity when p4.track = 1 and a user runs p4.run_print() on a file that only has lines starting with '--- '. In that case, the output of the print is lost. Disable tracking by setting p4.track = 0 (the default) will solve this problem. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2010.1 #232984 * Removed old Ruby 1.6 compatibility code that was no longer required. This paves the way for Ruby 1.9 compatibility. #230644 * It's now unnecessary to run a command before calling the following methods: P4#server_level P4#server_case_sensitive? P4#server_unicode? If no command has been run, P4Ruby will automatically run a 'p4 info' in order to gather the required information. #230191 * Added new P4#server_unicode? method that allows script writers to test whether or not a Perforce Server is in internationalized (unicode) mode. At least one Perforce command must have been executed against the server before this method can be called. #230190 * Added new P4::VERSION, P4::OS, and P4::PATCHLEVEL constants so that script writers can test the installation of P4Ruby without having to parse the output of P4::Identify() Bugs fixed in 2010.1 (none) -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2009.2 #214454 (Job #32916) * P4#port= now raises a P4Exception if called after P4#connect(). #214449 (Job #35416) * Added a P4#server_case_sensitive? method that enables scripts to detect whether the server is case-sensitive. Cannot be called until a command has been issued to the server. Bugs fixed in 2009.2 #214445,214999 (Job #35410) * P4Ruby now correctly tracks disconnects from the server. #222727 (Job #36568) * The Map class removed '-' and '+' from the path if the form Map.insert(lhs, rhs) was used, even if these characters did not appear at the beginning of the path. Now dashes and pluses are preserved within the path. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2009.1 #191900 (Job #26729) * A new method: P4#tagged( aBool ) { block } has been added to the P4 class. This method temporarily toggles the use of tagged output for the duration of the block and resets it when the block terminates. Bugs fixed in 2009.1 #191889 (Job #29911) * Calling P4#run_resolve() or P4#run( 'resolve' ) without a block or a previous call to P4#input no longer causes an infinite loop. #191623,191627 (Job #32918) * P4Ruby now correctly parses jobs when the jobspec contains field names ending in numbers. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2008.2 #162422 (Job #30364) * #166158 * A new class, P4::Map, enables users to create and use Perforce mappings without requiring a connection to a server. Methods in the P4::Map class are: P4::Map.new Constructor P4::Map.join Join two maps to create a third P4::Map#clear Empty a map P4::Map#count Return the number of entries P4::Map#empty? Tests whether a map object is empty P4::Map#insert Inserts an entry into the map P4::Map#translate Translate a string through a map P4::Map#includes? Tests whether a path is mapped P4::Map#reverse Swap left and right sides of the mapping P4::Map#lhs Returns the left side as an array P4::Map#rhs Returns the right side as an array P4::Map#to_a Returns the map as an array Bugs fixed in 2008.2 #169159 (Job #29935, Job #31096) * #165338 * P4Ruby now correctly loads the value of P4CHARSET from the environment. -------------------------------------------------------------------------- -------------------------------------------------------------------------- New functionality in 2008.1 #152356 (Job #29022) * A new method 'P4#env( var )' method has been added to the P4 class. This instance method enables the caller to interrogate the Perforce environment, including reading Perforce variables from P4CONFIG files and, on Windows, the registry. P4#cwd= now loads any P4CONFIG file settings that are appropriate to the new working directory. #153005 (Job #29308) * P4Ruby now supports Mac OS X 10.5. -------------------------------------------------------------------------- -------------------------------------------------------------------------- Bugs fixed in 2007.3 #151167 (Job #28774) * The Makefile generated on some Linux platforms (notably Ubuntu 7.10) was not correct, and attempted to link P4Ruby using 'cc' instead of 'c++', causing an 'undefined symbol' error (typically '_ZTVN10__cxxabiv120__si_class_type_infoE') , when attempting to use P4Ruby. This problem has been corrected. #150577 (Job #28704) * The presence of deleted revisions in a file's history might lead to incorrect fileSize and digest attributes for other revisions in the output of P4#run_filelog. This problem has been corrected. #150576 (Job #28773) * P4::Revision#filesize() always returned nil. This problem has been corrected.