yacy_search_server/htroot/CrawlResults.java

// CrawlResults.java
// (C) 2005 by Michael Peter Christen; mc@yacy.net, Frankfurt a. M., Germany
// first published 09.03.2005 on http://yacy.net
//
// This is a part of YaCy, a peer-to-peer based web search engine
//
// $LastChangedDate$
// $LastChangedRevision$
// $LastChangedBy$
//
// 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

import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.Arrays;
import java.util.Date;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import net.yacy.cora.date.GenericFormatter;
import net.yacy.cora.document.encoding.ASCII;
import net.yacy.cora.document.encoding.UTF8;
import net.yacy.cora.document.id.Punycode.PunycodeException;
import net.yacy.cora.protocol.RequestHeader;
import net.yacy.cora.util.ConcurrentLog;
import net.yacy.crawler.data.ResultURLs;
import net.yacy.crawler.data.ResultURLs.EventOrigin;
import net.yacy.crawler.data.ResultURLs.InitExecEntry;
import net.yacy.data.ListManager;
import net.yacy.kelondro.data.meta.URIMetadataNode;
import net.yacy.kelondro.util.FileUtils;
import net.yacy.peers.Seed;
import net.yacy.repository.Blacklist;
import net.yacy.search.Switchboard;
import net.yacy.search.SwitchboardConstants;
import net.yacy.search.schema.CollectionSchema;
import net.yacy.server.serverObjects;
import net.yacy.server.serverSwitch;
import net.yacy.utils.nxTools;

public class CrawlResults {

    /** Used for logging. */
    private static final String APP_NAME = "PLASMA";
    
    /** Default maximum lines number of the indexed table */
    private static final int DEFAULT_MAXIMUM_LINES = 500;
    
    public static serverObjects respond(final RequestHeader header, serverObjects post, final serverSwitch env) {
        // return variable that accumulates replacements
        final Switchboard sb = (Switchboard) env;
        final serverObjects prop = new serverObjects();

        int lines = DEFAULT_MAXIMUM_LINES;
        boolean showCollection = sb.index.fulltext().getDefaultConfiguration().isEmpty() || sb.index.fulltext().getDefaultConfiguration().contains(CollectionSchema.collection_sxt);
        boolean showInit    = env.getConfigBool("IndexMonitorInit", false);
        boolean showExec    = env.getConfigBool("IndexMonitorExec", false);
        boolean showDate    = env.getConfigBool("IndexMonitorDate", true);
        boolean showWords   = env.getConfigBool("IndexMonitorWords", true);
        boolean showTitle   = env.getConfigBool("IndexMonitorTitle", true);
        boolean showCountry = env.getConfigBool("IndexMonitorCountry", false);
        boolean showIP      = env.getConfigBool("IndexMonitorIP", false);
        boolean showURL     = env.getConfigBool("IndexMonitorURL", true);

        if (post == null) {
            post = new serverObjects();
            post.put("process", "0");
        }

        // find process number
        EventOrigin tabletype;
        try {
            tabletype = EventOrigin.getEvent(post.getInt("process", 0));
        } catch (final NumberFormatException e) {
            tabletype = EventOrigin.UNKNOWN;
        }

        if (
            post != null &&
            post.containsKey("autoforward") &&
            tabletype == EventOrigin.LOCAL_CRAWLING &&
            ResultURLs.getStackSize(EventOrigin.LOCAL_CRAWLING) == 0) {
            // the main menu does a request to the local crawler page, but in case this table is empty, the overview page is shown
            tabletype = (ResultURLs.getStackSize(EventOrigin.SURROGATES) == 0) ? EventOrigin.UNKNOWN : EventOrigin.SURROGATES;
        }

        // check if authorization is needed and/or given
        if (tabletype != EventOrigin.UNKNOWN ||
            (post != null && (post.containsKey("clearlist") ||
            post.containsKey("deleteentry")))) {
            final String authorization = (header.get(RequestHeader.AUTHORIZATION, "xxxxxx"));
            if (authorization.length() != 0) {
                if (! sb.verifyAuthentication(header)){
                    // force log-in (again, because wrong password was given)
                	prop.authenticationRequired();
                    return prop;
                }
            } else {
                // force log-in
            	prop.authenticationRequired();
                return prop;
            }
        }
        
        String selectedblacklist = post.get("selectedblacklist",Blacklist.defaultBlacklist(ListManager.listsPath));
        if (post != null) {
            // custom number of lines
            if (post.containsKey("count")) {
                lines = post.getInt("count", DEFAULT_MAXIMUM_LINES);
            }

            // do the commands
            if (post.containsKey("clearlist")) ResultURLs.clearStack(tabletype);

            if (post.containsKey("deleteentry")) {
                final String hash = post.get("hash", null);
                if (hash != null) {
                    // delete from database
                    sb.index.fulltext().remove(hash.getBytes());
                }
            }

            if (post.containsKey("deletedomain") || post.containsKey("delandaddtoblacklist")) {
                final String domain = post.get("domain", null);
                if (domain != null) {
                    selectedblacklist = post.get("blacklistname");
                    Set<String> hostnames = new HashSet<String>();
                    hostnames.add(domain);
                    sb.index.fulltext().deleteStaleDomainNames(hostnames, null);
                    ResultURLs.deleteDomain(tabletype, domain);
                    
                    // handle addtoblacklist
                    if (post.containsKey("delandaddtoblacklist")) {
                       try {
                        Switchboard.urlBlacklist.add(selectedblacklist, domain, ".*");
                    } catch (PunycodeException e) {
                        ConcurrentLog.warn(APP_NAME, "Unable to add blacklist entry to blacklist " + selectedblacklist, e);
                        
                    }
                    }
                }
            }

            if (post.containsKey("moreIndexed")) {
                lines = post.getInt("showIndexed", DEFAULT_MAXIMUM_LINES);
            }

            if (post.get("si") != null) showInit    = !("0".equals(post.get("si")));
            if (post.get("se") != null) showExec    = !("0".equals(post.get("se")));
            if (post.get("sd") != null) showDate    = !("0".equals(post.get("sd")));
            if (post.get("sw") != null) showWords   = !("0".equals(post.get("sw")));
            if (post.get("st") != null) showTitle   = !("0".equals(post.get("st")));
            if (post.get("sc") != null) showCountry = !("0".equals(post.get("sc")));
            if (post.get("sp") != null) showIP      = !("0".equals(post.get("sp")));
            if (post.get("su") != null) showURL     = !("0".equals(post.get("su")));
        } // end != null

        // create table
        if (tabletype == EventOrigin.UNKNOWN) {
            prop.put("table", "2");
        } else if (ResultURLs.getStackSize(tabletype) == 0 && ResultURLs.getDomainListSize(tabletype) == 0) {
            prop.put("table", "0");
        } else {
            prop.put("table", "1");
            if (lines > ResultURLs.getStackSize(tabletype)) lines = ResultURLs.getStackSize(tabletype);
            if (lines == ResultURLs.getStackSize(tabletype)) {
                prop.put("table_size", "0");
            } else {
                prop.put("table_size", "1");
                prop.put("table_size_count", lines);
                prop.put("table_size_tabletype", tabletype.getCode());
            }
            prop.put("table_size_all", ResultURLs.getStackSize(tabletype));

            prop.putHTML("table_feedbackpage", "CrawlResults.html");
            prop.put("table_tabletype", tabletype.getCode());
            prop.put("table_showCollection", (showCollection) ? "1" : "0");
            prop.put("table_showInit",    (showInit) ? "1" : "0");
            prop.put("table_showExec",    (showExec) ? "1" : "0");
            prop.put("table_showDate",    (showDate) ? "1" : "0");
            prop.put("table_showWords",   (showWords) ? "1" : "0");
            prop.put("table_showTitle",   (showTitle) ? "1" : "0");
            prop.put("table_showCountry", (showCountry) ? "1" : "0");
            prop.put("table_showIP",      (showIP) ? "1" : "0");
            prop.put("table_showURL",     (showURL) ? "1" : "0");

            boolean dark = true;
            String urlstr, urltxt;
            Seed initiatorSeed, executorSeed;
            URIMetadataNode urle;

            int cnt = 0;
            final Iterator<Map.Entry<String, InitExecEntry>> i = ResultURLs.results(tabletype);
            Map.Entry<String, InitExecEntry> entry;
            while (i.hasNext() && cnt < lines) {
                entry = i.next();
                try {
                    byte[] urlhash = UTF8.getBytes(entry.getKey());
                    urle = sb.index.fulltext().getMetadata(urlhash);
                    if (urle == null) {
                        sb.index.fulltext().commit(true);
                        urle = sb.index.fulltext().getMetadata(urlhash);
                    }
                    if (urle == null) {
                        ConcurrentLog.warn(APP_NAME, "CrawlResults: URL not in index with url hash " + entry.getKey());
                        urlstr = null;
                        urltxt = null;
                        continue;
                    }
                    urlstr = urle.url().toNormalform(true);
                    urltxt = nxTools.shortenURLString(urlstr, 72); // shorten the string text like a URL

                    initiatorSeed = entry.getValue() == null || entry.getValue().initiatorHash == null ? null : sb.peers.getConnected(ASCII.String(entry.getValue().initiatorHash));
                    executorSeed = entry.getValue() == null || entry.getValue().executorHash == null ? null : sb.peers.getConnected(ASCII.String(entry.getValue().executorHash));

                    prop.put("table_indexed_" + cnt + "_dark", (dark) ? "1" : "0");
                    prop.put("table_indexed_" + cnt + "_feedbackpage", "CrawlResults.html");
                    prop.put("table_indexed_" + cnt + "_tabletype", tabletype.getCode());
                    prop.put("table_indexed_" + cnt + "_urlhash", entry.getKey());

                    if (showCollection) {
                        prop.put("table_indexed_" + cnt + "_showCollection", "1");
                        prop.put("table_indexed_" + cnt + "_showCollection_collection", Arrays.toString(urle.collections()));
                    } else
                        prop.put("table_indexed_" + cnt + "_showCollection", "0");

                    if (showInit) {
                        prop.put("table_indexed_" + cnt + "_showInit", "1");
                        prop.put("table_indexed_" + cnt + "_showInit_initiatorSeed", (initiatorSeed == null) ? "unknown" : initiatorSeed.getName());
                    } else
                        prop.put("table_indexed_" + cnt + "_showInit", "0");

                    if (showExec) {
                        prop.put("table_indexed_" + cnt + "_showExec", "1");
                        prop.put("table_indexed_" + cnt + "_showExec_executorSeed", (executorSeed == null) ? "unknown" : executorSeed.getName());
                    } else
                        prop.put("table_indexed_" + cnt + "_showExec", "0");

                    if (showDate && urle != null) {
                        prop.put("table_indexed_" + cnt + "_showDate", "1");
                        prop.put("table_indexed_" + cnt + "_showDate_modified", daydate(urle.moddate()));
                    } else
                        prop.put("table_indexed_" + cnt + "_showDate", "0");

                    if (showWords && urle != null) {
                        prop.put("table_indexed_" + cnt + "_showWords", "1");
                        prop.put("table_indexed_" + cnt + "_showWords_count", urle.wordCount());
                    } else
                        prop.put("table_indexed_" + cnt + "_showWords", "0");

                    if (showTitle) {
                        prop.put("table_indexed_" + cnt + "_showTitle", (showTitle) ? "1" : "0");
                        prop.put("table_indexed_" + cnt + "_showTitle_available", "1");

                        if (urle.dc_title() == null || urle.dc_title().trim().isEmpty())
                            prop.put("table_indexed_" + cnt + "_showTitle_available_nodescr", "0");
                        else {
                            prop.put("table_indexed_" + cnt + "_showTitle_available_nodescr", "1");
                            prop.putHTML("table_indexed_" + cnt + "_showTitle_available_nodescr_urldescr", urle.dc_title());
                        }

                        prop.put("table_indexed_" + cnt + "_showTitle_available_urlHash", entry.getKey());
                        prop.putHTML("table_indexed_" + cnt + "_showTitle_available_urltitle", urlstr);
                    } else
                        prop.put("table_indexed_" + cnt + "_showTitle", "0");

                    if (showCountry && urle != null) {
                        prop.put("table_indexed_" + cnt + "_showCountry", "1");
                        prop.put("table_indexed_" + cnt + "_showCountry_country", urle.url().getLocale().getCountry());
                    } else
                        prop.put("table_indexed_" + cnt + "_showCountry", "0");

                    if (showIP && urle != null) {
                        prop.put("table_indexed_" + cnt + "_showIP", "1");
                        prop.put("table_indexed_" + cnt + "_showIP_ip", urle.url().getHost() == null ? "" : urle.url().getInetAddress().getHostAddress());
                    } else
                        prop.put("table_indexed_" + cnt + "_showIP", "0");

                    if (showURL) {
                        prop.put("table_indexed_" + cnt + "_showURL", "1");
                        prop.put("table_indexed_" + cnt + "_showURL_available", "1");

                        prop.put("table_indexed_" + cnt + "_showURL_available_urlHash", entry.getKey());
                        prop.putHTML("table_indexed_" + cnt + "_showURL_available_urltitle", urlstr);
                        prop.put("table_indexed_" + cnt + "_showURL_available_url", urltxt);
                    } else
                        prop.put("table_indexed_" + cnt + "_showURL", "0");

                    dark = !dark;
                    cnt++;
                } catch (final Exception e) {
                    ConcurrentLog.severe(APP_NAME, "genTableProps", e);
                }
            }
            prop.put("table_indexed", cnt);

            cnt = 0;
            dark = true;
            final Iterator<String> j = ResultURLs.domains(tabletype);
            String domain;
            while (j.hasNext() && cnt < 100) {
                domain = j.next();
                if (domain == null) break;
                prop.put("table_domains_" + cnt + "_dark", (dark) ? "1" : "0");
                prop.put("table_domains_" + cnt + "_feedbackpage", "CrawlResults.html");
                prop.put("table_domains_" + cnt + "_tabletype", tabletype.getCode());
                prop.put("table_domains_" + cnt + "_domain", domain);
                prop.put("table_domains_" + cnt + "_count", ResultURLs.domainCount(tabletype, domain));
                prop.put("table_domains_" + cnt + "_blacklistname", selectedblacklist);
                dark = !dark;
                cnt++;
            }
            prop.put("table_domains", cnt);

            // load all blacklist files located in the directory
            List<String> dirlist = FileUtils.getDirListing(ListManager.listsPath, Blacklist.BLACKLIST_FILENAME_FILTER);
            int blacklistCount = 0;
            if (dirlist != null) {
                for (final String element : dirlist) {
                    if (element.equals(selectedblacklist)) {
                        prop.put("table_blacklists_" + blacklistCount + "_selected", "selected");
                    } else {
                        prop.put("table_blacklists_" + blacklistCount + "_selected", "");
                    }
                    prop.putXML("table_blacklists_" + blacklistCount + "_name", element);

                    blacklistCount++;
                }
                prop.put("table_blacklists", blacklistCount);
            }           
        }

        prop.put("process", tabletype.getCode());
        prop.put("process_remoteCrawlerDisabled", !sb.getConfigBool(SwitchboardConstants.CRAWLJOB_REMOTE, false));
        // return rewrite properties
        return prop;
    }

	private static final DateTimeFormatter DAY_FORMATTER = DateTimeFormatter
			.ofPattern("uuuu/MM/dd", Locale.US).withZone(ZoneId.systemDefault());
	
	/**
	 * @param date a date to render as a String
	 * @return the date formatted using the DAY_FORMATTER pattern.
	 */
    private static String daydate(final Date date) {
        if (date == null) {
            return "";
        }
        return GenericFormatter.formatSafely(date.toInstant(), DAY_FORMATTER);
    }
}