Helix SwarmHelix Swarm
Loading...

README.html

  • //
  • guest/
  • hari_krishna_dara/
  • perforce/
  • utils/
  • p4db/
  • P4DB_2.01/
  • README.html #1
  • View
  • Commits
  • Open Download .zip Download (27 KB) 
  1. <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
  2. <html>
  3. <head>
  4.    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  5.    <meta name="GENERATOR" content="Mozilla/4.7 [en] (X11; I; Linux 2.2.13 i686) [Netscape]">
  6.    <meta name="Author" content="fredric@mydata.se">
  7.    <meta name="Description" content="Information on how to install and maintain P4DB">
  8.    <title>Developers README file for P4DB</title>
  9. <style TYPE="text/css"><!--
  10. H1,H2,H3,H4,H5,H6 {
  11.     font-family:      Arial, Helvetica ;
  12.     background-color: #e0e0e0 ;
  13. }  
  14. H3 {
  15.     margin-left: 3% ;
  16. }
  17. H4 {
  18.     margin-left: 6% ;
  19. }
  20. H5 {
  21.     margin-left: 9% ;
  22. }
  23. P.Norm {
  24.     margin-left: 12% ;
  25.     margin-right: 40pt ;
  26.     font-family: Arial, Helvetica ; 
  27. }
  28. P.Norm UL, P.Norm OL, P.Norm DL,P.Norm TABLE {
  29.     margin-left: 12% ;
  30.     margin-right: 40pt ;
  31.     font-family: Arial, Helvetica ; 
  32. }
  33. P.Note {
  34.     margin-left: 15% ;
  35.     margin-right: 40pt ;
  36.     background-color: #FFE0E0 ;
  37.     font-family: Arial, Helvetica ; 
  38.  }
  39. H1 {
  40.     text-align: center ;
  41.     font-family: Arial, Helvetica ; 
  42. }
  43. .TOC {
  44.     margin-left: 15% ;
  45.     font-family: Arial, Helvetica ; 
  46. }
  47. --></style>
  48. </head>
  49. <body>
  50.  
  51. <!-- *************************************************************************** -->
  52. <h1>Administrators README for P4DB Version 2.01</h1>
  53.  
  54. <!-- --------------------------------------------------------------------------  -->
  55. <h2>Introduction</h2>
  56.  
  57. <P Class=Norm>
  58.    This is a README for P4DB, a CGI  based p4 depot browser written by
  59.     Fredric Fredricson (<a href="mailto:fredric@mydata.se">fredric@mydata.se</a>)
  60.     (One part is written by Bob Sidebotham, no email available). The README
  61.     is intended for administrators and others that want to install, maintain,
  62.     and possibly contribute to,&nbsp; P4DB.
  63.  
  64. <!-- --------------------------------------------------------------------------  -->
  65. <h2>Table Of Contents</h2>
  66. <P Class=TOC>
  67. <ul class=TOC>
  68. <li>
  69. <a href="#About">About</a>
  70.  
  71. <li>
  72. <a href="#Software">Software Requirements</a>
  73.  
  74. <li>
  75. <a href="#Supported_platforms">Platforms and Compatibility</a>
  76.  
  77. <li>
  78. <a href="#Installation">Installation and Configuration</a>
  79.  
  80. <li>
  81. <a href="#Known">Known Bugs</a>
  82.  
  83. <li>
  84. <a href="#Diffs">What's New</a>
  85.  
  86. <li>
  87. <a href="#Licensing">Licensing</a>
  88.  
  89. <li>
  90. <a href="#Warranty">Warranty</a>
  91.  
  92. <li>
  93. <a href="#Contrib">Would You Like To Contribute?</a>
  94.  
  95. <li>
  96. <a href="#Doc">Design Documentation</a>
  97.  
  98. <li>
  99. <a href="#Credits">Credits</a>
  100.  
  101. </ul>
  102.  
  103.  
  104. <!-- --------------------------------------------------------------------------  -->
  105. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="About"></a>About</h2>
  106.  
  107. <P Class=Norm>
  108.  
  109.     P4DB is designed to provide a
  110.     user friendly and intuitive interface to the p4 depot. Information is presented
  111.     using a web browser and most pages combine output from two or more p4 commands.
  112. <br>
  113.     The driving force behind the development
  114.     has been my needs as a manager for a software team, the needs for our project
  115.     leaders to document changes in the code line and the need for our programmers
  116.     to analyze changes in the code line (and most important, of course, the
  117.     need for me as a frustrated software engineer promoted to my level of incompetence
  118.     to get my hands on a nice little programming project).
  119. <P Class=Norm>
  120.     The browser is written in perl and
  121.     developed on a Linux/Apache system and has been tested mainly with Netscape 4 
  122.     although some of our users use MS Explorer and no problems has been reported.
  123.  
  124. <h3>Why P4DB?</h3>
  125.  
  126. <P Class=Norm>
  127.     P4DB is inspired by a depot browser, perfbrowse.perl,
  128.     made available by
  129.     <a href="http://www.perforce.com">Perforce</a> at 
  130.     <a href="http://www.perforce.com/perforce/loadsupp.html#browse">
  131.     http://www.perforce.com/perforce/loadsupp.html#browse</a>
  132.     Perfbrowse.perl is written in perl and the author is unknown to me.
  133. <P Class=Norm>
  134.     The idea is also stolen so I can't claim that one.
  135. <P Class=Norm>
  136.     To view file a script by Bob Sidebotham called 
  137.     <tt><a href="p4pr.perl">p4pr.perl</a></tt> is used.
  138.     This script is also made available by Perforce at 
  139.     <a href="http://www.perforce.com/perforce/loadsupp.html#util">
  140.     http://www.perforce.com/perforce/loadsupp.html#util</a>
  141.     (but I made some minor changes and one bug fix).
  142. <P Class=Norm>
  143.    I liked perfbrowse.perl very much but wanted just a little more 
  144.    functionality. I started to add functionality and it quickly got out
  145.    of hand. Soon I had a huuuge perl script that I could no
  146.    longer maintain. 
  147.    Once I realized that I can write a perl script that is
  148.    about 2-4 times the size of the script that I can maintain I decided to
  149.    rewrite it all from the start as a set of small, maintainable, perl scripts.
  150.    I leave to others to judge if I succeeded in my mission.
  151. <br>
  152.    <i>(Maybe I should mention that it took much more time than I anticipated).</i>
  153.  
  154.  
  155. <!-- --------------------------------------------------------------------------  -->
  156. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Software"></a>Software requirements</h2>
  157.  
  158. <P Class=Norm>
  159.     P4DB version 2.01 requires:
  160.      <UL>
  161.     <li>
  162.         Perl 5.004 or newer with the CGI.pm modules
  163. 	installed. The CGI.pm module can be downloaded from 
  164. 	<a href="http://www.cpan.org/">http://www.cpan.org/</a>
  165. 	<A href="http://search.cpan.org/search?dist=CGI.pm">(link to CGI.pm)</A>.
  166.     <li>
  167.         A http server that supports CGI:s. Apache
  168. 	will do just fine.
  169.     <li>
  170.         P4 99.2 or later (98.2 will also work but
  171. 	some features will be missing, 97.3 and older... forget
  172. 	it!).<br>
  173. 	P4DB has been tested with 2000.2beta.
  174.     </UL>
  175. </P>
  176.  
  177. <!-- --------------------------------------------------------------------------  -->
  178. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Supported_platforms"></a>Supported platforms and compatibility</h2>
  179.  
  180. <P Class=Norm>
  181.     There is no real "list of supported
  182.     platforms" simply because there is no
  183.     real "support" for P4DB. I just write
  184.     it, test it, and release it.
  185. <P Class=Norm>
  186.     <b>Http server:</b>
  187.     <br>
  188.         P4DB is developed on a Linux box running
  189. 	Suse 6.3 and Apache 1.3.9 , runs in production on RedHat 6.2/Apache 1.3.9,
  190. 	and has been reported to run on SUN/Solaris and NT/IIS platforms as well.
  191. 	The NT platform require MKS toolkit or similar and some tweaking, though.
  192. <P Class=Norm>
  193.     <b>Browser:</b>
  194.     <br>
  195.         All development work is done using Netscape
  196. 	4.7 but I perform some basic testing with MS-Explorer. 
  197. 	I expect P4DB to work reasonably well with any GUI browser 
  198. 	like Mozilla or Opera. because P4DB use almost only plain HTML 
  199. 	and just a little CSS (Cascaded Style Sheets).
  200. 	P4DB is <u>not</u> designed for character mode browsers such as Lynx.
  201.     <br>
  202.         And, by the way, the browser should support cookies.
  203.  
  204. <!-- --------------------------------------------------------------------------  -->
  205. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Installation"></a>Installation and configuration</h2>
  206. <P Class=Norm>
  207.     NOTE: This installation description assumes that the 
  208.     reader is familiar with http servers, cgi 
  209.     scripts and, to a small degree, perl. 
  210.  
  211. <h3>First: Where to install</h3>
  212. <P Class=Norm>
  213.     Other than the obvious, that is
  214.     somewhere in a http servers CGI path, 
  215.     I recommend you to set up a http
  216.     server on your p4 server and run P4DB 
  217.     on that server. The main reasons
  218.     are that it improves response time and
  219.     reduce network load.
  220.  
  221. <h3>How to install</h3>
  222.  
  223.     <P Class=Norm>
  224.     <ol>
  225.         <li>
  226. 	    You obviously got to this README. Together
  227. 	    with README.html file you got:
  228. 	    <ul>
  229. 	        <li><tt>install.pl</tt>
  230. 		<li><tt>cgi_files.tar</tt>
  231. 		<li><tt>P4CGI.html</tt>
  232. 		<li><tt>P4DB.shortcuts.txt</tt>
  233. 		<li><tt>P4DB.shortcuts2.txt</tt> 
  234. 		<li><tt>P4DB.conf.txt</tt>
  235. 	    </ul>
  236. 	    Move all these files together with <tt>README.html</tt>
  237. 	    to the cgi-bin directory used by the web server or wherever
  238. 	    you want P4DB installed. Or you could just move the original 
  239. 	    tarball and unpack it. 
  240. 	<li>
  241. 	    Type "<tt>perl install.pl</tt>" To install
  242. 	    all scripts.
  243. 	    <br>
  244. 	    Install.pl will unpack all cgi scripts
  245. 	    and modifies the first line to contain the path to perl.
  246. 	    <br>For details, see the <tt><a href="install.pl">install.pl</a></tt>
  247. 	    script.
  248. 	<li>
  249. 	    The file <tt>index.cgi</tt> is the start page
  250. 	    for P4DB. Create your links to it..
  251.     </ol>
  252.     
  253.     <P Class=Norm>
  254.     This is the theory, at least. I have not tested
  255.     it on many systems
  256.  
  257.     <h4>Installation without <tt>install.pl</tt></h4>
  258.  
  259.     <P Class=Norm>
  260.         If <tt>install.pl</tt> don't work
  261. 	for you here is what it does that you need to do manually:
  262. 	<ol>
  263. 	    <li>
  264. 	        Verify that perl and the perl module CGI.pm
  265. 		is available
  266. 	    <li>
  267. 	        Unpack cgi_file.tar (<tt>tar -xf cgi_files.tar</tt>)
  268. 	    <li>
  269. 	        Find path to perl
  270. 	    <li>
  271. 	        Change first line of every file with extension
  272. 		".cgi", ".pl" or ".perl" to contain correct path to perl
  273. 	</ol>
  274.     </blockquote>
  275.  
  276.     <h3>How to configure</h3>
  277.  
  278.     <h4>Basic configuration</h4>
  279.  
  280.     <P Class=Norm>
  281.         The basic configuration file is named P4DB.conf. The file 
  282. 	is not included in the package but a sample configuration
  283. 	file called <tt><a href="P4DB.conf.txt">P4DB.conf.txt</a></tt> is.
  284. 	<p class=Norm>
  285.  	Copy the file P4DB.conf.txt to P4DB.conf
  286. 	and modify it. The instructions are included in the file.
  287. 	
  288.        <P class=Note>
  289.             <B>Security Note 1:</B> Since the DEPOT field in the
  290. 	    configuration file may contain passwords for p4 users it
  291. 	    may be wise to move the file outside the file tree
  292. 	    reachable by the web server. The path to the configuration
  293. 	    file is specified at the top of <tt>P4CGI.pm</tt>.
  294.  
  295.        <P class=Note>
  296. 	    <B>Security Note 2</B> P4DB does not provide any access protection
  297. 	    or other security. It is not possible to modify the depot using P4DB so
  298. 	    poorly trained or inexperienced operators should not be able to damage
  299. 	    the depot. If this security is not enough you have to rely on the authentication
  300. 	    provided by the web server.
  301.  
  302. 	<p class=Norm>
  303. 	You must specify a p4 user for P4DB. If I understand
  304. 	Perforce Licensing policies correctly you should not have
  305. 	to use a separate user license for this user, but this is
  306. 	just my interpretation and I recommend that you verify this
  307. 	 with Perforce.
  308.  
  309.     <h4>Shortcut files</h4>
  310.  
  311.     <P Class=Norm>
  312.         It is possible to add a set of	links to the P4DB 
  313. 	index page using a "shortcut file". The idea is to add
  314. 	links that function as shortcuts into P4DB for the users. 
  315. 	There can be more than one shortcut file and the user
  316. 	can select his/her favorite in the "set preferences" page.
  317.  
  318.     <h4>Shortcut file format:</h4>
  319.     <P Class=Norm>
  320. 	The shortcut file is format is HTML plus some
  321. 	extra tags and comment syntax added by P4DB. The HTML code is inserted
  322. 	into the P4DB index page. 
  323. 	There are no limits imposed by P4DB to the HTML code but there are an 
  324. 	infinite number of bad ideas to avoid (like, for example,
  325. 	inserting a <tt>&lt;/BODY></tt> tag in the shortcut file). 
  326. 	Ill-formed HTML will probably break the index page.
  327.  
  328. 	<h5>Difference from HTML</h5>
  329.         <P Class=Norm>
  330. 	<dl>
  331. 	    <dt>
  332. 	        Perl style comments
  333. 	    <dd>
  334. 	        Lines starting with '#' are ignored.
  335. 	    <dt>
  336. 	        Extra tag <tt>&lt;P4DB></tt><i>text</i><tt>&lt;/P4DB></tt>
  337. 	    <dd>
  338. 	        This tag will make "<i>text</i>" a link to
  339. 		a function in P4DB.
  340. 		<P class=Norm>
  341. 		<table border>
  342. 		    <tr>
  343. 		    <th VALIGN=TOP NOSAVE>Syntax</th>
  344. 		    <td><tt>&lt;P4DB>....&lt;/P4DB></tt></td>
  345. 		    </tr>
  346.  
  347. 		    <tr NOSAVE>
  348. 		    <th VALIGN=TOP NOSAVE>Attribute specifications</th>
  349. 		    <td NOSAVE>
  350. 		    <dl>
  351. 		        <dt>
  352. 			    <tt>TYPE=</tt><i>link_type </i>(mandatory)
  353. 			<dd>
  354. 			    <i>link_type</i> is one of:
  355. 			    <ul>
  356. 			        <li>
  357. 				    <tt>CHANGELIST</tt> - display list of changes
  358. 				<li>
  359. 				    <tt>BROWSE</tt> - browse depot
  360. 				<li>
  361. 				    <tt>JOBLIST</tt> - list jobs
  362. 			    </ul>
  363. 			<dt>
  364. 			    FSPC=<i>depot_file_spec </i>(valid for types
  365. 			    <tt>CHANGELIST</tt> and <tt>BROWSE</tt>)
  366. 			<dd>
  367. 			    <i>depot_file_spec</i> is a file spec in depot 
  368. 			    format. A typical file spec would be "//..." 
  369. 			    to view changes for or the whole depot or browse starting
  370. 			    at the top of the depot.
  371. 			    <br>
  372. 			    For CHANGELIST more than one file spec can be listed.
  373. 			    The file specifications should be separated by "+".
  374. 			    For example "<tt>//...*.c+//...*.h</tt>" would
  375. 			    list changes for all .c and .h files.
  376. 			<dt>
  377. 			    USER=<i>user_list </i>(valid for CHANGELIST).
  378. 			<dd>
  379. 			    <i>user_list</i> is a comma separated list of 
  380. 			    users that the changes should
  381. 			    be listed for.
  382. 			<dt>
  383. 			    GROUP=<i>group_list</i> (valid for CHANGELIST).
  384. 			<dd>
  385. 			    <i>group_list</i> is a comma separated list of
  386. 			    groups that the changes should be listed for.
  387. 			<dt>
  388. 			    <i>JOB_FIELD</i>=<i>data</i> (valid for JOBLIST)
  389. 			<dd>
  390. 			    JOB_FIELD is the field name for any field in
  391. 			     the job spec for the depot. Data is the data 
  392. 			     that this field should contain. Typical use would
  393. 			     be:
  394. 			     <br>
  395. 			     <tt>&lt;P4DB type=joblist status=open>list open jobs&lt;/P4DB>.</tt>
  396. 		    </dl>
  397. 		    <p>
  398. 		    These are the most important attribute specifications. 
  399. 		    More can be found if you study the URLs generated when
  400. 		    you browse around in P4DB. The attributes corresponds 
  401. 		    more or less directly to the URL parameters. The one exception 
  402. 		    is the job list where field names are translated to 
  403. 		    field codes in the URL.
  404. 		</dl>
  405. 		</tr>
  406. 	    </table>
  407. 	</dl>
  408.         <P Class=Norm>
  409. 	Two sample shortcut files are included with the distribution: 
  410. 	<A HREF="P4DB.shortcuts.txt"><tt>P4DB.shortcuts.txt</tt></a> and
  411. 	<A HREF="P4DB.shortcuts2.txt"><tt>P4DB.shortcuts2.txt</tt></a>.
  412.  
  413.     <h4>Configure file types (for viewers)</h4>
  414.         <P Class=Norm>
  415.         P4DB will let users view some file types using
  416. 	applications like MS-Word for Word-file etc. 
  417. 	This can be configured in a file
  418. 	<a href="viewConfig.pm">viewConfig.pm</a>. 
  419. 	Default will let you view HTML, gif, jpeg, MS-Word, MS-Powerpoint, 
  420. 	and Acrobat (PDF) formats.
  421. 	See file <a href="viewConfig.pm">viewConfig.pm</a> for details.
  422.  
  423. <!-- --------------------------------------------------------------------------  -->
  424. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Known"></a>Known bugs</h2>
  425.  
  426.     <P Class=Norm>
  427.     <ul>
  428.     <li>
  429.         A serious case of Feature Bloat.
  430.     </ul>	
  431.  
  432.  
  433. <!-- --------------------------------------------------------------------------  -->
  434. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Diffs"></a>Diffs between versions</h2>
  435.  
  436.     <h4>New to P4DB 2.01:</h4>
  437.     <P Class=Norm>
  438.     <dl>
  439.     <dt>Works for p4 2000.2beta
  440.         <dd>The jobspec command was changed and now P4DB understands
  441.         both 2000.2beta as well as 2000.1 thru 98.2.
  442.     <dt>Works for p4 2000.1
  443.         <dd>The depot statistics did not work properly for p4 release
  444.         2000.1
  445.     <dt>Made easier to port
  446.         <dd>The configuration file now contains fields for command to redirect to
  447.         null device and command to redirect to stdout. This makes it
  448.         easier to port P4DB to NT that thinks /dev/null is called
  449.         NUL:.
  450. 	<P class=Note>
  451. 	Configuration file for 2.0 not compatible with 2.01
  452. 	<br>
  453. 	<br>
  454.     <dt>Java GUI browser improved
  455.         <dd>Can now handle filenames containing spaces
  456.     <dt>Label diff view rewritten
  457.         <dd>The old code was buggy and difficult to maintain
  458.     <dt>Made some code more maintainable
  459.         <dd>Modified client view and label view code to make it more maintainable.
  460.     </dl>
  461.     <h4>Diff earlier version of P4DB to 2.0:</h4>
  462.     <P Class=Norm>
  463.        The difference is so huge that I do not care
  464.        to list it. P4DB 2.0 can simply do much more than earlier versions.
  465.  
  466. <!-- --------------------------------------------------------------------------  -->
  467. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Licensing"></a>Licensing</h2>
  468.  
  469.     <P Class=Norm>
  470.     There is no license for P4DB.
  471.     You are free to use, modify, resell, repackage, make money from (ha!),
  472.     P4DB.&nbsp; Your conscience is the limit ;-).
  473.     <br>
  474.     I might decide to apply GPL to it some
  475.     time in the future but I doubt that I will bother....
  476.  
  477. <!-- --------------------------------------------------------------------------  -->
  478. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Warranty"></a>Warranty</h2>
  479.  
  480.     <P Class=Norm>
  481.     If you get any problems because of these scripts I promise 
  482.     to feel sorry for you. Other than that you are
  483.     on your own.
  484.     <P Class=Note>
  485.     Please note for the record that I do not even claim that 
  486.     P4DB can be used to browse the P4 depot. I will also inform 
  487.     you that even though the intention is that P4DB should not 
  488.     in any way modify the depot
  489.     status I can make no promises that this is can not happen.<br><br>
  490.     And please remember that it would be easy for someone to grab the
  491.     P4DB code, insert a few malicious lines of code, and
  492.     &quot;release&quot; it with this &quot;Trojan Horse&quot;.
  493.  
  494.  
  495. <!-- --------------------------------------------------------------------------  -->
  496. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Contrib"></a>Would you like to contribute?</h2>
  497.  
  498.     <P Class=Norm>
  499.     If you would like to contribute
  500.     changes/improvements/new functions feel free to do so and mail them to
  501.     me and I will add them to the next "release" (flames and flattery are also
  502.     welcome).
  503.     <p class=Note><b>Disclaimer</b>: 
  504.        I may grow tired of
  505.        this project or change job or die or something in which case my promise
  506.        above probably expires.
  507.     
  508.     <h3>What would be a contribution?</h3>
  509.     <P Class=Norm>
  510.         I will be glad for any kind of contributions 
  511. 	ranging from corrections of my bad English to new interesting
  512. 	functionality. Nice letters are also welcome.
  513.  
  514. <!-- --------------------------------------------------------------------------  -->
  515. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Doc"></a>Design documentation</h2>
  516.  
  517.     <P Class=Norm>
  518.     The most important documentation is in the P4CGI.pm module. 
  519.     This modules is used by all scripts and contains
  520.     a set of common functions that are useful or defines some common "look
  521.     and feel" or both.
  522.     <P Class=Norm>
  523.     The P4CGI.pm module is documented using
  524.     perlpod (see perlpod man page). To get a HTML page 
  525.     containing documentation
  526.     type:
  527.     <br>
  528.     <tt>pod2html P4CGI.pm ><a href="P4CGI.html">P4CGI.html</a></tt>
  529.     (There is one distributed with P4DB, for convenience)
  530.     <P Class=Norm>
  531.     For other files: more often than not the
  532.     code is commented.
  533.     <P Class=Norm>
  534.     There are three different files 'types'
  535.     in the design:
  536.     <dl COMPACT>
  537.       <dt> P4CGI.pm
  538.       <dd> - A perl module containing functions that
  539.              I find useful and all other scripts use
  540.       <dt> *.cgi
  541.       <dd> - A set of cgi scripts that are used as ...eh..
  542.              cgi-scripts.
  543.       <dt>p4pr.perl
  544.       <dd> - The script by Bob Sidebotham I mentioner
  545.              earlier
  546.     </dl>
  547.     <P Class=Norm>
  548.     The code also uses the CGI.pm perl module.
  549.     This module should be part of the "standard distribution" of perl (if there
  550.     is such a thing). If you do not have the module it is available for download at 
  551.     <a href="http://www.cpan.org">www.cpan.org</a>.
  552.  
  553.     <P Class=Norm>
  554.     As a part of my personal religion the -w
  555.     flag is always turned on and 'use strict' flag is also set. I have never
  556.     had any reason to regret this particular peculiarity of mine but it might
  557.     cause some warning messages that will be printed to the browsers error
  558.     log.
  559.  
  560.     <P Class=Norm>
  561.     Performance has not been a great issue.
  562.     I assume that these cgi's will not have thousands 
  563.     of hits each day and
  564.     the design has focused on ease of 
  565.     development rather than speed.
  566.  
  567.     <h3>List Of Files:</h3>
  568.     <P Class=Norm>
  569.     <table NOSAVE>
  570.     <tr VALIGN=BOTTOM>
  571.     <td ALIGN=RIGHT VALIGN=TOP><tt>P4CGI.pm</tt></td>
  572.     <td>A perl package that contains common functions</td>
  573.     </tr>
  574.  
  575.     <tr VALIGN=BOTTOM>
  576.     <td ALIGN=RIGHT VALIGN=TOP><tt>index.cgi</tt></td>
  577.     <td>Entry point or "main" cgi</td>
  578.     </tr>
  579.  
  580.     <tr VALIGN=BOTTOM>
  581.     <td ALIGN=RIGHT VALIGN=TOP><tt>SetPreferences.cgi</tt></td>
  582.     <td>Set user preferences
  583.     <br>User preferences are stored in a cookie. If cookies are not enabled
  584.     the user can not modify the user preferences and the default setting will
  585.     be used.</td>
  586.     </tr>
  587.  
  588.     <tr VALIGN=BOTTOM>
  589.     <td ALIGN=RIGHT VALIGN=TOP><tt>branchList.cgi</tt></td>
  590.     <td>List branches</td>
  591.     </tr>
  592.  
  593.     <tr VALIGN=BOTTOM>
  594.     <td ALIGN=RIGHT VALIGN=TOP><tt>branchView.cgi</tt></td>
  595.     <td>View information about a branch</td>
  596.     </tr>
  597.  
  598.     <tr VALIGN=BOTTOM>
  599.     <td ALIGN=RIGHT VALIGN=TOP><tt>changeByUsers.cgi</tt></td>
  600.     <td>Select a set of users and groups to view changes for. Calls changeList.cgi
  601.     to do the job.</td>
  602.     </tr>
  603.  
  604.     <tr VALIGN=BOTTOM>
  605.     <td ALIGN=RIGHT VALIGN=TOP><tt>changeList.cgi</tt></td><td>
  606.     List changes
  607.     <blockquote>
  608.         NOTE:<br>
  609. 	Even if	I said earlier that my goal was to create a set of small, maintainable,
  610. 	scripts this script stands out as a blazing proof of my failure. It may
  611. 	not be huge but it is certainly not maintainable. Some day I might rewrite
  612. 	it......
  613. 	<br>
  614. 	<i>And to 2.0 I finally rewrote it.</i>
  615.     </blockquote>
  616.     </td>
  617.     </tr>
  618.  
  619.     <tr VALIGN=BOTTOM>
  620.     <td ALIGN=RIGHT VALIGN=TOP><tt>changeView.cgi</tt></td>
  621.     <td> View a change </td>
  622.     </tr>
  623.  
  624.     <tr VALIGN=BOTTOM>
  625.     <td ALIGN=RIGHT VALIGN=TOP><tt>clientList.cgi</tt></td><td>
  626.     List clients 
  627.     </td>
  628.     </tr>
  629.  
  630.     <tr VALIGN=BOTTOM>
  631.     <td ALIGN=RIGHT VALIGN=TOP><tt>clientView.cgi</tt></td><td>
  632.     View a client spec. 
  633.     </td>
  634.     </tr>
  635.  
  636.     <tr VALIGN=BOTTOM>
  637.     <td ALIGN=RIGHT VALIGN=TOP><tt>colorView.pm</tt></td><td>
  638.     Perl module used by fileViewer.cgi to handle color display of some file types.
  639.     </td>
  640.     </tr>
  641.  
  642.     <tr VALIGN=BOTTOM>
  643.     <td ALIGN=RIGHT VALIGN=TOP><tt>colorC.pl<br>
  644.     colorHtml.pl<br>
  645.     colorPerl.pl</tt></td><td>
  646.     Special designed filters that adds colors to C/C++ (colorC.pl), HTML code (colorHtml.pl) and
  647.     perl (colorPerl.pl).
  648.     The filters are quick hacks and more like demo examples.
  649.     </td>
  650.     </tr>
  651.  
  652.     <tr VALIGN=BOTTOM>
  653.     <td ALIGN=RIGHT VALIGN=TOP><tt>depotStats.cgi</tt></td><td>
  654.     View depot statistics 
  655.     </td>
  656.     </tr>
  657.  
  658.     <tr VALIGN=BOTTOM>
  659.     <td ALIGN=RIGHT VALIGN=TOP><tt>depotTreeBrowser.cgi</tt></td><td>
  660.     Browse the depot file tree 
  661.     </td>
  662.     </tr>
  663.  
  664.     <tr VALIGN=BOTTOM>
  665.     <td ALIGN=RIGHT VALIGN=TOP><tt>fileDiffView.cgi</tt></td><td>
  666.     View diff between
  667.     two files or two revisions 
  668.     </td>
  669.     </tr>
  670.  
  671.     <tr VALIGN=BOTTOM>
  672.     <td ALIGN=RIGHT VALIGN=TOP><tt>fileDownLoad.cgi</tt></td><td>
  673.     Download files 
  674.     </td>
  675.     </tr>
  676.  
  677.     <tr VALIGN=BOTTOM>
  678.     <td ALIGN=RIGHT VALIGN=TOP><tt>fileLogView.cgi</tt></td><td>
  679.     View file history 
  680.     </td>
  681.     </tr>
  682.  
  683.     <tr VALIGN=BOTTOM>
  684.     <td ALIGN=RIGHT VALIGN=TOP><tt>fileOpen.cgi</tt></td><td>
  685.     List open files 
  686.     </td>
  687.     </tr>
  688.  
  689.     <tr VALIGN=BOTTOM>
  690.     <td ALIGN=RIGHT VALIGN=TOP><tt>fileSearch.cgi</tt></td><td>
  691.     Search for file matching file spec 
  692.     </td>
  693.     </tr>
  694.  
  695.     <tr VALIGN=BOTTOM>
  696.     <td ALIGN=RIGHT VALIGN=TOP><tt>fileViewer.cgi</tt></td><td>
  697.     View a file 
  698.     </td>
  699.     </tr>
  700.  
  701.     <tr VALIGN=BOTTOM>
  702.     <td ALIGN=RIGHT VALIGN=TOP><tt>filesChangedSince.cgi</tt></td><td>
  703.     List recently modified files 
  704.     </td>
  705.     </tr>
  706.  
  707.     <tr VALIGN=BOTTOM>
  708.     <td ALIGN=RIGHT VALIGN=TOP><tt>groupView.cgi</tt></td><td>
  709.     View a group 
  710.     </td>
  711.     </tr>
  712.  
  713.     <tr VALIGN=BOTTOM>
  714.     <td ALIGN=RIGHT VALIGN=TOP><tt>htmlFileView.cgi</tt></td><td>
  715.     "Smart" html file viewer that translates relative links to links into the
  716.     depot
  717.     </td>
  718.     </tr>
  719.  
  720.     <tr VALIGN=BOTTOM>
  721.     <td ALIGN=RIGHT VALIGN=TOP><tt> javaDataView.cgi</tt></td><td>
  722.     Java depot browser cgi
  723.     <br>
  724.     Provides data for java part of depot browser 
  725.     </td>
  726.     </tr>
  727.  
  728.     <tr VALIGN=BOTTOM>
  729.     <td ALIGN=RIGHT VALIGN=TOP><tt>jobList.cgi</tt></td><td>
  730.     List jobs
  731.     </td>
  732.     </tr>
  733.  
  734.     <tr VALIGN=BOTTOM>
  735.     <td ALIGN=RIGHT VALIGN=TOP><tt>jobView.cgi</tt></td><td>
  736.     View info about a job 
  737.     </td>
  738.     </tr>
  739.  
  740.     <tr VALIGN=BOTTOM>
  741.     <td ALIGN=RIGHT VALIGN=TOP><tt>labelDiffView.cgi</tt></td><td>
  742.     Label diff viewer
  743.     <br>View diff between two labels 
  744.     </td>
  745.     </tr>
  746.  
  747.     <tr VALIGN=BOTTOM>
  748.     <td ALIGN=RIGHT VALIGN=TOP><tt>labelList.cgi</tt></td><td>
  749.     Display a list of all labels
  750.     </td>
  751.     </tr>
  752.  
  753.     <tr VALIGN=BOTTOM>
  754.     <td ALIGN=RIGHT VALIGN=TOP><tt>labelView.cgi</tt></td><td>
  755.     List info about a label 
  756.     </td>
  757.     </tr>
  758.  
  759.     <tr VALIGN=BOTTOM>
  760.     <td ALIGN=RIGHT VALIGN=TOP><tt>p4race.cgi</tt></td><td>
  761.     The p4 submit race 
  762.     </td>
  763.     </tr>
  764.     
  765.     <tr VALIGN=BOTTOM>
  766.     <td ALIGN=RIGHT VALIGN=TOP><tt>searchPattern.cgi</tt></td><td>
  767.     Specify a search for a pattern in description field in changes.
  768.     <br>
  769.     Calls changeList.cgi to do the actual job. 
  770.     </td>
  771.     </tr>
  772.  
  773.     <tr VALIGN=BOTTOM>
  774.     <td ALIGN=RIGHT VALIGN=TOP><tt>specialFileView.cgi</tt></td><td>
  775.     Special
  776.     file viewer
  777.     <br>
  778.     Special file viewer for HTML, JPEG, GIF , MS-Word, MS-Powerpoint, RTF,
  779.     and PDF file types. Downloads files with the appropriate Content-Type
  780.     </td>
  781.     </tr>
  782.  
  783.     <tr VALIGN=BOTTOM>
  784.     <td ALIGN=RIGHT VALIGN=TOP><tt>userList.cgi</tt></td><td>
  785.     Display a list of all users 
  786.     </td>
  787.     </tr>
  788.  
  789.     <tr VALIGN=BOTTOM>
  790.     <td ALIGN=RIGHT VALIGN=TOP><tt>userView.cgi</tt></td><td>
  791.     View info about a user
  792.     </td>
  793.     </tr>
  794.  
  795.     <tr VALIGN=BOTTOM>
  796.     <td ALIGN=RIGHT VALIGN=TOP><tt>p4jdb/P4DirTreeApplet.java<br>
  797.     p4jdb/P4DirTree.java<br>
  798.     P4Jdb/P4File.java<br>
  799.     p4jdb/P4Folder.java<br>
  800.     p4jdb/TreeDisplay.java</tt></td><td>
  801.     Java source code for the GUI depot tree
  802.     browser.
  803.     </td>
  804.     </tr>
  805.     
  806.     <tr VALIGN=BOTTOM>
  807.     <td ALIGN=RIGHT VALIGN=TOP><tt>Makefile</tt></td><td>
  808.     Make file for java classes (GNU make)
  809.     </td>
  810.     </tr>
  811.  
  812.     <tr VALIGN=BOTTOM>
  813.     <td ALIGN=RIGHT VALIGN=TOP><tt>p4jdb/*.class</font></td><td>
  814.     Java files compiled from the .java files above
  815.     </td>
  816.     </tr>
  817.     
  818.     </table>
  819.  
  820. <!-- --------------------------------------------------------------------------  -->
  821. <h2><hr ALIGN=LEFT WIDTH="50%"><a NAME="Credits"></a>Credits</h2>
  822.  
  823.     <P Class=Norm>
  824.     An incomplete list of people that has contributed to P4DB in different ways:
  825.     <ul>
  826.          <li>Diane Holt - Diane has also released her own version of P4DB 
  827. 	     adapted to NT. I think it's available in Perforce Public Depot.
  828. 	 <li>Lawrence You
  829. 	 <li>Ron Shalhoup
  830. 	 <li>Rob Chandhok
  831. 	 <li>Carl Martinsson - A colleague of mine that use P4DB a lot and 
  832. 	     contributed a lot of ideas for new functions.
  833. 	 <li>Eric Engberg - Provided valuable information on how to
  834. 	     facilitate ports to NT/Apache.
  835. 	 <li>Lee Marzke - For valuable bug reporting
  836.      </ul>
  837.     <P Class=Norm>
  838.      There are more but these are the only names I found in my records.
  839. </body>
  840. </html>
# Change User Description Committed
#1 5093 Hari Krishna Dara Populating perforce branch.
I will be adding p4admin files to it. 		20 years ago
//guest/perforce_software/utils/p4db/P4DB_2.01/README.html
#1 1884 rmg Update to the current (2.01) P4DB. 23 years ago