clientuserruby.cpp #23

/*******************************************************************************

Copyright (c) 1997-2004, 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 CONTR
IBUTORS "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.

*******************************************************************************/

/*******************************************************************************
 * Name		: clientuserruby.cc
 *
 * Author	: Tony Smith <tony@perforce.com> or <tony@smee.org>
 *
 * Description	: Ruby bindings for the Perforce API. User interface class
 * 		  for getting Perforce results into Ruby.
 *
 ******************************************************************************/
#include <ctype.h>
#include <ruby.h>
#include "undefdups.h"
#include <clientapi.h>
#include <spec.h>
#include <diff.h>
#include "extconf.h"
#include "gc_hack.h"
#include "p4result.h"
#include "p4rubydebug.h"
#include "p4mergedata.h"
#include "clientuserruby.h"
#include "specmgr.h"

/*******************************************************************************
 * ClientUserRuby - the user interface part. Gets responses from the Perforce
 * server, and converts the data to Ruby form for returning to the caller.
 ******************************************************************************/

ClientUserRuby::ClientUserRuby()
{ 
    debug = 0;
    input = Qnil;
    mergeData = Qnil;
    mergeResult = Qnil;
}

void
ClientUserRuby::Reset()
{
    results.Reset();
    lastSpecDef.Clear();

    // Leave input alone.
}

void	
ClientUserRuby::Finished()
{
    // Reset input coz we should be done with it now. Keeping hold of
    // it just prevents GC from sweeping it if possible
    if ( P4RDB_CALLS && input != Qnil )
	fprintf( stderr, "[P4] Cleaning up saved input\n" );

    input = Qnil;
}

void
ClientUserRuby::HandleError( Error *e )
{
    if( P4RDB_CALLS )
	fprintf( stderr, "[P4] HandleError()\n" );

    if( P4RDB_DATA ) 
    {
	StrBuf t;
	e->Fmt( t, EF_PLAIN );
	fprintf( stderr, "... [%s] %s\n", e->FmtSeverity(), t.Text() );
    }

    results.AddError( e );
}

void
ClientUserRuby::OutputText( const_char *data, int length )
{
    if( P4RDB_CALLS )
	fprintf( stderr, "[P4] OutputText()\n" );
    if( P4RDB_DATA )
	fprintf( stderr, "... [%d]%*s\n", length, length, data );

    results.AddOutput( data );
}

void
ClientUserRuby::OutputInfo( char level, const_char *data )
{
    if( P4RDB_CALLS )
	fprintf( stderr, "[P4] OutputInfo()\n" );
    if( P4RDB_DATA )
	fprintf( stderr, "... %s\n", data );

    results.AddOutput( data );
}

void
ClientUserRuby::OutputBinary( const_char *data, int length )
{
    if( P4RDB_CALLS )
	fprintf( stderr, "[P4] OutputBinary()\n" );
    if( P4RDB_DATA )
    {
	for( int l = 0; l < length; l++ )
	{
	    if( l % 16 == 0 )
		fprintf( stderr, "%s... ", l ? "\n" : "" );
	    fprintf( stderr, "%#hhx ", data[ l ] );
	}
    }

    //
    // Binary is just stored in a string. Since the char * version of
    // P4Result::AddOutput() assumes it can strlen() to find the length,
    // we'll make the String object here.
    //
    results.AddOutput( rb_str_new( data, length) );
}

void
ClientUserRuby::OutputStat( StrDict *values )
{
    SpecMgr		m;
    StrPtr *		spec 	= values->GetVar( "specdef" );
    StrPtr *		data 	= values->GetVar( "data" );
    StrPtr *		sf	= values->GetVar( "specFormatted" );
    StrDict *		dict	= values;
    SpecDataTable	specData;
    Error		e;

    //
    // Determine whether or not the data we've got contains a spec in one form
    // or another. 2000.1 -> 2005.1 servers supplied the form in a data variable
    // and we use the spec variable to parse the form. 2005.2 and later servers
    // supply the spec ready-parsed but set the 'specFormatted' variable to tell 
    // the client what's going on. Either way, we need the specdef variable set
    // to enable spec parsing.
    //
    int			isspec	= spec && ( sf || data );

    // Propagate our debug level
    m.SetDebug( debug );

    //
    // Save the spec definition for later retrieval by P4ClientApi
    //
    if( spec )
	lastSpecDef = spec->Text();

    //
    // Parse any form supplied in the 'data' variable and convert it into a 
    // dictionary.
    //
    if( spec && data )
    {
	// 2000.1 -> 2005.1 server's handle tagged form output by supplying the form
	// as text in the 'data' variable. We need to convert it to a dictionary
	// using the supplied spec.
	if( P4RDB_CALLS )
	    fprintf( stderr, "[P4] OutputStat() - parsing form\n" );


	// Parse the form. Use the ParseNoValid() interface to prevent
	// errors caused by the use of invalid defaults for select items in
	// jobspecs.

#if P4APIVER_ID >= 513538
	Spec s( spec->Text(), "", &e );
#else
	Spec s( spec->Text(), "" );
#endif
	if( !e.Test() ) s.ParseNoValid( data->Text(), &specData, &e );
	if( e.Test() )
	{
	    HandleError( &e );
	    return;
	}
	dict = specData.Dict();
    }

    //
    // If what we've got is a parsed form, then we'll convert it to a P4::Spec
    // object. Otherwise it's a plain hash.
    //
    if( isspec )
    {
	if( P4RDB_CALLS )
	    fprintf(stderr ,"[P4] OutputStat() - Converting to P4::Spec object\n");
	results.AddOutput( m.DictToSpec( dict, spec ) );
    }
    else
    {
	if( P4RDB_CALLS )
	    fprintf(stderr ,"[P4] OutputStat() - Converting to hash\n");
	results.AddOutput( m.DictToHash( dict ) );
    }
}


/*
 * Diff support for Ruby API. Since the Diff class only writes its output
 * to files, we run the requested diff putting the output into a temporary
 * file. Then we read the file in and add its contents line by line to the 
 * results.
 */

void
ClientUserRuby::Diff( FileSys *f1, FileSys *f2, int doPage, 
				char *diffFlags, Error *e )
{

    if ( P4RDB_CALLS )
	fprintf( stderr, "[P4] Diff() - comparing files\n" );

    //
    // Duck binary files. Much the same as ClientUser::Diff, we just
    // put the output into Ruby space rather than stdout.
    //
    if( !f1->IsTextual() || !f2->IsTextual() )
    {
	if ( f1->Compare( f2, e ) )
	    results.AddOutput( "(... files differ ...)" );
	return;
    }

    // Time to diff the two text files. Need to ensure that the
    // files are in binary mode, so we have to create new FileSys
    // objects to do this.

    FileSys *f1_bin = FileSys::Create( FST_BINARY );
    FileSys *f2_bin = FileSys::Create( FST_BINARY );
    FileSys *t = FileSys::CreateGlobalTemp( f1->GetType() );

    f1_bin->Set( f1->Name() );
    f2_bin->Set( f2->Name() );

    {
	//
	// In its own block to make sure that the diff object is deleted
	// before we delete the FileSys objects.
	//
#ifndef OS_NEXT
	::
#endif
	Diff d;

	d.SetInput( f1_bin, f2_bin, diffFlags, e );
	if ( ! e->Test() ) d.SetOutput( t->Name(), e );
	if ( ! e->Test() ) d.DiffWithFlags( diffFlags );
	d.CloseOutput( e );

	// OK, now we have the diff output, read it in and add it to 
	// the output.
	if ( ! e->Test() ) t->Open( FOM_READ, e );
	if ( ! e->Test() ) 
	{
	    StrBuf 	b;
	    while( t->ReadLine( &b, e ) )
		results.AddOutput( b.Text() );
	}
    }

    delete t;
    delete f1_bin;
    delete f2_bin;

    if ( e->Test() ) HandleError( e );
}


/*
 * convert input from the user into a form digestible to Perforce. This
 * involves either (a) converting any supplied hash to a Perforce form, or
 * (b) running to_s on whatever we were given. 
 */

void
ClientUserRuby::InputData( StrBuf *strbuf, Error *e )
{
    if ( P4RDB_CALLS )
	fprintf( stderr, "[P4] InputData(). Using supplied input\n" );

    VALUE  	inval = input;

    if( Qtrue == rb_obj_is_kind_of( input, rb_cArray ) )
    {
	inval = rb_ary_shift( input );
    }

    if( Qnil == inval )
    {
	rb_warn( "[P4] Expected user input, found none. " 
		 "Missing call to P4#input()?" );
	return;
    }

    if ( Qtrue == rb_obj_is_kind_of( inval, rb_cHash ) )
    {
	SpecMgr 	m;
	StrPtr * 	specDef = varList->GetVar( "specdef" );

	m.SetDebug( debug );
	m.HashToText( inval, strbuf, specDef, e );
	return;
    }

    // Convert whatever's left into a string
    ID	to_s 	= rb_intern( "to_s" );
    VALUE	str 	= rb_funcall( inval, to_s, 0 );
    strbuf->Set( STR2CSTR( str ) );
}

/*
 * In a script we don't really want the user to see a prompt, so we
 * (ab)use the SetInput() function to allow the caller to supply the
 * answer before the question is asked.
 */
void
ClientUserRuby::Prompt( const StrPtr &msg, StrBuf &rsp, int noEcho, Error *e )
{
    if ( P4RDB_CALLS )
	fprintf( stderr, "[P4] Prompt(): %s\n", msg.Text() );

    InputData( &rsp, e );
}


/*
 * Do a resolve. We implement a resolve by calling a block.
 */
int
ClientUserRuby::Resolve( ClientMerge *m, Error *e )
{
    //
    // If no block has been passed, default to using the merger's resolve
    //
    if( ! rb_block_given_p() )
	return m->Resolve( e );

    // 
    // First detect what the merger thinks the result ought to be
    //
    StrBuf t;
    MergeStatus autoMerge = m->AutoResolve( CMF_FORCE );

    // Now convert that to a string;
    switch( autoMerge )
    {
    case CMS_QUIT:	t = "q";	break;
    case CMS_SKIP:	t = "s";	break;
    case CMS_MERGED:	t = "am";	break;
    case CMS_EDIT:	t = "e";	break;
    case CMS_YOURS:	t = "ay";	break;
    case CMS_THEIRS:	t = "at";	break;
    }

    mergeData = MkMergeInfo( m, t );

    VALUE	r;
    StrBuf 	reply;
    for( int loop=0 ; loop < 10 ; loop++ )
    {
	int	excepted;

	//
	// Call the block using rb_protect to make sure that if the
	// block raises any exceptions we trap them here. We don't want
	// some random longjmp() trashing the Perforce connection. If an
	// exception is raised, we'll abort the merge.
	//
	r = rb_protect( P4RUBY_FUNC_CAST(rb_yield), mergeData, &excepted );
	if( excepted ) return CMS_QUIT;

   
	reply = STR2CSTR( r ); 

	if( reply == "ay" ) 		return CMS_YOURS;
	else if( reply == "at" )	return CMS_THEIRS;
	else if( reply == "am" )	return CMS_MERGED;
	else if( reply == "ae" )	return CMS_EDIT;
	else if( reply == "s" )		return CMS_SKIP;
	else if( reply == "q" ) 	return CMS_QUIT;
	else rb_warn( "Invalid 'p4 resolve' response." );
    }

    rb_warn( "Aborting resolve after 10 attempts" );
    return CMS_QUIT;
}


/*
 * Accept input from Ruby and convert to a StrBuf for Perforce
 * purposes.  We just save what we're given here because we may not 
 * have the specdef available to parse it with at this time.
 */

VALUE
ClientUserRuby::SetInput( VALUE i )
{
    if ( P4RDB_CALLS )
	fprintf( stderr, "[P4] SetInput()\n" );

    input = i;
    return Qtrue;
}


VALUE
ClientUserRuby::MkMergeInfo( ClientMerge *m, StrPtr &hint )
{
    ID		idP4 	= rb_intern( "P4" );
    ID		idP4M	= rb_intern( "MergeData" );

    VALUE	cP4	= rb_const_get_at( rb_cObject, idP4 );
    VALUE	cP4M	= rb_const_get_at( cP4, idP4M );

    P4MergeData *d = new P4MergeData( this, m, hint );
    return d->Wrap( cP4M );
}

//
// GC support
//
void
ClientUserRuby::GCMark()
{
    if( P4RDB_GC )
    	fprintf( stderr, 
		"[P4] Marking results and errors for garbage collection\n" );

    if( input != Qnil )		rb_gc_mark( input );
    if( mergeData != Qnil )	rb_gc_mark( mergeData );
    if( mergeResult != Qnil )	rb_gc_mark( mergeResult );

    results.GCMark();
}