yacy_search_server/source/de/anomic/plasma/plasmaCrawlLURLNewEntry.java

package de.anomic.plasma;

import java.io.IOException;
import java.net.MalformedURLException;
import java.text.ParseException;
import java.util.Date;
import java.util.Properties;
import java.util.ArrayList;

import de.anomic.index.indexEntry;
import de.anomic.index.indexURL;
import de.anomic.index.indexURLEntry;
import de.anomic.kelondro.kelondroNaturalOrder;
import de.anomic.kelondro.kelondroBase64Order;
import de.anomic.kelondro.kelondroRow;
import de.anomic.net.URL;
import de.anomic.server.serverCharBuffer;
import de.anomic.server.serverCodings;
import de.anomic.tools.crypt;
import de.anomic.tools.bitfield;
import de.anomic.tools.nxTools;

public class plasmaCrawlLURLNewEntry implements plasmaCrawlLURLEntry {

    public static final kelondroRow rowdef = new kelondroRow(
        "String hash-12, " +            // the url's hash
        "String comp-360, " +           // components: the url, description, author and tags. As 5th element, an ETag is possible
        "Cardinal mod-4 {b256}, " +     // last-modified from the httpd
        "Cardinal load-4 {b256}, " +    // time when the url was loaded
        "Cardinal fresh-4 {b256}, " +   // time until this url is fresh
        "String referrer-12, " +        // (one of) the url's referrer hash(es)
        "byte[] md5-8, " +              // the md5 of the url content (to identify changes)
        "Cardinal size-6 {b256}, " +    // size of file in bytes
        "Cardinal wc-3 {b256}, " +      // size of file by number of words; for video and audio: seconds
        "byte[] dt-1, " +               // doctype, taken from extension or any other heuristic
        "byte[] flags-4, " +            // flags; any stuff (see Word-Entity definition)
        "String lang-2, " +             // language
        "Cardinal llocal-2 {b256}, " +  // # of outlinks to same domain; for video and image: width 
        "Cardinal lother-2 {b256}, " +  // # of outlinks to outside domain; for video and image: height
        "Cardinal limage-2 {b256}, " + // # of embedded image links
        "Cardinal laudio-2 {b256}, " +  // # of embedded audio links; for audio: track number; for video: number of audio tracks
        "Cardinal lvideo-2 {b256}, " +  // # of embedded video links
        "Cardinal lapp-2 {b256}");   // # of embedded links to applications
    
    private kelondroRow.Entry entry;
    private String snippet;
    private indexEntry word; // this is only used if the url is transported via remote search requests

    public plasmaCrawlLURLNewEntry(
            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,
            bitfield flags,
            String lang,
            int llocal,
            int lother,
            int laudio,
            int limage,
            int lvideo,
            int lapp) {
        // create new entry and store it into database
        this.entry = rowdef.newEntry();
        this.entry.setCol("hash", indexURL.urlHash(url), null);
        this.entry.setCol("comp", encodeComp(url, descr, author, tags, ETag));
        this.entry.setCol("mod", encodeDate(mod));
        this.entry.setCol("load", encodeDate(load));
        this.entry.setCol("fresh", encodeDate(fresh));
        this.entry.setCol("referrer", referrer.getBytes());
        this.entry.setCol("md5", md5);
        this.entry.setCol("size", size);
        this.entry.setCol("wc", wc);
        this.entry.setCol("dt", dt);
        this.entry.setCol("flags", flags.getBytes());
        this.entry.setCol("lang", lang.getBytes());
        this.entry.setCol("llocal", llocal);
        this.entry.setCol("lother", lother);
        this.entry.setCol("limage", limage);
        this.entry.setCol("laudio", laudio);
        this.entry.setCol("lvideo", lvideo);
        this.entry.setCol("lapp", lapp);
        this.snippet = null;
        this.word = null;
    }

    public static byte[] encodeDate(Date d) {
        return kelondroNaturalOrder.encodeLong(d.getTime() / 86400000, 4);
    }
    
    public static byte[] encodeComp(URL url, String descr, String author, String tags, String ETag) {
        serverCharBuffer s = new serverCharBuffer(200);
        s.append(url.toNormalform()).append(10);
        s.append(descr).append(10);
        s.append(author).append(10);
        s.append(tags).append(10);
        s.append(ETag).append(10);
        return s.toString().getBytes();
    }
    
    public plasmaCrawlLURLNewEntry(kelondroRow.Entry entry, indexEntry searchedWord) {
        this.entry = entry;
        this.snippet = null;
        this.word = searchedWord;
    }

    public plasmaCrawlLURLNewEntry(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());
        URL url;
        try {
            url = new URL(crypt.simpleDecode(prop.getProperty("url", ""), null));
        } catch (MalformedURLException e) {
            url = null;
        }
        String descr = crypt.simpleDecode(prop.getProperty("descr", ""), null); if (descr == null) descr = "";
        String author = crypt.simpleDecode(prop.getProperty("author", ""), null); if (author == null) author = "";
        String tags = crypt.simpleDecode(prop.getProperty("tags", ""), null); if (tags == null) tags = "";
        String ETag = crypt.simpleDecode(prop.getProperty("ETag", ""), null); if (ETag == null) ETag = "";
        
        this.entry = rowdef.newEntry();
        this.entry.setCol("hash", indexURL.urlHash(url), null);
        this.entry.setCol("comp", encodeComp(url, descr, author, tags, ETag));
        try {
            this.entry.setCol("mod", encodeDate(indexURL.shortDayFormatter.parse(prop.getProperty("mod", "20000101"))));
        } catch (ParseException e) {
            this.entry.setCol("mod", encodeDate(new Date()));
        }
        try {
            this.entry.setCol("load", encodeDate(indexURL.shortDayFormatter.parse(prop.getProperty("load", "20000101"))));
        } catch (ParseException e) {
            this.entry.setCol("load", encodeDate(new Date()));
        }
        try {
            this.entry.setCol("fresh", encodeDate(indexURL.shortDayFormatter.parse(prop.getProperty("fresh", "20000101"))));
        } catch (ParseException e) {
            this.entry.setCol("fresh", encodeDate(new Date()));
        }
        this.entry.setCol("referrer", prop.getProperty("referrer", indexURL.dummyHash).getBytes());
        this.entry.setCol("md5", serverCodings.decodeHex(prop.getProperty("md5", "")));
        this.entry.setCol("size", Integer.parseInt(prop.getProperty("size", "0")));
        this.entry.setCol("wc", Integer.parseInt(prop.getProperty("wc", "0")));
        this.entry.setCol("dt", prop.getProperty("dt", "t").charAt(0));
        this.entry.setCol("flags", serverCodings.decodeHex(prop.getProperty("flags", "00000000")));
        this.entry.setCol("lang", prop.getProperty("lang", "uk").getBytes());
        this.entry.setCol("llocal", Integer.parseInt(prop.getProperty("llocal", "0")));
        this.entry.setCol("lother", Integer.parseInt(prop.getProperty("lother", "0")));
        this.entry.setCol("limage", Integer.parseInt(prop.getProperty("limage", "0")));
        this.entry.setCol("laudio", Integer.parseInt(prop.getProperty("laudio", "0")));
        this.entry.setCol("lvideo", Integer.parseInt(prop.getProperty("lvideo", "0")));
        this.entry.setCol("lapp", Integer.parseInt(prop.getProperty("lapp", "0")));
        this.snippet = crypt.simpleDecode(prop.getProperty("snippet", ""), null);
        this.word = (prop.containsKey("word")) ? new indexURLEntry(kelondroBase64Order.enhancedCoder.decodeString(prop.getProperty("word", ""))) : null;
    }

    private StringBuffer corePropList() {
        // generate a parseable string; this is a simple property-list
        plasmaCrawlLURLEntry.Components comp = this.comp();
        final StringBuffer s = new StringBuffer(300);
        try {
            s.append("hash=").append(hash());
            s.append(",url=").append(crypt.simpleEncode(comp.url().toNormalform()));
            s.append(",descr=").append(crypt.simpleEncode(comp.descr()));
            s.append(",author=").append(crypt.simpleEncode(comp.author()));
            s.append(",tags=").append(crypt.simpleEncode(comp.tags()));
            s.append(",ETag=").append(crypt.simpleEncode(comp.ETag()));
            s.append(",mod=").append(indexURL.shortDayFormatter.format(moddate()));
            s.append(",load=").append(indexURL.shortDayFormatter.format(loaddate()));
            s.append(",fresh=").append(indexURL.shortDayFormatter.format(freshdate()));
            s.append(",referrer=").append(referrerHash());
            s.append(",md5=").append(md5());
            s.append(",size=").append(size());
            s.append(",wc=").append(wordCount());
            s.append(",dt=").append(doctype());
            s.append(",flags=").append(serverCodings.encodeHex(flags().getBytes()));
            s.append(",lang=").append(language());
            s.append(",llocal=").append(llocal());
            s.append(",lother=").append(lother());
            s.append(",limage=").append(limage());
            s.append(",laudio=").append(laudio());
            s.append(",lvideo=").append(lvideo());
            s.append(",lapp=").append(lapp());
            
            if (this.word != null) {
                // append also word properties
                s.append(",word=").append(kelondroBase64Order.enhancedCoder.encodeString(word.toPropertyForm(false)));
            }
            return s;

        } catch (Exception e) {
            //          serverLog.logFailure("plasmaLURL.corePropList", e.getMessage());
            //          if (moddate == null) serverLog.logFailure("plasmaLURL.corePropList", "moddate=null");
            //          if (loaddate == null) serverLog.logFailure("plasmaLURL.corePropList", "loaddate=null");
            //          e.printStackTrace();
            return null;
        }
    }

    public kelondroRow.Entry toRowEntry() throws IOException {
        return this.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.entry.getColString("hash", "", null);
    }

    public plasmaCrawlLURLEntry.Components comp() {
        ArrayList cl = nxTools.strings(this.entry.getCol("comp", null), "UTF-8");
        return new de.anomic.plasma.plasmaCrawlLURLEntry.Components(
                (cl.size() > 0) ? (String) cl.get(0) : "",
                (cl.size() > 1) ? (String) cl.get(1) : "",
                (cl.size() > 2) ? (String) cl.get(2) : "",
                (cl.size() > 3) ? (String) cl.get(3) : "",
                (cl.size() > 4) ? (String) cl.get(4) : "");
    }
    
    public Date moddate() {
        return new Date(86400000 * entry.getColLong("mod", 0));
    }

    public Date loaddate() {
        return new Date(86400000 * entry.getColLong("load", 0));
    }

    public Date freshdate() {
        return new Date(86400000 * entry.getColLong("fresh", 0));
    }

    public String referrerHash() {
        // return the creator's hash
        return entry.getColString("referrer", indexURL.dummyHash, null);
    }

    public String md5() {
        // returns the md5 in hex representation
        return serverCodings.encodeHex(entry.getCol("md5", indexURL.dummyHash.getBytes()));
    }

    public char doctype() {
        return (char) entry.getColByte("dt", (byte) 't');
    }

    public String language() {
        return this.entry.getColString("lang", "uk", null);
    }

    public int size() {
        return (int) this.entry.getColLong("size", 0);
    }

    public bitfield flags() {
        return new bitfield(this.entry.getCol("flags", new byte[4]));
    }

    public int wordCount() {
        return (int) this.entry.getColLong("wc", 0);
    }

    public int llocal() {
        return (int) this.entry.getColLong("llocal", 0);
    }

    public int lother() {
        return (int) this.entry.getColLong("lother", 0);
    }

    public int limage() {
        return (int) this.entry.getColLong("limage", 0);
    }

    public int laudio() {
        return (int) this.entry.getColLong("laudio", 0);
    }

    public int lvideo() {
        return (int) this.entry.getColLong("lvideo", 0);
    }

    public int lapp() {
        return (int) this.entry.getColLong("lapp", 0);
    }
    
    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 indexEntry word() {
        return word;
    }

    public boolean isOlder(plasmaCrawlLURLEntry other) {
        if (other == null) return false;
        Date tmoddate = moddate();
        Date omoddate = other.moddate();
        if (tmoddate.before(omoddate)) return true;
        if (tmoddate.equals(omoddate)) {
            Date tloaddate = loaddate();
            Date oloaddate = other.loaddate();
            if (tloaddate.before(oloaddate)) return true;
            if (tloaddate.equals(oloaddate)) return true;
        }
        return false;
    }

    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 + "}";
    }

}