SpecMgr.cpp

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

Copyright (c) 2007-2011, 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.

$Id: //depot/r13.1/p4-python/SpecMgr.cpp#2 $
*******************************************************************************/

/*******************************************************************************
 * Name		: SpecMgr.cpp
 * 
 * Description	: Python bindings for the Perforce API. Class for handling
 * 		  Perforce specs. This class provides other classes with
 * 		  generic support for parsing and formatting Perforce
 *		  specs.
 *
 ******************************************************************************/
#include <Python.h>
#include <bytesobject.h>
#include "undefdups.h"
#include "python2to3.h"
#include <clientapi.h>
#include <strops.h>
#include <spec.h>
#include <strtable.h>
#include "P4PythonDebug.h"
#include "PythonSpecData.h"
#include "SpecMgr.h"

#include <iostream>
#include <string>
#include <sstream>

using namespace std;

struct specdata {
    const char *type;
    const char *spec;
} speclist[] = {

    {
	"branch",
	"Branch;code:301;rq;ro;fmt:L;len:32;;"
	"Update;code:302;type:date;ro;fmt:L;len:20;;"
	"Access;code:303;type:date;ro;fmt:L;len:20;;"
	"Owner;code:304;fmt:R;len:32;;"
	"Description;code:306;type:text;len:128;;"
	"Options;code:309;type:line;len:32;val:"
	    "unlocked/locked;;"
	"View;code:311;type:wlist;words:2;len:64;;"
    },
    {
	"change",
	"Change;code:201;rq;ro;fmt:L;seq:1;len:10;;"
	"Date;code:202;type:date;ro;fmt:R;seq:3;len:20;;"
	"Client;code:203;ro;fmt:L;seq:2;len:32;;"
	"User;code:204;ro;fmt:L;seq:4;len:32;;"
	"Status;code:205;ro;fmt:R;seq:5;len:10;;"
	"Type;code:211;seq:6;type:select;fmt:L;len:10;"
	    "val:public/restricted;;"
	"Description;code:206;type:text;rq;seq:7;;"
	"JobStatus;code:207;fmt:I;type:select;seq:9;;"
	"Jobs;code:208;type:wlist;seq:8;len:32;;"
	"Files;code:210;type:llist;len:64;;"
    },
    {
	"client",
	"Client;code:301;rq;ro;seq:1;len:32;;"
	"Update;code:302;type:date;ro;seq:2;fmt:L;len:20;;"
	"Access;code:303;type:date;ro;seq:4;fmt:L;len:20;;"
	"Owner;code:304;seq:3;fmt:R;len:32;;"
	"Host;code:305;seq:5;fmt:R;len:32;;"
	"Description;code:306;type:text;len:128;;"
	"Root;code:307;rq;type:line;len:64;;"
	"AltRoots;code:308;type:llist;len:64;;"
	"Options;code:309;type:line;len:64;val:"
	    "noallwrite/allwrite,noclobber/clobber,nocompress/compress,"
	    "unlocked/locked,nomodtime/modtime,normdir/rmdir;;"
	"SubmitOptions;code:313;type:select;fmt:L;len:25;val:"
	    "submitunchanged/submitunchanged+reopen/revertunchanged/"
	    "revertunchanged+reopen/leaveunchanged/leaveunchanged+reopen;;"
	"LineEnd;code:310;type:select;fmt:L;len:12;val:"
	    "local/unix/mac/win/share;;"
	"Stream;code:314;type:line;len:64;;"
	"StreamAtChange;code:316;type:line;len:64;;"
	"ServerID;code:315;type:line;ro;len:64;;"
	"View;code:311;type:wlist;words:2;len:64;;"
    },
    {
	"depot",
	"Depot;code:251;rq;ro;len:32;;"
	"Owner;code:252;len:32;;"
	"Date;code:253;type:date;ro;len:20;;"
	"Description;code:254;type:text;len:128;;"
	"Type;code:255;rq;len:10;;"
	"Address;code:256;len:64;;"
	"Suffix;code:258;len:64;;"
	"Map;code:257;rq;len:64;;"
	"SpecMap;code:259;type:wlist;len:64;;"
    },
    {
	"group",
	"Group;code:401;rq;ro;len:32;;"
	"MaxResults;code:402;type:word;len:12;;"
	"MaxScanRows;code:403;type:word;len:12;;"
	"MaxLockTime;code:407;type:word;len:12;;"
	"Timeout;code:406;type:word;len:12;;"
	"PasswordTimeout;code:409;type:word;len:12;;"
	"Subgroups;code:404;type:wlist;len:32;opt:default;;"
	"Owners;code:408;type:wlist;len:32;opt:default;;"
	"Users;code:405;type:wlist;len:32;opt:default;;"
    },
    {
	"job",
	"Job;code:101;rq;len:32;;"
	"Status;code:102;type:select;rq;len:10;"
	    "pre:open;val:open/suspended/closed;;"
	"User;code:103;rq;len:32;pre:$user;;"
	"Date;code:104;type:date;ro;len:20;pre:$now;;"
	"Description;code:105;type:text;rq;pre:$blank;;"
    },
    {
	"label",
	"Label;code:301;rq;ro;fmt:L;len:32;;"
	"Update;code:302;type:date;ro;fmt:L;len:20;;"
	"Access;code:303;type:date;ro;fmt:L;len:20;;"
	"Owner;code:304;fmt:R;len:32;;"
	"Description;code:306;type:text;len:128;;"
	"Options;code:309;type:line;len:64;val:"
	    "unlocked/locked,noautoreload/autoreload;;"
	"Revision;code:312;type:word;words:1;len:64;;"
	"View;code:311;type:wlist;len:64;;"
    },
    {
	"license",
	"License;code:451;len:32;;"
	"License-Expires;code:452;len:10;;"
	"Support-Expires;code:453;len:10;;"
	"Customer;code:454;type:line;len:128;;"
	"Application;code:455;len:32;;"
	"IPaddress;code:456;len:24;;"
	"IPservice;code:461;type:wlist;len:24;;"
	"Platform;code:457;len:32;;"
	"Clients;code:458;len:8;;"
	"Users;code:459;len:8;;"
	"Files;code:460;len:8;;"
    },
    {
	"protect",
	"Protections;code:501;type:wlist;words:5;opt:default;len:64;;"
    },
    {
	"spec",
	"Fields;code:351;type:wlist;words:5;rq;;"
	"Required;code:357;type:wlist;;"
	"Readonly;code:358;type:wlist;;"
	"Words;code:352;type:wlist;words:2;;"
	"Formats;code:353;type:wlist;words:3;;"
	"Values;code:354;type:wlist;words:2;;"
	"Presets;code:355;type:wlist;words:2;;"
	"Comments;code:356;type:text;;"
    },
    {
	"stream",
	"Stream;code:701;rq;ro;len:64;;"
	"Update;code:705;type:date;ro;fmt:L;len:20;;"
	"Access;code:706;type:date;ro;fmt:L;len:20;;"
	"Owner;code:704;len:32;;"
	"Name;code:703;rq;type:line;len:32;;"
	"Parent;code:702;rq;len:64;;"
	"Type;code:708;rq;len:32;;"
	"Description;code:709;type:text;len:128;;"
	"Options;code:707;type:line;len:64;val:"
	    "allsubmit/ownersubmit,unlocked/locked,"
	    "toparent/notoparent,fromparent/nofromparent;;"
	"Paths;code:710;rq;type:wlist;words:2;maxwords:3;len:64;;"
	"Remapped;code:711;type:wlist;words:2;len:64;;"
	"Ignored;code:712;type:wlist;words:1;len:64;;"
	"View;code:713;type:wlist;words:2;len:64;;"
    },
    {
	"triggers",
	"Triggers;code:551;type:wlist;words:4;len:64;opt:default;"
    },
    {
	"typemap",
	"TypeMap;code:601;type:wlist;words:2;len:64;opt:default;"
    },
    {
	"user",
	"User;code:651;rq;ro;seq:1;len:32;;"
	"Type;code:659;ro;fmt:R;len:10;;"
	"Email;code:652;fmt:R;rq;seq:3;len:32;;"
	"Update;code:653;fmt:L;type:date;ro;seq:2;len:20;;"
	"Access;code:654;fmt:L;type:date;ro;len:20;;"
	"FullName;code:655;fmt:R;type:line;rq;len:32;;"
	"JobView;code:656;type:line;len:64;;"
	"Password;code:657;len:32;;"
	"Reviews;code:658;type:wlist;len:64;;"
    },
    {
	"server",
	"ServerID;code:751;rq;ro;len:32;;"
	"Type;code:752;rq;len:32;;"
	"Name;code:753;type:line;len:32;;"
	"Address;code:754;type:line;len:32;;"
	"Services;code:755;rq;len:128;;"
	"Description;code:756;type:text;len:128;;"
	"ClientDataFilter;code:757;type:wlist;len:64;;"
	"RevisionDataFilter;code:758;type:wlist;len:64;;"
    },
    { 0, 0 }
};


SpecMgr::SpecMgr()
{
	debug = 0;
	specs = 0;
	encoding = "";
	Reset();
}

SpecMgr::~SpecMgr()
{
	delete specs;
}

void
SpecMgr::AddSpecDef( const char *type, StrPtr &specDef )
{
	if( specs->GetVar( type ) )
		specs->RemoveVar( type );
	specs->SetVar( type, specDef );
}

void
SpecMgr::AddSpecDef( const char *type, const char *specDef )
{
	if( specs->GetVar( type ) )
		specs->RemoveVar( type );
	specs->SetVar( type, specDef );
}


void
SpecMgr::Reset()
{
	delete specs;
	specs = new StrBufDict;

	for( struct specdata *sp = &speclist[ 0 ]; sp->type; sp++ )
		AddSpecDef( sp->type, sp->spec );

}

int
SpecMgr::HaveSpecDef( const char *type )
{
	return specs->GetVar( type ) != 0;
}

PyObject * SpecMgr::CreatePyString( const char * s )
{
    return CreatePythonString( s, encoding.Text() );
}

PyObject * SpecMgr::CreatePyStringAndSize(const char * text, size_t len)
{
    return CreatePythonStringAndSize( text, len, encoding.Text() );
}

//
// Convert a Perforce StrDict into a Python dict. Convert multi-level 
// data (Files0, Files1 etc. ) into (nested) array members of the dict. 
//

PyObject * SpecMgr::StrDictToDict( StrDict *dict, PyObject * pydict )
{
    return StrDictToDict(dict, pydict, debug);
}

PyObject * SpecMgr::StrDictToDict( StrDict *dict, PyObject * pydict, int debug )
{
	StrRef	var, val;
	int		i;

	if( pydict == NULL )
		pydict = PyDict_New();

	// TODO: Exception in case it failed to create pydict

	for ( i = 0; dict->GetVar( i, var, val ); i++ )
	{
		if ( var == "specdef" || var == "func" || var == "specFormatted" )
			continue;

		InsertItem( pydict, &var, &val, debug );
	}
	return pydict;
}

//
// Convert a Perforce StrDict into a P4.Spec object
//

PyObject * SpecMgr::StrDictToSpec( StrDict *dict, StrPtr *specDef )
{
    // This converts it to a string, and then to a dict, so we go from one 
    // type of dictionary to another, via an intermediate form (a StrBuf).

    SpecDataTable dictData( dict );
    StrBuf form;
	
    Error e;
    Spec s( specDef->Text(), "", &e );

    if( e.Test() ) Py_RETURN_FALSE;

    // Format the StrDict into a StrBuf object
    s.Format( &dictData, &form );

    // Now parse the StrBuf into a new P4::Spec object
    PyObject * spec = NewSpec( specDef );
    PythonSpecData specData( spec );

    s.ParseNoValid( form.Text(), &specData, &e );
    if( e.Test() ) Py_RETURN_FALSE;

    // Now see if there are any extraTag fields as we'll need to
    // add those fields into our output. Just iterate over them
    // extracting the fields and inserting them as we go.
    int i = 0;
    StrRef et("extraTag" );
    for( i = 0; ; i++ )
    {
		StrBuf tag;
		StrPtr *var;
		StrPtr *val;

		tag << et << i;

		if( !(var = dict->GetVar( tag ) ) )
			break;

		val = dict->GetVar( *var );

		if( !val )
			continue;

		InsertItem( spec, var, val );
    }

    return spec;
}

PyObject * SpecMgr::StringToSpec( const char *type, const char *form, Error *e )
{
	StrPtr * specDef = specs->GetVar( type );
	PyObject * spec = NewSpec( specDef );
	PythonSpecData specData( spec );
	
	Spec s( specDef->Text(), "", e );

	if( !e->Test() ) 
		s.ParseNoValid( form, &specData, e );

	if ( e->Test() )
		Py_RETURN_NONE;

	return spec;
}

//
// Format routine. updates a StrBuf object with the form content. 
// The StrBuf can then be converted to a Python string where required.
//
void SpecMgr::SpecToString( const char *type, PyObject * pydict, StrBuf &b, Error *e )
{
	StrBuf	buf;
	StrPtr *	specDef = specs->GetVar( type );

	if ( !specDef )
	{
		e->Set( E_FAILED, "No specdef available. Cannot convert dict to a "
				"Perforce form" );
		return;
	}

	PythonSpecData specData( pydict );

	Spec s( specDef->Text(), "", e );
	if( e->Test() ) return;

	s.Format( &specData, &b );
}

//
// This method returns a dict describing the valid fields in the spec. To
// make it easy on our users, we map the lowercase name to the name defined
// in the spec (with an underscore in front). 
// Thus, the users can always user lowercase, and if the field
// should be in mixed case, it will be. See P4.Spec.__getattr__ and __setattr__
//

PyObject * SpecMgr::SpecFields( const char *type )
{
	return SpecFields( specs->GetVar( type ) );
}

PyObject * SpecMgr::SpecFields( StrPtr *specDef )
{
	if( !specDef ) Py_RETURN_NONE;

	PyObject * 	dict = PyDict_New();

	Error e;

	Spec s( specDef->Text(), "", &e );
	if ( e.Test() ) Py_RETURN_NONE;
	
	for( int i = 0; i < s.Count(); i++ )
	{
	    //
		// Here we abuse the fact that SpecElem::tag is public, even though it's
		// only supposed to be public to SpecData's subclasses. It's hard to
		// see that changing anytime soon, and it makes this so simple and
		// reliable. So...
		//

		SpecElem * se = s.Get( i );
		StrBuf v = se->tag;
		StrBuf k = v;
		
		StrOps::Lower( k );

		PyObject * str = CreatePyString( v.Text() );
		if( str ) {
		    PyDict_SetItemString(dict, k.Text(), str );
		    Py_DECREF( str );
		}
		else {
		    return NULL;
		}
	}
	return dict;
}

//
// Split a key into its base name and its index. i.e. for a key "how1,0"
// the base name is "how" and they index is "1,0". We work backwards from
// the end of the key looking for the first char that is neither a
// digit, nor a comma.
//

void SpecMgr::SplitKey( const StrPtr *key, StrBuf &base, StrBuf &index )
{
	if ( key->Contains(StrRef("attr-")) == key->Text() || key->Contains(StrRef("openattr-")) == key->Text() ) {
		base.Set( key->Text(), key->Length() );
		index.Set( key->Text() + key->Length() );
		return;
	}
	
	base = *key;
	index = "";
	for ( size_t i = key->Length(); i; i-- )
	{
		char	prev = (*key)[ i-1 ];
		if ( !isdigit( prev ) && prev != ',' )
		{
			base.Set( key->Text(), i );
			index.Set( key->Text() + i );
			break;
		}
	}
}

//
// Insert an element into the response structure. The element may need to
// be inserted into an array nested deeply within the enclosing dict.
//

void SpecMgr::InsertItem( PyObject * dict, const StrPtr *var, const StrPtr *val )
{
    InsertItem(dict, var, val, debug);
}

void SpecMgr::InsertItem( PyObject * dict, const StrPtr *var, const StrPtr *val , int debug)
{
	StrBuf	base, index;
	StrRef	comma( "," );

	SplitKey( var, base, index );

	// If there's no index, then we insert into the top level dict 
	// but if the key is already defined then we need to rename the key. This
	// is probably one of those special keys like otherOpen which can be
	// both an array element and a scalar. The scalar comes last, so we
	// just rename it to "otherOpens" to avoid trashing the previous key
	// value

	if ( index == "" )
	{
		StrBuf key(*var);

		if ( PyDict_GetItemString( dict, key.Text() ))
			key << "s";

		if( P4PYDBG_DATA )
			cerr << "... " << key.Text() << " -> " << val->Text() << endl;

		PyObject * str = CreatePyString( val->Text() );
		if( str ) {
		    PyDict_SetItemString( dict, key.Text(),  str);
		    Py_DECREF( str );
		}
		return;
	}

	//
	// Get or create the parent array from the dict.
	//
	PyObject * list = PyDict_GetItemString( dict, base.Text() );

	if ( NULL == list )
	{
		list = PyList_New(0);
		PyDict_SetItemString( dict, base.Text(), list );
		Py_DECREF( list );
	}
	else if( ! PyList_Check(list) )
	{
		//
		// There's an index in our var name, but the name is already defined 
		// and the value it contains is not an array. This means we've got a 
		// name collision. This can happen in 'p4 diff2' for example, when 
		// one file gets 'depotFile' and the other gets 'depotFile2'. In 
		// these cases it makes sense to keep the structure flat so we
		// just use the raw variable name.
		//
		if( P4PYDBG_DATA )
			cerr << "... " << var->Text() << " -> " << val->Text() << endl;

		PyObject * str = CreatePyString( val->Text() );
		if( str ) {
		    PyDict_SetItemString( dict, var->Text(), str );
		    Py_DECREF( str );
		}
		return;
	}

	// The index may be a simple digit, or it could be a comma separated
	// list of digits. For each "level" in the index, we need a containing
	// array.
	if( P4PYDBG_DATA )
		cerr <<  "... " << base.Text() << " -> [";

	for( const char *c = 0 ; ( c = index.Contains( comma ) ); )
	{
		StrBuf	level;
		level.Set( index.Text(), c - index.Text() );
		index.Set( c + 1 );
		
		// Found another level so we need to get/create a nested array
		// under the current entry. We use the level as an index so that
		// missing entries are left empty deliberately.

		int levelValue = level.Atoi();
		PyObject * tlist = NULL;

		// Since Python does not allow access to array entries beyond its size 
		// and does not fill missing entries with None automatically as Ruby does
		// we need to fill in the missing bits ourself

		if ( levelValue >= PyList_Size(list) )
		{
			// no entries exist yet, fill the missing bits up with Py_None
			for (Py_ssize_t i = PyList_Size(list); i < levelValue; i++) {
				PyList_Append(list, Py_None);
			}
			tlist = PyList_New(0);
			PyList_Append(list, tlist);
			Py_DECREF( tlist );
		}
		else 
		{
			tlist = PyList_GetItem( list, levelValue );
			if (tlist == Py_None) {
				tlist = PyList_New(0);
				PyList_Append(list, tlist);
				Py_DECREF( tlist );
			}
		}

		if( P4PYDBG_DATA )
			cerr << level.Text() << "][";

		list = tlist;
	}
	
	for ( int i = index.Atoi(); i > PyList_Size(list); ) {
		PyList_Append( list, Py_None);
	}
	
	if( P4PYDBG_DATA )
		cerr << PyList_Size(list) << "] = " <<  val->Text() << endl;

	PyObject * str = CreatePyString( val->Text() );
	if( str ) {
	    PyList_Append( list, str );
	    Py_DECREF( str );
	}
}

//
// Create a new P4.Spec object and return it.
//

PyObject * SpecMgr::NewSpec( StrPtr *specDef )
{
	PyObject * module = PyImport_ImportModule("P4");
	if (module == NULL) {
		cerr << "Cannot find module P4, using <dict> instead of P4.Spec" << endl;
		return PyDict_New();
	}

	PyObject * 	fields = SpecFields( specDef );
	PyObject * newObj = PyObject_CallMethod(module, (char*)"Spec", (char*)"(O)", fields);
	if (newObj == NULL) {
		cout << "WARNING : could not find spec !!!" << endl;
	}
	return newObj;
}

#if PY_MAJOR_VERSION >= 3

PyObject * CreatePythonStringAndSize(const char * text, size_t len, const char *encoding) {
    if( strlen(encoding) == 0) {
	return PyUnicode_DecodeUTF8(text, len, "replace");
    }
    else {
	if( ! strcmp("raw", encoding) ) {
	    return PyBytes_FromStringAndSize(text, len);
	}
	else {
	    return PyUnicode_Decode(text, len, encoding, "strict");
	}
    }
}

PyObject * CreatePythonString(const char * text, const char *encoding) {
    return CreatePythonStringAndSize(text, strlen(text), encoding);
}

const char * GetPythonString(PyObject *obj) {
    if( PyUnicode_Check(obj) ) {
        return PyUnicode_AsUTF8(obj);
    }
    else
        return PyBytes_AS_STRING(obj);
}

#endif