src/org/z3950/zing/cql/CQLNode.java

   1 // $Id: CQLNode.java,v 1.17 2002-12-06 12:35:15 mike Exp $
   2
   3 package org.z3950.zing.cql;
   4 import java.util.Properties;
   5 import java.util.Vector;
   6
   7
   8 /**
   9  * Represents a node in a CQL parse-tree.
  10  *
  11  * @version     $Id: CQLNode.java,v 1.17 2002-12-06 12:35:15 mike Exp $
  12  */
  13 public abstract class CQLNode {
  14     CQLNode() {}                // prevent javadoc from documenting this
  15
  16     /**
  17      * Translates a parse-tree into an XCQL document.
  18      * <P>
  19      * @param level
  20      *  The number of levels to indent the top element of the XCQL
  21      *  document.  This will typically be 0 when invoked by an
  22      *  application; it takes higher values when this method is
  23      *  invoked recursively for nodes further down the tree.
  24      * @return
  25      *  A String containing an XCQL document equivalent to the
  26      *  parse-tree whose root is this node.
  27      */
  28     public String toXCQL(int level) {
  29         return toXCQL(level, new Vector());
  30     }
  31
  32     abstract public String toXCQL(int level, Vector prefixes);
  33
  34     protected static String renderPrefixes(int level, Vector prefixes) {
  35         if (prefixes.size() == 0)
  36             return "";
  37         String res = indent(level) + "<prefixes>\n";
  38         for (int i = 0; i < prefixes.size(); i++) {
  39             CQLPrefix p = (CQLPrefix) prefixes.get(i);
  40             res += indent(level+1) + "<prefix>\n";
  41             if (p.name != null)
  42                 res += indent(level+2) + "<name>" + p.name + "</name>\n";
  43             res += indent(level+2) +
  44                 "<identifier>" + p.identifier + "</identifier>\n";
  45             res += indent(level+1) + "</prefix>\n";
  46         }
  47         return res + indent(level) + "</prefixes>\n";
  48     }
  49
  50     /**
  51      * Decompiles a parse-tree into a CQL query.
  52      * <P>
  53      * @return
  54      *  A String containing a CQL query equivalent to the parse-tree
  55      *  whose root is this node, so that compiling that query will
  56      *  yield an identical tree.
  57      */
  58     abstract public String toCQL();
  59
  60     /**
  61      * Renders a parse-tree into a Yaz-style PQF string.
  62      * PQF, or Prefix Query Format, is a cryptic but powerful notation
  63      * that can be trivially mapped, one-to-one, int Z39.50 Type-1 and
  64      * Type-101 queries.  A specification for the format can be found
  65      * in
  66      * <A href="http://indexdata.dk/yaz/doc/tools.php#PQF"
  67      *  >Chapter 7 (Supporting Tools)</A> of the
  68      * <A href="http://indexdata.dk/yaz/">YAZ</A> manual.
  69      * <P>
  70      * @param config
  71      *  A <TT>Properties</TT> object containing configuration
  72      *  information that specifies the mapping from CQL qualifiers,
  73      *  relations, etc. to Type-1 attributes.  The mapping
  74      *  specification is described in the cql-java distribution's
  75      *  sample PQF-mapping configuration file,
  76      *  <TT>etc/pqf.properties</TT>, which see.
  77      * @return
  78      *  A String containing a PQF query equivalent to the parse-tree
  79      *  whose root is this node.  This may be fed into the tool of
  80      *  your choice to obtain a BER-encoded packet.
  81      */
  82     abstract public String toPQF(Properties config)
  83         throws PQFTranslationException;
  84
  85     /**
  86      * Returns a String of spaces for indenting to the specified level.
  87      */
  88     protected static String indent(int level) { return Utils.indent(level); }
  89
  90     /**
  91      * Returns the argument String quoted for XML.
  92      * For example, each occurrence of <TT>&lt;</TT> is translated to
  93      * <TT>&amp;lt;</TT>.
  94      */
  95     protected static String xq(String str) { return Utils.xq(str); }
  96
  97     /**
  98      * ### Document this!
  99      * ftp://ftp.rsasecurity.com/pub/pkcs/ascii/layman.asc
 100      */
 101     abstract public byte[] toType1(Properties config)
 102         throws PQFTranslationException;
 103
 104     // ANS.1 classes
 105     protected static final int UNIVERSAL   = 0;
 106     protected static final int APPLICATION = 1;
 107     protected static final int CONTEXT     = 2;
 108     protected static final int PRIVATE     = 3;
 109
 110     // ASN.1 tag forms
 111     protected static final int PRIMITIVE   = 0;
 112     protected static final int CONSTRUCTED = 1;
 113
 114     // ASN.1 UNIVERSAL data types
 115     public static final byte BOOLEAN          =  1;
 116     public static final byte INTEGER          =  2;
 117     public static final byte BITSTRING        =  3;
 118     public static final byte OCTETSTRING      =  4;
 119     public static final byte NULL             =  5;
 120     public static final byte OBJECTIDENTIFIER =  6;
 121     public static final byte OBJECTDESCRIPTOR =  7;
 122     public static final byte EXTERNAL         =  8;
 123     public static final byte ENUMERATED       = 10;
 124     public static final byte SEQUENCE         = 16;
 125     public static final byte SET              = 17;
 126     public static final byte VISIBLESTRING    = 26;
 127     public static final byte GENERALSTRING    = 27;
 128
 129     protected static final int putTag(int asn1class, int fldid, int form,
 130                                       byte[] record, int offset) {
 131         if (fldid < 31)
 132             record[offset++] = (byte)(fldid + asn1class*64 + form*32);
 133         else {
 134             record[offset++] = (byte)(31 + asn1class*64 + form*32);
 135             if (fldid < 128)
 136                 record[offset++] = (byte)(fldid);
 137             else {
 138                 record[offset++] = (byte)(128 + fldid/128);
 139                 record[offset++] = (byte)(fldid % 128);
 140             }
 141         }
 142         return offset;
 143     }
 144
 145     /**
 146      * Put a length directly into a BER record.
 147      *
 148      * @param length length to put into record
 149      * @return the new, incremented value of the offset parameter.
 150      */
 151     public // ### shouldn't this be protected?
 152         static final int putLen(int len, byte[] record, int offset) {
 153
 154         if (len < 128)
 155             record[offset++] = (byte)len;
 156         else {
 157             int t;
 158             record[offset] = (byte)(lenLen(len) - 1);
 159             for (t = record[offset]; t > 0; t--) {
 160                 record[offset+t] = (byte)(len & 0xff);
 161                 len >>= 8;
 162             }
 163             t = offset;
 164             offset += (record[offset]&0xff) + 1;
 165             record[t] += 128; // turn on bit 8 in length byte.
 166         }
 167         return offset;
 168     }
 169
 170     /**
 171      * Get the length needed to represent the given length.
 172      *
 173      * @param length determine length needed to encode this
 174      * @return length needed to encode given length
 175      */
 176     protected // ### shouldn't this be private?
 177         static final int lenLen(int length) {
 178
 179         return ((length < 128) ? 1 :
 180             (length < 256) ? 2 :
 181                 (length < 65536L) ? 3 : 4);
 182     }
 183
 184     /**
 185      * Get the length needed to represent the given number.
 186      *
 187      * @param number determine length needed to encode this
 188      * @return length needed to encode given number
 189      */
 190     protected static final int numLen(long num) {
 191         num = num < 0 ? -num : num;
 192         // ### Wouldn't this be better done algorithmically?
 193         // Or at least with the constants expressed in hex?
 194         return ((num < 128) ? 1 :
 195             (num < 32768) ? 2 :
 196                 (num < 8388608) ? 3 :
 197                     (num < 2147483648L) ? 4 :
 198                         (num < 549755813888L) ? 5 :
 199                             (num < 140737488355328L) ? 6 :
 200                                 (num < 36028797018963968L) ? 7 : 8);
 201     }
 202
 203     /**
 204      * Put a number into a given buffer
 205      *
 206      * @param num number to put into buffer
 207      * @param record buffer to use
 208      * @param offset offset into buffer
 209      * @return the new, incremented value of the offset parameter.
 210      */
 211     protected static final int putNum(long num, byte record[], int offset) {
 212         int cnt=numLen(num);
 213
 214         for (int count = cnt - 1; count >= 0; count--) {
 215             record[offset+count] = (byte)(num & 0xff);
 216             num >>= 8;
 217         }
 218         return offset+cnt;
 219     }
 220
 221     // Used only by the makeOID() method
 222     private static final java.util.Hashtable madeOIDs =
 223         new java.util.Hashtable(10);
 224
 225     protected static final byte[] makeOID(String oid) {
 226         byte[] o;
 227         int dot, offset = 0, oidOffset = 0, value;
 228
 229         if ((o = (byte[])madeOIDs.get(oid)) == null) {
 230             o = new byte[100];
 231
 232             // Isn't this kind of thing excruciating in Java?
 233             while (oidOffset < oid.length() &&
 234               Character.isDigit(oid.charAt(oidOffset)) == true) {
 235                 if (offset > 90) // too large
 236                     return null;
 237
 238                 dot = oid.indexOf('.', oidOffset);
 239                 if (dot == -1)
 240                     dot = oid.length();
 241
 242                 value = Integer.parseInt(oid.substring(oidOffset, dot));
 243
 244                 if (offset == 0) {  // 1st two are special
 245                     if (dot == -1) // ### can't happen: -1 is reassigned above
 246                         return null; // can't be this short
 247                     oidOffset = dot+1; // skip past '.'
 248
 249                     dot = oid.indexOf('.', oidOffset);
 250                     if (dot == -1)
 251                         dot = oid.length();
 252
 253                     // ### Eh?!
 254                     value = value * 40 +
 255                         Integer.parseInt(oid.substring(oidOffset,dot));
 256                 }
 257
 258                 if (value < 0x80) {
 259                     o[offset++] = (byte)value;
 260                 } else {
 261                     int count = 0;
 262                     byte bits[] = new byte[12]; // save a 84 (12*7) bit number
 263
 264                     while (value != 0) {
 265                         bits[count++] = (byte)(value & 0x7f);
 266                         value >>= 7;
 267                     }
 268
 269                     // Now place in the correct order
 270                     while (--count > 0)
 271                         o[offset++] = (byte)(bits[count] | 0x80);
 272
 273                     o[offset++] = bits[count];
 274                 }
 275
 276                 dot = oid.indexOf('.', oidOffset);
 277                 if (dot == -1)
 278                     break;
 279
 280                 oidOffset = dot+1;
 281             }
 282
 283             byte[] ptr = new byte[offset];
 284             System.arraycopy(o, 0, ptr, 0, offset);
 285             madeOIDs.put(oid, ptr);
 286             return ptr;
 287         }
 288         return o;
 289     }
 290
 291     public static final byte[] makeQuery(CQLNode root, Properties properties)
 292         throws PQFTranslationException {
 293         byte[] rpnStructure = root.toType1(properties);
 294         byte[] qry = new byte[rpnStructure.length+100];
 295         int offset = 0;
 296         offset = putTag(CONTEXT, 1, CONSTRUCTED, qry, offset);
 297         qry[offset++] = (byte)(0x80&0xff);  // indefinite length
 298         offset = putTag(UNIVERSAL, OBJECTIDENTIFIER, PRIMITIVE, qry, offset);
 299         byte[] oid = makeOID("1.2.840.10003.3.1"); // bib-1
 300         offset = putLen(oid.length, qry, offset);
 301         System.arraycopy(oid, 0, qry, offset, oid.length);
 302         offset += oid.length;
 303         System.arraycopy(rpnStructure, 0, qry, offset, rpnStructure.length);
 304         offset += rpnStructure.length;
 305         qry[offset++] = 0x00;  // end of query
 306         qry[offset++] = 0x00;
 307         byte[] q = new byte[offset];
 308         System.arraycopy(qry, 0, q, 0, offset);
 309         return q;
 310     }
 311 }