yacy_search_server/source/de/anomic/index/indexURLEntryOld.java

// plasmaCrawlLURLOldEntry.java
// (C) 2006 by Michael Peter Christen; mc@anomic.de, Frankfurt a. M., Germany
// first published 13.10.2006 on http://www.anomic.de
//
// This is a part of YaCy, a peer-to-peer based web search engine
//
// $LastChangedDate: 2006-04-02 22:40:07 +0200 (So, 02 Apr 2006) $
// $LastChangedRevision: 1986 $
// $LastChangedBy: orbiter $
//
// LICENSE
// 
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

package de.anomic.index;

import java.io.IOException;
import java.util.Date;
import java.util.Properties;

import de.anomic.http.httpc;
import de.anomic.kelondro.kelondroBase64Order;
import de.anomic.kelondro.kelondroBitfield;
import de.anomic.kelondro.kelondroRow;
import de.anomic.net.URL;
import de.anomic.plasma.plasmaSearchQuery;
import de.anomic.plasma.plasmaURL;
import de.anomic.server.logging.serverLog;
import de.anomic.tools.crypt;
import de.anomic.yacy.yacySeedDB;

public class indexURLEntryOld implements indexURLEntry {
    
    public static final kelondroRow rowdef = new kelondroRow(
            "String urlhash-" + yacySeedDB.commonHashLength + ", " + // the url's hash
            "String urlstring-256, " +                               // the url as string
            "String urldescr-80, " +                                 // the description of the url
            "Cardinal moddate-4 {b64e}, " +                          // last-modified from the httpd
            "Cardinal loaddate-4 {b64e}, " +                         // time when the url was loaded
            "String refhash-" + yacySeedDB.commonHashLength + ", " + // the url's referrer hash
            "Cardinal copycount-2 {b64e}, " +                        // not used
            "byte[] flags-2, " +                                     // flags
            "Cardinal quality-3 {b64e}, " +                          // deprecated
            "String language-2, " +                                  // language key; mainly the TDL
            "byte[] doctype-1, " +                                   //
            "Cardinal size-6 {b64e}, " +                             // size of file in bytes
            "Cardinal wc-3 {b64e}",                                  // word count
            kelondroBase64Order.enhancedCoder,
            0);

    private URL url;
    private String descr;
    private Date moddate;
    private Date loaddate;
    private String urlHash;
    private String referrerHash;
    private int copyCount;
    private String flags;
    private int quality;
    private String language;
    private char doctype;
    private int size;
    private int wordCount;
    private String snippet;
    private indexRWIEntry word; // this is only used if the url is transported via remote search requests

    public indexURLEntryOld(
            URL url,
            String descr,
            String author,
            String tags,
            String ETag,
            Date mod,
            Date load,
            Date fresh,
            String referrer,
            byte[] md5,
            long size,
            int wc,
            char dt,
            kelondroBitfield flags,
            String lang,
            int llocal,
            int lother,
            int laudio,
            int limage,
            int lvideo,
            int lapp) {
        // create new entry and store it into database
        this.urlHash = plasmaURL.urlHash(url);
        this.url = url;
        this.descr = (descr == null) ? this.url.toString() : descr;
        this.moddate = mod;
        this.loaddate = load;
        this.referrerHash = (referrerHash == null) ? plasmaURL.dummyHash : referrerHash;
        this.copyCount = 0; // the number of remote (global) copies of this object without this one
        this.flags = "  ";
        this.quality = 0;
        this.language = (language == null) ? "uk" : language;
        this.doctype = dt;
        this.size = (int) size;
        this.wordCount = wc;
        this.snippet = null;
        this.word = null;
    }

    public indexURLEntryOld(kelondroRow.Entry entry, indexRWIEntry searchedWord) throws IOException {
        try {
            this.urlHash = entry.getColString(0, null);
            this.url = new URL(entry.getColString(1, "UTF-8"));
            this.descr = (entry.empty(2)) ? this.url.toString() : entry.getColString(2, "UTF-8").trim();
            this.moddate = new Date(86400000 * entry.getColLong(3));
            this.loaddate = new Date(86400000 * entry.getColLong(4));
            this.referrerHash = (entry.empty(5)) ? plasmaURL.dummyHash : entry.getColString(5, "UTF-8");
            this.copyCount = (int) entry.getColLong(6);
            this.flags = entry.getColString(7, "UTF-8");
            this.quality = (int) entry.getColLong(8);
            this.language = entry.getColString(9, "UTF-8");
            this.doctype = (char) entry.getColByte(10);
            this.size = (int) entry.getColLong(11);
            this.wordCount = (int) entry.getColLong(12);
            this.snippet = null;
            this.word = searchedWord;
            return;
        } catch (Exception e) {
            serverLog.logSevere("PLASMA", "INTERNAL ERROR in plasmaLURL.entry/1: " + e.toString(), e);
            throw new IOException("plasmaLURL.entry/1: " + e.toString());
        }
    }

    public indexURLEntryOld(Properties prop) {
        // generates an plasmaLURLEntry using the properties from the argument
        // the property names must correspond to the one from toString
        //System.out.println("DEBUG-ENTRY: prop=" + prop.toString());
        this.urlHash = prop.getProperty("hash", plasmaURL.dummyHash);
        try {
            this.referrerHash = prop.getProperty("referrer", plasmaURL.dummyHash);
            this.moddate = plasmaURL.shortDayFormatter.parse(prop.getProperty("mod", "20000101"));
            //System.out.println("DEBUG: moddate = " + moddate + ", prop=" + prop.getProperty("mod"));
            this.loaddate = plasmaURL.shortDayFormatter.parse(prop.getProperty("load", "20000101"));
            this.copyCount = Integer.parseInt(prop.getProperty("cc", "0"));
            this.flags = ((prop.getProperty("local", "true").equals("true")) ? "L " : "  ");
            this.url = new URL(crypt.simpleDecode(prop.getProperty("url", ""), null));
            this.descr = crypt.simpleDecode(prop.getProperty("descr", ""), null);
            if (this.descr == null) this.descr = this.url.toString();
            this.quality = (int) kelondroBase64Order.enhancedCoder.decodeLong(prop.getProperty("q", ""));
            this.language = prop.getProperty("lang", "uk");
            this.doctype = prop.getProperty("dt", "t").charAt(0);
            this.size = Integer.parseInt(prop.getProperty("size", "0"));
            this.wordCount = Integer.parseInt(prop.getProperty("wc", "0"));
            this.snippet = prop.getProperty("snippet", "");
            if (snippet.length() == 0) snippet = null;
            else snippet = crypt.simpleDecode(snippet, null);
            this.word = null;
            if (prop.containsKey("word")) {
                this.word = new indexRWIEntryOld(kelondroBase64Order.enhancedCoder.decodeString(prop.getProperty("word", "")));
            }
            if (prop.containsKey("wi")) {
                this.word = new indexRWIEntryNew(kelondroBase64Order.enhancedCoder.decodeString(prop.getProperty("wi", "")));
            }
        } catch (Exception e) {
            serverLog.logSevere("PLASMA",
                    "INTERNAL ERROR in plasmaLURL.entry/2:"
                    + "\nProperties: "
                    + ((prop == null) ? null : prop.toString())
                    + ((prop.containsKey("word")) ? "\nWord:       "
                    + kelondroBase64Order.enhancedCoder.decodeString(prop.getProperty("word", "")) : "") + "\nErrorMsg:   "
                    + e.toString(), e);
        }
    }

    public static kelondroRow rowdef() {
        return rowdef;
    }
    
    public kelondroRow.Entry toRowEntry() throws IOException {
        final String moddatestr = kelondroBase64Order.enhancedCoder.encodeLong(moddate.getTime() / 86400000, rowdef.width(3));
        final String loaddatestr = kelondroBase64Order.enhancedCoder.encodeLong(loaddate.getTime() / 86400000, rowdef.width(4));

        final byte[][] entry = new byte[][] {
                urlHash.getBytes(),
                url.toString().getBytes(),
                descr.getBytes(), // null?
                moddatestr.getBytes(),
                loaddatestr.getBytes(),
                referrerHash.getBytes(),
                kelondroBase64Order.enhancedCoder.encodeLong(copyCount, rowdef.width(6)).getBytes(),
                flags.getBytes(),
                kelondroBase64Order.enhancedCoder.encodeLong(quality, rowdef.width(8)).getBytes(),
                language.getBytes(),
                new byte[] { (byte) doctype },
                kelondroBase64Order.enhancedCoder.encodeLong(size, rowdef.width(11)).getBytes(),
                kelondroBase64Order.enhancedCoder.encodeLong(wordCount, rowdef.width(12)).getBytes()};
        return rowdef.newEntry(entry);
    }

    public String hash() {
        // return a url-hash, based on the md5 algorithm
        // the result is a String of 12 bytes within a 72-bit space
        // (each byte has an 6-bit range)
        // that should be enough for all web pages on the world
        return this.urlHash;
    }
    
    public Components comp() {
        return new Components(url, descr, "", "", "");
    }

    public Date moddate() {
        return moddate;
    }

    public Date loaddate() {
        return loaddate;
    }

    public Date freshdate() {
        return loaddate;
    }

    public String referrerHash() {
        // return the creator's hash
        return referrerHash;
    }

    public char doctype() {
        return doctype;
    }

    public int copyCount() {
        // return number of copies of this object in the global index
        return copyCount;
    }

    public boolean local() {
        // returns true if the url was created locally and is needed for own word index
        if (flags == null) return false;
        return flags.charAt(0) == 'L';
    }

    public int quality() {
        return quality;
    }

    public String language() {
        return (language == null) ? "en" : language;
    }

    public int size() {
        return size;
    }

    public int wordCount() {
        return wordCount;
    }
    
    public kelondroBitfield flags() {
        return plasmaSearchQuery.empty_constraint;
    }

    public String snippet() {
        // the snippet may appear here if the url was transported in a remote search
        // it will not be saved anywhere, but can only be requested here
        return snippet;
    }

    public indexRWIEntry word() {
        return word;
    }

    public boolean isOlder(indexURLEntry other) {
        if (other == null) return false;
        if (moddate.before(other.moddate())) return true;
        if (moddate.equals(other.moddate())) {
            if (loaddate.before(other.loaddate())) return true;
            if (loaddate.equals(other.loaddate())) return true;
        }
        return false;
    }

    private StringBuffer corePropList() {
        // generate a parseable string; this is a simple property-list
        final StringBuffer corePropStr = new StringBuffer(300);
        try {
            corePropStr.append("hash=").append(urlHash).append(",referrer=")
                    .append(referrerHash).append(",mod=").append(
                            plasmaURL.shortDayFormatter.format(moddate)).append(
                            ",load=").append(
                            plasmaURL.shortDayFormatter.format(loaddate))
                    .append(",size=").append(size).append(",wc=").append(
                            wordCount).append(",cc=").append(copyCount).append(
                            ",local=").append(((local()) ? "true" : "false"))
                    .append(",q=0")
                    .append(",dt=").append(doctype).append(",lang=").append(
                            language).append(",url=").append(
                            crypt.simpleEncode(url.toString())).append(
                            ",descr=").append(crypt.simpleEncode(descr));

            if (this.word != null) {
                // append also word properties
                if (this.word instanceof indexRWIEntryOld) corePropStr.append(",word=").append(kelondroBase64Order.enhancedCoder.encodeString(word.toPropertyForm()));
                if (this.word instanceof indexRWIEntryNew) corePropStr.append(",wi=").append(kelondroBase64Order.enhancedCoder.encodeString(word.toPropertyForm()));
            }
            return corePropStr;

        } catch (Exception e) {
            return null;
        }
    }

    public String toString(String snippet) {
        // add information needed for remote transport
        final StringBuffer core = corePropList();
        if (core == null)
            return null;

        core.ensureCapacity(core.length() + snippet.length() * 2);
        core.insert(0, "{");
        core.append(",snippet=").append(crypt.simpleEncode(snippet));
        core.append("}");

        return core.toString();
        //return "{" + core + ",snippet=" + crypt.simpleEncode(snippet) + "}";
    }

    /**
     * Returns this object as String.<br> 
     * This e.g. looks like this:
     * <pre>{hash=jmqfMk7Y3NKw,referrer=------------,mod=20050610,load=20051003,size=51666,wc=1392,cc=0,local=true,q=AEn,dt=h,lang=uk,url=b|aHR0cDovL3d3dy50cmFuc3BhcmVuY3kub3JnL3N1cnZleXMv,descr=b|S25vd2xlZGdlIENlbnRyZTogQ29ycnVwdGlvbiBTdXJ2ZXlzIGFuZCBJbmRpY2Vz}</pre>
     */
    public String toString() {
        final StringBuffer core = corePropList();
        if (core == null) return null;

        core.insert(0, "{");
        core.append("}");

        return core.toString();
        //return "{" + core + "}";
    }

    public void print() {
        System.out.println("URL           : " + url);
        System.out.println("Description   : " + descr);
        System.out.println("Modified      : " + httpc.dateString(moddate));
        System.out.println("Loaded        : " + httpc.dateString(loaddate));
        System.out.println("Size          : " + size + " bytes, " + wordCount
                + " words");
        System.out.println("Referrer Hash : " + referrerHash);
        System.out.println("Quality       : " + quality);
        System.out.println("Language      : " + language);
        System.out.println("DocType       : " + doctype);
        System.out.println();
    }

    // compatibility methods
    public int lapp() {
        return 0;
    }

    public int laudio() {
        return 0;
    }

    public int limage() {
        return 0;
    }

    public int llocal() {
        return 0;
    }

    public int lother() {
        return 0;
    }

    public int lvideo() {
        return 0;
    }

}