yacy_search_server/source/de/anomic/yacy/yacyNewsDB.java

// yacyNewsQueue.java
// -----------------------
// part of YaCy
// (C) by Michael Peter Christen; mc@anomic.de
// first published on http://www.anomic.de
// Frankfurt, Germany, 2005
//
// $LastChangedDate$
// $LastChangedRevision$
// $LastChangedBy$
//
// 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
//
// Using this software in any meaning (reading, learning, copying, compiling,
// running) means that you agree that the Author(s) is (are) not responsible
// for cost, loss of data or any harm that may be caused directly or indirectly
// by usage of this softare or this documentation. The usage of this software
// is on your own risk. The installation and usage (starting/running) of this
// software may allow other people or application to access your computer and
// any attached devices and is highly dependent on the configuration of the
// software which must be done by the user of the software; the author(s) is
// (are) also not responsible for proper configuration and usage of the
// software, even if provoked by documentation provided together with
// the software.
//
// Any changes to this file according to the GPL as documented in the file
// gpl.txt aside this file in the shipment you received can be done to the
// lines that follows this copyright notice here, but changes must not be
// done inside the copyright notice above. A re-distribution must contain
// the intact and unchanged copyright notice.
// Contributions and changes to the program code must be marked as such.

package de.anomic.yacy;

import java.io.File;
import java.io.IOException;
import java.util.Iterator;

import de.anomic.yacy.yacyCore;
import de.anomic.kelondro.kelondroBase64Order;
import de.anomic.kelondro.kelondroColumn;
import de.anomic.kelondro.kelondroTree;
import de.anomic.kelondro.kelondroException;
import de.anomic.kelondro.kelondroRow;
import de.anomic.server.serverCodings;
import de.anomic.server.serverDate;

public class yacyNewsDB {

    private File path;
    private int bufferkb;
    private long preloadTime;
    private kelondroTree news;

    public static final int attributesMaxLength = yacyNewsRecord.maxNewsRecordLength
                 - yacyNewsRecord.idLength()
                 - yacyNewsRecord.categoryStringLength
                 - yacyCore.universalDateShortPattern.length()
                 - 2;

    public yacyNewsDB(File path, int bufferkb, long preloadTime) {
        this.path = path;
        this.bufferkb = bufferkb;
        this.preloadTime = preloadTime;
        
        if (path.exists()) try {
            news = new kelondroTree(path, bufferkb * 0x400, preloadTime, kelondroTree.defaultObjectCachePercent);
        } catch (IOException e) {
            news = createDB(path, bufferkb, preloadTime);
        } else {
            news = createDB(path, bufferkb, preloadTime);
        }
    }
    
    public static final kelondroRow rowdef = new kelondroRow(new kelondroColumn[]{
            new kelondroColumn("newsid", kelondroColumn.celltype_string, yacyNewsRecord.idLength(), kelondroColumn.encoder_string, yacyNewsRecord.idLength(), "id = created + originator"),
            new kelondroColumn("category", kelondroColumn.celltype_string, yacyNewsRecord.categoryStringLength, kelondroColumn.encoder_string, yacyNewsRecord.categoryStringLength, ""),
            new kelondroColumn("received", kelondroColumn.celltype_string, yacyCore.universalDateShortPattern.length(), kelondroColumn.encoder_string, yacyCore.universalDateShortPattern.length(), ""),
            new kelondroColumn("", kelondroColumn.celltype_string, 2, kelondroColumn.encoder_string, 2, ""),
            new kelondroColumn("", kelondroColumn.celltype_string, attributesMaxLength, kelondroColumn.encoder_string, attributesMaxLength, ""),
    });

    private static kelondroTree createDB(File path, int bufferkb, long preloadTime) {
        return new kelondroTree(path, bufferkb * 0x400, preloadTime, kelondroTree.defaultObjectCachePercent, rowdef, true);
    }

    private void resetDB() {
        try {close();} catch (Exception e) {}
        if (path.exists()) path.delete();
        news = createDB(path, bufferkb, preloadTime);
    }

    public int dbCacheNodeChunkSize() {
        return news.cacheNodeChunkSize();
    }

    public int[] dbCacheNodeStatus() {
        return news.cacheNodeStatus();
    }
    
    public String[] dbCacheObjectStatus() {
        return news.cacheObjectStatus();
    }
    
    public void close() {
        if (news != null) try {news.close();} catch (IOException e) {}
        news = null;
    }

    public void finalize() {
        close();
    }

    public int size() {
        return news.size();
    }

    public void remove(String id) throws IOException {
        news.remove(id.getBytes());
    }

    public synchronized yacyNewsRecord put(yacyNewsRecord record) throws IOException {
        try {
            return b2r(news.put(r2b(record)));
        } catch (kelondroException e) {
            resetDB();
            return b2r(news.put(r2b(record)));
        }
    }

    public synchronized Iterator news() throws IOException {
        // the iteration iterates yacyNewsRecord - type objects
        return new recordIterator();
    }

    public class recordIterator implements Iterator {

        Iterator rowIterator;

        public recordIterator() throws IOException {
            rowIterator = news.rows(true, false, null);
        }

        public boolean hasNext() {
            return rowIterator.hasNext();
        }

        public Object next() {
            return b2r((kelondroRow.Entry) rowIterator.next());
        }

        public void remove() {
        }

    }

    public synchronized yacyNewsRecord get(String id) throws IOException {
        try {
            return b2r(news.get(id.getBytes()));
        } catch (kelondroException e) {
            resetDB();
            return null;
        }
    }

    private static yacyNewsRecord b2r(kelondroRow.Entry b) {
        if (b == null) return null;
        return new yacyNewsRecord(
            b.getColString(0, null),
            b.getColString(1, null),
            (b.empty(2)) ? null : yacyCore.parseUniversalDate(b.getColString(2, null), serverDate.UTCDiffString()),
            (int) b.getColLongB64E(3),
            serverCodings.string2map(b.getColString(4, null))
        );
    }

    private kelondroRow.Entry r2b(yacyNewsRecord r) {
        if (r == null) return null;
        String attributes = r.attributes().toString();
        if (attributes.length() > attributesMaxLength) throw new IllegalArgumentException("attribute length=" + attributes.length() + " exceeds maximum size=" + attributesMaxLength);
        kelondroRow.Entry entry = news.row().newEntry();
        entry.setCol(0, r.id().getBytes());
        entry.setCol(1, r.category().getBytes());
        entry.setCol(2, (r.received() == null) ? null : yacyCore.universalDateShortString(r.received()).getBytes());
        entry.setCol(3, kelondroBase64Order.enhancedCoder.encodeLong(r.distributed(), 2).getBytes());
        entry.setCol(4, attributes.getBytes());
        return entry;
    }

}