pjs/caps/include/nsTarget.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */

#ifndef _NS_TARGET_H_
#define _NS_TARGET_H_

#include <string.h>
#include "prtypes.h"
#include "plhash.h"

#include "nsHashtable.h"
#include "nsVector.h"
#include "nsCaps.h"
#include "nsPrincipal.h"
#include "nsPrivilege.h"
#include "nsUserDialogHelper.h"

typedef nsVector nsTargetArray;

PR_BEGIN_EXTERN_C
#include "jpermission.h"
PR_PUBLIC_API(void)
java_netscape_security_getTargetDetails(const char *charSetName, char* targetName, 
                                        char** details, char **risk);
PR_END_EXTERN_C

extern int CAPS_TARGET_RISK_COLOR_HIGH;

extern PRBool CreateSystemTargets(nsPrincipal *sysPrin);

struct nsTarget {

public:

	/* Public Methods */

	virtual ~nsTarget(void);

	nsTarget(char *name, nsPrincipal *prin, 
             PRInt32 risk = JavaSecUI_targetRiskHigh(), 
             char *riskColor = JavaSecUI_getString(CAPS_TARGET_RISK_COLOR_HIGH), 
             char *description = NULL, 
             char *detailDescription = NULL,
             char *url = NULL, 
             nsTargetArray* targetArray = NULL)
    {
  		init(name, prin, targetArray, risk, riskColor, description, 
             detailDescription, url);
    }

	nsTarget * registerTarget(void);

	nsTarget * registerTarget(void* context);

	static nsTarget * findTarget(nsTarget *target);

	static nsTarget * findTarget(char *name);

	static nsTarget * findTarget(char *name, nsPrincipal *prin);

	nsPrivilege * checkPrivilegeEnabled(nsTargetArray* prinArray, void *data);

	nsPrivilege * checkPrivilegeEnabled(nsTargetArray* prinArray);

	nsPrivilege * checkPrivilegeEnabled(nsPrincipal *p, void *data);

	virtual nsPrivilege * enablePrivilege(nsPrincipal *prin, void *data);

	nsPrivilege * getPrincipalPrivilege(nsPrincipal *prin, void *data);

	nsTargetArray* getFlattenedTargetArray(void);

	static nsTargetArray* getAllRegisteredTargets(void);

	char * getRisk(void);

	char * getRiskColor(void);

	char * getDescription(void);

	char * getDetailDescription(void);

	static nsTarget * getTargetFromDescription(char *a);

	char * getHelpURL(void);

	char * getDetailedInfo(void *a);

	nsPrincipal * getPrincipal(void);

	char * getName(void);

	PRBool equals(nsTarget *a);

	PRInt32 hashCode(void);

	char * toString(void);

	PRBool isRegistered(void);

private:

	/* Private Field Accessors */
	char * itsName;

	nsPrincipal * itsPrincipal;

	PRInt32 itsRisk;

	char * itsRiskColorStr;

	char * itsDescriptionStr;

	char * itsDetailDescriptionStr;

	char * itsURLStr;

	PRBool itsRegistered;

	nsTargetArray* itsTargetArray;

	nsTargetArray* itsExpandedTargetArray;
	
	char *itsString;

	PRUint32 itsDescriptionHash;

	static PRBool theInited;

	/* Private Methods */
	void init(char *name, nsPrincipal *prin, nsTargetArray* targetArray, PRInt32 risk, char *riskColor, char *description, char *detailDescription, char *url);

	void getFlattenedTargets(nsHashtable *targHash, nsTargetArray* expandedTargetArray);

};


class TargetKey: public nsHashKey {
public:
  nsTarget *itsTarget;
  TargetKey(nsTarget *targ) {
    itsTarget = targ;
  }
  
  PRUint32 HashValue(void) const {
    return itsTarget->hashCode();
  }

  PRBool Equals(const nsHashKey *aKey) const {
    return (itsTarget->equals(((const TargetKey *) aKey)->itsTarget));
  }

  nsHashKey *Clone(void) const {
    return new TargetKey(itsTarget);
  }
};

/* XXX: IMO, IntegerKey and StringKey should be part of xpcom */
class IntegerKey: public nsHashKey {
private:
  PRUint32 itsHash;
  
public:
  IntegerKey(PRUint32 hash) {
    itsHash = hash;
  }
  
  PRUint32 HashValue(void) const {
    return itsHash;
  }

  PRBool Equals(const nsHashKey *aKey) const {
    return (itsHash == (((const IntegerKey *) aKey)->itsHash)) ? PR_TRUE : PR_FALSE;
  }

  nsHashKey *Clone(void) const {
    return new IntegerKey(itsHash);
  }
};

class StringKey: public nsHashKey {
public:
  const char *itsString;

  StringKey(const char *string) {
    itsString = string;
  }
  
  PRUint32 HashValue(void) const {
    return PL_HashString(itsString);
  }

  PRBool Equals(const nsHashKey *aKey) const {
    return (strcmp(itsString, (((const StringKey *) aKey)->itsString)) == 0);
  }

  nsHashKey *Clone(void) const {
    return new StringKey(itsString);
  }
};

#endif /* _NS_TARGET_H_ */