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 | lgpl-2.1 | e651cdba69a945f8baca977e6441cb9e72f9d28a | 0 | jbosstm/narayana,mmusgrov/narayana,mmusgrov/narayana,tomjenkinson/narayana,jbosstm/narayana,tomjenkinson/narayana,gytis/narayana,gytis/narayana,gytis/narayana,mmusgrov/narayana,jbosstm/narayana,gytis/narayana,tomjenkinson/narayana,gytis/narayana,mmusgrov/narayana,jbosstm/narayana,gytis/narayana,tomjenkinson/narayana | /*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* 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,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
/*
* Copyright (C) 2005,
*
* Arjuna Technologies Ltd,
* Newcastle upon Tyne,
* Tyne and Wear,
* UK.
*
* $Id$
*/
package com.arjuna.ats.internal.jta.transaction.arjunacore.jca;
import java.util.HashMap;
import java.util.Map;
import java.util.Stack;
import javax.resource.spi.work.Work;
import javax.resource.spi.work.WorkCompletedException;
import javax.resource.spi.work.WorkException;
import javax.transaction.Transaction;
import com.arjuna.ats.jta.logging.jtaLogger;
public class TxWorkManager
{
/*
* Although we allow multiple units of work per transaction, currently
* JCA only allows one. Might not be worth the hassle of maintaing this
* support.
*/
/**
* Add the specified work unit to the specified transaction.
*
* @param work The work to associate with the transaction.
* @param tx The transaction to have associated with the work.
*
* @throws WorkCompletedException thrown if there is already work
* associated with the transaction.
*/
public static void addWork (Work work, Transaction tx) throws WorkCompletedException
{
Stack<Work> workers;
synchronized (_transactions)
{
workers = _transactions.get(tx);
/*
* Stack is not required due to JCA 15.4.4 which restricts to one unit of work per TX.
*/
if (workers == null)
{
workers = new Stack<Work>();
_transactions.put(tx, workers);
}
else
throw new WorkCompletedException(jtaLogger.i18NLogger.get_transaction_arjunacore_jca_busy(), WorkException.TX_CONCURRENT_WORK_DISALLOWED);
}
synchronized (workers)
{
workers.push(work);
}
}
/**
* Remove the specified unit of work from the transaction.
*
* @param work the work to remove.
* @param tx the transaction the work should be disassociated from.
*/
public static void removeWork (Work work, Transaction tx)
{
Stack<Work> workers;
synchronized (_transactions)
{
workers = _transactions.get(tx);
}
if (workers != null)
{
synchronized (workers)
{
// TODO what if the work wasn't associated?
workers.remove(work);
if (workers.empty())
{
synchronized (_transactions)
{
_transactions.remove(tx);
}
}
}
}
else
{
// shouldn't happen!
}
}
/**
* Does the transaction have any work associated with it?
*
* @param tx the transaction to check.
*
* @return <code>true</code> if there is work associated with the transaction,
* <code>false</code> otherwise.
*/
public static boolean hasWork (Transaction tx)
{
synchronized (_transactions)
{
Stack workers = _transactions.get(tx);
return (boolean) (workers != null);
}
}
/**
* Get the work currently associated with the transaction.
*
* @param tx the transaction.
*
* @return the work, or <code>null</code> if there is none.
*/
public static Work getWork (Transaction tx)
{
Stack<Work> workers;
synchronized (_transactions)
{
workers = _transactions.get(tx);
}
if (workers != null)
{
synchronized (workers)
{
if (!workers.empty())
return workers.peek();
}
}
return null;
}
private static final Map<Transaction, Stack<Work>> _transactions = new HashMap<Transaction, Stack<Work>>();
}
| ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/transaction/arjunacore/jca/TxWorkManager.java | /*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* 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,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
/*
* Copyright (C) 2005,
*
* Arjuna Technologies Ltd,
* Newcastle upon Tyne,
* Tyne and Wear,
* UK.
*
* $Id$
*/
package com.arjuna.ats.internal.jta.transaction.arjunacore.jca;
import java.util.HashMap;
import java.util.Map;
import java.util.Stack;
import javax.resource.spi.work.Work;
import javax.resource.spi.work.WorkCompletedException;
import javax.resource.spi.work.WorkException;
import javax.transaction.Transaction;
import com.arjuna.ats.jta.logging.jtaLogger;
public class TxWorkManager
{
/*
* Although we allow multiple units of work per transaction, currently
* JCA only allows one. Might not be worth the hassle of maintaing this
* support.
*/
/**
* Add the specified work unit to the specified transaction.
*
* @param work The work to associate with the transaction.
* @param tx The transaction to have associated with the work.
*
* @throws WorkCompletedException thrown if there is already work
* associated with the transaction.
*/
public static void addWork (Work work, Transaction tx) throws WorkCompletedException
{
Stack<Work> workers;
synchronized (_transactions)
{
workers = _transactions.get(tx);
/*
* TODO
*
* Is this really correct? We only get to add one unit of work per
* transaction?! If so why use a stack datastructure?
*/
if (workers == null)
{
workers = new Stack<Work>();
_transactions.put(tx, workers);
}
else
throw new WorkCompletedException(jtaLogger.i18NLogger.get_transaction_arjunacore_jca_busy(), WorkException.TX_CONCURRENT_WORK_DISALLOWED);
}
synchronized (workers)
{
workers.push(work);
}
}
/**
* Remove the specified unit of work from the transaction.
*
* @param work the work to remove.
* @param tx the transaction the work should be disassociated from.
*/
public static void removeWork (Work work, Transaction tx)
{
Stack<Work> workers;
synchronized (_transactions)
{
workers = _transactions.get(tx);
}
if (workers != null)
{
synchronized (workers)
{
// TODO what if the work wasn't associated?
workers.remove(work);
if (workers.empty())
{
synchronized (_transactions)
{
_transactions.remove(tx);
}
}
}
}
else
{
// shouldn't happen!
}
}
/**
* Does the transaction have any work associated with it?
*
* @param tx the transaction to check.
*
* @return <code>true</code> if there is work associated with the transaction,
* <code>false</code> otherwise.
*/
public static boolean hasWork (Transaction tx)
{
synchronized (_transactions)
{
Stack workers = _transactions.get(tx);
return (boolean) (workers != null);
}
}
/**
* Get the work currently associated with the transaction.
*
* @param tx the transaction.
*
* @return the work, or <code>null</code> if there is none.
*/
public static Work getWork (Transaction tx)
{
Stack<Work> workers;
synchronized (_transactions)
{
workers = _transactions.get(tx);
}
if (workers != null)
{
synchronized (workers)
{
if (!workers.empty())
return workers.peek();
}
}
return null;
}
private static final Map<Transaction, Stack<Work>> _transactions = new HashMap<Transaction, Stack<Work>>();
}
| JBJCA-1329 Clarified the TODO message to reference the JCA spec | ArjunaJTA/jta/classes/com/arjuna/ats/internal/jta/transaction/arjunacore/jca/TxWorkManager.java | JBJCA-1329 Clarified the TODO message to reference the JCA spec | <ide><path>rjunaJTA/jta/classes/com/arjuna/ats/internal/jta/transaction/arjunacore/jca/TxWorkManager.java
<ide> workers = _transactions.get(tx);
<ide>
<ide> /*
<del> * TODO
<del> *
<del> * Is this really correct? We only get to add one unit of work per
<del> * transaction?! If so why use a stack datastructure?
<add> * Stack is not required due to JCA 15.4.4 which restricts to one unit of work per TX.
<ide> */
<ide>
<ide> if (workers == null) |
|
Java | bsd-3-clause | 17e617b57cbafa049435ff00af4e9122e996173a | 0 | psygate/CivModCore,psygate/CivModCore | package vg.civcraft.mc.civmodcore.world.operations;
import co.aikar.commands.annotation.CommandAlias;
import co.aikar.commands.annotation.CommandPermission;
import co.aikar.commands.annotation.Description;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.NamedTextColor;
import net.md_5.bungee.api.ChatColor;
import org.apache.commons.collections4.CollectionUtils;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.world.ChunkLoadEvent;
import org.bukkit.plugin.Plugin;
import vg.civcraft.mc.civmodcore.CivModCorePlugin;
import vg.civcraft.mc.civmodcore.command.AikarCommand;
import vg.civcraft.mc.civmodcore.world.WorldTracker;
import vg.civcraft.mc.civmodcore.world.WorldUtils;
import vg.civcraft.mc.civmodcore.world.WorldXZ;
public class ChunkOperationManager extends AikarCommand implements Listener {
public static final ChunkOperationManager INSTANCE = new ChunkOperationManager();
private static final CivModCorePlugin PLUGIN = CivModCorePlugin.getInstance();
private static final Map<WorldXZ, List<ChunkOperation>> STORAGE = new HashMap<>();
@EventHandler
public void onChunkLoad(final ChunkLoadEvent event) {
final Chunk chunk = event.getChunk();
final World world = chunk.getWorld();
final WorldXZ wxz = new WorldXZ(world.getUID(), chunk.getX(), chunk.getZ());
final List<ChunkOperation> operations = STORAGE.remove(wxz);
if (CollectionUtils.isEmpty(operations)) {
return;
}
for (final ChunkOperation operation : operations) {
executeOperation(operation, chunk);
}
operations.clear();
}
@CommandAlias("chunkoperations")
@Description("Shows a zoomed out view of all pending chunk operations.")
@CommandPermission("cmc.debug")
public void onDebugCommand(final CommandSender sender) {
sender.sendMessage(ChatColor.YELLOW + "Chunk Operations:");
for (final Map.Entry<WorldXZ, List<ChunkOperation>> entry : STORAGE.entrySet()) {
final WorldXZ wxz = entry.getKey();
final List<ChunkOperation> operations = entry.getValue();
final int operationCount = operations == null ? 0 : operations.size();
final World world = WorldTracker.getLoadedWorld(wxz.getWorld());
// First line: " WorldName: 22 operations"
final var component = Component.text().content(" ");
if (world == null) {
component.append(Component.text("{NOT LOADED}").color(NamedTextColor.RED));
}
else {
component.append(Component.text(world.getName()).color(NamedTextColor.GREEN));
}
component.append(Component.text(": "));
if (operationCount == 0) {
component.append(Component.text("0 operations"));
sender.sendMessage(component);
continue;
}
else if (operationCount == 1) {
component.append(Component.text("1 operation"));
}
else {
component.append(Component.text(operationCount + " operations"));
}
sender.sendMessage(component);
// Other lines: " - PluginName: 1 operation"
final Map<Plugin, Integer> pluginCount = new HashMap<>();
for (final ChunkOperation operation : operations) {
pluginCount.computeIfPresent(operation.plugin, (o, count) -> count + 1);
pluginCount.putIfAbsent(operation.plugin, 0);
}
for (final Map.Entry<Plugin, Integer> count : pluginCount.entrySet()) {
sender.sendMessage(" - " + ChatColor.AQUA + count.getKey().getName() + ": " +
ChatColor.RESET + count.getValue());
}
}
sender.sendMessage(ChatColor.RED + "End of operations.");
}
/**
* Stages an operation for a particular chunk, which may be executed immediately if the chunk is loaded.
*
* @param location The location of the chunk to operate on. MUST NOT BE A BLOCK LOCATION!
* @param operation The operation to perform.
* @return Returns true if the operation was executed immediately.
*/
public static boolean stageOperation(final Location location, final ChunkOperation operation) {
if (operation == null) {
throw new IllegalArgumentException("Operation cannot be null!");
}
if (location == null) {
throw new IllegalArgumentException("Location cannot be null!");
}
final World world = WorldUtils.getLocationWorld(location);
if (world == null) {
throw new IllegalArgumentException("Location's world must not be null!");
}
final Chunk chunk = WorldUtils.getLoadedChunk(world, location.getBlockX(), location.getBlockZ());
if (chunk == null) {
final WorldXZ wxz = new WorldXZ(location);
STORAGE.computeIfAbsent(wxz, l -> new ArrayList<>()).add(operation);
return false;
}
executeOperation(operation, chunk);
return true;
}
private static void executeOperation(final ChunkOperation operation, final Chunk chunk) {
try {
operation.process(chunk);
}
catch (Exception exception) {
PLUGIN.warning("Chunk Operation [" + operation.getClass().getName() + "] has thrown an error:", exception);
}
}
}
| src/main/java/vg/civcraft/mc/civmodcore/world/operations/ChunkOperationManager.java | package vg.civcraft.mc.civmodcore.world.operations;
import co.aikar.commands.annotation.CommandAlias;
import co.aikar.commands.annotation.CommandPermission;
import co.aikar.commands.annotation.Description;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.md_5.bungee.api.ChatColor;
import net.md_5.bungee.api.chat.TextComponent;
import org.apache.commons.collections4.CollectionUtils;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.world.ChunkLoadEvent;
import org.bukkit.plugin.Plugin;
import vg.civcraft.mc.civmodcore.CivModCorePlugin;
import vg.civcraft.mc.civmodcore.chat.ChatUtils;
import vg.civcraft.mc.civmodcore.command.AikarCommand;
import vg.civcraft.mc.civmodcore.world.WorldTracker;
import vg.civcraft.mc.civmodcore.world.WorldUtils;
import vg.civcraft.mc.civmodcore.world.WorldXZ;
public class ChunkOperationManager extends AikarCommand implements Listener {
public static final ChunkOperationManager INSTANCE = new ChunkOperationManager();
private static final CivModCorePlugin PLUGIN = CivModCorePlugin.getInstance();
private static final Map<WorldXZ, List<ChunkOperation>> STORAGE = new HashMap<>();
@EventHandler
public void onChunkLoad(final ChunkLoadEvent event) {
final Chunk chunk = event.getChunk();
final World world = chunk.getWorld();
final WorldXZ wxz = new WorldXZ(world.getUID(), chunk.getX(), chunk.getZ());
final List<ChunkOperation> operations = STORAGE.remove(wxz);
if (CollectionUtils.isEmpty(operations)) {
return;
}
for (final ChunkOperation operation : operations) {
executeOperation(operation, chunk);
}
operations.clear();
}
@CommandAlias("chunkoperations")
@Description("Shows a zoomed out view of all pending chunk operations.")
@CommandPermission("cmc.debug")
public void onDebugCommand(final CommandSender sender) {
sender.sendMessage(ChatColor.YELLOW + "Chunk Operations:");
for (final Map.Entry<WorldXZ, List<ChunkOperation>> entry : STORAGE.entrySet()) {
final WorldXZ wxz = entry.getKey();
final List<ChunkOperation> operations = entry.getValue();
final int operationCount = operations == null ? 0 : operations.size();
final World world = WorldTracker.getLoadedWorld(wxz.getWorld());
// First line: " WorldName: 22 operations"
final TextComponent textComponent = new TextComponent(" ");
if (world == null) {
textComponent.addExtra(ChatUtils.textComponent("{NOT LOADED}", ChatColor.RED));
}
else {
textComponent.addExtra(ChatUtils.textComponent(world.getName(), ChatColor.GREEN));
}
textComponent.addExtra(": ");
if (operationCount == 0) {
textComponent.addExtra("0 operations");
sender.spigot().sendMessage(textComponent);
continue;
}
else if (operationCount == 1) {
textComponent.addExtra("1 operation");
}
else {
textComponent.addExtra(operationCount + " operations");
}
sender.spigot().sendMessage(textComponent);
// Other lines: " - PluginName: 1 operation"
final Map<Plugin, Integer> pluginCount = new HashMap<>();
for (final ChunkOperation operation : operations) {
pluginCount.computeIfPresent(operation.plugin, (o, count) -> count + 1);
pluginCount.putIfAbsent(operation.plugin, 0);
}
for (final Map.Entry<Plugin, Integer> count : pluginCount.entrySet()) {
sender.sendMessage(" - " + ChatColor.AQUA + count.getKey().getName() + ": " +
ChatColor.RESET + count.getValue());
}
}
sender.sendMessage(ChatColor.RED + "End of operations.");
}
/**
* Stages an operation for a particular chunk, which may be executed immediately if the chunk is loaded.
*
* @param location The location of the chunk to operate on. MUST NOT BE A BLOCK LOCATION!
* @param operation The operation to perform.
* @return Returns true if the operation was executed immediately.
*/
public static boolean stageOperation(final Location location, final ChunkOperation operation) {
if (operation == null) {
throw new IllegalArgumentException("Operation cannot be null!");
}
if (location == null) {
throw new IllegalArgumentException("Location cannot be null!");
}
final World world = WorldUtils.getLocationWorld(location);
if (world == null) {
throw new IllegalArgumentException("Location's world must not be null!");
}
final Chunk chunk = WorldUtils.getLoadedChunk(world, location.getBlockX(), location.getBlockZ());
if (chunk == null) {
final WorldXZ wxz = new WorldXZ(location);
STORAGE.computeIfAbsent(wxz, l -> new ArrayList<>()).add(operation);
return false;
}
executeOperation(operation, chunk);
return true;
}
private static void executeOperation(final ChunkOperation operation, final Chunk chunk) {
try {
operation.process(chunk);
}
catch (Exception exception) {
PLUGIN.warning("Chunk Operation [" + operation.getClass().getName() + "] has thrown an error:", exception);
}
}
}
| Switch ChunkOperationManager over to Kyori components
| src/main/java/vg/civcraft/mc/civmodcore/world/operations/ChunkOperationManager.java | Switch ChunkOperationManager over to Kyori components | <ide><path>rc/main/java/vg/civcraft/mc/civmodcore/world/operations/ChunkOperationManager.java
<ide> import java.util.HashMap;
<ide> import java.util.List;
<ide> import java.util.Map;
<add>import net.kyori.adventure.text.Component;
<add>import net.kyori.adventure.text.format.NamedTextColor;
<ide> import net.md_5.bungee.api.ChatColor;
<del>import net.md_5.bungee.api.chat.TextComponent;
<ide> import org.apache.commons.collections4.CollectionUtils;
<ide> import org.bukkit.Chunk;
<ide> import org.bukkit.Location;
<ide> import org.bukkit.event.world.ChunkLoadEvent;
<ide> import org.bukkit.plugin.Plugin;
<ide> import vg.civcraft.mc.civmodcore.CivModCorePlugin;
<del>import vg.civcraft.mc.civmodcore.chat.ChatUtils;
<ide> import vg.civcraft.mc.civmodcore.command.AikarCommand;
<ide> import vg.civcraft.mc.civmodcore.world.WorldTracker;
<ide> import vg.civcraft.mc.civmodcore.world.WorldUtils;
<ide> final int operationCount = operations == null ? 0 : operations.size();
<ide> final World world = WorldTracker.getLoadedWorld(wxz.getWorld());
<ide> // First line: " WorldName: 22 operations"
<del> final TextComponent textComponent = new TextComponent(" ");
<add> final var component = Component.text().content(" ");
<ide> if (world == null) {
<del> textComponent.addExtra(ChatUtils.textComponent("{NOT LOADED}", ChatColor.RED));
<add> component.append(Component.text("{NOT LOADED}").color(NamedTextColor.RED));
<ide> }
<ide> else {
<del> textComponent.addExtra(ChatUtils.textComponent(world.getName(), ChatColor.GREEN));
<add> component.append(Component.text(world.getName()).color(NamedTextColor.GREEN));
<ide> }
<del> textComponent.addExtra(": ");
<add> component.append(Component.text(": "));
<ide> if (operationCount == 0) {
<del> textComponent.addExtra("0 operations");
<del> sender.spigot().sendMessage(textComponent);
<add> component.append(Component.text("0 operations"));
<add> sender.sendMessage(component);
<ide> continue;
<ide> }
<ide> else if (operationCount == 1) {
<del> textComponent.addExtra("1 operation");
<add> component.append(Component.text("1 operation"));
<ide> }
<ide> else {
<del> textComponent.addExtra(operationCount + " operations");
<add> component.append(Component.text(operationCount + " operations"));
<ide> }
<del> sender.spigot().sendMessage(textComponent);
<add> sender.sendMessage(component);
<ide> // Other lines: " - PluginName: 1 operation"
<ide> final Map<Plugin, Integer> pluginCount = new HashMap<>();
<ide> for (final ChunkOperation operation : operations) { |
|
JavaScript | apache-2.0 | 681634bc4371ed9826caa6599b4bf23eb5b91c60 | 0 | incedure/incedure-datalist-ui,nagyistoce/camunda-tasklist-ui,xlinur/camunda-bpm-webapp,TitanUser/camunda-bpm-webapp,tcrossland/camunda-bpm-webapp,TitanUser/camunda-bpm-webapp,xlinur/camunda-bpm-webapp,tcrossland/camunda-bpm-webapp,kingtec/camunda-tasklist-ui,tcrossland/camunda-bpm-webapp,xlinur/camunda-bpm-webapp,kingtec/camunda-tasklist-ui,nagyistoce/camunda-tasklist-ui,TitanUser/camunda-bpm-webapp | define([
'text!./cam-tasklist-task-form.html',
'text!./cam-tasklist-task-form-modal.html'
], function(template, modalTemplate) {
'use strict';
var $ = angular.element;
return [
'$rootScope',
'camAPI',
'CamForm',
'$translate',
'Notifications',
'$interval',
'$modal',
function(
$rootScope,
camAPI,
CamForm,
$translate,
Notifications,
$interval,
$modal
) {
var Task = camAPI.resource('task');
var ProcessDefinition = camAPI.resource('process-definition');
function setModalFormMaxHeight(wrapper, targetContainer) {
var availableHeight = $(window).height();
wrapper.find('> div').each(function() {
var $el = $(this);
if ($el.hasClass('form-container')) { return; }
availableHeight -= $el.outerHeight();
});
targetContainer.css({
'overflow': 'auto',
'max-height': availableHeight +'px'
});
}
function errorNotification(src, err) {
$translate(src).then(function(translated) {
Notifications.addError({
status: translated,
message: (err ? err.message : '')
});
});
}
function successNotification(src) {
$translate(src).then(function(translated) {
Notifications.addMessage({
duration: 3000,
status: translated
});
});
}
return {
scope: {
task: '='
},
link: function(scope, element) {
var container = element.find('.form-container');
var modalInstance;
scope.currentTaskId = null;
scope._camForm = null;
scope.fullscreen = false;
// // doh!
// scope.$valid = true;
// scope.$invalid = false;
scope.enterFullscreen = function() {
scope.fullscreen = !scope.fullscreen;
modalInstance = $modal.open({
// by passing the scope, we also pass the methods to submit the form
scope: scope,
template: modalTemplate,
windowClass: 'task-form-fullscreen'
});
modalInstance.opened.then(function() {
// dat ain't neat... dat is di only way to make sure da containa is inna di place
var targetContainer;
var checkContainerInterval = $interval(function() {
targetContainer = $('.modal-content .form-container');
if (targetContainer.length) {
loadForm(targetContainer);
var wrapper = $('.modal-content');
setModalFormMaxHeight(wrapper, targetContainer);
$(window).on('resize', function() {
setModalFormMaxHeight(wrapper, targetContainer);
});
// fatha always said: don't work for free
$interval.cancel(checkContainerInterval);
}
}, 100, 20, false);
});
};
scope.exitFullscreen = function() {
scope.fullscreen = !scope.fullscreen;
if (modalInstance) {
modalInstance.dismiss();
$(window).off('resize');
}
};
scope.toggleFullscreen = function() {
if (!scope.fullscreen) {
scope.enterFullscreen();
}
else {
scope.exitFullscreen();
}
};
function submitCb(err) {
if (err) {
return errorNotification('COMPLETE_ERROR', err);
}
scope.currentTaskId = null;
scope._camForm = null;
container.html('');
if (modalInstance) {
modalInstance.dismiss();
}
$rootScope.$broadcast('tasklist.task.update');
$rootScope.$broadcast('tasklist.task.complete');
successNotification('COMPLETE_OK');
}
scope.completeTask = function() {
if (scope._camForm) {
scope._camForm.submit(submitCb);
}
else {
var variables = {};
Task.submitForm({
id: scope.currentTaskId,
variables: variables
}, submitCb);
}
};
function showForm(targetContainer, processDefinition) {
var parts = (scope.task.formKey || '').split('embedded:');
var ctx = processDefinition.contextPath;
var formUrl;
if (parts.length > 1) {
formUrl = parts.pop();
// ensure a trailing slash
ctx = ctx + (ctx.slice(-1) !== '/' ? '/' : '');
formUrl = formUrl.replace(/app:(\/?)/, ctx);
}
else {
formUrl = scope.task.formKey;
}
if (formUrl) {
scope._camForm = new CamForm({
taskId: scope.task.id,
containerElement: targetContainer,
client: camAPI,
formUrl: formUrl,
initialized: function(camForm) {
var formName = camForm.formElement.attr('name');
var form = camForm.formElement.scope()[formName];
scope.$watch(function() {
return form.$valid;
}, function(value) {
scope.$invalid = !value;
});
}
});
}
else {
scope.$invalid = false;
// clear the content (to avoid other tasks form to appear)
$translate('NO_TASK_FORM').then(function(translated) {
targetContainer.html(translated || '');
});
}
}
function loadForm(targetContainer) {
targetContainer = targetContainer || container;
scope._camForm = null;
if (scope.task._embedded && scope.task._embedded.processDefinition[0]) {
showForm(targetContainer, scope.task._embedded.processDefinition[0]);
}
else {
// this should not happen, but...
ProcessDefinition.get(scope.task.processDefinitionId, function(err, result) {
if (err) {
return errorNotification('TASK_NO_PROCESS_DEFINITION', err);
}
scope.task._embedded.processDefinition = scope.task._embedded.processDefinition || [];
scope.task._embedded.processDefinition[0] = result;
showForm(targetContainer, scope.task._embedded.processDefinition[0]);
});
}
}
scope.$watch('task', function(newValue, oldValue) {
if (!scope.task) {
scope.currentTaskId = null;
}
else if (newValue.id !== oldValue.id) {
scope.currentTaskId = scope.task.id;
loadForm();
}
});
if (scope.task) {
scope.currentTaskId = scope.task.id;
loadForm();
}
},
template: template
};
}];
});
| client/scripts/task/directives/cam-tasklist-task-form.js | define([
'text!./cam-tasklist-task-form.html',
'text!./cam-tasklist-task-form-modal.html'
], function(template, modalTemplate) {
'use strict';
var $ = angular.element;
return [
'$rootScope',
'camAPI',
'CamForm',
'$translate',
'Notifications',
'$interval',
'$modal',
function(
$rootScope,
camAPI,
CamForm,
$translate,
Notifications,
$interval,
$modal
) {
var Task = camAPI.resource('task');
var ProcessDefinition = camAPI.resource('process-definition');
function setModalFormMaxHeight(wrapper, targetContainer) {
var availableHeight = $(window).height();
wrapper.find('> div').each(function() {
var $el = $(this);
if ($el.hasClass('form-container')) { return; }
availableHeight -= $el.outerHeight();
});
targetContainer.css({
'overflow': 'auto',
'max-height': availableHeight +'px'
});
}
function errorNotification(src, err) {
$translate(src).then(function(translated) {
Notifications.addError({
status: translated,
message: (err ? err.message : '')
});
});
}
function successNotification(src) {
$translate(src).then(function(translated) {
Notifications.addMessage({
duration: 3000,
status: translated
});
});
}
return {
scope: {
task: '='
},
link: function(scope, element) {
var container = element.find('.form-container');
var modalInstance;
scope.currentTaskId = null;
scope._camForm = null;
scope.fullscreen = false;
// // doh!
// scope.$valid = true;
// scope.$invalid = false;
scope.enterFullscreen = function() {
scope.fullscreen = !scope.fullscreen;
modalInstance = $modal.open({
// by passing the scope, we also pass the methods to submit the form
scope: scope,
template: modalTemplate,
windowClass: 'task-form-fullscreen'
});
modalInstance.opened.then(function() {
// dat ain't neat... dat is di only way to make sure da containa is inna di place
var targetContainer;
var checkContainerInterval = $interval(function() {
targetContainer = $('.modal-content .form-container');
if (targetContainer.length) {
loadForm(targetContainer);
var wrapper = $('.modal-content');
setModalFormMaxHeight(wrapper, targetContainer);
$(window).on('resize', function() {
setModalFormMaxHeight(wrapper, targetContainer);
});
// fatha always said: don't work for free
$interval.cancel(checkContainerInterval);
}
}, 100, 20, false);
});
};
scope.exitFullscreen = function() {
scope.fullscreen = !scope.fullscreen;
if (modalInstance) {
modalInstance.dismiss();
$(window).off('resize');
}
};
scope.toggleFullscreen = function() {
if (!scope.fullscreen) {
scope.enterFullscreen();
}
else {
scope.exitFullscreen();
}
};
function submitCb(err) {
if (err) {
return errorNotification('COMPLETE_ERROR', err);
}
scope.currentTaskId = null;
scope._camForm = null;
container.html('');
if (modalInstance) {
modalInstance.dismiss();
}
$rootScope.$broadcast('tasklist.task.update');
$rootScope.$broadcast('tasklist.task.complete');
successNotification('COMPLETE_OK');
}
scope.completeTask = function() {
if (scope._camForm) {
scope._camForm.submit(submitCb);
}
else {
var variables = {};
Task.submitForm({
id: scope.currentTaskId,
variables: variables
}, submitCb);
}
};
function showForm(targetContainer, processDefinition) {
var parts = (scope.task.formKey || '').split('embedded:');
var ctx = processDefinition.contextPath;
var formUrl;
if (parts.length > 1) {
formUrl = parts.pop();
// ensure a trailing slash
ctx = ctx + (ctx.slice(-1) !== '/' ? '/' : '');
formUrl = formUrl.replace(/app:(\/?)/, ctx);
}
else {
formUrl = scope.task.formKey;
}
if (formUrl) {
scope._camForm = new CamForm({
taskId: scope.task.id,
containerElement: targetContainer,
client: camAPI,
formUrl: formUrl,
initialized: function(camForm) {
var formName = camForm.formElement.attr('name');
var form = camForm.formElement.scope()[formName];
scope.$watch(function() {
return form.$valid;
}, function(value) {
scope.$invalid = !value;
});
}
});
}
else {
// clear the content (to avoid other tasks form to appear)
$translate('NO_TASK_FORM').then(function(translated) {
targetContainer.html(translated || '');
});
}
}
function loadForm(targetContainer) {
targetContainer = targetContainer || container;
scope._camForm = null;
if (scope.task._embedded && scope.task._embedded.processDefinition[0]) {
showForm(targetContainer, scope.task._embedded.processDefinition[0]);
}
else {
// this should not happen, but...
ProcessDefinition.get(scope.task.processDefinitionId, function(err, result) {
if (err) {
return errorNotification('TASK_NO_PROCESS_DEFINITION', err);
}
scope.task._embedded.processDefinition = scope.task._embedded.processDefinition || [];
scope.task._embedded.processDefinition[0] = result;
showForm(targetContainer, scope.task._embedded.processDefinition[0]);
});
}
}
scope.$watch('task', function(newValue, oldValue) {
if (!scope.task) {
scope.currentTaskId = null;
}
else if (newValue.id !== oldValue.id) {
scope.currentTaskId = scope.task.id;
loadForm();
}
});
if (scope.task) {
scope.currentTaskId = scope.task.id;
loadForm();
}
},
template: template
};
}];
});
| fix(task form): prevent task without form to be flagged as invalid
| client/scripts/task/directives/cam-tasklist-task-form.js | fix(task form): prevent task without form to be flagged as invalid | <ide><path>lient/scripts/task/directives/cam-tasklist-task-form.js
<ide>
<ide> }
<ide> else {
<add> scope.$invalid = false;
<add>
<ide> // clear the content (to avoid other tasks form to appear)
<ide> $translate('NO_TASK_FORM').then(function(translated) {
<ide> targetContainer.html(translated || ''); |
|
Java | unlicense | 16ddbf37142d603c42589a68692b7000e07612f3 | 0 | jggc/blitz,jggc/blitz | package com.coveo.blitz;
import java.util.ArrayList;
import java.util.List;
import org.apache.thrift.TException;
import com.coveo.blitz.thrift.Album;
import com.coveo.blitz.thrift.Artist;
import com.coveo.blitz.thrift.DocumentType;
import com.coveo.blitz.thrift.QueryResult;
public class Index {
private List<Document> docs;
private Tokenizer tokenizer;
public Index(){
docs = new ArrayList<Document>();
tokenizer = new Tokenizer();
}
public void indexArtist(Artist artistToIndex) {
tokenizer.setIndividualWords(artistToIndex.text);
String[] tokens = tokenizer.getIndividualWords();
docs.add(new Document(Integer.parseInt(artistToIndex.getId()), tokens, DocumentType.ARTIST));
}
public void indexAlbum(Album albumToIndex) {
System.out.println("tokenizing");
tokenizer.setIndividualWords(albumToIndex.text);
String[] tokens = tokenizer.getIndividualWords();
System.out.println("adding");
docs.add(new Document(Integer.parseInt(albumToIndex.getId()), tokens, DocumentType.ALBUM));
}
public List<QueryResult> search(String s){
List<QueryResult> results = new ArrayList<QueryResult>();
for( Document d : docs){
if(d.match(s))
results.add(new QueryResult(d.getType(), Integer.toString(d.getId())));
}
return results;
}
public List<QueryResult> getAllId() {
List<QueryResult> ids = new ArrayList<QueryResult>(docs.size());
for(Document d : docs){
ids.add(new QueryResult(d.getType(), Integer.toString(d.getId())));
}
return ids;
}
}
| blitzindex/src/main/java/com/coveo/blitz/Index.java | package com.coveo.blitz;
import java.util.ArrayList;
import java.util.List;
import org.apache.thrift.TException;
import com.coveo.blitz.thrift.Album;
import com.coveo.blitz.thrift.Artist;
import com.coveo.blitz.thrift.DocumentType;
import com.coveo.blitz.thrift.QueryResult;
public class Index {
private List<Document> docs;
private Tokenizer tokenizer;
public Index(){
docs = new ArrayList<Document>();
tokenizer = new Tokenizer();
}
public void indexArtist(Artist artistToIndex) {
tokenizer.setIndividualWords(artistToIndex.text);
String[] tokens = tokenizer.getIndividualWords();
docs.add(new Document(Integer.parseInt(artistToIndex.getId()), tokens, DocumentType.ARTIST));
}
public void indexAlbum(Album albumToIndex) {
tokenizer.setIndividualWords(albumToIndex.text);
String[] tokens = tokenizer.getIndividualWords();
docs.add(new Document(Integer.parseInt(albumToIndex.getId()), tokens, DocumentType.ALBUM));
}
public List<QueryResult> search(String s){
List<QueryResult> results = new ArrayList<QueryResult>();
for( Document d : docs){
if(d.match(s))
results.add(new QueryResult(d.getType(), Integer.toString(d.getId())));
}
return results;
}
public List<QueryResult> getAllId() {
List<QueryResult> ids = new ArrayList<QueryResult>(docs.size());
for(Document d : docs){
ids.add(new QueryResult(d.getType(), Integer.toString(d.getId())));
}
return ids;
}
}
| ajout de symboles de debug
| blitzindex/src/main/java/com/coveo/blitz/Index.java | ajout de symboles de debug | <ide><path>litzindex/src/main/java/com/coveo/blitz/Index.java
<ide> }
<ide>
<ide> public void indexAlbum(Album albumToIndex) {
<add> System.out.println("tokenizing");
<ide> tokenizer.setIndividualWords(albumToIndex.text);
<ide> String[] tokens = tokenizer.getIndividualWords();
<add> System.out.println("adding");
<ide> docs.add(new Document(Integer.parseInt(albumToIndex.getId()), tokens, DocumentType.ALBUM));
<ide> }
<ide> |
|
Java | lgpl-2.1 | f0edee88e71723f2e6c7a255257391879968873c | 0 | liujed/polyglot-eclipse,blue-systems-group/project.maybe.polyglot,liujed/polyglot-eclipse,liujed/polyglot-eclipse,xcv58/polyglot,xcv58/polyglot,blue-systems-group/project.maybe.polyglot,liujed/polyglot-eclipse,xcv58/polyglot,xcv58/polyglot,blue-systems-group/project.maybe.polyglot,blue-systems-group/project.maybe.polyglot | /*
* Scheduler.java
*
* Author: nystrom
* Creation date: Dec 14, 2004
*/
package polyglot.frontend;
import java.util.*;
import polyglot.ast.Node;
import polyglot.frontend.goals.*;
import polyglot.main.Report;
import polyglot.types.FieldInstance;
import polyglot.types.ParsedClassType;
import polyglot.types.UnavailableTypeException;
import polyglot.util.CodeWriter;
import polyglot.util.InternalCompilerError;
import polyglot.visit.*;
/**
* Comment for <code>Scheduler</code>
*
* @author nystrom
*/
public abstract class Scheduler {
protected ExtensionInfo extInfo;
/**
* Collection of uncompleted goals.
*/
protected Set inWorklist;
protected LinkedList worklist;
/**
* A map from <code>Source</code>s to <code>Job</code>s or to
* the <code>COMPLETED_JOB</code> object if the Job previously
* existed
* but has now finished. The map contains entries for all
* <code>Source</code>s that have had <code>Job</code>s added for them.
*/
protected Map jobs;
/** Map from goals to goals used to intern goals. */
protected Map goals;
/** Map from goals to number of times a pass was run for the goal. */
protected Map runCount;
/**
* Map from goals to the number of amount of progress made since just before
* the goal was last attempted.
*/
Map progressMap;
/**
* Progress made since the start of the compilation. When a pass is run,
* progress is incremented by the difference in distance from the goal before
* and after the pass is run.
*/
int currentProgress;
/** True if any pass has failed. */
boolean failed;
protected static final Object COMPLETED_JOB = "COMPLETED JOB";
/** The currently running pass, or null if no pass is running. */
protected Pass currentPass;
public Scheduler(ExtensionInfo extInfo) {
this.extInfo = extInfo;
this.jobs = new HashMap();
this.goals = new HashMap();
this.runCount = new HashMap();
this.progressMap = new HashMap();
this.inWorklist = new HashSet();
this.worklist = new LinkedList();
this.currentPass = null;
this.currentProgress = 0;
}
/**
* Add a new concurrent <code>subgoal</code> of the <code>goal</code>.
* <code>subgoal</code> is a goal on which <code>goal</code> mutually
* depends. The caller must be careful to ensure that all concurrent goals
* can be eventually reached.
*/
public void addConcurrentDependency(Goal goal, Goal subgoal) {
goal.addConcurrentGoal(subgoal);
}
/**
* Add a new <code>subgoal</code> of <code>goal</code>.
* <code>subgoal</code> must be completed before <code>goal</code> is
* attempted.
*
* @throws CyclicDependencyException
* if a prerequisite of <code>subgoal</code> is
* <code>goal</code>
*/
public void addPrerequisiteDependency(Goal goal, Goal subgoal) throws CyclicDependencyException {
goal.addPrerequisiteGoal(subgoal);
}
/** Add prerequisite dependencies between adjacent items in a list of goals. */
public void addPrerequisiteDependencyChain(List deps) throws CyclicDependencyException {
Goal prev = null;
for (Iterator i = deps.iterator(); i.hasNext(); ) {
Goal curr = (Goal) i.next();
if (prev != null)
addPrerequisiteDependency(curr, prev);
prev = curr;
}
}
/**
* Intern the <code>goal</code> so that there is only one copy of the goal.
* All goals passed into and returned by scheduler should be interned.
* @param goal
* @return the interned copy of <code>goal</code>
*/
public synchronized Goal internGoal(Goal goal) {
Goal g = (Goal) goals.get(goal);
if (g == null) {
g = goal;
goals.put(g, g);
if (Report.should_report(Report.frontend, 2))
Report.report(2, "new goal " + g);
if (Report.should_report(Report.frontend, 3))
Report.report(3, "goals = " + goals.keySet());
}
return g;
}
/** Add <code>goal</code> to the worklist and return its interned copy. */
public void addGoal(Goal goal) {
addGoalToWorklist(goal);
}
private synchronized void addGoalToWorklist(Goal g) {
if (! inWorklist.contains(g)) {
inWorklist.add(g);
worklist.add(g);
}
}
// Dummy pass needed for currentGoal(), currentPass(), etc., to work
// when checking if a goal was reached.
Pass schedulerPass(Goal g) {
return new EmptyPass(g) {
public boolean run() {
return true;
}
};
}
public boolean reached(Goal g) {
long t = System.currentTimeMillis();
Job job = g.job();
if (job != null && job.isRunning()) {
return false;
}
Pass pass = schedulerPass(g);
Pass oldPass = this.currentPass;
this.currentPass = pass;
// Stop the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
if (job != null) {
job.setRunningPass(pass);
}
boolean result = g.hasBeenReached();
if (job != null) {
job.setRunningPass(null);
}
this.currentPass = oldPass;
// Restart the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
t = System.currentTimeMillis() - t;
extInfo.getStats().accumPassTimes("scheduler.reached", t, t);
return result;
}
/**
* Attempt to complete all goals in the worklist (and any subgoals they
* have). This method returns <code>true</code> if all passes were
* successfully run and all goals in the worklist were reached. The worklist
* should be empty at return.
*/
public boolean runToCompletion() {
boolean okay = true;
while (! worklist.isEmpty()) {
if (Report.should_report(Report.frontend, 2))
Report.report(2, "processing next in worklist " + worklist);
Goal goal = selectGoalFromWorklist();
if (reached(goal)) {
continue;
}
if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Running to goal " + goal);
}
try {
okay &= attemptGoal(goal, true, new HashSet(), new HashSet());
}
catch (CyclicDependencyException e) {
addGoalToWorklist(goal);
continue;
}
if (! okay) {
break;
}
if (! reached(goal)) {
if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Failed to reach " + goal + "; will reattempt");
}
addGoalToWorklist(goal);
}
else if (goal instanceof CodeGenerated) {
// the job has finished. Let's remove it from the map so it
// can be garbage collected, and free up the AST.
jobs.put(goal.job().source(), COMPLETED_JOB);
if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Completed job " + goal.job());
}
}
}
if (Report.should_report(Report.frontend, 1))
Report.report(1, "Finished all passes -- " +
(okay ? "okay" : "failed"));
return okay;
}
/**
* Select and remove a <code>Goal</code> from the non-empty
* <code>worklist</code>. Return the selected <code>Goal</code>
* which will be scheduled to run all of its remaining passes.
*/
private Goal selectGoalFromWorklist() {
// TODO: Select the goal that will cause it's associated job to complete
// first. This is the goal with the fewest subgoals closest to job
// completion. The idea is to finish a job as quickly as possible in
// order to free its memory.
// Pick a goal not recently run, if available.
for (Iterator i = worklist.iterator(); i.hasNext(); ) {
Goal goal = (Goal) i.next();
Integer progress = (Integer) progressMap.get(goal);
if (progress == null || progress.intValue() < currentProgress) {
i.remove();
inWorklist.remove(goal);
return goal;
}
}
Goal goal = (Goal) worklist.removeFirst();
inWorklist.remove(goal);
return goal;
}
/**
* Load a source file and create a job for it. Optionally add a goal
* to compile the job to Java.
*
* @param source The source file to load.
* @param compile True if the compile goal should be added for the new job.
* @return The new job or null if the job has already completed.
*/
public Job loadSource(FileSource source, boolean compile) {
// Add a new Job for the given source. If a Job for the source
// already exists, then we will be given the existing job.
Job job = addJob(source);
if (job == null) {
// addJob returns null if the job has already been completed, in
// which case we can just ignore the request to read in the
// source.
return null;
}
// Create a goal for the job; this will set up dependencies for the goal,
// even if the goal isn't added to the work list.
Goal compileGoal = extInfo.getCompileGoal(job);
if (compile) {
// Now, add a goal for completing the job.
addGoal(compileGoal);
}
return job;
}
public Job currentJob() {
return currentPass != null ? currentPass.goal().job() : null;
}
public Pass currentPass() {
return currentPass;
}
public Goal currentGoal() {
return currentPass != null ? currentPass.goal() : null;
}
public boolean attemptGoal(Goal goal) throws CyclicDependencyException {
return attemptGoal(goal, true, new HashSet(), new HashSet());
}
/**
* Run a passes until the <code>goal</code> is attempted. Callers should
* check goal.completed() and should be able to handle the goal not being
* reached.
*
* @return false if there was an error trying to reach the goal; true if
* there was no error, even if the goal was not reached.
*/
private boolean attemptGoal(final Goal goal, boolean sameThread,
final Set prereqs, final Set goals)
throws CyclicDependencyException
{
if (Report.should_report(Report.frontend, 2))
Report.report(2, "Running to goal " + goal);
if (Report.should_report(Report.frontend, 3)) {
Report.report(3, " Distance = " + goal.distanceFromGoal());
Report.report(3, " Reachable = " + goal.isReachable());
Report.report(3, " Prerequisites for " + goal + " = " + goal.prerequisiteGoals());
Report.report(3, " Concurrent goals for " + goal + " = " + goal.concurrentGoals());
Report.report(3, " Prereqs = " + prereqs);
Report.report(3, " Dependees = " + goals);
}
if (reached(goal)) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Already reached goal " + goal);
return true;
}
if (! goal.isReachable()) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal);
return false;
}
if (prereqs.contains(goal)) {
// The goal has itself as a prerequisite.
throw new InternalCompilerError("Goal " + goal + " depends on itself.");
}
// Another pass is being run over the same source file. We cannot reach
// the goal yet, so just return and let the other pass complete. This
// goal will be reattempted later, if necessary.
if (goal.job() != null && goal.job().isRunning()) {
throw new CyclicDependencyException();
}
if (goals.contains(goal)) {
throw new CyclicDependencyException();
}
final boolean FORK = false;
// Fork a new thread so that the stack depth does not get too large.
if (FORK && ! sameThread) {
System.out.println("spawning thread for " + goal);
final int[] r = new int[1];
Thread th = new Thread() {
public void run() {
try {
boolean result = Scheduler.this.attemptGoal(goal, true, prereqs, goals);
r[0] = result ? 1 : 0;
}
catch (CyclicDependencyException e) {
r[0] = -1;
}
}
};
th.start();
try {
th.join();
}
catch (InterruptedException e) {
return false;
}
if (r[0] == -1) {
throw new CyclicDependencyException();
}
return r[0] == 1;
}
prereqs.add(goal);
goals.add(goal);
// Make sure all subgoals have been completed,
// except those that recursively depend on this goal.
// If a subgoal has not been completed, just return and let
// it complete before trying this goal again.
boolean runPass = true;
for (Iterator i = new ArrayList(goal.prerequisiteGoals()).iterator(); i.hasNext(); ) {
Goal subgoal = (Goal) i.next();
boolean okay = attemptGoal(subgoal, true, prereqs, goals);
if (! okay) {
goal.setUnreachable();
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal + "; " + subgoal + " failed");
return false;
}
if (! reached(subgoal)) {
// put the subgoal back on the worklist
addGoal(subgoal);
runPass = false;
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Will delay goal " + goal + "; " + subgoal + " not reached");
}
}
for (Iterator i = new ArrayList(goal.concurrentGoals()).iterator(); i.hasNext(); ) {
Goal subgoal = (Goal) i.next();
boolean okay = attemptGoal(subgoal, true, new HashSet(), goals);
if (! okay) {
goal.setUnreachable();
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal + "; " + subgoal + " failed");
return false;
}
if (! reached(subgoal)) {
// put the subgoal on the worklist
addGoal(subgoal);
// Don't run the pass if another pass over the same job
// needs to be completed first.
if (goal.job() != null && subgoal.job() == goal.job() && subgoal != goal) {
runPass = false;
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Will delay goal " + goal + "; " + subgoal + " not reached");
}
}
}
if (! runPass) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "A subgoal wasn't reached, delaying goal " + goal);
throw new CyclicDependencyException();
}
// Check for completion again -- the goal may have been reached
// while processing a subgoal.
if (reached(goal)) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Already reached goal " + goal + " (second check)");
return true;
}
if (! goal.isReachable()) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal + " (second check)");
return false;
}
Pass pass = goal.createPass(extInfo);
boolean result = runPass(pass);
goals.remove(goal);
prereqs.remove(goal);
if (result && ! reached(goal)) {
// Add the goal back on the worklist.
addGoalToWorklist(goal);
}
return result;
}
private int progressSinceLastAttempt(Goal goal) {
int progress;
Integer i = (Integer) progressMap.get(goal);
if (i == null) {
return Integer.MAX_VALUE;
}
else {
progress = i.intValue();
}
return currentProgress - progress;
}
/**
* Run the pass <code>pass</code>. All subgoals of the pass's goal
* required to start the pass should be satisfied. Running the pass
* may not satisfy the goal, forcing it to be retried later with new
* subgoals.
*/
private boolean runPass(Pass pass) {
Goal goal = pass.goal();
Job job = goal.job();
if (goal instanceof SourceFileGoal) {
if (extInfo.getOptions().disable_passes.contains(pass.name())) {
if (Report.should_report(Report.frontend, 1))
Report.report(1, "Skipping pass " + pass);
((SourceFileGoal) goal).markRun();
return true;
}
}
if (Report.should_report(Report.frontend, 1))
Report.report(1, "Running pass " + pass + " for " + goal);
if (reached(goal)) {
throw new InternalCompilerError("Cannot run a pass for completed goal " + goal);
}
if (false && progressSinceLastAttempt(goal) == 0) {
if (failed) {
return false;
}
throw new InternalCompilerError("Possible infinite loop detected trying to run a pass for " + goal + "; no progress made since last attempt. Current distance from goal is " + goal.distanceFromGoal() + ".");
}
final int MAX_RUN_COUNT = 100;
Integer countObj = (Integer) this.runCount.get(goal);
int count = countObj != null ? countObj.intValue() : 0;
count++;
this.runCount.put(goal, new Integer(count));
if (count >= MAX_RUN_COUNT) {
String[] suffix = new String[] { "th", "st", "nd", "rd" };
int index = count % 10;
if (index > 3) index = 0;
if (11 <= count && count <= 13) index = 0;
String cardinal = count + suffix[index];
throw new InternalCompilerError("Possible infinite loop detected trying to run a pass for " + goal + " for the " + cardinal + " time.");
}
pass.resetTimers();
boolean result = false;
int oldDistance = goal.distanceFromGoal();
int distanceAdjust = 0;
if (job == null || job.status()) {
Pass oldPass = this.currentPass;
this.currentPass = pass;
Report.should_report.push(pass.name());
// Stop the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
if (job != null) {
job.setRunningPass(pass);
}
pass.toggleTimers(false);
try {
result = pass.run();
}
catch (UnavailableTypeException e) {
result = true;
distanceAdjust++;
}
pass.toggleTimers(false);
if (! result) {
goal.setUnreachable();
}
if (job != null) {
job.setRunningPass(null);
}
Report.should_report.pop();
this.currentPass = oldPass;
// Restart the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
// pretty-print this pass if we need to.
if (job != null && extInfo.getOptions().print_ast.contains(pass.name())) {
System.err.println("--------------------------------" +
"--------------------------------");
System.err.println("Pretty-printing AST for " + job +
" after " + pass.name());
PrettyPrinter pp = new PrettyPrinter();
pp.printAst(job.ast(), new CodeWriter(System.err, 78));
}
// dump this pass if we need to.
if (job != null && extInfo.getOptions().dump_ast.contains(pass.name())) {
System.err.println("--------------------------------" +
"--------------------------------");
System.err.println("Dumping AST for " + job +
" after " + pass.name());
NodeVisitor dumper =
new DumpAst(new CodeWriter(System.err, 78));
dumper = dumper.begin();
job.ast().visit(dumper);
dumper.finish();
}
// This seems to work around a VM bug on linux with JDK
// 1.4.0. The mark-sweep collector will sometimes crash.
// Running the GC explicitly here makes the bug go away.
// If this fails, maybe run with bigger heap.
// System.gc();
}
Stats stats = extInfo.getStats();
stats.accumPassTimes(pass.name(), pass.inclusiveTime(),
pass.exclusiveTime());
if (! result) {
failed = true;
}
// Record the progress made before running the pass and then update
// the current progress.
progressMap.put(goal, new Integer(currentProgress));
int newDistance = goal.distanceFromGoal();
int progress = oldDistance - newDistance + distanceAdjust;
progress = progress > 0 ? progress : 0; // make sure progress is forward
if (! result) progress++; // count a failure as progress
currentProgress += progress;
if (Report.should_report(Report.time, 2)) {
Report.report(2, "Finished " + pass +
" status=" + statusString(result) + " inclusive_time=" +
pass.inclusiveTime() + " exclusive_time=" +
pass.exclusiveTime());
}
else if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Finished " + pass +
" status=" + statusString(result) +
" distance=" + oldDistance + "->" + newDistance);
}
if (job != null) {
job.updateStatus(result);
}
return result;
}
private static String statusString(boolean okay) {
if (okay) {
return "done";
}
else {
return "failed";
}
}
public abstract Goal TypeExists(String name);
public abstract Goal MembersAdded(ParsedClassType ct);
public abstract Goal SupertypesResolved(ParsedClassType ct);
public abstract Goal SignaturesResolved(ParsedClassType ct);
public abstract Goal FieldConstantsChecked(FieldInstance fi);
public abstract Goal Parsed(Job job);
public abstract Goal TypesInitialized(Job job);
public abstract Goal TypesInitializedForCommandLine();
public abstract Goal Disambiguated(Job job);
public abstract Goal TypeChecked(Job job);
public abstract Goal ConstantsChecked(Job job);
public abstract Goal ReachabilityChecked(Job job);
public abstract Goal ExceptionsChecked(Job job);
public abstract Goal ExitPathsChecked(Job job);
public abstract Goal InitializationsChecked(Job job);
public abstract Goal ConstructorCallsChecked(Job job);
public abstract Goal ForwardReferencesChecked(Job job);
public abstract Goal Serialized(Job job);
public abstract Goal CodeGenerated(Job job);
/** Return all compilation units currently being compiled. */
public Collection jobs() {
ArrayList l = new ArrayList(jobs.size());
for (Iterator i = jobs.values().iterator(); i.hasNext(); ) {
Object o = i.next();
if (o != COMPLETED_JOB) {
l.add(o);
}
}
return l;
}
/**
* Add a new <code>Job</code> for the <code>Source source</code>.
* A new job will be created if
* needed. If the <code>Source source</code> has already been processed,
* and its job discarded to release resources, then <code>null</code>
* will be returned.
*/
public Job addJob(Source source) {
return addJob(source, null);
}
/**
* Add a new <code>Job</code> for the <code>Source source</code>,
* with AST <code>ast</code>.
* A new job will be created if
* needed. If the <code>Source source</code> has already been processed,
* and its job discarded to release resources, then <code>null</code>
* will be returned.
*/
public Job addJob(Source source, Node ast) {
Object o = jobs.get(source);
Job job = null;
if (o == COMPLETED_JOB) {
// the job has already been completed.
// We don't need to add a job
return null;
}
else if (o == null) {
// No appropriate job yet exists, we will create one.
job = this.createSourceJob(source, ast);
// record the job in the map and the worklist.
jobs.put(source, job);
if (Report.should_report(Report.frontend, 3)) {
Report.report(3, "Adding job for " + source + " at the " +
"request of pass " + currentPass);
}
}
else {
job = (Job) o;
}
return job;
}
/**
* Create a new <code>Job</code> for the given source and AST.
* In general, this method should only be called by <code>addJob</code>.
*/
private Job createSourceJob(Source source, Node ast) {
return new Job(extInfo, extInfo.jobExt(), source, ast);
}
public String toString() {
return getClass().getName() + " worklist=" + worklist;
}
}
| src/polyglot/frontend/Scheduler.java | /*
* Scheduler.java
*
* Author: nystrom
* Creation date: Dec 14, 2004
*/
package polyglot.frontend;
import java.util.*;
import polyglot.ast.Node;
import polyglot.frontend.goals.*;
import polyglot.main.Report;
import polyglot.types.FieldInstance;
import polyglot.types.ParsedClassType;
import polyglot.util.CodeWriter;
import polyglot.util.InternalCompilerError;
import polyglot.visit.*;
/**
* Comment for <code>Scheduler</code>
*
* @author nystrom
*/
public abstract class Scheduler {
protected ExtensionInfo extInfo;
/**
* Collection of uncompleted goals.
*/
protected Set inWorklist;
protected LinkedList worklist;
/**
* A map from <code>Source</code>s to <code>Job</code>s or to
* the <code>COMPLETED_JOB</code> object if the Job previously
* existed
* but has now finished. The map contains entries for all
* <code>Source</code>s that have had <code>Job</code>s added for them.
*/
protected Map jobs;
/** Map from goals to goals used to intern goals. */
protected Map goals;
/** Map from goals to number of times a pass was run for the goal. */
protected Map runCount;
/**
* Map from goals to the number of amount of progress made since just before
* the goal was last attempted.
*/
Map progressMap;
/**
* Progress made since the start of the compilation. When a pass is run,
* progress is incremented by the difference in distance from the goal before
* and after the pass is run.
*/
int currentProgress;
/** True if any pass has failed. */
boolean failed;
protected static final Object COMPLETED_JOB = "COMPLETED JOB";
/** The currently running pass, or null if no pass is running. */
protected Pass currentPass;
public Scheduler(ExtensionInfo extInfo) {
this.extInfo = extInfo;
this.jobs = new HashMap();
this.goals = new HashMap();
this.runCount = new HashMap();
this.progressMap = new HashMap();
this.inWorklist = new HashSet();
this.worklist = new LinkedList();
this.currentPass = null;
this.currentProgress = 0;
}
/**
* Add a new concurrent <code>subgoal</code> of the <code>goal</code>.
* <code>subgoal</code> is a goal on which <code>goal</code> mutually
* depends. The caller must be careful to ensure that all concurrent goals
* can be eventually reached.
*/
public void addConcurrentDependency(Goal goal, Goal subgoal) {
goal.addConcurrentGoal(subgoal);
}
/**
* Add a new <code>subgoal</code> of <code>goal</code>.
* <code>subgoal</code> must be completed before <code>goal</code> is
* attempted.
*
* @throws CyclicDependencyException
* if a prerequisite of <code>subgoal</code> is
* <code>goal</code>
*/
public void addPrerequisiteDependency(Goal goal, Goal subgoal) throws CyclicDependencyException {
goal.addPrerequisiteGoal(subgoal);
}
/** Add prerequisite dependencies between adjacent items in a list of goals. */
public void addPrerequisiteDependencyChain(List deps) throws CyclicDependencyException {
Goal prev = null;
for (Iterator i = deps.iterator(); i.hasNext(); ) {
Goal curr = (Goal) i.next();
if (prev != null)
addPrerequisiteDependency(curr, prev);
prev = curr;
}
}
/**
* Intern the <code>goal</code> so that there is only one copy of the goal.
* All goals passed into and returned by scheduler should be interned.
* @param goal
* @return the interned copy of <code>goal</code>
*/
public synchronized Goal internGoal(Goal goal) {
Goal g = (Goal) goals.get(goal);
if (g == null) {
g = goal;
goals.put(g, g);
if (Report.should_report(Report.frontend, 2))
Report.report(2, "new goal " + g);
if (Report.should_report(Report.frontend, 3))
Report.report(3, "goals = " + goals.keySet());
}
return g;
}
/** Add <code>goal</code> to the worklist and return its interned copy. */
public void addGoal(Goal goal) {
addGoalToWorklist(goal);
}
private synchronized void addGoalToWorklist(Goal g) {
if (! inWorklist.contains(g)) {
inWorklist.add(g);
worklist.add(g);
}
}
// Dummy pass needed for currentGoal(), currentPass(), etc., to work
// when checking if a goal was reached.
Pass schedulerPass(Goal g) {
return new EmptyPass(g) {
public boolean run() {
return true;
}
};
}
public boolean reached(Goal g) {
long t = System.currentTimeMillis();
Job job = g.job();
if (job != null && job.isRunning()) {
return false;
}
Pass pass = schedulerPass(g);
Pass oldPass = this.currentPass;
this.currentPass = pass;
// Stop the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
if (job != null) {
job.setRunningPass(pass);
}
boolean result = g.hasBeenReached();
if (job != null) {
job.setRunningPass(null);
}
this.currentPass = oldPass;
// Restart the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
t = System.currentTimeMillis() - t;
extInfo.getStats().accumPassTimes("scheduler.reached", t, t);
return result;
}
/**
* Attempt to complete all goals in the worklist (and any subgoals they
* have). This method returns <code>true</code> if all passes were
* successfully run and all goals in the worklist were reached. The worklist
* should be empty at return.
*/
public boolean runToCompletion() {
boolean okay = true;
while (! worklist.isEmpty()) {
if (Report.should_report(Report.frontend, 2))
Report.report(2, "processing next in worklist " + worklist);
Goal goal = selectGoalFromWorklist();
if (reached(goal)) {
continue;
}
if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Running to goal " + goal);
}
try {
okay &= attemptGoal(goal, true, new HashSet(), new HashSet());
}
catch (CyclicDependencyException e) {
addGoalToWorklist(goal);
continue;
}
if (! okay) {
break;
}
if (! reached(goal)) {
if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Failed to reach " + goal + "; will reattempt");
}
addGoalToWorklist(goal);
}
else if (goal instanceof CodeGenerated) {
// the job has finished. Let's remove it from the map so it
// can be garbage collected, and free up the AST.
jobs.put(goal.job().source(), COMPLETED_JOB);
if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Completed job " + goal.job());
}
}
}
if (Report.should_report(Report.frontend, 1))
Report.report(1, "Finished all passes -- " +
(okay ? "okay" : "failed"));
return okay;
}
/**
* Select and remove a <code>Goal</code> from the non-empty
* <code>worklist</code>. Return the selected <code>Goal</code>
* which will be scheduled to run all of its remaining passes.
*/
private Goal selectGoalFromWorklist() {
// TODO: Select the goal that will cause it's associated job to complete
// first. This is the goal with the fewest subgoals closest to job
// completion. The idea is to finish a job as quickly as possible in
// order to free its memory.
// Pick a goal not recently run, if available.
for (Iterator i = worklist.iterator(); i.hasNext(); ) {
Goal goal = (Goal) i.next();
Integer progress = (Integer) progressMap.get(goal);
if (progress == null || progress.intValue() < currentProgress) {
i.remove();
inWorklist.remove(goal);
return goal;
}
}
Goal goal = (Goal) worklist.removeFirst();
inWorklist.remove(goal);
return goal;
}
/**
* Load a source file and create a job for it. Optionally add a goal
* to compile the job to Java.
*
* @param source The source file to load.
* @param compile True if the compile goal should be added for the new job.
* @return The new job or null if the job has already completed.
*/
public Job loadSource(FileSource source, boolean compile) {
// Add a new Job for the given source. If a Job for the source
// already exists, then we will be given the existing job.
Job job = addJob(source);
if (job == null) {
// addJob returns null if the job has already been completed, in
// which case we can just ignore the request to read in the
// source.
return null;
}
// Create a goal for the job; this will set up dependencies for the goal,
// even if the goal isn't added to the work list.
Goal compileGoal = extInfo.getCompileGoal(job);
if (compile) {
// Now, add a goal for completing the job.
addGoal(compileGoal);
}
return job;
}
public Job currentJob() {
return currentPass != null ? currentPass.goal().job() : null;
}
public Pass currentPass() {
return currentPass;
}
public Goal currentGoal() {
return currentPass != null ? currentPass.goal() : null;
}
public boolean attemptGoal(Goal goal) throws CyclicDependencyException {
return attemptGoal(goal, true, new HashSet(), new HashSet());
}
/**
* Run a passes until the <code>goal</code> is attempted. Callers should
* check goal.completed() and should be able to handle the goal not being
* reached.
*
* @return false if there was an error trying to reach the goal; true if
* there was no error, even if the goal was not reached.
*/
private boolean attemptGoal(final Goal goal, boolean sameThread,
final Set prereqs, final Set goals)
throws CyclicDependencyException
{
if (Report.should_report(Report.frontend, 2))
Report.report(2, "Running to goal " + goal);
if (Report.should_report(Report.frontend, 3)) {
Report.report(3, " Distance = " + goal.distanceFromGoal());
Report.report(3, " Reachable = " + goal.isReachable());
Report.report(3, " Prerequisites for " + goal + " = " + goal.prerequisiteGoals());
Report.report(3, " Concurrent goals for " + goal + " = " + goal.concurrentGoals());
Report.report(3, " Prereqs = " + prereqs);
Report.report(3, " Dependees = " + goals);
}
if (reached(goal)) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Already reached goal " + goal);
return true;
}
if (! goal.isReachable()) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal);
return false;
}
if (prereqs.contains(goal)) {
// The goal has itself as a prerequisite.
throw new InternalCompilerError("Goal " + goal + " depends on itself.");
}
// Another pass is being run over the same source file. We cannot reach
// the goal yet, so just return and let the other pass complete. This
// goal will be reattempted later, if necessary.
if (goal.job() != null && goal.job().isRunning()) {
throw new CyclicDependencyException();
}
if (goals.contains(goal)) {
throw new CyclicDependencyException();
}
final boolean FORK = false;
// Fork a new thread so that the stack depth does not get too large.
if (FORK && ! sameThread) {
System.out.println("spawning thread for " + goal);
final int[] r = new int[1];
Thread th = new Thread() {
public void run() {
try {
boolean result = Scheduler.this.attemptGoal(goal, true, prereqs, goals);
r[0] = result ? 1 : 0;
}
catch (CyclicDependencyException e) {
r[0] = -1;
}
}
};
th.start();
try {
th.join();
}
catch (InterruptedException e) {
return false;
}
if (r[0] == -1) {
throw new CyclicDependencyException();
}
return r[0] == 1;
}
prereqs.add(goal);
goals.add(goal);
// Make sure all subgoals have been completed,
// except those that recursively depend on this goal.
// If a subgoal has not been completed, just return and let
// it complete before trying this goal again.
boolean runPass = true;
for (Iterator i = new ArrayList(goal.prerequisiteGoals()).iterator(); i.hasNext(); ) {
Goal subgoal = (Goal) i.next();
boolean okay = attemptGoal(subgoal, true, prereqs, goals);
if (! okay) {
goal.setUnreachable();
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal + "; " + subgoal + " failed");
return false;
}
if (! reached(subgoal)) {
// put the subgoal back on the worklist
addGoal(subgoal);
runPass = false;
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Will delay goal " + goal + "; " + subgoal + " not reached");
}
}
for (Iterator i = new ArrayList(goal.concurrentGoals()).iterator(); i.hasNext(); ) {
Goal subgoal = (Goal) i.next();
boolean okay = attemptGoal(subgoal, true, new HashSet(), goals);
if (! okay) {
goal.setUnreachable();
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal + "; " + subgoal + " failed");
return false;
}
if (! reached(subgoal)) {
// put the subgoal on the worklist
addGoal(subgoal);
// Don't run the pass if another pass over the same job
// needs to be completed first.
if (goal.job() != null && subgoal.job() == goal.job() && subgoal != goal) {
runPass = false;
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Will delay goal " + goal + "; " + subgoal + " not reached");
}
}
}
if (! runPass) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "A subgoal wasn't reached, delaying goal " + goal);
throw new CyclicDependencyException();
}
// Check for completion again -- the goal may have been reached
// while processing a subgoal.
if (reached(goal)) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Already reached goal " + goal + " (second check)");
return true;
}
if (! goal.isReachable()) {
if (Report.should_report(Report.frontend, 3))
Report.report(3, "Cannot reach goal " + goal + " (second check)");
return false;
}
Pass pass = goal.createPass(extInfo);
boolean result = runPass(pass);
goals.remove(goal);
prereqs.remove(goal);
if (result && ! reached(goal)) {
// Add the goal back on the worklist.
addGoalToWorklist(goal);
}
return result;
}
private int progressSinceLastAttempt(Goal goal) {
int progress;
Integer i = (Integer) progressMap.get(goal);
if (i == null) {
return Integer.MAX_VALUE;
}
else {
progress = i.intValue();
}
return currentProgress - progress;
}
/**
* Run the pass <code>pass</code>. All subgoals of the pass's goal
* required to start the pass should be satisfied. Running the pass
* may not satisfy the goal, forcing it to be retried later with new
* subgoals.
*/
private boolean runPass(Pass pass) {
Goal goal = pass.goal();
Job job = goal.job();
if (goal instanceof SourceFileGoal) {
if (extInfo.getOptions().disable_passes.contains(pass.name())) {
if (Report.should_report(Report.frontend, 1))
Report.report(1, "Skipping pass " + pass);
((SourceFileGoal) goal).markRun();
return true;
}
}
if (Report.should_report(Report.frontend, 1))
Report.report(1, "Running pass " + pass + " for " + goal);
if (reached(goal)) {
throw new InternalCompilerError("Cannot run a pass for completed goal " + goal);
}
if (progressSinceLastAttempt(goal) == 0) {
if (failed) {
return false;
}
throw new InternalCompilerError("Possible infinite loop detected trying to run a pass for " + goal + "; no progress made since last attempt. Current distance from goal is " + goal.distanceFromGoal() + ".");
}
final int MAX_RUN_COUNT = 100;
Integer countObj = (Integer) this.runCount.get(goal);
int count = countObj != null ? countObj.intValue() : 0;
count++;
this.runCount.put(goal, new Integer(count));
if (count >= MAX_RUN_COUNT) {
String[] suffix = new String[] { "th", "st", "nd", "rd" };
int index = count % 10;
if (index > 3) index = 0;
if (11 <= count && count <= 13) index = 0;
String cardinal = count + suffix[index];
throw new InternalCompilerError("Possible infinite loop detected trying to run a pass for " + goal + " for the " + cardinal + " time.");
}
pass.resetTimers();
boolean result = false;
int oldDistance = goal.distanceFromGoal();
if (job == null || job.status()) {
Pass oldPass = this.currentPass;
this.currentPass = pass;
Report.should_report.push(pass.name());
// Stop the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
if (job != null) {
job.setRunningPass(pass);
}
pass.toggleTimers(false);
result = pass.run();
pass.toggleTimers(false);
if (! result) {
goal.setUnreachable();
}
if (job != null) {
job.setRunningPass(null);
}
Report.should_report.pop();
this.currentPass = oldPass;
// Restart the timer on the old pass. */
if (oldPass != null) {
oldPass.toggleTimers(true);
}
// pretty-print this pass if we need to.
if (job != null && extInfo.getOptions().print_ast.contains(pass.name())) {
System.err.println("--------------------------------" +
"--------------------------------");
System.err.println("Pretty-printing AST for " + job +
" after " + pass.name());
PrettyPrinter pp = new PrettyPrinter();
pp.printAst(job.ast(), new CodeWriter(System.err, 78));
}
// dump this pass if we need to.
if (job != null && extInfo.getOptions().dump_ast.contains(pass.name())) {
System.err.println("--------------------------------" +
"--------------------------------");
System.err.println("Dumping AST for " + job +
" after " + pass.name());
NodeVisitor dumper =
new DumpAst(new CodeWriter(System.err, 78));
dumper = dumper.begin();
job.ast().visit(dumper);
dumper.finish();
}
// This seems to work around a VM bug on linux with JDK
// 1.4.0. The mark-sweep collector will sometimes crash.
// Running the GC explicitly here makes the bug go away.
// If this fails, maybe run with bigger heap.
// System.gc();
}
Stats stats = extInfo.getStats();
stats.accumPassTimes(pass.name(), pass.inclusiveTime(),
pass.exclusiveTime());
if (! result) {
failed = true;
}
// Record the progress made before running the pass and then update
// the current progress.
progressMap.put(goal, new Integer(currentProgress));
int newDistance = goal.distanceFromGoal();
int progress = oldDistance - newDistance;
progress = progress > 0 ? progress : 0; // make sure progress is forward
if (! result) progress++; // count a failure as progress
currentProgress += progress;
if (Report.should_report(Report.time, 2)) {
Report.report(2, "Finished " + pass +
" status=" + statusString(result) + " inclusive_time=" +
pass.inclusiveTime() + " exclusive_time=" +
pass.exclusiveTime());
}
else if (Report.should_report(Report.frontend, 1)) {
Report.report(1, "Finished " + pass +
" status=" + statusString(result) +
" distance=" + oldDistance + "->" + newDistance);
}
if (job != null) {
job.updateStatus(result);
}
return result;
}
private static String statusString(boolean okay) {
if (okay) {
return "done";
}
else {
return "failed";
}
}
public abstract Goal TypeExists(String name);
public abstract Goal MembersAdded(ParsedClassType ct);
public abstract Goal SupertypesResolved(ParsedClassType ct);
public abstract Goal SignaturesResolved(ParsedClassType ct);
public abstract Goal FieldConstantsChecked(FieldInstance fi);
public abstract Goal Parsed(Job job);
public abstract Goal TypesInitialized(Job job);
public abstract Goal TypesInitializedForCommandLine();
public abstract Goal Disambiguated(Job job);
public abstract Goal TypeChecked(Job job);
public abstract Goal ConstantsChecked(Job job);
public abstract Goal ReachabilityChecked(Job job);
public abstract Goal ExceptionsChecked(Job job);
public abstract Goal ExitPathsChecked(Job job);
public abstract Goal InitializationsChecked(Job job);
public abstract Goal ConstructorCallsChecked(Job job);
public abstract Goal ForwardReferencesChecked(Job job);
public abstract Goal Serialized(Job job);
public abstract Goal CodeGenerated(Job job);
/** Return all compilation units currently being compiled. */
public Collection jobs() {
ArrayList l = new ArrayList(jobs.size());
for (Iterator i = jobs.values().iterator(); i.hasNext(); ) {
Object o = i.next();
if (o != COMPLETED_JOB) {
l.add(o);
}
}
return l;
}
/**
* Add a new <code>Job</code> for the <code>Source source</code>.
* A new job will be created if
* needed. If the <code>Source source</code> has already been processed,
* and its job discarded to release resources, then <code>null</code>
* will be returned.
*/
public Job addJob(Source source) {
return addJob(source, null);
}
/**
* Add a new <code>Job</code> for the <code>Source source</code>,
* with AST <code>ast</code>.
* A new job will be created if
* needed. If the <code>Source source</code> has already been processed,
* and its job discarded to release resources, then <code>null</code>
* will be returned.
*/
public Job addJob(Source source, Node ast) {
Object o = jobs.get(source);
Job job = null;
if (o == COMPLETED_JOB) {
// the job has already been completed.
// We don't need to add a job
return null;
}
else if (o == null) {
// No appropriate job yet exists, we will create one.
job = this.createSourceJob(source, ast);
// record the job in the map and the worklist.
jobs.put(source, job);
if (Report.should_report(Report.frontend, 3)) {
Report.report(3, "Adding job for " + source + " at the " +
"request of pass " + currentPass);
}
}
else {
job = (Job) o;
}
return job;
}
/**
* Create a new <code>Job</code> for the given source and AST.
* In general, this method should only be called by <code>addJob</code>.
*/
private Job createSourceJob(Source source, Node ast) {
return new Job(extInfo, extInfo.jobExt(), source, ast);
}
public String toString() {
return getClass().getName() + " worklist=" + worklist;
}
}
| Temporarily disabled over zealous infinite loop detection.
Fixed escaping UnavailableTypeException, but need a cleaner fix.
| src/polyglot/frontend/Scheduler.java | Temporarily disabled over zealous infinite loop detection. Fixed escaping UnavailableTypeException, but need a cleaner fix. | <ide><path>rc/polyglot/frontend/Scheduler.java
<ide> import polyglot.main.Report;
<ide> import polyglot.types.FieldInstance;
<ide> import polyglot.types.ParsedClassType;
<add>import polyglot.types.UnavailableTypeException;
<ide> import polyglot.util.CodeWriter;
<ide> import polyglot.util.InternalCompilerError;
<ide> import polyglot.visit.*;
<ide> throw new InternalCompilerError("Cannot run a pass for completed goal " + goal);
<ide> }
<ide>
<del> if (progressSinceLastAttempt(goal) == 0) {
<add> if (false && progressSinceLastAttempt(goal) == 0) {
<ide> if (failed) {
<ide> return false;
<ide> }
<ide>
<ide> boolean result = false;
<ide> int oldDistance = goal.distanceFromGoal();
<add> int distanceAdjust = 0;
<ide>
<ide> if (job == null || job.status()) {
<ide> Pass oldPass = this.currentPass;
<ide>
<ide> pass.toggleTimers(false);
<ide>
<del> result = pass.run();
<add> try {
<add> result = pass.run();
<add> }
<add> catch (UnavailableTypeException e) {
<add> result = true;
<add> distanceAdjust++;
<add> }
<ide>
<ide> pass.toggleTimers(false);
<ide>
<ide> // the current progress.
<ide> progressMap.put(goal, new Integer(currentProgress));
<ide> int newDistance = goal.distanceFromGoal();
<del> int progress = oldDistance - newDistance;
<add> int progress = oldDistance - newDistance + distanceAdjust;
<ide> progress = progress > 0 ? progress : 0; // make sure progress is forward
<ide> if (! result) progress++; // count a failure as progress
<ide> currentProgress += progress; |
|
Java | lgpl-2.1 | 91d4f5e2aca68b21a5564a6264e2cea7da06c610 | 0 | RemiKoutcherawy/exist,wshager/exist,MjAbuz/exist,shabanovd/exist,opax/exist,dizzzz/exist,wolfgangmm/exist,zwobit/exist,lcahlander/exist,RemiKoutcherawy/exist,adamretter/exist,kohsah/exist,joewiz/exist,patczar/exist,patczar/exist,eXist-db/exist,patczar/exist,olvidalo/exist,lcahlander/exist,RemiKoutcherawy/exist,jessealama/exist,jensopetersen/exist,MjAbuz/exist,wolfgangmm/exist,jensopetersen/exist,ljo/exist,lcahlander/exist,jensopetersen/exist,joewiz/exist,MjAbuz/exist,eXist-db/exist,shabanovd/exist,hungerburg/exist,zwobit/exist,opax/exist,hungerburg/exist,wolfgangmm/exist,jessealama/exist,ambs/exist,olvidalo/exist,joewiz/exist,dizzzz/exist,adamretter/exist,windauer/exist,ljo/exist,zwobit/exist,adamretter/exist,dizzzz/exist,MjAbuz/exist,shabanovd/exist,zwobit/exist,opax/exist,dizzzz/exist,ambs/exist,ambs/exist,adamretter/exist,ambs/exist,kohsah/exist,adamretter/exist,lcahlander/exist,kohsah/exist,joewiz/exist,olvidalo/exist,windauer/exist,shabanovd/exist,jessealama/exist,zwobit/exist,olvidalo/exist,wolfgangmm/exist,opax/exist,ljo/exist,ljo/exist,RemiKoutcherawy/exist,wshager/exist,RemiKoutcherawy/exist,hungerburg/exist,wolfgangmm/exist,wshager/exist,RemiKoutcherawy/exist,MjAbuz/exist,jessealama/exist,patczar/exist,eXist-db/exist,jessealama/exist,windauer/exist,patczar/exist,kohsah/exist,ljo/exist,jensopetersen/exist,wshager/exist,wolfgangmm/exist,windauer/exist,jensopetersen/exist,hungerburg/exist,eXist-db/exist,joewiz/exist,ljo/exist,shabanovd/exist,ambs/exist,zwobit/exist,kohsah/exist,kohsah/exist,MjAbuz/exist,wshager/exist,eXist-db/exist,patczar/exist,jessealama/exist,lcahlander/exist,olvidalo/exist,dizzzz/exist,jensopetersen/exist,adamretter/exist,dizzzz/exist,eXist-db/exist,hungerburg/exist,opax/exist,shabanovd/exist,windauer/exist,wshager/exist,joewiz/exist,windauer/exist,lcahlander/exist,ambs/exist | package org.exist.xmldb;
import java.io.IOException;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import org.exist.EXistException;
import org.exist.collections.triggers.TriggerException;
import org.exist.dom.DocumentImpl;
import org.exist.security.ACLPermission;
import org.exist.security.Group;
import org.exist.security.Permission;
import org.exist.security.PermissionDeniedException;
import org.exist.security.Subject;
import org.exist.security.Account;
import org.exist.security.User;
import org.exist.security.SecurityManager;
import org.exist.security.internal.aider.ACEAider;
import org.exist.security.internal.aider.UserAider;
import org.exist.storage.BrokerPool;
import org.exist.storage.DBBroker;
import org.exist.storage.lock.Lock;
import org.exist.storage.txn.TransactionManager;
import org.exist.storage.txn.Txn;
import org.exist.util.LockException;
import org.exist.util.SyntaxException;
import org.xmldb.api.base.Collection;
import org.xmldb.api.base.ErrorCodes;
import org.xmldb.api.base.Resource;
import org.xmldb.api.base.XMLDBException;
/**
* Local Implementation (i.e. embedded) of an eXist-specific service
* which provides methods to manage users and
* permissions.
*
* @author Wolfgang Meier <[email protected]>
* @author Modified by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it
* @author Adam Retter <[email protected]>
*/
public class LocalUserManagementService implements UserManagementService {
private LocalCollection collection;
private final BrokerPool pool;
private final Subject user;
public LocalUserManagementService(Subject user, BrokerPool pool, LocalCollection collection) {
this.pool = pool;
this.collection = collection;
this.user = user;
}
@Override
public String getName() {
return "UserManagementService";
}
@Override
public String getVersion() {
return "1.0";
}
@Override
public void addAccount(final Account u) throws XMLDBException {
final SecurityManager manager = pool.getSecurityManager();
if(!manager.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, " you are not allowed to change this user");
}
if(manager.hasAccount(u.getName())) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "user " + u.getName() + " exists");
}
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException {
manager.addAccount(u);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, e.getMessage(), e);
}
}
@Override
public void addGroup(final Group group) throws XMLDBException {
final SecurityManager manager = pool.getSecurityManager();
if(!manager.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, " you are not allowed to add role");
}
if(manager.hasGroup(group.getName())) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "group '" + group.getName() + "' exists");
}
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException {
manager.addGroup(group);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, e.getMessage(), e);
}
}
@Override
public void setPermissions(final Resource resource, final Permission perm) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
document.setPermissions(perm);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void setPermissions(final Collection child, final Permission perm) throws XMLDBException {
final XmldbURI childUri = XmldbURI.create(child.getName());
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, childUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, LockException {
collection.setPermissions(perm);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + childUri.toString() + "'", e);
}
}
@Override
public void setPermissions(Collection child, final String owner, final String group, final int mode, final List<ACEAider> aces) throws XMLDBException {
final XmldbURI childUri = XmldbURI.create(child.getName());
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, childUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, LockException {
Permission permission = collection.getPermissions();
permission.setOwner(owner);
permission.setGroup(group);
permission.setMode(mode);
if(permission instanceof ACLPermission) {
ACLPermission aclPermission = (ACLPermission)permission;
aclPermission.clear();
for(ACEAider ace : aces) {
aclPermission.addACE(ace.getAccessType(), ace.getTarget(), ace.getWho(), ace.getMode());
}
}
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + childUri.toString() + "'", e);
}
}
@Override
public void setPermissions(final Resource resource, final String owner, final String group, final int mode, final List<ACEAider> aces) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
Permission permission = document.getPermissions();
permission.setOwner(owner);
permission.setGroup(group);
permission.setMode(mode);
if(permission instanceof ACLPermission) {
ACLPermission aclPermission = (ACLPermission)permission;
aclPermission.clear();
for(ACEAider ace : aces) {
aclPermission.addACE(ace.getAccessType(), ace.getTarget(), ace.getWho(), ace.getMode());
}
}
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void chmod(final String modeStr) throws XMLDBException {
final XmldbURI collUri = collection.getPathURI();
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, collUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, SyntaxException, LockException {
collection.setPermissions(modeStr);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + collUri.toString() + "'", e);
}
}
@Override
public void chmod(final Resource resource, final int mode) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
document.getPermissions().setMode(mode);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void chmod(final int mode) throws XMLDBException {
final XmldbURI collUri = collection.getPathURI();
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, collUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, SyntaxException, LockException {
collection.setPermissions(mode);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + collUri.toString() + "'", e);
}
}
@Override
public void chmod(final Resource resource, final String modeStr) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws SyntaxException, PermissionDeniedException, LockException {
document.getPermissions().setMode(modeStr);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void chown(final Account u, final String group) throws XMLDBException {
final XmldbURI collUri = collection.getPathURI();
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, collUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, SyntaxException, LockException {
Permission permission = collection.getPermissions();
permission.setOwner(u);
permission.setGroup(group);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + collUri.toString() + "'", e);
}
}
@Override
public void chown(final Resource resource, final Account u, final String group) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
document.getPermissions().setOwner(u);
document.getPermissions().setGroup(group);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
/* (non-Javadoc)
* @see org.exist.xmldb.UserManagementService#hasUserLock(org.xmldb.api.base.Resource)
*/
@Override
public String hasUserLock(final Resource res) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<String>(){
@Override
public String withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readResource(broker, res, new DatabaseItemReader<DocumentImpl, String>(){
@Override
public String read(DocumentImpl document) {
Account lockOwner = document.getUserLock();
return lockOwner == null ? null : lockOwner.getName();
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void lockResource(final Resource resource, final Account u) throws XMLDBException {
final String resourceId = resource.getId();
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>(){
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, SyntaxException, LockException {
if(!document.getPermissions().validate(user, Permission.WRITE)) {
throw new PermissionDeniedException("User is not allowed to lock resource " + resourceId);
}
SecurityManager manager = broker.getBrokerPool().getSecurityManager();
if(!(user.equals(u) || manager.hasAdminPrivileges(user))) {
throw new PermissionDeniedException("User " + user.getName() + " is not allowed to lock resource '" + resourceId + "' for user " + u.getName());
}
Account lockOwner = document.getUserLock();
if(lockOwner != null) {
if(lockOwner.equals(u)) {
return null;
} else if(!manager.hasAdminPrivileges(user)) {
throw new PermissionDeniedException("Resource '" + resourceId + "' is already locked by user " + lockOwner.getName());
}
}
document.setUserLock(u);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Unable to lock resource '" + resourceId + "': " + e.getMessage(), e);
}
}
@Override
public void unlockResource(final Resource resource) throws XMLDBException {
final String resourceId = resource.getId();
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>(){
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, SyntaxException, LockException {
if(!document.getPermissions().validate(user, Permission.WRITE)) {
throw new PermissionDeniedException("User is not allowed to lock resource '" + resourceId + "'");
}
Account lockOwner = document.getUserLock();
SecurityManager manager = broker.getBrokerPool().getSecurityManager();
if(lockOwner != null && !(lockOwner.equals(user) || manager.hasAdminPrivileges(user))) {
throw new PermissionDeniedException("Resource '" + resourceId + "' is already locked by user " + lockOwner.getName());
}
document.setUserLock(null);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Unable to unlock resource '" + resourceId + "': " + e.getMessage(), e);
}
}
@Override
public Permission getPermissions(Collection coll) throws XMLDBException {
if(coll instanceof LocalCollection) {
return ((LocalCollection) coll).getCollection().getPermissions();
}
return null;
}
@Override
public Permission getSubCollectionPermissions(final Collection parent, final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Permission>(){
@Override
public Permission withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
if(parent instanceof LocalCollection) {
return ((LocalCollection) parent).getCollection().getSubCollectionEntry(broker, name).getPermissions();
}
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e);
}
}
@Override
public Permission getSubResourcePermissions(final Collection parent, final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Permission>(){
@Override
public Permission withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
if(parent instanceof LocalCollection) {
return ((LocalCollection) parent).getCollection().getResourceEntry(broker, name).getPermissions();
}
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e);
}
}
@Override
public Date getSubCollectionCreationTime(final Collection parent, final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Date>(){
@Override
public Date withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
if(parent instanceof LocalCollection) {
return new Date(((LocalCollection) parent).getCollection().getSubCollectionEntry(broker, name).getCreated());
}
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e);
}
}
@Override
public Permission getPermissions(final Resource resource) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Permission>() {
@Override
public Permission withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readResource(broker, resource, new DatabaseItemReader<DocumentImpl, Permission>(){
@Override
public Permission read(DocumentImpl document) {
return document.getPermissions();
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Permission[] listResourcePermissions() throws XMLDBException {
final XmldbURI collectionUri = collection.getPathURI();
try {
return executeWithBroker(new BrokerOperation<Permission[]>() {
@Override
public Permission[] withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readCollection(broker, collectionUri, new DatabaseItemReader<org.exist.collections.Collection, Permission[]>(){
@Override
public Permission[] read(org.exist.collections.Collection collection) throws PermissionDeniedException {
if(!collection.getPermissions().validate(user, Permission.READ)) {
return new Permission[0];
}
Permission perms[] = new Permission[collection.getDocumentCount(broker)];
Iterator<DocumentImpl> itDocument = collection.iterator(broker);
int i = 0;
while(itDocument.hasNext()) {
DocumentImpl document = itDocument.next();
perms[i++] = document.getPermissions();
}
return perms;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Permission[] listCollectionPermissions() throws XMLDBException {
final XmldbURI collectionUri = collection.getPathURI();
try {
return executeWithBroker(new BrokerOperation<Permission[]>() {
@Override
public Permission[] withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readCollection(broker, collectionUri, new DatabaseItemReader<org.exist.collections.Collection, Permission[]>(){
@Override
public Permission[] read(org.exist.collections.Collection collection) throws XMLDBException, PermissionDeniedException {
if(!collection.getPermissions().validate(user, Permission.READ)) {
return new Permission[0];
}
Permission perms[] = new Permission[collection.getChildCollectionCount(broker)];
Iterator<XmldbURI> itChildCollectionUri = collection.collectionIterator(broker);
int i = 0;
while(itChildCollectionUri.hasNext()) {
XmldbURI childCollectionUri = collectionUri.append(itChildCollectionUri.next());
Permission childPermission = readCollection(broker, childCollectionUri, new DatabaseItemReader<org.exist.collections.Collection, Permission>(){
@Override
public Permission read(org.exist.collections.Collection childCollection) {
return childCollection.getPermissions();
}
});
perms[i++] = childPermission;
}
return perms;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Account getAccount(final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Account>(){
@Override
public Account withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
return sm.getAccount(name);
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Account[] getAccounts() throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Account[]>(){
@Override
public Account[] withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
java.util.Collection<Account> users = sm.getUsers();
return users.toArray(new Account[users.size()]);
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Group getGroup(final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Group>(){
@Override
public Group withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
return sm.getGroup(name);
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public String[] getGroups() throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<String[]>(){
@Override
public String[] withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
java.util.Collection<Group> groups = sm.getGroups();
String[] groupNames = new String[groups.size()];
int i = 0;
for (Group group : groups) {
groupNames[i++] = group.getName();
}
return groupNames;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void removeAccount(final Account u) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
if(!sm.hasAdminPrivileges(user))
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not allowed to remove users");
sm.deleteAccount(u);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void removeGroup(final Group group) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
if(!sm.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not allowed to remove groups");
}
sm.deleteGroup(group.getName());
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void setCollection(Collection collection) throws XMLDBException {
this.collection = (LocalCollection) collection;
}
@Override
public void updateAccount(final Account u) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
sm.updateAccount(u);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void addUserGroup(Account user) throws XMLDBException {
}
@Override
public void removeGroup(Account user, String rmgroup) throws XMLDBException {
}
@Override
public void addUser(User user) throws XMLDBException {
Account account = new UserAider(user.getName());
addAccount(account);
}
@Override
public void updateUser(User user) throws XMLDBException {
Account account = new UserAider(user.getName());
account.setPassword(user.getPassword());
//TODO: groups
updateAccount(account);
}
@Override
public User getUser(String name) throws XMLDBException {
return getAccount(name);
}
@Override
public User[] getUsers() throws XMLDBException {
// TODO Auto-generated method stub
return null;
}
@Override
public void removeUser(User user) throws XMLDBException {
// TODO Auto-generated method stub
}
@Override
public void lockResource(Resource res, User u) throws XMLDBException {
Account account = new UserAider(u.getName());
lockResource(res, account);
}
@Override
public String getProperty(String property) throws XMLDBException {
return null;
}
@Override
public void setProperty(String property, String value) throws XMLDBException {
}
private interface BrokerOperation<R> {
public R withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException;
}
private <R> R executeWithBroker(BrokerOperation<R> brokerOperation) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
DBBroker broker = null;
try {
broker = pool.get(user);
return brokerOperation.withBroker(broker);
} finally {
if(broker != null) {
pool.release(broker);
}
}
}
private <R> R readResource(DBBroker broker, Resource resource, DatabaseItemReader<DocumentImpl, R> reader) throws XMLDBException, PermissionDeniedException {
DocumentImpl document = null;
try {
document = ((AbstractEXistResource) resource).openDocument(broker, Lock.READ_LOCK);
return reader.read(document);
} finally {
if(document != null) {
((AbstractEXistResource) resource).closeDocument(document, Lock.READ_LOCK);
}
}
}
private <R> R readCollection(DBBroker broker, XmldbURI collectionURI, DatabaseItemReader<org.exist.collections.Collection, R> reader) throws XMLDBException, PermissionDeniedException {
org.exist.collections.Collection coll = null;
try {
coll = broker.openCollection(collectionURI, Lock.READ_LOCK);
if(coll == null) {
throw new XMLDBException(ErrorCodes.INVALID_COLLECTION, "Collection " + collectionURI.toString() + " not found");
}
return reader.read(coll);
} finally {
if(coll != null) {
coll.release(Lock.READ_LOCK);
}
}
}
private <R> R modifyResource(DBBroker broker, Resource resource, DatabaseItemModifier<DocumentImpl, R> modifier) throws XMLDBException, LockException, PermissionDeniedException, EXistException, SyntaxException {
TransactionManager transact = broker.getBrokerPool().getTransactionManager();
Txn transaction = transact.beginTransaction();
DocumentImpl document = null;
try {
document = ((AbstractEXistResource) resource).openDocument(broker, Lock.WRITE_LOCK);
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
if(!document.getPermissions().validate(user, Permission.WRITE) && !sm.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not the owner of this resource; owner = " + document.getPermissions().getOwner());
}
R result = modifier.modify(document);
broker.storeXMLResource(transaction, document);
transact.commit(transaction);
return result;
} catch(EXistException ee) {
transact.abort(transaction);
throw ee;
} catch(XMLDBException xmldbe) {
transact.abort(transaction);
throw xmldbe;
} catch(LockException le) {
transact.abort(transaction);
throw le;
} catch(PermissionDeniedException pde) {
transact.abort(transaction);
throw pde;
} catch(SyntaxException se) {
transact.abort(transaction);
throw se;
} finally {
if(document != null) {
((AbstractEXistResource)resource).closeDocument(document, Lock.WRITE_LOCK);
}
}
}
private <R> R modifyCollection(DBBroker broker, XmldbURI collectionURI, DatabaseItemModifier<org.exist.collections.Collection, R> modifier) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
TransactionManager transact = broker.getBrokerPool().getTransactionManager();
Txn transaction = transact.beginTransaction();
org.exist.collections.Collection coll = null;
try {
coll = broker.openCollection(collectionURI, Lock.WRITE_LOCK);
if(coll == null) {
throw new XMLDBException(ErrorCodes.INVALID_COLLECTION, "Collection " + collectionURI.toString() + " not found");
}
R result = modifier.modify(coll);
broker.saveCollection(transaction, coll);
transact.commit(transaction);
broker.flush();
return result;
} catch(EXistException ee) {
transact.abort(transaction);
throw ee;
} catch(XMLDBException xmldbe) {
transact.abort(transaction);
throw xmldbe;
} catch(LockException le) {
transact.abort(transaction);
throw le;
} catch(PermissionDeniedException pde) {
transact.abort(transaction);
throw pde;
} catch(IOException ioe) {
transact.abort(transaction);
throw ioe;
} catch(TriggerException te) {
transact.abort(transaction);
throw te;
} catch(SyntaxException se) {
transact.abort(transaction);
throw se;
} finally {
if(coll != null) {
coll.release(Lock.WRITE_LOCK);
}
}
}
private interface DatabaseItemModifier<T, R> {
public R modify(T databaseItem) throws PermissionDeniedException, SyntaxException, LockException;
}
private interface DatabaseItemReader<T, R> {
public R read(T databaseItem) throws PermissionDeniedException, XMLDBException;
}
} | src/org/exist/xmldb/LocalUserManagementService.java | package org.exist.xmldb;
import java.io.IOException;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import org.exist.EXistException;
import org.exist.collections.triggers.TriggerException;
import org.exist.dom.DocumentImpl;
import org.exist.security.ACLPermission;
import org.exist.security.Group;
import org.exist.security.Permission;
import org.exist.security.PermissionDeniedException;
import org.exist.security.Subject;
import org.exist.security.Account;
import org.exist.security.User;
import org.exist.security.SecurityManager;
import org.exist.security.internal.aider.ACEAider;
import org.exist.security.internal.aider.UserAider;
import org.exist.storage.BrokerPool;
import org.exist.storage.DBBroker;
import org.exist.storage.lock.Lock;
import org.exist.storage.txn.TransactionManager;
import org.exist.storage.txn.Txn;
import org.exist.util.LockException;
import org.exist.util.SyntaxException;
import org.xmldb.api.base.Collection;
import org.xmldb.api.base.ErrorCodes;
import org.xmldb.api.base.Resource;
import org.xmldb.api.base.XMLDBException;
/**
* Local Implementation (i.e. embedded) of an eXist-specific service
* which provides methods to manage users and
* permissions.
*
* @author Wolfgang Meier <[email protected]>
* @author Modified by {Marco.Tampucci, Massimo.Martinelli} @isti.cnr.it
* @author Adam Retter <[email protected]>
*/
public class LocalUserManagementService implements UserManagementService {
private LocalCollection collection;
private final BrokerPool pool;
private final Subject user;
public LocalUserManagementService(Subject user, BrokerPool pool, LocalCollection collection) {
this.pool = pool;
this.collection = collection;
this.user = user;
}
@Override
public String getName() {
return "UserManagementService";
}
@Override
public String getVersion() {
return "1.0";
}
@Override
public void addAccount(final Account u) throws XMLDBException {
final SecurityManager manager = pool.getSecurityManager();
if(!manager.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, " you are not allowed to change this user");
}
if(manager.hasAccount(u.getName())) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "user " + u.getName() + " exists");
}
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException {
manager.addAccount(u);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, e.getMessage(), e);
}
}
@Override
public void addGroup(final Group group) throws XMLDBException {
final SecurityManager manager = pool.getSecurityManager();
if(!manager.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, " you are not allowed to add role");
}
if(manager.hasGroup(group.getName())) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "group '" + group.getName() + "' exists");
}
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException {
manager.addGroup(group);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, e.getMessage(), e);
}
}
@Override
public void setPermissions(final Resource resource, final Permission perm) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
document.setPermissions(perm);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void setPermissions(final Collection child, final Permission perm) throws XMLDBException {
final XmldbURI childUri = XmldbURI.create(child.getName());
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, childUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, LockException {
collection.setPermissions(perm);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + childUri.toString() + "'", e);
}
}
@Override
public void setPermissions(Collection child, final String owner, final String group, final int mode, final List<ACEAider> aces) throws XMLDBException {
final XmldbURI childUri = XmldbURI.create(child.getName());
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, childUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, LockException {
Permission permission = collection.getPermissions();
permission.setOwner(owner);
permission.setGroup(group);
permission.setMode(mode);
if(permission instanceof ACLPermission) {
ACLPermission aclPermission = (ACLPermission)permission;
aclPermission.clear();
for(ACEAider ace : aces) {
aclPermission.addACE(ace.getAccessType(), ace.getTarget(), ace.getWho(), ace.getMode());
}
}
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + childUri.toString() + "'", e);
}
}
@Override
public void setPermissions(final Resource resource, final String owner, final String group, final int mode, final List<ACEAider> aces) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
Permission permission = document.getPermissions();
permission.setOwner(owner);
permission.setGroup(group);
permission.setMode(mode);
if(permission instanceof ACLPermission) {
ACLPermission aclPermission = (ACLPermission)permission;
aclPermission.clear();
for(ACEAider ace : aces) {
aclPermission.addACE(ace.getAccessType(), ace.getTarget(), ace.getWho(), ace.getMode());
}
}
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void chmod(final String modeStr) throws XMLDBException {
final XmldbURI collUri = collection.getPathURI();
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, collUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, SyntaxException, LockException {
collection.setPermissions(modeStr);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + collUri.toString() + "'", e);
}
}
@Override
public void chmod(final Resource resource, final int mode) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
document.getPermissions().setMode(mode);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void chmod(final int mode) throws XMLDBException {
final XmldbURI collUri = collection.getPathURI();
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, collUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, SyntaxException, LockException {
collection.setPermissions(mode);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + collUri.toString() + "'", e);
}
}
@Override
public void chmod(final Resource resource, final String modeStr) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws SyntaxException, PermissionDeniedException, LockException {
document.getPermissions().setMode(modeStr);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
@Override
public void chown(final Account u, final String group) throws XMLDBException {
final XmldbURI collUri = collection.getPathURI();
try {
executeWithBroker(new BrokerOperation<Void>() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyCollection(broker, collUri, new DatabaseItemModifier<org.exist.collections.Collection, Void>() {
@Override
public Void modify(org.exist.collections.Collection collection) throws PermissionDeniedException, SyntaxException, LockException {
Permission permission = collection.getPermissions();
permission.setOwner(u);
permission.setGroup(group);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Collection '" + collUri.toString() + "'", e);
}
}
@Override
public void chown(final Resource resource, final Account u, final String group) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation() {
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>() {
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, LockException {
document.getPermissions().setOwner(u);
document.getPermissions().setGroup(group);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Failed to modify permission on Resource '" + resource.getId() + "'", e);
}
}
/* (non-Javadoc)
* @see org.exist.xmldb.UserManagementService#hasUserLock(org.xmldb.api.base.Resource)
*/
@Override
public String hasUserLock(final Resource res) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<String>(){
@Override
public String withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readResource(broker, res, new DatabaseItemReader<DocumentImpl, String>(){
@Override
public String read(DocumentImpl document) {
Account lockOwner = document.getUserLock();
return lockOwner == null ? null : lockOwner.getName();
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void lockResource(final Resource resource, final Account u) throws XMLDBException {
final String resourceId = resource.getId();
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>(){
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, SyntaxException, LockException {
if(!document.getPermissions().validate(user, Permission.WRITE)) {
throw new PermissionDeniedException("User is not allowed to lock resource " + resourceId);
}
SecurityManager manager = broker.getBrokerPool().getSecurityManager();
if(!(user.equals(u) || manager.hasAdminPrivileges(user))) {
throw new PermissionDeniedException("User " + user.getName() + " is not allowed to lock resource '" + resourceId + "' for user " + u.getName());
}
Account lockOwner = document.getUserLock();
if(lockOwner != null) {
if(lockOwner.equals(u)) {
return null;
} else if(!manager.hasAdminPrivileges(user)) {
throw new PermissionDeniedException("Resource '" + resourceId + "' is already locked by user " + lockOwner.getName());
}
}
document.setUserLock(u);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Unable to lock resource '" + resourceId + "': " + e.getMessage(), e);
}
}
@Override
public void unlockResource(final Resource resource) throws XMLDBException {
final String resourceId = resource.getId();
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return modifyResource(broker, resource, new DatabaseItemModifier<DocumentImpl, Void>(){
@Override
public Void modify(DocumentImpl document) throws PermissionDeniedException, SyntaxException, LockException {
if(!document.getPermissions().validate(user, Permission.WRITE)) {
throw new PermissionDeniedException("User is not allowed to lock resource '" + resourceId + "'");
}
Account lockOwner = document.getUserLock();
SecurityManager manager = broker.getBrokerPool().getSecurityManager();
if(lockOwner != null && !(lockOwner.equals(user) || manager.hasAdminPrivileges(user))) {
throw new PermissionDeniedException("Resource '" + resourceId + "' is already locked by user " + lockOwner.getName());
}
document.setUserLock(null);
return null;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, "Unable to unlock resource '" + resourceId + "': " + e.getMessage(), e);
}
}
@Override
public Permission getPermissions(Collection coll) throws XMLDBException {
if(coll instanceof LocalCollection) {
return ((LocalCollection) coll).getCollection().getPermissions();
}
return null;
}
@Override
public Permission getSubCollectionPermissions(final Collection parent, final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Permission>(){
@Override
public Permission withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
if(parent instanceof LocalCollection) {
return ((LocalCollection) parent).getCollection().getSubCollectionEntry(broker, name).getPermissions();
}
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e);
}
}
@Override
public Permission getSubResourcePermissions(final Collection parent, final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Permission>(){
@Override
public Permission withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
if(parent instanceof LocalCollection) {
return ((LocalCollection) parent).getCollection().getResourceEntry(broker, name).getPermissions();
}
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e);
}
}
@Override
public Date getSubCollectionCreationTime(final Collection parent, final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Date>(){
@Override
public Date withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
if(parent instanceof LocalCollection) {
return new Date(((LocalCollection) parent).getCollection().getSubCollectionEntry(broker, name).getCreated());
}
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e);
}
}
@Override
public Permission getPermissions(final Resource resource) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Permission>() {
@Override
public Permission withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readResource(broker, resource, new DatabaseItemReader<DocumentImpl, Permission>(){
@Override
public Permission read(DocumentImpl document) {
return document.getPermissions();
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Permission[] listResourcePermissions() throws XMLDBException {
final XmldbURI collectionUri = collection.getPathURI();
try {
return executeWithBroker(new BrokerOperation<Permission[]>() {
@Override
public Permission[] withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readCollection(broker, collectionUri, new DatabaseItemReader<org.exist.collections.Collection, Permission[]>(){
@Override
public Permission[] read(org.exist.collections.Collection collection) throws PermissionDeniedException {
if(!collection.getPermissions().validate(user, Permission.READ)) {
return new Permission[0];
}
Permission perms[] = new Permission[collection.getDocumentCount(broker)];
Iterator<DocumentImpl> itDocument = collection.iterator(broker);
int i = 0;
while(itDocument.hasNext()) {
DocumentImpl document = itDocument.next();
perms[i++] = document.getPermissions();
}
return perms;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Permission[] listCollectionPermissions() throws XMLDBException {
final XmldbURI collectionUri = collection.getPathURI();
try {
return executeWithBroker(new BrokerOperation<Permission[]>() {
@Override
public Permission[] withBroker(final DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
return readCollection(broker, collectionUri, new DatabaseItemReader<org.exist.collections.Collection, Permission[]>(){
@Override
public Permission[] read(org.exist.collections.Collection collection) throws XMLDBException, PermissionDeniedException {
if(!collection.getPermissions().validate(user, Permission.READ)) {
return new Permission[0];
}
Permission perms[] = new Permission[collection.getChildCollectionCount(broker)];
Iterator<XmldbURI> itChildCollectionUri = collection.collectionIterator(broker);
int i = 0;
while(itChildCollectionUri.hasNext()) {
XmldbURI childCollectionUri = collectionUri.append(itChildCollectionUri.next());
Permission childPermission = readCollection(broker, childCollectionUri, new DatabaseItemReader<org.exist.collections.Collection, Permission>(){
@Override
public Permission read(org.exist.collections.Collection childCollection) {
return childCollection.getPermissions();
}
});
perms[i++] = childPermission;
}
return perms;
}
});
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Account getAccount(final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Account>(){
@Override
public Account withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
return sm.getAccount(user, name);
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Account[] getAccounts() throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Account[]>(){
@Override
public Account[] withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
java.util.Collection<Account> users = sm.getUsers();
return users.toArray(new Account[users.size()]);
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public Group getGroup(final String name) throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<Group>(){
@Override
public Group withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
return sm.getGroup(user, name);
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public String[] getGroups() throws XMLDBException {
try {
return executeWithBroker(new BrokerOperation<String[]>(){
@Override
public String[] withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
java.util.Collection<Group> groups = sm.getGroups();
String[] groupNames = new String[groups.size()];
int i = 0;
for (Group group : groups) {
groupNames[i++] = group.getName();
}
return groupNames;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void removeAccount(final Account u) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
if(!sm.hasAdminPrivileges(user))
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not allowed to remove users");
sm.deleteAccount(u);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void removeGroup(final Group group) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
if(!sm.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not allowed to remove groups");
}
sm.deleteGroup(user, group.getName());
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void setCollection(Collection collection) throws XMLDBException {
this.collection = (LocalCollection) collection;
}
@Override
public void updateAccount(final Account u) throws XMLDBException {
try {
executeWithBroker(new BrokerOperation<Void>(){
@Override
public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
sm.updateAccount(user, u);
return null;
}
});
} catch(Exception e) {
throw new XMLDBException(ErrorCodes.VENDOR_ERROR, e.getMessage(), e);
}
}
@Override
public void addUserGroup(Account user) throws XMLDBException {
}
@Override
public void removeGroup(Account user, String rmgroup) throws XMLDBException {
}
@Override
public void addUser(User user) throws XMLDBException {
Account account = new UserAider(user.getName());
addAccount(account);
}
@Override
public void updateUser(User user) throws XMLDBException {
Account account = new UserAider(user.getName());
account.setPassword(user.getPassword());
//TODO: groups
updateAccount(account);
}
@Override
public User getUser(String name) throws XMLDBException {
return getAccount(name);
}
@Override
public User[] getUsers() throws XMLDBException {
// TODO Auto-generated method stub
return null;
}
@Override
public void removeUser(User user) throws XMLDBException {
// TODO Auto-generated method stub
}
@Override
public void lockResource(Resource res, User u) throws XMLDBException {
Account account = new UserAider(u.getName());
lockResource(res, account);
}
@Override
public String getProperty(String property) throws XMLDBException {
return null;
}
@Override
public void setProperty(String property, String value) throws XMLDBException {
}
private interface BrokerOperation<R> {
public R withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException;
}
private <R> R executeWithBroker(BrokerOperation<R> brokerOperation) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
DBBroker broker = null;
try {
broker = pool.get(user);
return brokerOperation.withBroker(broker);
} finally {
if(broker != null) {
pool.release(broker);
}
}
}
private <R> R readResource(DBBroker broker, Resource resource, DatabaseItemReader<DocumentImpl, R> reader) throws XMLDBException, PermissionDeniedException {
DocumentImpl document = null;
try {
document = ((AbstractEXistResource) resource).openDocument(broker, Lock.READ_LOCK);
return reader.read(document);
} finally {
if(document != null) {
((AbstractEXistResource) resource).closeDocument(document, Lock.READ_LOCK);
}
}
}
private <R> R readCollection(DBBroker broker, XmldbURI collectionURI, DatabaseItemReader<org.exist.collections.Collection, R> reader) throws XMLDBException, PermissionDeniedException {
org.exist.collections.Collection coll = null;
try {
coll = broker.openCollection(collectionURI, Lock.READ_LOCK);
if(coll == null) {
throw new XMLDBException(ErrorCodes.INVALID_COLLECTION, "Collection " + collectionURI.toString() + " not found");
}
return reader.read(coll);
} finally {
if(coll != null) {
coll.release(Lock.READ_LOCK);
}
}
}
private <R> R modifyResource(DBBroker broker, Resource resource, DatabaseItemModifier<DocumentImpl, R> modifier) throws XMLDBException, LockException, PermissionDeniedException, EXistException, SyntaxException {
TransactionManager transact = broker.getBrokerPool().getTransactionManager();
Txn transaction = transact.beginTransaction();
DocumentImpl document = null;
try {
document = ((AbstractEXistResource) resource).openDocument(broker, Lock.WRITE_LOCK);
SecurityManager sm = broker.getBrokerPool().getSecurityManager();
if(!document.getPermissions().validate(user, Permission.WRITE) && !sm.hasAdminPrivileges(user)) {
throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not the owner of this resource; owner = " + document.getPermissions().getOwner());
}
R result = modifier.modify(document);
broker.storeXMLResource(transaction, document);
transact.commit(transaction);
return result;
} catch(EXistException ee) {
transact.abort(transaction);
throw ee;
} catch(XMLDBException xmldbe) {
transact.abort(transaction);
throw xmldbe;
} catch(LockException le) {
transact.abort(transaction);
throw le;
} catch(PermissionDeniedException pde) {
transact.abort(transaction);
throw pde;
} catch(SyntaxException se) {
transact.abort(transaction);
throw se;
} finally {
if(document != null) {
((AbstractEXistResource)resource).closeDocument(document, Lock.WRITE_LOCK);
}
}
}
private <R> R modifyCollection(DBBroker broker, XmldbURI collectionURI, DatabaseItemModifier<org.exist.collections.Collection, R> modifier) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
TransactionManager transact = broker.getBrokerPool().getTransactionManager();
Txn transaction = transact.beginTransaction();
org.exist.collections.Collection coll = null;
try {
coll = broker.openCollection(collectionURI, Lock.WRITE_LOCK);
if(coll == null) {
throw new XMLDBException(ErrorCodes.INVALID_COLLECTION, "Collection " + collectionURI.toString() + " not found");
}
R result = modifier.modify(coll);
broker.saveCollection(transaction, coll);
transact.commit(transaction);
broker.flush();
return result;
} catch(EXistException ee) {
transact.abort(transaction);
throw ee;
} catch(XMLDBException xmldbe) {
transact.abort(transaction);
throw xmldbe;
} catch(LockException le) {
transact.abort(transaction);
throw le;
} catch(PermissionDeniedException pde) {
transact.abort(transaction);
throw pde;
} catch(IOException ioe) {
transact.abort(transaction);
throw ioe;
} catch(TriggerException te) {
transact.abort(transaction);
throw te;
} catch(SyntaxException se) {
transact.abort(transaction);
throw se;
} finally {
if(coll != null) {
coll.release(Lock.WRITE_LOCK);
}
}
}
private interface DatabaseItemModifier<T, R> {
public R modify(T databaseItem) throws PermissionDeniedException, SyntaxException, LockException;
}
private interface DatabaseItemReader<T, R> {
public R read(T databaseItem) throws PermissionDeniedException, XMLDBException;
}
} | [ignore] cleanup 'invokingUser' parameter
svn path=/trunk/eXist/; revision=16491
| src/org/exist/xmldb/LocalUserManagementService.java | [ignore] cleanup 'invokingUser' parameter | <ide><path>rc/org/exist/xmldb/LocalUserManagementService.java
<ide> @Override
<ide> public Account withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
<ide> SecurityManager sm = broker.getBrokerPool().getSecurityManager();
<del> return sm.getAccount(user, name);
<add> return sm.getAccount(name);
<ide> }
<ide> });
<ide> } catch(Exception e) {
<ide> @Override
<ide> public Group withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
<ide> SecurityManager sm = broker.getBrokerPool().getSecurityManager();
<del> return sm.getGroup(user, name);
<add> return sm.getGroup(name);
<ide> }
<ide> });
<ide> } catch(Exception e) {
<ide> public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
<ide> SecurityManager sm = broker.getBrokerPool().getSecurityManager();
<ide> if(!sm.hasAdminPrivileges(user)) {
<del> throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not allowed to remove groups");
<add> throw new XMLDBException(ErrorCodes.PERMISSION_DENIED, "you are not allowed to remove groups");
<ide> }
<ide>
<del> sm.deleteGroup(user, group.getName());
<add> sm.deleteGroup(group.getName());
<ide>
<ide> return null;
<ide> }
<ide> public Void withBroker(DBBroker broker) throws XMLDBException, LockException, PermissionDeniedException, IOException, EXistException, TriggerException, SyntaxException {
<ide> SecurityManager sm = broker.getBrokerPool().getSecurityManager();
<ide>
<del> sm.updateAccount(user, u);
<add> sm.updateAccount(u);
<ide>
<ide> return null;
<ide> } |
|
Java | bsd-3-clause | d8c4a230dbe00b6d695ac4cd68b59f0caaf1989a | 0 | Team766/Valkyrie | /*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2008. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
/*----------------------------------------------------------------------------*/
package com.ma.bears.Valkyrie;
/**
* @author Nicky Ivy [email protected]
*
* Java code for 2014 robot. Mainly a test
* and proof of concept to see how well Java
* works for programming the robot.
*
* Currently drives with a tank system.
* CheesyDrive may be implemented later.
*
* Command-based things are commented out
* for now. This means the shooter is
* manually pulled back by a button.
*
* TODO:
* Cheesy Drive
*/
import com.ma.bears.Valkyrie.commands.Arm.ArmDownCommand;
import com.ma.bears.Valkyrie.commands.Arm.EjectCommand;
import com.ma.bears.Valkyrie.commands.Arm.InboundCommand;
import com.ma.bears.Valkyrie.commands.Arm.PickupCommand;
import com.ma.bears.Valkyrie.commands.Arm.RollerInCommand;
import com.ma.bears.Valkyrie.commands.Arm.RollerOutCommand;
import com.ma.bears.Valkyrie.commands.Shooter.ShootCommand;
import com.ma.bears.Valkyrie.CheesyVisionServer;
import edu.wpi.first.wpilibj.IterativeRobot;
import edu.wpi.first.wpilibj.buttons.Button;
import edu.wpi.first.wpilibj.smartdashboard.SmartDashboard;
import edu.wpi.first.wpilibj.Talon;
import edu.wpi.first.wpilibj.Jaguar;
import edu.wpi.first.wpilibj.Solenoid;
import edu.wpi.first.wpilibj.Relay;
import edu.wpi.first.wpilibj.DigitalInput;
import edu.wpi.first.wpilibj.Watchdog;
import edu.wpi.first.wpilibj.Joystick;
import edu.wpi.first.wpilibj.buttons.JoystickButton;
import edu.wpi.first.wpilibj.command.Scheduler;
import edu.wpi.first.wpilibj.DriverStationLCD;
/**
* The VM is configured to automatically run this class, and to call the
* functions corresponding to each mode, as described in the SimpleRobot
* documentation. If you change the name of this class or the package after
* creating this project, you must also update the manifest file in the resource
* directory.
*/
public class Valkyrie extends IterativeRobot {
CheesyVisionServer server = CheesyVisionServer.getInstance();
public final int listenPort = 1180;
public static Joystick jLeft = new Joystick(1);
public static Joystick jRight = new Joystick(2);
public static Joystick jBox = new Joystick(3);
public static final Talon leftDrive = new Talon(Ports.PWM_Left_Drive);
public static final Talon rightDrive = new Talon(Ports.PWM_Right_Drive);
public static final Jaguar Winch = new Jaguar(Ports.PWM_Winch);
public static final Talon ArmWheels = new Talon(Ports.PWM_ArmWheels);
public static final Relay Compr = new Relay(Ports.Relay_Compr);
public static final DigitalInput Pressure = new DigitalInput(Ports.DIO_Pressure);
public static final DigitalInput LauncherBotm = new DigitalInput(Ports.DIO_LauncherBotm);
public static final Solenoid
Shifter = new Solenoid(Ports.Sol_Shifter),
WinchPist = new Solenoid(Ports.Sol_WinchPist),
Arm = new Solenoid(Ports.Sol_Arm),
BallGuard = new Solenoid(Ports.Sol_BallGuard),
Ejector = new Solenoid(Ports.Sol_Ejector);
//declare joystick buttons as Buttons instead of reading them raw
//not always used yet - useful for running things with commands
public static final Button
//button name = new JoystickButton(joystick, button number),
buttonShifter = new JoystickButton(jLeft, Buttons.Shifter),
buttonReverse = new JoystickButton(jRight, Buttons.Reverse),
buttonDriverPickup = new JoystickButton(jRight, Buttons.DriverPickup),
buttonDriverShoot = new JoystickButton(jRight, Buttons.DriverShoot),
buttonShoot = new JoystickButton(jBox, Buttons.Shoot),
buttonWinchOn = new JoystickButton(jBox, Buttons.WinchOn),
buttonRollerIn = new JoystickButton(jBox, Buttons.RollerIn),
buttonRollerOut = new JoystickButton(jBox, Buttons.RollerOut),
buttonPickup = new JoystickButton(jBox, Buttons.Pickup),
buttonInbound = new JoystickButton(jBox, Buttons.Inbound),
buttonEjector = new JoystickButton(jBox, Buttons.Ejector),
buttonArmDown = new JoystickButton(jBox, Buttons.Arm),
buttonAutoShoot = new JoystickButton(jBox, Buttons.AutoShoot),
buttonCancel = new JoystickButton(jBox, Buttons.ShootCancel);
public void robotInit(){
//just testing out some SmartDash, DriverLCD stuff
SmartDashboard.putString("test", "test");
DriverStationLCD lcd = DriverStationLCD.getInstance();
lcd.println(DriverStationLCD.Line.kUser1, 1, "test");
server.setPort(listenPort);
server.start();
}
public void autonomousInit() {
server.reset();
server.startSamplingCounts();
}
public void disabledInit() {
server.stopSamplingCounts();
}
public void autonomousPeriodic() {
System.out.println("Current left: " + server.getLeftStatus() + ", current right: " + server.getRightStatus());
System.out.println("Left count: " + server.getLeftCount() + ", right count: " + server.getRightCount() + ", total: " + server.getTotalCount() + "\n");
}
/**
* This function is called once each time the robot enters autonomous mode.
*/
public void autonomous() {
while(isAutonomous() && isEnabled()){
if(server.getLeftCount() > 5){
System.out.println("Left Hand Auton");
}
else if(server.getRightCount() > 5){
System.out.println("Right Hand Auton");
}
//Goalie Pole Stuff
/*if(server.getLeftStatus()){
//Move Backwards
}
if(server.getRightStatus()){
//Move Forwards
}
*/
}
}
/**
* This function is called once each time the robot enters operator control.
*/
public void operatorControl() {
}
public void teleopPeriodic(){
//Tank drive input
double LeftDriveC = -jLeft.getRawAxis(2);
double RightDriveC = jRight.getRawAxis(2);
boolean ShifterC = (jLeft.getRawButton(Buttons.Shifter));
boolean ReverseC = (jLeft.getRawButton(Buttons.Reverse));
//switches robot to drive like shooter is front, as opposed to pickup
if(ReverseC){
double RightSave = RightDriveC;
RightDriveC = LeftDriveC;
LeftDriveC = RightSave;
}
leftDrive.set(LeftDriveC);
rightDrive.set(RightDriveC);
Shifter.set(!ShifterC);
//Winch
//Press button to pull down winch on shooter
//Press separate button to launch
boolean ShooterWinchOnC = jBox.getRawButton(Buttons.WinchOn);
boolean ShooterLaunchC = (jBox.getRawButton(Buttons.Shoot) || jRight.getRawButton(Buttons.DriverShoot));
boolean ShooterLoaded = !LauncherBotm.get();
double WinchC = (!ShooterLoaded && !ShooterLaunchC && ShooterWinchOnC)? RobotValues.WinchSpeed : 0;
WinchPist.set(ShooterLaunchC);
Winch.set(WinchC);
//ball grippers default to on, but by code
//this way on, off works properly by commands with true, false
//but we want them default on to hold ball more reliably
boolean BallGuardC = true;
if (jBox.getRawAxis(4) < 0 && !ShooterLaunchC){
BallGuardC = false;
}
boolean EjectorC = jBox.getRawButton(Buttons.Ejector);
boolean ArmC = jBox.getRawButton(Buttons.Arm);
boolean PickupC = (jBox.getRawButton(Buttons.Pickup) || jRight.getRawButton(Buttons.DriverPickup));
boolean InboundC = jBox.getRawButton(Buttons.Inbound);
boolean RollerInC = jBox.getRawButton(Buttons.RollerIn);
boolean RollerOutC = jBox.getRawButton(Buttons.RollerOut);
double ArmWheelsC = 0;
if(RollerInC){ //manual roller in
ArmWheelsC = RobotValues.ArmWheels_In;
}
if(RollerOutC){ //manual roller out
ArmWheelsC = RobotValues.ArmWheels_Out;
}
if(PickupC){ //combo pickup - arm down, roller in, grips on
ArmWheelsC = RobotValues.ArmWheels_In;
BallGuardC = true;
ArmC = true;
}
if(InboundC){ //combo inbound - arm down, roller out, grips off
ArmWheelsC = RobotValues.ArmWheels_Out;
BallGuardC = false;
ArmC = true;
}
if(EjectorC){ //eject - ejector piston on, roller out, grips off
ArmWheelsC = RobotValues.ArmWheels_Out;
BallGuardC = false;
//the ejector itself will use EjectorC
}
Arm.set(ArmC);
ArmWheels.set(ArmWheelsC);
BallGuard.set(BallGuardC);
Ejector.set(EjectorC);
/*
* attempts at automatic commands here
* commented out at the moment for testing later
*
*/
/* buttonShoot.whenPressed(new ShootCommand());
//buttonCancel.cancelWhenPressed(new ShootSeqCommand()); //not really sure how this works?
buttonRollerIn.whileHeld(new RollerInCommand());
buttonRollerOut.whileHeld(new RollerOutCommand());
buttonArmDown.whileHeld(new ArmDownCommand());
buttonEjector.whileHeld(new EjectCommand());
buttonPickup.whileHeld(new PickupCommand());
buttonDriverPickup.toggleWhenPressed(new PickupCommand()); //driver is toggle while human is held
buttonInbound.whileHeld(new InboundCommand()); */
//compressor
Compr.set(Pressure.get()? Relay.Value.kOff : Relay.Value.kForward);
Scheduler.getInstance().run(); //update commands
Watchdog.getInstance().feed(); //very hungry
}
}
| src/com/ma/bears/Valkyrie/Valkyrie.java | /*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2008. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
/*----------------------------------------------------------------------------*/
package com.ma.bears.Valkyrie;
/**
* @author Nicky Ivy [email protected]
*
* Java code for 2014 robot. Mainly a test
* and proof of concept to see how well Java
* works for programming the robot.
*
* Currently drives with a tank system.
* CheesyDrive may be implemented later.
*
* Command-based things are commented out
* for now. This means the shooter is
* manually pulled back by a button.
*/
import com.ma.bears.Valkyrie.commands.Arm.ArmDownCommand;
import com.ma.bears.Valkyrie.commands.Arm.EjectCommand;
import com.ma.bears.Valkyrie.commands.Arm.InboundCommand;
import com.ma.bears.Valkyrie.commands.Arm.PickupCommand;
import com.ma.bears.Valkyrie.commands.Arm.RollerInCommand;
import com.ma.bears.Valkyrie.commands.Arm.RollerOutCommand;
import com.ma.bears.Valkyrie.commands.Shooter.ShootCommand;
import com.ma.bears.Valkyrie.CheesyVisionServer;
import edu.wpi.first.wpilibj.IterativeRobot;
import edu.wpi.first.wpilibj.buttons.Button;
import edu.wpi.first.wpilibj.smartdashboard.SmartDashboard;
import edu.wpi.first.wpilibj.Talon;
import edu.wpi.first.wpilibj.Jaguar;
import edu.wpi.first.wpilibj.Solenoid;
import edu.wpi.first.wpilibj.Relay;
import edu.wpi.first.wpilibj.DigitalInput;
import edu.wpi.first.wpilibj.Watchdog;
import edu.wpi.first.wpilibj.Joystick;
import edu.wpi.first.wpilibj.buttons.JoystickButton;
import edu.wpi.first.wpilibj.command.Scheduler;
import edu.wpi.first.wpilibj.DriverStationLCD;
/**
* The VM is configured to automatically run this class, and to call the
* functions corresponding to each mode, as described in the SimpleRobot
* documentation. If you change the name of this class or the package after
* creating this project, you must also update the manifest file in the resource
* directory.
*/
public class Valkyrie extends IterativeRobot {
CheesyVisionServer server = CheesyVisionServer.getInstance();
public final int listenPort = 1180;
public static Joystick jLeft = new Joystick(1);
public static Joystick jRight = new Joystick(2);
public static Joystick jBox = new Joystick(3);
public static final Talon leftDrive = new Talon(Ports.PWM_Left_Drive);
public static final Talon rightDrive = new Talon(Ports.PWM_Right_Drive);
public static final Jaguar Winch = new Jaguar(Ports.PWM_Winch);
public static final Talon ArmWheels = new Talon(Ports.PWM_ArmWheels);
public static final Relay Compr = new Relay(Ports.Relay_Compr);
public static final DigitalInput Pressure = new DigitalInput(Ports.DIO_Pressure);
public static final DigitalInput LauncherBotm = new DigitalInput(Ports.DIO_LauncherBotm);
public static final Solenoid
Shifter = new Solenoid(Ports.Sol_Shifter),
WinchPist = new Solenoid(Ports.Sol_WinchPist),
Arm = new Solenoid(Ports.Sol_Arm),
BallGuard = new Solenoid(Ports.Sol_BallGuard),
Ejector = new Solenoid(Ports.Sol_Ejector);
//declare joystick buttons as Buttons instead of reading them raw
//not always used yet - useful for running things with commands
public static final Button
//button name = new JoystickButton(joystick, button number),
buttonShifter = new JoystickButton(jLeft, Buttons.Shifter),
buttonReverse = new JoystickButton(jRight, Buttons.Reverse),
buttonDriverPickup = new JoystickButton(jRight, Buttons.DriverPickup),
buttonDriverShoot = new JoystickButton(jRight, Buttons.DriverShoot),
buttonShoot = new JoystickButton(jBox, Buttons.Shoot),
buttonWinchOn = new JoystickButton(jBox, Buttons.WinchOn),
buttonRollerIn = new JoystickButton(jBox, Buttons.RollerIn),
buttonRollerOut = new JoystickButton(jBox, Buttons.RollerOut),
buttonPickup = new JoystickButton(jBox, Buttons.Pickup),
buttonInbound = new JoystickButton(jBox, Buttons.Inbound),
buttonEjector = new JoystickButton(jBox, Buttons.Ejector),
buttonArmDown = new JoystickButton(jBox, Buttons.Arm),
buttonAutoShoot = new JoystickButton(jBox, Buttons.AutoShoot),
buttonCancel = new JoystickButton(jBox, Buttons.ShootCancel);
public void robotInit(){
//just testing out some SmartDash, DriverLCD stuff
SmartDashboard.putString("test", "test");
DriverStationLCD lcd = DriverStationLCD.getInstance();
lcd.println(DriverStationLCD.Line.kUser1, 1, "test");
server.setPort(listenPort);
server.start();
}
public void autonomousInit() {
server.reset();
server.startSamplingCounts();
}
public void disabledInit() {
server.stopSamplingCounts();
}
public void autonomousPeriodic() {
System.out.println("Current left: " + server.getLeftStatus() + ", current right: " + server.getRightStatus());
System.out.println("Left count: " + server.getLeftCount() + ", right count: " + server.getRightCount() + ", total: " + server.getTotalCount() + "\n");
}
/**
* This function is called once each time the robot enters autonomous mode.
*/
public void autonomous() {
while(isAutonomous() && isEnabled()){
if(server.getLeftCount() > 5){
System.out.println("Left Hand Auton");
}
else if(server.getRightCount() > 5){
System.out.println("Right Hand Auton");
}
//Goalie Pole Stuff
/*if(server.getLeftStatus()){
//Move Backwards
}
if(server.getRightStatus()){
//Move Forwards
}
*/
}
}
/**
* This function is called once each time the robot enters operator control.
*/
public void operatorControl() {
}
public void teleopPeriodic(){
//Tank drive input
double LeftDriveC = -jLeft.getRawAxis(2);
double RightDriveC = jRight.getRawAxis(2);
boolean ShifterC = (jLeft.getRawButton(Buttons.Shifter));
boolean ReverseC = (jLeft.getRawButton(Buttons.Reverse));
//switches robot to drive like shooter is front, as opposed to pickup
if(ReverseC){
double RightSave = RightDriveC;
RightDriveC = LeftDriveC;
LeftDriveC = RightSave;
}
leftDrive.set(LeftDriveC);
rightDrive.set(RightDriveC);
Shifter.set(!ShifterC);
//Winch
//Press button to pull down winch on shooter
//Press separate button to launch
boolean ShooterWinchOnC = jBox.getRawButton(Buttons.WinchOn);
boolean ShooterLaunchC = (jBox.getRawButton(Buttons.Shoot) || jRight.getRawButton(Buttons.DriverShoot));
boolean ShooterLoaded = !LauncherBotm.get();
double WinchC = (!ShooterLoaded && !ShooterLaunchC && ShooterWinchOnC)? RobotValues.WinchSpeed : 0;
WinchPist.set(ShooterLaunchC);
Winch.set(WinchC);
//ball grippers default to on, but by code
//this way on, off works properly by commands with true, false
//but we want them default on to hold ball more reliably
boolean BallGuardC = true;
if (jBox.getRawAxis(4) < 0 && !ShooterLaunchC){
BallGuardC = false;
}
boolean EjectorC = jBox.getRawButton(Buttons.Ejector);
boolean ArmC = jBox.getRawButton(Buttons.Arm);
boolean PickupC = (jBox.getRawButton(Buttons.Pickup) || jRight.getRawButton(Buttons.DriverPickup));
boolean InboundC = jBox.getRawButton(Buttons.Inbound);
boolean RollerInC = jBox.getRawButton(Buttons.RollerIn);
boolean RollerOutC = jBox.getRawButton(Buttons.RollerOut);
double ArmWheelsC = 0;
if(RollerInC){ //manual roller in
ArmWheelsC = RobotValues.ArmWheels_In;
}
if(RollerOutC){ //manual roller out
ArmWheelsC = RobotValues.ArmWheels_Out;
}
if(PickupC){ //combo pickup - arm down, roller in, grips on
ArmWheelsC = RobotValues.ArmWheels_In;
BallGuardC = true;
ArmC = true;
}
if(InboundC){ //combo inbound - arm down, roller out, grips off
ArmWheelsC = RobotValues.ArmWheels_Out;
BallGuardC = false;
ArmC = true;
}
if(EjectorC){ //eject - ejector piston on, roller out, grips off
ArmWheelsC = RobotValues.ArmWheels_Out;
BallGuardC = false;
//the ejector itself will use EjectorC
}
Arm.set(ArmC);
ArmWheels.set(ArmWheelsC);
BallGuard.set(BallGuardC);
Ejector.set(EjectorC);
/*
* attempts at automatic commands here
* commented out at the moment for testing later
*
*/
/* buttonShoot.whenPressed(new ShootCommand());
//buttonCancel.cancelWhenPressed(new ShootSeqCommand()); //not really sure how this works?
buttonRollerIn.whileHeld(new RollerInCommand());
buttonRollerOut.whileHeld(new RollerOutCommand());
buttonArmDown.whileHeld(new ArmDownCommand());
buttonEjector.whileHeld(new EjectCommand());
buttonPickup.whileHeld(new PickupCommand());
buttonDriverPickup.toggleWhenPressed(new PickupCommand()); //driver is toggle while human is held
buttonInbound.whileHeld(new InboundCommand()); */
//compressor
Compr.set(Pressure.get()? Relay.Value.kOff : Relay.Value.kForward);
Scheduler.getInstance().run(); //update commands
Watchdog.getInstance().feed(); //very hungry
}
}
| Added a TODO list | src/com/ma/bears/Valkyrie/Valkyrie.java | Added a TODO list | <ide><path>rc/com/ma/bears/Valkyrie/Valkyrie.java
<ide> * Command-based things are commented out
<ide> * for now. This means the shooter is
<ide> * manually pulled back by a button.
<add> *
<add> * TODO:
<add> * Cheesy Drive
<ide> */
<ide> import com.ma.bears.Valkyrie.commands.Arm.ArmDownCommand;
<ide> import com.ma.bears.Valkyrie.commands.Arm.EjectCommand; |
|
Java | mit | c76855a64e043fc6c4b090370052a0e032bbead6 | 0 | boq/mod-utils | package boq.utils.misc;
import java.util.Random;
import net.minecraft.entity.item.EntityItem;
import net.minecraft.item.ItemStack;
import net.minecraft.util.Vec3;
import net.minecraft.world.World;
import com.google.common.base.Preconditions;
public class Utils {
public static final Random RANDOM = new Random();
public static void dropItem(World world, Vec3 vec, ItemStack is) {
dropItem(world, vec.xCoord, vec.yCoord, vec.zCoord, is);
}
public static void dropItem(World world, double x, double y, double z, ItemStack is) {
EntityItem item = new EntityItem(world, x, y, z, is.copy());
double f3 = 0.05;
item.motionX = RANDOM.nextGaussian() * f3;
item.motionY = RANDOM.nextGaussian() * f3 + 0.2;
item.motionZ = RANDOM.nextGaussian() * f3;
world.spawnEntityInWorld(item);
}
public static Object[] wrap(Object... args) {
return args;
}
public static int toInt(Object obj) {
Preconditions.checkNotNull(obj, "Expected number but got null");
if (obj instanceof Number)
return ((Number)obj).intValue();
return Integer.parseInt(obj.toString());
}
public final static Object[] FALSE = wrap(false);
public final static Object[] TRUE = wrap(true);
public static boolean checkArg(Object[] args, int pos) {
return args.length > pos && args[pos] != null;
}
}
| boq/utils/misc/Utils.java | package boq.utils.misc;
import java.util.Random;
import net.minecraft.entity.item.EntityItem;
import net.minecraft.item.ItemStack;
import net.minecraft.util.Vec3;
import net.minecraft.world.World;
public class Utils {
public static final Random RANDOM = new Random();
public static void dropItem(World world, Vec3 vec, ItemStack is) {
dropItem(world, vec.xCoord, vec.yCoord, vec.zCoord, is);
}
public static void dropItem(World world, double x, double y, double z, ItemStack is) {
EntityItem item = new EntityItem(world, x, y, z, is.copy());
double f3 = 0.05;
item.motionX = RANDOM.nextGaussian() * f3;
item.motionY = RANDOM.nextGaussian() * f3 + 0.2;
item.motionZ = RANDOM.nextGaussian() * f3;
world.spawnEntityInWorld(item);
}
public static Object[] wrap(Object... args) {
return args;
}
public static int toInt(Object obj) {
return ((Number)obj).intValue();
}
public final static Object[] FALSE = wrap(false);
public final static Object[] TRUE = wrap(true);
}
| More flexible CC helpers
| boq/utils/misc/Utils.java | More flexible CC helpers | <ide><path>oq/utils/misc/Utils.java
<ide> import net.minecraft.item.ItemStack;
<ide> import net.minecraft.util.Vec3;
<ide> import net.minecraft.world.World;
<add>
<add>import com.google.common.base.Preconditions;
<ide>
<ide> public class Utils {
<ide> public static final Random RANDOM = new Random();
<ide> }
<ide>
<ide> public static int toInt(Object obj) {
<del> return ((Number)obj).intValue();
<add> Preconditions.checkNotNull(obj, "Expected number but got null");
<add>
<add> if (obj instanceof Number)
<add> return ((Number)obj).intValue();
<add>
<add> return Integer.parseInt(obj.toString());
<ide> }
<ide>
<ide> public final static Object[] FALSE = wrap(false);
<ide> public final static Object[] TRUE = wrap(true);
<add>
<add> public static boolean checkArg(Object[] args, int pos) {
<add> return args.length > pos && args[pos] != null;
<add> }
<ide> } |
|
Java | apache-2.0 | 8f229ad1e2447b381cd58f10fcf4a428979b3014 | 0 | rapidoid/rapidoid,rapidoid/rapidoid,rapidoid/rapidoid,rapidoid/rapidoid | package org.rapidoid.util;
/*
* #%L
* rapidoid-u
* %%
* Copyright (C) 2014 Nikolche Mihajlovski
* %%
* 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 java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.RandomAccessFile;
import java.io.UnsupportedEncodingException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.URL;
import java.net.URLDecoder;
import java.nio.ByteBuffer;
import java.nio.MappedByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.FileChannel.MapMode;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
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.TimeZone;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class U implements Constants {
public static final LogLevel TRACE = LogLevel.TRACE;
public static final LogLevel DEBUG = LogLevel.DEBUG;
public static final LogLevel INFO = LogLevel.INFO;
public static final LogLevel WARN = LogLevel.WARN;
public static final LogLevel ERROR = LogLevel.ERROR;
public static final LogLevel SEVERE = LogLevel.SEVERE;
private static LogLevel LOG_LEVEL = INFO;
private static final Map<Class<?>, Object> SINGLETONS = map();
protected static final Random RND = new Random();
private static final Map<Class<?>, Map<String, ? extends RuntimeException>> EXCEPTIONS = autoExpandingMap(new F1<Map<String, ? extends RuntimeException>, Class<?>>() {
@Override
public Map<String, ? extends RuntimeException> execute(final Class<?> clazz) throws Exception {
return autoExpandingMap(new F1<RuntimeException, String>() {
@Override
public RuntimeException execute(String msg) throws Exception {
return (RuntimeException) (msg.isEmpty() ? newInstance(clazz) : newInstance(clazz, msg));
}
});
}
});
private static final Method getGarbageCollectorMXBeans;
static {
Class<?> manFactory = U.getClassIfExists("java.lang.management.ManagementFactory");
getGarbageCollectorMXBeans = manFactory != null ? U.getMethod(manFactory, "getGarbageCollectorMXBeans") : null;
}
private static ScheduledThreadPoolExecutor EXECUTOR;
private static long measureStart;
private static String[] ARGS = {};
private static final Class<U> CLASS = U.class;
public static final ClassLoader CLASS_LOADER = CLASS.getClassLoader();
private static final Set<Class<?>> MANAGED_CLASSES = set();
private static final Set<Object> MANAGED_INSTANCES = set();
private static final Map<Object, Object> IOC_INSTANCES = map();
private static final Map<Class<?>, List<Field>> INJECTABLE_FIELDS = autoExpandingMap(new F1<List<Field>, Class<?>>() {
@Override
public List<Field> execute(Class<?> clazz) throws Exception {
List<Field> fields = getFieldsAnnotated(clazz, Inject.class);
debug("Retrieved injectable fields", "class", clazz, "fields", fields);
return fields;
}
});
private static final Calendar CALENDAR = Calendar.getInstance();
private static final Map<Class<?>, Set<Object>> INJECTION_PROVIDERS = map();
private static final Map<String, TypeKind> KINDS = initKinds();
/* RFC 1123 date-time format, e.g. Sun, 07 Sep 2014 00:17:29 GMT */
private static final DateFormat DATE_FORMAT = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
private static final Date CURR_DATE = new Date();
private static byte[] CURR_DATE_BYTES;
private static long updateCurrDateAfter = 0;
static {
DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("GMT"));
}
private U() {
}
public static byte[] getDateTimeBytes() {
long time = System.currentTimeMillis();
// avoid synchronization for better performance
if (time > updateCurrDateAfter) {
CURR_DATE.setTime(time);
CURR_DATE_BYTES = DATE_FORMAT.format(CURR_DATE).getBytes();
updateCurrDateAfter = time + 1000;
}
return CURR_DATE_BYTES;
}
private static final Map<Class<?>, List<F3<Object, Object, Method, Object[]>>> INTERCEPTORS = map();
private static final Map<Class<?>, Map<String, Prop>> BEAN_PROPERTIES = autoExpandingMap(new F1<Map<String, Prop>, Class<?>>() {
@Override
public Map<String, Prop> execute(Class<?> clazz) throws Exception {
Map<String, Prop> properties = map();
try {
for (Class<?> c = clazz; c != Object.class && c != null; c = c.getSuperclass()) {
Method[] methods = c.getDeclaredMethods();
for (Method method : methods) {
int modif = method.getModifiers();
if ((modif & Modifier.PUBLIC) > 0 && (modif & Modifier.STATIC) == 0
&& (modif & Modifier.ABSTRACT) == 0) {
String name = method.getName();
if (name.matches("^(get|set|is)[A-Z].*")) {
String fieldName;
if (name.startsWith("is")) {
fieldName = name.substring(2, 3).toLowerCase() + name.substring(3);
} else {
fieldName = name.substring(3, 4).toLowerCase() + name.substring(4);
}
Prop propInfo = properties.get(fieldName);
if (propInfo == null) {
propInfo = new Prop();
propInfo.setName(fieldName);
properties.put(fieldName, propInfo);
}
if (name.startsWith("set")) {
propInfo.setSetter(method);
} else {
propInfo.setGetter(method);
}
}
}
}
for (Iterator<Entry<String, Prop>> it = properties.entrySet().iterator(); it.hasNext();) {
Entry<String, Prop> entry = (Entry<String, Prop>) it.next();
Prop minfo = entry.getValue();
if (minfo.getGetter() == null || minfo.getSetter() == null) {
it.remove();
}
}
}
for (Class<?> c = clazz; c != Object.class && c != null; c = c.getSuperclass()) {
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
int modif = field.getModifiers();
if ((modif & Modifier.PUBLIC) > 0 && (modif & Modifier.FINAL) == 0
&& (modif & Modifier.STATIC) == 0) {
String fieldName = field.getName();
Prop propInfo = properties.get(fieldName);
if (propInfo == null) {
propInfo = new Prop();
propInfo.setName(fieldName);
properties.put(fieldName, propInfo);
propInfo.setField(field);
}
}
}
}
} catch (Exception e) {
throw U.rte(e);
}
return properties;
}
});
public static synchronized void setLogLevel(LogLevel logLevel) {
LOG_LEVEL = logLevel;
}
public static synchronized void reset() {
info("Reset U state");
LOG_LEVEL = INFO;
SINGLETONS.clear();
ARGS = new String[] {};
MANAGED_CLASSES.clear();
MANAGED_INSTANCES.clear();
IOC_INSTANCES.clear();
INJECTABLE_FIELDS.clear();
INJECTION_PROVIDERS.clear();
INTERCEPTORS.clear();
BEAN_PROPERTIES.clear();
}
public static Map<String, Prop> propertiesOf(Class<?> clazz) {
return BEAN_PROPERTIES.get(clazz);
}
@SuppressWarnings("unchecked")
public static Map<String, Prop> propertiesOf(Object obj) {
return obj != null ? propertiesOf(obj.getClass()) : Collections.EMPTY_MAP;
}
private static Map<String, TypeKind> initKinds() {
Map<String, TypeKind> kinds = new HashMap<String, TypeKind>();
kinds.put("boolean", TypeKind.BOOLEAN);
kinds.put("byte", TypeKind.BYTE);
kinds.put("char", TypeKind.CHAR);
kinds.put("short", TypeKind.SHORT);
kinds.put("int", TypeKind.INT);
kinds.put("long", TypeKind.LONG);
kinds.put("float", TypeKind.FLOAT);
kinds.put("double", TypeKind.DOUBLE);
kinds.put("java.lang.String", TypeKind.STRING);
kinds.put("java.lang.Boolean", TypeKind.BOOLEAN_OBJ);
kinds.put("java.lang.Byte", TypeKind.BYTE_OBJ);
kinds.put("java.lang.Character", TypeKind.CHAR_OBJ);
kinds.put("java.lang.Short", TypeKind.SHORT_OBJ);
kinds.put("java.lang.Integer", TypeKind.INT_OBJ);
kinds.put("java.lang.Long", TypeKind.LONG_OBJ);
kinds.put("java.lang.Float", TypeKind.FLOAT_OBJ);
kinds.put("java.lang.Double", TypeKind.DOUBLE_OBJ);
kinds.put("java.util.Date", TypeKind.DATE);
return kinds;
}
/**
* @return Any kind, except NULL
*/
public static TypeKind kindOf(Class<?> type) {
String typeName = type.getName();
TypeKind kind = KINDS.get(typeName);
if (kind == null) {
kind = TypeKind.OBJECT;
}
return kind;
}
/**
* @return Any kind, including NULL
*/
public static TypeKind kindOf(Object value) {
if (value == null) {
return TypeKind.NULL;
}
String typeName = value.getClass().getName();
TypeKind kind = KINDS.get(typeName);
if (kind == null) {
kind = TypeKind.OBJECT;
}
return kind;
}
private static String getCallingClass() {
StackTraceElement[] trace = Thread.currentThread().getStackTrace();
for (int i = 2; i < trace.length; i++) {
String cls = trace[i].getClassName();
if (!cls.equals(CLASS.getCanonicalName())) {
return cls;
}
}
return CLASS.getCanonicalName();
}
private static void log(Appendable out, LogLevel level, String msg, String key1, Object value1, String key2,
Object value2, String key3, Object value3, int paramsN) {
if (level.ordinal() >= LOG_LEVEL.ordinal()) {
try {
synchronized (out) {
out.append(level.name());
out.append(" | ");
out.append(Thread.currentThread().getName());
out.append(" | ");
out.append(getCallingClass());
out.append(" | ");
out.append(msg);
switch (paramsN) {
case 0:
break;
case 1:
printKeyValue(out, key1, value1);
break;
case 2:
printKeyValue(out, key1, value1);
printKeyValue(out, key2, value2);
break;
case 3:
printKeyValue(out, key1, value1);
printKeyValue(out, key2, value2);
printKeyValue(out, key3, value3);
break;
default:
throw notExpected();
}
out.append("\n");
}
} catch (IOException e) {
throw rte(e);
}
}
}
private static void printKeyValue(Appendable out, String key, Object value) throws IOException {
out.append(" | ");
out.append(key);
out.append("=");
out.append(text(value));
if (value instanceof Throwable) {
Throwable err = (Throwable) value;
ByteArrayOutputStream stream = new ByteArrayOutputStream();
err.printStackTrace(new PrintStream(stream));
out.append("\n");
out.append(stream.toString());
}
}
private static void log(LogLevel level, String msg, String key1, Object value1, String key2, Object value2,
String key3, Object value3, int paramsN) {
log(System.out, level, msg, key1, value1, key2, value2, key3, value3, paramsN);
}
public static void trace(String msg) {
log(TRACE, msg, null, null, null, null, null, null, 0);
}
public static void trace(String msg, String key, Object value) {
log(TRACE, msg, key, value, null, null, null, null, 1);
}
public static void trace(String msg, String key1, Object value1, String key2, Object value2) {
log(TRACE, msg, key1, value1, key2, value2, null, null, 2);
}
public static void trace(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(TRACE, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void debug(String msg) {
log(DEBUG, msg, null, null, null, null, null, null, 0);
}
public static void debug(String msg, String key, Object value) {
log(DEBUG, msg, key, value, null, null, null, null, 1);
}
public static void debug(String msg, String key1, Object value1, String key2, Object value2) {
log(DEBUG, msg, key1, value1, key2, value2, null, null, 2);
}
public static void debug(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(DEBUG, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void info(String msg) {
log(INFO, msg, null, null, null, null, null, null, 0);
}
public static void info(String msg, String key, Object value) {
log(INFO, msg, key, value, null, null, null, null, 1);
}
public static void info(String msg, String key1, Object value1, String key2, Object value2) {
log(INFO, msg, key1, value1, key2, value2, null, null, 2);
}
public static void info(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(INFO, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void warn(String msg) {
log(WARN, msg, null, null, null, null, null, null, 0);
}
public static void warn(String msg, String key, Object value) {
log(WARN, msg, key, value, null, null, null, null, 1);
}
public static void warn(String msg, String key1, Object value1, String key2, Object value2) {
log(WARN, msg, key1, value1, key2, value2, null, null, 2);
}
public static void warn(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(WARN, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void warn(String msg, Throwable error) {
warn(msg, "error", error);
}
public static void error(String msg) {
log(ERROR, msg, null, null, null, null, null, null, 0);
}
public static void error(String msg, String key, Object value) {
log(ERROR, msg, key, value, null, null, null, null, 1);
}
public static void error(String msg, String key1, Object value1, String key2, Object value2) {
log(ERROR, msg, key1, value1, key2, value2, null, null, 2);
}
public static void error(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(ERROR, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void error(String msg, Throwable error) {
error(msg, "error", error);
}
public static void severe(String msg) {
log(SEVERE, msg, null, null, null, null, null, null, 0);
}
public static void severe(String msg, String key, Object value) {
log(SEVERE, msg, key, value, null, null, null, null, 1);
}
public static void severe(String msg, String key1, Object value1, String key2, Object value2) {
log(SEVERE, msg, key1, value1, key2, value2, null, null, 2);
}
public static void severe(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(SEVERE, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void severe(String msg, Throwable error) {
severe(msg, "error", error);
}
public static void sleep(long millis) {
try {
Thread.sleep(millis);
} catch (InterruptedException e) {
// do nothing
}
}
public static boolean waitInterruption(long millis) {
try {
Thread.sleep(millis);
return true;
} catch (InterruptedException e) {
Thread.interrupted();
return false;
}
}
public static void waitFor(Object obj) {
try {
synchronized (obj) {
obj.wait();
}
} catch (InterruptedException e) {
// do nothing
}
}
public static void setFieldValue(Object instance, String fieldName, Object value) {
try {
for (Class<?> c = instance.getClass(); c != Object.class; c = c.getSuperclass()) {
try {
Field field = c.getDeclaredField(fieldName);
field.setAccessible(true);
field.set(instance, value);
field.setAccessible(false);
return;
} catch (NoSuchFieldException e) {
// keep searching the filed in the super-class...
}
}
} catch (Exception e) {
throw rte("Cannot set field value!", e);
}
throw rte("Cannot find the field '%s' in the class '%s'", fieldName, instance.getClass());
}
public static void setFieldValue(Field field, Object instance, Object value) {
try {
field.setAccessible(true);
field.set(instance, value);
field.setAccessible(false);
} catch (Exception e) {
throw rte("Cannot set field value!", e);
}
}
public static Object getFieldValue(Object instance, String fieldName) {
try {
for (Class<?> c = instance.getClass(); c != Object.class; c = c.getSuperclass()) {
try {
Field field = c.getDeclaredField(fieldName);
return getFieldValue(field, instance);
} catch (NoSuchFieldException e) {
// keep searching the filed in the super-class...
}
}
} catch (Exception e) {
throw rte("Cannot get field value!", e);
}
throw rte("Cannot find the field '%s' in the class '%s'", fieldName, instance.getClass());
}
public static Object getFieldValue(Field field, Object instance) {
try {
field.setAccessible(true);
Object value = field.get(instance);
field.setAccessible(false);
return value;
} catch (Exception e) {
throw rte("Cannot get field value!", e);
}
}
public static List<Annotation> getAnnotations(Class<?> clazz) {
List<Annotation> allAnnotations = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Annotation[] annotations = c.getDeclaredAnnotations();
for (Annotation an : annotations) {
allAnnotations.add(an);
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return allAnnotations;
}
public static List<Field> getFields(Class<?> clazz) {
List<Field> allFields = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
allFields.add(field);
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return allFields;
}
public static List<Field> getFieldsAnnotated(Class<?> clazz, Class<? extends Annotation> annotation) {
List<Field> annotatedFields = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
if (field.isAnnotationPresent(annotation)) {
annotatedFields.add(field);
}
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return annotatedFields;
}
public static List<Method> getMethodsAnnotated(Class<?> clazz, Class<? extends Annotation> annotation) {
List<Method> annotatedMethods = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Method[] methods = c.getMethods();
for (Method method : methods) {
if (method.isAnnotationPresent(annotation)) {
annotatedMethods.add(method);
}
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return annotatedMethods;
}
public static Method getMethod(Class<?> clazz, String name, Class<?>... parameterTypes) {
try {
return clazz.getMethod(name, parameterTypes);
} catch (NoSuchMethodException e) {
throw rte("Cannot find method: %s", e, name);
} catch (SecurityException e) {
throw rte("Cannot access method: %s", e, name);
}
}
public static Method findMethod(Class<?> clazz, String name, Class<?>... parameterTypes) {
try {
return clazz.getMethod(name, parameterTypes);
} catch (NoSuchMethodException e) {
return null;
} catch (SecurityException e) {
return null;
}
}
@SuppressWarnings("unchecked")
public static <T> T invokeStatic(Method m, Object... args) {
boolean accessible = m.isAccessible();
try {
m.setAccessible(true);
return (T) m.invoke(null, args);
} catch (IllegalAccessException e) {
throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
} catch (IllegalArgumentException e) {
throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
} catch (InvocationTargetException e) {
throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
} finally {
m.setAccessible(accessible);
}
}
@SuppressWarnings("unchecked")
public static <T> T invoke(Method m, Object target, Object... args) {
boolean accessible = m.isAccessible();
try {
m.setAccessible(true);
return (T) m.invoke(target, args);
} catch (Exception e) {
throw rte("Cannot invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
} finally {
m.setAccessible(accessible);
}
}
public static Class<?>[] getImplementedInterfaces(Class<?> clazz) {
try {
List<Class<?>> interfaces = new LinkedList<Class<?>>();
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
for (Class<?> interf : c.getInterfaces()) {
interfaces.add(interf);
}
}
return interfaces.toArray(new Class<?>[interfaces.size()]);
} catch (Exception e) {
throw rte("Cannot retrieve implemented interfaces!", e);
}
}
public static <T> Constructor<T> getConstructor(Class<T> clazz, Class<?>... paramTypes) {
try {
return (Constructor<T>) clazz.getConstructor(paramTypes);
} catch (Exception e) {
throw rte("Cannot find the constructor for %s with param types: %s", e, clazz, Arrays.toString(paramTypes));
}
}
public static boolean annotatedMethod(Object instance, String methodName, Class<Annotation> annotation) {
try {
Method method = instance.getClass().getMethod(methodName);
return method.getAnnotation(annotation) != null;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static String text(Collection<Object> coll) {
StringBuilder sb = new StringBuilder();
sb.append("[");
boolean first = true;
for (Object obj : coll) {
if (!first) {
sb.append(", ");
}
sb.append(text(obj));
first = false;
}
sb.append("]");
return sb.toString();
}
public static String text(Object obj) {
if (obj == null) {
return "null";
} else if (obj instanceof byte[]) {
return Arrays.toString((byte[]) obj);
} else if (obj instanceof short[]) {
return Arrays.toString((short[]) obj);
} else if (obj instanceof int[]) {
return Arrays.toString((int[]) obj);
} else if (obj instanceof long[]) {
return Arrays.toString((long[]) obj);
} else if (obj instanceof float[]) {
return Arrays.toString((float[]) obj);
} else if (obj instanceof double[]) {
return Arrays.toString((double[]) obj);
} else if (obj instanceof boolean[]) {
return Arrays.toString((boolean[]) obj);
} else if (obj instanceof char[]) {
return Arrays.toString((char[]) obj);
} else if (obj instanceof Object[]) {
return text((Object[]) obj);
} else {
return String.valueOf(obj);
}
}
public static String text(Object[] objs) {
StringBuilder sb = new StringBuilder();
sb.append("[");
for (int i = 0; i < objs.length; i++) {
if (i > 0) {
sb.append(", ");
}
sb.append(text(objs[i]));
}
sb.append("]");
return sb.toString();
}
public static String text(Iterator<?> it) {
StringBuilder sb = new StringBuilder();
sb.append("[");
boolean first = true;
while (it.hasNext()) {
if (first) {
sb.append(", ");
first = false;
}
sb.append(text(it.next()));
}
sb.append("]");
return sb.toString();
}
public static String textln(Object[] objs) {
StringBuilder sb = new StringBuilder();
sb.append("[");
for (int i = 0; i < objs.length; i++) {
if (i > 0) {
sb.append(",");
}
sb.append("\n ");
sb.append(text(objs[i]));
}
sb.append("\n]");
return sb.toString();
}
public static String replaceText(String s, String[][] repls) {
for (String[] repl : repls) {
s = s.replaceAll(Pattern.quote(repl[0]), repl[1]);
}
return s;
}
public static String join(String sep, Object... items) {
return render(items, "%s", sep);
}
public static String join(String sep, Iterable<?> items) {
return render(items, "%s", sep);
}
public static String render(Object[] items, String itemFormat, String sep) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < items.length; i++) {
if (i > 0) {
sb.append(sep);
}
sb.append(format(itemFormat, items[i]));
}
return sb.toString();
}
public static String render(Iterable<?> items, String itemFormat, String sep) {
StringBuilder sb = new StringBuilder();
int i = 0;
Iterator<?> it = items.iterator();
while (it.hasNext()) {
Object item = it.next();
if (i > 0) {
sb.append(sep);
}
sb.append(format(itemFormat, item));
i++;
}
return sb.toString();
}
public static URL resource(String filename) {
return CLASS_LOADER.getResource(filename);
}
public static File file(String filename) {
File file = new File(filename);
if (!file.exists()) {
URL res = resource(filename);
if (res != null) {
return new File(res.getFile());
}
}
return file;
}
public static long time() {
return System.currentTimeMillis();
}
public static boolean xor(boolean a, boolean b) {
return a && !b || b && !a;
}
public static boolean eq(Object a, Object b) {
if (a == b) {
return true;
}
if (a == null || b == null) {
return false;
}
return a.equals(b);
}
public static void failIf(boolean failureCondition, String msg) {
if (failureCondition) {
throw rte(msg);
}
}
public static String load(String name) {
InputStream stream = CLASS_LOADER.getResourceAsStream(name);
InputStreamReader reader = new InputStreamReader(stream);
BufferedReader r = new BufferedReader(reader);
StringBuilder sb = new StringBuilder();
String line;
try {
while ((line = r.readLine()) != null) {
sb.append(line);
}
} catch (IOException e) {
throw rte("Cannot read resource: " + name, e);
}
return sb.toString();
}
public static void save(String filename, String content) {
FileOutputStream out = null;
try {
out = new FileOutputStream(filename);
out.write(content.getBytes());
close(out, false);
} catch (Exception e) {
close(out, true);
throw rte(e);
}
}
public static void close(OutputStream out, boolean quiet) {
try {
out.close();
} catch (IOException e) {
if (!quiet) {
throw rte(e);
}
}
}
public static void close(InputStream in, boolean quiet) {
try {
in.close();
} catch (IOException e) {
if (!quiet) {
throw rte(e);
}
}
}
public static void delete(String filename) {
new File(filename).delete();
}
public static <T> T[] expand(T[] arr, int factor) {
int len = arr.length;
arr = Arrays.copyOf(arr, len * factor);
return arr;
}
public static <T> T[] expand(T[] arr, T item) {
int len = arr.length;
arr = Arrays.copyOf(arr, len + 1);
arr[len] = item;
return arr;
}
public static <T> T[] subarray(T[] arr, int from, int to) {
int start = from >= 0 ? from : arr.length + from;
int end = to >= 0 ? to : arr.length + to;
if (start < 0) {
start = 0;
}
if (end > arr.length - 1) {
end = arr.length - 1;
}
must(start <= end, "Invalid range: expected form <= to!");
int size = end - start + 1;
T[] part = Arrays.copyOf(arr, size);
System.arraycopy(arr, start, part, 0, size);
return part;
}
public static <T> T[] array(T... items) {
return items;
}
public static <T> Set<T> set(T... values) {
Set<T> set = new HashSet<T>();
for (T val : values) {
set.add(val);
}
return set;
}
public static <T> List<T> list(T... values) {
List<T> list = new ArrayList<T>();
for (T item : values) {
list.add(item);
}
return list;
}
public static <K, V> Map<K, V> map() {
return new HashMap<K, V>();
}
public static <K, V> Map<K, V> map(K key, V value) {
Map<K, V> map = map();
map.put(key, value);
return map;
}
public static <K, V> Map<K, V> map(K key1, V value1, K key2, V value2) {
Map<K, V> map = map(key1, value1);
map.put(key2, value2);
return map;
}
public static <K, V> Map<K, V> map(K key1, V value1, K key2, V value2, K key3, V value3) {
Map<K, V> map = map(key1, value1, key2, value2);
map.put(key3, value3);
return map;
}
public static <K, V> Map<K, V> map(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4) {
Map<K, V> map = map(key1, value1, key2, value2, key3, value3);
map.put(key4, value4);
return map;
}
@SuppressWarnings("serial")
public static <K, V> Map<K, V> autoExpandingMap(final F1<V, K> valueFactory) {
return new ConcurrentHashMap<K, V>() {
@SuppressWarnings("unchecked")
@Override
public synchronized V get(Object key) {
V val = super.get(key);
if (val == null) {
try {
val = valueFactory.execute((K) key);
} catch (Exception e) {
throw rte(e);
}
put((K) key, val);
}
return val;
}
};
}
public static <K, V> Map<K, V> autoExpandingMap(final Class<V> clazz) {
return autoExpandingMap(new F1<V, K>() {
@Override
public V execute(K param) throws Exception {
return inject(newInstance(clazz));
}
});
}
public static void waitFor(AtomicBoolean done) {
while (!done.get()) {
sleep(5);
}
}
public static void waitFor(AtomicInteger n, int value) {
while (n.get() != value) {
sleep(5);
}
}
public static byte[] serialize(Object value) {
try {
ByteArrayOutputStream output = new ByteArrayOutputStream();
ObjectOutputStream out = new ObjectOutputStream(output);
out.writeObject(value);
output.close();
return output.toByteArray();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static Object deserialize(byte[] buf) {
try {
ObjectInputStream in = new ObjectInputStream(new ByteArrayInputStream(buf));
Object obj = in.readObject();
in.close();
return obj;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static void serialize(Object value, ByteBuffer buf) {
byte[] bytes = serialize(value);
buf.putInt(bytes.length);
buf.put(bytes);
}
public static Object deserialize(ByteBuffer buf) {
int len = buf.getInt();
byte[] bytes = new byte[len];
buf.get(bytes);
return deserialize(bytes);
}
// TODO add such utils for other primitive types, as well
public static void encode(long value, ByteBuffer buf) {
buf.put((byte) TypeKind.LONG.ordinal());
buf.putLong(value);
}
public static void encode(Object value, ByteBuffer buf) {
TypeKind kind = kindOf(value);
int ordinal = kind.ordinal();
assert ordinal < 128;
byte kindCode = (byte) ordinal;
buf.put(kindCode);
switch (kind) {
case NULL:
// nothing else needed
break;
case BOOLEAN:
case BYTE:
case SHORT:
case CHAR:
case INT:
case LONG:
case FLOAT:
case DOUBLE:
throw notExpected();
case STRING:
String str = (String) value;
byte[] bytes = str.getBytes();
// 0-255
int len = bytes.length;
if (len < 255) {
buf.put(bytee(len));
} else {
buf.put(bytee(255));
buf.putInt(len);
}
buf.put(bytes);
break;
case BOOLEAN_OBJ:
boolean val = (Boolean) value;
buf.put((byte) (val ? 1 : 0));
break;
case BYTE_OBJ:
buf.put((Byte) value);
break;
case SHORT_OBJ:
buf.putShort((Short) value);
break;
case CHAR_OBJ:
buf.putChar((Character) value);
break;
case INT_OBJ:
buf.putInt((Integer) value);
break;
case LONG_OBJ:
buf.putLong((Long) value);
break;
case FLOAT_OBJ:
buf.putFloat((Float) value);
break;
case DOUBLE_OBJ:
buf.putDouble((Double) value);
break;
case OBJECT:
serialize(value, buf);
break;
case DATE:
buf.putLong(((Date) value).getTime());
break;
default:
throw notExpected();
}
}
private static byte bytee(int n) {
return (byte) (n - 128);
}
public static long decodeLong(ByteBuffer buf) {
U.must(buf.get() == TypeKind.LONG.ordinal());
return buf.getLong();
}
public static Object decode(ByteBuffer buf) {
byte kindCode = buf.get();
TypeKind kind = TypeKind.values()[kindCode];
switch (kind) {
case NULL:
return null;
case BOOLEAN:
case BOOLEAN_OBJ:
return buf.get() != 0;
case BYTE:
case BYTE_OBJ:
return buf.get();
case SHORT:
case SHORT_OBJ:
return buf.getShort();
case CHAR:
case CHAR_OBJ:
return buf.getChar();
case INT:
case INT_OBJ:
return buf.getInt();
case LONG:
case LONG_OBJ:
return buf.getLong();
case FLOAT:
case FLOAT_OBJ:
return buf.getFloat();
case DOUBLE:
case DOUBLE_OBJ:
return buf.getDouble();
case STRING:
byte len = buf.get();
int realLen = len + 128;
if (realLen == 255) {
realLen = buf.getInt();
}
byte[] sbuf = new byte[realLen];
buf.get(sbuf);
return new String(sbuf);
case OBJECT:
return deserialize(buf);
case DATE:
return new Date(buf.getLong());
default:
throw notExpected();
}
}
public static ByteBuffer expand(ByteBuffer buf, int newSize) {
ByteBuffer buf2 = ByteBuffer.allocate(newSize);
ByteBuffer buff = buf.duplicate();
buff.rewind();
buff.limit(buff.capacity());
buf2.put(buff);
return buf2;
}
public static ByteBuffer expand(ByteBuffer buf) {
int cap = buf.capacity();
if (cap <= 1000) {
cap *= 10;
} else if (cap <= 10000) {
cap *= 5;
} else {
cap *= 2;
}
return expand(buf, cap);
}
public static String buf2str(ByteBuffer buf) {
ByteBuffer buf2 = buf.duplicate();
buf2.rewind();
buf2.limit(buf2.capacity());
byte[] bytes = new byte[buf2.capacity()];
buf2.get(bytes);
return new String(bytes);
}
public static ByteBuffer buf(String s) {
byte[] bytes = s.getBytes();
ByteBuffer buf = ByteBuffer.allocateDirect(bytes.length);
buf.put(bytes);
buf.rewind();
return buf;
}
public static String copyNtimes(String s, int n) {
StringBuffer sb = new StringBuffer();
for (int i = 0; i < n; i++) {
sb.append(s);
}
return sb.toString();
}
public static RuntimeException rte(String message, Object... args) {
return new RuntimeException(format(message, args));
}
public static RuntimeException rte(String message, Throwable cause, Object... args) {
return new RuntimeException(format(message, args), cause);
}
public static RuntimeException rte(String message, Throwable cause) {
return new RuntimeException(message, cause);
}
public static RuntimeException rte(Throwable cause) {
return new RuntimeException(cause);
}
public static RuntimeException rte(String message) {
return cachedRTE(RuntimeException.class, message);
}
public static <T extends RuntimeException> T rte(Class<T> clazz) {
return cachedRTE(clazz, null);
}
public static <T extends RuntimeException> T rte(Class<T> clazz, String msg) {
return cachedRTE(clazz, msg);
}
@SuppressWarnings("unchecked")
private static synchronized <T extends RuntimeException> T cachedRTE(Class<T> clazz, String msg) {
return (T) EXCEPTIONS.get(clazz).get(U.or(msg, ""));
}
public static boolean must(boolean expectedCondition) {
if (!expectedCondition) {
throw rte("Expectation failed!");
}
return true;
}
public static boolean must(boolean expectedCondition, String message) {
if (!expectedCondition) {
throw rte(message);
}
return true;
}
public static boolean must(boolean expectedCondition, String message, long arg) {
if (!expectedCondition) {
throw rte(message, arg);
}
return true;
}
public static boolean must(boolean expectedCondition, String message, Object arg) {
if (!expectedCondition) {
throw rte(message, arg);
}
return true;
}
public static boolean must(boolean expectedCondition, String message, Object arg1, Object arg2) {
if (!expectedCondition) {
throw rte(message, arg1, arg2);
}
return true;
}
public static void notNull(Object... items) {
for (int i = 0; i < items.length; i++) {
if (items[i] == null) {
throw rte("The item[%s] must NOT be null!", i);
}
}
}
public static void notNull(Object value, String desc) {
if (value == null) {
throw rte("%s must NOT be null!", desc);
}
}
public static RuntimeException notReady() {
return rte("Not yet implemented!");
}
public static RuntimeException notSupported() {
return rte("This operation is not supported by this implementation!");
}
public static RuntimeException notExpected() {
return rte("This operation is not expected to be called!");
}
public static String stackTraceOf(Throwable e) {
ByteArrayOutputStream output = new ByteArrayOutputStream();
e.printStackTrace(new PrintStream(output));
return output.toString();
}
public static void benchmark(String name, int count, Runnable runnable) {
long start = Calendar.getInstance().getTimeInMillis();
for (int i = 0; i < count; i++) {
runnable.run();
}
long end = Calendar.getInstance().getTimeInMillis();
long ms = end - start;
if (ms == 0) {
ms = 1;
}
double avg = ((double) count / (double) ms);
String avgs = avg > 1 ? Math.round(avg) + "K" : Math.round(avg * 1000) + "";
String data = format("%s: %s in %s ms (%s/sec)", name, count, ms, avgs);
print(data + " | " + getCpuMemStats());
}
public static void benchmarkMT(int threadsN, final String name, final int count, final Runnable runnable) {
final CountDownLatch latch = new CountDownLatch(threadsN);
for (int i = 1; i <= threadsN; i++) {
new Thread() {
public void run() {
benchmark(name, count, runnable);
latch.countDown();
};
}.start();
}
try {
latch.await();
} catch (InterruptedException e) {
throw U.rte(e);
}
}
public static String getCpuMemStats() {
Runtime rt = Runtime.getRuntime();
long totalMem = rt.totalMemory();
long maxMem = rt.maxMemory();
long freeMem = rt.freeMemory();
long usedMem = totalMem - freeMem;
int megs = 1024 * 1024;
String msg = "MEM [total=%s MB, used=%s MB, max=%s MB]%s";
return format(msg, totalMem / megs, usedMem / megs, maxMem / megs, gcInfo());
}
public static String gcInfo() {
String gcinfo = "";
if (getGarbageCollectorMXBeans != null) {
List<?> gcs = invokeStatic(getGarbageCollectorMXBeans);
for (Object gc : gcs) {
gcinfo += " | " + getPropValue(gc, "name") + " x" + getPropValue(gc, "collectionCount") + ":"
+ getPropValue(gc, "collectionTime") + "ms";
}
}
return gcinfo;
}
@SuppressWarnings("unchecked")
public static <T> T createProxy(InvocationHandler handler, Class<?>... interfaces) {
return ((T) Proxy.newProxyInstance(CLASS_LOADER, interfaces, handler));
}
public static <T> T implementInterfaces(final Object target, final InvocationHandler handler,
Class<?>... interfaces) {
final Class<?> targetClass = target.getClass();
return createProxy(new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
if (method.getDeclaringClass().isAssignableFrom(targetClass)) {
return method.invoke(target, args);
}
return handler.invoke(proxy, method, args);
}
}, interfaces);
}
public static <T> T implementInterfaces(Object target, InvocationHandler handler) {
return implementInterfaces(target, handler, getImplementedInterfaces(target.getClass()));
}
public static <T> T tracer(Object target) {
return implementInterfaces(target, new InvocationHandler() {
@Override
public Object invoke(Object target, Method method, Object[] args) throws Throwable {
trace("intercepting", "method", method.getName(), "args", Arrays.toString(args));
return method.invoke(target, args);
}
});
}
public static void show(Object... values) {
String text = values.length == 1 ? text(values[0]) : text(values);
print(">" + text + "<");
}
public static <T> T newInstance(Class<T> clazz) {
try {
return clazz.newInstance();
} catch (Exception e) {
throw rte(e);
}
}
@SuppressWarnings("unchecked")
public static <T> T newInstance(Class<T> clazz, Object... args) {
for (Constructor<?> constr : clazz.getConstructors()) {
Class<?>[] paramTypes = constr.getParameterTypes();
if (areAssignable(paramTypes, args)) {
try {
return (T) constr.newInstance(args);
} catch (Exception e) {
throw rte(e);
}
}
}
throw rte("Cannot find appropriate constructor!");
}
public static <T> T initNewInstance(Class<T> clazz, Map<String, Object> params) {
return init(newInstance(clazz), params);
}
public static <T> T init(T obj, Map<String, Object> params) {
throw notReady();
}
private static boolean areAssignable(Class<?>[] types, Object[] values) {
if (types.length != values.length) {
return false;
}
for (int i = 0; i < values.length; i++) {
Object val = values[i];
if (val != null && !types[i].isAssignableFrom(val.getClass())) {
return false;
}
}
return true;
}
public static <T> T or(T value, T fallback) {
return value != null ? value : fallback;
}
public static synchronized void schedule(Runnable task, long delay) {
if (EXECUTOR == null) {
EXECUTOR = new ScheduledThreadPoolExecutor(3);
}
EXECUTOR.schedule(task, delay, TimeUnit.MILLISECONDS);
}
public static void startMeasure() {
measureStart = time();
}
public static void endMeasure() {
long delta = time() - measureStart;
show(delta + " ms");
}
public static void print(Object value) {
System.out.println(value);
}
public static void printAll(Collection<?> collection) {
for (Object item : collection) {
print(item);
}
}
public static void args(String... args) {
if (args != null) {
ARGS = args;
}
}
public static boolean hasOption(String name) {
notNull(ARGS, "command line arguments");
for (String op : ARGS) {
if (op.equalsIgnoreCase(name)) {
return true;
}
}
return false;
}
public static String option(String name, String defaultValue) {
notNull(ARGS, "command line arguments");
for (String op : ARGS) {
if (op.startsWith(name + "=")) {
return op.substring(name.length() + 1);
}
}
return defaultValue;
}
public static long option(String name, long defaultValue) {
String n = option(name, null);
return n != null ? Long.parseLong(n) : defaultValue;
}
public static double option(String name, double defaultValue) {
String n = option(name, null);
return n != null ? Double.parseDouble(n) : defaultValue;
}
public static boolean isEmpty(String value) {
return value == null || value.isEmpty();
}
public static void connect(String address, int port, F2<Void, BufferedReader, DataOutputStream> protocol) {
Socket socket = null;
try {
socket = new Socket(address, port);
DataOutputStream out = new DataOutputStream(socket.getOutputStream());
BufferedReader in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
protocol.execute(in, out);
socket.close();
} catch (Exception e) {
throw rte(e);
} finally {
if (socket != null) {
try {
socket.close();
} catch (IOException e) {
throw rte(e);
}
}
}
}
public static void listen(int port, F2<Void, BufferedReader, DataOutputStream> protocol) {
listen(null, port, protocol);
}
public static void listen(String hostname, int port, F2<Void, BufferedReader, DataOutputStream> protocol) {
ServerSocket socket = null;
try {
socket = new ServerSocket();
socket.bind(isEmpty(hostname) ? new InetSocketAddress(port) : new InetSocketAddress(hostname, port));
info("Starting TCP/IP server", "host", hostname, "port", port);
while (true) {
final Socket conn = socket.accept();
BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
DataOutputStream out = new DataOutputStream(conn.getOutputStream());
try {
protocol.execute(in, out);
} catch (Exception e) {
throw rte(e);
} finally {
conn.close();
}
}
} catch (Exception e) {
throw rte(e);
} finally {
if (socket != null) {
try {
socket.close();
} catch (IOException e) {
throw rte(e);
}
}
}
}
public static void microHttpServer(String hostname, int port, final F2<String, String, List<String>> handler) {
listen(hostname, port, new F2<Void, BufferedReader, DataOutputStream>() {
@Override
public Void execute(BufferedReader in, DataOutputStream out) throws Exception {
List<String> lines = new ArrayList<String>();
String line;
while ((line = in.readLine()) != null) {
if (line.isEmpty()) {
break;
}
lines.add(line);
}
if (!lines.isEmpty()) {
String req = lines.get(0);
if (req.startsWith("GET /")) {
int pos = req.indexOf(' ', 4);
String path = urlDecode(req.substring(4, pos));
String response = handler.execute(path, lines);
out.writeBytes(response);
} else {
out.writeBytes("Only GET requests are supported!");
}
} else {
out.writeBytes("Invalid HTTP request!");
}
return null;
}
});
}
public static String capitalized(String s) {
return s.substring(0, 1).toUpperCase() + s.substring(1);
}
public static long getId(Object obj) {
Object id = getPropValue(obj, "id");
if (id == null) {
throw rte("The field 'id' cannot be null!");
}
if (id instanceof Long) {
Long num = (Long) id;
return num;
} else {
throw rte("The field 'id' must have type 'long', but it has: " + id.getClass());
}
}
public static long[] getIds(Object... objs) {
long[] ids = new long[objs.length];
for (int i = 0; i < objs.length; i++) {
ids[i] = getId(objs[i]);
}
return ids;
}
public static String replace(String s, String regex, F1<String, String[]> replacer) {
StringBuffer output = new StringBuffer();
Pattern p = Pattern.compile(regex);
Matcher matcher = p.matcher(s);
while (matcher.find()) {
int len = matcher.groupCount() + 1;
String[] gr = new String[len];
for (int i = 0; i < gr.length; i++) {
gr[i] = matcher.group(i);
}
try {
String rep = replacer.execute(gr);
matcher.appendReplacement(output, rep);
} catch (Exception e) {
throw rte("Cannot replace text!", e);
}
}
matcher.appendTail(output);
return output.toString();
}
public static synchronized void manage(Object... classesOrInstances) {
List<Class<?>> autocreate = new ArrayList<Class<?>>();
for (Object classOrInstance : classesOrInstances) {
boolean isClass = isClass(classOrInstance);
Class<?> clazz = isClass ? (Class<?>) classOrInstance : classOrInstance.getClass();
for (Class<?> interfacee : getImplementedInterfaces(clazz)) {
addInjectionProvider(interfacee, classOrInstance);
}
if (isClass) {
debug("configuring managed class", "class", classOrInstance);
MANAGED_CLASSES.add(clazz);
if (!clazz.isInterface() && !clazz.isEnum() && !clazz.isAnnotation()) {
System.out.println(":" + clazz);
// if the class is annotated, auto-create an instance
if (clazz.getAnnotation(Autocreate.class) != null) {
autocreate.add(clazz);
}
}
} else {
debug("configuring managed instance", "instance", classOrInstance);
addInjectionProvider(clazz, classOrInstance);
MANAGED_INSTANCES.add(classOrInstance);
}
}
for (Class<?> clazz : autocreate) {
inject(clazz);
}
}
private static void addInjectionProvider(Class<?> type, Object provider) {
Set<Object> providers = INJECTION_PROVIDERS.get(type);
if (providers == null) {
providers = set();
INJECTION_PROVIDERS.put(type, providers);
}
providers.add(provider);
}
public static synchronized <T> T inject(Class<T> type) {
info("Inject", "type", type);
return provideIoCInstanceOf(type, null);
}
public static synchronized <T> T inject(T target) {
info("Inject", "target", target);
return ioc(target);
}
private static <T> T provideIoCInstanceOf(Class<T> type, String name) {
T instance = null;
if (name != null) {
instance = provideInstanceByName(type, name);
}
if (instance == null) {
instance = provideIoCInstanceByType(type);
}
if (instance == null) {
instance = provideNewIoCInstanceOf(type);
}
if (instance == null) {
if (name != null) {
throw rte("Couldn't provide a value for type '%s' and name '%s'!", type, name);
} else {
throw rte("Couldn't provide a value for type '%s'!", type);
}
}
return ioc(instance);
}
@SuppressWarnings("unchecked")
private static <T> T provideNewIoCInstanceOf(Class<T> type) {
// instantiation if it's real class
if (!type.isInterface() && !type.isEnum() && !type.isAnnotation()) {
T instance = (T) SINGLETONS.get(type);
if (instance == null) {
instance = ioc(newInstance(type));
}
return instance;
} else {
return null;
}
}
private static <T> T provideIoCInstanceByType(Class<T> type) {
Set<Object> providers = INJECTION_PROVIDERS.get(type);
if (providers != null && !providers.isEmpty()) {
Object provider = null;
for (Object pr : providers) {
if (provider == null) {
provider = pr;
} else {
if (isClass(provider) && !isClass(pr)) {
provider = pr;
} else if (isClass(provider) || !isClass(pr)) {
throw rte("Found more than 1 injection candidates for type '%s': %s", type, providers);
}
}
}
if (provider != null) {
return provideFrom(provider);
}
}
return null;
}
@SuppressWarnings("unchecked")
private static <T> T provideFrom(Object classOrInstance) {
T instance;
if (isClass(classOrInstance)) {
instance = provideNewIoCInstanceOf((Class<T>) classOrInstance);
} else {
instance = (T) classOrInstance;
}
return instance;
}
private static boolean isClass(Object obj) {
return obj instanceof Class;
}
@SuppressWarnings("unchecked")
private static <T> T provideInstanceByName(Class<T> type, String name) {
Object instance = null;
if (type.equals(Boolean.class) || type.equals(boolean.class)) {
instance = hasOption(name);
} else {
String opt = option(name, null);
if (opt != null) {
instance = convert(opt, type);
}
}
return (T) instance;
}
private static void autowire(Object target) {
debug("Autowiring", "target", target);
for (Field field : INJECTABLE_FIELDS.get(target.getClass())) {
Object value = provideIoCInstanceOf(field.getType(), field.getName());
debug("Injecting field value", "target", target, "field", field.getName(), "value", value);
setFieldValue(target, field.getName(), value);
}
}
private static <T> void invokePostConstruct(T target) {
List<Method> methods = getMethodsAnnotated(target.getClass(), Init.class);
for (Method method : methods) {
invoke(method, target);
}
}
private static <T> T ioc(T target) {
if (!isIocProcessed(target)) {
IOC_INSTANCES.put(target, null);
manage(target);
autowire(target);
invokePostConstruct(target);
T proxy = proxyWrap(target);
IOC_INSTANCES.put(target, proxy);
manage(proxy);
target = proxy;
}
return target;
}
private static boolean isIocProcessed(Object target) {
for (Entry<Object, Object> e : IOC_INSTANCES.entrySet()) {
if (e.getKey() == target || e.getValue() == target) {
return true;
}
}
return false;
}
@SuppressWarnings("unchecked")
private static <T> T proxyWrap(T instance) {
Set<F3<Object, Object, Method, Object[]>> done = set();
for (Class<?> interf : getImplementedInterfaces(instance.getClass())) {
final List<F3<Object, Object, Method, Object[]>> interceptors = INTERCEPTORS.get(interf);
if (interceptors != null) {
for (final F3<Object, Object, Method, Object[]> interceptor : interceptors) {
if (interceptor != null && !done.contains(interceptor)) {
debug("Creating proxy", "target", instance, "interface", interf, "interceptor", interceptor);
final T target = instance;
InvocationHandler handler = new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
return interceptor.execute(target, method, args);
}
};
instance = implementInterfaces(instance, handler, interf);
done.add(interceptor);
}
}
}
}
return instance;
}
@SuppressWarnings("unchecked")
public static <T> T convert(String value, Class<T> toType) {
TypeKind targetKind = kindOf(toType);
switch (targetKind) {
case NULL:
throw notExpected();
case BOOLEAN:
case BOOLEAN_OBJ:
if ("y".equalsIgnoreCase(value) || "t".equalsIgnoreCase(value) || "yes".equalsIgnoreCase(value)
|| "true".equalsIgnoreCase(value)) {
return (T) Boolean.TRUE;
}
if ("n".equalsIgnoreCase(value) || "f".equalsIgnoreCase(value) || "no".equalsIgnoreCase(value)
|| "false".equalsIgnoreCase(value)) {
return (T) Boolean.FALSE;
}
throw rte("Cannot convert the string value '%s' to boolean!", value);
case BYTE:
case BYTE_OBJ:
return (T) new Byte(value);
case SHORT:
case SHORT_OBJ:
return (T) new Short(value);
case CHAR:
case CHAR_OBJ:
return (T) new Character(value.charAt(0));
case INT:
case INT_OBJ:
return (T) new Integer(value);
case LONG:
case LONG_OBJ:
return (T) new Long(value);
case FLOAT:
case FLOAT_OBJ:
return (T) new Float(value);
case DOUBLE:
case DOUBLE_OBJ:
return (T) new Double(value);
case STRING:
return (T) value;
case OBJECT:
throw rte("Cannot convert string value to type '%s'!", toType);
case DATE:
return (T) date(value);
default:
throw notExpected();
}
}
private static Enumeration<URL> resources(String name) {
name = name.replace('.', '/');
if (name.equals("*")) {
name = "";
}
try {
return Thread.currentThread().getContextClassLoader().getResources(name);
} catch (IOException e) {
throw rte("Cannot scan: " + name, e);
}
}
public static List<Class<?>> classpathClasses(String packageName, String nameRegex, Predicate<Class<?>> filter) {
Pattern regex = Pattern.compile(nameRegex);
ArrayList<Class<?>> classes = new ArrayList<Class<?>>();
Enumeration<URL> urls = resources(packageName);
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
File file = new File(url.getFile());
getClasses(classes, file, file, regex, filter);
}
return classes;
}
public static List<File> classpath(String packageName, Predicate<File> filter) {
ArrayList<File> files = new ArrayList<File>();
classpath(packageName, files, filter);
return files;
}
public static void classpath(String packageName, Collection<File> files, Predicate<File> filter) {
Enumeration<URL> urls = resources(packageName);
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
File file = new File(url.getFile());
getFiles(files, file, filter);
}
}
private static void getFiles(Collection<File> files, File file, Predicate<File> filter) {
if (file.isDirectory()) {
debug("scanning directory", "dir", file);
for (File f : file.listFiles()) {
if (f.isDirectory()) {
getFiles(files, f, filter);
} else {
debug("scanned file", "file", f);
try {
if (filter == null || filter.eval(f)) {
files.add(f);
}
} catch (Exception e) {
throw rte(e);
}
}
}
}
}
private static void getClasses(Collection<Class<?>> classes, File root, File parent, Pattern nameRegex,
Predicate<Class<?>> filter) {
if (parent.isDirectory()) {
debug("scanning directory", "dir", parent);
for (File f : parent.listFiles()) {
if (f.isDirectory()) {
getClasses(classes, root, f, nameRegex, filter);
} else {
debug("scanned file", "file", f);
try {
if (f.getName().endsWith(".class")) {
String clsName = f.getAbsolutePath();
String rootPath = root.getAbsolutePath();
U.must(clsName.startsWith(rootPath));
clsName = clsName.substring(rootPath.length() + 1, clsName.length() - 6);
clsName = clsName.replace(File.separatorChar, '.');
if (nameRegex.matcher(clsName).matches()) {
Class<?> cls = Class.forName(clsName);
if (filter == null || filter.eval(cls)) {
classes.add(cls);
}
}
}
} catch (Exception e) {
throw rte(e);
}
}
}
}
}
public static String urlDecode(String value) {
try {
return URLDecoder.decode(value, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw U.rte(e);
}
}
public static Object getPropValue(Object instance, String propertyName) {
String propertyNameCap = capitalized(propertyName);
try {
for (Class<?> c = instance.getClass(); c != Object.class; c = c.getSuperclass()) {
try {
return invoke(c.getDeclaredMethod(propertyName), instance);
} catch (NoSuchMethodException e) {
try {
return invoke(c.getDeclaredMethod("get" + propertyNameCap), instance);
} catch (NoSuchMethodException e2) {
try {
return invoke(c.getDeclaredMethod("is" + propertyNameCap), instance);
} catch (NoSuchMethodException e3) {
try {
return getFieldValue(c.getDeclaredField(propertyName), instance);
} catch (NoSuchFieldException e4) {
// keep searching in the super-class...
}
}
}
}
}
} catch (Exception e) {
throw rte("Cannot get property value!", e);
}
throw rte("Cannot find the property '%s' in the class '%s'", propertyName, instance.getClass());
}
public static String mul(String s, int n) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < n; i++) {
sb.append(s);
}
return sb.toString();
}
public static Date date(String value) {
String[] parts = value.split("(\\.|-|/)");
int a = parts.length > 0 ? num(parts[0]) : -1;
int b = parts.length > 1 ? num(parts[1]) : -1;
int c = parts.length > 2 ? num(parts[2]) : -1;
switch (parts.length) {
case 3:
if (isDay(a) && isMonth(b) && isYear(c)) {
return date(a, b, c);
} else if (isYear(a) && isMonth(b) && isDay(c)) {
return date(c, b, a);
}
break;
case 2:
if (isDay(a) && isMonth(b)) {
return date(a, b, thisYear());
}
break;
default:
}
throw rte("Invalid date: " + value);
}
private static boolean isDay(int day) {
return day >= 1 && day <= 31;
}
private static boolean isMonth(int month) {
return month >= 1 && month <= 12;
}
private static boolean isYear(int year) {
return year >= 1000;
}
public static int num(String s) {
return Integer.parseInt(s);
}
public static synchronized Date date(int day, int month, int year) {
CALENDAR.set(year, month - 1, day - 1);
return CALENDAR.getTime();
}
public static synchronized int thisYear() {
CALENDAR.setTime(new Date());
return CALENDAR.get(Calendar.YEAR);
}
public static short bytesToShort(String s) {
ByteBuffer buf = buf(s);
must(buf.limit() == 2);
return buf.getShort();
}
public static int bytesToInt(String s) {
ByteBuffer buf = buf(s);
must(buf.limit() == 4);
return buf.getInt();
}
public static long bytesToLong(String s) {
ByteBuffer buf = buf(s);
must(buf.limit() == 8);
return buf.getLong();
}
public static int intFrom(byte a, byte b, byte c, byte d) {
return (a << 24) + (b << 16) + (c << 8) + d;
}
public static short shortFrom(byte a, byte b) {
return (short) ((a << 8) + b);
}
public static String format(String s, Object... args) {
return String.format(s, args);
}
public static String bytesToString(byte[] bytes) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < bytes.length; i++) {
sb.append(Integer.toString((bytes[i] & 0xff) + 0x100, 16).substring(1));
}
return sb.toString();
}
private static MessageDigest digest(String algorithm) {
try {
return MessageDigest.getInstance(algorithm);
} catch (NoSuchAlgorithmException e) {
throw rte("Cannot find algorithm: " + algorithm);
}
}
public static String md5(byte[] bytes) {
MessageDigest md5 = digest("MD5");
md5.update(bytes);
return bytesToString(md5.digest());
}
public static String md5(String data) {
return md5(data.getBytes());
}
public static char rndChar() {
return (char) (65 + rnd(26));
}
public static String rndStr(int length) {
return rndStr(length, length);
}
public static String rndStr(int minLength, int maxLength) {
int len = minLength + rnd(maxLength - minLength + 1);
StringBuffer sb = new StringBuffer();
for (int i = 0; i < len; i++) {
sb.append(rndChar());
}
return sb.toString();
}
public static int rnd(int n) {
return RND.nextInt(n);
}
public static int rndExcept(int n, int except) {
if (n > 1 || except != 0) {
while (true) {
int num = RND.nextInt(n);
if (num != except) {
return num;
}
}
} else {
throw new RuntimeException("Cannot produce such number!");
}
}
public static <T> T rnd(T[] arr) {
return arr[rnd(arr.length)];
}
public static int rnd() {
return RND.nextInt();
}
public static long rndL() {
return RND.nextLong();
}
@SuppressWarnings("resource")
public static MappedByteBuffer mmap(String filename, MapMode mode, long position, long size) {
try {
File file = new File(filename);
FileChannel fc = new RandomAccessFile(file, "rw").getChannel();
return fc.map(mode, position, size);
} catch (Exception e) {
throw U.rte(e);
}
}
public static MappedByteBuffer mmap(String filename, MapMode mode) {
File file = new File(filename);
U.must(file.exists());
return mmap(filename, mode, 0, file.length());
}
public static Class<?> getClassIfExists(String className) {
try {
return Class.forName(className);
} catch (ClassNotFoundException e) {
return null;
}
}
}
| rapidoid-u/src/main/java/org/rapidoid/util/U.java | package org.rapidoid.util;
/*
* #%L
* rapidoid-u
* %%
* Copyright (C) 2014 Nikolche Mihajlovski
* %%
* 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 java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.RandomAccessFile;
import java.io.UnsupportedEncodingException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.URL;
import java.net.URLDecoder;
import java.nio.ByteBuffer;
import java.nio.MappedByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.FileChannel.MapMode;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
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.TimeZone;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class U implements Constants {
public static final LogLevel TRACE = LogLevel.TRACE;
public static final LogLevel DEBUG = LogLevel.DEBUG;
public static final LogLevel INFO = LogLevel.INFO;
public static final LogLevel WARN = LogLevel.WARN;
public static final LogLevel ERROR = LogLevel.ERROR;
public static final LogLevel SEVERE = LogLevel.SEVERE;
private static LogLevel LOG_LEVEL = INFO;
private static final Map<Class<?>, Object> SINGLETONS = map();
protected static final Random RND = new Random();
private static final Map<Class<?>, Map<String, ? extends RuntimeException>> EXCEPTIONS = autoExpandingMap(new F1<Map<String, ? extends RuntimeException>, Class<?>>() {
@Override
public Map<String, ? extends RuntimeException> execute(final Class<?> clazz) throws Exception {
return autoExpandingMap(new F1<RuntimeException, String>() {
@Override
public RuntimeException execute(String msg) throws Exception {
return (RuntimeException) (msg.isEmpty() ? newInstance(clazz) : newInstance(clazz, msg));
}
});
}
});
private static final Method getGarbageCollectorMXBeans;
static {
Class<?> manFactory = U.getClassIfExists("java.lang.management.ManagementFactory");
getGarbageCollectorMXBeans = manFactory != null ? U.getMethod(manFactory, "getGarbageCollectorMXBeans") : null;
}
private static ScheduledThreadPoolExecutor EXECUTOR;
private static long measureStart;
private static String[] ARGS = {};
private static final Class<U> CLASS = U.class;
public static final ClassLoader CLASS_LOADER = CLASS.getClassLoader();
private static final Set<Class<?>> MANAGED_CLASSES = set();
private static final Set<Object> MANAGED_INSTANCES = set();
private static final Map<Object, Object> IOC_INSTANCES = map();
private static final Map<Class<?>, List<Field>> INJECTABLE_FIELDS = autoExpandingMap(new F1<List<Field>, Class<?>>() {
@Override
public List<Field> execute(Class<?> clazz) throws Exception {
List<Field> fields = getFieldsAnnotated(clazz, Inject.class);
debug("Retrieved injectable fields", "class", clazz, "fields", fields);
return fields;
}
});
private static final Calendar CALENDAR = Calendar.getInstance();
private static final Map<Class<?>, Set<Object>> INJECTION_PROVIDERS = map();
private static final Map<String, TypeKind> KINDS = initKinds();
/* RFC 1123 date-time format, e.g. Sun, 07 Sep 2014 00:17:29 GMT */
private static final DateFormat DATE_FORMAT = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
private static final Date CURR_DATE = new Date();
private static byte[] CURR_DATE_BYTES;
private static long updateCurrDateAfter = 0;
static {
DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("GMT"));
}
private U() {
}
public static byte[] getDateTimeBytes() {
long time = System.currentTimeMillis();
// avoid synchronization for better performance
if (time > updateCurrDateAfter) {
CURR_DATE.setTime(time);
CURR_DATE_BYTES = DATE_FORMAT.format(CURR_DATE).getBytes();
updateCurrDateAfter = time + 1000;
}
return CURR_DATE_BYTES;
}
private static final Map<Class<?>, List<F3<Object, Object, Method, Object[]>>> INTERCEPTORS = map();
private static final Map<Class<?>, Map<String, Prop>> BEAN_PROPERTIES = autoExpandingMap(new F1<Map<String, Prop>, Class<?>>() {
@Override
public Map<String, Prop> execute(Class<?> clazz) throws Exception {
Map<String, Prop> properties = map();
try {
for (Class<?> c = clazz; c != Object.class && c != null; c = c.getSuperclass()) {
Method[] methods = c.getDeclaredMethods();
for (Method method : methods) {
int modif = method.getModifiers();
if ((modif & Modifier.PUBLIC) > 0 && (modif & Modifier.STATIC) == 0
&& (modif & Modifier.ABSTRACT) == 0) {
String name = method.getName();
if (name.matches("^(get|set|is)[A-Z].*")) {
String fieldName;
if (name.startsWith("is")) {
fieldName = name.substring(2, 3).toLowerCase() + name.substring(3);
} else {
fieldName = name.substring(3, 4).toLowerCase() + name.substring(4);
}
Prop propInfo = properties.get(fieldName);
if (propInfo == null) {
propInfo = new Prop();
propInfo.setName(fieldName);
properties.put(fieldName, propInfo);
}
if (name.startsWith("set")) {
propInfo.setSetter(method);
} else {
propInfo.setGetter(method);
}
}
}
}
for (Iterator<Entry<String, Prop>> it = properties.entrySet().iterator(); it.hasNext();) {
Entry<String, Prop> entry = (Entry<String, Prop>) it.next();
Prop minfo = entry.getValue();
if (minfo.getGetter() == null || minfo.getSetter() == null) {
it.remove();
}
}
}
for (Class<?> c = clazz; c != Object.class && c != null; c = c.getSuperclass()) {
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
int modif = field.getModifiers();
if ((modif & Modifier.PUBLIC) > 0 && (modif & Modifier.FINAL) == 0
&& (modif & Modifier.STATIC) == 0) {
String fieldName = field.getName();
Prop propInfo = properties.get(fieldName);
if (propInfo == null) {
propInfo = new Prop();
propInfo.setName(fieldName);
properties.put(fieldName, propInfo);
propInfo.setField(field);
}
}
}
}
} catch (Exception e) {
throw U.rte(e);
}
return properties;
}
});
public static synchronized void setLogLevel(LogLevel logLevel) {
LOG_LEVEL = logLevel;
}
public static synchronized void reset() {
info("Reset U state");
LOG_LEVEL = INFO;
SINGLETONS.clear();
ARGS = new String[] {};
MANAGED_CLASSES.clear();
MANAGED_INSTANCES.clear();
IOC_INSTANCES.clear();
INJECTABLE_FIELDS.clear();
INJECTION_PROVIDERS.clear();
INTERCEPTORS.clear();
BEAN_PROPERTIES.clear();
}
public static Map<String, Prop> propertiesOf(Class<?> clazz) {
return BEAN_PROPERTIES.get(clazz);
}
@SuppressWarnings("unchecked")
public static Map<String, Prop> propertiesOf(Object obj) {
return obj != null ? propertiesOf(obj.getClass()) : Collections.EMPTY_MAP;
}
private static Map<String, TypeKind> initKinds() {
Map<String, TypeKind> kinds = new HashMap<String, TypeKind>();
kinds.put("boolean", TypeKind.BOOLEAN);
kinds.put("byte", TypeKind.BYTE);
kinds.put("char", TypeKind.CHAR);
kinds.put("short", TypeKind.SHORT);
kinds.put("int", TypeKind.INT);
kinds.put("long", TypeKind.LONG);
kinds.put("float", TypeKind.FLOAT);
kinds.put("double", TypeKind.DOUBLE);
kinds.put("java.lang.String", TypeKind.STRING);
kinds.put("java.lang.Boolean", TypeKind.BOOLEAN_OBJ);
kinds.put("java.lang.Byte", TypeKind.BYTE_OBJ);
kinds.put("java.lang.Character", TypeKind.CHAR_OBJ);
kinds.put("java.lang.Short", TypeKind.SHORT_OBJ);
kinds.put("java.lang.Integer", TypeKind.INT_OBJ);
kinds.put("java.lang.Long", TypeKind.LONG_OBJ);
kinds.put("java.lang.Float", TypeKind.FLOAT_OBJ);
kinds.put("java.lang.Double", TypeKind.DOUBLE_OBJ);
kinds.put("java.util.Date", TypeKind.DATE);
return kinds;
}
/**
* @return Any kind, except NULL
*/
public static TypeKind kindOf(Class<?> type) {
String typeName = type.getName();
TypeKind kind = KINDS.get(typeName);
if (kind == null) {
kind = TypeKind.OBJECT;
}
return kind;
}
/**
* @return Any kind, including NULL
*/
public static TypeKind kindOf(Object value) {
if (value == null) {
return TypeKind.NULL;
}
String typeName = value.getClass().getName();
TypeKind kind = KINDS.get(typeName);
if (kind == null) {
kind = TypeKind.OBJECT;
}
return kind;
}
private static String getCallingClass() {
StackTraceElement[] trace = Thread.currentThread().getStackTrace();
for (int i = 2; i < trace.length; i++) {
String cls = trace[i].getClassName();
if (!cls.equals(CLASS.getCanonicalName())) {
return cls;
}
}
return CLASS.getCanonicalName();
}
private static void log(Appendable out, LogLevel level, String msg, String key1, Object value1, String key2,
Object value2, String key3, Object value3, int paramsN) {
if (level.ordinal() >= LOG_LEVEL.ordinal()) {
try {
synchronized (out) {
out.append(level.name());
out.append(" | ");
out.append(Thread.currentThread().getName());
out.append(" | ");
out.append(getCallingClass());
out.append(" | ");
out.append(msg);
switch (paramsN) {
case 0:
break;
case 1:
printKeyValue(out, key1, value1);
break;
case 2:
printKeyValue(out, key1, value1);
printKeyValue(out, key2, value2);
break;
case 3:
printKeyValue(out, key1, value1);
printKeyValue(out, key2, value2);
printKeyValue(out, key3, value3);
break;
default:
throw notExpected();
}
out.append("\n");
}
} catch (IOException e) {
throw rte(e);
}
}
}
private static void printKeyValue(Appendable out, String key, Object value) throws IOException {
out.append(" | ");
out.append(key);
out.append("=");
out.append(text(value));
if (value instanceof Throwable) {
Throwable err = (Throwable) value;
ByteArrayOutputStream stream = new ByteArrayOutputStream();
err.printStackTrace(new PrintStream(stream));
out.append("\n");
out.append(stream.toString());
}
}
private static void log(LogLevel level, String msg, String key1, Object value1, String key2, Object value2,
String key3, Object value3, int paramsN) {
log(System.out, level, msg, key1, value1, key2, value2, key3, value3, paramsN);
}
public static void trace(String msg) {
log(TRACE, msg, null, null, null, null, null, null, 0);
}
public static void trace(String msg, String key, Object value) {
log(TRACE, msg, key, value, null, null, null, null, 1);
}
public static void trace(String msg, String key1, Object value1, String key2, Object value2) {
log(TRACE, msg, key1, value1, key2, value2, null, null, 2);
}
public static void trace(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(TRACE, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void debug(String msg) {
log(DEBUG, msg, null, null, null, null, null, null, 0);
}
public static void debug(String msg, String key, Object value) {
log(DEBUG, msg, key, value, null, null, null, null, 1);
}
public static void debug(String msg, String key1, Object value1, String key2, Object value2) {
log(DEBUG, msg, key1, value1, key2, value2, null, null, 2);
}
public static void debug(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(DEBUG, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void info(String msg) {
log(INFO, msg, null, null, null, null, null, null, 0);
}
public static void info(String msg, String key, Object value) {
log(INFO, msg, key, value, null, null, null, null, 1);
}
public static void info(String msg, String key1, Object value1, String key2, Object value2) {
log(INFO, msg, key1, value1, key2, value2, null, null, 2);
}
public static void info(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(INFO, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void warn(String msg) {
log(WARN, msg, null, null, null, null, null, null, 0);
}
public static void warn(String msg, String key, Object value) {
log(WARN, msg, key, value, null, null, null, null, 1);
}
public static void warn(String msg, String key1, Object value1, String key2, Object value2) {
log(WARN, msg, key1, value1, key2, value2, null, null, 2);
}
public static void warn(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(WARN, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void warn(String msg, Throwable error) {
warn(msg, "error", error);
}
public static void error(String msg) {
log(ERROR, msg, null, null, null, null, null, null, 0);
}
public static void error(String msg, String key, Object value) {
log(ERROR, msg, key, value, null, null, null, null, 1);
}
public static void error(String msg, String key1, Object value1, String key2, Object value2) {
log(ERROR, msg, key1, value1, key2, value2, null, null, 2);
}
public static void error(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(ERROR, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void error(String msg, Throwable error) {
error(msg, "error", error);
}
public static void severe(String msg) {
log(SEVERE, msg, null, null, null, null, null, null, 0);
}
public static void severe(String msg, String key, Object value) {
log(SEVERE, msg, key, value, null, null, null, null, 1);
}
public static void severe(String msg, String key1, Object value1, String key2, Object value2) {
log(SEVERE, msg, key1, value1, key2, value2, null, null, 2);
}
public static void severe(String msg, String key1, Object value1, String key2, Object value2, String key3,
Object value3) {
log(SEVERE, msg, key1, value1, key2, value2, key3, value3, 3);
}
public static void severe(String msg, Throwable error) {
severe(msg, "error", error);
}
public static void sleep(long millis) {
try {
Thread.sleep(millis);
} catch (InterruptedException e) {
// do nothing
}
}
public static boolean waitInterruption(long millis) {
try {
Thread.sleep(millis);
return true;
} catch (InterruptedException e) {
Thread.interrupted();
return false;
}
}
public static void waitFor(Object obj) {
try {
synchronized (obj) {
obj.wait();
}
} catch (InterruptedException e) {
// do nothing
}
}
public static void setFieldValue(Object instance, String fieldName, Object value) {
try {
for (Class<?> c = instance.getClass(); c != Object.class; c = c.getSuperclass()) {
try {
Field field = c.getDeclaredField(fieldName);
field.setAccessible(true);
field.set(instance, value);
field.setAccessible(false);
return;
} catch (NoSuchFieldException e) {
// keep searching the filed in the super-class...
}
}
} catch (Exception e) {
throw rte("Cannot set field value!", e);
}
throw rte("Cannot find the field '%s' in the class '%s'", fieldName, instance.getClass());
}
public static void setFieldValue(Field field, Object instance, Object value) {
try {
field.setAccessible(true);
field.set(instance, value);
field.setAccessible(false);
} catch (Exception e) {
throw rte("Cannot set field value!", e);
}
}
public static Object getFieldValue(Object instance, String fieldName) {
try {
for (Class<?> c = instance.getClass(); c != Object.class; c = c.getSuperclass()) {
try {
Field field = c.getDeclaredField(fieldName);
return getFieldValue(field, instance);
} catch (NoSuchFieldException e) {
// keep searching the filed in the super-class...
}
}
} catch (Exception e) {
throw rte("Cannot get field value!", e);
}
throw rte("Cannot find the field '%s' in the class '%s'", fieldName, instance.getClass());
}
public static Object getFieldValue(Field field, Object instance) {
try {
field.setAccessible(true);
Object value = field.get(instance);
field.setAccessible(false);
return value;
} catch (Exception e) {
throw rte("Cannot get field value!", e);
}
}
public static List<Annotation> getAnnotations(Class<?> clazz) {
List<Annotation> allAnnotations = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Annotation[] annotations = c.getDeclaredAnnotations();
for (Annotation an : annotations) {
allAnnotations.add(an);
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return allAnnotations;
}
public static List<Field> getFields(Class<?> clazz) {
List<Field> allFields = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
allFields.add(field);
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return allFields;
}
public static List<Field> getFieldsAnnotated(Class<?> clazz, Class<? extends Annotation> annotation) {
List<Field> annotatedFields = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
if (field.isAnnotationPresent(annotation)) {
annotatedFields.add(field);
}
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return annotatedFields;
}
public static List<Method> getMethodsAnnotated(Class<?> clazz, Class<? extends Annotation> annotation) {
List<Method> annotatedMethods = list();
try {
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
Method[] methods = c.getMethods();
for (Method method : methods) {
if (method.isAnnotationPresent(annotation)) {
annotatedMethods.add(method);
}
}
}
} catch (Exception e) {
throw rte("Cannot instantiate class!", e);
}
return annotatedMethods;
}
public static Method getMethod(Class<?> clazz, String name, Class<?>... parameterTypes) {
try {
return clazz.getMethod(name, parameterTypes);
} catch (NoSuchMethodException e) {
throw rte("Cannot find method: %s", e, name);
} catch (SecurityException e) {
throw rte("Cannot access method: %s", e, name);
}
}
public static Method findMethod(Class<?> clazz, String name, Class<?>... parameterTypes) {
try {
return clazz.getMethod(name, parameterTypes);
} catch (NoSuchMethodException e) {
return null;
} catch (SecurityException e) {
return null;
}
}
@SuppressWarnings("unchecked")
public static <T> T invokeStatic(Method m, Object... args) {
try {
return (T) m.invoke(null, args);
} catch (IllegalAccessException e) {
throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
} catch (IllegalArgumentException e) {
throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
} catch (InvocationTargetException e) {
throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
}
}
@SuppressWarnings("unchecked")
public static <T> T invoke(Method m, Object target, Object... args) {
try {
return (T) m.invoke(target, args);
} catch (Exception e) {
throw rte("Cannot invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
}
}
public static Class<?>[] getImplementedInterfaces(Class<?> clazz) {
try {
List<Class<?>> interfaces = new LinkedList<Class<?>>();
for (Class<?> c = clazz; c != Object.class; c = c.getSuperclass()) {
for (Class<?> interf : c.getInterfaces()) {
interfaces.add(interf);
}
}
return interfaces.toArray(new Class<?>[interfaces.size()]);
} catch (Exception e) {
throw rte("Cannot retrieve implemented interfaces!", e);
}
}
public static <T> Constructor<T> getConstructor(Class<T> clazz, Class<?>... paramTypes) {
try {
return (Constructor<T>) clazz.getConstructor(paramTypes);
} catch (Exception e) {
throw rte("Cannot find the constructor for %s with param types: %s", e, clazz, Arrays.toString(paramTypes));
}
}
public static boolean annotatedMethod(Object instance, String methodName, Class<Annotation> annotation) {
try {
Method method = instance.getClass().getMethod(methodName);
return method.getAnnotation(annotation) != null;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static String text(Collection<Object> coll) {
StringBuilder sb = new StringBuilder();
sb.append("[");
boolean first = true;
for (Object obj : coll) {
if (!first) {
sb.append(", ");
}
sb.append(text(obj));
first = false;
}
sb.append("]");
return sb.toString();
}
public static String text(Object obj) {
if (obj == null) {
return "null";
} else if (obj instanceof byte[]) {
return Arrays.toString((byte[]) obj);
} else if (obj instanceof short[]) {
return Arrays.toString((short[]) obj);
} else if (obj instanceof int[]) {
return Arrays.toString((int[]) obj);
} else if (obj instanceof long[]) {
return Arrays.toString((long[]) obj);
} else if (obj instanceof float[]) {
return Arrays.toString((float[]) obj);
} else if (obj instanceof double[]) {
return Arrays.toString((double[]) obj);
} else if (obj instanceof boolean[]) {
return Arrays.toString((boolean[]) obj);
} else if (obj instanceof char[]) {
return Arrays.toString((char[]) obj);
} else if (obj instanceof Object[]) {
return text((Object[]) obj);
} else {
return String.valueOf(obj);
}
}
public static String text(Object[] objs) {
StringBuilder sb = new StringBuilder();
sb.append("[");
for (int i = 0; i < objs.length; i++) {
if (i > 0) {
sb.append(", ");
}
sb.append(text(objs[i]));
}
sb.append("]");
return sb.toString();
}
public static String text(Iterator<?> it) {
StringBuilder sb = new StringBuilder();
sb.append("[");
boolean first = true;
while (it.hasNext()) {
if (first) {
sb.append(", ");
first = false;
}
sb.append(text(it.next()));
}
sb.append("]");
return sb.toString();
}
public static String textln(Object[] objs) {
StringBuilder sb = new StringBuilder();
sb.append("[");
for (int i = 0; i < objs.length; i++) {
if (i > 0) {
sb.append(",");
}
sb.append("\n ");
sb.append(text(objs[i]));
}
sb.append("\n]");
return sb.toString();
}
public static String replaceText(String s, String[][] repls) {
for (String[] repl : repls) {
s = s.replaceAll(Pattern.quote(repl[0]), repl[1]);
}
return s;
}
public static String join(String sep, Object... items) {
return render(items, "%s", sep);
}
public static String join(String sep, Iterable<?> items) {
return render(items, "%s", sep);
}
public static String render(Object[] items, String itemFormat, String sep) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < items.length; i++) {
if (i > 0) {
sb.append(sep);
}
sb.append(format(itemFormat, items[i]));
}
return sb.toString();
}
public static String render(Iterable<?> items, String itemFormat, String sep) {
StringBuilder sb = new StringBuilder();
int i = 0;
Iterator<?> it = items.iterator();
while (it.hasNext()) {
Object item = it.next();
if (i > 0) {
sb.append(sep);
}
sb.append(format(itemFormat, item));
i++;
}
return sb.toString();
}
public static URL resource(String filename) {
return CLASS_LOADER.getResource(filename);
}
public static File file(String filename) {
File file = new File(filename);
if (!file.exists()) {
URL res = resource(filename);
if (res != null) {
return new File(res.getFile());
}
}
return file;
}
public static long time() {
return System.currentTimeMillis();
}
public static boolean xor(boolean a, boolean b) {
return a && !b || b && !a;
}
public static boolean eq(Object a, Object b) {
if (a == b) {
return true;
}
if (a == null || b == null) {
return false;
}
return a.equals(b);
}
public static void failIf(boolean failureCondition, String msg) {
if (failureCondition) {
throw rte(msg);
}
}
public static String load(String name) {
InputStream stream = CLASS_LOADER.getResourceAsStream(name);
InputStreamReader reader = new InputStreamReader(stream);
BufferedReader r = new BufferedReader(reader);
StringBuilder sb = new StringBuilder();
String line;
try {
while ((line = r.readLine()) != null) {
sb.append(line);
}
} catch (IOException e) {
throw rte("Cannot read resource: " + name, e);
}
return sb.toString();
}
public static void save(String filename, String content) {
FileOutputStream out = null;
try {
out = new FileOutputStream(filename);
out.write(content.getBytes());
close(out, false);
} catch (Exception e) {
close(out, true);
throw rte(e);
}
}
public static void close(OutputStream out, boolean quiet) {
try {
out.close();
} catch (IOException e) {
if (!quiet) {
throw rte(e);
}
}
}
public static void close(InputStream in, boolean quiet) {
try {
in.close();
} catch (IOException e) {
if (!quiet) {
throw rte(e);
}
}
}
public static void delete(String filename) {
new File(filename).delete();
}
public static <T> T[] expand(T[] arr, int factor) {
int len = arr.length;
arr = Arrays.copyOf(arr, len * factor);
return arr;
}
public static <T> T[] expand(T[] arr, T item) {
int len = arr.length;
arr = Arrays.copyOf(arr, len + 1);
arr[len] = item;
return arr;
}
public static <T> T[] subarray(T[] arr, int from, int to) {
int start = from >= 0 ? from : arr.length + from;
int end = to >= 0 ? to : arr.length + to;
if (start < 0) {
start = 0;
}
if (end > arr.length - 1) {
end = arr.length - 1;
}
must(start <= end, "Invalid range: expected form <= to!");
int size = end - start + 1;
T[] part = Arrays.copyOf(arr, size);
System.arraycopy(arr, start, part, 0, size);
return part;
}
public static <T> T[] array(T... items) {
return items;
}
public static <T> Set<T> set(T... values) {
Set<T> set = new HashSet<T>();
for (T val : values) {
set.add(val);
}
return set;
}
public static <T> List<T> list(T... values) {
List<T> list = new ArrayList<T>();
for (T item : values) {
list.add(item);
}
return list;
}
public static <K, V> Map<K, V> map() {
return new HashMap<K, V>();
}
public static <K, V> Map<K, V> map(K key, V value) {
Map<K, V> map = map();
map.put(key, value);
return map;
}
public static <K, V> Map<K, V> map(K key1, V value1, K key2, V value2) {
Map<K, V> map = map(key1, value1);
map.put(key2, value2);
return map;
}
public static <K, V> Map<K, V> map(K key1, V value1, K key2, V value2, K key3, V value3) {
Map<K, V> map = map(key1, value1, key2, value2);
map.put(key3, value3);
return map;
}
public static <K, V> Map<K, V> map(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4) {
Map<K, V> map = map(key1, value1, key2, value2, key3, value3);
map.put(key4, value4);
return map;
}
@SuppressWarnings("serial")
public static <K, V> Map<K, V> autoExpandingMap(final F1<V, K> valueFactory) {
return new ConcurrentHashMap<K, V>() {
@SuppressWarnings("unchecked")
@Override
public synchronized V get(Object key) {
V val = super.get(key);
if (val == null) {
try {
val = valueFactory.execute((K) key);
} catch (Exception e) {
throw rte(e);
}
put((K) key, val);
}
return val;
}
};
}
public static <K, V> Map<K, V> autoExpandingMap(final Class<V> clazz) {
return autoExpandingMap(new F1<V, K>() {
@Override
public V execute(K param) throws Exception {
return inject(newInstance(clazz));
}
});
}
public static void waitFor(AtomicBoolean done) {
while (!done.get()) {
sleep(5);
}
}
public static void waitFor(AtomicInteger n, int value) {
while (n.get() != value) {
sleep(5);
}
}
public static byte[] serialize(Object value) {
try {
ByteArrayOutputStream output = new ByteArrayOutputStream();
ObjectOutputStream out = new ObjectOutputStream(output);
out.writeObject(value);
output.close();
return output.toByteArray();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static Object deserialize(byte[] buf) {
try {
ObjectInputStream in = new ObjectInputStream(new ByteArrayInputStream(buf));
Object obj = in.readObject();
in.close();
return obj;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static void serialize(Object value, ByteBuffer buf) {
byte[] bytes = serialize(value);
buf.putInt(bytes.length);
buf.put(bytes);
}
public static Object deserialize(ByteBuffer buf) {
int len = buf.getInt();
byte[] bytes = new byte[len];
buf.get(bytes);
return deserialize(bytes);
}
// TODO add such utils for other primitive types, as well
public static void encode(long value, ByteBuffer buf) {
buf.put((byte) TypeKind.LONG.ordinal());
buf.putLong(value);
}
public static void encode(Object value, ByteBuffer buf) {
TypeKind kind = kindOf(value);
int ordinal = kind.ordinal();
assert ordinal < 128;
byte kindCode = (byte) ordinal;
buf.put(kindCode);
switch (kind) {
case NULL:
// nothing else needed
break;
case BOOLEAN:
case BYTE:
case SHORT:
case CHAR:
case INT:
case LONG:
case FLOAT:
case DOUBLE:
throw notExpected();
case STRING:
String str = (String) value;
byte[] bytes = str.getBytes();
// 0-255
int len = bytes.length;
if (len < 255) {
buf.put(bytee(len));
} else {
buf.put(bytee(255));
buf.putInt(len);
}
buf.put(bytes);
break;
case BOOLEAN_OBJ:
boolean val = (Boolean) value;
buf.put((byte) (val ? 1 : 0));
break;
case BYTE_OBJ:
buf.put((Byte) value);
break;
case SHORT_OBJ:
buf.putShort((Short) value);
break;
case CHAR_OBJ:
buf.putChar((Character) value);
break;
case INT_OBJ:
buf.putInt((Integer) value);
break;
case LONG_OBJ:
buf.putLong((Long) value);
break;
case FLOAT_OBJ:
buf.putFloat((Float) value);
break;
case DOUBLE_OBJ:
buf.putDouble((Double) value);
break;
case OBJECT:
serialize(value, buf);
break;
case DATE:
buf.putLong(((Date) value).getTime());
break;
default:
throw notExpected();
}
}
private static byte bytee(int n) {
return (byte) (n - 128);
}
public static long decodeLong(ByteBuffer buf) {
U.must(buf.get() == TypeKind.LONG.ordinal());
return buf.getLong();
}
public static Object decode(ByteBuffer buf) {
byte kindCode = buf.get();
TypeKind kind = TypeKind.values()[kindCode];
switch (kind) {
case NULL:
return null;
case BOOLEAN:
case BOOLEAN_OBJ:
return buf.get() != 0;
case BYTE:
case BYTE_OBJ:
return buf.get();
case SHORT:
case SHORT_OBJ:
return buf.getShort();
case CHAR:
case CHAR_OBJ:
return buf.getChar();
case INT:
case INT_OBJ:
return buf.getInt();
case LONG:
case LONG_OBJ:
return buf.getLong();
case FLOAT:
case FLOAT_OBJ:
return buf.getFloat();
case DOUBLE:
case DOUBLE_OBJ:
return buf.getDouble();
case STRING:
byte len = buf.get();
int realLen = len + 128;
if (realLen == 255) {
realLen = buf.getInt();
}
byte[] sbuf = new byte[realLen];
buf.get(sbuf);
return new String(sbuf);
case OBJECT:
return deserialize(buf);
case DATE:
return new Date(buf.getLong());
default:
throw notExpected();
}
}
public static ByteBuffer expand(ByteBuffer buf, int newSize) {
ByteBuffer buf2 = ByteBuffer.allocate(newSize);
ByteBuffer buff = buf.duplicate();
buff.rewind();
buff.limit(buff.capacity());
buf2.put(buff);
return buf2;
}
public static ByteBuffer expand(ByteBuffer buf) {
int cap = buf.capacity();
if (cap <= 1000) {
cap *= 10;
} else if (cap <= 10000) {
cap *= 5;
} else {
cap *= 2;
}
return expand(buf, cap);
}
public static String buf2str(ByteBuffer buf) {
ByteBuffer buf2 = buf.duplicate();
buf2.rewind();
buf2.limit(buf2.capacity());
byte[] bytes = new byte[buf2.capacity()];
buf2.get(bytes);
return new String(bytes);
}
public static ByteBuffer buf(String s) {
byte[] bytes = s.getBytes();
ByteBuffer buf = ByteBuffer.allocateDirect(bytes.length);
buf.put(bytes);
buf.rewind();
return buf;
}
public static String copyNtimes(String s, int n) {
StringBuffer sb = new StringBuffer();
for (int i = 0; i < n; i++) {
sb.append(s);
}
return sb.toString();
}
public static RuntimeException rte(String message, Object... args) {
return new RuntimeException(format(message, args));
}
public static RuntimeException rte(String message, Throwable cause, Object... args) {
return new RuntimeException(format(message, args), cause);
}
public static RuntimeException rte(String message, Throwable cause) {
return new RuntimeException(message, cause);
}
public static RuntimeException rte(Throwable cause) {
return new RuntimeException(cause);
}
public static RuntimeException rte(String message) {
return cachedRTE(RuntimeException.class, message);
}
public static <T extends RuntimeException> T rte(Class<T> clazz) {
return cachedRTE(clazz, null);
}
public static <T extends RuntimeException> T rte(Class<T> clazz, String msg) {
return cachedRTE(clazz, msg);
}
@SuppressWarnings("unchecked")
private static synchronized <T extends RuntimeException> T cachedRTE(Class<T> clazz, String msg) {
return (T) EXCEPTIONS.get(clazz).get(U.or(msg, ""));
}
public static boolean must(boolean expectedCondition) {
if (!expectedCondition) {
throw rte("Expectation failed!");
}
return true;
}
public static boolean must(boolean expectedCondition, String message) {
if (!expectedCondition) {
throw rte(message);
}
return true;
}
public static boolean must(boolean expectedCondition, String message, long arg) {
if (!expectedCondition) {
throw rte(message, arg);
}
return true;
}
public static boolean must(boolean expectedCondition, String message, Object arg) {
if (!expectedCondition) {
throw rte(message, arg);
}
return true;
}
public static boolean must(boolean expectedCondition, String message, Object arg1, Object arg2) {
if (!expectedCondition) {
throw rte(message, arg1, arg2);
}
return true;
}
public static void notNull(Object... items) {
for (int i = 0; i < items.length; i++) {
if (items[i] == null) {
throw rte("The item[%s] must NOT be null!", i);
}
}
}
public static void notNull(Object value, String desc) {
if (value == null) {
throw rte("%s must NOT be null!", desc);
}
}
public static RuntimeException notReady() {
return rte("Not yet implemented!");
}
public static RuntimeException notSupported() {
return rte("This operation is not supported by this implementation!");
}
public static RuntimeException notExpected() {
return rte("This operation is not expected to be called!");
}
public static String stackTraceOf(Throwable e) {
ByteArrayOutputStream output = new ByteArrayOutputStream();
e.printStackTrace(new PrintStream(output));
return output.toString();
}
public static void benchmark(String name, int count, Runnable runnable) {
long start = Calendar.getInstance().getTimeInMillis();
for (int i = 0; i < count; i++) {
runnable.run();
}
long end = Calendar.getInstance().getTimeInMillis();
long ms = end - start;
if (ms == 0) {
ms = 1;
}
double avg = ((double) count / (double) ms);
String avgs = avg > 1 ? Math.round(avg) + "K" : Math.round(avg * 1000) + "";
String data = format("%s: %s in %s ms (%s/sec)", name, count, ms, avgs);
print(data + " | " + getCpuMemStats());
}
public static void benchmarkMT(int threadsN, final String name, final int count, final Runnable runnable) {
final CountDownLatch latch = new CountDownLatch(threadsN);
for (int i = 1; i <= threadsN; i++) {
new Thread() {
public void run() {
benchmark(name, count, runnable);
latch.countDown();
};
}.start();
}
try {
latch.await();
} catch (InterruptedException e) {
throw U.rte(e);
}
}
public static String getCpuMemStats() {
Runtime rt = Runtime.getRuntime();
long totalMem = rt.totalMemory();
long maxMem = rt.maxMemory();
long freeMem = rt.freeMemory();
long usedMem = totalMem - freeMem;
int megs = 1024 * 1024;
String msg = "MEM [total=%s MB, used=%s MB, max=%s MB]%s";
return format(msg, totalMem / megs, usedMem / megs, maxMem / megs, gcInfo());
}
public static String gcInfo() {
String gcinfo = "";
if (getGarbageCollectorMXBeans != null) {
List<?> gcs = invokeStatic(getGarbageCollectorMXBeans);
for (Object gc : gcs) {
gcinfo += " | " + getPropValue(gc, "name") + " x" + getPropValue(gc, "collectionCount") + ":"
+ getPropValue(gc, "collectionTime") + "ms";
}
}
return gcinfo;
}
@SuppressWarnings("unchecked")
public static <T> T createProxy(InvocationHandler handler, Class<?>... interfaces) {
return ((T) Proxy.newProxyInstance(CLASS_LOADER, interfaces, handler));
}
public static <T> T implementInterfaces(final Object target, final InvocationHandler handler,
Class<?>... interfaces) {
final Class<?> targetClass = target.getClass();
return createProxy(new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
if (method.getDeclaringClass().isAssignableFrom(targetClass)) {
return method.invoke(target, args);
}
return handler.invoke(proxy, method, args);
}
}, interfaces);
}
public static <T> T implementInterfaces(Object target, InvocationHandler handler) {
return implementInterfaces(target, handler, getImplementedInterfaces(target.getClass()));
}
public static <T> T tracer(Object target) {
return implementInterfaces(target, new InvocationHandler() {
@Override
public Object invoke(Object target, Method method, Object[] args) throws Throwable {
trace("intercepting", "method", method.getName(), "args", Arrays.toString(args));
return method.invoke(target, args);
}
});
}
public static void show(Object... values) {
String text = values.length == 1 ? text(values[0]) : text(values);
print(">" + text + "<");
}
public static <T> T newInstance(Class<T> clazz) {
try {
return clazz.newInstance();
} catch (Exception e) {
throw rte(e);
}
}
@SuppressWarnings("unchecked")
public static <T> T newInstance(Class<T> clazz, Object... args) {
for (Constructor<?> constr : clazz.getConstructors()) {
Class<?>[] paramTypes = constr.getParameterTypes();
if (areAssignable(paramTypes, args)) {
try {
return (T) constr.newInstance(args);
} catch (Exception e) {
throw rte(e);
}
}
}
throw rte("Cannot find appropriate constructor!");
}
public static <T> T initNewInstance(Class<T> clazz, Map<String, Object> params) {
return init(newInstance(clazz), params);
}
public static <T> T init(T obj, Map<String, Object> params) {
throw notReady();
}
private static boolean areAssignable(Class<?>[] types, Object[] values) {
if (types.length != values.length) {
return false;
}
for (int i = 0; i < values.length; i++) {
Object val = values[i];
if (val != null && !types[i].isAssignableFrom(val.getClass())) {
return false;
}
}
return true;
}
public static <T> T or(T value, T fallback) {
return value != null ? value : fallback;
}
public static synchronized void schedule(Runnable task, long delay) {
if (EXECUTOR == null) {
EXECUTOR = new ScheduledThreadPoolExecutor(3);
}
EXECUTOR.schedule(task, delay, TimeUnit.MILLISECONDS);
}
public static void startMeasure() {
measureStart = time();
}
public static void endMeasure() {
long delta = time() - measureStart;
show(delta + " ms");
}
public static void print(Object value) {
System.out.println(value);
}
public static void printAll(Collection<?> collection) {
for (Object item : collection) {
print(item);
}
}
public static void args(String... args) {
if (args != null) {
ARGS = args;
}
}
public static boolean hasOption(String name) {
notNull(ARGS, "command line arguments");
for (String op : ARGS) {
if (op.equalsIgnoreCase(name)) {
return true;
}
}
return false;
}
public static String option(String name, String defaultValue) {
notNull(ARGS, "command line arguments");
for (String op : ARGS) {
if (op.startsWith(name + "=")) {
return op.substring(name.length() + 1);
}
}
return defaultValue;
}
public static long option(String name, long defaultValue) {
String n = option(name, null);
return n != null ? Long.parseLong(n) : defaultValue;
}
public static double option(String name, double defaultValue) {
String n = option(name, null);
return n != null ? Double.parseDouble(n) : defaultValue;
}
public static boolean isEmpty(String value) {
return value == null || value.isEmpty();
}
public static void connect(String address, int port, F2<Void, BufferedReader, DataOutputStream> protocol) {
Socket socket = null;
try {
socket = new Socket(address, port);
DataOutputStream out = new DataOutputStream(socket.getOutputStream());
BufferedReader in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
protocol.execute(in, out);
socket.close();
} catch (Exception e) {
throw rte(e);
} finally {
if (socket != null) {
try {
socket.close();
} catch (IOException e) {
throw rte(e);
}
}
}
}
public static void listen(int port, F2<Void, BufferedReader, DataOutputStream> protocol) {
listen(null, port, protocol);
}
public static void listen(String hostname, int port, F2<Void, BufferedReader, DataOutputStream> protocol) {
ServerSocket socket = null;
try {
socket = new ServerSocket();
socket.bind(isEmpty(hostname) ? new InetSocketAddress(port) : new InetSocketAddress(hostname, port));
info("Starting TCP/IP server", "host", hostname, "port", port);
while (true) {
final Socket conn = socket.accept();
BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
DataOutputStream out = new DataOutputStream(conn.getOutputStream());
try {
protocol.execute(in, out);
} catch (Exception e) {
throw rte(e);
} finally {
conn.close();
}
}
} catch (Exception e) {
throw rte(e);
} finally {
if (socket != null) {
try {
socket.close();
} catch (IOException e) {
throw rte(e);
}
}
}
}
public static void microHttpServer(String hostname, int port, final F2<String, String, List<String>> handler) {
listen(hostname, port, new F2<Void, BufferedReader, DataOutputStream>() {
@Override
public Void execute(BufferedReader in, DataOutputStream out) throws Exception {
List<String> lines = new ArrayList<String>();
String line;
while ((line = in.readLine()) != null) {
if (line.isEmpty()) {
break;
}
lines.add(line);
}
if (!lines.isEmpty()) {
String req = lines.get(0);
if (req.startsWith("GET /")) {
int pos = req.indexOf(' ', 4);
String path = urlDecode(req.substring(4, pos));
String response = handler.execute(path, lines);
out.writeBytes(response);
} else {
out.writeBytes("Only GET requests are supported!");
}
} else {
out.writeBytes("Invalid HTTP request!");
}
return null;
}
});
}
public static String capitalized(String s) {
return s.substring(0, 1).toUpperCase() + s.substring(1);
}
public static long getId(Object obj) {
Object id = getPropValue(obj, "id");
if (id == null) {
throw rte("The field 'id' cannot be null!");
}
if (id instanceof Long) {
Long num = (Long) id;
return num;
} else {
throw rte("The field 'id' must have type 'long', but it has: " + id.getClass());
}
}
public static long[] getIds(Object... objs) {
long[] ids = new long[objs.length];
for (int i = 0; i < objs.length; i++) {
ids[i] = getId(objs[i]);
}
return ids;
}
public static String replace(String s, String regex, F1<String, String[]> replacer) {
StringBuffer output = new StringBuffer();
Pattern p = Pattern.compile(regex);
Matcher matcher = p.matcher(s);
while (matcher.find()) {
int len = matcher.groupCount() + 1;
String[] gr = new String[len];
for (int i = 0; i < gr.length; i++) {
gr[i] = matcher.group(i);
}
try {
String rep = replacer.execute(gr);
matcher.appendReplacement(output, rep);
} catch (Exception e) {
throw rte("Cannot replace text!", e);
}
}
matcher.appendTail(output);
return output.toString();
}
public static synchronized void manage(Object... classesOrInstances) {
List<Class<?>> autocreate = new ArrayList<Class<?>>();
for (Object classOrInstance : classesOrInstances) {
boolean isClass = isClass(classOrInstance);
Class<?> clazz = isClass ? (Class<?>) classOrInstance : classOrInstance.getClass();
for (Class<?> interfacee : getImplementedInterfaces(clazz)) {
addInjectionProvider(interfacee, classOrInstance);
}
if (isClass) {
debug("configuring managed class", "class", classOrInstance);
MANAGED_CLASSES.add(clazz);
if (!clazz.isInterface() && !clazz.isEnum() && !clazz.isAnnotation()) {
System.out.println(":" + clazz);
// if the class is annotated, auto-create an instance
if (clazz.getAnnotation(Autocreate.class) != null) {
autocreate.add(clazz);
}
}
} else {
debug("configuring managed instance", "instance", classOrInstance);
addInjectionProvider(clazz, classOrInstance);
MANAGED_INSTANCES.add(classOrInstance);
}
}
for (Class<?> clazz : autocreate) {
inject(clazz);
}
}
private static void addInjectionProvider(Class<?> type, Object provider) {
Set<Object> providers = INJECTION_PROVIDERS.get(type);
if (providers == null) {
providers = set();
INJECTION_PROVIDERS.put(type, providers);
}
providers.add(provider);
}
public static synchronized <T> T inject(Class<T> type) {
info("Inject", "type", type);
return provideIoCInstanceOf(type, null);
}
public static synchronized <T> T inject(T target) {
info("Inject", "target", target);
return ioc(target);
}
private static <T> T provideIoCInstanceOf(Class<T> type, String name) {
T instance = null;
if (name != null) {
instance = provideInstanceByName(type, name);
}
if (instance == null) {
instance = provideIoCInstanceByType(type);
}
if (instance == null) {
instance = provideNewIoCInstanceOf(type);
}
if (instance == null) {
if (name != null) {
throw rte("Couldn't provide a value for type '%s' and name '%s'!", type, name);
} else {
throw rte("Couldn't provide a value for type '%s'!", type);
}
}
return ioc(instance);
}
@SuppressWarnings("unchecked")
private static <T> T provideNewIoCInstanceOf(Class<T> type) {
// instantiation if it's real class
if (!type.isInterface() && !type.isEnum() && !type.isAnnotation()) {
T instance = (T) SINGLETONS.get(type);
if (instance == null) {
instance = ioc(newInstance(type));
}
return instance;
} else {
return null;
}
}
private static <T> T provideIoCInstanceByType(Class<T> type) {
Set<Object> providers = INJECTION_PROVIDERS.get(type);
if (providers != null && !providers.isEmpty()) {
Object provider = null;
for (Object pr : providers) {
if (provider == null) {
provider = pr;
} else {
if (isClass(provider) && !isClass(pr)) {
provider = pr;
} else if (isClass(provider) || !isClass(pr)) {
throw rte("Found more than 1 injection candidates for type '%s': %s", type, providers);
}
}
}
if (provider != null) {
return provideFrom(provider);
}
}
return null;
}
@SuppressWarnings("unchecked")
private static <T> T provideFrom(Object classOrInstance) {
T instance;
if (isClass(classOrInstance)) {
instance = provideNewIoCInstanceOf((Class<T>) classOrInstance);
} else {
instance = (T) classOrInstance;
}
return instance;
}
private static boolean isClass(Object obj) {
return obj instanceof Class;
}
@SuppressWarnings("unchecked")
private static <T> T provideInstanceByName(Class<T> type, String name) {
Object instance = null;
if (type.equals(Boolean.class) || type.equals(boolean.class)) {
instance = hasOption(name);
} else {
String opt = option(name, null);
if (opt != null) {
instance = convert(opt, type);
}
}
return (T) instance;
}
private static void autowire(Object target) {
debug("Autowiring", "target", target);
for (Field field : INJECTABLE_FIELDS.get(target.getClass())) {
Object value = provideIoCInstanceOf(field.getType(), field.getName());
debug("Injecting field value", "target", target, "field", field.getName(), "value", value);
setFieldValue(target, field.getName(), value);
}
}
private static <T> void invokePostConstruct(T target) {
List<Method> methods = getMethodsAnnotated(target.getClass(), Init.class);
for (Method method : methods) {
invoke(method, target);
}
}
private static <T> T ioc(T target) {
if (!isIocProcessed(target)) {
IOC_INSTANCES.put(target, null);
manage(target);
autowire(target);
invokePostConstruct(target);
T proxy = proxyWrap(target);
IOC_INSTANCES.put(target, proxy);
manage(proxy);
target = proxy;
}
return target;
}
private static boolean isIocProcessed(Object target) {
for (Entry<Object, Object> e : IOC_INSTANCES.entrySet()) {
if (e.getKey() == target || e.getValue() == target) {
return true;
}
}
return false;
}
@SuppressWarnings("unchecked")
private static <T> T proxyWrap(T instance) {
Set<F3<Object, Object, Method, Object[]>> done = set();
for (Class<?> interf : getImplementedInterfaces(instance.getClass())) {
final List<F3<Object, Object, Method, Object[]>> interceptors = INTERCEPTORS.get(interf);
if (interceptors != null) {
for (final F3<Object, Object, Method, Object[]> interceptor : interceptors) {
if (interceptor != null && !done.contains(interceptor)) {
debug("Creating proxy", "target", instance, "interface", interf, "interceptor", interceptor);
final T target = instance;
InvocationHandler handler = new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
return interceptor.execute(target, method, args);
}
};
instance = implementInterfaces(instance, handler, interf);
done.add(interceptor);
}
}
}
}
return instance;
}
@SuppressWarnings("unchecked")
public static <T> T convert(String value, Class<T> toType) {
TypeKind targetKind = kindOf(toType);
switch (targetKind) {
case NULL:
throw notExpected();
case BOOLEAN:
case BOOLEAN_OBJ:
if ("y".equalsIgnoreCase(value) || "t".equalsIgnoreCase(value) || "yes".equalsIgnoreCase(value)
|| "true".equalsIgnoreCase(value)) {
return (T) Boolean.TRUE;
}
if ("n".equalsIgnoreCase(value) || "f".equalsIgnoreCase(value) || "no".equalsIgnoreCase(value)
|| "false".equalsIgnoreCase(value)) {
return (T) Boolean.FALSE;
}
throw rte("Cannot convert the string value '%s' to boolean!", value);
case BYTE:
case BYTE_OBJ:
return (T) new Byte(value);
case SHORT:
case SHORT_OBJ:
return (T) new Short(value);
case CHAR:
case CHAR_OBJ:
return (T) new Character(value.charAt(0));
case INT:
case INT_OBJ:
return (T) new Integer(value);
case LONG:
case LONG_OBJ:
return (T) new Long(value);
case FLOAT:
case FLOAT_OBJ:
return (T) new Float(value);
case DOUBLE:
case DOUBLE_OBJ:
return (T) new Double(value);
case STRING:
return (T) value;
case OBJECT:
throw rte("Cannot convert string value to type '%s'!", toType);
case DATE:
return (T) date(value);
default:
throw notExpected();
}
}
private static Enumeration<URL> resources(String name) {
name = name.replace('.', '/');
if (name.equals("*")) {
name = "";
}
try {
return Thread.currentThread().getContextClassLoader().getResources(name);
} catch (IOException e) {
throw rte("Cannot scan: " + name, e);
}
}
public static List<Class<?>> classpathClasses(String packageName, String nameRegex, Predicate<Class<?>> filter) {
Pattern regex = Pattern.compile(nameRegex);
ArrayList<Class<?>> classes = new ArrayList<Class<?>>();
Enumeration<URL> urls = resources(packageName);
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
File file = new File(url.getFile());
getClasses(classes, file, file, regex, filter);
}
return classes;
}
public static List<File> classpath(String packageName, Predicate<File> filter) {
ArrayList<File> files = new ArrayList<File>();
classpath(packageName, files, filter);
return files;
}
public static void classpath(String packageName, Collection<File> files, Predicate<File> filter) {
Enumeration<URL> urls = resources(packageName);
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
File file = new File(url.getFile());
getFiles(files, file, filter);
}
}
private static void getFiles(Collection<File> files, File file, Predicate<File> filter) {
if (file.isDirectory()) {
debug("scanning directory", "dir", file);
for (File f : file.listFiles()) {
if (f.isDirectory()) {
getFiles(files, f, filter);
} else {
debug("scanned file", "file", f);
try {
if (filter == null || filter.eval(f)) {
files.add(f);
}
} catch (Exception e) {
throw rte(e);
}
}
}
}
}
private static void getClasses(Collection<Class<?>> classes, File root, File parent, Pattern nameRegex,
Predicate<Class<?>> filter) {
if (parent.isDirectory()) {
debug("scanning directory", "dir", parent);
for (File f : parent.listFiles()) {
if (f.isDirectory()) {
getClasses(classes, root, f, nameRegex, filter);
} else {
debug("scanned file", "file", f);
try {
if (f.getName().endsWith(".class")) {
String clsName = f.getAbsolutePath();
String rootPath = root.getAbsolutePath();
U.must(clsName.startsWith(rootPath));
clsName = clsName.substring(rootPath.length() + 1, clsName.length() - 6);
clsName = clsName.replace(File.separatorChar, '.');
if (nameRegex.matcher(clsName).matches()) {
Class<?> cls = Class.forName(clsName);
if (filter == null || filter.eval(cls)) {
classes.add(cls);
}
}
}
} catch (Exception e) {
throw rte(e);
}
}
}
}
}
public static String urlDecode(String value) {
try {
return URLDecoder.decode(value, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw U.rte(e);
}
}
public static Object getPropValue(Object instance, String propertyName) {
String propertyNameCap = capitalized(propertyName);
try {
for (Class<?> c = instance.getClass(); c != Object.class; c = c.getSuperclass()) {
try {
return invoke(c.getDeclaredMethod(propertyName), instance);
} catch (NoSuchMethodException e) {
try {
return invoke(c.getDeclaredMethod("get" + propertyNameCap), instance);
} catch (NoSuchMethodException e2) {
try {
return invoke(c.getDeclaredMethod("is" + propertyNameCap), instance);
} catch (NoSuchMethodException e3) {
try {
return getFieldValue(c.getDeclaredField(propertyName), instance);
} catch (NoSuchFieldException e4) {
// keep searching in the super-class...
}
}
}
}
}
} catch (Exception e) {
throw rte("Cannot get property value!", e);
}
throw rte("Cannot find the property '%s' in the class '%s'", propertyName, instance.getClass());
}
public static String mul(String s, int n) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < n; i++) {
sb.append(s);
}
return sb.toString();
}
public static Date date(String value) {
String[] parts = value.split("(\\.|-|/)");
int a = parts.length > 0 ? num(parts[0]) : -1;
int b = parts.length > 1 ? num(parts[1]) : -1;
int c = parts.length > 2 ? num(parts[2]) : -1;
switch (parts.length) {
case 3:
if (isDay(a) && isMonth(b) && isYear(c)) {
return date(a, b, c);
} else if (isYear(a) && isMonth(b) && isDay(c)) {
return date(c, b, a);
}
break;
case 2:
if (isDay(a) && isMonth(b)) {
return date(a, b, thisYear());
}
break;
default:
}
throw rte("Invalid date: " + value);
}
private static boolean isDay(int day) {
return day >= 1 && day <= 31;
}
private static boolean isMonth(int month) {
return month >= 1 && month <= 12;
}
private static boolean isYear(int year) {
return year >= 1000;
}
public static int num(String s) {
return Integer.parseInt(s);
}
public static synchronized Date date(int day, int month, int year) {
CALENDAR.set(year, month - 1, day - 1);
return CALENDAR.getTime();
}
public static synchronized int thisYear() {
CALENDAR.setTime(new Date());
return CALENDAR.get(Calendar.YEAR);
}
public static short bytesToShort(String s) {
ByteBuffer buf = buf(s);
must(buf.limit() == 2);
return buf.getShort();
}
public static int bytesToInt(String s) {
ByteBuffer buf = buf(s);
must(buf.limit() == 4);
return buf.getInt();
}
public static long bytesToLong(String s) {
ByteBuffer buf = buf(s);
must(buf.limit() == 8);
return buf.getLong();
}
public static int intFrom(byte a, byte b, byte c, byte d) {
return (a << 24) + (b << 16) + (c << 8) + d;
}
public static short shortFrom(byte a, byte b) {
return (short) ((a << 8) + b);
}
public static String format(String s, Object... args) {
return String.format(s, args);
}
public static String bytesToString(byte[] bytes) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < bytes.length; i++) {
sb.append(Integer.toString((bytes[i] & 0xff) + 0x100, 16).substring(1));
}
return sb.toString();
}
private static MessageDigest digest(String algorithm) {
try {
return MessageDigest.getInstance(algorithm);
} catch (NoSuchAlgorithmException e) {
throw rte("Cannot find algorithm: " + algorithm);
}
}
public static String md5(byte[] bytes) {
MessageDigest md5 = digest("MD5");
md5.update(bytes);
return bytesToString(md5.digest());
}
public static String md5(String data) {
return md5(data.getBytes());
}
public static char rndChar() {
return (char) (65 + rnd(26));
}
public static String rndStr(int length) {
return rndStr(length, length);
}
public static String rndStr(int minLength, int maxLength) {
int len = minLength + rnd(maxLength - minLength + 1);
StringBuffer sb = new StringBuffer();
for (int i = 0; i < len; i++) {
sb.append(rndChar());
}
return sb.toString();
}
public static int rnd(int n) {
return RND.nextInt(n);
}
public static int rndExcept(int n, int except) {
if (n > 1 || except != 0) {
while (true) {
int num = RND.nextInt(n);
if (num != except) {
return num;
}
}
} else {
throw new RuntimeException("Cannot produce such number!");
}
}
public static <T> T rnd(T[] arr) {
return arr[rnd(arr.length)];
}
public static int rnd() {
return RND.nextInt();
}
public static long rndL() {
return RND.nextLong();
}
@SuppressWarnings("resource")
public static MappedByteBuffer mmap(String filename, MapMode mode, long position, long size) {
try {
File file = new File(filename);
FileChannel fc = new RandomAccessFile(file, "rw").getChannel();
return fc.map(mode, position, size);
} catch (Exception e) {
throw U.rte(e);
}
}
public static MappedByteBuffer mmap(String filename, MapMode mode) {
File file = new File(filename);
U.must(file.exists());
return mmap(filename, mode, 0, file.length());
}
public static Class<?> getClassIfExists(String className) {
try {
return Class.forName(className);
} catch (ClassNotFoundException e) {
return null;
}
}
}
| Fixed method access bug.
| rapidoid-u/src/main/java/org/rapidoid/util/U.java | Fixed method access bug. | <ide><path>apidoid-u/src/main/java/org/rapidoid/util/U.java
<ide>
<ide> @SuppressWarnings("unchecked")
<ide> public static <T> T invokeStatic(Method m, Object... args) {
<del> try {
<add> boolean accessible = m.isAccessible();
<add> try {
<add> m.setAccessible(true);
<ide> return (T) m.invoke(null, args);
<ide> } catch (IllegalAccessException e) {
<ide> throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
<ide> throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
<ide> } catch (InvocationTargetException e) {
<ide> throw rte("Cannot statically invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
<add> } finally {
<add> m.setAccessible(accessible);
<ide> }
<ide> }
<ide>
<ide> @SuppressWarnings("unchecked")
<ide> public static <T> T invoke(Method m, Object target, Object... args) {
<del> try {
<add> boolean accessible = m.isAccessible();
<add> try {
<add> m.setAccessible(true);
<ide> return (T) m.invoke(target, args);
<ide> } catch (Exception e) {
<ide> throw rte("Cannot invoke method '%s' with args: %s", e, m.getName(), Arrays.toString(args));
<add> } finally {
<add> m.setAccessible(accessible);
<ide> }
<ide> }
<ide> |
|
Java | apache-2.0 | f13599d4b1e0e1b50a122a097faac83134685298 | 0 | spotify/styx,spotify/styx,spotify/styx | /*-
* -\-\-
* Spotify Styx Scheduler Service
* --
* Copyright (C) 2016 Spotify 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 com.spotify.styx;
import static com.spotify.apollo.environment.ConfigUtil.optionalInt;
import static com.spotify.styx.state.OutputHandler.fanOutput;
import static com.spotify.styx.state.StateUtil.getResourcesUsageMap;
import static com.spotify.styx.util.Connections.createBigTableConnection;
import static com.spotify.styx.util.Connections.createDatastore;
import static com.spotify.styx.util.GuardedRunnable.runGuarded;
import static com.spotify.styx.util.ShardedCounter.NUM_SHARDS;
import static java.util.Objects.requireNonNull;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;
import com.codahale.metrics.Gauge;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.googleapis.util.Utils;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.services.container.v1beta1.Container;
import com.google.api.services.container.v1beta1.ContainerScopes;
import com.google.api.services.container.v1beta1.model.Cluster;
import com.google.api.services.iam.v1.Iam;
import com.google.api.services.iam.v1.IamScopes;
import com.google.cloud.datastore.Datastore;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableList;
import com.google.common.io.Closer;
import com.google.common.util.concurrent.RateLimiter;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import com.spotify.apollo.AppInit;
import com.spotify.apollo.Environment;
import com.spotify.apollo.route.Route;
import com.spotify.metrics.core.SemanticMetricRegistry;
import com.spotify.styx.api.Api;
import com.spotify.styx.api.SchedulerResource;
import com.spotify.styx.docker.DockerRunner;
import com.spotify.styx.model.Event;
import com.spotify.styx.model.Resource;
import com.spotify.styx.model.SequenceEvent;
import com.spotify.styx.model.StyxConfig;
import com.spotify.styx.model.Workflow;
import com.spotify.styx.model.WorkflowId;
import com.spotify.styx.model.WorkflowInstance;
import com.spotify.styx.monitoring.MeteredDockerRunnerProxy;
import com.spotify.styx.monitoring.MeteredStorageProxy;
import com.spotify.styx.monitoring.MetricsStats;
import com.spotify.styx.monitoring.MonitoringHandler;
import com.spotify.styx.monitoring.Stats;
import com.spotify.styx.monitoring.StatsFactory;
import com.spotify.styx.publisher.Publisher;
import com.spotify.styx.state.OutputHandler;
import com.spotify.styx.state.QueuedStateManager;
import com.spotify.styx.state.RunState;
import com.spotify.styx.state.StateManager;
import com.spotify.styx.state.TimeoutConfig;
import com.spotify.styx.state.handlers.DockerRunnerHandler;
import com.spotify.styx.state.handlers.ExecutionDescriptionHandler;
import com.spotify.styx.state.handlers.PublisherHandler;
import com.spotify.styx.state.handlers.TerminationHandler;
import com.spotify.styx.state.handlers.TransitionLogger;
import com.spotify.styx.storage.AggregateStorage;
import com.spotify.styx.storage.InMemStorage;
import com.spotify.styx.storage.Storage;
import com.spotify.styx.util.CachedSupplier;
import com.spotify.styx.util.CounterSnapshotFactory;
import com.spotify.styx.util.Debug;
import com.spotify.styx.util.DockerImageValidator;
import com.spotify.styx.util.IsClosedException;
import com.spotify.styx.util.RetryUtil;
import com.spotify.styx.util.Shard;
import com.spotify.styx.util.ShardedCounter;
import com.spotify.styx.util.ShardedCounterSnapshotFactory;
import com.spotify.styx.util.StorageFactory;
import com.spotify.styx.util.Time;
import com.spotify.styx.util.TriggerUtil;
import com.spotify.styx.util.WorkflowValidator;
import com.typesafe.config.Config;
import eu.javaspecialists.tjsn.concurrency.stripedexecutor.StripedExecutorService;
import io.fabric8.kubernetes.client.ConfigBuilder;
import io.fabric8.kubernetes.client.DefaultKubernetesClient;
import io.fabric8.kubernetes.client.NamespacedKubernetesClient;
import java.io.Closeable;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.ThreadLocalRandom;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import org.apache.hadoop.hbase.client.Connection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class StyxScheduler implements AppInit {
public static final String SERVICE_NAME = "styx-scheduler";
public static final String GKE_CLUSTER_PATH = "styx.gke";
public static final String GKE_CLUSTER_PROJECT_ID = "project-id";
public static final String GKE_CLUSTER_ZONE = "cluster-zone";
public static final String GKE_CLUSTER_ID = "cluster-id";
public static final String GKE_CLUSTER_NAMESPACE = "namespace";
public static final String STYX_STALE_STATE_TTL_CONFIG = "styx.stale-state-ttls";
public static final String STYX_MODE = "styx.mode";
public static final String STYX_MODE_DEVELOPMENT = "development";
public static final String STYX_EVENT_PROCESSING_THREADS = "styx.event-processing-threads";
public static final String STYX_SCHEDULER_TICK_INTERVAL = "styx.scheduler.tick-interval";
public static final String STYX_TRIGGER_TICK_INTERVAL = "styx.trigger.tick-interval";
public static final int DEFAULT_STYX_EVENT_PROCESSING_THREADS = 32;
public static final Duration DEFAULT_SCHEDULER_TICK_INTERVAL = Duration.ofSeconds(2);
public static final Duration DEFAULT_TRIGGER_TICK_INTERVAL = Duration.ofSeconds(1);
public static final Duration CLEANER_TICK_INTERVAL = Duration.ofMinutes(30);
public static final Duration RUNTIME_CONFIG_UPDATE_INTERVAL = Duration.ofSeconds(5);
public static final Duration DEFAULT_RETRY_BASE_DELAY = Duration.ofMinutes(3);
public static final int DEFAULT_RETRY_MAX_EXPONENT = 4;
public static final Duration DEFAULT_RETRY_BASE_DELAY_BT = Duration.ofSeconds(1);
public static final RetryUtil DEFAULT_RETRY_UTIL =
new RetryUtil(DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_EXPONENT);
public static final double DEFAULT_SUBMISSION_RATE_PER_SEC = 1000D;
private static final Logger LOG = LoggerFactory.getLogger(StyxScheduler.class);
private final Time time;
private final StorageFactory storageFactory;
private final DockerRunnerFactory dockerRunnerFactory;
private final StatsFactory statsFactory;
private final ExecutorFactory executorFactory;
private final PublisherFactory publisherFactory;
private final RetryUtil retryUtil;
private final WorkflowResourceDecorator resourceDecorator;
private final EventConsumerFactory eventConsumerFactory;
private final WorkflowExecutionGateFactory executionGateFactory;
private StateManager stateManager;
private Scheduler scheduler;
private TriggerManager triggerManager;
private BackfillTriggerManager backfillTriggerManager;
// === Type aliases for dependency injectors ====================================================
public interface PublisherFactory extends Function<Environment, Publisher> { }
public interface EventConsumerFactory extends BiFunction<Environment, Stats, BiConsumer<SequenceEvent, RunState>> { }
public interface WorkflowExecutionGateFactory extends BiFunction<Environment, Storage, WorkflowExecutionGate> { }
@FunctionalInterface
interface DockerRunnerFactory {
DockerRunner create(
String id,
Environment environment,
StateManager stateManager,
ScheduledExecutorService scheduler,
Stats stats,
Debug debug);
}
@FunctionalInterface
interface ExecutorFactory {
ScheduledExecutorService create(
int threads,
ThreadFactory threadFactory);
}
public static class Builder {
private Time time = Instant::now;
private StorageFactory storageFactory = storage(StyxScheduler::storage);
private DockerRunnerFactory dockerRunnerFactory = StyxScheduler::createDockerRunner;
private StatsFactory statsFactory = StyxScheduler::stats;
private ExecutorFactory executorFactory = Executors::newScheduledThreadPool;
private PublisherFactory publisherFactory = (env) -> Publisher.NOOP;
private RetryUtil retryUtil = DEFAULT_RETRY_UTIL;
private WorkflowResourceDecorator resourceDecorator = WorkflowResourceDecorator.NOOP;
private EventConsumerFactory eventConsumerFactory = (env, stats) -> (event, state) -> { };
private WorkflowExecutionGateFactory executionGateFactory = (env, storage) -> WorkflowExecutionGate.NOOP;
public Builder setTime(Time time) {
this.time = time;
return this;
}
public Builder setStorageFactory(StorageFactory storageFactory) {
this.storageFactory = storageFactory;
return this;
}
public Builder setDockerRunnerFactory(DockerRunnerFactory dockerRunnerFactory) {
this.dockerRunnerFactory = dockerRunnerFactory;
return this;
}
public Builder setStatsFactory(StatsFactory statsFactory) {
this.statsFactory = statsFactory;
return this;
}
public Builder setExecutorFactory(ExecutorFactory executorFactory) {
this.executorFactory = executorFactory;
return this;
}
public Builder setPublisherFactory(PublisherFactory publisherFactory) {
this.publisherFactory = publisherFactory;
return this;
}
public Builder setRetryUtil(RetryUtil retryUtil) {
this.retryUtil = retryUtil;
return this;
}
public Builder setResourceDecorator(WorkflowResourceDecorator resourceDecorator) {
this.resourceDecorator = resourceDecorator;
return this;
}
public Builder setEventConsumerFactory(EventConsumerFactory eventConsumerFactory) {
this.eventConsumerFactory = eventConsumerFactory;
return this;
}
public Builder setExecutionGateFactory(WorkflowExecutionGateFactory executionGateFactory) {
this.executionGateFactory = executionGateFactory;
return this;
}
public StyxScheduler build() {
return new StyxScheduler(this);
}
}
public static Builder newBuilder() {
return new Builder();
}
public static StyxScheduler createDefault() {
return newBuilder().build();
}
// ==============================================================================================
private StyxScheduler(Builder builder) {
this.time = requireNonNull(builder.time);
this.storageFactory = requireNonNull(builder.storageFactory);
this.dockerRunnerFactory = requireNonNull(builder.dockerRunnerFactory);
this.statsFactory = requireNonNull(builder.statsFactory);
this.executorFactory = requireNonNull(builder.executorFactory);
this.publisherFactory = requireNonNull(builder.publisherFactory);
this.retryUtil = requireNonNull(builder.retryUtil);
this.resourceDecorator = requireNonNull(builder.resourceDecorator);
this.eventConsumerFactory = requireNonNull(builder.eventConsumerFactory);
this.executionGateFactory = requireNonNull(builder.executionGateFactory);
}
@Override
public void create(Environment environment) {
final Config config = environment.config();
final Closer closer = environment.closer();
final Thread.UncaughtExceptionHandler uncaughtExceptionHandler =
(thread, throwable) -> LOG.error("Thread {} threw {}", thread, throwable);
final ThreadFactory schedulerTf = new ThreadFactoryBuilder()
.setDaemon(true)
.setNameFormat("styx-scheduler-%d")
.setUncaughtExceptionHandler(uncaughtExceptionHandler)
.build();
final Publisher publisher = publisherFactory.apply(environment);
closer.register(publisher);
final ScheduledExecutorService executor = executorFactory.create(3, schedulerTf);
closer.register(executorCloser("scheduler", executor));
final StripedExecutorService eventProcessingExecutor = new StripedExecutorService(
optionalInt(config, STYX_EVENT_PROCESSING_THREADS).orElse(DEFAULT_STYX_EVENT_PROCESSING_THREADS));
closer.register(executorCloser("event-processing", eventProcessingExecutor));
final ExecutorService eventConsumerExecutor = Executors.newSingleThreadExecutor();
closer.register(executorCloser("event-consumer", eventConsumerExecutor));
final Stats stats = statsFactory.apply(environment);
final Storage storage = MeteredStorageProxy.instrument(storageFactory.apply(environment, stats), stats, time);
closer.register(storage);
final CounterSnapshotFactory counterSnapshotFactory = new ShardedCounterSnapshotFactory(storage);
final ShardedCounter shardedCounter = new ShardedCounter(storage, counterSnapshotFactory);
final Config staleStateTtlConfig = config.getConfig(STYX_STALE_STATE_TTL_CONFIG);
final TimeoutConfig timeoutConfig = TimeoutConfig.createFromConfig(staleStateTtlConfig);
final Supplier<Map<WorkflowId, Workflow>> workflowCache = new CachedSupplier<>(storage::workflows, time);
initializeResources(storage, shardedCounter, counterSnapshotFactory, timeoutConfig, workflowCache);
// TODO: hack to get around circular reference. Change OutputHandler.transitionInto() to
// take StateManager as argument instead?
final List<OutputHandler> outputHandlers = new ArrayList<>();
final QueuedStateManager stateManager = closer.register(
new QueuedStateManager(time, eventProcessingExecutor, storage,
eventConsumerFactory.apply(environment, stats), eventConsumerExecutor,
fanOutput(outputHandlers), shardedCounter));
final Supplier<StyxConfig> styxConfig = new CachedSupplier<>(storage::config, time);
final Supplier<String> dockerId = () -> styxConfig.get().globalDockerRunnerId();
final Debug debug = () -> styxConfig.get().debugEnabled();
final DockerRunner routingDockerRunner = DockerRunner.routing(
id -> dockerRunnerFactory.create(id, environment, stateManager, executor, stats, debug),
dockerId);
final DockerRunner dockerRunner = MeteredDockerRunnerProxy.instrument(routingDockerRunner, stats, time);
final RateLimiter dequeueRateLimiter = RateLimiter.create(DEFAULT_SUBMISSION_RATE_PER_SEC);
outputHandlers.addAll(ImmutableList.of(
new TransitionLogger(""),
new DockerRunnerHandler(
dockerRunner, stateManager),
new TerminationHandler(retryUtil, stateManager),
new MonitoringHandler(stats),
new PublisherHandler(publisher),
new ExecutionDescriptionHandler(storage, stateManager, new WorkflowValidator(new DockerImageValidator()))));
final TriggerListener trigger =
new StateInitializingTrigger(stateManager);
final TriggerManager triggerManager = new TriggerManager(trigger, time, storage, stats);
closer.register(triggerManager);
final BackfillTriggerManager backfillTriggerManager =
new BackfillTriggerManager(stateManager, storage, trigger, stats, time);
final Scheduler scheduler = new Scheduler(time, timeoutConfig, stateManager,
storage, resourceDecorator, stats, dequeueRateLimiter,
executionGateFactory.apply(environment, storage));
final Cleaner cleaner = new Cleaner(dockerRunner);
final Duration schedulerTickInterval = config.hasPath(STYX_SCHEDULER_TICK_INTERVAL)
? config.getDuration(STYX_SCHEDULER_TICK_INTERVAL)
: DEFAULT_SCHEDULER_TICK_INTERVAL;
final Duration triggerTickInterval = config.hasPath(STYX_TRIGGER_TICK_INTERVAL)
? config.getDuration(STYX_TRIGGER_TICK_INTERVAL)
: DEFAULT_TRIGGER_TICK_INTERVAL;
dockerRunner.restore();
startTriggerManager(triggerManager, executor, schedulerTickInterval);
startBackfillTriggerManager(backfillTriggerManager, executor, triggerTickInterval);
startScheduler(scheduler, executor, triggerTickInterval);
startRuntimeConfigUpdate(styxConfig, executor, dequeueRateLimiter);
startCleaner(cleaner, executor);
setupMetrics(stateManager, workflowCache, storage, dequeueRateLimiter, stats);
final SchedulerResource schedulerResource =
new SchedulerResource(stateManager, trigger, storage, time,
new WorkflowValidator(new DockerImageValidator()));
environment.routingEngine()
.registerAutoRoute(Route.sync("GET", "/ping", rc -> "pong"))
.registerRoutes(Api.withCommonMiddleware(schedulerResource.routes()));
this.stateManager = stateManager;
this.scheduler = scheduler;
this.triggerManager = triggerManager;
this.backfillTriggerManager = backfillTriggerManager;
}
@VisibleForTesting
CompletionStage<Void> receive(Event event) throws IsClosedException {
return stateManager.receive(event);
}
@VisibleForTesting
Optional<RunState> getState(WorkflowInstance workflowInstance) {
return stateManager.getActiveState(workflowInstance);
}
@VisibleForTesting
void tickScheduler() {
scheduler.tick();
}
@VisibleForTesting
void tickTriggerManager() {
triggerManager.tick();
}
@VisibleForTesting
void tickBackfillTriggerManager() {
backfillTriggerManager.tick();
}
private void initializeResources(Storage storage, ShardedCounter shardedCounter,
CounterSnapshotFactory counterSnapshotFactory,
TimeoutConfig timeoutConfig,
Supplier<Map<WorkflowId, Workflow>> workflowCache) {
try {
// Initialize resources
storage.resources().parallelStream().forEach(
resource -> {
counterSnapshotFactory.create(resource.id());
try {
storage.runInTransaction(tx -> {
shardedCounter.updateLimit(tx, resource.id(), resource.concurrency());
return null;
});
} catch (IOException e) {
LOG.error("Error creating a counter limit for {}", resource, e);
throw new RuntimeException(e);
}
});
LOG.info("Finished initializing resources");
// Sync resources usage
if (storage.config().resourcesSyncEnabled()) {
// first we reset all shards for each resource
storage.resources().parallelStream().forEach(resource -> resetShards(storage, resource));
// then we update shards with actual usage
try {
final Map<String, Long> resourcesUsageMap = getResourcesUsageMap(storage, timeoutConfig,
workflowCache, time.get(), resourceDecorator);
updateShards(storage, resourcesUsageMap);
} catch (Exception e) {
LOG.error("Error syncing resources", e);
throw new RuntimeException(e);
}
LOG.info("Finished syncing resources");
}
} catch (IOException e) {
LOG.error("Error while initializing/syncing resources", e);
throw new RuntimeException(e);
}
}
@VisibleForTesting
void resetShards(final Storage storage, final Resource resource) {
LOG.info("Resetting shards of resource {}", resource.id());
for (int i = 0; i < NUM_SHARDS; i++) {
final int index = i;
try {
storage.runInTransaction(tx -> {
tx.store(Shard.create(resource.id(), index, 0));
return null;
});
} catch (IOException e) {
LOG.error("Error resetting shards of resource {}", resource, e);
throw new RuntimeException(e);
}
}
}
/**
* For each resource, distribute usage value evenly across shards.
* For example, with a usage value of 10 and 3 available shards, the latter will be set to:
* Shard 1 = 4
* Shard 2 = 3
* Shard 3 = 3
*/
@VisibleForTesting
void updateShards(final Storage storage,
final Map<String, Long> resourceUsage) {
resourceUsage.entrySet().parallelStream().forEach(entity -> {
final String resource = entity.getKey();
final Long usage = entity.getValue();
LOG.info("Syncing {} -> {}", resource, usage);
try {
for (int i = 0; i < NUM_SHARDS; i++) {
final int index = i;
final int shardValue = (int) (usage / NUM_SHARDS + (index < usage % NUM_SHARDS ? 1 : 0));
storage.runInTransaction(tx -> {
tx.store(Shard.create(resource, index, shardValue));
return null;
});
LOG.info("Stored {}#shard-{} -> {}", resource, index, shardValue);
}
} catch (IOException e) {
LOG.error("Error syncing resource: {}", resource, e);
throw new RuntimeException(e);
}
});
}
private static void startCleaner(Cleaner cleaner, ScheduledExecutorService exec) {
scheduleWithJitter(cleaner::tick, exec, CLEANER_TICK_INTERVAL);
}
private static void startTriggerManager(TriggerManager triggerManager, ScheduledExecutorService exec,
Duration tickInterval) {
scheduleWithJitter(triggerManager::tick, exec, tickInterval);
}
private static void startBackfillTriggerManager(BackfillTriggerManager backfillTriggerManager,
ScheduledExecutorService exec, Duration tickInterval) {
scheduleWithJitter(backfillTriggerManager::tick, exec, tickInterval);
}
private static void startScheduler(Scheduler scheduler, ScheduledExecutorService exec, Duration tickInterval) {
scheduleWithJitter(scheduler::tick, exec, tickInterval);
}
private static void startRuntimeConfigUpdate(Supplier<StyxConfig> config, ScheduledExecutorService exec,
RateLimiter submissionRateLimiter) {
scheduleWithJitter(() -> updateRuntimeConfig(config, submissionRateLimiter), exec, RUNTIME_CONFIG_UPDATE_INTERVAL);
}
private static void updateRuntimeConfig(Supplier<StyxConfig> config, RateLimiter rateLimiter) {
try {
double currentRate = rateLimiter.getRate();
Double updatedRate = config.get().submissionRateLimit().orElse(
StyxScheduler.DEFAULT_SUBMISSION_RATE_PER_SEC);
if (Math.abs(updatedRate - currentRate) >= 0.1) {
LOG.info("Updating submission rate limit: {} -> {}", currentRate, updatedRate);
rateLimiter.setRate(updatedRate);
}
} catch (Exception e) {
LOG.warn("Failed to fetch the submission rate config from storage, "
+ "skipping RateLimiter update", e);
}
}
private static void scheduleWithJitter(Runnable runnable, ScheduledExecutorService exec, Duration tickInterval) {
final double jitter = ThreadLocalRandom.current().nextDouble(0.5, 1.5);
final long delayMillis = (long) (jitter * tickInterval.toMillis());
exec.schedule(() -> {
runGuarded(runnable);
scheduleWithJitter(runnable, exec, tickInterval);
}, delayMillis, MILLISECONDS);
}
private void setupMetrics(
QueuedStateManager stateManager,
Supplier<Map<WorkflowId, Workflow>> workflowCache,
Storage storage,
RateLimiter submissionRateLimiter,
Stats stats) {
stats.registerQueuedEventsMetric(stateManager::queuedEvents);
stats.registerWorkflowCountMetric("all", () -> (long) workflowCache.get().size());
stats.registerWorkflowCountMetric("configured", () -> workflowCache.get().values()
.stream()
.filter(workflow -> workflow.configuration().dockerImage().isPresent())
.count());
final Supplier<Gauge<Long>> configuredEnabledWorkflowsCountGaugeSupplier = () -> {
final Supplier<Set<WorkflowId>> enabledWorkflowSupplier =
new CachedSupplier<>(storage::enabled, Instant::now);
return () -> workflowCache.get().values()
.stream()
.filter(workflow -> workflow.configuration().dockerImage().isPresent())
.filter(workflow -> enabledWorkflowSupplier.get().contains(WorkflowId.ofWorkflow(workflow)))
.count();
};
stats.registerWorkflowCountMetric("enabled", configuredEnabledWorkflowsCountGaugeSupplier.get());
stats.registerWorkflowCountMetric("docker_termination_logging_enabled", () ->
workflowCache.get().values()
.stream()
.filter(workflow -> workflow.configuration().dockerImage().isPresent())
.filter(workflow -> workflow.configuration().dockerTerminationLogging())
.count());
Arrays.stream(RunState.State.values()).forEach(state -> {
TriggerUtil.triggerTypesList().forEach(triggerType ->
stats.registerActiveStatesMetric(
state,
triggerType,
() -> stateManager.getActiveStates().values().stream()
.filter(runState -> runState.state().equals(state))
.filter(runState -> runState.data().trigger().isPresent() && triggerType
.equals(TriggerUtil.triggerType(runState.data().trigger().get())))
.count()));
stats.registerActiveStatesMetric(
state,
"none",
() -> stateManager.getActiveStates().values().stream()
.filter(runState -> runState.state().equals(state))
.filter(runState -> !runState.data().trigger().isPresent())
.count());
});
stats.registerSubmissionRateLimitMetric(submissionRateLimiter::getRate);
}
private static Stats stats(Environment environment) {
return new MetricsStats(environment.resolve(SemanticMetricRegistry.class), Instant::now);
}
private static StorageFactory storage(StorageFactory storage) {
return (environment, stats) -> {
if (isDevMode(environment.config())) {
LOG.info("Running Styx in development mode, will use InMemStorage");
return new InMemStorage();
} else {
return storage.apply(environment, stats);
}
};
}
private static AggregateStorage storage(Environment environment, Stats stats ) {
final Config config = environment.config();
final Closer closer = environment.closer();
final Connection bigTable = closer.register(createBigTableConnection(config));
final Datastore datastore = createDatastore(config, stats);
return new AggregateStorage(bigTable, datastore, DEFAULT_RETRY_BASE_DELAY_BT);
}
private static DockerRunner createDockerRunner(
String id,
Environment environment,
StateManager stateManager,
ScheduledExecutorService scheduler,
Stats stats,
Debug debug) {
final Config config = environment.config();
final Closer closer = environment.closer();
if (isDevMode(config)) {
LOG.info("Creating LocalDockerRunner");
return closer.register(DockerRunner.local(scheduler, stateManager));
} else {
final NamespacedKubernetesClient kubernetes = closer.register(getKubernetesClient(
config, id, createGkeClient(), DefaultKubernetesClient::new));
final ServiceAccountKeyManager serviceAccountKeyManager = createServiceAccountKeyManager();
return closer.register(DockerRunner.kubernetes(kubernetes, stateManager, stats,
serviceAccountKeyManager, debug));
}
}
private static Container createGkeClient() {
try {
final HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
final JsonFactory jsonFactory = Utils.getDefaultJsonFactory();
final GoogleCredential credential =
GoogleCredential.getApplicationDefault(httpTransport, jsonFactory)
.createScoped(ContainerScopes.all());
return new Container.Builder(httpTransport, jsonFactory, credential)
.setApplicationName(SERVICE_NAME)
.build();
} catch (GeneralSecurityException | IOException e) {
throw new RuntimeException(e);
}
}
private static ServiceAccountKeyManager createServiceAccountKeyManager() {
try {
final HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
final JsonFactory jsonFactory = Utils.getDefaultJsonFactory();
final GoogleCredential credential = GoogleCredential
.getApplicationDefault(httpTransport, jsonFactory)
.createScoped(IamScopes.all());
final Iam iam = new Iam.Builder(
httpTransport, jsonFactory, credential)
.setApplicationName(SERVICE_NAME)
.build();
return new ServiceAccountKeyManager(iam);
} catch (GeneralSecurityException | IOException e) {
throw new RuntimeException(e);
}
}
static NamespacedKubernetesClient getKubernetesClient(Config rootConfig, String id,
Container gke, KubernetesClientFactory clientFactory) {
try {
final Config config = rootConfig
.getConfig(GKE_CLUSTER_PATH)
.getConfig(id);
final Cluster cluster = gke.projects().locations().clusters()
.get(String.format("projects/%s/locations/%s/clusters/%s",
config.getString(GKE_CLUSTER_PROJECT_ID),
config.getString(GKE_CLUSTER_ZONE),
config.getString(GKE_CLUSTER_ID))).execute();
final io.fabric8.kubernetes.client.Config kubeConfig = new ConfigBuilder()
.withMasterUrl("https://" + cluster.getEndpoint())
.withCaCertData(cluster.getMasterAuth().getClusterCaCertificate())
.withClientCertData(cluster.getMasterAuth().getClientCertificate())
.withClientKeyData(cluster.getMasterAuth().getClientKey())
.withNamespace(config.getString(GKE_CLUSTER_NAMESPACE))
.build();
return clientFactory.apply(kubeConfig);
} catch (IOException e) {
throw Throwables.propagate(e);
}
}
private static Closeable executorCloser(String name, ExecutorService executor) {
return () -> {
LOG.info("Shutting down executor: {}", name);
executor.shutdown();
try {
executor.awaitTermination(1, SECONDS);
} catch (InterruptedException ignored) {
}
final List<Runnable> runnables = executor.shutdownNow();
if (!runnables.isEmpty()) {
LOG.warn("{} task(s) in {} did not execute", runnables.size(), name);
}
};
}
private static boolean isDevMode(Config config) {
return STYX_MODE_DEVELOPMENT.equals(config.getString(STYX_MODE));
}
interface KubernetesClientFactory
extends Function<io.fabric8.kubernetes.client.Config, NamespacedKubernetesClient> { }
}
| styx-scheduler-service/src/main/java/com/spotify/styx/StyxScheduler.java | /*-
* -\-\-
* Spotify Styx Scheduler Service
* --
* Copyright (C) 2016 Spotify 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 com.spotify.styx;
import static com.spotify.apollo.environment.ConfigUtil.optionalInt;
import static com.spotify.styx.state.OutputHandler.fanOutput;
import static com.spotify.styx.state.StateUtil.getResourcesUsageMap;
import static com.spotify.styx.util.Connections.createBigTableConnection;
import static com.spotify.styx.util.Connections.createDatastore;
import static com.spotify.styx.util.GuardedRunnable.runGuarded;
import static com.spotify.styx.util.ShardedCounter.NUM_SHARDS;
import static java.util.Objects.requireNonNull;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;
import com.codahale.metrics.Gauge;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.googleapis.util.Utils;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.services.container.v1beta1.Container;
import com.google.api.services.container.v1beta1.ContainerScopes;
import com.google.api.services.container.v1beta1.model.Cluster;
import com.google.api.services.iam.v1.Iam;
import com.google.api.services.iam.v1.IamScopes;
import com.google.cloud.datastore.Datastore;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Throwables;
import com.google.common.collect.ImmutableList;
import com.google.common.io.Closer;
import com.google.common.util.concurrent.RateLimiter;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import com.spotify.apollo.AppInit;
import com.spotify.apollo.Environment;
import com.spotify.apollo.route.Route;
import com.spotify.metrics.core.SemanticMetricRegistry;
import com.spotify.styx.api.Api;
import com.spotify.styx.api.SchedulerResource;
import com.spotify.styx.docker.DockerRunner;
import com.spotify.styx.model.Event;
import com.spotify.styx.model.Resource;
import com.spotify.styx.model.SequenceEvent;
import com.spotify.styx.model.StyxConfig;
import com.spotify.styx.model.Workflow;
import com.spotify.styx.model.WorkflowId;
import com.spotify.styx.model.WorkflowInstance;
import com.spotify.styx.monitoring.MeteredDockerRunnerProxy;
import com.spotify.styx.monitoring.MeteredStorageProxy;
import com.spotify.styx.monitoring.MetricsStats;
import com.spotify.styx.monitoring.MonitoringHandler;
import com.spotify.styx.monitoring.Stats;
import com.spotify.styx.monitoring.StatsFactory;
import com.spotify.styx.publisher.Publisher;
import com.spotify.styx.state.OutputHandler;
import com.spotify.styx.state.QueuedStateManager;
import com.spotify.styx.state.RunState;
import com.spotify.styx.state.StateManager;
import com.spotify.styx.state.TimeoutConfig;
import com.spotify.styx.state.handlers.DockerRunnerHandler;
import com.spotify.styx.state.handlers.ExecutionDescriptionHandler;
import com.spotify.styx.state.handlers.PublisherHandler;
import com.spotify.styx.state.handlers.TerminationHandler;
import com.spotify.styx.state.handlers.TransitionLogger;
import com.spotify.styx.storage.AggregateStorage;
import com.spotify.styx.storage.InMemStorage;
import com.spotify.styx.storage.Storage;
import com.spotify.styx.util.CachedSupplier;
import com.spotify.styx.util.CounterSnapshotFactory;
import com.spotify.styx.util.Debug;
import com.spotify.styx.util.DockerImageValidator;
import com.spotify.styx.util.IsClosedException;
import com.spotify.styx.util.RetryUtil;
import com.spotify.styx.util.Shard;
import com.spotify.styx.util.ShardedCounter;
import com.spotify.styx.util.ShardedCounterSnapshotFactory;
import com.spotify.styx.util.StorageFactory;
import com.spotify.styx.util.Time;
import com.spotify.styx.util.TriggerUtil;
import com.spotify.styx.util.WorkflowValidator;
import com.typesafe.config.Config;
import eu.javaspecialists.tjsn.concurrency.stripedexecutor.StripedExecutorService;
import io.fabric8.kubernetes.client.ConfigBuilder;
import io.fabric8.kubernetes.client.DefaultKubernetesClient;
import io.fabric8.kubernetes.client.NamespacedKubernetesClient;
import java.io.Closeable;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.ThreadLocalRandom;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import org.apache.hadoop.hbase.client.Connection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class StyxScheduler implements AppInit {
public static final String SERVICE_NAME = "styx-scheduler";
public static final String GKE_CLUSTER_PATH = "styx.gke";
public static final String GKE_CLUSTER_PROJECT_ID = "project-id";
public static final String GKE_CLUSTER_ZONE = "cluster-zone";
public static final String GKE_CLUSTER_ID = "cluster-id";
public static final String GKE_CLUSTER_NAMESPACE = "namespace";
public static final String STYX_STALE_STATE_TTL_CONFIG = "styx.stale-state-ttls";
public static final String STYX_MODE = "styx.mode";
public static final String STYX_MODE_DEVELOPMENT = "development";
public static final String STYX_EVENT_PROCESSING_THREADS = "styx.event-processing-threads";
public static final String STYX_SCHEDULER_TICK_INTERVAL = "styx.scheduler.tick-interval";
public static final String STYX_TRIGGER_TICK_INTERVAL = "styx.trigger.tick-interval";
public static final int DEFAULT_STYX_EVENT_PROCESSING_THREADS = 32;
public static final Duration DEFAULT_SCHEDULER_TICK_INTERVAL = Duration.ofSeconds(2);
public static final Duration DEFAULT_TRIGGER_MANAGER_TICK_INTERVAL = Duration.ofSeconds(1);
public static final Duration CLEANER_TICK_INTERVAL = Duration.ofMinutes(30);
public static final Duration RUNTIME_CONFIG_UPDATE_INTERVAL = Duration.ofSeconds(5);
public static final Duration DEFAULT_RETRY_BASE_DELAY = Duration.ofMinutes(3);
public static final int DEFAULT_RETRY_MAX_EXPONENT = 4;
public static final Duration DEFAULT_RETRY_BASE_DELAY_BT = Duration.ofSeconds(1);
public static final RetryUtil DEFAULT_RETRY_UTIL =
new RetryUtil(DEFAULT_RETRY_BASE_DELAY, DEFAULT_RETRY_MAX_EXPONENT);
public static final double DEFAULT_SUBMISSION_RATE_PER_SEC = 1000D;
private static final Logger LOG = LoggerFactory.getLogger(StyxScheduler.class);
private final Time time;
private final StorageFactory storageFactory;
private final DockerRunnerFactory dockerRunnerFactory;
private final StatsFactory statsFactory;
private final ExecutorFactory executorFactory;
private final PublisherFactory publisherFactory;
private final RetryUtil retryUtil;
private final WorkflowResourceDecorator resourceDecorator;
private final EventConsumerFactory eventConsumerFactory;
private final WorkflowExecutionGateFactory executionGateFactory;
private StateManager stateManager;
private Scheduler scheduler;
private TriggerManager triggerManager;
private BackfillTriggerManager backfillTriggerManager;
// === Type aliases for dependency injectors ====================================================
public interface PublisherFactory extends Function<Environment, Publisher> { }
public interface EventConsumerFactory extends BiFunction<Environment, Stats, BiConsumer<SequenceEvent, RunState>> { }
public interface WorkflowExecutionGateFactory extends BiFunction<Environment, Storage, WorkflowExecutionGate> { }
@FunctionalInterface
interface DockerRunnerFactory {
DockerRunner create(
String id,
Environment environment,
StateManager stateManager,
ScheduledExecutorService scheduler,
Stats stats,
Debug debug);
}
@FunctionalInterface
interface ExecutorFactory {
ScheduledExecutorService create(
int threads,
ThreadFactory threadFactory);
}
public static class Builder {
private Time time = Instant::now;
private StorageFactory storageFactory = storage(StyxScheduler::storage);
private DockerRunnerFactory dockerRunnerFactory = StyxScheduler::createDockerRunner;
private StatsFactory statsFactory = StyxScheduler::stats;
private ExecutorFactory executorFactory = Executors::newScheduledThreadPool;
private PublisherFactory publisherFactory = (env) -> Publisher.NOOP;
private RetryUtil retryUtil = DEFAULT_RETRY_UTIL;
private WorkflowResourceDecorator resourceDecorator = WorkflowResourceDecorator.NOOP;
private EventConsumerFactory eventConsumerFactory = (env, stats) -> (event, state) -> { };
private WorkflowExecutionGateFactory executionGateFactory = (env, storage) -> WorkflowExecutionGate.NOOP;
public Builder setTime(Time time) {
this.time = time;
return this;
}
public Builder setStorageFactory(StorageFactory storageFactory) {
this.storageFactory = storageFactory;
return this;
}
public Builder setDockerRunnerFactory(DockerRunnerFactory dockerRunnerFactory) {
this.dockerRunnerFactory = dockerRunnerFactory;
return this;
}
public Builder setStatsFactory(StatsFactory statsFactory) {
this.statsFactory = statsFactory;
return this;
}
public Builder setExecutorFactory(ExecutorFactory executorFactory) {
this.executorFactory = executorFactory;
return this;
}
public Builder setPublisherFactory(PublisherFactory publisherFactory) {
this.publisherFactory = publisherFactory;
return this;
}
public Builder setRetryUtil(RetryUtil retryUtil) {
this.retryUtil = retryUtil;
return this;
}
public Builder setResourceDecorator(WorkflowResourceDecorator resourceDecorator) {
this.resourceDecorator = resourceDecorator;
return this;
}
public Builder setEventConsumerFactory(EventConsumerFactory eventConsumerFactory) {
this.eventConsumerFactory = eventConsumerFactory;
return this;
}
public Builder setExecutionGateFactory(WorkflowExecutionGateFactory executionGateFactory) {
this.executionGateFactory = executionGateFactory;
return this;
}
public StyxScheduler build() {
return new StyxScheduler(this);
}
}
public static Builder newBuilder() {
return new Builder();
}
public static StyxScheduler createDefault() {
return newBuilder().build();
}
// ==============================================================================================
private StyxScheduler(Builder builder) {
this.time = requireNonNull(builder.time);
this.storageFactory = requireNonNull(builder.storageFactory);
this.dockerRunnerFactory = requireNonNull(builder.dockerRunnerFactory);
this.statsFactory = requireNonNull(builder.statsFactory);
this.executorFactory = requireNonNull(builder.executorFactory);
this.publisherFactory = requireNonNull(builder.publisherFactory);
this.retryUtil = requireNonNull(builder.retryUtil);
this.resourceDecorator = requireNonNull(builder.resourceDecorator);
this.eventConsumerFactory = requireNonNull(builder.eventConsumerFactory);
this.executionGateFactory = requireNonNull(builder.executionGateFactory);
}
@Override
public void create(Environment environment) {
final Config config = environment.config();
final Closer closer = environment.closer();
final Thread.UncaughtExceptionHandler uncaughtExceptionHandler =
(thread, throwable) -> LOG.error("Thread {} threw {}", thread, throwable);
final ThreadFactory schedulerTf = new ThreadFactoryBuilder()
.setDaemon(true)
.setNameFormat("styx-scheduler-%d")
.setUncaughtExceptionHandler(uncaughtExceptionHandler)
.build();
final Publisher publisher = publisherFactory.apply(environment);
closer.register(publisher);
final ScheduledExecutorService executor = executorFactory.create(3, schedulerTf);
closer.register(executorCloser("scheduler", executor));
final StripedExecutorService eventProcessingExecutor = new StripedExecutorService(
optionalInt(config, STYX_EVENT_PROCESSING_THREADS).orElse(DEFAULT_STYX_EVENT_PROCESSING_THREADS));
closer.register(executorCloser("event-processing", eventProcessingExecutor));
final ExecutorService eventConsumerExecutor = Executors.newSingleThreadExecutor();
closer.register(executorCloser("event-consumer", eventConsumerExecutor));
final Stats stats = statsFactory.apply(environment);
final Storage storage = MeteredStorageProxy.instrument(storageFactory.apply(environment, stats), stats, time);
closer.register(storage);
final CounterSnapshotFactory counterSnapshotFactory = new ShardedCounterSnapshotFactory(storage);
final ShardedCounter shardedCounter = new ShardedCounter(storage, counterSnapshotFactory);
final Config staleStateTtlConfig = config.getConfig(STYX_STALE_STATE_TTL_CONFIG);
final TimeoutConfig timeoutConfig = TimeoutConfig.createFromConfig(staleStateTtlConfig);
final Supplier<Map<WorkflowId, Workflow>> workflowCache = new CachedSupplier<>(storage::workflows, time);
initializeResources(storage, shardedCounter, counterSnapshotFactory, timeoutConfig, workflowCache);
// TODO: hack to get around circular reference. Change OutputHandler.transitionInto() to
// take StateManager as argument instead?
final List<OutputHandler> outputHandlers = new ArrayList<>();
final QueuedStateManager stateManager = closer.register(
new QueuedStateManager(time, eventProcessingExecutor, storage,
eventConsumerFactory.apply(environment, stats), eventConsumerExecutor,
fanOutput(outputHandlers), shardedCounter));
final Supplier<StyxConfig> styxConfig = new CachedSupplier<>(storage::config, time);
final Supplier<String> dockerId = () -> styxConfig.get().globalDockerRunnerId();
final Debug debug = () -> styxConfig.get().debugEnabled();
final DockerRunner routingDockerRunner = DockerRunner.routing(
id -> dockerRunnerFactory.create(id, environment, stateManager, executor, stats, debug),
dockerId);
final DockerRunner dockerRunner = MeteredDockerRunnerProxy.instrument(routingDockerRunner, stats, time);
final RateLimiter dequeueRateLimiter = RateLimiter.create(DEFAULT_SUBMISSION_RATE_PER_SEC);
outputHandlers.addAll(ImmutableList.of(
new TransitionLogger(""),
new DockerRunnerHandler(
dockerRunner, stateManager),
new TerminationHandler(retryUtil, stateManager),
new MonitoringHandler(stats),
new PublisherHandler(publisher),
new ExecutionDescriptionHandler(storage, stateManager, new WorkflowValidator(new DockerImageValidator()))));
final TriggerListener trigger =
new StateInitializingTrigger(stateManager);
final TriggerManager triggerManager = new TriggerManager(trigger, time, storage, stats);
closer.register(triggerManager);
final BackfillTriggerManager backfillTriggerManager =
new BackfillTriggerManager(stateManager, storage, trigger, stats, time);
final Scheduler scheduler = new Scheduler(time, timeoutConfig, stateManager,
storage, resourceDecorator, stats, dequeueRateLimiter,
executionGateFactory.apply(environment, storage));
final Cleaner cleaner = new Cleaner(dockerRunner);
final Duration schedulerTickInterval = config.hasPath(STYX_SCHEDULER_TICK_INTERVAL)
? config.getDuration(STYX_SCHEDULER_TICK_INTERVAL)
: DEFAULT_SCHEDULER_TICK_INTERVAL;
final Duration triggerTickInterval = config.hasPath(STYX_TRIGGER_TICK_INTERVAL)
? config.getDuration(STYX_TRIGGER_TICK_INTERVAL)
: DEFAULT_TRIGGER_MANAGER_TICK_INTERVAL;
dockerRunner.restore();
startTriggerManager(triggerManager, executor, schedulerTickInterval);
startBackfillTriggerManager(backfillTriggerManager, executor, triggerTickInterval);
startScheduler(scheduler, executor, triggerTickInterval);
startRuntimeConfigUpdate(styxConfig, executor, dequeueRateLimiter);
startCleaner(cleaner, executor);
setupMetrics(stateManager, workflowCache, storage, dequeueRateLimiter, stats);
final SchedulerResource schedulerResource =
new SchedulerResource(stateManager, trigger, storage, time,
new WorkflowValidator(new DockerImageValidator()));
environment.routingEngine()
.registerAutoRoute(Route.sync("GET", "/ping", rc -> "pong"))
.registerRoutes(Api.withCommonMiddleware(schedulerResource.routes()));
this.stateManager = stateManager;
this.scheduler = scheduler;
this.triggerManager = triggerManager;
this.backfillTriggerManager = backfillTriggerManager;
}
@VisibleForTesting
CompletionStage<Void> receive(Event event) throws IsClosedException {
return stateManager.receive(event);
}
@VisibleForTesting
Optional<RunState> getState(WorkflowInstance workflowInstance) {
return stateManager.getActiveState(workflowInstance);
}
@VisibleForTesting
void tickScheduler() {
scheduler.tick();
}
@VisibleForTesting
void tickTriggerManager() {
triggerManager.tick();
}
@VisibleForTesting
void tickBackfillTriggerManager() {
backfillTriggerManager.tick();
}
private void initializeResources(Storage storage, ShardedCounter shardedCounter,
CounterSnapshotFactory counterSnapshotFactory,
TimeoutConfig timeoutConfig,
Supplier<Map<WorkflowId, Workflow>> workflowCache) {
try {
// Initialize resources
storage.resources().parallelStream().forEach(
resource -> {
counterSnapshotFactory.create(resource.id());
try {
storage.runInTransaction(tx -> {
shardedCounter.updateLimit(tx, resource.id(), resource.concurrency());
return null;
});
} catch (IOException e) {
LOG.error("Error creating a counter limit for {}", resource, e);
throw new RuntimeException(e);
}
});
LOG.info("Finished initializing resources");
// Sync resources usage
if (storage.config().resourcesSyncEnabled()) {
// first we reset all shards for each resource
storage.resources().parallelStream().forEach(resource -> resetShards(storage, resource));
// then we update shards with actual usage
try {
final Map<String, Long> resourcesUsageMap = getResourcesUsageMap(storage, timeoutConfig,
workflowCache, time.get(), resourceDecorator);
updateShards(storage, resourcesUsageMap);
} catch (Exception e) {
LOG.error("Error syncing resources", e);
throw new RuntimeException(e);
}
LOG.info("Finished syncing resources");
}
} catch (IOException e) {
LOG.error("Error while initializing/syncing resources", e);
throw new RuntimeException(e);
}
}
@VisibleForTesting
void resetShards(final Storage storage, final Resource resource) {
LOG.info("Resetting shards of resource {}", resource.id());
for (int i = 0; i < NUM_SHARDS; i++) {
final int index = i;
try {
storage.runInTransaction(tx -> {
tx.store(Shard.create(resource.id(), index, 0));
return null;
});
} catch (IOException e) {
LOG.error("Error resetting shards of resource {}", resource, e);
throw new RuntimeException(e);
}
}
}
/**
* For each resource, distribute usage value evenly across shards.
* For example, with a usage value of 10 and 3 available shards, the latter will be set to:
* Shard 1 = 4
* Shard 2 = 3
* Shard 3 = 3
*/
@VisibleForTesting
void updateShards(final Storage storage,
final Map<String, Long> resourceUsage) {
resourceUsage.entrySet().parallelStream().forEach(entity -> {
final String resource = entity.getKey();
final Long usage = entity.getValue();
LOG.info("Syncing {} -> {}", resource, usage);
try {
for (int i = 0; i < NUM_SHARDS; i++) {
final int index = i;
final int shardValue = (int) (usage / NUM_SHARDS + (index < usage % NUM_SHARDS ? 1 : 0));
storage.runInTransaction(tx -> {
tx.store(Shard.create(resource, index, shardValue));
return null;
});
LOG.info("Stored {}#shard-{} -> {}", resource, index, shardValue);
}
} catch (IOException e) {
LOG.error("Error syncing resource: {}", resource, e);
throw new RuntimeException(e);
}
});
}
private static void startCleaner(Cleaner cleaner, ScheduledExecutorService exec) {
scheduleWithJitter(cleaner::tick, exec, CLEANER_TICK_INTERVAL);
}
private static void startTriggerManager(TriggerManager triggerManager, ScheduledExecutorService exec,
Duration tickInterval) {
scheduleWithJitter(triggerManager::tick, exec, tickInterval);
}
private static void startBackfillTriggerManager(BackfillTriggerManager backfillTriggerManager,
ScheduledExecutorService exec, Duration tickInterval) {
scheduleWithJitter(backfillTriggerManager::tick, exec, tickInterval);
}
private static void startScheduler(Scheduler scheduler, ScheduledExecutorService exec, Duration tickInterval) {
scheduleWithJitter(scheduler::tick, exec, tickInterval);
}
private static void startRuntimeConfigUpdate(Supplier<StyxConfig> config, ScheduledExecutorService exec,
RateLimiter submissionRateLimiter) {
scheduleWithJitter(() -> updateRuntimeConfig(config, submissionRateLimiter), exec, RUNTIME_CONFIG_UPDATE_INTERVAL);
}
private static void updateRuntimeConfig(Supplier<StyxConfig> config, RateLimiter rateLimiter) {
try {
double currentRate = rateLimiter.getRate();
Double updatedRate = config.get().submissionRateLimit().orElse(
StyxScheduler.DEFAULT_SUBMISSION_RATE_PER_SEC);
if (Math.abs(updatedRate - currentRate) >= 0.1) {
LOG.info("Updating submission rate limit: {} -> {}", currentRate, updatedRate);
rateLimiter.setRate(updatedRate);
}
} catch (Exception e) {
LOG.warn("Failed to fetch the submission rate config from storage, "
+ "skipping RateLimiter update", e);
}
}
private static void scheduleWithJitter(Runnable runnable, ScheduledExecutorService exec, Duration tickInterval) {
final double jitter = ThreadLocalRandom.current().nextDouble(0.5, 1.5);
final long delayMillis = (long) (jitter * tickInterval.toMillis());
exec.schedule(() -> {
runGuarded(runnable);
scheduleWithJitter(runnable, exec, tickInterval);
}, delayMillis, MILLISECONDS);
}
private void setupMetrics(
QueuedStateManager stateManager,
Supplier<Map<WorkflowId, Workflow>> workflowCache,
Storage storage,
RateLimiter submissionRateLimiter,
Stats stats) {
stats.registerQueuedEventsMetric(stateManager::queuedEvents);
stats.registerWorkflowCountMetric("all", () -> (long) workflowCache.get().size());
stats.registerWorkflowCountMetric("configured", () -> workflowCache.get().values()
.stream()
.filter(workflow -> workflow.configuration().dockerImage().isPresent())
.count());
final Supplier<Gauge<Long>> configuredEnabledWorkflowsCountGaugeSupplier = () -> {
final Supplier<Set<WorkflowId>> enabledWorkflowSupplier =
new CachedSupplier<>(storage::enabled, Instant::now);
return () -> workflowCache.get().values()
.stream()
.filter(workflow -> workflow.configuration().dockerImage().isPresent())
.filter(workflow -> enabledWorkflowSupplier.get().contains(WorkflowId.ofWorkflow(workflow)))
.count();
};
stats.registerWorkflowCountMetric("enabled", configuredEnabledWorkflowsCountGaugeSupplier.get());
stats.registerWorkflowCountMetric("docker_termination_logging_enabled", () ->
workflowCache.get().values()
.stream()
.filter(workflow -> workflow.configuration().dockerImage().isPresent())
.filter(workflow -> workflow.configuration().dockerTerminationLogging())
.count());
Arrays.stream(RunState.State.values()).forEach(state -> {
TriggerUtil.triggerTypesList().forEach(triggerType ->
stats.registerActiveStatesMetric(
state,
triggerType,
() -> stateManager.getActiveStates().values().stream()
.filter(runState -> runState.state().equals(state))
.filter(runState -> runState.data().trigger().isPresent() && triggerType
.equals(TriggerUtil.triggerType(runState.data().trigger().get())))
.count()));
stats.registerActiveStatesMetric(
state,
"none",
() -> stateManager.getActiveStates().values().stream()
.filter(runState -> runState.state().equals(state))
.filter(runState -> !runState.data().trigger().isPresent())
.count());
});
stats.registerSubmissionRateLimitMetric(submissionRateLimiter::getRate);
}
private static Stats stats(Environment environment) {
return new MetricsStats(environment.resolve(SemanticMetricRegistry.class), Instant::now);
}
private static StorageFactory storage(StorageFactory storage) {
return (environment, stats) -> {
if (isDevMode(environment.config())) {
LOG.info("Running Styx in development mode, will use InMemStorage");
return new InMemStorage();
} else {
return storage.apply(environment, stats);
}
};
}
private static AggregateStorage storage(Environment environment, Stats stats ) {
final Config config = environment.config();
final Closer closer = environment.closer();
final Connection bigTable = closer.register(createBigTableConnection(config));
final Datastore datastore = createDatastore(config, stats);
return new AggregateStorage(bigTable, datastore, DEFAULT_RETRY_BASE_DELAY_BT);
}
private static DockerRunner createDockerRunner(
String id,
Environment environment,
StateManager stateManager,
ScheduledExecutorService scheduler,
Stats stats,
Debug debug) {
final Config config = environment.config();
final Closer closer = environment.closer();
if (isDevMode(config)) {
LOG.info("Creating LocalDockerRunner");
return closer.register(DockerRunner.local(scheduler, stateManager));
} else {
final NamespacedKubernetesClient kubernetes = closer.register(getKubernetesClient(
config, id, createGkeClient(), DefaultKubernetesClient::new));
final ServiceAccountKeyManager serviceAccountKeyManager = createServiceAccountKeyManager();
return closer.register(DockerRunner.kubernetes(kubernetes, stateManager, stats,
serviceAccountKeyManager, debug));
}
}
private static Container createGkeClient() {
try {
final HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
final JsonFactory jsonFactory = Utils.getDefaultJsonFactory();
final GoogleCredential credential =
GoogleCredential.getApplicationDefault(httpTransport, jsonFactory)
.createScoped(ContainerScopes.all());
return new Container.Builder(httpTransport, jsonFactory, credential)
.setApplicationName(SERVICE_NAME)
.build();
} catch (GeneralSecurityException | IOException e) {
throw new RuntimeException(e);
}
}
private static ServiceAccountKeyManager createServiceAccountKeyManager() {
try {
final HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
final JsonFactory jsonFactory = Utils.getDefaultJsonFactory();
final GoogleCredential credential = GoogleCredential
.getApplicationDefault(httpTransport, jsonFactory)
.createScoped(IamScopes.all());
final Iam iam = new Iam.Builder(
httpTransport, jsonFactory, credential)
.setApplicationName(SERVICE_NAME)
.build();
return new ServiceAccountKeyManager(iam);
} catch (GeneralSecurityException | IOException e) {
throw new RuntimeException(e);
}
}
static NamespacedKubernetesClient getKubernetesClient(Config rootConfig, String id,
Container gke, KubernetesClientFactory clientFactory) {
try {
final Config config = rootConfig
.getConfig(GKE_CLUSTER_PATH)
.getConfig(id);
final Cluster cluster = gke.projects().locations().clusters()
.get(String.format("projects/%s/locations/%s/clusters/%s",
config.getString(GKE_CLUSTER_PROJECT_ID),
config.getString(GKE_CLUSTER_ZONE),
config.getString(GKE_CLUSTER_ID))).execute();
final io.fabric8.kubernetes.client.Config kubeConfig = new ConfigBuilder()
.withMasterUrl("https://" + cluster.getEndpoint())
.withCaCertData(cluster.getMasterAuth().getClusterCaCertificate())
.withClientCertData(cluster.getMasterAuth().getClientCertificate())
.withClientKeyData(cluster.getMasterAuth().getClientKey())
.withNamespace(config.getString(GKE_CLUSTER_NAMESPACE))
.build();
return clientFactory.apply(kubeConfig);
} catch (IOException e) {
throw Throwables.propagate(e);
}
}
private static Closeable executorCloser(String name, ExecutorService executor) {
return () -> {
LOG.info("Shutting down executor: {}", name);
executor.shutdown();
try {
executor.awaitTermination(1, SECONDS);
} catch (InterruptedException ignored) {
}
final List<Runnable> runnables = executor.shutdownNow();
if (!runnables.isEmpty()) {
LOG.warn("{} task(s) in {} did not execute", runnables.size(), name);
}
};
}
private static boolean isDevMode(Config config) {
return STYX_MODE_DEVELOPMENT.equals(config.getString(STYX_MODE));
}
interface KubernetesClientFactory
extends Function<io.fabric8.kubernetes.client.Config, NamespacedKubernetesClient> { }
}
| Consistent name | styx-scheduler-service/src/main/java/com/spotify/styx/StyxScheduler.java | Consistent name | <ide><path>tyx-scheduler-service/src/main/java/com/spotify/styx/StyxScheduler.java
<ide>
<ide> public static final int DEFAULT_STYX_EVENT_PROCESSING_THREADS = 32;
<ide> public static final Duration DEFAULT_SCHEDULER_TICK_INTERVAL = Duration.ofSeconds(2);
<del> public static final Duration DEFAULT_TRIGGER_MANAGER_TICK_INTERVAL = Duration.ofSeconds(1);
<add> public static final Duration DEFAULT_TRIGGER_TICK_INTERVAL = Duration.ofSeconds(1);
<ide> public static final Duration CLEANER_TICK_INTERVAL = Duration.ofMinutes(30);
<ide> public static final Duration RUNTIME_CONFIG_UPDATE_INTERVAL = Duration.ofSeconds(5);
<ide> public static final Duration DEFAULT_RETRY_BASE_DELAY = Duration.ofMinutes(3);
<ide>
<ide> final Duration triggerTickInterval = config.hasPath(STYX_TRIGGER_TICK_INTERVAL)
<ide> ? config.getDuration(STYX_TRIGGER_TICK_INTERVAL)
<del> : DEFAULT_TRIGGER_MANAGER_TICK_INTERVAL;
<add> : DEFAULT_TRIGGER_TICK_INTERVAL;
<ide>
<ide> dockerRunner.restore();
<ide> startTriggerManager(triggerManager, executor, schedulerTickInterval); |
|
Java | apache-2.0 | error: pathspec 'shiro-demo-section4/src/test/java/NonConfigurationCreateTest.java' did not match any file(s) known to git
| ed6ef25e48c49d9910ed09b6328eb1effb9e1a0e | 1 | l81893521/shiro-demo | import com.alibaba.druid.pool.DruidDataSource;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy;
import org.apache.shiro.authc.pam.ModularRealmAuthenticator;
import org.apache.shiro.authz.ModularRealmAuthorizer;
import org.apache.shiro.authz.permission.WildcardPermissionResolver;
import org.apache.shiro.mgt.DefaultSecurityManager;
import org.apache.shiro.realm.jdbc.JdbcRealm;
import org.apache.shiro.subject.Subject;
import org.junit.Assert;
import org.junit.Test;
/**
* Created by Will.Zhang on 2016/12/2 0002 15:31.
*/
public class NonConfigurationCreateTest {
@Test
public void test(){
DefaultSecurityManager securityManager = new DefaultSecurityManager();
//设置authenticator
ModularRealmAuthenticator authenticator = new ModularRealmAuthenticator();
authenticator.setAuthenticationStrategy(new AtLeastOneSuccessfulStrategy());
securityManager.setAuthenticator(authenticator);
//设置authorizer
ModularRealmAuthorizer authorizer = new ModularRealmAuthorizer();
authorizer.setPermissionResolver(new WildcardPermissionResolver());
securityManager.setAuthorizer(authorizer);
//创建datasource
DruidDataSource dataSource = new DruidDataSource();
dataSource.setDriverClassName("com.mysql.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://192.168.31.188:3306/shiro");
dataSource.setUsername("root");
dataSource.setPassword("YEEkoo@2016");
//设置real
JdbcRealm realm = new JdbcRealm();
realm.setDataSource(dataSource);
realm.setPermissionsLookupEnabled(true);
securityManager.setRealm(realm);
//将SecurityManager设置到SecurityUtils,方便全局使用
SecurityUtils.setSecurityManager(securityManager);
Subject subject = SecurityUtils.getSubject();
UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");
subject.login(token);
Assert.assertTrue(subject.isAuthenticated());
}
}
| shiro-demo-section4/src/test/java/NonConfigurationCreateTest.java | update section4
| shiro-demo-section4/src/test/java/NonConfigurationCreateTest.java | update section4 | <ide><path>hiro-demo-section4/src/test/java/NonConfigurationCreateTest.java
<add>import com.alibaba.druid.pool.DruidDataSource;
<add>import org.apache.shiro.SecurityUtils;
<add>import org.apache.shiro.authc.UsernamePasswordToken;
<add>import org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy;
<add>import org.apache.shiro.authc.pam.ModularRealmAuthenticator;
<add>import org.apache.shiro.authz.ModularRealmAuthorizer;
<add>import org.apache.shiro.authz.permission.WildcardPermissionResolver;
<add>import org.apache.shiro.mgt.DefaultSecurityManager;
<add>import org.apache.shiro.realm.jdbc.JdbcRealm;
<add>import org.apache.shiro.subject.Subject;
<add>import org.junit.Assert;
<add>import org.junit.Test;
<add>
<add>/**
<add> * Created by Will.Zhang on 2016/12/2 0002 15:31.
<add> */
<add>public class NonConfigurationCreateTest {
<add>
<add> @Test
<add> public void test(){
<add>
<add> DefaultSecurityManager securityManager = new DefaultSecurityManager();
<add>
<add> //设置authenticator
<add> ModularRealmAuthenticator authenticator = new ModularRealmAuthenticator();
<add> authenticator.setAuthenticationStrategy(new AtLeastOneSuccessfulStrategy());
<add> securityManager.setAuthenticator(authenticator);
<add>
<add> //设置authorizer
<add> ModularRealmAuthorizer authorizer = new ModularRealmAuthorizer();
<add> authorizer.setPermissionResolver(new WildcardPermissionResolver());
<add> securityManager.setAuthorizer(authorizer);
<add>
<add> //创建datasource
<add> DruidDataSource dataSource = new DruidDataSource();
<add> dataSource.setDriverClassName("com.mysql.jdbc.Driver");
<add> dataSource.setUrl("jdbc:mysql://192.168.31.188:3306/shiro");
<add> dataSource.setUsername("root");
<add> dataSource.setPassword("YEEkoo@2016");
<add>
<add> //设置real
<add> JdbcRealm realm = new JdbcRealm();
<add> realm.setDataSource(dataSource);
<add> realm.setPermissionsLookupEnabled(true);
<add> securityManager.setRealm(realm);
<add>
<add> //将SecurityManager设置到SecurityUtils,方便全局使用
<add> SecurityUtils.setSecurityManager(securityManager);
<add>
<add>
<add> Subject subject = SecurityUtils.getSubject();
<add> UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");
<add> subject.login(token);
<add>
<add> Assert.assertTrue(subject.isAuthenticated());
<add> }
<add>} |
|
JavaScript | mit | c83a02fcbf862e3e80e99ec0c3aece3a9b7295eb | 0 | punkave/sanitize-html,SaintPeter/sanitize-html,YourDeveloperFriend/sanitize-html,emorikawa/sanitize-html,JamyDev/sanitize-html,zdravkoggeorgiev/sanitize-html | var assert = require("assert");
describe('sanitizeHtml', function() {
var sanitizeHtml;
it('should be successfully initialized', function() {
sanitizeHtml = require('../index.js');
});
it('should pass through simple well-formed whitelisted markup', function() {
assert.equal(sanitizeHtml('<div><p>Hello <b>there</b></p></div>'), '<div><p>Hello <b>there</b></p></div>');
});
it('should pass through all markup if allowedTags and allowedAttributes are set to false', function() {
assert.equal(sanitizeHtml('<div><wiggly worms="ewww">hello</wiggly></div>', {
allowedTags: false,
allowedAttributes: false
}), '<div><wiggly worms="ewww">hello</wiggly></div>');
});
it('should respect text nodes at top level', function() {
assert.equal(sanitizeHtml('Blah blah blah<p>Whee!</p>'), 'Blah blah blah<p>Whee!</p>');
});
it('should reject markup not whitelisted without destroying its text', function() {
assert.equal(sanitizeHtml('<div><wiggly>Hello</wiggly></div>'), '<div>Hello</div>');
});
it('should accept a custom list of allowed tags', function() {
assert.equal(sanitizeHtml('<blue><red><green>Cheese</green></red></blue>', { allowedTags: [ 'blue', 'green' ] }), '<blue><green>Cheese</green></blue>');
});
it('should reject attributes not whitelisted', function() {
assert.equal(sanitizeHtml('<a href="foo.html" whizbang="whangle">foo</a>'), '<a href="foo.html">foo</a>');
});
it('should accept a custom list of allowed attributes per element', function() {
assert.equal(sanitizeHtml('<a href="foo.html" whizbang="whangle">foo</a>', { allowedAttributes: { a: [ 'href', 'whizbang' ] } } ), '<a href="foo.html" whizbang="whangle">foo</a>');
});
it('should clean up unclosed img tags and p tags', function() {
assert.equal(sanitizeHtml('<img src="foo.jpg"><p>Whee<p>Again<p>Wow<b>cool</b>', { allowedTags: sanitizeHtml.defaults.allowedTags.concat([ 'img' ])}), '<img src="foo.jpg" /><p>Whee</p><p>Again</p><p>Wow<b>cool</b></p>');
});
it('should reject hrefs that are not relative, ftp, http, https or mailto', function() {
assert.equal(sanitizeHtml('<a href="http://google.com">google</a><a href="https://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a href="javascript:alert(0)">javascript</a>'), '<a href="http://google.com">google</a><a href="https://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a>javascript</a>');
});
it('should cope identically with capitalized attributes and tags and should tolerate capitalized schemes', function() {
assert.equal(sanitizeHtml('<A HREF="http://google.com">google</a><a href="HTTPS://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a href="javascript:alert(0)">javascript</a>'), '<a href="http://google.com">google</a><a href="HTTPS://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a>javascript</a>');
});
it('should drop the content of script elements', function() {
assert.equal(sanitizeHtml('<script>alert("ruhroh!");</script><p>Paragraph</p>'), '<p>Paragraph</p>');
});
it('should drop the content of style elements', function() {
assert.equal(sanitizeHtml('<style>.foo { color: blue; }</style><p>Paragraph</p>'), '<p>Paragraph</p>');
});
it('should preserve entities as such', function() {
assert.equal(sanitizeHtml('<a name="<silly>"><Kapow!></a>'), '<a name="<silly>"><Kapow!></a>');
});
it('should dump comments', function() {
assert.equal(sanitizeHtml('<p><!-- Blah blah -->Whee</p>'), '<p>Whee</p>');
});
it('should dump a sneaky encoded javascript url', function() {
assert.equal(sanitizeHtml('<a href="javascript:alert('XSS')">Hax</a>'), '<a>Hax</a>');
});
it('should dump an uppercase javascript url', function() {
assert.equal(sanitizeHtml('<a href="JAVASCRIPT:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should dump a javascript URL with a comment in the middle (probably only respected by browsers in XML data islands, but just in case someone enables those)', function() {
assert.equal(sanitizeHtml('<a href="java<!-- -->script:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should not mess up a hashcode with a : in it', function() {
assert.equal(sanitizeHtml('<a href="awesome.html#this:stuff">Hi</a>'), '<a href="awesome.html#this:stuff">Hi</a>');
});
it('should dump character codes 1-32 before testing scheme', function() {
assert.equal(sanitizeHtml('<a href="java\0\t\r\n script:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should dump character codes 1-32 even when escaped with padding rather than trailing ;', function() {
assert.equal(sanitizeHtml('<a href="java�script:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should still like nice schemes', function() {
assert.equal(sanitizeHtml('<a href="http://google.com/">Hi</a>'), '<a href="http://google.com/">Hi</a>');
});
it('should still like nice relative URLs', function() {
assert.equal(sanitizeHtml('<a href="hello.html">Hi</a>'), '<a href="hello.html">Hi</a>');
});
it('should replace ol to ul', function() {
assert.equal(sanitizeHtml('<ol><li>Hello world</li></ol>', { transformTags: {ol: 'ul'} }), '<ul><li>Hello world</li></ul>');
});
it('should replace ol to ul and add class attribute with foo value', function() {
assert.equal(sanitizeHtml('<ol><li>Hello world</li></ol>', { transformTags: {ol: sanitizeHtml.simpleTransform('ul', {class: 'foo'})}, allowedAttributes: { ul: ['class'] } }), '<ul class="foo"><li>Hello world</li></ul>');
});
it('should replace ol to ul, left attributes foo and bar untouched, remove baz attribute and add class attributte with foo value', function() {
assert.equal(sanitizeHtml('<ol foo="foo" bar="bar" baz="baz"><li>Hello world</li></ol>', { transformTags: {ol: sanitizeHtml.simpleTransform('ul', {class: 'foo'})}, allowedAttributes: { ul: ['foo', 'bar', 'class'] } }), '<ul foo="foo" bar="bar" class="foo"><li>Hello world</li></ul>');
});
it('should replace ol to ul and replace all attributes to class attribute with foo value', function() {
assert.equal(sanitizeHtml('<ol foo="foo" bar="bar" baz="baz"><li>Hello world</li></ol>', { transformTags: {ol: sanitizeHtml.simpleTransform('ul', {class: 'foo'}, false)}, allowedAttributes: { ul: ['foo', 'bar', 'class'] } }), '<ul class="foo"><li>Hello world</li></ul>');
});
it('should replace ol to ul and add attribute class with foo value and attribute bar with bar value', function() {
assert.equal(sanitizeHtml('<ol><li>Hello world</li></ol>', { transformTags: {ol: function(tagName, attribs){
attribs.class = 'foo';
attribs.bar = 'bar';
return {
tagName: 'ul',
attribs: attribs
}
}}, allowedAttributes: { ul: ['bar', 'class'] } }), '<ul class="foo" bar="bar"><li>Hello world</li></ul>');
});
it('should skip an empty link', function() {
assert.strictEqual(
sanitizeHtml('<p>This is <a href="http://www.linux.org"></a><br/>Linux</p>', {
exclusiveFilter: function (frame) {
return frame.tag === 'a' && !frame.text.trim();
}
}),
'<p>This is <br />Linux</p>'
);
});
it("Should expose a node's inner text and inner HTML to the filter", function() {
assert.strictEqual(
sanitizeHtml('<p>12<a href="http://www.linux.org"><br/>3<br></a><span>4</span></p>', {
exclusiveFilter : function(frame) {
if (frame.tag === 'p') {
assert.strictEqual(frame.text, '124');
} else if (frame.tag === 'a') {
assert.strictEqual(frame.text, '3');
return true;
} else if (frame.tag === 'br') {
assert.strictEqual(frame.text, '');
} else {
assert.fail('p, a, br', frame.tag);
}
return false;
}
}),
'<p>124</p>'
);
});
it('Should collapse nested empty elements', function() {
assert.strictEqual(
sanitizeHtml('<p><a href="http://www.linux.org"><br/></a></p>', {
exclusiveFilter : function(frame) {
return (frame.tag === 'a' || frame.tag === 'p' ) && !frame.text.trim();
}
}),
''
);
});
it('Exclusive filter should not affect elements which do not match the filter condition', function () {
assert.strictEqual(
sanitizeHtml('I love <a href="www.linux.org" target="_hplink">Linux</a> OS',
{
exclusiveFilter: function (frame) {
return (frame.tag === 'a') && !frame.text.trim();
}
}),
'I love <a href="www.linux.org" target="_hplink">Linux</a> OS'
);
});
it('should disallow data URLs with default allowedSchemes', function() {
assert.equal(
sanitizeHtml(
// teeny-tiny valid transparent GIF in a data URL
'<img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" />',
{
allowedTags: [ 'img' ]
}
),
'<img />'
);
});
it('should allow data URLs with custom allowedSchemes', function() {
assert.equal(
sanitizeHtml(
// teeny-tiny valid transparent GIF in a data URL
'<img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" />',
{
allowedTags: [ 'img', 'p' ],
allowedSchemes: [ 'data', 'http' ]
}
),
'<img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" />'
);
});
it('should allow specific classes when whitelisted with allowedClasses', function() {
assert.equal(
sanitizeHtml(
'<p class="nifty simple dippy">whee</p>',
{
allowedTags: [ 'p' ],
allowedClasses: {
p: [ 'nifty' ]
}
}
),
'<p class="nifty">whee</p>'
);
});
it('should not act weird when the class attribute is empty', function() {
assert.equal(
sanitizeHtml(
'<p class="">whee</p>',
{
allowedTags: [ 'p' ],
allowedClasses: {
p: [ 'nifty' ]
}
}
),
'<p>whee</p>'
);
});
it('should not crash on bad markup', function() {
assert.equal(
sanitizeHtml(
"<p a"
),
''
);
});
it('should not allow a naked = sign followed by an unrelated attribute to result in one merged attribute with unescaped double quote marks', function() {
assert.equal(
sanitizeHtml(
'<IMG SRC= onmouseover="alert(\'XSS\');">',
{
allowedTags: [ 'img' ],
allowedAttributes: {
img: [ 'src' ]
}
}
),
// This is weird but not dangerous. Without the " there
// would probably be some way to make it come out as a
// separate attribute
'<img src="onmouseover="alert(\'XSS\');"" />'
);
});
it('should not filter if exclusive filter does not match after transforming tags', function() {
assert.equal(
sanitizeHtml(
'<a href="test.html">test</a>',
{
allowedTags: [ 'a' ],
allowedAttributes: { a: ['href', 'target']},
transformTags: {
'a': function (tagName, attribs) {
if (!attribs.href)
return false;
return {
tagName: tagName,
attribs: {
target: '_blank',
href: attribs.href
}
};
}
},
exclusiveFilter: function(frame) {
return frame.tag === 'a' && frame.text.trim() == 'blah';
}
}
),
'<a target="_blank" href="test.html">test</a>'
)
});
it('should filter if exclusive filter does match after transforming tags', function() {
assert.equal(
sanitizeHtml(
'<a href="test.html">blah</a>',
{
allowedTags: [ 'a' ],
allowedAttributes: {a: ['href', 'target']},
transformTags: {
'a': function (tagName, attribs) {
if (!attribs.href)
return false;
return {
tagName: tagName,
attribs: {
target: '_blank',
href: attribs.href
}
};
}
},
exclusiveFilter: function(frame) {
return frame.tag === 'a' && frame.text.trim() == 'blah';
}
}
),
''
)
});
});
| test/test.js | var assert = require("assert");
describe('sanitizeHtml', function() {
var sanitizeHtml;
it('should be successfully initialized', function() {
sanitizeHtml = require('../index.js');
});
it('should pass through simple well-formed whitelisted markup', function() {
assert.equal(sanitizeHtml('<div><p>Hello <b>there</b></p></div>'), '<div><p>Hello <b>there</b></p></div>');
});
it('should pass through all markup if allowedTags and allowedAttributes are set to false', function() {
assert.equal(sanitizeHtml('<div><wiggly worms="ewww">hello</wiggly></div>', {
allowedTags: false,
allowedAttributes: false
}), '<div><wiggly worms="ewww">hello</wiggly></div>');
});
it('should respect text nodes at top level', function() {
assert.equal(sanitizeHtml('Blah blah blah<p>Whee!</p>'), 'Blah blah blah<p>Whee!</p>');
});
it('should reject markup not whitelisted without destroying its text', function() {
assert.equal(sanitizeHtml('<div><wiggly>Hello</wiggly></div>'), '<div>Hello</div>');
});
it('should accept a custom list of allowed tags', function() {
assert.equal(sanitizeHtml('<blue><red><green>Cheese</green></red></blue>', { allowedTags: [ 'blue', 'green' ] }), '<blue><green>Cheese</green></blue>');
});
it('should reject attributes not whitelisted', function() {
assert.equal(sanitizeHtml('<a href="foo.html" whizbang="whangle">foo</a>'), '<a href="foo.html">foo</a>');
});
it('should accept a custom list of allowed attributes per element', function() {
assert.equal(sanitizeHtml('<a href="foo.html" whizbang="whangle">foo</a>', { allowedAttributes: { a: [ 'href', 'whizbang' ] } } ), '<a href="foo.html" whizbang="whangle">foo</a>');
});
it('should clean up unclosed img tags and p tags', function() {
assert.equal(sanitizeHtml('<img src="foo.jpg"><p>Whee<p>Again<p>Wow<b>cool</b>', { allowedTags: sanitizeHtml.defaults.allowedTags.concat([ 'img' ])}), '<img src="foo.jpg" /><p>Whee</p><p>Again</p><p>Wow<b>cool</b></p>');
});
it('should reject hrefs that are not relative, ftp, http, https or mailto', function() {
assert.equal(sanitizeHtml('<a href="http://google.com">google</a><a href="https://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a href="javascript:alert(0)">javascript</a>'), '<a href="http://google.com">google</a><a href="https://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a>javascript</a>');
});
it('should cope identically with capitalized attributes and tags and should tolerate capitalized schemes', function() {
assert.equal(sanitizeHtml('<A HREF="http://google.com">google</a><a href="HTTPS://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a href="javascript:alert(0)">javascript</a>'), '<a href="http://google.com">google</a><a href="HTTPS://google.com">https google</a><a href="ftp://example.com">ftp</a><a href="mailto:[email protected]">mailto</a><a href="/relative.html">relative</a><a>javascript</a>');
});
it('should drop the content of script elements', function() {
assert.equal(sanitizeHtml('<script>alert("ruhroh!");</script><p>Paragraph</p>'), '<p>Paragraph</p>');
});
it('should drop the content of style elements', function() {
assert.equal(sanitizeHtml('<style>.foo { color: blue; }</style><p>Paragraph</p>'), '<p>Paragraph</p>');
});
it('should preserve entities as such', function() {
assert.equal(sanitizeHtml('<a name="<silly>"><Kapow!></a>'), '<a name="<silly>"><Kapow!></a>');
});
it('should dump comments', function() {
assert.equal(sanitizeHtml('<p><!-- Blah blah -->Whee</p>'), '<p>Whee</p>');
});
it('should dump a sneaky encoded javascript url', function() {
assert.equal(sanitizeHtml('<a href="javascript:alert('XSS')">Hax</a>'), '<a>Hax</a>');
});
it('should dump an uppercase javascript url', function() {
assert.equal(sanitizeHtml('<a href="JAVASCRIPT:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should dump a javascript URL with a comment in the middle (probably only respected by browsers in XML data islands, but just in case someone enables those)', function() {
assert.equal(sanitizeHtml('<a href="java<!-- -->script:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should not mess up a hashcode with a : in it', function() {
assert.equal(sanitizeHtml('<a href="awesome.html#this:stuff">Hi</a>'), '<a href="awesome.html#this:stuff">Hi</a>');
});
it('should dump character codes 1-32 before testing scheme', function() {
assert.equal(sanitizeHtml('<a href="java\0\t\r\n script:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should dump character codes 1-32 even when escaped with padding rather than trailing ;', function() {
assert.equal(sanitizeHtml('<a href="java�script:alert(\'foo\')">Hax</a>'), '<a>Hax</a>');
});
it('should still like nice schemes', function() {
assert.equal(sanitizeHtml('<a href="http://google.com/">Hi</a>'), '<a href="http://google.com/">Hi</a>');
});
it('should still like nice relative URLs', function() {
assert.equal(sanitizeHtml('<a href="hello.html">Hi</a>'), '<a href="hello.html">Hi</a>');
});
it('should replace ol to ul', function() {
assert.equal(sanitizeHtml('<ol><li>Hello world</li></ol>', { transformTags: {ol: 'ul'} }), '<ul><li>Hello world</li></ul>');
});
it('should replace ol to ul and add class attribute with foo value', function() {
assert.equal(sanitizeHtml('<ol><li>Hello world</li></ol>', { transformTags: {ol: sanitizeHtml.simpleTransform('ul', {class: 'foo'})}, allowedAttributes: { ul: ['class'] } }), '<ul class="foo"><li>Hello world</li></ul>');
});
it('should replace ol to ul, left attributes foo and bar untouched, remove baz attribute and add class attributte with foo value', function() {
assert.equal(sanitizeHtml('<ol foo="foo" bar="bar" baz="baz"><li>Hello world</li></ol>', { transformTags: {ol: sanitizeHtml.simpleTransform('ul', {class: 'foo'})}, allowedAttributes: { ul: ['foo', 'bar', 'class'] } }), '<ul foo="foo" bar="bar" class="foo"><li>Hello world</li></ul>');
});
it('should replace ol to ul and replace all attributes to class attribute with foo value', function() {
assert.equal(sanitizeHtml('<ol foo="foo" bar="bar" baz="baz"><li>Hello world</li></ol>', { transformTags: {ol: sanitizeHtml.simpleTransform('ul', {class: 'foo'}, false)}, allowedAttributes: { ul: ['foo', 'bar', 'class'] } }), '<ul class="foo"><li>Hello world</li></ul>');
});
it('should replace ol to ul and add attribute class with foo value and attribute bar with bar value', function() {
assert.equal(sanitizeHtml('<ol><li>Hello world</li></ol>', { transformTags: {ol: function(tagName, attribs){
attribs.class = 'foo';
attribs.bar = 'bar';
return {
tagName: 'ul',
attribs: attribs
}
}}, allowedAttributes: { ul: ['bar', 'class'] } }), '<ul class="foo" bar="bar"><li>Hello world</li></ul>');
});
it('should skip an empty link', function() {
assert.strictEqual(
sanitizeHtml('<p>This is <a href="http://www.linux.org"></a><br/>Linux</p>', {
exclusiveFilter: function (frame) {
return frame.tag === 'a' && !frame.text.trim();
}
}),
'<p>This is <br />Linux</p>'
);
});
it("Should expose a node's inner text and inner HTML to the filter", function() {
assert.strictEqual(
sanitizeHtml('<p>12<a href="http://www.linux.org"><br/>3<br></a><span>4</span></p>', {
exclusiveFilter : function(frame) {
if (frame.tag === 'p') {
assert.strictEqual(frame.text, '124');
} else if (frame.tag === 'a') {
assert.strictEqual(frame.text, '3');
return true;
} else if (frame.tag === 'br') {
assert.strictEqual(frame.text, '');
} else {
assert.fail('p, a, br', frame.tag);
}
return false;
}
}),
'<p>124</p>'
);
});
it('Should collapse nested empty elements', function() {
assert.strictEqual(
sanitizeHtml('<p><a href="http://www.linux.org"><br/></a></p>', {
exclusiveFilter : function(frame) {
return (frame.tag === 'a' || frame.tag === 'p' ) && !frame.text.trim();
}
}),
''
);
});
it('Exclusive filter should not affect elements which do not match the filter condition', function () {
assert.strictEqual(
sanitizeHtml('I love <a href="www.linux.org" target="_hplink">Linux</a> OS',
{
exclusiveFilter: function (frame) {
return (frame.tag === 'a') && !frame.text.trim();
}
}),
'I love <a href="www.linux.org" target="_hplink">Linux</a> OS'
);
});
it('should disallow data URLs with default allowedSchemes', function() {
assert.equal(
sanitizeHtml(
// teeny-tiny valid transparent GIF in a data URL
'<img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" />',
{
allowedTags: [ 'img' ]
}
),
'<img />'
);
});
it('should allow data URLs with custom allowedSchemes', function() {
assert.equal(
sanitizeHtml(
// teeny-tiny valid transparent GIF in a data URL
'<img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" />',
{
allowedTags: [ 'img', 'p' ],
allowedSchemes: [ 'data', 'http' ]
}
),
'<img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" />'
);
});
it('should allow specific classes when whitelisted with allowedClasses', function() {
assert.equal(
sanitizeHtml(
'<p class="nifty simple dippy">whee</p>',
{
allowedTags: [ 'p' ],
allowedClasses: {
p: [ 'nifty' ]
}
}
),
'<p class="nifty">whee</p>'
);
});
it('should not act weird when the class attribute is empty', function() {
assert.equal(
sanitizeHtml(
'<p class="">whee</p>',
{
allowedTags: [ 'p' ],
allowedClasses: {
p: [ 'nifty' ]
}
}
),
'<p>whee</p>'
);
});
it('should not crash on bad markup', function() {
assert.equal(
sanitizeHtml(
"<p a"
),
''
);
});
it('should not allow a naked = sign followed by an unrelated attribute to result in one merged attribute with unescaped double quote marks', function() {
assert.equal(
sanitizeHtml(
'<IMG SRC= onmouseover="alert(\'XSS\');">',
{
allowedTags: [ 'img' ],
allowedAttributes: {
img: [ 'src' ]
}
}
),
// This is weird but not dangerous. Without the " there
// would probably be some way to make it come out as a
// separate attribute
'<img src="onmouseover="alert(\'XSS\');"" />'
);
});
it('should not filter if exclusive filter does not match after transforming tags', function() {
assert.equal(
sanitizeHtml(
'<a href="test.html">test</a>',
{
allowedTags: [ 'a' ],
allowedAttributes: {
a: ['href', 'target']
},
transformTags: {
'a': function (tagName, attribs) {
if (!attribs.href)
return false;
return {
tagName: tagName,
attribs: {
target: '_blank',
href: attribs.href
}
};
}
},
exclusiveFilter: function(frame) {
return frame.tag === 'a' && frame.text.trim() == 'blah';
}
}
),
'<a target="_blank" href="test.html">test</a>'
)
});
it('should filter if exclusive filter does match after transforming tags', function() {
assert.equal(
sanitizeHtml(
'<a href="test.html">blah</a>',
{
allowedTags: [ 'a' ],
allowedAttributes: {
a: ['href', 'target']
},
transformTags: {
'a': function (tagName, attribs) {
if (!attribs.href)
return false;
return {
tagName: tagName,
attribs: {
target: '_blank',
href: attribs.href
}
};
}
},
exclusiveFilter: function(frame) {
return frame.tag === 'a' && frame.text.trim() == 'blah';
}
}
),
''
)
});
});
| Added some tests for behavior of an exclusiveFilter following a transformTags
| test/test.js | Added some tests for behavior of an exclusiveFilter following a transformTags | <ide><path>est/test.js
<ide> '<a href="test.html">test</a>',
<ide> {
<ide> allowedTags: [ 'a' ],
<del> allowedAttributes: {
<del> a: ['href', 'target']
<del> },
<add> allowedAttributes: { a: ['href', 'target']},
<ide> transformTags: {
<ide> 'a': function (tagName, attribs) {
<del>
<ide> if (!attribs.href)
<ide> return false;
<del>
<ide> return {
<ide> tagName: tagName,
<ide> attribs: {
<ide> '<a href="test.html">blah</a>',
<ide> {
<ide> allowedTags: [ 'a' ],
<del> allowedAttributes: {
<del> a: ['href', 'target']
<del> },
<add> allowedAttributes: {a: ['href', 'target']},
<ide> transformTags: {
<ide> 'a': function (tagName, attribs) {
<del>
<ide> if (!attribs.href)
<ide> return false;
<del>
<ide> return {
<ide> tagName: tagName,
<ide> attribs: { |
|
JavaScript | mit | c499487a1094ee18fab721642be68caed9cc9256 | 0 | subesokun/Rocket.Chat,inoio/Rocket.Chat,pkgodara/Rocket.Chat,subesokun/Rocket.Chat,4thParty/Rocket.Chat,pkgodara/Rocket.Chat,subesokun/Rocket.Chat,VoiSmart/Rocket.Chat,pkgodara/Rocket.Chat,pkgodara/Rocket.Chat,4thParty/Rocket.Chat,4thParty/Rocket.Chat,Sing-Li/Rocket.Chat,inoio/Rocket.Chat,VoiSmart/Rocket.Chat,subesokun/Rocket.Chat,4thParty/Rocket.Chat,inoio/Rocket.Chat,Sing-Li/Rocket.Chat,VoiSmart/Rocket.Chat,Sing-Li/Rocket.Chat,Sing-Li/Rocket.Chat | /* globals UploadFS */
import fs from 'fs';
import stream from 'stream';
import mime from 'mime-type/with-db';
import Future from 'fibers/future';
import sharp from 'sharp';
import { Cookies } from 'meteor/ostrio:cookies';
const cookie = new Cookies();
Object.assign(FileUpload, {
handlers: {},
configureUploadsStore(store, name, options) {
const type = name.split(':').pop();
const stores = UploadFS.getStores();
delete stores[name];
return new UploadFS.store[store](Object.assign({
name,
}, options, FileUpload[`default${ type }`]()));
},
defaultUploads() {
return {
collection: RocketChat.models.Uploads.model,
filter: new UploadFS.Filter({
onCheck: FileUpload.validateFileUpload,
}),
getPath(file) {
return `${ RocketChat.settings.get('uniqueID') }/uploads/${ file.rid }/${ file.userId }/${ file._id }`;
},
onValidate: FileUpload.uploadsOnValidate,
onRead(fileId, file, req, res) {
if (!FileUpload.requestCanAccessFiles(req)) {
res.writeHead(403);
return false;
}
res.setHeader('content-disposition', `attachment; filename="${ encodeURIComponent(file.name) }"`);
return true;
},
};
},
defaultAvatars() {
return {
collection: RocketChat.models.Avatars.model,
// filter: new UploadFS.Filter({
// onCheck: FileUpload.validateFileUpload
// }),
getPath(file) {
return `${ RocketChat.settings.get('uniqueID') }/avatars/${ file.userId }`;
},
onValidate: FileUpload.avatarsOnValidate,
onFinishUpload: FileUpload.avatarsOnFinishUpload,
};
},
defaultUserDataFiles() {
return {
collection: RocketChat.models.UserDataFiles.model,
getPath(file) {
return `${ RocketChat.settings.get('uniqueID') }/uploads/userData/${ file.userId }`;
},
onValidate: FileUpload.uploadsOnValidate,
onRead(fileId, file, req, res) {
if (!FileUpload.requestCanAccessFiles(req)) {
res.writeHead(403);
return false;
}
res.setHeader('content-disposition', `attachment; filename="${ encodeURIComponent(file.name) }"`);
return true;
},
};
},
avatarsOnValidate(file) {
if (RocketChat.settings.get('Accounts_AvatarResize') !== true) {
return;
}
const tempFilePath = UploadFS.getTempFilePath(file._id);
const height = RocketChat.settings.get('Accounts_AvatarSize');
const future = new Future();
const s = sharp(tempFilePath);
s.rotate();
// Get metadata to resize the image the first time to keep "inside" the dimensions
// then resize again to create the canvas around
s.metadata(Meteor.bindEnvironment((err, metadata) => {
if (!metadata) {
metadata = {};
}
s.toFormat(sharp.format.jpeg)
.resize(Math.min(height || 0, metadata.width || Infinity), Math.min(height || 0, metadata.height || Infinity))
.pipe(sharp()
.resize(height, height)
.background('#FFFFFF')
.embed()
)
// Use buffer to get the result in memory then replace the existing file
// There is no option to override a file using this library
.toBuffer()
.then(Meteor.bindEnvironment((outputBuffer) => {
fs.writeFile(tempFilePath, outputBuffer, Meteor.bindEnvironment((err) => {
if (err != null) {
console.error(err);
}
const { size } = fs.lstatSync(tempFilePath);
this.getCollection().direct.update({ _id: file._id }, { $set: { size } });
future.return();
}));
}));
}));
return future.wait();
},
resizeImagePreview(file) {
file = RocketChat.models.Uploads.findOneById(file._id);
file = FileUpload.addExtensionTo(file);
const image = FileUpload.getStore('Uploads')._store.getReadStream(file._id, file);
const transformer = sharp()
.resize(32, 32)
.max()
.jpeg()
.blur();
const result = transformer.toBuffer().then((out) => out.toString('base64'));
image.pipe(transformer);
return result;
},
uploadsOnValidate(file) {
if (!/^image\/((x-windows-)?bmp|p?jpeg|png)$/.test(file.type)) {
return;
}
const tmpFile = UploadFS.getTempFilePath(file._id);
const fut = new Future();
const s = sharp(tmpFile);
s.metadata(Meteor.bindEnvironment((err, metadata) => {
if (err != null) {
console.error(err);
return fut.return();
}
const identify = {
format: metadata.format,
size: {
width: metadata.width,
height: metadata.height,
},
};
const reorientation = (cb) => {
if (!metadata.orientation) {
return cb();
}
s.rotate()
.toFile(`${ tmpFile }.tmp`)
.then(Meteor.bindEnvironment(() => {
fs.unlink(tmpFile, Meteor.bindEnvironment(() => {
fs.rename(`${ tmpFile }.tmp`, tmpFile, Meteor.bindEnvironment(() => {
cb();
}));
}));
})).catch((err) => {
console.error(err);
fut.return();
});
return;
};
reorientation(() => {
const { size } = fs.lstatSync(tmpFile);
this.getCollection().direct.update({ _id: file._id }, {
$set: { size, identify },
});
fut.return();
});
}));
return fut.wait();
},
avatarsOnFinishUpload(file) {
// update file record to match user's username
const user = RocketChat.models.Users.findOneById(file.userId);
const oldAvatar = RocketChat.models.Avatars.findOneByName(user.username);
if (oldAvatar) {
RocketChat.models.Avatars.deleteFile(oldAvatar._id);
}
RocketChat.models.Avatars.updateFileNameById(file._id, user.username);
// console.log('upload finished ->', file);
},
requestCanAccessFiles({ headers = {}, query = {} }) {
if (!RocketChat.settings.get('FileUpload_ProtectFiles')) {
return true;
}
let { rc_uid, rc_token, rc_rid, rc_room_type } = query;
if (!rc_uid && headers.cookie) {
rc_uid = cookie.get('rc_uid', headers.cookie);
rc_token = cookie.get('rc_token', headers.cookie);
rc_rid = cookie.get('rc_rid', headers.cookie);
rc_room_type = cookie.get('rc_room_type', headers.cookie);
}
const isAuthorizedByCookies = rc_uid && rc_token && RocketChat.models.Users.findOneByIdAndLoginToken(rc_uid, rc_token);
const isAuthorizedByHeaders = headers['x-user-id'] && headers['x-auth-token'] && RocketChat.models.Users.findOneByIdAndLoginToken(headers['x-user-id'], headers['x-auth-token']);
const isAuthorizedByRoom = rc_room_type && RocketChat.roomTypes.getConfig(rc_room_type).canAccessUploadedFile({ rc_uid, rc_rid, rc_token });
return isAuthorizedByCookies || isAuthorizedByHeaders || isAuthorizedByRoom;
},
addExtensionTo(file) {
if (mime.lookup(file.name) === file.type) {
return file;
}
const ext = mime.extension(file.type);
if (ext && false === new RegExp(`\.${ ext }$`, 'i').test(file.name)) {
file.name = `${ file.name }.${ ext }`;
}
return file;
},
getStore(modelName) {
const storageType = RocketChat.settings.get('FileUpload_Storage_Type');
const handlerName = `${ storageType }:${ modelName }`;
return this.getStoreByName(handlerName);
},
getStoreByName(handlerName) {
if (this.handlers[handlerName] == null) {
console.error(`Upload handler "${ handlerName }" does not exists`);
}
return this.handlers[handlerName];
},
get(file, req, res, next) {
const store = this.getStoreByName(file.store);
if (store && store.get) {
return store.get(file, req, res, next);
}
res.writeHead(404);
res.end();
},
copy(file, targetFile) {
const store = this.getStoreByName(file.store);
const out = fs.createWriteStream(targetFile);
file = FileUpload.addExtensionTo(file);
if (store.copy) {
store.copy(file, out);
return true;
}
return false;
},
});
export class FileUploadClass {
constructor({ name, model, store, get, insert, getStore, copy }) {
this.name = name;
this.model = model || this.getModelFromName();
this._store = store || UploadFS.getStore(name);
this.get = get;
this.copy = copy;
if (insert) {
this.insert = insert;
}
if (getStore) {
this.getStore = getStore;
}
FileUpload.handlers[name] = this;
}
getStore() {
return this._store;
}
get store() {
return this.getStore();
}
set store(store) {
this._store = store;
}
getModelFromName() {
return RocketChat.models[this.name.split(':')[1]];
}
delete(fileId) {
if (this.store && this.store.delete) {
this.store.delete(fileId);
}
return this.model.deleteFile(fileId);
}
deleteById(fileId) {
const file = this.model.findOneById(fileId);
if (!file) {
return;
}
const store = FileUpload.getStoreByName(file.store);
return store.delete(file._id);
}
deleteByName(fileName) {
const file = this.model.findOneByName(fileName);
if (!file) {
return;
}
const store = FileUpload.getStoreByName(file.store);
return store.delete(file._id);
}
insert(fileData, streamOrBuffer, cb) {
fileData.size = parseInt(fileData.size) || 0;
// Check if the fileData matches store filter
const filter = this.store.getFilter();
if (filter && filter.check) {
filter.check(fileData);
}
const fileId = this.store.create(fileData);
const token = this.store.createToken(fileId);
const tmpFile = UploadFS.getTempFilePath(fileId);
try {
if (streamOrBuffer instanceof stream) {
streamOrBuffer.pipe(fs.createWriteStream(tmpFile));
} else if (streamOrBuffer instanceof Buffer) {
fs.writeFileSync(tmpFile, streamOrBuffer);
} else {
throw new Error('Invalid file type');
}
const file = Meteor.call('ufsComplete', fileId, this.name, token);
if (cb) {
cb(null, file);
}
return file;
} catch (e) {
if (cb) {
cb(e);
} else {
throw e;
}
}
}
}
| packages/rocketchat-file-upload/server/lib/FileUpload.js | /* globals UploadFS */
import fs from 'fs';
import stream from 'stream';
import mime from 'mime-type/with-db';
import Future from 'fibers/future';
import sharp from 'sharp';
import { Cookies } from 'meteor/ostrio:cookies';
const cookie = new Cookies();
Object.assign(FileUpload, {
handlers: {},
configureUploadsStore(store, name, options) {
const type = name.split(':').pop();
const stores = UploadFS.getStores();
delete stores[name];
return new UploadFS.store[store](Object.assign({
name,
}, options, FileUpload[`default${ type }`]()));
},
defaultUploads() {
return {
collection: RocketChat.models.Uploads.model,
filter: new UploadFS.Filter({
onCheck: FileUpload.validateFileUpload,
}),
getPath(file) {
return `${ RocketChat.settings.get('uniqueID') }/uploads/${ file.rid }/${ file.userId }/${ file._id }`;
},
onValidate: FileUpload.uploadsOnValidate,
onRead(fileId, file, req, res) {
if (!FileUpload.requestCanAccessFiles(req)) {
res.writeHead(403);
return false;
}
res.setHeader('content-disposition', `attachment; filename="${ encodeURIComponent(file.name) }"`);
return true;
},
};
},
defaultAvatars() {
return {
collection: RocketChat.models.Avatars.model,
// filter: new UploadFS.Filter({
// onCheck: FileUpload.validateFileUpload
// }),
getPath(file) {
return `${ RocketChat.settings.get('uniqueID') }/avatars/${ file.userId }`;
},
onValidate: FileUpload.avatarsOnValidate,
onFinishUpload: FileUpload.avatarsOnFinishUpload,
};
},
defaultUserDataFiles() {
return {
collection: RocketChat.models.UserDataFiles.model,
getPath(file) {
return `${ RocketChat.settings.get('uniqueID') }/uploads/userData/${ file.userId }`;
},
onValidate: FileUpload.uploadsOnValidate,
onRead(fileId, file, req, res) {
if (!FileUpload.requestCanAccessFiles(req)) {
res.writeHead(403);
return false;
}
res.setHeader('content-disposition', `attachment; filename="${ encodeURIComponent(file.name) }"`);
return true;
},
};
},
avatarsOnValidate(file) {
if (RocketChat.settings.get('Accounts_AvatarResize') !== true) {
return;
}
const tempFilePath = UploadFS.getTempFilePath(file._id);
const height = RocketChat.settings.get('Accounts_AvatarSize');
const future = new Future();
const s = sharp(tempFilePath);
s.rotate();
// Get metadata to resize the image the first time to keep "inside" the dimensions
// then resize again to create the canvas around
s.metadata(Meteor.bindEnvironment((err, metadata) => {
if (!metadata) {
metadata = {};
}
s.toFormat(sharp.format.jpeg)
.resize(Math.min(height || 0, metadata.width || Infinity), Math.min(height || 0, metadata.height || Infinity))
.pipe(sharp()
.resize(height, height)
.background('#FFFFFF')
.embed()
)
// Use buffer to get the result in memory then replace the existing file
// There is no option to override a file using this library
.toBuffer()
.then(Meteor.bindEnvironment((outputBuffer) => {
fs.writeFile(tempFilePath, outputBuffer, Meteor.bindEnvironment((err) => {
if (err != null) {
console.error(err);
}
const { size } = fs.lstatSync(tempFilePath);
this.getCollection().direct.update({ _id: file._id }, { $set: { size } });
future.return();
}));
}));
}));
return future.wait();
},
resizeImagePreview(file) {
file = RocketChat.models.Uploads.findOneById(file._id);
file = FileUpload.addExtensionTo(file);
const image = FileUpload.getStore('Uploads')._store.getReadStream(file._id, file);
const transformer = sharp()
.resize(32, 32)
.max()
.jpeg()
.blur();
const result = transformer.toBuffer().then((out) => out.toString('base64'));
image.pipe(transformer);
return result;
},
uploadsOnValidate(file) {
if (!/^image\/((x-windows-)?bmp|p?jpeg|png)$/.test(file.type)) {
return;
}
const tmpFile = UploadFS.getTempFilePath(file._id);
const fut = new Future();
const s = sharp(tmpFile);
s.metadata(Meteor.bindEnvironment((err, metadata) => {
if (err != null) {
console.error(err);
return fut.return();
}
const identify = {
format: metadata.format,
size: {
width: metadata.width,
height: metadata.height,
},
};
if (metadata.orientation == null) {
return fut.return();
}
s.rotate()
.toFile(`${ tmpFile }.tmp`)
.then(Meteor.bindEnvironment(() => {
fs.unlink(tmpFile, Meteor.bindEnvironment(() => {
fs.rename(`${ tmpFile }.tmp`, tmpFile, Meteor.bindEnvironment(() => {
const { size } = fs.lstatSync(tmpFile);
this.getCollection().direct.update({ _id: file._id }, {
$set: {
size,
identify,
},
});
fut.return();
}));
}));
})).catch((err) => {
console.error(err);
fut.return();
});
}));
return fut.wait();
},
avatarsOnFinishUpload(file) {
// update file record to match user's username
const user = RocketChat.models.Users.findOneById(file.userId);
const oldAvatar = RocketChat.models.Avatars.findOneByName(user.username);
if (oldAvatar) {
RocketChat.models.Avatars.deleteFile(oldAvatar._id);
}
RocketChat.models.Avatars.updateFileNameById(file._id, user.username);
// console.log('upload finished ->', file);
},
requestCanAccessFiles({ headers = {}, query = {} }) {
if (!RocketChat.settings.get('FileUpload_ProtectFiles')) {
return true;
}
let { rc_uid, rc_token, rc_rid, rc_room_type } = query;
if (!rc_uid && headers.cookie) {
rc_uid = cookie.get('rc_uid', headers.cookie);
rc_token = cookie.get('rc_token', headers.cookie);
rc_rid = cookie.get('rc_rid', headers.cookie);
rc_room_type = cookie.get('rc_room_type', headers.cookie);
}
const isAuthorizedByCookies = rc_uid && rc_token && RocketChat.models.Users.findOneByIdAndLoginToken(rc_uid, rc_token);
const isAuthorizedByHeaders = headers['x-user-id'] && headers['x-auth-token'] && RocketChat.models.Users.findOneByIdAndLoginToken(headers['x-user-id'], headers['x-auth-token']);
const isAuthorizedByRoom = rc_room_type && RocketChat.roomTypes.getConfig(rc_room_type).canAccessUploadedFile({ rc_uid, rc_rid, rc_token });
return isAuthorizedByCookies || isAuthorizedByHeaders || isAuthorizedByRoom;
},
addExtensionTo(file) {
if (mime.lookup(file.name) === file.type) {
return file;
}
const ext = mime.extension(file.type);
if (ext && false === new RegExp(`\.${ ext }$`, 'i').test(file.name)) {
file.name = `${ file.name }.${ ext }`;
}
return file;
},
getStore(modelName) {
const storageType = RocketChat.settings.get('FileUpload_Storage_Type');
const handlerName = `${ storageType }:${ modelName }`;
return this.getStoreByName(handlerName);
},
getStoreByName(handlerName) {
if (this.handlers[handlerName] == null) {
console.error(`Upload handler "${ handlerName }" does not exists`);
}
return this.handlers[handlerName];
},
get(file, req, res, next) {
const store = this.getStoreByName(file.store);
if (store && store.get) {
return store.get(file, req, res, next);
}
res.writeHead(404);
res.end();
},
copy(file, targetFile) {
const store = this.getStoreByName(file.store);
const out = fs.createWriteStream(targetFile);
file = FileUpload.addExtensionTo(file);
if (store.copy) {
store.copy(file, out);
return true;
}
return false;
},
});
export class FileUploadClass {
constructor({ name, model, store, get, insert, getStore, copy }) {
this.name = name;
this.model = model || this.getModelFromName();
this._store = store || UploadFS.getStore(name);
this.get = get;
this.copy = copy;
if (insert) {
this.insert = insert;
}
if (getStore) {
this.getStore = getStore;
}
FileUpload.handlers[name] = this;
}
getStore() {
return this._store;
}
get store() {
return this.getStore();
}
set store(store) {
this._store = store;
}
getModelFromName() {
return RocketChat.models[this.name.split(':')[1]];
}
delete(fileId) {
if (this.store && this.store.delete) {
this.store.delete(fileId);
}
return this.model.deleteFile(fileId);
}
deleteById(fileId) {
const file = this.model.findOneById(fileId);
if (!file) {
return;
}
const store = FileUpload.getStoreByName(file.store);
return store.delete(file._id);
}
deleteByName(fileName) {
const file = this.model.findOneByName(fileName);
if (!file) {
return;
}
const store = FileUpload.getStoreByName(file.store);
return store.delete(file._id);
}
insert(fileData, streamOrBuffer, cb) {
fileData.size = parseInt(fileData.size) || 0;
// Check if the fileData matches store filter
const filter = this.store.getFilter();
if (filter && filter.check) {
filter.check(fileData);
}
const fileId = this.store.create(fileData);
const token = this.store.createToken(fileId);
const tmpFile = UploadFS.getTempFilePath(fileId);
try {
if (streamOrBuffer instanceof stream) {
streamOrBuffer.pipe(fs.createWriteStream(tmpFile));
} else if (streamOrBuffer instanceof Buffer) {
fs.writeFileSync(tmpFile, streamOrBuffer);
} else {
throw new Error('Invalid file type');
}
const file = Meteor.call('ufsComplete', fileId, this.name, token);
if (cb) {
cb(null, file);
}
return file;
} catch (e) {
if (cb) {
cb(e);
} else {
throw e;
}
}
}
}
| [FIX] Add image dimensions to attachment even when no reorientation is required (#11521)
| packages/rocketchat-file-upload/server/lib/FileUpload.js | [FIX] Add image dimensions to attachment even when no reorientation is required (#11521) | <ide><path>ackages/rocketchat-file-upload/server/lib/FileUpload.js
<ide> },
<ide> };
<ide>
<del> if (metadata.orientation == null) {
<del> return fut.return();
<del> }
<del>
<del> s.rotate()
<del> .toFile(`${ tmpFile }.tmp`)
<del> .then(Meteor.bindEnvironment(() => {
<del> fs.unlink(tmpFile, Meteor.bindEnvironment(() => {
<del> fs.rename(`${ tmpFile }.tmp`, tmpFile, Meteor.bindEnvironment(() => {
<del> const { size } = fs.lstatSync(tmpFile);
<del> this.getCollection().direct.update({ _id: file._id }, {
<del> $set: {
<del> size,
<del> identify,
<del> },
<del> });
<del> fut.return();
<add> const reorientation = (cb) => {
<add> if (!metadata.orientation) {
<add> return cb();
<add> }
<add> s.rotate()
<add> .toFile(`${ tmpFile }.tmp`)
<add> .then(Meteor.bindEnvironment(() => {
<add> fs.unlink(tmpFile, Meteor.bindEnvironment(() => {
<add> fs.rename(`${ tmpFile }.tmp`, tmpFile, Meteor.bindEnvironment(() => {
<add> cb();
<add> }));
<ide> }));
<del> }));
<del> })).catch((err) => {
<del> console.error(err);
<del> fut.return();
<add> })).catch((err) => {
<add> console.error(err);
<add> fut.return();
<add> });
<add>
<add> return;
<add> };
<add>
<add> reorientation(() => {
<add> const { size } = fs.lstatSync(tmpFile);
<add> this.getCollection().direct.update({ _id: file._id }, {
<add> $set: { size, identify },
<ide> });
<add>
<add> fut.return();
<add> });
<ide> }));
<ide>
<ide> return fut.wait(); |
|
Java | apache-2.0 | 8efa01df1d85a98e76e5301f2c821f8a5bc2ba4b | 0 | rafizanbaharum/cfi-gov | package net.canang.cfi.core.so.dao.impl;
import net.canang.cfi.core.exception.RecursiveGroupException;
import net.canang.cfi.core.so.dao.CfPrincipalDao;
import net.canang.cfi.core.so.dao.CfRoleDao;
import net.canang.cfi.core.so.dao.DaoSupport;
import net.canang.cfi.core.so.model.*;
import net.canang.cfi.core.so.model.impl.CfPrincipalImpl;
import org.apache.log4j.Logger;
import org.hibernate.Query;
import org.hibernate.Session;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.stereotype.Repository;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* @author canang.technologies
* @since 7/12/13
*/
@Repository("principalDao")
public class CfPrincipalDaoImpl extends DaoSupport<Long, CfPrincipal, CfPrincipalImpl> implements CfPrincipalDao {
private static final Logger log = Logger.getLogger(CfPrincipalDaoImpl.class);
private CfRoleDao roleDao;
private boolean allowRecursiveGroup = false;
private Set<String> groupName = null;
@Override
public List<CfPrincipal> findAllPrincipals() {
Session session = sessionFactory.getCurrentSession();
List<CfPrincipal> results = new ArrayList<CfPrincipal>();
Query query = session.createQuery("select p from CfUser p where p.metadata.state = :state order by p.name");
query.setInteger("state", CfMetaState.ACTIVE.ordinal());
results.addAll((List<CfPrincipal>) query.list());
Query queryGroup = session.createQuery("select p from CfGroup p where p.metadata.state = :state order by p.name ");
queryGroup.setInteger("state", CfMetaState.ACTIVE.ordinal());
results.addAll((List<CfPrincipal>) queryGroup.list());
return results;
}
@Override
public List<CfPrincipal> findPrincipals(String filter) {
Session session = sessionFactory.getCurrentSession();
List<CfPrincipal> results = new ArrayList<CfPrincipal>();
Query query = session.createQuery("select p from CfPrincipal p where p.metadata.state = :state and p.name like :filter order by p.name");
query.setInteger("state", CfMetaState.ACTIVE.ordinal());
query.setString("filter", WILDCARD + filter + WILDCARD);
results.addAll((List<CfPrincipal>) query.list());
return results;
}
@Override
public List<CfPrincipal> findPrincipals(String filter, CfPrincipalType type) {
Session session = sessionFactory.getCurrentSession();
List<CfPrincipal> results = new ArrayList<CfPrincipal>();
Query query = session.createQuery("select p from CfPrincipal p where " +
"p.metadata.state = :state " +
"and p.name like :filter " +
"and p.principalType = :principalType " +
"order by p.name");
query.setInteger("state", CfMetaState.ACTIVE.ordinal());
query.setString("filter", WILDCARD + filter + WILDCARD);
query.setInteger("principalType", type.ordinal());
results.addAll((List<CfPrincipal>) query.list());
return results;
}
/**
* find principal
*
* @param offset offset
* @param limit limit
* @return list of principals
*/
@Override
public List<CfPrincipal> findPrincipals(Integer offset, Integer limit) {
Session session = sessionFactory.getCurrentSession();
Query query = session.createQuery("select p from CfPrincipal p");
query.setFirstResult(offset);
query.setMaxResults(limit);
return (List<CfPrincipal>) query.list();
}
@Override
public Set<CfGroup> loadEffectiveGroups(CfPrincipal principal) throws RecursiveGroupException {
/**
with recursive q(user_name,group_name,member_id,group_id) as (
select h.user_name,h.group_name,h.member_id,h.group_id, 1 as level from (
select u1.name user_name,g1.name group_name,member_id,group_id from cf_pcpl u1, cf_user u2, cf_pcpl g1, cf_grop g2, cf_grop_mmbr g3
where u1.id = u2.id
and g1.id = g2.id and g1.id = g3.group_id
and g3.member_id = u1.id
) h
union all
select hi.user_name,hi.group_name,hi.member_id,hi.group_id, q.level + 1 as level
from q, (
select u1.name user_name,g1.name group_name,member_id,group_id from cf_pcpl u1, cf_user u2, cf_pcpl g1, cf_grop g2, cf_grop_mmbr g3
where u1.id = u2.id
and g1.id = g2.id and g1.id = g3.group_id
and g3.member_id = u1.id
)hi where hi.member_id = q.group_id
)
select * from q;
*/
return null; // TODO:
}
public Set<GrantedAuthority> loadEffectiveAuthorities(CfPrincipal principal) throws RecursiveGroupException {
return new HashSet<GrantedAuthority>(); // todo
}
@Override
public CfPrincipal findByName(String name) {
Session session = sessionFactory.getCurrentSession();
log.debug("Searching for principal " + name);
Query query = session.createQuery("select p from CfPrincipal p where p.name = :name");
query.setString("name", name);
return (CfPrincipal) query.uniqueResult();
}
}
| src/main/java/net/canang/cfi/core/so/dao/impl/CfPrincipalDaoImpl.java | package net.canang.cfi.core.so.dao.impl;
import net.canang.cfi.core.exception.RecursiveGroupException;
import net.canang.cfi.core.so.dao.CfPrincipalDao;
import net.canang.cfi.core.so.dao.CfRoleDao;
import net.canang.cfi.core.so.dao.DaoSupport;
import net.canang.cfi.core.so.model.*;
import net.canang.cfi.core.so.model.impl.CfPrincipalImpl;
import org.apache.log4j.Logger;
import org.hibernate.Query;
import org.hibernate.Session;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.stereotype.Repository;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* @author canang.technologies
* @since 7/12/13
*/
@Repository("principalDao")
public class CfPrincipalDaoImpl extends DaoSupport<Long, CfPrincipal, CfPrincipalImpl> implements CfPrincipalDao {
private static final Logger log = Logger.getLogger(CfPrincipalDaoImpl.class);
private CfRoleDao roleDao;
private boolean allowRecursiveGroup = false;
private Set<String> groupName = null;
@Override
public List<CfPrincipal> findAllPrincipals() {
Session session = sessionFactory.getCurrentSession();
List<CfPrincipal> results = new ArrayList<CfPrincipal>();
Query query = session.createQuery("select p from CfUser p where p.metadata.state = :state order by p.name");
query.setInteger("state", CfMetaState.ACTIVE.ordinal());
results.addAll((List<CfPrincipal>) query.list());
Query queryGroup = session.createQuery("select p from CfGroup p where p.metadata.state = :state order by p.name ");
queryGroup.setInteger("state", CfMetaState.ACTIVE.ordinal());
results.addAll((List<CfPrincipal>) queryGroup.list());
return results;
}
@Override
public List<CfPrincipal> findPrincipals(String filter) {
Session session = sessionFactory.getCurrentSession();
List<CfPrincipal> results = new ArrayList<CfPrincipal>();
Query query = session.createQuery("select p from CfPrincipal p where p.metadata.state = :state and p.name like :filter order by p.name");
query.setInteger("state", CfMetaState.ACTIVE.ordinal());
query.setString("filter", WILDCARD + filter + WILDCARD);
results.addAll((List<CfPrincipal>) query.list());
return results;
}
@Override
public List<CfPrincipal> findPrincipals(String filter, CfPrincipalType type) {
Session session = sessionFactory.getCurrentSession();
List<CfPrincipal> results = new ArrayList<CfPrincipal>();
Query query = session.createQuery("select p from CfPrincipal p where " +
"p.metadata.state = :state " +
"and p.name like :filter " +
"and p.principalType = :principalType " +
"order by p.name");
query.setInteger("state", CfMetaState.ACTIVE.ordinal());
query.setString("filter", WILDCARD + filter + WILDCARD);
query.setInteger("principalType", type.ordinal());
results.addAll((List<CfPrincipal>) query.list());
return results;
}
/**
* find principal
*
* @param offset offset
* @param limit limit
* @return list of principals
*/
@Override
public List<CfPrincipal> findPrincipals(Integer offset, Integer limit) {
Session session = sessionFactory.getCurrentSession();
Query query = session.createQuery("select p from CfPrincipal p");
query.setFirstResult(offset);
query.setMaxResults(limit);
return (List<CfPrincipal>) query.list();
}
@Override
public Set<CfGroup> loadEffectiveGroups(CfPrincipal principal) throws RecursiveGroupException {
return null; // TODO:
}
public Set<GrantedAuthority> loadEffectiveAuthorities(CfPrincipal principal) throws RecursiveGroupException {
return new HashSet<GrantedAuthority>(); // todo
}
@Override
public CfPrincipal findByName(String name) {
Session session = sessionFactory.getCurrentSession();
log.debug("Searching for principal " + name);
Query query = session.createQuery("select p from CfPrincipal p where p.name = :name");
query.setString("name", name);
return (CfPrincipal) query.uniqueResult();
}
}
| added potential hierarchical query
http://www.commandprompt.com/blogs/alexey_klyukin/2012/04/migrating_hierarchical_queries_from_oracle_to_postgresql/
| src/main/java/net/canang/cfi/core/so/dao/impl/CfPrincipalDaoImpl.java | added potential hierarchical query | <ide><path>rc/main/java/net/canang/cfi/core/so/dao/impl/CfPrincipalDaoImpl.java
<ide>
<ide> @Override
<ide> public Set<CfGroup> loadEffectiveGroups(CfPrincipal principal) throws RecursiveGroupException {
<add> /**
<add>with recursive q(user_name,group_name,member_id,group_id) as (
<add>select h.user_name,h.group_name,h.member_id,h.group_id, 1 as level from (
<add>select u1.name user_name,g1.name group_name,member_id,group_id from cf_pcpl u1, cf_user u2, cf_pcpl g1, cf_grop g2, cf_grop_mmbr g3
<add>where u1.id = u2.id
<add>and g1.id = g2.id and g1.id = g3.group_id
<add>and g3.member_id = u1.id
<add>) h
<add>union all
<add>select hi.user_name,hi.group_name,hi.member_id,hi.group_id, q.level + 1 as level
<add>from q, (
<add>select u1.name user_name,g1.name group_name,member_id,group_id from cf_pcpl u1, cf_user u2, cf_pcpl g1, cf_grop g2, cf_grop_mmbr g3
<add>where u1.id = u2.id
<add>and g1.id = g2.id and g1.id = g3.group_id
<add>and g3.member_id = u1.id
<add>)hi where hi.member_id = q.group_id
<add>)
<add>select * from q;
<add> */
<add>
<add>
<ide> return null; // TODO:
<ide>
<ide> } |
|
Java | mit | 1ac791f05f5a7eff1daad98f1b89f84cc5954030 | 0 | retuxx/sig4j,msteinbeck/sig4j | package com.github.sig4j;
import com.github.sig4j.dispatcher.JavaFXDispatcher;
import com.github.sig4j.dispatcher.SwingDispatcher;
import java.util.AbstractMap.SimpleEntry;
import java.util.Map.Entry;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedDeque;
import java.util.concurrent.atomic.AtomicBoolean;
import static com.github.sig4j.Type.DIRECT;
import static com.github.sig4j.Type.JAVAFX;
import static com.github.sig4j.Type.SWING;
/**
* The base class of all signals.
*
* Note:
* Connecting and emitting slots concurrently is thread safe without blocking.
*/
@SuppressWarnings("WeakerAccess")
public abstract class Signal {
/**
* The {@link Dispatcher} of {@link Type#QUEUED} connected slots.
*/
private static final Dispatcher DISPATCHER = new Dispatcher();
static {
DISPATCHER.start();
}
/**
* Indicates whether a signal is enabled/disabled.
* @see #enable()
* @see #disable()
*/
private final AtomicBoolean enabled = new AtomicBoolean(true);
/**
* The queue of {@link Type#DIRECT} connected slots.
*/
private Queue<Slot> direct = new ConcurrentLinkedDeque<>();
/**
* The queue of {@link Type#QUEUED} connected slots.
*/
private Queue<Slot> queued = new ConcurrentLinkedDeque<>();
/**
* The queue of dispatched slots {@see Dispatcher}.
*/
private Queue<Entry<Slot, Dispatcher>>
dispatched = new ConcurrentLinkedDeque<>();
/**
* Enables this signal.
* @see #disable()
*/
public void enable() {
enabled.set(true);
}
/**
* Disables this signal. A disabled signal will not actuate its connected
* slots.
* @see #enable()
*/
public void disable() {
enabled.set(false);
}
/**
* Removes all connected slots. Clearing a signal is not an atomic
* operation and may result in a non-empty slot queue if one of the
* 'connect' methods is used concurrently.
*/
public void clear() {
direct.clear();
queued.clear();
dispatched.clear();
}
/**
* Connects the given slot using {@link Type#DIRECT}. This method is
* equivalent to {@code connect(slot, Type.DIRECT)}.
*
* @param slot The slot to connect.
* @throws IllegalArgumentException If {@code slot} is {@code null}.
*/
protected void connect(final Slot slot) {
if (slot == null) {
throw new IllegalArgumentException("slot is null");
}
direct.add(slot);
}
/**
* Connects the given slot according to {@link Type}.
*
* @param slot The slot to connect.
* @param type The connection type.
* @throws IllegalArgumentException If {@code slot} or {@code type} is
* {@code null}.
*/
protected void connect(final Slot slot, final Type type) {
if (slot == null) {
throw new IllegalArgumentException("slot is null");
} else if (type == null) {
throw new IllegalArgumentException("connection type is null");
} else if (type == DIRECT) {
direct.add(slot);
} else if (type == JAVAFX) {
connect(slot, JavaFXDispatcher.getInstance());
} else if (type == SWING) {
connect(slot, SwingDispatcher.getInstance());
} else {
queued.add(slot);
}
}
/**
* Connects the given slot and actuates it within the thread context of the
* given {@link Dispatcher} if the signal is emitted.
*
* @param slot The slot to connect.
* @param dispatcher The {@link Dispatcher} to use.
* @throws IllegalArgumentException If {@code slot} or {@code dispatcher}
* is {@code null}.
*/
protected void connect(final Slot slot, final Dispatcher dispatcher) {
if (slot == null) {
throw new IllegalArgumentException("slot is null");
} else if (dispatcher == null) {
throw new IllegalArgumentException("dispatcher is null");
}
dispatched.add(new SimpleEntry<>(slot, dispatcher));
}
/**
* Emits this signal with the given arguments.
*
* @param args The arguments to use pass to the connected slots.
*/
protected void emit(final Object... args) {
if (enabled.get()) {
dispatched.forEach(da -> {
final SlotActuation sa = new SlotActuation(da.getKey(), args);
da.getValue().actuate(sa);
});
queued.forEach(s -> {
final SlotActuation sa = new SlotActuation(s, args);
DISPATCHER.actuate(sa);
});
direct.forEach(s -> actuate(s, args));
}
}
/**
* A callback method used for slot actuation.
*
* The implementer of this method does not need to create any threads, but
* cast down the given slot and actuate it with the given arguments.
*
* This method should not have any side effects to this class.
*
* @param slot The slot to actuate.
* @param args The arguments of the actuated slot.
*/
protected abstract void actuate(final Slot slot, final Object[] args);
/**
* Represents a slot actuation. Use {@link #actuate()} to actuate the slot
* with its arguments.
*/
class SlotActuation {
private final Slot slot;
private final Object[] arguments;
private SlotActuation(final Slot s, final Object[] args) {
slot = s;
arguments = args;
}
void actuate() {
Signal.this.actuate(slot, arguments);
}
}
}
| src/main/java/com/github/sig4j/Signal.java | package com.github.sig4j;
import com.github.sig4j.dispatcher.JavaFXDispatcher;
import com.github.sig4j.dispatcher.SwingDispatcher;
import java.util.AbstractMap.SimpleEntry;
import java.util.Map.Entry;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedDeque;
import java.util.concurrent.atomic.AtomicBoolean;
import static com.github.sig4j.Type.DIRECT;
import static com.github.sig4j.Type.JAVAFX;
import static com.github.sig4j.Type.SWING;
/**
* The base class of all signals.
*
* Note:
* Connecting and emitting slots concurrently is thread safe without blocking.
*/
@SuppressWarnings("WeakerAccess")
public abstract class Signal {
/**
* The {@link Dispatcher} of {@link Type#QUEUED} connected slots.
*/
private static final Dispatcher DISPATCHER = new Dispatcher();
static {
DISPATCHER.start();
}
/**
* Indicates whether a signal is enabled/disabled.
* @see #enable()
* @see #disable()
*/
private final AtomicBoolean enabled = new AtomicBoolean(true);
/**
* The queue of {@link Type#DIRECT} connected slots.
*/
private Queue<Slot> direct = new ConcurrentLinkedDeque<>();
/**
* The queue of {@link Type#QUEUED} connected slots.
*/
private Queue<Slot> queued = new ConcurrentLinkedDeque<>();
/**
* The queue of dispatched slots {@see Dispatcher}.
*/
private Queue<Entry<Slot, Dispatcher>>
dispatched = new ConcurrentLinkedDeque<>();
/**
* Enables this signal.
* @see #disable()
*/
public void enable() {
enabled.set(true);
}
/**
* Disables this signal. A disabled signal will not actuate its connected
* slots.
* @see #enable()
*/
public void disable() {
enabled.set(false);
}
/**
* Removes all connected slots. Clearing a signal is not an atomic
* operation and may result in a non-empty slot queue if one of the
* 'connect' methods is used concurrently.
*/
public void clear() {
direct.clear();
queued.clear();
dispatched.clear();
}
/**
* Connects the given slot using {@link Type#DIRECT}. This method is
* equivalent to {@code connect(slot, Type.DIRECT)}.
*
* @param slot The slot to connect.
* @throws IllegalArgumentException If {@code slot} is {@code null}.
*/
protected void connect(final Slot slot) {
if (slot == null) {
throw new IllegalArgumentException("slot is null");
}
direct.add(slot);
}
/**
* Connects the given slot according to {@link Type}.
*
* @param slot The slot to connect.
* @param type The connection type.
* @throws IllegalArgumentException If {@code slot} or {@code type} is
* {@code null}.
*/
protected void connect(final Slot slot, final Type type) {
if (slot == null) {
throw new IllegalArgumentException("slot is null");
} else if (type == null) {
throw new IllegalArgumentException("connection type is null");
} else if (type == DIRECT) {
direct.add(slot);
} else if (type == JAVAFX) {
connect(slot, JavaFXDispatcher.getInstance());
} else if (type == SWING) {
connect(slot, SwingDispatcher.getInstance());
} else {
queued.add(slot);
}
}
/**
* Connects the given slot and actuates it within the thread context of the
* given {@link Dispatcher} if the signal is emitted.
*
* @param slot The slot to connect.
* @param dispatcher The {@link Dispatcher} to use.
* @throws IllegalArgumentException If {@code dispatcher} or {@code slot}
* is {@code null}.
*/
protected void connect(final Slot slot, final Dispatcher dispatcher) {
if (slot == null) {
throw new IllegalArgumentException("slot is null");
} else if (dispatcher == null) {
throw new IllegalArgumentException("dispatcher is null");
}
dispatched.add(new SimpleEntry<>(slot, dispatcher));
}
/**
* Emits this signal with the given arguments.
*
* @param args The arguments to use pass to the connected slots.
*/
protected void emit(final Object... args) {
if (enabled.get()) {
dispatched.forEach(da -> {
final SlotActuation sa = new SlotActuation(da.getKey(), args);
da.getValue().actuate(sa);
});
queued.forEach(s -> {
final SlotActuation sa = new SlotActuation(s, args);
DISPATCHER.actuate(sa);
});
direct.forEach(s -> actuate(s, args));
}
}
/**
* A callback method used for slot actuation.
*
* The implementer of this method does not need to create any threads, but
* cast down the given slot and actuate it with the given arguments.
*
* This method should not have any side effects to this class.
*
* @param slot The slot to actuate.
* @param args The arguments of the actuated slot.
*/
protected abstract void actuate(final Slot slot, final Object[] args);
/**
* Represents a slot actuation. Use {@link #actuate()} to actuate the slot
* with its arguments.
*/
class SlotActuation {
private final Slot slot;
private final Object[] arguments;
private SlotActuation(final Slot s, final Object[] args) {
slot = s;
arguments = args;
}
void actuate() {
Signal.this.actuate(slot, arguments);
}
}
}
| Minor docu fix.
| src/main/java/com/github/sig4j/Signal.java | Minor docu fix. | <ide><path>rc/main/java/com/github/sig4j/Signal.java
<ide> *
<ide> * @param slot The slot to connect.
<ide> * @param dispatcher The {@link Dispatcher} to use.
<del> * @throws IllegalArgumentException If {@code dispatcher} or {@code slot}
<add> * @throws IllegalArgumentException If {@code slot} or {@code dispatcher}
<ide> * is {@code null}.
<ide> */
<ide> protected void connect(final Slot slot, final Dispatcher dispatcher) { |
|
Java | mit | 7106f0bd982b61ead3f935e99993813ca9b1e6da | 0 | monapu/multimona,GroestlCoin/MultiGroestl,bslote/multibit,HashEngineering/digitalcoin-multibit,langerhans/multidoge,myronkaradimas/multibit,ai-coin/multibit,myronkaradimas/multibit,bubuntux/multibit,HashEngineering/digitalcoin-multibit,GroestlCoin/MultiGroestl,bitcoin-solutions/multibit,bubuntux/multibit,monapu/multimona,bitcartel/multibit,da2ce7/multibit,gregthegeek/multibit,ai-coin/multibit,langerhans/multidoge,travisfw/multibit,travisfw/multibit,gregthegeek/multibit,da2ce7/multibit,bslote/multibit,jim618/multibit,bitcartel/multibit | /**
* Copyright 2011 Google Inc.
*
* 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.google.bitcoin.core;
import static com.google.bitcoin.core.Utils.bitcoinValueToFriendlyString;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.ExecutionException;
import org.bitcoinj.wallet.Protos.Wallet.EncryptionType;
import org.multibit.IsMultiBitClass;
import org.multibit.MultiBit;
import org.multibit.store.MultiBitWalletProtobufSerializer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.spongycastle.crypto.params.KeyParameter;
import com.google.bitcoin.core.TransactionConfidence.ConfidenceType;
import com.google.bitcoin.core.WalletTransaction.Pool;
import com.google.bitcoin.crypto.EncryptedPrivateKey;
import com.google.bitcoin.crypto.KeyCrypter;
import com.google.bitcoin.crypto.KeyCrypterException;
import com.google.bitcoin.crypto.WalletIsAlreadyDecryptedException;
import com.google.bitcoin.crypto.WalletIsAlreadyEncryptedException;
import com.google.bitcoin.store.WalletProtobufSerializer;
import com.google.bitcoin.utils.EventListenerInvoker;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.util.concurrent.ListenableFuture;
// To do list:
//
// - Make the keychain member protected and switch it to be a hashmap of some kind so key lookup ops are faster.
// - Refactor how keys are managed to better handle things like deterministic wallets in future.
// - Decompose the class where possible: break logic out into classes that can be customized/replaced by the user.
// - Coin selection
// - [Auto]saving to a backing store
// - Key management
// - just generally make Wallet smaller and easier to work with
// - Make clearing of transactions able to only rewind the wallet a certain distance instead of all blocks.
/**
* <p>A Wallet stores keys and a record of transactions that send and receive value from those keys. Using these,
* it is able to create new transactions that spend the recorded transactions, and this is the fundamental operation
* of the Bitcoin protocol.</p>
*
* <p>To learn more about this class, read <b><a href="http://code.google.com/p/bitcoinj/wiki/WorkingWithTheWallet">
* working with the wallet.</a></b></p>
*
* <p>To fill up a Wallet with transactions, you need to use it in combination with a {@link BlockChain} and various
* other objects, see the <a href="http://code.google.com/p/bitcoinj/wiki/GettingStarted">Getting started</a> tutorial
* on the website to learn more about how to set everything up.</p>
*
* <p>Wallets can be serialized using either Java serialization - this is not compatible across versions of bitcoinj,
* or protocol buffer serialization. You need to save the wallet whenever it changes, there is an auto-save feature
* that simplifies this for you although you're still responsible for manually triggering a save when your app is about
* to quit because the auto-save feature waits a moment before actually committing to disk to avoid IO thrashing when
* the wallet is changing very fast (eg due to a block chain sync). See
* {@link Wallet#autosaveToFile(java.io.File, long, java.util.concurrent.TimeUnit, com.google.bitcoin.core.Wallet.AutosaveEventListener)}
* for more information about this.</p>
*/
public class Wallet implements Serializable, IsMultiBitClass {
private static final Logger log = LoggerFactory.getLogger(Wallet.class);
private static final long serialVersionUID = 2L;
public static final int MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND = 2;
// Algorithm for movement of transactions between pools. Outbound tx = us spending coins. Inbound tx = us
// receiving coins. If a tx is both inbound and outbound (spend with change) it is considered outbound for the
// purposes of the explanation below.
//
// 1. Outbound tx is created by us: ->pending
// 2. Outbound tx that was broadcast is accepted into the main chain:
// <-pending and
// If there is a change output ->unspent
// If there is no change output ->spent
// 3. Outbound tx that was broadcast is accepted into a side chain:
// ->inactive (remains in pending).
// 4. Inbound tx is accepted into the best chain:
// ->unspent/spent
// 5. Inbound tx is accepted into a side chain:
// ->inactive
// Whilst it's also 'pending' in some sense, in that miners will probably try and incorporate it into the
// best chain, we don't mark it as such here. It'll eventually show up after a re-org.
// 6. Outbound tx that is pending shares inputs with a tx that appears in the main chain:
// <-pending ->dead
//
// Re-orgs:
// 1. Tx is present in old chain and not present in new chain
// <-unspent/spent ->pending
// These newly inactive transactions will (if they are relevant to us) eventually come back via receive()
// as miners resurrect them and re-include into the new best chain.
// 2. Tx is not present in old chain and is present in new chain
// <-inactive and ->unspent/spent
// 3. Tx is present in new chain and shares inputs with a pending transaction, including those that were resurrected
// due to point (1)
// <-pending ->dead
//
// Balance:
// 1. Sum up all unspent outputs of the transactions in unspent.
// 2. Subtract the inputs of transactions in pending.
// 3. If requested, re-add the outputs of pending transactions that are mine. This is the estimated balance.
/**
* Map of txhash->Transactions that have not made it into the best chain yet. They are eligible to move there but
* are waiting for a miner to create a block on the best chain including them. These transactions inputs count as
* spent for the purposes of calculating our balance but their outputs are not available for spending yet. This
* means after a spend, our balance can actually go down temporarily before going up again! We should fix this to
* allow spending of pending transactions.
*
* Pending transactions get announced to peers when they first connect. This means that if we're currently offline,
* we can still create spends and upload them to the network later.
*/
final Map<Sha256Hash, Transaction> pending;
/**
* Map of txhash->Transactions where the Transaction has unspent outputs. These are transactions we can use
* to pay other people and so count towards our balance. Transactions only appear in this map if they are part
* of the best chain. Transactions we have broacast that are not confirmed yet appear in pending even though they
* may have unspent "change" outputs.<p>
* <p/>
* Note: for now we will not allow spends of transactions that did not make it into the block chain. The code
* that handles this in BitCoin C++ is complicated. Satoshis code will not allow you to spend unconfirmed coins,
* however, it does seem to support dependency resolution entirely within the context of the memory pool so
* theoretically you could spend zero-conf coins and all of them would be included together. To simplify we'll
* make people wait but it would be a good improvement to resolve this in future.
*/
final Map<Sha256Hash, Transaction> unspent;
/**
* Map of txhash->Transactions where the Transactions outputs are all fully spent. They are kept separately so
* the time to create a spend does not grow infinitely as wallets become more used. Some of these transactions
* may not have appeared in a block yet if they were created by us to spend coins and that spend is still being
* worked on by miners.<p>
* <p/>
* Transactions only appear in this map if they are part of the best chain.
*/
final Map<Sha256Hash, Transaction> spent;
/**
* An inactive transaction is one that is seen only in a block that is not a part of the best chain. We keep it
* around in case a re-org promotes a different chain to be the best. In this case some (not necessarily all)
* inactive transactions will be moved out to unspent and spent, and some might be moved in.<p>
* <p/>
* Note that in the case where a transaction appears in both the best chain and a side chain as well, it is not
* placed in this map. It's an error for a transaction to be in both the inactive pool and unspent/spent.
*/
final Map<Sha256Hash, Transaction> inactive;
/**
* A dead transaction is one that's been overridden by a double spend. Such a transaction is pending except it
* will never confirm and so should be presented to the user in some unique way - flashing red for example. This
* should nearly never happen in normal usage. Dead transactions can be "resurrected" by re-orgs just like any
* other. Dead transactions are not in the pending pool.
*/
final Map<Sha256Hash, Transaction> dead;
/**
* A list of public/private EC keys owned by this user. Access it using addKey[s], hasKey[s] and findPubKeyFromHash.
*/
public ArrayList<ECKey> keychain;
private final NetworkParameters params;
/**
* The hash of the last block seen on the best chain
*/
private Sha256Hash lastBlockSeenHash;
private transient ArrayList<WalletEventListener> eventListeners;
// A listener that relays confidence changes from the transaction confidence object to the wallet event listener,
// as a convenience to API users so they don't have to register on every transaction themselves.
private transient TransactionConfidence.Listener txConfidenceListener;
// If a TX hash appears in this set then notifyNewBestBlock will ignore it, as its confidence was already set up
// in receive() via Transaction.setBlockAppearance(). As the BlockChain always calls notifyNewBestBlock even if
// it sent transactions to the wallet, without this we'd double count.
private transient HashSet<Sha256Hash> ignoreNextNewBlock;
/**
* The keyCrypter for the wallet. This specifies the algorithm used for encrypting and decrypting the private keys.
* Null for an unencrypted wallet.
*/
private KeyCrypter keyCrypter;
/**
* The wallet version. This is an ordinal used to detect breaking changes in the wallet format.
*/
WalletVersion version;
/**
* A description for the wallet. This is persisted in the wallet file.
*/
String description;
/**
* Creates a new, empty wallet with no keys and no transactions. If you want to restore a wallet from disk instead,
* see loadFromFile.
*/
public Wallet(NetworkParameters params) {
this(params, null);
}
/**
* Create a wallet with a keyCrypter to use in encrypting and decrypting keys.
*/
public Wallet(NetworkParameters params, KeyCrypter keyCrypter) {
this.params = params;
this.keyCrypter = keyCrypter;
keychain = new ArrayList<ECKey>();
unspent = new HashMap<Sha256Hash, Transaction>();
spent = new HashMap<Sha256Hash, Transaction>();
inactive = new HashMap<Sha256Hash, Transaction>();
pending = new HashMap<Sha256Hash, Transaction>();
dead = new HashMap<Sha256Hash, Transaction>();
createTransientState();
}
private void createTransientState() {
eventListeners = new ArrayList<WalletEventListener>();
ignoreNextNewBlock = new HashSet<Sha256Hash>();
txConfidenceListener = new TransactionConfidence.Listener() {
@Override
public void onConfidenceChanged(Transaction tx) {
invokeOnTransactionConfidenceChanged(tx);
// Many onWalletChanged events will not occur because they are suppressed, eg, because:
// - we are inside a re-org
// - we are in the middle of processing a block
// - the confidence is changing because a new best block was accepted
// It will run in cases like:
// - the tx is pending and another peer announced it
// - the tx is pending and was killed by a detected double spend that was not in a block
// The latter case cannot happen today because we won't hear about it, but in future this may
// become more common if conflict notices are implemented.
invokeOnWalletChanged();
}
};
}
public NetworkParameters getNetworkParameters() {
return params;
}
/**
* Returns a snapshot of the keychain. This view is not live.
*/
public synchronized Iterable<ECKey> getKeys() {
return new ArrayList<ECKey>(keychain);
}
/**
* Uses protobuf serialization to save the wallet to the given file. To learn more about this file format, see
* {@link WalletProtobufSerializer}.
*
* This method is keep simple as the file saving lifecycle is dealt with in FileHandler.
*/
public synchronized void saveToFile(File destFile) throws IOException {
FileOutputStream stream = null;
try {
stream = new FileOutputStream(destFile);
saveToFileStream(stream);
// Attempt to force the bits to hit the disk. In reality the OS or hard disk itself may still decide
// to not write through to physical media for at least a few seconds, but this is the best we can do.
stream.flush();
stream.getFD().sync();
stream.close();
stream = null;
} finally {
if (stream != null) {
stream.close();
}
}
}
/**
* Uses protobuf serialization to save the wallet to the given file stream. To learn more about this file format, see
* {@link WalletProtobufSerializer}.
*/
public synchronized void saveToFileStream(OutputStream f) throws IOException {
new MultiBitWalletProtobufSerializer().writeWallet(this, f);
}
/** Returns the parameters this wallet was created with. */
public NetworkParameters getParams() {
return params;
}
/**
* Returns a wallet deserialized from the given file.
* @throws KeyCrypterException
*/
public static Wallet loadFromFile(File f) throws IOException, KeyCrypterException {
FileInputStream stream = new FileInputStream(f);
try {
return loadFromFileStream(stream);
} finally {
stream.close();
}
}
public boolean isConsistent() {
// Seems overzealous so switch off for now.
return true;
}
/**
* Returns a wallet deserialized from the given input stream.
* @throws KeyCrypterException
*/
public static Wallet loadFromFileStream(InputStream stream) throws IOException, KeyCrypterException {
// Determine what kind of wallet stream this is: Java Serialization or protobuf format.
stream = new BufferedInputStream(stream);
stream.mark(100);
boolean serialization = stream.read() == 0xac && stream.read() == 0xed;
stream.reset();
Wallet wallet;
if (serialization) {
ObjectInputStream ois = null;
try {
ois = new ObjectInputStream(stream);
wallet = (Wallet) ois.readObject();
} catch (ClassNotFoundException e) {
throw new RuntimeException(e);
} finally {
if (ois != null) ois.close();
}
} else {
MultiBitWalletProtobufSerializer walletProtobufSerializer = new MultiBitWalletProtobufSerializer();
if (MultiBit.getController() != null && MultiBit.getController().getMultiBitService() != null
&& MultiBit.getController().getMultiBitService().getChain() != null) {
walletProtobufSerializer.setChainHeight(MultiBit.getController().getMultiBitService().getChain().getBestChainHeight());
}
wallet = walletProtobufSerializer.readWallet(stream);
}
if (!wallet.isConsistent()) {
log.error("Loaded an inconsistent wallet");
}
return wallet;
}
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
createTransientState();
}
/**
* Called by the {@link BlockChain} when we receive a new block that sends coins to one of our addresses or
* spends coins from one of our addresses (note that a single transaction can do both).<p>
*
* This is necessary for the internal book-keeping Wallet does. When a transaction is received that sends us
* coins it is added to a pool so we can use it later to create spends. When a transaction is received that
* consumes outputs they are marked as spent so they won't be used in future.<p>
*
* A transaction that spends our own coins can be received either because a spend we created was accepted by the
* network and thus made it into a block, or because our keys are being shared between multiple instances and
* some other node spent the coins instead. We still have to know about that to avoid accidentally trying to
* double spend.<p>
*
* A transaction may be received multiple times if is included into blocks in parallel chains. The blockType
* parameter describes whether the containing block is on the main/best chain or whether it's on a presently
* inactive side chain. We must still record these transactions and the blocks they appear in because a future
* block might change which chain is best causing a reorganize. A re-org can totally change our balance!
*/
public synchronized void receiveFromBlock(Transaction tx, StoredBlock block,
BlockChain.NewBlockType blockType) throws VerificationException {
receive(tx, block, blockType, false);
}
/**
* Called when we have found a transaction (via network broadcast or otherwise) that is relevant to this wallet
* and want to record it. Note that we <b>cannot verify these transactions at all</b>, they may spend fictional
* coins or be otherwise invalid. They are useful to inform the user about coins they can expect to receive soon,
* and if you trust the sender of the transaction you can choose to assume they are in fact valid and will not
* be double spent as an optimization.
*
* @param tx
* @throws VerificationException
*/
public synchronized void receivePending(Transaction tx) throws VerificationException {
// Can run in a peer thread.
// Ignore it if we already know about this transaction. Receiving a pending transaction never moves it
// between pools.
EnumSet<Pool> containingPools = getContainingPools(tx);
if (!containingPools.equals(EnumSet.noneOf(Pool.class))) {
log.debug("Received tx we already saw in a block or created ourselves: " + tx.getHashAsString());
return;
}
// We only care about transactions that:
// - Send us coins
// - Spend our coins
if (!isTransactionRelevant(tx, true)) {
log.debug("Received tx that isn't relevant to this wallet, discarding.");
return;
}
BigInteger valueSentToMe = tx.getValueSentToMe(this);
BigInteger valueSentFromMe = tx.getValueSentFromMe(this);
if (log.isInfoEnabled()) {
log.info(String.format("Received a pending transaction %s that spends %s BTC from our own wallet," +
" and sends us %s BTC", tx.getHashAsString(), Utils.bitcoinValueToFriendlyString(valueSentFromMe),
Utils.bitcoinValueToFriendlyString(valueSentToMe)));
}
// Mark the tx as having been seen but is not yet in the chain. This will normally have been done already by
// the Peer before we got to this point, but in some cases (unit tests, other sources of transactions) it may
// have been missed out.
TransactionConfidence.ConfidenceType currentConfidence = tx.getConfidence().getConfidenceType();
if (currentConfidence == TransactionConfidence.ConfidenceType.UNKNOWN) {
tx.getConfidence().setConfidenceType(TransactionConfidence.ConfidenceType.NOT_SEEN_IN_CHAIN);
// Manually invoke the wallet tx confidence listener here as we didn't yet commit therefore the
// txConfidenceListener wasn't added.
invokeOnTransactionConfidenceChanged(tx);
}
// If this tx spends any of our unspent outputs, mark them as spent now, then add to the pending pool. This
// ensures that if some other client that has our keys broadcasts a spend we stay in sync. Also updates the
// timestamp on the transaction and registers/runs event listeners.
//
// Note that after we return from this function, the wallet may have been modified.
commitTx(tx);
}
// Boilerplate that allows event listeners to delete themselves during execution, and auto locks the listener.
private void invokeOnCoinsReceived(final Transaction tx, final BigInteger balance, final BigInteger newBalance) {
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override public void invoke(WalletEventListener listener) {
listener.onCoinsReceived(Wallet.this, tx, balance, newBalance);
}
});
}
private void invokeOnCoinsSent(final Transaction tx, final BigInteger prevBalance, final BigInteger newBalance) {
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override public void invoke(WalletEventListener listener) {
listener.onCoinsSent(Wallet.this, tx, prevBalance, newBalance);
}
});
}
/**
* Returns true if the given transaction sends coins to any of our keys, or has inputs spending any of our outputs,
* and if includeDoubleSpending is true, also returns true if tx has inputs that are spending outputs which are
* not ours but which are spent by pending transactions.<p>
*
* Note that if the tx has inputs containing one of our keys, but the connected transaction is not in the wallet,
* it will not be considered relevant.
*/
public synchronized boolean isTransactionRelevant(Transaction tx,
boolean includeDoubleSpending) throws ScriptException {
return tx.isMine(this) || tx.getValueSentFromMe(this).compareTo(BigInteger.ZERO) > 0
|| tx.getValueSentToMe(this).compareTo(BigInteger.ZERO) > 0
|| (includeDoubleSpending && (findDoubleSpendAgainstPending(tx) != null));
}
/**
* Checks if "tx" is spending any inputs of pending transactions. Not a general check, but it can work even if
* the double spent inputs are not ours. Returns the pending tx that was double spent or null if none found.
*/
private Transaction findDoubleSpendAgainstPending(Transaction tx) {
// Compile a set of outpoints that are spent by tx.
HashSet<TransactionOutPoint> outpoints = new HashSet<TransactionOutPoint>();
for (TransactionInput input : tx.getInputs()) {
outpoints.add(input.getOutpoint());
}
// Now for each pending transaction, see if it shares any outpoints with this tx.
for (Transaction p : pending.values()) {
for (TransactionInput input : p.getInputs()) {
if (outpoints.contains(input.getOutpoint())) {
// It does, it's a double spend against the pending pool, which makes it relevant.
return p;
}
}
}
return null;
}
private synchronized void receive(Transaction tx, StoredBlock block,
BlockChain.NewBlockType blockType,
boolean reorg) throws VerificationException {
// Runs in a peer thread.
BigInteger prevBalance = getBalance();
Sha256Hash txHash = tx.getHash();
boolean bestChain = blockType == BlockChain.NewBlockType.BEST_CHAIN;
boolean sideChain = blockType == BlockChain.NewBlockType.SIDE_CHAIN;
BigInteger valueSentFromMe = tx.getValueSentFromMe(this);
BigInteger valueSentToMe = tx.getValueSentToMe(this);
BigInteger valueDifference = valueSentToMe.subtract(valueSentFromMe);
if (!reorg) {
log.info("Received tx {} for {} BTC: {}", new Object[]{sideChain ? "on a side chain" : "",
bitcoinValueToFriendlyString(valueDifference), tx.getHashAsString()});
}
// If the transaction is already in our spent or unspent or there is no money in it it is probably
// due to a block replay so we do not want to do anything with it
// if it is on a sidechain then let the ELSE below deal with it
// if it is a double spend it gets processed later
Transaction doubleSpend = findDoubleSpendAgainstPending(tx);
boolean alreadyHaveIt = spent.containsKey(tx.getHash()) || unspent.containsKey(tx.getHash());
boolean noMoneyInItAndNotMine = BigInteger.ZERO.equals(valueSentFromMe) && BigInteger.ZERO.equals(valueSentToMe) && !tx.isMine(this);
if (bestChain && (doubleSpend == null) && (alreadyHaveIt || noMoneyInItAndNotMine)) {
log.info("Already have tx " + tx.getHash() + " in spent/ unspent or there is no money in it and it is not mine so ignoring");
return;
}
onWalletChangedSuppressions++;
// If this transaction is already in the wallet we may need to move it into a different pool. At the very
// least we need to ensure we're manipulating the canonical object rather than a duplicate.
Transaction wtx;
if ((wtx = pending.remove(txHash)) != null) {
// Make sure "tx" is always the canonical object we want to manipulate, send to event handlers, etc.
tx = wtx;
log.info(" <-pending");
// A transaction we created appeared in a block. Probably this is a spend we broadcast that has been
// accepted by the network.
if (bestChain) {
if (valueSentToMe.equals(BigInteger.ZERO)) {
// There were no change transactions so this tx is fully spent.
log.info(" ->spent");
addWalletTransaction(Pool.SPENT, tx);
} else {
// There was change back to us, or this tx was purely a spend back to ourselves (perhaps for
// anonymization purposes).
log.info(" ->unspent");
addWalletTransaction(Pool.UNSPENT, tx);
}
} else if (sideChain) {
// The transaction was accepted on an inactive side chain, but not yet by the best chain.
log.info(" ->inactive");
// It's OK for this to already be in the inactive pool because there can be multiple independent side
// chains in which it appears:
//
// b1 --> b2
// \-> b3
// \-> b4 (at this point it's already present in 'inactive'
boolean alreadyPresent = inactive.put(tx.getHash(), tx) != null;
if (alreadyPresent)
log.info("Saw a transaction be incorporated into multiple independent side chains");
// Put it back into the pending pool, because 'pending' means 'waiting to be included in best chain'.
pending.put(tx.getHash(), tx);
}
} else {
// This TX didn't originate with us. It could be sending us coins and also spending our own coins if keys
// are being shared between different wallets.
if (sideChain) {
if (unspent.containsKey(tx.getHash()) || spent.containsKey(tx.getHash())) {
// This side chain block contains transactions that already appeared in the best chain. It's normal,
// we don't need to consider this transaction inactive, we can just ignore it.
} else {
log.info(" ->inactive");
addWalletTransaction(Pool.INACTIVE, tx);
}
} else if (bestChain) {
// Saw a non-pending transaction appear on the best chain, ie, we are replaying the chain or a spend
// that we never saw broadcast (and did not originate) got included.
//
// This can trigger tx confidence listeners to be run in the case of double spends. We may need to
// delay the execution of the listeners until the bottom to avoid the wallet mutating during updates.
processTxFromBestChain(tx, doubleSpend);
}
}
log.info("Balance is now: " + bitcoinValueToFriendlyString(getBalance()));
// WARNING: The code beyond this point can trigger event listeners on transaction confidence objects, which are
// in turn allowed to re-enter the Wallet. This means we cannot assume anything about the state of the wallet
// from now on. The balance just received may already be spent.
if (block != null) {
// Mark the tx as appearing in this block so we can find it later after a re-org. This also tells the tx
// confidence object about the block and sets its work done/depth appropriately.
tx.setBlockAppearance(block, bestChain);
if (bestChain) {
// Don't notify this tx of work done in notifyNewBestBlock which will be called immediately after
// this method has been called by BlockChain for all relevant transactions. Otherwise we'd double
// count.
ignoreNextNewBlock.add(txHash);
}
}
// Inform anyone interested that we have received or sent coins but only if:
// - This is not due to a re-org.
// - The coins appeared on the best chain.
// - We did in fact receive some new money.
// - We have not already informed the user about the coins when we received the tx broadcast, or for our
// own spends. If users want to know when a broadcast tx becomes confirmed, they need to use tx confidence
// listeners.
//
// TODO: Decide whether to run the event listeners, if a tx confidence listener already modified the wallet.
boolean wasPending = wtx != null;
if (!reorg && bestChain && !wasPending) {
BigInteger newBalance = getBalance();
int diff = valueDifference.compareTo(BigInteger.ZERO);
// We pick one callback based on the value difference, though a tx can of course both send and receive
// coins from the wallet.
if (diff > 0) {
invokeOnCoinsReceived(tx, prevBalance, newBalance);
} else if (diff == 0) {
// Hack. Invoke onCoinsSent in order to let the client save the wallet. This needs to go away.
invokeOnCoinsSent(tx, prevBalance, newBalance);
} else {
invokeOnCoinsSent(tx, prevBalance, newBalance);
}
}
// Wallet change notification will be sent shortly after the block is finished processing, in notifyNewBestBlock
onWalletChangedSuppressions--;
checkState(isConsistent());
}
/**
* <p>Called by the {@link BlockChain} when a new block on the best chain is seen, AFTER relevant wallet
* transactions are extracted and sent to us UNLESS the new block caused a re-org, in which case this will
* not be called (the {@link Wallet#reorganize(StoredBlock, java.util.List, java.util.List)} method will
* call this one in that case).</p>
*
* <p>Used to update confidence data in each transaction and last seen block hash. Triggers auto saving.
* Invokes the onWalletChanged event listener if there were any affected transactions.</p>
*/
public synchronized void notifyNewBestBlock(Block block) throws VerificationException {
// Check to see if this block has been seen before.
Sha256Hash newBlockHash = block.getHash();
if (newBlockHash.equals(getLastBlockSeenHash()))
return;
// Store the new block hash.
setLastBlockSeenHash(newBlockHash);
// TODO: Clarify the code below.
// Notify all the BUILDING transactions of the new block.
// This is so that they can update their work done and depth.
onWalletChangedSuppressions++;
Set<Transaction> transactions = getTransactions(true, false);
for (Transaction tx : transactions) {
if (ignoreNextNewBlock.contains(tx.getHash())) {
// tx was already processed in receive() due to it appearing in this block, so we don't want to
// notify the tx confidence of work done twice, it'd result in miscounting.
ignoreNextNewBlock.remove(tx.getHash());
} else {
tx.getConfidence().notifyWorkDone(block);
}
}
onWalletChangedSuppressions--;
invokeOnWalletChanged();
}
/**
* Handle when a transaction becomes newly active on the best chain, either due to receiving a new block or a
* re-org making inactive transactions active.
*/
private void processTxFromBestChain(Transaction tx, Transaction doubleSpend) throws VerificationException {
// This TX may spend our existing outputs even though it was not pending. This can happen in unit
// tests, if keys are moved between wallets, if we're catching up to the chain given only a set of keys,
// or if a dead coinbase transaction has moved back onto the main chain.
boolean isDeadCoinbase = tx.isCoinBase() && dead.containsKey(tx.getHash());
if (isDeadCoinbase) {
// There is a dead coinbase tx being received on the best chain. A coinbase tx is made dead when it moves
// to a side chain but it can be switched back on a reorg and 'resurrected' back to spent or unspent.
// So take it out of the dead pool.
log.info(" coinbase tx {} <-dead: confidence {}", tx.getHashAsString(),
tx.getConfidence().getConfidenceType().name());
dead.remove(tx.getHash());
}
if (inactive.containsKey(tx.getHash())) {
// This transaction was seen first on a side chain, but now it's also been seen in the best chain.
// So we don't need to track it as inactive anymore.
log.info(" new tx {} <-inactive", tx.getHashAsString());
inactive.remove(tx.getHash());
}
updateForSpends(tx, true);
if (!tx.getValueSentToMe(this).equals(BigInteger.ZERO)) {
// It's sending us coins.
log.info(" new tx {} ->unspent", tx.getHashAsString());
addWalletTransaction(Pool.UNSPENT, tx);
} else if (!tx.getValueSentFromMe(this).equals(BigInteger.ZERO)) {
// It spent some of our coins and did not send us any.
log.info(" new tx {} ->spent", tx.getHashAsString());
addWalletTransaction(Pool.SPENT, tx);
} else {
// It didn't send us coins nor spend any of our coins. If we're processing it, that must be because it
// spends outpoints that are also spent by some pending transactions - maybe a double spend of somebody
// elses coins that were originally sent to us? ie, this might be a Finney attack where we think we
// received some money and then the sender co-operated with a miner to take back the coins, using a tx
// that isn't involving our keys at all.
// (it can also be an intra-wallet spend - see tx.isMine() call below)
if (doubleSpend != null) {
// This is mostly the same as the codepath in updateForSpends, but that one is only triggered when
// the transaction being double spent is actually in our wallet (ie, maybe we're double spending).
log.warn("Saw double spend from chain override pending tx {}", doubleSpend.getHashAsString());
log.warn(" <-pending ->dead");
pending.remove(doubleSpend.getHash());
dead.put(doubleSpend.getHash(), doubleSpend);
// Inform the event listeners of the newly dead tx.
doubleSpend.getConfidence().setOverridingTransaction(tx);
invokeOnTransactionConfidenceChanged(doubleSpend);
} else {
if (tx.isMine(this)) {
// a transaction that does not spend or send us coins but is ours none the less
// this can occur when a transaction is sent from outputs in our wallet to
// an address in the wallet - it burns a fee but is valid
log.info(" new tx -> spent (transfer within wallet - simply burns fee)");
boolean alreadyPresent = spent.put(tx.getHash(), tx) != null;
assert !alreadyPresent : "TX was received twice (transfer within wallet - simply burns fee";
invokeOnTransactionConfidenceChanged(tx);
} else {
throw new IllegalStateException("Received an irrelevant tx that was not a double spend.");
}
}
}
}
/**
* Updates the wallet by checking if this TX spends any of our outputs, and marking them as spent if so. It can
* be called in two contexts. One is when we receive a transaction on the best chain but it wasn't pending, this
* most commonly happens when we have a set of keys but the wallet transactions were wiped and we are catching up
* with the block chain. It can also happen if a block includes a transaction we never saw at broadcast time.
* If this tx double spends, it takes precedence over our pending transactions and the pending tx goes dead.
*
* The other context it can be called is from {@link Wallet#receivePending(Transaction)} ie we saw a tx be
* broadcast or one was submitted directly that spends our own coins. If this tx double spends it does NOT take
* precedence because the winner will be resolved by the miners - we assume that our version will win,
* if we are wrong then when a block appears the tx will go dead.
*/
private void updateForSpends(Transaction tx, boolean fromChain) throws VerificationException {
// tx is on the best chain by this point.
List<TransactionInput> inputs = tx.getInputs();
for (int i = 0; i < inputs.size(); i++) {
TransactionInput input = inputs.get(i);
TransactionInput.ConnectionResult result = input.connect(unspent, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
// Not found in the unspent map. Try again with the spent map.
result = input.connect(spent, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
// Not found in the unspent and spent maps. Try again with the pending map.
result = input.connect(pending, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
// Doesn't spend any of our outputs or is coinbase.
continue;
}
}
}
if (result == TransactionInput.ConnectionResult.ALREADY_SPENT) {
// Double spend! Work backwards like so:
//
// A -> spent by B [pending]
// \-> spent by C [chain]
Transaction doubleSpent = input.getOutpoint().fromTx; // == A
checkNotNull(doubleSpent);
int index = (int) input.getOutpoint().getIndex();
TransactionOutput output = doubleSpent.getOutputs().get(index);
TransactionInput spentBy = checkNotNull(output.getSpentBy());
Transaction connected = checkNotNull(spentBy.getParentTransaction());
if (fromChain) {
// This must have overridden a pending tx, or the block is bad (contains transactions
// that illegally double spend: should never occur if we are connected to an honest node).
if (pending.containsKey(connected.getHash())) {
log.warn("Saw double spend from chain override pending tx {}", connected.getHashAsString());
log.warn(" <-pending ->dead");
pending.remove(connected.getHash());
dead.put(connected.getHash(), connected);
// Now forcibly change the connection.
input.connect(unspent, TransactionInput.ConnectMode.DISCONNECT_ON_CONFLICT);
// Inform the [tx] event listeners of the newly dead tx. This sets confidence type also.
connected.getConfidence().setOverridingTransaction(tx);
}
} else {
// A pending transaction that tried to double spend our coins - we log and ignore it, because either
// 1) The double-spent tx is confirmed and thus this tx has no effect .... or
// 2) Both txns are pending, neither has priority. Miners will decide in a few minutes which won.
log.warn("Saw double spend from another pending transaction, ignoring tx {}",
tx.getHashAsString());
log.warn(" offending input is input {}", i);
return;
}
} else if (result == TransactionInput.ConnectionResult.SUCCESS) {
// Otherwise we saw a transaction spend our coins, but we didn't try and spend them ourselves yet.
// The outputs are already marked as spent by the connect call above, so check if there are any more for
// us to use. Move if not.
Transaction connected = checkNotNull(input.getOutpoint().fromTx);
maybeMoveTxToSpent(connected, "prevtx");
}
}
}
/**
* If the transactions outputs are all marked as spent, and it's in the unspent map, move it.
*/
private void maybeMoveTxToSpent(Transaction tx, String context) {
if (tx.isEveryOwnedOutputSpent(this)) {
// There's nothing left I can spend in this transaction.
if (unspent.remove(tx.getHash()) != null) {
if (log.isInfoEnabled()) {
log.info(" {} {} <-unspent", tx.getHashAsString(), context);
log.info(" {} {} ->spent", tx.getHashAsString(), context);
}
spent.put(tx.getHash(), tx);
}
}
}
/**
* Adds an event listener object. Methods on this object are called when something interesting happens,
* like receiving money.<p>
* <p/>
* Threading: Event listener methods are dispatched on library provided threads and the both the wallet and the
* listener objects are locked during dispatch, so your listeners do not have to be thread safe. However they
* should not block as the Peer will be unresponsive to network traffic whilst your listener is running.
*/
public synchronized void addEventListener(WalletEventListener listener) {
eventListeners.add(listener);
}
/**
* Removes the given event listener object. Returns true if the listener was removed,
* false if that listener was never added.
*/
public synchronized boolean removeEventListener(WalletEventListener listener) {
return eventListeners.remove(listener);
}
/**
* <p>Updates the wallet with the given transaction: puts it into the pending pool, sets the spent flags and runs
* the onCoinsSent/onCoinsReceived event listener. Used in two situations:</p>
*
* <ol>
* <li>When we have just successfully transmitted the tx we created to the network.</li>
* <li>When we receive a pending transaction that didn't appear in the chain yet, and we did not create it.</li>
* </ol>
*/
public synchronized void commitTx(Transaction tx) throws VerificationException {
checkArgument(!pending.containsKey(tx.getHash()), "commitTx called on the same transaction twice");
log.info("commitTx of {}", tx.getHashAsString());
BigInteger balance = getBalance();
tx.setUpdateTime(Utils.now());
// Mark the outputs we're spending as spent so we won't try and use them in future creations. This will also
// move any transactions that are now fully spent to the spent map so we can skip them when creating future
// spends.
updateForSpends(tx, false);
// Add to the pending pool. It'll be moved out once we receive this transaction on the best chain.
// This also registers txConfidenceListener so wallet listeners get informed.
log.info("->pending: {}", tx.getHashAsString());
addWalletTransaction(Pool.PENDING, tx);
// Event listeners may re-enter so we cannot make assumptions about wallet state after this loop completes.
try {
BigInteger valueSentFromMe = tx.getValueSentFromMe(this);
BigInteger valueSentToMe = tx.getValueSentToMe(this);
BigInteger newBalance = balance.add(valueSentToMe).subtract(valueSentFromMe);
if (valueSentToMe.compareTo(BigInteger.ZERO) > 0)
invokeOnCoinsReceived(tx, balance, newBalance);
if (valueSentFromMe.compareTo(BigInteger.ZERO) > 0)
invokeOnCoinsSent(tx, balance, newBalance);
invokeOnWalletChanged();
} catch (ScriptException e) {
// Cannot happen as we just created this transaction ourselves.
throw new RuntimeException(e);
}
checkState(isConsistent());
}
/**
* Returns a set of all transactions in the wallet.
* @param includeDead If true, transactions that were overridden by a double spend are included.
* @param includeInactive If true, transactions that are on side chains (are unspendable) are included.
*/
public synchronized Set<Transaction> getTransactions(boolean includeDead, boolean includeInactive) {
Set<Transaction> all = new HashSet<Transaction>();
all.addAll(unspent.values());
all.addAll(spent.values());
all.addAll(pending.values());
if (includeDead)
all.addAll(dead.values());
if (includeInactive)
all.addAll(inactive.values());
return all;
}
/**
* Returns a set of all WalletTransactions in the wallet.
*/
public synchronized Iterable<WalletTransaction> getWalletTransactions() {
HashSet<Transaction> pendingInactive = new HashSet<Transaction>();
pendingInactive.addAll(pending.values());
pendingInactive.retainAll(inactive.values());
HashSet<Transaction> onlyPending = new HashSet<Transaction>();
HashSet<Transaction> onlyInactive = new HashSet<Transaction>();
onlyPending.addAll(pending.values());
onlyPending.removeAll(pendingInactive);
onlyInactive.addAll(inactive.values());
onlyInactive.removeAll(pendingInactive);
Set<WalletTransaction> all = new HashSet<WalletTransaction>();
addWalletTransactionsToSet(all, Pool.UNSPENT, unspent.values());
addWalletTransactionsToSet(all, Pool.SPENT, spent.values());
addWalletTransactionsToSet(all, Pool.DEAD, dead.values());
addWalletTransactionsToSet(all, Pool.PENDING, onlyPending);
addWalletTransactionsToSet(all, Pool.INACTIVE, onlyInactive);
addWalletTransactionsToSet(all, Pool.PENDING_INACTIVE, pendingInactive);
return all;
}
private static synchronized void addWalletTransactionsToSet(Set<WalletTransaction> txs,
Pool poolType, Collection<Transaction> pool) {
for (Transaction tx : pool) {
txs.add(new WalletTransaction(poolType, tx));
}
}
/**
* Adds a transaction that has been associated with a particular wallet pool. This is intended for usage by
* deserialization code, such as the {@link WalletProtobufSerializer} class. It isn't normally useful for
* applications. It does not trigger auto saving.
*/
public void addWalletTransaction(WalletTransaction wtx) {
addWalletTransaction(wtx.getPool(), wtx.getTransaction());
}
/**
* Adds the given transaction to the given pools and registers a confidence change listener on it.
*/
private synchronized void addWalletTransaction(Pool pool, Transaction tx) {
switch (pool) {
case UNSPENT:
unspent.put(tx.getHash(), tx);
break;
case SPENT:
spent.put(tx.getHash(), tx);
break;
case PENDING:
pending.put(tx.getHash(), tx);
break;
case DEAD:
dead.put(tx.getHash(), tx);
break;
case INACTIVE:
inactive.put(tx.getHash(), tx);
break;
case PENDING_INACTIVE:
pending.put(tx.getHash(), tx);
inactive.put(tx.getHash(), tx);
break;
default:
throw new RuntimeException("Unknown wallet transaction type " + pool);
}
// This is safe even if the listener has been added before, as TransactionConfidence ignores duplicate
// registration requests. That makes the code in the wallet simpler.
tx.getConfidence().addEventListener(txConfidenceListener);
}
/**
* Returns all non-dead, active transactions ordered by recency.
*/
public List<Transaction> getTransactionsByTime() {
return getRecentTransactions(0, false);
}
/**
* Returns an list of N transactions, ordered by increasing age. Transactions on side chains are not included.
* Dead transactions (overridden by double spends) are optionally included. <p>
* <p/>
* Note: the current implementation is O(num transactions in wallet). Regardless of how many transactions are
* requested, the cost is always the same. In future, requesting smaller numbers of transactions may be faster
* depending on how the wallet is implemented (eg if backed by a database).
*/
public synchronized List<Transaction> getRecentTransactions(int numTransactions, boolean includeDead) {
checkArgument(numTransactions >= 0);
// Firstly, put all transactions into an array.
int size = getPoolSize(WalletTransaction.Pool.UNSPENT) +
getPoolSize(WalletTransaction.Pool.SPENT) +
getPoolSize(WalletTransaction.Pool.PENDING);
if (numTransactions > size || numTransactions == 0) {
numTransactions = size;
}
ArrayList<Transaction> all = new ArrayList<Transaction>(getTransactions(includeDead, false));
// Order by date.
Collections.sort(all, Collections.reverseOrder(new Comparator<Transaction>() {
@Override
public int compare(Transaction t1, Transaction t2) {
return t1.getUpdateTime().compareTo(t2.getUpdateTime());
}
}));
if (numTransactions == all.size()) {
return all;
} else {
all.subList(numTransactions, all.size()).clear();
return all;
}
}
/**
* Returns a transaction object given its hash, if it exists in this wallet, or null otherwise.
*/
public synchronized Transaction getTransaction(Sha256Hash hash) {
Transaction tx;
if ((tx = pending.get(hash)) != null)
return tx;
else if ((tx = unspent.get(hash)) != null)
return tx;
else if ((tx = spent.get(hash)) != null)
return tx;
else if ((tx = inactive.get(hash)) != null)
return tx;
else if ((tx = dead.get(hash)) != null)
return tx;
return null;
}
/**
* Deletes transactions which appeared above the given block height from the wallet, but does not touch the keys.
* This is useful if you have some keys and wish to replay the block chain into the wallet in order to pick them up.
*/
public synchronized void clearTransactions(int fromHeight) {
if (fromHeight == 0) {
unspent.clear();
spent.clear();
pending.clear();
inactive.clear();
dead.clear();
} else {
throw new UnsupportedOperationException();
}
}
synchronized EnumSet<Pool> getContainingPools(Transaction tx) {
EnumSet<Pool> result = EnumSet.noneOf(Pool.class);
Sha256Hash txHash = tx.getHash();
if (unspent.containsKey(txHash)) {
result.add(Pool.UNSPENT);
}
if (spent.containsKey(txHash)) {
result.add(Pool.SPENT);
}
if (pending.containsKey(txHash)) {
result.add(Pool.PENDING);
}
if (inactive.containsKey(txHash)) {
result.add(Pool.INACTIVE);
}
if (dead.containsKey(txHash)) {
result.add(Pool.DEAD);
}
return result;
}
synchronized int getPoolSize(WalletTransaction.Pool pool) {
switch (pool) {
case UNSPENT:
return unspent.size();
case SPENT:
return spent.size();
case PENDING:
return pending.size();
case INACTIVE:
return inactive.size();
case DEAD:
return dead.size();
case ALL:
return unspent.size() + spent.size() + pending.size() + inactive.size() + dead.size();
}
throw new RuntimeException("Unreachable");
}
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// SEND APIS
//
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/** A SendResult is returned to you as part of sending coins to a recipient. */
public static class SendResult {
/** The Bitcoin transaction message that moves the money. */
public Transaction tx;
/** A future that will complete once the tx message has been successfully broadcast to the network. */
public ListenableFuture<Transaction> broadcastComplete;
}
/**
* A SendRequest gives the wallet information about precisely how to send money to a recipient or set of recipients.
* Static methods are provided to help you create SendRequests and there are a few helper methods on the wallet that
* just simplify the most common use cases. You may wish to customize a SendRequest if you want to attach a fee or
* modify the change address.
*/
public static class SendRequest {
/**
* A transaction, probably incomplete, that describes the outline of what you want to do. This typically will
* mean it has some outputs to the intended destinations, but no inputs or change address (and therefore no
* fees) - the wallet will calculate all that for you and update tx later.
*/
public Transaction tx;
/**
* "Change" means the difference between the value gathered by a transactions inputs (the size of which you
* don't really control as it depends on who sent you money), and the value being sent somewhere else. The
* change address should be selected from this wallet, normally. <b>If null this will be chosen for you.</b>
*/
public Address changeAddress;
/**
* A transaction can have a fee attached, which is defined as the difference between the input values
* and output values. Any value taken in that is not provided to an output can be claimed by a miner. This
* is how mining is incentivized in later years of the Bitcoin system when inflation drops. It also provides
* a way for people to prioritize their transactions over others and is used as a way to make denial of service
* attacks expensive. Some transactions require a fee due to their structure - currently bitcoinj does not
* correctly calculate this! As of late 2012 most transactions require no fee.
*/
public BigInteger fee = BigInteger.ZERO;
// Tracks if this has been passed to wallet.completeTx already: just a safety check.
private boolean completed;
private SendRequest() {}
public static SendRequest to(Address destination, BigInteger value) {
SendRequest req = new Wallet.SendRequest();
req.tx = new Transaction(destination.getParameters());
req.tx.addOutput(value, destination);
return req;
}
public static SendRequest to(NetworkParameters params, ECKey destination, BigInteger value) {
SendRequest req = new SendRequest();
req.tx = new Transaction(params);
req.tx.addOutput(value, destination);
return req;
}
/** Simply wraps a pre-built incomplete transaction provided by you. */
public static SendRequest forTx(Transaction tx) {
SendRequest req = new SendRequest();
req.tx = tx;
return req;
}
}
/**
* Statelessly creates a transaction that sends the given number of nanocoins to address. The change is sent to
* {@link Wallet#getChangeAddress()}, so you must have added at least one key.<p>
* <p/>
* This method is stateless in the sense that calling it twice with the same inputs will result in two
* Transaction objects which are equal. The wallet is not updated to track its pending status or to mark the
* coins as spent until commitTx is called on the result.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction createSend(Address address, BigInteger nanocoins, final BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
return createSend(address, nanocoins, fee, getChangeAddress(), aesKey);
}
/**
* Sends coins to the given address but does not broadcast the resulting pending transaction. It is still stored
* in the wallet, so when the wallet is added to a {@link PeerGroup} or {@link Peer} the transaction will be
* announced to the network.
*
* @param to Address to send the coins to.
* @param nanocoins How many coins to send.
* @return the Transaction that was created, or null if there are insufficient coins in thew allet.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoinsOffline(Address to, BigInteger nanocoins, BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
Transaction tx = createSend(to, nanocoins, fee, aesKey);
if (tx == null) // Not enough money! :-(
return null;
try {
commitTx(tx);
} catch (VerificationException e) {
throw new RuntimeException(e); // Cannot happen unless there's a bug, as we just created this ourselves.
}
return tx;
}
/**
* Sends coins to the given address, via the given {@link PeerGroup}. Change is returned to {@link Wallet#getChangeAddress()}.
* The transaction will be announced to any connected nodes asynchronously. If you would like to know when
* the transaction was successfully sent to at least one node, use
* {@link Wallet#sendCoinsOffline(Address, java.math.BigInteger)} and then {@link PeerGroup#broadcastTransaction(Transaction)}
* on the result to obtain a {@link java.util.concurrent.Future<Transaction>}.
*
* @param peerGroup a PeerGroup to use for broadcast.
* @param to Which address to send coins to.
* @param nanocoins How many nanocoins to send. You can use Utils.toNanoCoins() to calculate this.
* @param fee The fee to include
* @return the Transaction
* @throws IOException if there was a problem broadcasting the transaction
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoinsAsync(PeerGroup peerGroup, Address to, BigInteger nanocoins, BigInteger fee, KeyParameter aesKey)
throws IOException, IllegalStateException, KeyCrypterException {
Transaction tx = sendCoinsOffline(to, nanocoins, fee, aesKey);
if (tx == null)
return null; // Not enough money.
// Just throw away the Future here. If the user wants it, they can call sendCoinsOffline/broadcastTransaction
// themselves.
peerGroup.broadcastTransaction(tx);
return tx;
}
/**
* Sends coins to the given address, via the given {@link PeerGroup}. Change is returned to {@link Wallet#getChangeAddress()}.
* The method will block until the transaction has been announced to at least one node.
*
* @param peerGroup a PeerGroup to use for broadcast or null.
* @param to Which address to send coins to.
* @param nanocoins How many nanocoins to send. You can use Utils.toNanoCoins() to calculate this.
* @param fee The fee to include
* @return The {@link Transaction} that was created or null if there was insufficient balance to send the coins.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoins(PeerGroup peerGroup, Address to, BigInteger nanocoins, final BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
Transaction tx = sendCoinsOffline(to, nanocoins, fee, aesKey);
if (tx == null)
return null; // Not enough money.
try {
return peerGroup.broadcastTransaction(tx).get();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ExecutionException e) {
throw new RuntimeException(e);
}
}
/**
* Sends coins to the given address, via the given {@link Peer}. Change is returned to {@link Wallet#getChangeAddress()}.
* If an exception is thrown by {@link Peer#sendMessage(Message)} the transaction is still committed, so the
* pending transaction must be broadcast <b>by you</b> at some other time.
*
* @param to Which address to send coins to.
* @param nanocoins How many nanocoins to send. You can use Utils.toNanoCoins() to calculate this.
* @param fee The fee to include
* @return The {@link Transaction} that was created or null if there was insufficient balance to send the coins.
* @throws IOException if there was a problem broadcasting the transaction
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoins(Peer peer, Address to, BigInteger nanocoins, BigInteger fee, KeyParameter aesKey) throws IOException, IllegalStateException, KeyCrypterException {
// TODO: This API is fairly questionable and the function isn't tested. If anything goes wrong during sending
// on the peer you don't get access to the created Transaction object and must fish it out of the wallet then
// do your own retry later.
Transaction tx = createSend(to, nanocoins, fee, aesKey);
if (tx == null) // Not enough money! :-(
return null;
try {
commitTx(tx);
} catch (VerificationException e) {
throw new RuntimeException(e); // Cannot happen unless there's a bug, as we just created this ourselves.
}
peer.sendMessage(tx);
return tx;
}
/**
* Creates a transaction that sends $coins.$cents BTC to the given address.<p>
* <p/>
* IMPORTANT: This method does NOT update the wallet. If you call createSend again you may get two transactions
* that spend the same coins. You have to call commitTx on the created transaction to prevent this,
* but that should only occur once the transaction has been accepted by the network. This implies you cannot have
* more than one outstanding sending tx at once.
*
* @param address The BitCoin address to send the money to.
* @param nanocoins How much currency to send, in nanocoins.
* @param fee The fee to include
* @param changeAddress Which address to send the change to, in case we can't make exactly the right value from
* our coins. This should be an address we own (is in the keychain).
* @return a new {@link Transaction} or null if we cannot afford this send.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
synchronized Transaction createSend(Address address, BigInteger nanocoins, final BigInteger fee, Address changeAddress, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
log.info("Creating send tx to " + address.toString() + " for " +
bitcoinValueToFriendlyString(nanocoins));
Transaction sendTx = new Transaction(params);
sendTx.addOutput(nanocoins, address);
if (completeTx(sendTx, changeAddress, fee, aesKey)) {
return sendTx;
} else {
return null;
}
}
/**
* Takes a transaction with arbitrary outputs, gathers the necessary inputs for spending, and signs it
* @param sendTx The transaction to complete
* @param changeAddress Which address to send the change to, in case we can't make exactly the right value from
* our coins. This should be an address we own (is in the keychain).
* @param fee The fee to include
* @return False if we cannot afford this send, true otherwise
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized boolean completeTx(Transaction sendTx, Address changeAddress, BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
// Calculate the transaction total
BigInteger nanocoins = BigInteger.ZERO;
for(TransactionOutput output : sendTx.getOutputs()) {
nanocoins = nanocoins.add(output.getValue());
}
final BigInteger total = nanocoins.add(fee);
log.info("Completing send tx with {} outputs totalling {}", sendTx.getOutputs().size(), bitcoinValueToFriendlyString(nanocoins));
// To send money to somebody else, we need to do gather up transactions with unspent outputs until we have
// sufficient value. Many coin selection algorithms are possible, we use a simple but suboptimal one.
// TODO: Sort coins so we use the smallest first, to combat wallet fragmentation and reduce fees.
BigInteger valueGathered = BigInteger.ZERO;
List<TransactionOutput> gathered = new LinkedList<TransactionOutput>();
for (Transaction tx : unspent.values()) {
// Do not try and spend coinbases that were mined too recently, the protocol forbids it.
if (!tx.isMature()) {
continue;
}
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isAvailableForSpending()) continue;
if (!output.isMine(this)) continue;
gathered.add(output);
valueGathered = valueGathered.add(output.getValue());
}
if (valueGathered.compareTo(total) >= 0)
break;
}
// Can we afford this?
if (valueGathered.compareTo(total) < 0) {
// If there are insufficient unspent coins, see if there are any pending coins that have change-back-to-self
// and that have been seen by two or more peers. These are eligible for spending ("The Boomerang Rule")
for (Transaction tx : pending.values()) {
// Do not try and spend coinbases that were mined too recently, the protocol forbids it.
if (!tx.isMature()) {
continue;
}
if (transactionSpendsFromThisWalletAndHasBoomerangedBack(tx)) {
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isAvailableForSpending())
continue;
if (!output.isMine(this))
continue;
gathered.add(output);
valueGathered = valueGathered.add(output.getValue());
}
if (valueGathered.compareTo(total) >= 0)
break;
}
}
if (valueGathered.compareTo(total) < 0) {
// Still not enough funds.
log.info("Insufficient value in wallet for send, missing "
+ bitcoinValueToFriendlyString(nanocoins.subtract(valueGathered)));
// TODO: Should throw an exception here.
return false;
}
}
checkState(gathered.size() > 0);
sendTx.getConfidence().setConfidenceType(TransactionConfidence.ConfidenceType.NOT_SEEN_IN_CHAIN);
BigInteger change = valueGathered.subtract(total);
if (change.compareTo(BigInteger.ZERO) > 0) {
// The value of the inputs is greater than what we want to send. Just like in real life then,
// we need to take back some coins ... this is called "change". Add another output that sends the change
// back to us.
log.info(" with " + bitcoinValueToFriendlyString(change) + " coins change");
sendTx.addOutput(new TransactionOutput(params, sendTx, change, changeAddress));
}
for (TransactionOutput output : gathered) {
sendTx.addInput(output);
}
// Now sign the inputs, thus proving that we are entitled to redeem the connected outputs.
try {
sendTx.signInputs(Transaction.SigHash.ALL, this, aesKey);
} catch (ScriptException e) {
// If this happens it means an output script in a wallet tx could not be understood. That should never
// happen, if it does it means the wallet has got into an inconsistent state.
throw new RuntimeException(e);
} catch (KeyCrypterException kce) {
// This can occur if the key being used is encrypted.
throw new RuntimeException(kce);
}
// keep a track of the date the tx was created (used in MultiBitService
// to work out the block it appears in)
sendTx.setUpdateTime(new Date());
log.info(" completed {}", sendTx.getHashAsString());
return true;
}
private boolean transactionSpendsFromThisWalletAndHasBoomerangedBack(Transaction tx) {
boolean seenByEnoughPeers = false;
TransactionConfidence confidence = tx.getConfidence();
if (confidence != null && confidence.getBroadcastBy() != null
&& confidence.getBroadcastBy().size() >= MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND) {
seenByEnoughPeers = true;
}
if (!seenByEnoughPeers) return false;
boolean wasSentFromMyWallet = true;
// Check all transaction inputs are from your own wallet
for (TransactionInput input : tx.getInputs()) {
TransactionOutPoint outPoint = input.getOutpoint();
try {
TransactionOutput transactionOutput = outPoint.getConnectedOutput();
if (transactionOutput == null) {
wasSentFromMyWallet = false;
break;
}
ECKey ecKey = outPoint.getConnectedKey(this);
// if no ecKey was found then the transaction uses a transaction output from somewhere else
if (ecKey == null) {
wasSentFromMyWallet = false;
break;
}
} catch (ScriptException e) {
wasSentFromMyWallet = false;
break;
}
}
if (!wasSentFromMyWallet) return false;
// Transaction is both from out wallet and has boomeranged back.
return true;
}
/**
* Takes a transaction with arbitrary outputs, gathers the necessary inputs for spending, and signs it.
* Change goes to {@link Wallet#getChangeAddress()}
* @param sendTx The transaction to complete
* @param fee The fee to include
* @return False if we cannot afford this send, true otherwise
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized boolean completeTx(Transaction sendTx, BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
return completeTx(sendTx, getChangeAddress(), fee, aesKey);
}
synchronized Address getChangeAddress() {
// For now let's just pick the first key in our keychain. In future we might want to do something else to
// give the user better privacy here, eg in incognito mode.
checkState(keychain.size() > 0, "Can't send value without an address to use for receiving change");
ECKey first = keychain.get(0);
return first.toAddress(params);
}
/**
* Adds the given ECKey to the wallet. There is currently no way to delete keys (that would result in coin loss).
* If {@link Wallet#autosaveToFile(java.io.File, long, java.util.concurrent.TimeUnit, com.google.bitcoin.core.Wallet.AutosaveEventListener)}
* has been called, triggers an auto save bypassing the normal coalescing delay and event handlers.
* If the key already exists in the wallet, does nothing and returns false.
* @throws KeyCrypterException
*/
public synchronized boolean addKey(final ECKey key) throws KeyCrypterException {
return addKeys(Lists.newArrayList(key)) == 1;
}
/**
* Adds the given keys to the wallet. There is currently no way to delete keys (that would result in coin loss).
* If {@link Wallet#autosaveToFile(java.io.File, long, java.util.concurrent.TimeUnit, com.google.bitcoin.core.Wallet.AutosaveEventListener)}
* has been called, triggers an auto save bypassing the normal coalescing delay and event handlers.
* Returns the number of keys added, after duplicates are ignored. The onKeyAdded event will be called for each key
* in the list that was not already present.
*/
public synchronized int addKeys(final List<ECKey> keys) throws KeyCrypterException {
// TODO: Consider making keys a sorted list or hashset so membership testing is faster.
int added = 0;
for (final ECKey key : keys) {
if (keychain.contains(key)) continue;
// If the key has a keyCrypter that does not match the Wallet's then a KeyCrypterException is thrown.
// This is done because only one keyCrypter is persisted per Wallet and hence all the keys must be homogenous.
if (keyCrypter != null && keyCrypter.getEncryptionType() != EncryptionType.UNENCRYPTED &&
!keyCrypter.equals(key.getKeyCrypter())) {
throw new KeyCrypterException("Cannot add key " + key.toString() + " because the keyCrypter does not match the wallets. Keys must be homogenous.");
}
keychain.add(key);
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onKeyAdded(key);
}
});
added++;
}
return added;
}
/**
* Locates a keypair from the keychain given the hash of the public key. This is needed when finding out which
* key we need to use to redeem a transaction output.
*
* @return ECKey object or null if no such key was found.
*/
public synchronized ECKey findKeyFromPubHash(byte[] pubkeyHash) {
for (ECKey key : keychain) {
if (Arrays.equals(key.getPubKeyHash(), pubkeyHash)) return key;
}
return null;
}
/** Returns true if the given key is in the wallet, false otherwise. Currently an O(N) operation. */
public boolean hasKey(ECKey key) {
return keychain.contains(key);
}
/**
* Returns true if this wallet contains a public key which hashes to the given hash.
*/
public synchronized boolean isPubKeyHashMine(byte[] pubkeyHash) {
return findKeyFromPubHash(pubkeyHash) != null;
}
/**
* Locates a keypair from the keychain given the raw public key bytes.
*
* @return ECKey or null if no such key was found.
*/
public synchronized ECKey findKeyFromPubKey(byte[] pubkey) {
for (ECKey key : keychain) {
if (Arrays.equals(key.getPubKey(), pubkey)) return key;
}
return null;
}
/**
* Returns true if this wallet contains a keypair with the given public key.
*/
public synchronized boolean isPubKeyMine(byte[] pubkey) {
return findKeyFromPubKey(pubkey) != null;
}
/**
* It's possible to calculate a wallets balance from multiple points of view. This enum selects which
* getBalance() should use.<p>
* <p/>
* Consider a real-world example: you buy a snack costing $5 but you only have a $10 bill. At the start you have
* $10 viewed from every possible angle. After you order the snack you hand over your $10 bill. From the
* perspective of your wallet you have zero dollars (AVAILABLE). But you know in a few seconds the shopkeeper
* will give you back $5 change so most people in practice would say they have $5 (ESTIMATED).<p>
*/
public enum BalanceType {
/**
* Balance calculated assuming all pending transactions are in fact included into the best chain by miners.
* This is the right balance to show in user interfaces.
*/
ESTIMATED,
/**
* Balance that can be safely used to create new spends. This is all confirmed unspent outputs minus the ones
* spent by pending transactions, but not including the outputs of those pending transactions.
*/
AVAILABLE,
/**
* Balance that can be safely used to create new spends. This includes all available and any change that
* has been been by MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND or more peers.
*/
AVAILABLE_WITH_BOOMERANG_CHANGE
}
/**
* Returns the AVAILABLE balance of this wallet. See {@link BalanceType#AVAILABLE} for details on what this
* means.<p>
* <p/>
* Note: the estimated balance is usually the one you want to show to the end user - however attempting to
* actually spend these coins may result in temporary failure. This method returns how much you can safely
* provide to {@link Wallet#createSend(Address, java.math.BigInteger)}.
*/
public synchronized BigInteger getBalance() {
return getBalance(BalanceType.AVAILABLE);
}
/**
* Returns the balance of this wallet as calculated by the provided balanceType.
*/
public synchronized BigInteger getBalance(BalanceType balanceType) {
BigInteger available = BigInteger.ZERO;
for (Transaction tx : unspent.values()) {
// For an 'available to spend' balance exclude coinbase transactions that have not yet matured.
if ((balanceType == BalanceType.AVAILABLE || balanceType == BalanceType.AVAILABLE_WITH_BOOMERANG_CHANGE) && !tx.isMature()) {
continue;
}
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isMine(this)) continue;
if (!output.isAvailableForSpending()) continue;
available = available.add(output.getValue());
}
}
if (balanceType == BalanceType.AVAILABLE)
return available;
checkState(balanceType == BalanceType.ESTIMATED || balanceType == BalanceType.AVAILABLE_WITH_BOOMERANG_CHANGE);
if (balanceType == BalanceType.ESTIMATED) {
// Now add back all the pending outputs to assume the transaction goes through.
BigInteger estimated = available;
for (Transaction tx : pending.values()) {
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isMine(this)) continue;
if (!output.isAvailableForSpending()) continue;
estimated = estimated.add(output.getValue());
}
}
return estimated;
} else {
BigInteger availableWithBoomerang = available;
// If transactions send from your own wallet then change is spendable after the transaction has been seen by
// MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND
for (Transaction tx : pending.values()) {
if (transactionSpendsFromThisWalletAndHasBoomerangedBack(tx)) {
// Transaction is both from out wallet and has boomeranged back.
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isMine(this))
continue;
if (!output.isAvailableForSpending())
continue;
availableWithBoomerang = availableWithBoomerang.add(output.getValue());
}
}
}
return availableWithBoomerang;
}
}
@Override
public synchronized String toString() {
return toString(false);
}
public synchronized String toString(boolean includePrivateKeys) {
StringBuilder builder = new StringBuilder();
builder.append(String.format("Wallet containing %s BTC in:%n", bitcoinValueToFriendlyString(getBalance())));
builder.append(String.format(" %d unspent transactions%n", unspent.size()));
builder.append(String.format(" %d spent transactions%n", spent.size()));
builder.append(String.format(" %d pending transactions%n", pending.size()));
builder.append(String.format(" %d inactive transactions%n", inactive.size()));
builder.append(String.format(" %d dead transactions%n", dead.size()));
builder.append(String.format("Last seen best block: %s%n", getLastBlockSeenHash()));
// Do the keys.
builder.append("\nKeys:\n");
for (ECKey key : keychain) {
builder.append(" addr:");
builder.append(key.toAddress(params));
builder.append(" ");
builder.append(includePrivateKeys ? key.toStringWithPrivate() : key.toString());
builder.append("\n");
}
// Print the transactions themselves
if (unspent.size() > 0) {
builder.append("\nUNSPENT:\n");
toStringHelper(builder, unspent);
}
if (spent.size() > 0) {
builder.append("\nSPENT:\n");
toStringHelper(builder, spent);
}
if (pending.size() > 0) {
builder.append("\nPENDING:\n");
toStringHelper(builder, pending);
}
if (inactive.size() > 0) {
builder.append("\nINACTIVE:\n");
toStringHelper(builder, inactive);
}
if (dead.size() > 0) {
builder.append("\nDEAD:\n");
toStringHelper(builder, dead);
}
// Add the keyCrypter so that any setup parameters are in the wallet toString.
if (this.keyCrypter != null) {
builder.append("\n KeyCrypter: " + keyCrypter.toString());
}
return builder.toString();
}
private void toStringHelper(StringBuilder builder, Map<Sha256Hash, Transaction> transactionMap) {
for (Transaction tx : transactionMap.values()) {
try {
builder.append("Sends ");
builder.append(Utils.bitcoinValueToFriendlyString(tx.getValueSentFromMe(this)));
builder.append(" and receives ");
builder.append(Utils.bitcoinValueToFriendlyString(tx.getValueSentToMe(this)));
builder.append(", total value ");
builder.append(Utils.bitcoinValueToFriendlyString(tx.getValue(this)));
builder.append(".\n");
} catch (ScriptException e) {
// Ignore and don't print this line.
}
builder.append(tx);
}
}
/**
* Called by the {@link BlockChain} when the best chain (representing total work done) has changed. In this case,
* we need to go through our transactions and find out if any have become invalid. It's possible for our balance
* to go down in this case: money we thought we had can suddenly vanish if the rest of the network agrees it
* should be so.<p>
*
* The oldBlocks/newBlocks lists are ordered height-wise from top first to bottom last.
*/
synchronized void reorganize(StoredBlock splitPoint, List<StoredBlock> oldBlocks, List<StoredBlock> newBlocks) throws VerificationException {
// This runs on any peer thread with the block chain synchronized.
//
// The reorganize functionality of the wallet is tested in ChainSplitTests.
//
// For each transaction we track which blocks they appeared in. Once a re-org takes place we have to find all
// transactions in the old branch, all transactions in the new branch and find the difference of those sets.
//
// receive() has been called on the block that is triggering the re-org before this is called.
List<Sha256Hash> oldBlockHashes = new ArrayList<Sha256Hash>(oldBlocks.size());
List<Sha256Hash> newBlockHashes = new ArrayList<Sha256Hash>(newBlocks.size());
log.info("Old part of chain (top to bottom):");
for (StoredBlock b : oldBlocks) {
log.info(" {}", b.getHeader().getHashAsString());
oldBlockHashes.add(b.getHeader().getHash());
}
log.info("New part of chain (top to bottom):");
for (StoredBlock b : newBlocks) {
log.info(" {}", b.getHeader().getHashAsString());
newBlockHashes.add(b.getHeader().getHash());
}
// Transactions that appear in the old chain segment.
Map<Sha256Hash, Transaction> oldChainTransactions = new HashMap<Sha256Hash, Transaction>();
// Transactions that appear in the old chain segment and NOT the new chain segment.
Map<Sha256Hash, Transaction> onlyOldChainTransactions = new HashMap<Sha256Hash, Transaction>();
// Transactions that appear in the new chain segment.
Map<Sha256Hash, Transaction> newChainTransactions = new HashMap<Sha256Hash, Transaction>();
// Transactions that don't appear in either the new or the old section, ie, the shared trunk.
Map<Sha256Hash, Transaction> commonChainTransactions = new HashMap<Sha256Hash, Transaction>();
Map<Sha256Hash, Transaction> all = new HashMap<Sha256Hash, Transaction>();
all.putAll(unspent);
all.putAll(spent);
all.putAll(inactive);
// Dead coinbase transactions are potentially resurrected so added to the list of tx to process.
for (Transaction tx : dead.values()) {
if (tx.isCoinBase()) {
all.put(tx.getHash(), tx);
}
}
for (Transaction tx : all.values()) {
Collection<Sha256Hash> appearsIn = tx.getAppearsInHashes();
checkNotNull(appearsIn);
// If the set of blocks this transaction appears in is disjoint with one of the chain segments it means
// the transaction was never incorporated by a miner into that side of the chain.
boolean inOldSection = !Collections.disjoint(appearsIn, oldBlockHashes);
boolean inNewSection = !Collections.disjoint(appearsIn, newBlockHashes);
boolean inCommonSection = !inNewSection && !inOldSection;
if (inCommonSection) {
boolean alreadyPresent = commonChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in common chain segment");
} else {
if (inOldSection) {
boolean alreadyPresent = oldChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in old chain segment");
if (!inNewSection) {
alreadyPresent = onlyOldChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in only-old map");
}
}
if (inNewSection) {
boolean alreadyPresent = newChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in new chain segment");
}
}
}
// If there is no difference it means we have nothing we need to do and the user does not care.
boolean affectedUs = !oldChainTransactions.equals(newChainTransactions);
log.info(affectedUs ? "Re-org affected our transactions" : "Re-org had no effect on our transactions");
if (!affectedUs) return;
// Avoid spuriously informing the user of wallet changes whilst we're re-organizing. This also prevents the
// user from modifying wallet contents (eg, trying to spend) whilst we're in the middle of the process.
onWalletChangedSuppressions++;
// For simplicity we will reprocess every transaction to ensure it's in the right bucket and has the right
// connections. Attempting to update each one with minimal work is possible but complex and was leading to
// edge cases that were hard to fix. As re-orgs are rare the amount of work this implies should be manageable
// unless the user has an enormous wallet. As an optimization fully spent transactions buried deeper than
// 1000 blocks could be put into yet another bucket which we never touch and assume re-orgs cannot affect.
for (Transaction tx : onlyOldChainTransactions.values()) log.info(" Only Old: {}", tx.getHashAsString());
for (Transaction tx : oldChainTransactions.values()) log.info(" Old: {}", tx.getHashAsString());
for (Transaction tx : newChainTransactions.values()) log.info(" New: {}", tx.getHashAsString());
// Break all the existing connections.
for (Transaction tx : all.values())
tx.disconnectInputs();
for (Transaction tx : pending.values())
tx.disconnectInputs();
// Reconnect the transactions in the common part of the chain.
for (Transaction tx : commonChainTransactions.values()) {
TransactionInput badInput = tx.connectForReorganize(all);
checkState(badInput == null, "Failed to connect %s, %s", tx.getHashAsString(),
badInput == null ? "" : badInput.toString());
}
// Recalculate the unspent/spent buckets for the transactions the re-org did not affect.
log.info("Moving transactions");
unspent.clear();
spent.clear();
inactive.clear();
for (Transaction tx : commonChainTransactions.values()) {
int unspentOutputs = 0;
for (TransactionOutput output : tx.getOutputs()) {
if (output.isAvailableForSpending() && output.isMine(this)) unspentOutputs++;
}
if (unspentOutputs > 0) {
log.info(" TX {} ->unspent", tx.getHashAsString());
unspent.put(tx.getHash(), tx);
} else {
log.info(" TX {} ->spent", tx.getHashAsString());
spent.put(tx.getHash(), tx);
}
}
// Inform all transactions that exist only in the old chain that they have moved, so they can update confidence
// and timestamps. Transactions will be told they're on the new best chain when the blocks are replayed.
for (Transaction tx : onlyOldChainTransactions.values()) {
tx.notifyNotOnBestChain();
// Kill any coinbase transactions that are only in the old chain.
// These transactions are no longer valid.
if (tx.isCoinBase()) {
// Move the transaction to the dead pool.
if (unspent.containsKey(tx.getHash())) {
log.info(" coinbase tx {} unspent->dead", tx.getHashAsString());
unspent.remove(tx.getHash());
} else if (spent.containsKey(tx.getHash())) {
log.info(" coinbase tx {} spent->dead", tx.getHashAsString());
// TODO Remove any dependent child transactions of the just removed coinbase transaction.
spent.remove(tx.getHash());
}
dead.put(tx.getHash(), tx);
// Set transaction confidence to dead and notify listeners.
tx.getConfidence().setConfidenceType(ConfidenceType.DEAD);
}
}
// Now replay the act of receiving the blocks that were previously in a side chain. This will:
// - Move any transactions that were pending and are now accepted into the right bucket.
// - Connect the newly active transactions.
Collections.reverse(newBlocks); // Need bottom-to-top but we get top-to-bottom.
// The old blocks have contributed to the depth and work done for all the transactions in the
// wallet that are in blocks up to and including the chain split block.
// The total depth and work done is calculated here and then subtracted from the appropriate transactions.
int depthToSubtract = oldBlocks.size();
BigInteger workDoneToSubtract = BigInteger.ZERO;
for (StoredBlock b : oldBlocks) {
workDoneToSubtract = workDoneToSubtract.add(b.getHeader().getWork());
}
log.info("DepthToSubtract = " + depthToSubtract + ", workDoneToSubtract = " + workDoneToSubtract);
// Remove depthToSubtract and workDoneToSubtract from all transactions in the wallet except for pending and inactive
// (i.e. the transactions in the two chains of blocks we are reorganising).
subtractDepthAndWorkDone(depthToSubtract, workDoneToSubtract, spent.values());
subtractDepthAndWorkDone(depthToSubtract, workDoneToSubtract, unspent.values());
subtractDepthAndWorkDone(depthToSubtract, workDoneToSubtract, dead.values());
// The effective last seen block is now the split point so set the lastSeenBlockHash.
setLastBlockSeenHash(splitPoint.getHeader().getHash());
for (StoredBlock b : newBlocks) {
log.info("Replaying block {}", b.getHeader().getHashAsString());
// Replay means: find the transactions that should be in that block, send them to the wallet, inform of
// new best block, repeat.
Set<Transaction> txns = new HashSet<Transaction>();
Sha256Hash blockHash = b.getHeader().getHash();
for (Transaction tx : newChainTransactions.values()) {
if (tx.getAppearsInHashes().contains(blockHash)) {
txns.add(tx);
log.info(" containing tx {}", tx.getHashAsString());
}
}
if (!txns.isEmpty()) {
// Add the transactions to the new blocks.
for (Transaction t : txns) {
try {
receive(t, b, BlockChain.NewBlockType.BEST_CHAIN, true);
} catch (ScriptException e) {
throw new RuntimeException(e); // Cannot happen as these blocks were already verified.
}
}
}
notifyNewBestBlock(b.getHeader());
}
// Find the transactions that didn't make it into the new chain yet. For each input, try to connect it to the
// transactions that are in {spent,unspent,pending}. Check the status of each input. For inactive
// transactions that only send us money, we put them into the inactive pool where they sit around waiting for
// another re-org or re-inclusion into the main chain. For inactive transactions where we spent money we must
// put them back into the pending pool if we can reconnect them, so we don't create a double spend whilst the
// network heals itself.
Map<Sha256Hash, Transaction> pool = new HashMap<Sha256Hash, Transaction>();
pool.putAll(unspent);
pool.putAll(spent);
pool.putAll(pending);
Map<Sha256Hash, Transaction> toReprocess = new HashMap<Sha256Hash, Transaction>();
toReprocess.putAll(onlyOldChainTransactions);
toReprocess.putAll(pending);
log.info("Reprocessing transactions not in new best chain:");
// Note, we must reprocess dead transactions first. The reason is that if there is a double spend across
// chains from our own coins we get a complicated situation:
//
// 1) We switch to a new chain (B) that contains a double spend overriding a pending transaction. The
// pending transaction goes dead.
// 2) We switch BACK to the first chain (A). The dead transaction must go pending again.
// 3) We resurrect the transactions that were in chain (B) and assume the miners will start work on putting them
// in to the chain, but it's not possible because it's a double spend. So now that transaction must become
// dead instead of pending.
//
// This only occurs when we are double spending our own coins.
for (Transaction tx : dead.values()) {
reprocessUnincludedTxAfterReorg(pool, tx);
}
for (Transaction tx : toReprocess.values()) {
reprocessUnincludedTxAfterReorg(pool, tx);
}
log.info("post-reorg balance is {}", Utils.bitcoinValueToFriendlyString(getBalance()));
// Inform event listeners that a re-org took place. They should save the wallet at this point.
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onReorganize(Wallet.this);
}
});
onWalletChangedSuppressions--;
invokeOnWalletChanged();
checkState(isConsistent());
}
/**
* Subtract the supplied depth and work done from the given transactions.
*/
synchronized private void subtractDepthAndWorkDone(int depthToSubtract, BigInteger workDoneToSubtract, Collection<Transaction> transactions) {
for (Transaction tx : transactions) {
if (tx.getConfidence().getConfidenceType() == ConfidenceType.BUILDING) {
tx.getConfidence().setDepthInBlocks(tx.getConfidence().getDepthInBlocks() - depthToSubtract);
tx.getConfidence().setWorkDone(tx.getConfidence().getWorkDone().subtract(workDoneToSubtract));
}
}
}
private void reprocessUnincludedTxAfterReorg(Map<Sha256Hash, Transaction> pool, Transaction tx) {
log.info("TX {}", tx.getHashAsString() + ", confidence = " + tx.getConfidence().getConfidenceType().name());
boolean isDeadCoinbase = tx.isCoinBase() && ConfidenceType.DEAD == tx.getConfidence().getConfidenceType();
// Dead coinbase transactions on a side chain stay dead.
if (isDeadCoinbase) {
return;
}
int numInputs = tx.getInputs().size();
int noSuchTx = 0;
int success = 0;
boolean isDead = false;
// The transactions that we connected inputs to, so we can go back later and move them into the right
// bucket if all their outputs got spent.
Set<Transaction> connectedTransactions = new TreeSet<Transaction>();
for (TransactionInput input : tx.getInputs()) {
TransactionInput.ConnectionResult result = input.connect(pool, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.SUCCESS) {
success++;
TransactionOutput connectedOutput = checkNotNull(input.getConnectedOutput(pool));
connectedTransactions.add(checkNotNull(connectedOutput.parentTransaction));
} else if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
noSuchTx++;
} else if (result == TransactionInput.ConnectionResult.ALREADY_SPENT) {
isDead = true;
// This transaction was replaced by a double spend on the new chain. Did you just reverse
// your own transaction? I hope not!!
log.info(" ->dead, will not confirm now unless there's another re-org", tx.getHashAsString());
TransactionOutput doubleSpent = input.getConnectedOutput(pool);
Transaction replacement = doubleSpent.getSpentBy().getParentTransaction();
dead.put(tx.getHash(), tx);
pending.remove(tx.getHash());
// This updates the tx confidence type automatically.
tx.getConfidence().setOverridingTransaction(replacement);
break;
}
}
if (isDead) return;
// If all inputs do not appear in this wallet move to inactive.
if (noSuchTx == numInputs) {
log.info(" ->inactive", tx.getHashAsString() + ", confidence = " + tx.getConfidence().getConfidenceType().name());
inactive.put(tx.getHash(), tx);
dead.remove(tx.getHash());
} else if (success == numInputs - noSuchTx) {
// All inputs are either valid for spending or don't come from us. Miners are trying to reinclude it.
log.info(" ->pending", tx.getHashAsString() + ", confidence = " + tx.getConfidence().getConfidenceType().name());
pending.put(tx.getHash(), tx);
dead.remove(tx.getHash());
}
// The act of re-connecting this un-included transaction may have caused other transactions to become fully
// spent so move them into the right bucket here to keep performance good.
for (Transaction maybeSpent : connectedTransactions) {
maybeMoveTxToSpent(maybeSpent, "reorg");
}
}
private void invokeOnTransactionConfidenceChanged(final Transaction tx) {
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onTransactionConfidenceChanged(Wallet.this, tx);
}
});
}
private int onWalletChangedSuppressions;
private synchronized void invokeOnWalletChanged() {
// Don't invoke the callback in some circumstances, eg, whilst we are re-organizing or fiddling with
// transactions due to a new block arriving. It will be called later instead.
Preconditions.checkState(onWalletChangedSuppressions >= 0);
if (onWalletChangedSuppressions > 0) return;
// Call with the wallet locked.
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onWalletChanged(Wallet.this);
}
});
}
/**
* Returns an immutable view of the transactions currently waiting for network confirmations.
*/
public synchronized Collection<Transaction> getPendingTransactions() {
return Collections.unmodifiableCollection(pending.values());
}
/**
* Returns the earliest creation time of the keys in this wallet, in seconds since the epoch, ie the min of
* {@link com.google.bitcoin.core.ECKey#getCreationTimeSeconds()}. This can return zero if at least one key does
* not have that data (was created before key timestamping was implemented). <p>
*
* This method is most often used in conjunction with {@link PeerGroup#setFastCatchupTimeSecs(long)} in order to
* optimize chain download for new users of wallet apps. Backwards compatibility notice: if you get zero from this
* method, you can instead use the time of the first release of your software, as it's guaranteed no users will
* have wallets pre-dating this time. <p>
*
* If there are no keys in the wallet, the current time is returned.
*/
public synchronized long getEarliestKeyCreationTime() {
if (keychain.size() == 0) {
return Utils.now().getTime() / 1000;
}
long earliestTime = Long.MAX_VALUE;
for (ECKey key : keychain) {
earliestTime = Math.min(key.getCreationTimeSeconds(), earliestTime);
}
return earliestTime;
}
// This object is used to receive events from a Peer or PeerGroup. Currently it is only used to receive
// transactions. Note that it does NOT pay attention to block message because they will be received from the
// BlockChain object along with extra data we need for correct handling of re-orgs.
private transient PeerEventListener peerEventListener;
/**
* The returned object can be used to connect the wallet to a {@link Peer} or {@link PeerGroup} in order to
* receive and process blocks and transactions.
*/
public synchronized PeerEventListener getPeerEventListener() {
if (peerEventListener == null) {
// Instantiate here to avoid issues with wallets resurrected from serialized copies.
peerEventListener = new AbstractPeerEventListener() {
@Override
public void onTransaction(Peer peer, Transaction t) {
// Runs locked on a peer thread.
try {
receivePending(t);
} catch (VerificationException e) {
log.warn("Received broadcast transaction that does not validate: {}", t);
log.warn("VerificationException caught", e);
}
}
};
}
return peerEventListener;
}
public Sha256Hash getLastBlockSeenHash() {
return lastBlockSeenHash;
}
public void setLastBlockSeenHash(Sha256Hash lastBlockSeenHash) {
this.lastBlockSeenHash = lastBlockSeenHash;
}
public Collection<ECKey> getKeychain() {
return keychain;
}
/**
* Deletes transactions which appeared after a certain date
*/
public synchronized void clearTransactions(Date fromDate) {
if (fromDate == null) {
unspent.clear();
spent.clear();
pending.clear();
inactive.clear();
dead.clear();
} else {
removeEntriesAfterDate(unspent, fromDate);
removeEntriesAfterDate(spent, fromDate);
removeEntriesAfterDate(pending, fromDate);
removeEntriesAfterDate(inactive, fromDate);
removeEntriesAfterDate(dead, fromDate);
}
}
private void removeEntriesAfterDate(Map<Sha256Hash, Transaction> pool, Date fromDate) {
log.debug("Wallet#removeEntriesAfterDate - Removing transactions later than " + fromDate.toString());
Set<Entry<Sha256Hash, Transaction>> loopEntries = pool.entrySet();
Iterator<Entry<Sha256Hash, Transaction>> iterator = loopEntries.iterator();
while(iterator.hasNext()) {
Entry<Sha256Hash, Transaction> member = iterator.next();
if (member.getValue() != null) {
Date updateTime = member.getValue().getUpdateTime();
if (updateTime != null && updateTime.after(fromDate)) {
iterator.remove();
log.debug("Wallet#removeEntriesAfterDate - Removed tx.1 " + member.getValue());
continue;
}
// if no updateTime remove them
if (updateTime == null || updateTime.getTime() == 0) {
iterator.remove();
log.debug("Removed tx.2 " + member.getValue());
continue;
}
}
}
}
/**
* Encrypt the wallet using the KeyCrypter and the AES key.
* @param keyCrypter The KeyCrypter that specifies how to encrypt/ decrypt a key
* @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
* @throws KeyCrypterException Thrown if the wallet encryption fails. If so, the wallet state is unchanged.
*/
synchronized public void encrypt(KeyCrypter keyCrypter, KeyParameter aesKey) throws KeyCrypterException {
if (keyCrypter == null) {
throw new KeyCrypterException("A keyCrypter must be specified to encrypt a wallet.");
}
/**
* If the wallet is already encrypted then you cannot encrypt it again.
*/
if (getEncryptionType() != EncryptionType.UNENCRYPTED) {
throw new WalletIsAlreadyEncryptedException("Wallet is already encrypted");
}
// Create a new arraylist that will contain the encrypted keys
ArrayList<ECKey> encryptedKeyChain = new ArrayList<ECKey>();
for (ECKey key : keychain) {
if (key.isEncrypted()) {
throw new WalletIsAlreadyEncryptedException("Key '" + key.toString() + "' is already encrypted.");
}
// Clone the key before encrypting.
// (note that only the EncryptedPrivateKey is deep copied).
ECKey clonedECKey = new ECKey(key.getPrivKeyBytes(), new EncryptedPrivateKey(key.getEncryptedPrivateKey()),
key.getPubKey(), keyCrypter);
clonedECKey.encrypt(keyCrypter, aesKey);
encryptedKeyChain.add(clonedECKey);
}
// Replace the old keychain with the encrypted one.
keychain = encryptedKeyChain;
// The wallet is now encrypted.
this.keyCrypter = keyCrypter;
}
/**
* Decrypt the wallet with the keyCrypter and AES key.
*
* @param keyCrypter The KeyCrypter that specifies how to encrypt/ decrypt a key
* @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
* @throws KeyCrypterException Thrown if the wallet decryption fails. If so, the wallet state is unchanged.
*/
synchronized public void decrypt(KeyCrypter keyCrypter, KeyParameter aesKey) throws KeyCrypterException {
// Check the wallet is already encrypted - you cannot decrypt an unencrypted wallet.
if (getEncryptionType() == EncryptionType.UNENCRYPTED) {
throw new WalletIsAlreadyDecryptedException("Wallet is already decrypted");
}
// Check that this.keyCrypter is identical to the one passed in otherwise there is risk of data loss.
// (This is trying to decrypt a wallet with a different algorithm to that used to encrypt it.)
if (!keyCrypter.equals(this.keyCrypter)) {
throw new KeyCrypterException("You are trying to decrypt a wallet with a different keyCrypter to the one used to encrypt it. Aborting.");
}
// Create a new arraylist that will contain the decrypted keys
ArrayList<ECKey> decryptedKeyChain = new ArrayList<ECKey>();
for (ECKey key : keychain) {
if (!key.isEncrypted()) {
throw new WalletIsAlreadyDecryptedException("Key '" + key.toString() + "' is already decrypted.");
}
// Clone the key before decrypting.
// (note that only the EncryptedPrivateKey is deep copied).
ECKey clonedECKey = new ECKey(new EncryptedPrivateKey(key.getEncryptedPrivateKey()), key.getPubKey(),
keyCrypter);
clonedECKey.decrypt(keyCrypter, aesKey);
decryptedKeyChain.add(clonedECKey);
}
// Replace the old keychain with the unencrypted one.
keychain = decryptedKeyChain;
// The wallet is now unencrypted.
this.keyCrypter = null;
}
/**
* Check whether the password can decrypt the first key in the wallet.
* @throws KeyCrypterException
*
* @returns boolean True if password supplied can decrypt the first private key in the wallet, false otherwise.
*/
public boolean checkPasswordCanDecryptFirstPrivateKey(char[] password) throws KeyCrypterException {
if (keyCrypter == null) {
// The password cannot decrypt anything as the keyCrypter is null.
return false;
}
return checkAESKeyCanDecryptFirstPrivateKey(keyCrypter.deriveKey(password));
}
/**
* Check whether the AES key can decrypt the first key in the wallet.
* This can be used to check the validity of an entered password.
*
* @returns boolean True if AES key supplied can decrypt the first private key in the wallet, false otherwise.
*/
public boolean checkAESKeyCanDecryptFirstPrivateKey(KeyParameter aesKey) {
if (getKeychain() == null || getKeychain().size() == 0) {
return false;
}
ECKey firstECKey = getKeychain().iterator().next();
if (firstECKey != null && firstECKey.getEncryptedPrivateKey() != null) {
try {
EncryptedPrivateKey clonedPrivateKey = new EncryptedPrivateKey(firstECKey.getEncryptedPrivateKey());
keyCrypter.decrypt(clonedPrivateKey, aesKey);
// Success.
return true;
} catch (KeyCrypterException ede) {
// The AES key supplied is incorrect.
return false;
}
}
return false;
}
/**
* Get the wallet's KeyCrypter.
* (Used in encrypting/ decrypting an ECKey).
*/
public KeyCrypter getKeyCrypter() {
return keyCrypter;
}
/**
* Get the type of encryption used for this wallet.
*/
public EncryptionType getEncryptionType() {
if (keyCrypter == null) {
// Unencrypted wallet.
return EncryptionType.UNENCRYPTED;
} else {
return keyCrypter.getEncryptionType();
}
}
/**
* Get the wallet version number.
*/
public WalletVersion getVersion() {
return version;
}
public void setVersion(WalletVersion version) {
this.version = version;
}
/**
* Set the text decription of the Wallet.
*/
public void setDescription(String description) {
this.description = description;
}
public String getDescription() {
return description;
}
}
| src/main/java/com/google/bitcoin/core/Wallet.java | /**
* Copyright 2011 Google Inc.
*
* 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.google.bitcoin.core;
import static com.google.bitcoin.core.Utils.bitcoinValueToFriendlyString;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.ExecutionException;
import org.bitcoinj.wallet.Protos.Wallet.EncryptionType;
import org.multibit.IsMultiBitClass;
import org.multibit.MultiBit;
import org.multibit.store.MultiBitWalletProtobufSerializer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.spongycastle.crypto.params.KeyParameter;
import com.google.bitcoin.core.TransactionConfidence.ConfidenceType;
import com.google.bitcoin.core.WalletTransaction.Pool;
import com.google.bitcoin.crypto.EncryptedPrivateKey;
import com.google.bitcoin.crypto.KeyCrypter;
import com.google.bitcoin.crypto.KeyCrypterException;
import com.google.bitcoin.crypto.WalletIsAlreadyDecryptedException;
import com.google.bitcoin.crypto.WalletIsAlreadyEncryptedException;
import com.google.bitcoin.store.WalletProtobufSerializer;
import com.google.bitcoin.utils.EventListenerInvoker;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.util.concurrent.ListenableFuture;
// To do list:
//
// - Make the keychain member protected and switch it to be a hashmap of some kind so key lookup ops are faster.
// - Refactor how keys are managed to better handle things like deterministic wallets in future.
// - Decompose the class where possible: break logic out into classes that can be customized/replaced by the user.
// - Coin selection
// - [Auto]saving to a backing store
// - Key management
// - just generally make Wallet smaller and easier to work with
// - Make clearing of transactions able to only rewind the wallet a certain distance instead of all blocks.
/**
* <p>A Wallet stores keys and a record of transactions that send and receive value from those keys. Using these,
* it is able to create new transactions that spend the recorded transactions, and this is the fundamental operation
* of the Bitcoin protocol.</p>
*
* <p>To learn more about this class, read <b><a href="http://code.google.com/p/bitcoinj/wiki/WorkingWithTheWallet">
* working with the wallet.</a></b></p>
*
* <p>To fill up a Wallet with transactions, you need to use it in combination with a {@link BlockChain} and various
* other objects, see the <a href="http://code.google.com/p/bitcoinj/wiki/GettingStarted">Getting started</a> tutorial
* on the website to learn more about how to set everything up.</p>
*
* <p>Wallets can be serialized using either Java serialization - this is not compatible across versions of bitcoinj,
* or protocol buffer serialization. You need to save the wallet whenever it changes, there is an auto-save feature
* that simplifies this for you although you're still responsible for manually triggering a save when your app is about
* to quit because the auto-save feature waits a moment before actually committing to disk to avoid IO thrashing when
* the wallet is changing very fast (eg due to a block chain sync). See
* {@link Wallet#autosaveToFile(java.io.File, long, java.util.concurrent.TimeUnit, com.google.bitcoin.core.Wallet.AutosaveEventListener)}
* for more information about this.</p>
*/
public class Wallet implements Serializable, IsMultiBitClass {
private static final Logger log = LoggerFactory.getLogger(Wallet.class);
private static final long serialVersionUID = 2L;
public static final int MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND = 2;
// Algorithm for movement of transactions between pools. Outbound tx = us spending coins. Inbound tx = us
// receiving coins. If a tx is both inbound and outbound (spend with change) it is considered outbound for the
// purposes of the explanation below.
//
// 1. Outbound tx is created by us: ->pending
// 2. Outbound tx that was broadcast is accepted into the main chain:
// <-pending and
// If there is a change output ->unspent
// If there is no change output ->spent
// 3. Outbound tx that was broadcast is accepted into a side chain:
// ->inactive (remains in pending).
// 4. Inbound tx is accepted into the best chain:
// ->unspent/spent
// 5. Inbound tx is accepted into a side chain:
// ->inactive
// Whilst it's also 'pending' in some sense, in that miners will probably try and incorporate it into the
// best chain, we don't mark it as such here. It'll eventually show up after a re-org.
// 6. Outbound tx that is pending shares inputs with a tx that appears in the main chain:
// <-pending ->dead
//
// Re-orgs:
// 1. Tx is present in old chain and not present in new chain
// <-unspent/spent ->pending
// These newly inactive transactions will (if they are relevant to us) eventually come back via receive()
// as miners resurrect them and re-include into the new best chain.
// 2. Tx is not present in old chain and is present in new chain
// <-inactive and ->unspent/spent
// 3. Tx is present in new chain and shares inputs with a pending transaction, including those that were resurrected
// due to point (1)
// <-pending ->dead
//
// Balance:
// 1. Sum up all unspent outputs of the transactions in unspent.
// 2. Subtract the inputs of transactions in pending.
// 3. If requested, re-add the outputs of pending transactions that are mine. This is the estimated balance.
/**
* Map of txhash->Transactions that have not made it into the best chain yet. They are eligible to move there but
* are waiting for a miner to create a block on the best chain including them. These transactions inputs count as
* spent for the purposes of calculating our balance but their outputs are not available for spending yet. This
* means after a spend, our balance can actually go down temporarily before going up again! We should fix this to
* allow spending of pending transactions.
*
* Pending transactions get announced to peers when they first connect. This means that if we're currently offline,
* we can still create spends and upload them to the network later.
*/
final Map<Sha256Hash, Transaction> pending;
/**
* Map of txhash->Transactions where the Transaction has unspent outputs. These are transactions we can use
* to pay other people and so count towards our balance. Transactions only appear in this map if they are part
* of the best chain. Transactions we have broacast that are not confirmed yet appear in pending even though they
* may have unspent "change" outputs.<p>
* <p/>
* Note: for now we will not allow spends of transactions that did not make it into the block chain. The code
* that handles this in BitCoin C++ is complicated. Satoshis code will not allow you to spend unconfirmed coins,
* however, it does seem to support dependency resolution entirely within the context of the memory pool so
* theoretically you could spend zero-conf coins and all of them would be included together. To simplify we'll
* make people wait but it would be a good improvement to resolve this in future.
*/
final Map<Sha256Hash, Transaction> unspent;
/**
* Map of txhash->Transactions where the Transactions outputs are all fully spent. They are kept separately so
* the time to create a spend does not grow infinitely as wallets become more used. Some of these transactions
* may not have appeared in a block yet if they were created by us to spend coins and that spend is still being
* worked on by miners.<p>
* <p/>
* Transactions only appear in this map if they are part of the best chain.
*/
final Map<Sha256Hash, Transaction> spent;
/**
* An inactive transaction is one that is seen only in a block that is not a part of the best chain. We keep it
* around in case a re-org promotes a different chain to be the best. In this case some (not necessarily all)
* inactive transactions will be moved out to unspent and spent, and some might be moved in.<p>
* <p/>
* Note that in the case where a transaction appears in both the best chain and a side chain as well, it is not
* placed in this map. It's an error for a transaction to be in both the inactive pool and unspent/spent.
*/
final Map<Sha256Hash, Transaction> inactive;
/**
* A dead transaction is one that's been overridden by a double spend. Such a transaction is pending except it
* will never confirm and so should be presented to the user in some unique way - flashing red for example. This
* should nearly never happen in normal usage. Dead transactions can be "resurrected" by re-orgs just like any
* other. Dead transactions are not in the pending pool.
*/
final Map<Sha256Hash, Transaction> dead;
/**
* A list of public/private EC keys owned by this user. Access it using addKey[s], hasKey[s] and findPubKeyFromHash.
*/
public ArrayList<ECKey> keychain;
private final NetworkParameters params;
/**
* The hash of the last block seen on the best chain
*/
private Sha256Hash lastBlockSeenHash;
private transient ArrayList<WalletEventListener> eventListeners;
// A listener that relays confidence changes from the transaction confidence object to the wallet event listener,
// as a convenience to API users so they don't have to register on every transaction themselves.
private transient TransactionConfidence.Listener txConfidenceListener;
// If a TX hash appears in this set then notifyNewBestBlock will ignore it, as its confidence was already set up
// in receive() via Transaction.setBlockAppearance(). As the BlockChain always calls notifyNewBestBlock even if
// it sent transactions to the wallet, without this we'd double count.
private transient HashSet<Sha256Hash> ignoreNextNewBlock;
/**
* The keyCrypter for the wallet. This specifies the algorithm used for encrypting and decrypting the private keys.
*/
private KeyCrypter keyCrypter;
/**
* The wallet version. This is an ordinal used to detect breaking changes.
* in the wallet format.
*/
WalletVersion version;
/**
* A description for the wallet.
*/
String description;
/**
* Creates a new, empty wallet with no keys and no transactions. If you want to restore a wallet from disk instead,
* see loadFromFile.
*/
public Wallet(NetworkParameters params) {
this(params, null);
}
/**
* Create a wallet with a keyCrypter to use in encrypting and decrypting keys.
*/
public Wallet(NetworkParameters params, KeyCrypter keyCrypter) {
this.params = params;
this.keyCrypter = keyCrypter;
keychain = new ArrayList<ECKey>();
unspent = new HashMap<Sha256Hash, Transaction>();
spent = new HashMap<Sha256Hash, Transaction>();
inactive = new HashMap<Sha256Hash, Transaction>();
pending = new HashMap<Sha256Hash, Transaction>();
dead = new HashMap<Sha256Hash, Transaction>();
createTransientState();
}
private void createTransientState() {
eventListeners = new ArrayList<WalletEventListener>();
ignoreNextNewBlock = new HashSet<Sha256Hash>();
txConfidenceListener = new TransactionConfidence.Listener() {
@Override
public void onConfidenceChanged(Transaction tx) {
invokeOnTransactionConfidenceChanged(tx);
// Many onWalletChanged events will not occur because they are suppressed, eg, because:
// - we are inside a re-org
// - we are in the middle of processing a block
// - the confidence is changing because a new best block was accepted
// It will run in cases like:
// - the tx is pending and another peer announced it
// - the tx is pending and was killed by a detected double spend that was not in a block
// The latter case cannot happen today because we won't hear about it, but in future this may
// become more common if conflict notices are implemented.
invokeOnWalletChanged();
}
};
}
public NetworkParameters getNetworkParameters() {
return params;
}
/**
* Returns a snapshot of the keychain. This view is not live.
*/
public synchronized Iterable<ECKey> getKeys() {
return new ArrayList<ECKey>(keychain);
}
/**
* Uses protobuf serialization to save the wallet to the given file. To learn more about this file format, see
* {@link WalletProtobufSerializer}.
*
* This method is keep simple as the file saving lifecycle is dealt with in FileHandler.
*/
public synchronized void saveToFile(File destFile) throws IOException {
FileOutputStream stream = null;
try {
stream = new FileOutputStream(destFile);
saveToFileStream(stream);
// Attempt to force the bits to hit the disk. In reality the OS or hard disk itself may still decide
// to not write through to physical media for at least a few seconds, but this is the best we can do.
stream.flush();
stream.getFD().sync();
stream.close();
stream = null;
} finally {
if (stream != null) {
stream.close();
}
}
}
/**
* Uses protobuf serialization to save the wallet to the given file stream. To learn more about this file format, see
* {@link WalletProtobufSerializer}.
*/
public synchronized void saveToFileStream(OutputStream f) throws IOException {
new MultiBitWalletProtobufSerializer().writeWallet(this, f);
}
/** Returns the parameters this wallet was created with. */
public NetworkParameters getParams() {
return params;
}
/**
* Returns a wallet deserialized from the given file.
* @throws KeyCrypterException
*/
public static Wallet loadFromFile(File f) throws IOException, KeyCrypterException {
FileInputStream stream = new FileInputStream(f);
try {
return loadFromFileStream(stream);
} finally {
stream.close();
}
}
public boolean isConsistent() {
// Seems overzealous so switch off for now.
return true;
}
/**
* Returns a wallet deserialized from the given input stream.
* @throws KeyCrypterException
*/
public static Wallet loadFromFileStream(InputStream stream) throws IOException, KeyCrypterException {
// Determine what kind of wallet stream this is: Java Serialization or protobuf format.
stream = new BufferedInputStream(stream);
stream.mark(100);
boolean serialization = stream.read() == 0xac && stream.read() == 0xed;
stream.reset();
Wallet wallet;
if (serialization) {
ObjectInputStream ois = null;
try {
ois = new ObjectInputStream(stream);
wallet = (Wallet) ois.readObject();
} catch (ClassNotFoundException e) {
throw new RuntimeException(e);
} finally {
if (ois != null) ois.close();
}
} else {
MultiBitWalletProtobufSerializer walletProtobufSerializer = new MultiBitWalletProtobufSerializer();
if (MultiBit.getController() != null && MultiBit.getController().getMultiBitService() != null
&& MultiBit.getController().getMultiBitService().getChain() != null) {
walletProtobufSerializer.setChainHeight(MultiBit.getController().getMultiBitService().getChain().getBestChainHeight());
}
wallet = walletProtobufSerializer.readWallet(stream);
}
if (!wallet.isConsistent()) {
log.error("Loaded an inconsistent wallet");
}
return wallet;
}
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
in.defaultReadObject();
createTransientState();
}
/**
* Called by the {@link BlockChain} when we receive a new block that sends coins to one of our addresses or
* spends coins from one of our addresses (note that a single transaction can do both).<p>
*
* This is necessary for the internal book-keeping Wallet does. When a transaction is received that sends us
* coins it is added to a pool so we can use it later to create spends. When a transaction is received that
* consumes outputs they are marked as spent so they won't be used in future.<p>
*
* A transaction that spends our own coins can be received either because a spend we created was accepted by the
* network and thus made it into a block, or because our keys are being shared between multiple instances and
* some other node spent the coins instead. We still have to know about that to avoid accidentally trying to
* double spend.<p>
*
* A transaction may be received multiple times if is included into blocks in parallel chains. The blockType
* parameter describes whether the containing block is on the main/best chain or whether it's on a presently
* inactive side chain. We must still record these transactions and the blocks they appear in because a future
* block might change which chain is best causing a reorganize. A re-org can totally change our balance!
*/
public synchronized void receiveFromBlock(Transaction tx, StoredBlock block,
BlockChain.NewBlockType blockType) throws VerificationException {
receive(tx, block, blockType, false);
}
/**
* Called when we have found a transaction (via network broadcast or otherwise) that is relevant to this wallet
* and want to record it. Note that we <b>cannot verify these transactions at all</b>, they may spend fictional
* coins or be otherwise invalid. They are useful to inform the user about coins they can expect to receive soon,
* and if you trust the sender of the transaction you can choose to assume they are in fact valid and will not
* be double spent as an optimization.
*
* @param tx
* @throws VerificationException
*/
public synchronized void receivePending(Transaction tx) throws VerificationException {
// Can run in a peer thread.
// Ignore it if we already know about this transaction. Receiving a pending transaction never moves it
// between pools.
EnumSet<Pool> containingPools = getContainingPools(tx);
if (!containingPools.equals(EnumSet.noneOf(Pool.class))) {
log.debug("Received tx we already saw in a block or created ourselves: " + tx.getHashAsString());
return;
}
// We only care about transactions that:
// - Send us coins
// - Spend our coins
if (!isTransactionRelevant(tx, true)) {
log.debug("Received tx that isn't relevant to this wallet, discarding.");
return;
}
BigInteger valueSentToMe = tx.getValueSentToMe(this);
BigInteger valueSentFromMe = tx.getValueSentFromMe(this);
if (log.isInfoEnabled()) {
log.info(String.format("Received a pending transaction %s that spends %s BTC from our own wallet," +
" and sends us %s BTC", tx.getHashAsString(), Utils.bitcoinValueToFriendlyString(valueSentFromMe),
Utils.bitcoinValueToFriendlyString(valueSentToMe)));
}
// Mark the tx as having been seen but is not yet in the chain. This will normally have been done already by
// the Peer before we got to this point, but in some cases (unit tests, other sources of transactions) it may
// have been missed out.
TransactionConfidence.ConfidenceType currentConfidence = tx.getConfidence().getConfidenceType();
if (currentConfidence == TransactionConfidence.ConfidenceType.UNKNOWN) {
tx.getConfidence().setConfidenceType(TransactionConfidence.ConfidenceType.NOT_SEEN_IN_CHAIN);
// Manually invoke the wallet tx confidence listener here as we didn't yet commit therefore the
// txConfidenceListener wasn't added.
invokeOnTransactionConfidenceChanged(tx);
}
// If this tx spends any of our unspent outputs, mark them as spent now, then add to the pending pool. This
// ensures that if some other client that has our keys broadcasts a spend we stay in sync. Also updates the
// timestamp on the transaction and registers/runs event listeners.
//
// Note that after we return from this function, the wallet may have been modified.
commitTx(tx);
}
// Boilerplate that allows event listeners to delete themselves during execution, and auto locks the listener.
private void invokeOnCoinsReceived(final Transaction tx, final BigInteger balance, final BigInteger newBalance) {
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override public void invoke(WalletEventListener listener) {
listener.onCoinsReceived(Wallet.this, tx, balance, newBalance);
}
});
}
private void invokeOnCoinsSent(final Transaction tx, final BigInteger prevBalance, final BigInteger newBalance) {
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override public void invoke(WalletEventListener listener) {
listener.onCoinsSent(Wallet.this, tx, prevBalance, newBalance);
}
});
}
/**
* Returns true if the given transaction sends coins to any of our keys, or has inputs spending any of our outputs,
* and if includeDoubleSpending is true, also returns true if tx has inputs that are spending outputs which are
* not ours but which are spent by pending transactions.<p>
*
* Note that if the tx has inputs containing one of our keys, but the connected transaction is not in the wallet,
* it will not be considered relevant.
*/
public synchronized boolean isTransactionRelevant(Transaction tx,
boolean includeDoubleSpending) throws ScriptException {
return tx.isMine(this) || tx.getValueSentFromMe(this).compareTo(BigInteger.ZERO) > 0
|| tx.getValueSentToMe(this).compareTo(BigInteger.ZERO) > 0
|| (includeDoubleSpending && (findDoubleSpendAgainstPending(tx) != null));
}
/**
* Checks if "tx" is spending any inputs of pending transactions. Not a general check, but it can work even if
* the double spent inputs are not ours. Returns the pending tx that was double spent or null if none found.
*/
private Transaction findDoubleSpendAgainstPending(Transaction tx) {
// Compile a set of outpoints that are spent by tx.
HashSet<TransactionOutPoint> outpoints = new HashSet<TransactionOutPoint>();
for (TransactionInput input : tx.getInputs()) {
outpoints.add(input.getOutpoint());
}
// Now for each pending transaction, see if it shares any outpoints with this tx.
for (Transaction p : pending.values()) {
for (TransactionInput input : p.getInputs()) {
if (outpoints.contains(input.getOutpoint())) {
// It does, it's a double spend against the pending pool, which makes it relevant.
return p;
}
}
}
return null;
}
private synchronized void receive(Transaction tx, StoredBlock block,
BlockChain.NewBlockType blockType,
boolean reorg) throws VerificationException {
// Runs in a peer thread.
BigInteger prevBalance = getBalance();
Sha256Hash txHash = tx.getHash();
boolean bestChain = blockType == BlockChain.NewBlockType.BEST_CHAIN;
boolean sideChain = blockType == BlockChain.NewBlockType.SIDE_CHAIN;
BigInteger valueSentFromMe = tx.getValueSentFromMe(this);
BigInteger valueSentToMe = tx.getValueSentToMe(this);
BigInteger valueDifference = valueSentToMe.subtract(valueSentFromMe);
if (!reorg) {
log.info("Received tx {} for {} BTC: {}", new Object[]{sideChain ? "on a side chain" : "",
bitcoinValueToFriendlyString(valueDifference), tx.getHashAsString()});
}
// If the transaction is already in our spent or unspent or there is no money in it it is probably
// due to a block replay so we do not want to do anything with it
// if it is on a sidechain then let the ELSE below deal with it
// if it is a double spend it gets processed later
Transaction doubleSpend = findDoubleSpendAgainstPending(tx);
boolean alreadyHaveIt = spent.containsKey(tx.getHash()) || unspent.containsKey(tx.getHash());
boolean noMoneyInItAndNotMine = BigInteger.ZERO.equals(valueSentFromMe) && BigInteger.ZERO.equals(valueSentToMe) && !tx.isMine(this);
if (bestChain && (doubleSpend == null) && (alreadyHaveIt || noMoneyInItAndNotMine)) {
log.info("Already have tx " + tx.getHash() + " in spent/ unspent or there is no money in it and it is not mine so ignoring");
return;
}
onWalletChangedSuppressions++;
// If this transaction is already in the wallet we may need to move it into a different pool. At the very
// least we need to ensure we're manipulating the canonical object rather than a duplicate.
Transaction wtx;
if ((wtx = pending.remove(txHash)) != null) {
// Make sure "tx" is always the canonical object we want to manipulate, send to event handlers, etc.
tx = wtx;
log.info(" <-pending");
// A transaction we created appeared in a block. Probably this is a spend we broadcast that has been
// accepted by the network.
if (bestChain) {
if (valueSentToMe.equals(BigInteger.ZERO)) {
// There were no change transactions so this tx is fully spent.
log.info(" ->spent");
addWalletTransaction(Pool.SPENT, tx);
} else {
// There was change back to us, or this tx was purely a spend back to ourselves (perhaps for
// anonymization purposes).
log.info(" ->unspent");
addWalletTransaction(Pool.UNSPENT, tx);
}
} else if (sideChain) {
// The transaction was accepted on an inactive side chain, but not yet by the best chain.
log.info(" ->inactive");
// It's OK for this to already be in the inactive pool because there can be multiple independent side
// chains in which it appears:
//
// b1 --> b2
// \-> b3
// \-> b4 (at this point it's already present in 'inactive'
boolean alreadyPresent = inactive.put(tx.getHash(), tx) != null;
if (alreadyPresent)
log.info("Saw a transaction be incorporated into multiple independent side chains");
// Put it back into the pending pool, because 'pending' means 'waiting to be included in best chain'.
pending.put(tx.getHash(), tx);
}
} else {
// This TX didn't originate with us. It could be sending us coins and also spending our own coins if keys
// are being shared between different wallets.
if (sideChain) {
if (unspent.containsKey(tx.getHash()) || spent.containsKey(tx.getHash())) {
// This side chain block contains transactions that already appeared in the best chain. It's normal,
// we don't need to consider this transaction inactive, we can just ignore it.
} else {
log.info(" ->inactive");
addWalletTransaction(Pool.INACTIVE, tx);
}
} else if (bestChain) {
// Saw a non-pending transaction appear on the best chain, ie, we are replaying the chain or a spend
// that we never saw broadcast (and did not originate) got included.
//
// This can trigger tx confidence listeners to be run in the case of double spends. We may need to
// delay the execution of the listeners until the bottom to avoid the wallet mutating during updates.
processTxFromBestChain(tx, doubleSpend);
}
}
log.info("Balance is now: " + bitcoinValueToFriendlyString(getBalance()));
// WARNING: The code beyond this point can trigger event listeners on transaction confidence objects, which are
// in turn allowed to re-enter the Wallet. This means we cannot assume anything about the state of the wallet
// from now on. The balance just received may already be spent.
if (block != null) {
// Mark the tx as appearing in this block so we can find it later after a re-org. This also tells the tx
// confidence object about the block and sets its work done/depth appropriately.
tx.setBlockAppearance(block, bestChain);
if (bestChain) {
// Don't notify this tx of work done in notifyNewBestBlock which will be called immediately after
// this method has been called by BlockChain for all relevant transactions. Otherwise we'd double
// count.
ignoreNextNewBlock.add(txHash);
}
}
// Inform anyone interested that we have received or sent coins but only if:
// - This is not due to a re-org.
// - The coins appeared on the best chain.
// - We did in fact receive some new money.
// - We have not already informed the user about the coins when we received the tx broadcast, or for our
// own spends. If users want to know when a broadcast tx becomes confirmed, they need to use tx confidence
// listeners.
//
// TODO: Decide whether to run the event listeners, if a tx confidence listener already modified the wallet.
boolean wasPending = wtx != null;
if (!reorg && bestChain && !wasPending) {
BigInteger newBalance = getBalance();
int diff = valueDifference.compareTo(BigInteger.ZERO);
// We pick one callback based on the value difference, though a tx can of course both send and receive
// coins from the wallet.
if (diff > 0) {
invokeOnCoinsReceived(tx, prevBalance, newBalance);
} else if (diff == 0) {
// Hack. Invoke onCoinsSent in order to let the client save the wallet. This needs to go away.
invokeOnCoinsSent(tx, prevBalance, newBalance);
} else {
invokeOnCoinsSent(tx, prevBalance, newBalance);
}
}
// Wallet change notification will be sent shortly after the block is finished processing, in notifyNewBestBlock
onWalletChangedSuppressions--;
checkState(isConsistent());
}
/**
* <p>Called by the {@link BlockChain} when a new block on the best chain is seen, AFTER relevant wallet
* transactions are extracted and sent to us UNLESS the new block caused a re-org, in which case this will
* not be called (the {@link Wallet#reorganize(StoredBlock, java.util.List, java.util.List)} method will
* call this one in that case).</p>
*
* <p>Used to update confidence data in each transaction and last seen block hash. Triggers auto saving.
* Invokes the onWalletChanged event listener if there were any affected transactions.</p>
*/
public synchronized void notifyNewBestBlock(Block block) throws VerificationException {
// Check to see if this block has been seen before.
Sha256Hash newBlockHash = block.getHash();
if (newBlockHash.equals(getLastBlockSeenHash()))
return;
// Store the new block hash.
setLastBlockSeenHash(newBlockHash);
// TODO: Clarify the code below.
// Notify all the BUILDING transactions of the new block.
// This is so that they can update their work done and depth.
onWalletChangedSuppressions++;
Set<Transaction> transactions = getTransactions(true, false);
for (Transaction tx : transactions) {
if (ignoreNextNewBlock.contains(tx.getHash())) {
// tx was already processed in receive() due to it appearing in this block, so we don't want to
// notify the tx confidence of work done twice, it'd result in miscounting.
ignoreNextNewBlock.remove(tx.getHash());
} else {
tx.getConfidence().notifyWorkDone(block);
}
}
onWalletChangedSuppressions--;
invokeOnWalletChanged();
}
/**
* Handle when a transaction becomes newly active on the best chain, either due to receiving a new block or a
* re-org making inactive transactions active.
*/
private void processTxFromBestChain(Transaction tx, Transaction doubleSpend) throws VerificationException {
// This TX may spend our existing outputs even though it was not pending. This can happen in unit
// tests, if keys are moved between wallets, if we're catching up to the chain given only a set of keys,
// or if a dead coinbase transaction has moved back onto the main chain.
boolean isDeadCoinbase = tx.isCoinBase() && dead.containsKey(tx.getHash());
if (isDeadCoinbase) {
// There is a dead coinbase tx being received on the best chain. A coinbase tx is made dead when it moves
// to a side chain but it can be switched back on a reorg and 'resurrected' back to spent or unspent.
// So take it out of the dead pool.
log.info(" coinbase tx {} <-dead: confidence {}", tx.getHashAsString(),
tx.getConfidence().getConfidenceType().name());
dead.remove(tx.getHash());
}
if (inactive.containsKey(tx.getHash())) {
// This transaction was seen first on a side chain, but now it's also been seen in the best chain.
// So we don't need to track it as inactive anymore.
log.info(" new tx {} <-inactive", tx.getHashAsString());
inactive.remove(tx.getHash());
}
updateForSpends(tx, true);
if (!tx.getValueSentToMe(this).equals(BigInteger.ZERO)) {
// It's sending us coins.
log.info(" new tx {} ->unspent", tx.getHashAsString());
addWalletTransaction(Pool.UNSPENT, tx);
} else if (!tx.getValueSentFromMe(this).equals(BigInteger.ZERO)) {
// It spent some of our coins and did not send us any.
log.info(" new tx {} ->spent", tx.getHashAsString());
addWalletTransaction(Pool.SPENT, tx);
} else {
// It didn't send us coins nor spend any of our coins. If we're processing it, that must be because it
// spends outpoints that are also spent by some pending transactions - maybe a double spend of somebody
// elses coins that were originally sent to us? ie, this might be a Finney attack where we think we
// received some money and then the sender co-operated with a miner to take back the coins, using a tx
// that isn't involving our keys at all.
// (it can also be an intra-wallet spend - see tx.isMine() call below)
if (doubleSpend != null) {
// This is mostly the same as the codepath in updateForSpends, but that one is only triggered when
// the transaction being double spent is actually in our wallet (ie, maybe we're double spending).
log.warn("Saw double spend from chain override pending tx {}", doubleSpend.getHashAsString());
log.warn(" <-pending ->dead");
pending.remove(doubleSpend.getHash());
dead.put(doubleSpend.getHash(), doubleSpend);
// Inform the event listeners of the newly dead tx.
doubleSpend.getConfidence().setOverridingTransaction(tx);
invokeOnTransactionConfidenceChanged(doubleSpend);
} else {
if (tx.isMine(this)) {
// a transaction that does not spend or send us coins but is ours none the less
// this can occur when a transaction is sent from outputs in our wallet to
// an address in the wallet - it burns a fee but is valid
log.info(" new tx -> spent (transfer within wallet - simply burns fee)");
boolean alreadyPresent = spent.put(tx.getHash(), tx) != null;
assert !alreadyPresent : "TX was received twice (transfer within wallet - simply burns fee";
invokeOnTransactionConfidenceChanged(tx);
} else {
throw new IllegalStateException("Received an irrelevant tx that was not a double spend.");
}
}
}
}
/**
* Updates the wallet by checking if this TX spends any of our outputs, and marking them as spent if so. It can
* be called in two contexts. One is when we receive a transaction on the best chain but it wasn't pending, this
* most commonly happens when we have a set of keys but the wallet transactions were wiped and we are catching up
* with the block chain. It can also happen if a block includes a transaction we never saw at broadcast time.
* If this tx double spends, it takes precedence over our pending transactions and the pending tx goes dead.
*
* The other context it can be called is from {@link Wallet#receivePending(Transaction)} ie we saw a tx be
* broadcast or one was submitted directly that spends our own coins. If this tx double spends it does NOT take
* precedence because the winner will be resolved by the miners - we assume that our version will win,
* if we are wrong then when a block appears the tx will go dead.
*/
private void updateForSpends(Transaction tx, boolean fromChain) throws VerificationException {
// tx is on the best chain by this point.
List<TransactionInput> inputs = tx.getInputs();
for (int i = 0; i < inputs.size(); i++) {
TransactionInput input = inputs.get(i);
TransactionInput.ConnectionResult result = input.connect(unspent, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
// Not found in the unspent map. Try again with the spent map.
result = input.connect(spent, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
// Not found in the unspent and spent maps. Try again with the pending map.
result = input.connect(pending, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
// Doesn't spend any of our outputs or is coinbase.
continue;
}
}
}
if (result == TransactionInput.ConnectionResult.ALREADY_SPENT) {
// Double spend! Work backwards like so:
//
// A -> spent by B [pending]
// \-> spent by C [chain]
Transaction doubleSpent = input.getOutpoint().fromTx; // == A
checkNotNull(doubleSpent);
int index = (int) input.getOutpoint().getIndex();
TransactionOutput output = doubleSpent.getOutputs().get(index);
TransactionInput spentBy = checkNotNull(output.getSpentBy());
Transaction connected = checkNotNull(spentBy.getParentTransaction());
if (fromChain) {
// This must have overridden a pending tx, or the block is bad (contains transactions
// that illegally double spend: should never occur if we are connected to an honest node).
if (pending.containsKey(connected.getHash())) {
log.warn("Saw double spend from chain override pending tx {}", connected.getHashAsString());
log.warn(" <-pending ->dead");
pending.remove(connected.getHash());
dead.put(connected.getHash(), connected);
// Now forcibly change the connection.
input.connect(unspent, TransactionInput.ConnectMode.DISCONNECT_ON_CONFLICT);
// Inform the [tx] event listeners of the newly dead tx. This sets confidence type also.
connected.getConfidence().setOverridingTransaction(tx);
}
} else {
// A pending transaction that tried to double spend our coins - we log and ignore it, because either
// 1) The double-spent tx is confirmed and thus this tx has no effect .... or
// 2) Both txns are pending, neither has priority. Miners will decide in a few minutes which won.
log.warn("Saw double spend from another pending transaction, ignoring tx {}",
tx.getHashAsString());
log.warn(" offending input is input {}", i);
return;
}
} else if (result == TransactionInput.ConnectionResult.SUCCESS) {
// Otherwise we saw a transaction spend our coins, but we didn't try and spend them ourselves yet.
// The outputs are already marked as spent by the connect call above, so check if there are any more for
// us to use. Move if not.
Transaction connected = checkNotNull(input.getOutpoint().fromTx);
maybeMoveTxToSpent(connected, "prevtx");
}
}
}
/**
* If the transactions outputs are all marked as spent, and it's in the unspent map, move it.
*/
private void maybeMoveTxToSpent(Transaction tx, String context) {
if (tx.isEveryOwnedOutputSpent(this)) {
// There's nothing left I can spend in this transaction.
if (unspent.remove(tx.getHash()) != null) {
if (log.isInfoEnabled()) {
log.info(" {} {} <-unspent", tx.getHashAsString(), context);
log.info(" {} {} ->spent", tx.getHashAsString(), context);
}
spent.put(tx.getHash(), tx);
}
}
}
/**
* Adds an event listener object. Methods on this object are called when something interesting happens,
* like receiving money.<p>
* <p/>
* Threading: Event listener methods are dispatched on library provided threads and the both the wallet and the
* listener objects are locked during dispatch, so your listeners do not have to be thread safe. However they
* should not block as the Peer will be unresponsive to network traffic whilst your listener is running.
*/
public synchronized void addEventListener(WalletEventListener listener) {
eventListeners.add(listener);
}
/**
* Removes the given event listener object. Returns true if the listener was removed,
* false if that listener was never added.
*/
public synchronized boolean removeEventListener(WalletEventListener listener) {
return eventListeners.remove(listener);
}
/**
* <p>Updates the wallet with the given transaction: puts it into the pending pool, sets the spent flags and runs
* the onCoinsSent/onCoinsReceived event listener. Used in two situations:</p>
*
* <ol>
* <li>When we have just successfully transmitted the tx we created to the network.</li>
* <li>When we receive a pending transaction that didn't appear in the chain yet, and we did not create it.</li>
* </ol>
*/
public synchronized void commitTx(Transaction tx) throws VerificationException {
checkArgument(!pending.containsKey(tx.getHash()), "commitTx called on the same transaction twice");
log.info("commitTx of {}", tx.getHashAsString());
BigInteger balance = getBalance();
tx.setUpdateTime(Utils.now());
// Mark the outputs we're spending as spent so we won't try and use them in future creations. This will also
// move any transactions that are now fully spent to the spent map so we can skip them when creating future
// spends.
updateForSpends(tx, false);
// Add to the pending pool. It'll be moved out once we receive this transaction on the best chain.
// This also registers txConfidenceListener so wallet listeners get informed.
log.info("->pending: {}", tx.getHashAsString());
addWalletTransaction(Pool.PENDING, tx);
// Event listeners may re-enter so we cannot make assumptions about wallet state after this loop completes.
try {
BigInteger valueSentFromMe = tx.getValueSentFromMe(this);
BigInteger valueSentToMe = tx.getValueSentToMe(this);
BigInteger newBalance = balance.add(valueSentToMe).subtract(valueSentFromMe);
if (valueSentToMe.compareTo(BigInteger.ZERO) > 0)
invokeOnCoinsReceived(tx, balance, newBalance);
if (valueSentFromMe.compareTo(BigInteger.ZERO) > 0)
invokeOnCoinsSent(tx, balance, newBalance);
invokeOnWalletChanged();
} catch (ScriptException e) {
// Cannot happen as we just created this transaction ourselves.
throw new RuntimeException(e);
}
checkState(isConsistent());
}
/**
* Returns a set of all transactions in the wallet.
* @param includeDead If true, transactions that were overridden by a double spend are included.
* @param includeInactive If true, transactions that are on side chains (are unspendable) are included.
*/
public synchronized Set<Transaction> getTransactions(boolean includeDead, boolean includeInactive) {
Set<Transaction> all = new HashSet<Transaction>();
all.addAll(unspent.values());
all.addAll(spent.values());
all.addAll(pending.values());
if (includeDead)
all.addAll(dead.values());
if (includeInactive)
all.addAll(inactive.values());
return all;
}
/**
* Returns a set of all WalletTransactions in the wallet.
*/
public synchronized Iterable<WalletTransaction> getWalletTransactions() {
HashSet<Transaction> pendingInactive = new HashSet<Transaction>();
pendingInactive.addAll(pending.values());
pendingInactive.retainAll(inactive.values());
HashSet<Transaction> onlyPending = new HashSet<Transaction>();
HashSet<Transaction> onlyInactive = new HashSet<Transaction>();
onlyPending.addAll(pending.values());
onlyPending.removeAll(pendingInactive);
onlyInactive.addAll(inactive.values());
onlyInactive.removeAll(pendingInactive);
Set<WalletTransaction> all = new HashSet<WalletTransaction>();
addWalletTransactionsToSet(all, Pool.UNSPENT, unspent.values());
addWalletTransactionsToSet(all, Pool.SPENT, spent.values());
addWalletTransactionsToSet(all, Pool.DEAD, dead.values());
addWalletTransactionsToSet(all, Pool.PENDING, onlyPending);
addWalletTransactionsToSet(all, Pool.INACTIVE, onlyInactive);
addWalletTransactionsToSet(all, Pool.PENDING_INACTIVE, pendingInactive);
return all;
}
private static synchronized void addWalletTransactionsToSet(Set<WalletTransaction> txs,
Pool poolType, Collection<Transaction> pool) {
for (Transaction tx : pool) {
txs.add(new WalletTransaction(poolType, tx));
}
}
/**
* Adds a transaction that has been associated with a particular wallet pool. This is intended for usage by
* deserialization code, such as the {@link WalletProtobufSerializer} class. It isn't normally useful for
* applications. It does not trigger auto saving.
*/
public void addWalletTransaction(WalletTransaction wtx) {
addWalletTransaction(wtx.getPool(), wtx.getTransaction());
}
/**
* Adds the given transaction to the given pools and registers a confidence change listener on it.
*/
private synchronized void addWalletTransaction(Pool pool, Transaction tx) {
switch (pool) {
case UNSPENT:
unspent.put(tx.getHash(), tx);
break;
case SPENT:
spent.put(tx.getHash(), tx);
break;
case PENDING:
pending.put(tx.getHash(), tx);
break;
case DEAD:
dead.put(tx.getHash(), tx);
break;
case INACTIVE:
inactive.put(tx.getHash(), tx);
break;
case PENDING_INACTIVE:
pending.put(tx.getHash(), tx);
inactive.put(tx.getHash(), tx);
break;
default:
throw new RuntimeException("Unknown wallet transaction type " + pool);
}
// This is safe even if the listener has been added before, as TransactionConfidence ignores duplicate
// registration requests. That makes the code in the wallet simpler.
tx.getConfidence().addEventListener(txConfidenceListener);
}
/**
* Returns all non-dead, active transactions ordered by recency.
*/
public List<Transaction> getTransactionsByTime() {
return getRecentTransactions(0, false);
}
/**
* Returns an list of N transactions, ordered by increasing age. Transactions on side chains are not included.
* Dead transactions (overridden by double spends) are optionally included. <p>
* <p/>
* Note: the current implementation is O(num transactions in wallet). Regardless of how many transactions are
* requested, the cost is always the same. In future, requesting smaller numbers of transactions may be faster
* depending on how the wallet is implemented (eg if backed by a database).
*/
public synchronized List<Transaction> getRecentTransactions(int numTransactions, boolean includeDead) {
checkArgument(numTransactions >= 0);
// Firstly, put all transactions into an array.
int size = getPoolSize(WalletTransaction.Pool.UNSPENT) +
getPoolSize(WalletTransaction.Pool.SPENT) +
getPoolSize(WalletTransaction.Pool.PENDING);
if (numTransactions > size || numTransactions == 0) {
numTransactions = size;
}
ArrayList<Transaction> all = new ArrayList<Transaction>(getTransactions(includeDead, false));
// Order by date.
Collections.sort(all, Collections.reverseOrder(new Comparator<Transaction>() {
@Override
public int compare(Transaction t1, Transaction t2) {
return t1.getUpdateTime().compareTo(t2.getUpdateTime());
}
}));
if (numTransactions == all.size()) {
return all;
} else {
all.subList(numTransactions, all.size()).clear();
return all;
}
}
/**
* Returns a transaction object given its hash, if it exists in this wallet, or null otherwise.
*/
public synchronized Transaction getTransaction(Sha256Hash hash) {
Transaction tx;
if ((tx = pending.get(hash)) != null)
return tx;
else if ((tx = unspent.get(hash)) != null)
return tx;
else if ((tx = spent.get(hash)) != null)
return tx;
else if ((tx = inactive.get(hash)) != null)
return tx;
else if ((tx = dead.get(hash)) != null)
return tx;
return null;
}
/**
* Deletes transactions which appeared above the given block height from the wallet, but does not touch the keys.
* This is useful if you have some keys and wish to replay the block chain into the wallet in order to pick them up.
*/
public synchronized void clearTransactions(int fromHeight) {
if (fromHeight == 0) {
unspent.clear();
spent.clear();
pending.clear();
inactive.clear();
dead.clear();
} else {
throw new UnsupportedOperationException();
}
}
synchronized EnumSet<Pool> getContainingPools(Transaction tx) {
EnumSet<Pool> result = EnumSet.noneOf(Pool.class);
Sha256Hash txHash = tx.getHash();
if (unspent.containsKey(txHash)) {
result.add(Pool.UNSPENT);
}
if (spent.containsKey(txHash)) {
result.add(Pool.SPENT);
}
if (pending.containsKey(txHash)) {
result.add(Pool.PENDING);
}
if (inactive.containsKey(txHash)) {
result.add(Pool.INACTIVE);
}
if (dead.containsKey(txHash)) {
result.add(Pool.DEAD);
}
return result;
}
synchronized int getPoolSize(WalletTransaction.Pool pool) {
switch (pool) {
case UNSPENT:
return unspent.size();
case SPENT:
return spent.size();
case PENDING:
return pending.size();
case INACTIVE:
return inactive.size();
case DEAD:
return dead.size();
case ALL:
return unspent.size() + spent.size() + pending.size() + inactive.size() + dead.size();
}
throw new RuntimeException("Unreachable");
}
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// SEND APIS
//
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/** A SendResult is returned to you as part of sending coins to a recipient. */
public static class SendResult {
/** The Bitcoin transaction message that moves the money. */
public Transaction tx;
/** A future that will complete once the tx message has been successfully broadcast to the network. */
public ListenableFuture<Transaction> broadcastComplete;
}
/**
* A SendRequest gives the wallet information about precisely how to send money to a recipient or set of recipients.
* Static methods are provided to help you create SendRequests and there are a few helper methods on the wallet that
* just simplify the most common use cases. You may wish to customize a SendRequest if you want to attach a fee or
* modify the change address.
*/
public static class SendRequest {
/**
* A transaction, probably incomplete, that describes the outline of what you want to do. This typically will
* mean it has some outputs to the intended destinations, but no inputs or change address (and therefore no
* fees) - the wallet will calculate all that for you and update tx later.
*/
public Transaction tx;
/**
* "Change" means the difference between the value gathered by a transactions inputs (the size of which you
* don't really control as it depends on who sent you money), and the value being sent somewhere else. The
* change address should be selected from this wallet, normally. <b>If null this will be chosen for you.</b>
*/
public Address changeAddress;
/**
* A transaction can have a fee attached, which is defined as the difference between the input values
* and output values. Any value taken in that is not provided to an output can be claimed by a miner. This
* is how mining is incentivized in later years of the Bitcoin system when inflation drops. It also provides
* a way for people to prioritize their transactions over others and is used as a way to make denial of service
* attacks expensive. Some transactions require a fee due to their structure - currently bitcoinj does not
* correctly calculate this! As of late 2012 most transactions require no fee.
*/
public BigInteger fee = BigInteger.ZERO;
// Tracks if this has been passed to wallet.completeTx already: just a safety check.
private boolean completed;
private SendRequest() {}
public static SendRequest to(Address destination, BigInteger value) {
SendRequest req = new Wallet.SendRequest();
req.tx = new Transaction(destination.getParameters());
req.tx.addOutput(value, destination);
return req;
}
public static SendRequest to(NetworkParameters params, ECKey destination, BigInteger value) {
SendRequest req = new SendRequest();
req.tx = new Transaction(params);
req.tx.addOutput(value, destination);
return req;
}
/** Simply wraps a pre-built incomplete transaction provided by you. */
public static SendRequest forTx(Transaction tx) {
SendRequest req = new SendRequest();
req.tx = tx;
return req;
}
}
/**
* Statelessly creates a transaction that sends the given number of nanocoins to address. The change is sent to
* {@link Wallet#getChangeAddress()}, so you must have added at least one key.<p>
* <p/>
* This method is stateless in the sense that calling it twice with the same inputs will result in two
* Transaction objects which are equal. The wallet is not updated to track its pending status or to mark the
* coins as spent until commitTx is called on the result.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction createSend(Address address, BigInteger nanocoins, final BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
return createSend(address, nanocoins, fee, getChangeAddress(), aesKey);
}
/**
* Sends coins to the given address but does not broadcast the resulting pending transaction. It is still stored
* in the wallet, so when the wallet is added to a {@link PeerGroup} or {@link Peer} the transaction will be
* announced to the network.
*
* @param to Address to send the coins to.
* @param nanocoins How many coins to send.
* @return the Transaction that was created, or null if there are insufficient coins in thew allet.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoinsOffline(Address to, BigInteger nanocoins, BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
Transaction tx = createSend(to, nanocoins, fee, aesKey);
if (tx == null) // Not enough money! :-(
return null;
try {
commitTx(tx);
} catch (VerificationException e) {
throw new RuntimeException(e); // Cannot happen unless there's a bug, as we just created this ourselves.
}
return tx;
}
/**
* Sends coins to the given address, via the given {@link PeerGroup}. Change is returned to {@link Wallet#getChangeAddress()}.
* The transaction will be announced to any connected nodes asynchronously. If you would like to know when
* the transaction was successfully sent to at least one node, use
* {@link Wallet#sendCoinsOffline(Address, java.math.BigInteger)} and then {@link PeerGroup#broadcastTransaction(Transaction)}
* on the result to obtain a {@link java.util.concurrent.Future<Transaction>}.
*
* @param peerGroup a PeerGroup to use for broadcast.
* @param to Which address to send coins to.
* @param nanocoins How many nanocoins to send. You can use Utils.toNanoCoins() to calculate this.
* @param fee The fee to include
* @return the Transaction
* @throws IOException if there was a problem broadcasting the transaction
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoinsAsync(PeerGroup peerGroup, Address to, BigInteger nanocoins, BigInteger fee, KeyParameter aesKey)
throws IOException, IllegalStateException, KeyCrypterException {
Transaction tx = sendCoinsOffline(to, nanocoins, fee, aesKey);
if (tx == null)
return null; // Not enough money.
// Just throw away the Future here. If the user wants it, they can call sendCoinsOffline/broadcastTransaction
// themselves.
peerGroup.broadcastTransaction(tx);
return tx;
}
/**
* Sends coins to the given address, via the given {@link PeerGroup}. Change is returned to {@link Wallet#getChangeAddress()}.
* The method will block until the transaction has been announced to at least one node.
*
* @param peerGroup a PeerGroup to use for broadcast or null.
* @param to Which address to send coins to.
* @param nanocoins How many nanocoins to send. You can use Utils.toNanoCoins() to calculate this.
* @param fee The fee to include
* @return The {@link Transaction} that was created or null if there was insufficient balance to send the coins.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoins(PeerGroup peerGroup, Address to, BigInteger nanocoins, final BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
Transaction tx = sendCoinsOffline(to, nanocoins, fee, aesKey);
if (tx == null)
return null; // Not enough money.
try {
return peerGroup.broadcastTransaction(tx).get();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ExecutionException e) {
throw new RuntimeException(e);
}
}
/**
* Sends coins to the given address, via the given {@link Peer}. Change is returned to {@link Wallet#getChangeAddress()}.
* If an exception is thrown by {@link Peer#sendMessage(Message)} the transaction is still committed, so the
* pending transaction must be broadcast <b>by you</b> at some other time.
*
* @param to Which address to send coins to.
* @param nanocoins How many nanocoins to send. You can use Utils.toNanoCoins() to calculate this.
* @param fee The fee to include
* @return The {@link Transaction} that was created or null if there was insufficient balance to send the coins.
* @throws IOException if there was a problem broadcasting the transaction
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized Transaction sendCoins(Peer peer, Address to, BigInteger nanocoins, BigInteger fee, KeyParameter aesKey) throws IOException, IllegalStateException, KeyCrypterException {
// TODO: This API is fairly questionable and the function isn't tested. If anything goes wrong during sending
// on the peer you don't get access to the created Transaction object and must fish it out of the wallet then
// do your own retry later.
Transaction tx = createSend(to, nanocoins, fee, aesKey);
if (tx == null) // Not enough money! :-(
return null;
try {
commitTx(tx);
} catch (VerificationException e) {
throw new RuntimeException(e); // Cannot happen unless there's a bug, as we just created this ourselves.
}
peer.sendMessage(tx);
return tx;
}
/**
* Creates a transaction that sends $coins.$cents BTC to the given address.<p>
* <p/>
* IMPORTANT: This method does NOT update the wallet. If you call createSend again you may get two transactions
* that spend the same coins. You have to call commitTx on the created transaction to prevent this,
* but that should only occur once the transaction has been accepted by the network. This implies you cannot have
* more than one outstanding sending tx at once.
*
* @param address The BitCoin address to send the money to.
* @param nanocoins How much currency to send, in nanocoins.
* @param fee The fee to include
* @param changeAddress Which address to send the change to, in case we can't make exactly the right value from
* our coins. This should be an address we own (is in the keychain).
* @return a new {@link Transaction} or null if we cannot afford this send.
* @throws KeyCrypterException
* @throws IllegalStateException
*/
synchronized Transaction createSend(Address address, BigInteger nanocoins, final BigInteger fee, Address changeAddress, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
log.info("Creating send tx to " + address.toString() + " for " +
bitcoinValueToFriendlyString(nanocoins));
Transaction sendTx = new Transaction(params);
sendTx.addOutput(nanocoins, address);
if (completeTx(sendTx, changeAddress, fee, aesKey)) {
return sendTx;
} else {
return null;
}
}
/**
* Takes a transaction with arbitrary outputs, gathers the necessary inputs for spending, and signs it
* @param sendTx The transaction to complete
* @param changeAddress Which address to send the change to, in case we can't make exactly the right value from
* our coins. This should be an address we own (is in the keychain).
* @param fee The fee to include
* @return False if we cannot afford this send, true otherwise
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized boolean completeTx(Transaction sendTx, Address changeAddress, BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
// Calculate the transaction total
BigInteger nanocoins = BigInteger.ZERO;
for(TransactionOutput output : sendTx.getOutputs()) {
nanocoins = nanocoins.add(output.getValue());
}
final BigInteger total = nanocoins.add(fee);
log.info("Completing send tx with {} outputs totalling {}", sendTx.getOutputs().size(), bitcoinValueToFriendlyString(nanocoins));
// To send money to somebody else, we need to do gather up transactions with unspent outputs until we have
// sufficient value. Many coin selection algorithms are possible, we use a simple but suboptimal one.
// TODO: Sort coins so we use the smallest first, to combat wallet fragmentation and reduce fees.
BigInteger valueGathered = BigInteger.ZERO;
List<TransactionOutput> gathered = new LinkedList<TransactionOutput>();
for (Transaction tx : unspent.values()) {
// Do not try and spend coinbases that were mined too recently, the protocol forbids it.
if (!tx.isMature()) {
continue;
}
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isAvailableForSpending()) continue;
if (!output.isMine(this)) continue;
gathered.add(output);
valueGathered = valueGathered.add(output.getValue());
}
if (valueGathered.compareTo(total) >= 0)
break;
}
// Can we afford this?
if (valueGathered.compareTo(total) < 0) {
// If there are insufficient unspent coins, see if there are any pending coins that have change-back-to-self
// and that have been seen by two or more peers. These are eligible for spending ("The Boomerang Rule")
for (Transaction tx : pending.values()) {
// Do not try and spend coinbases that were mined too recently, the protocol forbids it.
if (!tx.isMature()) {
continue;
}
if (transactionSpendsFromThisWalletAndHasBoomerangedBack(tx)) {
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isAvailableForSpending())
continue;
if (!output.isMine(this))
continue;
gathered.add(output);
valueGathered = valueGathered.add(output.getValue());
}
if (valueGathered.compareTo(total) >= 0)
break;
}
}
if (valueGathered.compareTo(total) < 0) {
// Still not enough funds.
log.info("Insufficient value in wallet for send, missing "
+ bitcoinValueToFriendlyString(nanocoins.subtract(valueGathered)));
// TODO: Should throw an exception here.
return false;
}
}
checkState(gathered.size() > 0);
sendTx.getConfidence().setConfidenceType(TransactionConfidence.ConfidenceType.NOT_SEEN_IN_CHAIN);
BigInteger change = valueGathered.subtract(total);
if (change.compareTo(BigInteger.ZERO) > 0) {
// The value of the inputs is greater than what we want to send. Just like in real life then,
// we need to take back some coins ... this is called "change". Add another output that sends the change
// back to us.
log.info(" with " + bitcoinValueToFriendlyString(change) + " coins change");
sendTx.addOutput(new TransactionOutput(params, sendTx, change, changeAddress));
}
for (TransactionOutput output : gathered) {
sendTx.addInput(output);
}
// Now sign the inputs, thus proving that we are entitled to redeem the connected outputs.
try {
sendTx.signInputs(Transaction.SigHash.ALL, this, aesKey);
} catch (ScriptException e) {
// If this happens it means an output script in a wallet tx could not be understood. That should never
// happen, if it does it means the wallet has got into an inconsistent state.
throw new RuntimeException(e);
} catch (KeyCrypterException kce) {
// This can occur if the key being used is encrypted.
throw new RuntimeException(kce);
}
// keep a track of the date the tx was created (used in MultiBitService
// to work out the block it appears in)
sendTx.setUpdateTime(new Date());
log.info(" completed {}", sendTx.getHashAsString());
return true;
}
private boolean transactionSpendsFromThisWalletAndHasBoomerangedBack(Transaction tx) {
boolean seenByEnoughPeers = false;
TransactionConfidence confidence = tx.getConfidence();
if (confidence != null && confidence.getBroadcastBy() != null
&& confidence.getBroadcastBy().size() >= MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND) {
seenByEnoughPeers = true;
}
if (!seenByEnoughPeers) return false;
boolean wasSentFromMyWallet = true;
// Check all transaction inputs are from your own wallet
for (TransactionInput input : tx.getInputs()) {
TransactionOutPoint outPoint = input.getOutpoint();
try {
TransactionOutput transactionOutput = outPoint.getConnectedOutput();
if (transactionOutput == null) {
wasSentFromMyWallet = false;
break;
}
ECKey ecKey = outPoint.getConnectedKey(this);
// if no ecKey was found then the transaction uses a transaction output from somewhere else
if (ecKey == null) {
wasSentFromMyWallet = false;
break;
}
} catch (ScriptException e) {
wasSentFromMyWallet = false;
break;
}
}
if (!wasSentFromMyWallet) return false;
// Transaction is both from out wallet and has boomeranged back.
return true;
}
/**
* Takes a transaction with arbitrary outputs, gathers the necessary inputs for spending, and signs it.
* Change goes to {@link Wallet#getChangeAddress()}
* @param sendTx The transaction to complete
* @param fee The fee to include
* @return False if we cannot afford this send, true otherwise
* @throws KeyCrypterException
* @throws IllegalStateException
*/
public synchronized boolean completeTx(Transaction sendTx, BigInteger fee, KeyParameter aesKey) throws IllegalStateException, KeyCrypterException {
return completeTx(sendTx, getChangeAddress(), fee, aesKey);
}
synchronized Address getChangeAddress() {
// For now let's just pick the first key in our keychain. In future we might want to do something else to
// give the user better privacy here, eg in incognito mode.
checkState(keychain.size() > 0, "Can't send value without an address to use for receiving change");
ECKey first = keychain.get(0);
return first.toAddress(params);
}
/**
* Adds the given ECKey to the wallet. There is currently no way to delete keys (that would result in coin loss).
* If {@link Wallet#autosaveToFile(java.io.File, long, java.util.concurrent.TimeUnit, com.google.bitcoin.core.Wallet.AutosaveEventListener)}
* has been called, triggers an auto save bypassing the normal coalescing delay and event handlers.
* If the key already exists in the wallet, does nothing and returns false.
* @throws KeyCrypterException
*/
public synchronized boolean addKey(final ECKey key) throws KeyCrypterException {
return addKeys(Lists.newArrayList(key)) == 1;
}
/**
* Adds the given keys to the wallet. There is currently no way to delete keys (that would result in coin loss).
* If {@link Wallet#autosaveToFile(java.io.File, long, java.util.concurrent.TimeUnit, com.google.bitcoin.core.Wallet.AutosaveEventListener)}
* has been called, triggers an auto save bypassing the normal coalescing delay and event handlers.
* Returns the number of keys added, after duplicates are ignored. The onKeyAdded event will be called for each key
* in the list that was not already present.
*/
public synchronized int addKeys(final List<ECKey> keys) throws KeyCrypterException {
// TODO: Consider making keys a sorted list or hashset so membership testing is faster.
int added = 0;
for (final ECKey key : keys) {
if (keychain.contains(key)) continue;
// If the key has a keyCrypter that does not match the Wallet's then a KeyCrypterException is thrown.
// This is done because only one keyCrypter is persisted per Wallet and hence all the keys must be homogenous.
if (keyCrypter != null && keyCrypter.getEncryptionType() != EncryptionType.UNENCRYPTED &&
!keyCrypter.equals(key.getKeyCrypter())) {
throw new KeyCrypterException("Cannot add key " + key.toString() + " because the keyCrypter does not match the wallets. Keys must be homogenous.");
}
keychain.add(key);
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onKeyAdded(key);
}
});
added++;
}
return added;
}
/**
* Locates a keypair from the keychain given the hash of the public key. This is needed when finding out which
* key we need to use to redeem a transaction output.
*
* @return ECKey object or null if no such key was found.
*/
public synchronized ECKey findKeyFromPubHash(byte[] pubkeyHash) {
for (ECKey key : keychain) {
if (Arrays.equals(key.getPubKeyHash(), pubkeyHash)) return key;
}
return null;
}
/** Returns true if the given key is in the wallet, false otherwise. Currently an O(N) operation. */
public boolean hasKey(ECKey key) {
return keychain.contains(key);
}
/**
* Returns true if this wallet contains a public key which hashes to the given hash.
*/
public synchronized boolean isPubKeyHashMine(byte[] pubkeyHash) {
return findKeyFromPubHash(pubkeyHash) != null;
}
/**
* Locates a keypair from the keychain given the raw public key bytes.
*
* @return ECKey or null if no such key was found.
*/
public synchronized ECKey findKeyFromPubKey(byte[] pubkey) {
for (ECKey key : keychain) {
if (Arrays.equals(key.getPubKey(), pubkey)) return key;
}
return null;
}
/**
* Returns true if this wallet contains a keypair with the given public key.
*/
public synchronized boolean isPubKeyMine(byte[] pubkey) {
return findKeyFromPubKey(pubkey) != null;
}
/**
* It's possible to calculate a wallets balance from multiple points of view. This enum selects which
* getBalance() should use.<p>
* <p/>
* Consider a real-world example: you buy a snack costing $5 but you only have a $10 bill. At the start you have
* $10 viewed from every possible angle. After you order the snack you hand over your $10 bill. From the
* perspective of your wallet you have zero dollars (AVAILABLE). But you know in a few seconds the shopkeeper
* will give you back $5 change so most people in practice would say they have $5 (ESTIMATED).<p>
*/
public enum BalanceType {
/**
* Balance calculated assuming all pending transactions are in fact included into the best chain by miners.
* This is the right balance to show in user interfaces.
*/
ESTIMATED,
/**
* Balance that can be safely used to create new spends. This is all confirmed unspent outputs minus the ones
* spent by pending transactions, but not including the outputs of those pending transactions.
*/
AVAILABLE,
/**
* Balance that can be safely used to create new spends. This includes all available and any change that
* has been been by MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND or more peers.
*/
AVAILABLE_WITH_BOOMERANG_CHANGE
}
/**
* Returns the AVAILABLE balance of this wallet. See {@link BalanceType#AVAILABLE} for details on what this
* means.<p>
* <p/>
* Note: the estimated balance is usually the one you want to show to the end user - however attempting to
* actually spend these coins may result in temporary failure. This method returns how much you can safely
* provide to {@link Wallet#createSend(Address, java.math.BigInteger)}.
*/
public synchronized BigInteger getBalance() {
return getBalance(BalanceType.AVAILABLE);
}
/**
* Returns the balance of this wallet as calculated by the provided balanceType.
*/
public synchronized BigInteger getBalance(BalanceType balanceType) {
BigInteger available = BigInteger.ZERO;
for (Transaction tx : unspent.values()) {
// For an 'available to spend' balance exclude coinbase transactions that have not yet matured.
if ((balanceType == BalanceType.AVAILABLE || balanceType == BalanceType.AVAILABLE_WITH_BOOMERANG_CHANGE) && !tx.isMature()) {
continue;
}
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isMine(this)) continue;
if (!output.isAvailableForSpending()) continue;
available = available.add(output.getValue());
}
}
if (balanceType == BalanceType.AVAILABLE)
return available;
checkState(balanceType == BalanceType.ESTIMATED || balanceType == BalanceType.AVAILABLE_WITH_BOOMERANG_CHANGE);
if (balanceType == BalanceType.ESTIMATED) {
// Now add back all the pending outputs to assume the transaction goes through.
BigInteger estimated = available;
for (Transaction tx : pending.values()) {
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isMine(this)) continue;
if (!output.isAvailableForSpending()) continue;
estimated = estimated.add(output.getValue());
}
}
return estimated;
} else {
BigInteger availableWithBoomerang = available;
// If transactions send from your own wallet then change is spendable after the transaction has been seen by
// MINIMUM_NUMBER_OF_PEERS_A_TRANSACTION_IS_SEEN_BY_FOR_SPEND
for (Transaction tx : pending.values()) {
if (transactionSpendsFromThisWalletAndHasBoomerangedBack(tx)) {
// Transaction is both from out wallet and has boomeranged back.
for (TransactionOutput output : tx.getOutputs()) {
if (!output.isMine(this))
continue;
if (!output.isAvailableForSpending())
continue;
availableWithBoomerang = availableWithBoomerang.add(output.getValue());
}
}
}
return availableWithBoomerang;
}
}
@Override
public synchronized String toString() {
return toString(false);
}
public synchronized String toString(boolean includePrivateKeys) {
StringBuilder builder = new StringBuilder();
builder.append(String.format("Wallet containing %s BTC in:%n", bitcoinValueToFriendlyString(getBalance())));
builder.append(String.format(" %d unspent transactions%n", unspent.size()));
builder.append(String.format(" %d spent transactions%n", spent.size()));
builder.append(String.format(" %d pending transactions%n", pending.size()));
builder.append(String.format(" %d inactive transactions%n", inactive.size()));
builder.append(String.format(" %d dead transactions%n", dead.size()));
builder.append(String.format("Last seen best block: %s%n", getLastBlockSeenHash()));
// Do the keys.
builder.append("\nKeys:\n");
for (ECKey key : keychain) {
builder.append(" addr:");
builder.append(key.toAddress(params));
builder.append(" ");
builder.append(includePrivateKeys ? key.toStringWithPrivate() : key.toString());
builder.append("\n");
}
// Print the transactions themselves
if (unspent.size() > 0) {
builder.append("\nUNSPENT:\n");
toStringHelper(builder, unspent);
}
if (spent.size() > 0) {
builder.append("\nSPENT:\n");
toStringHelper(builder, spent);
}
if (pending.size() > 0) {
builder.append("\nPENDING:\n");
toStringHelper(builder, pending);
}
if (inactive.size() > 0) {
builder.append("\nINACTIVE:\n");
toStringHelper(builder, inactive);
}
if (dead.size() > 0) {
builder.append("\nDEAD:\n");
toStringHelper(builder, dead);
}
// Add the keyCrypter so that any setup parameters are in the wallet toString.
if (this.keyCrypter != null) {
builder.append("\n KeyCrypter: " + keyCrypter.toString());
}
return builder.toString();
}
private void toStringHelper(StringBuilder builder, Map<Sha256Hash, Transaction> transactionMap) {
for (Transaction tx : transactionMap.values()) {
try {
builder.append("Sends ");
builder.append(Utils.bitcoinValueToFriendlyString(tx.getValueSentFromMe(this)));
builder.append(" and receives ");
builder.append(Utils.bitcoinValueToFriendlyString(tx.getValueSentToMe(this)));
builder.append(", total value ");
builder.append(Utils.bitcoinValueToFriendlyString(tx.getValue(this)));
builder.append(".\n");
} catch (ScriptException e) {
// Ignore and don't print this line.
}
builder.append(tx);
}
}
/**
* Called by the {@link BlockChain} when the best chain (representing total work done) has changed. In this case,
* we need to go through our transactions and find out if any have become invalid. It's possible for our balance
* to go down in this case: money we thought we had can suddenly vanish if the rest of the network agrees it
* should be so.<p>
*
* The oldBlocks/newBlocks lists are ordered height-wise from top first to bottom last.
*/
synchronized void reorganize(StoredBlock splitPoint, List<StoredBlock> oldBlocks, List<StoredBlock> newBlocks) throws VerificationException {
// This runs on any peer thread with the block chain synchronized.
//
// The reorganize functionality of the wallet is tested in ChainSplitTests.
//
// For each transaction we track which blocks they appeared in. Once a re-org takes place we have to find all
// transactions in the old branch, all transactions in the new branch and find the difference of those sets.
//
// receive() has been called on the block that is triggering the re-org before this is called.
List<Sha256Hash> oldBlockHashes = new ArrayList<Sha256Hash>(oldBlocks.size());
List<Sha256Hash> newBlockHashes = new ArrayList<Sha256Hash>(newBlocks.size());
log.info("Old part of chain (top to bottom):");
for (StoredBlock b : oldBlocks) {
log.info(" {}", b.getHeader().getHashAsString());
oldBlockHashes.add(b.getHeader().getHash());
}
log.info("New part of chain (top to bottom):");
for (StoredBlock b : newBlocks) {
log.info(" {}", b.getHeader().getHashAsString());
newBlockHashes.add(b.getHeader().getHash());
}
// Transactions that appear in the old chain segment.
Map<Sha256Hash, Transaction> oldChainTransactions = new HashMap<Sha256Hash, Transaction>();
// Transactions that appear in the old chain segment and NOT the new chain segment.
Map<Sha256Hash, Transaction> onlyOldChainTransactions = new HashMap<Sha256Hash, Transaction>();
// Transactions that appear in the new chain segment.
Map<Sha256Hash, Transaction> newChainTransactions = new HashMap<Sha256Hash, Transaction>();
// Transactions that don't appear in either the new or the old section, ie, the shared trunk.
Map<Sha256Hash, Transaction> commonChainTransactions = new HashMap<Sha256Hash, Transaction>();
Map<Sha256Hash, Transaction> all = new HashMap<Sha256Hash, Transaction>();
all.putAll(unspent);
all.putAll(spent);
all.putAll(inactive);
// Dead coinbase transactions are potentially resurrected so added to the list of tx to process.
for (Transaction tx : dead.values()) {
if (tx.isCoinBase()) {
all.put(tx.getHash(), tx);
}
}
for (Transaction tx : all.values()) {
Collection<Sha256Hash> appearsIn = tx.getAppearsInHashes();
checkNotNull(appearsIn);
// If the set of blocks this transaction appears in is disjoint with one of the chain segments it means
// the transaction was never incorporated by a miner into that side of the chain.
boolean inOldSection = !Collections.disjoint(appearsIn, oldBlockHashes);
boolean inNewSection = !Collections.disjoint(appearsIn, newBlockHashes);
boolean inCommonSection = !inNewSection && !inOldSection;
if (inCommonSection) {
boolean alreadyPresent = commonChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in common chain segment");
} else {
if (inOldSection) {
boolean alreadyPresent = oldChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in old chain segment");
if (!inNewSection) {
alreadyPresent = onlyOldChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in only-old map");
}
}
if (inNewSection) {
boolean alreadyPresent = newChainTransactions.put(tx.getHash(), tx) != null;
checkState(!alreadyPresent, "Transaction appears twice in new chain segment");
}
}
}
// If there is no difference it means we have nothing we need to do and the user does not care.
boolean affectedUs = !oldChainTransactions.equals(newChainTransactions);
log.info(affectedUs ? "Re-org affected our transactions" : "Re-org had no effect on our transactions");
if (!affectedUs) return;
// Avoid spuriously informing the user of wallet changes whilst we're re-organizing. This also prevents the
// user from modifying wallet contents (eg, trying to spend) whilst we're in the middle of the process.
onWalletChangedSuppressions++;
// For simplicity we will reprocess every transaction to ensure it's in the right bucket and has the right
// connections. Attempting to update each one with minimal work is possible but complex and was leading to
// edge cases that were hard to fix. As re-orgs are rare the amount of work this implies should be manageable
// unless the user has an enormous wallet. As an optimization fully spent transactions buried deeper than
// 1000 blocks could be put into yet another bucket which we never touch and assume re-orgs cannot affect.
for (Transaction tx : onlyOldChainTransactions.values()) log.info(" Only Old: {}", tx.getHashAsString());
for (Transaction tx : oldChainTransactions.values()) log.info(" Old: {}", tx.getHashAsString());
for (Transaction tx : newChainTransactions.values()) log.info(" New: {}", tx.getHashAsString());
// Break all the existing connections.
for (Transaction tx : all.values())
tx.disconnectInputs();
for (Transaction tx : pending.values())
tx.disconnectInputs();
// Reconnect the transactions in the common part of the chain.
for (Transaction tx : commonChainTransactions.values()) {
TransactionInput badInput = tx.connectForReorganize(all);
checkState(badInput == null, "Failed to connect %s, %s", tx.getHashAsString(),
badInput == null ? "" : badInput.toString());
}
// Recalculate the unspent/spent buckets for the transactions the re-org did not affect.
log.info("Moving transactions");
unspent.clear();
spent.clear();
inactive.clear();
for (Transaction tx : commonChainTransactions.values()) {
int unspentOutputs = 0;
for (TransactionOutput output : tx.getOutputs()) {
if (output.isAvailableForSpending() && output.isMine(this)) unspentOutputs++;
}
if (unspentOutputs > 0) {
log.info(" TX {} ->unspent", tx.getHashAsString());
unspent.put(tx.getHash(), tx);
} else {
log.info(" TX {} ->spent", tx.getHashAsString());
spent.put(tx.getHash(), tx);
}
}
// Inform all transactions that exist only in the old chain that they have moved, so they can update confidence
// and timestamps. Transactions will be told they're on the new best chain when the blocks are replayed.
for (Transaction tx : onlyOldChainTransactions.values()) {
tx.notifyNotOnBestChain();
// Kill any coinbase transactions that are only in the old chain.
// These transactions are no longer valid.
if (tx.isCoinBase()) {
// Move the transaction to the dead pool.
if (unspent.containsKey(tx.getHash())) {
log.info(" coinbase tx {} unspent->dead", tx.getHashAsString());
unspent.remove(tx.getHash());
} else if (spent.containsKey(tx.getHash())) {
log.info(" coinbase tx {} spent->dead", tx.getHashAsString());
// TODO Remove any dependent child transactions of the just removed coinbase transaction.
spent.remove(tx.getHash());
}
dead.put(tx.getHash(), tx);
// Set transaction confidence to dead and notify listeners.
tx.getConfidence().setConfidenceType(ConfidenceType.DEAD);
}
}
// Now replay the act of receiving the blocks that were previously in a side chain. This will:
// - Move any transactions that were pending and are now accepted into the right bucket.
// - Connect the newly active transactions.
Collections.reverse(newBlocks); // Need bottom-to-top but we get top-to-bottom.
// The old blocks have contributed to the depth and work done for all the transactions in the
// wallet that are in blocks up to and including the chain split block.
// The total depth and work done is calculated here and then subtracted from the appropriate transactions.
int depthToSubtract = oldBlocks.size();
BigInteger workDoneToSubtract = BigInteger.ZERO;
for (StoredBlock b : oldBlocks) {
workDoneToSubtract = workDoneToSubtract.add(b.getHeader().getWork());
}
log.info("DepthToSubtract = " + depthToSubtract + ", workDoneToSubtract = " + workDoneToSubtract);
// Remove depthToSubtract and workDoneToSubtract from all transactions in the wallet except for pending and inactive
// (i.e. the transactions in the two chains of blocks we are reorganising).
subtractDepthAndWorkDone(depthToSubtract, workDoneToSubtract, spent.values());
subtractDepthAndWorkDone(depthToSubtract, workDoneToSubtract, unspent.values());
subtractDepthAndWorkDone(depthToSubtract, workDoneToSubtract, dead.values());
// The effective last seen block is now the split point so set the lastSeenBlockHash.
setLastBlockSeenHash(splitPoint.getHeader().getHash());
for (StoredBlock b : newBlocks) {
log.info("Replaying block {}", b.getHeader().getHashAsString());
// Replay means: find the transactions that should be in that block, send them to the wallet, inform of
// new best block, repeat.
Set<Transaction> txns = new HashSet<Transaction>();
Sha256Hash blockHash = b.getHeader().getHash();
for (Transaction tx : newChainTransactions.values()) {
if (tx.getAppearsInHashes().contains(blockHash)) {
txns.add(tx);
log.info(" containing tx {}", tx.getHashAsString());
}
}
if (!txns.isEmpty()) {
// Add the transactions to the new blocks.
for (Transaction t : txns) {
try {
receive(t, b, BlockChain.NewBlockType.BEST_CHAIN, true);
} catch (ScriptException e) {
throw new RuntimeException(e); // Cannot happen as these blocks were already verified.
}
}
}
notifyNewBestBlock(b.getHeader());
}
// Find the transactions that didn't make it into the new chain yet. For each input, try to connect it to the
// transactions that are in {spent,unspent,pending}. Check the status of each input. For inactive
// transactions that only send us money, we put them into the inactive pool where they sit around waiting for
// another re-org or re-inclusion into the main chain. For inactive transactions where we spent money we must
// put them back into the pending pool if we can reconnect them, so we don't create a double spend whilst the
// network heals itself.
Map<Sha256Hash, Transaction> pool = new HashMap<Sha256Hash, Transaction>();
pool.putAll(unspent);
pool.putAll(spent);
pool.putAll(pending);
Map<Sha256Hash, Transaction> toReprocess = new HashMap<Sha256Hash, Transaction>();
toReprocess.putAll(onlyOldChainTransactions);
toReprocess.putAll(pending);
log.info("Reprocessing transactions not in new best chain:");
// Note, we must reprocess dead transactions first. The reason is that if there is a double spend across
// chains from our own coins we get a complicated situation:
//
// 1) We switch to a new chain (B) that contains a double spend overriding a pending transaction. The
// pending transaction goes dead.
// 2) We switch BACK to the first chain (A). The dead transaction must go pending again.
// 3) We resurrect the transactions that were in chain (B) and assume the miners will start work on putting them
// in to the chain, but it's not possible because it's a double spend. So now that transaction must become
// dead instead of pending.
//
// This only occurs when we are double spending our own coins.
for (Transaction tx : dead.values()) {
reprocessUnincludedTxAfterReorg(pool, tx);
}
for (Transaction tx : toReprocess.values()) {
reprocessUnincludedTxAfterReorg(pool, tx);
}
log.info("post-reorg balance is {}", Utils.bitcoinValueToFriendlyString(getBalance()));
// Inform event listeners that a re-org took place. They should save the wallet at this point.
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onReorganize(Wallet.this);
}
});
onWalletChangedSuppressions--;
invokeOnWalletChanged();
checkState(isConsistent());
}
/**
* Subtract the supplied depth and work done from the given transactions.
*/
synchronized private void subtractDepthAndWorkDone(int depthToSubtract, BigInteger workDoneToSubtract, Collection<Transaction> transactions) {
for (Transaction tx : transactions) {
if (tx.getConfidence().getConfidenceType() == ConfidenceType.BUILDING) {
tx.getConfidence().setDepthInBlocks(tx.getConfidence().getDepthInBlocks() - depthToSubtract);
tx.getConfidence().setWorkDone(tx.getConfidence().getWorkDone().subtract(workDoneToSubtract));
}
}
}
private void reprocessUnincludedTxAfterReorg(Map<Sha256Hash, Transaction> pool, Transaction tx) {
log.info("TX {}", tx.getHashAsString() + ", confidence = " + tx.getConfidence().getConfidenceType().name());
boolean isDeadCoinbase = tx.isCoinBase() && ConfidenceType.DEAD == tx.getConfidence().getConfidenceType();
// Dead coinbase transactions on a side chain stay dead.
if (isDeadCoinbase) {
return;
}
int numInputs = tx.getInputs().size();
int noSuchTx = 0;
int success = 0;
boolean isDead = false;
// The transactions that we connected inputs to, so we can go back later and move them into the right
// bucket if all their outputs got spent.
Set<Transaction> connectedTransactions = new TreeSet<Transaction>();
for (TransactionInput input : tx.getInputs()) {
TransactionInput.ConnectionResult result = input.connect(pool, TransactionInput.ConnectMode.ABORT_ON_CONFLICT);
if (result == TransactionInput.ConnectionResult.SUCCESS) {
success++;
TransactionOutput connectedOutput = checkNotNull(input.getConnectedOutput(pool));
connectedTransactions.add(checkNotNull(connectedOutput.parentTransaction));
} else if (result == TransactionInput.ConnectionResult.NO_SUCH_TX) {
noSuchTx++;
} else if (result == TransactionInput.ConnectionResult.ALREADY_SPENT) {
isDead = true;
// This transaction was replaced by a double spend on the new chain. Did you just reverse
// your own transaction? I hope not!!
log.info(" ->dead, will not confirm now unless there's another re-org", tx.getHashAsString());
TransactionOutput doubleSpent = input.getConnectedOutput(pool);
Transaction replacement = doubleSpent.getSpentBy().getParentTransaction();
dead.put(tx.getHash(), tx);
pending.remove(tx.getHash());
// This updates the tx confidence type automatically.
tx.getConfidence().setOverridingTransaction(replacement);
break;
}
}
if (isDead) return;
// If all inputs do not appear in this wallet move to inactive.
if (noSuchTx == numInputs) {
log.info(" ->inactive", tx.getHashAsString() + ", confidence = " + tx.getConfidence().getConfidenceType().name());
inactive.put(tx.getHash(), tx);
dead.remove(tx.getHash());
} else if (success == numInputs - noSuchTx) {
// All inputs are either valid for spending or don't come from us. Miners are trying to reinclude it.
log.info(" ->pending", tx.getHashAsString() + ", confidence = " + tx.getConfidence().getConfidenceType().name());
pending.put(tx.getHash(), tx);
dead.remove(tx.getHash());
}
// The act of re-connecting this un-included transaction may have caused other transactions to become fully
// spent so move them into the right bucket here to keep performance good.
for (Transaction maybeSpent : connectedTransactions) {
maybeMoveTxToSpent(maybeSpent, "reorg");
}
}
private void invokeOnTransactionConfidenceChanged(final Transaction tx) {
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onTransactionConfidenceChanged(Wallet.this, tx);
}
});
}
private int onWalletChangedSuppressions;
private synchronized void invokeOnWalletChanged() {
// Don't invoke the callback in some circumstances, eg, whilst we are re-organizing or fiddling with
// transactions due to a new block arriving. It will be called later instead.
Preconditions.checkState(onWalletChangedSuppressions >= 0);
if (onWalletChangedSuppressions > 0) return;
// Call with the wallet locked.
EventListenerInvoker.invoke(eventListeners, new EventListenerInvoker<WalletEventListener>() {
@Override
public void invoke(WalletEventListener listener) {
listener.onWalletChanged(Wallet.this);
}
});
}
/**
* Returns an immutable view of the transactions currently waiting for network confirmations.
*/
public synchronized Collection<Transaction> getPendingTransactions() {
return Collections.unmodifiableCollection(pending.values());
}
/**
* Returns the earliest creation time of the keys in this wallet, in seconds since the epoch, ie the min of
* {@link com.google.bitcoin.core.ECKey#getCreationTimeSeconds()}. This can return zero if at least one key does
* not have that data (was created before key timestamping was implemented). <p>
*
* This method is most often used in conjunction with {@link PeerGroup#setFastCatchupTimeSecs(long)} in order to
* optimize chain download for new users of wallet apps. Backwards compatibility notice: if you get zero from this
* method, you can instead use the time of the first release of your software, as it's guaranteed no users will
* have wallets pre-dating this time. <p>
*
* If there are no keys in the wallet, the current time is returned.
*/
public synchronized long getEarliestKeyCreationTime() {
if (keychain.size() == 0) {
return Utils.now().getTime() / 1000;
}
long earliestTime = Long.MAX_VALUE;
for (ECKey key : keychain) {
earliestTime = Math.min(key.getCreationTimeSeconds(), earliestTime);
}
return earliestTime;
}
// This object is used to receive events from a Peer or PeerGroup. Currently it is only used to receive
// transactions. Note that it does NOT pay attention to block message because they will be received from the
// BlockChain object along with extra data we need for correct handling of re-orgs.
private transient PeerEventListener peerEventListener;
/**
* The returned object can be used to connect the wallet to a {@link Peer} or {@link PeerGroup} in order to
* receive and process blocks and transactions.
*/
public synchronized PeerEventListener getPeerEventListener() {
if (peerEventListener == null) {
// Instantiate here to avoid issues with wallets resurrected from serialized copies.
peerEventListener = new AbstractPeerEventListener() {
@Override
public void onTransaction(Peer peer, Transaction t) {
// Runs locked on a peer thread.
try {
receivePending(t);
} catch (VerificationException e) {
log.warn("Received broadcast transaction that does not validate: {}", t);
log.warn("VerificationException caught", e);
}
}
};
}
return peerEventListener;
}
public Sha256Hash getLastBlockSeenHash() {
return lastBlockSeenHash;
}
public void setLastBlockSeenHash(Sha256Hash lastBlockSeenHash) {
this.lastBlockSeenHash = lastBlockSeenHash;
}
public Collection<ECKey> getKeychain() {
return keychain;
}
/**
* Deletes transactions which appeared after a certain date
*/
public synchronized void clearTransactions(Date fromDate) {
if (fromDate == null) {
unspent.clear();
spent.clear();
pending.clear();
inactive.clear();
dead.clear();
} else {
removeEntriesAfterDate(unspent, fromDate);
removeEntriesAfterDate(spent, fromDate);
removeEntriesAfterDate(pending, fromDate);
removeEntriesAfterDate(inactive, fromDate);
removeEntriesAfterDate(dead, fromDate);
}
}
private void removeEntriesAfterDate(Map<Sha256Hash, Transaction> pool, Date fromDate) {
log.debug("Wallet#removeEntriesAfterDate - Removing transactions later than " + fromDate.toString());
Set<Entry<Sha256Hash, Transaction>> loopEntries = pool.entrySet();
Iterator<Entry<Sha256Hash, Transaction>> iterator = loopEntries.iterator();
while(iterator.hasNext()) {
Entry<Sha256Hash, Transaction> member = iterator.next();
if (member.getValue() != null) {
Date updateTime = member.getValue().getUpdateTime();
if (updateTime != null && updateTime.after(fromDate)) {
iterator.remove();
log.debug("Wallet#removeEntriesAfterDate - Removed tx.1 " + member.getValue());
continue;
}
// if no updateTime remove them
if (updateTime == null || updateTime.getTime() == 0) {
iterator.remove();
log.debug("Removed tx.2 " + member.getValue());
continue;
}
}
}
}
/**
* Encrypt the wallet using the KeyCrypter and the AES key.
* @param keyCrypter The KeyCrypter that specifies how to encrypt/ decrypt a key
* @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
* @throws KeyCrypterException
*/
synchronized public void encrypt(KeyCrypter keyCrypter, KeyParameter aesKey) throws KeyCrypterException {
if (keyCrypter == null) {
throw new KeyCrypterException("A keyCrypter must be specified to encrypt a wallet.");
}
/**
* If the wallet is already encrypted then you cannot encrypt it again.
*/
if (this.keyCrypter != null && this.keyCrypter.getEncryptionType() != EncryptionType.UNENCRYPTED) {
throw new WalletIsAlreadyEncryptedException("Wallet is already encrypted");
}
// Create a new arraylist that will contain the encrypted keys
ArrayList<ECKey> encryptedKeyChain = new ArrayList<ECKey>();
for (ECKey key : keychain) {
if (key.isEncrypted()) {
throw new WalletIsAlreadyEncryptedException("Key '" + key.toString() + "' is already encrypted.");
}
// Clone the key before encrypting.
// (note that only the EncryptedPrivateKey is deep copied).
ECKey clonedECKey = new ECKey(key.getPrivKeyBytes(), new EncryptedPrivateKey(key.getEncryptedPrivateKey()),
key.getPubKey(), keyCrypter);
clonedECKey.encrypt(keyCrypter, aesKey);
encryptedKeyChain.add(clonedECKey);
}
// Replace the old keychain with the encrypted one.
keychain = encryptedKeyChain;
// The wallet is now encrypted.
this.keyCrypter = keyCrypter;
}
/**
* Decrypt the wallet with the keyCrypter and AES key.
*
* @param keyCrypter The KeyCrypter that specifies how to encrypt/ decrypt a key
* @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
* @throws KeyCrypterException
*/
synchronized public void decrypt(KeyCrypter keyCrypter, KeyParameter aesKey) throws KeyCrypterException {
// Check the wallet is already encrypted - you cannot decrypt an unencrypted wallet.
if (this.keyCrypter == null || this.keyCrypter.getEncryptionType() == EncryptionType.UNENCRYPTED) {
throw new WalletIsAlreadyDecryptedException("Wallet is already decrypted");
}
// Check that this.keyCrypter is identical to the one passed in otherwise there is risk of data loss.
// (This is trying to decrypt a wallet with a different algorithm to that used to encrypt it.)
if (!keyCrypter.equals(this.keyCrypter)) {
throw new KeyCrypterException("You are trying to decrypt a wallet with a different keyCrypter to the one used to encrypt it. Aborting.");
}
// Create a new arraylist that will contain the decrypted keys
ArrayList<ECKey> decryptedKeyChain = new ArrayList<ECKey>();
for (ECKey key : keychain) {
if (!key.isEncrypted()) {
throw new WalletIsAlreadyDecryptedException("Key '" + key.toString() + "' is already decrypted.");
}
// Clone the key before decrypting.
// (note that only the EncryptedPrivateKey is deep copied).
ECKey clonedECKey = new ECKey(new EncryptedPrivateKey(key.getEncryptedPrivateKey()), key.getPubKey(),
keyCrypter);
clonedECKey.decrypt(keyCrypter, aesKey);
decryptedKeyChain.add(clonedECKey);
}
// Replace the old keychain with the unencrypted one.
keychain = decryptedKeyChain;
// The wallet is now unencrypted.
this.keyCrypter = null;
}
/**
* Check whether the password can decrypt the first key in the wallet.
* @throws KeyCrypterException
*
* @returns boolean True if password supplied can decrypt the first private key in the wallet, false otherwise.
*/
public boolean checkPasswordCanDecryptFirstPrivateKey(char[] password) throws KeyCrypterException {
if (keyCrypter == null) {
// The password cannot decrypt anything as the keyCrypter is null.
return false;
}
return checkAESKeyCanDecryptFirstPrivateKey(keyCrypter.deriveKey(password));
}
/**
* Check whether the AES key can decrypt the first key in the wallet.
* This can be used to check the validity of an entered password.
*
* @returns boolean True if AES key supplied can decrypt the first private key in the wallet, false otherwise.
*/
public boolean checkAESKeyCanDecryptFirstPrivateKey(KeyParameter aesKey) {
if (getKeychain() == null || getKeychain().size() == 0) {
return false;
}
ECKey firstECKey = getKeychain().iterator().next();
if (firstECKey != null && firstECKey.getEncryptedPrivateKey() != null) {
try {
EncryptedPrivateKey clonedPrivateKey = new EncryptedPrivateKey(firstECKey.getEncryptedPrivateKey());
keyCrypter.decrypt(clonedPrivateKey, aesKey);
// Success.
return true;
} catch (KeyCrypterException ede) {
// The AES key supplied is incorrect.
return false;
}
}
return false;
}
/**
* Get the wallet's KeyCrypter.
* (Used in encrypting/ decrypting an ECKey).
*/
public KeyCrypter getKeyCrypter() {
return keyCrypter;
}
/**
* Get the type of encryption used for this wallet.
*/
public EncryptionType getEncryptionType() {
if (keyCrypter == null) {
// Unencrypted wallet.
return EncryptionType.UNENCRYPTED;
} else {
return keyCrypter.getEncryptionType();
}
}
/**
* Get the wallet version number.
* (This version number increases whenever the wallet format has a breaking change.)
*/
public WalletVersion getVersion() {
return version;
}
public void setVersion(WalletVersion version) {
this.version = version;
}
/**
* Set the text decription of the Wallet.
* (This is persisted in the wallet protobuf.)
*/
public void setDescription(String description) {
this.description = description;
}
public String getDescription() {
return description;
}
}
| tidy up | src/main/java/com/google/bitcoin/core/Wallet.java | tidy up | <ide><path>rc/main/java/com/google/bitcoin/core/Wallet.java
<ide>
<ide> /**
<ide> * The keyCrypter for the wallet. This specifies the algorithm used for encrypting and decrypting the private keys.
<add> * Null for an unencrypted wallet.
<ide> */
<ide> private KeyCrypter keyCrypter;
<ide>
<ide> /**
<del> * The wallet version. This is an ordinal used to detect breaking changes.
<del> * in the wallet format.
<add> * The wallet version. This is an ordinal used to detect breaking changes in the wallet format.
<ide> */
<ide> WalletVersion version;
<ide>
<ide> /**
<del> * A description for the wallet.
<add> * A description for the wallet. This is persisted in the wallet file.
<ide> */
<ide> String description;
<ide>
<ide> * Encrypt the wallet using the KeyCrypter and the AES key.
<ide> * @param keyCrypter The KeyCrypter that specifies how to encrypt/ decrypt a key
<ide> * @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
<del> * @throws KeyCrypterException
<add> * @throws KeyCrypterException Thrown if the wallet encryption fails. If so, the wallet state is unchanged.
<ide> */
<ide> synchronized public void encrypt(KeyCrypter keyCrypter, KeyParameter aesKey) throws KeyCrypterException {
<ide> if (keyCrypter == null) {
<ide> /**
<ide> * If the wallet is already encrypted then you cannot encrypt it again.
<ide> */
<del> if (this.keyCrypter != null && this.keyCrypter.getEncryptionType() != EncryptionType.UNENCRYPTED) {
<add> if (getEncryptionType() != EncryptionType.UNENCRYPTED) {
<ide> throw new WalletIsAlreadyEncryptedException("Wallet is already encrypted");
<ide> }
<ide>
<ide> * Decrypt the wallet with the keyCrypter and AES key.
<ide> *
<ide> * @param keyCrypter The KeyCrypter that specifies how to encrypt/ decrypt a key
<del> * @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
<del> * @throws KeyCrypterException
<add> * @param aesKey AES key to use (normally created using KeyCrypter#deriveKey and cached as it is time consuming to create from a password)
<add> * @throws KeyCrypterException Thrown if the wallet decryption fails. If so, the wallet state is unchanged.
<ide> */
<ide> synchronized public void decrypt(KeyCrypter keyCrypter, KeyParameter aesKey) throws KeyCrypterException {
<ide> // Check the wallet is already encrypted - you cannot decrypt an unencrypted wallet.
<del> if (this.keyCrypter == null || this.keyCrypter.getEncryptionType() == EncryptionType.UNENCRYPTED) {
<add> if (getEncryptionType() == EncryptionType.UNENCRYPTED) {
<ide> throw new WalletIsAlreadyDecryptedException("Wallet is already decrypted");
<ide> }
<ide>
<ide>
<ide> /**
<ide> * Get the wallet version number.
<del> * (This version number increases whenever the wallet format has a breaking change.)
<ide> */
<ide> public WalletVersion getVersion() {
<ide> return version;
<ide>
<ide> /**
<ide> * Set the text decription of the Wallet.
<del> * (This is persisted in the wallet protobuf.)
<ide> */
<ide> public void setDescription(String description) {
<ide> this.description = description; |
|
Java | apache-2.0 | 6e729923c9f2aef8a2af84eefacf91c57a9c9175 | 0 | apache/rampart,apache/rampart | /*
* Copyright 2004,2005 The Apache Software Foundation.
*
* 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.apache.ws.secpolicy.model;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.HashMap;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.apache.neethi.PolicyComponent;
import org.apache.ws.secpolicy.SP11Constants;
import org.apache.ws.secpolicy.SP12Constants;
import org.apache.ws.secpolicy.SPConstants;
public class SignedEncryptedElements extends AbstractSecurityAssertion {
private ArrayList xPathExpressions = new ArrayList();
private HashMap declaredNamespaces = new HashMap();
private String xPathVersion;
/**
* Just a flag to identify whether this holds sign element info or encr
* elements info
*/
private boolean signedElemets;
public SignedEncryptedElements(boolean signedElements, int version) {
this.signedElemets = signedElements;
setVersion(version);
}
/**
* @return Returns the xPathExpressions.
*/
public ArrayList getXPathExpressions() {
return xPathExpressions;
}
public void addXPathExpression(String expr) {
this.xPathExpressions.add(expr);
}
/**
* @return Returns the xPathVersion.
*/
public String getXPathVersion() {
return xPathVersion;
}
/**
* @param pathVersion
* The xPathVersion to set.
*/
public void setXPathVersion(String pathVersion) {
xPathVersion = pathVersion;
}
/**
* @return Returns the signedElemets.
*/
public boolean isSignedElemets() {
return signedElemets;
}
public HashMap getDeclaredNamespaces () {
return declaredNamespaces;
}
public void addDeclaredNamespaces(String uri, String prefix ) {
declaredNamespaces.put(prefix, uri);
}
public void serialize(XMLStreamWriter writer) throws XMLStreamException {
String localName = getName().getLocalPart();
String namespaceURI = getName().getNamespaceURI();
String prefix = writer.getPrefix(namespaceURI);
if (prefix == null) {
prefix = getName().getPrefix();
writer.setPrefix(prefix, namespaceURI);
}
// <sp:SignedElements> | <sp:EncryptedElements>
writer.writeStartElement(prefix, localName, namespaceURI);
// xmlns:sp=".."
writer.writeNamespace(prefix, namespaceURI);
if (xPathVersion != null) {
writer.writeAttribute(prefix, namespaceURI, SPConstants.XPATH_VERSION, xPathVersion);
}
String xpathExpression;
for (Iterator iterator = xPathExpressions.iterator(); iterator
.hasNext();) {
xpathExpression = (String) iterator.next();
// <sp:XPath ..>
writer.writeStartElement(prefix, SPConstants.XPATH_EXPR, namespaceURI);
Iterator<String> namespaces = declaredNamespaces.keySet().iterator();
while(namespaces.hasNext()) {
prefix = (String) namespaces.next();
namespaceURI = (String) declaredNamespaces.get(prefix);
writer.writeNamespace(prefix,namespaceURI);
}
writer.writeCharacters(xpathExpression);
writer.writeEndElement();
}
// </sp:SignedElements> | </sp:EncryptedElements>
writer.writeEndElement();
}
public QName getName() {
if (signedElemets) {
if (version == SPConstants.SP_V12) {
return SP12Constants.SIGNED_ELEMENTS;
} else {
return SP11Constants.SIGNED_ELEMENTS;
}
}
if (version == SPConstants.SP_V12) {
return SP12Constants.ENCRYPTED_ELEMENTS;
} else {
return SP11Constants.ENCRYPTED_ELEMENTS;
}
}
public PolicyComponent normalize() {
return this;
}
}
| modules/rampart-policy/src/main/java/org/apache/ws/secpolicy/model/SignedEncryptedElements.java | /*
* Copyright 2004,2005 The Apache Software Foundation.
*
* 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.apache.ws.secpolicy.model;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.HashMap;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.apache.neethi.PolicyComponent;
import org.apache.ws.secpolicy.SP11Constants;
import org.apache.ws.secpolicy.SP12Constants;
import org.apache.ws.secpolicy.SPConstants;
public class SignedEncryptedElements extends AbstractSecurityAssertion {
private ArrayList xPathExpressions = new ArrayList();
private HashMap declaredNamespaces = new HashMap();
private String xPathVersion;
/**
* Just a flag to identify whether this holds sign element info or encr
* elements info
*/
private boolean signedElemets;
public SignedEncryptedElements(boolean signedElements, int version) {
this.signedElemets = signedElements;
setVersion(version);
}
/**
* @return Returns the xPathExpressions.
*/
public ArrayList getXPathExpressions() {
return xPathExpressions;
}
public void addXPathExpression(String expr) {
this.xPathExpressions.add(expr);
}
/**
* @return Returns the xPathVersion.
*/
public String getXPathVersion() {
return xPathVersion;
}
/**
* @param pathVersion
* The xPathVersion to set.
*/
public void setXPathVersion(String pathVersion) {
xPathVersion = pathVersion;
}
/**
* @return Returns the signedElemets.
*/
public boolean isSignedElemets() {
return signedElemets;
}
public HashMap getDeclaredNamespaces () {
return declaredNamespaces;
}
public void addDeclaredNamespaces(String uri, String prefix ) {
declaredNamespaces.put(prefix, uri);
}
public void serialize(XMLStreamWriter writer) throws XMLStreamException {
String localName = getName().getLocalPart();
String namespaceURI = getName().getNamespaceURI();
String prefix = writer.getPrefix(namespaceURI);
if (prefix == null) {
prefix = getName().getPrefix();
writer.setPrefix(prefix, namespaceURI);
}
// <sp:SignedElements> | <sp:EncryptedElements>
writer.writeStartElement(prefix, localName, namespaceURI);
// xmlns:sp=".."
writer.writeNamespace(prefix, namespaceURI);
if (xPathVersion != null) {
writer.writeAttribute(prefix, namespaceURI, SPConstants.XPATH_VERSION, xPathVersion);
}
String xpathExpression;
for (Iterator iterator = xPathExpressions.iterator(); iterator
.hasNext();) {
xpathExpression = (String) iterator.next();
// <sp:XPath ..>
writer.writeStartElement(prefix, SPConstants.XPATH_EXPR, namespaceURI);
writer.writeCharacters(xpathExpression);
writer.writeEndElement();
}
// </sp:SignedElements> | </sp:EncryptedElements>
writer.writeEndElement();
}
public QName getName() {
if (signedElemets) {
if (version == SPConstants.SP_V12) {
return SP12Constants.SIGNED_ELEMENTS;
} else {
return SP11Constants.SIGNED_ELEMENTS;
}
}
if (version == SPConstants.SP_V12) {
return SP12Constants.ENCRYPTED_ELEMENTS;
} else {
return SP11Constants.ENCRYPTED_ELEMENTS;
}
}
public PolicyComponent normalize() {
return this;
}
}
| Serializing the namespaces
git-svn-id: 826b4206cfd113e788b1201c7dc26b81d52deb30@760506 13f79535-47bb-0310-9956-ffa450edef68
| modules/rampart-policy/src/main/java/org/apache/ws/secpolicy/model/SignedEncryptedElements.java | Serializing the namespaces | <ide><path>odules/rampart-policy/src/main/java/org/apache/ws/secpolicy/model/SignedEncryptedElements.java
<ide> xpathExpression = (String) iterator.next();
<ide> // <sp:XPath ..>
<ide> writer.writeStartElement(prefix, SPConstants.XPATH_EXPR, namespaceURI);
<add>
<add> Iterator<String> namespaces = declaredNamespaces.keySet().iterator();
<add>
<add> while(namespaces.hasNext()) {
<add> prefix = (String) namespaces.next();
<add> namespaceURI = (String) declaredNamespaces.get(prefix);
<add> writer.writeNamespace(prefix,namespaceURI);
<add> }
<add>
<ide> writer.writeCharacters(xpathExpression);
<ide> writer.writeEndElement();
<ide> } |
|
Java | apache-2.0 | e323192cfc4b48ea930b2a9b2998ef5a7893bfec | 0 | OpenTOSCA/container,OpenTOSCA/container | package org.opentosca.container.core.plan;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
import javax.script.ScriptException;
import javax.ws.rs.HttpMethod;
import javax.xml.namespace.QName;
import org.eclipse.winery.model.tosca.TExtensibleElements;
import org.eclipse.winery.model.tosca.TNodeTemplate;
import org.eclipse.winery.model.tosca.TServiceTemplate;
import org.eclipse.winery.model.tosca.TTag;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.apache.http.HttpHeaders;
import org.opentosca.container.core.model.choreography.SituationExpression;
import org.opentosca.container.core.model.choreography.SituationRule;
import org.opentosca.container.core.model.csar.Csar;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
@Service
public class ChoreographyHandler {
private final static Logger LOG = LoggerFactory.getLogger(ChoreographyHandler.class);
private final static QName PARTICIPANT_ATTRIBUTE = QName.valueOf("{http://www.opentosca.org/winery/extensions/tosca/2013/02/12}participant");
private static final String PARTICIPANT = "participant";
private static final String APP_CHOR_ID = "app_chor_id";
private static final String PARTNERSELECTION_RULES = "partnerselection_rules";
private static final String CHOREOGRAPHY = "choreography";
/**
* Check if the given ServiceTemplate is part of a choreographed application deployment
*/
public boolean isChoreography(final TServiceTemplate serviceTemplate) {
return Objects.nonNull(getTagWithName(serviceTemplate, CHOREOGRAPHY));
}
/**
* Get the participant tag of the given ServiceTemplate
*/
public String getInitiator(final TServiceTemplate serviceTemplate) {
return getTagWithName(serviceTemplate, PARTICIPANT);
}
/**
* Get the app_chor_id tag of the given ServiceTemplate
*/
public String getAppChorId(final TServiceTemplate serviceTemplate) {
return getTagWithName(serviceTemplate, APP_CHOR_ID);
}
public Collection<SituationExpression> getSituationExpressions(final TServiceTemplate serviceTemplate) {
List<SituationExpression> situationRules = new ArrayList<>();
Map<String, String> tags = this.getTags(serviceTemplate);
// get tag containing the situation rules
String situationRuleTag = tags.get(PARTNERSELECTION_RULES);
if (Objects.nonNull(situationRuleTag)) {
String[] situationRuleCandidates = situationRuleTag.split(";");
LOG.debug("Found {} situation rule candidate(s)!", situationRuleCandidates.length);
// check validity of rules and parse to rules object
for (String situationRuleCandidate : situationRuleCandidates) {
// each rule requires a situation and two alternative partners
String[] situationRuleParts = situationRuleCandidate.split(",");
if (situationRuleParts.length != 2) {
continue;
}
String expression = situationRuleParts[0];
String partner = situationRuleParts[1];
if (Objects.nonNull(partner)) {
situationRules.add(new SituationExpression(expression.trim(), partner.trim(), tags));
} else {
LOG.warn("Unable to retrieve required URLs for rule with name '{}', situation compliant partner '{}', and alternative partner '{}'!",
situationRuleParts[0], situationRuleParts[1]);
}
}
} else {
LOG.warn("Unable to find situation rule tag!");
}
return situationRules;
}
/**
* Get the situation rules to decide which partner to include in a choreography
*/
public List<SituationRule> getSituationRules(final TServiceTemplate serviceTemplate) {
List<SituationRule> situationRules = new ArrayList<>();
// get tag containing the situation rules
String situationRuleTag = getTagWithName(serviceTemplate, PARTNERSELECTION_RULES);
if (Objects.nonNull(situationRuleTag)) {
String[] situationRuleCandidates = situationRuleTag.split(";");
LOG.debug("Found {} situation rule candidate(s)!", situationRuleCandidates.length);
// check validity of rules and parse to rules object
for (String situationRuleCandidate : situationRuleCandidates) {
// each rule requires a situation and two alternative partners
String[] situationRuleParts = situationRuleCandidate.split(",");
if (situationRuleParts.length != 3) {
continue;
}
String situationUrl = getTagWithName(serviceTemplate, situationRuleParts[0]);
String situationCompliantPartnerUrl = getTagWithName(serviceTemplate, situationRuleParts[1]);
String alternativePartnerUrl = getTagWithName(serviceTemplate, situationRuleParts[2]);
if (Objects.nonNull(situationUrl) && Objects.nonNull(situationCompliantPartnerUrl) && Objects.nonNull(alternativePartnerUrl)) {
try {
situationRules.add(new SituationRule(new URL(situationUrl), situationRuleParts[1], new URL(situationCompliantPartnerUrl), situationRuleParts[2], new URL(alternativePartnerUrl)));
} catch (MalformedURLException e) {
LOG.error("Unable to generate situation rule because of malformed URL: {}", e.getMessage());
}
} else {
LOG.warn("Unable to retrieve required URLs for rule with name '{}', situation compliant partner '{}', and alternative partner '{}'!",
situationRuleParts[0], situationRuleParts[1], situationRuleParts[2]);
}
}
} else {
LOG.warn("Unable to find situation rule tag!");
}
return situationRules;
}
/**
* Get the list of involved partners based on available selection rules
*
* @param situationRules a list of situation expressions to filter the required partners
* @param possiblePartners a list of possible partners from the ServiceTemplate tags
* @return a list of filtered partners
*/
public List<String> getPartnersBasedOnSelectionExpression(Collection<SituationExpression> situationRules, List<String> possiblePartners) {
List<String> partners = new ArrayList<>();
// check all situation rules and add the corresponding partners
for (SituationExpression situationRule : situationRules) {
possiblePartners.remove(situationRule.partner);
try {
if (situationRule.evaluateExpression()) {
partners.add(situationRule.partner);
}
} catch (ScriptException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
LOG.debug("Number of situation independent partners: {}", possiblePartners.size());
LOG.debug("Number of situation dependent partners: {}", partners.size());
// assumption if at the end no dependent partners are selected => no deployment possible
if (partners.isEmpty()) {
return new ArrayList<String>();
}
partners.addAll(possiblePartners);
return partners;
}
/**
* Get the list of involved partners based on available selection rules
*
* @param situationRules a list of situation rules to filter the required partners
* @param possiblePartners a list of possible partners from the ServiceTemplate tags
* @return a list of filtered partners
*/
public List<String> getPartnersBasedOnSelectionRule(List<SituationRule> situationRules, List<String> possiblePartners) {
List<String> partners = new ArrayList<>();
Map<String, String> partnerAlternatives = new HashMap<String, String>();
// check all situation rules and add the corresponding partners
for (SituationRule situationRule : situationRules) {
possiblePartners.remove(situationRule.getSituationCompliantPartnerName());
possiblePartners.remove(situationRule.getAlternativePartnerName());
partnerAlternatives.put(situationRule.getSituationCompliantPartnerName(), situationRule.getAlternativePartnerName());
if (isSituationRuleActive(situationRule.getSituationRuleUrl())) {
LOG.debug("Adding compliant partner '{}' for situation with URL: {}", situationRule.getSituationCompliantPartnerName(), situationRule.getSituationRuleUrl());
partners.add(situationRule.getSituationCompliantPartnerName());
} else {
LOG.debug("Adding alternative partner '{}' for situation with URL: {}", situationRule.getAlternativePartnerName(), situationRule.getSituationRuleUrl());
partners.add(situationRule.getAlternativePartnerName());
}
}
LOG.debug("Number of situation independent partners: {}", possiblePartners.size());
LOG.debug("Number of situation dependent partners: {}", partners.size());
// check if some partners are both valid but therefore introduce ambiguity => remove ambiguity
// what we'll do is the following:
// - iterate overall partner alternatives that were collected from the situationRule,
// - make sure from an alternative there is exactly (!) one partner in the set of dependent partners
// - if there is more than one partner in the set -> remove one randomly(sure if randomly?)
// - if there is none of the partners availabel -> return an empty list as we didn't find a valid configuration of partners
for (String partner1 : partnerAlternatives.keySet()) {
String partner2 = partnerAlternatives.get(partner1);
boolean partner1Available = false;
boolean partner2Available = false;
if (partners.contains(partner1)) partner1Available = true;
if (partners.contains(partner2)) partner2Available = true;
if (partner1Available && partner2Available) {
// both partners of a rule are valid = ambiguity => remove one partner
partners.remove(partner2);
} else if (!partner1Available && !partner2Available) {
// both partners of a rule are not valid => deployment not valid
return new ArrayList<String>();
}
}
partners.addAll(possiblePartners);
return partners;
}
/**
* Check if the situation on the given URL is active
*
* @param situationUrl the URL to the situation rule to evaluate
* @return <code>true</code> if the referenced situation rule is active, <code>false</code> otherwise
*/
private boolean isSituationRuleActive(URL situationUrl) {
try {
// retrieve situation
HttpURLConnection connection = (HttpURLConnection) situationUrl.openConnection();
connection.setDoOutput(true);
connection.setInstanceFollowRedirects(false);
connection.setRequestMethod(HttpMethod.GET);
connection.setRequestProperty(HttpHeaders.ACCEPT, "application/json");
connection.connect();
String json = IOUtils.toString(connection.getInputStream(), StandardCharsets.UTF_8);
// read active part and parse to boolean to check if situation is active
Map<String, Object> map = new ObjectMapper().readValue(json, Map.class);
if (!map.containsKey("active")) {
LOG.warn("Situation at URL '{}' is invalid!", situationUrl);
return false;
}
return Boolean.parseBoolean(map.get("active").toString());
} catch (IOException e) {
LOG.debug("Unable to parse situation from URL {}: {}", situationUrl, e.getMessage());
return false;
}
}
/**
* Get the endpoints of all choreography partners from the ServiceTemplate.
*
* @param serviceTemplate the ServiceTemplate for the choreography
* @return a list of tags containing the partner name as key and the endpoints as value or
* <code>null</code> if no tags are defined on the ServiceTemplate
*/
public List<TTag> getPartnerEndpoints(final TServiceTemplate serviceTemplate) {
// get the tags containing the endpoints of the partners
if (Objects.isNull(serviceTemplate.getTags())) {
LOG.error("Unable to retrieve tags for ServiceTemplate with ID {}.", serviceTemplate.getId());
return null;
}
List<TTag> tags = serviceTemplate.getTags().getTag();
LOG.debug("Number of tags: {}", tags.size());
List<TTag> partnerTags = Lists.newArrayList();
tags.forEach(tag -> {
if (tag.getName().startsWith("participant:")) {
String participantName = tag.getName().replace("participant:", "");
partnerTags.add(new TTag.Builder().setName(participantName).setValue(tag.getValue()).build());
}});
LOG.debug("Number of tags after filtering for partners: {}", tags.size());
return partnerTags;
}
public String getPossiblePartners(final TNodeTemplate nodeTemplate, Collection<String> participants) {
if (nodeTemplate.getOtherAttributes().get(PARTICIPANT_ATTRIBUTE) != null) {
for (String participant : nodeTemplate.getOtherAttributes().get(PARTICIPANT_ATTRIBUTE).split(",")) {
if (participants.contains(participant)) {
return participant;
}
}
}
return null;
}
private Map<String, String> getTags(final TServiceTemplate serviceTemplate) {
Map<String, String> tags = new HashMap<String, String>();
if (Objects.isNull(serviceTemplate.getTags())) {
return tags;
}
for (TTag tag : serviceTemplate.getTags().getTag()) {
tags.put(tag.getName(), tag.getValue());
}
return tags;
}
/**
* Get the tag with the given name
*/
private String getTagWithName(final TServiceTemplate serviceTemplate, String tagName) {
if (Objects.isNull(serviceTemplate.getTags())) {
return null;
}
for (TTag tag : serviceTemplate.getTags().getTag()) {
if (tag.getName().equals(tagName)) {
return tag.getValue();
}
}
return null;
}
public Csar getChoreographyCsar(String appChoreoId, Collection<Csar> csars, String receivingPartner) {
for (Csar csar : csars) {
TServiceTemplate serviceTemplate = csar.entryServiceTemplate();
String tagAppChorId = new ChoreographyHandler().getAppChorId(serviceTemplate);
String participantName = getTagWithName(serviceTemplate, PARTICIPANT);
if (Objects.nonNull(tagAppChorId) && tagAppChorId.equals(appChoreoId) && Objects.nonNull(participantName) && participantName.equals(receivingPartner)) {
return csar;
}
}
return null;
}
}
| org.opentosca.container.core/src/main/java/org/opentosca/container/core/plan/ChoreographyHandler.java | package org.opentosca.container.core.plan;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;
import javax.script.ScriptException;
import javax.ws.rs.HttpMethod;
import javax.xml.namespace.QName;
import org.eclipse.winery.model.tosca.TExtensibleElements;
import org.eclipse.winery.model.tosca.TNodeTemplate;
import org.eclipse.winery.model.tosca.TServiceTemplate;
import org.eclipse.winery.model.tosca.TTag;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.apache.http.HttpHeaders;
import org.opentosca.container.core.model.choreography.SituationExpression;
import org.opentosca.container.core.model.choreography.SituationRule;
import org.opentosca.container.core.model.csar.Csar;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
@Service
public class ChoreographyHandler {
private final static Logger LOG = LoggerFactory.getLogger(ChoreographyHandler.class);
private final static QName PARTICIPANT_ATTRIBUTE = QName.valueOf("{http://www.opentosca.org/winery/extensions/tosca/2013/02/12}participant");
private static final String PARTICIPANT = "participant";
private static final String APP_CHOR_ID = "app_chor_id";
private static final String PARTNERSELECTION_RULES = "partnerselection_rules";
private static final String CHOREOGRAPHY = "choreography";
/**
* Check if the given ServiceTemplate is part of a choreographed application deployment
*/
public boolean isChoreography(final TServiceTemplate serviceTemplate) {
return Objects.nonNull(getTagWithName(serviceTemplate, CHOREOGRAPHY));
}
/**
* Get the participant tag of the given ServiceTemplate
*/
public String getInitiator(final TServiceTemplate serviceTemplate) {
return getTagWithName(serviceTemplate, PARTICIPANT);
}
/**
* Get the app_chor_id tag of the given ServiceTemplate
*/
public String getAppChorId(final TServiceTemplate serviceTemplate) {
return getTagWithName(serviceTemplate, APP_CHOR_ID);
}
public Collection<SituationExpression> getSituationExpressions(final TServiceTemplate serviceTemplate) {
List<SituationExpression> situationRules = new ArrayList<>();
Map<String, String> tags = this.getTags(serviceTemplate);
// get tag containing the situation rules
String situationRuleTag = tags.get(PARTNERSELECTION_RULES);
if (Objects.nonNull(situationRuleTag)) {
String[] situationRuleCandidates = situationRuleTag.split(";");
LOG.debug("Found {} situation rule candidate(s)!", situationRuleCandidates.length);
// check validity of rules and parse to rules object
for (String situationRuleCandidate : situationRuleCandidates) {
// each rule requires a situation and two alternative partners
String[] situationRuleParts = situationRuleCandidate.split(",");
if (situationRuleParts.length != 2) {
continue;
}
String expression = situationRuleParts[0];
String partner = situationRuleParts[1];
if (Objects.nonNull(partner)) {
situationRules.add(new SituationExpression(expression.trim(), partner.trim(), tags));
} else {
LOG.warn("Unable to retrieve required URLs for rule with name '{}', situation compliant partner '{}', and alternative partner '{}'!",
situationRuleParts[0], situationRuleParts[1]);
}
}
} else {
LOG.warn("Unable to find situation rule tag!");
}
return situationRules;
}
/**
* Get the situation rules to decide which partner to include in a choreography
*/
public List<SituationRule> getSituationRules(final TServiceTemplate serviceTemplate) {
List<SituationRule> situationRules = new ArrayList<>();
// get tag containing the situation rules
String situationRuleTag = getTagWithName(serviceTemplate, PARTNERSELECTION_RULES);
if (Objects.nonNull(situationRuleTag)) {
String[] situationRuleCandidates = situationRuleTag.split(";");
LOG.debug("Found {} situation rule candidate(s)!", situationRuleCandidates.length);
// check validity of rules and parse to rules object
for (String situationRuleCandidate : situationRuleCandidates) {
// each rule requires a situation and two alternative partners
String[] situationRuleParts = situationRuleCandidate.split(",");
if (situationRuleParts.length != 3) {
continue;
}
String situationUrl = getTagWithName(serviceTemplate, situationRuleParts[0]);
String situationCompliantPartnerUrl = getTagWithName(serviceTemplate, situationRuleParts[1]);
String alternativePartnerUrl = getTagWithName(serviceTemplate, situationRuleParts[2]);
if (Objects.nonNull(situationUrl) && Objects.nonNull(situationCompliantPartnerUrl) && Objects.nonNull(alternativePartnerUrl)) {
try {
situationRules.add(new SituationRule(new URL(situationUrl), situationRuleParts[1], new URL(situationCompliantPartnerUrl), situationRuleParts[2], new URL(alternativePartnerUrl)));
} catch (MalformedURLException e) {
LOG.error("Unable to generate situation rule because of malformed URL: {}", e.getMessage());
}
} else {
LOG.warn("Unable to retrieve required URLs for rule with name '{}', situation compliant partner '{}', and alternative partner '{}'!",
situationRuleParts[0], situationRuleParts[1], situationRuleParts[2]);
}
}
} else {
LOG.warn("Unable to find situation rule tag!");
}
return situationRules;
}
/**
* Get the list of involved partners based on available selection rules
*
* @param situationRules a list of situation expressions to filter the required partners
* @param possiblePartners a list of possible partners from the ServiceTemplate tags
* @return a list of filtered partners
*/
public List<String> getPartnersBasedOnSelectionExpression(Collection<SituationExpression> situationRules, List<String> possiblePartners) {
List<String> partners = new ArrayList<>();
// check all situation rules and add the corresponding partners
for (SituationExpression situationRule : situationRules) {
possiblePartners.remove(situationRule.partner);
try {
if (situationRule.evaluateExpression()) {
partners.add(situationRule.partner);
}
} catch (ScriptException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
LOG.debug("Number of situation independent partners: {}", possiblePartners.size());
LOG.debug("Number of situation dependent partners: {}", partners.size());
// assumption if at the end no dependent partners are selected => no deployment possible
if (partners.isEmpty()) {
return new ArrayList<String>();
}
partners.addAll(possiblePartners);
return partners;
}
/**
* Get the list of involved partners based on available selection rules
*
* @param situationRules a list of situation rules to filter the required partners
* @param possiblePartners a list of possible partners from the ServiceTemplate tags
* @return a list of filtered partners
*/
public List<String> getPartnersBasedOnSelectionRule(List<SituationRule> situationRules, List<String> possiblePartners) {
List<String> partners = new ArrayList<>();
Map<String, String> partnerAlternatives = new HashMap<String, String>();
// check all situation rules and add the corresponding partners
for (SituationRule situationRule : situationRules) {
possiblePartners.remove(situationRule.getSituationCompliantPartnerName());
possiblePartners.remove(situationRule.getAlternativePartnerName());
partnerAlternatives.put(situationRule.getSituationCompliantPartnerName(), situationRule.getAlternativePartnerName());
if (isSituationRuleActive(situationRule.getSituationRuleUrl())) {
LOG.debug("Adding compliant partner '{}' for situation with URL: {}", situationRule.getSituationCompliantPartnerName(), situationRule.getSituationRuleUrl());
partners.add(situationRule.getSituationCompliantPartnerName());
} else {
LOG.debug("Adding alternative partner '{}' for situation with URL: {}", situationRule.getAlternativePartnerName(), situationRule.getSituationRuleUrl());
partners.add(situationRule.getAlternativePartnerName());
}
}
LOG.debug("Number of situation independent partners: {}", possiblePartners.size());
LOG.debug("Number of situation dependent partners: {}", partners.size());
// check if some partners are both valid but therefore introduce ambiguity => remove ambiguity
// what we'll do is the following:
// - iterate overall partner alternatives that were collected from the situationRule,
// - make sure from an alternative there is exactly (!) one partner in the set of dependent partners
// - if there is more than one partner in the set -> remove one randomly(sure if randomly?)
// - if there is none of the partners availabel -> return an empty list as we didn't find a valid configuration of partners
for (String partner1 : partnerAlternatives.keySet()) {
String partner2 = partnerAlternatives.get(partner1);
boolean partner1Available = false;
boolean partner2Available = false;
if (partners.contains(partner1)) partner1Available = true;
if (partners.contains(partner2)) partner2Available = true;
if (partner1Available && partner2Available) {
// both partners of a rule are valid = ambiguity => remove one partner
partners.remove(partner2);
} else if (!partner1Available && !partner2Available) {
// both partners of a rule are not valid => deployment not valid
return new ArrayList<String>();
}
}
partners.addAll(possiblePartners);
return partners;
}
/**
* Check if the situation on the given URL is active
*
* @param situationUrl the URL to the situation rule to evaluate
* @return <code>true</code> if the referenced situation rule is active, <code>false</code> otherwise
*/
private boolean isSituationRuleActive(URL situationUrl) {
try {
// retrieve situation
HttpURLConnection connection = (HttpURLConnection) situationUrl.openConnection();
connection.setDoOutput(true);
connection.setInstanceFollowRedirects(false);
connection.setRequestMethod(HttpMethod.GET);
connection.setRequestProperty(HttpHeaders.ACCEPT, "application/json");
connection.connect();
String json = IOUtils.toString(connection.getInputStream(), StandardCharsets.UTF_8);
// read active part and parse to boolean to check if situation is active
Map<String, Object> map = new ObjectMapper().readValue(json, Map.class);
if (!map.containsKey("active")) {
LOG.warn("Situation at URL '{}' is invalid!", situationUrl);
return false;
}
return Boolean.parseBoolean(map.get("active").toString());
} catch (IOException e) {
LOG.debug("Unable to parse situation from URL {}: {}", situationUrl, e.getMessage());
return false;
}
}
/**
* Get the endpoints of all choreography partners from the ServiceTemplate.
*
* @param serviceTemplate the ServiceTemplate for the choreography
* @return a list of tags containing the partner name as key and the endpoints as value or
* <code>null</code> if no tags are defined on the ServiceTemplate
*/
public List<TTag> getPartnerEndpoints(final TServiceTemplate serviceTemplate) {
// get the tags containing the endpoints of the partners
if (Objects.isNull(serviceTemplate.getTags())) {
LOG.error("Unable to retrieve tags for ServiceTemplate with ID {}.", serviceTemplate.getId());
return null;
}
List<TTag> tags = Lists.newArrayList(serviceTemplate.getTags().getTag().iterator());
LOG.debug("Number of tags: {}", tags.size());
// get the provider names defined in the NodeTemplates to check which tag names specify a partner endpoint
final List<String> partnerNames =
serviceTemplate.getTopologyTemplate().getNodeTemplateOrRelationshipTemplate().stream()
.filter(entity -> entity instanceof TNodeTemplate).map(TExtensibleElements::getOtherAttributes)
.map(attributes -> attributes.get(PARTICIPANT_ATTRIBUTE))
.flatMap(locationString -> Arrays.stream(locationString.split(",")))
.distinct()
.collect(Collectors.toList());
LOG.debug("Number of partners: {}", partnerNames.size());
// remove tags that do not specify a partner endpoint and get endpoints
//tags.removeIf(tag -> !partnerNames.contains(tag.getName()));
List<TTag> partnerTags = Lists.newArrayList();
tags.forEach(tag -> {
if (tag.getName().startsWith("participant:")) {
String participantName = tag.getName().replace("participant:", "");
if(partnerNames.contains(participantName)){
partnerTags.add(new TTag.Builder().setName(participantName).setValue(tag.getValue()).build());
}
}});
LOG.debug("Number of tags after filtering for partners: {}", tags.size());
return partnerTags;
}
public String getPossiblePartners(final TNodeTemplate nodeTemplate, Collection<String> participants) {
if (nodeTemplate.getOtherAttributes().get(PARTICIPANT_ATTRIBUTE) != null) {
for (String participant : nodeTemplate.getOtherAttributes().get(PARTICIPANT_ATTRIBUTE).split(",")) {
if (participants.contains(participant)) {
return participant;
}
}
}
return null;
}
private Map<String, String> getTags(final TServiceTemplate serviceTemplate) {
Map<String, String> tags = new HashMap<String, String>();
if (Objects.isNull(serviceTemplate.getTags())) {
return tags;
}
for (TTag tag : serviceTemplate.getTags().getTag()) {
tags.put(tag.getName(), tag.getValue());
}
return tags;
}
/**
* Get the tag with the given name
*/
private String getTagWithName(final TServiceTemplate serviceTemplate, String tagName) {
if (Objects.isNull(serviceTemplate.getTags())) {
return null;
}
for (TTag tag : serviceTemplate.getTags().getTag()) {
if (tag.getName().equals(tagName)) {
return tag.getValue();
}
}
return null;
}
public Csar getChoreographyCsar(String appChoreoId, Collection<Csar> csars, String receivingPartner) {
for (Csar csar : csars) {
TServiceTemplate serviceTemplate = csar.entryServiceTemplate();
String tagAppChorId = new ChoreographyHandler().getAppChorId(serviceTemplate);
String participantName = getTagWithName(serviceTemplate, PARTICIPANT);
if (Objects.nonNull(tagAppChorId) && tagAppChorId.equals(appChoreoId) && Objects.nonNull(participantName) && participantName.equals(receivingPartner)) {
return csar;
}
}
return null;
}
}
| improves retrieving of partner endpoints
Signed-off-by: Kálmán Képes <[email protected]>
| org.opentosca.container.core/src/main/java/org/opentosca/container/core/plan/ChoreographyHandler.java | improves retrieving of partner endpoints | <ide><path>rg.opentosca.container.core/src/main/java/org/opentosca/container/core/plan/ChoreographyHandler.java
<ide> * <code>null</code> if no tags are defined on the ServiceTemplate
<ide> */
<ide> public List<TTag> getPartnerEndpoints(final TServiceTemplate serviceTemplate) {
<del>
<ide> // get the tags containing the endpoints of the partners
<ide> if (Objects.isNull(serviceTemplate.getTags())) {
<ide> LOG.error("Unable to retrieve tags for ServiceTemplate with ID {}.", serviceTemplate.getId());
<ide> return null;
<ide> }
<del>
<del> List<TTag> tags = Lists.newArrayList(serviceTemplate.getTags().getTag().iterator());
<add> List<TTag> tags = serviceTemplate.getTags().getTag();
<ide> LOG.debug("Number of tags: {}", tags.size());
<del>
<del> // get the provider names defined in the NodeTemplates to check which tag names specify a partner endpoint
<del> final List<String> partnerNames =
<del> serviceTemplate.getTopologyTemplate().getNodeTemplateOrRelationshipTemplate().stream()
<del> .filter(entity -> entity instanceof TNodeTemplate).map(TExtensibleElements::getOtherAttributes)
<del> .map(attributes -> attributes.get(PARTICIPANT_ATTRIBUTE))
<del> .flatMap(locationString -> Arrays.stream(locationString.split(",")))
<del> .distinct()
<del> .collect(Collectors.toList());
<del> LOG.debug("Number of partners: {}", partnerNames.size());
<del>
<del> // remove tags that do not specify a partner endpoint and get endpoints
<del> //tags.removeIf(tag -> !partnerNames.contains(tag.getName()));
<ide>
<ide> List<TTag> partnerTags = Lists.newArrayList();
<ide>
<ide> tags.forEach(tag -> {
<ide> if (tag.getName().startsWith("participant:")) {
<ide> String participantName = tag.getName().replace("participant:", "");
<del> if(partnerNames.contains(participantName)){
<del> partnerTags.add(new TTag.Builder().setName(participantName).setValue(tag.getValue()).build());
<del> }
<del>
<add> partnerTags.add(new TTag.Builder().setName(participantName).setValue(tag.getValue()).build());
<ide> }});
<ide>
<ide> LOG.debug("Number of tags after filtering for partners: {}", tags.size()); |
|
Java | lgpl-2.1 | 539d71aeec76e46febb78cd67eb1b093e581a41b | 0 | levants/lightmare | package org.lightmare.jpa;
import java.io.IOException;
import java.net.URL;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;
import org.apache.log4j.Logger;
import org.lightmare.cache.ConnectionContainer;
import org.lightmare.cache.ConnectionSemaphore;
import org.lightmare.config.Configuration;
import org.lightmare.jndi.JndiManager;
import org.lightmare.jpa.hibernate.HibernatePersistenceProviderImpl;
import org.lightmare.jpa.jta.HibernateConfig;
import org.lightmare.libraries.LibraryLoader;
import org.lightmare.utils.CollectionUtils;
import org.lightmare.utils.NamingUtils;
import org.lightmare.utils.ObjectUtils;
import org.lightmare.utils.StringUtils;
/**
* Creates and caches {@link EntityManagerFactory} for each EJB bean
* {@link Class}'s appropriate field (annotated by @PersistenceContext)
*
* @author Levan Tsinadze
* @since 0.0.79-SNAPSHOT
*/
public class JpaManager {
// Entity classes
private List<String> classes;
private String path;
private URL url;
// Additional properties
private Map<Object, Object> properties;
private boolean swapDataSource;
private boolean scanArchives;
// Initialize level class loader
private ClassLoader loader;
// Error message for connection binding to JNDI names
private static final String COULD_NOT_BIND_JNDI_ERROR = "could not bind connection";
private static final Logger LOG = Logger.getLogger(JpaManager.class);
private JpaManager() {
}
/**
* Checks if entity persistence.xml {@link URL} is provided
*
* @return boolean
*/
private boolean checkForURL() {
return ObjectUtils.notNull(url) && StringUtils.valid(url.toString());
}
/**
* Checks if entity classes or persistence.xml path are provided
*
* @param classes
* @return boolean
*/
private boolean checkForBuild() {
return CollectionUtils.valid(classes) || StringUtils.valid(path)
|| checkForURL() || swapDataSource || scanArchives;
}
/**
* Added transaction properties for JTA data sources
*/
private void addTransactionManager() {
if (properties == null) {
properties = new HashMap<Object, Object>();
}
HibernateConfig[] hibernateConfigs = HibernateConfig.values();
for (HibernateConfig hibernateConfig : hibernateConfigs) {
properties.put(hibernateConfig.key, hibernateConfig.value);
}
}
/**
* Creates {@link EntityManagerFactory} by hibernate or by extended builder
* {@link Ejb3ConfigurationImpl} if entity classes or persistence.xml file
* path are provided
*
* @see Ejb3ConfigurationImpl#configure(String, Map) and
* Ejb3ConfigurationImpl#createEntityManagerFactory()
*
* @param unitName
* @return {@link EntityManagerFactory}
*/
private EntityManagerFactory buildEntityManagerFactory(String unitName)
throws IOException {
EntityManagerFactory emf;
HibernatePersistenceProviderImpl cfg;
boolean pathCheck = StringUtils.valid(path);
boolean urlCheck = checkForURL();
HibernatePersistenceProviderImpl.Builder builder = new HibernatePersistenceProviderImpl.Builder();
if (loader == null) {
loader = LibraryLoader.getContextClassLoader();
}
if (CollectionUtils.valid(classes)) {
builder.setClasses(classes);
// Loads entity classes to current ClassLoader instance
LibraryLoader.loadClasses(classes, loader);
}
if (pathCheck || urlCheck) {
Enumeration<URL> xmls;
ConfigLoader configLoader = new ConfigLoader();
if (pathCheck) {
xmls = configLoader.readFile(path);
} else {
xmls = configLoader.readURL(url);
}
builder.setXmls(xmls);
String shortPath = configLoader.getShortPath();
builder.setShortPath(shortPath);
}
builder.setSwapDataSource(swapDataSource);
builder.setScanArchives(scanArchives);
builder.setOverridenClassLoader(loader);
cfg = builder.build();
if (ObjectUtils.notTrue(swapDataSource)) {
addTransactionManager();
}
emf = cfg.createEntityManagerFactory(unitName, properties);
return emf;
}
/**
* Checks if entity classes or persistence.xml file path are provided to
* create {@link EntityManagerFactory}
*
* @see #buildEntityManagerFactory(String, String, Map, List)
*
* @param unitName
* @param properties
* @param path
* @param classes
* @return {@link EntityManagerFactory}
* @throws IOException
*/
private EntityManagerFactory createEntityManagerFactory(String unitName)
throws IOException {
EntityManagerFactory emf = buildEntityManagerFactory(unitName);
return emf;
}
/**
* Binds {@link EntityManagerFactory} to {@link javax.naming.InitialContext}
*
* @param jndiName
* @param unitName
* @param emf
* @throws IOException
*/
private void bindJndiName(ConnectionSemaphore semaphore) throws IOException {
boolean bound = semaphore.isBound();
if (ObjectUtils.notTrue(bound)) {
String jndiName = semaphore.getJndiName();
if (StringUtils.valid(jndiName)) {
JndiManager jndiManager = new JndiManager();
try {
String fullJndiName = NamingUtils
.createJpaJndiName(jndiName);
if (jndiManager.lookup(fullJndiName) == null) {
jndiManager.rebind(fullJndiName, semaphore.getEmf());
}
} catch (IOException ex) {
LOG.error(ex.getMessage(), ex);
String errorMessage = StringUtils.concat(
COULD_NOT_BIND_JNDI_ERROR, semaphore.getUnitName());
throw new IOException(errorMessage, ex);
}
}
}
semaphore.setBound(Boolean.TRUE);
}
/**
* Builds connection, wraps it in {@link ConnectionSemaphore} locks and
* caches appropriate instance
*
* @param unitName
* @throws IOException
*/
public void create(String unitName) throws IOException {
ConnectionSemaphore semaphore = ConnectionContainer
.getSemaphore(unitName);
if (semaphore.isInProgress()) {
EntityManagerFactory emf = createEntityManagerFactory(unitName);
semaphore.setEmf(emf);
semaphore.setInProgress(Boolean.FALSE);
bindJndiName(semaphore);
} else if (semaphore.getEmf() == null) {
String errorMessage = String.format(
"Connection %s was not in progress", unitName);
throw new IOException(errorMessage);
} else {
bindJndiName(semaphore);
}
}
/**
* Closes passed {@link EntityManagerFactory}
*
* @param emf
*/
public static void closeEntityManagerFactory(EntityManagerFactory emf) {
if (ObjectUtils.notNull(emf) && emf.isOpen()) {
emf.close();
}
}
/**
* Closes passed {@link EntityManager} instance if it is not null and it is
* open
*
* @param em
*/
public static void closeEntityManager(EntityManager em) {
if (ObjectUtils.notNull(em) && em.isOpen()) {
em.close();
}
}
/**
* Builder class to create {@link JpaManager} class object
*
* @author Levan Tsinadze
* @since 0.0.79-SNAPSHOT
*/
public static class Builder {
private JpaManager manager;
public Builder() {
manager = new JpaManager();
manager.scanArchives = Boolean.TRUE;
}
/**
* Sets {@link javax.persistence.Entity} class names to initialize
*
* @param classes
* @return {@link Builder}
*/
public Builder setClasses(List<String> classes) {
manager.classes = classes;
return this;
}
/**
* Sets {@link URL} for persistence.xml file
*
* @param url
* @return {@link Builder}
*/
public Builder setURL(URL url) {
manager.url = url;
return this;
}
/**
* Sets path for persistence.xml file
*
* @param path
* @return {@link Builder}
*/
public Builder setPath(String path) {
manager.path = path;
return this;
}
/**
* Sets additional persistence properties
*
* @param properties
* @return {@link Builder}
*/
public Builder setProperties(Map<Object, Object> properties) {
manager.properties = properties;
return this;
}
/**
* Sets boolean check property to swap jta data source value with non
* jta data source value
*
* @param swapDataSource
* @return {@link Builder}
*/
public Builder setSwapDataSource(boolean swapDataSource) {
manager.swapDataSource = swapDataSource;
return this;
}
/**
* Sets boolean check to scan deployed archive files for
* {@link javax.persistence.Entity} annotated classes
*
* @param scanArchives
* @return {@link Builder}
*/
public Builder setScanArchives(boolean scanArchives) {
manager.scanArchives = scanArchives;
return this;
}
/**
* Sets {@link ClassLoader} for persistence classes
*
* @param loader
* @return {@link Builder}
*/
public Builder setClassLoader(ClassLoader loader) {
manager.loader = loader;
return this;
}
/**
* Sets all parameters from passed {@link Configuration} instance
*
* @param configuration
* @return {@link Builder}
*/
public Builder configure(Configuration configuration) {
// Sets all parameters from Configuration class
setPath(configuration.getPersXmlPath())
.setProperties(configuration.getPersistenceProperties())
.setSwapDataSource(configuration.isSwapDataSource())
.setScanArchives(configuration.isScanArchives());
return this;
}
public JpaManager build() {
return manager;
}
}
}
| src/main/java/org/lightmare/jpa/JpaManager.java | package org.lightmare.jpa;
import java.io.IOException;
import java.net.URL;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;
import org.apache.log4j.Logger;
import org.lightmare.cache.ConnectionContainer;
import org.lightmare.cache.ConnectionSemaphore;
import org.lightmare.config.Configuration;
import org.lightmare.jndi.JndiManager;
import org.lightmare.jpa.hibernate.HibernatePersistenceProviderImpl;
import org.lightmare.jpa.jta.HibernateConfig;
import org.lightmare.libraries.LibraryLoader;
import org.lightmare.utils.CollectionUtils;
import org.lightmare.utils.NamingUtils;
import org.lightmare.utils.ObjectUtils;
import org.lightmare.utils.StringUtils;
/**
* Creates and caches {@link EntityManagerFactory} for each EJB bean
* {@link Class}'s appropriate field (annotated by @PersistenceContext)
*
* @author Levan Tsinadze
* @since 0.0.79-SNAPSHOT
*/
public class JpaManager {
// Entity classes
private List<String> classes;
private String path;
private URL url;
// Additional properties
private Map<Object, Object> properties;
private boolean swapDataSource;
private boolean scanArchives;
// Initialize level class loader
private ClassLoader loader;
// Error message for connection binding to JNDI names
private static final String COULD_NOT_BIND_JNDI_ERROR = "could not bind connection";
private static final Logger LOG = Logger.getLogger(JpaManager.class);
private JpaManager() {
}
/**
* Checks if entity persistence.xml {@link URL} is provided
*
* @return boolean
*/
private boolean checkForURL() {
return ObjectUtils.notNull(url) && StringUtils.valid(url.toString());
}
/**
* Checks if entity classes or persistence.xml path are provided
*
* @param classes
* @return boolean
*/
private boolean checkForBuild() {
return CollectionUtils.valid(classes) || StringUtils.valid(path)
|| checkForURL() || swapDataSource || scanArchives;
}
/**
* Added transaction properties for JTA data sources
*/
private void addTransactionManager() {
if (properties == null) {
properties = new HashMap<Object, Object>();
}
HibernateConfig[] hibernateConfigs = HibernateConfig.values();
for (HibernateConfig hibernateConfig : hibernateConfigs) {
properties.put(hibernateConfig.key, hibernateConfig.value);
}
}
/**
* Creates {@link EntityManagerFactory} by hibernate or by extended builder
* {@link Ejb3ConfigurationImpl} if entity classes or persistence.xml file
* path are provided
*
* @see Ejb3ConfigurationImpl#configure(String, Map) and
* Ejb3ConfigurationImpl#createEntityManagerFactory()
*
* @param unitName
* @return {@link EntityManagerFactory}
*/
private EntityManagerFactory buildEntityManagerFactory(String unitName)
throws IOException {
EntityManagerFactory emf;
HibernatePersistenceProviderImpl cfg;
boolean pathCheck = StringUtils.valid(path);
boolean urlCheck = checkForURL();
HibernatePersistenceProviderImpl.Builder builder = new HibernatePersistenceProviderImpl.Builder();
if (loader == null) {
loader = LibraryLoader.getContextClassLoader();
}
if (CollectionUtils.valid(classes)) {
builder.setClasses(classes);
// Loads entity classes to current ClassLoader instance
LibraryLoader.loadClasses(classes, loader);
}
if (pathCheck || urlCheck) {
Enumeration<URL> xmls;
ConfigLoader configLoader = new ConfigLoader();
if (pathCheck) {
xmls = configLoader.readFile(path);
} else {
xmls = configLoader.readURL(url);
}
builder.setXmls(xmls);
String shortPath = configLoader.getShortPath();
builder.setShortPath(shortPath);
}
builder.setSwapDataSource(swapDataSource);
builder.setScanArchives(scanArchives);
builder.setOverridenClassLoader(loader);
cfg = builder.build();
if (ObjectUtils.notTrue(swapDataSource)) {
addTransactionManager();
}
emf = cfg.createEntityManagerFactory(unitName, properties);
return emf;
}
/**
* Checks if entity classes or persistence.xml file path are provided to
* create {@link EntityManagerFactory}
*
* @see #buildEntityManagerFactory(String, String, Map, List)
*
* @param unitName
* @param properties
* @param path
* @param classes
* @return {@link EntityManagerFactory}
* @throws IOException
*/
private EntityManagerFactory createEntityManagerFactory(String unitName)
throws IOException {
EntityManagerFactory emf;
if (checkForBuild()) {
emf = buildEntityManagerFactory(unitName);
} else if (properties == null) {
emf = Persistence.createEntityManagerFactory(unitName);
} else {
emf = Persistence.createEntityManagerFactory(unitName, properties);
}
return emf;
}
/**
* Binds {@link EntityManagerFactory} to {@link javax.naming.InitialContext}
*
* @param jndiName
* @param unitName
* @param emf
* @throws IOException
*/
private void bindJndiName(ConnectionSemaphore semaphore) throws IOException {
boolean bound = semaphore.isBound();
if (ObjectUtils.notTrue(bound)) {
String jndiName = semaphore.getJndiName();
if (StringUtils.valid(jndiName)) {
JndiManager jndiManager = new JndiManager();
try {
String fullJndiName = NamingUtils
.createJpaJndiName(jndiName);
if (jndiManager.lookup(fullJndiName) == null) {
jndiManager.rebind(fullJndiName, semaphore.getEmf());
}
} catch (IOException ex) {
LOG.error(ex.getMessage(), ex);
String errorMessage = StringUtils.concat(
COULD_NOT_BIND_JNDI_ERROR, semaphore.getUnitName());
throw new IOException(errorMessage, ex);
}
}
}
semaphore.setBound(Boolean.TRUE);
}
/**
* Builds connection, wraps it in {@link ConnectionSemaphore} locks and
* caches appropriate instance
*
* @param unitName
* @throws IOException
*/
public void create(String unitName) throws IOException {
ConnectionSemaphore semaphore = ConnectionContainer
.getSemaphore(unitName);
if (semaphore.isInProgress()) {
EntityManagerFactory emf = createEntityManagerFactory(unitName);
semaphore.setEmf(emf);
semaphore.setInProgress(Boolean.FALSE);
bindJndiName(semaphore);
} else if (semaphore.getEmf() == null) {
String errorMessage = String.format(
"Connection %s was not in progress", unitName);
throw new IOException(errorMessage);
} else {
bindJndiName(semaphore);
}
}
/**
* Closes passed {@link EntityManagerFactory}
*
* @param emf
*/
public static void closeEntityManagerFactory(EntityManagerFactory emf) {
if (ObjectUtils.notNull(emf) && emf.isOpen()) {
emf.close();
}
}
/**
* Closes passed {@link EntityManager} instance if it is not null and it is
* open
*
* @param em
*/
public static void closeEntityManager(EntityManager em) {
if (ObjectUtils.notNull(em) && em.isOpen()) {
em.close();
}
}
/**
* Builder class to create {@link JpaManager} class object
*
* @author Levan Tsinadze
* @since 0.0.79-SNAPSHOT
*/
public static class Builder {
private JpaManager manager;
public Builder() {
manager = new JpaManager();
manager.scanArchives = Boolean.TRUE;
}
/**
* Sets {@link javax.persistence.Entity} class names to initialize
*
* @param classes
* @return {@link Builder}
*/
public Builder setClasses(List<String> classes) {
manager.classes = classes;
return this;
}
/**
* Sets {@link URL} for persistence.xml file
*
* @param url
* @return {@link Builder}
*/
public Builder setURL(URL url) {
manager.url = url;
return this;
}
/**
* Sets path for persistence.xml file
*
* @param path
* @return {@link Builder}
*/
public Builder setPath(String path) {
manager.path = path;
return this;
}
/**
* Sets additional persistence properties
*
* @param properties
* @return {@link Builder}
*/
public Builder setProperties(Map<Object, Object> properties) {
manager.properties = properties;
return this;
}
/**
* Sets boolean check property to swap jta data source value with non
* jta data source value
*
* @param swapDataSource
* @return {@link Builder}
*/
public Builder setSwapDataSource(boolean swapDataSource) {
manager.swapDataSource = swapDataSource;
return this;
}
/**
* Sets boolean check to scan deployed archive files for
* {@link javax.persistence.Entity} annotated classes
*
* @param scanArchives
* @return {@link Builder}
*/
public Builder setScanArchives(boolean scanArchives) {
manager.scanArchives = scanArchives;
return this;
}
/**
* Sets {@link ClassLoader} for persistence classes
*
* @param loader
* @return {@link Builder}
*/
public Builder setClassLoader(ClassLoader loader) {
manager.loader = loader;
return this;
}
/**
* Sets all parameters from passed {@link Configuration} instance
*
* @param configuration
* @return {@link Builder}
*/
public Builder configure(Configuration configuration) {
// Sets all parameters from Configuration class
setPath(configuration.getPersXmlPath())
.setProperties(configuration.getPersistenceProperties())
.setSwapDataSource(configuration.isSwapDataSource())
.setScanArchives(configuration.isScanArchives());
return this;
}
public JpaManager build() {
return manager;
}
}
}
| imporved "hibernate" utilities | src/main/java/org/lightmare/jpa/JpaManager.java | imporved "hibernate" utilities | <ide><path>rc/main/java/org/lightmare/jpa/JpaManager.java
<ide> private EntityManagerFactory createEntityManagerFactory(String unitName)
<ide> throws IOException {
<ide>
<del> EntityManagerFactory emf;
<del>
<del> if (checkForBuild()) {
<del> emf = buildEntityManagerFactory(unitName);
<del> } else if (properties == null) {
<del> emf = Persistence.createEntityManagerFactory(unitName);
<del> } else {
<del> emf = Persistence.createEntityManagerFactory(unitName, properties);
<del> }
<add> EntityManagerFactory emf = buildEntityManagerFactory(unitName);
<ide>
<ide> return emf;
<ide> } |
|
JavaScript | agpl-3.0 | d9a3be34f2ec6bc17c554068966766a1124126df | 0 | gisce/openerp-web,vnc-biz/openerp-web,MarkusTeufelberger/openerp-web,vnc-biz/openerp-web,vnc-biz/openerp-web,MarkusTeufelberger/openerp-web,MarkusTeufelberger/openerp-web,gisce/openerp-web,splbio/openerp-web,splbio/openerp-web,vnc-biz/openerp-web,gisce/openerp-web,splbio/openerp-web | // Underscore.string
// (c) 2010 Esa-Matti Suuronen <esa-matti aet suuronen dot org>
// Underscore.strings is freely distributable under the terms of the MIT license.
// Documentation: https://github.com/epeli/underscore.string
// Some code is borrowed from MooTools and Alexandru Marasteanu.
// Version 1.2.0
(function(root){
'use strict';
// Defining helper functions.
var nativeTrim = String.prototype.trim;
var parseNumber = function(source) { return source * 1 || 0; };
var strRepeat = function(i, m) {
for (var o = []; m > 0; o[--m] = i) {}
return o.join('');
};
var slice = function(a){
return Array.prototype.slice.call(a);
};
var defaultToWhiteSpace = function(characters){
if (characters) {
return _s.escapeRegExp(characters);
}
return '\\s';
};
var sArgs = function(method){
return function(){
var args = slice(arguments);
for(var i=0; i<args.length; i++)
args[i] = args[i] == null ? '' : '' + args[i];
return method.apply(null, args);
};
};
// sprintf() for JavaScript 0.7-beta1
// http://www.diveintojavascript.com/projects/javascript-sprintf
//
// Copyright (c) Alexandru Marasteanu <alexaholic [at) gmail (dot] com>
// All rights reserved.
var sprintf = (function() {
function get_type(variable) {
return Object.prototype.toString.call(variable).slice(8, -1).toLowerCase();
}
var str_repeat = strRepeat;
var str_format = function() {
if (!str_format.cache.hasOwnProperty(arguments[0])) {
str_format.cache[arguments[0]] = str_format.parse(arguments[0]);
}
return str_format.format.call(null, str_format.cache[arguments[0]], arguments);
};
str_format.format = function(parse_tree, argv) {
var cursor = 1, tree_length = parse_tree.length, node_type = '', arg, output = [], i, k, match, pad, pad_character, pad_length;
for (i = 0; i < tree_length; i++) {
node_type = get_type(parse_tree[i]);
if (node_type === 'string') {
output.push(parse_tree[i]);
}
else if (node_type === 'array') {
match = parse_tree[i]; // convenience purposes only
if (match[2]) { // keyword argument
arg = argv[cursor];
for (k = 0; k < match[2].length; k++) {
if (!arg.hasOwnProperty(match[2][k])) {
throw new Error(sprintf('[_.sprintf] property "%s" does not exist', match[2][k]));
}
arg = arg[match[2][k]];
}
} else if (match[1]) { // positional argument (explicit)
arg = argv[match[1]];
}
else { // positional argument (implicit)
arg = argv[cursor++];
}
if (/[^s]/.test(match[8]) && (get_type(arg) != 'number')) {
throw new Error(sprintf('[_.sprintf] expecting number but found %s', get_type(arg)));
}
switch (match[8]) {
case 'b': arg = arg.toString(2); break;
case 'c': arg = String.fromCharCode(arg); break;
case 'd': arg = parseInt(arg, 10); break;
case 'e': arg = match[7] ? arg.toExponential(match[7]) : arg.toExponential(); break;
case 'f': arg = match[7] ? parseFloat(arg).toFixed(match[7]) : parseFloat(arg); break;
case 'o': arg = arg.toString(8); break;
case 's': arg = ((arg = String(arg)) && match[7] ? arg.substring(0, match[7]) : arg); break;
case 'u': arg = Math.abs(arg); break;
case 'x': arg = arg.toString(16); break;
case 'X': arg = arg.toString(16).toUpperCase(); break;
}
arg = (/[def]/.test(match[8]) && match[3] && arg >= 0 ? '+'+ arg : arg);
pad_character = match[4] ? match[4] == '0' ? '0' : match[4].charAt(1) : ' ';
pad_length = match[6] - String(arg).length;
pad = match[6] ? str_repeat(pad_character, pad_length) : '';
output.push(match[5] ? arg + pad : pad + arg);
}
}
return output.join('');
};
str_format.cache = {};
str_format.parse = function(fmt) {
var _fmt = fmt, match = [], parse_tree = [], arg_names = 0;
while (_fmt) {
if ((match = /^[^\x25]+/.exec(_fmt)) !== null) {
parse_tree.push(match[0]);
}
else if ((match = /^\x25{2}/.exec(_fmt)) !== null) {
parse_tree.push('%');
}
else if ((match = /^\x25(?:([1-9]\d*)\$|\(([^\)]+)\))?(\+)?(0|'[^$])?(-)?(\d+)?(?:\.(\d+))?([b-fosuxX])/.exec(_fmt)) !== null) {
if (match[2]) {
arg_names |= 1;
var field_list = [], replacement_field = match[2], field_match = [];
if ((field_match = /^([a-z_][a-z_\d]*)/i.exec(replacement_field)) !== null) {
field_list.push(field_match[1]);
while ((replacement_field = replacement_field.substring(field_match[0].length)) !== '') {
if ((field_match = /^\.([a-z_][a-z_\d]*)/i.exec(replacement_field)) !== null) {
field_list.push(field_match[1]);
}
else if ((field_match = /^\[(\d+)\]/.exec(replacement_field)) !== null) {
field_list.push(field_match[1]);
}
else {
throw new Error('[_.sprintf] huh?');
}
}
}
else {
throw new Error('[_.sprintf] huh?');
}
match[2] = field_list;
}
else {
arg_names |= 2;
}
if (arg_names === 3) {
throw new Error('[_.sprintf] mixing positional and named placeholders is not (yet) supported');
}
parse_tree.push(match);
}
else {
throw new Error('[_.sprintf] huh?');
}
_fmt = _fmt.substring(match[0].length);
}
return parse_tree;
};
return str_format;
})();
// Defining underscore.string
var _s = {
VERSION: '1.2.0',
isBlank: sArgs(function(str){
return (/^\s*$/).test(str);
}),
stripTags: sArgs(function(str){
return str.replace(/<\/?[^>]+>/ig, '');
}),
capitalize : sArgs(function(str) {
return str.charAt(0).toUpperCase() + str.substring(1).toLowerCase();
}),
chop: sArgs(function(str, step){
step = parseNumber(step) || str.length;
var arr = [];
for (var i = 0; i < str.length;) {
arr.push(str.slice(i,i + step));
i = i + step;
}
return arr;
}),
clean: sArgs(function(str){
return _s.strip(str.replace(/\s+/g, ' '));
}),
count: sArgs(function(str, substr){
var count = 0, index;
for (var i=0; i < str.length;) {
index = str.indexOf(substr, i);
index >= 0 && count++;
i = i + (index >= 0 ? index : 0) + substr.length;
}
return count;
}),
chars: sArgs(function(str) {
return str.split('');
}),
escapeHTML: sArgs(function(str) {
return str.replace(/&/g,'&').replace(/</g,'<').replace(/>/g,'>')
.replace(/"/g, '"').replace(/'/g, "'");
}),
unescapeHTML: sArgs(function(str) {
return str.replace(/</g, '<').replace(/>/g, '>')
.replace(/"/g, '"').replace(/'/g, "'").replace(/&/g, '&');
}),
escapeRegExp: sArgs(function(str){
// From MooTools core 1.2.4
return str.replace(/([-.*+?^${}()|[\]\/\\])/g, '\\$1');
}),
insert: sArgs(function(str, i, substr){
var arr = str.split('');
arr.splice(parseNumber(i), 0, substr);
return arr.join('');
}),
include: sArgs(function(str, needle){
return str.indexOf(needle) !== -1;
}),
join: sArgs(function(sep) {
var args = slice(arguments);
return args.join(args.shift());
}),
lines: sArgs(function(str) {
return str.split("\n");
}),
reverse: sArgs(function(str){
return Array.prototype.reverse.apply(String(str).split('')).join('');
}),
splice: sArgs(function(str, i, howmany, substr){
var arr = str.split('');
arr.splice(parseNumber(i), parseNumber(howmany), substr);
return arr.join('');
}),
startsWith: sArgs(function(str, starts){
return str.length >= starts.length && str.substring(0, starts.length) === starts;
}),
endsWith: sArgs(function(str, ends){
return str.length >= ends.length && str.substring(str.length - ends.length) === ends;
}),
succ: sArgs(function(str){
var arr = str.split('');
arr.splice(str.length-1, 1, String.fromCharCode(str.charCodeAt(str.length-1) + 1));
return arr.join('');
}),
titleize: sArgs(function(str){
var arr = str.split(' '),
word;
for (var i=0; i < arr.length; i++) {
word = arr[i].split('');
if(typeof word[0] !== 'undefined') word[0] = word[0].toUpperCase();
i+1 === arr.length ? arr[i] = word.join('') : arr[i] = word.join('') + ' ';
}
return arr.join('');
}),
camelize: sArgs(function(str){
return _s.trim(str).replace(/(\-|_|\s)+(.)?/g, function(match, separator, chr) {
return chr ? chr.toUpperCase() : '';
});
}),
underscored: function(str){
return _s.trim(str).replace(/([a-z\d])([A-Z]+)/g, '$1_$2').replace(/\-|\s+/g, '_').toLowerCase();
},
dasherize: function(str){
return _s.trim(str).replace(/([a-z\d])([A-Z]+)/g, '$1-$2').replace(/^([A-Z]+)/, '-$1').replace(/\_|\s+/g, '-').toLowerCase();
},
humanize: function(str){
return _s.capitalize(this.underscored(str).replace(/_id$/,'').replace(/_/g, ' '));
},
trim: sArgs(function(str, characters){
if (!characters && nativeTrim) {
return nativeTrim.call(str);
}
characters = defaultToWhiteSpace(characters);
return str.replace(new RegExp('\^[' + characters + ']+|[' + characters + ']+$', 'g'), '');
}),
ltrim: sArgs(function(str, characters){
characters = defaultToWhiteSpace(characters);
return str.replace(new RegExp('\^[' + characters + ']+', 'g'), '');
}),
rtrim: sArgs(function(str, characters){
characters = defaultToWhiteSpace(characters);
return str.replace(new RegExp('[' + characters + ']+$', 'g'), '');
}),
truncate: sArgs(function(str, length, truncateStr){
truncateStr = truncateStr || '...';
length = parseNumber(length);
return str.length > length ? str.slice(0,length) + truncateStr : str;
}),
/**
* _s.prune: a more elegant version of truncate
* prune extra chars, never leaving a half-chopped word.
* @author github.com/sergiokas
*/
prune: sArgs(function(str, length, pruneStr){
pruneStr = pruneStr || '...';
length = parseNumber(length);
var pruned = '';
// Check if we're in the middle of a word
if( str.substring(length-1, length+1).search(/^\w\w$/) === 0 )
pruned = _s.rtrim(str.slice(0,length).replace(/([\W][\w]*)$/,''));
else
pruned = _s.rtrim(str.slice(0,length));
pruned = pruned.replace(/\W+$/,'');
return (pruned.length+pruneStr.length>str.length) ? str : pruned + pruneStr;
}),
words: function(str, delimiter) {
return String(str).split(delimiter || " ");
},
pad: sArgs(function(str, length, padStr, type) {
var padding = '',
padlen = 0;
length = parseNumber(length);
if (!padStr) { padStr = ' '; }
else if (padStr.length > 1) { padStr = padStr.charAt(0); }
switch(type) {
case 'right':
padlen = (length - str.length);
padding = strRepeat(padStr, padlen);
str = str+padding;
break;
case 'both':
padlen = (length - str.length);
padding = {
'left' : strRepeat(padStr, Math.ceil(padlen/2)),
'right': strRepeat(padStr, Math.floor(padlen/2))
};
str = padding.left+str+padding.right;
break;
default: // 'left'
padlen = (length - str.length);
padding = strRepeat(padStr, padlen);;
str = padding+str;
}
return str;
}),
lpad: function(str, length, padStr) {
return _s.pad(str, length, padStr);
},
rpad: function(str, length, padStr) {
return _s.pad(str, length, padStr, 'right');
},
lrpad: function(str, length, padStr) {
return _s.pad(str, length, padStr, 'both');
},
sprintf: sprintf,
vsprintf: function(fmt, argv){
argv.unshift(fmt);
return sprintf.apply(null, argv);
},
toNumber: function(str, decimals) {
var num = parseNumber(parseNumber(str).toFixed(parseNumber(decimals)));
return (!(num === 0 && (str !== "0" && str !== 0))) ? num : Number.NaN;
},
strRight: sArgs(function(sourceStr, sep){
var pos = (!sep) ? -1 : sourceStr.indexOf(sep);
return (pos != -1) ? sourceStr.slice(pos+sep.length, sourceStr.length) : sourceStr;
}),
strRightBack: sArgs(function(sourceStr, sep){
var pos = (!sep) ? -1 : sourceStr.lastIndexOf(sep);
return (pos != -1) ? sourceStr.slice(pos+sep.length, sourceStr.length) : sourceStr;
}),
strLeft: sArgs(function(sourceStr, sep){
var pos = (!sep) ? -1 : sourceStr.indexOf(sep);
return (pos != -1) ? sourceStr.slice(0, pos) : sourceStr;
}),
strLeftBack: sArgs(function(sourceStr, sep){
var pos = sourceStr.lastIndexOf(sep);
return (pos != -1) ? sourceStr.slice(0, pos) : sourceStr;
}),
exports: function() {
var result = {};
for (var prop in this) {
if (!this.hasOwnProperty(prop) || prop == 'include' || prop == 'contains' || prop == 'reverse') continue;
result[prop] = this[prop];
}
return result;
}
};
// Aliases
_s.strip = _s.trim;
_s.lstrip = _s.ltrim;
_s.rstrip = _s.rtrim;
_s.center = _s.lrpad;
_s.ljust = _s.lpad;
_s.rjust = _s.rpad;
_s.contains = _s.include;
// CommonJS module is defined
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
// Export module
module.exports = _s;
}
exports._s = _s;
// Integrate with Underscore.js
} else if (typeof root._ !== 'undefined') {
// root._.mixin(_s);
root._.string = _s;
root._.str = root._.string;
// Or define it
} else {
root._ = {
string: _s,
str: _s
};
}
}(this || window));
| addons/web/static/lib/underscore/underscore.string.js | // Underscore.string
// (c) 2010 Esa-Matti Suuronen <esa-matti aet suuronen dot org>
// Underscore.strings is freely distributable under the terms of the MIT license.
// Documentation: https://github.com/epeli/underscore.string
// Some code is borrowed from MooTools and Alexandru Marasteanu.
// Version 1.2.0
(function(root){
'use strict';
// Defining helper functions.
var nativeTrim = String.prototype.trim;
var parseNumber = function(source) { return source * 1 || 0; };
var strRepeat = function(i, m) {
for (var o = []; m > 0; o[--m] = i) {}
return o.join('');
};
var slice = function(a){
return Array.prototype.slice.call(a);
};
var defaultToWhiteSpace = function(characters){
if (characters) {
return _s.escapeRegExp(characters);
}
return '\\s';
};
var sArgs = function(method){
return function(){
var args = slice(arguments);
for(var i=0; i<args.length; i++)
args[i] = args[i] == null ? '' : '' + args[i];
return method.apply(null, args);
};
};
// sprintf() for JavaScript 0.7-beta1
// http://www.diveintojavascript.com/projects/javascript-sprintf
//
// Copyright (c) Alexandru Marasteanu <alexaholic [at) gmail (dot] com>
// All rights reserved.
var sprintf = (function() {
function get_type(variable) {
return Object.prototype.toString.call(variable).slice(8, -1).toLowerCase();
}
var str_repeat = strRepeat;
var str_format = function() {
if (!str_format.cache.hasOwnProperty(arguments[0])) {
str_format.cache[arguments[0]] = str_format.parse(arguments[0]);
}
return str_format.format.call(null, str_format.cache[arguments[0]], arguments);
};
str_format.format = function(parse_tree, argv) {
var cursor = 1, tree_length = parse_tree.length, node_type = '', arg, output = [], i, k, match, pad, pad_character, pad_length;
for (i = 0; i < tree_length; i++) {
node_type = get_type(parse_tree[i]);
if (node_type === 'string') {
output.push(parse_tree[i]);
}
else if (node_type === 'array') {
match = parse_tree[i]; // convenience purposes only
if (match[2]) { // keyword argument
arg = argv[cursor];
for (k = 0; k < match[2].length; k++) {
if (!arg.hasOwnProperty(match[2][k])) {
throw(sprintf('[_.sprintf] property "%s" does not exist', match[2][k]));
}
arg = arg[match[2][k]];
}
} else if (match[1]) { // positional argument (explicit)
arg = argv[match[1]];
}
else { // positional argument (implicit)
arg = argv[cursor++];
}
if (/[^s]/.test(match[8]) && (get_type(arg) != 'number')) {
throw(sprintf('[_.sprintf] expecting number but found %s', get_type(arg)));
}
switch (match[8]) {
case 'b': arg = arg.toString(2); break;
case 'c': arg = String.fromCharCode(arg); break;
case 'd': arg = parseInt(arg, 10); break;
case 'e': arg = match[7] ? arg.toExponential(match[7]) : arg.toExponential(); break;
case 'f': arg = match[7] ? parseFloat(arg).toFixed(match[7]) : parseFloat(arg); break;
case 'o': arg = arg.toString(8); break;
case 's': arg = ((arg = String(arg)) && match[7] ? arg.substring(0, match[7]) : arg); break;
case 'u': arg = Math.abs(arg); break;
case 'x': arg = arg.toString(16); break;
case 'X': arg = arg.toString(16).toUpperCase(); break;
}
arg = (/[def]/.test(match[8]) && match[3] && arg >= 0 ? '+'+ arg : arg);
pad_character = match[4] ? match[4] == '0' ? '0' : match[4].charAt(1) : ' ';
pad_length = match[6] - String(arg).length;
pad = match[6] ? str_repeat(pad_character, pad_length) : '';
output.push(match[5] ? arg + pad : pad + arg);
}
}
return output.join('');
};
str_format.cache = {};
str_format.parse = function(fmt) {
var _fmt = fmt, match = [], parse_tree = [], arg_names = 0;
while (_fmt) {
if ((match = /^[^\x25]+/.exec(_fmt)) !== null) {
parse_tree.push(match[0]);
}
else if ((match = /^\x25{2}/.exec(_fmt)) !== null) {
parse_tree.push('%');
}
else if ((match = /^\x25(?:([1-9]\d*)\$|\(([^\)]+)\))?(\+)?(0|'[^$])?(-)?(\d+)?(?:\.(\d+))?([b-fosuxX])/.exec(_fmt)) !== null) {
if (match[2]) {
arg_names |= 1;
var field_list = [], replacement_field = match[2], field_match = [];
if ((field_match = /^([a-z_][a-z_\d]*)/i.exec(replacement_field)) !== null) {
field_list.push(field_match[1]);
while ((replacement_field = replacement_field.substring(field_match[0].length)) !== '') {
if ((field_match = /^\.([a-z_][a-z_\d]*)/i.exec(replacement_field)) !== null) {
field_list.push(field_match[1]);
}
else if ((field_match = /^\[(\d+)\]/.exec(replacement_field)) !== null) {
field_list.push(field_match[1]);
}
else {
throw('[_.sprintf] huh?');
}
}
}
else {
throw('[_.sprintf] huh?');
}
match[2] = field_list;
}
else {
arg_names |= 2;
}
if (arg_names === 3) {
throw('[_.sprintf] mixing positional and named placeholders is not (yet) supported');
}
parse_tree.push(match);
}
else {
throw('[_.sprintf] huh?');
}
_fmt = _fmt.substring(match[0].length);
}
return parse_tree;
};
return str_format;
})();
// Defining underscore.string
var _s = {
VERSION: '1.2.0',
isBlank: sArgs(function(str){
return (/^\s*$/).test(str);
}),
stripTags: sArgs(function(str){
return str.replace(/<\/?[^>]+>/ig, '');
}),
capitalize : sArgs(function(str) {
return str.charAt(0).toUpperCase() + str.substring(1).toLowerCase();
}),
chop: sArgs(function(str, step){
step = parseNumber(step) || str.length;
var arr = [];
for (var i = 0; i < str.length;) {
arr.push(str.slice(i,i + step));
i = i + step;
}
return arr;
}),
clean: sArgs(function(str){
return _s.strip(str.replace(/\s+/g, ' '));
}),
count: sArgs(function(str, substr){
var count = 0, index;
for (var i=0; i < str.length;) {
index = str.indexOf(substr, i);
index >= 0 && count++;
i = i + (index >= 0 ? index : 0) + substr.length;
}
return count;
}),
chars: sArgs(function(str) {
return str.split('');
}),
escapeHTML: sArgs(function(str) {
return str.replace(/&/g,'&').replace(/</g,'<').replace(/>/g,'>')
.replace(/"/g, '"').replace(/'/g, "'");
}),
unescapeHTML: sArgs(function(str) {
return str.replace(/</g, '<').replace(/>/g, '>')
.replace(/"/g, '"').replace(/'/g, "'").replace(/&/g, '&');
}),
escapeRegExp: sArgs(function(str){
// From MooTools core 1.2.4
return str.replace(/([-.*+?^${}()|[\]\/\\])/g, '\\$1');
}),
insert: sArgs(function(str, i, substr){
var arr = str.split('');
arr.splice(parseNumber(i), 0, substr);
return arr.join('');
}),
include: sArgs(function(str, needle){
return str.indexOf(needle) !== -1;
}),
join: sArgs(function(sep) {
var args = slice(arguments);
return args.join(args.shift());
}),
lines: sArgs(function(str) {
return str.split("\n");
}),
reverse: sArgs(function(str){
return Array.prototype.reverse.apply(String(str).split('')).join('');
}),
splice: sArgs(function(str, i, howmany, substr){
var arr = str.split('');
arr.splice(parseNumber(i), parseNumber(howmany), substr);
return arr.join('');
}),
startsWith: sArgs(function(str, starts){
return str.length >= starts.length && str.substring(0, starts.length) === starts;
}),
endsWith: sArgs(function(str, ends){
return str.length >= ends.length && str.substring(str.length - ends.length) === ends;
}),
succ: sArgs(function(str){
var arr = str.split('');
arr.splice(str.length-1, 1, String.fromCharCode(str.charCodeAt(str.length-1) + 1));
return arr.join('');
}),
titleize: sArgs(function(str){
var arr = str.split(' '),
word;
for (var i=0; i < arr.length; i++) {
word = arr[i].split('');
if(typeof word[0] !== 'undefined') word[0] = word[0].toUpperCase();
i+1 === arr.length ? arr[i] = word.join('') : arr[i] = word.join('') + ' ';
}
return arr.join('');
}),
camelize: sArgs(function(str){
return _s.trim(str).replace(/(\-|_|\s)+(.)?/g, function(match, separator, chr) {
return chr ? chr.toUpperCase() : '';
});
}),
underscored: function(str){
return _s.trim(str).replace(/([a-z\d])([A-Z]+)/g, '$1_$2').replace(/\-|\s+/g, '_').toLowerCase();
},
dasherize: function(str){
return _s.trim(str).replace(/([a-z\d])([A-Z]+)/g, '$1-$2').replace(/^([A-Z]+)/, '-$1').replace(/\_|\s+/g, '-').toLowerCase();
},
humanize: function(str){
return _s.capitalize(this.underscored(str).replace(/_id$/,'').replace(/_/g, ' '));
},
trim: sArgs(function(str, characters){
if (!characters && nativeTrim) {
return nativeTrim.call(str);
}
characters = defaultToWhiteSpace(characters);
return str.replace(new RegExp('\^[' + characters + ']+|[' + characters + ']+$', 'g'), '');
}),
ltrim: sArgs(function(str, characters){
characters = defaultToWhiteSpace(characters);
return str.replace(new RegExp('\^[' + characters + ']+', 'g'), '');
}),
rtrim: sArgs(function(str, characters){
characters = defaultToWhiteSpace(characters);
return str.replace(new RegExp('[' + characters + ']+$', 'g'), '');
}),
truncate: sArgs(function(str, length, truncateStr){
truncateStr = truncateStr || '...';
length = parseNumber(length);
return str.length > length ? str.slice(0,length) + truncateStr : str;
}),
/**
* _s.prune: a more elegant version of truncate
* prune extra chars, never leaving a half-chopped word.
* @author github.com/sergiokas
*/
prune: sArgs(function(str, length, pruneStr){
pruneStr = pruneStr || '...';
length = parseNumber(length);
var pruned = '';
// Check if we're in the middle of a word
if( str.substring(length-1, length+1).search(/^\w\w$/) === 0 )
pruned = _s.rtrim(str.slice(0,length).replace(/([\W][\w]*)$/,''));
else
pruned = _s.rtrim(str.slice(0,length));
pruned = pruned.replace(/\W+$/,'');
return (pruned.length+pruneStr.length>str.length) ? str : pruned + pruneStr;
}),
words: function(str, delimiter) {
return String(str).split(delimiter || " ");
},
pad: sArgs(function(str, length, padStr, type) {
var padding = '',
padlen = 0;
length = parseNumber(length);
if (!padStr) { padStr = ' '; }
else if (padStr.length > 1) { padStr = padStr.charAt(0); }
switch(type) {
case 'right':
padlen = (length - str.length);
padding = strRepeat(padStr, padlen);
str = str+padding;
break;
case 'both':
padlen = (length - str.length);
padding = {
'left' : strRepeat(padStr, Math.ceil(padlen/2)),
'right': strRepeat(padStr, Math.floor(padlen/2))
};
str = padding.left+str+padding.right;
break;
default: // 'left'
padlen = (length - str.length);
padding = strRepeat(padStr, padlen);;
str = padding+str;
}
return str;
}),
lpad: function(str, length, padStr) {
return _s.pad(str, length, padStr);
},
rpad: function(str, length, padStr) {
return _s.pad(str, length, padStr, 'right');
},
lrpad: function(str, length, padStr) {
return _s.pad(str, length, padStr, 'both');
},
sprintf: sprintf,
vsprintf: function(fmt, argv){
argv.unshift(fmt);
return sprintf.apply(null, argv);
},
toNumber: function(str, decimals) {
var num = parseNumber(parseNumber(str).toFixed(parseNumber(decimals)));
return (!(num === 0 && (str !== "0" && str !== 0))) ? num : Number.NaN;
},
strRight: sArgs(function(sourceStr, sep){
var pos = (!sep) ? -1 : sourceStr.indexOf(sep);
return (pos != -1) ? sourceStr.slice(pos+sep.length, sourceStr.length) : sourceStr;
}),
strRightBack: sArgs(function(sourceStr, sep){
var pos = (!sep) ? -1 : sourceStr.lastIndexOf(sep);
return (pos != -1) ? sourceStr.slice(pos+sep.length, sourceStr.length) : sourceStr;
}),
strLeft: sArgs(function(sourceStr, sep){
var pos = (!sep) ? -1 : sourceStr.indexOf(sep);
return (pos != -1) ? sourceStr.slice(0, pos) : sourceStr;
}),
strLeftBack: sArgs(function(sourceStr, sep){
var pos = sourceStr.lastIndexOf(sep);
return (pos != -1) ? sourceStr.slice(0, pos) : sourceStr;
}),
exports: function() {
var result = {};
for (var prop in this) {
if (!this.hasOwnProperty(prop) || prop == 'include' || prop == 'contains' || prop == 'reverse') continue;
result[prop] = this[prop];
}
return result;
}
};
// Aliases
_s.strip = _s.trim;
_s.lstrip = _s.ltrim;
_s.rstrip = _s.rtrim;
_s.center = _s.lrpad;
_s.ljust = _s.lpad;
_s.rjust = _s.rpad;
_s.contains = _s.include;
// CommonJS module is defined
if (typeof exports !== 'undefined') {
if (typeof module !== 'undefined' && module.exports) {
// Export module
module.exports = _s;
}
exports._s = _s;
// Integrate with Underscore.js
} else if (typeof root._ !== 'undefined') {
// root._.mixin(_s);
root._.string = _s;
root._.str = root._.string;
// Or define it
} else {
root._ = {
string: _s,
str: _s
};
}
}(this || window));
| [FIX] error reporting in _.sprintf | addons/web/static/lib/underscore/underscore.string.js | [FIX] error reporting in _.sprintf | <ide><path>ddons/web/static/lib/underscore/underscore.string.js
<ide> arg = argv[cursor];
<ide> for (k = 0; k < match[2].length; k++) {
<ide> if (!arg.hasOwnProperty(match[2][k])) {
<del> throw(sprintf('[_.sprintf] property "%s" does not exist', match[2][k]));
<add> throw new Error(sprintf('[_.sprintf] property "%s" does not exist', match[2][k]));
<ide> }
<ide> arg = arg[match[2][k]];
<ide> }
<ide> }
<ide>
<ide> if (/[^s]/.test(match[8]) && (get_type(arg) != 'number')) {
<del> throw(sprintf('[_.sprintf] expecting number but found %s', get_type(arg)));
<add> throw new Error(sprintf('[_.sprintf] expecting number but found %s', get_type(arg)));
<ide> }
<ide> switch (match[8]) {
<ide> case 'b': arg = arg.toString(2); break;
<ide> field_list.push(field_match[1]);
<ide> }
<ide> else {
<del> throw('[_.sprintf] huh?');
<add> throw new Error('[_.sprintf] huh?');
<ide> }
<ide> }
<ide> }
<ide> else {
<del> throw('[_.sprintf] huh?');
<add> throw new Error('[_.sprintf] huh?');
<ide> }
<ide> match[2] = field_list;
<ide> }
<ide> arg_names |= 2;
<ide> }
<ide> if (arg_names === 3) {
<del> throw('[_.sprintf] mixing positional and named placeholders is not (yet) supported');
<add> throw new Error('[_.sprintf] mixing positional and named placeholders is not (yet) supported');
<ide> }
<ide> parse_tree.push(match);
<ide> }
<ide> else {
<del> throw('[_.sprintf] huh?');
<add> throw new Error('[_.sprintf] huh?');
<ide> }
<ide> _fmt = _fmt.substring(match[0].length);
<ide> } |
|
Java | apache-2.0 | 2e333f955834f290bb90844c15c8a909f7523236 | 0 | oriontribunal/CoffeeMud,bozimmerman/CoffeeMud,bozimmerman/CoffeeMud,oriontribunal/CoffeeMud,bozimmerman/CoffeeMud,bozimmerman/CoffeeMud,oriontribunal/CoffeeMud,oriontribunal/CoffeeMud | package com.planet_ink.coffee_mud.Items.Software;
import com.planet_ink.coffee_mud.Items.Basic.StdItem;
import com.planet_ink.coffee_mud.core.interfaces.*;
import com.planet_ink.coffee_mud.core.threads.TimeMs;
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.Items.interfaces.ShipComponent.ShipEngine;
import com.planet_ink.coffee_mud.Items.interfaces.Technical.TechCommand;
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.Races.interfaces.*;
import java.net.*;
import java.io.*;
import java.util.*;
/*
Copyright 2013-2015 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 RocketShipProgram extends GenShipProgram
{
@Override public String ID(){ return "RocketShipProgram";}
protected volatile long nextPowerCycleTmr = System.currentTimeMillis()+(8*1000);
protected String noActivationMenu="^rNo engine systems found.\n\r";
protected volatile List<ShipEngine> engines=null;
protected volatile List<ShipComponent> sensors=null;
protected volatile List<Electronics.PowerSource> batteries=null;
protected final List<CMObject> sensorReport = new LinkedList<CMObject>();
public RocketShipProgram()
{
super();
setName("a shuttle operations disk");
setDisplayText("a small software disk sits here.");
setDescription("It appears to be a program to operate a small shuttle or rocket.");
basePhyStats.setWeight(100);
material=RawMaterial.RESOURCE_STEEL;
baseGoldValue=1000;
recoverPhyStats();
}
@Override
public String getParentMenu()
{
return "";
}
@Override
public String getInternalName()
{
return "SHIP";
}
protected String buildActivationMenu(List<ShipComponent> sensors, List<ShipEngine> engines, List<Electronics.PowerSource> batteries)
{
final StringBuilder str=new StringBuilder();
str.append("^X").append(CMStrings.centerPreserve(L(" -- Flight Status -- "),60)).append("^.^N\n\r");
final SpaceObject spaceObject=CMLib.map().getSpaceObject(this,true);
final SpaceShip ship=(spaceObject instanceof SpaceShip)?(SpaceShip)spaceObject:null;
final SpaceObject shipSpaceObject=(ship==null)?null:ship.getShipSpaceObject();
if(ship==null)
str.append("^Z").append(CMStrings.centerPreserve(L(" -- Can Not Determine -- "),60)).append("^.^N\n\r");
else
if(ship.getIsDocked() != null)
{
str.append("^H").append(CMStrings.padRight(L("Docked at ^w@x1",ship.getIsDocked().displayText(null)),60)).append("^.^N\n\r");
final SpaceObject planet=CMLib.map().getSpaceObject(ship.getIsDocked(), true);
if(planet!=null)
str.append("^H").append(CMStrings.padRight(L("On Planet ^w@x1",planet.Name()),60)).append("^.^N\n\r");
}
else
if((shipSpaceObject==null)||(!CMLib.map().isObjectInSpace(shipSpaceObject)))
str.append("^Z").append(CMStrings.centerPreserve(L(" -- System Malfunction-- "),60)).append("^.^N\n\r");
else
{
final List<SpaceObject> orbs=CMLib.map().getSpaceObjectsWithin(shipSpaceObject,0,SpaceObject.Distance.LightMinute.dm);
SpaceObject orbitingPlanet=null;
SpaceObject altitudePlanet=null;
for(final SpaceObject orb : orbs)
{
if(orb instanceof Area)
{
final long distance=CMLib.map().getDistanceFrom(shipSpaceObject, orb);
if((distance > orb.radius())&&((distance-orb.radius()) < orb.radius()*SpaceObject.MULTIPLIER_GRAVITY_RADIUS))
altitudePlanet=orb; // since they are sorted, this would be the nearest.
if((distance > orb.radius()*SpaceObject.MULTIPLIER_ORBITING_RADIUS_MIN)&&(distance<orb.radius()*SpaceObject.MULTIPLIER_ORBITING_RADIUS_MAX))
orbitingPlanet=orb; // since they are sorted, this would be the nearest.
break;
}
}
str.append("^H").append(CMStrings.padRight(L("Speed"),10));
str.append("^N").append(CMStrings.padRight(displayPerSec(Math.round(ship.speed())),20));
str.append("^H").append(CMStrings.padRight(L("Direction"),10));
final String dirStr=display(ship.direction());
str.append("^N").append(CMStrings.padRight(dirStr,20));
str.append("\n\r");
str.append("^H").append(CMStrings.padRight(L("Location"),10));
if(orbitingPlanet!=null)
str.append("^N").append(CMStrings.padRight(L("orbiting @x1",orbitingPlanet.name()),50));
else
str.append("^N").append(CMStrings.padRight(CMParms.toStringList(shipSpaceObject.coordinates()),50));
str.append("\n\r");
str.append("^H").append(CMStrings.padRight(L("Facing"),10));
final String facStr=display(ship.facing());
str.append("^N").append(CMStrings.padRight(facStr,20));
if(altitudePlanet!=null)
{
str.append("^H").append(CMStrings.padRight(L("Altitude"),10));
str.append("^N").append(CMStrings.padRight(display(CMLib.map().getDistanceFrom(shipSpaceObject, altitudePlanet)-altitudePlanet.radius()),20));
}
else
{
str.append("\n\r");
}
str.append("\n\r");
}
str.append("^N\n\r");
if((sensors!=null)&&(sensors.size()>0))
{
str.append("^X").append(CMStrings.centerPreserve(L(" -- Sensors -- "),60)).append("^.^N\n\r");
int sensorNumber=1;
for(final ShipComponent sensor : sensors)
{
str.append("^H").append(CMStrings.padRight(L("SENSOR@x1",""+sensorNumber),9));
str.append(CMStrings.padRight(sensor.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
str.append("^H").append(CMStrings.padRight(sensor.Name(),34));
str.append("^.^N\n\r");
final List<CMObject> localSensorReport;
synchronized(sensorReport)
{
sensorReport.clear();
final String code=Technical.TechCommand.SENSE.makeCommand();
final MOB mob=CMClass.getFactoryMOB();
try
{
final CMMsg msg=CMClass.getMsg(mob, sensor, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_ACTIVATE|CMMsg.MASK_CNTRLMSG, code, CMMsg.NO_EFFECT,null);
if(sensor.owner() instanceof Room)
{
if(((Room)sensor.owner()).okMessage(mob, msg))
((Room)sensor.owner()).send(mob, msg);
}
else
if(sensor.okMessage(mob, msg))
sensor.executeMsg(mob, msg);
}
finally
{
mob.destroy();
}
localSensorReport = new SLinkedList<CMObject>(sensorReport.iterator());
sensorReport.clear();
}
if(localSensorReport.size()==0)
str.append("^R").append(L("No Report"));
else
for(CMObject o : localSensorReport)
{
if(o instanceof SpaceObject)
{
SpaceObject O=(SpaceObject)o;
str.append("^W").append(L("Found: ")).append("^N").append(O.displayText());
}
else
str.append("^W").append(L("Found: ")).append("^N").append(o.name());
str.append("^.^N\n\r");
}
str.append("^.^N\n\r");
sensorNumber++;
}
}
if((batteries!=null)&&(batteries.size()>0))
{
str.append("^X").append(CMStrings.centerPreserve(L(" -- Batteries -- "),60)).append("^.^N\n\r");
int sensorNumber=1;
for(final Electronics.PowerSource battery : batteries)
{
str.append("^H").append(CMStrings.padRight(L("BATTERY@x1",""+sensorNumber),9));
str.append(CMStrings.padRight(battery.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
str.append("^H").append(CMStrings.padRight(L("Power"),6));
str.append("^N").append(CMStrings.padRight(Long.toString(battery.powerRemaining()),11));
str.append("^H").append(CMStrings.padRight(battery.Name(),24));
str.append("^.^N\n\r");
sensorNumber++;
}
str.append("^.^N\n\r");
}
if((engines==null)||(engines.size()==0))
str.append(noActivationMenu);
else
{
str.append("^X").append(CMStrings.centerPreserve(L(" -- Engines -- "),60)).append("^.^N\n\r");
int engineNumber=1;
for(final ShipEngine engine : engines)
{
str.append("^H").append(CMStrings.padRight(L("ENGINE@x1",""+engineNumber),9));
str.append(CMStrings.padRight(engine.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
str.append("^H").append(CMStrings.padRight(L("Fuel"),5));
str.append("^N").append(CMStrings.padRight(Long.toString(engine.getFuelRemaining()),11));
str.append("^H").append(CMStrings.padRight(engine.Name(),24));
str.append("^.^N\n\r");
engineNumber++;
}
str.append("^N\n\r");
str.append("^X").append(CMStrings.centerPreserve(L(" -- Commands -- "),60)).append("^.^N\n\r");
str.append("^H").append(CMStrings.padRight(L("[ENGINEHELP] : Give details about engine commands."),60)).append("\n\r");
str.append("^H").append(CMStrings.padRight(L("[ENGINE#/NAME] ([AFT/PORT/STARBOARD/DORSEL/VENTRAL]) [AMT]"),60)).append("\n\r");
str.append("^X").append(CMStrings.centerPreserve("",60)).append("^.^N\n\r");
str.append("^N\n\r");
}
return str.toString();
}
@Override
public String getCurrentScreenDisplay()
{
return this.getActivationMenu();
}
protected synchronized List<ShipEngine> getEngines()
{
if(engines == null)
{
if(circuitKey.length()==0)
engines=new Vector<ShipEngine>(0);
else
{
final List<Electronics> electronics=CMLib.tech().getMakeRegisteredElectronics(circuitKey);
engines=new Vector<ShipEngine>(1);
for(final Electronics E : electronics)
{
if(E instanceof ShipComponent.ShipEngine)
engines.add((ShipComponent.ShipEngine)E);
}
}
}
return engines;
}
protected synchronized List<ShipComponent> getShipSensors()
{
if(sensors == null)
{
if(circuitKey.length()==0)
sensors=new Vector<ShipComponent>(0);
else
{
final List<Electronics> electronics=CMLib.tech().getMakeRegisteredElectronics(circuitKey);
sensors=new Vector<ShipComponent>(1);
for(final Electronics E : electronics)
{
if((E instanceof ShipComponent)&&(E.getTechType()==TechType.SHIP_SENSOR))
sensors.add((ShipComponent)E);
}
}
}
return sensors;
}
protected synchronized List<Electronics.PowerSource> getBatteries()
{
if(batteries == null)
{
if(circuitKey.length()==0)
batteries=new Vector<Electronics.PowerSource>(0);
else
{
final List<Electronics> electronics=CMLib.tech().getMakeRegisteredElectronics(circuitKey);
batteries=new Vector<Electronics.PowerSource>(1);
for(final Electronics E : electronics)
{
if((E instanceof ShipComponent)
&&(E.getTechType()==TechType.SHIP_POWER)
&&(!(E instanceof Electronics.FuelConsumer))
&&(E instanceof Electronics.PowerSource))
batteries.add((Electronics.PowerSource)E);
}
}
}
return batteries;
}
@Override public boolean isActivationString(String word)
{
return isCommandString(word,false);
}
@Override public boolean isDeActivationString(String word)
{
return isCommandString(word,false);
}
protected ShipEngine findEngineByName(String name)
{
final List<ShipEngine> engines=getEngines();
if(engines.size()==0)
return null;
name=name.toUpperCase();
if(name.startsWith("ENGINE"))
{
final String numStr=name.substring(6);
if(!CMath.isInteger(numStr))
return null;
final int num=CMath.s_int(numStr);
if((num>0)&&(num<=engines.size()))
return engines.get(num-1);
return null;
}
ShipEngine E=(ShipEngine)CMLib.english().fetchEnvironmental(engines, name, true);
if(E==null)
E=(ShipEngine)CMLib.english().fetchEnvironmental(engines, name, false);
return E;
}
@Override public boolean isCommandString(String word, boolean isActive)
{
final Vector<String> parsed=CMParms.parse(word);
if(parsed.size()==0)
return false;
final String uword=parsed.get(0).toUpperCase();
if(uword.startsWith("ENGINEHELP"))
return true;
return findEngineByName(uword)!=null;
}
@Override
public String getActivationMenu()
{
return buildActivationMenu(getShipSensors(), getEngines(), getBatteries());
}
@Override
public boolean checkActivate(MOB mob, String message)
{
return true;
}
@Override
public boolean checkDeactivate(MOB mob, String message)
{
return true;
}
@Override
public boolean checkTyping(MOB mob, String message)
{
return true;
}
@Override
public boolean checkPowerCurrent(int value)
{
return true;
}
@Override
public void onTyping(MOB mob, String message)
{
synchronized(this)
{
final Vector<String> parsed=CMParms.parse(message);
if(parsed.size()==0)
{
super.addScreenMessage(L("Error: No command."));
return;
}
final String uword=parsed.get(0).toUpperCase();
if(uword.equalsIgnoreCase("ENGINEHELP"))
{
super.addScreenMessage(L("^HENGINEHELP:^N\n\r^N"+"The ENGINE command instructs the given " +
"engine number or name to fire in the appropriate direction. What happens, " +
"and how quickly, depends largely on the capabilities of the engine. " +
"Giving a direction is optional, and if not given, AFT is assumed. All "+
"directions result in corrected bursts, except for AFT, which will result " +
"in sustained accelleration."));
return;
}
final ShipEngine E=findEngineByName(uword);
if(E==null)
{
super.addScreenMessage(L("Error: Unknown engine '"+uword+"'."));
return;
}
int amount=0;
ShipEngine.ThrustPort portDir=ShipEngine.ThrustPort.AFT;
if(parsed.size()>3)
{
super.addScreenMessage(L("Error: Too many parameters."));
return;
}
if(parsed.size()==1)
{
super.addScreenMessage(L("Error: No thrust amount given."));
return;
}
if(!CMath.isInteger(parsed.get(parsed.size()-1)))
{
super.addScreenMessage(L("Error: '@x1' is not a valid amount.",parsed.get(parsed.size()-1)));
return;
}
amount=CMath.s_int(parsed.get(parsed.size()-1));
if(parsed.size()==3)
{
portDir=(ShipEngine.ThrustPort)CMath.s_valueOf(ShipEngine.ThrustPort.class, parsed.get(1).toUpperCase().trim());
if(portDir!=null) { }
else
if("aft".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.AFT;
else
if("port".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.PORT;
else
if("starboard".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.STARBOARD;
else
if("ventral".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.VENTRAL;
else
if("dorsel".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.DORSEL;
else
{
super.addScreenMessage(L("Error: '@x1' is not a valid direction: AFT, PORT, VENTRAL, DORSEL, or STARBOARD.",parsed.get(1)));
return;
}
}
final String code=Technical.TechCommand.THRUST.makeCommand(portDir,Integer.valueOf(amount));
final CMMsg msg=CMClass.getMsg(mob, E, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_ACTIVATE|CMMsg.MASK_CNTRLMSG, code, CMMsg.NO_EFFECT,null);
if(E.owner() instanceof Room)
{
if(((Room)E.owner()).okMessage(mob, msg))
((Room)E.owner()).send(mob, msg);
}
else
if(E.okMessage(mob, msg))
E.executeMsg(mob, msg);
}
}
@Override
public void onActivate(MOB mob, String message)
{
onTyping(mob,message);
}
@Override
public void onDeactivate(MOB mob, String message)
{
final Vector<String> parsed=CMParms.parse(message);
if(parsed.size()==0)
{
super.addScreenMessage(L("Syntax Error!"));
return;
}
String uword=parsed.get(0).toUpperCase();
ShipEngine E=findEngineByName(uword);
if(E!=null)
{
onTyping(mob,"\""+uword+"\" "+0);
return;
}
uword=message.toUpperCase();
E=findEngineByName(uword);
if(E==null)
{
super.addScreenMessage(L("Unknown engine '@x1'!",uword));
return;
}
final CMMsg msg=CMClass.getMsg(mob, E, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_DEACTIVATE|CMMsg.MASK_CNTRLMSG, "", CMMsg.NO_EFFECT,null);
if(E.owner() instanceof Room)
{
if(((Room)E.owner()).okMessage(mob, msg))
((Room)E.owner()).send(mob, msg);
}
else
if(E.okMessage(mob, msg))
E.executeMsg(mob, msg);
return;
}
@Override public void onPowerCurrent(int value)
{
if(System.currentTimeMillis()>nextPowerCycleTmr)
{
engines=null;
nextPowerCycleTmr = System.currentTimeMillis()+(8*1000);
}
}
@Override
public void executeMsg(Environmental host, CMMsg msg)
{
if(msg.amITarget(this))
{
switch(msg.targetMinor())
{
case CMMsg.TYP_GET:
case CMMsg.TYP_PUSH:
case CMMsg.TYP_PULL:
case CMMsg.TYP_PUT:
case CMMsg.TYP_INSTALL:
engines=null;
break;
case CMMsg.TYP_ACTIVATE:
{
if(msg.isTarget(CMMsg.MASK_CNTRLMSG) && (msg.targetMessage()!=null))
{
final String[] parts=msg.targetMessage().split(" ");
final TechCommand command=TechCommand.findCommand(parts);
if((command == TechCommand.SENSE) && (msg.tool() != null)) // this is a sensor report
{
this.sensorReport.add(msg.tool());
return;
}
}
break;
}
}
}
super.executeMsg(host,msg);
}
}
| com/planet_ink/coffee_mud/Items/Software/RocketShipProgram.java | package com.planet_ink.coffee_mud.Items.Software;
import com.planet_ink.coffee_mud.Items.Basic.StdItem;
import com.planet_ink.coffee_mud.core.interfaces.*;
import com.planet_ink.coffee_mud.core.threads.TimeMs;
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.Items.interfaces.ShipComponent.ShipEngine;
import com.planet_ink.coffee_mud.Items.interfaces.Technical.TechCommand;
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.Races.interfaces.*;
import java.net.*;
import java.io.*;
import java.util.*;
/*
Copyright 2013-2015 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 RocketShipProgram extends GenShipProgram
{
@Override public String ID(){ return "RocketShipProgram";}
protected volatile long nextPowerCycleTmr = System.currentTimeMillis()+(8*1000);
protected String noActivationMenu="^rNo engine systems found.\n\r";
protected volatile List<ShipEngine> engines=null;
protected volatile List<ShipComponent> sensors=null;
protected final List<CMObject> sensorReport = new LinkedList<CMObject>();
public RocketShipProgram()
{
super();
setName("a shuttle operations disk");
setDisplayText("a small software disk sits here.");
setDescription("It appears to be a program to operate a small shuttle or rocket.");
basePhyStats.setWeight(100);
material=RawMaterial.RESOURCE_STEEL;
baseGoldValue=1000;
recoverPhyStats();
}
@Override
public String getParentMenu()
{
return "";
}
@Override
public String getInternalName()
{
return "SHIP";
}
protected String buildActivationMenu(List<ShipComponent> sensors, List<ShipEngine> engines)
{
final StringBuilder str=new StringBuilder();
str.append("^X").append(CMStrings.centerPreserve(L(" -- Flight Status -- "),60)).append("^.^N\n\r");
final SpaceObject spaceObject=CMLib.map().getSpaceObject(this,true);
final SpaceShip ship=(spaceObject instanceof SpaceShip)?(SpaceShip)spaceObject:null;
final SpaceObject shipSpaceObject=(ship==null)?null:ship.getShipSpaceObject();
if(ship==null)
str.append("^Z").append(CMStrings.centerPreserve(L(" -- Can Not Determine -- "),60)).append("^.^N\n\r");
else
if(ship.getIsDocked() != null)
{
str.append("^H").append(CMStrings.padRight(L("Docked at ^w@x1",ship.getIsDocked().displayText(null)),60)).append("^.^N\n\r");
final SpaceObject planet=CMLib.map().getSpaceObject(ship.getIsDocked(), true);
if(planet!=null)
str.append("^H").append(CMStrings.padRight(L("On Planet ^w@x1",planet.Name()),60)).append("^.^N\n\r");
}
else
if((shipSpaceObject==null)||(!CMLib.map().isObjectInSpace(shipSpaceObject)))
str.append("^Z").append(CMStrings.centerPreserve(L(" -- System Malfunction-- "),60)).append("^.^N\n\r");
else
{
final List<SpaceObject> orbs=CMLib.map().getSpaceObjectsWithin(shipSpaceObject,0,SpaceObject.Distance.LightMinute.dm);
SpaceObject orbitingPlanet=null;
SpaceObject altitudePlanet=null;
for(final SpaceObject orb : orbs)
{
if(orb instanceof Area)
{
final long distance=CMLib.map().getDistanceFrom(shipSpaceObject, orb);
if((distance > orb.radius())&&((distance-orb.radius()) < orb.radius()*SpaceObject.MULTIPLIER_GRAVITY_RADIUS))
altitudePlanet=orb; // since they are sorted, this would be the nearest.
if((distance > orb.radius()*SpaceObject.MULTIPLIER_ORBITING_RADIUS_MIN)&&(distance<orb.radius()*SpaceObject.MULTIPLIER_ORBITING_RADIUS_MAX))
orbitingPlanet=orb; // since they are sorted, this would be the nearest.
break;
}
}
str.append("^H").append(CMStrings.padRight(L("Speed"),10));
str.append("^N").append(CMStrings.padRight(displayPerSec(Math.round(ship.speed())),20));
str.append("^H").append(CMStrings.padRight(L("Direction"),10));
final String dirStr=display(ship.direction());
str.append("^N").append(CMStrings.padRight(dirStr,20));
str.append("\n\r");
str.append("^H").append(CMStrings.padRight(L("Location"),10));
if(orbitingPlanet!=null)
str.append("^N").append(CMStrings.padRight(L("orbiting @x1",orbitingPlanet.name()),50));
else
str.append("^N").append(CMStrings.padRight(CMParms.toStringList(shipSpaceObject.coordinates()),50));
str.append("\n\r");
str.append("^H").append(CMStrings.padRight(L("Facing"),10));
final String facStr=display(ship.facing());
str.append("^N").append(CMStrings.padRight(facStr,20));
if(altitudePlanet!=null)
{
str.append("^H").append(CMStrings.padRight(L("Altitude"),10));
str.append("^N").append(CMStrings.padRight(display((CMLib.map().getDistanceFrom(shipSpaceObject, altitudePlanet)-altitudePlanet.radius())/10),20));
}
else
{
str.append("\n\r");
}
str.append("\n\r");
}
str.append("^N\n\r");
if((sensors!=null)&&(sensors.size()>0))
{
str.append("^X").append(CMStrings.centerPreserve(L(" -- Sensor Reports -- "),60)).append("^.^N\n\r");
int sensorNumber=1;
for(final ShipComponent sensor : sensors)
{
str.append("^H").append(CMStrings.padRight(L("SENSOR@x1",""+sensorNumber),9));
str.append(CMStrings.padRight(sensor.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
str.append("^H").append(CMStrings.padRight(sensor.Name(),24));
str.append("^.^N\n\r");
final List<CMObject> localSensorReport;
synchronized(sensorReport)
{
sensorReport.clear();
final String code=Technical.TechCommand.SENSE.makeCommand();
final MOB mob=CMClass.getFactoryMOB();
try
{
final CMMsg msg=CMClass.getMsg(mob, sensor, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_ACTIVATE|CMMsg.MASK_CNTRLMSG, code, CMMsg.NO_EFFECT,null);
if(sensor.owner() instanceof Room)
{
if(((Room)sensor.owner()).okMessage(mob, msg))
((Room)sensor.owner()).send(mob, msg);
}
else
if(sensor.okMessage(mob, msg))
sensor.executeMsg(mob, msg);
}
finally
{
mob.destroy();
}
localSensorReport = new SLinkedList<CMObject>(sensorReport.iterator());
sensorReport.clear();
}
if(localSensorReport.size()==0)
str.append("^R").append(L("No Report"));
else
for(CMObject o : localSensorReport)
{
if(o instanceof SpaceObject)
{
SpaceObject O=(SpaceObject)o;
str.append("^W").append(L("Found: ")).append("^N").append(O.displayText());
}
else
str.append("^W").append(L("Found: ")).append("^N").append(o.name());
str.append("^.^N\n\r");
}
str.append("^.^N\n\r");
sensorNumber++;
}
}
if((engines==null)||(engines.size()==0))
str.append(noActivationMenu);
else
{
str.append("^X").append(CMStrings.centerPreserve(L(" -- Engines -- "),60)).append("^.^N\n\r");
int engineNumber=1;
for(final ShipEngine engine : engines)
{
str.append("^H").append(CMStrings.padRight(L("ENGINE@x1",""+engineNumber),9));
str.append(CMStrings.padRight(engine.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
str.append("^H").append(CMStrings.padRight(L("Fuel"),5));
str.append("^N").append(CMStrings.padRight(Long.toString(engine.getFuelRemaining()),11));
str.append("^H").append(CMStrings.padRight(engine.Name(),24));
str.append("^.^N\n\r");
engineNumber++;
}
str.append("^N\n\r");
str.append("^X").append(CMStrings.centerPreserve(L(" -- Commands -- "),60)).append("^.^N\n\r");
str.append("^H").append(CMStrings.padRight(L("[ENGINEHELP] : Give details about engine commands."),60)).append("\n\r");
str.append("^H").append(CMStrings.padRight(L("[ENGINE#/NAME] ([AFT/PORT/STARBOARD/DORSEL/VENTRAL]) [AMT]"),60)).append("\n\r");
str.append("^X").append(CMStrings.centerPreserve("",60)).append("^.^N\n\r");
str.append("^N\n\r");
}
return str.toString();
}
@Override
public String getCurrentScreenDisplay()
{
return this.getActivationMenu();
}
protected synchronized List<ShipEngine> getEngines()
{
if(engines == null)
{
if(circuitKey.length()==0)
engines=new Vector<ShipEngine>(0);
else
{
final List<Electronics> electronics=CMLib.tech().getMakeRegisteredElectronics(circuitKey);
engines=new Vector<ShipEngine>(1);
for(final Electronics E : electronics)
{
if(E instanceof ShipComponent.ShipEngine)
engines.add((ShipComponent.ShipEngine)E);
}
}
}
return engines;
}
protected synchronized List<ShipComponent> getShipSensors()
{
if(sensors == null)
{
if(circuitKey.length()==0)
sensors=new Vector<ShipComponent>(0);
else
{
final List<Electronics> electronics=CMLib.tech().getMakeRegisteredElectronics(circuitKey);
sensors=new Vector<ShipComponent>(1);
for(final Electronics E : electronics)
{
if((E instanceof ShipComponent)&&(E.getTechType()==TechType.SHIP_SENSOR))
sensors.add((ShipComponent)E);
}
}
}
return sensors;
}
@Override public boolean isActivationString(String word)
{
return isCommandString(word,false);
}
@Override public boolean isDeActivationString(String word)
{
return isCommandString(word,false);
}
protected ShipEngine findEngineByName(String name)
{
final List<ShipEngine> engines=getEngines();
if(engines.size()==0)
return null;
name=name.toUpperCase();
if(name.startsWith("ENGINE"))
{
final String numStr=name.substring(6);
if(!CMath.isInteger(numStr))
return null;
final int num=CMath.s_int(numStr);
if((num>0)&&(num<=engines.size()))
return engines.get(num-1);
return null;
}
ShipEngine E=(ShipEngine)CMLib.english().fetchEnvironmental(engines, name, true);
if(E==null)
E=(ShipEngine)CMLib.english().fetchEnvironmental(engines, name, false);
return E;
}
@Override public boolean isCommandString(String word, boolean isActive)
{
final Vector<String> parsed=CMParms.parse(word);
if(parsed.size()==0)
return false;
final String uword=parsed.get(0).toUpperCase();
if(uword.startsWith("ENGINEHELP"))
return true;
return findEngineByName(uword)!=null;
}
@Override
public String getActivationMenu()
{
return buildActivationMenu(getShipSensors(), getEngines());
}
@Override
public boolean checkActivate(MOB mob, String message)
{
return true;
}
@Override
public boolean checkDeactivate(MOB mob, String message)
{
return true;
}
@Override
public boolean checkTyping(MOB mob, String message)
{
return true;
}
@Override
public boolean checkPowerCurrent(int value)
{
return true;
}
@Override
public void onTyping(MOB mob, String message)
{
synchronized(this)
{
final Vector<String> parsed=CMParms.parse(message);
if(parsed.size()==0)
{
super.addScreenMessage("Error: No command.");
return;
}
final String uword=parsed.get(0).toUpperCase();
if(uword.equalsIgnoreCase("ENGINEHELP"))
{
super.addScreenMessage("^HENGINEHELP:^N\n\r^N"+"The ENGINE command instructs the given " +
"engine number or name to fire in the appropriate direction. What happens, " +
"and how quickly, depends largely on the capabilities of the engine. " +
"Giving a direction is optional, and if not given, AFT is assumed. All "+
"directions result in corrected bursts, except for AFT, which will result " +
"in sustained accelleration.");
return;
}
final ShipEngine E=findEngineByName(uword);
if(E==null)
{
super.addScreenMessage("Error: Unknown engine '"+uword+"'.");
return;
}
int amount=0;
ShipEngine.ThrustPort portDir=ShipEngine.ThrustPort.AFT;
if(parsed.size()>3)
{
super.addScreenMessage("Error: Too many parameters.");
return;
}
if(parsed.size()==1)
{
super.addScreenMessage("Error: No thrust amount given.");
return;
}
if(!CMath.isInteger(parsed.get(parsed.size()-1)))
{
super.addScreenMessage("Error: '"+parsed.get(parsed.size()-1)+"' is not a valid amount.");
return;
}
amount=CMath.s_int(parsed.get(parsed.size()-1));
if(parsed.size()==3)
{
portDir=(ShipEngine.ThrustPort)CMath.s_valueOf(ShipEngine.ThrustPort.class, parsed.get(1).toUpperCase().trim());
if(portDir!=null) { }
else
if("aft".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.AFT;
else
if("port".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.PORT;
else
if("starboard".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.STARBOARD;
else
if("ventral".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.VENTRAL;
else
if("dorsel".startsWith(parsed.get(1).toLowerCase()))
portDir=ShipEngine.ThrustPort.DORSEL;
else
{
super.addScreenMessage("Error: '"+parsed.get(1)+" is not a valid direction: AFT, PORT, VENTRAL, DORSEL, or STARBOARD.");
return;
}
}
final String code=Technical.TechCommand.THRUST.makeCommand(portDir,Integer.valueOf(amount));
final CMMsg msg=CMClass.getMsg(mob, E, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_ACTIVATE|CMMsg.MASK_CNTRLMSG, code, CMMsg.NO_EFFECT,null);
if(E.owner() instanceof Room)
{
if(((Room)E.owner()).okMessage(mob, msg))
((Room)E.owner()).send(mob, msg);
}
else
if(E.okMessage(mob, msg))
E.executeMsg(mob, msg);
}
}
@Override
public void onActivate(MOB mob, String message)
{
onTyping(mob,message);
}
@Override
public void onDeactivate(MOB mob, String message)
{
final Vector<String> parsed=CMParms.parse(message);
if(parsed.size()==0)
{
super.addScreenMessage("Syntax Error!");
return;
}
String uword=parsed.get(0).toUpperCase();
ShipEngine E=findEngineByName(uword);
if(E!=null)
{
onTyping(mob,"\""+uword+"\" "+0);
return;
}
uword=message.toUpperCase();
E=findEngineByName(uword);
if(E==null)
{
super.addScreenMessage("Unknown engine '"+uword+"'!");
return;
}
final CMMsg msg=CMClass.getMsg(mob, E, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_DEACTIVATE|CMMsg.MASK_CNTRLMSG, "", CMMsg.NO_EFFECT,null);
if(E.owner() instanceof Room)
{
if(((Room)E.owner()).okMessage(mob, msg))
((Room)E.owner()).send(mob, msg);
}
else
if(E.okMessage(mob, msg))
E.executeMsg(mob, msg);
return;
}
@Override public void onPowerCurrent(int value)
{
if(System.currentTimeMillis()>nextPowerCycleTmr)
{
engines=null;
nextPowerCycleTmr = System.currentTimeMillis()+(8*1000);
}
}
@Override
public void executeMsg(Environmental host, CMMsg msg)
{
if(msg.amITarget(this))
{
switch(msg.targetMinor())
{
case CMMsg.TYP_GET:
case CMMsg.TYP_PUSH:
case CMMsg.TYP_PULL:
case CMMsg.TYP_PUT:
case CMMsg.TYP_INSTALL:
engines=null;
break;
case CMMsg.TYP_ACTIVATE:
{
if(msg.isTarget(CMMsg.MASK_CNTRLMSG) && (msg.targetMessage()!=null))
{
final String[] parts=msg.targetMessage().split(" ");
final TechCommand command=TechCommand.findCommand(parts);
if((command == TechCommand.SENSE) && (msg.tool() != null)) // this is a sensor report
{
this.sensorReport.add(msg.tool());
return;
}
}
break;
}
}
}
super.executeMsg(host,msg);
}
}
|
git-svn-id: svn://192.168.1.10/public/CoffeeMud@13147 0d6f1817-ed0e-0410-87c9-987e46238f29
| com/planet_ink/coffee_mud/Items/Software/RocketShipProgram.java | <ide><path>om/planet_ink/coffee_mud/Items/Software/RocketShipProgram.java
<ide>
<ide> protected volatile List<ShipEngine> engines=null;
<ide> protected volatile List<ShipComponent> sensors=null;
<add> protected volatile List<Electronics.PowerSource> batteries=null;
<ide>
<ide> protected final List<CMObject> sensorReport = new LinkedList<CMObject>();
<ide>
<ide> return "SHIP";
<ide> }
<ide>
<del> protected String buildActivationMenu(List<ShipComponent> sensors, List<ShipEngine> engines)
<add> protected String buildActivationMenu(List<ShipComponent> sensors, List<ShipEngine> engines, List<Electronics.PowerSource> batteries)
<ide> {
<ide> final StringBuilder str=new StringBuilder();
<ide> str.append("^X").append(CMStrings.centerPreserve(L(" -- Flight Status -- "),60)).append("^.^N\n\r");
<ide> if(altitudePlanet!=null)
<ide> {
<ide> str.append("^H").append(CMStrings.padRight(L("Altitude"),10));
<del> str.append("^N").append(CMStrings.padRight(display((CMLib.map().getDistanceFrom(shipSpaceObject, altitudePlanet)-altitudePlanet.radius())/10),20));
<add> str.append("^N").append(CMStrings.padRight(display(CMLib.map().getDistanceFrom(shipSpaceObject, altitudePlanet)-altitudePlanet.radius()),20));
<ide> }
<ide> else
<ide> {
<ide>
<ide> if((sensors!=null)&&(sensors.size()>0))
<ide> {
<del> str.append("^X").append(CMStrings.centerPreserve(L(" -- Sensor Reports -- "),60)).append("^.^N\n\r");
<add> str.append("^X").append(CMStrings.centerPreserve(L(" -- Sensors -- "),60)).append("^.^N\n\r");
<ide> int sensorNumber=1;
<ide> for(final ShipComponent sensor : sensors)
<ide> {
<ide> str.append("^H").append(CMStrings.padRight(L("SENSOR@x1",""+sensorNumber),9));
<ide> str.append(CMStrings.padRight(sensor.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
<del> str.append("^H").append(CMStrings.padRight(sensor.Name(),24));
<add> str.append("^H").append(CMStrings.padRight(sensor.Name(),34));
<ide> str.append("^.^N\n\r");
<ide> final List<CMObject> localSensorReport;
<ide> synchronized(sensorReport)
<ide> }
<ide> }
<ide>
<add> if((batteries!=null)&&(batteries.size()>0))
<add> {
<add> str.append("^X").append(CMStrings.centerPreserve(L(" -- Batteries -- "),60)).append("^.^N\n\r");
<add> int sensorNumber=1;
<add> for(final Electronics.PowerSource battery : batteries)
<add> {
<add> str.append("^H").append(CMStrings.padRight(L("BATTERY@x1",""+sensorNumber),9));
<add> str.append(CMStrings.padRight(battery.activated()?L("^gACTIVE"):L("^rINACTIVE"),9));
<add> str.append("^H").append(CMStrings.padRight(L("Power"),6));
<add> str.append("^N").append(CMStrings.padRight(Long.toString(battery.powerRemaining()),11));
<add> str.append("^H").append(CMStrings.padRight(battery.Name(),24));
<add> str.append("^.^N\n\r");
<add> sensorNumber++;
<add> }
<add> str.append("^.^N\n\r");
<add> }
<ide> if((engines==null)||(engines.size()==0))
<ide> str.append(noActivationMenu);
<ide> else
<ide> return sensors;
<ide> }
<ide>
<add> protected synchronized List<Electronics.PowerSource> getBatteries()
<add> {
<add> if(batteries == null)
<add> {
<add> if(circuitKey.length()==0)
<add> batteries=new Vector<Electronics.PowerSource>(0);
<add> else
<add> {
<add> final List<Electronics> electronics=CMLib.tech().getMakeRegisteredElectronics(circuitKey);
<add> batteries=new Vector<Electronics.PowerSource>(1);
<add> for(final Electronics E : electronics)
<add> {
<add> if((E instanceof ShipComponent)
<add> &&(E.getTechType()==TechType.SHIP_POWER)
<add> &&(!(E instanceof Electronics.FuelConsumer))
<add> &&(E instanceof Electronics.PowerSource))
<add> batteries.add((Electronics.PowerSource)E);
<add> }
<add>
<add> }
<add> }
<add> return batteries;
<add> }
<add>
<ide> @Override public boolean isActivationString(String word)
<ide> {
<ide> return isCommandString(word,false);
<ide> @Override
<ide> public String getActivationMenu()
<ide> {
<del> return buildActivationMenu(getShipSensors(), getEngines());
<add> return buildActivationMenu(getShipSensors(), getEngines(), getBatteries());
<ide> }
<ide>
<ide> @Override
<ide> final Vector<String> parsed=CMParms.parse(message);
<ide> if(parsed.size()==0)
<ide> {
<del> super.addScreenMessage("Error: No command.");
<add> super.addScreenMessage(L("Error: No command."));
<ide> return;
<ide> }
<ide> final String uword=parsed.get(0).toUpperCase();
<ide> if(uword.equalsIgnoreCase("ENGINEHELP"))
<ide> {
<del> super.addScreenMessage("^HENGINEHELP:^N\n\r^N"+"The ENGINE command instructs the given " +
<add> super.addScreenMessage(L("^HENGINEHELP:^N\n\r^N"+"The ENGINE command instructs the given " +
<ide> "engine number or name to fire in the appropriate direction. What happens, " +
<ide> "and how quickly, depends largely on the capabilities of the engine. " +
<ide> "Giving a direction is optional, and if not given, AFT is assumed. All "+
<ide> "directions result in corrected bursts, except for AFT, which will result " +
<del> "in sustained accelleration.");
<add> "in sustained accelleration."));
<ide> return;
<ide> }
<ide> final ShipEngine E=findEngineByName(uword);
<ide> if(E==null)
<ide> {
<del> super.addScreenMessage("Error: Unknown engine '"+uword+"'.");
<add> super.addScreenMessage(L("Error: Unknown engine '"+uword+"'."));
<ide> return;
<ide> }
<ide> int amount=0;
<ide> ShipEngine.ThrustPort portDir=ShipEngine.ThrustPort.AFT;
<ide> if(parsed.size()>3)
<ide> {
<del> super.addScreenMessage("Error: Too many parameters.");
<add> super.addScreenMessage(L("Error: Too many parameters."));
<ide> return;
<ide> }
<ide> if(parsed.size()==1)
<ide> {
<del> super.addScreenMessage("Error: No thrust amount given.");
<add> super.addScreenMessage(L("Error: No thrust amount given."));
<ide> return;
<ide> }
<ide> if(!CMath.isInteger(parsed.get(parsed.size()-1)))
<ide> {
<del> super.addScreenMessage("Error: '"+parsed.get(parsed.size()-1)+"' is not a valid amount.");
<add> super.addScreenMessage(L("Error: '@x1' is not a valid amount.",parsed.get(parsed.size()-1)));
<ide> return;
<ide> }
<ide> amount=CMath.s_int(parsed.get(parsed.size()-1));
<ide> portDir=ShipEngine.ThrustPort.DORSEL;
<ide> else
<ide> {
<del> super.addScreenMessage("Error: '"+parsed.get(1)+" is not a valid direction: AFT, PORT, VENTRAL, DORSEL, or STARBOARD.");
<add> super.addScreenMessage(L("Error: '@x1' is not a valid direction: AFT, PORT, VENTRAL, DORSEL, or STARBOARD.",parsed.get(1)));
<ide> return;
<ide> }
<ide> }
<ide> final Vector<String> parsed=CMParms.parse(message);
<ide> if(parsed.size()==0)
<ide> {
<del> super.addScreenMessage("Syntax Error!");
<add> super.addScreenMessage(L("Syntax Error!"));
<ide> return;
<ide> }
<ide> String uword=parsed.get(0).toUpperCase();
<ide> E=findEngineByName(uword);
<ide> if(E==null)
<ide> {
<del> super.addScreenMessage("Unknown engine '"+uword+"'!");
<add> super.addScreenMessage(L("Unknown engine '@x1'!",uword));
<ide> return;
<ide> }
<ide> final CMMsg msg=CMClass.getMsg(mob, E, this, CMMsg.NO_EFFECT, null, CMMsg.MSG_DEACTIVATE|CMMsg.MASK_CNTRLMSG, "", CMMsg.NO_EFFECT,null); |
||
Java | apache-2.0 | 926298cce95d0b17f18a43cc506187335de70dde | 0 | qiscus/qiscus-sdk-android | package com.qiscus.sdk.chat.core.presenter;
import com.qiscus.sdk.chat.core.QiscusCore;
import com.qiscus.sdk.chat.core.data.model.QiscusAccount;
import com.qiscus.sdk.chat.core.data.model.QiscusChatRoom;
import com.qiscus.sdk.chat.core.data.model.QiscusComment;
import com.qiscus.sdk.chat.core.data.model.QiscusRoomMember;
import com.qiscus.sdk.chat.core.data.remote.QiscusPusherApi;
import com.qiscus.sdk.chat.core.event.QiscusChatRoomEvent;
import com.qiscus.sdk.chat.core.util.QiscusAndroidUtil;
import com.qiscus.sdk.chat.core.util.QiscusRawDataExtractor;
import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.json.JSONException;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.concurrent.TimeUnit;
/**
* @author Yuana [email protected]
* @since Jan, Fri 04 2019 14.34
* <p>
* ChatRoom Event Handler Class
**/
public class QiscusChatRoomEventHandler {
private QiscusAccount qiscusAccount;
private StateListener listener;
private QiscusChatRoom qiscusChatRoom;
private Runnable listenChatRoomTask;
private HashMap<String, QiscusRoomMember> memberState;
public QiscusChatRoomEventHandler(QiscusChatRoom qiscusChatRoom, StateListener listener) {
this.listener = listener;
this.qiscusAccount = QiscusCore.getQiscusAccount();
setChatRoom(qiscusChatRoom);
if (!EventBus.getDefault().isRegistered(this)) {
EventBus.getDefault().register(this);
}
this.listenChatRoomTask = this::listenChatRoomEvent;
QiscusAndroidUtil.runOnUIThread(listenChatRoomTask, TimeUnit.SECONDS.toMillis(1));
}
public void setChatRoom(QiscusChatRoom qiscusChatRoom) {
this.qiscusChatRoom = qiscusChatRoom;
setMemberState();
}
private void setMemberState() {
if (memberState == null) {
memberState = new HashMap<>();
} else {
memberState.clear();
}
if (qiscusChatRoom.getMember().isEmpty()) {
return;
}
for (QiscusRoomMember member : qiscusChatRoom.getMember()) {
memberState.put(member.getEmail(), member);
}
}
private void listenChatRoomEvent() {
QiscusPusherApi.getInstance().subscribeChatRoom(qiscusChatRoom);
}
public void detach() {
QiscusAndroidUtil.cancelRunOnUIThread(listenChatRoomTask);
QiscusPusherApi.getInstance().unsubsribeChatRoom(qiscusChatRoom);
EventBus.getDefault().unregister(this);
}
@Subscribe
public void onChatRoomEvent(QiscusChatRoomEvent event) {
QiscusAndroidUtil.runOnBackgroundThread(() -> handleEvent(event));
}
private void handleEvent(QiscusChatRoomEvent event) {
if (event.getRoomId() == qiscusChatRoom.getId()) {
switch (event.getEvent()) {
case TYPING:
listener.onUserTypng(event.getUser(), event.isTyping());
break;
case DELIVERED:
long lastDeliveredCommentId = event.getCommentId();
QiscusCore.getDataStore().updateLastDeliveredComment(qiscusChatRoom.getId(), lastDeliveredCommentId);
listener.onChangeLastDelivered(lastDeliveredCommentId);
break;
case READ:
long lastReadCommentId = event.getCommentId();
QiscusCore.getDataStore().updateLastReadComment(qiscusChatRoom.getId(), lastReadCommentId);
listener.onChangeLastRead(lastReadCommentId);
break;
}
}
}
public void onGotComment(QiscusComment qiscusComment) {
if (!qiscusComment.getSender().equals(qiscusAccount.getEmail())) {
// handle room event such s invite user, kick user
if (qiscusComment.getType() == QiscusComment.Type.SYSTEM_EVENT) {
handleChatRoomChanged(qiscusComment);
}
if (!QiscusCore.getEnableRealtime() && qiscusChatRoom.getId() == qiscusComment.getRoomId()) {
QiscusChatRoom room = QiscusCore.getDataStore().getChatRoom(qiscusChatRoom.getId());
if ( room.getLastComment().getState() == QiscusComment.STATE_ON_QISCUS ||
room.getLastComment().getState() == QiscusComment.STATE_DELIVERED ) {
QiscusCore.getDataStore().updateLastReadComment(qiscusChatRoom.getId(), qiscusComment.getId());
listener.onChangeLastRead(qiscusComment.getId());
}
}
}
}
private void handleChatRoomChanged(QiscusComment qiscusComment) {
try {
JSONObject payload = QiscusRawDataExtractor.getPayload(qiscusComment);
QiscusRoomMember member = new QiscusRoomMember();
switch (payload.optString("type")) {
case "add_member":
member.setEmail(payload.optString("object_email"));
member.setUsername(payload.optString("object_username"));
handleMemberAdded(member);
break;
case "join_room":
member.setEmail(payload.optString("subject_email"));
member.setUsername(payload.optString("subject_username"));
handleMemberAdded(member);
break;
case "remove_member":
member.setEmail(payload.optString("object_email"));
member.setUsername(payload.optString("object_username"));
handleMemberRemoved(member);
break;
case "left_room":
member.setEmail(payload.optString("subject_email"));
member.setUsername(payload.optString("subject_username"));
handleMemberRemoved(member);
break;
case "change_room_name":
listener.onChatRoomNameChanged(payload.optString("room_name"));
break;
}
} catch (JSONException e) {
//Do nothing
}
}
private void handleMemberAdded(QiscusRoomMember member) {
if (!memberState.containsKey(member.getEmail())) {
memberState.put(member.getEmail(), member);
listener.onChatRoomMemberAdded(member);
QiscusAndroidUtil.runOnBackgroundThread(() ->
QiscusCore.getDataStore().addOrUpdateRoomMember(qiscusChatRoom.getId(), member, qiscusChatRoom.getDistinctId()));
}
}
private void handleMemberRemoved(QiscusRoomMember member) {
if (memberState.remove(member.getEmail()) != null) {
listener.onChatRoomMemberRemoved(member);
QiscusAndroidUtil.runOnBackgroundThread(() ->
QiscusCore.getDataStore().deleteRoomMember(qiscusChatRoom.getId(), member.getEmail()));
}
}
public interface StateListener {
void onChatRoomNameChanged(String name);
void onChatRoomMemberAdded(QiscusRoomMember member);
void onChatRoomMemberRemoved(QiscusRoomMember member);
void onUserTypng(String email, boolean typing);
void onChangeLastDelivered(long lastDeliveredCommentId);
void onChangeLastRead(long lastReadCommentId);
}
}
| chat-core/src/main/java/com/qiscus/sdk/chat/core/presenter/QiscusChatRoomEventHandler.java | package com.qiscus.sdk.chat.core.presenter;
import com.qiscus.sdk.chat.core.QiscusCore;
import com.qiscus.sdk.chat.core.data.model.QiscusAccount;
import com.qiscus.sdk.chat.core.data.model.QiscusChatRoom;
import com.qiscus.sdk.chat.core.data.model.QiscusComment;
import com.qiscus.sdk.chat.core.data.model.QiscusRoomMember;
import com.qiscus.sdk.chat.core.data.remote.QiscusPusherApi;
import com.qiscus.sdk.chat.core.event.QiscusChatRoomEvent;
import com.qiscus.sdk.chat.core.util.QiscusAndroidUtil;
import com.qiscus.sdk.chat.core.util.QiscusRawDataExtractor;
import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.json.JSONException;
import org.json.JSONObject;
import java.util.HashMap;
import java.util.concurrent.TimeUnit;
/**
* @author Yuana [email protected]
* @since Jan, Fri 04 2019 14.34
* <p>
* ChatRoom Event Handler Class
**/
public class QiscusChatRoomEventHandler {
private QiscusAccount qiscusAccount;
private StateListener listener;
private QiscusChatRoom qiscusChatRoom;
private Runnable listenChatRoomTask;
private HashMap<String, QiscusRoomMember> memberState;
public QiscusChatRoomEventHandler(QiscusChatRoom qiscusChatRoom, StateListener listener) {
this.listener = listener;
this.qiscusAccount = QiscusCore.getQiscusAccount();
setChatRoom(qiscusChatRoom);
if (!EventBus.getDefault().isRegistered(this)) {
EventBus.getDefault().register(this);
}
this.listenChatRoomTask = this::listenChatRoomEvent;
QiscusAndroidUtil.runOnUIThread(listenChatRoomTask, TimeUnit.SECONDS.toMillis(1));
}
public void setChatRoom(QiscusChatRoom qiscusChatRoom) {
this.qiscusChatRoom = qiscusChatRoom;
setMemberState();
}
private void setMemberState() {
if (memberState == null) {
memberState = new HashMap<>();
} else {
memberState.clear();
}
if (qiscusChatRoom.getMember().isEmpty()) {
return;
}
for (QiscusRoomMember member : qiscusChatRoom.getMember()) {
memberState.put(member.getEmail(), member);
}
}
private void listenChatRoomEvent() {
QiscusPusherApi.getInstance().subscribeChatRoom(qiscusChatRoom);
}
public void detach() {
QiscusAndroidUtil.cancelRunOnUIThread(listenChatRoomTask);
QiscusPusherApi.getInstance().unsubsribeChatRoom(qiscusChatRoom);
EventBus.getDefault().unregister(this);
}
@Subscribe
public void onChatRoomEvent(QiscusChatRoomEvent event) {
QiscusAndroidUtil.runOnBackgroundThread(() -> handleEvent(event));
}
private void handleEvent(QiscusChatRoomEvent event) {
if (event.getRoomId() == qiscusChatRoom.getId()) {
switch (event.getEvent()) {
case TYPING:
listener.onUserTypng(event.getUser(), event.isTyping());
break;
case DELIVERED:
long lastDeliveredCommentId = event.getCommentId();
QiscusCore.getDataStore().updateLastDeliveredComment(qiscusChatRoom.getId(), lastDeliveredCommentId);
listener.onChangeLastDelivered(lastDeliveredCommentId);
break;
case READ:
long lastReadCommentId = event.getCommentId();
QiscusCore.getDataStore().updateLastReadComment(qiscusChatRoom.getId(), lastReadCommentId);
listener.onChangeLastRead(lastReadCommentId);
break;
}
}
}
public void onGotComment(QiscusComment qiscusComment) {
if (!qiscusComment.getSender().equals(qiscusAccount.getEmail())) {
// handle room event such s invite user, kick user
if (qiscusComment.getType() == QiscusComment.Type.SYSTEM_EVENT) {
handleChatRoomChanged(qiscusComment);
}
if (!QiscusCore.getEnableRealtime() && qiscusChatRoom.getId() == qiscusComment.getRoomId()) {
QiscusChatRoom room = QiscusCore.getDataStore().getChatRoom(qiscusChatRoom.getId());
if ( room.getLastComment().getState() == 2 ||
room.getLastComment().getState() == 3 ) {
QiscusCore.getDataStore().updateLastReadComment(qiscusChatRoom.getId(), qiscusComment.getId());
listener.onChangeLastRead(qiscusComment.getId());
}
}
}
}
private void handleChatRoomChanged(QiscusComment qiscusComment) {
try {
JSONObject payload = QiscusRawDataExtractor.getPayload(qiscusComment);
QiscusRoomMember member = new QiscusRoomMember();
switch (payload.optString("type")) {
case "add_member":
member.setEmail(payload.optString("object_email"));
member.setUsername(payload.optString("object_username"));
handleMemberAdded(member);
break;
case "join_room":
member.setEmail(payload.optString("subject_email"));
member.setUsername(payload.optString("subject_username"));
handleMemberAdded(member);
break;
case "remove_member":
member.setEmail(payload.optString("object_email"));
member.setUsername(payload.optString("object_username"));
handleMemberRemoved(member);
break;
case "left_room":
member.setEmail(payload.optString("subject_email"));
member.setUsername(payload.optString("subject_username"));
handleMemberRemoved(member);
break;
case "change_room_name":
listener.onChatRoomNameChanged(payload.optString("room_name"));
break;
}
} catch (JSONException e) {
//Do nothing
}
}
private void handleMemberAdded(QiscusRoomMember member) {
if (!memberState.containsKey(member.getEmail())) {
memberState.put(member.getEmail(), member);
listener.onChatRoomMemberAdded(member);
QiscusAndroidUtil.runOnBackgroundThread(() ->
QiscusCore.getDataStore().addOrUpdateRoomMember(qiscusChatRoom.getId(), member, qiscusChatRoom.getDistinctId()));
}
}
private void handleMemberRemoved(QiscusRoomMember member) {
if (memberState.remove(member.getEmail()) != null) {
listener.onChatRoomMemberRemoved(member);
QiscusAndroidUtil.runOnBackgroundThread(() ->
QiscusCore.getDataStore().deleteRoomMember(qiscusChatRoom.getId(), member.getEmail()));
}
}
public interface StateListener {
void onChatRoomNameChanged(String name);
void onChatRoomMemberAdded(QiscusRoomMember member);
void onChatRoomMemberRemoved(QiscusRoomMember member);
void onUserTypng(String email, boolean typing);
void onChangeLastDelivered(long lastDeliveredCommentId);
void onChangeLastRead(long lastReadCommentId);
}
}
| update feedback using QiscusComment.STATE_ON_QISCUS and QiscusComment.STATE_DELIVERED
| chat-core/src/main/java/com/qiscus/sdk/chat/core/presenter/QiscusChatRoomEventHandler.java | update feedback using QiscusComment.STATE_ON_QISCUS and QiscusComment.STATE_DELIVERED | <ide><path>hat-core/src/main/java/com/qiscus/sdk/chat/core/presenter/QiscusChatRoomEventHandler.java
<ide>
<ide> if (!QiscusCore.getEnableRealtime() && qiscusChatRoom.getId() == qiscusComment.getRoomId()) {
<ide> QiscusChatRoom room = QiscusCore.getDataStore().getChatRoom(qiscusChatRoom.getId());
<del> if ( room.getLastComment().getState() == 2 ||
<del> room.getLastComment().getState() == 3 ) {
<add> if ( room.getLastComment().getState() == QiscusComment.STATE_ON_QISCUS ||
<add> room.getLastComment().getState() == QiscusComment.STATE_DELIVERED ) {
<ide> QiscusCore.getDataStore().updateLastReadComment(qiscusChatRoom.getId(), qiscusComment.getId());
<ide> listener.onChangeLastRead(qiscusComment.getId());
<ide> } |
|
JavaScript | bsd-3-clause | b0ae094ef7596b842103c2d7c6362100e576cd44 | 0 | jkbrzt/rrule,jkbrzt/rrule | /**
* General date-related utilities.
* Also handles several incompatibilities between JavaScript and Python
*
*/
const dateutil = {
MONTH_DAYS: [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31],
/**
* Number of milliseconds of one day
*/
ONE_DAY: 1000 * 60 * 60 * 24,
/**
* @see: <http://docs.python.org/library/datetime.html#datetime.MAXYEAR>
*/
MAXYEAR: 9999,
/**
* Python uses 1-Jan-1 as the base for calculating ordinals but we don't
* want to confuse the JS engine with milliseconds > Number.MAX_NUMBER,
* therefore we use 1-Jan-1970 instead
*/
ORDINAL_BASE: new Date(1970, 0, 1),
/**
* Python: MO-SU: 0 - 6
* JS: SU-SAT 0 - 6
*/
PY_WEEKDAYS: [6, 0, 1, 2, 3, 4, 5],
/**
* py_date.timetuple()[7]
*/
getYearDay: function (date) {
const dateNoTime = new Date(
date.getFullYear(), date.getMonth(), date.getDate())
return Math.ceil(
(dateNoTime - new Date(date.getFullYear(), 0, 1)) / dateutil.ONE_DAY) + 1
},
isLeapYear: function (year) {
return ((year % 4 === 0) && (year % 100 !== 0)) || (year % 400 === 0)
},
/**
* @return {Number} the date's timezone offset in ms
*/
tzOffset: function (date) {
return date.getTimezoneOffset() * 60 * 1000
},
/**
* @see: <http://www.mcfedries.com/JavaScript/DaysBetween.asp>
*/
daysBetween: function (date1, date2) {
// The number of milliseconds in one day
// Convert both dates to milliseconds
const date1ms = date1.getTime() - dateutil.tzOffset(date1)
const date2ms = date2.getTime() - dateutil.tzOffset(date2)
// Calculate the difference in milliseconds
const differencems = date1ms - date2ms
// Convert back to days and return
return Math.round(differencems / dateutil.ONE_DAY)
},
/**
* @see: <http://docs.python.org/library/datetime.html#datetime.date.toordinal>
*/
toOrdinal: function (date) {
return dateutil.daysBetween(date, dateutil.ORDINAL_BASE)
},
/**
* @see - <http://docs.python.org/library/datetime.html#datetime.date.fromordinal>
*/
fromOrdinal: function (ordinal) {
return new Date(dateutil.ORDINAL_BASE.getTime() + (ordinal * dateutil.ONE_DAY))
},
/**
* @see: <http://docs.python.org/library/calendar.html#calendar.monthrange>
*/
monthRange: function (year, month) {
const date = new Date(year, month, 1)
return [dateutil.getWeekday(date), dateutil.getMonthDays(date)]
},
getMonthDays: function (date) {
const month = date.getMonth()
return month === 1 && dateutil.isLeapYear(date.getFullYear())
? 29 : dateutil.MONTH_DAYS[month]
},
/**
* @return {Number} python-like weekday
*/
getWeekday: function (date) {
return dateutil.PY_WEEKDAYS[date.getDay()]
},
/**
* @see: <http://docs.python.org/library/datetime.html#datetime.datetime.combine>
*/
combine: function (date, time) {
time = time || date
return new Date(
date.getFullYear(), date.getMonth(), date.getDate(),
time.getHours(), time.getMinutes(), time.getSeconds(),
time.getMilliseconds())
},
clone: function (date) {
const dolly = new Date(date.getTime())
return dolly
},
cloneDates: function (dates) {
const clones = []
for (let i = 0; i < dates.length; i++) {
clones.push(dateutil.clone(dates[i]))
}
return clones
},
/**
* Sorts an array of Date or dateutil.Time objects
*/
sort: function (dates) {
dates.sort(function (a, b) {
return a.getTime() - b.getTime()
})
},
timeToUntilString: function (time) {
let comp
const date = new Date(time)
const comps = [
date.getUTCFullYear(),
date.getUTCMonth() + 1,
date.getUTCDate(),
'T',
date.getUTCHours(),
date.getUTCMinutes(),
date.getUTCSeconds(),
'Z'
]
for (let i = 0; i < comps.length; i++) {
comp = comps[i]
if (!/[TZ]/.test(comp) && comp < 10) comps[i] = '0' + String(comp)
}
return comps.join('')
},
untilStringToDate: function (until) {
const re = /^(\d{4})(\d{2})(\d{2})(T(\d{2})(\d{2})(\d{2})Z?)?$/
const bits = re.exec(until)
if (!bits) throw new Error('Invalid UNTIL value: ' + until)
return new Date(Date.UTC(
bits[1],
bits[2] - 1,
bits[3],
bits[5] || 0,
bits[6] || 0,
bits[7] || 0))
}
}
class Time {
constructor (hour, minute, second, millisecond) {
this.hour = hour
this.minute = minute
this.second = second
this.millisecond = millisecond || 0
}
getHours () {
return this.hour
}
getMinutes () {
return this.minute
}
getSeconds () {
return this.second
}
getMilliseconds () {
return this.millisecond
}
getTime () {
return ((this.hour * 60 * 60) + (this.minute * 60) + this.second) * 1000 +
this.millisecond
}
}
dateutil.Time = Time
export default dateutil
| src/dateutil.js | /**
* General date-related utilities.
* Also handles several incompatibilities between JavaScript and Python
*
*/
const dateutil = {
MONTH_DAYS: [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31],
/**
* Number of milliseconds of one day
*/
ONE_DAY: 1000 * 60 * 60 * 24,
/**
* @see: <http://docs.python.org/library/datetime.html#datetime.MAXYEAR>
*/
MAXYEAR: 9999,
/**
* Python uses 1-Jan-1 as the base for calculating ordinals but we don't
* want to confuse the JS engine with milliseconds > Number.MAX_NUMBER,
* therefore we use 1-Jan-1970 instead
*/
ORDINAL_BASE: new Date(1970, 0, 1),
/**
* Python: MO-SU: 0 - 6
* JS: SU-SAT 0 - 6
*/
PY_WEEKDAYS: [6, 0, 1, 2, 3, 4, 5],
/**
* py_date.timetuple()[7]
*/
getYearDay: function (date) {
const dateNoTime = new Date(
date.getFullYear(), date.getMonth(), date.getDate())
return Math.ceil(
(dateNoTime - new Date(date.getFullYear(), 0, 1)) / dateutil.ONE_DAY) + 1
},
isLeapYear: function (year) {
return ((year % 4 === 0) && (year % 100 !== 0)) || (year % 400 === 0)
},
/**
* @return {Number} the date's timezone offset in ms
*/
tzOffset: function (date) {
return date.getTimezoneOffset() * 60 * 1000
},
/**
* @see: <http://www.mcfedries.com/JavaScript/DaysBetween.asp>
*/
daysBetween: function (date1, date2) {
// The number of milliseconds in one day
// Convert both dates to milliseconds
const date1ms = date1.getTime() - dateutil.tzOffset(date1)
const date2ms = date2.getTime() - dateutil.tzOffset(date2)
// Calculate the difference in milliseconds
const differencems = date1ms - date2ms
// Convert back to days and return
return Math.round(differencems / dateutil.ONE_DAY)
},
/**
* @see: <http://docs.python.org/library/datetime.html#datetime.date.toordinal>
*/
toOrdinal: function (date) {
return dateutil.daysBetween(date, dateutil.ORDINAL_BASE)
},
/**
* @see - <http://docs.python.org/library/datetime.html#datetime.date.fromordinal>
*/
fromOrdinal: function (ordinal) {
const millisecsFromBase = ordinal * dateutil.ONE_DAY
return new Date(dateutil.ORDINAL_BASE.getTime() -
dateutil.tzOffset(dateutil.ORDINAL_BASE) +
millisecsFromBase +
dateutil.tzOffset(new Date(millisecsFromBase)))
},
/**
* @see: <http://docs.python.org/library/calendar.html#calendar.monthrange>
*/
monthRange: function (year, month) {
const date = new Date(year, month, 1)
return [dateutil.getWeekday(date), dateutil.getMonthDays(date)]
},
getMonthDays: function (date) {
const month = date.getMonth()
return month === 1 && dateutil.isLeapYear(date.getFullYear())
? 29 : dateutil.MONTH_DAYS[month]
},
/**
* @return {Number} python-like weekday
*/
getWeekday: function (date) {
return dateutil.PY_WEEKDAYS[date.getDay()]
},
/**
* @see: <http://docs.python.org/library/datetime.html#datetime.datetime.combine>
*/
combine: function (date, time) {
time = time || date
return new Date(
date.getFullYear(), date.getMonth(), date.getDate(),
time.getHours(), time.getMinutes(), time.getSeconds(),
time.getMilliseconds())
},
clone: function (date) {
const dolly = new Date(date.getTime())
return dolly
},
cloneDates: function (dates) {
const clones = []
for (let i = 0; i < dates.length; i++) {
clones.push(dateutil.clone(dates[i]))
}
return clones
},
/**
* Sorts an array of Date or dateutil.Time objects
*/
sort: function (dates) {
dates.sort(function (a, b) {
return a.getTime() - b.getTime()
})
},
timeToUntilString: function (time) {
let comp
const date = new Date(time)
const comps = [
date.getUTCFullYear(),
date.getUTCMonth() + 1,
date.getUTCDate(),
'T',
date.getUTCHours(),
date.getUTCMinutes(),
date.getUTCSeconds(),
'Z'
]
for (let i = 0; i < comps.length; i++) {
comp = comps[i]
if (!/[TZ]/.test(comp) && comp < 10) comps[i] = '0' + String(comp)
}
return comps.join('')
},
untilStringToDate: function (until) {
const re = /^(\d{4})(\d{2})(\d{2})(T(\d{2})(\d{2})(\d{2})Z?)?$/
const bits = re.exec(until)
if (!bits) throw new Error('Invalid UNTIL value: ' + until)
return new Date(Date.UTC(
bits[1],
bits[2] - 1,
bits[3],
bits[5] || 0,
bits[6] || 0,
bits[7] || 0))
}
}
class Time {
constructor (hour, minute, second, millisecond) {
this.hour = hour
this.minute = minute
this.second = second
this.millisecond = millisecond || 0
}
getHours () {
return this.hour
}
getMinutes () {
return this.minute
}
getSeconds () {
return this.second
}
getMilliseconds () {
return this.millisecond
}
getTime () {
return ((this.hour * 60 * 60) + (this.minute * 60) + this.second) * 1000 +
this.millisecond
}
}
dateutil.Time = Time
export default dateutil
| removed time zone offset from fromOrdinal method
In dateutil.js, the method fromOrdinal (lines 77-83) does not need to subtract and then re-add the time zone offset. When the time zone of the ORINDAL_BASE and passed in ordinal value are the same, the net result is 0 anyway. But in the case of time zones that go on and off daylight savings time, like Eastern time zone, the time zone offset for the ORDINAL_BASE and the time zone offset for the passed in ordinal value will be different when the ordinal date is in daylight savings and the ORDINAL_BASE is not, resulting in a date value that is 1 hour less than what it should be. | src/dateutil.js | removed time zone offset from fromOrdinal method | <ide><path>rc/dateutil.js
<ide> * @see - <http://docs.python.org/library/datetime.html#datetime.date.fromordinal>
<ide> */
<ide> fromOrdinal: function (ordinal) {
<del> const millisecsFromBase = ordinal * dateutil.ONE_DAY
<del> return new Date(dateutil.ORDINAL_BASE.getTime() -
<del> dateutil.tzOffset(dateutil.ORDINAL_BASE) +
<del> millisecsFromBase +
<del> dateutil.tzOffset(new Date(millisecsFromBase)))
<add> return new Date(dateutil.ORDINAL_BASE.getTime() + (ordinal * dateutil.ONE_DAY))
<ide> },
<ide>
<ide> /** |
|
Java | lgpl-2.1 | 94e7ba3a1d1cd759b1a44c3419ce8b03f207f9c8 | 0 | lhanson/checkstyle,maddingo/checkstyle,lhanson/checkstyle,maddingo/checkstyle | package com.puppycrawl.tools.checkstyle.checks;
import java.util.Stack;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.JavaTokenTypes;
// TODO: need to create a class to represent the constants in JavaTokenTypes.
// Needed to break circular dependencies
public class RedundantModifierCheck extends Check implements JavaTokenTypes
{
private final Stack mInInterface = new Stack();
public void beginTree()
{
super.beginTree();
mInInterface.clear();
}
public int[] getDefaultTokens()
{
return new int[] {MODIFIERS, INTERFACE_DEF, CLASS_DEF};
}
public void visitToken(DetailAST aAST)
{
switch (aAST.getType())
{
case INTERFACE_DEF:
mInInterface.push(Boolean.TRUE);
break;
case CLASS_DEF:
mInInterface.push(Boolean.FALSE);
break;
case MODIFIERS:
// modifiers of the interface itself (public interface X)
// will be below the INTERFACE_DEF node. Example:
// public interface X {void y();}
// INTERFACE_DEF
// + MODUFIERS
// + public
// + OBJ_BLOCK
// + ...
if (inInterfaceBlock(aAST)) {
DetailAST ast = (DetailAST) aAST.getFirstChild();
while (ast != null) {
String modifier = ast.getText();
if ("public".equals(modifier)
|| "abstract".equals(modifier))
{
log(ast.getLineNo(),
ast.getColumnNo(),
"redundantModifier",
new String[] {modifier});
}
ast = (DetailAST) ast.getNextSibling();
}
}
break;
default:
return;
}
}
/** @return whether currently in an interface block,
* i.e. in an OBJ_BLOCK of an INTERFACE_DEF
*/
private boolean inInterfaceBlock(DetailAST aAST)
{
if (mInInterface.empty()) {
return false;
}
if (aAST.getParent().getType() == INTERFACE_DEF) {
int size = mInInterface.size();
return size > 1 && Boolean.TRUE.equals(mInInterface.get(size - 2));
}
else {
return Boolean.TRUE.equals(mInInterface.peek());
}
}
}
| src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RedundantModifierCheck.java | package com.puppycrawl.tools.checkstyle.checks;
import java.util.Stack;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.JavaTokenTypes;
public class RedundantModifierCheck extends Check implements JavaTokenTypes
{
private final Stack mInInterface = new Stack();
public void beginTree()
{
super.beginTree();
mInInterface.clear();
}
public int[] getDefaultTokens()
{
return new int[] {MODIFIERS, INTERFACE_DEF, CLASS_DEF};
}
public void visitToken(DetailAST aAST)
{
switch (aAST.getType())
{
case INTERFACE_DEF:
mInInterface.push(Boolean.TRUE);
break;
case CLASS_DEF:
mInInterface.push(Boolean.FALSE);
break;
case MODIFIERS:
// modifiers of the interface itself (public interface X)
// will be below the INTERFACE_DEF node. Example:
// public interface X {void y();}
// INTERFACE_DEF
// + MODUFIERS
// + public
// + OBJ_BLOCK
// + ...
if (inInterfaceBlock(aAST)) {
DetailAST ast = (DetailAST) aAST.getFirstChild();
while (ast != null) {
String modifier = ast.getText();
if ("public".equals(modifier)
|| "abstract".equals(modifier))
{
log(ast.getLineNo(),
ast.getColumnNo(),
"redundantModifier",
new String[] {modifier});
}
ast = (DetailAST) ast.getNextSibling();
}
}
break;
default:
return;
}
}
/** @return whether currently in an interface block,
* i.e. in an OBJ_BLOCK of an INTERFACE_DEF
*/
private boolean inInterfaceBlock(DetailAST aAST)
{
if (mInInterface.empty()) {
return false;
}
if (aAST.getParent().getType() == INTERFACE_DEF) {
int size = mInInterface.size();
return size > 1 && Boolean.TRUE.equals(mInInterface.get(size - 2));
}
else {
return Boolean.TRUE.equals(mInInterface.peek());
}
}
}
| added reminder
| src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RedundantModifierCheck.java | added reminder | <ide><path>rc/checkstyle/com/puppycrawl/tools/checkstyle/checks/RedundantModifierCheck.java
<ide> import com.puppycrawl.tools.checkstyle.api.DetailAST;
<ide> import com.puppycrawl.tools.checkstyle.JavaTokenTypes;
<ide>
<add>// TODO: need to create a class to represent the constants in JavaTokenTypes.
<add>// Needed to break circular dependencies
<ide> public class RedundantModifierCheck extends Check implements JavaTokenTypes
<ide> {
<ide> private final Stack mInInterface = new Stack(); |
|
Java | mit | 111925ba17e95e5001e6282a9f8d98ba0d566164 | 0 | HSR-Challenge-Projekt-2014/AndroidApp | package ch.hsr.challp.museum;
import android.app.Activity;
import android.app.Fragment;
import android.content.res.Configuration;
import android.os.Bundle;
import android.support.v4.app.ActionBarDrawerToggle;
import android.support.v4.widget.DrawerLayout;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemClickListener;
import android.widget.ListAdapter;
import android.widget.ListView;
import java.util.ArrayList;
import java.util.List;
import ch.hsr.challp.museum.adapter.NavDrawerListAdapter;
import ch.hsr.challp.museum.model.NavDrawerItem;
public class HomeActivity extends Activity {
public static final int SECTION_GUIDE = 0;
public static final int SECTION_QUESTION = 1;
public static final int SECTION_READ_LATER = 2;
public static final int SECTION_INFORMATION = 3;
private String[] titles;
private DrawerLayout dLayout;
private ListView dList;
private ListAdapter adapter;
private ActionBarDrawerToggle dToggle;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_home);
titles = new String[]{getString(R.string.title_companion), getString(R.string.title_question), getString(R.string.title_read_later), getString(R.string.title_about)};
dLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
dList = (ListView) findViewById(R.id.left_drawer_list);
List<NavDrawerItem> items = new ArrayList<>();
items.add(new NavDrawerItem(getString(R.string.title_companion), R.drawable.ic_guide));
items.add(new NavDrawerItem(getString(R.string.title_question), R.drawable.ic_question));
items.add(new NavDrawerItem(getString(R.string.title_read_later), R.drawable.ic_read_later));
items.add(new NavDrawerItem(getString(R.string.title_about), R.drawable.ic_information));
adapter = new NavDrawerListAdapter(getApplicationContext(), items);
dList.setAdapter(adapter);
dList.setOnItemClickListener(new OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> arg0, View v, int position, long id) {
dLayout.closeDrawers();
showContent(position);
}
});
dToggle = new ActionBarDrawerToggle(this, dLayout,
R.drawable.ic_drawer, R.string.drawer_open, R.string.drawer_close) {
/**
* Called when a drawer has settled in a completely closed state.
*/
public void onDrawerClosed(View view) {
super.onDrawerClosed(view);
invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
}
/**
* Called when a drawer has settled in a completely open state.
*/
public void onDrawerOpened(View drawerView) {
super.onDrawerOpened(drawerView);
invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
}
};
dLayout.setDrawerListener(dToggle);
if (getActionBar() != null) {
getActionBar().setDisplayHomeAsUpEnabled(true);
getActionBar().setHomeButtonEnabled(true);
}
showContent(0);
}
@Override
protected void onPostCreate(Bundle savedInstanceState) {
super.onPostCreate(savedInstanceState);
// Sync the toggle state after onRestoreInstanceState has occurred.
dToggle.syncState();
}
@Override
public void onConfigurationChanged(Configuration newConfig) {
super.onConfigurationChanged(newConfig);
dToggle.onConfigurationChanged(newConfig);
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
// Pass the event to ActionBarDrawerToggle, if it returns
// true, then it has handled the app icon touch event
if (dToggle.onOptionsItemSelected(item)) {
return true;
}
// Handle your other action bar items...
return super.onOptionsItemSelected(item);
}
private void showContent(int position) {
Fragment fragment;
if (position == SECTION_GUIDE) {
fragment = new GuideFragment();
} else if (position == SECTION_QUESTION) {
fragment = new QuestionFragment();
} else {
Bundle args = new Bundle();
args.putString("Menu", titles[position]);
fragment = new DetailFragment();
fragment.setArguments(args);
}
setTitleByFragment(position);
getFragmentManager().beginTransaction().replace(R.id.content_frame, fragment).addToBackStack("").commit();
dList.setItemChecked(position, true);
dList.setSelection(position);
}
private void setTitleByFragment(int position) {
String title = titles[position];
if (getActionBar() != null) getActionBar().setTitle(title);
}
}
| app/src/main/java/ch/hsr/challp/museum/HomeActivity.java | package ch.hsr.challp.museum;
import android.app.ActionBar;
import android.app.Activity;
import android.app.Fragment;
import android.content.res.Configuration;
import android.os.Bundle;
import android.support.v4.app.ActionBarDrawerToggle;
import android.support.v4.widget.DrawerLayout;
import android.view.MenuItem;
import android.view.View;
import android.widget.AdapterView;
import android.widget.AdapterView.OnItemClickListener;
import android.widget.ListAdapter;
import android.widget.ListView;
import java.util.ArrayList;
import java.util.List;
import ch.hsr.challp.museum.adapter.NavDrawerListAdapter;
import ch.hsr.challp.museum.model.NavDrawerItem;
public class HomeActivity extends Activity {
private String[] menu;
private DrawerLayout dLayout;
private ActionBarDrawerToggle dToggle;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ListView dList;
ListAdapter adapter;
setContentView(R.layout.activity_home);
menu = new String[]{"Begleiter", "Fragen ans Museum", "Read at Home"};
dLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
dList = (ListView) findViewById(R.id.left_drawer_list);
List<NavDrawerItem> items = new ArrayList<>();
items.add(new NavDrawerItem(getString(R.string.title_companion), R.drawable.ic_guide));
items.add(new NavDrawerItem(getString(R.string.title_question), R.drawable.ic_question));
items.add(new NavDrawerItem(getString(R.string.title_read_later), R.drawable.ic_read_later));
items.add(new NavDrawerItem(getString(R.string.title_about), R.drawable.ic_information));
adapter = new NavDrawerListAdapter(getApplicationContext(), items);
dList.setAdapter(adapter);
dList.setOnItemClickListener(new OnItemClickListener() {
@Override
public void onItemClick(AdapterView<?> arg0, View v, int position, long id) {
dLayout.closeDrawers();
showContent(position);
}
});
dToggle = new ActionBarDrawerToggle(this, dLayout,
R.drawable.ic_drawer, R.string.drawer_open, R.string.drawer_close) {
/**
* Called when a drawer has settled in a completely closed state.
*/
public void onDrawerClosed(View view) {
super.onDrawerClosed(view);
invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
}
/**
* Called when a drawer has settled in a completely open state.
*/
public void onDrawerOpened(View drawerView) {
super.onDrawerOpened(drawerView);
invalidateOptionsMenu(); // creates call to onPrepareOptionsMenu()
}
};
dLayout.setDrawerListener(dToggle);
final ActionBar actionBar = getActionBar();
if (actionBar != null) {
actionBar.setDisplayHomeAsUpEnabled(true);
actionBar.setHomeButtonEnabled(true);
}
showContent(0);
}
@Override
protected void onPostCreate(Bundle savedInstanceState) {
super.onPostCreate(savedInstanceState);
// Sync the toggle state after onRestoreInstanceState has occurred.
dToggle.syncState();
}
@Override
public void onConfigurationChanged(Configuration newConfig) {
super.onConfigurationChanged(newConfig);
dToggle.onConfigurationChanged(newConfig);
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
// Pass the event to ActionBarDrawerToggle, if it returns
// true, then it has handled the app icon touch event
if (dToggle.onOptionsItemSelected(item)) {
return true;
}
// Handle your other action bar items...
return super.onOptionsItemSelected(item);
}
private void showContent(int position) {
Fragment fragment;
String title = menu[position];
if (position == 0) {
fragment = new GuideFragment();
} else if (position == 1) {
fragment = new QuestionFragment();
} else {
Bundle args = new Bundle();
args.putString("Menu", menu[position]);
fragment = new DetailFragment();
fragment.setArguments(args);
}
if (getActionBar() != null) {
getActionBar().setTitle(title);
}
getFragmentManager().beginTransaction().replace(R.id.content_frame, fragment).addToBackStack("").commit();
}
}
| issue #1 - action bar title refactorings
| app/src/main/java/ch/hsr/challp/museum/HomeActivity.java | issue #1 - action bar title refactorings | <ide><path>pp/src/main/java/ch/hsr/challp/museum/HomeActivity.java
<ide> package ch.hsr.challp.museum;
<ide>
<del>import android.app.ActionBar;
<ide> import android.app.Activity;
<ide> import android.app.Fragment;
<ide> import android.content.res.Configuration;
<ide> import android.os.Bundle;
<ide> import android.support.v4.app.ActionBarDrawerToggle;
<ide> import android.support.v4.widget.DrawerLayout;
<add>import android.view.Menu;
<ide> import android.view.MenuItem;
<ide> import android.view.View;
<ide> import android.widget.AdapterView;
<ide> import ch.hsr.challp.museum.model.NavDrawerItem;
<ide>
<ide> public class HomeActivity extends Activity {
<del> private String[] menu;
<add> public static final int SECTION_GUIDE = 0;
<add> public static final int SECTION_QUESTION = 1;
<add> public static final int SECTION_READ_LATER = 2;
<add> public static final int SECTION_INFORMATION = 3;
<add> private String[] titles;
<ide> private DrawerLayout dLayout;
<add> private ListView dList;
<add> private ListAdapter adapter;
<ide> private ActionBarDrawerToggle dToggle;
<ide>
<ide> @Override
<ide> protected void onCreate(Bundle savedInstanceState) {
<ide> super.onCreate(savedInstanceState);
<del> ListView dList;
<del> ListAdapter adapter;
<ide> setContentView(R.layout.activity_home);
<del> menu = new String[]{"Begleiter", "Fragen ans Museum", "Read at Home"};
<add> titles = new String[]{getString(R.string.title_companion), getString(R.string.title_question), getString(R.string.title_read_later), getString(R.string.title_about)};
<ide> dLayout = (DrawerLayout) findViewById(R.id.drawer_layout);
<ide> dList = (ListView) findViewById(R.id.left_drawer_list);
<ide> List<NavDrawerItem> items = new ArrayList<>();
<ide> };
<ide> dLayout.setDrawerListener(dToggle);
<ide>
<del> final ActionBar actionBar = getActionBar();
<del> if (actionBar != null) {
<del> actionBar.setDisplayHomeAsUpEnabled(true);
<del> actionBar.setHomeButtonEnabled(true);
<add> if (getActionBar() != null) {
<add> getActionBar().setDisplayHomeAsUpEnabled(true);
<add> getActionBar().setHomeButtonEnabled(true);
<ide> }
<ide>
<ide> showContent(0);
<ide>
<ide> private void showContent(int position) {
<ide> Fragment fragment;
<del> String title = menu[position];
<del> if (position == 0) {
<add> if (position == SECTION_GUIDE) {
<ide> fragment = new GuideFragment();
<del> } else if (position == 1) {
<add> } else if (position == SECTION_QUESTION) {
<ide> fragment = new QuestionFragment();
<ide> } else {
<ide> Bundle args = new Bundle();
<del> args.putString("Menu", menu[position]);
<add> args.putString("Menu", titles[position]);
<ide> fragment = new DetailFragment();
<ide> fragment.setArguments(args);
<ide> }
<del> if (getActionBar() != null) {
<del> getActionBar().setTitle(title);
<del> }
<add> setTitleByFragment(position);
<ide> getFragmentManager().beginTransaction().replace(R.id.content_frame, fragment).addToBackStack("").commit();
<add> dList.setItemChecked(position, true);
<add> dList.setSelection(position);
<add> }
<add>
<add> private void setTitleByFragment(int position) {
<add> String title = titles[position];
<add> if (getActionBar() != null) getActionBar().setTitle(title);
<ide> }
<ide>
<ide> } |
|
Java | apache-2.0 | 80ede648e37a3855d9ef681e18bc7a963390c5cc | 0 | jcshen007/cloudstack,GabrielBrascher/cloudstack,jcshen007/cloudstack,GabrielBrascher/cloudstack,resmo/cloudstack,GabrielBrascher/cloudstack,cinderella/incubator-cloudstack,argv0/cloudstack,jcshen007/cloudstack,jcshen007/cloudstack,DaanHoogland/cloudstack,mufaddalq/cloudstack-datera-driver,argv0/cloudstack,mufaddalq/cloudstack-datera-driver,DaanHoogland/cloudstack,jcshen007/cloudstack,resmo/cloudstack,GabrielBrascher/cloudstack,wido/cloudstack,cinderella/incubator-cloudstack,resmo/cloudstack,argv0/cloudstack,DaanHoogland/cloudstack,mufaddalq/cloudstack-datera-driver,GabrielBrascher/cloudstack,mufaddalq/cloudstack-datera-driver,cinderella/incubator-cloudstack,GabrielBrascher/cloudstack,wido/cloudstack,wido/cloudstack,DaanHoogland/cloudstack,DaanHoogland/cloudstack,resmo/cloudstack,wido/cloudstack,resmo/cloudstack,DaanHoogland/cloudstack,jcshen007/cloudstack,mufaddalq/cloudstack-datera-driver,cinderella/incubator-cloudstack,cinderella/incubator-cloudstack,GabrielBrascher/cloudstack,argv0/cloudstack,DaanHoogland/cloudstack,resmo/cloudstack,wido/cloudstack,resmo/cloudstack,wido/cloudstack,jcshen007/cloudstack,argv0/cloudstack,wido/cloudstack,mufaddalq/cloudstack-datera-driver,argv0/cloudstack | /**
* Copyright (C) 2010 Cloud.com, Inc. All rights reserved.
*
* This software is licensed under the GNU General Public License v3 or later.
*
* It is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package com.cloud.vm.dao;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
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 javax.ejb.Local;
import org.apache.log4j.Logger;
import com.cloud.api.ApiDBUtils;
import com.cloud.api.response.NicResponse;
import com.cloud.api.response.SecurityGroupResponse;
import com.cloud.api.response.UserVmResponse;
import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.utils.component.ComponentLocator;
import com.cloud.utils.db.Attribute;
import com.cloud.utils.db.GenericDaoBase;
import com.cloud.utils.db.GenericSearchBuilder;
import com.cloud.utils.db.JoinBuilder;
import com.cloud.utils.db.SearchBuilder;
import com.cloud.utils.db.SearchCriteria;
import com.cloud.utils.db.SearchCriteria.Func;
import com.cloud.utils.db.Transaction;
import com.cloud.utils.exception.CloudRuntimeException;
import com.cloud.vm.NicVO;
import com.cloud.vm.UserVmVO;
import com.cloud.vm.VirtualMachine;
import com.cloud.vm.VirtualMachine.State;
@Local(value={UserVmDao.class})
public class UserVmDaoImpl extends GenericDaoBase<UserVmVO, Long> implements UserVmDao {
public static final Logger s_logger = Logger.getLogger(UserVmDaoImpl.class);
protected final SearchBuilder<UserVmVO> AccountPodSearch;
protected final SearchBuilder<UserVmVO> AccountDataCenterSearch;
protected final SearchBuilder<UserVmVO> AccountSearch;
protected final SearchBuilder<UserVmVO> HostSearch;
protected final SearchBuilder<UserVmVO> LastHostSearch;
protected final SearchBuilder<UserVmVO> HostUpSearch;
protected final SearchBuilder<UserVmVO> HostRunningSearch;
protected final SearchBuilder<UserVmVO> StateChangeSearch;
protected final SearchBuilder<UserVmVO> AccountHostSearch;
protected final SearchBuilder<UserVmVO> DestroySearch;
protected SearchBuilder<UserVmVO> AccountDataCenterVirtualSearch;
protected GenericSearchBuilder<UserVmVO, Long> CountByAccountPod;
protected GenericSearchBuilder<UserVmVO, Long> CountByAccount;
protected GenericSearchBuilder<UserVmVO, Long> PodsHavingVmsForAccount;
protected SearchBuilder<UserVmVO> UserVmSearch;
protected final Attribute _updateTimeAttr;
private static final String LIST_PODS_HAVING_VMS_FOR_ACCOUNT = "SELECT pod_id FROM cloud.vm_instance WHERE data_center_id = ? AND account_id = ? AND pod_id IS NOT NULL AND state = 'Running' OR state = 'Stopped' " +
"GROUP BY pod_id HAVING count(id) > 0 ORDER BY count(id) DESC";
private static final String VM_DETAILS = "select account.account_name, account.type, domain.name, instance_group.id, instance_group.name," +
"data_center.id, data_center.name, data_center.is_security_group_enabled, host.id, host.name, " +
"vm_template.id, vm_template.name, vm_template.display_text, iso.id, iso.name, " +
"vm_template.enable_password, service_offering.id, disk_offering.name, storage_pool.id, storage_pool.pool_type, " +
"service_offering.cpu, service_offering.speed, service_offering.ram_size, volumes.id, volumes.device_id, volumes.volume_type, security_group.id, security_group.name, " +
"security_group.description, nics.id, nics.ip4_address, nics.gateway, nics.network_id, nics.netmask, nics.mac_address, nics.broadcast_uri, nics.isolation_uri, " +
"networks.traffic_type, networks.guest_type, networks.is_default from vm_instance " +
"left join account on vm_instance.account_id=account.id " +
"left join domain on vm_instance.domain_id=domain.id " +
"left join instance_group_vm_map on vm_instance.id=instance_group_vm_map.instance_id " +
"left join instance_group on instance_group_vm_map.group_id=instance_group.id " +
"left join data_center on vm_instance.data_center_id=data_center.id " +
"left join host on vm_instance.host_id=host.id " +
"left join vm_template on vm_instance.vm_template_id=vm_template.id " +
"left join vm_template iso on iso.id=? " +
"left join service_offering on vm_instance.service_offering_id=service_offering.id " +
"left join disk_offering on vm_instance.service_offering_id=disk_offering.id " +
"left join volumes on vm_instance.id=volumes.instance_id " +
"left join storage_pool on volumes.pool_id=storage_pool.id " +
"left join security_group_vm_map on vm_instance.id=security_group_vm_map.instance_id " +
"left join security_group on security_group_vm_map.security_group_id=security_group.id " +
"left join nics on vm_instance.id=nics.instance_id " +
"left join networks on nics.network_id=networks.id " +
"where vm_instance.id=?";
protected final UserVmDetailsDaoImpl _detailsDao = ComponentLocator.inject(UserVmDetailsDaoImpl.class);
protected UserVmDaoImpl() {
AccountSearch = createSearchBuilder();
AccountSearch.and("account", AccountSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountSearch.done();
HostSearch = createSearchBuilder();
HostSearch.and("host", HostSearch.entity().getHostId(), SearchCriteria.Op.EQ);
HostSearch.done();
LastHostSearch = createSearchBuilder();
LastHostSearch.and("lastHost", LastHostSearch.entity().getLastHostId(), SearchCriteria.Op.EQ);
LastHostSearch.and("state", LastHostSearch.entity().getState(), SearchCriteria.Op.EQ);
LastHostSearch.done();
HostUpSearch = createSearchBuilder();
HostUpSearch.and("host", HostUpSearch.entity().getHostId(), SearchCriteria.Op.EQ);
HostUpSearch.and("states", HostUpSearch.entity().getState(), SearchCriteria.Op.NIN);
HostUpSearch.done();
HostRunningSearch = createSearchBuilder();
HostRunningSearch.and("host", HostRunningSearch.entity().getHostId(), SearchCriteria.Op.EQ);
HostRunningSearch.and("state", HostRunningSearch.entity().getState(), SearchCriteria.Op.EQ);
HostRunningSearch.done();
AccountPodSearch = createSearchBuilder();
AccountPodSearch.and("account", AccountPodSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountPodSearch.and("pod", AccountPodSearch.entity().getPodIdToDeployIn(), SearchCriteria.Op.EQ);
AccountPodSearch.done();
AccountDataCenterSearch = createSearchBuilder();
AccountDataCenterSearch.and("account", AccountDataCenterSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountDataCenterSearch.and("dc", AccountDataCenterSearch.entity().getDataCenterIdToDeployIn(), SearchCriteria.Op.EQ);
AccountDataCenterSearch.done();
StateChangeSearch = createSearchBuilder();
StateChangeSearch.and("id", StateChangeSearch.entity().getId(), SearchCriteria.Op.EQ);
StateChangeSearch.and("states", StateChangeSearch.entity().getState(), SearchCriteria.Op.EQ);
StateChangeSearch.and("host", StateChangeSearch.entity().getHostId(), SearchCriteria.Op.EQ);
StateChangeSearch.and("update", StateChangeSearch.entity().getUpdated(), SearchCriteria.Op.EQ);
StateChangeSearch.done();
DestroySearch = createSearchBuilder();
DestroySearch.and("state", DestroySearch.entity().getState(), SearchCriteria.Op.IN);
DestroySearch.and("updateTime", DestroySearch.entity().getUpdateTime(), SearchCriteria.Op.LT);
DestroySearch.done();
AccountHostSearch = createSearchBuilder();
AccountHostSearch.and("accountId", AccountHostSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountHostSearch.and("hostId", AccountHostSearch.entity().getHostId(), SearchCriteria.Op.EQ);
AccountHostSearch.done();
CountByAccountPod = createSearchBuilder(Long.class);
CountByAccountPod.select(null, Func.COUNT, null);
CountByAccountPod.and("account", CountByAccountPod.entity().getAccountId(), SearchCriteria.Op.EQ);
CountByAccountPod.and("pod", CountByAccountPod.entity().getPodIdToDeployIn(), SearchCriteria.Op.EQ);
CountByAccountPod.done();
CountByAccount = createSearchBuilder(Long.class);
CountByAccount.select(null, Func.COUNT, null);
CountByAccount.and("account", CountByAccount.entity().getAccountId(), SearchCriteria.Op.EQ);
CountByAccount.and("type", CountByAccount.entity().getType(), SearchCriteria.Op.EQ);
CountByAccount.and("state", CountByAccount.entity().getState(), SearchCriteria.Op.NIN);
CountByAccount.done();
_updateTimeAttr = _allAttributes.get("updateTime");
assert _updateTimeAttr != null : "Couldn't get this updateTime attribute";
}
@Override
public List<UserVmVO> listByAccountAndPod(long accountId, long podId) {
SearchCriteria<UserVmVO> sc = AccountPodSearch.create();
sc.setParameters("account", accountId);
sc.setParameters("pod", podId);
return listIncludingRemovedBy(sc);
}
@Override
public List<UserVmVO> listByAccountAndDataCenter(long accountId, long dcId) {
SearchCriteria<UserVmVO> sc = AccountDataCenterSearch.create();
sc.setParameters("account", accountId);
sc.setParameters("dc", dcId);
return listIncludingRemovedBy(sc);
}
@Override
public void updateVM(long id, String displayName, boolean enable, Long osTypeId, String userData) {
UserVmVO vo = createForUpdate();
vo.setDisplayName(displayName);
vo.setHaEnabled(enable);
vo.setGuestOSId(osTypeId);
vo.setUserData(userData);
update(id, vo);
}
@Override
public List<UserVmVO> findDestroyedVms(Date date) {
SearchCriteria<UserVmVO> sc = DestroySearch.create();
sc.setParameters("state", State.Destroyed, State.Expunging, State.Error);
sc.setParameters("updateTime", date);
return listBy(sc);
}
@Override
public List<UserVmVO> listByAccountId(long id) {
SearchCriteria<UserVmVO> sc = AccountSearch.create();
sc.setParameters("account", id);
return listBy(sc);
}
@Override
public List<UserVmVO> listByHostId(Long id) {
SearchCriteria<UserVmVO> sc = HostSearch.create();
sc.setParameters("host", id);
return listBy(sc);
}
@Override
public List<UserVmVO> listUpByHostId(Long hostId) {
SearchCriteria<UserVmVO> sc = HostUpSearch.create();
sc.setParameters("host", hostId);
sc.setParameters("states", new Object[] {State.Destroyed, State.Stopped, State.Expunging});
return listBy(sc);
}
@Override
public List<UserVmVO> listRunningByHostId(long hostId) {
SearchCriteria<UserVmVO> sc = HostRunningSearch.create();
sc.setParameters("host", hostId);
sc.setParameters("state", State.Running);
return listBy(sc);
}
@Override
public List<UserVmVO> listVirtualNetworkInstancesByAcctAndZone(long accountId, long dcId, long networkId) {
if (AccountDataCenterVirtualSearch == null) {
NicDao _nicDao = ComponentLocator.getLocator("management-server").getDao(NicDao.class);
SearchBuilder<NicVO> nicSearch = _nicDao.createSearchBuilder();
nicSearch.and("networkId", nicSearch.entity().getNetworkId(), SearchCriteria.Op.EQ);
nicSearch.and("ip4Address", nicSearch.entity().getIp4Address(), SearchCriteria.Op.NNULL);
AccountDataCenterVirtualSearch = createSearchBuilder();
AccountDataCenterVirtualSearch.and("account", AccountDataCenterVirtualSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountDataCenterVirtualSearch.and("dc", AccountDataCenterVirtualSearch.entity().getDataCenterIdToDeployIn(), SearchCriteria.Op.EQ);
AccountDataCenterVirtualSearch.join("nicSearch", nicSearch, AccountDataCenterVirtualSearch.entity().getId(), nicSearch.entity().getInstanceId(), JoinBuilder.JoinType.INNER);
AccountDataCenterVirtualSearch.done();
}
SearchCriteria<UserVmVO> sc = AccountDataCenterVirtualSearch.create();
sc.setParameters("account", accountId);
sc.setParameters("dc", dcId);
sc.setJoinParameters("nicSearch", "networkId", networkId);
return listBy(sc);
}
@Override
public List<UserVmVO> listByNetworkIdAndStates(long networkId, State... states) {
if (UserVmSearch == null) {
NicDao _nicDao = ComponentLocator.getLocator("management-server").getDao(NicDao.class);
SearchBuilder<NicVO> nicSearch = _nicDao.createSearchBuilder();
nicSearch.and("networkId", nicSearch.entity().getNetworkId(), SearchCriteria.Op.EQ);
nicSearch.and("ip4Address", nicSearch.entity().getIp4Address(), SearchCriteria.Op.NNULL);
UserVmSearch = createSearchBuilder();
UserVmSearch.and("states", UserVmSearch.entity().getState(), SearchCriteria.Op.IN);
UserVmSearch.join("nicSearch", nicSearch, UserVmSearch.entity().getId(), nicSearch.entity().getInstanceId(), JoinBuilder.JoinType.INNER);
UserVmSearch.done();
}
SearchCriteria<UserVmVO> sc = UserVmSearch.create();
if (states != null && states.length != 0) {
sc.setParameters("states", (Object[]) states);
}
sc.setJoinParameters("nicSearch", "networkId", networkId);
return listBy(sc);
}
@Override
public List<UserVmVO> listByLastHostId(Long hostId) {
SearchCriteria<UserVmVO> sc = LastHostSearch.create();
sc.setParameters("lastHost", hostId);
sc.setParameters("state", State.Stopped);
return listBy(sc);
}
@Override
public List<UserVmVO> listByAccountIdAndHostId(long accountId, long hostId) {
SearchCriteria<UserVmVO> sc = AccountHostSearch.create();
sc.setParameters("hostId", hostId);
sc.setParameters("accountId", accountId);
return listBy(sc);
}
@Override
public void loadDetails(UserVmVO vm) {
Map<String, String> details = _detailsDao.findDetails(vm.getId());
vm.setDetails(details);
}
@Override
public void saveDetails(UserVmVO vm) {
Map<String, String> details = vm.getDetails();
if (details == null) {
return;
}
_detailsDao.persist(vm.getId(), details);
}
@Override
public List<Long> listPodIdsHavingVmsforAccount(long zoneId, long accountId){
Transaction txn = Transaction.currentTxn();
PreparedStatement pstmt = null;
List<Long> result = new ArrayList<Long>();
try {
String sql = LIST_PODS_HAVING_VMS_FOR_ACCOUNT;
pstmt = txn.prepareAutoCloseStatement(sql);
pstmt.setLong(1, zoneId);
pstmt.setLong(2, accountId);
ResultSet rs = pstmt.executeQuery();
while (rs.next()) {
result.add(rs.getLong(1));
}
return result;
} catch (SQLException e) {
throw new CloudRuntimeException("DB Exception on: " + LIST_PODS_HAVING_VMS_FOR_ACCOUNT, e);
} catch (Throwable e) {
throw new CloudRuntimeException("Caught: " + LIST_PODS_HAVING_VMS_FOR_ACCOUNT, e);
}
}
@Override
public UserVmResponse listVmDetails(UserVm userVm, boolean show_host){
Transaction txn = Transaction.currentTxn();
PreparedStatement pstmt = null;
try {
String sql = VM_DETAILS;
pstmt = txn.prepareAutoCloseStatement(sql);
pstmt.setLong(1, userVm.getIsoId() == null ? -1 : userVm.getIsoId());
pstmt.setLong(2, userVm.getId());
ResultSet rs = pstmt.executeQuery();
boolean is_data_center_security_group_enabled=false;
Set<SecurityGroupResponse> securityGroupResponse = new HashSet<SecurityGroupResponse>();
Set<NicResponse> nicResponses = new HashSet<NicResponse>();
UserVmResponse userVmResponse = null;
while (rs.next()) {
if (userVmResponse==null){
userVmResponse=new UserVmResponse();
userVmResponse.setId(userVm.getId());
userVmResponse.setName(userVm.getDisplayName());
userVmResponse.setCreated(userVm.getCreated());
userVmResponse.setGuestOsId(userVm.getGuestOSId());
userVmResponse.setHaEnable(userVm.isHaEnabled());
if (userVm.getState() != null) {
userVmResponse.setState(userVm.getState().toString());
}
if (userVm.getDisplayName() != null) {
userVmResponse.setDisplayName(userVm.getDisplayName());
} else {
userVmResponse.setDisplayName(userVm.getHostName());
}
//account.account_name, account.type, domain.name, instance_group.id, instance_group.name,"
userVmResponse.setAccountName(rs.getString("account.account_name"));
userVmResponse.setDomainId(userVm.getDomainId());
userVmResponse.setDomainName(rs.getString("domain.name"));
long grp_id = rs.getLong("instance_group.id");
if (grp_id > 0){
userVmResponse.setGroupId(grp_id);
userVmResponse.setGroup(rs.getString("instance_group.name"));
}
//"data_center.id, data_center.name, host.id, host.name, vm_template.id, vm_template.name, vm_template.display_text, vm_template.enable_password,
userVmResponse.setZoneId(rs.getLong("data_center.id"));
userVmResponse.setZoneName(rs.getString("data_center.name"));
if (show_host){
userVmResponse.setHostId(rs.getLong("host.id"));
userVmResponse.setHostName(rs.getString("host.name"));
}
if (userVm.getHypervisorType() != null) {
userVmResponse.setHypervisor(userVm.getHypervisorType().toString());
}
long template_id = rs.getLong("vm_template.id");
if (template_id > 0){
userVmResponse.setTemplateId(template_id);
userVmResponse.setTemplateName(rs.getString("vm_template.name"));
userVmResponse.setTemplateDisplayText(rs.getString("vm_template.display_text"));
userVmResponse.setPasswordEnabled(rs.getBoolean("vm_template.enable_password"));
}
else {
userVmResponse.setTemplateId(-1L);
userVmResponse.setTemplateName("ISO Boot");
userVmResponse.setTemplateDisplayText("ISO Boot");
userVmResponse.setPasswordEnabled(false);
}
long iso_id = rs.getLong("iso.id");
if (iso_id > 0){
userVmResponse.setIsoId(iso_id);
userVmResponse.setIsoName(rs.getString("iso.name"));
}
if (userVm.getPassword() != null) {
userVmResponse.setPassword(userVm.getPassword());
}
//service_offering.id, disk_offering.name, "
//"service_offering.cpu, service_offering.speed, service_offering.ram_size,
userVmResponse.setServiceOfferingId(rs.getLong("service_offering.id"));
userVmResponse.setServiceOfferingName(rs.getString("disk_offering.name"));
userVmResponse.setCpuNumber(rs.getInt("service_offering.cpu"));
userVmResponse.setCpuSpeed(rs.getInt("service_offering.speed"));
userVmResponse.setMemory(rs.getInt("service_offering.ram_size"));
// volumes.device_id, volumes.volume_type,
long vol_id = rs.getLong("volumes.id");
if (vol_id > 0){
userVmResponse.setRootDeviceId(rs.getLong("volumes.device_id"));
userVmResponse.setRootDeviceType(rs.getString("volumes.volume_type"));
// storage pool
long pool_id = rs.getLong("storage_pool.id");
if (pool_id > 0){
userVmResponse.setRootDeviceType(rs.getString("storage_pool.pool_type"));
}
else {
userVmResponse.setRootDeviceType("Not created");
}
}
is_data_center_security_group_enabled = rs.getBoolean("data_center.is_security_group_enabled");
}
//security_group.id, security_group.name, security_group.description, , data_center.is_security_group_enabled
if (is_data_center_security_group_enabled){
SecurityGroupResponse resp = new SecurityGroupResponse();
resp.setId(rs.getLong("security_group.id"));
resp.setName(rs.getString("security_group.name"));
resp.setDescription(rs.getString("security_group.description"));
resp.setObjectName("securitygroup");
securityGroupResponse.add(resp);
}
//nics.id, nics.ip4_address, nics.gateway, nics.network_id, nics.netmask, nics. mac_address, nics.broadcast_uri, nics.isolation_uri, " +
//"networks.traffic_type, networks.guest_type, networks.is_default from vm_instance, "
long nic_id = rs.getLong("nics.id");
if (nic_id > 0){
NicResponse nicResponse = new NicResponse();
nicResponse.setId(nic_id);
nicResponse.setIpaddress(rs.getString("nics.ip4_address"));
nicResponse.setGateway(rs.getString("nics.gateway"));
nicResponse.setNetmask(rs.getString("nics.netmask"));
nicResponse.setNetworkid(rs.getLong("nics.network_id"));
nicResponse.setMacAddress(rs.getString("nics.mac_address"));
int account_type = rs.getInt("account.type");
if (account_type == Account.ACCOUNT_TYPE_ADMIN) {
nicResponse.setBroadcastUri(rs.getString("nics.broadcast_uri"));
nicResponse.setIsolationUri(rs.getString("nics.isolation_uri"));
}
nicResponse.setTrafficType(rs.getString("networks.traffic_type"));
nicResponse.setType(rs.getString("networks.guest_type"));
nicResponse.setIsDefault(rs.getBoolean("networks.is_default"));
nicResponse.setObjectName("nic");
nicResponses.add(nicResponse);
}
}
userVmResponse.setSecurityGroupList(new ArrayList(securityGroupResponse));
userVmResponse.setNics(new ArrayList(nicResponses));
return userVmResponse;
} catch (SQLException e) {
throw new CloudRuntimeException("DB Exception on: " + VM_DETAILS, e);
} catch (Throwable e) {
throw new CloudRuntimeException("Caught: " + VM_DETAILS, e);
}
}
@Override
public Long countAllocatedVMsForAccount(long accountId) {
SearchCriteria<Long> sc = CountByAccount.create();
sc.setParameters("account", accountId);
sc.setParameters("type", VirtualMachine.Type.User);
sc.setParameters("state", new Object[] {State.Destroyed, State.Error, State.Expunging});
return customSearch(sc, null).get(0);
}
}
| server/src/com/cloud/vm/dao/UserVmDaoImpl.java | /**
* Copyright (C) 2010 Cloud.com, Inc. All rights reserved.
*
* This software is licensed under the GNU General Public License v3 or later.
*
* It is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package com.cloud.vm.dao;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
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 javax.ejb.Local;
import org.apache.log4j.Logger;
import com.cloud.api.ApiDBUtils;
import com.cloud.api.response.NicResponse;
import com.cloud.api.response.SecurityGroupResponse;
import com.cloud.api.response.UserVmResponse;
import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.utils.component.ComponentLocator;
import com.cloud.utils.db.Attribute;
import com.cloud.utils.db.GenericDaoBase;
import com.cloud.utils.db.GenericSearchBuilder;
import com.cloud.utils.db.JoinBuilder;
import com.cloud.utils.db.SearchBuilder;
import com.cloud.utils.db.SearchCriteria;
import com.cloud.utils.db.SearchCriteria.Func;
import com.cloud.utils.db.Transaction;
import com.cloud.utils.exception.CloudRuntimeException;
import com.cloud.vm.NicVO;
import com.cloud.vm.UserVmVO;
import com.cloud.vm.VirtualMachine;
import com.cloud.vm.VirtualMachine.State;
@Local(value={UserVmDao.class})
public class UserVmDaoImpl extends GenericDaoBase<UserVmVO, Long> implements UserVmDao {
public static final Logger s_logger = Logger.getLogger(UserVmDaoImpl.class);
protected final SearchBuilder<UserVmVO> AccountPodSearch;
protected final SearchBuilder<UserVmVO> AccountDataCenterSearch;
protected final SearchBuilder<UserVmVO> AccountSearch;
protected final SearchBuilder<UserVmVO> HostSearch;
protected final SearchBuilder<UserVmVO> LastHostSearch;
protected final SearchBuilder<UserVmVO> HostUpSearch;
protected final SearchBuilder<UserVmVO> HostRunningSearch;
protected final SearchBuilder<UserVmVO> StateChangeSearch;
protected final SearchBuilder<UserVmVO> AccountHostSearch;
protected final SearchBuilder<UserVmVO> DestroySearch;
protected SearchBuilder<UserVmVO> AccountDataCenterVirtualSearch;
protected GenericSearchBuilder<UserVmVO, Long> CountByAccountPod;
protected GenericSearchBuilder<UserVmVO, Long> CountByAccount;
protected GenericSearchBuilder<UserVmVO, Long> PodsHavingVmsForAccount;
protected SearchBuilder<UserVmVO> UserVmSearch;
protected final Attribute _updateTimeAttr;
private static final String LIST_PODS_HAVING_VMS_FOR_ACCOUNT = "SELECT pod_id FROM cloud.vm_instance WHERE data_center_id = ? AND account_id = ? AND pod_id IS NOT NULL AND state = 'Running' OR state = 'Stopped' " +
"GROUP BY pod_id HAVING count(id) > 0 ORDER BY count(id) DESC";
private static final String VM_DETAILS = "select account.account_name, account.type, domain.name, instance_group.id, instance_group.name," +
"data_center.id, data_center.name, data_center.is_security_group_enabled, host.id, host.name, " +
"vm_template.id, vm_template.name, vm_template.display_text, iso.id, iso.name, " +
"vm_template.enable_password, service_offering.id, disk_offering.name, storage_pool.id, storage_pool.pool_type, " +
"service_offering.cpu, service_offering.speed, service_offering.ram_size, volumes.id, volumes.device_id, volumes.volume_type, security_group.id, security_group.name, " +
"security_group.description, nics.id, nics.ip4_address, nics.gateway, nics.network_id, nics.netmask, nics.mac_address, nics.broadcast_uri, nics.isolation_uri, " +
"networks.traffic_type, networks.guest_type, networks.is_default from vm_instance " +
"left join account on vm_instance.account_id=account.id " +
"left join domain on vm_instance.domain_id=domain.id " +
"left join instance_group_vm_map on vm_instance.id=instance_group_vm_map.instance_id " +
"left join instance_group on instance_group_vm_map.group_id=instance_group.id " +
"left join data_center on vm_instance.data_center_id=data_center.id " +
"left join host on vm_instance.host_id=host.id " +
"left join vm_template on vm_instance.vm_template_id=vm_template.id " +
"left join vm_template iso on iso.id=? " +
"left join service_offering on vm_instance.service_offering_id=service_offering.id " +
"left join disk_offering on vm_instance.service_offering_id=disk_offering.id " +
"left join volumes on vm_instance.id=volumes.instance_id " +
"left join storage_pool on volumes.pool_id=storage_pool.id " +
"left join security_group_vm_map on vm_instance.id=security_group_vm_map.instance_id " +
"left join security_group on security_group_vm_map.security_group_id=security_group.id " +
"left join nics on vm_instance.id=nics.instance_id " +
"left join networks on nics.network_id=networks.id " +
"where vm_instance.id=?";
protected final UserVmDetailsDaoImpl _detailsDao = ComponentLocator.inject(UserVmDetailsDaoImpl.class);
protected UserVmDaoImpl() {
AccountSearch = createSearchBuilder();
AccountSearch.and("account", AccountSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountSearch.done();
HostSearch = createSearchBuilder();
HostSearch.and("host", HostSearch.entity().getHostId(), SearchCriteria.Op.EQ);
HostSearch.done();
LastHostSearch = createSearchBuilder();
LastHostSearch.and("lastHost", LastHostSearch.entity().getLastHostId(), SearchCriteria.Op.EQ);
LastHostSearch.and("state", LastHostSearch.entity().getState(), SearchCriteria.Op.EQ);
LastHostSearch.done();
HostUpSearch = createSearchBuilder();
HostUpSearch.and("host", HostUpSearch.entity().getHostId(), SearchCriteria.Op.EQ);
HostUpSearch.and("states", HostUpSearch.entity().getState(), SearchCriteria.Op.NIN);
HostUpSearch.done();
HostRunningSearch = createSearchBuilder();
HostRunningSearch.and("host", HostRunningSearch.entity().getHostId(), SearchCriteria.Op.EQ);
HostRunningSearch.and("state", HostRunningSearch.entity().getState(), SearchCriteria.Op.EQ);
HostRunningSearch.done();
AccountPodSearch = createSearchBuilder();
AccountPodSearch.and("account", AccountPodSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountPodSearch.and("pod", AccountPodSearch.entity().getPodIdToDeployIn(), SearchCriteria.Op.EQ);
AccountPodSearch.done();
AccountDataCenterSearch = createSearchBuilder();
AccountDataCenterSearch.and("account", AccountDataCenterSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountDataCenterSearch.and("dc", AccountDataCenterSearch.entity().getDataCenterIdToDeployIn(), SearchCriteria.Op.EQ);
AccountDataCenterSearch.done();
StateChangeSearch = createSearchBuilder();
StateChangeSearch.and("id", StateChangeSearch.entity().getId(), SearchCriteria.Op.EQ);
StateChangeSearch.and("states", StateChangeSearch.entity().getState(), SearchCriteria.Op.EQ);
StateChangeSearch.and("host", StateChangeSearch.entity().getHostId(), SearchCriteria.Op.EQ);
StateChangeSearch.and("update", StateChangeSearch.entity().getUpdated(), SearchCriteria.Op.EQ);
StateChangeSearch.done();
DestroySearch = createSearchBuilder();
DestroySearch.and("state", DestroySearch.entity().getState(), SearchCriteria.Op.IN);
DestroySearch.and("updateTime", DestroySearch.entity().getUpdateTime(), SearchCriteria.Op.LT);
DestroySearch.done();
AccountHostSearch = createSearchBuilder();
AccountHostSearch.and("accountId", AccountHostSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountHostSearch.and("hostId", AccountHostSearch.entity().getHostId(), SearchCriteria.Op.EQ);
AccountHostSearch.done();
CountByAccountPod = createSearchBuilder(Long.class);
CountByAccountPod.select(null, Func.COUNT, null);
CountByAccountPod.and("account", CountByAccountPod.entity().getAccountId(), SearchCriteria.Op.EQ);
CountByAccountPod.and("pod", CountByAccountPod.entity().getPodIdToDeployIn(), SearchCriteria.Op.EQ);
CountByAccountPod.done();
CountByAccount = createSearchBuilder(Long.class);
CountByAccount.select(null, Func.COUNT, null);
CountByAccount.and("account", CountByAccount.entity().getAccountId(), SearchCriteria.Op.EQ);
CountByAccount.and("type", CountByAccount.entity().getType(), SearchCriteria.Op.EQ);
CountByAccount.and("state", CountByAccount.entity().getState(), SearchCriteria.Op.NIN);
CountByAccount.done();
_updateTimeAttr = _allAttributes.get("updateTime");
assert _updateTimeAttr != null : "Couldn't get this updateTime attribute";
}
@Override
public List<UserVmVO> listByAccountAndPod(long accountId, long podId) {
SearchCriteria<UserVmVO> sc = AccountPodSearch.create();
sc.setParameters("account", accountId);
sc.setParameters("pod", podId);
return listIncludingRemovedBy(sc);
}
@Override
public List<UserVmVO> listByAccountAndDataCenter(long accountId, long dcId) {
SearchCriteria<UserVmVO> sc = AccountDataCenterSearch.create();
sc.setParameters("account", accountId);
sc.setParameters("dc", dcId);
return listIncludingRemovedBy(sc);
}
@Override
public void updateVM(long id, String displayName, boolean enable, Long osTypeId, String userData) {
UserVmVO vo = createForUpdate();
vo.setDisplayName(displayName);
vo.setHaEnabled(enable);
vo.setGuestOSId(osTypeId);
vo.setUserData(userData);
update(id, vo);
}
@Override
public List<UserVmVO> findDestroyedVms(Date date) {
SearchCriteria<UserVmVO> sc = DestroySearch.create();
sc.setParameters("state", State.Destroyed, State.Expunging, State.Error);
sc.setParameters("updateTime", date);
return listBy(sc);
}
@Override
public List<UserVmVO> listByAccountId(long id) {
SearchCriteria<UserVmVO> sc = AccountSearch.create();
sc.setParameters("account", id);
return listBy(sc);
}
@Override
public List<UserVmVO> listByHostId(Long id) {
SearchCriteria<UserVmVO> sc = HostSearch.create();
sc.setParameters("host", id);
return listBy(sc);
}
@Override
public List<UserVmVO> listUpByHostId(Long hostId) {
SearchCriteria<UserVmVO> sc = HostUpSearch.create();
sc.setParameters("host", hostId);
sc.setParameters("states", new Object[] {State.Destroyed, State.Stopped, State.Expunging});
return listBy(sc);
}
@Override
public List<UserVmVO> listRunningByHostId(long hostId) {
SearchCriteria<UserVmVO> sc = HostRunningSearch.create();
sc.setParameters("host", hostId);
sc.setParameters("state", State.Running);
return listBy(sc);
}
@Override
public List<UserVmVO> listVirtualNetworkInstancesByAcctAndZone(long accountId, long dcId, long networkId) {
if (AccountDataCenterVirtualSearch == null) {
NicDao _nicDao = ComponentLocator.getLocator("management-server").getDao(NicDao.class);
SearchBuilder<NicVO> nicSearch = _nicDao.createSearchBuilder();
nicSearch.and("networkId", nicSearch.entity().getNetworkId(), SearchCriteria.Op.EQ);
nicSearch.and("ip4Address", nicSearch.entity().getIp4Address(), SearchCriteria.Op.NNULL);
AccountDataCenterVirtualSearch = createSearchBuilder();
AccountDataCenterVirtualSearch.and("account", AccountDataCenterVirtualSearch.entity().getAccountId(), SearchCriteria.Op.EQ);
AccountDataCenterVirtualSearch.and("dc", AccountDataCenterVirtualSearch.entity().getDataCenterIdToDeployIn(), SearchCriteria.Op.EQ);
AccountDataCenterVirtualSearch.join("nicSearch", nicSearch, AccountDataCenterVirtualSearch.entity().getId(), nicSearch.entity().getInstanceId(), JoinBuilder.JoinType.INNER);
AccountDataCenterVirtualSearch.done();
}
SearchCriteria<UserVmVO> sc = AccountDataCenterVirtualSearch.create();
sc.setParameters("account", accountId);
sc.setParameters("dc", dcId);
sc.setJoinParameters("nicSearch", "networkId", networkId);
return listBy(sc);
}
@Override
public List<UserVmVO> listByNetworkIdAndStates(long networkId, State... states) {
if (UserVmSearch == null) {
NicDao _nicDao = ComponentLocator.getLocator("management-server").getDao(NicDao.class);
SearchBuilder<NicVO> nicSearch = _nicDao.createSearchBuilder();
nicSearch.and("networkId", nicSearch.entity().getNetworkId(), SearchCriteria.Op.EQ);
nicSearch.and("ip4Address", nicSearch.entity().getIp4Address(), SearchCriteria.Op.NNULL);
UserVmSearch = createSearchBuilder();
UserVmSearch.and("states", UserVmSearch.entity().getState(), SearchCriteria.Op.IN);
UserVmSearch.join("nicSearch", nicSearch, UserVmSearch.entity().getId(), nicSearch.entity().getInstanceId(), JoinBuilder.JoinType.INNER);
UserVmSearch.done();
}
SearchCriteria<UserVmVO> sc = UserVmSearch.create();
if (states != null && states.length != 0) {
sc.setParameters("states", (Object[]) states);
}
sc.setJoinParameters("nicSearch", "networkId", networkId);
return listBy(sc);
}
@Override
public List<UserVmVO> listByLastHostId(Long hostId) {
SearchCriteria<UserVmVO> sc = LastHostSearch.create();
sc.setParameters("lastHost", hostId);
sc.setParameters("state", State.Stopped);
return listBy(sc);
}
@Override
public List<UserVmVO> listByAccountIdAndHostId(long accountId, long hostId) {
SearchCriteria<UserVmVO> sc = AccountHostSearch.create();
sc.setParameters("hostId", hostId);
sc.setParameters("accountId", accountId);
return listBy(sc);
}
@Override
public void loadDetails(UserVmVO vm) {
Map<String, String> details = _detailsDao.findDetails(vm.getId());
vm.setDetails(details);
}
@Override
public void saveDetails(UserVmVO vm) {
Map<String, String> details = vm.getDetails();
if (details == null) {
return;
}
_detailsDao.persist(vm.getId(), details);
}
@Override
public List<Long> listPodIdsHavingVmsforAccount(long zoneId, long accountId){
Transaction txn = Transaction.currentTxn();
PreparedStatement pstmt = null;
List<Long> result = new ArrayList<Long>();
try {
String sql = LIST_PODS_HAVING_VMS_FOR_ACCOUNT;
pstmt = txn.prepareAutoCloseStatement(sql);
pstmt.setLong(1, zoneId);
pstmt.setLong(2, accountId);
ResultSet rs = pstmt.executeQuery();
while (rs.next()) {
result.add(rs.getLong(1));
}
return result;
} catch (SQLException e) {
throw new CloudRuntimeException("DB Exception on: " + LIST_PODS_HAVING_VMS_FOR_ACCOUNT, e);
} catch (Throwable e) {
throw new CloudRuntimeException("Caught: " + LIST_PODS_HAVING_VMS_FOR_ACCOUNT, e);
}
}
@Override
public UserVmResponse listVmDetails(UserVm userVm, boolean show_host){
Transaction txn = Transaction.currentTxn();
PreparedStatement pstmt = null;
try {
String sql = VM_DETAILS;
pstmt = txn.prepareAutoCloseStatement(sql);
pstmt.setLong(1, userVm.getIsoId() == null ? -1 : userVm.getIsoId());
pstmt.setLong(2, userVm.getId());
ResultSet rs = pstmt.executeQuery();
boolean is_data_center_security_group_enabled=false;
Set<SecurityGroupResponse> securityGroupResponse = new HashSet<SecurityGroupResponse>();
Set<NicResponse> nicResponses = new HashSet<NicResponse>();
UserVmResponse userVmResponse = null;
while (rs.next()) {
if (userVmResponse==null){
userVmResponse=new UserVmResponse();
userVmResponse.setId(userVm.getId());
userVmResponse.setName(userVm.getDisplayName());
userVmResponse.setCreated(userVm.getCreated());
userVmResponse.setGuestOsId(userVm.getGuestOSId());
userVmResponse.setHaEnable(userVm.isHaEnabled());
if (userVm.getState() != null) {
userVmResponse.setState(userVm.getState().toString());
}
if (userVm.getDisplayName() != null) {
userVmResponse.setDisplayName(userVm.getDisplayName());
} else {
userVmResponse.setDisplayName(userVm.getHostName());
}
//account.account_name, account.type, domain.name, instance_group.id, instance_group.name,"
userVmResponse.setAccountName(rs.getString("account.account_name"));
userVmResponse.setDomainId(userVm.getDomainId());
userVmResponse.setDomainName(rs.getString("domain.name"));
long grp_id = rs.getLong("instance_group.id");
if (grp_id > 0){
userVmResponse.setGroupId(grp_id);
userVmResponse.setGroup(rs.getString("instance_group.name"));
}
//"data_center.id, data_center.name, host.id, host.name, vm_template.id, vm_template.name, vm_template.display_text, vm_template.enable_password,
userVmResponse.setZoneId(rs.getLong("data_center.id"));
userVmResponse.setZoneName(rs.getString("data_center.name"));
if (show_host){
userVmResponse.setHostId(rs.getLong("host.id"));
userVmResponse.setHostName(rs.getString("host.name"));
}
if (userVm.getHypervisorType() != null) {
userVmResponse.setHypervisor(userVm.getHypervisorType().toString());
}
long template_id = rs.getLong("vm_template.id");
if (template_id > 0){
userVmResponse.setTemplateId(template_id);
userVmResponse.setTemplateName(rs.getString("vm_template.name"));
userVmResponse.setTemplateDisplayText(rs.getString("vm_template.display_text"));
userVmResponse.setPasswordEnabled(rs.getBoolean("vm_template.enable_password"));
}
else {
userVmResponse.setTemplateId(-1L);
userVmResponse.setTemplateName("ISO Boot");
userVmResponse.setTemplateDisplayText("ISO Boot");
userVmResponse.setPasswordEnabled(false);
}
long iso_id = rs.getLong("iso.id");
if (iso_id > 0){
userVmResponse.setIsoId(iso_id);
userVmResponse.setIsoName(rs.getString("iso.name"));
}
if (userVm.getPassword() != null) {
userVmResponse.setPassword(userVm.getPassword());
}
//service_offering.id, disk_offering.name, "
//"service_offering.cpu, service_offering.speed, service_offering.ram_size,
userVmResponse.setServiceOfferingId(rs.getLong("service_offering.id"));
userVmResponse.setServiceOfferingName(rs.getString("disk_offering.name"));
userVmResponse.setCpuNumber(rs.getInt("service_offering.cpu"));
userVmResponse.setCpuSpeed(rs.getInt("service_offering.speed"));
userVmResponse.setMemory(rs.getInt("service_offering.ram_size"));
// volumes.device_id, volumes.volume_type,
long vol_id = rs.getLong("volumes.id");
if (vol_id > 0){
userVmResponse.setRootDeviceId(rs.getLong("volumes.device_id"));
userVmResponse.setRootDeviceType(rs.getString("volumes.volume_type"));
// storage pool
long pool_id = rs.getLong("storage_pool.id");
if (pool_id > 0){
userVmResponse.setRootDeviceType(rs.getString("storage_pool.pool_type"));
}
else {
userVmResponse.setRootDeviceType("Not created");
}
}
is_data_center_security_group_enabled = rs.getBoolean("data_center.is_security_group_enabled");
}
//security_group.id, security_group.name, security_group.description, , data_center.is_security_group_enabled
if (is_data_center_security_group_enabled){
SecurityGroupResponse resp = new SecurityGroupResponse();
resp.setId(rs.getLong("security_group.id"));
resp.setName("security_group.name");
resp.setDescription("security_group.description");
resp.setObjectName("securitygroup");
securityGroupResponse.add(resp);
}
//nics.id, nics.ip4_address, nics.gateway, nics.network_id, nics.netmask, nics. mac_address, nics.broadcast_uri, nics.isolation_uri, " +
//"networks.traffic_type, networks.guest_type, networks.is_default from vm_instance, "
long nic_id = rs.getLong("nics.id");
if (nic_id > 0){
NicResponse nicResponse = new NicResponse();
nicResponse.setId(nic_id);
nicResponse.setIpaddress(rs.getString("nics.ip4_address"));
nicResponse.setGateway(rs.getString("nics.gateway"));
nicResponse.setNetmask(rs.getString("nics.netmask"));
nicResponse.setNetworkid(rs.getLong("nics.network_id"));
nicResponse.setMacAddress(rs.getString("nics.mac_address"));
int account_type = rs.getInt("account.type");
if (account_type == Account.ACCOUNT_TYPE_ADMIN) {
nicResponse.setBroadcastUri(rs.getString("nics.broadcast_uri"));
nicResponse.setIsolationUri(rs.getString("nics.isolation_uri"));
}
nicResponse.setTrafficType(rs.getString("networks.traffic_type"));
nicResponse.setType(rs.getString("networks.guest_type"));
nicResponse.setIsDefault(rs.getBoolean("networks.is_default"));
nicResponse.setObjectName("nic");
nicResponses.add(nicResponse);
}
}
userVmResponse.setSecurityGroupList(new ArrayList(securityGroupResponse));
userVmResponse.setNics(new ArrayList(nicResponses));
return userVmResponse;
} catch (SQLException e) {
throw new CloudRuntimeException("DB Exception on: " + VM_DETAILS, e);
} catch (Throwable e) {
throw new CloudRuntimeException("Caught: " + VM_DETAILS, e);
}
}
@Override
public Long countAllocatedVMsForAccount(long accountId) {
SearchCriteria<Long> sc = CountByAccount.create();
sc.setParameters("account", accountId);
sc.setParameters("type", VirtualMachine.Type.User);
sc.setParameters("state", new Object[] {State.Destroyed, State.Error, State.Expunging});
return customSearch(sc, null).get(0);
}
}
| bug 10629: fixed regression bug in listVms - security group name and display text weren't returned
status 10629: resolved fixed
| server/src/com/cloud/vm/dao/UserVmDaoImpl.java | bug 10629: fixed regression bug in listVms - security group name and display text weren't returned status 10629: resolved fixed | <ide><path>erver/src/com/cloud/vm/dao/UserVmDaoImpl.java
<ide> if (is_data_center_security_group_enabled){
<ide> SecurityGroupResponse resp = new SecurityGroupResponse();
<ide> resp.setId(rs.getLong("security_group.id"));
<del> resp.setName("security_group.name");
<del> resp.setDescription("security_group.description");
<add> resp.setName(rs.getString("security_group.name"));
<add> resp.setDescription(rs.getString("security_group.description"));
<ide> resp.setObjectName("securitygroup");
<ide> securityGroupResponse.add(resp);
<ide> } |
|
Java | apache-2.0 | 0552c7fee2f08362198ed3be72bfb99616976a94 | 0 | fnl/txtfnnl,fnl/txtfnnl,fnl/txtfnnl,fnl/txtfnnl | package txtfnnl.pipelines;
import java.io.File;
import java.io.IOException;
import java.util.logging.Logger;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.cli.PosixParser;
import org.apache.uima.UIMAException;
import txtfnnl.uima.analysis_component.BioLemmatizerAnnotator;
import txtfnnl.uima.analysis_component.GeniaTaggerAnnotator;
import txtfnnl.uima.analysis_component.NOOPAnnotator;
import txtfnnl.uima.analysis_component.opennlp.SentenceAnnotator;
import txtfnnl.uima.analysis_component.opennlp.TokenAnnotator;
import txtfnnl.uima.collection.TaggedSentenceLineWriter;
/**
* A plaintext tagger for (nearly arbitrary) input files to annotate sentences, tokens, lemmas, PoS
* tags, and chunks.
* <p>
* Input files can be read from a directory or listed explicitly, while output files are written to
* some directory or to STDOUT. Sentences are written on a single line. Tokens are annotated with
* their stems and PoS tags and grouped into phrase chunks.
*
* @author Florian Leitner
*/
public class SentenceTagger extends Pipeline {
private SentenceTagger() {
throw new AssertionError("n/a");
}
public static void main(String[] arguments) {
final CommandLineParser parser = new PosixParser();
final Options opts = new Options();
CommandLine cmd = null;
Pipeline.addLogHelpAndInputOptions(opts);
Pipeline.addTikaOptions(opts);
Pipeline.addOutputOptions(opts);
// sentence splitter options
opts.addOption("S", "successive-newlines", false, "split sentences on successive newlines");
opts.addOption("s", "single-newlines", false, "split sentences on single newlines");
// tokenizer options setup
opts.addOption("g", "genia", true,
"use GENIA (with the dir containing 'morphdic/') instead of OpenNLP");
try {
cmd = parser.parse(opts, arguments);
} catch (final ParseException e) {
System.err.println(e.getLocalizedMessage());
System.exit(1); // == EXIT ==
}
final Logger l = Pipeline.loggingSetup(cmd, opts,
"txtfnnl tag [options] <directory|files...>\n");
// (GENIA) tokenizer
final String geniaDir = cmd.getOptionValue('g');
// sentence splitter
String splitSentences = null; // S, s
if (cmd.hasOption('s')) {
splitSentences = "single";
} else if (cmd.hasOption('S')) {
splitSentences = "successive";
}
// output (format)
final String encoding = Pipeline.outputEncoding(cmd);
final File outputDirectory = Pipeline.outputDirectory(cmd);
final boolean overwriteFiles = Pipeline.outputOverwriteFiles(cmd);
try {
final Pipeline tagger = new Pipeline(4); // tika, splitter, tokenizer, lemmatizer
tagger.setReader(cmd);
tagger.configureTika(cmd);
tagger.set(1, SentenceAnnotator.configure(splitSentences));
if (geniaDir == null) {
tagger.set(2, TokenAnnotator.configure());
tagger.set(3, BioLemmatizerAnnotator.configure());
} else {
tagger.set(2, GeniaTaggerAnnotator.configure(new File(geniaDir)));
// the GENIA Tagger already lemmatizes; nothing to do
tagger.set(3, NOOPAnnotator.configure());
}
tagger.setConsumer(TaggedSentenceLineWriter.configure(outputDirectory, encoding,
outputDirectory == null, overwriteFiles));
tagger.run();
} catch (final UIMAException e) {
l.severe(e.toString());
System.err.println(e.getLocalizedMessage());
System.exit(1); // == EXIT ==
} catch (final IOException e) {
l.severe(e.toString());
System.err.println(e.getLocalizedMessage());
System.exit(1); // == EXIT ==
}
System.exit(0);
}
}
| txtfnnl-bin/src/main/java/txtfnnl/pipelines/SentenceTagger.java | package txtfnnl.pipelines;
import java.io.File;
import java.io.IOException;
import java.util.logging.Logger;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.cli.PosixParser;
import org.apache.uima.UIMAException;
import txtfnnl.uima.analysis_component.BioLemmatizerAnnotator;
import txtfnnl.uima.analysis_component.GeniaTaggerAnnotator;
import txtfnnl.uima.analysis_component.NOOPAnnotator;
import txtfnnl.uima.analysis_component.opennlp.SentenceAnnotator;
import txtfnnl.uima.analysis_component.opennlp.TokenAnnotator;
import txtfnnl.uima.collection.TaggedSentenceLineWriter;
/**
* A plaintext tagger for (nearly arbitrary) input files to annotate sentences, tokens, lemmas, PoS
* tags, and chunks.
* <p>
* Input files can be read from a directory or listed explicitly, while output files are written to
* some directory or to STDOUT. Sentences are written on a single line. Tokens are annotated with
* their stems and PoS tags and grouped into phrase chunks. Instead of the usual grouping of chunks
* using square brackets, curly brackets are used so the output is easier to analyze with regular
* expressions.
*
* @author Florian Leitner
*/
public class SentenceTagger extends Pipeline {
private SentenceTagger() {
throw new AssertionError("n/a");
}
public static void main(String[] arguments) {
final CommandLineParser parser = new PosixParser();
final Options opts = new Options();
CommandLine cmd = null;
Pipeline.addLogHelpAndInputOptions(opts);
Pipeline.addTikaOptions(opts);
Pipeline.addOutputOptions(opts);
// sentence splitter options
opts.addOption("S", "successive-newlines", false, "split sentences on successive newlines");
opts.addOption("s", "single-newlines", false, "split sentences on single newlines");
// tokenizer options setup
opts.addOption("g", "genia", true,
"use GENIA (giving the dir containing 'morphdic/') instead of OpenNLP");
try {
cmd = parser.parse(opts, arguments);
} catch (final ParseException e) {
System.err.println(e.getLocalizedMessage());
System.exit(1); // == EXIT ==
}
final Logger l = Pipeline.loggingSetup(cmd, opts,
"txtfnnl tag [options] <directory|files...>\n");
// (GENIA) tokenizer
final String geniaDir = cmd.getOptionValue('g');
// sentence splitter
String splitSentences = null; // S, s
if (cmd.hasOption('s')) {
splitSentences = "single";
} else if (cmd.hasOption('S')) {
splitSentences = "successive";
}
// output (format)
final String encoding = Pipeline.outputEncoding(cmd);
final File outputDirectory = Pipeline.outputDirectory(cmd);
final boolean overwriteFiles = Pipeline.outputOverwriteFiles(cmd);
try {
final Pipeline tagger = new Pipeline(4); // tika, splitter, tokenizer, lemmatizer
tagger.setReader(cmd);
tagger.configureTika(cmd);
tagger.set(1, SentenceAnnotator.configure(splitSentences));
if (geniaDir == null) {
tagger.set(2, TokenAnnotator.configure());
tagger.set(3, BioLemmatizerAnnotator.configure());
} else {
tagger.set(2, GeniaTaggerAnnotator.configure(new File(geniaDir)));
// the GENIA Tagger already lemmatizes; nothing to do
tagger.set(3, NOOPAnnotator.configure());
}
tagger.setConsumer(TaggedSentenceLineWriter.configure(outputDirectory, encoding,
outputDirectory == null, overwriteFiles));
tagger.run();
} catch (final UIMAException e) {
l.severe(e.toString());
System.err.println(e.getLocalizedMessage());
System.exit(1); // == EXIT ==
} catch (final IOException e) {
l.severe(e.toString());
System.err.println(e.getLocalizedMessage());
System.exit(1); // == EXIT ==
}
System.exit(0);
}
}
| comments updates | txtfnnl-bin/src/main/java/txtfnnl/pipelines/SentenceTagger.java | comments updates | <ide><path>xtfnnl-bin/src/main/java/txtfnnl/pipelines/SentenceTagger.java
<ide> * <p>
<ide> * Input files can be read from a directory or listed explicitly, while output files are written to
<ide> * some directory or to STDOUT. Sentences are written on a single line. Tokens are annotated with
<del> * their stems and PoS tags and grouped into phrase chunks. Instead of the usual grouping of chunks
<del> * using square brackets, curly brackets are used so the output is easier to analyze with regular
<del> * expressions.
<add> * their stems and PoS tags and grouped into phrase chunks.
<ide> *
<ide> * @author Florian Leitner
<ide> */
<ide> opts.addOption("s", "single-newlines", false, "split sentences on single newlines");
<ide> // tokenizer options setup
<ide> opts.addOption("g", "genia", true,
<del> "use GENIA (giving the dir containing 'morphdic/') instead of OpenNLP");
<add> "use GENIA (with the dir containing 'morphdic/') instead of OpenNLP");
<ide> try {
<ide> cmd = parser.parse(opts, arguments);
<ide> } catch (final ParseException e) { |
|
Java | agpl-3.0 | 8c08ca7224d03eb2752788b475b79932ae1cd18d | 0 | mnlipp/jgrapes,mnlipp/jgrapes | /*
* JGrapes Event Driven Framework
* Copyright (C) 2016 Michael N. Lipp
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 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 General Public License along
* with this program; if not, see <http://www.gnu.org/licenses/>.
*/
package org.jdrupes.httpcodec.fields;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
/**
* An HTTP field value that consists of a list of separated by a delimiter
* strings. The class provides a "list of field values" view of the values.
*
* @author Michael N. Lipp
*/
public abstract class HttpListField<T> extends HttpField<List<T>>
implements List<T>, Cloneable {
private String unparsedValue;
private int position;
private List<T> elements = new ArrayList<>();
/**
* Creates a new header field object with the given field name and no
* elements.
*
* @param name
* the field name
*/
protected HttpListField(String name) {
super(name);
reset();
}
/**
* Creates a new header field object with the given field name and unparsed
* value.
*
* @param name
* the field name
* @param unparsedValue
* the field value as it appears in the HTTP header
*/
protected HttpListField(String name, String unparsedValue) {
this(name);
this.unparsedValue = unparsedValue;
}
/* (non-Javadoc)
* @see java.lang.Object#clone()
*/
@Override
public HttpListField<T> clone() {
HttpListField<T> result = (HttpListField<T>)super.clone();
result.elements = new ArrayList<>(elements);
return result;
}
/**
* Returns the char that separates the items in the list.
*
* @return the default implementation returns a comma
*/
protected char getDelimiter() {
// Used by default in RFC 7230, see section 7.
return ',';
}
/**
* Reset the parsing state.
*/
protected void reset() {
position = 0;
}
/**
* Returns the next element from the unparsed value.
*
* @return the next element or {@code null} if no elements remain
* @throws ParseException
*/
protected String nextElement() throws ParseException {
// RFC 7230 3.2.6
boolean inDquote = false;
int startPosition = position;
char separator = getDelimiter();
try {
while (true) {
if (inDquote) {
char ch = unparsedValue.charAt(position);
switch (ch) {
case '\\':
position += 2;
continue;
case '\"':
inDquote = false;
default:
position += 1;
continue;
}
}
if (position == unparsedValue.length()) {
if (position == startPosition) {
return null;
}
return unparsedValue.substring(startPosition, position);
}
char ch = unparsedValue.charAt(position);
if (ch == separator) {
String result = unparsedValue
.substring(startPosition, position);
position += 1; // Skip comma
while (true) { // Skip optional white space
ch = unparsedValue.charAt(position);
if (ch != ' ' && ch != '\t') {
break;
}
position += 1;
}
return result;
}
switch (ch) {
case '\"':
inDquote = true;
default:
position += 1;
continue;
}
}
} catch (IndexOutOfBoundsException e) {
throw new ParseException(unparsedValue, position);
}
}
/* (non-Javadoc)
* @see org.jdrupes.httpcodec.fields.HttpField#getValue()
*/
@Override
public List<T> getValue() {
return this;
}
protected abstract String elementToString(T element);
/* (non-Javadoc)
* @see org.jdrupes.httpcodec.util.HttpFieldValue#asString()
*/
@Override
public String asFieldValue() {
char separator = getDelimiter();
boolean first = true;
StringBuilder result = new StringBuilder();
for (T e: this) {
if (first) {
first = false;
} else {
result.append(separator);
result.append(" ");
}
result.append(elementToString(e));
}
return result.toString();
}
/**
* Combine this list with another list of the same type.
*
* @param other the other list
*/
@SuppressWarnings("unchecked")
public void combine(@SuppressWarnings("rawtypes") HttpListField other) {
if (!(getClass().equals(other.getClass()))
|| getName() != other.getName()) {
throw new IllegalArgumentException("Types and name must be equal.");
}
addAll(other);
}
/**
* @see java.util.List#add(int, java.lang.Object)
*/
public void add(int index, T element) {
elements.add(index, element);
}
/**
* @see java.util.List#add(java.lang.Object)
*/
public boolean add(T e) {
return elements.add(e);
}
/**
* @see java.util.List#addAll(java.util.Collection)
*/
public boolean addAll(Collection<? extends T> c) {
return elements.addAll(c);
}
/**
* @see java.util.List#addAll(int, java.util.Collection)
*/
public boolean addAll(int index, Collection<? extends T> c) {
return elements.addAll(index, c);
}
/**
* @see java.util.List#clear()
*/
public void clear() {
elements.clear();
}
/**
* @see java.util.List#contains(java.lang.Object)
*/
public boolean contains(Object o) {
return elements.contains(o);
}
/**
* @see java.util.List#containsAll(java.util.Collection)
*/
public boolean containsAll(Collection<?> c) {
return elements.containsAll(c);
}
/**
* @see java.util.List#get(int)
*/
public T get(int index) {
return elements.get(index);
}
/**
* @see java.util.List#indexOf(java.lang.Object)
*/
public int indexOf(Object o) {
return elements.indexOf(o);
}
/**
* @see java.util.List#isEmpty()
*/
public boolean isEmpty() {
return elements.isEmpty();
}
/**
* @see java.util.List#iterator()
*/
public Iterator<T> iterator() {
return elements.iterator();
}
/**
* @see java.util.List#lastIndexOf(java.lang.Object)
*/
public int lastIndexOf(Object o) {
return elements.lastIndexOf(o);
}
/**
* @see java.util.List#listIterator()
*/
public ListIterator<T> listIterator() {
return elements.listIterator();
}
/**
* @see java.util.List#listIterator(int)
*/
public ListIterator<T> listIterator(int index) {
return elements.listIterator(index);
}
/**
* @see java.util.List#remove(int)
*/
public T remove(int index) {
return elements.remove(index);
}
/**
* @see java.util.List#remove(java.lang.Object)
*/
public boolean remove(Object o) {
return elements.remove(o);
}
/**
* @see java.util.List#removeAll(java.util.Collection)
*/
public boolean removeAll(Collection<?> c) {
return elements.removeAll(c);
}
/**
* @see java.util.List#retainAll(java.util.Collection)
*/
public boolean retainAll(Collection<?> c) {
return elements.retainAll(c);
}
/**
* @see java.util.List#set(int, java.lang.Object)
*/
public T set(int index, T element) {
return elements.set(index, element);
}
/**
* @see java.util.List#size()
*/
public int size() {
return elements.size();
}
/**
* @see java.util.List#subList(int, int)
*/
public List<T> subList(int fromIndex, int toIndex) {
return elements.subList(fromIndex, toIndex);
}
/**
* @see java.util.List#toArray()
*/
public Object[] toArray() {
return elements.toArray();
}
/**
* @see java.util.List#toArray(java.lang.Object[])
*/
public <U> U[] toArray(U[] a) {
return elements.toArray(a);
}
}
| org.jdrupes.httpcodec/src/org/jdrupes/httpcodec/fields/HttpListField.java | /*
* JGrapes Event Driven Framework
* Copyright (C) 2016 Michael N. Lipp
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 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 General Public License along
* with this program; if not, see <http://www.gnu.org/licenses/>.
*/
package org.jdrupes.httpcodec.fields;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
/**
* An HTTP field value that consists of a list of separated by a delimiter
* strings. The class provides a "list of field values" view of the values.
*
* @author Michael N. Lipp
*/
public abstract class HttpListField<T> extends HttpField<List<T>>
implements List<T>, Cloneable {
private String unparsedValue;
private int position;
private List<T> elements = new ArrayList<>();
/**
* Creates a new header field object with the given field name and no
* elements.
*
* @param name
* the field name
*/
protected HttpListField(String name) {
super(name);
reset();
}
/**
* Creates a new header field object with the given field name and unparsed
* value.
*
* @param name
* the field name
* @param unparsedValue
* the field value as it appears in the HTTP header
*/
protected HttpListField(String name, String unparsedValue) {
this(name);
this.unparsedValue = unparsedValue;
}
/* (non-Javadoc)
* @see java.lang.Object#clone()
*/
@Override
public HttpListField<T> clone() {
HttpListField<T> result = (HttpListField<T>)super.clone();
result.elements = new ArrayList<>(elements);
return result;
}
/**
* Returns the char that separates the items in the list.
*
* @return the default implementation returns a comma
*/
protected char getDelimiter() {
return ',';
}
/**
* Reset the parsing state.
*/
protected void reset() {
position = 0;
}
/**
* Returns the next element from the unparsed value.
*
* @return the next element or {@code null} if no elements remain
* @throws ParseException
*/
protected String nextElement() throws ParseException {
// RFC 7230 3.2.6
boolean inDquote = false;
int startPosition = position;
char separator = getDelimiter();
try {
while (true) {
if (inDquote) {
char ch = unparsedValue.charAt(position);
switch (ch) {
case '\\':
position += 2;
continue;
case '\"':
inDquote = false;
default:
position += 1;
continue;
}
}
if (position == unparsedValue.length()) {
if (position == startPosition) {
return null;
}
return unparsedValue.substring(startPosition, position);
}
char ch = unparsedValue.charAt(position);
if (ch == separator) {
String result = unparsedValue
.substring(startPosition, position);
position += 1; // Skip comma
while (true) { // Skip optional white space
ch = unparsedValue.charAt(position);
if (ch != ' ' && ch != '\t') {
break;
}
position += 1;
}
return result;
}
switch (ch) {
case '\"':
inDquote = true;
default:
position += 1;
continue;
}
}
} catch (IndexOutOfBoundsException e) {
throw new ParseException(unparsedValue, position);
}
}
/* (non-Javadoc)
* @see org.jdrupes.httpcodec.fields.HttpField#getValue()
*/
@Override
public List<T> getValue() {
return this;
}
protected abstract String elementToString(T element);
/* (non-Javadoc)
* @see org.jdrupes.httpcodec.util.HttpFieldValue#asString()
*/
@Override
public String asFieldValue() {
char separator = getDelimiter();
boolean first = true;
StringBuilder result = new StringBuilder();
for (T e: this) {
if (first) {
first = false;
} else {
result.append(separator);
result.append(" ");
}
result.append(elementToString(e));
}
return result.toString();
}
/**
* Combine this list with another list of the same type.
*
* @param other the other list
*/
@SuppressWarnings("unchecked")
public void combine(@SuppressWarnings("rawtypes") HttpListField other) {
if (!(getClass().equals(other.getClass()))
|| getName() != other.getName()) {
throw new IllegalArgumentException("Types and name must be equal.");
}
addAll(other);
}
/**
* @see java.util.List#add(int, java.lang.Object)
*/
public void add(int index, T element) {
elements.add(index, element);
}
/**
* @see java.util.List#add(java.lang.Object)
*/
public boolean add(T e) {
return elements.add(e);
}
/**
* @see java.util.List#addAll(java.util.Collection)
*/
public boolean addAll(Collection<? extends T> c) {
return elements.addAll(c);
}
/**
* @see java.util.List#addAll(int, java.util.Collection)
*/
public boolean addAll(int index, Collection<? extends T> c) {
return elements.addAll(index, c);
}
/**
* @see java.util.List#clear()
*/
public void clear() {
elements.clear();
}
/**
* @see java.util.List#contains(java.lang.Object)
*/
public boolean contains(Object o) {
return elements.contains(o);
}
/**
* @see java.util.List#containsAll(java.util.Collection)
*/
public boolean containsAll(Collection<?> c) {
return elements.containsAll(c);
}
/**
* @see java.util.List#get(int)
*/
public T get(int index) {
return elements.get(index);
}
/**
* @see java.util.List#indexOf(java.lang.Object)
*/
public int indexOf(Object o) {
return elements.indexOf(o);
}
/**
* @see java.util.List#isEmpty()
*/
public boolean isEmpty() {
return elements.isEmpty();
}
/**
* @see java.util.List#iterator()
*/
public Iterator<T> iterator() {
return elements.iterator();
}
/**
* @see java.util.List#lastIndexOf(java.lang.Object)
*/
public int lastIndexOf(Object o) {
return elements.lastIndexOf(o);
}
/**
* @see java.util.List#listIterator()
*/
public ListIterator<T> listIterator() {
return elements.listIterator();
}
/**
* @see java.util.List#listIterator(int)
*/
public ListIterator<T> listIterator(int index) {
return elements.listIterator(index);
}
/**
* @see java.util.List#remove(int)
*/
public T remove(int index) {
return elements.remove(index);
}
/**
* @see java.util.List#remove(java.lang.Object)
*/
public boolean remove(Object o) {
return elements.remove(o);
}
/**
* @see java.util.List#removeAll(java.util.Collection)
*/
public boolean removeAll(Collection<?> c) {
return elements.removeAll(c);
}
/**
* @see java.util.List#retainAll(java.util.Collection)
*/
public boolean retainAll(Collection<?> c) {
return elements.retainAll(c);
}
/**
* @see java.util.List#set(int, java.lang.Object)
*/
public T set(int index, T element) {
return elements.set(index, element);
}
/**
* @see java.util.List#size()
*/
public int size() {
return elements.size();
}
/**
* @see java.util.List#subList(int, int)
*/
public List<T> subList(int fromIndex, int toIndex) {
return elements.subList(fromIndex, toIndex);
}
/**
* @see java.util.List#toArray()
*/
public Object[] toArray() {
return elements.toArray();
}
/**
* @see java.util.List#toArray(java.lang.Object[])
*/
public <U> U[] toArray(U[] a) {
return elements.toArray(a);
}
}
| Improved documentation. | org.jdrupes.httpcodec/src/org/jdrupes/httpcodec/fields/HttpListField.java | Improved documentation. | <ide><path>rg.jdrupes.httpcodec/src/org/jdrupes/httpcodec/fields/HttpListField.java
<ide> * @return the default implementation returns a comma
<ide> */
<ide> protected char getDelimiter() {
<add> // Used by default in RFC 7230, see section 7.
<ide> return ',';
<ide> }
<ide> |
|
Java | apache-2.0 | 0afb732f0325789cd1fb9c1963b3f72614a014f5 | 0 | jagrosh/GiveawayBot | /*
* Copyright 2018 John Grosh ([email protected]).
*
* 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.jagrosh.giveawaybot.util;
import com.neovisionaries.ws.client.OpeningHandshakeException;
import net.dv8tion.jda.core.JDA;
import net.dv8tion.jda.core.utils.SessionControllerAdapter;
/**
*
* @author John Grosh ([email protected])
*/
public class BlockingSessionController extends SessionControllerAdapter
{
private final long MIN_DELAY = 10000L; // 10 seconds
private final long MAX_DELAY = 40000L; // 40 seconds
@Override
protected void runWorker()
{
synchronized (lock)
{
if (workerHandle == null)
{
workerHandle = new BlockingQueueWorker(MIN_DELAY);
workerHandle.start();
}
}
}
protected class BlockingQueueWorker extends QueueWorker
{
protected BlockingQueueWorker(long min)
{
super(min);
}
@Override
public void run()
{
try
{
if (this.delay > 0)
{
final long interval = System.currentTimeMillis() - lastConnect;
if (interval < this.delay)
Thread.sleep(this.delay - interval);
}
}
catch (InterruptedException ex)
{
log.error("Unable to backoff", ex);
}
processQueue();
synchronized (lock)
{
workerHandle = null;
if (!connectQueue.isEmpty())
runWorker();
}
}
@Override
protected void processQueue()
{
boolean isMultiple = connectQueue.size() > 1;
while (!connectQueue.isEmpty())
{
SessionConnectNode node = connectQueue.poll();
try
{
log.info("Attempting to start node: {}", node.getShardInfo().getShardId());
node.run(isMultiple && connectQueue.isEmpty());
isMultiple = true;
lastConnect = System.currentTimeMillis();
if (connectQueue.isEmpty())
break;
// block until we're fully loaded
long total = 0;
while(node.getJDA().getStatus() != JDA.Status.CONNECTED
&& node.getJDA().getStatus() != JDA.Status.SHUTDOWN
&& total < MAX_DELAY)
{
total += 100;
Thread.sleep(100);
}
if (this.delay > 0)
Thread.sleep(this.delay);
log.info("Finished with delay of {}", System.currentTimeMillis() - lastConnect);
}
catch (IllegalStateException e)
{
Throwable t = e.getCause();
if (t instanceof OpeningHandshakeException)
log.error("Failed opening handshake, appending to queue. Message: {}", e.getMessage());
else
log.error("Failed to establish connection for a node, appending to queue", e);
appendSession(node);
}
catch (InterruptedException e)
{
log.error("Failed to run node", e);
appendSession(node);
return; // caller should start a new thread
}
}
}
}
}
| src/main/java/com/jagrosh/giveawaybot/util/BlockingSessionController.java | /*
* Copyright 2018 John Grosh ([email protected]).
*
* 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.jagrosh.giveawaybot.util;
import com.neovisionaries.ws.client.OpeningHandshakeException;
import net.dv8tion.jda.core.utils.SessionControllerAdapter;
/**
*
* @author John Grosh ([email protected])
*/
public class BlockingSessionController extends SessionControllerAdapter
{
private final long MIN_DELAY = 20000L; // 20 seconds
@Override
protected void runWorker()
{
synchronized (lock)
{
if (workerHandle == null)
{
workerHandle = new BlockingQueueWorker(MIN_DELAY);
workerHandle.start();
}
}
}
protected class BlockingQueueWorker extends QueueWorker
{
protected BlockingQueueWorker(long min)
{
super(min);
}
@Override
public void run()
{
try
{
if (this.delay > 0)
{
final long interval = System.currentTimeMillis() - lastConnect;
if (interval < this.delay)
Thread.sleep(this.delay - interval);
}
}
catch (InterruptedException ex)
{
log.error("Unable to backoff", ex);
}
processQueue();
synchronized (lock)
{
workerHandle = null;
if (!connectQueue.isEmpty())
runWorker();
}
}
@Override
protected void processQueue()
{
boolean isMultiple = connectQueue.size() > 1;
while (!connectQueue.isEmpty())
{
SessionConnectNode node = connectQueue.poll();
try
{
log.info("Attempting to start node: {}", node.getShardInfo().getShardId());
node.run(isMultiple && connectQueue.isEmpty());
isMultiple = true;
lastConnect = System.currentTimeMillis();
if (connectQueue.isEmpty())
break;
if (this.delay > 0)
Thread.sleep(this.delay);
log.info("Finished with delay of {}", this.delay);
}
catch (IllegalStateException e)
{
Throwable t = e.getCause();
if (t instanceof OpeningHandshakeException)
log.error("Failed opening handshake, appending to queue. Message: {}", e.getMessage());
else
log.error("Failed to establish connection for a node, appending to queue", e);
appendSession(node);
}
catch (InterruptedException e)
{
log.error("Failed to run node", e);
appendSession(node);
return; // caller should start a new thread
}
}
}
}
}
| actually block | src/main/java/com/jagrosh/giveawaybot/util/BlockingSessionController.java | actually block | <ide><path>rc/main/java/com/jagrosh/giveawaybot/util/BlockingSessionController.java
<ide> package com.jagrosh.giveawaybot.util;
<ide>
<ide> import com.neovisionaries.ws.client.OpeningHandshakeException;
<add>import net.dv8tion.jda.core.JDA;
<ide> import net.dv8tion.jda.core.utils.SessionControllerAdapter;
<ide>
<ide> /**
<ide> */
<ide> public class BlockingSessionController extends SessionControllerAdapter
<ide> {
<del> private final long MIN_DELAY = 20000L; // 20 seconds
<add> private final long MIN_DELAY = 10000L; // 10 seconds
<add> private final long MAX_DELAY = 40000L; // 40 seconds
<ide>
<ide> @Override
<ide> protected void runWorker()
<ide> lastConnect = System.currentTimeMillis();
<ide> if (connectQueue.isEmpty())
<ide> break;
<add>
<add> // block until we're fully loaded
<add> long total = 0;
<add> while(node.getJDA().getStatus() != JDA.Status.CONNECTED
<add> && node.getJDA().getStatus() != JDA.Status.SHUTDOWN
<add> && total < MAX_DELAY)
<add> {
<add> total += 100;
<add> Thread.sleep(100);
<add> }
<add>
<ide> if (this.delay > 0)
<ide> Thread.sleep(this.delay);
<del> log.info("Finished with delay of {}", this.delay);
<add> log.info("Finished with delay of {}", System.currentTimeMillis() - lastConnect);
<ide> }
<ide> catch (IllegalStateException e)
<ide> { |
|
Java | mit | b3bab47df7fa7b0b24640f39092af5579fe87705 | 0 | lesstif/spongycastle,bcgit/bc-java,partheinstein/bc-java,sergeypayu/bc-java,open-keychain/spongycastle,FAU-Inf2/spongycastle,sonork/spongycastle,bcgit/bc-java,open-keychain/spongycastle,isghe/bc-java,onessimofalconi/bc-java,savichris/spongycastle,sergeypayu/bc-java,Skywalker-11/spongycastle,isghe/bc-java,savichris/spongycastle,Skywalker-11/spongycastle,open-keychain/spongycastle,Skywalker-11/spongycastle,bcgit/bc-java,isghe/bc-java,lesstif/spongycastle,partheinstein/bc-java,onessimofalconi/bc-java,onessimofalconi/bc-java,sonork/spongycastle,sonork/spongycastle,FAU-Inf2/spongycastle,savichris/spongycastle,lesstif/spongycastle,FAU-Inf2/spongycastle,partheinstein/bc-java,sergeypayu/bc-java | package org.bouncycastle.asn1;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Enumeration;
import java.util.Vector;
/**
* ASN.1 <code>SET</code> and <code>SET OF</code> constructs.
* <p>
* Note: This does not know which syntax the set is!
* (The difference: ordering of SET elements or not ordering.)
* <p>
* DER form is always definite form length fields, while
* BER support uses indefinite form.
* <p>
* The CER form support does not exist.
* <p>
* <hr>
* <h2>X.690</h2>
* <h3>8: Basic encoding rules</h3>
* <h4>8.11 Encoding of a set value </h4>
* <b>8.11.1</b> The encoding of a set value shall be constructed
* <p>
* <b>8.11.2</b> The contents octets shall consist of the complete
* encoding of a data value from each of the types listed in the
* ASN.1 definition of the set type, in an order chosen by the sender,
* unless the type was referenced with the keyword
* <b>OPTIONAL</b> or the keyword <b>DEFAULT</b>.
* <p>
* <b>8.11.3</b> The encoding of a data value may, but need not,
* be present for a type which was referenced with the keyword
* <b>OPTIONAL</b> or the keyword <b>DEFAULT</b>.
* <blockquote>
* NOTE — The order of data values in a set value is not significant,
* and places no constraints on the order during transfer
* </blockquote>
* <h4>8.12 Encoding of a set-of value</h4>
* <b>8.12.1</b> The encoding of a set-of value shall be constructed.
* <p>
* <b>8.12.2</b> The text of 8.10.2 applies:
* <i>The contents octets shall consist of zero,
* one or more complete encodings of data values from the type listed in
* the ASN.1 definition.</i>
* <p>
* <b>8.12.3</b> The order of data values need not be preserved by
* the encoding and subsequent decoding.
*
* <h3>9: Canonical encoding rules</h3>
* <h4>9.1 Length forms</h4>
* If the encoding is constructed, it shall employ the indefinite length form.
* If the encoding is primitive, it shall include the fewest length octets necessary.
* [Contrast with 8.1.3.2 b).]
* <h4>9.3 Set components</h4>
* The encodings of the component values of a set value shall
* appear in an order determined by their tags as specified
* in 8.6 of ITU-T Rec. X.680 | ISO/IEC 8824-1.
* Additionally, for the purposes of determining the order in which
* components are encoded when one or more component is an untagged
* choice type, each untagged choice type is ordered as though it
* has a tag equal to that of the smallest tag in that choice type
* or any untagged choice types nested within.
*
* <h3>10: Distinguished encoding rules</h3>
* <h4>10.1 Length forms</h4>
* The definite form of length encoding shall be used,
* encoded in the minimum number of octets.
* [Contrast with 8.1.3.2 b).]
* <h4>10.3 Set components</h4>
* The encodings of the component values of a set value shall appear
* in an order determined by their tags as specified
* in 8.6 of ITU-T Rec. X.680 | ISO/IEC 8824-1.
* <blockquote>
* NOTE — Where a component of the set is an untagged choice type,
* the location of that component in the ordering will depend on
* the tag of the choice component being encoded.
* </blockquote>
*
* <h3>11: Restrictions on BER employed by both CER and DER</h3>
* <h4>11.5 Set and sequence components with default value </h4>
* The encoding of a set value or sequence value shall not include
* an encoding for any component value which is equal to
* its default value.
* <h4>11.6 Set-of components </h4>
* <p>
* The encodings of the component values of a set-of value
* shall appear in ascending order, the encodings being compared
* as octet strings with the shorter components being padded at
* their trailing end with 0-octets.
* <blockquote>
* NOTE — The padding octets are for comparison purposes only
* and do not appear in the encodings.
* </blockquote>
*/
public abstract class ASN1Set
extends ASN1Primitive
{
private Vector set = new Vector();
private boolean isSorted = false;
/**
* return an ASN1Set from the given object.
*
* @param obj the object we want converted.
* @exception IllegalArgumentException if the object cannot be converted.
* @return an ASN1Set instance, or null.
*/
public static ASN1Set getInstance(
Object obj)
{
if (obj == null || obj instanceof ASN1Set)
{
return (ASN1Set)obj;
}
else if (obj instanceof ASN1SetParser)
{
return ASN1Set.getInstance(((ASN1SetParser)obj).toASN1Primitive());
}
else if (obj instanceof byte[])
{
try
{
return ASN1Set.getInstance(ASN1Primitive.fromByteArray((byte[])obj));
}
catch (IOException e)
{
throw new IllegalArgumentException("failed to construct set from byte[]: " + e.getMessage());
}
}
else if (obj instanceof ASN1Encodable)
{
ASN1Primitive primitive = ((ASN1Encodable)obj).toASN1Primitive();
if (primitive instanceof ASN1Set)
{
return (ASN1Set)primitive;
}
}
throw new IllegalArgumentException("unknown object in getInstance: " + obj.getClass().getName());
}
/**
* Return an ASN1 set from a tagged object. There is a special
* case here, if an object appears to have been explicitly tagged on
* reading but we were expecting it to be implicitly tagged in the
* normal course of events it indicates that we lost the surrounding
* set - so we need to add it back (this will happen if the tagged
* object is a sequence that contains other sequences). If you are
* dealing with implicitly tagged sets you really <b>should</b>
* be using this method.
*
* @param obj the tagged object.
* @param explicit true if the object is meant to be explicitly tagged
* false otherwise.
* @exception IllegalArgumentException if the tagged object cannot
* be converted.
* @return an ASN1Set instance.
*/
public static ASN1Set getInstance(
ASN1TaggedObject obj,
boolean explicit)
{
if (explicit)
{
if (!obj.isExplicit())
{
throw new IllegalArgumentException("object implicit - explicit expected.");
}
return (ASN1Set)obj.getObject();
}
else
{
//
// constructed object which appears to be explicitly tagged
// and it's really implicit means we have to add the
// surrounding set.
//
if (obj.isExplicit())
{
if (obj instanceof BERTaggedObject)
{
return new BERSet(obj.getObject());
}
else
{
return new DLSet(obj.getObject());
}
}
else
{
if (obj.getObject() instanceof ASN1Set)
{
return (ASN1Set)obj.getObject();
}
//
// in this case the parser returns a sequence, convert it
// into a set.
//
if (obj.getObject() instanceof ASN1Sequence)
{
ASN1Sequence s = (ASN1Sequence)obj.getObject();
if (obj instanceof BERTaggedObject)
{
return new BERSet(s.toArray());
}
else
{
return new DLSet(s.toArray());
}
}
}
}
throw new IllegalArgumentException("unknown object in getInstance: " + obj.getClass().getName());
}
protected ASN1Set()
{
}
/**
* create a sequence containing one object
* @param obj object to be added to the SET.
*/
protected ASN1Set(
ASN1Encodable obj)
{
set.addElement(obj);
}
/**
* create a sequence containing a vector of objects.
* @param v a vector of objects to make up the SET.
* @param doSort true if should be sorted DER style, false otherwise.
*/
protected ASN1Set(
ASN1EncodableVector v,
boolean doSort)
{
for (int i = 0; i != v.size(); i++)
{
set.addElement(v.get(i));
}
if (doSort)
{
this.sort();
}
}
/**
* create a sequence containing a vector of objects.
*/
protected ASN1Set(
ASN1Encodable[] array,
boolean doSort)
{
for (int i = 0; i != array.length; i++)
{
set.addElement(array[i]);
}
if (doSort)
{
this.sort();
}
}
public Enumeration getObjects()
{
return set.elements();
}
/**
* return the object at the set position indicated by index.
*
* @param index the set number (starting at zero) of the object
* @return the object at the set position indicated by index.
*/
public ASN1Encodable getObjectAt(
int index)
{
return (ASN1Encodable)set.elementAt(index);
}
/**
* return the number of objects in this set.
*
* @return the number of objects in this set.
*/
public int size()
{
return set.size();
}
public ASN1Encodable[] toArray()
{
ASN1Encodable[] values = new ASN1Encodable[this.size()];
for (int i = 0; i != this.size(); i++)
{
values[i] = this.getObjectAt(i);
}
return values;
}
public ASN1SetParser parser()
{
final ASN1Set outer = this;
return new ASN1SetParser()
{
private final int max = size();
private int index;
public ASN1Encodable readObject() throws IOException
{
if (index == max)
{
return null;
}
ASN1Encodable obj = getObjectAt(index++);
if (obj instanceof ASN1Sequence)
{
return ((ASN1Sequence)obj).parser();
}
if (obj instanceof ASN1Set)
{
return ((ASN1Set)obj).parser();
}
return obj;
}
public ASN1Primitive getLoadedObject()
{
return outer;
}
public ASN1Primitive toASN1Primitive()
{
return outer;
}
};
}
public int hashCode()
{
Enumeration e = this.getObjects();
int hashCode = size();
while (e.hasMoreElements())
{
Object o = getNext(e);
hashCode *= 17;
hashCode ^= o.hashCode();
}
return hashCode;
}
/**
* Change current SET object to be encoded as {@link DERSet}.
* This is part of Distinguished Encoding Rules form serialization.
*/
ASN1Primitive toDERObject()
{
if (isSorted)
{
ASN1Set derSet = new DERSet();
derSet.set = this.set;
return derSet;
}
else
{
Vector v = new Vector();
for (int i = 0; i != set.size(); i++)
{
v.addElement(set.elementAt(i));
}
ASN1Set derSet = new DERSet();
derSet.set = v;
derSet.sort();
return derSet;
}
}
/**
* Change current SET object to be encoded as {@link DLSet}.
* This is part of Direct Length form serialization.
*/
ASN1Primitive toDLObject()
{
ASN1Set derSet = new DLSet();
derSet.set = this.set;
return derSet;
}
boolean asn1Equals(
ASN1Primitive o)
{
if (!(o instanceof ASN1Set))
{
return false;
}
ASN1Set other = (ASN1Set)o;
if (this.size() != other.size())
{
return false;
}
Enumeration s1 = this.getObjects();
Enumeration s2 = other.getObjects();
while (s1.hasMoreElements())
{
ASN1Encodable obj1 = getNext(s1);
ASN1Encodable obj2 = getNext(s2);
ASN1Primitive o1 = obj1.toASN1Primitive();
ASN1Primitive o2 = obj2.toASN1Primitive();
if (o1 == o2 || o1.equals(o2))
{
continue;
}
return false;
}
return true;
}
private ASN1Encodable getNext(Enumeration e)
{
ASN1Encodable encObj = (ASN1Encodable)e.nextElement();
// unfortunately null was allowed as a substitute for DER null
if (encObj == null)
{
return DERNull.INSTANCE;
}
return encObj;
}
/**
* return true if a <= b (arrays are assumed padded with zeros).
*/
private boolean lessThanOrEqual(
byte[] a,
byte[] b)
{
int len = Math.min(a.length, b.length);
for (int i = 0; i != len; ++i)
{
if (a[i] != b[i])
{
return (a[i] & 0xff) < (b[i] & 0xff);
}
}
return len == a.length;
}
private byte[] getDEREncoded(
ASN1Encodable obj)
{
ByteArrayOutputStream bOut = new ByteArrayOutputStream();
DEROutputStream dOut = new DEROutputStream(bOut);
try
{
dOut.writeObject(obj);
}
catch (IOException e)
{
throw new IllegalArgumentException("cannot encode object added to SET");
}
return bOut.toByteArray();
}
protected void sort()
{
if (!isSorted)
{
isSorted = true;
if (set.size() > 1)
{
boolean swapped = true;
int lastSwap = set.size() - 1;
while (swapped)
{
int index = 0;
int swapIndex = 0;
byte[] a = getDEREncoded((ASN1Encodable)set.elementAt(0));
swapped = false;
while (index != lastSwap)
{
byte[] b = getDEREncoded((ASN1Encodable)set.elementAt(index + 1));
if (lessThanOrEqual(a, b))
{
a = b;
}
else
{
Object o = set.elementAt(index);
set.setElementAt(set.elementAt(index + 1), index);
set.setElementAt(o, index + 1);
swapped = true;
swapIndex = index;
}
index++;
}
lastSwap = swapIndex;
}
}
}
}
boolean isConstructed()
{
return true;
}
abstract void encode(ASN1OutputStream out)
throws IOException;
public String toString()
{
return set.toString();
}
}
| core/src/main/java/org/bouncycastle/asn1/ASN1Set.java | package org.bouncycastle.asn1;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Enumeration;
import java.util.Vector;
/**
* ASN.1 <code>SET</code> and <code>SET OF</code> constructs.
* <p>
* Note: This does not know which syntax the set is!
* (The difference: ordering of SET elements or not ordering.)
* <p>
* DER form is always definite form length fields, while
* BER support uses indefinite form.
* <p>
* The CER form support does not exist.
* <p>
* <hr>
* <h2>X.690</h2>
* <h3>8: Basic encoding rules</h3>
* <h4>8.11 Encoding of a set value </h4>
* <b>8.11.1</b> The encoding of a set value shall be constructed
* <p>
* <b>8.11.2</b> The contents octets shall consist of the complete
* encoding of a data value from each of the types listed in the
* ASN.1 definition of the set type, in an order chosen by the sender,
* unless the type was referenced with the keyword
* <b>OPTIONAL</b> or the keyword <b>DEFAULT</b>.
* <p>
* <b>8.11.3</b> The encoding of a data value may, but need not,
* be present for a type which was referenced with the keyword
* <b>OPTIONAL</b> or the keyword <b>DEFAULT</b>.
* <blockquote>
* NOTE — The order of data values in a set value is not significant,
* and places no constraints on the order during transfer
* </blockquote>
* <h4>8.12 Encoding of a set-of value</h4>
* <b>8.12.1</b> The encoding of a set-of value shall be constructed.
* <p>
* <b>8.12.2</b> The text of 8.10.2 applies:
* <i>The contents octets shall consist of zero,
* one or more complete encodings of data values from the type listed in
* the ASN.1 definition.</i>
* <p>
* <b>8.12.3</b> The order of data values need not be preserved by
* the encoding and subsequent decoding.
*
* <h3>9: Canonical encoding rules</h3>
* <h4>9.1 Length forms</h4>
* If the encoding is constructed, it shall employ the indefinite length form.
* If the encoding is primitive, it shall include the fewest length octets necessary.
* [Contrast with 8.1.3.2 b).]
* <h4>9.3 Set components</h4>
* The encodings of the component values of a set value shall
* appear in an order determined by their tags as specified
* in 8.6 of ITU-T Rec. X.680 | ISO/IEC 8824-1.
* Additionally, for the purposes of determining the order in which
* components are encoded when one or more component is an untagged
* choice type, each untagged choice type is ordered as though it
* has a tag equal to that of the smallest tag in that choice type
* or any untagged choice types nested within.
*
* <h3>10: Distinguished encoding rules</h3>
* <h4>10.1 Length forms</h4>
* The definite form of length encoding shall be used,
* encoded in the minimum number of octets.
* [Contrast with 8.1.3.2 b).]
* <h4>10.3 Set components</h4>
* The encodings of the component values of a set value shall appear
* in an order determined by their tags as specified
* in 8.6 of ITU-T Rec. X.680 | ISO/IEC 8824-1.
* <blockquote>
* NOTE — Where a component of the set is an untagged choice type,
* the location of that component in the ordering will depend on
* the tag of the choice component being encoded.
* </blockquote>
*
* <h3>11: Restrictions on BER employed by both CER and DER</h3>
* <h4>11.5 Set and sequence components with default value </h4>
* The encoding of a set value or sequence value shall not include
* an encoding for any component value which is equal to
* its default value.
* <h4>11.6 Set-of components </h4>
* <p>
* The encodings of the component values of a set-of value
* shall appear in ascending order, the encodings being compared
* as octet strings with the shorter components being padded at
* their trailing end with 0-octets.
* <blockquote>
* NOTE — The padding octets are for comparison purposes only
* and do not appear in the encodings.
* </blockquote>
*/
public abstract class ASN1Set
extends ASN1Primitive
{
private Vector set = new Vector();
private boolean isSorted = false;
/**
* return an ASN1Set from the given object.
*
* @param obj the object we want converted.
* @exception IllegalArgumentException if the object cannot be converted.
* @return an ASN1Set instance, or null.
*/
public static ASN1Set getInstance(
Object obj)
{
if (obj == null || obj instanceof ASN1Set)
{
return (ASN1Set)obj;
}
else if (obj instanceof ASN1SetParser)
{
return ASN1Set.getInstance(((ASN1SetParser)obj).toASN1Primitive());
}
else if (obj instanceof byte[])
{
try
{
return ASN1Set.getInstance(ASN1Primitive.fromByteArray((byte[])obj));
}
catch (IOException e)
{
throw new IllegalArgumentException("failed to construct set from byte[]: " + e.getMessage());
}
}
else if (obj instanceof ASN1Encodable)
{
ASN1Primitive primitive = ((ASN1Encodable)obj).toASN1Primitive();
if (primitive instanceof ASN1Set)
{
return (ASN1Set)primitive;
}
}
throw new IllegalArgumentException("unknown object in getInstance: " + obj.getClass().getName());
}
/**
* Return an ASN1 set from a tagged object. There is a special
* case here, if an object appears to have been explicitly tagged on
* reading but we were expecting it to be implicitly tagged in the
* normal course of events it indicates that we lost the surrounding
* set - so we need to add it back (this will happen if the tagged
* object is a sequence that contains other sequences). If you are
* dealing with implicitly tagged sets you really <b>should</b>
* be using this method.
*
* @param obj the tagged object.
* @param explicit true if the object is meant to be explicitly tagged
* false otherwise.
* @exception IllegalArgumentException if the tagged object cannot
* be converted.
* @return an ASN1Set instance.
*/
public static ASN1Set getInstance(
ASN1TaggedObject obj,
boolean explicit)
{
if (explicit)
{
if (!obj.isExplicit())
{
throw new IllegalArgumentException("object implicit - explicit expected.");
}
return (ASN1Set)obj.getObject();
}
else
{
//
// constructed object which appears to be explicitly tagged
// and it's really implicit means we have to add the
// surrounding set.
//
if (obj.isExplicit())
{
if (obj instanceof BERTaggedObject)
{
return new BERSet(obj.getObject());
}
else
{
return new DLSet(obj.getObject());
}
}
else
{
if (obj.getObject() instanceof ASN1Set)
{
return (ASN1Set)obj.getObject();
}
//
// in this case the parser returns a sequence, convert it
// into a set.
//
if (obj.getObject() instanceof ASN1Sequence)
{
ASN1Sequence s = (ASN1Sequence)obj.getObject();
if (obj instanceof BERTaggedObject)
{
return new BERSet(s.toArray());
}
else
{
return new DLSet(s.toArray());
}
}
}
}
throw new IllegalArgumentException("unknown object in getInstance: " + obj.getClass().getName());
}
protected ASN1Set()
{
}
/**
* create a sequence containing one object
* @param obj object to be added to the SET.
*/
protected ASN1Set(
ASN1Encodable obj)
{
set.addElement(obj);
}
/**
* create a sequence containing a vector of objects.
* @param v a vector of objects to make up the SET.
* @param doSort true if should be sorted DER style, false otherwise.
*/
protected ASN1Set(
ASN1EncodableVector v,
boolean doSort)
{
for (int i = 0; i != v.size(); i++)
{
set.addElement(v.get(i));
}
if (doSort)
{
this.sort();
}
}
/**
* create a sequence containing a vector of objects.
*/
protected ASN1Set(
ASN1Encodable[] array,
boolean doSort)
{
for (int i = 0; i != array.length; i++)
{
set.addElement(array[i]);
}
if (doSort)
{
this.sort();
}
}
public Enumeration getObjects()
{
return set.elements();
}
/**
* return the object at the set position indicated by index.
*
* @param index the set number (starting at zero) of the object
* @return the object at the set position indicated by index.
*/
public ASN1Encodable getObjectAt(
int index)
{
return (ASN1Encodable)set.elementAt(index);
}
/**
* return the number of objects in this set.
*
* @return the number of objects in this set.
*/
public int size()
{
return set.size();
}
public ASN1Encodable[] toArray()
{
ASN1Encodable[] values = new ASN1Encodable[this.size()];
for (int i = 0; i != this.size(); i++)
{
values[i] = this.getObjectAt(i);
}
return values;
}
public ASN1SetParser parser()
{
final ASN1Set outer = this;
return new ASN1SetParser()
{
private final int max = size();
private int index;
public ASN1Encodable readObject() throws IOException
{
if (index == max)
{
return null;
}
ASN1Encodable obj = getObjectAt(index++);
if (obj instanceof ASN1Sequence)
{
return ((ASN1Sequence)obj).parser();
}
if (obj instanceof ASN1Set)
{
return ((ASN1Set)obj).parser();
}
return obj;
}
public ASN1Primitive getLoadedObject()
{
return outer;
}
public ASN1Primitive toASN1Primitive()
{
return outer;
}
};
}
public int hashCode()
{
Enumeration e = this.getObjects();
int hashCode = size();
while (e.hasMoreElements())
{
Object o = getNext(e);
hashCode *= 17;
hashCode ^= o.hashCode();
}
return hashCode;
}
/**
* Change current SET object to be encoded as {@link DERSet}.
* This is part of Distinguished Encoding Rules form serialization.
*/
ASN1Primitive toDERObject()
{
if (isSorted)
{
ASN1Set derSet = new DERSet();
derSet.set = this.set;
return derSet;
}
else
{
Vector v = new Vector();
for (int i = 0; i != set.size(); i++)
{
v.addElement(set.elementAt(i));
}
ASN1Set derSet = new DERSet();
derSet.set = v;
derSet.sort();
return derSet;
}
}
/**
* Change current SET object to be encoded as {@link DLSet}.
* This is part of Direct Length form serialization.
*/
ASN1Primitive toDLObject()
{
ASN1Set derSet = new DLSet();
derSet.set = this.set;
return derSet;
}
boolean asn1Equals(
ASN1Primitive o)
{
if (!(o instanceof ASN1Set))
{
return false;
}
ASN1Set other = (ASN1Set)o;
if (this.size() != other.size())
{
return false;
}
Enumeration s1 = this.getObjects();
Enumeration s2 = other.getObjects();
while (s1.hasMoreElements())
{
ASN1Encodable obj1 = getNext(s1);
ASN1Encodable obj2 = getNext(s2);
ASN1Primitive o1 = obj1.toASN1Primitive();
ASN1Primitive o2 = obj2.toASN1Primitive();
if (o1 == o2 || o1.equals(o2))
{
continue;
}
return false;
}
return true;
}
private ASN1Encodable getNext(Enumeration e)
{
ASN1Encodable encObj = (ASN1Encodable)e.nextElement();
// unfortunately null was allowed as a substitute for DER null
if (encObj == null)
{
return DERNull.INSTANCE;
}
return encObj;
}
/**
* return true if a <= b (arrays are assumed padded with zeros).
*/
private boolean lessThanOrEqual(
byte[] a,
byte[] b)
{
int len = Math.min(a.length, b.length);
for (int i = 0; i != len; ++i)
{
if (a[i] != b[i])
{
return (a[i] & 0xff) < (b[i] & 0xff);
}
}
return len == a.length;
}
private byte[] getEncoded(
ASN1Encodable obj)
{
ByteArrayOutputStream bOut = new ByteArrayOutputStream();
ASN1OutputStream aOut = new ASN1OutputStream(bOut);
try
{
aOut.writeObject(obj);
}
catch (IOException e)
{
throw new IllegalArgumentException("cannot encode object added to SET");
}
return bOut.toByteArray();
}
protected void sort()
{
if (!isSorted)
{
isSorted = true;
if (set.size() > 1)
{
boolean swapped = true;
int lastSwap = set.size() - 1;
while (swapped)
{
int index = 0;
int swapIndex = 0;
byte[] a = getEncoded((ASN1Encodable)set.elementAt(0));
swapped = false;
while (index != lastSwap)
{
byte[] b = getEncoded((ASN1Encodable)set.elementAt(index + 1));
if (lessThanOrEqual(a, b))
{
a = b;
}
else
{
Object o = set.elementAt(index);
set.setElementAt(set.elementAt(index + 1), index);
set.setElementAt(o, index + 1);
swapped = true;
swapIndex = index;
}
index++;
}
lastSwap = swapIndex;
}
}
}
}
boolean isConstructed()
{
return true;
}
abstract void encode(ASN1OutputStream out)
throws IOException;
public String toString()
{
return set.toString();
}
}
| made use of DER encoding explicit.
| core/src/main/java/org/bouncycastle/asn1/ASN1Set.java | made use of DER encoding explicit. | <ide><path>ore/src/main/java/org/bouncycastle/asn1/ASN1Set.java
<ide> return len == a.length;
<ide> }
<ide>
<del> private byte[] getEncoded(
<add> private byte[] getDEREncoded(
<ide> ASN1Encodable obj)
<ide> {
<ide> ByteArrayOutputStream bOut = new ByteArrayOutputStream();
<del> ASN1OutputStream aOut = new ASN1OutputStream(bOut);
<add> DEROutputStream dOut = new DEROutputStream(bOut);
<ide>
<ide> try
<ide> {
<del> aOut.writeObject(obj);
<add> dOut.writeObject(obj);
<ide> }
<ide> catch (IOException e)
<ide> {
<ide> {
<ide> int index = 0;
<ide> int swapIndex = 0;
<del> byte[] a = getEncoded((ASN1Encodable)set.elementAt(0));
<add> byte[] a = getDEREncoded((ASN1Encodable)set.elementAt(0));
<ide>
<ide> swapped = false;
<ide>
<ide> while (index != lastSwap)
<ide> {
<del> byte[] b = getEncoded((ASN1Encodable)set.elementAt(index + 1));
<add> byte[] b = getDEREncoded((ASN1Encodable)set.elementAt(index + 1));
<ide>
<ide> if (lessThanOrEqual(a, b))
<ide> { |
|
JavaScript | apache-2.0 | 8c58824efbc7de57908e7e84aa078cef0b82ba12 | 0 | bmwshop/brooklyn,bmwshop/brooklyn,andreaturli/legacy-brooklyn,neykov/incubator-brooklyn,bmwshop/brooklyn,aledsage/legacy-brooklyn,aledsage/legacy-brooklyn,andreaturli/legacy-brooklyn,aledsage/legacy-brooklyn,bmwshop/brooklyn,bmwshop/brooklyn,neykov/incubator-brooklyn,andreaturli/legacy-brooklyn,aledsage/legacy-brooklyn,aledsage/legacy-brooklyn,bmwshop/brooklyn,andreaturli/legacy-brooklyn,andreaturli/legacy-brooklyn,neykov/incubator-brooklyn,aledsage/legacy-brooklyn,neykov/incubator-brooklyn,neykov/incubator-brooklyn,andreaturli/legacy-brooklyn,neykov/incubator-brooklyn,andreaturli/legacy-brooklyn,aledsage/legacy-brooklyn,bmwshop/brooklyn | define([
"model/app-tree"
], function (AppTree) {
var apps = new AppTree.Collection
apps.url = "fixtures/application-tree.json"
apps.fetch({async:false})
describe("model/app-tree", function () {
it("loads fixture data", function () {
expect(apps.length).toBe(2)
var app1 = apps.at(0)
expect(app1.get("name")).toBe("test")
expect(app1.get("id")).toBe("riBZUjMq")
expect(app1.get("type")).toBe(null)
expect(app1.get("children").length).toBe(1)
expect(app1.get("children")[0].name).toBe("tomcat1")
expect(app1.get("children")[0].type).toBe("brooklyn.entity.webapp.tomcat.TomcatServer")
expect(apps.at(1).get("children").length).toBe(2)
})
it("has working getDisplayName", function () {
var app1 = apps.at(0)
expect(app1.getDisplayName()).toBe("test")
})
it("has working hasChildren method", function () {
expect(apps.at(0).hasChildren()).toBeTruthy()
})
it("returns AppTree.Collection for getChildren", function () {
var app1 = apps.at(0),
children = new AppTree.Collection(app1.get("children"))
expect(children.length).toBe(1)
expect(children.at(0).getDisplayName()).toBe("tomcat1")
})
})
}) | usage/jsgui/src/test/javascript/specs/model/app-tree-spec.js | define([
"model/app-tree"
], function (AppTree) {
var apps = new AppTree.Collection
apps.url = "fixtures/application-tree.json"
apps.fetch({async:false})
describe("model/app-tree", function () {
it("loads fixture data", function () {
expect(apps.length).toBe(2)
var app1 = apps.at(0)
expect(app1.get("name")).toBe("test")
expect(app1.get("id")).toBe("riBZUjMq")
expect(app1.get("type")).toBe(null)
expect(app1.get("children").length).toBe(1)
expect(app1.get("children")[0].name).toBe("tomcat1")
expect(app1.get("children")[0].type).toBe("brooklyn.entity.webapp.tomcat.TomcatServer")
expect(apps.at(1).get("children").length).toBe(2)
})
it("has working getDisplayName", function () {
var app1 = apps.at(0)
expect(app1.getDisplayName()).toBe("test:riBZUjMq")
})
it("has working hasChildren method", function () {
expect(apps.at(0).hasChildren()).toBeTruthy()
})
it("returns AppTree.Collection for getChildren", function () {
var app1 = apps.at(0),
children = new AppTree.Collection(app1.get("children"))
expect(children.length).toBe(1)
expect(children.at(0).getDisplayName()).toBe("tomcat1:fXyyQ7Ap")
})
})
}) | fix tests for previous app-tree tidy
| usage/jsgui/src/test/javascript/specs/model/app-tree-spec.js | fix tests for previous app-tree tidy | <ide><path>sage/jsgui/src/test/javascript/specs/model/app-tree-spec.js
<ide>
<ide> it("has working getDisplayName", function () {
<ide> var app1 = apps.at(0)
<del> expect(app1.getDisplayName()).toBe("test:riBZUjMq")
<add> expect(app1.getDisplayName()).toBe("test")
<ide> })
<ide>
<ide> it("has working hasChildren method", function () {
<ide> var app1 = apps.at(0),
<ide> children = new AppTree.Collection(app1.get("children"))
<ide> expect(children.length).toBe(1)
<del> expect(children.at(0).getDisplayName()).toBe("tomcat1:fXyyQ7Ap")
<add> expect(children.at(0).getDisplayName()).toBe("tomcat1")
<ide> })
<ide> })
<ide> }) |
|
Java | apache-2.0 | b1d10c5a4c068350d11b5799d1b18a9a88fac355 | 0 | GerritCodeReview/gerrit,qtproject/qtqa-gerrit,GerritCodeReview/gerrit,GerritCodeReview/gerrit,GerritCodeReview/gerrit,GerritCodeReview/gerrit,WANdisco/gerrit,qtproject/qtqa-gerrit,qtproject/qtqa-gerrit,qtproject/qtqa-gerrit,WANdisco/gerrit,WANdisco/gerrit,qtproject/qtqa-gerrit,qtproject/qtqa-gerrit,WANdisco/gerrit,WANdisco/gerrit,GerritCodeReview/gerrit,WANdisco/gerrit,GerritCodeReview/gerrit,WANdisco/gerrit,GerritCodeReview/gerrit,qtproject/qtqa-gerrit | // Copyright (C) 2009 The Android Open Source Project
//
// 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.google.gerrit.server.mail.send;
import com.google.gerrit.common.errors.EmailException;
import com.google.gerrit.extensions.api.changes.RecipientType;
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.Change;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.account.ProjectWatches.NotifyType;
import com.google.gerrit.server.mail.send.ProjectWatch.Watchers;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.RefPermission;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.assistedinject.Assisted;
import java.util.stream.StreamSupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** Notify interested parties of a brand new change. */
public class CreateChangeSender extends NewChangeSender {
private static final Logger log = LoggerFactory.getLogger(CreateChangeSender.class);
public interface Factory {
CreateChangeSender create(Project.NameKey project, Change.Id id);
}
private final PermissionBackend permissionBackend;
@Inject
public CreateChangeSender(
EmailArguments ea,
PermissionBackend permissionBackend,
@Assisted Project.NameKey project,
@Assisted Change.Id id)
throws OrmException {
super(ea, newChangeData(ea, project, id));
this.permissionBackend = permissionBackend;
}
@Override
protected void init() throws EmailException {
super.init();
try {
// Upgrade watching owners from CC and BCC to TO.
Watchers matching =
getWatchers(NotifyType.NEW_CHANGES, !change.isWorkInProgress() && !change.isPrivate());
// TODO(hiesel): Remove special handling for owners
StreamSupport.stream(matching.all().accounts.spliterator(), false)
.filter(acc -> isOwnerOfProjectOrBranch(acc))
.forEach(acc -> add(RecipientType.TO, acc));
// Add everyone else. Owners added above will not be duplicated.
add(RecipientType.TO, matching.to);
add(RecipientType.CC, matching.cc);
add(RecipientType.BCC, matching.bcc);
} catch (OrmException err) {
// Just don't CC everyone. Better to send a partial message to those
// we already have queued up then to fail deliver entirely to people
// who have a lower interest in the change.
log.warn("Cannot notify watchers for new change", err);
}
includeWatchers(NotifyType.NEW_PATCHSETS, !change.isWorkInProgress() && !change.isPrivate());
}
private boolean isOwnerOfProjectOrBranch(Account.Id userId) {
return permissionBackend
.user(identifiedUserFactory.create(userId))
.ref(change.getDest())
.testOrFalse(RefPermission.WRITE_CONFIG);
}
}
| java/com/google/gerrit/server/mail/send/CreateChangeSender.java | // Copyright (C) 2009 The Android Open Source Project
//
// 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.google.gerrit.server.mail.send;
import com.google.gerrit.common.errors.EmailException;
import com.google.gerrit.extensions.api.changes.RecipientType;
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.client.Change;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.account.ProjectWatches.NotifyType;
import com.google.gerrit.server.mail.send.ProjectWatch.Watchers;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.RefPermission;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.assistedinject.Assisted;
import java.util.stream.StreamSupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** Notify interested parties of a brand new change. */
public class CreateChangeSender extends NewChangeSender {
private static final Logger log = LoggerFactory.getLogger(CreateChangeSender.class);
public interface Factory {
CreateChangeSender create(Project.NameKey project, Change.Id id);
}
private final IdentifiedUser.GenericFactory identifiedUserFactory;
private final PermissionBackend permissionBackend;
@Inject
public CreateChangeSender(
EmailArguments ea,
IdentifiedUser.GenericFactory identifiedUserFactory,
PermissionBackend permissionBackend,
@Assisted Project.NameKey project,
@Assisted Change.Id id)
throws OrmException {
super(ea, newChangeData(ea, project, id));
this.identifiedUserFactory = identifiedUserFactory;
this.permissionBackend = permissionBackend;
}
@Override
protected void init() throws EmailException {
super.init();
try {
// Upgrade watching owners from CC and BCC to TO.
Watchers matching =
getWatchers(NotifyType.NEW_CHANGES, !change.isWorkInProgress() && !change.isPrivate());
// TODO(hiesel): Remove special handling for owners
StreamSupport.stream(matching.all().accounts.spliterator(), false)
.filter(acc -> isOwnerOfProjectOrBranch(acc))
.forEach(acc -> add(RecipientType.TO, acc));
// Add everyone else. Owners added above will not be duplicated.
add(RecipientType.TO, matching.to);
add(RecipientType.CC, matching.cc);
add(RecipientType.BCC, matching.bcc);
} catch (OrmException err) {
// Just don't CC everyone. Better to send a partial message to those
// we already have queued up then to fail deliver entirely to people
// who have a lower interest in the change.
log.warn("Cannot notify watchers for new change", err);
}
includeWatchers(NotifyType.NEW_PATCHSETS, !change.isWorkInProgress() && !change.isPrivate());
}
private boolean isOwnerOfProjectOrBranch(Account.Id userId) {
return permissionBackend
.user(identifiedUserFactory.create(userId))
.ref(change.getDest())
.testOrFalse(RefPermission.WRITE_CONFIG);
}
}
| Remove unused variable in CreateChangeSender
Change-Id: I39d6e18be87173ce1c66f1a67bbe9bbbffd347b1
| java/com/google/gerrit/server/mail/send/CreateChangeSender.java | Remove unused variable in CreateChangeSender | <ide><path>ava/com/google/gerrit/server/mail/send/CreateChangeSender.java
<ide> import com.google.gerrit.reviewdb.client.Account;
<ide> import com.google.gerrit.reviewdb.client.Change;
<ide> import com.google.gerrit.reviewdb.client.Project;
<del>import com.google.gerrit.server.IdentifiedUser;
<ide> import com.google.gerrit.server.account.ProjectWatches.NotifyType;
<ide> import com.google.gerrit.server.mail.send.ProjectWatch.Watchers;
<ide> import com.google.gerrit.server.permissions.PermissionBackend;
<ide> CreateChangeSender create(Project.NameKey project, Change.Id id);
<ide> }
<ide>
<del> private final IdentifiedUser.GenericFactory identifiedUserFactory;
<ide> private final PermissionBackend permissionBackend;
<ide>
<ide> @Inject
<ide> public CreateChangeSender(
<ide> EmailArguments ea,
<del> IdentifiedUser.GenericFactory identifiedUserFactory,
<ide> PermissionBackend permissionBackend,
<ide> @Assisted Project.NameKey project,
<ide> @Assisted Change.Id id)
<ide> throws OrmException {
<ide> super(ea, newChangeData(ea, project, id));
<del> this.identifiedUserFactory = identifiedUserFactory;
<ide> this.permissionBackend = permissionBackend;
<ide> }
<ide> |
|
JavaScript | mit | b71e3763932588087e1caa7336bec6e78fd17609 | 0 | Tudmotu/gnome-shell-extension-clipboard-indicator,RaphaelRochet/gnome-shell-extension-clipboard-indicator,RaphaelRochet/gnome-shell-extension-clipboard-indicator | const GObject = imports.gi.GObject;
const Gtk = imports.gi.Gtk;
const Gio = imports.gi.Gio;
const Lang = imports.lang;
const Extension = imports.misc.extensionUtils.getCurrentExtension();
const Utils = Extension.imports.utils;
const prettyPrint = Utils.prettyPrint;
const Gettext = imports.gettext;
const _ = Gettext.domain('clipboard-indicator').gettext;
var Fields = {
INTERVAL : 'refresh-interval',
HISTORY_SIZE : 'history-size',
PREVIEW_SIZE : 'preview-size',
CACHE_FILE_SIZE : 'cache-size',
CACHE_ONLY_FAVORITE : 'cache-only-favorites',
DELETE : 'enable-deletion',
NOTIFY_ON_COPY : 'notify-on-copy',
MOVE_ITEM_FIRST : 'move-item-first',
ENABLE_KEYBINDING : 'enable-keybindings',
TOPBAR_PREVIEW_SIZE: 'topbar-preview-size',
TOPBAR_DISPLAY_MODE_ID : 'display-mode',
STRIP_TEXT : 'strip-text'
};
const SCHEMA_NAME = 'org.gnome.shell.extensions.clipboard-indicator';
const getSchema = function () {
let schemaDir = Extension.dir.get_child('schemas').get_path();
let schemaSource = Gio.SettingsSchemaSource.new_from_directory(schemaDir, Gio.SettingsSchemaSource.get_default(), false);
let schema = schemaSource.lookup(SCHEMA_NAME, false);
return new Gio.Settings({ settings_schema: schema });
};
var SettingsSchema = getSchema();
function init() {
let localeDir = Extension.dir.get_child('locale');
if (localeDir.query_exists(null))
Gettext.bindtextdomain('clipboard-indicator', localeDir.get_path());
}
const App = new Lang.Class({
Name: 'ClipboardIndicator.App',
_init: function() {
this.main = new Gtk.Grid({
margin: 10,
row_spacing: 12,
column_spacing: 18,
column_homogeneous: false,
row_homogeneous: false
});
this.field_interval = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 500,
upper: 5000,
step_increment: 100
})
});
this.field_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 1,
upper: 200,
step_increment: 1
})
});
this.field_preview_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 10,
upper: 100,
step_increment: 1
})
});
this.field_cache_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 512,
upper: Math.pow(2, 14),
step_increment: 1
})
});
this.field_topbar_preview_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 1,
upper: 100,
step_increment: 1
})
});
this.field_display_mode = new Gtk.ComboBox({
model: this._create_display_mode_options()});
let rendererText = new Gtk.CellRendererText();
this.field_display_mode.pack_start (rendererText, false);
this.field_display_mode.add_attribute (rendererText, "text", 0);
this.field_cache_disable = new Gtk.Switch();
this.field_notification_toggle = new Gtk.Switch();
this.field_strip_text = new Gtk.Switch();
this.field_move_item_first = new Gtk.Switch();
this.field_keybinding = createKeybindingWidget(SettingsSchema);
addKeybinding(this.field_keybinding.model, SettingsSchema, "toggle-menu",
_("Toggle the menu"));
addKeybinding(this.field_keybinding.model, SettingsSchema, "clear-history",
_("Clear history"));
addKeybinding(this.field_keybinding.model, SettingsSchema, "prev-entry",
_("Previous entry"));
addKeybinding(this.field_keybinding.model, SettingsSchema, "next-entry",
_("Next entry"));
var that = this;
this.field_keybinding_activation = new Gtk.Switch();
this.field_keybinding_activation.connect("notify::active", function(widget){
that.field_keybinding.set_sensitive(widget.active);
});
let sizeLabel = new Gtk.Label({
label: _("History Size"),
hexpand: true,
halign: Gtk.Align.START
});
let intervalLabel = new Gtk.Label({
label: _("Refresh Interval (ms)"),
hexpand: true,
halign: Gtk.Align.START
});
let previewLabel = new Gtk.Label({
label: _("Preview Size (characters)"),
hexpand: true,
halign: Gtk.Align.START
});
let cacheSizeLabel = new Gtk.Label({
label: _("Max cache file size (kb)"),
hexpand: true,
halign: Gtk.Align.START
});
let cacheDisableLabel = new Gtk.Label({
label: _("Cache only favorites"),
hexpand: true,
halign: Gtk.Align.START
});
let notificationLabel = new Gtk.Label({
label: _("Show notification on copy"),
hexpand: true,
halign: Gtk.Align.START
});
let moveFirstLabel = new Gtk.Label({
label: _("Move item to the top after selection"),
hexpand: true,
halign: Gtk.Align.START
});
let keybindingLabel = new Gtk.Label({
label: _("Keyboard shortcuts"),
hexpand: true,
halign: Gtk.Align.START
});
let topbarPreviewLabel = new Gtk.Label({
label: _("Number of characters in top bar"),
hexpand: true,
halign: Gtk.Align.START
});
let displayModeLabel = new Gtk.Label({
label: _("What to show in top bar"),
hexpand: true,
halign: Gtk.Align.START
});
let stripTextLabel = new Gtk.Label({
label: _("Remove whitespace around text"),
hexpand: true,
halign: Gtk.Align.START
});
const addRow = ((main) => {
let row = 0;
return (label, input) => {
let inputWidget = input;
if (input instanceof Gtk.Switch) {
inputWidget = new Gtk.HBox();
inputWidget.pack_end(input, false, false, 0);
}
if (label) {
main.attach(label, 0, row, 1, 1);
main.attach(inputWidget, 1, row, 1, 1);
}
else {
main.attach(inputWidget, 0, row, 2, 1);
}
row++;
};
})(this.main);
addRow(sizeLabel, this.field_size);
addRow(previewLabel, this.field_preview_size);
addRow(intervalLabel, this.field_interval);
addRow(cacheSizeLabel, this.field_cache_size);
addRow(cacheDisableLabel, this.field_cache_disable);
addRow(notificationLabel, this.field_notification_toggle);
addRow(displayModeLabel, this.field_display_mode);
addRow(topbarPreviewLabel, this.field_topbar_preview_size);
addRow(stripTextLabel, this.field_strip_text);
addRow(moveFirstLabel, this.field_move_item_first);
addRow(keybindingLabel, this.field_keybinding_activation);
addRow(null, this.field_keybinding);
SettingsSchema.bind(Fields.INTERVAL, this.field_interval, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.HISTORY_SIZE, this.field_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.PREVIEW_SIZE, this.field_preview_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.CACHE_FILE_SIZE, this.field_cache_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.CACHE_ONLY_FAVORITE, this.field_cache_disable, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.NOTIFY_ON_COPY, this.field_notification_toggle, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.MOVE_ITEM_FIRST, this.field_move_item_first, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.TOPBAR_DISPLAY_MODE_ID, this.field_display_mode, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.TOPBAR_PREVIEW_SIZE, this.field_topbar_preview_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.STRIP_TEXT, this.field_strip_text, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.ENABLE_KEYBINDING, this.field_keybinding_activation, 'active', Gio.SettingsBindFlags.DEFAULT);
this.main.show_all();
},
_create_display_mode_options : function(){
let options = [{ name: _("Icon") },
{ name: _("Clipboard Content"),},
{ name: _("Both")}];
let liststore = new Gtk.ListStore();
liststore.set_column_types([GObject.TYPE_STRING])
for (let i = 0; i < options.length; i++ ) {
let option = options[i];
let iter = liststore.append();
liststore.set (iter, [0], [option.name]);
}
return liststore;
}
});
function buildPrefsWidget(){
let widget = new App();
return widget.main;
}
//binding widgets
//////////////////////////////////
const COLUMN_ID = 0;
const COLUMN_DESCRIPTION = 1;
const COLUMN_KEY = 2;
const COLUMN_MODS = 3;
function addKeybinding(model, settings, id, description) {
// Get the current accelerator.
let accelerator = settings.get_strv(id)[0];
let key, mods;
if (accelerator == null)
[key, mods] = [0, 0];
else
[key, mods] = Gtk.accelerator_parse(settings.get_strv(id)[0]);
// Add a row for the keybinding.
let row = model.insert(100); // Erm...
model.set(row,
[COLUMN_ID, COLUMN_DESCRIPTION, COLUMN_KEY, COLUMN_MODS],
[id, description, key, mods]);
}
function createKeybindingWidget(SettingsSchema) {
let model = new Gtk.ListStore();
model.set_column_types(
[GObject.TYPE_STRING, // COLUMN_ID
GObject.TYPE_STRING, // COLUMN_DESCRIPTION
GObject.TYPE_INT, // COLUMN_KEY
GObject.TYPE_INT]); // COLUMN_MODS
let treeView = new Gtk.TreeView();
treeView.model = model;
treeView.headers_visible = false;
let column, renderer;
// Description column.
renderer = new Gtk.CellRendererText();
column = new Gtk.TreeViewColumn();
column.expand = true;
column.pack_start(renderer, true);
column.add_attribute(renderer, "text", COLUMN_DESCRIPTION);
treeView.append_column(column);
// Key binding column.
renderer = new Gtk.CellRendererAccel();
renderer.accel_mode = Gtk.CellRendererAccelMode.GTK;
renderer.editable = true;
renderer.connect("accel-edited",
function (renderer, path, key, mods, hwCode) {
let [ok, iter] = model.get_iter_from_string(path);
if(!ok)
return;
// Update the UI.
model.set(iter, [COLUMN_KEY, COLUMN_MODS], [key, mods]);
// Update the stored setting.
let id = model.get_value(iter, COLUMN_ID);
let accelString = Gtk.accelerator_name(key, mods);
SettingsSchema.set_strv(id, [accelString]);
});
renderer.connect("accel-cleared",
function (renderer, path) {
let [ok, iter] = model.get_iter_from_string(path);
if(!ok)
return;
// Update the UI.
model.set(iter, [COLUMN_KEY, COLUMN_MODS], [0, 0]);
// Update the stored setting.
let id = model.get_value(iter, COLUMN_ID);
SettingsSchema.set_strv(id, []);
});
column = new Gtk.TreeViewColumn();
column.pack_end(renderer, false);
column.add_attribute(renderer, "accel-key", COLUMN_KEY);
column.add_attribute(renderer, "accel-mods", COLUMN_MODS);
treeView.append_column(column);
return treeView;
}
| prefs.js | const GObject = imports.gi.GObject;
const Gtk = imports.gi.Gtk;
const Gio = imports.gi.Gio;
const Lang = imports.lang;
const Extension = imports.misc.extensionUtils.getCurrentExtension();
const Utils = Extension.imports.utils;
const prettyPrint = Utils.prettyPrint;
const Gettext = imports.gettext;
const _ = Gettext.domain('clipboard-indicator').gettext;
const Fields = {
INTERVAL : 'refresh-interval',
HISTORY_SIZE : 'history-size',
PREVIEW_SIZE : 'preview-size',
CACHE_FILE_SIZE : 'cache-size',
CACHE_ONLY_FAVORITE : 'cache-only-favorites',
DELETE : 'enable-deletion',
NOTIFY_ON_COPY : 'notify-on-copy',
MOVE_ITEM_FIRST : 'move-item-first',
ENABLE_KEYBINDING : 'enable-keybindings',
TOPBAR_PREVIEW_SIZE: 'topbar-preview-size',
TOPBAR_DISPLAY_MODE_ID : 'display-mode',
STRIP_TEXT : 'strip-text'
};
const SCHEMA_NAME = 'org.gnome.shell.extensions.clipboard-indicator';
const getSchema = function () {
let schemaDir = Extension.dir.get_child('schemas').get_path();
let schemaSource = Gio.SettingsSchemaSource.new_from_directory(schemaDir, Gio.SettingsSchemaSource.get_default(), false);
let schema = schemaSource.lookup(SCHEMA_NAME, false);
return new Gio.Settings({ settings_schema: schema });
};
const SettingsSchema = getSchema();
function init() {
let localeDir = Extension.dir.get_child('locale');
if (localeDir.query_exists(null))
Gettext.bindtextdomain('clipboard-indicator', localeDir.get_path());
}
const App = new Lang.Class({
Name: 'ClipboardIndicator.App',
_init: function() {
this.main = new Gtk.Grid({
margin: 10,
row_spacing: 12,
column_spacing: 18,
column_homogeneous: false,
row_homogeneous: false
});
this.field_interval = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 500,
upper: 5000,
step_increment: 100
})
});
this.field_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 1,
upper: 200,
step_increment: 1
})
});
this.field_preview_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 10,
upper: 100,
step_increment: 1
})
});
this.field_cache_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 512,
upper: Math.pow(2, 14),
step_increment: 1
})
});
this.field_topbar_preview_size = new Gtk.SpinButton({
adjustment: new Gtk.Adjustment({
lower: 1,
upper: 100,
step_increment: 1
})
});
this.field_display_mode = new Gtk.ComboBox({
model: this._create_display_mode_options()});
let rendererText = new Gtk.CellRendererText();
this.field_display_mode.pack_start (rendererText, false);
this.field_display_mode.add_attribute (rendererText, "text", 0);
this.field_cache_disable = new Gtk.Switch();
this.field_notification_toggle = new Gtk.Switch();
this.field_strip_text = new Gtk.Switch();
this.field_move_item_first = new Gtk.Switch();
this.field_keybinding = createKeybindingWidget(SettingsSchema);
addKeybinding(this.field_keybinding.model, SettingsSchema, "toggle-menu",
_("Toggle the menu"));
addKeybinding(this.field_keybinding.model, SettingsSchema, "clear-history",
_("Clear history"));
addKeybinding(this.field_keybinding.model, SettingsSchema, "prev-entry",
_("Previous entry"));
addKeybinding(this.field_keybinding.model, SettingsSchema, "next-entry",
_("Next entry"));
var that = this;
this.field_keybinding_activation = new Gtk.Switch();
this.field_keybinding_activation.connect("notify::active", function(widget){
that.field_keybinding.set_sensitive(widget.active);
});
//this.field_deletion = new Gtk.Switch({
//active: true
//});
let sizeLabel = new Gtk.Label({
label: _("History Size"),
hexpand: true,
halign: Gtk.Align.START
});
let intervalLabel = new Gtk.Label({
label: _("Refresh Interval (ms)"),
hexpand: true,
halign: Gtk.Align.START
});
let previewLabel = new Gtk.Label({
label: _("Preview Size (characters)"),
hexpand: true,
halign: Gtk.Align.START
});
let cacheSizeLabel = new Gtk.Label({
label: _("Max cache file size (kb)"),
hexpand: true,
halign: Gtk.Align.START
});
let cacheDisableLabel = new Gtk.Label({
label: _("Cache only favorites"),
hexpand: true,
halign: Gtk.Align.START
});
let notificationLabel = new Gtk.Label({
label: _("Show notification on copy"),
hexpand: true,
halign: Gtk.Align.START
});
let moveFirstLabel = new Gtk.Label({
label: _("Move item to the top after selection"),
hexpand: true,
halign: Gtk.Align.START
});
let keybindingLabel = new Gtk.Label({
label: _("Keyboard shortcuts"),
hexpand: true,
halign: Gtk.Align.START
});
let topbarPreviewLabel = new Gtk.Label({
label: _("Number of characters in top bar"),
hexpand: true,
halign: Gtk.Align.START
});
let displayModeLabel = new Gtk.Label({
label: _("What to show in top bar"),
hexpand: true,
halign: Gtk.Align.START
});
let stripTextLabel = new Gtk.Label({
label: _("Remove whitespace around text"),
hexpand: true,
halign: Gtk.Align.START
});
//let deleteLabel = new Gtk.Label({
//label: _("Enable Deletion"),
//hexpand: true,
//halign: Gtk.Align.START
//});
this.main.attach(sizeLabel , 2, 1, 2 ,1);
this.main.attach(previewLabel , 2, 2, 2 ,1);
this.main.attach(intervalLabel , 2, 3, 2 ,1);
this.main.attach(cacheSizeLabel , 2, 4, 2 ,1);
this.main.attach(cacheDisableLabel , 2, 5, 2 ,1);
//this.main.attach(deleteLabel , 2, 4, 2 ,1);
this.main.attach(notificationLabel , 2, 6, 2 ,1);
this.main.attach(displayModeLabel , 2, 7, 2, 1);
this.main.attach(topbarPreviewLabel , 2, 8, 2 ,1);
this.main.attach(stripTextLabel , 2, 9, 2 ,1);
this.main.attach(moveFirstLabel , 2, 10, 2 ,1);
this.main.attach(keybindingLabel , 2, 11, 2 ,1);
this.main.attach(this.field_size , 4, 1, 2, 1);
this.main.attach(this.field_preview_size , 4, 2, 2, 1);
this.main.attach(this.field_interval , 4, 3, 2, 1);
this.main.attach(this.field_cache_size , 4, 4, 2, 1);
this.main.attach(this.field_cache_disable , 4, 5, 2, 1);
//this.main.attach(this.field_deletion , 4, 4, 2, 1);
this.main.attach(this.field_notification_toggle , 4, 6, 2, 1);
this.main.attach(this.field_display_mode , 4, 7, 2, 1);
this.main.attach(this.field_topbar_preview_size , 4, 8, 2, 1);
this.main.attach(this.field_strip_text , 4, 9, 2, 1);
this.main.attach(this.field_move_item_first , 4, 10, 2, 1);
this.main.attach(this.field_keybinding_activation , 4, 11, 2, 1);
this.main.attach(this.field_keybinding , 2, 12, 4, 2);
SettingsSchema.bind(Fields.INTERVAL, this.field_interval, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.HISTORY_SIZE, this.field_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.PREVIEW_SIZE, this.field_preview_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.CACHE_FILE_SIZE, this.field_cache_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.CACHE_ONLY_FAVORITE, this.field_cache_disable, 'active', Gio.SettingsBindFlags.DEFAULT);
//SettingsSchema.bind(Fields.DELETE, this.field_deletion, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.NOTIFY_ON_COPY, this.field_notification_toggle, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.MOVE_ITEM_FIRST, this.field_move_item_first, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.TOPBAR_DISPLAY_MODE_ID, this.field_display_mode, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.TOPBAR_PREVIEW_SIZE, this.field_topbar_preview_size, 'value', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.STRIP_TEXT, this.field_strip_text, 'active', Gio.SettingsBindFlags.DEFAULT);
SettingsSchema.bind(Fields.ENABLE_KEYBINDING, this.field_keybinding_activation, 'active', Gio.SettingsBindFlags.DEFAULT);
this.main.show_all();
},
_create_display_mode_options : function(){
let options = [{ name: _("Icon") },
{ name: _("Clipboard Content"),},
{ name: _("Both")}];
let liststore = new Gtk.ListStore();
liststore.set_column_types([GObject.TYPE_STRING])
for (let i = 0; i < options.length; i++ ) {
let option = options[i];
let iter = liststore.append();
liststore.set (iter, [0], [option.name]);
}
return liststore;
}
});
function buildPrefsWidget(){
let widget = new App();
return widget.main;
}
//binding widgets
//////////////////////////////////
const COLUMN_ID = 0;
const COLUMN_DESCRIPTION = 1;
const COLUMN_KEY = 2;
const COLUMN_MODS = 3;
function addKeybinding(model, settings, id, description) {
// Get the current accelerator.
let accelerator = settings.get_strv(id)[0];
let key, mods;
if (accelerator == null)
[key, mods] = [0, 0];
else
[key, mods] = Gtk.accelerator_parse(settings.get_strv(id)[0]);
// Add a row for the keybinding.
let row = model.insert(100); // Erm...
model.set(row,
[COLUMN_ID, COLUMN_DESCRIPTION, COLUMN_KEY, COLUMN_MODS],
[id, description, key, mods]);
}
function createKeybindingWidget(SettingsSchema) {
let model = new Gtk.ListStore();
model.set_column_types(
[GObject.TYPE_STRING, // COLUMN_ID
GObject.TYPE_STRING, // COLUMN_DESCRIPTION
GObject.TYPE_INT, // COLUMN_KEY
GObject.TYPE_INT]); // COLUMN_MODS
let treeView = new Gtk.TreeView();
treeView.model = model;
treeView.headers_visible = false;
let column, renderer;
// Description column.
renderer = new Gtk.CellRendererText();
column = new Gtk.TreeViewColumn();
column.expand = true;
column.pack_start(renderer, true);
column.add_attribute(renderer, "text", COLUMN_DESCRIPTION);
treeView.append_column(column);
// Key binding column.
renderer = new Gtk.CellRendererAccel();
renderer.accel_mode = Gtk.CellRendererAccelMode.GTK;
renderer.editable = true;
renderer.connect("accel-edited",
function (renderer, path, key, mods, hwCode) {
let [ok, iter] = model.get_iter_from_string(path);
if(!ok)
return;
// Update the UI.
model.set(iter, [COLUMN_KEY, COLUMN_MODS], [key, mods]);
// Update the stored setting.
let id = model.get_value(iter, COLUMN_ID);
let accelString = Gtk.accelerator_name(key, mods);
SettingsSchema.set_strv(id, [accelString]);
});
renderer.connect("accel-cleared",
function (renderer, path) {
let [ok, iter] = model.get_iter_from_string(path);
if(!ok)
return;
// Update the UI.
model.set(iter, [COLUMN_KEY, COLUMN_MODS], [0, 0]);
// Update the stored setting.
let id = model.get_value(iter, COLUMN_ID);
SettingsSchema.set_strv(id, []);
});
column = new Gtk.TreeViewColumn();
column.pack_end(renderer, false);
column.add_attribute(renderer, "accel-key", COLUMN_KEY);
column.add_attribute(renderer, "accel-mods", COLUMN_MODS);
treeView.append_column(column);
return treeView;
}
| Fix size of Gtk.Switch widgets in settings and refactor code a bit
| prefs.js | Fix size of Gtk.Switch widgets in settings and refactor code a bit | <ide><path>refs.js
<ide> const Gettext = imports.gettext;
<ide> const _ = Gettext.domain('clipboard-indicator').gettext;
<ide>
<del>const Fields = {
<add>var Fields = {
<ide> INTERVAL : 'refresh-interval',
<ide> HISTORY_SIZE : 'history-size',
<ide> PREVIEW_SIZE : 'preview-size',
<ide> return new Gio.Settings({ settings_schema: schema });
<ide> };
<ide>
<del>const SettingsSchema = getSchema();
<add>var SettingsSchema = getSchema();
<ide>
<ide>
<ide> function init() {
<ide> const App = new Lang.Class({
<ide> Name: 'ClipboardIndicator.App',
<ide> _init: function() {
<del> this.main = new Gtk.Grid({
<add> this.main = new Gtk.Grid({
<ide> margin: 10,
<ide> row_spacing: 12,
<ide> column_spacing: 18,
<ide> that.field_keybinding.set_sensitive(widget.active);
<ide> });
<ide>
<del> //this.field_deletion = new Gtk.Switch({
<del> //active: true
<del> //});
<del>
<ide> let sizeLabel = new Gtk.Label({
<ide> label: _("History Size"),
<ide> hexpand: true,
<ide> hexpand: true,
<ide> halign: Gtk.Align.START
<ide> });
<del> //let deleteLabel = new Gtk.Label({
<del> //label: _("Enable Deletion"),
<del> //hexpand: true,
<del> //halign: Gtk.Align.START
<del> //});
<del> this.main.attach(sizeLabel , 2, 1, 2 ,1);
<del> this.main.attach(previewLabel , 2, 2, 2 ,1);
<del> this.main.attach(intervalLabel , 2, 3, 2 ,1);
<del> this.main.attach(cacheSizeLabel , 2, 4, 2 ,1);
<del> this.main.attach(cacheDisableLabel , 2, 5, 2 ,1);
<del> //this.main.attach(deleteLabel , 2, 4, 2 ,1);
<del> this.main.attach(notificationLabel , 2, 6, 2 ,1);
<del> this.main.attach(displayModeLabel , 2, 7, 2, 1);
<del> this.main.attach(topbarPreviewLabel , 2, 8, 2 ,1);
<del> this.main.attach(stripTextLabel , 2, 9, 2 ,1);
<del> this.main.attach(moveFirstLabel , 2, 10, 2 ,1);
<del> this.main.attach(keybindingLabel , 2, 11, 2 ,1);
<del>
<del> this.main.attach(this.field_size , 4, 1, 2, 1);
<del> this.main.attach(this.field_preview_size , 4, 2, 2, 1);
<del> this.main.attach(this.field_interval , 4, 3, 2, 1);
<del> this.main.attach(this.field_cache_size , 4, 4, 2, 1);
<del> this.main.attach(this.field_cache_disable , 4, 5, 2, 1);
<del> //this.main.attach(this.field_deletion , 4, 4, 2, 1);
<del> this.main.attach(this.field_notification_toggle , 4, 6, 2, 1);
<del> this.main.attach(this.field_display_mode , 4, 7, 2, 1);
<del> this.main.attach(this.field_topbar_preview_size , 4, 8, 2, 1);
<del> this.main.attach(this.field_strip_text , 4, 9, 2, 1);
<del> this.main.attach(this.field_move_item_first , 4, 10, 2, 1);
<del> this.main.attach(this.field_keybinding_activation , 4, 11, 2, 1);
<del> this.main.attach(this.field_keybinding , 2, 12, 4, 2);
<add>
<add> const addRow = ((main) => {
<add> let row = 0;
<add> return (label, input) => {
<add> let inputWidget = input;
<add>
<add> if (input instanceof Gtk.Switch) {
<add> inputWidget = new Gtk.HBox();
<add> inputWidget.pack_end(input, false, false, 0);
<add> }
<add>
<add> if (label) {
<add> main.attach(label, 0, row, 1, 1);
<add> main.attach(inputWidget, 1, row, 1, 1);
<add> }
<add> else {
<add> main.attach(inputWidget, 0, row, 2, 1);
<add> }
<add>
<add> row++;
<add> };
<add> })(this.main);
<add>
<add> addRow(sizeLabel, this.field_size);
<add> addRow(previewLabel, this.field_preview_size);
<add> addRow(intervalLabel, this.field_interval);
<add> addRow(cacheSizeLabel, this.field_cache_size);
<add> addRow(cacheDisableLabel, this.field_cache_disable);
<add> addRow(notificationLabel, this.field_notification_toggle);
<add> addRow(displayModeLabel, this.field_display_mode);
<add> addRow(topbarPreviewLabel, this.field_topbar_preview_size);
<add> addRow(stripTextLabel, this.field_strip_text);
<add> addRow(moveFirstLabel, this.field_move_item_first);
<add> addRow(keybindingLabel, this.field_keybinding_activation);
<add> addRow(null, this.field_keybinding);
<ide>
<ide> SettingsSchema.bind(Fields.INTERVAL, this.field_interval, 'value', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.HISTORY_SIZE, this.field_size, 'value', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.PREVIEW_SIZE, this.field_preview_size, 'value', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.CACHE_FILE_SIZE, this.field_cache_size, 'value', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.CACHE_ONLY_FAVORITE, this.field_cache_disable, 'active', Gio.SettingsBindFlags.DEFAULT);
<del> //SettingsSchema.bind(Fields.DELETE, this.field_deletion, 'active', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.NOTIFY_ON_COPY, this.field_notification_toggle, 'active', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.MOVE_ITEM_FIRST, this.field_move_item_first, 'active', Gio.SettingsBindFlags.DEFAULT);
<ide> SettingsSchema.bind(Fields.TOPBAR_DISPLAY_MODE_ID, this.field_display_mode, 'active', Gio.SettingsBindFlags.DEFAULT); |
|
Java | apache-2.0 | b8285a08ee926bed4441a1420e9c52730671bbf6 | 0 | org-tigris-jsapar/jsapar | package org.jsapar.schema;
import java.io.IOException;
import java.io.Writer;
import org.jsapar.Cell;
public class CsvSchemaCell extends SchemaCell {
private final static String replaceString = "\u00A0"; // non-breaking space
public CsvSchemaCell(String sName) {
super(sName);
}
public CsvSchemaCell(String sName, SchemaCellFormat cellFormat) {
super(sName, cellFormat);
}
public CsvSchemaCell() {
super();
}
void output(Cell cell, Writer writer, String cellSeparator, char quoteChar) throws IOException {
String sValue = format(cell);
if (quoteChar == 0)
sValue = sValue.replace(cellSeparator, replaceString);
else {
if (sValue.contains(cellSeparator) || (!sValue.isEmpty() && sValue.charAt(0) ==quoteChar))
sValue = quoteChar + sValue + quoteChar;
}
writer.write(sValue);
}
@Override
public CsvSchemaCell clone() {
return (CsvSchemaCell) super.clone();
}
}
| src/main/java/org/jsapar/schema/CsvSchemaCell.java | package org.jsapar.schema;
import java.io.IOException;
import java.io.Writer;
import org.jsapar.Cell;
public class CsvSchemaCell extends SchemaCell {
private final static String replaceString = "\u00A0"; // non-breaking space
public CsvSchemaCell(String sName) {
super(sName);
}
public CsvSchemaCell(String sName, SchemaCellFormat cellFormat) {
super(sName, cellFormat);
}
public CsvSchemaCell() {
super();
}
void output(Cell cell, Writer writer, String cellSeparator, char quoteChar) throws IOException {
String sValue = format(cell);
if (quoteChar == 0)
sValue = sValue.replace(cellSeparator, replaceString);
else {
if (sValue.contains(cellSeparator) || sValue.charAt(0) ==quoteChar)
sValue = quoteChar + sValue + quoteChar;
}
writer.write(sValue);
}
@Override
public CsvSchemaCell clone() {
return (CsvSchemaCell) super.clone();
}
}
| Needs to check for empty string first
| src/main/java/org/jsapar/schema/CsvSchemaCell.java | Needs to check for empty string first | <ide><path>rc/main/java/org/jsapar/schema/CsvSchemaCell.java
<ide> if (quoteChar == 0)
<ide> sValue = sValue.replace(cellSeparator, replaceString);
<ide> else {
<del> if (sValue.contains(cellSeparator) || sValue.charAt(0) ==quoteChar)
<add> if (sValue.contains(cellSeparator) || (!sValue.isEmpty() && sValue.charAt(0) ==quoteChar))
<ide> sValue = quoteChar + sValue + quoteChar;
<ide> }
<ide> writer.write(sValue); |
|
Java | apache-2.0 | 56772eeb6c84bbfaf7f047e6ef3d71edf020d162 | 0 | brenuart/spring-cloud-netflix,brenuart/spring-cloud-netflix,ryanjbaxter/spring-cloud-netflix,joshiste/spring-cloud-netflix,spring-cloud/spring-cloud-netflix,sfat/spring-cloud-netflix,ryanjbaxter/spring-cloud-netflix,brenuart/spring-cloud-netflix,joshiste/spring-cloud-netflix,spring-cloud/spring-cloud-netflix,brenuart/spring-cloud-netflix,joshiste/spring-cloud-netflix,joshiste/spring-cloud-netflix,sfat/spring-cloud-netflix,brenuart/spring-cloud-netflix,ryanjbaxter/spring-cloud-netflix,ryanjbaxter/spring-cloud-netflix,joshiste/spring-cloud-netflix,sfat/spring-cloud-netflix,sfat/spring-cloud-netflix,sfat/spring-cloud-netflix,ryanjbaxter/spring-cloud-netflix | /*
* Copyright 2014-2018 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.cloud.netflix.turbine.stream;
import java.time.Duration;
import java.util.Collections;
import java.util.Map;
import com.netflix.turbine.aggregator.InstanceKey;
import com.netflix.turbine.aggregator.StreamAggregator;
import com.netflix.turbine.internal.JsonUtility;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Flux;
import rx.Observable;
import rx.RxReactiveStreams;
import rx.subjects.PublishSubject;
@RestController
public class TurbineController {
private static final Log log = LogFactory.getLog(TurbineController.class);
private final Flux<String> flux;
public TurbineController(PublishSubject<Map<String, Object>> hystrixSubject) {
Observable<Map<String, Object>> stream = StreamAggregator.aggregateGroupedStreams(hystrixSubject.groupBy(
data -> InstanceKey.create((String) data.get("instanceId"))))
.doOnUnsubscribe(() -> log.info("Unsubscribing aggregation."))
.doOnSubscribe(() -> log.info("Starting aggregation")).flatMap(o -> o);
Flux<Map<String, Object>> ping = Flux.interval(Duration.ofSeconds(5), Duration.ofSeconds(10))
.map(l -> Collections.singletonMap("type", (Object) "ping"))
.share();
flux = Flux.merge(RxReactiveStreams.toPublisher(stream), ping)
.share().map(map -> JsonUtility.mapToJson(map));
}
@GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE)
public Flux<String> stream() {
return this.flux;
}
}
| spring-cloud-netflix-turbine-stream/src/main/java/org/springframework/cloud/netflix/turbine/stream/TurbineController.java | /*
* Copyright 2014-2018 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.cloud.netflix.turbine.stream;
import java.time.Duration;
import java.util.Collections;
import java.util.Map;
import com.netflix.turbine.aggregator.InstanceKey;
import com.netflix.turbine.aggregator.StreamAggregator;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Flux;
import rx.Observable;
import rx.RxReactiveStreams;
import rx.subjects.PublishSubject;
@RestController
public class TurbineController {
private static final Log log = LogFactory.getLog(TurbineController.class);
private final Flux<Map<String, Object>> flux;
public TurbineController(PublishSubject<Map<String, Object>> hystrixSubject) {
Observable<Map<String, Object>> stream = StreamAggregator.aggregateGroupedStreams(hystrixSubject.groupBy(
data -> InstanceKey.create((String) data.get("instanceId"))))
.doOnUnsubscribe(() -> log.info("Unsubscribing aggregation."))
.doOnSubscribe(() -> log.info("Starting aggregation")).flatMap(o -> o);
Flux<Map<String, Object>> ping = Flux.interval(Duration.ofSeconds(5), Duration.ofSeconds(10))
.map(l -> Collections.singletonMap("type", (Object) "ping"))
.share();
flux = Flux.merge(RxReactiveStreams.toPublisher(stream), ping)
.share();
}
@GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE)
public Flux<Map<String, Object>> stream() {
return this.flux;
}
}
| Converts Map to JSON. Fixes json format errors with Hystrix Dashboard. (#2950)
| spring-cloud-netflix-turbine-stream/src/main/java/org/springframework/cloud/netflix/turbine/stream/TurbineController.java | Converts Map to JSON. Fixes json format errors with Hystrix Dashboard. (#2950) | <ide><path>pring-cloud-netflix-turbine-stream/src/main/java/org/springframework/cloud/netflix/turbine/stream/TurbineController.java
<ide>
<ide> import com.netflix.turbine.aggregator.InstanceKey;
<ide> import com.netflix.turbine.aggregator.StreamAggregator;
<add>import com.netflix.turbine.internal.JsonUtility;
<ide> import org.apache.commons.logging.Log;
<ide> import org.apache.commons.logging.LogFactory;
<ide> import org.springframework.http.MediaType;
<ide> public class TurbineController {
<ide> private static final Log log = LogFactory.getLog(TurbineController.class);
<ide>
<del> private final Flux<Map<String, Object>> flux;
<add> private final Flux<String> flux;
<ide>
<ide> public TurbineController(PublishSubject<Map<String, Object>> hystrixSubject) {
<ide> Observable<Map<String, Object>> stream = StreamAggregator.aggregateGroupedStreams(hystrixSubject.groupBy(
<ide> Flux<Map<String, Object>> ping = Flux.interval(Duration.ofSeconds(5), Duration.ofSeconds(10))
<ide> .map(l -> Collections.singletonMap("type", (Object) "ping"))
<ide> .share();
<del>
<ide> flux = Flux.merge(RxReactiveStreams.toPublisher(stream), ping)
<del> .share();
<add> .share().map(map -> JsonUtility.mapToJson(map));
<ide> }
<ide>
<ide> @GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE)
<del> public Flux<Map<String, Object>> stream() {
<add> public Flux<String> stream() {
<ide> return this.flux;
<ide> }
<ide> } |
|
Java | apache-2.0 | 1913bb2854ee7e0461c45fe9e2b6bfd88603ba32 | 0 | mosoft521/wicket,selckin/wicket,apache/wicket,mafulafunk/wicket,bitstorm/wicket,mosoft521/wicket,AlienQueen/wicket,apache/wicket,mosoft521/wicket,mosoft521/wicket,astrapi69/wicket,dashorst/wicket,klopfdreh/wicket,selckin/wicket,Servoy/wicket,mafulafunk/wicket,mosoft521/wicket,martin-g/wicket-osgi,klopfdreh/wicket,topicusonderwijs/wicket,aldaris/wicket,bitstorm/wicket,freiheit-com/wicket,dashorst/wicket,apache/wicket,aldaris/wicket,selckin/wicket,Servoy/wicket,mafulafunk/wicket,aldaris/wicket,dashorst/wicket,astrapi69/wicket,topicusonderwijs/wicket,apache/wicket,freiheit-com/wicket,freiheit-com/wicket,topicusonderwijs/wicket,Servoy/wicket,freiheit-com/wicket,selckin/wicket,klopfdreh/wicket,zwsong/wicket,dashorst/wicket,Servoy/wicket,astrapi69/wicket,astrapi69/wicket,klopfdreh/wicket,martin-g/wicket-osgi,AlienQueen/wicket,zwsong/wicket,freiheit-com/wicket,dashorst/wicket,aldaris/wicket,bitstorm/wicket,zwsong/wicket,topicusonderwijs/wicket,AlienQueen/wicket,bitstorm/wicket,apache/wicket,AlienQueen/wicket,aldaris/wicket,klopfdreh/wicket,bitstorm/wicket,selckin/wicket,topicusonderwijs/wicket,Servoy/wicket,zwsong/wicket,AlienQueen/wicket,martin-g/wicket-osgi | /*
* 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 wicket.markup.html.image.resource;
import java.io.Serializable;
import java.util.Locale;
import wicket.Application;
import wicket.Component;
import wicket.IResourceFactory;
import wicket.IResourceListener;
import wicket.MarkupContainer;
import wicket.RequestCycle;
import wicket.Resource;
import wicket.ResourceReference;
import wicket.WicketRuntimeException;
import wicket.markup.ComponentTag;
import wicket.markup.html.PackageResource;
import wicket.markup.html.border.Border;
import wicket.util.lang.Objects;
import wicket.util.parse.metapattern.Group;
import wicket.util.parse.metapattern.MetaPattern;
import wicket.util.parse.metapattern.OptionalMetaPattern;
import wicket.util.parse.metapattern.parsers.MetaPatternParser;
import wicket.util.string.Strings;
import wicket.util.value.ValueMap;
/**
* THIS CLASS IS INTENDED FOR INTERNAL USE IN IMPLEMENTING LOCALE SENSITIVE
* COMPONENTS THAT USE IMAGE RESOURCES AND SHOULD NOT BE USED DIRECTLY BY
* END-USERS.
* <p>
* This class contains the logic for extracting static image resources
* referenced by the SRC attribute of component tags and keeping these static
* image resources in sync with the component locale.
* <p>
* If no image is specified by the SRC attribute of an IMG tag, then any VALUE
* attribute is inspected. If there is a VALUE attribute, it must be of the form
* "[factoryName]:[sharedImageName]?:[specification]". [factoryName] is the name
* of a resource factory that has been added to Application (for example,
* DefaultButtonImageResourceFactory is installed by default under the name
* "buttonFactory"). The [sharedImageName] value is optional and gives a name
* under which a given generated image is shared. For example, a cancel button
* image generated by the VALUE attribute "buttonFactory:cancelButton:Cancel" is
* shared under the name "cancelButton" and this specification will cause a
* component to reference the same image resource no matter what page it appears
* on, which is a very convenient and efficient way to create and share images.
* The [specification] string which follows the second colon is passed directly
* to the image factory and its format is dependent on the specific image
* factory. For details on the default buttonFactory, see
* {@link wicket.markup.html.image.resource.DefaultButtonImageResourceFactory}.
* <p>
* Finally, if there is no SRC attribute and no VALUE attribute, the Image
* component's model is inspected. If the model contains a resource or resource
* reference, this image is used, otherwise the model is converted to a
* String and that value is used as a path to load the image.
*
* @author Jonathan Locke
*/
public final class LocalizedImageResource implements Serializable, IResourceListener
{
private static final long serialVersionUID = 1L;
/** What kind of resource it is. TRUE==Resource is set, FALSE==ResourceReference is set, null none */
private Boolean resourceKind;
/** The component that is referencing this image resource */
private Component component;
/** The image resource this image component references */
private Resource resource;
/** The resource reference */
private ResourceReference resourceReference;
/** The resource parameters */
private ValueMap resourceParameters;
/** The locale of the image resource */
private transient Locale locale;
/** The style of the image resource */
private transient String style;
/**
* Parses image value specifications of the form "[factoryName]:
* [shared-image-name]?:[specification]"
*
* @author Jonathan Locke
*/
private static final class ImageValueParser extends MetaPatternParser
{
/** Factory name */
private static final Group factoryName = new Group(MetaPattern.VARIABLE_NAME);
/** Image reference name */
private static final Group imageReferenceName = new Group(MetaPattern.VARIABLE_NAME);
/** Factory specification string */
private static final Group specification = new Group(MetaPattern.ANYTHING_NON_EMPTY);
/** Meta pattern. */
private static final MetaPattern pattern = new MetaPattern(new MetaPattern[] { factoryName,
MetaPattern.COLON,
new OptionalMetaPattern(new MetaPattern[] { imageReferenceName }),
MetaPattern.COLON, specification });
/**
* Construct.
*
* @param input
* to parse
*/
private ImageValueParser(final CharSequence input)
{
super(pattern, input);
}
/**
* @return The factory name
*/
private String getFactoryName()
{
return factoryName.get(matcher());
}
/**
* @return Returns the imageReferenceName.
*/
private String getImageReferenceName()
{
return imageReferenceName.get(matcher());
}
/**
* @return Returns the specification.
*/
private String getSpecification()
{
return specification.get(matcher());
}
}
/**
* Constructor
*
* @param component
* The component that owns this localized image resource
*/
public LocalizedImageResource(final Component component)
{
this.component = component;
this.locale = component.getLocale();
this.style = component.getStyle();
}
/**
* Binds this resource if it is shared
*/
public final void bind()
{
// If we have a resource reference
if (resourceReference != null)
{
// Bind the reference to the application
resourceReference.bind(component.getApplication());
// Then dereference the resource
resource = resourceReference.getResource();
}
}
/**
* @see wicket.IResourceListener#onResourceRequested()
*/
public final void onResourceRequested()
{
bind();
resource.onResourceRequested();
}
/**
* @param resource
* The resource to set.
*/
public final void setResource(final Resource resource)
{
resourceKind = Boolean.TRUE;
this.resource = resource;
}
/**
* @param resourceReference
* The resource to set.
*/
public final void setResourceReference(final ResourceReference resourceReference)
{
setResourceReference(resourceReference, null);
}
/**
* @return If it is stateless (if resource is null)
*/
public final boolean isStateless()
{
return this.resource == null;
}
/**
* @param resourceReference
* The resource to set.
* @param resourceParameters
* The resource parameters for the shared resource
*/
public final void setResourceReference(final ResourceReference resourceReference,final ValueMap resourceParameters)
{
resourceKind = Boolean.FALSE;
this.resourceReference = resourceReference;
this.resourceParameters = resourceParameters;
bind();
}
/**
* @param tag
* The tag to inspect for an optional src attribute that might
* reference an image.
* @throws WicketRuntimeException
* Thrown if an image is required by the caller, but none can be
* found.
*/
public final void setSrcAttribute(final ComponentTag tag)
{
// If locale has changed from the initial locale used to attach image
// resource, then we need to reload the resource in the new locale
if ( resourceKind == null &&
(!Objects.equal(locale, component.getLocale())
|| !Objects.equal(style, component.getStyle())))
{
// Get new component locale and style
this.locale = component.getLocale();
this.style = component.getStyle();
// Invalidate current resource so it will be reloaded/recomputed
this.resourceReference = null;
this.resource = null;
}
else
{
// TODO post 1.2: should we have support for locale changes when the
// resource reference (or resource??) is set manually..
// We should get a new resource reference for the current locale then
// that points to the same resource but with another locale if it exists.
// something like SharedResource.getResourceReferenceForLocale(resourceReference);
}
// check if the model contains a resource, if so, load the resource from the model.
Object modelObject = component.getModelObject();
if ( modelObject instanceof ResourceReference ) {
resourceReference = (ResourceReference) modelObject;
} else if ( modelObject instanceof Resource ) {
resource = (Resource) modelObject;
}
// Need to load image resource for this component?
if (resource == null && resourceReference == null)
{
// Get SRC attribute of tag
final CharSequence src = tag.getString("src");
if (src != null)
{
// Try to load static image
loadStaticImage(src.toString());
}
else
{
// Get VALUE attribute of tag
final CharSequence value = tag.getString("value");
if (value != null)
{
// Try to generate an image using an image factory
newImage(value);
}
else
{
// Load static image using model object as the path
loadStaticImage(component.getModelObjectAsString());
}
}
}
// Get URL for resource
final CharSequence url;
if (this.resourceReference != null)
{
// Create URL to shared resource
url = RequestCycle.get().urlFor(resourceReference, resourceParameters);
}
else
{
// Create URL to component
url = component.urlFor(IResourceListener.INTERFACE);
}
// Set the SRC attribute to point to the component or shared resource
tag.put("src", Strings.replaceAll(RequestCycle.get().getOriginalResponse().encodeURL(url), "&", "&"));
}
/**
* @param application
* The application
* @param factoryName
* The name of the image resource factory
* @return The resource factory
* @throws WicketRuntimeException
* Thrown if factory cannot be found
*/
private IResourceFactory getResourceFactory(final Application application,
final String factoryName)
{
final IResourceFactory factory = application.getResourceSettings().getResourceFactory(factoryName);
// Found factory?
if (factory == null)
{
throw new WicketRuntimeException("Could not find image resource factory named "
+ factoryName);
}
return factory;
}
/**
* Tries to load static image at the given path and throws an exception if
* the image cannot be located.
*
* @param path
* The path to the image
* @throws WicketRuntimeException
* Thrown if the image cannot be located
*/
private void loadStaticImage(final String path)
{
if ((path.indexOf("..") != -1) || (path.indexOf("./") != -1) || (path.indexOf("/.") != -1))
{
throw new WicketRuntimeException(
"The 'src' attribute must not contain any of the following strings: '..', './', '/.': path="
+ path);
}
MarkupContainer parent = component.findParentWithAssociatedMarkup();
if (parent instanceof Border)
{
parent = parent.getParent();
}
final Class scope = parent.getClass();
this.resourceReference = new ResourceReference(scope, path)
{
private static final long serialVersionUID = 1L;
/**
* @see wicket.ResourceReference#newResource()
*/
protected Resource newResource()
{
PackageResource pr = PackageResource.get(getScope(), getName(), LocalizedImageResource.this.locale, style);
locale = pr.getLocale();
return pr;
}
};
resourceReference.setLocale(locale);
resourceReference.setStyle(style);
bind();
}
/**
* Generates an image resource based on the attribute values on tag
*
* @param value
* The value to parse
*/
private void newImage(final CharSequence value)
{
// Parse value
final ImageValueParser valueParser = new ImageValueParser(value);
// Does value match parser?
if (valueParser.matches())
{
final String imageReferenceName = valueParser.getImageReferenceName();
final String specification = Strings.replaceHtmlEscapeNumber(valueParser.getSpecification());
final String factoryName = valueParser.getFactoryName();
final Application application = component.getApplication();
// Do we have a reference?
if (!Strings.isEmpty(imageReferenceName))
{
// Is resource already available via the application?
if (application.getSharedResources().get(Application.class, imageReferenceName, locale, style, true) == null)
{
// Resource not available yet, so create it with factory and
// share via Application
final Resource imageResource = getResourceFactory(application, factoryName)
.newResource(specification, locale, style);
application.getSharedResources().add(Application.class, imageReferenceName, locale, style,
imageResource);
}
// Create resource reference
this.resourceReference = new ResourceReference(Application.class,
imageReferenceName);
resourceReference.setLocale(locale);
resourceReference.setStyle(style);
}
else
{
this.resource = getResourceFactory(application, factoryName)
.newResource(specification, locale, style);
}
}
else
{
throw new WicketRuntimeException(
"Could not generate image for value attribute '"
+ value
+ "'. Was expecting a value attribute of the form \"[resourceFactoryName]:[resourceReferenceName]?:[factorySpecification]\".");
}
}
}
| wicket/src/main/java/wicket/markup/html/image/resource/LocalizedImageResource.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 wicket.markup.html.image.resource;
import java.io.Serializable;
import java.util.Locale;
import wicket.Application;
import wicket.Component;
import wicket.IResourceFactory;
import wicket.IResourceListener;
import wicket.MarkupContainer;
import wicket.RequestCycle;
import wicket.Resource;
import wicket.ResourceReference;
import wicket.WicketRuntimeException;
import wicket.markup.ComponentTag;
import wicket.markup.html.PackageResource;
import wicket.markup.html.border.Border;
import wicket.util.lang.Objects;
import wicket.util.parse.metapattern.Group;
import wicket.util.parse.metapattern.MetaPattern;
import wicket.util.parse.metapattern.OptionalMetaPattern;
import wicket.util.parse.metapattern.parsers.MetaPatternParser;
import wicket.util.string.Strings;
import wicket.util.value.ValueMap;
/**
* THIS CLASS IS INTENDED FOR INTERNAL USE IN IMPLEMENTING LOCALE SENSITIVE
* COMPONENTS THAT USE IMAGE RESOURCES AND SHOULD NOT BE USED DIRECTLY BY
* END-USERS.
* <p>
* This class contains the logic for extracting static image resources
* referenced by the SRC attribute of component tags and keeping these static
* image resources in sync with the component locale.
* <p>
* If no image is specified by the SRC attribute of an IMG tag, then any VALUE
* attribute is inspected. If there is a VALUE attribute, it must be of the form
* "[factoryName]:[sharedImageName]?:[specification]". [factoryName] is the name
* of a resource factory that has been added to Application (for example,
* DefaultButtonImageResourceFactory is installed by default under the name
* "buttonFactory"). The [sharedImageName] value is optional and gives a name
* under which a given generated image is shared. For example, a cancel button
* image generated by the VALUE attribute "buttonFactory:cancelButton:Cancel" is
* shared under the name "cancelButton" and this specification will cause a
* component to reference the same image resource no matter what page it appears
* on, which is a very convenient and efficient way to create and share images.
* The [specification] string which follows the second colon is passed directly
* to the image factory and its format is dependent on the specific image
* factory. For details on the default buttonFactory, see
* {@link wicket.markup.html.image.resource.DefaultButtonImageResourceFactory}.
* <p>
* Finally, if there is no SRC attribute and no VALUE attribute, the Image
* component's model is converted to a String and that value is used as a path
* to load the image.
*
* @author Jonathan Locke
*/
public final class LocalizedImageResource implements Serializable, IResourceListener
{
private static final long serialVersionUID = 1L;
/** What kind of resource it is. TRUE==Resource is set, FALSE==ResourceReference is set, null none */
private Boolean resourceKind;
/** The component that is referencing this image resource */
private Component component;
/** The image resource this image component references */
private Resource resource;
/** The resource reference */
private ResourceReference resourceReference;
/** The resource parameters */
private ValueMap resourceParameters;
/** The locale of the image resource */
private transient Locale locale;
/** The style of the image resource */
private transient String style;
/**
* Parses image value specifications of the form "[factoryName]:
* [shared-image-name]?:[specification]"
*
* @author Jonathan Locke
*/
private static final class ImageValueParser extends MetaPatternParser
{
/** Factory name */
private static final Group factoryName = new Group(MetaPattern.VARIABLE_NAME);
/** Image reference name */
private static final Group imageReferenceName = new Group(MetaPattern.VARIABLE_NAME);
/** Factory specification string */
private static final Group specification = new Group(MetaPattern.ANYTHING_NON_EMPTY);
/** Meta pattern. */
private static final MetaPattern pattern = new MetaPattern(new MetaPattern[] { factoryName,
MetaPattern.COLON,
new OptionalMetaPattern(new MetaPattern[] { imageReferenceName }),
MetaPattern.COLON, specification });
/**
* Construct.
*
* @param input
* to parse
*/
private ImageValueParser(final CharSequence input)
{
super(pattern, input);
}
/**
* @return The factory name
*/
private String getFactoryName()
{
return factoryName.get(matcher());
}
/**
* @return Returns the imageReferenceName.
*/
private String getImageReferenceName()
{
return imageReferenceName.get(matcher());
}
/**
* @return Returns the specification.
*/
private String getSpecification()
{
return specification.get(matcher());
}
}
/**
* Constructor
*
* @param component
* The component that owns this localized image resource
*/
public LocalizedImageResource(final Component component)
{
this.component = component;
this.locale = component.getLocale();
this.style = component.getStyle();
}
/**
* Binds this resource if it is shared
*/
public final void bind()
{
// If we have a resource reference
if (resourceReference != null)
{
// Bind the reference to the application
resourceReference.bind(component.getApplication());
// Then dereference the resource
resource = resourceReference.getResource();
}
}
/**
* @see wicket.IResourceListener#onResourceRequested()
*/
public final void onResourceRequested()
{
bind();
resource.onResourceRequested();
}
/**
* @param resource
* The resource to set.
*/
public final void setResource(final Resource resource)
{
resourceKind = Boolean.TRUE;
this.resource = resource;
}
/**
* @param resourceReference
* The resource to set.
*/
public final void setResourceReference(final ResourceReference resourceReference)
{
setResourceReference(resourceReference, null);
}
/**
* @return If it is stateless (if resource is null)
*/
public final boolean isStateless()
{
return this.resource == null;
}
/**
* @param resourceReference
* The resource to set.
* @param resourceParameters
* The resource parameters for the shared resource
*/
public final void setResourceReference(final ResourceReference resourceReference,final ValueMap resourceParameters)
{
resourceKind = Boolean.FALSE;
this.resourceReference = resourceReference;
this.resourceParameters = resourceParameters;
bind();
}
/**
* @param tag
* The tag to inspect for an optional src attribute that might
* reference an image.
* @throws WicketRuntimeException
* Thrown if an image is required by the caller, but none can be
* found.
*/
public final void setSrcAttribute(final ComponentTag tag)
{
// If locale has changed from the initial locale used to attach image
// resource, then we need to reload the resource in the new locale
if ( resourceKind == null &&
(!Objects.equal(locale, component.getLocale())
|| !Objects.equal(style, component.getStyle())))
{
// Get new component locale and style
this.locale = component.getLocale();
this.style = component.getStyle();
// Invalidate current resource so it will be reloaded/recomputed
this.resourceReference = null;
this.resource = null;
}
else
{
// TODO post 1.2: should we have support for locale changes when the
// resource reference (or resource??) is set manually..
// We should get a new resource reference for the current locale then
// that points to the same resource but with another locale if it exists.
// something like SharedResource.getResourceReferenceForLocale(resourceReference);
}
// Need to load image resource for this component?
if (resource == null && resourceReference == null)
{
// Get SRC attribute of tag
final CharSequence src = tag.getString("src");
if (src != null)
{
// Try to load static image
loadStaticImage(src.toString());
}
else
{
// Get VALUE attribute of tag
final CharSequence value = tag.getString("value");
if (value != null)
{
// Try to generate an image using an image factory
newImage(value);
}
else
{
// Load static image using model object as the path
loadStaticImage(component.getModelObjectAsString());
}
}
}
// Get URL for resource
final CharSequence url;
if (this.resourceReference != null)
{
// Create URL to shared resource
url = RequestCycle.get().urlFor(resourceReference, resourceParameters);
}
else
{
// Create URL to component
url = component.urlFor(IResourceListener.INTERFACE);
}
// Set the SRC attribute to point to the component or shared resource
tag.put("src", Strings.replaceAll(RequestCycle.get().getOriginalResponse().encodeURL(url), "&", "&"));
}
/**
* @param application
* The application
* @param factoryName
* The name of the image resource factory
* @return The resource factory
* @throws WicketRuntimeException
* Thrown if factory cannot be found
*/
private IResourceFactory getResourceFactory(final Application application,
final String factoryName)
{
final IResourceFactory factory = application.getResourceSettings().getResourceFactory(factoryName);
// Found factory?
if (factory == null)
{
throw new WicketRuntimeException("Could not find image resource factory named "
+ factoryName);
}
return factory;
}
/**
* Tries to load static image at the given path and throws an exception if
* the image cannot be located.
*
* @param path
* The path to the image
* @throws WicketRuntimeException
* Thrown if the image cannot be located
*/
private void loadStaticImage(final String path)
{
if ((path.indexOf("..") != -1) || (path.indexOf("./") != -1) || (path.indexOf("/.") != -1))
{
throw new WicketRuntimeException(
"The 'src' attribute must not contain any of the following strings: '..', './', '/.': path="
+ path);
}
MarkupContainer parent = component.findParentWithAssociatedMarkup();
if (parent instanceof Border)
{
parent = parent.getParent();
}
final Class scope = parent.getClass();
this.resourceReference = new ResourceReference(scope, path)
{
private static final long serialVersionUID = 1L;
/**
* @see wicket.ResourceReference#newResource()
*/
protected Resource newResource()
{
PackageResource pr = PackageResource.get(getScope(), getName(), LocalizedImageResource.this.locale, style);
locale = pr.getLocale();
return pr;
}
};
resourceReference.setLocale(locale);
resourceReference.setStyle(style);
bind();
}
/**
* Generates an image resource based on the attribute values on tag
*
* @param value
* The value to parse
*/
private void newImage(final CharSequence value)
{
// Parse value
final ImageValueParser valueParser = new ImageValueParser(value);
// Does value match parser?
if (valueParser.matches())
{
final String imageReferenceName = valueParser.getImageReferenceName();
final String specification = Strings.replaceHtmlEscapeNumber(valueParser.getSpecification());
final String factoryName = valueParser.getFactoryName();
final Application application = component.getApplication();
// Do we have a reference?
if (!Strings.isEmpty(imageReferenceName))
{
// Is resource already available via the application?
if (application.getSharedResources().get(Application.class, imageReferenceName, locale, style, true) == null)
{
// Resource not available yet, so create it with factory and
// share via Application
final Resource imageResource = getResourceFactory(application, factoryName)
.newResource(specification, locale, style);
application.getSharedResources().add(Application.class, imageReferenceName, locale, style,
imageResource);
}
// Create resource reference
this.resourceReference = new ResourceReference(Application.class,
imageReferenceName);
resourceReference.setLocale(locale);
resourceReference.setStyle(style);
}
else
{
this.resource = getResourceFactory(application, factoryName)
.newResource(specification, locale, style);
}
}
else
{
throw new WicketRuntimeException(
"Could not generate image for value attribute '"
+ value
+ "'. Was expecting a value attribute of the form \"[resourceFactoryName]:[resourceReferenceName]?:[factorySpecification]\".");
}
}
}
| WICKET-5
git-svn-id: 6d6ade8e88b1292e17cba3559b7335a947e495e0@477041 13f79535-47bb-0310-9956-ffa450edef68
| wicket/src/main/java/wicket/markup/html/image/resource/LocalizedImageResource.java | WICKET-5 | <ide><path>icket/src/main/java/wicket/markup/html/image/resource/LocalizedImageResource.java
<ide> * {@link wicket.markup.html.image.resource.DefaultButtonImageResourceFactory}.
<ide> * <p>
<ide> * Finally, if there is no SRC attribute and no VALUE attribute, the Image
<del> * component's model is converted to a String and that value is used as a path
<del> * to load the image.
<add> * component's model is inspected. If the model contains a resource or resource
<add> * reference, this image is used, otherwise the model is converted to a
<add> * String and that value is used as a path to load the image.
<ide> *
<ide> * @author Jonathan Locke
<ide> */
<ide> // We should get a new resource reference for the current locale then
<ide> // that points to the same resource but with another locale if it exists.
<ide> // something like SharedResource.getResourceReferenceForLocale(resourceReference);
<add> }
<add>
<add> // check if the model contains a resource, if so, load the resource from the model.
<add> Object modelObject = component.getModelObject();
<add> if ( modelObject instanceof ResourceReference ) {
<add> resourceReference = (ResourceReference) modelObject;
<add> } else if ( modelObject instanceof Resource ) {
<add> resource = (Resource) modelObject;
<ide> }
<ide>
<ide> // Need to load image resource for this component? |
|
Java | bsd-3-clause | 2d19576f247894a8dc39c9bf10617952f041a587 | 0 | rmacnak-google/engine,devoncarew/engine,Hixie/sky_engine,chinmaygarde/sky_engine,Hixie/sky_engine,Hixie/sky_engine,jamesr/sky_engine,devoncarew/engine,jason-simmons/sky_engine,jamesr/sky_engine,tvolkert/engine,rmacnak-google/engine,jason-simmons/flutter_engine,Hixie/sky_engine,flutter/engine,jamesr/flutter_engine,jason-simmons/sky_engine,rmacnak-google/engine,chinmaygarde/sky_engine,aam/engine,jamesr/flutter_engine,devoncarew/engine,jason-simmons/flutter_engine,jamesr/flutter_engine,aam/engine,Hixie/sky_engine,devoncarew/sky_engine,jamesr/sky_engine,Hixie/sky_engine,jason-simmons/sky_engine,jamesr/sky_engine,tvolkert/engine,aam/engine,jason-simmons/flutter_engine,jason-simmons/flutter_engine,aam/engine,aam/engine,flutter/engine,jason-simmons/sky_engine,devoncarew/sky_engine,chinmaygarde/flutter_engine,tvolkert/engine,flutter/engine,aam/engine,jamesr/flutter_engine,chinmaygarde/sky_engine,jason-simmons/flutter_engine,chinmaygarde/flutter_engine,tvolkert/engine,jason-simmons/sky_engine,jason-simmons/flutter_engine,chinmaygarde/sky_engine,chinmaygarde/flutter_engine,jamesr/flutter_engine,jason-simmons/sky_engine,chinmaygarde/sky_engine,flutter/engine,rmacnak-google/engine,jamesr/sky_engine,devoncarew/engine,jamesr/flutter_engine,aam/engine,chinmaygarde/flutter_engine,jason-simmons/flutter_engine,flutter/engine,devoncarew/engine,chinmaygarde/sky_engine,tvolkert/engine,devoncarew/sky_engine,jamesr/flutter_engine,tvolkert/engine,rmacnak-google/engine,flutter/engine,Hixie/sky_engine,rmacnak-google/engine,devoncarew/sky_engine,jason-simmons/flutter_engine,chinmaygarde/flutter_engine,jason-simmons/sky_engine,tvolkert/engine,chinmaygarde/sky_engine,devoncarew/sky_engine,aam/engine,flutter/engine,devoncarew/sky_engine,chinmaygarde/flutter_engine,rmacnak-google/engine,jamesr/flutter_engine,jamesr/flutter_engine,devoncarew/engine,jamesr/sky_engine,devoncarew/sky_engine,chinmaygarde/flutter_engine,Hixie/sky_engine,devoncarew/engine,flutter/engine,jamesr/sky_engine | // Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package io.flutter.plugin.editing;
import android.annotation.SuppressLint;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.content.Context;
import android.os.Build;
import android.provider.Settings;
import android.text.DynamicLayout;
import android.text.Editable;
import android.text.InputType;
import android.text.Layout;
import android.text.Selection;
import android.text.TextPaint;
import android.view.KeyEvent;
import android.view.View;
import android.view.inputmethod.BaseInputConnection;
import android.view.inputmethod.CursorAnchorInfo;
import android.view.inputmethod.EditorInfo;
import android.view.inputmethod.ExtractedText;
import android.view.inputmethod.ExtractedTextRequest;
import android.view.inputmethod.InputMethodManager;
import android.view.inputmethod.InputMethodSubtype;
import io.flutter.Log;
import io.flutter.embedding.engine.systemchannels.TextInputChannel;
class InputConnectionAdaptor extends BaseInputConnection {
private final View mFlutterView;
private final int mClient;
private final TextInputChannel textInputChannel;
private final Editable mEditable;
private final EditorInfo mEditorInfo;
private int mBatchCount;
private InputMethodManager mImm;
private final Layout mLayout;
// Used to determine if Samsung-specific hacks should be applied.
private final boolean isSamsung;
private boolean mRepeatCheckNeeded = false;
private TextEditingValue mLastSentTextEditngValue;
// Data class used to get and store the last-sent values via updateEditingState to
// the framework. These are then compared against to prevent redundant messages
// with the same data before any valid operations were made to the contents.
private class TextEditingValue {
public int selectionStart;
public int selectionEnd;
public int composingStart;
public int composingEnd;
public String text;
public TextEditingValue(Editable editable) {
selectionStart = Selection.getSelectionStart(editable);
selectionEnd = Selection.getSelectionEnd(editable);
composingStart = BaseInputConnection.getComposingSpanStart(editable);
composingEnd = BaseInputConnection.getComposingSpanEnd(editable);
text = editable.toString();
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (!(o instanceof TextEditingValue)) {
return false;
}
TextEditingValue value = (TextEditingValue) o;
return selectionStart == value.selectionStart
&& selectionEnd == value.selectionEnd
&& composingStart == value.composingStart
&& composingEnd == value.composingEnd
&& text.equals(value.text);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + selectionStart;
result = prime * result + selectionEnd;
result = prime * result + composingStart;
result = prime * result + composingEnd;
result = prime * result + text.hashCode();
return result;
}
}
@SuppressWarnings("deprecation")
public InputConnectionAdaptor(
View view,
int client,
TextInputChannel textInputChannel,
Editable editable,
EditorInfo editorInfo) {
super(view, true);
mFlutterView = view;
mClient = client;
this.textInputChannel = textInputChannel;
mEditable = editable;
mEditorInfo = editorInfo;
mBatchCount = 0;
// We create a dummy Layout with max width so that the selection
// shifting acts as if all text were in one line.
mLayout =
new DynamicLayout(
mEditable,
new TextPaint(),
Integer.MAX_VALUE,
Layout.Alignment.ALIGN_NORMAL,
1.0f,
0.0f,
false);
mImm = (InputMethodManager) view.getContext().getSystemService(Context.INPUT_METHOD_SERVICE);
isSamsung = isSamsung();
}
// Send the current state of the editable to Flutter.
private void updateEditingState() {
// If the IME is in the middle of a batch edit, then wait until it completes.
if (mBatchCount > 0) return;
TextEditingValue currentValue = new TextEditingValue(mEditable);
// Return if this data has already been sent and no meaningful changes have
// occurred to mark this as dirty. This prevents duplicate remote updates of
// the same data, which can break formatters that change the length of the
// contents.
if (mRepeatCheckNeeded && currentValue.equals(mLastSentTextEditngValue)) {
return;
}
mImm.updateSelection(
mFlutterView,
currentValue.selectionStart,
currentValue.selectionEnd,
currentValue.composingStart,
currentValue.composingEnd);
textInputChannel.updateEditingState(
mClient,
currentValue.text,
currentValue.selectionStart,
currentValue.selectionEnd,
currentValue.composingStart,
currentValue.composingEnd);
mRepeatCheckNeeded = true;
mLastSentTextEditngValue = currentValue;
}
// This should be called whenever a change could have been made to
// the value of mEditable, which will make any call of updateEditingState()
// ineligible for repeat checking as we do not want to skip sending real changes
// to the framework.
public void markDirty() {
// Disable updateEditngState's repeat-update check
mRepeatCheckNeeded = false;
}
@Override
public Editable getEditable() {
return mEditable;
}
@Override
public boolean beginBatchEdit() {
mBatchCount++;
return super.beginBatchEdit();
}
@Override
public boolean endBatchEdit() {
boolean result = super.endBatchEdit();
mBatchCount--;
updateEditingState();
return result;
}
@Override
public boolean commitText(CharSequence text, int newCursorPosition) {
boolean result = super.commitText(text, newCursorPosition);
markDirty();
return result;
}
@Override
public boolean deleteSurroundingText(int beforeLength, int afterLength) {
if (Selection.getSelectionStart(mEditable) == -1) return true;
boolean result = super.deleteSurroundingText(beforeLength, afterLength);
markDirty();
return result;
}
@Override
public boolean deleteSurroundingTextInCodePoints(int beforeLength, int afterLength) {
boolean result = super.deleteSurroundingTextInCodePoints(beforeLength, afterLength);
markDirty();
return result;
}
@Override
public boolean setComposingRegion(int start, int end) {
boolean result = super.setComposingRegion(start, end);
markDirty();
return result;
}
@Override
public boolean setComposingText(CharSequence text, int newCursorPosition) {
boolean result;
if (text.length() == 0) {
result = super.commitText(text, newCursorPosition);
} else {
result = super.setComposingText(text, newCursorPosition);
}
markDirty();
return result;
}
@Override
public boolean finishComposingText() {
boolean result = super.finishComposingText();
// Apply Samsung hacks. Samsung caches composing region data strangely, causing text
// duplication.
if (isSamsung) {
if (Build.VERSION.SDK_INT >= 21) {
// Samsung keyboards don't clear the composing region on finishComposingText.
// Update the keyboard with a reset/empty composing region. Critical on
// Samsung keyboards to prevent punctuation duplication.
CursorAnchorInfo.Builder builder = new CursorAnchorInfo.Builder();
builder.setComposingText(/*composingTextStart*/ -1, /*composingText*/ "");
CursorAnchorInfo anchorInfo = builder.build();
mImm.updateCursorAnchorInfo(mFlutterView, anchorInfo);
}
}
markDirty();
return result;
}
// TODO(garyq): Implement a more feature complete version of getExtractedText
@Override
public ExtractedText getExtractedText(ExtractedTextRequest request, int flags) {
ExtractedText extractedText = new ExtractedText();
extractedText.selectionStart = Selection.getSelectionStart(mEditable);
extractedText.selectionEnd = Selection.getSelectionEnd(mEditable);
extractedText.text = mEditable.toString();
return extractedText;
}
@Override
public boolean clearMetaKeyStates(int states) {
boolean result = super.clearMetaKeyStates(states);
markDirty();
return result;
}
// Detect if the keyboard is a Samsung keyboard, where we apply Samsung-specific hacks to
// fix critical bugs that make the keyboard otherwise unusable. See finishComposingText() for
// more details.
@SuppressLint("NewApi") // New API guard is inline, the linter can't see it.
@SuppressWarnings("deprecation")
private boolean isSamsung() {
InputMethodSubtype subtype = mImm.getCurrentInputMethodSubtype();
// Impacted devices all shipped with Android Lollipop or newer.
if (subtype == null
|| Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP
|| !Build.MANUFACTURER.equals("samsung")) {
return false;
}
String keyboardName =
Settings.Secure.getString(
mFlutterView.getContext().getContentResolver(), Settings.Secure.DEFAULT_INPUT_METHOD);
// The Samsung keyboard is called "com.sec.android.inputmethod/.SamsungKeypad" but look
// for "Samsung" just in case Samsung changes the name of the keyboard.
return keyboardName.contains("Samsung");
}
@Override
public boolean setSelection(int start, int end) {
boolean result = super.setSelection(start, end);
markDirty();
return result;
}
// Sanitizes the index to ensure the index is within the range of the
// contents of editable.
private static int clampIndexToEditable(int index, Editable editable) {
int clamped = Math.max(0, Math.min(editable.length(), index));
if (clamped != index) {
Log.d(
"flutter",
"Text selection index was clamped ("
+ index
+ "->"
+ clamped
+ ") to remain in bounds. This may not be your fault, as some keyboards may select outside of bounds.");
}
return clamped;
}
@Override
public boolean sendKeyEvent(KeyEvent event) {
markDirty();
if (event.getAction() == KeyEvent.ACTION_DOWN) {
if (event.getKeyCode() == KeyEvent.KEYCODE_DEL) {
int selStart = clampIndexToEditable(Selection.getSelectionStart(mEditable), mEditable);
int selEnd = clampIndexToEditable(Selection.getSelectionEnd(mEditable), mEditable);
if (selEnd > selStart) {
// Delete the selection.
Selection.setSelection(mEditable, selStart);
mEditable.delete(selStart, selEnd);
updateEditingState();
return true;
} else if (selStart > 0) {
// Delete to the left/right of the cursor depending on direction of text.
// TODO(garyq): Explore how to obtain per-character direction. The
// isRTLCharAt() call below is returning blanket direction assumption
// based on the first character in the line.
boolean isRtl = mLayout.isRtlCharAt(mLayout.getLineForOffset(selStart));
try {
if (isRtl) {
Selection.extendRight(mEditable, mLayout);
} else {
Selection.extendLeft(mEditable, mLayout);
}
} catch (IndexOutOfBoundsException e) {
// On some Chinese devices (primarily Huawei, some Xiaomi),
// on initial app startup before focus is lost, the
// Selection.extendLeft and extendRight calls always extend
// from the index of the initial contents of mEditable. This
// try-catch will prevent crashing on Huawei devices by falling
// back to a simple way of deletion, although this a hack and
// will not handle emojis.
Selection.setSelection(mEditable, selStart, selStart - 1);
}
int newStart = clampIndexToEditable(Selection.getSelectionStart(mEditable), mEditable);
int newEnd = clampIndexToEditable(Selection.getSelectionEnd(mEditable), mEditable);
Selection.setSelection(mEditable, Math.min(newStart, newEnd));
// Min/Max the values since RTL selections will start at a higher
// index than they end at.
mEditable.delete(Math.min(newStart, newEnd), Math.max(newStart, newEnd));
updateEditingState();
return true;
}
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_LEFT) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
int newSel = Math.max(selStart - 1, 0);
setSelection(newSel, newSel);
} else {
int newSelEnd = Math.max(selEnd - 1, 0);
setSelection(selStart, newSelEnd);
}
return true;
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_RIGHT) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
int newSel = Math.min(selStart + 1, mEditable.length());
setSelection(newSel, newSel);
} else {
int newSelEnd = Math.min(selEnd + 1, mEditable.length());
setSelection(selStart, newSelEnd);
}
return true;
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_UP) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
Selection.moveUp(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
setSelection(newSelStart, newSelStart);
} else {
Selection.extendUp(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
int newSelEnd = Selection.getSelectionEnd(mEditable);
setSelection(newSelStart, newSelEnd);
}
return true;
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_DOWN) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
Selection.moveDown(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
setSelection(newSelStart, newSelStart);
} else {
Selection.extendDown(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
int newSelEnd = Selection.getSelectionEnd(mEditable);
setSelection(newSelStart, newSelEnd);
}
return true;
// When the enter key is pressed on a non-multiline field, consider it a
// submit instead of a newline.
} else if ((event.getKeyCode() == KeyEvent.KEYCODE_ENTER
|| event.getKeyCode() == KeyEvent.KEYCODE_NUMPAD_ENTER)
&& (InputType.TYPE_TEXT_FLAG_MULTI_LINE & mEditorInfo.inputType) == 0) {
performEditorAction(mEditorInfo.imeOptions & EditorInfo.IME_MASK_ACTION);
return true;
} else {
// Enter a character.
int character = event.getUnicodeChar();
if (character != 0) {
int selStart = Math.max(0, Selection.getSelectionStart(mEditable));
int selEnd = Math.max(0, Selection.getSelectionEnd(mEditable));
int selMin = Math.min(selStart, selEnd);
int selMax = Math.max(selStart, selEnd);
if (selMin != selMax) mEditable.delete(selMin, selMax);
mEditable.insert(selMin, String.valueOf((char) character));
setSelection(selMin + 1, selMin + 1);
}
return true;
}
}
if (event.getAction() == KeyEvent.ACTION_UP
&& (event.getKeyCode() == KeyEvent.KEYCODE_SHIFT_LEFT
|| event.getKeyCode() == KeyEvent.KEYCODE_SHIFT_RIGHT)) {
int selEnd = Selection.getSelectionEnd(mEditable);
setSelection(selEnd, selEnd);
return true;
}
return false;
}
@Override
public boolean performContextMenuAction(int id) {
markDirty();
if (id == android.R.id.selectAll) {
setSelection(0, mEditable.length());
return true;
} else if (id == android.R.id.cut) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart != selEnd) {
int selMin = Math.min(selStart, selEnd);
int selMax = Math.max(selStart, selEnd);
CharSequence textToCut = mEditable.subSequence(selMin, selMax);
ClipboardManager clipboard =
(ClipboardManager)
mFlutterView.getContext().getSystemService(Context.CLIPBOARD_SERVICE);
ClipData clip = ClipData.newPlainText("text label?", textToCut);
clipboard.setPrimaryClip(clip);
mEditable.delete(selMin, selMax);
setSelection(selMin, selMin);
}
return true;
} else if (id == android.R.id.copy) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart != selEnd) {
CharSequence textToCopy =
mEditable.subSequence(Math.min(selStart, selEnd), Math.max(selStart, selEnd));
ClipboardManager clipboard =
(ClipboardManager)
mFlutterView.getContext().getSystemService(Context.CLIPBOARD_SERVICE);
clipboard.setPrimaryClip(ClipData.newPlainText("text label?", textToCopy));
}
return true;
} else if (id == android.R.id.paste) {
ClipboardManager clipboard =
(ClipboardManager) mFlutterView.getContext().getSystemService(Context.CLIPBOARD_SERVICE);
ClipData clip = clipboard.getPrimaryClip();
if (clip != null) {
CharSequence textToPaste = clip.getItemAt(0).coerceToText(mFlutterView.getContext());
int selStart = Math.max(0, Selection.getSelectionStart(mEditable));
int selEnd = Math.max(0, Selection.getSelectionEnd(mEditable));
int selMin = Math.min(selStart, selEnd);
int selMax = Math.max(selStart, selEnd);
if (selMin != selMax) mEditable.delete(selMin, selMax);
mEditable.insert(selMin, textToPaste);
int newSelStart = selMin + textToPaste.length();
setSelection(newSelStart, newSelStart);
}
return true;
}
return false;
}
@Override
public boolean performEditorAction(int actionCode) {
markDirty();
switch (actionCode) {
case EditorInfo.IME_ACTION_NONE:
textInputChannel.newline(mClient);
break;
case EditorInfo.IME_ACTION_UNSPECIFIED:
textInputChannel.unspecifiedAction(mClient);
break;
case EditorInfo.IME_ACTION_GO:
textInputChannel.go(mClient);
break;
case EditorInfo.IME_ACTION_SEARCH:
textInputChannel.search(mClient);
break;
case EditorInfo.IME_ACTION_SEND:
textInputChannel.send(mClient);
break;
case EditorInfo.IME_ACTION_NEXT:
textInputChannel.next(mClient);
break;
case EditorInfo.IME_ACTION_PREVIOUS:
textInputChannel.previous(mClient);
break;
default:
case EditorInfo.IME_ACTION_DONE:
textInputChannel.done(mClient);
break;
}
return true;
}
}
| shell/platform/android/io/flutter/plugin/editing/InputConnectionAdaptor.java | // Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package io.flutter.plugin.editing;
import android.annotation.SuppressLint;
import android.content.ClipData;
import android.content.ClipboardManager;
import android.content.Context;
import android.os.Build;
import android.provider.Settings;
import android.text.DynamicLayout;
import android.text.Editable;
import android.text.InputType;
import android.text.Layout;
import android.text.Selection;
import android.text.TextPaint;
import android.view.KeyEvent;
import android.view.View;
import android.view.inputmethod.BaseInputConnection;
import android.view.inputmethod.CursorAnchorInfo;
import android.view.inputmethod.EditorInfo;
import android.view.inputmethod.ExtractedText;
import android.view.inputmethod.ExtractedTextRequest;
import android.view.inputmethod.InputMethodManager;
import android.view.inputmethod.InputMethodSubtype;
import io.flutter.Log;
import io.flutter.embedding.engine.systemchannels.TextInputChannel;
class InputConnectionAdaptor extends BaseInputConnection {
private final View mFlutterView;
private final int mClient;
private final TextInputChannel textInputChannel;
private final Editable mEditable;
private final EditorInfo mEditorInfo;
private int mBatchCount;
private InputMethodManager mImm;
private final Layout mLayout;
// Used to determine if Samsung-specific hacks should be applied.
private final boolean isSamsung;
private boolean mRepeatCheckNeeded = false;
private TextEditingValue mLastSentTextEditngValue;
// Data class used to get and store the last-sent values via updateEditingState to
// the framework. These are then compared against to prevent redundant messages
// with the same data before any valid operations were made to the contents.
private class TextEditingValue {
public int selectionStart;
public int selectionEnd;
public int composingStart;
public int composingEnd;
public String text;
public TextEditingValue(Editable editable) {
selectionStart = Selection.getSelectionStart(editable);
selectionEnd = Selection.getSelectionEnd(editable);
composingStart = BaseInputConnection.getComposingSpanStart(editable);
composingEnd = BaseInputConnection.getComposingSpanEnd(editable);
text = editable.toString();
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (!(o instanceof TextEditingValue)) {
return false;
}
TextEditingValue value = (TextEditingValue) o;
return selectionStart == value.selectionStart
&& selectionEnd == value.selectionEnd
&& composingStart == value.composingStart
&& composingEnd == value.composingEnd
&& text.equals(value.text);
}
}
@SuppressWarnings("deprecation")
public InputConnectionAdaptor(
View view,
int client,
TextInputChannel textInputChannel,
Editable editable,
EditorInfo editorInfo) {
super(view, true);
mFlutterView = view;
mClient = client;
this.textInputChannel = textInputChannel;
mEditable = editable;
mEditorInfo = editorInfo;
mBatchCount = 0;
// We create a dummy Layout with max width so that the selection
// shifting acts as if all text were in one line.
mLayout =
new DynamicLayout(
mEditable,
new TextPaint(),
Integer.MAX_VALUE,
Layout.Alignment.ALIGN_NORMAL,
1.0f,
0.0f,
false);
mImm = (InputMethodManager) view.getContext().getSystemService(Context.INPUT_METHOD_SERVICE);
isSamsung = isSamsung();
}
// Send the current state of the editable to Flutter.
private void updateEditingState() {
// If the IME is in the middle of a batch edit, then wait until it completes.
if (mBatchCount > 0) return;
TextEditingValue currentValue = new TextEditingValue(mEditable);
// Return if this data has already been sent and no meaningful changes have
// occurred to mark this as dirty. This prevents duplicate remote updates of
// the same data, which can break formatters that change the length of the
// contents.
if (mRepeatCheckNeeded && currentValue.equals(mLastSentTextEditngValue)) {
return;
}
mImm.updateSelection(
mFlutterView,
currentValue.selectionStart,
currentValue.selectionEnd,
currentValue.composingStart,
currentValue.composingEnd);
textInputChannel.updateEditingState(
mClient,
currentValue.text,
currentValue.selectionStart,
currentValue.selectionEnd,
currentValue.composingStart,
currentValue.composingEnd);
mRepeatCheckNeeded = true;
mLastSentTextEditngValue = currentValue;
}
// This should be called whenever a change could have been made to
// the value of mEditable, which will make any call of updateEditingState()
// ineligible for repeat checking as we do not want to skip sending real changes
// to the framework.
public void markDirty() {
// Disable updateEditngState's repeat-update check
mRepeatCheckNeeded = false;
}
@Override
public Editable getEditable() {
return mEditable;
}
@Override
public boolean beginBatchEdit() {
mBatchCount++;
return super.beginBatchEdit();
}
@Override
public boolean endBatchEdit() {
boolean result = super.endBatchEdit();
mBatchCount--;
updateEditingState();
return result;
}
@Override
public boolean commitText(CharSequence text, int newCursorPosition) {
boolean result = super.commitText(text, newCursorPosition);
markDirty();
return result;
}
@Override
public boolean deleteSurroundingText(int beforeLength, int afterLength) {
if (Selection.getSelectionStart(mEditable) == -1) return true;
boolean result = super.deleteSurroundingText(beforeLength, afterLength);
markDirty();
return result;
}
@Override
public boolean deleteSurroundingTextInCodePoints(int beforeLength, int afterLength) {
boolean result = super.deleteSurroundingTextInCodePoints(beforeLength, afterLength);
markDirty();
return result;
}
@Override
public boolean setComposingRegion(int start, int end) {
boolean result = super.setComposingRegion(start, end);
markDirty();
return result;
}
@Override
public boolean setComposingText(CharSequence text, int newCursorPosition) {
boolean result;
if (text.length() == 0) {
result = super.commitText(text, newCursorPosition);
} else {
result = super.setComposingText(text, newCursorPosition);
}
markDirty();
return result;
}
@Override
public boolean finishComposingText() {
boolean result = super.finishComposingText();
// Apply Samsung hacks. Samsung caches composing region data strangely, causing text
// duplication.
if (isSamsung) {
if (Build.VERSION.SDK_INT >= 21) {
// Samsung keyboards don't clear the composing region on finishComposingText.
// Update the keyboard with a reset/empty composing region. Critical on
// Samsung keyboards to prevent punctuation duplication.
CursorAnchorInfo.Builder builder = new CursorAnchorInfo.Builder();
builder.setComposingText(/*composingTextStart*/ -1, /*composingText*/ "");
CursorAnchorInfo anchorInfo = builder.build();
mImm.updateCursorAnchorInfo(mFlutterView, anchorInfo);
}
}
markDirty();
return result;
}
// TODO(garyq): Implement a more feature complete version of getExtractedText
@Override
public ExtractedText getExtractedText(ExtractedTextRequest request, int flags) {
ExtractedText extractedText = new ExtractedText();
extractedText.selectionStart = Selection.getSelectionStart(mEditable);
extractedText.selectionEnd = Selection.getSelectionEnd(mEditable);
extractedText.text = mEditable.toString();
return extractedText;
}
@Override
public boolean clearMetaKeyStates(int states) {
boolean result = super.clearMetaKeyStates(states);
markDirty();
return result;
}
// Detect if the keyboard is a Samsung keyboard, where we apply Samsung-specific hacks to
// fix critical bugs that make the keyboard otherwise unusable. See finishComposingText() for
// more details.
@SuppressLint("NewApi") // New API guard is inline, the linter can't see it.
@SuppressWarnings("deprecation")
private boolean isSamsung() {
InputMethodSubtype subtype = mImm.getCurrentInputMethodSubtype();
// Impacted devices all shipped with Android Lollipop or newer.
if (subtype == null
|| Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP
|| !Build.MANUFACTURER.equals("samsung")) {
return false;
}
String keyboardName =
Settings.Secure.getString(
mFlutterView.getContext().getContentResolver(), Settings.Secure.DEFAULT_INPUT_METHOD);
// The Samsung keyboard is called "com.sec.android.inputmethod/.SamsungKeypad" but look
// for "Samsung" just in case Samsung changes the name of the keyboard.
return keyboardName.contains("Samsung");
}
@Override
public boolean setSelection(int start, int end) {
boolean result = super.setSelection(start, end);
markDirty();
return result;
}
// Sanitizes the index to ensure the index is within the range of the
// contents of editable.
private static int clampIndexToEditable(int index, Editable editable) {
int clamped = Math.max(0, Math.min(editable.length(), index));
if (clamped != index) {
Log.d(
"flutter",
"Text selection index was clamped ("
+ index
+ "->"
+ clamped
+ ") to remain in bounds. This may not be your fault, as some keyboards may select outside of bounds.");
}
return clamped;
}
@Override
public boolean sendKeyEvent(KeyEvent event) {
markDirty();
if (event.getAction() == KeyEvent.ACTION_DOWN) {
if (event.getKeyCode() == KeyEvent.KEYCODE_DEL) {
int selStart = clampIndexToEditable(Selection.getSelectionStart(mEditable), mEditable);
int selEnd = clampIndexToEditable(Selection.getSelectionEnd(mEditable), mEditable);
if (selEnd > selStart) {
// Delete the selection.
Selection.setSelection(mEditable, selStart);
mEditable.delete(selStart, selEnd);
updateEditingState();
return true;
} else if (selStart > 0) {
// Delete to the left/right of the cursor depending on direction of text.
// TODO(garyq): Explore how to obtain per-character direction. The
// isRTLCharAt() call below is returning blanket direction assumption
// based on the first character in the line.
boolean isRtl = mLayout.isRtlCharAt(mLayout.getLineForOffset(selStart));
try {
if (isRtl) {
Selection.extendRight(mEditable, mLayout);
} else {
Selection.extendLeft(mEditable, mLayout);
}
} catch (IndexOutOfBoundsException e) {
// On some Chinese devices (primarily Huawei, some Xiaomi),
// on initial app startup before focus is lost, the
// Selection.extendLeft and extendRight calls always extend
// from the index of the initial contents of mEditable. This
// try-catch will prevent crashing on Huawei devices by falling
// back to a simple way of deletion, although this a hack and
// will not handle emojis.
Selection.setSelection(mEditable, selStart, selStart - 1);
}
int newStart = clampIndexToEditable(Selection.getSelectionStart(mEditable), mEditable);
int newEnd = clampIndexToEditable(Selection.getSelectionEnd(mEditable), mEditable);
Selection.setSelection(mEditable, Math.min(newStart, newEnd));
// Min/Max the values since RTL selections will start at a higher
// index than they end at.
mEditable.delete(Math.min(newStart, newEnd), Math.max(newStart, newEnd));
updateEditingState();
return true;
}
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_LEFT) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
int newSel = Math.max(selStart - 1, 0);
setSelection(newSel, newSel);
} else {
int newSelEnd = Math.max(selEnd - 1, 0);
setSelection(selStart, newSelEnd);
}
return true;
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_RIGHT) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
int newSel = Math.min(selStart + 1, mEditable.length());
setSelection(newSel, newSel);
} else {
int newSelEnd = Math.min(selEnd + 1, mEditable.length());
setSelection(selStart, newSelEnd);
}
return true;
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_UP) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
Selection.moveUp(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
setSelection(newSelStart, newSelStart);
} else {
Selection.extendUp(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
int newSelEnd = Selection.getSelectionEnd(mEditable);
setSelection(newSelStart, newSelEnd);
}
return true;
} else if (event.getKeyCode() == KeyEvent.KEYCODE_DPAD_DOWN) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart == selEnd && !event.isShiftPressed()) {
Selection.moveDown(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
setSelection(newSelStart, newSelStart);
} else {
Selection.extendDown(mEditable, mLayout);
int newSelStart = Selection.getSelectionStart(mEditable);
int newSelEnd = Selection.getSelectionEnd(mEditable);
setSelection(newSelStart, newSelEnd);
}
return true;
// When the enter key is pressed on a non-multiline field, consider it a
// submit instead of a newline.
} else if ((event.getKeyCode() == KeyEvent.KEYCODE_ENTER
|| event.getKeyCode() == KeyEvent.KEYCODE_NUMPAD_ENTER)
&& (InputType.TYPE_TEXT_FLAG_MULTI_LINE & mEditorInfo.inputType) == 0) {
performEditorAction(mEditorInfo.imeOptions & EditorInfo.IME_MASK_ACTION);
return true;
} else {
// Enter a character.
int character = event.getUnicodeChar();
if (character != 0) {
int selStart = Math.max(0, Selection.getSelectionStart(mEditable));
int selEnd = Math.max(0, Selection.getSelectionEnd(mEditable));
int selMin = Math.min(selStart, selEnd);
int selMax = Math.max(selStart, selEnd);
if (selMin != selMax) mEditable.delete(selMin, selMax);
mEditable.insert(selMin, String.valueOf((char) character));
setSelection(selMin + 1, selMin + 1);
}
return true;
}
}
if (event.getAction() == KeyEvent.ACTION_UP
&& (event.getKeyCode() == KeyEvent.KEYCODE_SHIFT_LEFT
|| event.getKeyCode() == KeyEvent.KEYCODE_SHIFT_RIGHT)) {
int selEnd = Selection.getSelectionEnd(mEditable);
setSelection(selEnd, selEnd);
return true;
}
return false;
}
@Override
public boolean performContextMenuAction(int id) {
markDirty();
if (id == android.R.id.selectAll) {
setSelection(0, mEditable.length());
return true;
} else if (id == android.R.id.cut) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart != selEnd) {
int selMin = Math.min(selStart, selEnd);
int selMax = Math.max(selStart, selEnd);
CharSequence textToCut = mEditable.subSequence(selMin, selMax);
ClipboardManager clipboard =
(ClipboardManager)
mFlutterView.getContext().getSystemService(Context.CLIPBOARD_SERVICE);
ClipData clip = ClipData.newPlainText("text label?", textToCut);
clipboard.setPrimaryClip(clip);
mEditable.delete(selMin, selMax);
setSelection(selMin, selMin);
}
return true;
} else if (id == android.R.id.copy) {
int selStart = Selection.getSelectionStart(mEditable);
int selEnd = Selection.getSelectionEnd(mEditable);
if (selStart != selEnd) {
CharSequence textToCopy =
mEditable.subSequence(Math.min(selStart, selEnd), Math.max(selStart, selEnd));
ClipboardManager clipboard =
(ClipboardManager)
mFlutterView.getContext().getSystemService(Context.CLIPBOARD_SERVICE);
clipboard.setPrimaryClip(ClipData.newPlainText("text label?", textToCopy));
}
return true;
} else if (id == android.R.id.paste) {
ClipboardManager clipboard =
(ClipboardManager) mFlutterView.getContext().getSystemService(Context.CLIPBOARD_SERVICE);
ClipData clip = clipboard.getPrimaryClip();
if (clip != null) {
CharSequence textToPaste = clip.getItemAt(0).coerceToText(mFlutterView.getContext());
int selStart = Math.max(0, Selection.getSelectionStart(mEditable));
int selEnd = Math.max(0, Selection.getSelectionEnd(mEditable));
int selMin = Math.min(selStart, selEnd);
int selMax = Math.max(selStart, selEnd);
if (selMin != selMax) mEditable.delete(selMin, selMax);
mEditable.insert(selMin, textToPaste);
int newSelStart = selMin + textToPaste.length();
setSelection(newSelStart, newSelStart);
}
return true;
}
return false;
}
@Override
public boolean performEditorAction(int actionCode) {
markDirty();
switch (actionCode) {
case EditorInfo.IME_ACTION_NONE:
textInputChannel.newline(mClient);
break;
case EditorInfo.IME_ACTION_UNSPECIFIED:
textInputChannel.unspecifiedAction(mClient);
break;
case EditorInfo.IME_ACTION_GO:
textInputChannel.go(mClient);
break;
case EditorInfo.IME_ACTION_SEARCH:
textInputChannel.search(mClient);
break;
case EditorInfo.IME_ACTION_SEND:
textInputChannel.send(mClient);
break;
case EditorInfo.IME_ACTION_NEXT:
textInputChannel.next(mClient);
break;
case EditorInfo.IME_ACTION_PREVIOUS:
textInputChannel.previous(mClient);
break;
default:
case EditorInfo.IME_ACTION_DONE:
textInputChannel.done(mClient);
break;
}
return true;
}
}
| Implement Hashcode for TextEditingValue in InputConnectionAdaptor (#17643)
| shell/platform/android/io/flutter/plugin/editing/InputConnectionAdaptor.java | Implement Hashcode for TextEditingValue in InputConnectionAdaptor (#17643) | <ide><path>hell/platform/android/io/flutter/plugin/editing/InputConnectionAdaptor.java
<ide> && composingStart == value.composingStart
<ide> && composingEnd == value.composingEnd
<ide> && text.equals(value.text);
<add> }
<add>
<add> @Override
<add> public int hashCode() {
<add> final int prime = 31;
<add> int result = 1;
<add> result = prime * result + selectionStart;
<add> result = prime * result + selectionEnd;
<add> result = prime * result + composingStart;
<add> result = prime * result + composingEnd;
<add> result = prime * result + text.hashCode();
<add> return result;
<ide> }
<ide> }
<ide> |
|
JavaScript | mit | eeae3bfae92eb5ad910f62773e0db1cd49414058 | 0 | Inist-CNRS/node-xml-writer,touv/node-xml-writer |
function strval(s) {
if (typeof s == 'string') {
return s;
}
else if (typeof s == 'function') {
return s();
}
else if (s instanceof XMLWriter) {
return s.toString();
}
else throw Error('Bad Parameter');
}
function XMLWriter(indent, callback) {
if (!(this instanceof XMLWriter)) {
return new XMLWriter();
}
this.name_regex = /[_:A-Za-z][-._:A-Za-z0-9]*/;
this.indent = indent ? true : false;
this.output = '';
this.stack = [];
this.tags = 0;
this.attributes = 0;
this.attribute = 0;
this.texts = 0;
this.comment = 0;
this.pi = 0;
this.cdata = 0;
this.writer;
this.writer_encoding = 'UTF-8';
if (typeof callback == 'function') {
this.writer = callback;
} else {
this.writer = function (s, e) {
this.output += s;
}
}
}
XMLWriter.prototype = {
toString : function () {
this.flush();
return this.output;
},
indenter : function () {
if (this.indent) {
this.write('\n');
for (var i = 1; i < this.tags; i++) {
this.write(' ');
}
}
},
write : function () {
for (var i = 0; i < arguments.length; i++) {
this.writer(arguments[i], this.writer_encoding);
}
},
flush : function () {
for (var i = this.tags; i > 0; i--) {
this.endElement();
}
this.tags = 0;
},
startDocument : function (version, encoding, standalone) {
if (this.tags || this.attributes) return this;
this.startPI('xml');
this.startAttribute('version');
this.text(typeof version == "string" ? version : "1.0");
this.endAttribute();
if (typeof encoding == "string") {
this.startAttribute('encoding');
this.text(encoding);
this.endAttribute();
writer_encoding = encoding;
}
if (standalone) {
this.startAttribute('standalone');
this.text("yes");
this.endAttribute();
}
this.endPI();
if (!this.indent) {
this.write('\n');
}
return this;
},
endDocument : function () {
if (this.attributes) this.endAttributes();
return this;
},
writeElement : function (name, content) {
return this.startElement(name).text(content).endElement();
},
startElement : function (name) {
name = strval(name);
if (!name.match(this.name_regex)) throw Error('Invalid Parameter');
if (this.attributes) this.endAttributes();
++this.tags;
this.texts = 0;
if (this.stack.length > 0)
this.stack[this.stack.length-1].containsTag = true;
this.stack.push({
name: name,
tags: this.tags
});
this.indenter();
this.write('<', name);
this.startAttributes();
return this;
},
endElement : function () {
if (!this.tags) return this;
var t = this.stack.pop();
if (this.attributes > 0) {
if (this.attribute) {
if (this.texts) this.endAttribute();
this.endAttribute();
}
this.write('/');
this.endAttributes();
} else {
if (t.containsTag) this.indenter();
this.write('</', t.name, '>');
}
--this.tags;
this.texts = 0;
return this;
},
writeAttribute : function (name, content) {
return this.startAttribute(name).text(content).endAttribute();
},
startAttributes : function () {
this.attributes = 1;
return this;
},
endAttributes : function () {
if (!this.attributes) return this;
if (this.attribute) this.endAttribute();
this.attributes = 0;
this.attribute = 0;
this.texts = 0;
this.write('>');
return this;
},
startAttribute : function (name) {
name = strval(name);
if (!name.match(this.name_regex)) throw Error('Invalid Parameter');
if (!this.attributes && !this.pi) return this;
if (this.attribute) return this;
this.attribute = 1;
this.write(' ', name, '="');
return this;
},
endAttribute : function () {
if (!this.attribute) return this;
this.attribute = 0;
this.texts = 0;
this.write('"');
return this;
},
text : function (content) {
content = strval(content);
if (!this.tags && !this.comment && !this.pi && !this.cdata) return this;
if (this.attributes && this.attribute) {
++this.texts;
this.write(content.replace(/&/g, '&').replace(/"/g, '"'));
return this;
} else if (this.attributes && !this.attribute) {
this.endAttributes();
}
++this.texts;
this.write(content.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>'));
return this;
},
writeComment : function (content) {
return this.startComment().text(content).endComment();
},
startComment : function () {
if (this.comment) return this;
if (this.attributes) this.endAttributes();
this.indenter();
this.write('<!--');
this.comment = 1;
return this;
},
endComment : function () {
if (!this.comment) return this;
this.write('-->');
this.comment = 0;
return this;
},
writePI : function (name, content) {
return this.startPI(name).text(content).endPI()
},
startPI : function (name) {
name = strval(name);
if (!name.match(this.name_regex)) throw Error('Invalid Parameter');
if (this.pi) return this;
if (this.attributes) this.endAttributes();
if (this.stack.length) {
this.indenter();
}
this.write('<?', name);
this.pi = 1;
return this;
},
endPI : function () {
if (!this.pi) return this;
this.write('?>');
this.pi = 0;
return this;
},
writeCData : function (content) {
return this.startCData().text(content).endCData();
},
startCData : function () {
if (this.cdata) return this;
if (this.attributes) this.endAttributes();
this.indenter();
this.write('<![CDATA[');
this.cdata = 1;
return this;
},
endCData : function () {
if (!this.cdata) return this;
this.write(']]>');
this.cdata = 0;
return this;
},
writeRaw : function(content) {
content = strval(content);
if (!this.tags && !this.comment && !this.pi && !this.cdata) return this;
if (this.attributes && this.attribute) {
++this.texts;
this.write(content.replace('&', '&').replace('"', '"'));
return this;
} else if (this.attributes && !this.attribute) {
this.endAttributes();
}
++this.texts;
this.write(content);
return this;
}
}
module.exports = XMLWriter;
| lib/xml-writer.js |
function strval(s) {
if (typeof s == 'string') {
return s;
}
else if (typeof s == 'function') {
return s();
}
else if (s instanceof XMLWriter) {
return s.toString();
}
else throw Error('Bad Parameter');
}
function XMLWriter(indent, callback) {
if (!(this instanceof XMLWriter)) {
return new XMLWriter();
}
this.name_regex = /[_:A-Za-z][-._:A-Za-z0-9]*/;
this.indent = indent ? true : false;
this.output = '';
this.stack = [];
this.tags = 0;
this.attributes = 0;
this.attribute = 0;
this.texts = 0;
this.comment = 0;
this.pi = 0;
this.cdata = 0;
this.writer;
this.writer_encoding = 'UTF-8';
if (typeof callback == 'function') {
this.writer = callback;
} else {
this.writer = function (s, e) {
this.output += s;
}
}
}
XMLWriter.prototype = {
toString : function () {
this.flush();
return this.output;
},
indenter : function () {
if (this.indent) {
this.write('\n');
for (var i = 1; i < this.tags; i++) {
this.write(' ');
}
}
},
write : function () {
for (var i = 0; i < arguments.length; i++) {
this.writer(arguments[i], this.writer_encoding);
}
},
flush : function () {
for (var i = this.tags; i > 0; i--) {
this.endElement();
}
this.tags = 0;
},
startDocument : function (version, encoding, standalone) {
if (this.tags || this.attributes) return this;
this.startPI('xml');
this.startAttribute('version');
this.text(typeof version == "string" ? version : "1.0");
this.endAttribute();
if (typeof encoding == "string") {
this.startAttribute('encoding');
this.text(encoding);
this.endAttribute();
writer_encoding = encoding;
}
if (standalone) {
this.startAttribute('standalone');
this.text("yes");
this.endAttribute();
}
this.endPI();
if (!this.indent) {
this.write('\n');
}
return this;
},
endDocument : function () {
if (this.attributes) this.endAttributes();
return this;
},
writeElement : function (name, content) {
return this.startElement(name).text(content).endElement();
},
startElement : function (name) {
name = strval(name);
if (!name.match(this.name_regex)) throw Error('Invalid Parameter');
if (this.attributes) this.endAttributes();
++this.tags;
this.texts = 0;
this.stack.push({
name: name,
tags: this.tags
});
this.indenter();
this.write('<', name);
this.startAttributes();
return this;
},
endElement : function () {
if (!this.tags) return this;
var t = this.stack.pop();
if (this.attributes > 0) {
if (this.attribute) {
if (this.texts) this.endAttribute();
this.endAttribute();
}
this.write('/');
this.endAttributes();
} else {
this.write('</', t.name, '>');
}
--this.tags;
this.texts = 0;
return this;
},
writeAttribute : function (name, content) {
return this.startAttribute(name).text(content).endAttribute();
},
startAttributes : function () {
this.attributes = 1;
return this;
},
endAttributes : function () {
if (!this.attributes) return this;
if (this.attribute) this.endAttribute();
this.attributes = 0;
this.attribute = 0;
this.texts = 0;
this.write('>');
return this;
},
startAttribute : function (name) {
name = strval(name);
if (!name.match(this.name_regex)) throw Error('Invalid Parameter');
if (!this.attributes && !this.pi) return this;
if (this.attribute) return this;
this.attribute = 1;
this.write(' ', name, '="');
return this;
},
endAttribute : function () {
if (!this.attribute) return this;
this.attribute = 0;
this.texts = 0;
this.write('"');
return this;
},
text : function (content) {
content = strval(content);
if (!this.tags && !this.comment && !this.pi && !this.cdata) return this;
if (this.attributes && this.attribute) {
++this.texts;
this.write(content.replace(/&/g, '&').replace(/"/g, '"'));
return this;
} else if (this.attributes && !this.attribute) {
this.endAttributes();
}
++this.texts;
this.write(content.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>'));
return this;
},
writeComment : function (content) {
return this.startComment().text(content).endComment();
},
startComment : function () {
if (this.comment) return this;
if (this.attributes) this.endAttributes();
this.indenter();
this.write('<!--');
this.comment = 1;
return this;
},
endComment : function () {
if (!this.comment) return this;
this.write('-->');
this.comment = 0;
return this;
},
writePI : function (name, content) {
return this.startPI(name).text(content).endPI()
},
startPI : function (name) {
name = strval(name);
if (!name.match(this.name_regex)) throw Error('Invalid Parameter');
if (this.pi) return this;
if (this.attributes) this.endAttributes();
if (this.stack.length) {
this.indenter();
}
this.write('<?', name);
this.pi = 1;
return this;
},
endPI : function () {
if (!this.pi) return this;
this.write('?>');
this.pi = 0;
return this;
},
writeCData : function (content) {
return this.startCData().text(content).endCData();
},
startCData : function () {
if (this.cdata) return this;
if (this.attributes) this.endAttributes();
this.indenter();
this.write('<![CDATA[');
this.cdata = 1;
return this;
},
endCData : function () {
if (!this.cdata) return this;
this.write(']]>');
this.cdata = 0;
return this;
},
writeRaw : function(content) {
content = strval(content);
if (!this.tags && !this.comment && !this.pi && !this.cdata) return this;
if (this.attributes && this.attribute) {
++this.texts;
this.write(content.replace('&', '&').replace('"', '"'));
return this;
} else if (this.attributes && !this.attribute) {
this.endAttributes();
}
++this.texts;
this.write(content);
return this;
}
}
module.exports = XMLWriter;
| Fixed indentation not being applied to end tags whose groups contained
a subtree | lib/xml-writer.js | Fixed indentation not being applied to end tags whose groups contained a subtree | <ide><path>ib/xml-writer.js
<ide> if (this.attributes) this.endAttributes();
<ide> ++this.tags;
<ide> this.texts = 0;
<add> if (this.stack.length > 0)
<add> this.stack[this.stack.length-1].containsTag = true;
<add>
<ide> this.stack.push({
<ide> name: name,
<ide> tags: this.tags
<ide> this.write('/');
<ide> this.endAttributes();
<ide> } else {
<add> if (t.containsTag) this.indenter();
<ide> this.write('</', t.name, '>');
<ide> }
<ide> --this.tags;
<ide> return this;
<ide> },
<ide>
<del> writeRaw : function(content) {
<add> writeRaw : function(content) {
<ide> content = strval(content);
<ide> if (!this.tags && !this.comment && !this.pi && !this.cdata) return this;
<ide> if (this.attributes && this.attribute) { |
|
Java | apache-2.0 | 3c8f1c53b2feba92f486bf6f542b36209ce12e3b | 0 | ChetnaChaudhari/hadoop,ChetnaChaudhari/hadoop,ChetnaChaudhari/hadoop,ChetnaChaudhari/hadoop,ChetnaChaudhari/hadoop,ChetnaChaudhari/hadoop,ChetnaChaudhari/hadoop | /**
* 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.ozone.scm.block;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hdfs.DFSUtil;
import org.apache.hadoop.metrics2.util.MBeans;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.protocol.proto.OzoneProtos;
import org.apache.hadoop.ozone.scm.container.Mapping;
import org.apache.hadoop.ozone.scm.exceptions.SCMException;
import org.apache.hadoop.ozone.scm.node.NodeManager;
import org.apache.hadoop.ozone.web.utils.OzoneUtils;
import org.apache.hadoop.scm.ScmConfigKeys;
import org.apache.hadoop.scm.container.common.helpers.AllocatedBlock;
import org.apache.hadoop.scm.container.common.helpers.ContainerInfo;
import org.apache.hadoop.scm.container.common.helpers.BlockContainerInfo;
import org.apache.hadoop.scm.container.common.helpers.Pipeline;
import org.apache.hadoop.util.StringUtils;
import org.apache.hadoop.utils.BatchOperation;
import org.apache.hadoop.utils.MetadataStore;
import org.apache.hadoop.utils.MetadataStoreBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.management.ObjectName;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.stream.Collectors;
import java.util.UUID;
import static org.apache.hadoop.ozone.OzoneConsts.BLOCK_DB;
import static org.apache.hadoop.ozone.OzoneConsts.OPEN_CONTAINERS_DB;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
CHILL_MODE_EXCEPTION;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_ALLOCATE_CONTAINER;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_FIND_CONTAINER;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_FIND_CONTAINER_WITH_SAPCE;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_FIND_BLOCK;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_LOAD_OPEN_CONTAINER;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
INVALID_BLOCK_SIZE;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS_DEFAULT;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_TIMEOUT;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_TIMEOUT_DEFAULT;
/**
* Block Manager manages the block access for SCM.
*/
public class BlockManagerImpl implements BlockManager, BlockmanagerMXBean {
private static final Logger LOG =
LoggerFactory.getLogger(BlockManagerImpl.class);
private final NodeManager nodeManager;
private final Mapping containerManager;
private final MetadataStore blockStore;
private final Lock lock;
private final long containerSize;
private final long cacheSize;
// Track all containers owned by block service.
private final MetadataStore containerStore;
private final DeletedBlockLog deletedBlockLog;
private final SCMBlockDeletingService blockDeletingService;
private Map<OzoneProtos.LifeCycleState,
Map<String, BlockContainerInfo>> containers;
private final int containerProvisionBatchSize;
private final Random rand;
private final ObjectName mxBean;
/**
* Constructor.
* @param conf - configuration.
* @param nodeManager - node manager.
* @param containerManager - container manager.
* @param cacheSizeMB - cache size for level db store.
* @throws IOException
*/
public BlockManagerImpl(final Configuration conf,
final NodeManager nodeManager, final Mapping containerManager,
final int cacheSizeMB) throws IOException {
this.nodeManager = nodeManager;
this.containerManager = containerManager;
this.cacheSize = cacheSizeMB;
File metaDir = OzoneUtils.getScmMetadirPath(conf);
String scmMetaDataDir = metaDir.getPath();
// Write the block key to container name mapping.
File blockContainerDbPath = new File(scmMetaDataDir, BLOCK_DB);
blockStore = MetadataStoreBuilder.newBuilder()
.setConf(conf)
.setDbFile(blockContainerDbPath)
.setCacheSize(this.cacheSize * OzoneConsts.MB)
.build();
this.containerSize = OzoneConsts.GB * conf.getInt(
ScmConfigKeys.OZONE_SCM_CONTAINER_SIZE_GB,
ScmConfigKeys.OZONE_SCM_CONTAINER_SIZE_DEFAULT);
// Load store of all open contains for block allocation
File openContainsDbPath = new File(scmMetaDataDir, OPEN_CONTAINERS_DB);
containerStore = MetadataStoreBuilder.newBuilder()
.setConf(conf)
.setDbFile(openContainsDbPath)
.setCacheSize(this.cacheSize * OzoneConsts.MB)
.build();
loadAllocatedContainers();
this.containerProvisionBatchSize = conf.getInt(
ScmConfigKeys.OZONE_SCM_CONTAINER_PROVISION_BATCH_SIZE,
ScmConfigKeys.OZONE_SCM_CONTAINER_PROVISION_BATCH_SIZE_DEFAULT);
rand = new Random();
this.lock = new ReentrantLock();
mxBean = MBeans.register("BlockManager", "BlockManagerImpl", this);
// SCM block deleting transaction log and deleting service.
deletedBlockLog = new DeletedBlockLogImpl(conf);
int svcInterval = conf.getInt(
OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS,
OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS_DEFAULT);
long serviceTimeout = conf.getTimeDuration(
OZONE_BLOCK_DELETING_SERVICE_TIMEOUT,
OZONE_BLOCK_DELETING_SERVICE_TIMEOUT_DEFAULT, TimeUnit.MILLISECONDS);
blockDeletingService = new SCMBlockDeletingService(deletedBlockLog,
containerManager, nodeManager, svcInterval, serviceTimeout);
}
/**
* Start block manager services.
* @throws IOException
*/
public void start() throws IOException {
this.blockDeletingService.start();
}
/**
* Shutdown block manager services.
* @throws IOException
*/
public void stop() throws IOException {
this.blockDeletingService.shutdown();
this.close();
}
// TODO: close full (or almost full) containers with a separate thread.
/**
* Load allocated containers from persistent store.
* @throws IOException
*/
private void loadAllocatedContainers() throws IOException {
// Pre-allocate empty map entry by state to avoid null check
containers = new ConcurrentHashMap<>();
for (OzoneProtos.LifeCycleState state :
OzoneProtos.LifeCycleState.values()) {
containers.put(state, new ConcurrentHashMap());
}
try {
containerStore.iterate(null, (key, value) -> {
try {
String containerName = DFSUtil.bytes2String(key);
Long containerUsed = Long.parseLong(DFSUtil.bytes2String(value));
ContainerInfo containerInfo =
containerManager.getContainer(containerName);
// TODO: remove the container from block manager's container DB
// Most likely the allocated container is timeout and cleaned up
// by SCM, we should clean up correspondingly instead of just skip it.
if (containerInfo == null) {
LOG.warn("Container {} allocated by block service" +
"can't be found in SCM", containerName);
return true;
}
Map<String, BlockContainerInfo> containersByState =
containers.get(containerInfo.getState());
containersByState.put(containerName,
new BlockContainerInfo(containerInfo, containerUsed));
LOG.debug("Loading allocated container: {} used : {} state: {}",
containerName, containerUsed, containerInfo.getState());
} catch (Exception e) {
LOG.warn("Failed loading allocated container, continue next...");
}
return true;
});
} catch (IOException e) {
LOG.error("Loading open container store failed." + e);
throw new SCMException("Failed to load open container store",
FAILED_TO_LOAD_OPEN_CONTAINER);
}
}
/**
* Pre allocate specified count of containers for block creation.
* @param count - number of containers to allocate.
* @return list of container names allocated.
* @throws IOException
*/
private List<String> allocateContainers(int count) throws IOException {
List<String> results = new ArrayList();
lock.lock();
try {
for (int i = 0; i < count; i++) {
String containerName = UUID.randomUUID().toString();
ContainerInfo containerInfo = null;
try {
// TODO: Fix this later when Ratis is made the Default.
containerInfo = containerManager.allocateContainer(
OzoneProtos.ReplicationType.STAND_ALONE,
OzoneProtos.ReplicationFactor.ONE,
containerName);
if (containerInfo == null) {
LOG.warn("Unable to allocate container.");
continue;
}
} catch (IOException ex) {
LOG.warn("Unable to allocate container: " + ex);
continue;
}
Map<String, BlockContainerInfo> containersByState =
containers.get(OzoneProtos.LifeCycleState.ALLOCATED);
Preconditions.checkNotNull(containersByState);
containersByState.put(containerName,
new BlockContainerInfo(containerInfo, 0));
containerStore.put(DFSUtil.string2Bytes(containerName),
DFSUtil.string2Bytes(Long.toString(0L)));
results.add(containerName);
}
} finally {
lock.unlock();
}
return results;
}
/**
* Filter container by states and size.
* @param state the state of the container.
* @param size the minimal available size of the container
* @return allocated containers satisfy both state and size.
*/
private List <String> filterContainers(OzoneProtos.LifeCycleState state,
long size) {
Map<String, BlockContainerInfo> containersByState =
this.containers.get(state);
return containersByState.entrySet().parallelStream()
.filter(e -> ((e.getValue().getAllocated() + size < containerSize)))
.map(e -> e.getKey())
.collect(Collectors.toList());
}
private BlockContainerInfo getContainer(OzoneProtos.LifeCycleState state,
String name) {
Map<String, BlockContainerInfo> containersByState = this.containers.get(state);
return containersByState.get(name);
}
// Relies on the caller such as allocateBlock() to hold the lock
// to ensure containers map consistent.
private void updateContainer(OzoneProtos.LifeCycleState oldState, String name,
OzoneProtos.LifeCycleState newState) {
if (LOG.isDebugEnabled()) {
LOG.debug("Update container {} from state {} to state {}",
name, oldState, newState);
}
Map<String, BlockContainerInfo> containersInOldState =
this.containers.get(oldState);
BlockContainerInfo containerInfo = containersInOldState.get(name);
Preconditions.checkNotNull(containerInfo);
containersInOldState.remove(name);
Map<String, BlockContainerInfo> containersInNewState =
this.containers.get(newState);
containersInNewState.put(name, containerInfo);
}
// Refresh containers that have been allocated.
// We may not need to track all the states, just the creating/open/close
// should be enough for now.
private void refreshContainers() {
Map<String, BlockContainerInfo> containersByState =
this.containers.get(OzoneProtos.LifeCycleState.CREATING);
for (String containerName: containersByState.keySet()) {
try {
ContainerInfo containerInfo =
containerManager.getContainer(containerName);
if (containerInfo == null) {
// TODO: clean up containers that has been deleted on SCM but
// TODO: still in ALLOCATED state in block manager.
LOG.debug("Container {} allocated by block service" +
"can't be found in SCM", containerName);
continue;
}
if (containerInfo.getState() == OzoneProtos.LifeCycleState.OPEN) {
updateContainer(OzoneProtos.LifeCycleState.CREATING, containerName,
containerInfo.getState());
}
// TODO: check containers in other state and refresh as needed.
// TODO: ALLOCATED container that is timeout and DELETED. (unit test)
// TODO: OPEN container that is CLOSE.
} catch (IOException ex) {
LOG.debug("Failed to get container info for: {}", containerName);
}
}
}
/**
* Allocates a new block for a given size.
*
* SCM choose one of the open containers and returns that as the location for
* the new block. An open container is a container that is actively written to
* via replicated log.
* @param size - size of the block to be allocated
* @return - the allocated pipeline and key for the block
* @throws IOException
*/
@Override
public AllocatedBlock allocateBlock(final long size) throws IOException {
boolean createContainer = false;
if (size < 0 || size > containerSize) {
throw new SCMException("Unsupported block size",
INVALID_BLOCK_SIZE);
}
if (!nodeManager.isOutOfNodeChillMode()) {
throw new SCMException("Unable to create block while in chill mode",
CHILL_MODE_EXCEPTION);
}
lock.lock();
try {
refreshContainers();
List<String> candidates;
candidates = filterContainers(OzoneProtos.LifeCycleState.OPEN, size);
if (candidates.size() == 0) {
candidates = filterContainers(OzoneProtos.LifeCycleState.ALLOCATED,
size);
if (candidates.size() == 0) {
try {
candidates = allocateContainers(containerProvisionBatchSize);
} catch (IOException ex) {
LOG.error("Unable to allocate container for the block.");
throw new SCMException("Unable to allocate container for the block",
FAILED_TO_ALLOCATE_CONTAINER);
}
}
// now we should have some candidates in ALLOCATE state
if (candidates.size() == 0) {
throw new SCMException("Fail to find any container to allocate block " +
"of size " + size + ".", FAILED_TO_FIND_CONTAINER_WITH_SAPCE);
}
}
// Candidates list now should include only ALLOCATE or OPEN containers
int randomIdx = rand.nextInt(candidates.size());
String containerName = candidates.get(randomIdx);
if (LOG.isDebugEnabled()) {
LOG.debug("Find {} candidates: {}, picking: {}", candidates.size(),
candidates.toString(), containerName);
}
ContainerInfo containerInfo =
containerManager.getContainer(containerName);
if (containerInfo == null) {
LOG.debug("Unable to find container for the block");
throw new SCMException("Unable to find container to allocate block",
FAILED_TO_FIND_CONTAINER);
}
if (LOG.isDebugEnabled()) {
LOG.debug("Candidate {} state {}", containerName,
containerInfo.getState());
}
// Container must be either OPEN or ALLOCATE state
if (containerInfo.getState() == OzoneProtos.LifeCycleState.ALLOCATED) {
createContainer = true;
}
// TODO: make block key easier to debug (e.g., seq no)
// Allocate key for the block
String blockKey = UUID.randomUUID().toString();
AllocatedBlock.Builder abb = new AllocatedBlock.Builder()
.setKey(blockKey).setPipeline(containerInfo.getPipeline())
.setShouldCreateContainer(createContainer);
if (containerInfo.getPipeline().getMachines().size() > 0) {
blockStore.put(DFSUtil.string2Bytes(blockKey),
DFSUtil.string2Bytes(containerName));
// update the container usage information
BlockContainerInfo containerInfoUpdate =
getContainer(containerInfo.getState(), containerName);
Preconditions.checkNotNull(containerInfoUpdate);
containerInfoUpdate.addAllocated(size);
containerStore.put(DFSUtil.string2Bytes(containerName),
DFSUtil.string2Bytes(Long.toString(containerInfoUpdate.getAllocated())));
if (createContainer) {
OzoneProtos.LifeCycleState newState =
containerManager.updateContainerState(containerName,
OzoneProtos.LifeCycleEvent.BEGIN_CREATE);
updateContainer(containerInfo.getState(), containerName, newState);
}
return abb.build();
}
} finally {
lock.unlock();
}
return null;
}
/**
*
* Given a block key, return the Pipeline information.
* @param key - block key assigned by SCM.
* @return Pipeline (list of DNs and leader) to access the block.
* @throws IOException
*/
@Override
public Pipeline getBlock(final String key) throws IOException {
lock.lock();
try {
byte[] containerBytes = blockStore.get(DFSUtil.string2Bytes(key));
if (containerBytes == null) {
throw new SCMException("Specified block key does not exist. key : " +
key, FAILED_TO_FIND_BLOCK);
}
String containerName = DFSUtil.bytes2String(containerBytes);
ContainerInfo containerInfo = containerManager.getContainer(
containerName);
if (containerInfo == null) {
LOG.debug("Container {} allocated by block service" +
"can't be found in SCM", containerName);
throw new SCMException("Unable to find container for the block",
SCMException.ResultCodes.FAILED_TO_FIND_CONTAINER);
}
return containerInfo.getPipeline();
} finally {
lock.unlock();
}
}
/**
* Given a block key, delete a block.
* @param key - block key assigned by SCM.
* @throws IOException
*/
@Override
public void deleteBlock(final String key) throws IOException {
if (!nodeManager.isOutOfNodeChillMode()) {
throw new SCMException("Unable to delete block while in chill mode",
CHILL_MODE_EXCEPTION);
}
lock.lock();
try {
byte[] containerBytes = blockStore.get(DFSUtil.string2Bytes(key));
if (containerBytes == null) {
throw new SCMException("Specified block key does not exist. key : " +
key, FAILED_TO_FIND_BLOCK);
}
// TODO: track the block size info so that we can reclaim the container
// TODO: used space when the block is deleted.
BatchOperation batch = new BatchOperation();
String deletedKeyName = getDeletedKeyName(key);
// Add a tombstone for the deleted key
batch.put(DFSUtil.string2Bytes(deletedKeyName), containerBytes);
// Delete the block key
batch.delete(DFSUtil.string2Bytes(key));
blockStore.writeBatch(batch);
// TODO: Add async tombstone clean thread to send delete command to
// datanodes in the pipeline to clean up the blocks from containers.
// TODO: Container report handling of the deleted blocks:
// Remove tombstone and update open container usage.
// We will revisit this when the closed container replication is done.
} finally {
lock.unlock();
}
}
@Override
public DeletedBlockLog getDeletedBlockLog() {
return this.deletedBlockLog;
}
@VisibleForTesting
public String getDeletedKeyName(String key) {
return StringUtils.format(".Deleted/%s", key);
}
/**
* Close the resources for BlockManager.
* @throws IOException
*/
@Override
public void close() throws IOException {
if (blockStore != null) {
blockStore.close();
}
if (containerStore != null) {
containerStore.close();
}
if (deletedBlockLog != null) {
deletedBlockLog.close();
}
blockDeletingService.shutdown();
MBeans.unregister(mxBean);
}
@Override
public int getOpenContainersNo() {
return containers.get(OzoneProtos.LifeCycleState.OPEN).size();
}
}
| hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/scm/block/BlockManagerImpl.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.ozone.scm.block;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hdfs.DFSUtil;
import org.apache.hadoop.metrics2.util.MBeans;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.protocol.proto.OzoneProtos;
import org.apache.hadoop.ozone.scm.container.Mapping;
import org.apache.hadoop.ozone.scm.exceptions.SCMException;
import org.apache.hadoop.ozone.scm.node.NodeManager;
import org.apache.hadoop.ozone.web.utils.OzoneUtils;
import org.apache.hadoop.scm.ScmConfigKeys;
import org.apache.hadoop.scm.container.common.helpers.AllocatedBlock;
import org.apache.hadoop.scm.container.common.helpers.ContainerInfo;
import org.apache.hadoop.scm.container.common.helpers.BlockContainerInfo;
import org.apache.hadoop.scm.container.common.helpers.Pipeline;
import org.apache.hadoop.util.StringUtils;
import org.apache.hadoop.utils.BatchOperation;
import org.apache.hadoop.utils.MetadataStore;
import org.apache.hadoop.utils.MetadataStoreBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.management.ObjectName;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.stream.Collectors;
import java.util.UUID;
import static org.apache.hadoop.ozone.OzoneConsts.BLOCK_DB;
import static org.apache.hadoop.ozone.OzoneConsts.OPEN_CONTAINERS_DB;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
CHILL_MODE_EXCEPTION;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_ALLOCATE_CONTAINER;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_FIND_CONTAINER;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_FIND_CONTAINER_WITH_SAPCE;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_FIND_BLOCK;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
FAILED_TO_LOAD_OPEN_CONTAINER;
import static org.apache.hadoop.ozone.scm.exceptions.SCMException.ResultCodes.
INVALID_BLOCK_SIZE;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS_DEFAULT;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_TIMEOUT;
import static org.apache.hadoop.ozone.OzoneConfigKeys
.OZONE_BLOCK_DELETING_SERVICE_TIMEOUT_DEFAULT;
/**
* Block Manager manages the block access for SCM.
*/
public class BlockManagerImpl implements BlockManager, BlockmanagerMXBean {
private static final Logger LOG =
LoggerFactory.getLogger(BlockManagerImpl.class);
private final NodeManager nodeManager;
private final Mapping containerManager;
private final MetadataStore blockStore;
private final Lock lock;
private final long containerSize;
private final long cacheSize;
// Track all containers owned by block service.
private final MetadataStore containerStore;
private final DeletedBlockLog deletedBlockLog;
private final SCMBlockDeletingService blockDeletingService;
private Map<OzoneProtos.LifeCycleState,
Map<String, BlockContainerInfo>> containers;
private final int containerProvisionBatchSize;
private final Random rand;
private final ObjectName mxBean;
/**
* Constructor.
* @param conf - configuration.
* @param nodeManager - node manager.
* @param containerManager - container manager.
* @param cacheSizeMB - cache size for level db store.
* @throws IOException
*/
public BlockManagerImpl(final Configuration conf,
final NodeManager nodeManager, final Mapping containerManager,
final int cacheSizeMB) throws IOException {
this.nodeManager = nodeManager;
this.containerManager = containerManager;
this.cacheSize = cacheSizeMB;
File metaDir = OzoneUtils.getScmMetadirPath(conf);
String scmMetaDataDir = metaDir.getPath();
// Write the block key to container name mapping.
File blockContainerDbPath = new File(scmMetaDataDir, BLOCK_DB);
blockStore = MetadataStoreBuilder.newBuilder()
.setConf(conf)
.setDbFile(blockContainerDbPath)
.setCacheSize(this.cacheSize * OzoneConsts.MB)
.build();
this.containerSize = OzoneConsts.GB * conf.getInt(
ScmConfigKeys.OZONE_SCM_CONTAINER_SIZE_GB,
ScmConfigKeys.OZONE_SCM_CONTAINER_SIZE_DEFAULT);
// Load store of all open contains for block allocation
File openContainsDbPath = new File(scmMetaDataDir, OPEN_CONTAINERS_DB);
containerStore = MetadataStoreBuilder.newBuilder()
.setConf(conf)
.setDbFile(openContainsDbPath)
.setCacheSize(this.cacheSize * OzoneConsts.MB)
.build();
loadAllocatedContainers();
this.containerProvisionBatchSize = conf.getInt(
ScmConfigKeys.OZONE_SCM_CONTAINER_PROVISION_BATCH_SIZE,
ScmConfigKeys.OZONE_SCM_CONTAINER_PROVISION_BATCH_SIZE_DEFAULT);
rand = new Random();
this.lock = new ReentrantLock();
mxBean = MBeans.register("BlockManager", "BlockManagerImpl", this);
// SCM block deleting transaction log and deleting service.
deletedBlockLog = new DeletedBlockLogImpl(conf);
int svcInterval = conf.getInt(
OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS,
OZONE_BLOCK_DELETING_SERVICE_INTERVAL_MS_DEFAULT);
long serviceTimeout = conf.getTimeDuration(
OZONE_BLOCK_DELETING_SERVICE_TIMEOUT,
OZONE_BLOCK_DELETING_SERVICE_TIMEOUT_DEFAULT, TimeUnit.MILLISECONDS);
blockDeletingService = new SCMBlockDeletingService(deletedBlockLog,
containerManager, nodeManager, svcInterval, serviceTimeout);
}
/**
* Start block manager services.
* @throws IOException
*/
public void start() throws IOException {
this.blockDeletingService.start();
}
/**
* Shutdown block manager services.
* @throws IOException
*/
public void stop() throws IOException {
this.blockDeletingService.shutdown();
this.close();
}
// TODO: close full (or almost full) containers with a separate thread.
/**
* Load allocated containers from persistent store.
* @throws IOException
*/
private void loadAllocatedContainers() throws IOException {
// Pre-allocate empty map entry by state to avoid null check
containers = new ConcurrentHashMap<>();
for (OzoneProtos.LifeCycleState state :
OzoneProtos.LifeCycleState.values()) {
containers.put(state, new ConcurrentHashMap());
}
try {
containerStore.iterate(null, (key, value) -> {
try {
String containerName = DFSUtil.bytes2String(key);
Long containerUsed = Long.parseLong(DFSUtil.bytes2String(value));
ContainerInfo containerInfo =
containerManager.getContainer(containerName);
// TODO: remove the container from block manager's container DB
// Most likely the allocated container is timeout and cleaned up
// by SCM, we should clean up correspondingly instead of just skip it.
if (containerInfo == null) {
LOG.warn("Container {} allocated by block service" +
"can't be found in SCM", containerName);
return true;
}
Map<String, BlockContainerInfo> containersByState =
containers.get(containerInfo.getState());
containersByState.put(containerName,
new BlockContainerInfo(containerInfo, containerUsed));
LOG.debug("Loading allocated container: {} used : {} state: {}",
containerName, containerUsed, containerInfo.getState());
} catch (Exception e) {
LOG.warn("Failed loading allocated container, continue next...");
}
return true;
});
} catch (IOException e) {
LOG.error("Loading open container store failed." + e);
throw new SCMException("Failed to load open container store",
FAILED_TO_LOAD_OPEN_CONTAINER);
}
}
/**
* Pre allocate specified count of containers for block creation.
* @param count - number of containers to allocate.
* @return list of container names allocated.
* @throws IOException
*/
private List<String> allocateContainers(int count) throws IOException {
List<String> results = new ArrayList();
lock.lock();
try {
for (int i = 0; i < count; i++) {
String containerName = UUID.randomUUID().toString();
ContainerInfo containerInfo = null;
try {
// TODO: Fix this later when Ratis is made the Default.
containerInfo = containerManager.allocateContainer(
OzoneProtos.ReplicationType.STAND_ALONE,
OzoneProtos.ReplicationFactor.ONE,
containerName);
if (containerInfo == null) {
LOG.warn("Unable to allocate container.");
continue;
}
} catch (IOException ex) {
LOG.warn("Unable to allocate container: " + ex);
continue;
}
Map<String, BlockContainerInfo> containersByState =
containers.get(OzoneProtos.LifeCycleState.ALLOCATED);
Preconditions.checkNotNull(containersByState);
containersByState.put(containerName,
new BlockContainerInfo(containerInfo, 0));
containerStore.put(DFSUtil.string2Bytes(containerName),
DFSUtil.string2Bytes(Long.toString(0L)));
results.add(containerName);
}
} finally {
lock.unlock();
}
return results;
}
/**
* Filter container by states and size.
* @param state the state of the container.
* @param size the minimal available size of the container
* @return allocated containers satisfy both state and size.
*/
private List <String> filterContainers(OzoneProtos.LifeCycleState state,
long size) {
Map<String, BlockContainerInfo> containersByState =
this.containers.get(state);
return containersByState.entrySet().parallelStream()
.filter(e -> ((e.getValue().getAllocated() + size < containerSize)))
.map(e -> e.getKey())
.collect(Collectors.toList());
}
private BlockContainerInfo getContainer(OzoneProtos.LifeCycleState state,
String name) {
Map<String, BlockContainerInfo> containersByState = this.containers.get(state);
return containersByState.get(name);
}
// Relies on the caller such as allocateBlock() to hold the lock
// to ensure containers map consistent.
private void updateContainer(OzoneProtos.LifeCycleState oldState, String name,
OzoneProtos.LifeCycleState newState) {
if (LOG.isDebugEnabled()) {
LOG.debug("Update container {} from state {} to state {}",
name, oldState, newState);
}
Map<String, BlockContainerInfo> containersInOldState =
this.containers.get(oldState);
BlockContainerInfo containerInfo = containersInOldState.get(name);
Preconditions.checkNotNull(containerInfo);
containersInOldState.remove(name);
Map<String, BlockContainerInfo> containersInNewState =
this.containers.get(newState);
containersInNewState.put(name, containerInfo);
}
// Refresh containers that have been allocated.
// We may not need to track all the states, just the creating/open/close
// should be enough for now.
private void refreshContainers() {
Map<String, BlockContainerInfo> containersByState =
this.containers.get(OzoneProtos.LifeCycleState.ALLOCATED);
for (String containerName: containersByState.keySet()) {
try {
ContainerInfo containerInfo =
containerManager.getContainer(containerName);
if (containerInfo == null) {
// TODO: clean up containers that has been deleted on SCM but
// TODO: still in ALLOCATED state in block manager.
LOG.debug("Container {} allocated by block service" +
"can't be found in SCM", containerName);
continue;
}
if (containerInfo.getState() == OzoneProtos.LifeCycleState.OPEN) {
updateContainer(OzoneProtos.LifeCycleState.ALLOCATED, containerName,
containerInfo.getState());
}
// TODO: check containers in other state and refresh as needed.
// TODO: ALLOCATED container that is timeout and DELETED. (unit test)
// TODO: OPEN container that is CLOSE.
} catch (IOException ex) {
LOG.debug("Failed to get container info for: {}", containerName);
}
}
}
/**
* Allocates a new block for a given size.
*
* SCM choose one of the open containers and returns that as the location for
* the new block. An open container is a container that is actively written to
* via replicated log.
* @param size - size of the block to be allocated
* @return - the allocated pipeline and key for the block
* @throws IOException
*/
@Override
public AllocatedBlock allocateBlock(final long size) throws IOException {
boolean createContainer = false;
if (size < 0 || size > containerSize) {
throw new SCMException("Unsupported block size",
INVALID_BLOCK_SIZE);
}
if (!nodeManager.isOutOfNodeChillMode()) {
throw new SCMException("Unable to create block while in chill mode",
CHILL_MODE_EXCEPTION);
}
lock.lock();
try {
refreshContainers();
List<String> candidates;
candidates = filterContainers(OzoneProtos.LifeCycleState.OPEN, size);
if (candidates.size() == 0) {
candidates = filterContainers(OzoneProtos.LifeCycleState.ALLOCATED,
size);
if (candidates.size() == 0) {
try {
candidates = allocateContainers(containerProvisionBatchSize);
} catch (IOException ex) {
LOG.error("Unable to allocate container for the block.");
throw new SCMException("Unable to allocate container for the block",
FAILED_TO_ALLOCATE_CONTAINER);
}
}
// now we should have some candidates in ALLOCATE state
if (candidates.size() == 0) {
throw new SCMException("Fail to find any container to allocate block " +
"of size " + size + ".", FAILED_TO_FIND_CONTAINER_WITH_SAPCE);
}
}
// Candidates list now should include only ALLOCATE or OPEN containers
int randomIdx = rand.nextInt(candidates.size());
String containerName = candidates.get(randomIdx);
if (LOG.isDebugEnabled()) {
LOG.debug("Find {} candidates: {}, picking: {}", candidates.size(),
candidates.toString(), containerName);
}
ContainerInfo containerInfo =
containerManager.getContainer(containerName);
if (containerInfo == null) {
LOG.debug("Unable to find container for the block");
throw new SCMException("Unable to find container to allocate block",
FAILED_TO_FIND_CONTAINER);
}
if (LOG.isDebugEnabled()) {
LOG.debug("Candidate {} state {}", containerName,
containerInfo.getState());
}
// Container must be either OPEN or ALLOCATE state
if (containerInfo.getState() == OzoneProtos.LifeCycleState.ALLOCATED) {
createContainer = true;
}
// TODO: make block key easier to debug (e.g., seq no)
// Allocate key for the block
String blockKey = UUID.randomUUID().toString();
AllocatedBlock.Builder abb = new AllocatedBlock.Builder()
.setKey(blockKey).setPipeline(containerInfo.getPipeline())
.setShouldCreateContainer(createContainer);
if (containerInfo.getPipeline().getMachines().size() > 0) {
blockStore.put(DFSUtil.string2Bytes(blockKey),
DFSUtil.string2Bytes(containerName));
// update the container usage information
BlockContainerInfo containerInfoUpdate =
getContainer(containerInfo.getState(), containerName);
Preconditions.checkNotNull(containerInfoUpdate);
containerInfoUpdate.addAllocated(size);
containerStore.put(DFSUtil.string2Bytes(containerName),
DFSUtil.string2Bytes(Long.toString(containerInfoUpdate.getAllocated())));
if (createContainer) {
OzoneProtos.LifeCycleState newState =
containerManager.updateContainerState(containerName,
OzoneProtos.LifeCycleEvent.BEGIN_CREATE);
updateContainer(containerInfo.getState(), containerName, newState);
}
return abb.build();
}
} finally {
lock.unlock();
}
return null;
}
/**
*
* Given a block key, return the Pipeline information.
* @param key - block key assigned by SCM.
* @return Pipeline (list of DNs and leader) to access the block.
* @throws IOException
*/
@Override
public Pipeline getBlock(final String key) throws IOException {
lock.lock();
try {
byte[] containerBytes = blockStore.get(DFSUtil.string2Bytes(key));
if (containerBytes == null) {
throw new SCMException("Specified block key does not exist. key : " +
key, FAILED_TO_FIND_BLOCK);
}
String containerName = DFSUtil.bytes2String(containerBytes);
ContainerInfo containerInfo = containerManager.getContainer(
containerName);
if (containerInfo == null) {
LOG.debug("Container {} allocated by block service" +
"can't be found in SCM", containerName);
throw new SCMException("Unable to find container for the block",
SCMException.ResultCodes.FAILED_TO_FIND_CONTAINER);
}
return containerInfo.getPipeline();
} finally {
lock.unlock();
}
}
/**
* Given a block key, delete a block.
* @param key - block key assigned by SCM.
* @throws IOException
*/
@Override
public void deleteBlock(final String key) throws IOException {
if (!nodeManager.isOutOfNodeChillMode()) {
throw new SCMException("Unable to delete block while in chill mode",
CHILL_MODE_EXCEPTION);
}
lock.lock();
try {
byte[] containerBytes = blockStore.get(DFSUtil.string2Bytes(key));
if (containerBytes == null) {
throw new SCMException("Specified block key does not exist. key : " +
key, FAILED_TO_FIND_BLOCK);
}
// TODO: track the block size info so that we can reclaim the container
// TODO: used space when the block is deleted.
BatchOperation batch = new BatchOperation();
String deletedKeyName = getDeletedKeyName(key);
// Add a tombstone for the deleted key
batch.put(DFSUtil.string2Bytes(deletedKeyName), containerBytes);
// Delete the block key
batch.delete(DFSUtil.string2Bytes(key));
blockStore.writeBatch(batch);
// TODO: Add async tombstone clean thread to send delete command to
// datanodes in the pipeline to clean up the blocks from containers.
// TODO: Container report handling of the deleted blocks:
// Remove tombstone and update open container usage.
// We will revisit this when the closed container replication is done.
} finally {
lock.unlock();
}
}
@Override
public DeletedBlockLog getDeletedBlockLog() {
return this.deletedBlockLog;
}
@VisibleForTesting
public String getDeletedKeyName(String key) {
return StringUtils.format(".Deleted/%s", key);
}
/**
* Close the resources for BlockManager.
* @throws IOException
*/
@Override
public void close() throws IOException {
if (blockStore != null) {
blockStore.close();
}
if (containerStore != null) {
containerStore.close();
}
if (deletedBlockLog != null) {
deletedBlockLog.close();
}
blockDeletingService.shutdown();
MBeans.unregister(mxBean);
}
@Override
public int getOpenContainersNo() {
return containers.get(OzoneProtos.LifeCycleState.OPEN).size();
}
}
| HDFS-12382. Ozone: SCM: BlockManager creates a new container for each allocateBlock call. Contributed by Nandakumar.
| hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/scm/block/BlockManagerImpl.java | HDFS-12382. Ozone: SCM: BlockManager creates a new container for each allocateBlock call. Contributed by Nandakumar. | <ide><path>adoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/ozone/scm/block/BlockManagerImpl.java
<ide> // should be enough for now.
<ide> private void refreshContainers() {
<ide> Map<String, BlockContainerInfo> containersByState =
<del> this.containers.get(OzoneProtos.LifeCycleState.ALLOCATED);
<add> this.containers.get(OzoneProtos.LifeCycleState.CREATING);
<ide> for (String containerName: containersByState.keySet()) {
<ide> try {
<ide> ContainerInfo containerInfo =
<ide> continue;
<ide> }
<ide> if (containerInfo.getState() == OzoneProtos.LifeCycleState.OPEN) {
<del> updateContainer(OzoneProtos.LifeCycleState.ALLOCATED, containerName,
<add> updateContainer(OzoneProtos.LifeCycleState.CREATING, containerName,
<ide> containerInfo.getState());
<ide> }
<ide> // TODO: check containers in other state and refresh as needed. |
|
JavaScript | mit | dcf50df89867ae91671455e0e110b6b5848c9e60 | 0 | ihmeuw/beaut,ihmeuw/beaut,ihmeuw/beaut,ihmeuw/ihme-ui,ihmeuw/ihme-ui,ihmeuw/ihme-ui | import topojson from 'topojson';
import { reduce } from 'lodash';
import d3 from 'd3';
/**
* extract topojson layers as geoJSON
* @param {Object} topology -> valid topojson
* @param {Array} layers -> layers to include
* @return {Object} -> { mesh: {...}, feature: {...} }
*/
export function extractGeoJSON(topology, layers) {
const initialMap = {
mesh: {},
feature: {}
};
const defaultMeshFilter = () => { return true; };
return reduce(layers, (map, layer) => {
/* eslint-disable no-param-reassign */
// each layer is an object with keys 'name', 'type', and, optionally, 'filterFn'
// 'name' should map to a key in topology.objects
// 'type' is one of 'feature' or 'mesh', defaults to 'feature'
// make certain the layer exists on the topojson
if (!topology.objects.hasOwnProperty(layer.name)) return map;
switch (layer.type) {
// wrap case in braces to create local scope
case 'mesh': {
// if filterFn is undefined, the meshgrid will be unfiltered
const filter = layer.filterFn || defaultMeshFilter;
map.mesh[layer.name] = topojson.mesh(topology, topology.objects[layer.name], filter);
break;
}
case 'feature': // FALL THROUGH
default:
map.feature[layer.name] = topojson.feature(topology, topology.objects[layer.name]);
}
return map;
}, initialMap);
}
/**
*
* @param {Object} extractedGeoJSON -> expect type of object returned by extractGeoJSON
* @returns {Array} array of features
*/
export function concatGeoJSON(extractedGeoJSON) {
// iterate over each property of extractedGeoJSON ('mesh' & 'feature')
// reduce to single array of features
return reduce(extractedGeoJSON, (collection, type) => {
// extractedGeoJSON[type] will be one of [extractedGeoJSON.mesh, extractedGeoJSON.feature]
// each is an object with geoJSON features or geometric objects
const combinedFeatures = reduce(type, (intermediateCollection, geoJSON) => {
switch (geoJSON.type) {
// topojson::feature will only return GeoJSON Feature or FeatureCollection
// topojson::mesh will return GeoJSON MultiLineString
case 'FeatureCollection':
return intermediateCollection.concat(geoJSON.features);
case 'MultiLineString': // FALL THROUGH
case 'Feature':
intermediateCollection.push(geoJSON);
return intermediateCollection;
default:
return intermediateCollection;
}
}, []);
return collection.concat(combinedFeatures);
}, []);
}
/**
* compute projected bounding box (in pixel space) of geometry
* @param featureCollection
* @returns {Array} [[left, top], [right, bottom]]
*/
export function computeBounds(featureCollection) {
return d3.geo.path().projection(null).bounds(featureCollection);
}
/**
* calculate center point of geometry given
* current translation, scale, and container dimensions
* @returns {Array}
*/
export function calcCenterPoint(width, height, scale, translate) {
// mike bostock math
return [(width - 2 * translate[0]) / scale, (height - 2 * translate[1]) / scale];
}
/**
* calculate scale at which the topology will fit centered in its container
* @param {Array} bounds
* @param {Number} width
* @param {Number} height
* @param {Number} proportion
* @returns {Number}
*/
export function calcScale(bounds, width, height, proportion = 0.95) {
// mike bostock math
// aspectX = rightEdge - leftEdge / width
const aspectX = (Math.abs(bounds[1][0] - bounds[0][0])) / width;
// aspectY = bottomEdge - topEdge / height
const aspectY = (Math.abs(bounds[1][1] - bounds[0][1])) / height;
return (proportion / Math.max(aspectX, aspectY));
}
/**
* calculate translations at which the topology will fit centered in its container
* @param {Number} width
* @param {Number} height
* @param {Number} scale
* @param {Array} bounds -> optional bounds of topology;
* if not passed in, must pass in center
* @param {Array} center -> optional center point of topology;
* if not passed in, must pass in bounds
* @returns {Array}
*/
export function calcTranslate(width, height, scale, bounds, center) {
const geometryX = center ? center[0] : bounds[1][0] + bounds[0][0];
const geometryY = center ? center[1] : bounds[1][1] + bounds[0][1];
// mike bostock math
return [
(width - (scale * geometryX)) / 2,
(height - (scale * geometryY)) / 2
];
}
/**
* @param geoJSON {Object} -> expect object as returned by ihme-ui/utils/geo/extractGeoJSON
* @returns {Array}
*/
export function concatAndComputeGeoJSONBounds(geoJSON) {
// returns projected bounding box (in pixel space)
// of entire geometry
// returns [[left, top], [right, bottom]]
return computeBounds({
type: 'FeatureCollection',
features: concatGeoJSON(geoJSON)
});
}
/**
* simple wrapper around topojson.presimplify
* @param topology {Object} topojson
* @returns {Object} topojson
*/
export function simplifyTopoJSON(topology) {
// topojson::presimplify adds z dimension to arcs
// used for dynamic simplification
return topojson.presimplify(topology);
}
| src/utils/geo.js | import topojson from 'topojson';
import { reduce } from 'lodash';
import d3 from 'd3';
/**
* extract topojson layers as geoJSON
* @param {Object} geo -> valid topojson
* @param {Array} layers -> layers to include
* @return {Object} -> { mesh: {...}, feature: {...} }
*/
export function extractGeoJSON(topology, layers) {
const initialMap = {
mesh: {},
feature: {}
};
const defaultMeshFilter = () => { return true; };
return reduce(layers, (map, layer) => {
/* eslint-disable no-param-reassign */
// each layer is an object with keys 'name', 'type', and, optionally, 'filterFn'
// 'name' should map to a key in topology.objects
// 'type' is one of 'feature' or 'mesh', defaults to 'feature'
// make certain the layer exists on the topojson
if (!topology.objects.hasOwnProperty(layer.name)) return map;
switch (layer.type) {
// wrap case in braces to create local scope
case 'mesh': {
// if filterFn is undefined, the meshgrid will be unfiltered
const filter = layer.filterFn || defaultMeshFilter;
map.mesh[layer.name] = topojson.mesh(topology, topology.objects[layer.name], filter);
break;
}
case 'feature': // FALL THROUGH
default:
map.feature[layer.name] = topojson.feature(topology, topology.objects[layer.name]);
}
return map;
}, initialMap);
}
/**
*
* @param {Object} extractedGeoJSON -> expect type of object returned by extractGeoJSON
* @returns {Array} array of features
*/
export function concatGeoJSON(extractedGeoJSON) {
// iterate over each property of extractedGeoJSON ('mesh' & 'feature')
// reduce to single array of features
return reduce(extractedGeoJSON, (collection, type) => {
// extractedGeoJSON[type] will be one of [extractedGeoJSON.mesh, extractedGeoJSON.feature]
// each is an object with geoJSON features or geometric objects
const combinedFeatures = reduce(type, (intermediateCollection, geoJSON) => {
switch (geoJSON.type) {
// topojson::feature will only return GeoJSON Feature or FeatureCollection
// topojson::mesh will return GeoJSON MultiLineString
case 'FeatureCollection':
return intermediateCollection.concat(geoJSON.features);
case 'MultiLineString': // FALL THROUGH
case 'Feature':
intermediateCollection.push(geoJSON);
return intermediateCollection;
default:
return intermediateCollection;
}
}, []);
return collection.concat(combinedFeatures);
}, []);
}
/**
* compute projected bounding box (in pixel space) of geometry
* @param featureCollection
* @returns {Array} [[left, top], [right, bottom]]
*/
export function computeBounds(feature) {
return d3.geo.path().projection(null).bounds(feature);
}
/**
* calculate center point of geometry given
* current translation, scale, and container dimensions
* @returns {Array}
*/
export function calcCenterPoint(width, height, scale, translate) {
// mike bostock math
return [(width - 2 * translate[0]) / scale, (height - 2 * translate[1]) / scale];
}
/**
* calculate scale at which the topology will fit centered in its container
* @param {Array} bounds
* @param {Number} width
* @param {Number} height
* @param {Number} proportion
* @returns {Number}
*/
export function calcScale(bounds, width, height, proportion = 0.95) {
// mike bostock math
// aspectX = rightEdge - leftEdge / width
const aspectX = (Math.abs(bounds[1][0] - bounds[0][0])) / width;
// aspectY = bottomEdge - topEdge / height
const aspectY = (Math.abs(bounds[1][1] - bounds[0][1])) / height;
return (proportion / Math.max(aspectX, aspectY));
}
/**
* calculate translations at which the topology will fit centered in its container
* @param {Number} width
* @param {Number} height
* @param {Number} scale
* @param {Array} bounds -> optional bounds of topology;
* if not passed in, must pass in center
* @param {Array} center -> optional center point of topology;
* if not passed in, must pass in bounds
* @returns {Array}
*/
export function calcTranslate(width, height, scale, bounds, center) {
const geometryX = center ? center[0] : bounds[1][0] + bounds[0][0];
const geometryY = center ? center[1] : bounds[1][1] + bounds[0][1];
// mike bostock math
return [
(width - (scale * geometryX)) / 2,
(height - (scale * geometryY)) / 2
];
}
/**
* @param geoJSON {Object} -> expect object as returned by ihme-ui/utils/geo/extractGeoJSON
* @returns {Array}
*/
export function concatAndComputeGeoJSONBounds(geoJSON) {
// returns projected bounding box (in pixel space)
// of entire geometry
// returns [[left, top], [right, bottom]]
return computeBounds({
type: 'FeatureCollection',
features: concatGeoJSON(geoJSON)
});
}
/**
* simple wrapper around topojson.presimplify
* @param topology {Object} topojon
* @returns {Object} toposjon
*/
export function simplifyTopoJSON(topology) {
// topojson::presimplify adds z dimension to arcs
// used for dynamic simplification
return topojson.presimplify(topology);
}
| fix documentation for geo utils
| src/utils/geo.js | fix documentation for geo utils | <ide><path>rc/utils/geo.js
<ide>
<ide> /**
<ide> * extract topojson layers as geoJSON
<del> * @param {Object} geo -> valid topojson
<add> * @param {Object} topology -> valid topojson
<ide> * @param {Array} layers -> layers to include
<ide> * @return {Object} -> { mesh: {...}, feature: {...} }
<ide> */
<ide> * @param featureCollection
<ide> * @returns {Array} [[left, top], [right, bottom]]
<ide> */
<del>export function computeBounds(feature) {
<del> return d3.geo.path().projection(null).bounds(feature);
<add>export function computeBounds(featureCollection) {
<add> return d3.geo.path().projection(null).bounds(featureCollection);
<ide> }
<ide>
<ide> /**
<ide>
<ide> /**
<ide> * simple wrapper around topojson.presimplify
<del> * @param topology {Object} topojon
<del> * @returns {Object} toposjon
<add> * @param topology {Object} topojson
<add> * @returns {Object} topojson
<ide> */
<ide> export function simplifyTopoJSON(topology) {
<ide> // topojson::presimplify adds z dimension to arcs |
|
JavaScript | mit | 05f77707b4fef98b2e005a644872cbc7d94ac6fa | 0 | dplassmann/ngp-userscripts | // ==UserScript==
// @name Skip Paypal Validation - CAUTION!
// @namespace NGPVAN
// @description Skip Oberon Paypal Validation
// @include https://*.myngp.com/Tenant/Create*
// @include https://*.myngp.com/Tenant/Update*
// @include http://*.myngp.com/Tenant/Create*
// @include http://*.myngp.com/Tenant/Update*
// @author ckoppelman
// @version 1.6.1
// ==/UserScript==
window.$(document).ready(function() {
var addButton = function () {
window.$(".paymentGatewayContainer :button[name^='PaymentGateway_']").parent().append("<button type='button' name='skipValidation'>Skip Validation</button>");
return true;
};
window.$("#AddGateway").click(addButton);
addButton();
window.$(".paymentGatewayContainer").on("click", "[name='skipValidation']", function () {
var $ = window.$;
var ngp = window.ngp;
var messages = ngp.tenant.update.paymentGateway.Messages;
messages.TestSuccessful = "We have not necessarily verified this account as valid. Please look things over very carefully to ensure that these are the correct credentials.";
messages.Changed += " Remember - We have not necessarily verified this account as valid.";
var fakeButton = $(this);
var button = fakeButton.prevAll(":button:visible");
window.savingIndicator = new window.progressIndicator({ button: button, text: $('.indicatorText', window.$form).html() });
var containingDivId = button[0].name.replace(".PrimaryAction", "");
var paymentGateway = $('div[id="' + containingDivId + '"]');
ngp.tenant.update.hidePaymentGatewayFields(paymentGateway);
ngp.tenant.update.testPaymentGatewaySuccess(button);
fakeButton.hide();
ngp.FeedBack.update({DisplayMessageType: window.Constants.ResponseResultCode.Success});
button.siblings(".hint").addClass("yellowbox");
return false;
});
}); | Skip_Paypal_Validation_-_CAUTION!.user.js | // ==UserScript==
// @name Skip Paypal Validation - CAUTION!
// @namespace NGPVAN
// @description Skip Oberon Paypal Validation
// @include https://*.myngp.com/Tenant/Create*
// @include https://*.myngp.com/Tenant/Update*
// @include http://*.myngp.com/Tenant/Create*
// @include http://*.myngp.com/Tenant/Update*
// @version 1.6.1
// ==/UserScript==
window.$(document).ready(function() {
var addButton = function () {
window.$(".paymentGatewayContainer :button[name^='PaymentGateway_']").parent().append("<button type='button' name='skipValidation'>Skip Validation</button>");
return true;
};
window.$("#AddGateway").click(addButton);
addButton();
window.$(".paymentGatewayContainer").on("click", "[name='skipValidation']", function () {
var $ = window.$;
var ngp = window.ngp;
var messages = ngp.tenant.update.paymentGateway.Messages;
messages.TestSuccessful = "We have not necessarily verified this account as valid. Please look things over very carefully to ensure that these are the correct credentials.";
messages.Changed += " Remember - We have not necessarily verified this account as valid.";
var fakeButton = $(this);
var button = fakeButton.prevAll(":button:visible");
window.savingIndicator = new window.progressIndicator({ button: button, text: $('.indicatorText', window.$form).html() });
var containingDivId = button[0].name.replace(".PrimaryAction", "");
var paymentGateway = $('div[id="' + containingDivId + '"]');
ngp.tenant.update.hidePaymentGatewayFields(paymentGateway);
ngp.tenant.update.testPaymentGatewaySuccess(button);
fakeButton.hide();
ngp.FeedBack.update({DisplayMessageType: window.Constants.ResponseResultCode.Success});
button.siblings(".hint").addClass("yellowbox");
return false;
});
}); | added author
| Skip_Paypal_Validation_-_CAUTION!.user.js | added author | <ide><path>kip_Paypal_Validation_-_CAUTION!.user.js
<ide> // @include https://*.myngp.com/Tenant/Update*
<ide> // @include http://*.myngp.com/Tenant/Create*
<ide> // @include http://*.myngp.com/Tenant/Update*
<add>// @author ckoppelman
<ide> // @version 1.6.1
<ide> // ==/UserScript==
<ide> |
|
Java | apache-2.0 | c1691206147b546c41a4846bb9347563049cf2a8 | 0 | xsyntrex/selenium,jsakamoto/selenium,SeleniumHQ/selenium,mach6/selenium,o-schneider/selenium,thanhpete/selenium,GorK-ChO/selenium,anshumanchatterji/selenium,actmd/selenium,Sravyaksr/selenium,doungni/selenium,HtmlUnit/selenium,temyers/selenium,SeleniumHQ/selenium,eric-stanley/selenium,isaksky/selenium,TheBlackTuxCorp/selenium,vveliev/selenium,alb-i986/selenium,BlackSmith/selenium,aluedeke/chromedriver,mestihudson/selenium,mach6/selenium,5hawnknight/selenium,SevInf/IEDriver,lummyare/lummyare-test,joshmgrant/selenium,GorK-ChO/selenium,tbeadle/selenium,orange-tv-blagnac/selenium,mach6/selenium,i17c/selenium,amar-sharma/selenium,gurayinan/selenium,s2oBCN/selenium,gorlemik/selenium,livioc/selenium,krmahadevan/selenium,uchida/selenium,lukeis/selenium,houchj/selenium,AutomatedTester/selenium,dandv/selenium,krmahadevan/selenium,asashour/selenium,DrMarcII/selenium,houchj/selenium,jknguyen/josephknguyen-selenium,rplevka/selenium,MeetMe/selenium,lilredindy/selenium,dimacus/selenium,krmahadevan/selenium,kalyanjvn1/selenium,misttechnologies/selenium,soundcloud/selenium,GorK-ChO/selenium,jerome-jacob/selenium,pulkitsinghal/selenium,isaksky/selenium,jabbrwcky/selenium,davehunt/selenium,quoideneuf/selenium,compstak/selenium,carsonmcdonald/selenium,chrsmithdemos/selenium,juangj/selenium,twalpole/selenium,twalpole/selenium,Dude-X/selenium,AutomatedTester/selenium,vveliev/selenium,houchj/selenium,joshuaduffy/selenium,joshmgrant/selenium,o-schneider/selenium,freynaud/selenium,titusfortner/selenium,gotcha/selenium,doungni/selenium,actmd/selenium,misttechnologies/selenium,jerome-jacob/selenium,houchj/selenium,actmd/selenium,telefonicaid/selenium,jsakamoto/selenium,thanhpete/selenium,krmahadevan/selenium,compstak/selenium,juangj/selenium,krmahadevan/selenium,gurayinan/selenium,misttechnologies/selenium,temyers/selenium,temyers/selenium,sag-enorman/selenium,mach6/selenium,lummyare/lummyare-lummy,thanhpete/selenium,BlackSmith/selenium,kalyanjvn1/selenium,meksh/selenium,tkurnosova/selenium,livioc/selenium,joshbruning/selenium,soundcloud/selenium,markodolancic/selenium,orange-tv-blagnac/selenium,meksh/selenium,lilredindy/selenium,actmd/selenium,yukaReal/selenium,compstak/selenium,juangj/selenium,eric-stanley/selenium,krosenvold/selenium,joshbruning/selenium,sankha93/selenium,tarlabs/selenium,krmahadevan/selenium,juangj/selenium,lmtierney/selenium,asolntsev/selenium,tbeadle/selenium,vveliev/selenium,manuelpirez/selenium,dkentw/selenium,wambat/selenium,krosenvold/selenium,krosenvold/selenium,BlackSmith/selenium,dandv/selenium,joshbruning/selenium,bartolkaruza/selenium,dbo/selenium,s2oBCN/selenium,chrisblock/selenium,lilredindy/selenium,amar-sharma/selenium,kalyanjvn1/selenium,i17c/selenium,amikey/selenium,zenefits/selenium,minhthuanit/selenium,RamaraoDonta/ramarao-clone,lilredindy/selenium,minhthuanit/selenium,stupidnetizen/selenium,juangj/selenium,joshuaduffy/selenium,doungni/selenium,uchida/selenium,tarlabs/selenium,tbeadle/selenium,SouWilliams/selenium,SeleniumHQ/selenium,meksh/selenium,livioc/selenium,lmtierney/selenium,soundcloud/selenium,orange-tv-blagnac/selenium,zenefits/selenium,DrMarcII/selenium,quoideneuf/selenium,titusfortner/selenium,onedox/selenium,Appdynamics/selenium,quoideneuf/selenium,mojwang/selenium,houchj/selenium,dkentw/selenium,gemini-testing/selenium,AutomatedTester/selenium,Ardesco/selenium,anshumanchatterji/selenium,SevInf/IEDriver,bmannix/selenium,xmhubj/selenium,titusfortner/selenium,SouWilliams/selenium,arunsingh/selenium,thanhpete/selenium,anshumanchatterji/selenium,customcommander/selenium,pulkitsinghal/selenium,customcommander/selenium,anshumanchatterji/selenium,JosephCastro/selenium,dibagga/selenium,joshuaduffy/selenium,sevaseva/selenium,Jarob22/selenium,gorlemik/selenium,alexec/selenium,sebady/selenium,yukaReal/selenium,AutomatedTester/selenium,blueyed/selenium,SouWilliams/selenium,SeleniumHQ/selenium,Ardesco/selenium,jsarenik/jajomojo-selenium,gregerrag/selenium,gotcha/selenium,jknguyen/josephknguyen-selenium,blackboarddd/selenium,rrussell39/selenium,mestihudson/selenium,alexec/selenium,gabrielsimas/selenium,jerome-jacob/selenium,rovner/selenium,doungni/selenium,manuelpirez/selenium,joshbruning/selenium,RamaraoDonta/ramarao-clone,alexec/selenium,mestihudson/selenium,quoideneuf/selenium,alb-i986/selenium,carsonmcdonald/selenium,slongwang/selenium,dcjohnson1989/selenium,soundcloud/selenium,knorrium/selenium,o-schneider/selenium,lummyare/lummyare-lummy,thanhpete/selenium,xsyntrex/selenium,MeetMe/selenium,alb-i986/selenium,p0deje/selenium,customcommander/selenium,bmannix/selenium,dcjohnson1989/selenium,alb-i986/selenium,arunsingh/selenium,gotcha/selenium,tarlabs/selenium,RamaraoDonta/ramarao-clone,clavery/selenium,gemini-testing/selenium,aluedeke/chromedriver,Herst/selenium,MeetMe/selenium,lummyare/lummyare-test,misttechnologies/selenium,oddui/selenium,mojwang/selenium,bayandin/selenium,dcjohnson1989/selenium,anshumanchatterji/selenium,chrsmithdemos/selenium,GorK-ChO/selenium,jerome-jacob/selenium,Sravyaksr/selenium,5hawnknight/selenium,Herst/selenium,anshumanchatterji/selenium,eric-stanley/selenium,amar-sharma/selenium,davehunt/selenium,twalpole/selenium,joshbruning/selenium,wambat/selenium,temyers/selenium,carsonmcdonald/selenium,dbo/selenium,gregerrag/selenium,Dude-X/selenium,dimacus/selenium,s2oBCN/selenium,sevaseva/selenium,mojwang/selenium,lrowe/selenium,amikey/selenium,i17c/selenium,sebady/selenium,meksh/selenium,AutomatedTester/selenium,xsyntrex/selenium,xsyntrex/selenium,jerome-jacob/selenium,petruc/selenium,dibagga/selenium,asashour/selenium,gorlemik/selenium,jsarenik/jajomojo-selenium,rrussell39/selenium,slongwang/selenium,asashour/selenium,oddui/selenium,GorK-ChO/selenium,actmd/selenium,jsarenik/jajomojo-selenium,SouWilliams/selenium,mestihudson/selenium,slongwang/selenium,jsarenik/jajomojo-selenium,livioc/selenium,i17c/selenium,jknguyen/josephknguyen-selenium,joshmgrant/selenium,isaksky/selenium,rovner/selenium,titusfortner/selenium,gurayinan/selenium,blackboarddd/selenium,wambat/selenium,s2oBCN/selenium,bayandin/selenium,tbeadle/selenium,lmtierney/selenium,joshbruning/selenium,arunsingh/selenium,houchj/selenium,BlackSmith/selenium,livioc/selenium,onedox/selenium,blueyed/selenium,jsakamoto/selenium,lummyare/lummyare-lummy,lummyare/lummyare-lummy,denis-vilyuzhanin/selenium-fastview,p0deje/selenium,Tom-Trumper/selenium,chrisblock/selenium,slongwang/selenium,lilredindy/selenium,telefonicaid/selenium,compstak/selenium,temyers/selenium,carsonmcdonald/selenium,dibagga/selenium,rplevka/selenium,tkurnosova/selenium,RamaraoDonta/ramarao-clone,clavery/selenium,freynaud/selenium,kalyanjvn1/selenium,dandv/selenium,valfirst/selenium,gregerrag/selenium,5hawnknight/selenium,bartolkaruza/selenium,TikhomirovSergey/selenium,Ardesco/selenium,rplevka/selenium,AutomatedTester/selenium,alexec/selenium,stupidnetizen/selenium,vinay-qa/vinayit-android-server-apk,xmhubj/selenium,bartolkaruza/selenium,sri85/selenium,lilredindy/selenium,isaksky/selenium,gabrielsimas/selenium,5hawnknight/selenium,carlosroh/selenium,uchida/selenium,Ardesco/selenium,p0deje/selenium,krosenvold/selenium-git-release-candidate,aluedeke/chromedriver,jknguyen/josephknguyen-selenium,clavery/selenium,kalyanjvn1/selenium,carlosroh/selenium,gabrielsimas/selenium,DrMarcII/selenium,wambat/selenium,lrowe/selenium,gemini-testing/selenium,anshumanchatterji/selenium,petruc/selenium,BlackSmith/selenium,petruc/selenium,amikey/selenium,slongwang/selenium,temyers/selenium,tkurnosova/selenium,sag-enorman/selenium,Ardesco/selenium,rovner/selenium,alexec/selenium,TikhomirovSergey/selenium,SevInf/IEDriver,mojwang/selenium,xsyntrex/selenium,quoideneuf/selenium,doungni/selenium,manuelpirez/selenium,doungni/selenium,temyers/selenium,MCGallaspy/selenium,eric-stanley/selenium,denis-vilyuzhanin/selenium-fastview,gorlemik/selenium,vinay-qa/vinayit-android-server-apk,Appdynamics/selenium,dbo/selenium,gemini-testing/selenium,MeetMe/selenium,amar-sharma/selenium,compstak/selenium,bmannix/selenium,jabbrwcky/selenium,dcjohnson1989/selenium,bayandin/selenium,yukaReal/selenium,valfirst/selenium,Jarob22/selenium,dcjohnson1989/selenium,pulkitsinghal/selenium,markodolancic/selenium,Appdynamics/selenium,minhthuanit/selenium,joshmgrant/selenium,TheBlackTuxCorp/selenium,sevaseva/selenium,valfirst/selenium,TheBlackTuxCorp/selenium,denis-vilyuzhanin/selenium-fastview,Herst/selenium,carsonmcdonald/selenium,p0deje/selenium,gregerrag/selenium,joshmgrant/selenium,kalyanjvn1/selenium,gorlemik/selenium,joshbruning/selenium,sebady/selenium,AutomatedTester/selenium,misttechnologies/selenium,lukeis/selenium,pulkitsinghal/selenium,mojwang/selenium,bmannix/selenium,SeleniumHQ/selenium,lummyare/lummyare-test,SevInf/IEDriver,manuelpirez/selenium,joshuaduffy/selenium,carlosroh/selenium,denis-vilyuzhanin/selenium-fastview,juangj/selenium,p0deje/selenium,BlackSmith/selenium,MCGallaspy/selenium,MCGallaspy/selenium,AutomatedTester/selenium,krmahadevan/selenium,MeetMe/selenium,freynaud/selenium,asolntsev/selenium,gemini-testing/selenium,anshumanchatterji/selenium,krosenvold/selenium,vinay-qa/vinayit-android-server-apk,dibagga/selenium,minhthuanit/selenium,GorK-ChO/selenium,xmhubj/selenium,soundcloud/selenium,twalpole/selenium,doungni/selenium,dibagga/selenium,sebady/selenium,sebady/selenium,BlackSmith/selenium,isaksky/selenium,Sravyaksr/selenium,lummyare/lummyare-lummy,lummyare/lummyare-test,jsarenik/jajomojo-selenium,chrsmithdemos/selenium,dkentw/selenium,amikey/selenium,uchida/selenium,quoideneuf/selenium,skurochkin/selenium,Jarob22/selenium,RamaraoDonta/ramarao-clone,knorrium/selenium,aluedeke/chromedriver,orange-tv-blagnac/selenium,orange-tv-blagnac/selenium,bartolkaruza/selenium,eric-stanley/selenium,uchida/selenium,orange-tv-blagnac/selenium,valfirst/selenium,customcommander/selenium,SouWilliams/selenium,stupidnetizen/selenium,gregerrag/selenium,i17c/selenium,carsonmcdonald/selenium,Appdynamics/selenium,valfirst/selenium,HtmlUnit/selenium,jabbrwcky/selenium,markodolancic/selenium,asashour/selenium,sankha93/selenium,wambat/selenium,mach6/selenium,jabbrwcky/selenium,BlackSmith/selenium,chrisblock/selenium,JosephCastro/selenium,Herst/selenium,oddui/selenium,oddui/selenium,amar-sharma/selenium,gorlemik/selenium,SeleniumHQ/selenium,lummyare/lummyare-lummy,davehunt/selenium,misttechnologies/selenium,houchj/selenium,gotcha/selenium,TheBlackTuxCorp/selenium,sri85/selenium,clavery/selenium,petruc/selenium,MeetMe/selenium,MCGallaspy/selenium,krosenvold/selenium-git-release-candidate,chrisblock/selenium,DrMarcII/selenium,titusfortner/selenium,dimacus/selenium,alexec/selenium,gotcha/selenium,kalyanjvn1/selenium,dbo/selenium,sevaseva/selenium,Tom-Trumper/selenium,meksh/selenium,gregerrag/selenium,vinay-qa/vinayit-android-server-apk,telefonicaid/selenium,chrsmithdemos/selenium,thanhpete/selenium,pulkitsinghal/selenium,sri85/selenium,lmtierney/selenium,sankha93/selenium,sag-enorman/selenium,misttechnologies/selenium,zenefits/selenium,isaksky/selenium,soundcloud/selenium,SevInf/IEDriver,denis-vilyuzhanin/selenium-fastview,customcommander/selenium,sankha93/selenium,amikey/selenium,thanhpete/selenium,asashour/selenium,clavery/selenium,titusfortner/selenium,thanhpete/selenium,s2oBCN/selenium,jabbrwcky/selenium,SeleniumHQ/selenium,isaksky/selenium,carsonmcdonald/selenium,gurayinan/selenium,customcommander/selenium,mach6/selenium,carsonmcdonald/selenium,JosephCastro/selenium,gotcha/selenium,vinay-qa/vinayit-android-server-apk,Tom-Trumper/selenium,slongwang/selenium,bartolkaruza/selenium,gurayinan/selenium,TheBlackTuxCorp/selenium,freynaud/selenium,dbo/selenium,sankha93/selenium,blueyed/selenium,Herst/selenium,orange-tv-blagnac/selenium,valfirst/selenium,petruc/selenium,DrMarcII/selenium,amar-sharma/selenium,krmahadevan/selenium,gorlemik/selenium,stupidnetizen/selenium,amar-sharma/selenium,Jarob22/selenium,knorrium/selenium,jknguyen/josephknguyen-selenium,AutomatedTester/selenium,lilredindy/selenium,carlosroh/selenium,temyers/selenium,lummyare/lummyare-test,sebady/selenium,s2oBCN/selenium,SouWilliams/selenium,joshbruning/selenium,Appdynamics/selenium,blackboarddd/selenium,gorlemik/selenium,gabrielsimas/selenium,joshmgrant/selenium,gregerrag/selenium,alb-i986/selenium,lummyare/lummyare-test,yukaReal/selenium,Appdynamics/selenium,jerome-jacob/selenium,p0deje/selenium,vveliev/selenium,clavery/selenium,Ardesco/selenium,lukeis/selenium,telefonicaid/selenium,krmahadevan/selenium,yukaReal/selenium,tkurnosova/selenium,HtmlUnit/selenium,vveliev/selenium,meksh/selenium,misttechnologies/selenium,lmtierney/selenium,bmannix/selenium,sag-enorman/selenium,slongwang/selenium,xmhubj/selenium,jsakamoto/selenium,minhthuanit/selenium,joshmgrant/selenium,denis-vilyuzhanin/selenium-fastview,Tom-Trumper/selenium,DrMarcII/selenium,uchida/selenium,asolntsev/selenium,jsarenik/jajomojo-selenium,doungni/selenium,amikey/selenium,vveliev/selenium,blackboarddd/selenium,minhthuanit/selenium,vinay-qa/vinayit-android-server-apk,markodolancic/selenium,HtmlUnit/selenium,tarlabs/selenium,oddui/selenium,chrsmithdemos/selenium,alexec/selenium,wambat/selenium,jsarenik/jajomojo-selenium,o-schneider/selenium,carlosroh/selenium,tarlabs/selenium,5hawnknight/selenium,joshmgrant/selenium,davehunt/selenium,dandv/selenium,orange-tv-blagnac/selenium,compstak/selenium,gurayinan/selenium,onedox/selenium,bayandin/selenium,Sravyaksr/selenium,MCGallaspy/selenium,s2oBCN/selenium,krosenvold/selenium-git-release-candidate,s2oBCN/selenium,dandv/selenium,dimacus/selenium,gemini-testing/selenium,telefonicaid/selenium,wambat/selenium,rplevka/selenium,juangj/selenium,yukaReal/selenium,asolntsev/selenium,gemini-testing/selenium,davehunt/selenium,SeleniumHQ/selenium,BlackSmith/selenium,i17c/selenium,lukeis/selenium,JosephCastro/selenium,dandv/selenium,lukeis/selenium,MCGallaspy/selenium,sri85/selenium,Jarob22/selenium,juangj/selenium,rovner/selenium,eric-stanley/selenium,mach6/selenium,gurayinan/selenium,DrMarcII/selenium,vveliev/selenium,zenefits/selenium,gemini-testing/selenium,sankha93/selenium,rrussell39/selenium,dkentw/selenium,slongwang/selenium,skurochkin/selenium,blueyed/selenium,pulkitsinghal/selenium,HtmlUnit/selenium,davehunt/selenium,jsakamoto/selenium,davehunt/selenium,HtmlUnit/selenium,gabrielsimas/selenium,lmtierney/selenium,joshuaduffy/selenium,Dude-X/selenium,houchj/selenium,petruc/selenium,markodolancic/selenium,vinay-qa/vinayit-android-server-apk,blackboarddd/selenium,compstak/selenium,lummyare/lummyare-lummy,tbeadle/selenium,carsonmcdonald/selenium,skurochkin/selenium,meksh/selenium,sebady/selenium,krosenvold/selenium-git-release-candidate,actmd/selenium,sankha93/selenium,bartolkaruza/selenium,Appdynamics/selenium,lmtierney/selenium,JosephCastro/selenium,minhthuanit/selenium,sevaseva/selenium,JosephCastro/selenium,lukeis/selenium,SeleniumHQ/selenium,mojwang/selenium,o-schneider/selenium,freynaud/selenium,TikhomirovSergey/selenium,compstak/selenium,eric-stanley/selenium,dkentw/selenium,GorK-ChO/selenium,chrisblock/selenium,SevInf/IEDriver,gregerrag/selenium,manuelpirez/selenium,livioc/selenium,skurochkin/selenium,Tom-Trumper/selenium,rovner/selenium,MeetMe/selenium,sri85/selenium,chrisblock/selenium,gotcha/selenium,compstak/selenium,davehunt/selenium,chrsmithdemos/selenium,jknguyen/josephknguyen-selenium,lrowe/selenium,mestihudson/selenium,tkurnosova/selenium,joshbruning/selenium,Dude-X/selenium,yukaReal/selenium,dandv/selenium,tarlabs/selenium,joshuaduffy/selenium,tbeadle/selenium,dbo/selenium,minhthuanit/selenium,orange-tv-blagnac/selenium,xsyntrex/selenium,jsakamoto/selenium,tbeadle/selenium,lukeis/selenium,manuelpirez/selenium,rplevka/selenium,sri85/selenium,lummyare/lummyare-test,tkurnosova/selenium,isaksky/selenium,gabrielsimas/selenium,titusfortner/selenium,arunsingh/selenium,pulkitsinghal/selenium,5hawnknight/selenium,gotcha/selenium,bayandin/selenium,alb-i986/selenium,tbeadle/selenium,alb-i986/selenium,sevaseva/selenium,petruc/selenium,Appdynamics/selenium,dkentw/selenium,sebady/selenium,DrMarcII/selenium,lummyare/lummyare-lummy,pulkitsinghal/selenium,doungni/selenium,dibagga/selenium,sevaseva/selenium,chrsmithdemos/selenium,asolntsev/selenium,jknguyen/josephknguyen-selenium,rplevka/selenium,customcommander/selenium,zenefits/selenium,krosenvold/selenium-git-release-candidate,dimacus/selenium,bmannix/selenium,dimacus/selenium,mojwang/selenium,asolntsev/selenium,denis-vilyuzhanin/selenium-fastview,Dude-X/selenium,chrisblock/selenium,Herst/selenium,twalpole/selenium,titusfortner/selenium,telefonicaid/selenium,joshmgrant/selenium,denis-vilyuzhanin/selenium-fastview,onedox/selenium,asolntsev/selenium,thanhpete/selenium,skurochkin/selenium,jabbrwcky/selenium,JosephCastro/selenium,lukeis/selenium,stupidnetizen/selenium,gabrielsimas/selenium,sag-enorman/selenium,asashour/selenium,RamaraoDonta/ramarao-clone,sag-enorman/selenium,gurayinan/selenium,RamaraoDonta/ramarao-clone,jsakamoto/selenium,actmd/selenium,yukaReal/selenium,lmtierney/selenium,TikhomirovSergey/selenium,valfirst/selenium,Dude-X/selenium,eric-stanley/selenium,dcjohnson1989/selenium,blueyed/selenium,Ardesco/selenium,rrussell39/selenium,vinay-qa/vinayit-android-server-apk,valfirst/selenium,titusfortner/selenium,lrowe/selenium,twalpole/selenium,o-schneider/selenium,yukaReal/selenium,davehunt/selenium,telefonicaid/selenium,jsakamoto/selenium,amikey/selenium,rplevka/selenium,bartolkaruza/selenium,bmannix/selenium,HtmlUnit/selenium,skurochkin/selenium,mach6/selenium,blueyed/selenium,Ardesco/selenium,soundcloud/selenium,stupidnetizen/selenium,rovner/selenium,chrsmithdemos/selenium,asashour/selenium,jabbrwcky/selenium,customcommander/selenium,telefonicaid/selenium,sevaseva/selenium,uchida/selenium,oddui/selenium,krosenvold/selenium,SouWilliams/selenium,krosenvold/selenium,JosephCastro/selenium,o-schneider/selenium,manuelpirez/selenium,SevInf/IEDriver,s2oBCN/selenium,SevInf/IEDriver,amikey/selenium,knorrium/selenium,lrowe/selenium,skurochkin/selenium,freynaud/selenium,xmhubj/selenium,gurayinan/selenium,markodolancic/selenium,dbo/selenium,aluedeke/chromedriver,Tom-Trumper/selenium,lummyare/lummyare-lummy,onedox/selenium,jabbrwcky/selenium,krosenvold/selenium-git-release-candidate,MCGallaspy/selenium,sebady/selenium,titusfortner/selenium,amar-sharma/selenium,actmd/selenium,anshumanchatterji/selenium,quoideneuf/selenium,asolntsev/selenium,markodolancic/selenium,sankha93/selenium,carlosroh/selenium,tarlabs/selenium,zenefits/selenium,arunsingh/selenium,lmtierney/selenium,bayandin/selenium,SouWilliams/selenium,TheBlackTuxCorp/selenium,xmhubj/selenium,arunsingh/selenium,lummyare/lummyare-test,sri85/selenium,aluedeke/chromedriver,mestihudson/selenium,krosenvold/selenium,twalpole/selenium,Sravyaksr/selenium,SeleniumHQ/selenium,blackboarddd/selenium,markodolancic/selenium,Sravyaksr/selenium,chrisblock/selenium,onedox/selenium,pulkitsinghal/selenium,tarlabs/selenium,stupidnetizen/selenium,sri85/selenium,bayandin/selenium,krosenvold/selenium,dkentw/selenium,TheBlackTuxCorp/selenium,isaksky/selenium,TikhomirovSergey/selenium,joshuaduffy/selenium,quoideneuf/selenium,livioc/selenium,aluedeke/chromedriver,clavery/selenium,bartolkaruza/selenium,manuelpirez/selenium,blackboarddd/selenium,dibagga/selenium,rovner/selenium,Herst/selenium,lrowe/selenium,wambat/selenium,uchida/selenium,knorrium/selenium,customcommander/selenium,minhthuanit/selenium,xmhubj/selenium,Tom-Trumper/selenium,Herst/selenium,gotcha/selenium,DrMarcII/selenium,Jarob22/selenium,alb-i986/selenium,sag-enorman/selenium,lrowe/selenium,manuelpirez/selenium,soundcloud/selenium,mach6/selenium,soundcloud/selenium,o-schneider/selenium,dkentw/selenium,MCGallaspy/selenium,Jarob22/selenium,aluedeke/chromedriver,onedox/selenium,actmd/selenium,bmannix/selenium,oddui/selenium,rrussell39/selenium,sri85/selenium,joshmgrant/selenium,krosenvold/selenium-git-release-candidate,TheBlackTuxCorp/selenium,sevaseva/selenium,gregerrag/selenium,titusfortner/selenium,xsyntrex/selenium,5hawnknight/selenium,jsakamoto/selenium,vveliev/selenium,i17c/selenium,5hawnknight/selenium,mojwang/selenium,dcjohnson1989/selenium,bmannix/selenium,knorrium/selenium,dbo/selenium,asashour/selenium,TikhomirovSergey/selenium,rovner/selenium,JosephCastro/selenium,joshuaduffy/selenium,rovner/selenium,carlosroh/selenium,TikhomirovSergey/selenium,jerome-jacob/selenium,Sravyaksr/selenium,sag-enorman/selenium,eric-stanley/selenium,5hawnknight/selenium,valfirst/selenium,joshuaduffy/selenium,valfirst/selenium,alexec/selenium,GorK-ChO/selenium,gorlemik/selenium,MeetMe/selenium,blueyed/selenium,quoideneuf/selenium,HtmlUnit/selenium,clavery/selenium,dimacus/selenium,denis-vilyuzhanin/selenium-fastview,meksh/selenium,wambat/selenium,HtmlUnit/selenium,Dude-X/selenium,dibagga/selenium,Herst/selenium,petruc/selenium,freynaud/selenium,lukeis/selenium,oddui/selenium,telefonicaid/selenium,arunsingh/selenium,petruc/selenium,markodolancic/selenium,Tom-Trumper/selenium,misttechnologies/selenium,jabbrwcky/selenium,temyers/selenium,carlosroh/selenium,Jarob22/selenium,xmhubj/selenium,stupidnetizen/selenium,oddui/selenium,jsarenik/jajomojo-selenium,zenefits/selenium,lilredindy/selenium,mestihudson/selenium,skurochkin/selenium,SevInf/IEDriver,krosenvold/selenium,Tom-Trumper/selenium,chrsmithdemos/selenium,jerome-jacob/selenium,Jarob22/selenium,tbeadle/selenium,vinay-qa/vinayit-android-server-apk,rrussell39/selenium,bayandin/selenium,blueyed/selenium,rplevka/selenium,twalpole/selenium,dandv/selenium,alexec/selenium,Dude-X/selenium,dcjohnson1989/selenium,lrowe/selenium,jknguyen/josephknguyen-selenium,twalpole/selenium,meksh/selenium,onedox/selenium,lummyare/lummyare-test,dimacus/selenium,valfirst/selenium,bartolkaruza/selenium,tkurnosova/selenium,mojwang/selenium,rrussell39/selenium,bayandin/selenium,sag-enorman/selenium,asashour/selenium,RamaraoDonta/ramarao-clone,rrussell39/selenium,dibagga/selenium,zenefits/selenium,carlosroh/selenium,dimacus/selenium,dcjohnson1989/selenium,houchj/selenium,Sravyaksr/selenium,joshmgrant/selenium,xmhubj/selenium,knorrium/selenium,gabrielsimas/selenium,Sravyaksr/selenium,xsyntrex/selenium,jerome-jacob/selenium,juangj/selenium,dbo/selenium,RamaraoDonta/ramarao-clone,clavery/selenium,gabrielsimas/selenium,zenefits/selenium,uchida/selenium,krosenvold/selenium-git-release-candidate,p0deje/selenium,p0deje/selenium,skurochkin/selenium,amikey/selenium,knorrium/selenium,i17c/selenium,tkurnosova/selenium,TikhomirovSergey/selenium,SeleniumHQ/selenium,dkentw/selenium,MeetMe/selenium,TikhomirovSergey/selenium,slongwang/selenium,MCGallaspy/selenium,xsyntrex/selenium,blueyed/selenium,HtmlUnit/selenium,TheBlackTuxCorp/selenium,jsarenik/jajomojo-selenium,rplevka/selenium,arunsingh/selenium,sankha93/selenium,aluedeke/chromedriver,Dude-X/selenium,kalyanjvn1/selenium,kalyanjvn1/selenium,knorrium/selenium,freynaud/selenium,mestihudson/selenium,mestihudson/selenium,tkurnosova/selenium,alb-i986/selenium,onedox/selenium,Appdynamics/selenium,rrussell39/selenium,tarlabs/selenium,lilredindy/selenium,gemini-testing/selenium,amar-sharma/selenium,arunsingh/selenium,i17c/selenium,blackboarddd/selenium,chrisblock/selenium,vveliev/selenium,Ardesco/selenium,blackboarddd/selenium,p0deje/selenium,asolntsev/selenium,freynaud/selenium,jknguyen/josephknguyen-selenium,o-schneider/selenium,livioc/selenium,SouWilliams/selenium,GorK-ChO/selenium,stupidnetizen/selenium,livioc/selenium,dandv/selenium,lrowe/selenium | /*
* Copyright 2006 ThoughtWorks, Inc.
*
* 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.openqa.selenium.server;
import org.apache.commons.logging.Log;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.Get;
import org.apache.tools.ant.util.FileUtils;
import org.mortbay.http.HttpConnection;
import org.mortbay.http.HttpException;
import org.mortbay.http.HttpFields;
import org.mortbay.http.HttpRequest;
import org.mortbay.http.HttpResponse;
import org.mortbay.http.handler.ResourceHandler;
import org.mortbay.log.LogFactory;
import org.mortbay.util.StringUtil;
import org.openqa.selenium.server.BrowserSessionFactory.BrowserSessionInfo;
import org.openqa.selenium.server.browserlaunchers.AsyncExecute;
import org.openqa.selenium.server.browserlaunchers.BrowserLauncher;
import org.openqa.selenium.server.browserlaunchers.BrowserLauncherFactory;
import org.openqa.selenium.server.commands.CaptureScreenshotCommand;
import org.openqa.selenium.server.commands.CaptureScreenshotToStringCommand;
import org.openqa.selenium.server.commands.RetrieveLastRemoteControlLogsCommand;
import org.openqa.selenium.server.commands.CaptureEntirePageScreenshotToStringCommand;
import org.openqa.selenium.server.commands.SeleniumCoreCommand;
import org.openqa.selenium.server.htmlrunner.HTMLLauncher;
import org.openqa.selenium.server.log.AntJettyLoggerBuildListener;
import java.awt.*;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.lang.reflect.Field;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.Vector;
/**
* A Jetty handler that takes care of remote Selenium requests.
*
* Remote Selenium requests are described in detail in the class description for
* <code>SeleniumServer</code>
* @see org.openqa.selenium.server.SeleniumServer
* @author Paul Hammant
* @version $Revision: 674 $
*/
@SuppressWarnings("serial")
public class SeleniumDriverResourceHandler extends ResourceHandler {
static final Log LOGGER = LogFactory.getLog(SeleniumDriverResourceHandler.class);
static Log browserSideLog = LogFactory.getLog(SeleniumDriverResourceHandler.class.getName()+".browserSideLog");
private SeleniumServer remoteControl;
private static String lastSessionId = null;
private Map<String, String> domainsBySessionId = new HashMap<String, String>();
private StringBuffer logMessagesBuffer = new StringBuffer();
private BrowserLauncherFactory browserLauncherFactory = new BrowserLauncherFactory();
private final BrowserSessionFactory browserSessionFactory =
new BrowserSessionFactory(browserLauncherFactory);
public SeleniumDriverResourceHandler(SeleniumServer remoteControl) {
this.remoteControl = remoteControl;
}
/** Handy helper to retrieve the first parameter value matching the name
*
* @param req - the Jetty HttpRequest
* @param name - the HTTP parameter whose value we'll return
* @return the value of the first HTTP parameter whose name matches <code>name</code>, or <code>null</code> if there is no such parameter
*/
private String getParam(HttpRequest req, String name) {
List<?> parameterValues = req.getParameterValues(name);
if (parameterValues == null) {
return null;
}
return (String) parameterValues.get(0);
}
@Override public void handle(String pathInContext, String pathParams, HttpRequest req, HttpResponse res) throws HttpException, IOException {
try {
LOGGER.debug("Thread name: " + Thread.currentThread().getName());
res.setField(HttpFields.__ContentType, "text/plain");
setNoCacheHeaders(res);
String method = req.getMethod();
String cmd = getParam(req, "cmd");
String sessionId = getParam(req, "sessionId");
String seleniumStart = getParam(req, "seleniumStart");
String loggingParam = getParam(req, "logging");
String jsStateParam = getParam(req, "state");
String retry = getParam(req, "retry");
String closingParam = getParam(req, "closing");
boolean logging = "true".equals(loggingParam);
boolean jsState = "true".equals(jsStateParam);
boolean justLoaded = "true".equals(seleniumStart);
boolean retrying = "true".equals(retry);
boolean closing = "true".equals(closingParam);
LOGGER.debug("req: "+req);
// If this is a browser requesting work for the first time...
if (cmd != null) {
handleCommandRequest(req, res, cmd, sessionId);
} else if ("POST".equalsIgnoreCase(method) || justLoaded || logging) {
handleBrowserResponse(req, res, sessionId, logging, jsState,
justLoaded, retrying, closing);
} else if (-1 != req.getRequestURL().indexOf("selenium-server/core/scripts/user-extensions.js")
|| -1 != req.getRequestURL().indexOf("selenium-server/tests/html/tw.jpg")){
// ignore failure to find these items...
}
else {
LOGGER.debug("Not handling: " + req.getRequestURL() + "?" + req.getQuery());
req.setHandled(false);
}
} catch (RuntimeException e) {
if (looksLikeBrowserLaunchFailedBecauseFileNotFound(e)) {
String apparentFile = extractNameOfFileThatCouldntBeFound(e);
if (apparentFile!=null) {
LOGGER.error("Could not start browser; it appears that " + apparentFile + " is missing or inaccessible");
}
}
throw e;
}
}
private void handleBrowserResponse(HttpRequest req, HttpResponse res,
String sessionId, boolean logging, boolean jsState,
boolean justLoaded, boolean retrying, boolean closing)
throws IOException {
String seleniumWindowName = getParam(req, "seleniumWindowName");
String localFrameAddress = getParam(req, "localFrameAddress");
FrameAddress frameAddress = FrameGroupCommandQueueSet.makeFrameAddress(seleniumWindowName,
localFrameAddress);
String uniqueId = getParam(req, "uniqueId");
String sequenceNumberString = getParam(req, "sequenceNumber");
int sequenceNumber = -1;
FrameGroupCommandQueueSet queueSet = FrameGroupCommandQueueSet.getQueueSet(sessionId);
BrowserResponseSequencer browserResponseSequencer = queueSet.getCommandQueue(uniqueId).getBrowserResponseSequencer();
if (sequenceNumberString != null && sequenceNumberString.length() > 0) {
sequenceNumber = Integer.parseInt(sequenceNumberString);
browserResponseSequencer.waitUntilNumIsAtLeast(sequenceNumber);
}
String postedData = readPostedData(req, sessionId, uniqueId);
if (logging) {
handleLogMessages(postedData);
} else if (jsState) {
handleJsState(sessionId, uniqueId, postedData);
}
if (postedData == null || postedData.equals("") || logging
|| jsState) {
if (sequenceNumber != -1) {
browserResponseSequencer.increaseNum();
}
res.getOutputStream().write("\r\n\r\n".getBytes());
req.setHandled(true);
return;
}
logPostedData(frameAddress, justLoaded, sessionId, postedData,
uniqueId);
if (retrying) {
postedData = null; // DGF retries don't really have a result
}
List<?> jsWindowNameVar = req.getParameterValues("jsWindowNameVar");
RemoteCommand sc = queueSet.handleCommandResult(postedData,
frameAddress, uniqueId, justLoaded, jsWindowNameVar);
if (sc != null) {
respond(res, sc, uniqueId);
}
req.setHandled(true);
}
private void logPostedData(FrameAddress frameAddress, boolean justLoaded, String sessionId, String postedData, String uniqueId) {
StringBuffer sb = new StringBuffer();
sb.append("Browser " + sessionId + "/" + frameAddress + " " + uniqueId + " posted " + postedData);
if (!frameAddress.isDefault()) {
sb.append(" from " + frameAddress);
}
if (justLoaded) {
sb.append(" NEW");
}
LOGGER.debug(sb.toString());
}
private void respond(HttpResponse res, RemoteCommand sc, String uniqueId) throws IOException {
ByteArrayOutputStream buf = new ByteArrayOutputStream(1000);
Writer writer = new OutputStreamWriter(buf, StringUtil.__UTF_8);
if (sc!=null) {
writer.write(sc.toString());
LOGGER.debug("res to " + uniqueId +
": " + sc.toString());
} else {
LOGGER.debug("res empty");
}
for (int pad = 998 - buf.size(); pad-- > 0;) {
writer.write(" ");
}
writer.write("\015\012");
writer.close();
OutputStream out = res.getOutputStream();
buf.writeTo(out);
}
/**
* extract the posted data from an incoming request, stripping away a piggybacked data
*
* @param req
* @param sessionId
* @param uniqueId
* @return a string containing the posted data (with piggybacked log info stripped)
* @throws IOException
*/
private String readPostedData(HttpRequest req, String sessionId, String uniqueId) throws IOException {
// if the request was sent as application/x-www-form-urlencoded, we can get the decoded data right away...
// we do this because it appears that Safari likes to send the data back as application/x-www-form-urlencoded
// even when told to send it back as application/xml. So in short, this function pulls back the data in any
// way it can!
if (req.getParameter("postedData") != null) {
return req.getParameter("postedData");
}
InputStream is = req.getInputStream();
StringBuffer sb = new StringBuffer();
InputStreamReader r = new InputStreamReader(is, "UTF-8");
int c;
while ((c = r.read()) != -1) {
sb.append((char) c);
}
String postedData = sb.toString();
// we check here because, depending on the Selenium Core version you have, specifically the selenium-testrunner.js,
// the data could be sent back directly or as URL-encoded for the parameter "postedData" (see above). Because
// firefox and other browsers like to send it back as application/xml (opposite of Safari), we need to be prepared
// to decode the data ourselves. Also, we check for the string starting with the key because in the rare case
// someone has an outdated version selenium-testrunner.js, which, until today (3/25/2007) sent back the data
// *un*-encoded, we'd like to be as flexible as possible.
if (postedData.startsWith("postedData=")) {
postedData = postedData.substring(11);
postedData = URLDecoder.decode(postedData, "UTF-8");
}
return postedData;
}
private void handleLogMessages(String s) {
String[] lines = s.split("\n");
for (String line : lines) {
if (line.startsWith("logLevel=")) {
int logLevelIdx = line.indexOf(':', "logLevel=".length());
String logLevel = line.substring("logLevel=".length(), logLevelIdx).toUpperCase();
String logMessage = line.substring(logLevelIdx+1);
if ("ERROR".equals(logLevel)) {
browserSideLog.error(logMessage);
} else if ("WARN".equals(logLevel)) {
browserSideLog.warn(logMessage);
} else if ("INFO".equals(logLevel)) {
browserSideLog.info(logMessage);
} else {
// DGF debug is default
browserSideLog.debug(logMessage);
}
}
}
}
private void handleJsState(String sessionId, String uniqueId, String s) {
String jsInitializers = grepStringsStartingWith("state:", s);
if (jsInitializers==null) {
return;
}
for (String jsInitializer : jsInitializers.split("\n")) {
String jsVarName = extractVarName(jsInitializer);
InjectionHelper.saveJsStateInitializer(sessionId, uniqueId, jsVarName, jsInitializer);
}
}
private String extractVarName(String jsInitializer) {
int x = jsInitializer.indexOf('=');
if (x==-1) {
// apparently a method call, not an assignment
// for 'browserBot.recordedAlerts.push("lskdjf")',
// return 'browserBot.recordedAlerts':
x = jsInitializer.lastIndexOf('(');
if (x==-1) {
throw new RuntimeException("expected method call, saw " + jsInitializer);
}
x = jsInitializer.lastIndexOf('.', x-1);
if (x==-1) {
throw new RuntimeException("expected method call, saw " + jsInitializer);
}
}
return jsInitializer.substring(0, x);
}
private String grepStringsStartingWith(String pattern, String s) {
String[] lines = s.split("\n");
StringBuffer sb = new StringBuffer();
String retval = null;
for (String line : lines) {
if (line.startsWith(pattern)) {
sb.append(line.substring(pattern.length()))
.append('\n');
}
}
if (sb.length()!=0) {
retval = sb.toString();
}
return retval;
}
/** Try to extract the name of the file whose absence caused the exception
*
* @param e - the exception
* @return the name of the file whose absence caused the exception
*/
private String extractNameOfFileThatCouldntBeFound(Exception e) {
String s = e.getMessage();
if (s==null) {
return null;
}
// will only succeed on Windows -- perhaps I will make it work on other platforms later
return s.replaceFirst(".*CreateProcess: ", "").replaceFirst(" .*", "");
}
private boolean looksLikeBrowserLaunchFailedBecauseFileNotFound(Exception e) {
String s = e.getMessage();
// will only succeed on Windows -- perhaps I will make it work on other platforms later
return (s!=null) && s.matches("java.io.IOException: CreateProcess: .*error=3");
}
private void handleCommandRequest(HttpRequest req, HttpResponse res, String cmd, String sessionId) {
final String results;
// If this a Driver Client sending a new command...
res.setContentType("text/plain");
hackRemoveConnectionCloseHeader(res);
Vector<String> values = parseSeleneseParameters(req);
results = doCommand(cmd, values, sessionId, res);
// under some conditions, the results variable will be null
// (cf http://forums.openqa.org/thread.jspa?threadID=2955&messageID=8085#8085 for an example of this)
if (results!=null) {
try {
res.getOutputStream().write(results.getBytes("UTF-8"));
} catch (IOException e) {
e.printStackTrace();
}
}
req.setHandled(true);
}
protected FrameGroupCommandQueueSet getQueueSet(String sessionId) {
return FrameGroupCommandQueueSet.getQueueSet(sessionId);
}
public String doCommand(String cmd, Vector<String> values, String sessionId, HttpResponse res) {
LOGGER.info("Command request: " + cmd + values.toString() + " on session " + sessionId);
String results = null;
// handle special commands
switch(SpecialCommand.getValue(cmd)) {
case getNewBrowserSession:
String browserString = values.get(0);
String extensionJs = values.size() > 2 ? values.get(2) : "";
String browserConfigurations = values.size() > 3 ? values.get(3) : "";
try {
sessionId = getNewBrowserSession(browserString, values.get(1), extensionJs, new BrowserConfigurationOptions(browserConfigurations));
setDomain(sessionId, values.get(1));
results = "OK," + sessionId;
} catch (RemoteCommandException rce) {
results = "Failed to start new browser session: " + rce.getMessage();
}
break;
case testComplete:
browserSessionFactory.endBrowserSession(sessionId, remoteControl.getConfiguration());
results = "OK";
break;
case shutDown:
results = null;
shutDown(res);
break;
case getLogMessages:
results = "OK," + logMessagesBuffer.toString();
logMessagesBuffer.setLength(0);
break;
case retrieveLastRemoteControlLogs:
results = new RetrieveLastRemoteControlLogsCommand().execute();
break;
case captureEntirePageScreenshotToString:
results = new CaptureEntirePageScreenshotToStringCommand(values.get(0), sessionId).execute();
break;
case captureScreenshot:
results = new CaptureScreenshotCommand(values.get(0)).execute();
break;
case captureScreenshotToString:
results = new CaptureScreenshotToStringCommand().execute();
break;
case keyDownNative:
try {
RobotRetriever.getRobot().keyPress(Integer.parseInt(values.get(0)));
results = "OK";
} catch (Exception e) {
LOGGER.error("Problem during keyDown: ", e);
results = "ERROR: Problem during keyDown: " + e.getMessage();
}
break;
case keyUpNative:
try {
RobotRetriever.getRobot().keyRelease(Integer.parseInt(values.get(0)));
results = "OK";
} catch (Exception e) {
LOGGER.error("Problem during keyUp: ", e);
results = "ERROR: Problem during keyUp: " + e.getMessage();
}
break;
case keyPressNative:
try {
Robot r = RobotRetriever.getRobot();
int keycode = Integer.parseInt(values.get(0));
r.keyPress(keycode);
r.waitForIdle();
r.keyRelease(keycode);
results = "OK";
} catch (Exception e) {
LOGGER.error("Problem during keyDown: ", e);
results = "ERROR: Problem during keyDown: " + e.getMessage();
}
// TODO typeKeysNative. Requires converting String to array of keycodes.
break;
case isPostSupported:
results = "OK,true";
break;
case setSpeed:
try {
int speed = Integer.parseInt(values.get(0));
setSpeedForSession(sessionId, speed);
} catch (NumberFormatException e) {
return "ERROR: setSlowMode expects a string containing an integer, but saw '" + values.get(0) + "'";
}
results = "OK";
break;
case getSpeed:
results = getSpeedForSession(sessionId);
break;
case addStaticContent:
File dir = new File( values.get(0));
if (dir.exists()) {
remoteControl.addNewStaticContent(dir);
results = "OK";
} else {
results = "ERROR: dir does not exist - " + dir.getAbsolutePath();
}
break;
case runHTMLSuite:
HTMLLauncher launcher = new HTMLLauncher(remoteControl);
File output = null;
if (values.size() < 4) {
results = "ERROR: Not enough arguments (browser, browserURL, suiteURL, multiWindow, [outputFile])";
} else {
if (values.size() > 4) {
output = new File(values.get(4));
}
try {
results = launcher.runHTMLSuite( values.get(0), values.get(1), values.get(2), output, remoteControl.getConfiguration().getTimeoutInSeconds(), "true".equals(values.get(3)));
} catch (IOException e) {
e.printStackTrace();
results = e.toString();
}
}
break;
case launchOnly:
if (values.size() < 1) {
results = "ERROR: You must specify a browser";
} else {
String browser = values.get(0);
String newSessionId = generateNewSessionId();
BrowserLauncher simpleLauncher = browserLauncherFactory.getBrowserLauncher(browser, newSessionId, remoteControl.getConfiguration(), new BrowserConfigurationOptions());
String baseUrl = "http://localhost:" + remoteControl.getPort();
remoteControl.registerBrowserSession(new BrowserSessionInfo(
newSessionId, browser, baseUrl, simpleLauncher, null));
simpleLauncher.launchHTMLSuite("TestPrompt.html?thisIsSeleniumServer=true", baseUrl);
results = "OK";
}
break;
case slowResources:
String arg = values.get(0);
boolean setting = true;
if ("off".equals(arg) || "false".equals(arg)) {
setting = false;
}
StaticContentHandler.setSlowResources(setting);
results = "OK";
break;
case attachFile:
FrameGroupCommandQueueSet queue = getQueueSet(sessionId);
try {
File downloadedFile = downloadFile(values.get(1));
queue.addTemporaryFile(downloadedFile);
results = queue.doCommand("type", values.get(0), downloadedFile.getAbsolutePath());
} catch (Exception e) {
results = e.toString();
}
break;
case open:
warnIfApparentDomainChange(sessionId, values.get(0));
case nonSpecial:
results = new SeleniumCoreCommand(cmd, values, sessionId).execute();
}
if (CaptureScreenshotToStringCommand.ID.equals(cmd)
|| CaptureEntirePageScreenshotToStringCommand.ID.equals(cmd)
|| SeleniumCoreCommand.CAPTURE_ENTIRE_PAGE_SCREENSHOT_ID.equals(cmd)) {
LOGGER.info("Got result: [base64 encoded PNG] on session " + sessionId);
} else if (RetrieveLastRemoteControlLogsCommand.ID.equals(cmd)) {
/* Trim logs to avoid Larsen effect (see remote control stability tests) */
LOGGER.info("Got result:" + results.substring(0, 30) + "... on session " + sessionId);
} else {
LOGGER.info("Got result: " + results + " on session " + sessionId);
}
return results;
}
private void warnIfApparentDomainChange(String sessionId, String url) {
if (url.startsWith("http://")) {
String urlDomain = url.replaceFirst("^(http://[^/]+, url)/.*", "$1");
String domain = getDomain(sessionId);
if (domain==null) {
setDomain(sessionId, urlDomain);
}
else if (!url.startsWith(domain)) {
LOGGER.warn("you appear to be changing domains from " + domain + " to " + urlDomain + "\n"
+ "this may lead to a 'Permission denied' from the browser (unless it is running as *iehta or *chrome,\n"
+ "or alternatively the selenium server is running in proxy injection mode)");
}
}
}
private String getDomain(String sessionId) {
return domainsBySessionId.get(sessionId);
}
private Vector<String> parseSeleneseParameters(HttpRequest req) {
Vector<String> values = new Vector<String>();
for (int i = 1; req.getParameter(Integer.toString(i)) != null; i++) {
values.add(req.getParameter(Integer.toString(i)));
}
if (values.size() < 1) {
values.add("");
}
if (values.size() < 2) {
values.add("");
}
return values;
}
protected void downloadWithAnt(final URL url, final File outputFile) {
Project p = new Project();
p.addBuildListener(new AntJettyLoggerBuildListener(LOGGER));
Get g = new Get();
g.setProject(p);
g.setSrc(url);
g.setDest(outputFile);
g.execute();
}
protected File createTempFile(String name) {
String parent = System.getProperty("java.io.tmpdir");
// Hack for windows...
int parentLength = parent.length();
if (parent.lastIndexOf(File.separator) == parentLength - 1) {
parent = parent.substring(0, parentLength - 1);
}
return new File(parent, name);
}
private File downloadFile(String urlString) {
URL url;
try {
url = new URL(urlString);
} catch (MalformedURLException e) {
throw new RuntimeException("Malformed URL <" + urlString + ">, ", e);
}
String fileName = url.getFile();
File outputFile = createTempFile(fileName);
outputFile.deleteOnExit(); // to be on the safe side.
downloadWithAnt(url, outputFile);
return outputFile;
}
protected static String getSpeedForSession(String sessionId) {
String results = null;
if (null != sessionId) {
// get the speed for this session's queues
FrameGroupCommandQueueSet queueSet =
FrameGroupCommandQueueSet.getQueueSet(sessionId);
if (null != queueSet) {
results = "OK," + queueSet.getSpeed();
}
}
if (null == results) {
// get the default speed for new command queues.
results = "OK," + CommandQueue.getSpeed();
}
return results;
}
protected static void setSpeedForSession(String sessionId, int speed) {
if (null != sessionId) {
// set the speed for this session's queues
FrameGroupCommandQueueSet queueSet =
FrameGroupCommandQueueSet.getQueueSet(sessionId);
if (speed < 0) speed = 0;
if (null != queueSet) {
queueSet.setSpeed(speed);
}
} else {
// otherwise set the default speed for all new command queues.
CommandQueue.setSpeed(speed);
}
}
private void shutDown(HttpResponse res) {
LOGGER.info("Shutdown command received");
Runnable initiateShutDown = new Runnable() {
public void run() {
LOGGER.info("initiating shutdown");
AsyncExecute.sleepTight(500);
System.exit(0);
}
};
Thread isd = new Thread(initiateShutDown);
isd.setName("initiateShutDown");
isd.start();
if (res != null) {
try {
res.getOutputStream().write("OK".getBytes());
res.commit();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
private String generateNewSessionId() {
return UUID.randomUUID().toString().replaceAll("-", "");
}
protected String getNewBrowserSession(String browserString, String startURL, String extensionJs,
BrowserConfigurationOptions browserConfigurations)
throws RemoteCommandException {
BrowserSessionInfo sessionInfo = browserSessionFactory
.getNewBrowserSession(browserString, startURL, extensionJs,
browserConfigurations, remoteControl.getConfiguration());
setLastSessionId(sessionInfo.sessionId);
return sessionInfo.sessionId;
}
/** Perl and Ruby hang forever when they see "Connection: close" in the HTTP headers.
* They see that and they think that Jetty will close the socket connection, but
* Jetty doesn't appear to do that reliably when we're creating a process while
* handling the HTTP response! So, removing the "Connection: close" header so that
* Perl and Ruby think we're morons and hang up on us in disgust.
* @param res the HTTP response
*/
private void hackRemoveConnectionCloseHeader(HttpResponse res) {
// First, if Connection has been added, remove it.
res.removeField(HttpFields.__Connection);
// Now, claim that this connection is *actually* persistent
Field[] fields = HttpConnection.class.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
if (fields[i].getName().equals("_close")) {
Field _close = fields[i];
_close.setAccessible(true);
try {
_close.setBoolean(res.getHttpConnection(), false);
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
if (fields[i].getName().equals("_persistent")) {
Field _close = fields[i];
_close.setAccessible(true);
try {
_close.setBoolean(res.getHttpConnection(), true);
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
/**
* Registers the given browser session among the active sessions
* to handle.
*
* Usually externally created browser sessions are managed themselves,
* but registering them allows the shutdown procedures to be simpler.
*
* @param sessionInfo the externally created browser session to register.
*/
public void registerBrowserSession(BrowserSessionInfo sessionInfo) {
browserSessionFactory.registerExternalSession(sessionInfo);
}
/**
* De-registers the given browser session from among the active sessions.
*
* When an externally managed but registered session is closed,
* this method should be called to keep the set of active sessions
* up to date.
*
* @param sessionInfo the session to deregister.
*/
public void deregisterBrowserSession(BrowserSessionInfo sessionInfo) {
browserSessionFactory.deregisterExternalSession(sessionInfo);
}
/** Kills all running browsers */
public void stopAllBrowsers() {
browserSessionFactory.endAllBrowserSessions(remoteControl.getConfiguration());
}
/** Sets all the don't-cache headers on the HttpResponse */
private void setNoCacheHeaders(HttpResponse res) {
res.setField(HttpFields.__CacheControl, "no-cache");
res.setField(HttpFields.__Pragma, "no-cache");
res.setField(HttpFields.__Expires, HttpFields.__01Jan1970);
}
private void setDomain(String sessionId, String domain) {
domainsBySessionId.put(sessionId, domain);
}
public static String getLastSessionId() {
return lastSessionId;
}
public static void setLastSessionId(String sessionId) {
SeleniumDriverResourceHandler.lastSessionId = sessionId;
}
public BrowserLauncherFactory getBrowserLauncherFactory() {
return browserLauncherFactory;
}
public void setBrowserLauncherFactory(
BrowserLauncherFactory browserLauncherFactory) {
this.browserLauncherFactory = browserLauncherFactory;
}
}
| server-coreless/src/main/java/org/openqa/selenium/server/SeleniumDriverResourceHandler.java | /*
* Copyright 2006 ThoughtWorks, Inc.
*
* 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.openqa.selenium.server;
import org.apache.commons.logging.Log;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.Get;
import org.apache.tools.ant.util.FileUtils;
import org.mortbay.http.HttpConnection;
import org.mortbay.http.HttpException;
import org.mortbay.http.HttpFields;
import org.mortbay.http.HttpRequest;
import org.mortbay.http.HttpResponse;
import org.mortbay.http.handler.ResourceHandler;
import org.mortbay.log.LogFactory;
import org.mortbay.util.StringUtil;
import org.openqa.selenium.server.BrowserSessionFactory.BrowserSessionInfo;
import org.openqa.selenium.server.browserlaunchers.AsyncExecute;
import org.openqa.selenium.server.browserlaunchers.BrowserLauncher;
import org.openqa.selenium.server.browserlaunchers.BrowserLauncherFactory;
import org.openqa.selenium.server.commands.CaptureScreenshotCommand;
import org.openqa.selenium.server.commands.CaptureScreenshotToStringCommand;
import org.openqa.selenium.server.commands.RetrieveLastRemoteControlLogsCommand;
import org.openqa.selenium.server.commands.CaptureEntirePageScreenshotToStringCommand;
import org.openqa.selenium.server.commands.SeleniumCoreCommand;
import org.openqa.selenium.server.htmlrunner.HTMLLauncher;
import org.openqa.selenium.server.log.AntJettyLoggerBuildListener;
import java.awt.*;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.lang.reflect.Field;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.Vector;
/**
* A Jetty handler that takes care of remote Selenium requests.
*
* Remote Selenium requests are described in detail in the class description for
* <code>SeleniumServer</code>
* @see org.openqa.selenium.server.SeleniumServer
* @author Paul Hammant
* @version $Revision: 674 $
*/
@SuppressWarnings("serial")
public class SeleniumDriverResourceHandler extends ResourceHandler {
static final Log LOGGER = LogFactory.getLog(SeleniumDriverResourceHandler.class);
static Log browserSideLog = LogFactory.getLog(SeleniumDriverResourceHandler.class.getName()+".browserSideLog");
private SeleniumServer remoteControl;
private static String lastSessionId = null;
private Map<String, String> domainsBySessionId = new HashMap<String, String>();
private StringBuffer logMessagesBuffer = new StringBuffer();
private BrowserLauncherFactory browserLauncherFactory = new BrowserLauncherFactory();
private final BrowserSessionFactory browserSessionFactory =
new BrowserSessionFactory(browserLauncherFactory);
public SeleniumDriverResourceHandler(SeleniumServer remoteControl) {
this.remoteControl = remoteControl;
}
/** Handy helper to retrieve the first parameter value matching the name
*
* @param req - the Jetty HttpRequest
* @param name - the HTTP parameter whose value we'll return
* @return the value of the first HTTP parameter whose name matches <code>name</code>, or <code>null</code> if there is no such parameter
*/
private String getParam(HttpRequest req, String name) {
List<?> parameterValues = req.getParameterValues(name);
if (parameterValues == null) {
return null;
}
return (String) parameterValues.get(0);
}
@Override public void handle(String pathInContext, String pathParams, HttpRequest req, HttpResponse res) throws HttpException, IOException {
try {
LOGGER.debug("Thread name: " + Thread.currentThread().getName());
res.setField(HttpFields.__ContentType, "text/plain");
setNoCacheHeaders(res);
String method = req.getMethod();
String cmd = getParam(req, "cmd");
String sessionId = getParam(req, "sessionId");
String seleniumStart = getParam(req, "seleniumStart");
String loggingParam = getParam(req, "logging");
String jsStateParam = getParam(req, "state");
String retry = getParam(req, "retry");
String closingParam = getParam(req, "closing");
boolean logging = "true".equals(loggingParam);
boolean jsState = "true".equals(jsStateParam);
boolean justLoaded = "true".equals(seleniumStart);
boolean retrying = "true".equals(retry);
boolean closing = "true".equals(closingParam);
LOGGER.debug("req: "+req);
// If this is a browser requesting work for the first time...
if (cmd != null) {
handleCommandRequest(req, res, cmd, sessionId);
} else if ("POST".equalsIgnoreCase(method) || justLoaded || logging) {
handleBrowserResponse(req, res, sessionId, logging, jsState,
justLoaded, retrying, closing);
} else if (-1 != req.getRequestURL().indexOf("selenium-server/core/scripts/user-extensions.js")
|| -1 != req.getRequestURL().indexOf("selenium-server/tests/html/tw.jpg")){
// ignore failure to find these items...
}
else {
LOGGER.debug("Not handling: " + req.getRequestURL() + "?" + req.getQuery());
req.setHandled(false);
}
} catch (RuntimeException e) {
if (looksLikeBrowserLaunchFailedBecauseFileNotFound(e)) {
String apparentFile = extractNameOfFileThatCouldntBeFound(e);
if (apparentFile!=null) {
LOGGER.error("Could not start browser; it appears that " + apparentFile + " is missing or inaccessible");
}
}
throw e;
}
}
private void handleBrowserResponse(HttpRequest req, HttpResponse res,
String sessionId, boolean logging, boolean jsState,
boolean justLoaded, boolean retrying, boolean closing)
throws IOException {
String seleniumWindowName = getParam(req, "seleniumWindowName");
String localFrameAddress = getParam(req, "localFrameAddress");
FrameAddress frameAddress = FrameGroupCommandQueueSet.makeFrameAddress(seleniumWindowName,
localFrameAddress);
String uniqueId = getParam(req, "uniqueId");
String sequenceNumberString = getParam(req, "sequenceNumber");
int sequenceNumber = -1;
FrameGroupCommandQueueSet queueSet = FrameGroupCommandQueueSet.getQueueSet(sessionId);
BrowserResponseSequencer browserResponseSequencer = queueSet.getCommandQueue(uniqueId).getBrowserResponseSequencer();
if (sequenceNumberString != null && sequenceNumberString.length() > 0) {
sequenceNumber = Integer.parseInt(sequenceNumberString);
browserResponseSequencer.waitUntilNumIsAtLeast(sequenceNumber);
}
String postedData = readPostedData(req, sessionId, uniqueId);
if (logging) {
handleLogMessages(postedData);
} else if (jsState) {
handleJsState(sessionId, uniqueId, postedData);
}
if (postedData == null || postedData.equals("") || logging
|| jsState) {
if (sequenceNumber != -1) {
browserResponseSequencer.increaseNum();
}
res.getOutputStream().write("\r\n\r\n".getBytes());
req.setHandled(true);
return;
}
logPostedData(frameAddress, justLoaded, sessionId, postedData,
uniqueId);
if (retrying) {
postedData = null; // DGF retries don't really have a result
}
List<?> jsWindowNameVar = req.getParameterValues("jsWindowNameVar");
RemoteCommand sc = queueSet.handleCommandResult(postedData,
frameAddress, uniqueId, justLoaded, jsWindowNameVar);
if (sc != null) {
respond(res, sc, uniqueId);
}
req.setHandled(true);
}
private void logPostedData(FrameAddress frameAddress, boolean justLoaded, String sessionId, String postedData, String uniqueId) {
StringBuffer sb = new StringBuffer();
sb.append("Browser " + sessionId + "/" + frameAddress + " " + uniqueId + " posted " + postedData);
if (!frameAddress.isDefault()) {
sb.append(" from " + frameAddress);
}
if (justLoaded) {
sb.append(" NEW");
}
LOGGER.debug(sb.toString());
}
private void respond(HttpResponse res, RemoteCommand sc, String uniqueId) throws IOException {
ByteArrayOutputStream buf = new ByteArrayOutputStream(1000);
Writer writer = new OutputStreamWriter(buf, StringUtil.__UTF_8);
if (sc!=null) {
writer.write(sc.toString());
LOGGER.debug("res to " + uniqueId +
": " + sc.toString());
} else {
LOGGER.debug("res empty");
}
for (int pad = 998 - buf.size(); pad-- > 0;) {
writer.write(" ");
}
writer.write("\015\012");
writer.close();
OutputStream out = res.getOutputStream();
buf.writeTo(out);
}
/**
* extract the posted data from an incoming request, stripping away a piggybacked data
*
* @param req
* @param sessionId
* @param uniqueId
* @return a string containing the posted data (with piggybacked log info stripped)
* @throws IOException
*/
private String readPostedData(HttpRequest req, String sessionId, String uniqueId) throws IOException {
// if the request was sent as application/x-www-form-urlencoded, we can get the decoded data right away...
// we do this because it appears that Safari likes to send the data back as application/x-www-form-urlencoded
// even when told to send it back as application/xml. So in short, this function pulls back the data in any
// way it can!
if (req.getParameter("postedData") != null) {
return req.getParameter("postedData");
}
InputStream is = req.getInputStream();
StringBuffer sb = new StringBuffer();
InputStreamReader r = new InputStreamReader(is, "UTF-8");
int c;
while ((c = r.read()) != -1) {
sb.append((char) c);
}
String postedData = sb.toString();
// we check here because, depending on the Selenium Core version you have, specifically the selenium-testrunner.js,
// the data could be sent back directly or as URL-encoded for the parameter "postedData" (see above). Because
// firefox and other browsers like to send it back as application/xml (opposite of Safari), we need to be prepared
// to decode the data ourselves. Also, we check for the string starting with the key because in the rare case
// someone has an outdated version selenium-testrunner.js, which, until today (3/25/2007) sent back the data
// *un*-encoded, we'd like to be as flexible as possible.
if (postedData.startsWith("postedData=")) {
postedData = postedData.substring(11);
postedData = URLDecoder.decode(postedData, "UTF-8");
}
return postedData;
}
private void handleLogMessages(String s) {
String[] lines = s.split("\n");
for (String line : lines) {
if (line.startsWith("logLevel=")) {
int logLevelIdx = line.indexOf(':', "logLevel=".length());
String logLevel = line.substring("logLevel=".length(), logLevelIdx).toUpperCase();
String logMessage = line.substring(logLevelIdx+1);
if ("ERROR".equals(logLevel)) {
browserSideLog.error(logMessage);
} else if ("WARN".equals(logLevel)) {
browserSideLog.warn(logMessage);
} else if ("INFO".equals(logLevel)) {
browserSideLog.info(logMessage);
} else {
// DGF debug is default
browserSideLog.debug(logMessage);
}
}
}
}
private void handleJsState(String sessionId, String uniqueId, String s) {
String jsInitializers = grepStringsStartingWith("state:", s);
if (jsInitializers==null) {
return;
}
for (String jsInitializer : jsInitializers.split("\n")) {
String jsVarName = extractVarName(jsInitializer);
InjectionHelper.saveJsStateInitializer(sessionId, uniqueId, jsVarName, jsInitializer);
}
}
private String extractVarName(String jsInitializer) {
int x = jsInitializer.indexOf('=');
if (x==-1) {
// apparently a method call, not an assignment
// for 'browserBot.recordedAlerts.push("lskdjf")',
// return 'browserBot.recordedAlerts':
x = jsInitializer.lastIndexOf('(');
if (x==-1) {
throw new RuntimeException("expected method call, saw " + jsInitializer);
}
x = jsInitializer.lastIndexOf('.', x-1);
if (x==-1) {
throw new RuntimeException("expected method call, saw " + jsInitializer);
}
}
return jsInitializer.substring(0, x);
}
private String grepStringsStartingWith(String pattern, String s) {
String[] lines = s.split("\n");
StringBuffer sb = new StringBuffer();
String retval = null;
for (String line : lines) {
if (line.startsWith(pattern)) {
sb.append(line.substring(pattern.length()))
.append('\n');
}
}
if (sb.length()!=0) {
retval = sb.toString();
}
return retval;
}
/** Try to extract the name of the file whose absence caused the exception
*
* @param e - the exception
* @return the name of the file whose absence caused the exception
*/
private String extractNameOfFileThatCouldntBeFound(Exception e) {
String s = e.getMessage();
if (s==null) {
return null;
}
// will only succeed on Windows -- perhaps I will make it work on other platforms later
return s.replaceFirst(".*CreateProcess: ", "").replaceFirst(" .*", "");
}
private boolean looksLikeBrowserLaunchFailedBecauseFileNotFound(Exception e) {
String s = e.getMessage();
// will only succeed on Windows -- perhaps I will make it work on other platforms later
return (s!=null) && s.matches("java.io.IOException: CreateProcess: .*error=3");
}
private void handleCommandRequest(HttpRequest req, HttpResponse res, String cmd, String sessionId) {
final String results;
// If this a Driver Client sending a new command...
res.setContentType("text/plain");
hackRemoveConnectionCloseHeader(res);
Vector<String> values = parseSeleneseParameters(req);
results = doCommand(cmd, values, sessionId, res);
// under some conditions, the results variable will be null
// (cf http://forums.openqa.org/thread.jspa?threadID=2955&messageID=8085#8085 for an example of this)
if (results!=null) {
try {
res.getOutputStream().write(results.getBytes("UTF-8"));
} catch (IOException e) {
e.printStackTrace();
}
}
req.setHandled(true);
}
protected FrameGroupCommandQueueSet getQueueSet(String sessionId) {
return FrameGroupCommandQueueSet.getQueueSet(sessionId);
}
public String doCommand(String cmd, Vector<String> values, String sessionId, HttpResponse res) {
LOGGER.info("Command request: " + cmd + values.toString() + " on session " + sessionId);
String results = null;
// handle special commands
switch(SpecialCommand.getValue(cmd)) {
case getNewBrowserSession:
String browserString = values.get(0);
String extensionJs = values.size() > 2 ? values.get(2) : "";
String browserConfigurations = values.size() > 3 ? values.get(3) : "";
try {
sessionId = getNewBrowserSession(browserString, values.get(1), extensionJs, new BrowserConfigurationOptions(browserConfigurations));
setDomain(sessionId, values.get(1));
results = "OK," + sessionId;
} catch (RemoteCommandException rce) {
results = "Failed to start new browser session: " + rce.getMessage();
}
break;
case testComplete:
browserSessionFactory.endBrowserSession(sessionId, remoteControl.getConfiguration());
results = "OK";
break;
case shutDown:
results = null;
shutDown(res);
break;
case getLogMessages:
results = "OK," + logMessagesBuffer.toString();
logMessagesBuffer.setLength(0);
break;
case retrieveLastRemoteControlLogs:
results = new RetrieveLastRemoteControlLogsCommand().execute();
break;
case captureEntirePageScreenshotToString:
results = new CaptureEntirePageScreenshotToStringCommand(values.get(0), sessionId).execute();
break;
case captureScreenshot:
results = new CaptureScreenshotCommand(values.get(0)).execute();
break;
case captureScreenshotToString:
results = new CaptureScreenshotToStringCommand().execute();
break;
case keyDownNative:
try {
RobotRetriever.getRobot().keyPress(Integer.parseInt(values.get(0)));
results = "OK";
} catch (Exception e) {
LOGGER.error("Problem during keyDown: ", e);
results = "ERROR: Problem during keyDown: " + e.getMessage();
}
break;
case keyUpNative:
try {
RobotRetriever.getRobot().keyRelease(Integer.parseInt(values.get(0)));
results = "OK";
} catch (Exception e) {
LOGGER.error("Problem during keyUp: ", e);
results = "ERROR: Problem during keyUp: " + e.getMessage();
}
break;
case keyPressNative:
try {
Robot r = RobotRetriever.getRobot();
int keycode = Integer.parseInt(values.get(0));
r.keyPress(keycode);
r.waitForIdle();
r.keyRelease(keycode);
results = "OK";
} catch (Exception e) {
LOGGER.error("Problem during keyDown: ", e);
results = "ERROR: Problem during keyDown: " + e.getMessage();
}
// TODO typeKeysNative. Requires converting String to array of keycodes.
break;
case isPostSupported:
results = "OK,true";
break;
case setSpeed:
try {
int speed = Integer.parseInt(values.get(0));
setSpeedForSession(sessionId, speed);
} catch (NumberFormatException e) {
return "ERROR: setSlowMode expects a string containing an integer, but saw '" + values.get(0) + "'";
}
results = "OK";
break;
case getSpeed:
results = getSpeedForSession(sessionId);
break;
case addStaticContent:
File dir = new File( values.get(0));
if (dir.exists()) {
remoteControl.addNewStaticContent(dir);
results = "OK";
} else {
results = "ERROR: dir does not exist - " + dir.getAbsolutePath();
}
break;
case runHTMLSuite:
HTMLLauncher launcher = new HTMLLauncher(remoteControl);
File output = null;
if (values.size() < 4) {
results = "ERROR: Not enough arguments (browser, browserURL, suiteURL, multiWindow, [outputFile])";
} else {
if (values.size() > 4) {
output = new File(values.get(4));
}
try {
results = launcher.runHTMLSuite( values.get(0), values.get(1), values.get(2), output, remoteControl.getConfiguration().getTimeoutInSeconds(), "true".equals(values.get(3)));
} catch (IOException e) {
e.printStackTrace();
results = e.toString();
}
}
break;
case launchOnly:
if (values.size() < 1) {
results = "ERROR: You must specify a browser";
} else {
String browser = values.get(0);
String newSessionId = generateNewSessionId();
BrowserLauncher simpleLauncher = browserLauncherFactory.getBrowserLauncher(browser, newSessionId, remoteControl.getConfiguration(), new BrowserConfigurationOptions());
String baseUrl = "http://localhost:" + remoteControl.getPort();
remoteControl.registerBrowserSession(new BrowserSessionInfo(
newSessionId, browser, baseUrl, simpleLauncher, null));
simpleLauncher.launchHTMLSuite("TestPrompt.html?thisIsSeleniumServer=true", baseUrl);
results = "OK";
}
break;
case slowResources:
String arg = values.get(0);
boolean setting = true;
if ("off".equals(arg) || "false".equals(arg)) {
setting = false;
}
StaticContentHandler.setSlowResources(setting);
results = "OK";
break;
case attachFile:
FrameGroupCommandQueueSet queue = getQueueSet(sessionId);
try {
File downloadedFile = downloadFile(values.get(1));
queue.addTemporaryFile(downloadedFile);
results = queue.doCommand("type", values.get(0), downloadedFile.getAbsolutePath());
} catch (Exception e) {
results = e.toString();
}
break;
case open:
warnIfApparentDomainChange(sessionId, values.get(0));
case nonSpecial:
results = new SeleniumCoreCommand(cmd, values, sessionId).execute();
}
if (CaptureScreenshotToStringCommand.ID.equals(cmd)
|| CaptureEntirePageScreenshotToStringCommand.ID.equals(cmd)
|| SeleniumCoreCommand.CAPTURE_ENTIRE_PAGE_SCREENSHOT_ID.equals(cmd)) {
LOGGER.info("Got result: [base64 encoded PNG] on session " + sessionId);
} else if (RetrieveLastRemoteControlLogsCommand.ID.equals(cmd)) {
/* Trim logs to avoid Larsen effect (see remote control stability tests) */
LOGGER.info("Got result:" + results.substring(0, 30) + "... on session " + sessionId);
} else {
LOGGER.info("Got result: " + results + " on session " + sessionId);
}
return results;
}
private void warnIfApparentDomainChange(String sessionId, String url) {
if (url.startsWith("http://")) {
String urlDomain = url.replaceFirst("^(http://[^/]+, url)/.*", "$1");
String domain = getDomain(sessionId);
if (domain==null) {
setDomain(sessionId, urlDomain);
}
else if (!url.startsWith(domain)) {
LOGGER.warn("you appear to be changing domains from " + domain + " to " + urlDomain + "\n"
+ "this may lead to a 'Permission denied' from the browser (unless it is running as *iehta or *chrome,\n"
+ "or alternatively the selenium server is running in proxy injection mode)");
}
}
}
private String getDomain(String sessionId) {
return domainsBySessionId.get(sessionId);
}
private Vector<String> parseSeleneseParameters(HttpRequest req) {
Vector<String> values = new Vector<String>();
for (int i = 1; req.getParameter(Integer.toString(i)) != null; i++) {
values.add(req.getParameter(Integer.toString(i)));
}
if (values.size() < 1) {
values.add("");
}
if (values.size() < 2) {
values.add("");
}
return values;
}
protected void downloadWithAnt(final URL url, final File outputFile) {
Project p = new Project();
p.addBuildListener(new AntJettyLoggerBuildListener(LOGGER));
Get g = new Get();
g.setProject(p);
g.setSrc(url);
g.setDest(outputFile);
g.execute();
}
protected File createTempFile(String name) {
String parent = System.getProperty("java.io.tmpdir");
return new File(parent, name);
}
private File downloadFile(String urlString) {
URL url;
try {
url = new URL(urlString);
} catch (MalformedURLException e) {
throw new RuntimeException("Malformed URL <" + urlString + ">, ", e);
}
String fileName = url.getFile();
File outputFile = createTempFile(fileName);
outputFile.deleteOnExit(); // to be on the safe side.
downloadWithAnt(url, outputFile);
return outputFile;
}
protected static String getSpeedForSession(String sessionId) {
String results = null;
if (null != sessionId) {
// get the speed for this session's queues
FrameGroupCommandQueueSet queueSet =
FrameGroupCommandQueueSet.getQueueSet(sessionId);
if (null != queueSet) {
results = "OK," + queueSet.getSpeed();
}
}
if (null == results) {
// get the default speed for new command queues.
results = "OK," + CommandQueue.getSpeed();
}
return results;
}
protected static void setSpeedForSession(String sessionId, int speed) {
if (null != sessionId) {
// set the speed for this session's queues
FrameGroupCommandQueueSet queueSet =
FrameGroupCommandQueueSet.getQueueSet(sessionId);
if (speed < 0) speed = 0;
if (null != queueSet) {
queueSet.setSpeed(speed);
}
} else {
// otherwise set the default speed for all new command queues.
CommandQueue.setSpeed(speed);
}
}
private void shutDown(HttpResponse res) {
LOGGER.info("Shutdown command received");
Runnable initiateShutDown = new Runnable() {
public void run() {
LOGGER.info("initiating shutdown");
AsyncExecute.sleepTight(500);
System.exit(0);
}
};
Thread isd = new Thread(initiateShutDown);
isd.setName("initiateShutDown");
isd.start();
if (res != null) {
try {
res.getOutputStream().write("OK".getBytes());
res.commit();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
private String generateNewSessionId() {
return UUID.randomUUID().toString().replaceAll("-", "");
}
protected String getNewBrowserSession(String browserString, String startURL, String extensionJs,
BrowserConfigurationOptions browserConfigurations)
throws RemoteCommandException {
BrowserSessionInfo sessionInfo = browserSessionFactory
.getNewBrowserSession(browserString, startURL, extensionJs,
browserConfigurations, remoteControl.getConfiguration());
setLastSessionId(sessionInfo.sessionId);
return sessionInfo.sessionId;
}
/** Perl and Ruby hang forever when they see "Connection: close" in the HTTP headers.
* They see that and they think that Jetty will close the socket connection, but
* Jetty doesn't appear to do that reliably when we're creating a process while
* handling the HTTP response! So, removing the "Connection: close" header so that
* Perl and Ruby think we're morons and hang up on us in disgust.
* @param res the HTTP response
*/
private void hackRemoveConnectionCloseHeader(HttpResponse res) {
// First, if Connection has been added, remove it.
res.removeField(HttpFields.__Connection);
// Now, claim that this connection is *actually* persistent
Field[] fields = HttpConnection.class.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
if (fields[i].getName().equals("_close")) {
Field _close = fields[i];
_close.setAccessible(true);
try {
_close.setBoolean(res.getHttpConnection(), false);
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
if (fields[i].getName().equals("_persistent")) {
Field _close = fields[i];
_close.setAccessible(true);
try {
_close.setBoolean(res.getHttpConnection(), true);
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
/**
* Registers the given browser session among the active sessions
* to handle.
*
* Usually externally created browser sessions are managed themselves,
* but registering them allows the shutdown procedures to be simpler.
*
* @param sessionInfo the externally created browser session to register.
*/
public void registerBrowserSession(BrowserSessionInfo sessionInfo) {
browserSessionFactory.registerExternalSession(sessionInfo);
}
/**
* De-registers the given browser session from among the active sessions.
*
* When an externally managed but registered session is closed,
* this method should be called to keep the set of active sessions
* up to date.
*
* @param sessionInfo the session to deregister.
*/
public void deregisterBrowserSession(BrowserSessionInfo sessionInfo) {
browserSessionFactory.deregisterExternalSession(sessionInfo);
}
/** Kills all running browsers */
public void stopAllBrowsers() {
browserSessionFactory.endAllBrowserSessions(remoteControl.getConfiguration());
}
/** Sets all the don't-cache headers on the HttpResponse */
private void setNoCacheHeaders(HttpResponse res) {
res.setField(HttpFields.__CacheControl, "no-cache");
res.setField(HttpFields.__Pragma, "no-cache");
res.setField(HttpFields.__Expires, HttpFields.__01Jan1970);
}
private void setDomain(String sessionId, String domain) {
domainsBySessionId.put(sessionId, domain);
}
public static String getLastSessionId() {
return lastSessionId;
}
public static void setLastSessionId(String sessionId) {
SeleniumDriverResourceHandler.lastSessionId = sessionId;
}
public BrowserLauncherFactory getBrowserLauncherFactory() {
return browserLauncherFactory;
}
public void setBrowserLauncherFactory(
BrowserLauncherFactory browserLauncherFactory) {
this.browserLauncherFactory = browserLauncherFactory;
}
}
| * Added hack for windows temp folder in createTempFile()
r6454
| server-coreless/src/main/java/org/openqa/selenium/server/SeleniumDriverResourceHandler.java | * Added hack for windows temp folder in createTempFile() | <ide><path>erver-coreless/src/main/java/org/openqa/selenium/server/SeleniumDriverResourceHandler.java
<ide>
<ide> protected File createTempFile(String name) {
<ide> String parent = System.getProperty("java.io.tmpdir");
<add> // Hack for windows...
<add> int parentLength = parent.length();
<add> if (parent.lastIndexOf(File.separator) == parentLength - 1) {
<add> parent = parent.substring(0, parentLength - 1);
<add> }
<add>
<ide> return new File(parent, name);
<ide> }
<ide> |
|
Java | lgpl-2.1 | 80918a6b9337a4671966ce098c9e733fea6d9f74 | 0 | certusoft/swingx,certusoft/swingx | /*
* $Id$
*
* Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A. All rights reserved.
*
* 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 St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jdesktop.swingx.painter;
import java.awt.Graphics2D;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.image.BufferedImage;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingUtilities;
import javax.swing.Timer;
import org.jdesktop.swingx.JXButton;
import org.jdesktop.swingx.JXPanel;
import org.jdesktop.swingx.image.FastBlurFilter;
/**
* JW: renamed from PainterInteractiveTest to fix the build failure. Revisit!
* @author rbair
*/
public class PainterVisualCheck extends RichInteractiveTestCase {
public void testJXButtonTextChangeWithBlur() {
//Creates a button with a blur on the text. On click events, the
//button changes its text. If things are working, then the text
//on the button will be changed, and reblurred. In other words,
//the painter will be invalid (cache cleared), and updated on the
//next paint.
final JXButton button = new JXButton();
AbstractPainter<?> p = (AbstractPainter<?>)button.getForegroundPainter();
p.setFilters(new FastBlurFilter());
button.addActionListener(new ActionListener(){
private String[] values = new String[] {"Hello", "Goodbye", "SwingLabs", "Turkey Bowl"};
private int index = 1;
public void actionPerformed(ActionEvent ae) {
button.setText(values[index]);
index++;
if (index >= values.length) {
index = 0;
}
}
});
JPanel pa = new JPanel();
pa.add(button);
assertTrue(showTest(pa, "JXButton text-change with a blur",
"On click events, the button changes its text. " +
"If things are working, then the text on the button " +
"will be changed, and reblurred."));
}
public void testCacheWithBlurAndAnimation() {
//This test is also covered (more or less) by the regression tests.
//This is a second line of defense test, because if the regression test
//is messed up, it will be easy to notice here.
//I simply have a rectangle painter and a text painter, and the text changes
//over time. This should cause the text painter to be invalidated. Likewise,
//there is a drop-shadow like blur applied to the whole thing.
final JXPanel p = new JXPanel();
final String[] messages = new String[] {
"These are the times",
"That try men's souls",
"And something else",
"I can't quite remember"
};
final TextPainter text = new TextPainter();
text.setText(messages[0]);
CompoundPainter<?> cp = new CompoundPainter<Object>(
new RectanglePainter(),
text
);
cp.setFilters(new FastBlurFilter());
p.setBackgroundPainter(cp);
Timer t = new Timer(1000, new ActionListener() {
int index = 1;
public void actionPerformed(ActionEvent ae) {
text.setText(messages[index]);
index++;
if (index >= messages.length) {
index = 0;
}
p.repaint();
}
});
t.start();
try {
assertTrue(showTest(p, "Test cache works with blur and animation",
"In this setup, there is a TextPainter within a CompoundPainter. " +
"The CompoundPainter has a filter applied, and uses caching. Thus " +
"when the text changes, it is invalidating itself, and the " +
"CompoundPainter should detect that and invalidate its cache. " +
"If you see the text changing, then this test is passing (or the " +
"cache isn't working, but whatever :-))"));
} finally {
t.stop();
}
}
public void testCacheWorks() {
JXPanel p = new JXPanel();
JLabel label1 = new JLabel();
JLabel label2 = new JLabel();
SlowPainter painter1 = new SlowPainter();
painter1.setCacheable(true);
SlowPainter painter2 = new SlowPainter();
painter2.setCacheable(false);
p.setLayout(new GridBagLayout());
p.add(label1, new GridBagConstraints(0, 0, 1, 1, 1.0, 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0));
p.add(label2, new GridBagConstraints(0, 1, 1, 1, 1.0, 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0));
//fire off two background threads, and let them run until the test is over
Thread t1 = new SlowTestThread(painter1, label1, "Cached Painter FPS: ");
t1.start();
Thread t2 = new SlowTestThread(painter2, label2, "Normal Painter FPS: ");
t2.start();
try {
assertTrue(showTest(p, "Test cache works",
"Simply tests that rendering speed for a cached painter is faster than " +
"rendering speed of a non cached painter. Simply compare the two FPS counters. " +
"(Note, I introduce a purposeful 1 second delay on " +
"the non-cached version, to ensure that whenever painting occurs, it will " +
"be slower than using the cache. Also, both painters are run on background " +
"threads so as not to block the GUI)"));
} finally {
t1.interrupt();
t2.interrupt();
}
}
private static final class SlowPainter extends AbstractPainter<Object> {
@Override
protected void doPaint(Graphics2D g, Object component, int width, int height) {
try {
Thread.sleep(1000);
} catch (Exception e) {}
}
@Override
protected boolean shouldUseCache() {
return isCacheable();
}
}
private static final class SlowTestThread extends Thread {
private Graphics2D g = new BufferedImage(10, 10, BufferedImage.TYPE_INT_ARGB).createGraphics();
private Painter<?> p = null;
private JLabel label = null;
private String prefix = null;
public SlowTestThread(SlowPainter p, JLabel l, String s) {
this.p = p;
this.label = l;
this.prefix = s;
}
@Override
public void run() {
while(true) {
double start = System.currentTimeMillis();
p.paint(g, null, 10, 10);
double stop = System.currentTimeMillis();
final double fps = 1000.0/(stop - start);
SwingUtilities.invokeLater(new Runnable() {
public void run() {
label.setText(prefix + fps);
}
});
}
}
}
}
| src/test/org/jdesktop/swingx/painter/PainterVisualCheck.java | /*
* $Id$
*
* Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A. All rights reserved.
*
* 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 St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jdesktop.swingx.painter;
import java.awt.Graphics2D;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.image.BufferedImage;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingUtilities;
import javax.swing.Timer;
import org.jdesktop.swingx.JXButton;
import org.jdesktop.swingx.JXPanel;
import org.jdesktop.swingx.image.FastBlurFilter;
/**
* JW: renamed from PainterInteractiveTest to fix the build failure. Revisit!
* @author rbair
*/
public class PainterVisualCheck extends RichInteractiveTestCase {
public void testJXButtonTextChangeWithBlur() {
//Creates a button with a blur on the text. On click events, the
//button changes its text. If things are working, then the text
//on the button will be changed, and reblurred. In other words,
//the painter will be invalid (cache cleared), and updated on the
//next paint.
final JXButton button = new JXButton();
AbstractPainter<?> p = (AbstractPainter<?>)button.getForegroundPainter();
p.setFilters(new FastBlurFilter());
button.addActionListener(new ActionListener(){
private String[] values = new String[] {"Hello", "Goodbye", "SwingLabs", "Turkey Bowl"};
private int index = 1;
public void actionPerformed(ActionEvent ae) {
button.setText(values[index]);
index++;
if (index >= values.length) {
index = 0;
}
}
});
JPanel pa = new JPanel();
pa.add(button);
assertTrue(showTest(pa, "JXButton text-change with a blur",
"On click events, the button changes its text. " +
"If things are working, then the text on the button " +
"will be changed, and reblurred."));
}
public void testCacheWithBlurAndAnimation() {
//This test is also covered (more or less) by the regression tests.
//This is a second line of defense test, because if the regression test
//is messed up, it will be easy to notice here.
//I simply have a rectangle painter and a text painter, and the text changes
//over time. This should cause the text painter to be invalidated. Likewise,
//there is a drop-shadow like blur applied to the whole thing.
final JXPanel p = new JXPanel();
final String[] messages = new String[] {
"These are the times",
"That try men's souls",
"And something else",
"I can't quite remember"
};
final TextPainter text = new TextPainter();
text.setText(messages[0]);
CompoundPainter<?> cp = new CompoundPainter<Object>(
new RectanglePainter<Object>(),
text
);
cp.setFilters(new FastBlurFilter());
p.setBackgroundPainter(cp);
Timer t = new Timer(1000, new ActionListener() {
int index = 1;
public void actionPerformed(ActionEvent ae) {
text.setText(messages[index]);
index++;
if (index >= messages.length) {
index = 0;
}
p.repaint();
}
});
t.start();
try {
assertTrue(showTest(p, "Test cache works with blur and animation",
"In this setup, there is a TextPainter within a CompoundPainter. " +
"The CompoundPainter has a filter applied, and uses caching. Thus " +
"when the text changes, it is invalidating itself, and the " +
"CompoundPainter should detect that and invalidate its cache. " +
"If you see the text changing, then this test is passing (or the " +
"cache isn't working, but whatever :-))"));
} finally {
t.stop();
}
}
public void testCacheWorks() {
JXPanel p = new JXPanel();
JLabel label1 = new JLabel();
JLabel label2 = new JLabel();
SlowPainter painter1 = new SlowPainter();
painter1.setCacheable(true);
SlowPainter painter2 = new SlowPainter();
painter2.setCacheable(false);
p.setLayout(new GridBagLayout());
p.add(label1, new GridBagConstraints(0, 0, 1, 1, 1.0, 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0));
p.add(label2, new GridBagConstraints(0, 1, 1, 1, 1.0, 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0));
//fire off two background threads, and let them run until the test is over
Thread t1 = new SlowTestThread(painter1, label1, "Cached Painter FPS: ");
t1.start();
Thread t2 = new SlowTestThread(painter2, label2, "Normal Painter FPS: ");
t2.start();
try {
assertTrue(showTest(p, "Test cache works",
"Simply tests that rendering speed for a cached painter is faster than " +
"rendering speed of a non cached painter. Simply compare the two FPS counters. " +
"(Note, I introduce a purposeful 1 second delay on " +
"the non-cached version, to ensure that whenever painting occurs, it will " +
"be slower than using the cache. Also, both painters are run on background " +
"threads so as not to block the GUI)"));
} finally {
t1.interrupt();
t2.interrupt();
}
}
private static final class SlowPainter extends AbstractPainter<Object> {
@Override
protected void doPaint(Graphics2D g, Object component, int width, int height) {
try {
Thread.sleep(1000);
} catch (Exception e) {}
}
@Override
protected boolean shouldUseCache() {
return isCacheable();
}
}
private static final class SlowTestThread extends Thread {
private Graphics2D g = new BufferedImage(10, 10, BufferedImage.TYPE_INT_ARGB).createGraphics();
private Painter<?> p = null;
private JLabel label = null;
private String prefix = null;
public SlowTestThread(SlowPainter p, JLabel l, String s) {
this.p = p;
this.label = l;
this.prefix = s;
}
@Override
public void run() {
while(true) {
double start = System.currentTimeMillis();
p.paint(g, null, 10, 10);
double stop = System.currentTimeMillis();
final double fps = 1000.0/(stop - start);
SwingUtilities.invokeLater(new Runnable() {
public void run() {
label.setText(prefix + fps);
}
});
}
}
}
}
| Update to change in RectanglePainter. | src/test/org/jdesktop/swingx/painter/PainterVisualCheck.java | Update to change in RectanglePainter. | <ide><path>rc/test/org/jdesktop/swingx/painter/PainterVisualCheck.java
<ide> final TextPainter text = new TextPainter();
<ide> text.setText(messages[0]);
<ide> CompoundPainter<?> cp = new CompoundPainter<Object>(
<del> new RectanglePainter<Object>(),
<add> new RectanglePainter(),
<ide> text
<ide> );
<ide> cp.setFilters(new FastBlurFilter()); |
|
Java | mit | 2fa5e53c95a59dd7e02500e828303473f43fac12 | 0 | pitkley/jmccs | package de.pitkley.ddcci.main;
import com.sun.jna.Memory;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.ptr.IntByReference;
import de.pitkley.ddcci.monitor.*;
import java.util.List;
public class Main {
private static void testMonitorManager() {
msg("Getting monitor manager");
MonitorManager monitorManager = Monitors.getMonitorManager();
msg("Getting monitors");
List<Monitor> monitors = monitorManager.getMonitors();
msg("Monitor count: " + monitors.size());
msg("Looping through monitors...");
for (Monitor monitor : monitors) {
msg("Checking if brightness is supported");
boolean brightnessSupported = monitor.isCapabilitySupported(MonitorCapability.BRIGHTNESS);
msg("Response: " + brightnessSupported);
if (brightnessSupported) {
msg("Getting current brightness...");
int currentBrightness = monitor.getCurrentBrightness();
msg("Response: " + currentBrightness);
if (currentBrightness == 50) {
msg("Setting brightness to 90...");
monitor.setBrightness(90);
} else {
msg("Setting brightness to 50...");
monitor.setBrightness(50);
}
}
}
msg("Closing monitors");
monitorManager.closeMonitors();
}
private static void testLibOSX() {
int displayCount = LibOSX.INSTANCE.getDisplayCount(5);
System.out.println("displayCount: " + displayCount);
Pointer onlineDisplays = new Memory(5 * Native.getNativeSize(Integer.TYPE));
IntByReference ptrDisplayCount = new IntByReference();
LibOSX.INSTANCE.getOnlineDisplayList(5, onlineDisplays, ptrDisplayCount);
System.out.println(onlineDisplays);
System.out.println(ptrDisplayCount.getValue());
for (int i = 0; i < ptrDisplayCount.getValue(); i++) {
System.out.println(onlineDisplays.getInt(i * Native.getNativeSize(Integer.TYPE)));
}
}
private static void testCoreGraphics() {
int maxDisplays = 5;
Pointer onlineDisplays = new Memory(maxDisplays * Native.getNativeSize(Integer.TYPE));
IntByReference ptrDisplayCount = new IntByReference();
CoreGraphics.INSTANCE.CGGetOnlineDisplayList(maxDisplays, onlineDisplays, ptrDisplayCount);
msg("onlineDisplays: "+onlineDisplays);
msg("displayCount: "+ptrDisplayCount.getValue());
for (int i = 0; i < ptrDisplayCount.getValue(); i++) {
msg("Display " + i + ": " + onlineDisplays.getInt(i * Native.getNativeSize(Integer.TYPE)));
}
}
public static void main(String[] args) {
testCoreGraphics();
}
private static long lastMsg = 0L;
public static void msg(String msg) {
long now = System.currentTimeMillis();
if (lastMsg == 0L) {
lastMsg = now;
}
long delta = now - lastMsg;
lastMsg = now;
System.out.println(String.format("%d] %4d] %s", now, delta, msg));
}
}
| app/src/main/java/de/pitkley/ddcci/main/Main.java | package de.pitkley.ddcci.main;
import de.pitkley.ddcci.monitor.*;
import java.util.List;
public class Main {
public static void main(String[] args) {
msg("Getting monitor manager");
MonitorManager monitorManager = Monitors.getMonitorManager();
msg("Getting monitors");
List<Monitor> monitors = monitorManager.getMonitors();
msg("Monitor count: " + monitors.size());
msg("Looping through monitors...");
for (Monitor monitor : monitors) {
msg("Checking if brightness is supported");
boolean brightnessSupported = monitor.isCapabilitySupported(MonitorCapability.BRIGHTNESS);
msg("Response: " + brightnessSupported);
if (brightnessSupported) {
msg("Getting current brightness...");
int currentBrightness = monitor.getCurrentBrightness();
msg("Response: " + currentBrightness);
if (currentBrightness == 50) {
msg("Setting brightness to 90...");
monitor.setBrightness(90);
} else {
msg("Setting brightness to 50...");
monitor.setBrightness(50);
}
}
}
msg("Closing monitors");
monitorManager.closeMonitors();
}
private static long lastMsg = 0L;
public static void msg(String msg) {
long now = System.currentTimeMillis();
if (lastMsg == 0L) {
lastMsg = now;
}
long delta = now - lastMsg;
lastMsg = now;
System.out.println(String.format("%d] %4d] %s", now, delta, msg));
}
}
| Added native parts for OS X, tests in Main class
| app/src/main/java/de/pitkley/ddcci/main/Main.java | Added native parts for OS X, tests in Main class | <ide><path>pp/src/main/java/de/pitkley/ddcci/main/Main.java
<ide> package de.pitkley.ddcci.main;
<ide>
<add>import com.sun.jna.Memory;
<add>import com.sun.jna.Native;
<add>import com.sun.jna.Pointer;
<add>import com.sun.jna.ptr.IntByReference;
<ide> import de.pitkley.ddcci.monitor.*;
<ide>
<ide> import java.util.List;
<ide>
<ide> public class Main {
<del> public static void main(String[] args) {
<add>
<add> private static void testMonitorManager() {
<ide> msg("Getting monitor manager");
<ide> MonitorManager monitorManager = Monitors.getMonitorManager();
<ide> msg("Getting monitors");
<ide> monitorManager.closeMonitors();
<ide> }
<ide>
<add> private static void testLibOSX() {
<add> int displayCount = LibOSX.INSTANCE.getDisplayCount(5);
<add> System.out.println("displayCount: " + displayCount);
<add>
<add> Pointer onlineDisplays = new Memory(5 * Native.getNativeSize(Integer.TYPE));
<add> IntByReference ptrDisplayCount = new IntByReference();
<add> LibOSX.INSTANCE.getOnlineDisplayList(5, onlineDisplays, ptrDisplayCount);
<add> System.out.println(onlineDisplays);
<add> System.out.println(ptrDisplayCount.getValue());
<add> for (int i = 0; i < ptrDisplayCount.getValue(); i++) {
<add> System.out.println(onlineDisplays.getInt(i * Native.getNativeSize(Integer.TYPE)));
<add> }
<add> }
<add>
<add> private static void testCoreGraphics() {
<add> int maxDisplays = 5;
<add>
<add> Pointer onlineDisplays = new Memory(maxDisplays * Native.getNativeSize(Integer.TYPE));
<add> IntByReference ptrDisplayCount = new IntByReference();
<add>
<add> CoreGraphics.INSTANCE.CGGetOnlineDisplayList(maxDisplays, onlineDisplays, ptrDisplayCount);
<add> msg("onlineDisplays: "+onlineDisplays);
<add> msg("displayCount: "+ptrDisplayCount.getValue());
<add> for (int i = 0; i < ptrDisplayCount.getValue(); i++) {
<add> msg("Display " + i + ": " + onlineDisplays.getInt(i * Native.getNativeSize(Integer.TYPE)));
<add> }
<add> }
<add>
<add> public static void main(String[] args) {
<add> testCoreGraphics();
<add> }
<add>
<ide> private static long lastMsg = 0L;
<ide>
<ide> public static void msg(String msg) { |
|
JavaScript | bsd-3-clause | 25b3be4a8fc3c14915619e4135827476e878e3c9 | 0 | PolymerLabs/arcs,PolymerLabs/arcs,PolymerLabs/arcs,PolymerLabs/arcs,PolymerLabs/arcs,PolymerLabs/arcs,PolymerLabs/arcs,PolymerLabs/arcs | /**
* @license
* Copyright (c) 2018 Google Inc. All rights reserved.
* This code may only be used under the BSD style license found at
* http://polymer.github.io/LICENSE.txt
* Code distributed by Google as part of this project is also
* subject to an additional IP rights grant found at
* http://polymer.github.io/PATENTS.txt
*/
'use strict';
import {assert} from '../platform/assert-web.js';
import {SlotConsumer} from './slot-consumer.js';
import Template from '../shell/components/xen/xen-template.js';
const templateByName = new Map();
export class SlotDomConsumer extends SlotConsumer {
constructor(consumeConn, containerKind) {
super(consumeConn, containerKind);
this._observer = this._initMutationObserver();
}
constructRenderRequest(hostedSlotConsumer) {
let request = ['model'];
let prefixes = [this.templatePrefix];
if (hostedSlotConsumer) {
prefixes.push(hostedSlotConsumer.consumeConn.particle.name);
prefixes.push(hostedSlotConsumer.consumeConn.name);
}
if (!SlotDomConsumer.hasTemplate(prefixes.join('::'))) {
request.push('template');
}
return request;
}
static hasTemplate(templatePrefix) {
return [...templateByName.keys()].find(key => key.startsWith(templatePrefix));
}
isSameContainer(container, contextContainer) {
return container.parentNode == contextContainer;
}
createNewContainer(contextContainer, subId) {
let newContainer = document.createElement(this._containerKind || 'div');
if (this.consumeConn) {
newContainer.setAttribute('particle-host', this.consumeConn.getQualifiedName());
}
contextContainer.appendChild(newContainer);
return newContainer;
}
deleteContainer(container) {
if (container.parentNode) {
container.parentNode.removeChild(container);
}
}
formatContent(content, subId) {
let newContent = {};
// Format model.
if (Object.keys(content).indexOf('model') >= 0) {
if (content.model) {
// Merge descriptions into model.
newContent.model = Object.assign({}, content.model, content.descriptions);
// Replace items list by an single item corresponding to the given subId.
if (subId && content.model.items) {
assert(this.consumeConn.slotSpec.isSet);
let item = content.model.items.find(item => item.subId == subId);
if (item) {
newContent.model = Object.assign({}, newContent.model, item);
delete newContent.model.items;
} else {
newContent.model = undefined;
}
}
} else {
newContent.model = undefined;
}
}
// Format template name and template.
if (content.templateName) {
newContent.templateName = typeof content.templateName === 'string' ? content.templateName : content.templateName[subId];
if (content.template) {
newContent.template = typeof content.template === 'string' ? content.template : content.template[newContent.templateName];
}
}
return newContent;
}
setContainerContent(rendering, content, subId) {
if (!rendering.container)
return;
if (Object.keys(content).length == 0) {
this.clearContainer(rendering);
return;
}
this._setTemplate(rendering, this.templatePrefix, content.templateName, content.template);
rendering.model = content.model;
this._onUpdate(rendering);
}
clearContainer(rendering) {
if (rendering.liveDom) {
rendering.liveDom.root.textContent = '';
}
rendering.liveDom = null;
}
dispose() {
this._observer && this._observer.disconnect();
this.container && this.deleteContainer(this.container);
this.renderings.forEach(([subId, {container}]) => this.deleteContainer(container));
}
static clear(container) {
container.textContent = '';
}
static dispose() {
// empty template cache
templateByName.clear();
}
static findRootContainers(topContainer) {
let containerBySlotId = {};
Array.from(topContainer.querySelectorAll('[slotid]')).forEach(container => {
//assert(this.isDirectInnerSlot(container), 'Unexpected inner slot');
let slotId = container.getAttribute('slotid');
assert(!containerBySlotId[slotId], `Duplicate root slot ${slotId}`);
containerBySlotId[slotId] = container;
});
return containerBySlotId;
}
createTemplateElement(template) {
return Object.assign(document.createElement('template'), {innerHTML: template});
}
get templatePrefix() {
return this.consumeConn.getQualifiedName();
}
_setTemplate(rendering, templatePrefix, templateName, template) {
if (templateName) {
rendering.templateName = [templatePrefix, templateName].filter(s => s).join('::');
if (template) {
if (templateByName.has(rendering.templateName)) {
// TODO: check whether the new template is different from the one that was previously used.
// Template is being replaced.
this.clearContainer(rendering);
}
templateByName.set(rendering.templateName, this.createTemplateElement(template));
}
}
}
_onUpdate(rendering) {
this._observe(rendering.container);
if (rendering.templateName) {
let template = templateByName.get(rendering.templateName);
assert(template, `No template for ${rendering.templateName}`);
this._stampTemplate(rendering, template);
}
this._updateModel(rendering);
}
_observe(container) {
assert(container, 'Cannot observe without a container');
this._observer && this._observer.observe(container, {childList: true, subtree: true});
}
_stampTemplate(rendering, template) {
if (!rendering.liveDom) {
// TODO(sjmiles): hack to allow subtree elements (e.g. x-list) to marshal events
rendering.container._eventMapper = this._eventMapper.bind(this, this._eventHandler);
rendering.liveDom = Template
.stamp(template)
.events(rendering.container._eventMapper)
.appendTo(rendering.container);
}
}
_updateModel(rendering) {
let liveDom = rendering.liveDom;
if (liveDom) {
liveDom.set(rendering.model);
}
}
initInnerContainers(container) {
Array.from(container.querySelectorAll('[slotid]')).filter(innerContainer => {
if (!this.isDirectInnerSlot(container, innerContainer)) {
// Skip inner slots of an inner slot of the given slot.
return false;
}
const slotId = this.getNodeValue(innerContainer, 'slotid');
const providedSlotSpec = this.consumeConn.slotSpec.getProvidedSlotSpec(slotId);
if (!providedSlotSpec) { // Skip non-declared slots
console.warn(`Slot ${this.consumeConn.slotSpec.name} has unexpected inner slot ${slotId}`);
return;
}
const subId = this.getNodeValue(innerContainer, 'subid');
this._validateSubId(providedSlotSpec, subId);
this._initInnerSlotContainer(slotId, subId, innerContainer);
});
}
// get a value from node that could be an attribute, if not a property
getNodeValue(node, name) {
// TODO(sjmiles): remember that attribute names from HTML are lower-case
return node[name] || node.getAttribute(name);
}
_validateSubId(providedSlotSpec, subId) {
assert(!this.subId || !subId || this.subId == subId, `Unexpected sub-id ${subId}, expecting ${this.subId}`);
assert(Boolean(this.subId || subId) === providedSlotSpec.isSet,
`Sub-id ${subId} for provided slot ${providedSlotSpec.name} doesn't match set spec: ${providedSlotSpec.isSet}`);
}
isDirectInnerSlot(container, innerContainer) {
if (innerContainer === container) {
return true;
}
let parentNode = innerContainer.parentNode;
while (parentNode) {
if (parentNode == container) {
return true;
}
if (parentNode.getAttribute('slotid')) {
// this is an inner slot of an inner slot.
return false;
}
parentNode = parentNode.parentNode;
}
// innerContainer won't be a child node of container if the method is triggered
// by mutation observer record and innerContainer was removed.
return false;
}
_initMutationObserver() {
if (this.consumeConn) {
return new MutationObserver(async (records) => {
this._observer.disconnect();
let containers = this.renderings.map(([subId, {container}]) => container)
.filter(container => records.some(r => this.isDirectInnerSlot(container, r.target)));
if (containers.length > 0) {
this._innerContainerBySlotName = {};
containers.forEach(container => this.initInnerContainers(container));
this.updateProvidedContexts();
// Reactivate the observer.
containers.forEach(container => this._observe(container));
}
});
}
}
_eventMapper(eventHandler, node, eventName, handlerName) {
node.addEventListener(eventName, event => {
// TODO(sjmiles): we have an extremely minimalist approach to events here, this is useful IMO for
// finding the smallest set of features that we are going to need.
// First problem: click event firing multiple times as it bubbles up the tree, minimalist solution
// is to enforce a 'first listener' rule by executing `stopPropagation`.
event.stopPropagation();
// propagate keyboard information
const {altKey, ctrlKey, metaKey, shiftKey, code, key, repeat} = event;
eventHandler({
handler: handlerName,
data: {
// TODO(sjmiles): this is a data-key (as in key-value pair), may be confusing vs `keys`
key: node.key,
value: node.value,
keys: {altKey, ctrlKey, metaKey, shiftKey, code, key, repeat}
}
});
});
}
formatHostedContent(hostedSlot, content) {
if (content.templateName) {
if (typeof content.templateName == 'string') {
content.templateName = `${hostedSlot.consumeConn.particle.name}::${hostedSlot.consumeConn.name}::${content.templateName}`;
} else {
// TODO(mmandlis): add support for hosted particle rendering set slot.
assert(false, 'TODO: Implement this!');
}
}
return content;
}
}
| runtime/slot-dom-consumer.js | /**
* @license
* Copyright (c) 2018 Google Inc. All rights reserved.
* This code may only be used under the BSD style license found at
* http://polymer.github.io/LICENSE.txt
* Code distributed by Google as part of this project is also
* subject to an additional IP rights grant found at
* http://polymer.github.io/PATENTS.txt
*/
'use strict';
import {assert} from '../platform/assert-web.js';
import {SlotConsumer} from './slot-consumer.js';
import Template from '../shell/components/xen/xen-template.js';
const templateByName = new Map();
export class SlotDomConsumer extends SlotConsumer {
constructor(consumeConn, containerKind) {
super(consumeConn, containerKind);
this._observer = this._initMutationObserver();
}
constructRenderRequest(hostedSlotConsumer) {
let request = ['model'];
let prefixes = [this.templatePrefix];
if (hostedSlotConsumer) {
prefixes.push(hostedSlotConsumer.consumeConn.particle.name);
prefixes.push(hostedSlotConsumer.consumeConn.name);
}
if (!SlotDomConsumer.hasTemplate(prefixes.join('::'))) {
request.push('template');
}
return request;
}
static hasTemplate(templatePrefix) {
return [...templateByName.keys()].find(key => key.startsWith(templatePrefix));
}
isSameContainer(container, contextContainer) {
return container.parentNode == contextContainer;
}
createNewContainer(contextContainer, subId) {
let newContainer = document.createElement(this._containerKind || 'div');
if (this.consumeConn) {
newContainer.setAttribute('particle-host', this.consumeConn.getQualifiedName());
}
contextContainer.appendChild(newContainer);
return newContainer;
}
deleteContainer(container) {
if (container.parentNode) {
container.parentNode.removeChild(container);
}
}
formatContent(content, subId) {
let newContent = {};
// Format model.
if (Object.keys(content).indexOf('model') >= 0) {
if (content.model) {
// Merge descriptions into model.
newContent.model = Object.assign({}, content.model, content.descriptions);
// Replace items list by an single item corresponding to the given subId.
if (subId && content.model.items) {
assert(this.consumeConn.slotSpec.isSet);
let item = content.model.items.find(item => item.subId == subId);
if (item) {
newContent.model = Object.assign({}, newContent.model, item);
delete newContent.model.items;
} else {
newContent.model = undefined;
}
}
} else {
newContent.model = undefined;
}
}
// Format template name and template.
if (content.templateName) {
newContent.templateName = typeof content.templateName === 'string' ? content.templateName : content.templateName[subId];
if (content.template) {
newContent.template = typeof content.template === 'string' ? content.template : content.template[newContent.templateName];
}
}
return newContent;
}
setContainerContent(rendering, content, subId) {
if (!rendering.container)
return;
if (Object.keys(content).length == 0) {
this.clearContainer(rendering);
return;
}
this._setTemplate(rendering, this.templatePrefix, content.templateName, content.template);
rendering.model = content.model;
this._onUpdate(rendering);
}
clearContainer(rendering) {
if (rendering.liveDom) {
rendering.liveDom.root.textContent = '';
}
rendering.liveDom = null;
}
dispose() {
this._observer && this._observer.disconnect();
this.container && this.deleteContainer(this.container);
this.renderings.forEach(([subId, {container}]) => this.deleteContainer(container));
}
static clear(container) {
container.textContent = '';
}
static dispose() {
// empty template cache
templateByName.clear();
}
static findRootContainers(topContainer) {
let containerBySlotId = {};
Array.from(topContainer.querySelectorAll('[slotid]')).forEach(container => {
//assert(this.isDirectInnerSlot(container), 'Unexpected inner slot');
let slotId = container.getAttribute('slotid');
assert(!containerBySlotId[slotId], `Duplicate root slot ${slotId}`);
containerBySlotId[slotId] = container;
});
return containerBySlotId;
}
createTemplateElement(template) {
return Object.assign(document.createElement('template'), {innerHTML: template});
}
get templatePrefix() {
return this.consumeConn.getQualifiedName();
}
_setTemplate(rendering, templatePrefix, templateName, template) {
if (templateName) {
rendering.templateName = [templatePrefix, templateName].filter(s => s).join('::');
if (template) {
if (templateByName.has(rendering.templateName)) {
// TODO: check whether the new template is different from the one that was previously used.
// Template is being replaced.
this.clearContainer(rendering);
}
templateByName.set(rendering.templateName, this.createTemplateElement(template));
}
}
}
_onUpdate(rendering) {
this._observe(rendering.container);
if (rendering.templateName) {
let template = templateByName.get(rendering.templateName);
assert(template, `No template for ${rendering.templateName}`);
this._stampTemplate(rendering, template);
}
this._updateModel(rendering);
}
_observe(container) {
assert(container, 'Cannot observe without a container');
this._observer && this._observer.observe(container, {childList: true, subtree: true});
}
_stampTemplate(rendering, template) {
if (!rendering.liveDom) {
// TODO(sjmiles): hack to allow subtree elements (e.g. x-list) to marshal events
rendering.container._eventMapper = this._eventMapper.bind(this, this._eventHandler);
rendering.liveDom = Template
.stamp(template)
.events(rendering.container._eventMapper)
.appendTo(rendering.container);
}
}
_updateModel(rendering) {
let liveDom = rendering.liveDom;
if (liveDom) {
liveDom.set(rendering.model);
}
}
initInnerContainers(container) {
Array.from(container.querySelectorAll('[slotid]')).filter(innerContainer => {
if (!this.isDirectInnerSlot(container, innerContainer)) {
// Skip inner slots of an inner slot of the given slot.
return false;
}
const slotId = this.getNodeValue(innerContainer, 'slotid');
const providedSlotSpec = this.consumeConn.slotSpec.getProvidedSlotSpec(slotId);
if (!providedSlotSpec) { // Skip non-declared slots
console.warn(`Slot ${this.consumeConn.slotSpec.name} has unexpected inner slot ${slotId}`);
return;
}
const subId = this.getNodeValue(innerContainer, 'subid');
this._validateSubId(providedSlotSpec, subId);
this._initInnerSlotContainer(slotId, subId, innerContainer);
});
}
// get a value from node that could be an attribute, if not a property
getNodeValue(node, name) {
// TODO(sjmiles): remember that attribute names from HTML are lower-case
return node[name] || node.getAttribute(name);
}
_validateSubId(providedSlotSpec, subId) {
assert(!this.subId || !subId || this.subId == subId, `Unexpected sub-id ${subId}, expecting ${this.subId}`);
assert(Boolean(this.subId || subId) === providedSlotSpec.isSet,
`Sub-id ${subId} for provided slot ${providedSlotSpec.name} doesn't match set spec: ${providedSlotSpec.isSet}`);
}
isDirectInnerSlot(container, innerContainer) {
if (innerContainer === container) {
return true;
}
let parentNode = innerContainer.parentNode;
while (parentNode) {
if (parentNode == container) {
return true;
}
if (parentNode.getAttribute('slotid')) {
// this is an inner slot of an inner slot.
return false;
}
parentNode = parentNode.parentNode;
}
assert(false);
}
_initMutationObserver() {
if (this.consumeConn) {
return new MutationObserver(async (records) => {
this._observer.disconnect();
let containers = this.renderings.map(([subId, {container}]) => container)
.filter(container => records.some(r => this.isDirectInnerSlot(container, r.target)));
if (containers.length > 0) {
this._innerContainerBySlotName = {};
containers.forEach(container => this.initInnerContainers(container));
this.updateProvidedContexts();
// Reactivate the observer.
containers.forEach(container => this._observe(container));
}
});
}
}
_eventMapper(eventHandler, node, eventName, handlerName) {
node.addEventListener(eventName, event => {
// TODO(sjmiles): we have an extremely minimalist approach to events here, this is useful IMO for
// finding the smallest set of features that we are going to need.
// First problem: click event firing multiple times as it bubbles up the tree, minimalist solution
// is to enforce a 'first listener' rule by executing `stopPropagation`.
event.stopPropagation();
// propagate keyboard information
const {altKey, ctrlKey, metaKey, shiftKey, code, key, repeat} = event;
eventHandler({
handler: handlerName,
data: {
// TODO(sjmiles): this is a data-key (as in key-value pair), may be confusing vs `keys`
key: node.key,
value: node.value,
keys: {altKey, ctrlKey, metaKey, shiftKey, code, key, repeat}
}
});
});
}
formatHostedContent(hostedSlot, content) {
if (content.templateName) {
if (typeof content.templateName == 'string') {
content.templateName = `${hostedSlot.consumeConn.particle.name}::${hostedSlot.consumeConn.name}::${content.templateName}`;
} else {
// TODO(mmandlis): add support for hosted particle rendering set slot.
assert(false, 'TODO: Implement this!');
}
}
return content;
}
}
| Replace inappropriate assert in dom slot. (#1718)
| runtime/slot-dom-consumer.js | Replace inappropriate assert in dom slot. (#1718) | <ide><path>untime/slot-dom-consumer.js
<ide> }
<ide> parentNode = parentNode.parentNode;
<ide> }
<del> assert(false);
<add> // innerContainer won't be a child node of container if the method is triggered
<add> // by mutation observer record and innerContainer was removed.
<add> return false;
<ide> }
<ide>
<ide> _initMutationObserver() { |
|
Java | agpl-3.0 | c015437fa07d83bd26278ee689af01604b76d539 | 0 | qiuyesuifeng/sql-layer,ngaut/sql-layer,shunwang/sql-layer-1,relateiq/sql-layer,wfxiang08/sql-layer-1,jaytaylor/sql-layer,relateiq/sql-layer,ngaut/sql-layer,relateiq/sql-layer,jaytaylor/sql-layer,shunwang/sql-layer-1,wfxiang08/sql-layer-1,wfxiang08/sql-layer-1,shunwang/sql-layer-1,shunwang/sql-layer-1,qiuyesuifeng/sql-layer,ngaut/sql-layer,ngaut/sql-layer,jaytaylor/sql-layer,qiuyesuifeng/sql-layer,wfxiang08/sql-layer-1,jaytaylor/sql-layer,relateiq/sql-layer,qiuyesuifeng/sql-layer | /**
* Copyright (C) 2009-2013 FoundationDB, LLC
*
* 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.foundationdb.server.store;
import com.foundationdb.ais.model.*;
import com.foundationdb.ais.util.TableChangeValidator.ChangeLevel;
import com.foundationdb.qp.operator.StoreAdapter;
import com.foundationdb.qp.persistitadapter.PersistitAdapter;
import com.foundationdb.qp.persistitadapter.PersistitHKey;
import com.foundationdb.qp.persistitadapter.indexrow.PersistitIndexRow;
import com.foundationdb.qp.persistitadapter.indexrow.PersistitIndexRowBuffer;
import com.foundationdb.qp.rowtype.IndexRowType;
import com.foundationdb.qp.rowtype.Schema;
import com.foundationdb.server.*;
import com.foundationdb.server.AccumulatorAdapter.AccumInfo;
import com.foundationdb.server.collation.CString;
import com.foundationdb.server.collation.CStringKeyCoder;
import com.foundationdb.server.error.*;
import com.foundationdb.server.error.DuplicateKeyException;
import com.foundationdb.server.rowdata.*;
import com.foundationdb.server.service.Service;
import com.foundationdb.server.service.config.ConfigurationService;
import com.foundationdb.server.service.listener.ListenerService;
import com.foundationdb.server.service.lock.LockService;
import com.foundationdb.server.service.session.Session;
import com.foundationdb.server.service.tree.TreeLink;
import com.foundationdb.server.service.tree.TreeService;
import com.google.inject.Inject;
import com.persistit.*;
import com.persistit.encoding.CoderManager;
import com.persistit.exception.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.*;
import static com.persistit.Key.EQ;
public class PersistitStore extends AbstractStore<Exchange> implements Service
{
private static final Logger LOG = LoggerFactory.getLogger(PersistitStore.class);
private static final String WRITE_LOCK_ENABLED_CONFIG = "fdbsql.write_lock_enabled";
private boolean writeLockEnabled;
private final ConfigurationService config;
private final TreeService treeService;
private final SchemaManager schemaManager;
private RowDataValueCoder valueCoder;
@Inject
public PersistitStore(TreeService treeService,
ConfigurationService config,
SchemaManager schemaManager,
LockService lockService,
ListenerService listenerService) {
super(lockService, schemaManager, listenerService);
this.treeService = treeService;
this.config = config;
this.schemaManager = schemaManager;
}
@Override
public synchronized void start() {
CoderManager cm = getDb().getCoderManager();
cm.registerValueCoder(RowData.class, valueCoder = new RowDataValueCoder());
cm.registerKeyCoder(CString.class, new CStringKeyCoder());
if (config != null) {
writeLockEnabled = Boolean.parseBoolean(config.getProperty(WRITE_LOCK_ENABLED_CONFIG));
}
}
@Override
public synchronized void stop() {
getDb().getCoderManager().unregisterValueCoder(RowData.class);
getDb().getCoderManager().unregisterKeyCoder(CString.class);
}
@Override
public void crash() {
stop();
}
@Override
public Key createKey() {
return treeService.createKey();
}
public Persistit getDb() {
return treeService.getDb();
}
public Exchange getExchange(Session session, Group group) {
return createStoreData(session, group);
}
public Exchange getExchange(final Session session, final RowDef rowDef) {
return createStoreData(session, rowDef.getGroup());
}
public Exchange getExchange(final Session session, final Index index) {
return createStoreData(session, index.indexDef());
}
public void releaseExchange(final Session session, final Exchange exchange) {
releaseStoreData(session, exchange);
}
private void constructIndexRow(Session session,
Exchange exchange,
RowData rowData,
Index index,
Key hKey,
PersistitIndexRowBuffer indexRow,
boolean forInsert) throws PersistitException
{
indexRow.resetForWrite(index, exchange.getKey(), exchange.getValue());
indexRow.initialize(rowData, hKey);
indexRow.close(session, this, forInsert);
}
@Override
protected Exchange createStoreData(Session session, TreeLink treeLink) {
return treeService.getExchange(session, treeLink);
}
@Override
protected void releaseStoreData(Session session, Exchange exchange) {
treeService.releaseExchange(session, exchange);
}
@Override
public PersistitIndexRowBuffer readIndexRow(Session session,
Index parentPKIndex,
Exchange exchange,
RowDef childRowDef,
RowData childRowData)
{
PersistitKeyAppender keyAppender = PersistitKeyAppender.create(exchange.getKey());
int[] fields = childRowDef.getParentJoinFields();
for (int fieldIndex = 0; fieldIndex < fields.length; fieldIndex++) {
FieldDef fieldDef = childRowDef.getFieldDef(fields[fieldIndex]);
keyAppender.append(fieldDef, childRowData);
}
try {
exchange.fetch();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
PersistitIndexRowBuffer indexRow = null;
if (exchange.getValue().isDefined()) {
indexRow = new PersistitIndexRowBuffer(this);
indexRow.resetForRead(parentPKIndex, exchange.getKey(), exchange.getValue());
}
return indexRow;
}
// --------------------- Implement Store interface --------------------
@Override
public void truncateIndexes(Session session, Collection<? extends Index> indexes) {
for(Index index : indexes) {
truncateTree(session, index.indexDef());
if(index.isGroupIndex()) {
try {
Tree tree = index.indexDef().getTreeCache().getTree();
new AccumulatorAdapter(AccumulatorAdapter.AccumInfo.ROW_COUNT, tree).set(0);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
}
}
private void checkNotGroupIndex(Index index) {
if (index.isGroupIndex()) {
throw new UnsupportedOperationException("can't update group indexes from PersistitStore: " + index);
}
}
@Override
protected void writeIndexRow(Session session,
Index index,
RowData rowData,
Key hKey,
PersistitIndexRowBuffer indexRow)
{
checkNotGroupIndex(index);
Exchange iEx = getExchange(session, index);
try {
constructIndexRow(session, iEx, rowData, index, hKey, indexRow, true);
checkUniqueness(index, rowData, iEx);
iEx.store();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, iEx);
}
}
private void checkUniqueness(Index index, RowData rowData, Exchange iEx) throws PersistitException
{
if (index.isUnique() && !hasNullIndexSegments(rowData, index)) {
Key key = iEx.getKey();
int segmentCount = index.indexDef().getIndexKeySegmentCount();
// An index that isUniqueAndMayContainNulls has the extra null-separating field.
if (index.isUniqueAndMayContainNulls()) {
segmentCount++;
}
key.setDepth(segmentCount);
if (keyExistsInIndex(index, iEx)) {
throw new DuplicateKeyException(index.getIndexName().getName(), key);
}
}
}
private boolean keyExistsInIndex(Index index, Exchange exchange) throws PersistitException
{
boolean keyExistsInIndex;
// Passing -1 as the last argument of traverse leaves the exchange's key and value unmodified.
// (0 would leave just the value unmodified.)
if (index.isUnique()) {
// The Persistit Key stores exactly the index key, so just check whether the key exists.
// TODO:
// The right thing to do is traverse(EQ, false, -1) but that returns true, even when the
// tree is empty. Peter says this is a bug (1023549)
keyExistsInIndex = exchange.traverse(Key.Direction.EQ, true, -1);
} else {
// Check for children by traversing forward from the current key.
keyExistsInIndex = exchange.traverse(Key.Direction.GTEQ, true, -1);
}
return keyExistsInIndex;
}
private void deleteIndexRow(Session session,
Index index,
Exchange exchange,
RowData rowData,
Key hKey,
PersistitIndexRowBuffer indexRowBuffer)
throws PersistitException
{
// Non-unique index: The exchange's key has all fields of the index row. If there is such a row it will be
// deleted, if not, exchange.remove() does nothing.
// PK index: The exchange's key has the key fields of the index row, and a null separator of 0. If there is
// such a row it will be deleted, if not, exchange.remove() does nothing. Because PK columns are NOT NULL,
// the null separator's value must be 0.
// Unique index with no nulls: Like the PK case.
// Unique index with nulls: isUniqueAndMayContainNulls is true. The exchange's key is written with the
// key of the index row. There may be duplicates due to nulls, and they will have different null separator
// values and the hkeys will differ. Look through these until the desired hkey is found, and delete that
// row. If the hkey is missing, then the row is already not present.
boolean deleted = false;
PersistitAdapter adapter = adapter(session);
if (index.isUniqueAndMayContainNulls()) {
// Can't use a PIRB, because we need to get the hkey. Need a PersistitIndexRow.
IndexRowType indexRowType = adapter.schema().indexRowType(index);
PersistitIndexRow indexRow = adapter.takeIndexRow(indexRowType);
constructIndexRow(session, exchange, rowData, index, hKey, indexRow, false);
Key.Direction direction = Key.Direction.GTEQ;
while (exchange.traverse(direction, true)) {
// Delicate: copyFromExchange() initializes the key returned by hKey
indexRow.copyFrom(exchange);
PersistitHKey rowHKey = (PersistitHKey)indexRow.hKey();
if (rowHKey.key().compareTo(hKey) == 0) {
deleted = exchange.remove();
break;
}
direction = Key.Direction.GT;
}
adapter.returnIndexRow(indexRow);
} else {
constructIndexRow(session, exchange, rowData, index, hKey, indexRowBuffer, false);
deleted = exchange.remove();
}
assert deleted : "Exchange remove on deleteIndexRow";
}
@Override
protected void deleteIndexRow(Session session,
Index index,
RowData rowData,
Key hKey,
PersistitIndexRowBuffer indexRowBuffer) {
checkNotGroupIndex(index);
Exchange iEx = getExchange(session, index);
try {
deleteIndexRow(session, index, iEx, rowData, hKey, indexRowBuffer);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, iEx);
}
}
@Override
public void packRowData(Exchange ex, RowData rowData) {
Value value = ex.getValue();
value.directPut(valueCoder, rowData, null);
}
@Override
public void store(Session session, Exchange ex) {
try {
ex.store();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
protected boolean fetch(Session session, Exchange ex) {
try {
// ex.isValueDefined() doesn't actually fetch the value
// ex.fetch() + ex.getValue().isDefined() would give false negatives (i.e. stored key with no value)
return ex.traverse(EQ, true, Integer.MAX_VALUE);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
protected boolean clear(Session session, Exchange ex) {
try {
return ex.remove();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
void resetForWrite(Exchange ex, Index index, PersistitIndexRowBuffer indexRowBuffer) {
indexRowBuffer.resetForWrite(index, ex.getKey(), ex.getValue());
}
@Override
protected Iterator<Void> createDescendantIterator(final Session session, final Exchange ex) {
final Key hKey = ex.getKey();
final KeyFilter filter = new KeyFilter(hKey, hKey.getDepth() + 1, Integer.MAX_VALUE);
return new Iterator<Void>() {
private Boolean lastExNext = null;
@Override
public boolean hasNext() {
if(lastExNext == null) {
next();
}
return lastExNext;
}
@Override
public Void next() {
if(lastExNext != null) {
lastExNext = null;
} else {
try {
lastExNext = ex.next(filter);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
return null;
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
};
}
@Override
protected void sumAddGICount(Session session, Exchange ex, GroupIndex index, int count) {
AccumulatorAdapter.sumAdd(AccumulatorAdapter.AccumInfo.ROW_COUNT, ex, count);
}
@Override
public void expandRowData(final Exchange exchange, final RowData rowData) {
final Value value = exchange.getValue();
try {
value.directGet(valueCoder, rowData, RowData.class, null);
}
catch(CorruptRowDataException e) {
LOG.error("Corrupt RowData at key {}: {}", exchange.getKey(), e.getMessage());
throw new RowDataCorruptionException(exchange.getKey());
}
// UNNECESSARY: Already done by value.directGet(...)
// rowData.prepareRow(0);
}
@Override
protected void preWrite(Session session, Exchange storeData, RowDef rowDef, RowData rowData) {
try {
lockKeys(adapter(session), rowDef, rowData, storeData);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
protected Key getKey(Session session, Exchange exchange) {
return exchange.getKey();
}
@Override
public void deleteSequences (Session session, Collection<? extends Sequence> sequences) {
removeTrees(session, sequences);
}
@Override
public void traverse(Session session, Group group, TreeRecordVisitor visitor) {
Exchange exchange = getExchange(session, group);
try {
exchange.clear().append(Key.BEFORE);
visitor.initialize(session, this);
while(exchange.next(true)) {
RowData rowData = new RowData();
expandRowData(exchange, rowData);
visitor.visit(exchange.getKey(), rowData);
}
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, exchange);
}
}
@Override
public <V extends IndexVisitor<Key,Value>> V traverse(Session session, Index index, V visitor, long scanTimeLimit, long sleepTime) {
Transaction xact = null;
long nextCommitTime = 0;
if (scanTimeLimit >= 0) {
xact = treeService.getTransaction(session);
nextCommitTime = System.currentTimeMillis() + scanTimeLimit;
}
Exchange exchange = getExchange(session, index).append(Key.BEFORE);
try {
while (exchange.next(true)) {
visitor.visit(exchange.getKey(), exchange.getValue());
if ((scanTimeLimit >= 0) &&
(System.currentTimeMillis() >= nextCommitTime)) {
xact.commit();
xact.end();
if (sleepTime > 0) {
try {
Thread.sleep(sleepTime);
}
catch (InterruptedException ex) {
throw new QueryCanceledException(session);
}
}
xact.begin();
nextCommitTime = System.currentTimeMillis() + scanTimeLimit;
}
}
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, exchange);
}
return visitor;
}
private static PersistitAdapter adapter(Session session)
{
return (PersistitAdapter) session.get(StoreAdapter.STORE_ADAPTER_KEY);
}
private void lockKeys(PersistitAdapter adapter, RowDef rowDef, RowData rowData, Exchange exchange)
throws PersistitException
{
// Temporary fix for #1118871 and #1078331
// disable the lock used to prevent write skew for some cases of data loading
if (!writeLockEnabled) return;
UserTable table = rowDef.userTable();
// Make fieldDefs big enough to accommodate PK field defs and FK field defs
FieldDef[] fieldDefs = new FieldDef[table.getColumnsIncludingInternal().size()];
Key lockKey = adapter.newKey();
PersistitKeyAppender lockKeyAppender = PersistitKeyAppender.create(lockKey);
// Primary key
List<Column> pkColumns = table.getPrimaryKeyIncludingInternal().getColumns();
for (int c = 0; c < pkColumns.size(); c++) {
fieldDefs[c] = rowDef.getFieldDef(c);
}
lockKey(rowData, table, fieldDefs, pkColumns.size(), lockKeyAppender, exchange);
// Grouping foreign key
Join parentJoin = table.getParentJoin();
if (parentJoin != null) {
List<JoinColumn> joinColumns = parentJoin.getJoinColumns();
for (int c = 0; c < joinColumns.size(); c++) {
fieldDefs[c] = rowDef.getFieldDef(joinColumns.get(c).getChild().getPosition());
}
lockKey(rowData, parentJoin.getParent(), fieldDefs, joinColumns.size(), lockKeyAppender, exchange);
}
}
private void lockKey(RowData rowData,
UserTable lockTable,
FieldDef[] fieldDefs,
int nFields,
PersistitKeyAppender lockKeyAppender,
Exchange exchange)
throws PersistitException
{
// Write ordinal id to the lock key
lockKeyAppender.key().append(lockTable.getOrdinal());
// Write column values to the lock key
for (int f = 0; f < nFields; f++) {
lockKeyAppender.append(fieldDefs[f], rowData);
}
exchange.lock(lockKeyAppender.key());
lockKeyAppender.clear();
}
@Override
public PersistitAdapter createAdapter(Session session, Schema schema) {
return new PersistitAdapter(schema, this, treeService, session, config);
}
@Override
public boolean treeExists(Session session, String schemaName, String treeName) {
return treeService.treeExists(schemaName, treeName);
}
@Override
public boolean isRetryableException(Throwable t) {
if (t instanceof PersistitAdapterException) {
t = t.getCause();
}
return (t instanceof RollbackException);
}
@Override
public long nullIndexSeparatorValue(Session session, Index index) {
Tree tree = index.indexDef().getTreeCache().getTree();
AccumulatorAdapter accumulator = new AccumulatorAdapter(AccumulatorAdapter.AccumInfo.UNIQUE_ID, tree);
return accumulator.seqAllocate();
}
@Override
public void finishedAlter(Session session, Map<TableName, TableName> tableNames, ChangeLevel changeLevel) {
// None
}
@Override
public void truncateTree(Session session, TreeLink treeLink) {
Exchange iEx = treeService.getExchange(session, treeLink);
try {
iEx.removeAll();
} catch (PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, iEx);
}
}
@Override
public void removeTree(Session session, TreeLink treeLink) {
try {
if(!schemaManager.treeRemovalIsDelayed()) {
Exchange ex = treeService.getExchange(session, treeLink);
ex.removeTree();
// Do not releaseExchange, causes caching and leak for now unused tree
}
schemaManager.treeWasRemoved(session, treeLink.getSchemaName(), treeLink.getTreeName());
} catch (PersistitException | RollbackException e) {
LOG.debug("Exception removing tree from Persistit", e);
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
public long nextSequenceValue(Session session, Sequence sequence) {
// Note: Ever increasing, always incremented by 1, rollbacks will leave gaps. See bug1167045 for discussion.
AccumulatorAdapter accum = getAdapter(sequence);
long rawSequence = accum.seqAllocate();
return sequence.realValueForRawNumber(rawSequence);
}
@Override
public long curSequenceValue(Session session, Sequence sequence) {
AccumulatorAdapter accum = getAdapter(sequence);
try {
return sequence.realValueForRawNumber(accum.getSnapshot());
} catch (PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
private AccumulatorAdapter getAdapter(Sequence sequence) {
Tree tree = sequence.getTreeCache().getTree();
return new AccumulatorAdapter(AccumInfo.SEQUENCE, tree);
}
@Override
public String getName() {
return "Persistit " + getDb().version();
}
}
| src/main/java/com/foundationdb/server/store/PersistitStore.java | /**
* Copyright (C) 2009-2013 FoundationDB, LLC
*
* 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.foundationdb.server.store;
import com.foundationdb.ais.model.*;
import com.foundationdb.ais.util.TableChangeValidator.ChangeLevel;
import com.foundationdb.qp.operator.StoreAdapter;
import com.foundationdb.qp.persistitadapter.PersistitAdapter;
import com.foundationdb.qp.persistitadapter.PersistitHKey;
import com.foundationdb.qp.persistitadapter.indexrow.PersistitIndexRow;
import com.foundationdb.qp.persistitadapter.indexrow.PersistitIndexRowBuffer;
import com.foundationdb.qp.rowtype.IndexRowType;
import com.foundationdb.qp.rowtype.Schema;
import com.foundationdb.server.*;
import com.foundationdb.server.AccumulatorAdapter.AccumInfo;
import com.foundationdb.server.collation.CString;
import com.foundationdb.server.collation.CStringKeyCoder;
import com.foundationdb.server.error.*;
import com.foundationdb.server.error.DuplicateKeyException;
import com.foundationdb.server.rowdata.*;
import com.foundationdb.server.service.Service;
import com.foundationdb.server.service.config.ConfigurationService;
import com.foundationdb.server.service.listener.ListenerService;
import com.foundationdb.server.service.lock.LockService;
import com.foundationdb.server.service.session.Session;
import com.foundationdb.server.service.tree.TreeLink;
import com.foundationdb.server.service.tree.TreeService;
import com.google.inject.Inject;
import com.persistit.*;
import com.persistit.Management.DisplayFilter;
import com.persistit.encoding.CoderManager;
import com.persistit.exception.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.rmi.RemoteException;
import java.util.*;
import static com.persistit.Key.EQ;
public class PersistitStore extends AbstractStore<Exchange> implements Service
{
private static final Logger LOG = LoggerFactory.getLogger(PersistitStore.class);
private static final String WRITE_LOCK_ENABLED_CONFIG = "fdbsql.write_lock_enabled";
private boolean writeLockEnabled;
private final ConfigurationService config;
private final TreeService treeService;
private final SchemaManager schemaManager;
private RowDataValueCoder valueCoder;
@Inject
public PersistitStore(TreeService treeService,
ConfigurationService config,
SchemaManager schemaManager,
LockService lockService,
ListenerService listenerService) {
super(lockService, schemaManager, listenerService);
this.treeService = treeService;
this.config = config;
this.schemaManager = schemaManager;
}
@Override
public synchronized void start() {
CoderManager cm = getDb().getCoderManager();
cm.registerValueCoder(RowData.class, valueCoder = new RowDataValueCoder());
cm.registerKeyCoder(CString.class, new CStringKeyCoder());
if (config != null) {
writeLockEnabled = Boolean.parseBoolean(config.getProperty(WRITE_LOCK_ENABLED_CONFIG));
}
}
@Override
public synchronized void stop() {
getDb().getCoderManager().unregisterValueCoder(RowData.class);
getDb().getCoderManager().unregisterKeyCoder(CString.class);
}
@Override
public void crash() {
stop();
}
@Override
public Key createKey() {
return treeService.createKey();
}
public Persistit getDb() {
return treeService.getDb();
}
public Exchange getExchange(Session session, Group group) {
return createStoreData(session, group);
}
public Exchange getExchange(final Session session, final RowDef rowDef) {
return createStoreData(session, rowDef.getGroup());
}
public Exchange getExchange(final Session session, final Index index) {
return createStoreData(session, index.indexDef());
}
public void releaseExchange(final Session session, final Exchange exchange) {
releaseStoreData(session, exchange);
}
private void constructIndexRow(Session session,
Exchange exchange,
RowData rowData,
Index index,
Key hKey,
PersistitIndexRowBuffer indexRow,
boolean forInsert) throws PersistitException
{
indexRow.resetForWrite(index, exchange.getKey(), exchange.getValue());
indexRow.initialize(rowData, hKey);
indexRow.close(session, this, forInsert);
}
@Override
protected Exchange createStoreData(Session session, TreeLink treeLink) {
return treeService.getExchange(session, treeLink);
}
@Override
protected void releaseStoreData(Session session, Exchange exchange) {
treeService.releaseExchange(session, exchange);
}
@Override
public PersistitIndexRowBuffer readIndexRow(Session session,
Index parentPKIndex,
Exchange exchange,
RowDef childRowDef,
RowData childRowData)
{
PersistitKeyAppender keyAppender = PersistitKeyAppender.create(exchange.getKey());
int[] fields = childRowDef.getParentJoinFields();
for (int fieldIndex = 0; fieldIndex < fields.length; fieldIndex++) {
FieldDef fieldDef = childRowDef.getFieldDef(fields[fieldIndex]);
keyAppender.append(fieldDef, childRowData);
}
try {
exchange.fetch();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
PersistitIndexRowBuffer indexRow = null;
if (exchange.getValue().isDefined()) {
indexRow = new PersistitIndexRowBuffer(this);
indexRow.resetForRead(parentPKIndex, exchange.getKey(), exchange.getValue());
}
return indexRow;
}
// --------------------- Implement Store interface --------------------
@Override
public void truncateIndexes(Session session, Collection<? extends Index> indexes) {
for(Index index : indexes) {
truncateTree(session, index.indexDef());
if(index.isGroupIndex()) {
try {
Tree tree = index.indexDef().getTreeCache().getTree();
new AccumulatorAdapter(AccumulatorAdapter.AccumInfo.ROW_COUNT, tree).set(0);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
}
}
private void checkNotGroupIndex(Index index) {
if (index.isGroupIndex()) {
throw new UnsupportedOperationException("can't update group indexes from PersistitStore: " + index);
}
}
@Override
protected void writeIndexRow(Session session,
Index index,
RowData rowData,
Key hKey,
PersistitIndexRowBuffer indexRow)
{
checkNotGroupIndex(index);
Exchange iEx = getExchange(session, index);
try {
constructIndexRow(session, iEx, rowData, index, hKey, indexRow, true);
checkUniqueness(index, rowData, iEx);
iEx.store();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, iEx);
}
}
private void checkUniqueness(Index index, RowData rowData, Exchange iEx) throws PersistitException
{
if (index.isUnique() && !hasNullIndexSegments(rowData, index)) {
Key key = iEx.getKey();
int segmentCount = index.indexDef().getIndexKeySegmentCount();
// An index that isUniqueAndMayContainNulls has the extra null-separating field.
if (index.isUniqueAndMayContainNulls()) {
segmentCount++;
}
key.setDepth(segmentCount);
if (keyExistsInIndex(index, iEx)) {
throw new DuplicateKeyException(index.getIndexName().getName(), key);
}
}
}
private boolean keyExistsInIndex(Index index, Exchange exchange) throws PersistitException
{
boolean keyExistsInIndex;
// Passing -1 as the last argument of traverse leaves the exchange's key and value unmodified.
// (0 would leave just the value unmodified.)
if (index.isUnique()) {
// The Persistit Key stores exactly the index key, so just check whether the key exists.
// TODO:
// The right thing to do is traverse(EQ, false, -1) but that returns true, even when the
// tree is empty. Peter says this is a bug (1023549)
keyExistsInIndex = exchange.traverse(Key.Direction.EQ, true, -1);
} else {
// Check for children by traversing forward from the current key.
keyExistsInIndex = exchange.traverse(Key.Direction.GTEQ, true, -1);
}
return keyExistsInIndex;
}
private void deleteIndexRow(Session session,
Index index,
Exchange exchange,
RowData rowData,
Key hKey,
PersistitIndexRowBuffer indexRowBuffer)
throws PersistitException
{
// Non-unique index: The exchange's key has all fields of the index row. If there is such a row it will be
// deleted, if not, exchange.remove() does nothing.
// PK index: The exchange's key has the key fields of the index row, and a null separator of 0. If there is
// such a row it will be deleted, if not, exchange.remove() does nothing. Because PK columns are NOT NULL,
// the null separator's value must be 0.
// Unique index with no nulls: Like the PK case.
// Unique index with nulls: isUniqueAndMayContainNulls is true. The exchange's key is written with the
// key of the index row. There may be duplicates due to nulls, and they will have different null separator
// values and the hkeys will differ. Look through these until the desired hkey is found, and delete that
// row. If the hkey is missing, then the row is already not present.
boolean deleted = false;
PersistitAdapter adapter = adapter(session);
if (index.isUniqueAndMayContainNulls()) {
// Can't use a PIRB, because we need to get the hkey. Need a PersistitIndexRow.
IndexRowType indexRowType = adapter.schema().indexRowType(index);
PersistitIndexRow indexRow = adapter.takeIndexRow(indexRowType);
constructIndexRow(session, exchange, rowData, index, hKey, indexRow, false);
Key.Direction direction = Key.Direction.GTEQ;
while (exchange.traverse(direction, true)) {
// Delicate: copyFromExchange() initializes the key returned by hKey
indexRow.copyFrom(exchange);
PersistitHKey rowHKey = (PersistitHKey)indexRow.hKey();
if (rowHKey.key().compareTo(hKey) == 0) {
deleted = exchange.remove();
break;
}
direction = Key.Direction.GT;
}
adapter.returnIndexRow(indexRow);
} else {
constructIndexRow(session, exchange, rowData, index, hKey, indexRowBuffer, false);
deleted = exchange.remove();
}
assert deleted : "Exchange remove on deleteIndexRow";
}
@Override
protected void deleteIndexRow(Session session,
Index index,
RowData rowData,
Key hKey,
PersistitIndexRowBuffer indexRowBuffer) {
checkNotGroupIndex(index);
Exchange iEx = getExchange(session, index);
try {
deleteIndexRow(session, index, iEx, rowData, hKey, indexRowBuffer);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, iEx);
}
}
@Override
public void packRowData(Exchange ex, RowData rowData) {
Value value = ex.getValue();
value.directPut(valueCoder, rowData, null);
}
@Override
public void store(Session session, Exchange ex) {
try {
ex.store();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
protected boolean fetch(Session session, Exchange ex) {
try {
// ex.isValueDefined() doesn't actually fetch the value
// ex.fetch() + ex.getValue().isDefined() would give false negatives (i.e. stored key with no value)
return ex.traverse(EQ, true, Integer.MAX_VALUE);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
protected boolean clear(Session session, Exchange ex) {
try {
return ex.remove();
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
void resetForWrite(Exchange ex, Index index, PersistitIndexRowBuffer indexRowBuffer) {
indexRowBuffer.resetForWrite(index, ex.getKey(), ex.getValue());
}
@Override
protected Iterator<Void> createDescendantIterator(final Session session, final Exchange ex) {
final Key hKey = ex.getKey();
final KeyFilter filter = new KeyFilter(hKey, hKey.getDepth() + 1, Integer.MAX_VALUE);
return new Iterator<Void>() {
private Boolean lastExNext = null;
@Override
public boolean hasNext() {
if(lastExNext == null) {
next();
}
return lastExNext;
}
@Override
public Void next() {
if(lastExNext != null) {
lastExNext = null;
} else {
try {
lastExNext = ex.next(filter);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
return null;
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
};
}
@Override
protected void sumAddGICount(Session session, Exchange ex, GroupIndex index, int count) {
AccumulatorAdapter.sumAdd(AccumulatorAdapter.AccumInfo.ROW_COUNT, ex, count);
}
@Override
public void expandRowData(final Exchange exchange, final RowData rowData) {
final Value value = exchange.getValue();
try {
value.directGet(valueCoder, rowData, RowData.class, null);
}
catch(CorruptRowDataException e) {
LOG.error("Corrupt RowData at key {}: {}", exchange.getKey(), e.getMessage());
throw new RowDataCorruptionException(exchange.getKey());
}
// UNNECESSARY: Already done by value.directGet(...)
// rowData.prepareRow(0);
}
@Override
protected void preWrite(Session session, Exchange storeData, RowDef rowDef, RowData rowData) {
try {
lockKeys(adapter(session), rowDef, rowData, storeData);
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
protected Key getKey(Session session, Exchange exchange) {
return exchange.getKey();
}
@Override
public void deleteSequences (Session session, Collection<? extends Sequence> sequences) {
removeTrees(session, sequences);
}
@Override
public void traverse(Session session, Group group, TreeRecordVisitor visitor) {
Exchange exchange = getExchange(session, group);
try {
exchange.clear().append(Key.BEFORE);
visitor.initialize(session, this);
while(exchange.next(true)) {
RowData rowData = new RowData();
expandRowData(exchange, rowData);
visitor.visit(exchange.getKey(), rowData);
}
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, exchange);
}
}
@Override
public <V extends IndexVisitor<Key,Value>> V traverse(Session session, Index index, V visitor, long scanTimeLimit, long sleepTime) {
Transaction xact = null;
long nextCommitTime = 0;
if (scanTimeLimit >= 0) {
xact = treeService.getTransaction(session);
nextCommitTime = System.currentTimeMillis() + scanTimeLimit;
}
Exchange exchange = getExchange(session, index).append(Key.BEFORE);
try {
while (exchange.next(true)) {
visitor.visit(exchange.getKey(), exchange.getValue());
if ((scanTimeLimit >= 0) &&
(System.currentTimeMillis() >= nextCommitTime)) {
xact.commit();
xact.end();
if (sleepTime > 0) {
try {
Thread.sleep(sleepTime);
}
catch (InterruptedException ex) {
throw new QueryCanceledException(session);
}
}
xact.begin();
nextCommitTime = System.currentTimeMillis() + scanTimeLimit;
}
}
} catch(PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, exchange);
}
return visitor;
}
private static PersistitAdapter adapter(Session session)
{
return (PersistitAdapter) session.get(StoreAdapter.STORE_ADAPTER_KEY);
}
private void lockKeys(PersistitAdapter adapter, RowDef rowDef, RowData rowData, Exchange exchange)
throws PersistitException
{
// Temporary fix for #1118871 and #1078331
// disable the lock used to prevent write skew for some cases of data loading
if (!writeLockEnabled) return;
UserTable table = rowDef.userTable();
// Make fieldDefs big enough to accommodate PK field defs and FK field defs
FieldDef[] fieldDefs = new FieldDef[table.getColumnsIncludingInternal().size()];
Key lockKey = adapter.newKey();
PersistitKeyAppender lockKeyAppender = PersistitKeyAppender.create(lockKey);
// Primary key
List<Column> pkColumns = table.getPrimaryKeyIncludingInternal().getColumns();
for (int c = 0; c < pkColumns.size(); c++) {
fieldDefs[c] = rowDef.getFieldDef(c);
}
lockKey(rowData, table, fieldDefs, pkColumns.size(), lockKeyAppender, exchange);
// Grouping foreign key
Join parentJoin = table.getParentJoin();
if (parentJoin != null) {
List<JoinColumn> joinColumns = parentJoin.getJoinColumns();
for (int c = 0; c < joinColumns.size(); c++) {
fieldDefs[c] = rowDef.getFieldDef(joinColumns.get(c).getChild().getPosition());
}
lockKey(rowData, parentJoin.getParent(), fieldDefs, joinColumns.size(), lockKeyAppender, exchange);
}
}
private void lockKey(RowData rowData,
UserTable lockTable,
FieldDef[] fieldDefs,
int nFields,
PersistitKeyAppender lockKeyAppender,
Exchange exchange)
throws PersistitException
{
// Write ordinal id to the lock key
lockKeyAppender.key().append(lockTable.getOrdinal());
// Write column values to the lock key
for (int f = 0; f < nFields; f++) {
lockKeyAppender.append(fieldDefs[f], rowData);
}
exchange.lock(lockKeyAppender.key());
lockKeyAppender.clear();
}
@Override
public PersistitAdapter createAdapter(Session session, Schema schema) {
return new PersistitAdapter(schema, this, treeService, session, config);
}
@Override
public boolean treeExists(Session session, String schemaName, String treeName) {
return treeService.treeExists(schemaName, treeName);
}
@Override
public boolean isRetryableException(Throwable t) {
if (t instanceof PersistitAdapterException) {
t = t.getCause();
}
return (t instanceof RollbackException);
}
@Override
public long nullIndexSeparatorValue(Session session, Index index) {
Tree tree = index.indexDef().getTreeCache().getTree();
AccumulatorAdapter accumulator = new AccumulatorAdapter(AccumulatorAdapter.AccumInfo.UNIQUE_ID, tree);
return accumulator.seqAllocate();
}
@Override
public void finishedAlter(Session session, Map<TableName, TableName> tableNames, ChangeLevel changeLevel) {
// None
}
@Override
public void truncateTree(Session session, TreeLink treeLink) {
Exchange iEx = treeService.getExchange(session, treeLink);
try {
iEx.removeAll();
} catch (PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
} finally {
releaseExchange(session, iEx);
}
}
@Override
public void removeTree(Session session, TreeLink treeLink) {
try {
if(!schemaManager.treeRemovalIsDelayed()) {
Exchange ex = treeService.getExchange(session, treeLink);
ex.removeTree();
// Do not releaseExchange, causes caching and leak for now unused tree
}
schemaManager.treeWasRemoved(session, treeLink.getSchemaName(), treeLink.getTreeName());
} catch (PersistitException | RollbackException e) {
LOG.debug("Exception removing tree from Persistit", e);
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
@Override
public long nextSequenceValue(Session session, Sequence sequence) {
// Note: Ever increasing, always incremented by 1, rollbacks will leave gaps. See bug1167045 for discussion.
AccumulatorAdapter accum = getAdapter(sequence);
long rawSequence = accum.seqAllocate();
return sequence.realValueForRawNumber(rawSequence);
}
@Override
public long curSequenceValue(Session session, Sequence sequence) {
AccumulatorAdapter accum = getAdapter(sequence);
try {
return sequence.realValueForRawNumber(accum.getSnapshot());
} catch (PersistitException | RollbackException e) {
throw PersistitAdapter.wrapPersistitException(session, e);
}
}
private AccumulatorAdapter getAdapter(Sequence sequence) {
Tree tree = sequence.getTreeCache().getTree();
return new AccumulatorAdapter(AccumInfo.SEQUENCE, tree);
}
@Override
public String getName() {
return "Persistit " + getDb().version();
}
}
| Import cleanup
| src/main/java/com/foundationdb/server/store/PersistitStore.java | Import cleanup | <ide><path>rc/main/java/com/foundationdb/server/store/PersistitStore.java
<ide> import com.foundationdb.server.service.tree.TreeService;
<ide> import com.google.inject.Inject;
<ide> import com.persistit.*;
<del>import com.persistit.Management.DisplayFilter;
<ide> import com.persistit.encoding.CoderManager;
<ide> import com.persistit.exception.*;
<ide>
<ide> import org.slf4j.Logger;
<ide> import org.slf4j.LoggerFactory;
<ide>
<del>import java.rmi.RemoteException;
<ide> import java.util.*;
<ide>
<ide> import static com.persistit.Key.EQ; |
|
Java | apache-2.0 | error: pathspec 'Aplicativo.java' did not match any file(s) known to git
| 32903e8c8347c30dbe9f70fc625dce2375eb62bb | 1 | JohnnyRedfox/Dietas | import java.awt.BorderLayout;
import java.awt.FlowLayout;
import javax.swing.JFrame;
import javax.swing.SwingConstants;
public class Aplicativo {
public static void main(String[] args) {
JTextFields janela = new JTextFields();
janela.setLayout(new FlowLayout(SwingConstants.CENTER));
janela.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
janela.setSize(550, 250);
janela.setVisible(true);
}
}
| Aplicativo.java | Aplicativo
Classe que contém a main | Aplicativo.java | Aplicativo | <ide><path>plicativo.java
<add>import java.awt.BorderLayout;
<add>import java.awt.FlowLayout;
<add>
<add>import javax.swing.JFrame;
<add>import javax.swing.SwingConstants;
<add>
<add>
<add>public class Aplicativo {
<add> public static void main(String[] args) {
<add>
<add> JTextFields janela = new JTextFields();
<add> janela.setLayout(new FlowLayout(SwingConstants.CENTER));
<add> janela.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
<add> janela.setSize(550, 250);
<add> janela.setVisible(true);
<add>
<add> }
<add>} |
|
Java | apache-2.0 | 94b9fa44866f750d713a07861b5576e2400f9885 | 0 | lakmali/product-apim,hevayo/product-apim,chamilaadhi/product-apim,thilinicooray/product-apim,amalkasubasinghe/product-apim,pradeepmurugesan/product-apim,hevayo/product-apim,rswijesena/product-apim,jaadds/product-apim,dewmini/product-apim,amalkasubasinghe/product-apim,pradeepmurugesan/product-apim,chamilaadhi/product-apim,irhamiqbal/product-apim,dhanuka84/product-apim,jaadds/product-apim,abimarank/product-apim,tharikaGitHub/product-apim,dhanuka84/product-apim,hevayo/product-apim,nu1silva/product-apim,chamilaadhi/product-apim,jaadds/product-apim,amalkasubasinghe/product-apim,dhanuka84/product-apim,tharikaGitHub/product-apim,chamilaadhi/product-apim,nu1silva/product-apim,irhamiqbal/product-apim,ChamNDeSilva/product-apim,thilinicooray/product-apim,sambaheerathan/product-apim,nu1silva/product-apim,dewmini/product-apim,amalkasubasinghe/product-apim,tharindu1st/product-apim,chamilaadhi/product-apim,thilinicooray/product-apim,wso2/product-apim,nu1silva/product-apim,lakmali/product-apim,irhamiqbal/product-apim,hevayo/product-apim,tharikaGitHub/product-apim,wso2/product-apim,jaadds/product-apim,dewmini/product-apim,wso2/product-apim,dewmini/product-apim,ChamNDeSilva/product-apim,pradeepmurugesan/product-apim,sambaheerathan/product-apim,wso2/product-apim,irhamiqbal/product-apim,wso2/product-apim,tharikaGitHub/product-apim,dewmini/product-apim,pradeepmurugesan/product-apim,rswijesena/product-apim,tharikaGitHub/product-apim,nu1silva/product-apim,dhanuka84/product-apim,abimarank/product-apim,thilinicooray/product-apim | /*
*Copyright (c) 2015, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
*WSO2 Inc. 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.wso2.am.integration.tests.restapi.testcases;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Factory;
import org.testng.annotations.Test;
import org.wso2.am.integration.test.utils.base.APIMIntegrationBaseTest;
import org.wso2.am.integration.tests.restapi.RESTAPITestConstants;
import org.wso2.am.integration.tests.restapi.utils.RESTAPITestUtil;
import org.wso2.carbon.automation.engine.annotations.ExecutionEnvironment;
import org.wso2.carbon.automation.engine.annotations.SetEnvironment;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import java.io.File;
import static org.testng.Assert.assertTrue;
@SetEnvironment(executionEnvironments = {ExecutionEnvironment.STANDALONE})
public class TierTestCase extends APIMIntegrationBaseTest {
@Factory(dataProvider = "userModeDataProvider")
public TierTestCase(TestUserMode userMode) {
this.userMode = userMode;
}
@DataProvider
public static Object[][] userModeDataProvider() {
return new Object[][]{
new Object[]{TestUserMode.SUPER_TENANT_ADMIN}
};
}
@BeforeClass(alwaysRun = true)
public void setEnvironment() throws Exception {
super.init(userMode);
}
@Test(groups = {"wso2.am"}, description = "REST API Implementation test : Tier handling test case")
public void testTiers() {
String gatewayURL = getGatewayURLNhttp();
String keyManagerURL = getKeyManagerURLHttp();
//file name of the JSON data file related to : Tier handling test case
String dataFileName = "TierTestCase.txt";
String dataFilePath = (new File(System.getProperty("user.dir"))).getParent() +
RESTAPITestConstants.PATH_SUBSTRING + dataFileName;
boolean testSuccessStatus = new RESTAPITestUtil().testRestAPI(dataFilePath, gatewayURL, keyManagerURL);
assertTrue(testSuccessStatus);
}
@AfterClass(alwaysRun = true)
public void destroy() throws Exception {
super.cleanUp();
}
}
| modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/restapi/testcases/TierTestCase.java | /*
*Copyright (c) 2015, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
*WSO2 Inc. 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.wso2.am.integration.tests.restapi.testcases;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Factory;
import org.testng.annotations.Test;
import org.wso2.am.integration.test.utils.base.APIMIntegrationBaseTest;
import org.wso2.am.integration.tests.restapi.RESTAPITestConstants;
import org.wso2.am.integration.tests.restapi.utils.RESTAPITestUtil;
import org.wso2.carbon.automation.engine.annotations.ExecutionEnvironment;
import org.wso2.carbon.automation.engine.annotations.SetEnvironment;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import static org.testng.Assert.assertTrue;
@SetEnvironment(executionEnvironments = {ExecutionEnvironment.STANDALONE})
public class TierTestCase extends APIMIntegrationBaseTest {
@Factory(dataProvider = "userModeDataProvider")
public TierTestCase(TestUserMode userMode) {
this.userMode = userMode;
}
@DataProvider
public static Object[][] userModeDataProvider() {
return new Object[][]{
new Object[]{TestUserMode.SUPER_TENANT_ADMIN}
};
}
@BeforeClass(alwaysRun = true)
public void setEnvironment() throws Exception {
super.init(userMode);
}
@Test(groups = {"wso2.am"}, description = "REST API Implementation test : Tier handling test case")
public void testTiers() {
String gatewayURL = getGatewayURLNhttp();
String keyManagerURL = getKeyManagerURLHttp();
//file name of the JSON data file related to : Tier handling test case
String dataFileName = "TierTestCase.txt";
String dataFilePath = (new File(System.getProperty("user.dir"))).getParent() +
RESTAPITestConstants.PATH_SUBSTRING + dataFileName;
boolean testSuccessStatus = new RESTAPITestUtil().testRestAPI(dataFilePath, gatewayURL, keyManagerURL);
assertTrue(testSuccessStatus);
}
@AfterClass(alwaysRun = true)
public void destroy() throws Exception {
super.cleanUp();
}
}
| Remove unused imports in TierTestCase.java file
| modules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/restapi/testcases/TierTestCase.java | Remove unused imports in TierTestCase.java file | <ide><path>odules/integration/tests-integration/tests-backend/src/test/java/org/wso2/am/integration/tests/restapi/testcases/TierTestCase.java
<ide> import org.wso2.carbon.automation.engine.context.TestUserMode;
<ide>
<ide> import java.io.File;
<del>import java.nio.file.Path;
<del>import java.nio.file.Paths;
<ide>
<ide> import static org.testng.Assert.assertTrue;
<ide> |
|
Java | apache-2.0 | b2740e6d5272d87c3410db2532f7f40544a8ff04 | 0 | GerritCodeReview/plugins_x-docs,GerritCodeReview/plugins_x-docs | // Copyright (C) 2014 The Android Open Source Project
//
// 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.googlesource.gerrit.plugins.xdocs;
import com.google.gerrit.extensions.restapi.IdString;
import com.google.gerrit.reviewdb.client.Project;
import org.eclipse.jgit.lib.ObjectId;
import java.util.Objects;
public class XDocResourceKey {
private final String formatter;
private final Project.NameKey project;
private final String resource;
private final ObjectId revId;
private final ObjectId metaConfigRevId;
XDocResourceKey(String formatter, Project.NameKey project, String r,
ObjectId revId, ObjectId metaConfigRevId) {
this.formatter = formatter;
this.project = project;
this.resource = r;
this.revId = revId;
this.metaConfigRevId = metaConfigRevId;
}
public String getFormatter() {
return formatter;
}
public Project.NameKey getProject() {
return project;
}
public String getResource() {
return resource;
}
public ObjectId getRevId() {
return revId;
}
@Override
public int hashCode() {
return Objects.hash(formatter, project, resource, revId, metaConfigRevId);
}
@Override
public boolean equals(Object other) {
if (other instanceof XDocResourceKey) {
XDocResourceKey rk = (XDocResourceKey) other;
return Objects.equals(formatter, rk.formatter)
&& Objects.equals(project, rk.project)
&& Objects.equals(resource, rk.resource)
&& Objects.equals(revId, rk.revId)
&& Objects.equals(metaConfigRevId, rk.metaConfigRevId);
}
return false;
}
public String asString() {
StringBuilder b = new StringBuilder();
b.append(IdString.fromDecoded(formatter).encoded());
b.append("/");
b.append(IdString.fromDecoded(project.get()).encoded());
b.append("/");
b.append(resource != null ? IdString.fromDecoded(resource).encoded() : "");
b.append("/");
b.append(revId != null ? revId.name() : "");
b.append("/");
b.append(metaConfigRevId != null ? metaConfigRevId.name() : "");
return b.toString();
}
public static XDocResourceKey fromString(String str) {
String[] s = str.split("/");
String formatter = null;
String project = null;
String file = null;
String revision = null;
String metaConfigRevision = null;
if (s.length > 0) {
formatter = IdString.fromUrl(s[0]).get();
}
if (s.length > 1) {
project = IdString.fromUrl(s[1]).get();
}
if (s.length > 2) {
file = IdString.fromUrl(s[2]).get();
}
if (s.length > 3) {
revision = s[3];
}
if (s.length > 4) {
metaConfigRevision = s[4];
}
return new XDocResourceKey(formatter, new Project.NameKey(project), file,
toObjectId(revision), toObjectId(metaConfigRevision));
}
private static ObjectId toObjectId(String id) {
return id != null ? ObjectId.fromString(id) : null;
}
}
| src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocResourceKey.java | // Copyright (C) 2014 The Android Open Source Project
//
// 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.googlesource.gerrit.plugins.xdocs;
import com.google.common.base.Objects;
import com.google.gerrit.extensions.restapi.IdString;
import com.google.gerrit.reviewdb.client.Project;
import org.eclipse.jgit.lib.ObjectId;
public class XDocResourceKey {
private final String formatter;
private final Project.NameKey project;
private final String resource;
private final ObjectId revId;
private final ObjectId metaConfigRevId;
XDocResourceKey(String formatter, Project.NameKey project, String r,
ObjectId revId, ObjectId metaConfigRevId) {
this.formatter = formatter;
this.project = project;
this.resource = r;
this.revId = revId;
this.metaConfigRevId = metaConfigRevId;
}
public String getFormatter() {
return formatter;
}
public Project.NameKey getProject() {
return project;
}
public String getResource() {
return resource;
}
public ObjectId getRevId() {
return revId;
}
@Override
public int hashCode() {
return Objects.hashCode(formatter, project, resource, revId);
}
@Override
public boolean equals(Object other) {
if (other instanceof XDocResourceKey) {
XDocResourceKey rk = (XDocResourceKey) other;
return formatter.equals(rk.formatter) && project.equals(rk.project)
&& resource.equals(rk.resource) && revId.equals(rk.revId);
}
return false;
}
public String asString() {
StringBuilder b = new StringBuilder();
b.append(IdString.fromDecoded(formatter).encoded());
b.append("/");
b.append(IdString.fromDecoded(project.get()).encoded());
b.append("/");
b.append(resource != null ? IdString.fromDecoded(resource).encoded() : "");
b.append("/");
b.append(revId != null ? revId.name() : "");
b.append("/");
b.append(metaConfigRevId != null ? metaConfigRevId.name() : "");
return b.toString();
}
public static XDocResourceKey fromString(String str) {
String[] s = str.split("/");
String formatter = null;
String project = null;
String file = null;
String revision = null;
String metaConfigRevision = null;
if (s.length > 0) {
formatter = IdString.fromUrl(s[0]).get();
}
if (s.length > 1) {
project = IdString.fromUrl(s[1]).get();
}
if (s.length > 2) {
file = IdString.fromUrl(s[2]).get();
}
if (s.length > 3) {
revision = s[3];
}
if (s.length > 4) {
metaConfigRevision = s[4];
}
return new XDocResourceKey(formatter, new Project.NameKey(project), file,
toObjectId(revision), toObjectId(metaConfigRevision));
}
private static ObjectId toObjectId(String id) {
return id != null ? ObjectId.fromString(id) : null;
}
}
| Fix implementation of equals(...) and hashCode() in XDocResourceKey
Both methods ignored 'metaConfigRevId' and equals would have failed if
'rev' was null.
The new implementation uses java.util.Objects rather than
com.google.common.base.Objects. The JavaDoc of both methods in
com.google.common.base.Objects says that they should be treated as
deprecated and that the corresponding Java 7 methods in
java.util.Objects should be used instead.
Change-Id: Ic1f4d6b0b6480a6ac83ea84a6b63fe63210a8a87
Signed-off-by: Edwin Kempin <[email protected]>
| src/main/java/com/googlesource/gerrit/plugins/xdocs/XDocResourceKey.java | Fix implementation of equals(...) and hashCode() in XDocResourceKey | <ide><path>rc/main/java/com/googlesource/gerrit/plugins/xdocs/XDocResourceKey.java
<ide>
<ide> package com.googlesource.gerrit.plugins.xdocs;
<ide>
<del>import com.google.common.base.Objects;
<ide> import com.google.gerrit.extensions.restapi.IdString;
<ide> import com.google.gerrit.reviewdb.client.Project;
<ide>
<ide> import org.eclipse.jgit.lib.ObjectId;
<add>
<add>import java.util.Objects;
<ide>
<ide> public class XDocResourceKey {
<ide> private final String formatter;
<ide>
<ide> @Override
<ide> public int hashCode() {
<del> return Objects.hashCode(formatter, project, resource, revId);
<add> return Objects.hash(formatter, project, resource, revId, metaConfigRevId);
<ide> }
<ide>
<ide> @Override
<ide> public boolean equals(Object other) {
<ide> if (other instanceof XDocResourceKey) {
<ide> XDocResourceKey rk = (XDocResourceKey) other;
<del> return formatter.equals(rk.formatter) && project.equals(rk.project)
<del> && resource.equals(rk.resource) && revId.equals(rk.revId);
<add> return Objects.equals(formatter, rk.formatter)
<add> && Objects.equals(project, rk.project)
<add> && Objects.equals(resource, rk.resource)
<add> && Objects.equals(revId, rk.revId)
<add> && Objects.equals(metaConfigRevId, rk.metaConfigRevId);
<ide> }
<ide> return false;
<ide> } |
|
Java | apache-2.0 | ec25beb66066cbf5385cea36e2d96e9c81e030bd | 0 | ejona86/grpc-java,ejona86/grpc-java,dapengzhang0/grpc-java,stanley-cheung/grpc-java,dapengzhang0/grpc-java,dapengzhang0/grpc-java,ejona86/grpc-java,ejona86/grpc-java,grpc/grpc-java,stanley-cheung/grpc-java,grpc/grpc-java,grpc/grpc-java,grpc/grpc-java,dapengzhang0/grpc-java,stanley-cheung/grpc-java,stanley-cheung/grpc-java | /*
* Copyright 2016 The gRPC 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 io.grpc.grpclb;
import static com.google.common.truth.Truth.assertThat;
import static io.grpc.ConnectivityState.CONNECTING;
import static io.grpc.ConnectivityState.IDLE;
import static io.grpc.ConnectivityState.READY;
import static io.grpc.ConnectivityState.SHUTDOWN;
import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
import static io.grpc.grpclb.GrpclbState.BUFFER_ENTRY;
import static io.grpc.grpclb.GrpclbState.DROP_PICK_RESULT;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.AdditionalAnswers.delegatesTo;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import com.google.common.collect.Iterables;
import com.google.protobuf.ByteString;
import com.google.protobuf.util.Durations;
import com.google.protobuf.util.Timestamps;
import io.grpc.Attributes;
import io.grpc.ChannelLogger;
import io.grpc.ClientStreamTracer;
import io.grpc.ConnectivityState;
import io.grpc.ConnectivityStateInfo;
import io.grpc.EquivalentAddressGroup;
import io.grpc.LoadBalancer.Helper;
import io.grpc.LoadBalancer.PickResult;
import io.grpc.LoadBalancer.PickSubchannelArgs;
import io.grpc.LoadBalancer.ResolvedAddresses;
import io.grpc.LoadBalancer.Subchannel;
import io.grpc.LoadBalancer.SubchannelPicker;
import io.grpc.ManagedChannel;
import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.Status.Code;
import io.grpc.SynchronizationContext;
import io.grpc.grpclb.GrpclbState.BackendEntry;
import io.grpc.grpclb.GrpclbState.DropEntry;
import io.grpc.grpclb.GrpclbState.ErrorEntry;
import io.grpc.grpclb.GrpclbState.IdleSubchannelEntry;
import io.grpc.grpclb.GrpclbState.Mode;
import io.grpc.grpclb.GrpclbState.RoundRobinPicker;
import io.grpc.inprocess.InProcessChannelBuilder;
import io.grpc.inprocess.InProcessServerBuilder;
import io.grpc.internal.BackoffPolicy;
import io.grpc.internal.FakeClock;
import io.grpc.lb.v1.ClientStats;
import io.grpc.lb.v1.ClientStatsPerToken;
import io.grpc.lb.v1.FallbackResponse;
import io.grpc.lb.v1.InitialLoadBalanceRequest;
import io.grpc.lb.v1.InitialLoadBalanceResponse;
import io.grpc.lb.v1.LoadBalanceRequest;
import io.grpc.lb.v1.LoadBalanceResponse;
import io.grpc.lb.v1.LoadBalancerGrpc;
import io.grpc.lb.v1.Server;
import io.grpc.lb.v1.ServerList;
import io.grpc.stub.StreamObserver;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Nullable;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
/** Unit tests for {@link GrpclbLoadBalancer}. */
@RunWith(JUnit4.class)
public class GrpclbLoadBalancerTest {
private static final String SERVICE_AUTHORITY = "api.google.com";
// The tasks are wrapped by SynchronizationContext, so we can't compare the types
// directly.
private static final FakeClock.TaskFilter LOAD_REPORTING_TASK_FILTER =
new FakeClock.TaskFilter() {
@Override
public boolean shouldAccept(Runnable command) {
return command.toString().contains(GrpclbState.LoadReportingTask.class.getSimpleName());
}
};
private static final FakeClock.TaskFilter FALLBACK_MODE_TASK_FILTER =
new FakeClock.TaskFilter() {
@Override
public boolean shouldAccept(Runnable command) {
return command.toString().contains(GrpclbState.FallbackModeTask.class.getSimpleName());
}
};
private static final FakeClock.TaskFilter LB_RPC_RETRY_TASK_FILTER =
new FakeClock.TaskFilter() {
@Override
public boolean shouldAccept(Runnable command) {
return command.toString().contains(GrpclbState.LbRpcRetryTask.class.getSimpleName());
}
};
private static final Attributes LB_BACKEND_ATTRS =
Attributes.newBuilder().set(GrpclbConstants.ATTR_LB_PROVIDED_BACKEND, true).build();
@Mock
private Helper helper;
@Mock
private SubchannelPool subchannelPool;
private final ArrayList<String> logs = new ArrayList<>();
private final ChannelLogger channelLogger = new ChannelLogger() {
@Override
public void log(ChannelLogLevel level, String msg) {
logs.add(level + ": " + msg);
}
@Override
public void log(ChannelLogLevel level, String template, Object... args) {
log(level, MessageFormat.format(template, args));
}
};
private SubchannelPicker currentPicker;
private LoadBalancerGrpc.LoadBalancerImplBase mockLbService;
@Captor
private ArgumentCaptor<StreamObserver<LoadBalanceResponse>> lbResponseObserverCaptor;
private final FakeClock fakeClock = new FakeClock();
private final LinkedList<StreamObserver<LoadBalanceRequest>> lbRequestObservers =
new LinkedList<>();
private final LinkedList<Subchannel> mockSubchannels = new LinkedList<>();
private final LinkedList<ManagedChannel> fakeOobChannels = new LinkedList<>();
private final ArrayList<Subchannel> pooledSubchannelTracker = new ArrayList<>();
private final ArrayList<Subchannel> unpooledSubchannelTracker = new ArrayList<>();
private final ArrayList<ManagedChannel> oobChannelTracker = new ArrayList<>();
private final ArrayList<String> failingLbAuthorities = new ArrayList<>();
private final SynchronizationContext syncContext = new SynchronizationContext(
new Thread.UncaughtExceptionHandler() {
@Override
public void uncaughtException(Thread t, Throwable e) {
throw new AssertionError(e);
}
});
private static final ClientStreamTracer.StreamInfo STREAM_INFO =
ClientStreamTracer.StreamInfo.newBuilder().build();
private io.grpc.Server fakeLbServer;
@Captor
private ArgumentCaptor<SubchannelPicker> pickerCaptor;
@Mock
private BackoffPolicy.Provider backoffPolicyProvider;
@Mock
private BackoffPolicy backoffPolicy1;
@Mock
private BackoffPolicy backoffPolicy2;
private GrpclbLoadBalancer balancer;
@SuppressWarnings({"unchecked", "deprecation"})
@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
mockLbService = mock(LoadBalancerGrpc.LoadBalancerImplBase.class, delegatesTo(
new LoadBalancerGrpc.LoadBalancerImplBase() {
@Override
public StreamObserver<LoadBalanceRequest> balanceLoad(
final StreamObserver<LoadBalanceResponse> responseObserver) {
StreamObserver<LoadBalanceRequest> requestObserver =
mock(StreamObserver.class);
Answer<Void> closeRpc = new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) {
responseObserver.onCompleted();
return null;
}
};
doAnswer(closeRpc).when(requestObserver).onCompleted();
lbRequestObservers.add(requestObserver);
return requestObserver;
}
}));
fakeLbServer = InProcessServerBuilder.forName("fakeLb")
.directExecutor().addService(mockLbService).build().start();
doAnswer(new Answer<ManagedChannel>() {
@Override
public ManagedChannel answer(InvocationOnMock invocation) throws Throwable {
String authority = (String) invocation.getArguments()[1];
ManagedChannel channel;
if (failingLbAuthorities.contains(authority)) {
channel = InProcessChannelBuilder.forName("nonExistFakeLb").directExecutor()
.overrideAuthority(authority).build();
} else {
channel = InProcessChannelBuilder.forName("fakeLb").directExecutor()
.overrideAuthority(authority).build();
}
fakeOobChannels.add(channel);
oobChannelTracker.add(channel);
return channel;
}
}).when(helper).createOobChannel(any(EquivalentAddressGroup.class), any(String.class));
doAnswer(new Answer<Subchannel>() {
@Override
public Subchannel answer(InvocationOnMock invocation) throws Throwable {
Subchannel subchannel = mock(Subchannel.class);
EquivalentAddressGroup eag = (EquivalentAddressGroup) invocation.getArguments()[0];
Attributes attrs = (Attributes) invocation.getArguments()[1];
when(subchannel.getAllAddresses()).thenReturn(Arrays.asList(eag));
when(subchannel.getAttributes()).thenReturn(attrs);
mockSubchannels.add(subchannel);
pooledSubchannelTracker.add(subchannel);
return subchannel;
}
}).when(subchannelPool).takeOrCreateSubchannel(
any(EquivalentAddressGroup.class), any(Attributes.class));
doAnswer(new Answer<Subchannel>() {
@Override
public Subchannel answer(InvocationOnMock invocation) throws Throwable {
Subchannel subchannel = mock(Subchannel.class);
List<EquivalentAddressGroup> eagList =
(List<EquivalentAddressGroup>) invocation.getArguments()[0];
Attributes attrs = (Attributes) invocation.getArguments()[1];
when(subchannel.getAllAddresses()).thenReturn(eagList);
when(subchannel.getAttributes()).thenReturn(attrs);
mockSubchannels.add(subchannel);
unpooledSubchannelTracker.add(subchannel);
return subchannel;
}
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
}).when(helper).createSubchannel(any(List.class), any(Attributes.class));
when(helper.getSynchronizationContext()).thenReturn(syncContext);
when(helper.getScheduledExecutorService()).thenReturn(fakeClock.getScheduledExecutorService());
when(helper.getChannelLogger()).thenReturn(channelLogger);
doAnswer(new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) throws Throwable {
currentPicker = (SubchannelPicker) invocation.getArguments()[1];
return null;
}
}).when(helper).updateBalancingState(
any(ConnectivityState.class), any(SubchannelPicker.class));
when(helper.getAuthority()).thenReturn(SERVICE_AUTHORITY);
when(backoffPolicy1.nextBackoffNanos()).thenReturn(10L, 100L);
when(backoffPolicy2.nextBackoffNanos()).thenReturn(10L, 100L);
when(backoffPolicyProvider.get()).thenReturn(backoffPolicy1, backoffPolicy2);
balancer = new GrpclbLoadBalancer(helper, subchannelPool, fakeClock.getTimeProvider(),
fakeClock.getStopwatchSupplier().get(),
backoffPolicyProvider);
verify(subchannelPool).init(same(helper), same(balancer));
}
@After
public void tearDown() {
try {
if (balancer != null) {
syncContext.execute(new Runnable() {
@Override
public void run() {
balancer.shutdown();
}
});
}
for (ManagedChannel channel : oobChannelTracker) {
assertTrue(channel + " is shutdown", channel.isShutdown());
// balancer should have closed the LB stream, terminating the OOB channel.
assertTrue(channel + " is terminated", channel.isTerminated());
}
// GRPCLB manages subchannels only through subchannelPool
for (Subchannel subchannel : pooledSubchannelTracker) {
verify(subchannelPool).returnSubchannel(same(subchannel), any(ConnectivityStateInfo.class));
// Our mock subchannelPool never calls Subchannel.shutdown(), thus we can tell if
// LoadBalancer has called it expectedly.
verify(subchannel, never()).shutdown();
}
for (Subchannel subchannel : unpooledSubchannelTracker) {
verify(subchannel).shutdown();
}
// No timer should linger after shutdown
assertThat(fakeClock.getPendingTasks()).isEmpty();
} finally {
if (fakeLbServer != null) {
fakeLbServer.shutdownNow();
}
}
}
@Test
public void roundRobinPickerNoDrop() {
GrpclbClientLoadRecorder loadRecorder =
new GrpclbClientLoadRecorder(fakeClock.getTimeProvider());
Subchannel subchannel = mock(Subchannel.class);
BackendEntry b1 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0001");
BackendEntry b2 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0002");
List<BackendEntry> pickList = Arrays.asList(b1, b2);
RoundRobinPicker picker = new RoundRobinPicker(Collections.<DropEntry>emptyList(), pickList);
PickSubchannelArgs args1 = mock(PickSubchannelArgs.class);
Metadata headers1 = new Metadata();
// The existing token on the headers will be replaced
headers1.put(GrpclbConstants.TOKEN_METADATA_KEY, "LBTOKEN__OLD");
when(args1.getHeaders()).thenReturn(headers1);
assertSame(b1.result, picker.pickSubchannel(args1));
verify(args1).getHeaders();
assertThat(headers1.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
PickSubchannelArgs args2 = mock(PickSubchannelArgs.class);
Metadata headers2 = new Metadata();
when(args2.getHeaders()).thenReturn(headers2);
assertSame(b2.result, picker.pickSubchannel(args2));
verify(args2).getHeaders();
assertThat(headers2.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0002");
PickSubchannelArgs args3 = mock(PickSubchannelArgs.class);
Metadata headers3 = new Metadata();
when(args3.getHeaders()).thenReturn(headers3);
assertSame(b1.result, picker.pickSubchannel(args3));
verify(args3).getHeaders();
assertThat(headers3.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
verify(subchannel, never()).getAttributes();
}
@Test
public void roundRobinPickerWithDrop() {
assertTrue(DROP_PICK_RESULT.isDrop());
GrpclbClientLoadRecorder loadRecorder =
new GrpclbClientLoadRecorder(fakeClock.getTimeProvider());
Subchannel subchannel = mock(Subchannel.class);
// 1 out of 2 requests are to be dropped
DropEntry d = new DropEntry(loadRecorder, "LBTOKEN0003");
List<DropEntry> dropList = Arrays.asList(null, d);
BackendEntry b1 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0001");
BackendEntry b2 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0002");
List<BackendEntry> pickList = Arrays.asList(b1, b2);
RoundRobinPicker picker = new RoundRobinPicker(dropList, pickList);
// dropList[0], pickList[0]
PickSubchannelArgs args1 = mock(PickSubchannelArgs.class);
Metadata headers1 = new Metadata();
headers1.put(GrpclbConstants.TOKEN_METADATA_KEY, "LBTOKEN__OLD");
when(args1.getHeaders()).thenReturn(headers1);
assertSame(b1.result, picker.pickSubchannel(args1));
verify(args1).getHeaders();
assertThat(headers1.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
// dropList[1]: drop
PickSubchannelArgs args2 = mock(PickSubchannelArgs.class);
Metadata headers2 = new Metadata();
when(args2.getHeaders()).thenReturn(headers2);
assertSame(DROP_PICK_RESULT, picker.pickSubchannel(args2));
verify(args2, never()).getHeaders();
// dropList[0], pickList[1]
PickSubchannelArgs args3 = mock(PickSubchannelArgs.class);
Metadata headers3 = new Metadata();
when(args3.getHeaders()).thenReturn(headers3);
assertSame(b2.result, picker.pickSubchannel(args3));
verify(args3).getHeaders();
assertThat(headers3.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0002");
// dropList[1]: drop
PickSubchannelArgs args4 = mock(PickSubchannelArgs.class);
Metadata headers4 = new Metadata();
when(args4.getHeaders()).thenReturn(headers4);
assertSame(DROP_PICK_RESULT, picker.pickSubchannel(args4));
verify(args4, never()).getHeaders();
// dropList[0], pickList[0]
PickSubchannelArgs args5 = mock(PickSubchannelArgs.class);
Metadata headers5 = new Metadata();
when(args5.getHeaders()).thenReturn(headers5);
assertSame(b1.result, picker.pickSubchannel(args5));
verify(args5).getHeaders();
assertThat(headers5.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
verify(subchannel, never()).getAttributes();
}
@Test
public void roundRobinPickerWithIdleEntry_noDrop() {
Subchannel subchannel = mock(Subchannel.class);
IdleSubchannelEntry entry = new IdleSubchannelEntry(subchannel, syncContext);
RoundRobinPicker picker =
new RoundRobinPicker(Collections.<DropEntry>emptyList(), Collections.singletonList(entry));
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
verify(subchannel, never()).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
verify(subchannel).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
// Only the first pick triggers requestConnection()
verify(subchannel).requestConnection();
}
@Test
public void roundRobinPickerWithIdleEntry_andDrop() {
GrpclbClientLoadRecorder loadRecorder =
new GrpclbClientLoadRecorder(fakeClock.getTimeProvider());
// 1 out of 2 requests are to be dropped
DropEntry d = new DropEntry(loadRecorder, "LBTOKEN0003");
List<DropEntry> dropList = Arrays.asList(null, d);
Subchannel subchannel = mock(Subchannel.class);
IdleSubchannelEntry entry = new IdleSubchannelEntry(subchannel, syncContext);
RoundRobinPicker picker = new RoundRobinPicker(dropList, Collections.singletonList(entry));
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
verify(subchannel, never()).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
verify(subchannel).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(DROP_PICK_RESULT);
verify(subchannel).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
// Only the first pick triggers requestConnection()
verify(subchannel).requestConnection();
}
@Test
public void loadReporting() {
Metadata headers = new Metadata();
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
when(args.getHeaders()).thenReturn(headers);
long loadReportIntervalMillis = 1983;
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
// Fallback timer is started as soon as address is resolved.
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
InOrder inOrder = inOrder(lbRequestObserver);
InOrder helperInOrder = inOrder(helper, subchannelPool);
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// Load reporting task is scheduled
assertEquals(1, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
assertEquals(0, fakeClock.runDueTasks());
List<ServerEntry> backends = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("token0001"), // drop
new ServerEntry("127.0.0.1", 2010, "token0002"),
new ServerEntry("token0003")); // drop
lbResponseObserver.onNext(buildLbResponse(backends));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
helperInOrder.verify(helper, atLeast(1))
.updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0001"),
null,
new DropEntry(getLoadRecorder(), "token0003")).inOrder();
assertThat(picker.pickList).containsExactly(
new BackendEntry(subchannel1, getLoadRecorder(), "token0001"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0002")).inOrder();
// Report, no data
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder().build());
PickResult pick1 = picker.pickSubchannel(args);
assertSame(subchannel1, pick1.getSubchannel());
assertSame(getLoadRecorder(), pick1.getStreamTracerFactory());
// Merely the pick will not be recorded as upstart.
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder().build());
ClientStreamTracer tracer1 =
pick1.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
PickResult pick2 = picker.pickSubchannel(args);
assertNull(pick2.getSubchannel());
assertSame(DROP_PICK_RESULT, pick2);
// Report includes upstart of pick1 and the drop of pick2
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(2)
.setNumCallsFinished(1) // pick2
.addCallsFinishedWithDrop(
ClientStatsPerToken.newBuilder()
.setLoadBalanceToken("token0001")
.setNumCalls(1) // pick2
.build())
.build());
PickResult pick3 = picker.pickSubchannel(args);
assertSame(subchannel2, pick3.getSubchannel());
assertSame(getLoadRecorder(), pick3.getStreamTracerFactory());
ClientStreamTracer tracer3 =
pick3.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
// pick3 has sent out headers
tracer3.outboundHeaders();
// 3rd report includes pick3's upstart
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1)
.build());
PickResult pick4 = picker.pickSubchannel(args);
assertNull(pick4.getSubchannel());
assertSame(DROP_PICK_RESULT, pick4);
// pick1 ended without sending anything
tracer1.streamClosed(Status.CANCELLED);
// 4th report includes end of pick1 and drop of pick4
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1) // pick4
.setNumCallsFinished(2)
.setNumCallsFinishedWithClientFailedToSend(1) // pick1
.addCallsFinishedWithDrop(
ClientStatsPerToken.newBuilder()
.setLoadBalanceToken("token0003")
.setNumCalls(1) // pick4
.build())
.build());
PickResult pick5 = picker.pickSubchannel(args);
assertSame(subchannel1, pick1.getSubchannel());
assertSame(getLoadRecorder(), pick5.getStreamTracerFactory());
ClientStreamTracer tracer5 =
pick5.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
// pick3 ended without receiving response headers
tracer3.streamClosed(Status.DEADLINE_EXCEEDED);
// pick5 sent and received headers
tracer5.outboundHeaders();
tracer5.inboundHeaders();
// 5th report includes pick3's end and pick5's upstart
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1) // pick5
.setNumCallsFinished(1) // pick3
.build());
// pick5 ends
tracer5.streamClosed(Status.OK);
// 6th report includes pick5's end
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsFinished(1)
.setNumCallsFinishedKnownReceived(1)
.build());
assertEquals(1, fakeClock.numPendingTasks());
// Balancer closes the stream, scheduled reporting task cancelled
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
assertEquals(0, fakeClock.numPendingTasks());
// New stream created
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
inOrder = inOrder(lbRequestObserver);
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Load reporting is also requested
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// No picker created because balancer is still using the results from the last stream
helperInOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// Make a new pick on that picker. It will not show up on the report of the new stream, because
// that picker is associated with the previous stream.
PickResult pick6 = picker.pickSubchannel(args);
assertNull(pick6.getSubchannel());
assertSame(DROP_PICK_RESULT, pick6);
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder().build());
// New stream got the list update
lbResponseObserver.onNext(buildLbResponse(backends));
// Same backends, thus no new subchannels
helperInOrder.verify(subchannelPool, never()).takeOrCreateSubchannel(
any(EquivalentAddressGroup.class), any(Attributes.class));
// But the new RoundRobinEntries have a new loadRecorder, thus considered different from
// the previous list, thus a new picker is created
helperInOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
picker = (RoundRobinPicker) pickerCaptor.getValue();
PickResult pick1p = picker.pickSubchannel(args);
assertSame(subchannel1, pick1p.getSubchannel());
assertSame(getLoadRecorder(), pick1p.getStreamTracerFactory());
pick1p.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
// The pick from the new stream will be included in the report
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1)
.build());
verify(args, atLeast(0)).getHeaders();
verifyNoMoreInteractions(args);
}
@Test
public void abundantInitialResponse() {
Metadata headers = new Metadata();
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
when(args.getHeaders()).thenReturn(headers);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
// Simulate LB initial response
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
lbResponseObserver.onNext(buildInitialResponse(1983));
// Load reporting task is scheduled
assertEquals(1, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
FakeClock.ScheduledTask scheduledTask =
Iterables.getOnlyElement(fakeClock.getPendingTasks(LOAD_REPORTING_TASK_FILTER));
assertEquals(1983, scheduledTask.getDelay(TimeUnit.MILLISECONDS));
logs.clear();
// Simulate an abundant LB initial response, with a different report interval
lbResponseObserver.onNext(buildInitialResponse(9097));
// This incident is logged
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildInitialResponse(9097),
"WARNING: Ignoring unexpected response type: INITIAL_RESPONSE").inOrder();
// It doesn't affect load-reporting at all
assertThat(fakeClock.getPendingTasks(LOAD_REPORTING_TASK_FILTER))
.containsExactly(scheduledTask);
assertEquals(1983, scheduledTask.getDelay(TimeUnit.MILLISECONDS));
}
@Test
public void raceBetweenLoadReportingAndLbStreamClosure() {
Metadata headers = new Metadata();
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
when(args.getHeaders()).thenReturn(headers);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
InOrder inOrder = inOrder(lbRequestObserver);
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
lbResponseObserver.onNext(buildInitialResponse(1983));
// Load reporting task is scheduled
assertEquals(1, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
FakeClock.ScheduledTask scheduledTask =
Iterables.getOnlyElement(fakeClock.getPendingTasks(LOAD_REPORTING_TASK_FILTER));
assertEquals(1983, scheduledTask.getDelay(TimeUnit.MILLISECONDS));
// Close lbStream
lbResponseObserver.onCompleted();
// Reporting task cancelled
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
// Simulate a race condition where the task has just started when its cancelled
scheduledTask.command.run();
// No report sent. No new task scheduled
inOrder.verify(lbRequestObserver, never()).onNext(any(LoadBalanceRequest.class));
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
}
private void assertNextReport(
InOrder inOrder, StreamObserver<LoadBalanceRequest> lbRequestObserver,
long loadReportIntervalMillis, ClientStats expectedReport) {
assertEquals(0, fakeClock.forwardTime(loadReportIntervalMillis - 1, TimeUnit.MILLISECONDS));
inOrder.verifyNoMoreInteractions();
assertEquals(1, fakeClock.forwardTime(1, TimeUnit.MILLISECONDS));
assertEquals(1, fakeClock.numPendingTasks());
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder()
.setClientStats(
ClientStats.newBuilder(expectedReport)
.setTimestamp(Timestamps.fromNanos(fakeClock.getTicker().read()))
.build())
.build()));
}
@Test
public void receiveNoBackendAndBalancerAddress() {
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
Collections.<EquivalentAddressGroup>emptyList());
verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).isEmpty();
Status error = Iterables.getOnlyElement(picker.pickList).picked(new Metadata()).getStatus();
assertThat(error.getCode()).isEqualTo(Code.UNAVAILABLE);
assertThat(error.getDescription()).isEqualTo("No backend or balancer addresses found");
}
@Test
public void nameResolutionFailsThenRecover() {
Status error = Status.NOT_FOUND.withDescription("www.google.com not found");
deliverNameResolutionError(error);
verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
assertThat(logs).containsExactly(
"DEBUG: Error: " + error,
"INFO: TRANSIENT_FAILURE: picks="
+ "[Status{code=NOT_FOUND, description=www.google.com not found, cause=null}],"
+ " drops=[]")
.inOrder();
logs.clear();
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).isEmpty();
assertThat(picker.pickList).containsExactly(new ErrorEntry(error));
// Recover with a subsequent success
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
EquivalentAddressGroup eag = grpclbBalancerList.get(0);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
verify(helper).createOobChannel(eq(eag), eq(lbAuthority(0)));
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
}
@Test
public void grpclbThenNameResolutionFails() {
InOrder inOrder = inOrder(helper, subchannelPool);
// Go to GRPCLB first
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
// Let name resolution fail before round-robin list is ready
Status error = Status.NOT_FOUND.withDescription("www.google.com not found");
deliverNameResolutionError(error);
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).isEmpty();
assertThat(picker.pickList).containsExactly(new ErrorEntry(error));
assertFalse(oobChannel.isShutdown());
// Simulate receiving LB response
List<ServerEntry> backends = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "TOKEN1"),
new ServerEntry("127.0.0.1", 2010, "TOKEN2"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
}
@Test
public void grpclbUpdatedAddresses_avoidsReconnect() {
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
ManagedChannel oobChannel = fakeOobChannels.poll();
assertEquals(1, lbRequestObservers.size());
List<EquivalentAddressGroup> backendList2 = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList2 = createResolvedBalancerAddresses(2);
EquivalentAddressGroup combinedEag = new EquivalentAddressGroup(Arrays.asList(
grpclbBalancerList2.get(0).getAddresses().get(0),
grpclbBalancerList2.get(1).getAddresses().get(0)),
lbAttributes(lbAuthority(0)));
deliverResolvedAddresses(backendList2, grpclbBalancerList2);
verify(helper).updateOobChannelAddresses(eq(oobChannel), eq(combinedEag));
assertEquals(1, lbRequestObservers.size()); // No additional RPC
}
@Test
public void grpclbUpdatedAddresses_reconnectOnAuthorityChange() {
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
ManagedChannel oobChannel = fakeOobChannels.poll();
assertEquals(1, lbRequestObservers.size());
final String newAuthority = "some-new-authority";
List<EquivalentAddressGroup> backendList2 = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList2 =
Collections.singletonList(
new EquivalentAddressGroup(
new FakeSocketAddress("somethingNew"), lbAttributes(newAuthority)));
deliverResolvedAddresses(backendList2, grpclbBalancerList2);
assertTrue(oobChannel.isTerminated());
verify(helper).createOobChannel(eq(grpclbBalancerList2.get(0)), eq(newAuthority));
assertEquals(2, lbRequestObservers.size()); // An additional RPC
}
@Test
public void grpclbWorking() {
InOrder inOrder = inOrder(helper, subchannelPool);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
// Fallback timer is started as soon as the addresses are resolved.
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
logs.clear();
lbResponseObserver.onNext(buildInitialResponse());
assertThat(logs).containsExactly("DEBUG: Got an LB response: " + buildInitialResponse());
logs.clear();
lbResponseObserver.onNext(buildLbResponse(backends1));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannel1).requestConnection();
verify(subchannel2).requestConnection();
assertEquals(
new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS),
subchannel1.getAddresses());
assertEquals(
new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS),
subchannel2.getAddresses());
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(BUFFER_ENTRY);
inOrder.verifyNoMoreInteractions();
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends1),
"INFO: Using RR list="
+ "[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}](token0001),"
+ " [[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}](token0002)],"
+ " drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
logs.clear();
// Let subchannels be connected
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0001)],"
+ " [[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(
new BackendEntry(subchannel1, getLoadRecorder(), "token0001"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"))
.inOrder();
// Disconnected subchannels
verify(subchannel1).requestConnection();
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(IDLE));
verify(subchannel1, times(2)).requestConnection();
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verifyNoMoreInteractions();
// As long as there is at least one READY subchannel, round robin will work.
ConnectivityStateInfo errorState1 =
ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE.withDescription("error1"));
deliverSubchannelState(subchannel1, errorState1);
inOrder.verifyNoMoreInteractions();
// If no subchannel is READY, some with error and the others are IDLE, will report CONNECTING
verify(subchannel2).requestConnection();
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(IDLE));
verify(subchannel2, times(2)).requestConnection();
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]");
logs.clear();
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.dropList).containsExactly(null, null);
assertThat(picker4.pickList).containsExactly(BUFFER_ENTRY);
// Update backends, with a drop entry
List<ServerEntry> backends2 =
Arrays.asList(
new ServerEntry("127.0.0.1", 2030, "token0003"), // New address
new ServerEntry("token0003"), // drop
new ServerEntry("127.0.0.1", 2010, "token0004"), // Existing address with token changed
new ServerEntry("127.0.0.1", 2030, "token0005"), // New address appearing second time
new ServerEntry("token0006")); // drop
verify(subchannelPool, never())
.returnSubchannel(same(subchannel1), any(ConnectivityStateInfo.class));
lbResponseObserver.onNext(buildLbResponse(backends2));
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends2),
"INFO: Using RR list="
+ "[[[/127.0.0.1:2030]/{io.grpc.grpclb.lbProvidedBackend=true}](token0003),"
+ " [[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}](token0004),"
+ " [[/127.0.0.1:2030]/{io.grpc.grpclb.lbProvidedBackend=true}](token0005)],"
+ " drop=[null, drop(token0003), null, null, drop(token0006)]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY],"
+ " drops=[null, drop(token0003), null, null, drop(token0006)]")
.inOrder();
logs.clear();
// not in backends2, closed
verify(subchannelPool).returnSubchannel(same(subchannel1), same(errorState1));
// backends2[2], will be kept
verify(subchannelPool, never())
.returnSubchannel(same(subchannel2), any(ConnectivityStateInfo.class));
inOrder.verify(subchannelPool, never()).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends2.get(2).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends2.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
ConnectivityStateInfo errorOnCachedSubchannel1 =
ConnectivityStateInfo.forTransientFailure(
Status.UNAVAILABLE.withDescription("You can get this error even if you are cached"));
deliverSubchannelState(subchannel1, errorOnCachedSubchannel1);
verify(subchannelPool).handleSubchannelState(same(subchannel1), same(errorOnCachedSubchannel1));
assertEquals(1, mockSubchannels.size());
Subchannel subchannel3 = mockSubchannels.poll();
verify(subchannel3).requestConnection();
assertEquals(
new EquivalentAddressGroup(backends2.get(0).addr, LB_BACKEND_ATTRS),
subchannel3.getAddresses());
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker7 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker7.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0003"),
null,
null,
new DropEntry(getLoadRecorder(), "token0006")).inOrder();
assertThat(picker7.pickList).containsExactly(BUFFER_ENTRY);
// State updates on obsolete subchannel1 will only be passed to the pool
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
deliverSubchannelState(
subchannel1, ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(SHUTDOWN));
inOrder.verify(subchannelPool)
.handleSubchannelState(same(subchannel1), eq(ConnectivityStateInfo.forNonError(READY)));
inOrder.verify(subchannelPool).handleSubchannelState(
same(subchannel1), eq(ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE)));
inOrder.verifyNoMoreInteractions();
deliverSubchannelState(subchannel3, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker8 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker8.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0003"),
null,
null,
new DropEntry(getLoadRecorder(), "token0006")).inOrder();
// subchannel2 is still IDLE, thus not in the active list
assertThat(picker8.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token0003"),
new BackendEntry(subchannel3, getLoadRecorder(), "token0005")).inOrder();
// subchannel2 becomes READY and makes it into the list
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker9 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker9.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0003"),
null,
null,
new DropEntry(getLoadRecorder(), "token0006")).inOrder();
assertThat(picker9.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token0003"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0004"),
new BackendEntry(subchannel3, getLoadRecorder(), "token0005")).inOrder();
verify(subchannelPool, never())
.returnSubchannel(same(subchannel3), any(ConnectivityStateInfo.class));
// Update backends, with no entry
lbResponseObserver.onNext(buildLbResponse(Collections.<ServerEntry>emptyList()));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(READY)));
verify(subchannelPool)
.returnSubchannel(same(subchannel3), eq(ConnectivityStateInfo.forNonError(READY)));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker10 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker10.dropList).isEmpty();
assertThat(picker10.pickList).containsExactly(BUFFER_ENTRY);
assertFalse(oobChannel.isShutdown());
assertEquals(0, lbRequestObservers.size());
verify(lbRequestObserver, never()).onCompleted();
verify(lbRequestObserver, never()).onError(any(Throwable.class));
// Load reporting was not requested, thus never scheduled
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
verify(subchannelPool, never()).clear();
balancer.shutdown();
verify(subchannelPool).clear();
}
@Test
public void grpclbFallback_initialTimeout_serverListReceivedBeforeTimerExpires() {
subtestGrpclbFallbackInitialTimeout(false);
}
@Test
public void grpclbFallback_initialTimeout_timerExpires() {
subtestGrpclbFallbackInitialTimeout(true);
}
// Fallback or not within the period of the initial timeout.
private void subtestGrpclbFallbackInitialTimeout(boolean timerExpires) {
long loadReportIntervalMillis = 1983;
InOrder inOrder = inOrder(helper, subchannelPool);
// Create balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
inOrder.verify(helper)
.createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
// Attempted to connect to balancer
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// We don't care if these methods have been run.
inOrder.verify(helper, atLeast(0)).getSynchronizationContext();
inOrder.verify(helper, atLeast(0)).getScheduledExecutorService();
inOrder.verifyNoMoreInteractions();
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
fakeClock.forwardTime(GrpclbState.FALLBACK_TIMEOUT_MS - 1, TimeUnit.MILLISECONDS);
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
//////////////////////////////////
// Fallback timer expires (or not)
//////////////////////////////////
if (timerExpires) {
logs.clear();
fakeClock.forwardTime(1, TimeUnit.MILLISECONDS);
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
List<EquivalentAddressGroup> fallbackList =
Arrays.asList(backendList.get(0), backendList.get(1));
assertThat(logs).containsExactly(
"INFO: Using fallback backends",
"INFO: Using RR list=[[[FakeSocketAddress-fake-address-0]/{}], "
+ "[[FakeSocketAddress-fake-address-1]/{}]], drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
// Fall back to the backends from resolver
fallbackTestVerifyUseOfFallbackBackendLists(inOrder, fallbackList);
assertFalse(oobChannel.isShutdown());
verify(lbRequestObserver, never()).onCompleted();
}
//////////////////////////////////////////////////////////////////////
// Name resolver sends new resolution results without any backend addr
//////////////////////////////////////////////////////////////////////
grpclbBalancerList = createResolvedBalancerAddresses(2);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(),grpclbBalancerList);
// New addresses are updated to the OobChannel
inOrder.verify(helper).updateOobChannelAddresses(
same(oobChannel),
eq(new EquivalentAddressGroup(
Arrays.asList(
grpclbBalancerList.get(0).getAddresses().get(0),
grpclbBalancerList.get(1).getAddresses().get(0)),
lbAttributes(lbAuthority(0)))));
if (timerExpires) {
// Still in fallback logic, except that the backend list is empty
fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Collections.<EquivalentAddressGroup>emptyList());
}
////////////////////////////////////////////////////////////////
// Name resolver sends new resolution results with backend addrs
////////////////////////////////////////////////////////////////
backendList = createResolvedBackendAddresses(2);
grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
// New LB address is updated to the OobChannel
inOrder.verify(helper).updateOobChannelAddresses(
same(oobChannel),
eq(grpclbBalancerList.get(0)));
if (timerExpires) {
// New backend addresses are used for fallback
fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Arrays.asList(backendList.get(0), backendList.get(1)));
}
////////////////////////////////////////////////
// Break the LB stream after the timer expires
////////////////////////////////////////////////
if (timerExpires) {
Status streamError = Status.UNAVAILABLE.withDescription("OOB stream broken");
lbResponseObserver.onError(streamError.asException());
// The error will NOT propagate to picker because fallback list is in use.
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// A new stream is created
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
}
/////////////////////////////////
// Balancer returns a server list
/////////////////////////////////
List<ServerEntry> serverList = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(serverList));
// Balancer-provided server list now in effect
fallbackTestVerifyUseOfBalancerBackendLists(inOrder, serverList);
///////////////////////////////////////////////////////////////
// New backend addresses from resolver outside of fallback mode
///////////////////////////////////////////////////////////////
backendList = createResolvedBackendAddresses(1);
grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
// Will not affect the round robin list at all
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// No fallback timeout timer scheduled.
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
}
@Test
public void grpclbFallback_breakLbStreamBeforeFallbackTimerExpires() {
long loadReportIntervalMillis = 1983;
InOrder inOrder = inOrder(helper, subchannelPool);
// Create balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
inOrder.verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
// Attempted to connect to balancer
assertThat(fakeOobChannels).hasSize(1);
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertThat(lbRequestObservers).hasSize(1);
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// We don't care if these methods have been run.
inOrder.verify(helper, atLeast(0)).getSynchronizationContext();
inOrder.verify(helper, atLeast(0)).getScheduledExecutorService();
inOrder.verifyNoMoreInteractions();
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
/////////////////////////////////////////////
// Break the LB stream before timer expires
/////////////////////////////////////////////
Status streamError = Status.UNAVAILABLE.withDescription("OOB stream broken");
lbResponseObserver.onError(streamError.asException());
// Fall back to the backends from resolver
fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Arrays.asList(backendList.get(0), backendList.get(1)));
// A new stream is created
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
assertThat(lbRequestObservers).hasSize(1);
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
}
@Test
public void grpclbFallback_noBalancerAddress() {
InOrder inOrder = inOrder(helper, subchannelPool);
// Create just backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
deliverResolvedAddresses(backendList, Collections.<EquivalentAddressGroup>emptyList());
assertThat(logs).containsExactly(
"INFO: Using fallback backends",
"INFO: Using RR list=[[[FakeSocketAddress-fake-address-0]/{}], "
+ "[[FakeSocketAddress-fake-address-1]/{}]], drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
// Fall back to the backends from resolver
fallbackTestVerifyUseOfFallbackBackendLists(inOrder, backendList);
// No fallback timeout timer scheduled.
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
verify(helper, never())
.createOobChannel(any(EquivalentAddressGroup.class), anyString());
}
@Test
public void grpclbFallback_balancerLost() {
subtestGrpclbFallbackConnectionLost(true, false);
}
@Test
public void grpclbFallback_subchannelsLost() {
subtestGrpclbFallbackConnectionLost(false, true);
}
@Test
public void grpclbFallback_allLost() {
subtestGrpclbFallbackConnectionLost(true, true);
}
// Fallback outside of the initial timeout, where all connections are lost.
private void subtestGrpclbFallbackConnectionLost(
boolean balancerBroken, boolean allSubchannelsBroken) {
long loadReportIntervalMillis = 1983;
InOrder inOrder = inOrder(helper, mockLbService, subchannelPool);
// Create balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList);
inOrder.verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
// Attempted to connect to balancer
assertEquals(1, fakeOobChannels.size());
fakeOobChannels.poll();
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// We don't care if these methods have been run.
inOrder.verify(helper, atLeast(0)).getSynchronizationContext();
inOrder.verify(helper, atLeast(0)).getScheduledExecutorService();
inOrder.verifyNoMoreInteractions();
// Balancer returns a server list
List<ServerEntry> serverList = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(serverList));
List<Subchannel> subchannels = fallbackTestVerifyUseOfBalancerBackendLists(inOrder, serverList);
// Break connections
if (balancerBroken) {
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// A new stream to LB is created
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
}
if (allSubchannelsBroken) {
for (Subchannel subchannel : subchannels) {
// A READY subchannel transits to IDLE when receiving a go-away
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(IDLE));
}
}
if (balancerBroken && allSubchannelsBroken) {
// Going into fallback
subchannels = fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Arrays.asList(backendList.get(0), backendList.get(1)));
// When in fallback mode, fallback timer should not be scheduled when all backend
// connections are lost
for (Subchannel subchannel : subchannels) {
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(IDLE));
}
// Exit fallback mode or cancel fallback timer when receiving a new server list from balancer
List<ServerEntry> serverList2 = Arrays.asList(
new ServerEntry("127.0.0.1", 2001, "token0003"),
new ServerEntry("127.0.0.1", 2011, "token0004"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(serverList2));
fallbackTestVerifyUseOfBalancerBackendLists(inOrder, serverList2);
}
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
if (!(balancerBroken && allSubchannelsBroken)) {
verify(subchannelPool, never()).takeOrCreateSubchannel(
eq(backendList.get(0)), any(Attributes.class));
verify(subchannelPool, never()).takeOrCreateSubchannel(
eq(backendList.get(1)), any(Attributes.class));
}
}
private List<Subchannel> fallbackTestVerifyUseOfFallbackBackendLists(
InOrder inOrder, List<EquivalentAddressGroup> addrs) {
return fallbackTestVerifyUseOfBackendLists(inOrder, addrs, null);
}
private List<Subchannel> fallbackTestVerifyUseOfBalancerBackendLists(
InOrder inOrder, List<ServerEntry> servers) {
ArrayList<EquivalentAddressGroup> addrs = new ArrayList<>();
ArrayList<String> tokens = new ArrayList<>();
for (ServerEntry server : servers) {
addrs.add(new EquivalentAddressGroup(server.addr, LB_BACKEND_ATTRS));
tokens.add(server.token);
}
return fallbackTestVerifyUseOfBackendLists(inOrder, addrs, tokens);
}
private List<Subchannel> fallbackTestVerifyUseOfBackendLists(
InOrder inOrder, List<EquivalentAddressGroup> addrs,
@Nullable List<String> tokens) {
if (tokens != null) {
assertEquals(addrs.size(), tokens.size());
}
for (EquivalentAddressGroup addr : addrs) {
inOrder.verify(subchannelPool).takeOrCreateSubchannel(eq(addr), any(Attributes.class));
}
RoundRobinPicker picker = (RoundRobinPicker) currentPicker;
assertThat(picker.dropList).containsExactlyElementsIn(Collections.nCopies(addrs.size(), null));
assertThat(picker.pickList).containsExactly(GrpclbState.BUFFER_ENTRY);
assertEquals(addrs.size(), mockSubchannels.size());
ArrayList<Subchannel> subchannels = new ArrayList<>(mockSubchannels);
mockSubchannels.clear();
for (Subchannel subchannel : subchannels) {
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
}
inOrder.verify(helper, atLeast(0))
.updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
ArrayList<BackendEntry> pickList = new ArrayList<>();
for (int i = 0; i < addrs.size(); i++) {
Subchannel subchannel = subchannels.get(i);
BackendEntry backend;
if (tokens == null) {
backend = new BackendEntry(subchannel);
} else {
backend = new BackendEntry(subchannel, getLoadRecorder(), tokens.get(i));
}
pickList.add(backend);
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList)
.containsExactlyElementsIn(Collections.nCopies(addrs.size(), null));
assertThat(picker.pickList).containsExactlyElementsIn(pickList);
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
}
return subchannels;
}
@Test
public void grpclbMultipleAuthorities() throws Exception {
List<EquivalentAddressGroup> backendList = Collections.singletonList(
new EquivalentAddressGroup(new FakeSocketAddress("not-a-lb-address")));
List<EquivalentAddressGroup> grpclbBalancerList = Arrays.asList(
new EquivalentAddressGroup(
new FakeSocketAddress("fake-address-1"),
lbAttributes("fake-authority-1")),
new EquivalentAddressGroup(
new FakeSocketAddress("fake-address-2"),
lbAttributes("fake-authority-2")),
new EquivalentAddressGroup(
new FakeSocketAddress("fake-address-3"),
lbAttributes("fake-authority-1")));
final EquivalentAddressGroup goldenOobChannelEag = new EquivalentAddressGroup(
Arrays.<SocketAddress>asList(
new FakeSocketAddress("fake-address-1"),
new FakeSocketAddress("fake-address-3")),
lbAttributes("fake-authority-1")); // Supporting multiple authorities would be good, one day
deliverResolvedAddresses(backendList, grpclbBalancerList);
verify(helper).createOobChannel(goldenOobChannelEag, "fake-authority-1");
}
@Test
public void grpclbBalancerStreamClosedAndRetried() throws Exception {
LoadBalanceRequest expectedInitialRequest =
LoadBalanceRequest.newBuilder()
.setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build();
InOrder inOrder =
inOrder(mockLbService, backoffPolicyProvider, backoffPolicy1, backoffPolicy2, helper);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
assertEquals(1, fakeOobChannels.size());
@SuppressWarnings("unused")
ManagedChannel oobChannel = fakeOobChannels.poll();
// First balancer RPC
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Balancer closes it immediately (erroneously)
lbResponseObserver.onCompleted();
// Will start backoff sequence 1 (10ns)
inOrder.verify(backoffPolicyProvider).get();
inOrder.verify(backoffPolicy1).nextBackoffNanos();
assertEquals(1, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
inOrder.verify(helper).refreshNameResolution();
// Fast-forward to a moment before the retry
fakeClock.forwardNanos(9);
verifyNoMoreInteractions(mockLbService);
// Then time for retry
fakeClock.forwardNanos(1);
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Balancer closes it with an error.
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// Will continue the backoff sequence 1 (100ns)
verifyNoMoreInteractions(backoffPolicyProvider);
inOrder.verify(backoffPolicy1).nextBackoffNanos();
assertEquals(1, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
inOrder.verify(helper).refreshNameResolution();
// Fast-forward to a moment before the retry
fakeClock.forwardNanos(100 - 1);
verifyNoMoreInteractions(mockLbService);
// Then time for retry
fakeClock.forwardNanos(1);
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Balancer sends initial response.
lbResponseObserver.onNext(buildInitialResponse());
// Then breaks the RPC
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// Will reset the retry sequence and retry immediately, because balancer has responded.
inOrder.verify(backoffPolicyProvider).get();
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
inOrder.verify(helper).refreshNameResolution();
// Fail the retry after spending 4ns
fakeClock.forwardNanos(4);
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// Will be on the first retry (10ns) of backoff sequence 2.
inOrder.verify(backoffPolicy2).nextBackoffNanos();
assertEquals(1, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
inOrder.verify(helper).refreshNameResolution();
// Fast-forward to a moment before the retry, the time spent in the last try is deducted.
fakeClock.forwardNanos(10 - 4 - 1);
verifyNoMoreInteractions(mockLbService);
// Then time for retry
fakeClock.forwardNanos(1);
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Wrapping up
verify(backoffPolicyProvider, times(2)).get();
verify(backoffPolicy1, times(2)).nextBackoffNanos();
verify(backoffPolicy2, times(1)).nextBackoffNanos();
verify(helper, times(4)).refreshNameResolution();
}
@SuppressWarnings({"unchecked", "deprecation"})
@Test
public void grpclbWorking_pickFirstMode() throws Exception {
InOrder inOrder = inOrder(helper);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
GrpclbConfig.create(Mode.PICK_FIRST));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
// Initially IDLE
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
// Only one subchannel is created
assertThat(mockSubchannels).hasSize(1);
Subchannel subchannel = mockSubchannels.poll();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(new IdleSubchannelEntry(subchannel, syncContext));
// PICK_FIRST doesn't eagerly connect
verify(subchannel, never()).requestConnection();
// CONNECTING
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(BUFFER_ENTRY);
// TRANSIENT_FAILURE
Status error = Status.UNAVAILABLE.withDescription("Simulated connection error");
deliverSubchannelState(subchannel, ConnectivityStateInfo.forTransientFailure(error));
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(new ErrorEntry(error));
// READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
// New server list with drops
List<ServerEntry> backends2 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("token0003"), // drop
new ServerEntry("127.0.0.1", 2020, "token0004"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildLbResponse(backends2));
// new addresses will be updated to the existing subchannel
// createSubchannel() has ever been called only once
verify(helper, times(1)).createSubchannel(any(List.class), any(Attributes.class));
assertThat(mockSubchannels).isEmpty();
verify(subchannel).updateAddresses(
eq(Arrays.asList(
new EquivalentAddressGroup(backends2.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends2.get(2).addr,
eagAttrsWithToken("token0004")))));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.dropList).containsExactly(
null, new DropEntry(getLoadRecorder(), "token0003"), null);
assertThat(picker4.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
// Subchannel goes IDLE, but PICK_FIRST will not try to reconnect
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(IDLE));
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker5 = (RoundRobinPicker) pickerCaptor.getValue();
verify(subchannel, never()).requestConnection();
// ... until it's selected
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
PickResult pick = picker5.pickSubchannel(args);
assertThat(pick).isSameInstanceAs(PickResult.withNoResult());
verify(subchannel).requestConnection();
// ... or requested by application
balancer.requestConnection();
verify(subchannel, times(2)).requestConnection();
// PICK_FIRST doesn't use subchannelPool
verify(subchannelPool, never())
.takeOrCreateSubchannel(any(EquivalentAddressGroup.class), any(Attributes.class));
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
}
@SuppressWarnings({"unchecked", "deprecation"})
@Test
public void grpclbWorking_pickFirstMode_lbSendsEmptyAddress() throws Exception {
InOrder inOrder = inOrder(helper);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
GrpclbConfig.create(Mode.PICK_FIRST));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
// Initially IDLE
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
// Only one subchannel is created
assertThat(mockSubchannels).hasSize(1);
Subchannel subchannel = mockSubchannels.poll();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(new IdleSubchannelEntry(subchannel, syncContext));
// PICK_FIRST doesn't eagerly connect
verify(subchannel, never()).requestConnection();
// CONNECTING
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(BUFFER_ENTRY);
// TRANSIENT_FAILURE
Status error = Status.UNAVAILABLE.withDescription("Simulated connection error");
deliverSubchannelState(subchannel, ConnectivityStateInfo.forTransientFailure(error));
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(new ErrorEntry(error));
// READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// Empty addresses from LB
lbResponseObserver.onNext(buildLbResponse(Collections.<ServerEntry>emptyList()));
// new addresses will be updated to the existing subchannel
// createSubchannel() has ever been called only once
inOrder.verify(helper, never()).createSubchannel(any(List.class), any(Attributes.class));
assertThat(mockSubchannels).isEmpty();
verify(subchannel).shutdown();
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker errorPicker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(errorPicker.pickList)
.containsExactly(new ErrorEntry(GrpclbState.NO_AVAILABLE_BACKENDS_STATUS));
lbResponseObserver.onNext(buildLbResponse(Collections.<ServerEntry>emptyList()));
// Test recover from new LB response with addresses
// New server list with drops
List<ServerEntry> backends2 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("token0003"), // drop
new ServerEntry("127.0.0.1", 2020, "token0004"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildLbResponse(backends2));
// new addresses will be updated to the existing subchannel
inOrder.verify(helper, times(1)).createSubchannel(any(List.class), any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
subchannel = mockSubchannels.poll();
// Subchannel became READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
}
@Test
public void shutdownWithoutSubchannel_roundRobin() throws Exception {
subtestShutdownWithoutSubchannel(GrpclbConfig.create(Mode.ROUND_ROBIN));
}
@Test
public void shutdownWithoutSubchannel_pickFirst() throws Exception {
subtestShutdownWithoutSubchannel(GrpclbConfig.create(Mode.PICK_FIRST));
}
private void subtestShutdownWithoutSubchannel(GrpclbConfig grpclbConfig) {
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
grpclbConfig);
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> requestObserver = lbRequestObservers.poll();
verify(requestObserver, never()).onCompleted();
balancer.shutdown();
ArgumentCaptor<Throwable> throwableCaptor = ArgumentCaptor.forClass(Throwable.class);
verify(requestObserver).onError(throwableCaptor.capture());
assertThat(Status.fromThrowable(throwableCaptor.getValue()).getCode())
.isEqualTo(Code.CANCELLED);
}
@SuppressWarnings({"unchecked", "deprecation"})
@Test
public void pickFirstMode_fallback() throws Exception {
InOrder inOrder = inOrder(helper);
// Name resolver returns balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
backendList,
grpclbBalancerList,
GrpclbConfig.create(Mode.PICK_FIRST));
// Attempted to connect to balancer
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
// Fallback timer expires with no response
fakeClock.forwardTime(GrpclbState.FALLBACK_TIMEOUT_MS, TimeUnit.MILLISECONDS);
// Entering fallback mode
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(backendList.get(0), backendList.get(1))),
any(Attributes.class));
assertThat(mockSubchannels).hasSize(1);
Subchannel subchannel = mockSubchannels.poll();
// Initially IDLE
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
// READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(null)));
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(new IdleSubchannelEntry(subchannel, syncContext));
// Finally, an LB response, which brings us out of fallback
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// new addresses will be updated to the existing subchannel
// createSubchannel() has ever been called only once
verify(helper, times(1)).createSubchannel(any(List.class), any(Attributes.class));
assertThat(mockSubchannels).isEmpty();
verify(subchannel).updateAddresses(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr,
eagAttrsWithToken("token0002")))));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
// PICK_FIRST doesn't use subchannelPool
verify(subchannelPool, never())
.takeOrCreateSubchannel(any(EquivalentAddressGroup.class), any(Attributes.class));
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
}
@SuppressWarnings("deprecation")
@Test
public void switchMode() throws Exception {
InOrder inOrder = inOrder(helper);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
GrpclbConfig.create(Mode.ROUND_ROBIN));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// ROUND_ROBIN: create one subchannel per server
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
// Switch to PICK_FIRST
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, GrpclbConfig.create(Mode.PICK_FIRST));
// GrpclbState will be shutdown, and a new one will be created
assertThat(oobChannel.isShutdown()).isTrue();
verify(subchannelPool)
.returnSubchannel(same(subchannel1), eq(ConnectivityStateInfo.forNonError(IDLE)));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(IDLE)));
// A new LB stream is created
assertEquals(1, fakeOobChannels.size());
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// PICK_FIRST Subchannel
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(IDLE), any(SubchannelPicker.class));
}
private static Attributes eagAttrsWithToken(String token) {
return LB_BACKEND_ATTRS.toBuilder().set(GrpclbConstants.TOKEN_ATTRIBUTE_KEY, token).build();
}
@Test
@SuppressWarnings("deprecation")
public void switchMode_nullLbPolicy() throws Exception {
InOrder inOrder = inOrder(helper);
final List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList);
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// ROUND_ROBIN: create one subchannel per server
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
// Switch to PICK_FIRST
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
GrpclbConfig.create(Mode.PICK_FIRST));
// GrpclbState will be shutdown, and a new one will be created
assertThat(oobChannel.isShutdown()).isTrue();
verify(subchannelPool)
.returnSubchannel(same(subchannel1), eq(ConnectivityStateInfo.forNonError(IDLE)));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(IDLE)));
// A new LB stream is created
assertEquals(1, fakeOobChannels.size());
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// PICK_FIRST Subchannel
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(IDLE), any(SubchannelPicker.class));
}
@Test
public void switchServiceName() throws Exception {
InOrder inOrder = inOrder(helper);
String serviceName = "foo.google.com";
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
GrpclbConfig.create(Mode.ROUND_ROBIN, serviceName));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(serviceName).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// ROUND_ROBIN: create one subchannel per server
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
// Switch to different serviceName
serviceName = "bar.google.com";
List<EquivalentAddressGroup> newGrpclbResolutionList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
newGrpclbResolutionList,
GrpclbConfig.create(Mode.ROUND_ROBIN, serviceName));
// GrpclbState will be shutdown, and a new one will be created
assertThat(oobChannel.isShutdown()).isTrue();
verify(subchannelPool)
.returnSubchannel(same(subchannel1), eq(ConnectivityStateInfo.forNonError(IDLE)));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(IDLE)));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(serviceName).build())
.build()));
}
@Test
public void grpclbWorking_lbSendsFallbackMessage() {
InOrder inOrder = inOrder(helper, subchannelPool);
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(2);
deliverResolvedAddresses(backendList, grpclbBalancerList);
// Fallback timer is started as soon as the addresses are resolved.
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
List<SocketAddress> addrs = new ArrayList<>();
addrs.addAll(grpclbBalancerList.get(0).getAddresses());
addrs.addAll(grpclbBalancerList.get(1).getAddresses());
Attributes attr = grpclbBalancerList.get(0).getAttributes();
EquivalentAddressGroup oobChannelEag = new EquivalentAddressGroup(addrs, attr);
verify(helper).createOobChannel(eq(oobChannelEag), eq(lbAuthority(0)));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder()
.setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
ServerEntry backend1a = new ServerEntry("127.0.0.1", 2000, "token0001");
ServerEntry backend1b = new ServerEntry("127.0.0.1", 2010, "token0002");
List<ServerEntry> backends1 = Arrays.asList(backend1a, backend1b);
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
logs.clear();
lbResponseObserver.onNext(buildInitialResponse());
assertThat(logs).containsExactly("DEBUG: Got an LB response: " + buildInitialResponse());
logs.clear();
lbResponseObserver.onNext(buildLbResponse(backends1));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend1a.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend1b.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannel1).requestConnection();
verify(subchannel2).requestConnection();
assertEquals(
new EquivalentAddressGroup(backend1a.addr, LB_BACKEND_ATTRS),
subchannel1.getAddresses());
assertEquals(
new EquivalentAddressGroup(backend1b.addr, LB_BACKEND_ATTRS),
subchannel2.getAddresses());
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(BUFFER_ENTRY);
inOrder.verifyNoMoreInteractions();
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends1),
"INFO: Using RR list="
+ "[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}](token0001),"
+ " [[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}](token0002)],"
+ " drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
logs.clear();
// Let subchannels be connected
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0001)],"
+ " [[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(
new BackendEntry(subchannel1, getLoadRecorder(), "token0001"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"))
.inOrder();
// enter fallback mode
lbResponseObserver.onNext(buildLbFallbackResponse());
// existing subchannels must be returned immediately to gracefully shutdown.
verify(subchannelPool)
.returnSubchannel(eq(subchannel1), eq(ConnectivityStateInfo.forNonError(READY)));
verify(subchannelPool)
.returnSubchannel(eq(subchannel2), eq(ConnectivityStateInfo.forNonError(READY)));
// verify fallback
fallbackTestVerifyUseOfFallbackBackendLists(inOrder, backendList);
assertFalse(oobChannel.isShutdown());
verify(lbRequestObserver, never()).onCompleted();
// exit fall back by providing two new backends
ServerEntry backend2a = new ServerEntry("127.0.0.1", 8000, "token1001");
ServerEntry backend2b = new ServerEntry("127.0.0.1", 8010, "token1002");
List<ServerEntry> backends2 = Arrays.asList(backend2a, backend2b);
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
logs.clear();
lbResponseObserver.onNext(buildLbResponse(backends2));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend2a.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend2b.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel3 = mockSubchannels.poll();
Subchannel subchannel4 = mockSubchannels.poll();
verify(subchannel3).requestConnection();
verify(subchannel4).requestConnection();
assertEquals(
new EquivalentAddressGroup(backend2a.addr, LB_BACKEND_ATTRS),
subchannel3.getAddresses());
assertEquals(
new EquivalentAddressGroup(backend2b.addr, LB_BACKEND_ATTRS),
subchannel4.getAddresses());
deliverSubchannelState(subchannel3, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel4, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker6 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker6.dropList).containsExactly(null, null);
assertThat(picker6.pickList).containsExactly(BUFFER_ENTRY);
inOrder.verifyNoMoreInteractions();
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends2),
"INFO: Using RR list="
+ "[[[/127.0.0.1:8000]/{io.grpc.grpclb.lbProvidedBackend=true}](token1001),"
+ " [[/127.0.0.1:8010]/{io.grpc.grpclb.lbProvidedBackend=true}](token1002)],"
+ " drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
logs.clear();
// Let new subchannels be connected
deliverSubchannelState(subchannel3, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:8000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token1001)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token1001"));
deliverSubchannelState(subchannel4, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:8000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token1001)],"
+ " [[[[/127.0.0.1:8010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token1002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.dropList).containsExactly(null, null);
assertThat(picker4.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token1001"),
new BackendEntry(subchannel4, getLoadRecorder(), "token1002"))
.inOrder();
}
@SuppressWarnings("deprecation")
private void deliverSubchannelState(
final Subchannel subchannel, final ConnectivityStateInfo newState) {
syncContext.execute(new Runnable() {
@Override
public void run() {
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new API.
balancer.handleSubchannelState(subchannel, newState);
}
});
}
private void deliverNameResolutionError(final Status error) {
syncContext.execute(new Runnable() {
@Override
public void run() {
balancer.handleNameResolutionError(error);
}
});
}
private void deliverResolvedAddresses(
final List<EquivalentAddressGroup> backendAddrs,
List<EquivalentAddressGroup> balancerAddrs) {
deliverResolvedAddresses(backendAddrs, balancerAddrs, GrpclbConfig.create(Mode.ROUND_ROBIN));
}
private void deliverResolvedAddresses(
final List<EquivalentAddressGroup> backendAddrs,
List<EquivalentAddressGroup> balancerAddrs,
final GrpclbConfig grpclbConfig) {
final Attributes attrs =
Attributes.newBuilder().set(GrpclbConstants.ATTR_LB_ADDRS, balancerAddrs).build();
syncContext.execute(new Runnable() {
@Override
public void run() {
balancer.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(backendAddrs)
.setAttributes(attrs)
.setLoadBalancingPolicyConfig(grpclbConfig)
.build());
}
});
}
private GrpclbClientLoadRecorder getLoadRecorder() {
return balancer.getGrpclbState().getLoadRecorder();
}
private static List<EquivalentAddressGroup> createResolvedBackendAddresses(int n) {
List<EquivalentAddressGroup> list = new ArrayList<>();
for (int i = 0; i < n; i++) {
SocketAddress addr = new FakeSocketAddress("fake-address-" + i);
list.add(new EquivalentAddressGroup(addr));
}
return list;
}
private static List<EquivalentAddressGroup> createResolvedBalancerAddresses(int n) {
List<EquivalentAddressGroup> list = new ArrayList<>();
for (int i = 0; i < n; i++) {
SocketAddress addr = new FakeSocketAddress("fake-address-" + i);
list.add(new EquivalentAddressGroup(addr, lbAttributes(lbAuthority(i))));
}
return list;
}
private static String lbAuthority(int unused) {
// TODO(ejona): Support varying authorities
return "lb.google.com";
}
private static Attributes lbAttributes(String authority) {
return Attributes.newBuilder()
.set(GrpclbConstants.ATTR_LB_ADDR_AUTHORITY, authority)
.build();
}
private static LoadBalanceResponse buildInitialResponse() {
return buildInitialResponse(0);
}
private static LoadBalanceResponse buildInitialResponse(long loadReportIntervalMillis) {
return LoadBalanceResponse.newBuilder()
.setInitialResponse(
InitialLoadBalanceResponse.newBuilder()
.setClientStatsReportInterval(Durations.fromMillis(loadReportIntervalMillis)))
.build();
}
private static LoadBalanceResponse buildLbFallbackResponse() {
return LoadBalanceResponse.newBuilder()
.setFallbackResponse(FallbackResponse.newBuilder().build())
.build();
}
private static LoadBalanceResponse buildLbResponse(List<ServerEntry> servers) {
ServerList.Builder serverListBuilder = ServerList.newBuilder();
for (ServerEntry server : servers) {
if (server.addr != null) {
serverListBuilder.addServers(Server.newBuilder()
.setIpAddress(ByteString.copyFrom(server.addr.getAddress().getAddress()))
.setPort(server.addr.getPort())
.setLoadBalanceToken(server.token)
.build());
} else {
serverListBuilder.addServers(Server.newBuilder()
.setDrop(true)
.setLoadBalanceToken(server.token)
.build());
}
}
return LoadBalanceResponse.newBuilder()
.setServerList(serverListBuilder.build())
.build();
}
private static class ServerEntry {
final InetSocketAddress addr;
final String token;
ServerEntry(String host, int port, String token) {
this.addr = new InetSocketAddress(host, port);
this.token = token;
}
// Drop entry
ServerEntry(String token) {
this.addr = null;
this.token = token;
}
}
}
| grpclb/src/test/java/io/grpc/grpclb/GrpclbLoadBalancerTest.java | /*
* Copyright 2016 The gRPC 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 io.grpc.grpclb;
import static com.google.common.truth.Truth.assertThat;
import static io.grpc.ConnectivityState.CONNECTING;
import static io.grpc.ConnectivityState.IDLE;
import static io.grpc.ConnectivityState.READY;
import static io.grpc.ConnectivityState.SHUTDOWN;
import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
import static io.grpc.grpclb.GrpclbState.BUFFER_ENTRY;
import static io.grpc.grpclb.GrpclbState.DROP_PICK_RESULT;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.AdditionalAnswers.delegatesTo;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import com.google.common.collect.Iterables;
import com.google.protobuf.ByteString;
import com.google.protobuf.util.Durations;
import com.google.protobuf.util.Timestamps;
import io.grpc.Attributes;
import io.grpc.ChannelLogger;
import io.grpc.ClientStreamTracer;
import io.grpc.ConnectivityState;
import io.grpc.ConnectivityStateInfo;
import io.grpc.EquivalentAddressGroup;
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancer.Helper;
import io.grpc.LoadBalancer.PickResult;
import io.grpc.LoadBalancer.PickSubchannelArgs;
import io.grpc.LoadBalancer.ResolvedAddresses;
import io.grpc.LoadBalancer.Subchannel;
import io.grpc.LoadBalancer.SubchannelPicker;
import io.grpc.ManagedChannel;
import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.Status.Code;
import io.grpc.SynchronizationContext;
import io.grpc.grpclb.GrpclbState.BackendEntry;
import io.grpc.grpclb.GrpclbState.DropEntry;
import io.grpc.grpclb.GrpclbState.ErrorEntry;
import io.grpc.grpclb.GrpclbState.IdleSubchannelEntry;
import io.grpc.grpclb.GrpclbState.Mode;
import io.grpc.grpclb.GrpclbState.RoundRobinPicker;
import io.grpc.inprocess.InProcessChannelBuilder;
import io.grpc.inprocess.InProcessServerBuilder;
import io.grpc.internal.BackoffPolicy;
import io.grpc.internal.FakeClock;
import io.grpc.internal.JsonParser;
import io.grpc.lb.v1.ClientStats;
import io.grpc.lb.v1.ClientStatsPerToken;
import io.grpc.lb.v1.FallbackResponse;
import io.grpc.lb.v1.InitialLoadBalanceRequest;
import io.grpc.lb.v1.InitialLoadBalanceResponse;
import io.grpc.lb.v1.LoadBalanceRequest;
import io.grpc.lb.v1.LoadBalanceResponse;
import io.grpc.lb.v1.LoadBalancerGrpc;
import io.grpc.lb.v1.Server;
import io.grpc.lb.v1.ServerList;
import io.grpc.stub.StreamObserver;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import javax.annotation.Nullable;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
/** Unit tests for {@link GrpclbLoadBalancer}. */
@RunWith(JUnit4.class)
public class GrpclbLoadBalancerTest {
private static final String SERVICE_AUTHORITY = "api.google.com";
// The tasks are wrapped by SynchronizationContext, so we can't compare the types
// directly.
private static final FakeClock.TaskFilter LOAD_REPORTING_TASK_FILTER =
new FakeClock.TaskFilter() {
@Override
public boolean shouldAccept(Runnable command) {
return command.toString().contains(GrpclbState.LoadReportingTask.class.getSimpleName());
}
};
private static final FakeClock.TaskFilter FALLBACK_MODE_TASK_FILTER =
new FakeClock.TaskFilter() {
@Override
public boolean shouldAccept(Runnable command) {
return command.toString().contains(GrpclbState.FallbackModeTask.class.getSimpleName());
}
};
private static final FakeClock.TaskFilter LB_RPC_RETRY_TASK_FILTER =
new FakeClock.TaskFilter() {
@Override
public boolean shouldAccept(Runnable command) {
return command.toString().contains(GrpclbState.LbRpcRetryTask.class.getSimpleName());
}
};
private static final Attributes LB_BACKEND_ATTRS =
Attributes.newBuilder().set(GrpclbConstants.ATTR_LB_PROVIDED_BACKEND, true).build();
@Mock
private Helper helper;
@Mock
private SubchannelPool subchannelPool;
private final ArrayList<String> logs = new ArrayList<>();
private final ChannelLogger channelLogger = new ChannelLogger() {
@Override
public void log(ChannelLogLevel level, String msg) {
logs.add(level + ": " + msg);
}
@Override
public void log(ChannelLogLevel level, String template, Object... args) {
log(level, MessageFormat.format(template, args));
}
};
private SubchannelPicker currentPicker;
private LoadBalancerGrpc.LoadBalancerImplBase mockLbService;
@Captor
private ArgumentCaptor<StreamObserver<LoadBalanceResponse>> lbResponseObserverCaptor;
private final FakeClock fakeClock = new FakeClock();
private final LinkedList<StreamObserver<LoadBalanceRequest>> lbRequestObservers =
new LinkedList<>();
private final LinkedList<Subchannel> mockSubchannels = new LinkedList<>();
private final LinkedList<ManagedChannel> fakeOobChannels = new LinkedList<>();
private final ArrayList<Subchannel> pooledSubchannelTracker = new ArrayList<>();
private final ArrayList<Subchannel> unpooledSubchannelTracker = new ArrayList<>();
private final ArrayList<ManagedChannel> oobChannelTracker = new ArrayList<>();
private final ArrayList<String> failingLbAuthorities = new ArrayList<>();
private final SynchronizationContext syncContext = new SynchronizationContext(
new Thread.UncaughtExceptionHandler() {
@Override
public void uncaughtException(Thread t, Throwable e) {
throw new AssertionError(e);
}
});
private final GrpclbLoadBalancerProvider grpclbLoadBalancerProvider =
new GrpclbLoadBalancerProvider();
private static final ClientStreamTracer.StreamInfo STREAM_INFO =
ClientStreamTracer.StreamInfo.newBuilder().build();
private io.grpc.Server fakeLbServer;
@Captor
private ArgumentCaptor<SubchannelPicker> pickerCaptor;
@Mock
private BackoffPolicy.Provider backoffPolicyProvider;
@Mock
private BackoffPolicy backoffPolicy1;
@Mock
private BackoffPolicy backoffPolicy2;
private GrpclbLoadBalancer balancer;
@SuppressWarnings({"unchecked", "deprecation"})
@Before
public void setUp() throws Exception {
MockitoAnnotations.initMocks(this);
mockLbService = mock(LoadBalancerGrpc.LoadBalancerImplBase.class, delegatesTo(
new LoadBalancerGrpc.LoadBalancerImplBase() {
@Override
public StreamObserver<LoadBalanceRequest> balanceLoad(
final StreamObserver<LoadBalanceResponse> responseObserver) {
StreamObserver<LoadBalanceRequest> requestObserver =
mock(StreamObserver.class);
Answer<Void> closeRpc = new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) {
responseObserver.onCompleted();
return null;
}
};
doAnswer(closeRpc).when(requestObserver).onCompleted();
lbRequestObservers.add(requestObserver);
return requestObserver;
}
}));
fakeLbServer = InProcessServerBuilder.forName("fakeLb")
.directExecutor().addService(mockLbService).build().start();
doAnswer(new Answer<ManagedChannel>() {
@Override
public ManagedChannel answer(InvocationOnMock invocation) throws Throwable {
String authority = (String) invocation.getArguments()[1];
ManagedChannel channel;
if (failingLbAuthorities.contains(authority)) {
channel = InProcessChannelBuilder.forName("nonExistFakeLb").directExecutor()
.overrideAuthority(authority).build();
} else {
channel = InProcessChannelBuilder.forName("fakeLb").directExecutor()
.overrideAuthority(authority).build();
}
fakeOobChannels.add(channel);
oobChannelTracker.add(channel);
return channel;
}
}).when(helper).createOobChannel(any(EquivalentAddressGroup.class), any(String.class));
doAnswer(new Answer<Subchannel>() {
@Override
public Subchannel answer(InvocationOnMock invocation) throws Throwable {
Subchannel subchannel = mock(Subchannel.class);
EquivalentAddressGroup eag = (EquivalentAddressGroup) invocation.getArguments()[0];
Attributes attrs = (Attributes) invocation.getArguments()[1];
when(subchannel.getAllAddresses()).thenReturn(Arrays.asList(eag));
when(subchannel.getAttributes()).thenReturn(attrs);
mockSubchannels.add(subchannel);
pooledSubchannelTracker.add(subchannel);
return subchannel;
}
}).when(subchannelPool).takeOrCreateSubchannel(
any(EquivalentAddressGroup.class), any(Attributes.class));
doAnswer(new Answer<Subchannel>() {
@Override
public Subchannel answer(InvocationOnMock invocation) throws Throwable {
Subchannel subchannel = mock(Subchannel.class);
List<EquivalentAddressGroup> eagList =
(List<EquivalentAddressGroup>) invocation.getArguments()[0];
Attributes attrs = (Attributes) invocation.getArguments()[1];
when(subchannel.getAllAddresses()).thenReturn(eagList);
when(subchannel.getAttributes()).thenReturn(attrs);
mockSubchannels.add(subchannel);
unpooledSubchannelTracker.add(subchannel);
return subchannel;
}
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
}).when(helper).createSubchannel(any(List.class), any(Attributes.class));
when(helper.getSynchronizationContext()).thenReturn(syncContext);
when(helper.getScheduledExecutorService()).thenReturn(fakeClock.getScheduledExecutorService());
when(helper.getChannelLogger()).thenReturn(channelLogger);
doAnswer(new Answer<Void>() {
@Override
public Void answer(InvocationOnMock invocation) throws Throwable {
currentPicker = (SubchannelPicker) invocation.getArguments()[1];
return null;
}
}).when(helper).updateBalancingState(
any(ConnectivityState.class), any(SubchannelPicker.class));
when(helper.getAuthority()).thenReturn(SERVICE_AUTHORITY);
when(backoffPolicy1.nextBackoffNanos()).thenReturn(10L, 100L);
when(backoffPolicy2.nextBackoffNanos()).thenReturn(10L, 100L);
when(backoffPolicyProvider.get()).thenReturn(backoffPolicy1, backoffPolicy2);
balancer = new GrpclbLoadBalancer(helper, subchannelPool, fakeClock.getTimeProvider(),
fakeClock.getStopwatchSupplier().get(),
backoffPolicyProvider);
verify(subchannelPool).init(same(helper), same(balancer));
}
@After
public void tearDown() {
try {
if (balancer != null) {
syncContext.execute(new Runnable() {
@Override
public void run() {
balancer.shutdown();
}
});
}
for (ManagedChannel channel : oobChannelTracker) {
assertTrue(channel + " is shutdown", channel.isShutdown());
// balancer should have closed the LB stream, terminating the OOB channel.
assertTrue(channel + " is terminated", channel.isTerminated());
}
// GRPCLB manages subchannels only through subchannelPool
for (Subchannel subchannel : pooledSubchannelTracker) {
verify(subchannelPool).returnSubchannel(same(subchannel), any(ConnectivityStateInfo.class));
// Our mock subchannelPool never calls Subchannel.shutdown(), thus we can tell if
// LoadBalancer has called it expectedly.
verify(subchannel, never()).shutdown();
}
for (Subchannel subchannel : unpooledSubchannelTracker) {
verify(subchannel).shutdown();
}
// No timer should linger after shutdown
assertThat(fakeClock.getPendingTasks()).isEmpty();
} finally {
if (fakeLbServer != null) {
fakeLbServer.shutdownNow();
}
}
}
@Test
public void roundRobinPickerNoDrop() {
GrpclbClientLoadRecorder loadRecorder =
new GrpclbClientLoadRecorder(fakeClock.getTimeProvider());
Subchannel subchannel = mock(Subchannel.class);
BackendEntry b1 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0001");
BackendEntry b2 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0002");
List<BackendEntry> pickList = Arrays.asList(b1, b2);
RoundRobinPicker picker = new RoundRobinPicker(Collections.<DropEntry>emptyList(), pickList);
PickSubchannelArgs args1 = mock(PickSubchannelArgs.class);
Metadata headers1 = new Metadata();
// The existing token on the headers will be replaced
headers1.put(GrpclbConstants.TOKEN_METADATA_KEY, "LBTOKEN__OLD");
when(args1.getHeaders()).thenReturn(headers1);
assertSame(b1.result, picker.pickSubchannel(args1));
verify(args1).getHeaders();
assertThat(headers1.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
PickSubchannelArgs args2 = mock(PickSubchannelArgs.class);
Metadata headers2 = new Metadata();
when(args2.getHeaders()).thenReturn(headers2);
assertSame(b2.result, picker.pickSubchannel(args2));
verify(args2).getHeaders();
assertThat(headers2.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0002");
PickSubchannelArgs args3 = mock(PickSubchannelArgs.class);
Metadata headers3 = new Metadata();
when(args3.getHeaders()).thenReturn(headers3);
assertSame(b1.result, picker.pickSubchannel(args3));
verify(args3).getHeaders();
assertThat(headers3.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
verify(subchannel, never()).getAttributes();
}
@Test
public void roundRobinPickerWithDrop() {
assertTrue(DROP_PICK_RESULT.isDrop());
GrpclbClientLoadRecorder loadRecorder =
new GrpclbClientLoadRecorder(fakeClock.getTimeProvider());
Subchannel subchannel = mock(Subchannel.class);
// 1 out of 2 requests are to be dropped
DropEntry d = new DropEntry(loadRecorder, "LBTOKEN0003");
List<DropEntry> dropList = Arrays.asList(null, d);
BackendEntry b1 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0001");
BackendEntry b2 = new BackendEntry(subchannel, loadRecorder, "LBTOKEN0002");
List<BackendEntry> pickList = Arrays.asList(b1, b2);
RoundRobinPicker picker = new RoundRobinPicker(dropList, pickList);
// dropList[0], pickList[0]
PickSubchannelArgs args1 = mock(PickSubchannelArgs.class);
Metadata headers1 = new Metadata();
headers1.put(GrpclbConstants.TOKEN_METADATA_KEY, "LBTOKEN__OLD");
when(args1.getHeaders()).thenReturn(headers1);
assertSame(b1.result, picker.pickSubchannel(args1));
verify(args1).getHeaders();
assertThat(headers1.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
// dropList[1]: drop
PickSubchannelArgs args2 = mock(PickSubchannelArgs.class);
Metadata headers2 = new Metadata();
when(args2.getHeaders()).thenReturn(headers2);
assertSame(DROP_PICK_RESULT, picker.pickSubchannel(args2));
verify(args2, never()).getHeaders();
// dropList[0], pickList[1]
PickSubchannelArgs args3 = mock(PickSubchannelArgs.class);
Metadata headers3 = new Metadata();
when(args3.getHeaders()).thenReturn(headers3);
assertSame(b2.result, picker.pickSubchannel(args3));
verify(args3).getHeaders();
assertThat(headers3.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0002");
// dropList[1]: drop
PickSubchannelArgs args4 = mock(PickSubchannelArgs.class);
Metadata headers4 = new Metadata();
when(args4.getHeaders()).thenReturn(headers4);
assertSame(DROP_PICK_RESULT, picker.pickSubchannel(args4));
verify(args4, never()).getHeaders();
// dropList[0], pickList[0]
PickSubchannelArgs args5 = mock(PickSubchannelArgs.class);
Metadata headers5 = new Metadata();
when(args5.getHeaders()).thenReturn(headers5);
assertSame(b1.result, picker.pickSubchannel(args5));
verify(args5).getHeaders();
assertThat(headers5.getAll(GrpclbConstants.TOKEN_METADATA_KEY)).containsExactly("LBTOKEN0001");
verify(subchannel, never()).getAttributes();
}
@Test
public void roundRobinPickerWithIdleEntry_noDrop() {
Subchannel subchannel = mock(Subchannel.class);
IdleSubchannelEntry entry = new IdleSubchannelEntry(subchannel, syncContext);
RoundRobinPicker picker =
new RoundRobinPicker(Collections.<DropEntry>emptyList(), Collections.singletonList(entry));
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
verify(subchannel, never()).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
verify(subchannel).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
// Only the first pick triggers requestConnection()
verify(subchannel).requestConnection();
}
@Test
public void roundRobinPickerWithIdleEntry_andDrop() {
GrpclbClientLoadRecorder loadRecorder =
new GrpclbClientLoadRecorder(fakeClock.getTimeProvider());
// 1 out of 2 requests are to be dropped
DropEntry d = new DropEntry(loadRecorder, "LBTOKEN0003");
List<DropEntry> dropList = Arrays.asList(null, d);
Subchannel subchannel = mock(Subchannel.class);
IdleSubchannelEntry entry = new IdleSubchannelEntry(subchannel, syncContext);
RoundRobinPicker picker = new RoundRobinPicker(dropList, Collections.singletonList(entry));
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
verify(subchannel, never()).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
verify(subchannel).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(DROP_PICK_RESULT);
verify(subchannel).requestConnection();
assertThat(picker.pickSubchannel(args)).isSameInstanceAs(PickResult.withNoResult());
// Only the first pick triggers requestConnection()
verify(subchannel).requestConnection();
}
@Test
public void loadReporting() {
Metadata headers = new Metadata();
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
when(args.getHeaders()).thenReturn(headers);
long loadReportIntervalMillis = 1983;
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
// Fallback timer is started as soon as address is resolved.
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
InOrder inOrder = inOrder(lbRequestObserver);
InOrder helperInOrder = inOrder(helper, subchannelPool);
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// Load reporting task is scheduled
assertEquals(1, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
assertEquals(0, fakeClock.runDueTasks());
List<ServerEntry> backends = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("token0001"), // drop
new ServerEntry("127.0.0.1", 2010, "token0002"),
new ServerEntry("token0003")); // drop
lbResponseObserver.onNext(buildLbResponse(backends));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
helperInOrder.verify(helper, atLeast(1))
.updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0001"),
null,
new DropEntry(getLoadRecorder(), "token0003")).inOrder();
assertThat(picker.pickList).containsExactly(
new BackendEntry(subchannel1, getLoadRecorder(), "token0001"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0002")).inOrder();
// Report, no data
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder().build());
PickResult pick1 = picker.pickSubchannel(args);
assertSame(subchannel1, pick1.getSubchannel());
assertSame(getLoadRecorder(), pick1.getStreamTracerFactory());
// Merely the pick will not be recorded as upstart.
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder().build());
ClientStreamTracer tracer1 =
pick1.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
PickResult pick2 = picker.pickSubchannel(args);
assertNull(pick2.getSubchannel());
assertSame(DROP_PICK_RESULT, pick2);
// Report includes upstart of pick1 and the drop of pick2
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(2)
.setNumCallsFinished(1) // pick2
.addCallsFinishedWithDrop(
ClientStatsPerToken.newBuilder()
.setLoadBalanceToken("token0001")
.setNumCalls(1) // pick2
.build())
.build());
PickResult pick3 = picker.pickSubchannel(args);
assertSame(subchannel2, pick3.getSubchannel());
assertSame(getLoadRecorder(), pick3.getStreamTracerFactory());
ClientStreamTracer tracer3 =
pick3.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
// pick3 has sent out headers
tracer3.outboundHeaders();
// 3rd report includes pick3's upstart
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1)
.build());
PickResult pick4 = picker.pickSubchannel(args);
assertNull(pick4.getSubchannel());
assertSame(DROP_PICK_RESULT, pick4);
// pick1 ended without sending anything
tracer1.streamClosed(Status.CANCELLED);
// 4th report includes end of pick1 and drop of pick4
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1) // pick4
.setNumCallsFinished(2)
.setNumCallsFinishedWithClientFailedToSend(1) // pick1
.addCallsFinishedWithDrop(
ClientStatsPerToken.newBuilder()
.setLoadBalanceToken("token0003")
.setNumCalls(1) // pick4
.build())
.build());
PickResult pick5 = picker.pickSubchannel(args);
assertSame(subchannel1, pick1.getSubchannel());
assertSame(getLoadRecorder(), pick5.getStreamTracerFactory());
ClientStreamTracer tracer5 =
pick5.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
// pick3 ended without receiving response headers
tracer3.streamClosed(Status.DEADLINE_EXCEEDED);
// pick5 sent and received headers
tracer5.outboundHeaders();
tracer5.inboundHeaders();
// 5th report includes pick3's end and pick5's upstart
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1) // pick5
.setNumCallsFinished(1) // pick3
.build());
// pick5 ends
tracer5.streamClosed(Status.OK);
// 6th report includes pick5's end
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsFinished(1)
.setNumCallsFinishedKnownReceived(1)
.build());
assertEquals(1, fakeClock.numPendingTasks());
// Balancer closes the stream, scheduled reporting task cancelled
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
assertEquals(0, fakeClock.numPendingTasks());
// New stream created
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
inOrder = inOrder(lbRequestObserver);
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Load reporting is also requested
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// No picker created because balancer is still using the results from the last stream
helperInOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// Make a new pick on that picker. It will not show up on the report of the new stream, because
// that picker is associated with the previous stream.
PickResult pick6 = picker.pickSubchannel(args);
assertNull(pick6.getSubchannel());
assertSame(DROP_PICK_RESULT, pick6);
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder().build());
// New stream got the list update
lbResponseObserver.onNext(buildLbResponse(backends));
// Same backends, thus no new subchannels
helperInOrder.verify(subchannelPool, never()).takeOrCreateSubchannel(
any(EquivalentAddressGroup.class), any(Attributes.class));
// But the new RoundRobinEntries have a new loadRecorder, thus considered different from
// the previous list, thus a new picker is created
helperInOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
picker = (RoundRobinPicker) pickerCaptor.getValue();
PickResult pick1p = picker.pickSubchannel(args);
assertSame(subchannel1, pick1p.getSubchannel());
assertSame(getLoadRecorder(), pick1p.getStreamTracerFactory());
pick1p.getStreamTracerFactory().newClientStreamTracer(STREAM_INFO, new Metadata());
// The pick from the new stream will be included in the report
assertNextReport(
inOrder, lbRequestObserver, loadReportIntervalMillis,
ClientStats.newBuilder()
.setNumCallsStarted(1)
.build());
verify(args, atLeast(0)).getHeaders();
verifyNoMoreInteractions(args);
}
@Test
public void abundantInitialResponse() {
Metadata headers = new Metadata();
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
when(args.getHeaders()).thenReturn(headers);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
// Simulate LB initial response
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
lbResponseObserver.onNext(buildInitialResponse(1983));
// Load reporting task is scheduled
assertEquals(1, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
FakeClock.ScheduledTask scheduledTask =
Iterables.getOnlyElement(fakeClock.getPendingTasks(LOAD_REPORTING_TASK_FILTER));
assertEquals(1983, scheduledTask.getDelay(TimeUnit.MILLISECONDS));
logs.clear();
// Simulate an abundant LB initial response, with a different report interval
lbResponseObserver.onNext(buildInitialResponse(9097));
// This incident is logged
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildInitialResponse(9097),
"WARNING: Ignoring unexpected response type: INITIAL_RESPONSE").inOrder();
// It doesn't affect load-reporting at all
assertThat(fakeClock.getPendingTasks(LOAD_REPORTING_TASK_FILTER))
.containsExactly(scheduledTask);
assertEquals(1983, scheduledTask.getDelay(TimeUnit.MILLISECONDS));
}
@Test
public void raceBetweenLoadReportingAndLbStreamClosure() {
Metadata headers = new Metadata();
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
when(args.getHeaders()).thenReturn(headers);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
InOrder inOrder = inOrder(lbRequestObserver);
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
lbResponseObserver.onNext(buildInitialResponse(1983));
// Load reporting task is scheduled
assertEquals(1, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
FakeClock.ScheduledTask scheduledTask =
Iterables.getOnlyElement(fakeClock.getPendingTasks(LOAD_REPORTING_TASK_FILTER));
assertEquals(1983, scheduledTask.getDelay(TimeUnit.MILLISECONDS));
// Close lbStream
lbResponseObserver.onCompleted();
// Reporting task cancelled
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
// Simulate a race condition where the task has just started when its cancelled
scheduledTask.command.run();
// No report sent. No new task scheduled
inOrder.verify(lbRequestObserver, never()).onNext(any(LoadBalanceRequest.class));
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
}
private void assertNextReport(
InOrder inOrder, StreamObserver<LoadBalanceRequest> lbRequestObserver,
long loadReportIntervalMillis, ClientStats expectedReport) {
assertEquals(0, fakeClock.forwardTime(loadReportIntervalMillis - 1, TimeUnit.MILLISECONDS));
inOrder.verifyNoMoreInteractions();
assertEquals(1, fakeClock.forwardTime(1, TimeUnit.MILLISECONDS));
assertEquals(1, fakeClock.numPendingTasks());
inOrder.verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder()
.setClientStats(
ClientStats.newBuilder(expectedReport)
.setTimestamp(Timestamps.fromNanos(fakeClock.getTicker().read()))
.build())
.build()));
}
@Test
public void receiveNoBackendAndBalancerAddress() {
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
Collections.<EquivalentAddressGroup>emptyList(),
Attributes.EMPTY);
verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).isEmpty();
Status error = Iterables.getOnlyElement(picker.pickList).picked(new Metadata()).getStatus();
assertThat(error.getCode()).isEqualTo(Code.UNAVAILABLE);
assertThat(error.getDescription()).isEqualTo("No backend or balancer addresses found");
}
@Test
public void nameResolutionFailsThenRecover() {
Status error = Status.NOT_FOUND.withDescription("www.google.com not found");
deliverNameResolutionError(error);
verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
assertThat(logs).containsExactly(
"DEBUG: Error: " + error,
"INFO: TRANSIENT_FAILURE: picks="
+ "[Status{code=NOT_FOUND, description=www.google.com not found, cause=null}],"
+ " drops=[]")
.inOrder();
logs.clear();
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).isEmpty();
assertThat(picker.pickList).containsExactly(new ErrorEntry(error));
// Recover with a subsequent success
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
EquivalentAddressGroup eag = grpclbBalancerList.get(0);
Attributes resolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList, resolutionAttrs);
verify(helper).createOobChannel(eq(eag), eq(lbAuthority(0)));
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
}
@Test
public void grpclbThenNameResolutionFails() {
InOrder inOrder = inOrder(helper, subchannelPool);
// Go to GRPCLB first
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
// Let name resolution fail before round-robin list is ready
Status error = Status.NOT_FOUND.withDescription("www.google.com not found");
deliverNameResolutionError(error);
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList).isEmpty();
assertThat(picker.pickList).containsExactly(new ErrorEntry(error));
assertFalse(oobChannel.isShutdown());
// Simulate receiving LB response
List<ServerEntry> backends = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "TOKEN1"),
new ServerEntry("127.0.0.1", 2010, "TOKEN2"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
}
@Test
public void grpclbUpdatedAddresses_avoidsReconnect() {
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
ManagedChannel oobChannel = fakeOobChannels.poll();
assertEquals(1, lbRequestObservers.size());
List<EquivalentAddressGroup> backendList2 = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList2 = createResolvedBalancerAddresses(2);
EquivalentAddressGroup combinedEag = new EquivalentAddressGroup(Arrays.asList(
grpclbBalancerList2.get(0).getAddresses().get(0),
grpclbBalancerList2.get(1).getAddresses().get(0)),
lbAttributes(lbAuthority(0)));
deliverResolvedAddresses(backendList2, grpclbBalancerList2, grpclbResolutionAttrs);
verify(helper).updateOobChannelAddresses(eq(oobChannel), eq(combinedEag));
assertEquals(1, lbRequestObservers.size()); // No additional RPC
}
@Test
public void grpclbUpdatedAddresses_reconnectOnAuthorityChange() {
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
ManagedChannel oobChannel = fakeOobChannels.poll();
assertEquals(1, lbRequestObservers.size());
final String newAuthority = "some-new-authority";
List<EquivalentAddressGroup> backendList2 = createResolvedBackendAddresses(1);
List<EquivalentAddressGroup> grpclbBalancerList2 =
Collections.singletonList(
new EquivalentAddressGroup(
new FakeSocketAddress("somethingNew"), lbAttributes(newAuthority)));
deliverResolvedAddresses(
backendList2, grpclbBalancerList2, grpclbResolutionAttrs);
assertTrue(oobChannel.isTerminated());
verify(helper).createOobChannel(eq(grpclbBalancerList2.get(0)), eq(newAuthority));
assertEquals(2, lbRequestObservers.size()); // An additional RPC
}
@Test
public void grpclbWorking() {
InOrder inOrder = inOrder(helper, subchannelPool);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
// Fallback timer is started as soon as the addresses are resolved.
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
logs.clear();
lbResponseObserver.onNext(buildInitialResponse());
assertThat(logs).containsExactly("DEBUG: Got an LB response: " + buildInitialResponse());
logs.clear();
lbResponseObserver.onNext(buildLbResponse(backends1));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannel1).requestConnection();
verify(subchannel2).requestConnection();
assertEquals(
new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS),
subchannel1.getAddresses());
assertEquals(
new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS),
subchannel2.getAddresses());
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(BUFFER_ENTRY);
inOrder.verifyNoMoreInteractions();
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends1),
"INFO: Using RR list="
+ "[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}](token0001),"
+ " [[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}](token0002)],"
+ " drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
logs.clear();
// Let subchannels be connected
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0001)],"
+ " [[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(
new BackendEntry(subchannel1, getLoadRecorder(), "token0001"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"))
.inOrder();
// Disconnected subchannels
verify(subchannel1).requestConnection();
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(IDLE));
verify(subchannel1, times(2)).requestConnection();
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verifyNoMoreInteractions();
// As long as there is at least one READY subchannel, round robin will work.
ConnectivityStateInfo errorState1 =
ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE.withDescription("error1"));
deliverSubchannelState(subchannel1, errorState1);
inOrder.verifyNoMoreInteractions();
// If no subchannel is READY, some with error and the others are IDLE, will report CONNECTING
verify(subchannel2).requestConnection();
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(IDLE));
verify(subchannel2, times(2)).requestConnection();
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]");
logs.clear();
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.dropList).containsExactly(null, null);
assertThat(picker4.pickList).containsExactly(BUFFER_ENTRY);
// Update backends, with a drop entry
List<ServerEntry> backends2 =
Arrays.asList(
new ServerEntry("127.0.0.1", 2030, "token0003"), // New address
new ServerEntry("token0003"), // drop
new ServerEntry("127.0.0.1", 2010, "token0004"), // Existing address with token changed
new ServerEntry("127.0.0.1", 2030, "token0005"), // New address appearing second time
new ServerEntry("token0006")); // drop
verify(subchannelPool, never())
.returnSubchannel(same(subchannel1), any(ConnectivityStateInfo.class));
lbResponseObserver.onNext(buildLbResponse(backends2));
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends2),
"INFO: Using RR list="
+ "[[[/127.0.0.1:2030]/{io.grpc.grpclb.lbProvidedBackend=true}](token0003),"
+ " [[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}](token0004),"
+ " [[/127.0.0.1:2030]/{io.grpc.grpclb.lbProvidedBackend=true}](token0005)],"
+ " drop=[null, drop(token0003), null, null, drop(token0006)]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY],"
+ " drops=[null, drop(token0003), null, null, drop(token0006)]")
.inOrder();
logs.clear();
// not in backends2, closed
verify(subchannelPool).returnSubchannel(same(subchannel1), same(errorState1));
// backends2[2], will be kept
verify(subchannelPool, never())
.returnSubchannel(same(subchannel2), any(ConnectivityStateInfo.class));
inOrder.verify(subchannelPool, never()).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends2.get(2).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends2.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
ConnectivityStateInfo errorOnCachedSubchannel1 =
ConnectivityStateInfo.forTransientFailure(
Status.UNAVAILABLE.withDescription("You can get this error even if you are cached"));
deliverSubchannelState(subchannel1, errorOnCachedSubchannel1);
verify(subchannelPool).handleSubchannelState(same(subchannel1), same(errorOnCachedSubchannel1));
assertEquals(1, mockSubchannels.size());
Subchannel subchannel3 = mockSubchannels.poll();
verify(subchannel3).requestConnection();
assertEquals(
new EquivalentAddressGroup(backends2.get(0).addr, LB_BACKEND_ATTRS),
subchannel3.getAddresses());
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker7 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker7.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0003"),
null,
null,
new DropEntry(getLoadRecorder(), "token0006")).inOrder();
assertThat(picker7.pickList).containsExactly(BUFFER_ENTRY);
// State updates on obsolete subchannel1 will only be passed to the pool
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
deliverSubchannelState(
subchannel1, ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(SHUTDOWN));
inOrder.verify(subchannelPool)
.handleSubchannelState(same(subchannel1), eq(ConnectivityStateInfo.forNonError(READY)));
inOrder.verify(subchannelPool).handleSubchannelState(
same(subchannel1), eq(ConnectivityStateInfo.forTransientFailure(Status.UNAVAILABLE)));
inOrder.verifyNoMoreInteractions();
deliverSubchannelState(subchannel3, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker8 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker8.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0003"),
null,
null,
new DropEntry(getLoadRecorder(), "token0006")).inOrder();
// subchannel2 is still IDLE, thus not in the active list
assertThat(picker8.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token0003"),
new BackendEntry(subchannel3, getLoadRecorder(), "token0005")).inOrder();
// subchannel2 becomes READY and makes it into the list
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker9 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker9.dropList).containsExactly(
null,
new DropEntry(getLoadRecorder(), "token0003"),
null,
null,
new DropEntry(getLoadRecorder(), "token0006")).inOrder();
assertThat(picker9.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token0003"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0004"),
new BackendEntry(subchannel3, getLoadRecorder(), "token0005")).inOrder();
verify(subchannelPool, never())
.returnSubchannel(same(subchannel3), any(ConnectivityStateInfo.class));
// Update backends, with no entry
lbResponseObserver.onNext(buildLbResponse(Collections.<ServerEntry>emptyList()));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(READY)));
verify(subchannelPool)
.returnSubchannel(same(subchannel3), eq(ConnectivityStateInfo.forNonError(READY)));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker10 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker10.dropList).isEmpty();
assertThat(picker10.pickList).containsExactly(BUFFER_ENTRY);
assertFalse(oobChannel.isShutdown());
assertEquals(0, lbRequestObservers.size());
verify(lbRequestObserver, never()).onCompleted();
verify(lbRequestObserver, never()).onError(any(Throwable.class));
// Load reporting was not requested, thus never scheduled
assertEquals(0, fakeClock.numPendingTasks(LOAD_REPORTING_TASK_FILTER));
verify(subchannelPool, never()).clear();
balancer.shutdown();
verify(subchannelPool).clear();
}
@Test
public void grpclbFallback_initialTimeout_serverListReceivedBeforeTimerExpires() {
subtestGrpclbFallbackInitialTimeout(false);
}
@Test
public void grpclbFallback_initialTimeout_timerExpires() {
subtestGrpclbFallbackInitialTimeout(true);
}
// Fallback or not within the period of the initial timeout.
private void subtestGrpclbFallbackInitialTimeout(boolean timerExpires) {
long loadReportIntervalMillis = 1983;
InOrder inOrder = inOrder(helper, subchannelPool);
// Create balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes resolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
inOrder.verify(helper)
.createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
// Attempted to connect to balancer
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// We don't care if these methods have been run.
inOrder.verify(helper, atLeast(0)).getSynchronizationContext();
inOrder.verify(helper, atLeast(0)).getScheduledExecutorService();
inOrder.verifyNoMoreInteractions();
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
fakeClock.forwardTime(GrpclbState.FALLBACK_TIMEOUT_MS - 1, TimeUnit.MILLISECONDS);
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
//////////////////////////////////
// Fallback timer expires (or not)
//////////////////////////////////
if (timerExpires) {
logs.clear();
fakeClock.forwardTime(1, TimeUnit.MILLISECONDS);
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
List<EquivalentAddressGroup> fallbackList =
Arrays.asList(backendList.get(0), backendList.get(1));
assertThat(logs).containsExactly(
"INFO: Using fallback backends",
"INFO: Using RR list=[[[FakeSocketAddress-fake-address-0]/{}], "
+ "[[FakeSocketAddress-fake-address-1]/{}]], drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
// Fall back to the backends from resolver
fallbackTestVerifyUseOfFallbackBackendLists(inOrder, fallbackList);
assertFalse(oobChannel.isShutdown());
verify(lbRequestObserver, never()).onCompleted();
}
//////////////////////////////////////////////////////////////////////
// Name resolver sends new resolution results without any backend addr
//////////////////////////////////////////////////////////////////////
grpclbBalancerList = createResolvedBalancerAddresses(2);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),grpclbBalancerList, resolutionAttrs);
// New addresses are updated to the OobChannel
inOrder.verify(helper).updateOobChannelAddresses(
same(oobChannel),
eq(new EquivalentAddressGroup(
Arrays.asList(
grpclbBalancerList.get(0).getAddresses().get(0),
grpclbBalancerList.get(1).getAddresses().get(0)),
lbAttributes(lbAuthority(0)))));
if (timerExpires) {
// Still in fallback logic, except that the backend list is empty
fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Collections.<EquivalentAddressGroup>emptyList());
}
////////////////////////////////////////////////////////////////
// Name resolver sends new resolution results with backend addrs
////////////////////////////////////////////////////////////////
backendList = createResolvedBackendAddresses(2);
grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
// New LB address is updated to the OobChannel
inOrder.verify(helper).updateOobChannelAddresses(
same(oobChannel),
eq(grpclbBalancerList.get(0)));
if (timerExpires) {
// New backend addresses are used for fallback
fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Arrays.asList(backendList.get(0), backendList.get(1)));
}
////////////////////////////////////////////////
// Break the LB stream after the timer expires
////////////////////////////////////////////////
if (timerExpires) {
Status streamError = Status.UNAVAILABLE.withDescription("OOB stream broken");
lbResponseObserver.onError(streamError.asException());
// The error will NOT propagate to picker because fallback list is in use.
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// A new stream is created
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
}
/////////////////////////////////
// Balancer returns a server list
/////////////////////////////////
List<ServerEntry> serverList = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(serverList));
// Balancer-provided server list now in effect
fallbackTestVerifyUseOfBalancerBackendLists(inOrder, serverList);
///////////////////////////////////////////////////////////////
// New backend addresses from resolver outside of fallback mode
///////////////////////////////////////////////////////////////
backendList = createResolvedBackendAddresses(1);
grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
// Will not affect the round robin list at all
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// No fallback timeout timer scheduled.
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
}
@Test
public void grpclbFallback_breakLbStreamBeforeFallbackTimerExpires() {
long loadReportIntervalMillis = 1983;
InOrder inOrder = inOrder(helper, subchannelPool);
// Create balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes resolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
inOrder.verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
// Attempted to connect to balancer
assertThat(fakeOobChannels).hasSize(1);
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertThat(lbRequestObservers).hasSize(1);
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// We don't care if these methods have been run.
inOrder.verify(helper, atLeast(0)).getSynchronizationContext();
inOrder.verify(helper, atLeast(0)).getScheduledExecutorService();
inOrder.verifyNoMoreInteractions();
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
/////////////////////////////////////////////
// Break the LB stream before timer expires
/////////////////////////////////////////////
Status streamError = Status.UNAVAILABLE.withDescription("OOB stream broken");
lbResponseObserver.onError(streamError.asException());
// Fall back to the backends from resolver
fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Arrays.asList(backendList.get(0), backendList.get(1)));
// A new stream is created
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
assertThat(lbRequestObservers).hasSize(1);
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
}
@Test
public void grpclbFallback_noBalancerAddress() {
InOrder inOrder = inOrder(helper, subchannelPool);
// Create just backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
Attributes resolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
backendList, Collections.<EquivalentAddressGroup>emptyList(), resolutionAttrs);
assertThat(logs).containsExactly(
"INFO: Using fallback backends",
"INFO: Using RR list=[[[FakeSocketAddress-fake-address-0]/{}], "
+ "[[FakeSocketAddress-fake-address-1]/{}]], drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
// Fall back to the backends from resolver
fallbackTestVerifyUseOfFallbackBackendLists(inOrder, backendList);
// No fallback timeout timer scheduled.
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
verify(helper, never())
.createOobChannel(any(EquivalentAddressGroup.class), anyString());
}
@Test
public void grpclbFallback_balancerLost() {
subtestGrpclbFallbackConnectionLost(true, false);
}
@Test
public void grpclbFallback_subchannelsLost() {
subtestGrpclbFallbackConnectionLost(false, true);
}
@Test
public void grpclbFallback_allLost() {
subtestGrpclbFallbackConnectionLost(true, true);
}
// Fallback outside of the initial timeout, where all connections are lost.
private void subtestGrpclbFallbackConnectionLost(
boolean balancerBroken, boolean allSubchannelsBroken) {
long loadReportIntervalMillis = 1983;
InOrder inOrder = inOrder(helper, mockLbService, subchannelPool);
// Create balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes resolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
inOrder.verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
// Attempted to connect to balancer
assertEquals(1, fakeOobChannels.size());
fakeOobChannels.poll();
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
lbResponseObserver.onNext(buildInitialResponse(loadReportIntervalMillis));
// We don't care if these methods have been run.
inOrder.verify(helper, atLeast(0)).getSynchronizationContext();
inOrder.verify(helper, atLeast(0)).getScheduledExecutorService();
inOrder.verifyNoMoreInteractions();
// Balancer returns a server list
List<ServerEntry> serverList = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(serverList));
List<Subchannel> subchannels = fallbackTestVerifyUseOfBalancerBackendLists(inOrder, serverList);
// Break connections
if (balancerBroken) {
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// A new stream to LB is created
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
}
if (allSubchannelsBroken) {
for (Subchannel subchannel : subchannels) {
// A READY subchannel transits to IDLE when receiving a go-away
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(IDLE));
}
}
if (balancerBroken && allSubchannelsBroken) {
// Going into fallback
subchannels = fallbackTestVerifyUseOfFallbackBackendLists(
inOrder, Arrays.asList(backendList.get(0), backendList.get(1)));
// When in fallback mode, fallback timer should not be scheduled when all backend
// connections are lost
for (Subchannel subchannel : subchannels) {
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(IDLE));
}
// Exit fallback mode or cancel fallback timer when receiving a new server list from balancer
List<ServerEntry> serverList2 = Arrays.asList(
new ServerEntry("127.0.0.1", 2001, "token0003"),
new ServerEntry("127.0.0.1", 2011, "token0004"));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(serverList2));
fallbackTestVerifyUseOfBalancerBackendLists(inOrder, serverList2);
}
assertEquals(0, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
if (!(balancerBroken && allSubchannelsBroken)) {
verify(subchannelPool, never()).takeOrCreateSubchannel(
eq(backendList.get(0)), any(Attributes.class));
verify(subchannelPool, never()).takeOrCreateSubchannel(
eq(backendList.get(1)), any(Attributes.class));
}
}
private List<Subchannel> fallbackTestVerifyUseOfFallbackBackendLists(
InOrder inOrder, List<EquivalentAddressGroup> addrs) {
return fallbackTestVerifyUseOfBackendLists(inOrder, addrs, null);
}
private List<Subchannel> fallbackTestVerifyUseOfBalancerBackendLists(
InOrder inOrder, List<ServerEntry> servers) {
ArrayList<EquivalentAddressGroup> addrs = new ArrayList<>();
ArrayList<String> tokens = new ArrayList<>();
for (ServerEntry server : servers) {
addrs.add(new EquivalentAddressGroup(server.addr, LB_BACKEND_ATTRS));
tokens.add(server.token);
}
return fallbackTestVerifyUseOfBackendLists(inOrder, addrs, tokens);
}
private List<Subchannel> fallbackTestVerifyUseOfBackendLists(
InOrder inOrder, List<EquivalentAddressGroup> addrs,
@Nullable List<String> tokens) {
if (tokens != null) {
assertEquals(addrs.size(), tokens.size());
}
for (EquivalentAddressGroup addr : addrs) {
inOrder.verify(subchannelPool).takeOrCreateSubchannel(eq(addr), any(Attributes.class));
}
RoundRobinPicker picker = (RoundRobinPicker) currentPicker;
assertThat(picker.dropList).containsExactlyElementsIn(Collections.nCopies(addrs.size(), null));
assertThat(picker.pickList).containsExactly(GrpclbState.BUFFER_ENTRY);
assertEquals(addrs.size(), mockSubchannels.size());
ArrayList<Subchannel> subchannels = new ArrayList<>(mockSubchannels);
mockSubchannels.clear();
for (Subchannel subchannel : subchannels) {
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
}
inOrder.verify(helper, atLeast(0))
.updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
ArrayList<BackendEntry> pickList = new ArrayList<>();
for (int i = 0; i < addrs.size(); i++) {
Subchannel subchannel = subchannels.get(i);
BackendEntry backend;
if (tokens == null) {
backend = new BackendEntry(subchannel);
} else {
backend = new BackendEntry(subchannel, getLoadRecorder(), tokens.get(i));
}
pickList.add(backend);
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
picker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker.dropList)
.containsExactlyElementsIn(Collections.nCopies(addrs.size(), null));
assertThat(picker.pickList).containsExactlyElementsIn(pickList);
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
}
return subchannels;
}
@Test
public void grpclbMultipleAuthorities() throws Exception {
List<EquivalentAddressGroup> backendList = Collections.singletonList(
new EquivalentAddressGroup(new FakeSocketAddress("not-a-lb-address")));
List<EquivalentAddressGroup> grpclbBalancerList = Arrays.asList(
new EquivalentAddressGroup(
new FakeSocketAddress("fake-address-1"),
lbAttributes("fake-authority-1")),
new EquivalentAddressGroup(
new FakeSocketAddress("fake-address-2"),
lbAttributes("fake-authority-2")),
new EquivalentAddressGroup(
new FakeSocketAddress("fake-address-3"),
lbAttributes("fake-authority-1")));
final EquivalentAddressGroup goldenOobChannelEag = new EquivalentAddressGroup(
Arrays.<SocketAddress>asList(
new FakeSocketAddress("fake-address-1"),
new FakeSocketAddress("fake-address-3")),
lbAttributes("fake-authority-1")); // Supporting multiple authorities would be good, one day
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
verify(helper).createOobChannel(goldenOobChannelEag, "fake-authority-1");
}
@Test
public void grpclbBalancerStreamClosedAndRetried() throws Exception {
LoadBalanceRequest expectedInitialRequest =
LoadBalanceRequest.newBuilder()
.setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build();
InOrder inOrder =
inOrder(mockLbService, backoffPolicyProvider, backoffPolicy1, backoffPolicy2, helper);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
assertEquals(1, fakeOobChannels.size());
@SuppressWarnings("unused")
ManagedChannel oobChannel = fakeOobChannels.poll();
// First balancer RPC
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Balancer closes it immediately (erroneously)
lbResponseObserver.onCompleted();
// Will start backoff sequence 1 (10ns)
inOrder.verify(backoffPolicyProvider).get();
inOrder.verify(backoffPolicy1).nextBackoffNanos();
assertEquals(1, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
inOrder.verify(helper).refreshNameResolution();
// Fast-forward to a moment before the retry
fakeClock.forwardNanos(9);
verifyNoMoreInteractions(mockLbService);
// Then time for retry
fakeClock.forwardNanos(1);
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Balancer closes it with an error.
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// Will continue the backoff sequence 1 (100ns)
verifyNoMoreInteractions(backoffPolicyProvider);
inOrder.verify(backoffPolicy1).nextBackoffNanos();
assertEquals(1, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
inOrder.verify(helper).refreshNameResolution();
// Fast-forward to a moment before the retry
fakeClock.forwardNanos(100 - 1);
verifyNoMoreInteractions(mockLbService);
// Then time for retry
fakeClock.forwardNanos(1);
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Balancer sends initial response.
lbResponseObserver.onNext(buildInitialResponse());
// Then breaks the RPC
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// Will reset the retry sequence and retry immediately, because balancer has responded.
inOrder.verify(backoffPolicyProvider).get();
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
inOrder.verify(helper).refreshNameResolution();
// Fail the retry after spending 4ns
fakeClock.forwardNanos(4);
lbResponseObserver.onError(Status.UNAVAILABLE.asException());
// Will be on the first retry (10ns) of backoff sequence 2.
inOrder.verify(backoffPolicy2).nextBackoffNanos();
assertEquals(1, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
inOrder.verify(helper).refreshNameResolution();
// Fast-forward to a moment before the retry, the time spent in the last try is deducted.
fakeClock.forwardNanos(10 - 4 - 1);
verifyNoMoreInteractions(mockLbService);
// Then time for retry
fakeClock.forwardNanos(1);
inOrder.verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(eq(expectedInitialRequest));
assertEquals(0, fakeClock.numPendingTasks(LB_RPC_RETRY_TASK_FILTER));
// Wrapping up
verify(backoffPolicyProvider, times(2)).get();
verify(backoffPolicy1, times(2)).nextBackoffNanos();
verify(backoffPolicy2, times(1)).nextBackoffNanos();
verify(helper, times(4)).refreshNameResolution();
}
@SuppressWarnings({"unchecked", "deprecation"})
@Test
public void grpclbWorking_pickFirstMode() throws Exception {
InOrder inOrder = inOrder(helper);
String lbConfig = "{\"childPolicy\" : [ {\"pick_first\" : {}} ]}";
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
// Initially IDLE
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
// Only one subchannel is created
assertThat(mockSubchannels).hasSize(1);
Subchannel subchannel = mockSubchannels.poll();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(new IdleSubchannelEntry(subchannel, syncContext));
// PICK_FIRST doesn't eagerly connect
verify(subchannel, never()).requestConnection();
// CONNECTING
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(BUFFER_ENTRY);
// TRANSIENT_FAILURE
Status error = Status.UNAVAILABLE.withDescription("Simulated connection error");
deliverSubchannelState(subchannel, ConnectivityStateInfo.forTransientFailure(error));
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(new ErrorEntry(error));
// READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
// New server list with drops
List<ServerEntry> backends2 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("token0003"), // drop
new ServerEntry("127.0.0.1", 2020, "token0004"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildLbResponse(backends2));
// new addresses will be updated to the existing subchannel
// createSubchannel() has ever been called only once
verify(helper, times(1)).createSubchannel(any(List.class), any(Attributes.class));
assertThat(mockSubchannels).isEmpty();
verify(subchannel).updateAddresses(
eq(Arrays.asList(
new EquivalentAddressGroup(backends2.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends2.get(2).addr,
eagAttrsWithToken("token0004")))));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.dropList).containsExactly(
null, new DropEntry(getLoadRecorder(), "token0003"), null);
assertThat(picker4.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
// Subchannel goes IDLE, but PICK_FIRST will not try to reconnect
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(IDLE));
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker5 = (RoundRobinPicker) pickerCaptor.getValue();
verify(subchannel, never()).requestConnection();
// ... until it's selected
PickSubchannelArgs args = mock(PickSubchannelArgs.class);
PickResult pick = picker5.pickSubchannel(args);
assertThat(pick).isSameInstanceAs(PickResult.withNoResult());
verify(subchannel).requestConnection();
// ... or requested by application
balancer.requestConnection();
verify(subchannel, times(2)).requestConnection();
// PICK_FIRST doesn't use subchannelPool
verify(subchannelPool, never())
.takeOrCreateSubchannel(any(EquivalentAddressGroup.class), any(Attributes.class));
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
}
@SuppressWarnings({"unchecked", "deprecation"})
@Test
public void grpclbWorking_pickFirstMode_lbSendsEmptyAddress() throws Exception {
InOrder inOrder = inOrder(helper);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
Attributes.EMPTY,
GrpclbConfig.create(Mode.PICK_FIRST));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
// Initially IDLE
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
// Only one subchannel is created
assertThat(mockSubchannels).hasSize(1);
Subchannel subchannel = mockSubchannels.poll();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(new IdleSubchannelEntry(subchannel, syncContext));
// PICK_FIRST doesn't eagerly connect
verify(subchannel, never()).requestConnection();
// CONNECTING
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(BUFFER_ENTRY);
// TRANSIENT_FAILURE
Status error = Status.UNAVAILABLE.withDescription("Simulated connection error");
deliverSubchannelState(subchannel, ConnectivityStateInfo.forTransientFailure(error));
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(new ErrorEntry(error));
// READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
// Empty addresses from LB
lbResponseObserver.onNext(buildLbResponse(Collections.<ServerEntry>emptyList()));
// new addresses will be updated to the existing subchannel
// createSubchannel() has ever been called only once
inOrder.verify(helper, never()).createSubchannel(any(List.class), any(Attributes.class));
assertThat(mockSubchannels).isEmpty();
verify(subchannel).shutdown();
inOrder.verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
RoundRobinPicker errorPicker = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(errorPicker.pickList)
.containsExactly(new ErrorEntry(GrpclbState.NO_AVAILABLE_BACKENDS_STATUS));
lbResponseObserver.onNext(buildLbResponse(Collections.<ServerEntry>emptyList()));
// Test recover from new LB response with addresses
// New server list with drops
List<ServerEntry> backends2 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("token0003"), // drop
new ServerEntry("127.0.0.1", 2020, "token0004"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildLbResponse(backends2));
// new addresses will be updated to the existing subchannel
inOrder.verify(helper, times(1)).createSubchannel(any(List.class), any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
subchannel = mockSubchannels.poll();
// Subchannel became READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
}
@Test
public void shutdownWithoutSubchannel_roundRobin() throws Exception {
subtestShutdownWithoutSubchannel("round_robin");
}
@Test
public void shutdownWithoutSubchannel_pickFirst() throws Exception {
subtestShutdownWithoutSubchannel("pick_first");
}
@SuppressWarnings("deprecation") // TODO(creamsoup) use parsed object
private void subtestShutdownWithoutSubchannel(String childPolicy) throws Exception {
String lbConfig = "{\"childPolicy\" : [ {\"" + childPolicy + "\" : {}} ]}";
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> requestObserver = lbRequestObservers.poll();
verify(requestObserver, never()).onCompleted();
balancer.shutdown();
ArgumentCaptor<Throwable> throwableCaptor = ArgumentCaptor.forClass(Throwable.class);
verify(requestObserver).onError(throwableCaptor.capture());
assertThat(Status.fromThrowable(throwableCaptor.getValue()).getCode())
.isEqualTo(Code.CANCELLED);
}
@SuppressWarnings({"unchecked", "deprecation"})
@Test
public void pickFirstMode_fallback() throws Exception {
InOrder inOrder = inOrder(helper);
String lbConfig = "{\"childPolicy\" : [ {\"pick_first\" : {}} ]}";
// Name resolver returns balancer and backend addresses
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
// Attempted to connect to balancer
assertEquals(1, fakeOobChannels.size());
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
// Fallback timer expires with no response
fakeClock.forwardTime(GrpclbState.FALLBACK_TIMEOUT_MS, TimeUnit.MILLISECONDS);
// Entering fallback mode
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(backendList.get(0), backendList.get(1))),
any(Attributes.class));
assertThat(mockSubchannels).hasSize(1);
Subchannel subchannel = mockSubchannels.poll();
// Initially IDLE
inOrder.verify(helper).updateBalancingState(eq(IDLE), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
// READY
deliverSubchannelState(subchannel, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(null)));
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(new IdleSubchannelEntry(subchannel, syncContext));
// Finally, an LB response, which brings us out of fallback
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// new addresses will be updated to the existing subchannel
// createSubchannel() has ever been called only once
verify(helper, times(1)).createSubchannel(any(List.class), any(Attributes.class));
assertThat(mockSubchannels).isEmpty();
verify(subchannel).updateAddresses(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr,
eagAttrsWithToken("token0002")))));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(
new BackendEntry(subchannel, new TokenAttachingTracerFactory(getLoadRecorder())));
// PICK_FIRST doesn't use subchannelPool
verify(subchannelPool, never())
.takeOrCreateSubchannel(any(EquivalentAddressGroup.class), any(Attributes.class));
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
}
@SuppressWarnings("deprecation")
@Test
public void switchMode() throws Exception {
InOrder inOrder = inOrder(helper);
String lbConfig = "{\"childPolicy\" : [ {\"round_robin\" : {}} ]}";
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// ROUND_ROBIN: create one subchannel per server
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
// Switch to PICK_FIRST
lbConfig = "{\"childPolicy\" : [ {\"pick_first\" : {}} ]}";
grpclbResolutionAttrs = Attributes.newBuilder().set(
LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList, grpclbResolutionAttrs);
// GrpclbState will be shutdown, and a new one will be created
assertThat(oobChannel.isShutdown()).isTrue();
verify(subchannelPool)
.returnSubchannel(same(subchannel1), eq(ConnectivityStateInfo.forNonError(IDLE)));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(IDLE)));
// A new LB stream is created
assertEquals(1, fakeOobChannels.size());
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// PICK_FIRST Subchannel
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(IDLE), any(SubchannelPicker.class));
}
private static Attributes eagAttrsWithToken(String token) {
return LB_BACKEND_ATTRS.toBuilder().set(GrpclbConstants.TOKEN_ATTRIBUTE_KEY, token).build();
}
@Test
@SuppressWarnings("deprecation")
public void switchMode_nullLbPolicy() throws Exception {
InOrder inOrder = inOrder(helper);
final List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
Attributes.EMPTY,
/* grpclbConfig= */ null);
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// ROUND_ROBIN: create one subchannel per server
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
// Switch to PICK_FIRST
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
grpclbBalancerList,
Attributes.EMPTY,
GrpclbConfig.create(Mode.PICK_FIRST));
// GrpclbState will be shutdown, and a new one will be created
assertThat(oobChannel.isShutdown()).isTrue();
verify(subchannelPool)
.returnSubchannel(same(subchannel1), eq(ConnectivityStateInfo.forNonError(IDLE)));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(IDLE)));
// A new LB stream is created
assertEquals(1, fakeOobChannels.size());
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// PICK_FIRST Subchannel
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new createSubchannel().
inOrder.verify(helper).createSubchannel(
eq(Arrays.asList(
new EquivalentAddressGroup(backends1.get(0).addr, eagAttrsWithToken("token0001")),
new EquivalentAddressGroup(backends1.get(1).addr, eagAttrsWithToken("token0002")))),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(IDLE), any(SubchannelPicker.class));
}
@SuppressWarnings("deprecation")
@Test
public void switchServiceName() throws Exception {
InOrder inOrder = inOrder(helper);
String lbConfig = "{\"serviceName\": \"foo.google.com\"}";
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
Attributes grpclbResolutionAttrs = Attributes.newBuilder()
.set(LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig))
.build();
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList, grpclbResolutionAttrs);
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName("foo.google.com").build())
.build()));
// Simulate receiving LB response
List<ServerEntry> backends1 = Arrays.asList(
new ServerEntry("127.0.0.1", 2000, "token0001"),
new ServerEntry("127.0.0.1", 2010, "token0002"));
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
lbResponseObserver.onNext(buildInitialResponse());
lbResponseObserver.onNext(buildLbResponse(backends1));
// ROUND_ROBIN: create one subchannel per server
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(0).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backends1.get(1).addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), any(SubchannelPicker.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannelPool, never())
.returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
// Switch to different serviceName
lbConfig = "{\"serviceName\": \"bar.google.com\"}";
grpclbResolutionAttrs = Attributes.newBuilder().set(
LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
List<EquivalentAddressGroup> newGrpclbResolutionList = createResolvedBalancerAddresses(1);
deliverResolvedAddresses(
Collections.<EquivalentAddressGroup>emptyList(),
newGrpclbResolutionList,
grpclbResolutionAttrs);
// GrpclbState will be shutdown, and a new one will be created
assertThat(oobChannel.isShutdown()).isTrue();
verify(subchannelPool)
.returnSubchannel(same(subchannel1), eq(ConnectivityStateInfo.forNonError(IDLE)));
verify(subchannelPool)
.returnSubchannel(same(subchannel2), eq(ConnectivityStateInfo.forNonError(IDLE)));
assertEquals(1, fakeOobChannels.size());
verify(mockLbService, times(2)).balanceLoad(lbResponseObserverCaptor.capture());
assertEquals(1, lbRequestObservers.size());
lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder().setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName("bar.google.com").build())
.build()));
}
@Test
public void grpclbWorking_lbSendsFallbackMessage() {
InOrder inOrder = inOrder(helper, subchannelPool);
List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(2);
Attributes grpclbResolutionAttrs = Attributes.EMPTY;
deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
// Fallback timer is started as soon as the addresses are resolved.
assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
List<SocketAddress> addrs = new ArrayList<>();
addrs.addAll(grpclbBalancerList.get(0).getAddresses());
addrs.addAll(grpclbBalancerList.get(1).getAddresses());
Attributes attr = grpclbBalancerList.get(0).getAttributes();
EquivalentAddressGroup oobChannelEag = new EquivalentAddressGroup(addrs, attr);
verify(helper).createOobChannel(eq(oobChannelEag), eq(lbAuthority(0)));
assertEquals(1, fakeOobChannels.size());
ManagedChannel oobChannel = fakeOobChannels.poll();
verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
assertEquals(1, lbRequestObservers.size());
StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
verify(lbRequestObserver).onNext(
eq(LoadBalanceRequest.newBuilder()
.setInitialRequest(
InitialLoadBalanceRequest.newBuilder().setName(SERVICE_AUTHORITY).build())
.build()));
// Simulate receiving LB response
ServerEntry backend1a = new ServerEntry("127.0.0.1", 2000, "token0001");
ServerEntry backend1b = new ServerEntry("127.0.0.1", 2010, "token0002");
List<ServerEntry> backends1 = Arrays.asList(backend1a, backend1b);
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
logs.clear();
lbResponseObserver.onNext(buildInitialResponse());
assertThat(logs).containsExactly("DEBUG: Got an LB response: " + buildInitialResponse());
logs.clear();
lbResponseObserver.onNext(buildLbResponse(backends1));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend1a.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend1b.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel1 = mockSubchannels.poll();
Subchannel subchannel2 = mockSubchannels.poll();
verify(subchannel1).requestConnection();
verify(subchannel2).requestConnection();
assertEquals(
new EquivalentAddressGroup(backend1a.addr, LB_BACKEND_ATTRS),
subchannel1.getAddresses());
assertEquals(
new EquivalentAddressGroup(backend1b.addr, LB_BACKEND_ATTRS),
subchannel2.getAddresses());
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker0 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker0.dropList).containsExactly(null, null);
assertThat(picker0.pickList).containsExactly(BUFFER_ENTRY);
inOrder.verifyNoMoreInteractions();
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends1),
"INFO: Using RR list="
+ "[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}](token0001),"
+ " [[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}](token0002)],"
+ " drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
logs.clear();
// Let subchannels be connected
deliverSubchannelState(subchannel2, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker1 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker1.dropList).containsExactly(null, null);
assertThat(picker1.pickList).containsExactly(
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"));
deliverSubchannelState(subchannel1, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:2000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0001)],"
+ " [[[[/127.0.0.1:2010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token0002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker2 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker2.dropList).containsExactly(null, null);
assertThat(picker2.pickList).containsExactly(
new BackendEntry(subchannel1, getLoadRecorder(), "token0001"),
new BackendEntry(subchannel2, getLoadRecorder(), "token0002"))
.inOrder();
// enter fallback mode
lbResponseObserver.onNext(buildLbFallbackResponse());
// existing subchannels must be returned immediately to gracefully shutdown.
verify(subchannelPool)
.returnSubchannel(eq(subchannel1), eq(ConnectivityStateInfo.forNonError(READY)));
verify(subchannelPool)
.returnSubchannel(eq(subchannel2), eq(ConnectivityStateInfo.forNonError(READY)));
// verify fallback
fallbackTestVerifyUseOfFallbackBackendLists(inOrder, backendList);
assertFalse(oobChannel.isShutdown());
verify(lbRequestObserver, never()).onCompleted();
// exit fall back by providing two new backends
ServerEntry backend2a = new ServerEntry("127.0.0.1", 8000, "token1001");
ServerEntry backend2b = new ServerEntry("127.0.0.1", 8010, "token1002");
List<ServerEntry> backends2 = Arrays.asList(backend2a, backend2b);
inOrder.verify(helper, never())
.updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
logs.clear();
lbResponseObserver.onNext(buildLbResponse(backends2));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend2a.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
inOrder.verify(subchannelPool).takeOrCreateSubchannel(
eq(new EquivalentAddressGroup(backend2b.addr, LB_BACKEND_ATTRS)),
any(Attributes.class));
assertEquals(2, mockSubchannels.size());
Subchannel subchannel3 = mockSubchannels.poll();
Subchannel subchannel4 = mockSubchannels.poll();
verify(subchannel3).requestConnection();
verify(subchannel4).requestConnection();
assertEquals(
new EquivalentAddressGroup(backend2a.addr, LB_BACKEND_ATTRS),
subchannel3.getAddresses());
assertEquals(
new EquivalentAddressGroup(backend2b.addr, LB_BACKEND_ATTRS),
subchannel4.getAddresses());
deliverSubchannelState(subchannel3, ConnectivityStateInfo.forNonError(CONNECTING));
deliverSubchannelState(subchannel4, ConnectivityStateInfo.forNonError(CONNECTING));
inOrder.verify(helper).updateBalancingState(eq(CONNECTING), pickerCaptor.capture());
RoundRobinPicker picker6 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker6.dropList).containsExactly(null, null);
assertThat(picker6.pickList).containsExactly(BUFFER_ENTRY);
inOrder.verifyNoMoreInteractions();
assertThat(logs).containsExactly(
"DEBUG: Got an LB response: " + buildLbResponse(backends2),
"INFO: Using RR list="
+ "[[[/127.0.0.1:8000]/{io.grpc.grpclb.lbProvidedBackend=true}](token1001),"
+ " [[/127.0.0.1:8010]/{io.grpc.grpclb.lbProvidedBackend=true}](token1002)],"
+ " drop=[null, null]",
"INFO: CONNECTING: picks=[BUFFER_ENTRY], drops=[null, null]").inOrder();
logs.clear();
// Let new subchannels be connected
deliverSubchannelState(subchannel3, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:8000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token1001)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker3 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker3.dropList).containsExactly(null, null);
assertThat(picker3.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token1001"));
deliverSubchannelState(subchannel4, ConnectivityStateInfo.forNonError(READY));
inOrder.verify(helper).updateBalancingState(eq(READY), pickerCaptor.capture());
assertThat(logs).containsExactly(
"INFO: READY: picks="
+ "[[[[[/127.0.0.1:8000]/{io.grpc.grpclb.lbProvidedBackend=true}]](token1001)],"
+ " [[[[/127.0.0.1:8010]/{io.grpc.grpclb.lbProvidedBackend=true}]](token1002)]],"
+ " drops=[null, null]");
logs.clear();
RoundRobinPicker picker4 = (RoundRobinPicker) pickerCaptor.getValue();
assertThat(picker4.dropList).containsExactly(null, null);
assertThat(picker4.pickList).containsExactly(
new BackendEntry(subchannel3, getLoadRecorder(), "token1001"),
new BackendEntry(subchannel4, getLoadRecorder(), "token1002"))
.inOrder();
}
@SuppressWarnings("deprecation")
private void deliverSubchannelState(
final Subchannel subchannel, final ConnectivityStateInfo newState) {
syncContext.execute(new Runnable() {
@Override
public void run() {
// TODO(zhangkun83): remove the deprecation suppression on this method once migrated to
// the new API.
balancer.handleSubchannelState(subchannel, newState);
}
});
}
private void deliverNameResolutionError(final Status error) {
syncContext.execute(new Runnable() {
@Override
public void run() {
balancer.handleNameResolutionError(error);
}
});
}
@SuppressWarnings("deprecation") // TODO(creamsoup) migrate test cases to use GrpclbConfig.
private void deliverResolvedAddresses(
List<EquivalentAddressGroup> backendAddrs,
List<EquivalentAddressGroup> balancerAddrs,
Attributes attrs) {
GrpclbConfig grpclbConfig;
Map<String, ?> lbJsonMap = attrs.get(LoadBalancer.ATTR_LOAD_BALANCING_CONFIG);
if (lbJsonMap != null) {
grpclbConfig = (GrpclbConfig) grpclbLoadBalancerProvider
.parseLoadBalancingPolicyConfig(lbJsonMap).getConfig();
} else {
grpclbConfig = GrpclbConfig.create(Mode.ROUND_ROBIN);
}
deliverResolvedAddresses(backendAddrs, balancerAddrs, attrs, grpclbConfig);
}
private void deliverResolvedAddresses(
final List<EquivalentAddressGroup> backendAddrs,
List<EquivalentAddressGroup> balancerAddrs,
Attributes attributes,
final GrpclbConfig grpclbConfig) {
final Attributes attrs =
attributes.toBuilder().set(GrpclbConstants.ATTR_LB_ADDRS, balancerAddrs).build();
syncContext.execute(new Runnable() {
@Override
public void run() {
balancer.handleResolvedAddresses(
ResolvedAddresses.newBuilder()
.setAddresses(backendAddrs)
.setAttributes(attrs)
.setLoadBalancingPolicyConfig(grpclbConfig)
.build());
}
});
}
private GrpclbClientLoadRecorder getLoadRecorder() {
return balancer.getGrpclbState().getLoadRecorder();
}
private static List<EquivalentAddressGroup> createResolvedBackendAddresses(int n) {
List<EquivalentAddressGroup> list = new ArrayList<>();
for (int i = 0; i < n; i++) {
SocketAddress addr = new FakeSocketAddress("fake-address-" + i);
list.add(new EquivalentAddressGroup(addr));
}
return list;
}
private static List<EquivalentAddressGroup> createResolvedBalancerAddresses(int n) {
List<EquivalentAddressGroup> list = new ArrayList<>();
for (int i = 0; i < n; i++) {
SocketAddress addr = new FakeSocketAddress("fake-address-" + i);
list.add(new EquivalentAddressGroup(addr, lbAttributes(lbAuthority(i))));
}
return list;
}
private static String lbAuthority(int unused) {
// TODO(ejona): Support varying authorities
return "lb.google.com";
}
private static Attributes lbAttributes(String authority) {
return Attributes.newBuilder()
.set(GrpclbConstants.ATTR_LB_ADDR_AUTHORITY, authority)
.build();
}
private static LoadBalanceResponse buildInitialResponse() {
return buildInitialResponse(0);
}
private static LoadBalanceResponse buildInitialResponse(long loadReportIntervalMillis) {
return LoadBalanceResponse.newBuilder()
.setInitialResponse(
InitialLoadBalanceResponse.newBuilder()
.setClientStatsReportInterval(Durations.fromMillis(loadReportIntervalMillis)))
.build();
}
private static LoadBalanceResponse buildLbFallbackResponse() {
return LoadBalanceResponse.newBuilder()
.setFallbackResponse(FallbackResponse.newBuilder().build())
.build();
}
private static LoadBalanceResponse buildLbResponse(List<ServerEntry> servers) {
ServerList.Builder serverListBuilder = ServerList.newBuilder();
for (ServerEntry server : servers) {
if (server.addr != null) {
serverListBuilder.addServers(Server.newBuilder()
.setIpAddress(ByteString.copyFrom(server.addr.getAddress().getAddress()))
.setPort(server.addr.getPort())
.setLoadBalanceToken(server.token)
.build());
} else {
serverListBuilder.addServers(Server.newBuilder()
.setDrop(true)
.setLoadBalanceToken(server.token)
.build());
}
}
return LoadBalanceResponse.newBuilder()
.setServerList(serverListBuilder.build())
.build();
}
@SuppressWarnings("unchecked")
private static Map<String, ?> parseJsonObject(String json) throws Exception {
return (Map<String, ?>) JsonParser.parse(json);
}
private static class ServerEntry {
final InetSocketAddress addr;
final String token;
ServerEntry(String host, int port, String token) {
this.addr = new InetSocketAddress(host, port);
this.token = token;
}
// Drop entry
ServerEntry(String token) {
this.addr = null;
this.token = token;
}
}
}
| grpclb: clean up usage of raw load balancing config attributes in tests (#6798)
| grpclb/src/test/java/io/grpc/grpclb/GrpclbLoadBalancerTest.java | grpclb: clean up usage of raw load balancing config attributes in tests (#6798) | <ide><path>rpclb/src/test/java/io/grpc/grpclb/GrpclbLoadBalancerTest.java
<ide> import io.grpc.ConnectivityState;
<ide> import io.grpc.ConnectivityStateInfo;
<ide> import io.grpc.EquivalentAddressGroup;
<del>import io.grpc.LoadBalancer;
<ide> import io.grpc.LoadBalancer.Helper;
<ide> import io.grpc.LoadBalancer.PickResult;
<ide> import io.grpc.LoadBalancer.PickSubchannelArgs;
<ide> import io.grpc.inprocess.InProcessServerBuilder;
<ide> import io.grpc.internal.BackoffPolicy;
<ide> import io.grpc.internal.FakeClock;
<del>import io.grpc.internal.JsonParser;
<ide> import io.grpc.lb.v1.ClientStats;
<ide> import io.grpc.lb.v1.ClientStatsPerToken;
<ide> import io.grpc.lb.v1.FallbackResponse;
<ide> import java.util.Collections;
<ide> import java.util.LinkedList;
<ide> import java.util.List;
<del>import java.util.Map;
<ide> import java.util.concurrent.TimeUnit;
<ide> import javax.annotation.Nullable;
<ide> import org.junit.After;
<ide> throw new AssertionError(e);
<ide> }
<ide> });
<del> private final GrpclbLoadBalancerProvider grpclbLoadBalancerProvider =
<del> new GrpclbLoadBalancerProvider();
<ide> private static final ClientStreamTracer.StreamInfo STREAM_INFO =
<ide> ClientStreamTracer.StreamInfo.newBuilder().build();
<ide>
<ide>
<ide> long loadReportIntervalMillis = 1983;
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide>
<ide> // Fallback timer is started as soon as address is resolved.
<ide> assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
<ide> when(args.getHeaders()).thenReturn(headers);
<ide>
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide> assertEquals(1, fakeOobChannels.size());
<ide> verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
<ide> StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
<ide> when(args.getHeaders()).thenReturn(headers);
<ide>
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide> assertEquals(1, fakeOobChannels.size());
<ide> verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
<ide> StreamObserver<LoadBalanceResponse> lbResponseObserver = lbResponseObserverCaptor.getValue();
<ide> public void receiveNoBackendAndBalancerAddress() {
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> Attributes.EMPTY);
<add> Collections.<EquivalentAddressGroup>emptyList());
<ide> verify(helper).updateBalancingState(eq(TRANSIENT_FAILURE), pickerCaptor.capture());
<ide> RoundRobinPicker picker = (RoundRobinPicker) pickerCaptor.getValue();
<ide> assertThat(picker.dropList).isEmpty();
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<ide> EquivalentAddressGroup eag = grpclbBalancerList.get(0);
<ide>
<del> Attributes resolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide>
<ide> verify(helper).createOobChannel(eq(eag), eq(lbAuthority(0)));
<ide> verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
<ide> InOrder inOrder = inOrder(helper, subchannelPool);
<ide> // Go to GRPCLB first
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide>
<ide> verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
<ide> assertEquals(1, fakeOobChannels.size());
<ide> public void grpclbUpdatedAddresses_avoidsReconnect() {
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(1);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
<ide> ManagedChannel oobChannel = fakeOobChannels.poll();
<ide> grpclbBalancerList2.get(0).getAddresses().get(0),
<ide> grpclbBalancerList2.get(1).getAddresses().get(0)),
<ide> lbAttributes(lbAuthority(0)));
<del> deliverResolvedAddresses(backendList2, grpclbBalancerList2, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(backendList2, grpclbBalancerList2);
<ide> verify(helper).updateOobChannelAddresses(eq(oobChannel), eq(combinedEag));
<ide> assertEquals(1, lbRequestObservers.size()); // No additional RPC
<ide> }
<ide> public void grpclbUpdatedAddresses_reconnectOnAuthorityChange() {
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(1);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
<ide> ManagedChannel oobChannel = fakeOobChannels.poll();
<ide> Collections.singletonList(
<ide> new EquivalentAddressGroup(
<ide> new FakeSocketAddress("somethingNew"), lbAttributes(newAuthority)));
<del> deliverResolvedAddresses(
<del> backendList2, grpclbBalancerList2, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(backendList2, grpclbBalancerList2);
<ide> assertTrue(oobChannel.isTerminated());
<ide> verify(helper).createOobChannel(eq(grpclbBalancerList2.get(0)), eq(newAuthority));
<ide> assertEquals(2, lbRequestObservers.size()); // An additional RPC
<ide> public void grpclbWorking() {
<ide> InOrder inOrder = inOrder(helper, subchannelPool);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide>
<ide> // Fallback timer is started as soon as the addresses are resolved.
<ide> assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
<ide> // Create balancer and backend addresses
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes resolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> inOrder.verify(helper)
<ide> .createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
<ide> // Name resolver sends new resolution results without any backend addr
<ide> //////////////////////////////////////////////////////////////////////
<ide> grpclbBalancerList = createResolvedBalancerAddresses(2);
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(),grpclbBalancerList);
<ide>
<ide> // New addresses are updated to the OobChannel
<ide> inOrder.verify(helper).updateOobChannelAddresses(
<ide> ////////////////////////////////////////////////////////////////
<ide> backendList = createResolvedBackendAddresses(2);
<ide> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> // New LB address is updated to the OobChannel
<ide> inOrder.verify(helper).updateOobChannelAddresses(
<ide> ///////////////////////////////////////////////////////////////
<ide> backendList = createResolvedBackendAddresses(1);
<ide> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide> // Will not affect the round robin list at all
<ide> inOrder.verify(helper, never())
<ide> .updateBalancingState(any(ConnectivityState.class), any(SubchannelPicker.class));
<ide> // Create balancer and backend addresses
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes resolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> inOrder.verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
<ide>
<ide>
<ide> // Create just backend addresses
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
<del> Attributes resolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> backendList, Collections.<EquivalentAddressGroup>emptyList(), resolutionAttrs);
<add> deliverResolvedAddresses(backendList, Collections.<EquivalentAddressGroup>emptyList());
<ide>
<ide> assertThat(logs).containsExactly(
<ide> "INFO: Using fallback backends",
<ide> // Create balancer and backend addresses
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes resolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, resolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> inOrder.verify(helper).createOobChannel(eq(grpclbBalancerList.get(0)), eq(lbAuthority(0)));
<ide>
<ide> new FakeSocketAddress("fake-address-3")),
<ide> lbAttributes("fake-authority-1")); // Supporting multiple authorities would be good, one day
<ide>
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> verify(helper).createOobChannel(goldenOobChannelEag, "fake-authority-1");
<ide> }
<ide> InOrder inOrder =
<ide> inOrder(mockLbService, backoffPolicyProvider, backoffPolicy1, backoffPolicy2, helper);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList);
<ide>
<ide> assertEquals(1, fakeOobChannels.size());
<ide> @SuppressWarnings("unused")
<ide> public void grpclbWorking_pickFirstMode() throws Exception {
<ide> InOrder inOrder = inOrder(helper);
<ide>
<del> String lbConfig = "{\"childPolicy\" : [ {\"pick_first\" : {}} ]}";
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
<del> LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
<ide>
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> grpclbBalancerList,
<add> GrpclbConfig.create(Mode.PICK_FIRST));
<ide>
<ide> assertEquals(1, fakeOobChannels.size());
<ide> verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<ide> grpclbBalancerList,
<del> Attributes.EMPTY,
<ide> GrpclbConfig.create(Mode.PICK_FIRST));
<ide>
<ide> assertEquals(1, fakeOobChannels.size());
<ide>
<ide> @Test
<ide> public void shutdownWithoutSubchannel_roundRobin() throws Exception {
<del> subtestShutdownWithoutSubchannel("round_robin");
<add> subtestShutdownWithoutSubchannel(GrpclbConfig.create(Mode.ROUND_ROBIN));
<ide> }
<ide>
<ide> @Test
<ide> public void shutdownWithoutSubchannel_pickFirst() throws Exception {
<del> subtestShutdownWithoutSubchannel("pick_first");
<del> }
<del>
<del> @SuppressWarnings("deprecation") // TODO(creamsoup) use parsed object
<del> private void subtestShutdownWithoutSubchannel(String childPolicy) throws Exception {
<del> String lbConfig = "{\"childPolicy\" : [ {\"" + childPolicy + "\" : {}} ]}";
<add> subtestShutdownWithoutSubchannel(GrpclbConfig.create(Mode.PICK_FIRST));
<add> }
<add>
<add> private void subtestShutdownWithoutSubchannel(GrpclbConfig grpclbConfig) {
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
<del> LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> grpclbBalancerList,
<add> grpclbConfig);
<ide> verify(mockLbService).balanceLoad(lbResponseObserverCaptor.capture());
<ide> assertEquals(1, lbRequestObservers.size());
<ide> StreamObserver<LoadBalanceRequest> requestObserver = lbRequestObservers.poll();
<ide> public void pickFirstMode_fallback() throws Exception {
<ide> InOrder inOrder = inOrder(helper);
<ide>
<del> String lbConfig = "{\"childPolicy\" : [ {\"pick_first\" : {}} ]}";
<del>
<ide> // Name resolver returns balancer and backend addresses
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
<del> LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(
<add> backendList,
<add> grpclbBalancerList,
<add> GrpclbConfig.create(Mode.PICK_FIRST));
<ide>
<ide> // Attempted to connect to balancer
<ide> assertEquals(1, fakeOobChannels.size());
<ide> public void switchMode() throws Exception {
<ide> InOrder inOrder = inOrder(helper);
<ide>
<del> String lbConfig = "{\"childPolicy\" : [ {\"round_robin\" : {}} ]}";
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.newBuilder().set(
<del> LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
<del>
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> grpclbBalancerList,
<add> GrpclbConfig.create(Mode.ROUND_ROBIN));
<ide>
<ide> assertEquals(1, fakeOobChannels.size());
<ide> ManagedChannel oobChannel = fakeOobChannels.poll();
<ide> .returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
<ide>
<ide> // Switch to PICK_FIRST
<del> lbConfig = "{\"childPolicy\" : [ {\"pick_first\" : {}} ]}";
<del> grpclbResolutionAttrs = Attributes.newBuilder().set(
<del> LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList, grpclbResolutionAttrs);
<add> grpclbBalancerList, GrpclbConfig.create(Mode.PICK_FIRST));
<ide>
<ide>
<ide> // GrpclbState will be shutdown, and a new one will be created
<ide> final List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<del> grpclbBalancerList,
<del> Attributes.EMPTY,
<del> /* grpclbConfig= */ null);
<add> grpclbBalancerList);
<ide>
<ide> assertEquals(1, fakeOobChannels.size());
<ide> ManagedChannel oobChannel = fakeOobChannels.poll();
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<ide> grpclbBalancerList,
<del> Attributes.EMPTY,
<ide> GrpclbConfig.create(Mode.PICK_FIRST));
<ide>
<ide> // GrpclbState will be shutdown, and a new one will be created
<ide> inOrder.verify(helper).updateBalancingState(eq(IDLE), any(SubchannelPicker.class));
<ide> }
<ide>
<del> @SuppressWarnings("deprecation")
<ide> @Test
<ide> public void switchServiceName() throws Exception {
<ide> InOrder inOrder = inOrder(helper);
<ide>
<del> String lbConfig = "{\"serviceName\": \"foo.google.com\"}";
<add> String serviceName = "foo.google.com";
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(1);
<del> Attributes grpclbResolutionAttrs = Attributes.newBuilder()
<del> .set(LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig))
<del> .build();
<ide>
<ide> deliverResolvedAddresses(
<del> Collections.<EquivalentAddressGroup>emptyList(), grpclbBalancerList, grpclbResolutionAttrs);
<add> Collections.<EquivalentAddressGroup>emptyList(),
<add> grpclbBalancerList,
<add> GrpclbConfig.create(Mode.ROUND_ROBIN, serviceName));
<ide>
<ide> assertEquals(1, fakeOobChannels.size());
<ide> ManagedChannel oobChannel = fakeOobChannels.poll();
<ide> StreamObserver<LoadBalanceRequest> lbRequestObserver = lbRequestObservers.poll();
<ide> verify(lbRequestObserver).onNext(
<ide> eq(LoadBalanceRequest.newBuilder().setInitialRequest(
<del> InitialLoadBalanceRequest.newBuilder().setName("foo.google.com").build())
<add> InitialLoadBalanceRequest.newBuilder().setName(serviceName).build())
<ide> .build()));
<ide>
<ide> // Simulate receiving LB response
<ide> .returnSubchannel(any(Subchannel.class), any(ConnectivityStateInfo.class));
<ide>
<ide> // Switch to different serviceName
<del> lbConfig = "{\"serviceName\": \"bar.google.com\"}";
<del> grpclbResolutionAttrs = Attributes.newBuilder().set(
<del> LoadBalancer.ATTR_LOAD_BALANCING_CONFIG, parseJsonObject(lbConfig)).build();
<add> serviceName = "bar.google.com";
<ide> List<EquivalentAddressGroup> newGrpclbResolutionList = createResolvedBalancerAddresses(1);
<ide> deliverResolvedAddresses(
<ide> Collections.<EquivalentAddressGroup>emptyList(),
<ide> newGrpclbResolutionList,
<del> grpclbResolutionAttrs);
<add> GrpclbConfig.create(Mode.ROUND_ROBIN, serviceName));
<ide>
<ide> // GrpclbState will be shutdown, and a new one will be created
<ide> assertThat(oobChannel.isShutdown()).isTrue();
<ide> lbRequestObserver = lbRequestObservers.poll();
<ide> verify(lbRequestObserver).onNext(
<ide> eq(LoadBalanceRequest.newBuilder().setInitialRequest(
<del> InitialLoadBalanceRequest.newBuilder().setName("bar.google.com").build())
<add> InitialLoadBalanceRequest.newBuilder().setName(serviceName).build())
<ide> .build()));
<ide> }
<ide>
<ide> InOrder inOrder = inOrder(helper, subchannelPool);
<ide> List<EquivalentAddressGroup> backendList = createResolvedBackendAddresses(2);
<ide> List<EquivalentAddressGroup> grpclbBalancerList = createResolvedBalancerAddresses(2);
<del> Attributes grpclbResolutionAttrs = Attributes.EMPTY;
<del> deliverResolvedAddresses(backendList, grpclbBalancerList, grpclbResolutionAttrs);
<add> deliverResolvedAddresses(backendList, grpclbBalancerList);
<ide>
<ide> // Fallback timer is started as soon as the addresses are resolved.
<ide> assertEquals(1, fakeClock.numPendingTasks(FALLBACK_MODE_TASK_FILTER));
<ide> });
<ide> }
<ide>
<del> @SuppressWarnings("deprecation") // TODO(creamsoup) migrate test cases to use GrpclbConfig.
<ide> private void deliverResolvedAddresses(
<del> List<EquivalentAddressGroup> backendAddrs,
<del> List<EquivalentAddressGroup> balancerAddrs,
<del> Attributes attrs) {
<del> GrpclbConfig grpclbConfig;
<del> Map<String, ?> lbJsonMap = attrs.get(LoadBalancer.ATTR_LOAD_BALANCING_CONFIG);
<del> if (lbJsonMap != null) {
<del> grpclbConfig = (GrpclbConfig) grpclbLoadBalancerProvider
<del> .parseLoadBalancingPolicyConfig(lbJsonMap).getConfig();
<del> } else {
<del> grpclbConfig = GrpclbConfig.create(Mode.ROUND_ROBIN);
<del> }
<del> deliverResolvedAddresses(backendAddrs, balancerAddrs, attrs, grpclbConfig);
<add> final List<EquivalentAddressGroup> backendAddrs,
<add> List<EquivalentAddressGroup> balancerAddrs) {
<add> deliverResolvedAddresses(backendAddrs, balancerAddrs, GrpclbConfig.create(Mode.ROUND_ROBIN));
<ide> }
<ide>
<ide> private void deliverResolvedAddresses(
<ide> final List<EquivalentAddressGroup> backendAddrs,
<ide> List<EquivalentAddressGroup> balancerAddrs,
<del> Attributes attributes,
<ide> final GrpclbConfig grpclbConfig) {
<ide> final Attributes attrs =
<del> attributes.toBuilder().set(GrpclbConstants.ATTR_LB_ADDRS, balancerAddrs).build();
<add> Attributes.newBuilder().set(GrpclbConstants.ATTR_LB_ADDRS, balancerAddrs).build();
<ide> syncContext.execute(new Runnable() {
<ide> @Override
<ide> public void run() {
<ide> .build();
<ide> }
<ide>
<del> @SuppressWarnings("unchecked")
<del> private static Map<String, ?> parseJsonObject(String json) throws Exception {
<del> return (Map<String, ?>) JsonParser.parse(json);
<del> }
<del>
<ide> private static class ServerEntry {
<ide> final InetSocketAddress addr;
<ide> final String token; |
|
Java | mit | a25d20a37b4dc5304b29d91165c95ecf0ba335ed | 0 | ItinoseSan/Twi-Java | package com.company;
import org.apache.http.HttpHeaders;
import org.apache.http.auth.Credentials;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.DefaultHttpClientConnectionOperator;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.apache.http.auth.AuthScope;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.HttpResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.KeyPair;
import java.security.NoSuchAlgorithmException;
import java.util.*;
import java.util.stream.Collectors;
public class TwiJava{
private final String CONSUMER_KEY;
private final String CONSUMER_SECRET;
private final String ACCESS_TOKEN;
private final String ACCESS_TOKEN_SECRET;
private static final String BASE_URL = "https://api.twitter.com/1.1/";
private static final String TIMELINE_URL="statuses/home_timeline.json";
public TwiJava(String CONSUMER_KEY, String CONSUMER_SECRET, String ACCESS_TOKEN, String ACCESS_TOKEN_SECRET) {
this.CONSUMER_KEY = CONSUMER_KEY;
this.CONSUMER_SECRET = CONSUMER_SECRET;
this.ACCESS_TOKEN = ACCESS_TOKEN;
this.ACCESS_TOKEN_SECRET = ACCESS_TOKEN_SECRET;
}
public String gethomeTimeline()throws IOException {
String url=BASE_URL+TIMELINE_URL;
Map<String,String>header=createHeader();
Map<String,String>AuthticationMerged=new TreeMap<>(header);
Map<String,String>timeLineData=new TreeMap<>();
AuthticationMerged.putAll(timeLineData);
header.put("oauth_signature",generateTLsignature(url,"GET",AuthticationMerged));
String headerString = "OAuth " + header.entrySet().stream()
.map(e -> String.format("%s=\"%s\"", urlEncode(e.getKey()), urlEncode(e.getValue())))
.collect(Collectors.joining(", "));
try (CloseableHttpClient client = HttpClients.createDefault()) {
HttpGet get = new HttpGet(url);
get.setHeader(HttpHeaders.AUTHORIZATION, headerString);
// レスポンスボディを勝手に文字列にして返してくれるおまじない
return client.execute(get, res -> EntityUtils.toString(res.getEntity(), "UTF-8"));
}
}
public String generateTLsignature(String url,String methodname,Map<String,String>data){
Mac m=null;
try{
String sha1SecretKey=String.join("&",CONSUMER_KEY,CONSUMER_SECRET);
SecretKeySpec secretKeySpec=new SecretKeySpec(sha1SecretKey.getBytes(StandardCharsets.US_ASCII),"HmacSHA1");
m = Mac.getInstance("HmacSHA1");
m.init(secretKeySpec);
}
catch (Exception e){
}
String signature = String.join("&",
methodname, urlEncode(url), urlEncode(formUrlEncodedContent(data)));
return Base64.getEncoder().encodeToString(
m.doFinal(signature.getBytes(StandardCharsets.US_ASCII)));
}
public String tweet(String text) throws IOException {
Map<String, String> data = new TreeMap<>();
data.put("status", text);
data.put("trim_user", "1");
return SendRequest("statuses/update.json", data);
}
public String SendRequest(String url, Map<String, String> data) throws IOException {
String fullUrl = BASE_URL + url;
Map<String, String> header = createHeader();
Map<String, String> merged = new TreeMap<>(header);
merged.putAll(data);
header.put("oauth_signature", generateSignature(fullUrl, "POST", merged));
// Authorizationの要素が揃ったので文字列にする(エスケープを忘れない)
String headerString = "OAuth " + header.entrySet().stream()
.map(e -> String.format("%s=\"%s\"", urlEncode(e.getKey()), urlEncode(e.getValue())))
.collect(Collectors.joining(", "));
// POSTするデータのHttpComponentsの仕様
List<NameValuePair> postData = data.entrySet().stream()
.map(e -> new BasicNameValuePair(e.getKey(), e.getValue()))
.collect(Collectors.toList());
try (CloseableHttpClient client = HttpClients.createDefault()) {
HttpPost post = new HttpPost(fullUrl);
post.setHeader(HttpHeaders.AUTHORIZATION, headerString);
// 入出力でUTF-8を明示する
post.setEntity(new UrlEncodedFormEntity(postData, StandardCharsets.UTF_8));
// レスポンスボディを勝手に文字列にして返してくれるおまじない
return client.execute(post, res -> EntityUtils.toString(res.getEntity(), "UTF-8"));
}
}
private Map<String, String> createHeader() {
// TreeMapはcompareToに基づく順序付けMap
Map<String, String> data = new TreeMap<>();
data.put("oauth_consumer_key", CONSUMER_KEY);
data.put("oauth_signature_method", "HMAC-SHA1");
data.put("oauth_timestamp", String.valueOf(Calendar
.getInstance(TimeZone.getTimeZone("UTC")).getTime().getTime() / 1000));
data.put("oauth_nonce", GenerateNonce());
data.put("oauth_token", ACCESS_TOKEN);
data.put("oauth_version", "1.0");
return data;
}
private String generateSignature(String url, String method, Map<String, String> data) {
Mac mac = null;
try {
String key = String.join("&", CONSUMER_SECRET, ACCESS_TOKEN_SECRET);
// シークレットを合わせてSHA1の秘密鍵を作る
SecretKeySpec sk = new SecretKeySpec(key.getBytes(StandardCharsets.US_ASCII), "HmacSHA1");
mac = Mac.getInstance("HmacSHA1");
mac.init(sk);
} catch (NoSuchAlgorithmException | InvalidKeyException e) { // おそらく出ないであろう例外
}
// 繋げる
String signature = String.join("&",
method, urlEncode(url), urlEncode(formUrlEncodedContent(data)));
// ハッシュ化したシグネチャをBase64に変化する
return Base64.getEncoder().encodeToString(
mac.doFinal(signature.getBytes(StandardCharsets.US_ASCII)));
}
private String formUrlEncodedContent(Map<String, String> data) {
// Map<K, V>はEntry<K, V>になりkey=value&key=...の形で文字列に変換される
return data.entrySet().stream()
.map(e -> urlEncode(e.getKey()) + "=" + urlEncode(e.getValue()))
.collect(Collectors.joining("&"));
}
private String urlEncode(String s) {
try {
return URLEncoder.encode(s, "UTF-8");
} catch (UnsupportedEncodingException e) {
return s;
}
}
private String GenerateNonce() {
Random rnd = new Random();
return String.valueOf(123400 + rnd.nextInt(9999999 - 123400));
}
}
| TwitterAPI/src/com/company/UpdateJson.java | package com.company;
import com.sun.org.apache.xml.internal.security.keys.content.KeyValue;
import com.sun.org.apache.xml.internal.security.keys.content.keyvalues.KeyValueContent;
import com.sun.xml.internal.ws.policy.privateutil.PolicyUtils;
import org.apache.http.HttpHeaders;
import org.apache.http.auth.Credentials;
import org.apache.http.NameValuePair;
import org.apache.http.client.HttpClient;
import org.apache.http.client.entity.UrlEncodedFormEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.DefaultHttpClientConnectionOperator;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.apache.http.auth.AuthScope;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.HttpResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.KeyPair;
import java.security.NoSuchAlgorithmException;
import java.util.*;
import java.util.stream.Collectors;
public class TwiJava{
private final String CONSUMER_KEY;
private final String CONSUMER_SECRET;
private final String ACCESS_TOKEN;
private final String ACCESS_TOKEN_SECRET;
private static final String BASE_URL = "https://api.twitter.com/1.1/";
private static final String TIMELINE_URL="statuses/home_timeline.json";
public TwiJava(String CONSUMER_KEY, String CONSUMER_SECRET, String ACCESS_TOKEN, String ACCESS_TOKEN_SECRET) {
this.CONSUMER_KEY = CONSUMER_KEY;
this.CONSUMER_SECRET = CONSUMER_SECRET;
this.ACCESS_TOKEN = ACCESS_TOKEN;
this.ACCESS_TOKEN_SECRET = ACCESS_TOKEN_SECRET;
}
public String gethomeTimeline()throws IOException {
String url=BASE_URL+TIMELINE_URL;
Map<String,String>header=createHeader();
Map<String,String>AuthticationMerged=new TreeMap<>(header);
Map<String,String>timeLineData=new TreeMap<>();
AuthticationMerged.putAll(timeLineData);
header.put("oauth_signature",generateTLsignature(url,"GET",AuthticationMerged));
String headerString = "OAuth " + header.entrySet().stream()
.map(e -> String.format("%s=\"%s\"", urlEncode(e.getKey()), urlEncode(e.getValue())))
.collect(Collectors.joining(", "));
try (CloseableHttpClient client = HttpClients.createDefault()) {
HttpGet get = new HttpGet(url);
get.setHeader(HttpHeaders.AUTHORIZATION, headerString);
// レスポンスボディを勝手に文字列にして返してくれるおまじない
return client.execute(get, res -> EntityUtils.toString(res.getEntity(), "UTF-8"));
}
}
public String generateTLsignature(String url,String methodname,Map<String,String>data){
Mac m=null;
try{
String sha1SecretKey=String.join("&",CONSUMER_KEY,CONSUMER_SECRET);
SecretKeySpec secretKeySpec=new SecretKeySpec(sha1SecretKey.getBytes(StandardCharsets.US_ASCII),"HmacSHA1");
m = Mac.getInstance("HmacSHA1");
m.init(secretKeySpec);
}
catch (Exception e){
}
String signature = String.join("&",
methodname, urlEncode(url), urlEncode(formUrlEncodedContent(data)));
return Base64.getEncoder().encodeToString(
m.doFinal(signature.getBytes(StandardCharsets.US_ASCII)));
}
public String tweet(String text) throws IOException {
Map<String, String> data = new TreeMap<>();
data.put("status", text);
data.put("trim_user", "1");
return SendRequest("statuses/update.json", data);
}
public String SendRequest(String url, Map<String, String> data) throws IOException {
String fullUrl = BASE_URL + url;
Map<String, String> header = createHeader();
Map<String, String> merged = new TreeMap<>(header);
merged.putAll(data);
header.put("oauth_signature", generateSignature(fullUrl, "POST", merged));
// Authorizationの要素が揃ったので文字列にする(エスケープを忘れない)
String headerString = "OAuth " + header.entrySet().stream()
.map(e -> String.format("%s=\"%s\"", urlEncode(e.getKey()), urlEncode(e.getValue())))
.collect(Collectors.joining(", "));
// POSTするデータのHttpComponentsの仕様
List<NameValuePair> postData = data.entrySet().stream()
.map(e -> new BasicNameValuePair(e.getKey(), e.getValue()))
.collect(Collectors.toList());
try (CloseableHttpClient client = HttpClients.createDefault()) {
HttpPost post = new HttpPost(fullUrl);
post.setHeader(HttpHeaders.AUTHORIZATION, headerString);
// 入出力でUTF-8を明示する
post.setEntity(new UrlEncodedFormEntity(postData, StandardCharsets.UTF_8));
// レスポンスボディを勝手に文字列にして返してくれるおまじない
return client.execute(post, res -> EntityUtils.toString(res.getEntity(), "UTF-8"));
}
}
private Map<String, String> createHeader() {
// TreeMapはcompareToに基づく順序付けMap
Map<String, String> data = new TreeMap<>();
data.put("oauth_consumer_key", CONSUMER_KEY);
data.put("oauth_signature_method", "HMAC-SHA1");
data.put("oauth_timestamp", String.valueOf(Calendar
.getInstance(TimeZone.getTimeZone("UTC")).getTime().getTime() / 1000));
data.put("oauth_nonce", GenerateNonce());
data.put("oauth_token", ACCESS_TOKEN);
data.put("oauth_version", "1.0");
return data;
}
private String generateSignature(String url, String method, Map<String, String> data) {
Mac mac = null;
try {
String key = String.join("&", CONSUMER_SECRET, ACCESS_TOKEN_SECRET);
// シークレットを合わせてSHA1の秘密鍵を作る
SecretKeySpec sk = new SecretKeySpec(key.getBytes(StandardCharsets.US_ASCII), "HmacSHA1");
mac = Mac.getInstance("HmacSHA1");
mac.init(sk);
} catch (NoSuchAlgorithmException | InvalidKeyException e) { // おそらく出ないであろう例外
}
// 繋げる
String signature = String.join("&",
method, urlEncode(url), urlEncode(formUrlEncodedContent(data)));
// ハッシュ化したシグネチャをBase64に変化する
return Base64.getEncoder().encodeToString(
mac.doFinal(signature.getBytes(StandardCharsets.US_ASCII)));
}
private String formUrlEncodedContent(Map<String, String> data) {
// Map<K, V>はEntry<K, V>になりkey=value&key=...の形で文字列に変換される
return data.entrySet().stream()
.map(e -> urlEncode(e.getKey()) + "=" + urlEncode(e.getValue()))
.collect(Collectors.joining("&"));
}
private String urlEncode(String s) {
try {
return URLEncoder.encode(s, "UTF-8");
} catch (UnsupportedEncodingException e) {
return s;
}
}
private String GenerateNonce() {
Random rnd = new Random();
return String.valueOf(123400 + rnd.nextInt(9999999 - 123400));
}
}
| Update UpdateJson.java | TwitterAPI/src/com/company/UpdateJson.java | Update UpdateJson.java | <ide><path>witterAPI/src/com/company/UpdateJson.java
<ide> package com.company;
<ide>
<del>import com.sun.org.apache.xml.internal.security.keys.content.KeyValue;
<del>import com.sun.org.apache.xml.internal.security.keys.content.keyvalues.KeyValueContent;
<del>import com.sun.xml.internal.ws.policy.privateutil.PolicyUtils;
<ide> import org.apache.http.HttpHeaders;
<ide> import org.apache.http.auth.Credentials;
<ide> import org.apache.http.NameValuePair; |
|
Java | apache-2.0 | a1339b4d847657597d851866dbc71273af29bbe4 | 0 | DataSketches/sketches-core | /*
* Copyright 2018, Yahoo! Inc. Licensed under the terms of the
* Apache License 2.0. See LICENSE file at the project root for terms.
*/
package com.yahoo.sketches.cpc;
import static com.yahoo.sketches.Util.DEFAULT_UPDATE_SEED;
import static com.yahoo.sketches.Util.checkSeedHashes;
import static com.yahoo.sketches.Util.computeSeedHash;
import static com.yahoo.sketches.Util.invPow2;
import static com.yahoo.sketches.cpc.CpcUtil.checkLgK;
import static com.yahoo.sketches.hash.MurmurHash3.hash;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.yahoo.memory.Memory;
import com.yahoo.memory.WritableMemory;
import com.yahoo.sketches.Family;
/**
* This is a unique-counting sketch that implements the
* <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in
* his paper
* <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly
* Optimal Cardinality Estimation Algorithm</a>.
*
* <p>This sketch is extremely space-efficient when serialized. In an apples-to-apples empirical
* comparison against compressed HyperLogLog sketches, this new algorithm simultaneously wins on
* the two dimensions of the space/accuracy tradeoff and produces sketches that are
* smaller than the entropy of HLL, so no possible implementation of compressed HLL can match its
* space efficiency for a given accuracy. As described in the paper this sketch implements a newly
* developed ICON estimator algorithm that survives unioning operations, another
* well-known estimator, the
* <a href="https://arxiv.org/abs/1306.3284">Historical Inverse Probability (HIP)</a> estimator
* does not.
* The update speed performance of this sketch is quite fast and is comparable to the speed of HLL.
* The unioning (merging) capability of this sketch also allows for merging of sketches with
* different configurations of K.
*
* <p>For additional security this sketch can be configured with a user-specified hash seed.
*
* @author Lee Rhodes
* @author Kevin Lang
*/
public final class CpcSketch {
private static final String LS = System.getProperty("line.separator");
private static final double[] kxpByteLookup = new double[256];
final long seed;
//common variables
final int lgK;
long numCoupons; // The number of coupons collected so far.
boolean mergeFlag; // Is the sketch the result of merging?
int fiCol; // First Interesting Column. This is part of a speed optimization.
int windowOffset;
byte[] slidingWindow; //either null or size K bytes
PairTable pairTable; //for sparse and surprising values, either null or variable size
//The following variables are only valid in HIP varients
double kxp; //used with HIP
double hipEstAccum; //used with HIP
/**
* Constructor with log_base2 of k.
* @param lgK the given log_base2 of k
*/
public CpcSketch(final int lgK) {
this(lgK, DEFAULT_UPDATE_SEED);
}
/**
* Constructor with log_base2 of k and seed.
* @param lgK the given log_base2 of k
* @param seed the given seed
*/
public CpcSketch(final int lgK, final long seed) {
checkLgK(lgK);
this.lgK = (byte) lgK;
this.seed = seed;
kxp = 1 << lgK;
reset();
}
/**
* Returns a copy of this sketch
* @return a copy of this sketcch
*/
CpcSketch copy() {
final CpcSketch copy = new CpcSketch(lgK, seed);
copy.numCoupons = numCoupons;
copy.mergeFlag = mergeFlag;
copy.fiCol = fiCol;
copy.windowOffset = windowOffset;
copy.slidingWindow = (slidingWindow == null) ? null : slidingWindow.clone();
copy.pairTable = (pairTable == null) ? null : pairTable.copy();
copy.kxp = kxp;
copy.hipEstAccum = hipEstAccum;
return copy;
}
/**
* Returns the best estimate of the cardinality of the sketch.
* @return the best estimate of the cardinality of the sketch.
*/
public double getEstimate() {
if (mergeFlag) { return IconEstimator.getIconEstimate(lgK, numCoupons); }
return hipEstAccum;
}
/**
* Return the DataSketches identifier for this CPC family of sketches.
* @return the DataSketches identifier for this CPC family of sketches.
*/
public static Family getFamily() {
return Family.CPC;
}
/**
* Return the parameter LgK.
* @return the parameter LgK.
*/
public int getLgK() {
return lgK;
}
/**
* Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>,
* the number of standard deviations from the mean.
* @param kappa the given number of standard deviations from the mean: 1, 2 or 3.
* @return the best estimate of the lower bound of the confidence interval given <i>kappa</i>.
*/
public double getLowerBound(final int kappa) {
if (mergeFlag) {
return CpcConfidence.getIconConfidenceLB(lgK, numCoupons, kappa);
}
return CpcConfidence.getHipConfidenceLB(lgK, numCoupons, hipEstAccum, kappa);
}
/*
* These empirical values for the 99.9th percentile of size in bytes were measured using 100,000
* trials. The value for each trial is the maximum of 5*16=80 measurements that were equally
* spaced over values of the quantity C/K between 3.0 and 8.0. This table does not include the
* worst-case space for the preamble, which is added by the function.
*/
private static final int[] empiricalMaxBytes = {
24, // lgK = 4
36, // lgK = 5
56, // lgK = 6
100, // lgK = 7
180, // lgK = 8
344, // lgK = 9
660, // lgK = 10
1292, // lgK = 11
2540, // lgK = 12
5020, // lgK = 13
9968, // lgK = 14
19836, // lgK = 15
39532, // lgK = 16
78880, // lgK = 17
157516, // lgK = 18
314656 // lgK = 19
};
/**
* The actual size of a compressed CPC sketch has a small random variance, but the following
* empirically measured size should be large enough for at least 99.9 percent of sketches.
*
* <p>For small values of <i>n</i> the size can be much smaller.
*
* @param lgK the given value of lgK.
* @return the estimated maximum compressed serialized size of a sketch.
*/
public static int getMaxSerializedBytes(final int lgK) {
checkLgK(lgK);
if (lgK <= 19) { return empiricalMaxBytes[lgK - 4] + 40; }
final int k = 1 << lgK;
return (int) (0.6 * k) + 40; // 0.6 = 4.8 / 8.0
}
/**
* Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>,
* the number of standard deviations from the mean.
* @param kappa the given number of standard deviations from the mean: 1, 2 or 3.
* @return the best estimate of the upper bound of the confidence interval given <i>kappa</i>.
*/
public double getUpperBound(final int kappa) {
if (mergeFlag) {
return CpcConfidence.getIconConfidenceUB(lgK, numCoupons, kappa);
}
return CpcConfidence.getHipConfidenceUB(lgK, numCoupons, hipEstAccum, kappa);
}
/**
* Return the given Memory as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.
* @param mem the given Memory
* @return the given Memory as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final Memory mem) {
return heapify(mem, DEFAULT_UPDATE_SEED);
}
/**
* Return the given byte array as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.
* @param byteArray the given byte array
* @return the given byte array as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final byte[] byteArray) {
return heapify(byteArray, DEFAULT_UPDATE_SEED);
}
/**
* Return the given Memory as a CpcSketch on the Java heap.
* @param mem the given Memory
* @param seed the seed used to create the original sketch from which the Memory was derived.
* @return the given Memory as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final Memory mem, final long seed) {
final CompressedState state = CompressedState.importFromMemory(mem);
return uncompress(state, seed);
}
/**
* Return the given byte array as a CpcSketch on the Java heap.
* @param byteArray the given byte array
* @param seed the seed used to create the original sketch from which the byte array was derived.
* @return the given byte array as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final byte[] byteArray, final long seed) {
final Memory mem = Memory.wrap(byteArray);
return heapify(mem, seed);
}
/**
* Return true if this sketch is empty
* @return true if this sketch is empty
*/
public boolean isEmpty() {
return numCoupons == 0;
}
/**
* Resets this sketch to empty but retains the original LgK and Seed.
*/
public final void reset() {
numCoupons = 0;
mergeFlag = false;
fiCol = 0;
windowOffset = 0;
slidingWindow = null;
pairTable = null;
kxp = 1 << lgK;
hipEstAccum = 0;
}
/**
* Return this sketch as a compressed byte array.
* @return this sketch as a compressed byte array.
*/
public byte[] toByteArray() {
final CompressedState state = CompressedState.compress(this);
final long cap = state.getMemoryCapacity();
final WritableMemory wmem = WritableMemory.allocate((int) cap);
state.exportToMemory(wmem);
return (byte[]) wmem.getArray();
}
/**
* Present the given long as a potential unique item.
*
* @param datum The given long datum.
*/
public void update(final long datum) {
final long[] data = { datum };
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given double (or float) datum as a potential unique item.
* The double will be converted to a long using Double.doubleToLongBits(datum),
* which normalizes all NaN values to a single NaN representation.
* Plus and minus zero will be normalized to plus zero.
* The special floating-point values NaN and +/- Infinity are treated as distinct.
*
* @param datum The given double datum.
*/
public void update(final double datum) {
final double d = (datum == 0.0) ? 0.0 : datum; // canonicalize -0.0, 0.0
final long[] data = { Double.doubleToLongBits(d) };// canonicalize all NaN forms
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given String as a potential unique item.
* The string is converted to a byte array using UTF8 encoding.
* If the string is null or empty no update attempt is made and the method returns.
*
* <p>Note: About 2X faster performance can be obtained by first converting the String to a
* char[] and updating the sketch with that. This bypasses the complexity of the Java UTF_8
* encoding. This, of course, will not produce the same internal hash values as updating directly
* with a String. So be consistent! Unioning two sketches, one fed with strings and the other
* fed with char[] will be meaningless.
* </p>
*
* @param datum The given String.
*/
public void update(final String datum) {
if ((datum == null) || datum.isEmpty()) { return; }
final byte[] data = datum.getBytes(UTF_8);
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given byte array as a potential unique item.
* If the byte array is null or empty no update attempt is made and the method returns.
*
* @param data The given byte array.
*/
public void update(final byte[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given char array as a potential unique item.
* If the char array is null or empty no update attempt is made and the method returns.
*
* <p>Note: this will not produce the same output hash values as the {@link #update(String)}
* method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p>
*
* @param data The given char array.
*/
public void update(final char[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given integer array as a potential unique item.
* If the integer array is null or empty no update attempt is made and the method returns.
*
* @param data The given int array.
*/
public void update(final int[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given long array as a potential unique item.
* If the long array is null or empty no update attempt is made and the method returns.
*
* @param data The given long array.
*/
public void update(final long[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Returns the current Flavor of this sketch.
* @return the current Flavor of this sketch.
*/
Flavor getFlavor() {
return CpcUtil.determineFlavor(lgK, numCoupons);
}
/**
* Returns the Format of the serialized form of this sketch.
* @return the Format of the serialized form of this sketch.
*/
Format getFormat() {
final int ordinal;
final Flavor f = getFlavor();
if ((f == Flavor.HYBRID) || (f == Flavor.SPARSE)) {
ordinal = 2 | ( mergeFlag ? 0 : 1 ); //Hybrid is serialized as SPARSE
} else {
ordinal = ((slidingWindow != null) ? 4 : 0)
| (((pairTable != null) && (pairTable.getNumPairs() > 0)) ? 2 : 0)
| ( mergeFlag ? 0 : 1 );
}
return Format.ordinalToFormat(ordinal);
}
private static void promoteEmptyToSparse(final CpcSketch sketch) {
assert sketch.numCoupons == 0;
assert sketch.pairTable == null;
sketch.pairTable = new PairTable(2, 6 + sketch.lgK);
}
//In terms of flavor, this promotes SPARSE to HYBRID.
private static void promoteSparseToWindowed(final CpcSketch sketch) {
final int lgK = sketch.lgK;
final int k = (1 << lgK);
final long c32 = sketch.numCoupons << 5;
assert ((c32 == (3 * k)) || ((lgK == 4) && (c32 > (3 * k))));
final byte[] window = new byte[k];
final PairTable newTable = new PairTable(2, 6 + lgK);
final PairTable oldTable = sketch.pairTable;
final int[] oldSlots = oldTable.getSlotsArr();
final int oldNumSlots = (1 << oldTable.getLgSizeInts());
assert (sketch.windowOffset == 0);
for (int i = 0; i < oldNumSlots; i++) {
final int rowCol = oldSlots[i];
if (rowCol != -1) {
final int col = rowCol & 63;
if (col < 8) {
final int row = rowCol >>> 6;
window[row] |= (1 << col);
}
else {
// cannot use Table.mustInsert(), because it doesn't provide for growth
final boolean isNovel = PairTable.maybeInsert(newTable, rowCol);
assert (isNovel == true);
}
}
}
assert (sketch.slidingWindow == null);
sketch.slidingWindow = window;
sketch.pairTable = newTable;
}
/**
* The KXP register is a double with roughly 50 bits of precision, but
* it might need roughly 90 bits to track the value with perfect accuracy.
* Therefore we recalculate KXP occasionally from the sketch's full bitMatrix
* so that it will reflect changes that were previously outside the mantissa.
* @param sketch the given sketch
* @param bitMatrix the given bit Matrix
*/
//Also used in test
static void refreshKXP(final CpcSketch sketch, final long[] bitMatrix) {
final int k = (1 << sketch.lgK);
// for improved numerical accuracy, we separately sum the bytes of the U64's
final double[] byteSums = new double[8];
for (int j = 0; j < 8; j++) { byteSums[j] = 0.0; }
for (int i = 0; i < k; i++) {
long row = bitMatrix[i];
for (int j = 0; j < 8; j++) {
final int byteIdx = (int) (row & 0XFFL);
byteSums[j] += kxpByteLookup[byteIdx];
row >>>= 8;
}
}
double total = 0.0;
for (int j = 7; j-- > 0; ) { // the reverse order is important
final double factor = invPow2(8 * j); // pow(256, -j) == pow(2, -8 * j);
total += factor * byteSums[j];
}
sketch.kxp = total;
}
/**
* This moves the sliding window
* @param sketch the given sketch
* @param newOffset the new offset, which must be oldOffset + 1
*/
private static void modifyOffset(final CpcSketch sketch, final int newOffset) {
assert ((newOffset >= 0) && (newOffset <= 56));
assert (newOffset == (sketch.windowOffset + 1));
assert (newOffset == CpcUtil.determineCorrectOffset(sketch.lgK, sketch.numCoupons));
assert (sketch.slidingWindow != null);
assert (sketch.pairTable != null);
final int k = 1 << sketch.lgK;
// Construct the full-sized bit matrix that corresponds to the sketch
final long[] bitMatrix = CpcUtil.bitMatrixOfSketch(sketch);
// refresh the KXP register on every 8th window shift.
if ((newOffset & 0x7) == 0) { refreshKXP(sketch, bitMatrix); }
sketch.pairTable.clear();
final PairTable table = sketch.pairTable;
final byte[] window = sketch.slidingWindow;
final long maskForClearingWindow = (0XFFL << newOffset) ^ -1L;
final long maskForFlippingEarlyZone = (1L << newOffset) - 1L;
long allSurprisesORed = 0;
for (int i = 0; i < k; i++) {
long pattern = bitMatrix[i];
window[i] = (byte) ((pattern >>> newOffset) & 0XFFL);
pattern &= maskForClearingWindow;
// The following line converts surprising 0's to 1's in the "early zone",
// (and vice versa, which is essential for this procedure's O(k) time cost).
pattern ^= maskForFlippingEarlyZone;
allSurprisesORed |= pattern; // a cheap way to recalculate fiCol
while (pattern != 0) {
final int col = Long.numberOfTrailingZeros(pattern);
pattern = pattern ^ (1L << col); // erase the 1.
final int rowCol = (i << 6) | col;
final boolean isNovel = PairTable.maybeInsert(table, rowCol);
assert isNovel == true;
}
}
sketch.windowOffset = newOffset;
sketch.fiCol = Long.numberOfTrailingZeros(allSurprisesORed);
if (sketch.fiCol > newOffset) {
sketch.fiCol = newOffset; // corner case
}
}
/**
* Call this whenever a new coupon has been collected.
* @param sketch the given sketch
* @param rowCol the given row / column
*/
private static void updateHIP(final CpcSketch sketch, final int rowCol) {
final int k = 1 << sketch.lgK;
final int col = rowCol & 63;
final double oneOverP = k / sketch.kxp;
sketch.hipEstAccum += oneOverP;
sketch.kxp -= invPow2(col + 1); // notice the "+1"
}
private static void updateSparse(final CpcSketch sketch, final int rowCol) {
final int k = 1 << sketch.lgK;
final long c32pre = sketch.numCoupons << 5;
assert (c32pre < (3L * k)); // C < 3K/32, in other words, flavor == SPARSE
assert (sketch.pairTable != null);
final boolean isNovel = PairTable.maybeInsert(sketch.pairTable, rowCol);
if (isNovel) {
sketch.numCoupons += 1;
updateHIP(sketch, rowCol);
final long c32post = sketch.numCoupons << 5;
if (c32post >= (3L * k)) { promoteSparseToWindowed(sketch); } // C >= 3K/32
}
}
/**
* The flavor is HYBRID, PINNED, or SLIDING.
* @param sketch the given sketch
* @param rowCol the given rowCol
*/
private static void updateWindowed(final CpcSketch sketch, final int rowCol) {
assert ((sketch.windowOffset >= 0) && (sketch.windowOffset <= 56));
final int k = 1 << sketch.lgK;
final long c32pre = sketch.numCoupons << 5;
assert c32pre >= (3L * k); // C < 3K/32, in other words flavor >= HYBRID
final long c8pre = sketch.numCoupons << 3;
final int w8pre = sketch.windowOffset << 3;
assert c8pre < ((27L + w8pre) * k); // C < (K * 27/8) + (K * windowOffset)
boolean isNovel = false; //novel if new coupon
final int col = rowCol & 63;
if (col < sketch.windowOffset) { // track the surprising 0's "before" the window
isNovel = PairTable.maybeDelete(sketch.pairTable, rowCol); // inverted logic
}
else if (col < (sketch.windowOffset + 8)) { // track the 8 bits inside the window
assert (col >= sketch.windowOffset);
final int row = rowCol >>> 6;
final byte oldBits = sketch.slidingWindow[row];
final byte newBits = (byte) (oldBits | (1 << (col - sketch.windowOffset)));
if (newBits != oldBits) {
sketch.slidingWindow[row] = newBits;
isNovel = true;
}
}
else { // track the surprising 1's "after" the window
assert col >= (sketch.windowOffset + 8);
isNovel = PairTable.maybeInsert(sketch.pairTable, rowCol); // normal logic
}
if (isNovel) {
sketch.numCoupons += 1;
updateHIP(sketch, rowCol);
final long c8post = sketch.numCoupons << 3;
if (c8post >= ((27L + w8pre) * k)) {
modifyOffset(sketch, sketch.windowOffset + 1);
assert (sketch.windowOffset >= 1) && (sketch.windowOffset <= 56);
final int w8post = sketch.windowOffset << 3;
assert c8post < ((27L + w8post) * k); // C < (K * 27/8) + (K * windowOffset)
}
}
}
//also used in test
static CpcSketch uncompress(final CompressedState source, final long seed) {
checkSeedHashes(computeSeedHash(seed), source.seedHash);
final CpcSketch sketch = new CpcSketch(source.lgK, seed);
sketch.numCoupons = source.numCoupons;
sketch.windowOffset = source.getWindowOffset();
sketch.fiCol = source.fiCol;
sketch.mergeFlag = source.mergeFlag;
sketch.kxp = source.kxp;
sketch.hipEstAccum = source.hipEstAccum;
sketch.slidingWindow = null;
sketch.pairTable = null;
CpcCompression.uncompress(source, sketch);
return sketch;
}
//Used here and for testing
void hashUpdate(final long hash0, final long hash1) {
int col = Long.numberOfLeadingZeros(hash1);
if (col < fiCol) { return; } // important speed optimization
if (col > 63) { col = 63; } // clip so that 0 <= col <= 63
final long c = numCoupons;
if (c == 0) { promoteEmptyToSparse(this); }
final long k = 1L << lgK;
final int row = (int) (hash0 & (k - 1L));
int rowCol = (row << 6) | col;
// Avoid the hash table's "empty" value which is (2^26 -1, 63) (all ones) by changing it
// to the pair (2^26 - 2, 63), which effectively merges the two cells.
// This case is *extremely* unlikely, but we might as well handle it.
// It can't happen at all if lgK (or maxLgK) < 26.
if (rowCol == -1) { rowCol ^= (1 << 6); } //set the LSB of row to 0
if ((c << 5) < (3L * k)) { updateSparse(this, rowCol); }
else { updateWindowed(this, rowCol); }
}
//Used by union and in testing
void rowColUpdate(final int rowCol) {
final int col = rowCol & 63;
if (col < fiCol) { return; } // important speed optimization
final long c = numCoupons;
if (c == 0) { promoteEmptyToSparse(this); }
final long k = 1L << lgK;
if ((c << 5) < (3L * k)) { updateSparse(this, rowCol); }
else { updateWindowed(this, rowCol); }
}
/**
* Return a human-readable string summary of this sketch
*/
@Override
public String toString() {
return toString(false);
}
/**
* Return a human-readable string summary of this sketch
* @param detail include data detail
* @return a human-readable string summary of this sketch
*/
public String toString(final boolean detail) {
final int numPairs = (pairTable == null) ? 0 : pairTable.getNumPairs();
final StringBuilder sb = new StringBuilder();
sb.append("CpcSketch").append(LS);
sb.append(" Flavor : ").append(getFlavor()).append(LS);
sb.append(" lgK : ").append(lgK).append(LS);
sb.append(" seed : ").append(seed).append(LS);
sb.append(" numCoupons : ").append(numCoupons).append(LS);
sb.append(" numPairs (SV): ").append(numPairs).append(LS);
sb.append(" mergeFlag : ").append(mergeFlag).append(LS);
sb.append(" fiCol : ").append(fiCol).append(LS);
sb.append(" Window? : ").append(slidingWindow != null).append(LS);
sb.append(" winOffset : ").append(windowOffset).append(LS);
sb.append(" kxp : ").append(kxp).append(LS);
sb.append(" hipAccum : ").append(hipEstAccum).append(LS);
if (detail) {
if (pairTable != null) {
sb.append(pairTable.toString(true));
}
if (slidingWindow != null) {
sb.append(" SlidingWindow : ").append(LS);
for (int i = 0; i < slidingWindow.length; i++) {
sb.append(String.format("%8d %6d" + LS, i, slidingWindow[i]));
}
}
}
return sb.toString();
}
private static void fillKxpByteLookup() { //called from static initializer
for (int b = 0; b < 256; b++) {
double sum = 0;
for (int col = 0; col < 8; col++) {
final int bit = (b >>> col) & 1;
if (bit == 0) { // note the inverted logic
sum += invPow2(col + 1); //note the "+1"
}
}
kxpByteLookup[b] = sum;
}
}
static {
fillKxpByteLookup();
}
}
| src/main/java/com/yahoo/sketches/cpc/CpcSketch.java | /*
* Copyright 2018, Yahoo! Inc. Licensed under the terms of the
* Apache License 2.0. See LICENSE file at the project root for terms.
*/
package com.yahoo.sketches.cpc;
import static com.yahoo.sketches.Util.DEFAULT_UPDATE_SEED;
import static com.yahoo.sketches.Util.checkSeedHashes;
import static com.yahoo.sketches.Util.computeSeedHash;
import static com.yahoo.sketches.Util.invPow2;
import static com.yahoo.sketches.cpc.CpcUtil.checkLgK;
import static com.yahoo.sketches.hash.MurmurHash3.hash;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.yahoo.memory.Memory;
import com.yahoo.memory.WritableMemory;
import com.yahoo.sketches.Family;
/**
* This is a unique-counting sketch that implements the
* <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in
* his paper
* <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly
* Optimal Cardinality Estimation Algorithm</a>.
*
* <p>This sketch is extremely space-efficient when serialized. In an apples-to-apples empirical
* comparison against compressed HyperLogLog sketches, this new algorithm simultaneously wins on
* the two dimensions of the space/accuracy tradeoff and produces sketches that are
* smaller than the entropy of HLL, so no possible implementation of compressed HLL can match its
* space efficiency for a given accuracy. As described in the paper this sketch implements a newly
* developed ICON estimator algorithm that survives unioning operations, another
* well-known estimator, the
* <a href="https://arxiv.org/abs/1306.3284">Historical Inverse Probability (HIP)</a> estimator
* does not.
* The update speed performance of this sketch is quite fast and is comparable to the speed of HLL.
* The unioning (merging) capability of this sketch also allows for merging of sketches with
* different configurations of K.
*
* <p>For additional security this sketch can be configured with a user-specified hash seed.
*
* @author Lee Rhodes
* @author Kevin Lang
*/
public final class CpcSketch {
private static final String LS = System.getProperty("line.separator");
private static final double[] kxpByteLookup = new double[256];
final long seed;
//common variables
final int lgK;
long numCoupons; // The number of coupons collected so far.
boolean mergeFlag; // Is the sketch the result of merging?
int fiCol; // First Interesting Column. This is part of a speed optimization.
int windowOffset;
byte[] slidingWindow; //either null or size K bytes
PairTable pairTable; //for sparse and surprising values, either null or variable size
//The following variables are only valid in HIP varients
double kxp; //used with HIP
double hipEstAccum; //used with HIP
/**
* Constructor with log_base2 of k.
* @param lgK the given log_base2 of k
*/
public CpcSketch(final int lgK) {
this(lgK, DEFAULT_UPDATE_SEED);
}
/**
* Constructor with log_base2 of k and seed.
* @param lgK the given log_base2 of k
* @param seed the given seed
*/
public CpcSketch(final int lgK, final long seed) {
checkLgK(lgK);
this.lgK = (byte) lgK;
this.seed = seed;
kxp = 1 << lgK;
reset();
}
/**
* Returns a copy of this sketch
* @return a copy of this sketcch
*/
CpcSketch copy() {
final CpcSketch copy = new CpcSketch(lgK, seed);
copy.numCoupons = numCoupons;
copy.mergeFlag = mergeFlag;
copy.fiCol = fiCol;
copy.windowOffset = windowOffset;
copy.slidingWindow = (slidingWindow == null) ? null : slidingWindow.clone();
copy.pairTable = (pairTable == null) ? null : pairTable.copy();
copy.kxp = kxp;
copy.hipEstAccum = hipEstAccum;
return copy;
}
/**
* Returns the best estimate of the cardinality of the sketch.
* @return the best estimate of the cardinality of the sketch.
*/
public double getEstimate() {
if (mergeFlag) { return IconEstimator.getIconEstimate(lgK, numCoupons); }
return hipEstAccum;
}
/**
* Return the DataSketches identifier for this CPC family of sketches.
* @return the DataSketches identifier for this CPC family of sketches.
*/
public static Family getFamily() {
return Family.CPC;
}
/**
* Return the parameter LgK.
* @return the parameter LgK.
*/
public int getLgK() {
return lgK;
}
/**
* Returns the best estimate of the lower bound of the confidence interval given <i>kappa</i>,
* the number of standard deviations from the mean.
* @param kappa the given number of standard deviations from the mean: 1, 2 or 3.
* @return the best estimate of the lower bound of the confidence interval given <i>kappa</i>.
*/
public double getLowerBound(final int kappa) {
if (mergeFlag) {
return CpcConfidence.getIconConfidenceLB(lgK, numCoupons, kappa);
}
return CpcConfidence.getHipConfidenceLB(lgK, numCoupons, hipEstAccum, kappa);
}
/*
* These empirical values for the 99.9th percentile of size in bytes were measured using 100,000
* trials. The value for each trial is the maximum of 5*16=80 measurements that were equally
* spaced over values of the quantity C/K between 3.0 and 8.0.
*/
private static final int[] empiricalMaxBytes = {
24, // lgK = 4
36, // lgK = 5
56, // lgK = 6
100, // lgK = 7
180, // lgK = 8
344, // lgK = 9
660, // lgK = 10
1292, // lgK = 11
2540, // lgK = 12
5020, // lgK = 13
9968, // lgK = 14
19836, // lgK = 15
39532, // lgK = 16
78880, // lgK = 17
157516, // lgK = 18
314656 // lgK = 19
};
/**
* The actual size of a compressed CPC sketch has a small random variance, but the following
* empirically measured size should be large enough for at least 99.9 percent of sketches.
*
* <p>For small values of <i>n</i> the size can be much smaller.
*
* @param lgK the given value of lgK.
* @return the estimated maximum compressed serialized size of a sketch.
*/
public static int getMaxSerializedBytes(final int lgK) {
checkLgK(lgK);
if (lgK <= 19) { return empiricalMaxBytes[lgK - 4] + 40; }
final int k = 1 << lgK;
return (int) (0.6 * k) + 40; // 0.6 = 4.8 / 8.0
}
/**
* Returns the best estimate of the upper bound of the confidence interval given <i>kappa</i>,
* the number of standard deviations from the mean.
* @param kappa the given number of standard deviations from the mean: 1, 2 or 3.
* @return the best estimate of the upper bound of the confidence interval given <i>kappa</i>.
*/
public double getUpperBound(final int kappa) {
if (mergeFlag) {
return CpcConfidence.getIconConfidenceUB(lgK, numCoupons, kappa);
}
return CpcConfidence.getHipConfidenceUB(lgK, numCoupons, hipEstAccum, kappa);
}
/**
* Return the given Memory as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.
* @param mem the given Memory
* @return the given Memory as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final Memory mem) {
return heapify(mem, DEFAULT_UPDATE_SEED);
}
/**
* Return the given byte array as a CpcSketch on the Java heap using the DEFAULT_UPDATE_SEED.
* @param byteArray the given byte array
* @return the given byte array as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final byte[] byteArray) {
return heapify(byteArray, DEFAULT_UPDATE_SEED);
}
/**
* Return the given Memory as a CpcSketch on the Java heap.
* @param mem the given Memory
* @param seed the seed used to create the original sketch from which the Memory was derived.
* @return the given Memory as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final Memory mem, final long seed) {
final CompressedState state = CompressedState.importFromMemory(mem);
return uncompress(state, seed);
}
/**
* Return the given byte array as a CpcSketch on the Java heap.
* @param byteArray the given byte array
* @param seed the seed used to create the original sketch from which the byte array was derived.
* @return the given byte array as a CpcSketch on the Java heap.
*/
public static CpcSketch heapify(final byte[] byteArray, final long seed) {
final Memory mem = Memory.wrap(byteArray);
return heapify(mem, seed);
}
/**
* Return true if this sketch is empty
* @return true if this sketch is empty
*/
public boolean isEmpty() {
return numCoupons == 0;
}
/**
* Resets this sketch to empty but retains the original LgK and Seed.
*/
public final void reset() {
numCoupons = 0;
mergeFlag = false;
fiCol = 0;
windowOffset = 0;
slidingWindow = null;
pairTable = null;
kxp = 1 << lgK;
hipEstAccum = 0;
}
/**
* Return this sketch as a compressed byte array.
* @return this sketch as a compressed byte array.
*/
public byte[] toByteArray() {
final CompressedState state = CompressedState.compress(this);
final long cap = state.getMemoryCapacity();
final WritableMemory wmem = WritableMemory.allocate((int) cap);
state.exportToMemory(wmem);
return (byte[]) wmem.getArray();
}
/**
* Present the given long as a potential unique item.
*
* @param datum The given long datum.
*/
public void update(final long datum) {
final long[] data = { datum };
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given double (or float) datum as a potential unique item.
* The double will be converted to a long using Double.doubleToLongBits(datum),
* which normalizes all NaN values to a single NaN representation.
* Plus and minus zero will be normalized to plus zero.
* The special floating-point values NaN and +/- Infinity are treated as distinct.
*
* @param datum The given double datum.
*/
public void update(final double datum) {
final double d = (datum == 0.0) ? 0.0 : datum; // canonicalize -0.0, 0.0
final long[] data = { Double.doubleToLongBits(d) };// canonicalize all NaN forms
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given String as a potential unique item.
* The string is converted to a byte array using UTF8 encoding.
* If the string is null or empty no update attempt is made and the method returns.
*
* <p>Note: About 2X faster performance can be obtained by first converting the String to a
* char[] and updating the sketch with that. This bypasses the complexity of the Java UTF_8
* encoding. This, of course, will not produce the same internal hash values as updating directly
* with a String. So be consistent! Unioning two sketches, one fed with strings and the other
* fed with char[] will be meaningless.
* </p>
*
* @param datum The given String.
*/
public void update(final String datum) {
if ((datum == null) || datum.isEmpty()) { return; }
final byte[] data = datum.getBytes(UTF_8);
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given byte array as a potential unique item.
* If the byte array is null or empty no update attempt is made and the method returns.
*
* @param data The given byte array.
*/
public void update(final byte[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given char array as a potential unique item.
* If the char array is null or empty no update attempt is made and the method returns.
*
* <p>Note: this will not produce the same output hash values as the {@link #update(String)}
* method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p>
*
* @param data The given char array.
*/
public void update(final char[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given integer array as a potential unique item.
* If the integer array is null or empty no update attempt is made and the method returns.
*
* @param data The given int array.
*/
public void update(final int[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Present the given long array as a potential unique item.
* If the long array is null or empty no update attempt is made and the method returns.
*
* @param data The given long array.
*/
public void update(final long[] data) {
if ((data == null) || (data.length == 0)) { return; }
final long[] arr = hash(data, seed);
hashUpdate(arr[0], arr[1]);
}
/**
* Returns the current Flavor of this sketch.
* @return the current Flavor of this sketch.
*/
Flavor getFlavor() {
return CpcUtil.determineFlavor(lgK, numCoupons);
}
/**
* Returns the Format of the serialized form of this sketch.
* @return the Format of the serialized form of this sketch.
*/
Format getFormat() {
final int ordinal;
final Flavor f = getFlavor();
if ((f == Flavor.HYBRID) || (f == Flavor.SPARSE)) {
ordinal = 2 | ( mergeFlag ? 0 : 1 ); //Hybrid is serialized as SPARSE
} else {
ordinal = ((slidingWindow != null) ? 4 : 0)
| (((pairTable != null) && (pairTable.getNumPairs() > 0)) ? 2 : 0)
| ( mergeFlag ? 0 : 1 );
}
return Format.ordinalToFormat(ordinal);
}
private static void promoteEmptyToSparse(final CpcSketch sketch) {
assert sketch.numCoupons == 0;
assert sketch.pairTable == null;
sketch.pairTable = new PairTable(2, 6 + sketch.lgK);
}
//In terms of flavor, this promotes SPARSE to HYBRID.
private static void promoteSparseToWindowed(final CpcSketch sketch) {
final int lgK = sketch.lgK;
final int k = (1 << lgK);
final long c32 = sketch.numCoupons << 5;
assert ((c32 == (3 * k)) || ((lgK == 4) && (c32 > (3 * k))));
final byte[] window = new byte[k];
final PairTable newTable = new PairTable(2, 6 + lgK);
final PairTable oldTable = sketch.pairTable;
final int[] oldSlots = oldTable.getSlotsArr();
final int oldNumSlots = (1 << oldTable.getLgSizeInts());
assert (sketch.windowOffset == 0);
for (int i = 0; i < oldNumSlots; i++) {
final int rowCol = oldSlots[i];
if (rowCol != -1) {
final int col = rowCol & 63;
if (col < 8) {
final int row = rowCol >>> 6;
window[row] |= (1 << col);
}
else {
// cannot use Table.mustInsert(), because it doesn't provide for growth
final boolean isNovel = PairTable.maybeInsert(newTable, rowCol);
assert (isNovel == true);
}
}
}
assert (sketch.slidingWindow == null);
sketch.slidingWindow = window;
sketch.pairTable = newTable;
}
/**
* The KXP register is a double with roughly 50 bits of precision, but
* it might need roughly 90 bits to track the value with perfect accuracy.
* Therefore we recalculate KXP occasionally from the sketch's full bitMatrix
* so that it will reflect changes that were previously outside the mantissa.
* @param sketch the given sketch
* @param bitMatrix the given bit Matrix
*/
//Also used in test
static void refreshKXP(final CpcSketch sketch, final long[] bitMatrix) {
final int k = (1 << sketch.lgK);
// for improved numerical accuracy, we separately sum the bytes of the U64's
final double[] byteSums = new double[8];
for (int j = 0; j < 8; j++) { byteSums[j] = 0.0; }
for (int i = 0; i < k; i++) {
long row = bitMatrix[i];
for (int j = 0; j < 8; j++) {
final int byteIdx = (int) (row & 0XFFL);
byteSums[j] += kxpByteLookup[byteIdx];
row >>>= 8;
}
}
double total = 0.0;
for (int j = 7; j-- > 0; ) { // the reverse order is important
final double factor = invPow2(8 * j); // pow(256, -j) == pow(2, -8 * j);
total += factor * byteSums[j];
}
sketch.kxp = total;
}
/**
* This moves the sliding window
* @param sketch the given sketch
* @param newOffset the new offset, which must be oldOffset + 1
*/
private static void modifyOffset(final CpcSketch sketch, final int newOffset) {
assert ((newOffset >= 0) && (newOffset <= 56));
assert (newOffset == (sketch.windowOffset + 1));
assert (newOffset == CpcUtil.determineCorrectOffset(sketch.lgK, sketch.numCoupons));
assert (sketch.slidingWindow != null);
assert (sketch.pairTable != null);
final int k = 1 << sketch.lgK;
// Construct the full-sized bit matrix that corresponds to the sketch
final long[] bitMatrix = CpcUtil.bitMatrixOfSketch(sketch);
// refresh the KXP register on every 8th window shift.
if ((newOffset & 0x7) == 0) { refreshKXP(sketch, bitMatrix); }
sketch.pairTable.clear();
final PairTable table = sketch.pairTable;
final byte[] window = sketch.slidingWindow;
final long maskForClearingWindow = (0XFFL << newOffset) ^ -1L;
final long maskForFlippingEarlyZone = (1L << newOffset) - 1L;
long allSurprisesORed = 0;
for (int i = 0; i < k; i++) {
long pattern = bitMatrix[i];
window[i] = (byte) ((pattern >>> newOffset) & 0XFFL);
pattern &= maskForClearingWindow;
// The following line converts surprising 0's to 1's in the "early zone",
// (and vice versa, which is essential for this procedure's O(k) time cost).
pattern ^= maskForFlippingEarlyZone;
allSurprisesORed |= pattern; // a cheap way to recalculate fiCol
while (pattern != 0) {
final int col = Long.numberOfTrailingZeros(pattern);
pattern = pattern ^ (1L << col); // erase the 1.
final int rowCol = (i << 6) | col;
final boolean isNovel = PairTable.maybeInsert(table, rowCol);
assert isNovel == true;
}
}
sketch.windowOffset = newOffset;
sketch.fiCol = Long.numberOfTrailingZeros(allSurprisesORed);
if (sketch.fiCol > newOffset) {
sketch.fiCol = newOffset; // corner case
}
}
/**
* Call this whenever a new coupon has been collected.
* @param sketch the given sketch
* @param rowCol the given row / column
*/
private static void updateHIP(final CpcSketch sketch, final int rowCol) {
final int k = 1 << sketch.lgK;
final int col = rowCol & 63;
final double oneOverP = k / sketch.kxp;
sketch.hipEstAccum += oneOverP;
sketch.kxp -= invPow2(col + 1); // notice the "+1"
}
private static void updateSparse(final CpcSketch sketch, final int rowCol) {
final int k = 1 << sketch.lgK;
final long c32pre = sketch.numCoupons << 5;
assert (c32pre < (3L * k)); // C < 3K/32, in other words, flavor == SPARSE
assert (sketch.pairTable != null);
final boolean isNovel = PairTable.maybeInsert(sketch.pairTable, rowCol);
if (isNovel) {
sketch.numCoupons += 1;
updateHIP(sketch, rowCol);
final long c32post = sketch.numCoupons << 5;
if (c32post >= (3L * k)) { promoteSparseToWindowed(sketch); } // C >= 3K/32
}
}
/**
* The flavor is HYBRID, PINNED, or SLIDING.
* @param sketch the given sketch
* @param rowCol the given rowCol
*/
private static void updateWindowed(final CpcSketch sketch, final int rowCol) {
assert ((sketch.windowOffset >= 0) && (sketch.windowOffset <= 56));
final int k = 1 << sketch.lgK;
final long c32pre = sketch.numCoupons << 5;
assert c32pre >= (3L * k); // C < 3K/32, in other words flavor >= HYBRID
final long c8pre = sketch.numCoupons << 3;
final int w8pre = sketch.windowOffset << 3;
assert c8pre < ((27L + w8pre) * k); // C < (K * 27/8) + (K * windowOffset)
boolean isNovel = false; //novel if new coupon
final int col = rowCol & 63;
if (col < sketch.windowOffset) { // track the surprising 0's "before" the window
isNovel = PairTable.maybeDelete(sketch.pairTable, rowCol); // inverted logic
}
else if (col < (sketch.windowOffset + 8)) { // track the 8 bits inside the window
assert (col >= sketch.windowOffset);
final int row = rowCol >>> 6;
final byte oldBits = sketch.slidingWindow[row];
final byte newBits = (byte) (oldBits | (1 << (col - sketch.windowOffset)));
if (newBits != oldBits) {
sketch.slidingWindow[row] = newBits;
isNovel = true;
}
}
else { // track the surprising 1's "after" the window
assert col >= (sketch.windowOffset + 8);
isNovel = PairTable.maybeInsert(sketch.pairTable, rowCol); // normal logic
}
if (isNovel) {
sketch.numCoupons += 1;
updateHIP(sketch, rowCol);
final long c8post = sketch.numCoupons << 3;
if (c8post >= ((27L + w8pre) * k)) {
modifyOffset(sketch, sketch.windowOffset + 1);
assert (sketch.windowOffset >= 1) && (sketch.windowOffset <= 56);
final int w8post = sketch.windowOffset << 3;
assert c8post < ((27L + w8post) * k); // C < (K * 27/8) + (K * windowOffset)
}
}
}
//also used in test
static CpcSketch uncompress(final CompressedState source, final long seed) {
checkSeedHashes(computeSeedHash(seed), source.seedHash);
final CpcSketch sketch = new CpcSketch(source.lgK, seed);
sketch.numCoupons = source.numCoupons;
sketch.windowOffset = source.getWindowOffset();
sketch.fiCol = source.fiCol;
sketch.mergeFlag = source.mergeFlag;
sketch.kxp = source.kxp;
sketch.hipEstAccum = source.hipEstAccum;
sketch.slidingWindow = null;
sketch.pairTable = null;
CpcCompression.uncompress(source, sketch);
return sketch;
}
//Used here and for testing
void hashUpdate(final long hash0, final long hash1) {
int col = Long.numberOfLeadingZeros(hash1);
if (col < fiCol) { return; } // important speed optimization
if (col > 63) { col = 63; } // clip so that 0 <= col <= 63
final long c = numCoupons;
if (c == 0) { promoteEmptyToSparse(this); }
final long k = 1L << lgK;
final int row = (int) (hash0 & (k - 1L));
int rowCol = (row << 6) | col;
// Avoid the hash table's "empty" value which is (2^26 -1, 63) (all ones) by changing it
// to the pair (2^26 - 2, 63), which effectively merges the two cells.
// This case is *extremely* unlikely, but we might as well handle it.
// It can't happen at all if lgK (or maxLgK) < 26.
if (rowCol == -1) { rowCol ^= (1 << 6); } //set the LSB of row to 0
if ((c << 5) < (3L * k)) { updateSparse(this, rowCol); }
else { updateWindowed(this, rowCol); }
}
//Used by union and in testing
void rowColUpdate(final int rowCol) {
final int col = rowCol & 63;
if (col < fiCol) { return; } // important speed optimization
final long c = numCoupons;
if (c == 0) { promoteEmptyToSparse(this); }
final long k = 1L << lgK;
if ((c << 5) < (3L * k)) { updateSparse(this, rowCol); }
else { updateWindowed(this, rowCol); }
}
/**
* Return a human-readable string summary of this sketch
*/
@Override
public String toString() {
return toString(false);
}
/**
* Return a human-readable string summary of this sketch
* @param detail include data detail
* @return a human-readable string summary of this sketch
*/
public String toString(final boolean detail) {
final int numPairs = (pairTable == null) ? 0 : pairTable.getNumPairs();
final StringBuilder sb = new StringBuilder();
sb.append("CpcSketch").append(LS);
sb.append(" Flavor : ").append(getFlavor()).append(LS);
sb.append(" lgK : ").append(lgK).append(LS);
sb.append(" seed : ").append(seed).append(LS);
sb.append(" numCoupons : ").append(numCoupons).append(LS);
sb.append(" numPairs (SV): ").append(numPairs).append(LS);
sb.append(" mergeFlag : ").append(mergeFlag).append(LS);
sb.append(" fiCol : ").append(fiCol).append(LS);
sb.append(" Window? : ").append(slidingWindow != null).append(LS);
sb.append(" winOffset : ").append(windowOffset).append(LS);
sb.append(" kxp : ").append(kxp).append(LS);
sb.append(" hipAccum : ").append(hipEstAccum).append(LS);
if (detail) {
if (pairTable != null) {
sb.append(pairTable.toString(true));
}
if (slidingWindow != null) {
sb.append(" SlidingWindow : ").append(LS);
for (int i = 0; i < slidingWindow.length; i++) {
sb.append(String.format("%8d %6d" + LS, i, slidingWindow[i]));
}
}
}
return sb.toString();
}
private static void fillKxpByteLookup() { //called from static initializer
for (int b = 0; b < 256; b++) {
double sum = 0;
for (int col = 0; col < 8; col++) {
final int bit = (b >>> col) & 1;
if (bit == 0) { // note the inverted logic
sum += invPow2(col + 1); //note the "+1"
}
}
kxpByteLookup[b] = sum;
}
}
static {
fillKxpByteLookup();
}
}
| Update javadoc | src/main/java/com/yahoo/sketches/cpc/CpcSketch.java | Update javadoc | <ide><path>rc/main/java/com/yahoo/sketches/cpc/CpcSketch.java
<ide> /*
<ide> * These empirical values for the 99.9th percentile of size in bytes were measured using 100,000
<ide> * trials. The value for each trial is the maximum of 5*16=80 measurements that were equally
<del> * spaced over values of the quantity C/K between 3.0 and 8.0.
<add> * spaced over values of the quantity C/K between 3.0 and 8.0. This table does not include the
<add> * worst-case space for the preamble, which is added by the function.
<ide> */
<ide> private static final int[] empiricalMaxBytes = {
<ide> 24, // lgK = 4 |
|
JavaScript | bsd-3-clause | cae5ef85177d2466b0e9080817c387c147d8c6f2 | 0 | maier49/dstore,kfranqueiro/dstore,kfranqueiro/dstore,maier49/dstore,kfranqueiro/dstore,maier49/dstore,kfranqueiro/dstore,maier49/dstore | // Learn more about configuring this file at <https://github.com/theintern/intern/wiki/Configuring-Intern>.
// These default settings work OK for most people. The options that *must* be changed below are the
// packages, suites, excludeInstrumentation, and (if you want functional tests) functionalSuites.
define({
// The port on which the instrumenting proxy will listen
proxyPort: 9000,
// A fully qualified URL to the Intern proxy
proxyUrl: 'http://localhost:9000/',
// Default desired capabilities for all environments. Individual capabilities can be overridden by any of the
// specified browser environments in the `environments` array below as well. See
// https://code.google.com/p/selenium/wiki/DesiredCapabilities for standard Selenium capabilities and
// https://saucelabs.com/docs/additional-config#desired-capabilities for Sauce Labs capabilities.
// Note that the `build` capability will be filled in with the current commit ID from the Travis CI environment
// automatically
capabilities: {
'selenium-version': '2.33.0'
},
// Browsers to run integration testing against. Note that version numbers must be strings if used with Sauce
// OnDemand. Options that will be permutated are browserName, version, platform, and platformVersion; any other
// capabilities options specified for an environment will be copied as-is
environments: [
{ browserName: 'internet explorer', version: '10', platform: 'Windows 8' },
{ browserName: 'internet explorer', version: '9', platform: 'Windows 7' },
{ browserName: 'firefox', version: '22', platform: [ 'Linux', 'Windows 7' ] },
{ browserName: 'firefox', version: '21', platform: 'Mac 10.6' },
{ browserName: 'chrome', platform: [ 'Linux', 'Mac 10.8', 'Windows 7' ] },
{ browserName: 'safari', version: '6', platform: 'Mac 10.8' }
],
// Maximum number of simultaneous integration tests that should be executed on the remote WebDriver service
maxConcurrency: 3,
// Whether or not to start Sauce Connect before running tests
useSauceConnect: true,
// Connection information for the remote WebDriver service. If using Sauce Labs, keep your username and password
// in the SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables unless you are sure you will NEVER be
// publishing this configuration file somewhere
webdriver: {
host: 'localhost',
port: 4444
},
// Configuration options for the module loader; any AMD configuration options supported by the Dojo loader can be
// used here
loader: {
baseUrl: typeof process === 'undefined' ?
// if we are using the full path to dstore, we assume we are running
// in a sibling path configuration
location.search.indexOf('config=dstore') > -1 ? '../..' : '..' :
'./node_modules',
// Packages that should be registered with the loader in each testing environment
requestProvider: 'dojo/request/registry',
packages: [
{ name: 'dojo', location: 'dojo' },
{ name: 'dstore', location: location.search.indexOf('config=dstore') > -1 ? 'dstore' : '..' },
{ name: 'rql', location: 'rql' },
{ name: 'json-schema', location: 'json-schema' }
]
},
// Non-functional test suite(s) to run in each browser
suites: [ 'dstore/tests/all' ],
// Functional test suite(s) to run in each browser once non-functional tests are completed
functionalSuites: [],
// A regular expression matching URLs to files that should not be included in code coverage analysis
excludeInstrumentation: /^dojox?|^tests?\//
});
| tests/intern.js | // Learn more about configuring this file at <https://github.com/theintern/intern/wiki/Configuring-Intern>.
// These default settings work OK for most people. The options that *must* be changed below are the
// packages, suites, excludeInstrumentation, and (if you want functional tests) functionalSuites.
define({
// The port on which the instrumenting proxy will listen
proxyPort: 9000,
// A fully qualified URL to the Intern proxy
proxyUrl: 'http://localhost:9000/',
// Default desired capabilities for all environments. Individual capabilities can be overridden by any of the
// specified browser environments in the `environments` array below as well. See
// https://code.google.com/p/selenium/wiki/DesiredCapabilities for standard Selenium capabilities and
// https://saucelabs.com/docs/additional-config#desired-capabilities for Sauce Labs capabilities.
// Note that the `build` capability will be filled in with the current commit ID from the Travis CI environment
// automatically
capabilities: {
'selenium-version': '2.33.0'
},
// Browsers to run integration testing against. Note that version numbers must be strings if used with Sauce
// OnDemand. Options that will be permutated are browserName, version, platform, and platformVersion; any other
// capabilities options specified for an environment will be copied as-is
environments: [
{ browserName: 'internet explorer', version: '10', platform: 'Windows 8' },
{ browserName: 'internet explorer', version: '9', platform: 'Windows 7' },
{ browserName: 'firefox', version: '22', platform: [ 'Linux', 'Windows 7' ] },
{ browserName: 'firefox', version: '21', platform: 'Mac 10.6' },
{ browserName: 'chrome', platform: [ 'Linux', 'Mac 10.8', 'Windows 7' ] },
{ browserName: 'safari', version: '6', platform: 'Mac 10.8' }
],
// Maximum number of simultaneous integration tests that should be executed on the remote WebDriver service
maxConcurrency: 3,
// Whether or not to start Sauce Connect before running tests
useSauceConnect: true,
// Connection information for the remote WebDriver service. If using Sauce Labs, keep your username and password
// in the SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables unless you are sure you will NEVER be
// publishing this configuration file somewhere
webdriver: {
host: 'localhost',
port: 4444
},
// Configuration options for the module loader; any AMD configuration options supported by the Dojo loader can be
// used here
loader: {
baseUrl: typeof process === 'undefined' ? '..' : './node_modules',
// Packages that should be registered with the loader in each testing environment
requestProvider: 'dojo/request/registry',
packages: [
{ name: 'dojo', location: 'dojo' },
{ name: 'dstore', location: '..' },
{ name: 'rql', location: 'rql' },
{ name: 'json-schema', location: 'json-schema' }
]
},
// Non-functional test suite(s) to run in each browser
suites: [ 'dstore/tests/all' ],
// Functional test suite(s) to run in each browser once non-functional tests are completed
functionalSuites: [],
// A regular expression matching URLs to files that should not be included in code coverage analysis
excludeInstrumentation: /^dojox?|^tests?\//
});
| Make intern configuration adapt to sibling or child configuration of
node_modules folder
| tests/intern.js | Make intern configuration adapt to sibling or child configuration of node_modules folder | <ide><path>ests/intern.js
<ide> // Learn more about configuring this file at <https://github.com/theintern/intern/wiki/Configuring-Intern>.
<ide> // These default settings work OK for most people. The options that *must* be changed below are the
<ide> // packages, suites, excludeInstrumentation, and (if you want functional tests) functionalSuites.
<add>
<ide> define({
<ide> // The port on which the instrumenting proxy will listen
<ide> proxyPort: 9000,
<ide> // Configuration options for the module loader; any AMD configuration options supported by the Dojo loader can be
<ide> // used here
<ide> loader: {
<del> baseUrl: typeof process === 'undefined' ? '..' : './node_modules',
<add> baseUrl: typeof process === 'undefined' ?
<add> // if we are using the full path to dstore, we assume we are running
<add> // in a sibling path configuration
<add> location.search.indexOf('config=dstore') > -1 ? '../..' : '..' :
<add> './node_modules',
<ide>
<ide> // Packages that should be registered with the loader in each testing environment
<ide> requestProvider: 'dojo/request/registry',
<ide> packages: [
<ide> { name: 'dojo', location: 'dojo' },
<del> { name: 'dstore', location: '..' },
<add> { name: 'dstore', location: location.search.indexOf('config=dstore') > -1 ? 'dstore' : '..' },
<ide> { name: 'rql', location: 'rql' },
<ide> { name: 'json-schema', location: 'json-schema' }
<ide> ] |
|
Java | agpl-3.0 | 32db225d5d75c5990a2126c4658408d443d8b0a7 | 0 | ghjansen/cas,ghjansen/cas | /*
* CAS - Cellular Automata Simulator
* Copyright (C) 2016 Guilherme Humberto Jansen
*
* 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.ghjansen.cas.ui.desktop.manager;
import java.awt.Color;
import java.awt.Font;
import java.awt.SystemColor;
import java.awt.image.BufferedImage;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.imageio.ImageIO;
import javax.swing.ButtonModel;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JCheckBox;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import javax.swing.border.TitledBorder;
import javax.swing.filechooser.FileNameExtensionFilter;
import com.ghjansen.cas.control.exception.InvalidSimulationParameterException;
import com.ghjansen.cas.control.exception.SimulationBuilderException;
import com.ghjansen.cas.ui.desktop.i18n.Language;
import com.ghjansen.cas.ui.desktop.i18n.Translator;
import com.ghjansen.cas.ui.desktop.swing.ActivityState;
import com.ghjansen.cas.ui.desktop.swing.GUIValidator;
import com.ghjansen.cas.ui.desktop.swing.IconListRenderer;
import com.ghjansen.cas.ui.desktop.swing.Main;
import com.ghjansen.cas.ui.desktop.swing.SimulationExportUtil;
import com.ghjansen.cas.ui.desktop.swing.SimulationParameterJsonAdapter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalInitialConditionParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalLimitsParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalRuleConfigurationParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalRuleTypeParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSequenceParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSimulationBuilder;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSimulationController;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSimulationParameter;
import com.ghjansen.cas.unidimensional.physics.UnidimensionalUniverse;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
/**
* @author Guilherme Humberto Jansen ([email protected])
*/
public class EventManager {
private Main main;
private boolean skipRuleNumberEvent;
private Color invalidFieldColor;
public GUIValidator validator;
public Gson gson;
public UnidimensionalSimulationParameter simulationParameter;
public UnidimensionalSimulationController simulationController;
public ActivityState activityState;
private ActivityState previousActivityState;
private Notification notification;
public boolean omitDiscardConfirmation = false;
public EventManager(Main main) {
this.main = main;
this.skipRuleNumberEvent = false;
this.invalidFieldColor = Color.red;
this.validator = new GUIValidator(main, invalidFieldColor);
GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.registerTypeAdapter(UnidimensionalSimulationParameter.class, new SimulationParameterJsonAdapter<UnidimensionalSimulationParameter>());
gsonBuilder.setPrettyPrinting();
this.gson = gsonBuilder.create();
this.notification = new Notification(this);
this.previousActivityState = null;
}
public void createSimulationParameter() throws InvalidSimulationParameterException, SimulationBuilderException{
int[] s = main.transitionsView.getStates();
int iterations = Integer.valueOf(main.txtIterations.getText());
int cells = Integer.valueOf(main.txtCells.getText());
UnidimensionalRuleTypeParameter ruleType = new UnidimensionalRuleTypeParameter(true);
UnidimensionalRuleConfigurationParameter ruleConfiguration = new UnidimensionalRuleConfigurationParameter(s[7],s[6],s[5],s[4],s[3],s[2],s[1],s[0]);
UnidimensionalLimitsParameter limits = new UnidimensionalLimitsParameter(cells, iterations);
// UnidimensionalSequenceParameter sequence1 = new UnidimensionalSequenceParameter(1, cells/2, 0);
// UnidimensionalSequenceParameter sequence2 = new UnidimensionalSequenceParameter((cells/2)+1, (cells/2)+1, 1);
// UnidimensionalSequenceParameter sequence3 = new UnidimensionalSequenceParameter((cells/2)+2, cells, 0);
UnidimensionalInitialConditionParameter initialCondition = new UnidimensionalInitialConditionParameter(getSequences(cells));
this.simulationParameter = new UnidimensionalSimulationParameter(ruleType, ruleConfiguration, limits, initialCondition);
}
private UnidimensionalSequenceParameter[] getSequences(int totalCells){
if(totalCells == 1){
if(main.rdbtnRandom.isSelected()){
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, getRandomBoolean()? 1 : 0)};
} else {
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, 1)};
}
} else if (totalCells == 2){
if(main.rdbtnRandom.isSelected()){
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, getRandomBoolean()? 1 : 0), new UnidimensionalSequenceParameter(2, 2, getRandomBoolean()? 1 : 0)};
} else {
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, 1), new UnidimensionalSequenceParameter(2, 2, 0)};
}
} else if (totalCells >= 3){
if(main.rdbtnRandom.isSelected()){
UnidimensionalSequenceParameter[] sequence = new UnidimensionalSequenceParameter[totalCells];
sequence[0] = new UnidimensionalSequenceParameter(1, 1, getRandomBoolean()? 1 : 0);
for(int i = 2; i <= totalCells; i++){
sequence[i-1] = new UnidimensionalSequenceParameter(i, i, getRandomBoolean()? 1 : 0);
}
return sequence;
} else {
int centralCell = getCentralCell(totalCells);
UnidimensionalSequenceParameter sequence1 = new UnidimensionalSequenceParameter(1, centralCell-1, 0);
UnidimensionalSequenceParameter sequence2 = new UnidimensionalSequenceParameter(centralCell, centralCell, 1);
UnidimensionalSequenceParameter sequence3 = new UnidimensionalSequenceParameter(centralCell+1, totalCells, 0);
return new UnidimensionalSequenceParameter[]{sequence1, sequence2, sequence3};
}
}
return null;
}
public static boolean getRandomBoolean() {
return Math.random() < 0.5;
}
private int getCentralCell(int totalCells){
if(totalCells > 1){
return (int) Math.ceil((double) totalCells / 2);
} else return 1;
}
private void createSimulationController() throws SimulationBuilderException{
UnidimensionalSimulationBuilder simulationBuilder = new UnidimensionalSimulationBuilder(this.simulationParameter);
simulationController = new UnidimensionalSimulationController(simulationBuilder, notification);
main.simulationView.setUniverse((UnidimensionalUniverse) simulationController.getSimulation().getUniverse());
main.simulationView.reset();
main.progressBar.setMaximum(simulationParameter.getLimitsParameter().getIterations());
main.progressBar.setValue(0);
main.simulationView.setProgressBar(main.progressBar);
main.simulationView.setValidator(validator);
}
public void executeComplete(){
try {
setActivityState(ActivityState.EXECUTING_RULE);
this.validator.setNormalStatus("msgSimulationInProgress");
if(this.simulationParameter == null){
createSimulationParameter();
}
if(this.simulationController == null){
createSimulationController();
}
simulationController.startCompleteTask();
} catch (Throwable e) {
validator.setErrorStatus("errSimulationExecution", e.toString());
e.printStackTrace();
}
}
public void executeIterationEvent(){
try {
setActivityState(ActivityState.EXECUTING_RULE);
this.validator.setNormalStatus("msgSimulationInProgress");
if(this.simulationParameter == null){
createSimulationParameter();
}
if(this.simulationController == null){
createSimulationController();
}
simulationController.startIterationTask();
} catch (Throwable e) {
validator.setErrorStatus("errSimulationExecution", e.toString());
}
}
public void elementaryRuleTypeEvent(){
}
public void totalisticRuleTypeEvent(){
}
public void transitionsEvent(){
int[] states = main.transitionsView.getStates();
int result = 0;
for(int i = 0; i < states.length; i++){
result = (int) (result + (states[i] == 1 ? Math.pow(2, i) : 0));
}
this.skipRuleNumberEvent = true;
main.txtRuleNumber.setText(String.valueOf(result));
main.txtRuleNumber.setBackground(SystemColor.text);
validator.updateStatus();
this.skipRuleNumberEvent = false;
}
public void ruleNumberEvent(){
if(validator.isRuleNumberValid()){
int value = Integer.valueOf(main.txtRuleNumber.getText());
main.txtRuleNumber.setBackground(SystemColor.text);
char[] binary = Integer.toBinaryString(value).toCharArray();
int[] states = new int[8];
for(int i = 0; i < states.length; i++){
if(i < binary.length){
states[i] = Integer.parseInt(String.valueOf(binary[binary.length - 1 - i]));
} else {
states[i] = 0;
}
}
main.transitionsView.setStates(states);
}
}
public void cellsEvent(){
validator.isCellsValid();
}
public void iterationsEvent(){
validator.isIterationsValid();
}
public void uniqueCellEvent(){
/*
if(main.scrollPane != null){
main.scrollPane.setEnabled(false);
main.table.setEnabled(false);
main.btnAdd.setEnabled(false);
main.btnRemove.setEnabled(false);
main.btnClean.setEnabled(false);
}
*/
}
public void RandomEvent(){
/*
if(main.scrollPane != null){
main.scrollPane.setEnabled(false);
main.table.setEnabled(false);
main.btnAdd.setEnabled(false);
main.btnRemove.setEnabled(false);
main.btnClean.setEnabled(false);
}
*/
}
public void informPatternCellEvent(){
main.scrollPane.setEnabled(true);
main.table.setEnabled(true);
main.btnAdd.setEnabled(true);
main.btnRemove.setEnabled(true);
main.btnClean.setEnabled(true);
}
public boolean isSkipRuleNumberEvent(){
return this.skipRuleNumberEvent;
}
public void discardEvent(){
int result;
if(!omitDiscardConfirmation){
JCheckBox checkbox = new JCheckBox(Translator.getInstance().get("msgCheckDiscard"));
String message = Translator.getInstance().get("msgConfirmDialog");
Object[] params = {message, checkbox};
result = JOptionPane.showConfirmDialog(main.frame, params, null, JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE);
if(checkbox.isSelected()){
omitDiscardConfirmation = true;
}
} else {
result = JOptionPane.YES_OPTION;
}
if(result == JOptionPane.YES_OPTION){
simulationController.getSimulation().setActive(false);
main.simulationView.setUniverse(null);
simulationController = null;
simulationParameter = null;
main.txtRuleNumber.setText("0");
main.txtCells.setText("1");
main.txtIterations.setText("1");
main.transitionsView.hideHighlight();
main.progressBar.setValue(0);
validator.updateStatus();
setActivityState(ActivityState.CONFIGURING_RULE);
}
}
private void resetSimulation(){
simulationController.getSimulation().setActive(false);
main.simulationView.setUniverse(null);
simulationController = null;
simulationParameter = null;
main.txtRuleNumber.setText("0");
main.txtCells.setText("1");
main.txtIterations.setText("1");
main.transitionsView.hideHighlight();
main.progressBar.setValue(0);
}
public void saveEvent(){
ActivityState previous = activityState;
setActivityState(ActivityState.SAVING_FILE);
JFileChooser fc = new JFileChooser();
fc.setFileSelectionMode(JFileChooser.FILES_ONLY);
fc.setSelectedFile(fc.getCurrentDirectory() );
fc.setDialogTitle(Translator.getInstance().get("msgSaveDialogTitle"));
fc.setMultiSelectionEnabled(false);
fc.setFileFilter(new FileNameExtensionFilter(Translator.getInstance().get("casFileExtension"), "cas"));
int result = fc.showSaveDialog(main.frame);
if(result == JFileChooser.APPROVE_OPTION){
if(this.simulationParameter == null){
try {
createSimulationParameter();
} catch (InvalidSimulationParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SimulationBuilderException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
String fileName = String.valueOf(fc.getSelectedFile());
if(!fileName.endsWith(".cas")){
fileName = fileName + ".cas";
}
String content = gson.toJson(simulationParameter);
FileWriter fw;
try {
fw = new FileWriter(fileName);
fw.write(content);
fw.close();
validator.setNormalStatus("msgSaveSuccess");
setActivityState(previous);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
public void openEvent(){
ButtonModel selected = main.grpInitialCondition.getSelection();
setActivityState(ActivityState.OPENING_FILE);
JFileChooser fc = new JFileChooser();
fc.setFileSelectionMode(JFileChooser.FILES_ONLY);
fc.setSelectedFile(fc.getCurrentDirectory() );
fc.setDialogTitle(Translator.getInstance().get("msgOpenDialogTitle"));
fc.setMultiSelectionEnabled(false);
fc.setFileFilter(new FileNameExtensionFilter(Translator.getInstance().get("casFileExtension"), "cas"));
int result = fc.showOpenDialog(main.frame);
if(result == JFileChooser.APPROVE_OPTION){
BufferedReader br = null;
StringBuilder content = new StringBuilder();
String line = null;
try {
br = new BufferedReader(new FileReader(fc.getSelectedFile()));
while((line = br.readLine()) != null){
content.append(line);
}
if(content.length() > 0){
this.simulationParameter = gson.fromJson(content.toString(), UnidimensionalSimulationParameter.class);
updateVisualParameters();
validator.updateStatus();
if(!validator.isActivityLocked()){
simulationController = null;
main.transitionsView.hideHighlight();
main.progressBar.setValue(0);
executeComplete();
}
} else {
validator.setErrorStatus("errOpenFileInvalid", "");
}
} catch (Exception e) {
e.printStackTrace();
validator.setErrorStatus("errOpenFileGeneric", e.toString());
}
} else {
revertActivityState();
main.grpInitialCondition.setSelected(selected, true);
}
}
private void updateVisualParameters(){
int[] statesParameter = this.simulationParameter.getRuleConfigurationParameter().getStateValues();
int[] statesVisual = new int[statesParameter.length];
for(int i = 0; i < statesParameter.length; i++){
statesVisual[statesVisual.length-1-i] = statesParameter[i];
}
main.transitionsView.setStates(statesVisual);
transitionsEvent();
main.txtCells.setText(String.valueOf(this.simulationParameter.getLimitsParameter().getCells()));
main.txtIterations.setText(String.valueOf(this.simulationParameter.getLimitsParameter().getIterations()));
main.rdbtnUniqueCell.setSelected(false);
main.rdbtnRandom.setSelected(false);
}
public void exportEvent(){
if(main.keyMonitor.isCtrlPressed()){
main.aeo.setVisible(true);
} else {
exportSimulation(1, false, 0, null);
}
}
public void exportSimulation(int cellScale, boolean showGrid, int gridLineThickness, Color gridLineColour){
ActivityState previous = activityState;
setActivityState(ActivityState.EXPORTING_FILE);
JFileChooser fc = new JFileChooser();
fc.setFileSelectionMode(JFileChooser.FILES_ONLY);
fc.setSelectedFile(fc.getCurrentDirectory() );
fc.setDialogTitle(Translator.getInstance().get("msgExportDialogTitle"));
fc.setMultiSelectionEnabled(false);
fc.setFileFilter(new FileNameExtensionFilter(Translator.getInstance().get("pngFileExtension"), "png"));
int result = fc.showSaveDialog(main.frame);
if(result == JFileChooser.APPROVE_OPTION){
String fileName = String.valueOf(fc.getSelectedFile());
if(!fileName.endsWith(".png")){
fileName = fileName + ".png";
}
BufferedImage buffer = SimulationExportUtil.createBufferedImage(simulationController, cellScale, showGrid, gridLineThickness, gridLineColour);
File f = new File(fileName);
try {
ImageIO.write(buffer, "PNG", f);
validator.setNormalStatus("msgExportSuccess");
setActivityState(previous);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
public void languageEvent(){
if(main.langCombo.getSelectedIndex() == 0){
Translator.getInstance().setLanguage(Language.PORTUGUESE_BRAZIL);
} else if (main.langCombo.getSelectedIndex() == 1){
Translator.getInstance().setLanguage(Language.ENGLISH_UNITED_KINGDOM);
}
updateComponentsLanguage();
}
private void updateComponentsLanguage(){
main.pnlRuleType.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlRuleType"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.rdbtnElementary.setText(Translator.getInstance().get("rdbtnElementary"));
main.rdbtnTotalistic.setText(Translator.getInstance().get("rdbtnTotalistic"));
main.pnlRuleConfig.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlRuleConfig"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.lblRuleNumber.setText(Translator.getInstance().get("lblRuleNumber"));
main.pnlLimits.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlLimits"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.lblCells.setText(Translator.getInstance().get("lblCells"));
main.lblIterations.setText(Translator.getInstance().get("lblIterations"));
main.pnlInitialCondition.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlInitialCondition"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.rdbtnUniqueCell.setText(Translator.getInstance().get("rdbtnUniqueCell"));
main.rdbtnRandom.setText(Translator.getInstance().get("rdbtnRandom"));
main.pnlControl.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlControl"), TitledBorder.LEADING, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.btnOpen.setText(Translator.getInstance().get("btnOpen"));
main.btnSave.setText(Translator.getInstance().get("btnSave"));
main.btnExport.setText(Translator.getInstance().get("btnExport"));
main.lblStatus.setText(Translator.getInstance().get(main.getLastStatusKey()));
main.pnlView.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlView"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.langCombo.removeAllItems();
Map<Object, Icon> icons = new HashMap<Object, Icon>();
icons.put(Translator.getInstance().get("langCombo0"), new ImageIcon(Main.class.getResource("br.png")));
icons.put(Translator.getInstance().get("langCombo1"), new ImageIcon(Main.class.getResource("en.png")));
Iterator it = icons.keySet().iterator();
main.langCombo.addItem(Translator.getInstance().get("langCombo0"));
main.langCombo.addItem(Translator.getInstance().get("langCombo1"));
main.langCombo.setRenderer(new IconListRenderer(icons));
main.langCombo.setSelectedIndex(Translator.getInstance().getLanguage().getId());
}
public void setActivityState(ActivityState state){
switch(state){
case CONFIGURING_RULE:
main.transitionsView.setMouseEnabled(true);
main.txtRuleNumber.setEnabled(true);
main.txtCells.setEnabled(true);
main.txtIterations.setEnabled(true);
main.btnDiscard.setEnabled(false);
main.btnSimulateComplete.setEnabled(true);
main.btnSimulateIteration.setEnabled(true);
main.btnOpen.setEnabled(true);
main.btnSave.setEnabled(true);
main.btnExport.setEnabled(false);
main.progressBar.setStringPainted(false);
main.langCombo.setEnabled(true);
main.rdbtnUniqueCell.setEnabled(true);
main.rdbtnUniqueCell.setSelected(true);
main.rdbtnRandom.setEnabled(true);
changeActivityState(state);
break;
case EXECUTING_RULE:
main.transitionsView.setMouseEnabled(false);
main.txtRuleNumber.setEnabled(false);
main.txtCells.setEnabled(false);
main.txtIterations.setEnabled(false);
main.btnDiscard.setEnabled(true);
main.btnSimulateComplete.setEnabled(true);
main.btnSimulateIteration.setEnabled(true);
main.btnOpen.setEnabled(false);
main.btnSave.setEnabled(true);
main.btnExport.setEnabled(false);
main.progressBar.setStringPainted(true);
main.langCombo.setEnabled(false);
main.rdbtnUniqueCell.setEnabled(false);
main.rdbtnRandom.setEnabled(false);
changeActivityState(state);
break;
case ANALYSING:
main.transitionsView.setMouseEnabled(false);
main.txtRuleNumber.setEnabled(false);
main.txtCells.setEnabled(false);
main.txtIterations.setEnabled(false);
main.btnDiscard.setEnabled(true);
main.btnSimulateComplete.setEnabled(false);
main.btnSimulateIteration.setEnabled(false);
main.btnOpen.setEnabled(true);
main.btnSave.setEnabled(true);
main.btnExport.setEnabled(true);
main.progressBar.setStringPainted(true);
main.langCombo.setEnabled(false);
main.rdbtnUniqueCell.setEnabled(false);
main.rdbtnRandom.setEnabled(false);
changeActivityState(state);
break;
case EXPORTING_FILE:
changeActivityState(state);
break;
case OPENING_FILE:
main.grpInitialCondition.clearSelection();
changeActivityState(state);
break;
case SAVING_FILE:
changeActivityState(state);
break;
default:
break;
}
}
private void changeActivityState(ActivityState newState){
this.previousActivityState = this.activityState;
this.activityState = newState;
}
private void revertActivityState(){
if(this.previousActivityState != null){
this.activityState = null;
setActivityState(this.previousActivityState);
}
}
public void aEOCellScaleEvent(){
if(validator.isAEOCellScaleValid()){
if(Integer.valueOf(main.aeo.txtAEOCellScale.getText()) >= 3) {
if(!main.aeo.rdbtnAEOYes.isEnabled()){
main.aeo.rdbtnAEONo.setEnabled(true);
main.aeo.rdbtnAEOYes.setEnabled(true);
}
if(!main.aeo.rdbtnAEOYes.isSelected()){
main.aeo.rdbtnAEONo.setSelected(true);
} else {
aEOGridYesEvent();
}
} else {
main.aeo.rdbtnAEONo.setEnabled(false);
main.aeo.rdbtnAEOYes.setEnabled(false);
}
}
}
public void aEOGridYesEvent(){
main.aeo.txtAEOGridLinesThickness.setEnabled(true);
main.aeo.txtAEOCellLinesColour.setEnabled(true);
validator.isAEOCellLinesThicknessValid();
validator.isAEOCellColourValid();
}
public void aEOGridNoEvent(){
main.aeo.txtAEOGridLinesThickness.setEnabled(false);
main.aeo.txtAEOGridLinesThickness.setBackground(SystemColor.text);
main.aeo.txtAEOCellLinesColour.setEnabled(false);
main.aeo.txtAEOCellLinesColour.setBackground(SystemColor.text);
aEOCellScaleEvent();
}
public void aEOGridThicknessEvent(){
validator.isAEOCellLinesThicknessValid();
}
public void aEOGridColourEvent(){
validator.isAEOCellColourValid();
}
public void aEOExportEvent(){
if(!validator.isAEOActivityLocked()){
main.aeo.setVisible(false);
main.aeo.txtAEOCellScale.requestFocus();
int scale = Integer.valueOf(main.aeo.txtAEOCellScale.getText());
boolean showGrid = main.aeo.rdbtnAEOYes.isSelected() ? true : false;
int thickness = Integer.valueOf(main.aeo.txtAEOGridLinesThickness.getText());
String hex = main.aeo.txtAEOCellLinesColour.getText().replaceAll("#", "");
int r = Integer.valueOf(hex.substring(0, 2));
int g = Integer.valueOf(hex.substring(2, 4));
int b = Integer.valueOf(hex.substring(4, 6));
int rgb = r;
rgb = (rgb << 8) + g;
rgb = (rgb << 8) + b;
Color gridColour = new Color(rgb);
exportSimulation(scale, showGrid, thickness, gridColour);
}
}
}
| cas-ui-desktop/src/main/java/com/ghjansen/cas/ui/desktop/manager/EventManager.java | /*
* CAS - Cellular Automata Simulator
* Copyright (C) 2016 Guilherme Humberto Jansen
*
* 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.ghjansen.cas.ui.desktop.manager;
import java.awt.Color;
import java.awt.Font;
import java.awt.SystemColor;
import java.awt.image.BufferedImage;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.imageio.ImageIO;
import javax.swing.ButtonModel;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JCheckBox;
import javax.swing.JFileChooser;
import javax.swing.JOptionPane;
import javax.swing.border.TitledBorder;
import javax.swing.filechooser.FileNameExtensionFilter;
import com.ghjansen.cas.control.exception.InvalidSimulationParameterException;
import com.ghjansen.cas.control.exception.SimulationBuilderException;
import com.ghjansen.cas.ui.desktop.i18n.Language;
import com.ghjansen.cas.ui.desktop.i18n.Translator;
import com.ghjansen.cas.ui.desktop.swing.ActivityState;
import com.ghjansen.cas.ui.desktop.swing.GUIValidator;
import com.ghjansen.cas.ui.desktop.swing.IconListRenderer;
import com.ghjansen.cas.ui.desktop.swing.Main;
import com.ghjansen.cas.ui.desktop.swing.SimulationExportUtil;
import com.ghjansen.cas.ui.desktop.swing.SimulationParameterJsonAdapter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalInitialConditionParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalLimitsParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalRuleConfigurationParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalRuleTypeParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSequenceParameter;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSimulationBuilder;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSimulationController;
import com.ghjansen.cas.unidimensional.control.UnidimensionalSimulationParameter;
import com.ghjansen.cas.unidimensional.physics.UnidimensionalUniverse;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
/**
* @author Guilherme Humberto Jansen ([email protected])
*/
public class EventManager {
private Main main;
private boolean skipRuleNumberEvent;
private Color invalidFieldColor;
public GUIValidator validator;
public Gson gson;
public UnidimensionalSimulationParameter simulationParameter;
public UnidimensionalSimulationController simulationController;
public ActivityState activityState;
private ActivityState previousActivityState;
private Notification notification;
public boolean omitDiscardConfirmation = false;
public EventManager(Main main) {
this.main = main;
this.skipRuleNumberEvent = false;
this.invalidFieldColor = Color.red;
this.validator = new GUIValidator(main, invalidFieldColor);
GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.registerTypeAdapter(UnidimensionalSimulationParameter.class, new SimulationParameterJsonAdapter<UnidimensionalSimulationParameter>());
gsonBuilder.setPrettyPrinting();
this.gson = gsonBuilder.create();
this.notification = new Notification(this);
this.previousActivityState = null;
}
public void createSimulationParameter() throws InvalidSimulationParameterException, SimulationBuilderException{
int[] s = main.transitionsView.getStates();
int iterations = Integer.valueOf(main.txtIterations.getText());
int cells = Integer.valueOf(main.txtCells.getText());
UnidimensionalRuleTypeParameter ruleType = new UnidimensionalRuleTypeParameter(true);
UnidimensionalRuleConfigurationParameter ruleConfiguration = new UnidimensionalRuleConfigurationParameter(s[7],s[6],s[5],s[4],s[3],s[2],s[1],s[0]);
UnidimensionalLimitsParameter limits = new UnidimensionalLimitsParameter(cells, iterations);
// UnidimensionalSequenceParameter sequence1 = new UnidimensionalSequenceParameter(1, cells/2, 0);
// UnidimensionalSequenceParameter sequence2 = new UnidimensionalSequenceParameter((cells/2)+1, (cells/2)+1, 1);
// UnidimensionalSequenceParameter sequence3 = new UnidimensionalSequenceParameter((cells/2)+2, cells, 0);
UnidimensionalInitialConditionParameter initialCondition = new UnidimensionalInitialConditionParameter(getSequences(cells));
this.simulationParameter = new UnidimensionalSimulationParameter(ruleType, ruleConfiguration, limits, initialCondition);
}
private UnidimensionalSequenceParameter[] getSequences(int totalCells){
if(totalCells == 1){
if(main.rdbtnRandom.isSelected()){
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, getRandomBoolean()? 1 : 0)};
} else {
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, 1)};
}
} else if (totalCells == 2){
if(main.rdbtnRandom.isSelected()){
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, getRandomBoolean()? 1 : 0), new UnidimensionalSequenceParameter(2, 2, getRandomBoolean()? 1 : 0)};
} else {
return new UnidimensionalSequenceParameter[]{new UnidimensionalSequenceParameter(1, 1, 1), new UnidimensionalSequenceParameter(2, 2, 0)};
}
} else if (totalCells >= 3){
if(main.rdbtnRandom.isSelected()){
UnidimensionalSequenceParameter[] sequence = new UnidimensionalSequenceParameter[totalCells];
sequence[0] = new UnidimensionalSequenceParameter(1, 1, getRandomBoolean()? 1 : 0);
for(int i = 2; i <= totalCells; i++){
sequence[i-1] = new UnidimensionalSequenceParameter(i, i, getRandomBoolean()? 1 : 0);
}
return sequence;
} else {
int centralCell = getCentralCell(totalCells);
UnidimensionalSequenceParameter sequence1 = new UnidimensionalSequenceParameter(1, centralCell-1, 0);
UnidimensionalSequenceParameter sequence2 = new UnidimensionalSequenceParameter(centralCell, centralCell, 1);
UnidimensionalSequenceParameter sequence3 = new UnidimensionalSequenceParameter(centralCell+1, totalCells, 0);
return new UnidimensionalSequenceParameter[]{sequence1, sequence2, sequence3};
}
}
return null;
}
public static boolean getRandomBoolean() {
return Math.random() < 0.5;
}
private int getCentralCell(int totalCells){
if(totalCells > 1){
return (int) Math.ceil((double) totalCells / 2);
} else return 1;
}
private void createSimulationController() throws SimulationBuilderException{
UnidimensionalSimulationBuilder simulationBuilder = new UnidimensionalSimulationBuilder(this.simulationParameter);
simulationController = new UnidimensionalSimulationController(simulationBuilder, notification);
main.simulationView.setUniverse((UnidimensionalUniverse) simulationController.getSimulation().getUniverse());
main.simulationView.reset();
main.progressBar.setMaximum(simulationParameter.getLimitsParameter().getIterations());
main.progressBar.setValue(0);
main.simulationView.setProgressBar(main.progressBar);
main.simulationView.setValidator(validator);
}
public void executeComplete(){
try {
setActivityState(ActivityState.EXECUTING_RULE);
this.validator.setNormalStatus("msgSimulationInProgress");
if(this.simulationParameter == null){
createSimulationParameter();
}
if(this.simulationController == null){
createSimulationController();
}
simulationController.startCompleteTask();
} catch (Throwable e) {
validator.setErrorStatus("errSimulationExecution", e.toString());
e.printStackTrace();
}
}
public void executeIterationEvent(){
try {
setActivityState(ActivityState.EXECUTING_RULE);
this.validator.setNormalStatus("msgSimulationInProgress");
if(this.simulationParameter == null){
createSimulationParameter();
}
if(this.simulationController == null){
createSimulationController();
}
simulationController.startIterationTask();
} catch (Throwable e) {
validator.setErrorStatus("errSimulationExecution", e.toString());
}
}
public void elementaryRuleTypeEvent(){
}
public void totalisticRuleTypeEvent(){
}
public void transitionsEvent(){
int[] states = main.transitionsView.getStates();
int result = 0;
for(int i = 0; i < states.length; i++){
result = (int) (result + (states[i] == 1 ? Math.pow(2, i) : 0));
}
this.skipRuleNumberEvent = true;
main.txtRuleNumber.setText(String.valueOf(result));
main.txtRuleNumber.setBackground(SystemColor.text);
validator.updateStatus();
this.skipRuleNumberEvent = false;
}
public void ruleNumberEvent(){
if(validator.isRuleNumberValid()){
int value = Integer.valueOf(main.txtRuleNumber.getText());
main.txtRuleNumber.setBackground(SystemColor.text);
char[] binary = Integer.toBinaryString(value).toCharArray();
int[] states = new int[8];
for(int i = 0; i < states.length; i++){
if(i < binary.length){
states[i] = Integer.parseInt(String.valueOf(binary[binary.length - 1 - i]));
} else {
states[i] = 0;
}
}
main.transitionsView.setStates(states);
}
}
public void cellsEvent(){
validator.isCellsValid();
}
public void iterationsEvent(){
validator.isIterationsValid();
}
public void uniqueCellEvent(){
/*
if(main.scrollPane != null){
main.scrollPane.setEnabled(false);
main.table.setEnabled(false);
main.btnAdd.setEnabled(false);
main.btnRemove.setEnabled(false);
main.btnClean.setEnabled(false);
}
*/
}
public void RandomEvent(){
/*
if(main.scrollPane != null){
main.scrollPane.setEnabled(false);
main.table.setEnabled(false);
main.btnAdd.setEnabled(false);
main.btnRemove.setEnabled(false);
main.btnClean.setEnabled(false);
}
*/
}
public void informPatternCellEvent(){
main.scrollPane.setEnabled(true);
main.table.setEnabled(true);
main.btnAdd.setEnabled(true);
main.btnRemove.setEnabled(true);
main.btnClean.setEnabled(true);
}
public boolean isSkipRuleNumberEvent(){
return this.skipRuleNumberEvent;
}
public void discardEvent(){
int result;
if(!omitDiscardConfirmation){
JCheckBox checkbox = new JCheckBox(Translator.getInstance().get("msgCheckDiscard"));
String message = Translator.getInstance().get("msgConfirmDialog");
Object[] params = {message, checkbox};
result = JOptionPane.showConfirmDialog(main.frame, params, null, JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.WARNING_MESSAGE);
if(checkbox.isSelected()){
omitDiscardConfirmation = true;
}
} else {
result = JOptionPane.YES_OPTION;
}
if(result == JOptionPane.YES_OPTION){
simulationController.getSimulation().setActive(false);
main.simulationView.setUniverse(null);
simulationController = null;
simulationParameter = null;
main.txtRuleNumber.setText("0");
main.txtCells.setText("1");
main.txtIterations.setText("1");
main.transitionsView.hideHighlight();
main.progressBar.setValue(0);
validator.updateStatus();
setActivityState(ActivityState.CONFIGURING_RULE);
}
}
private void resetSimulation(){
simulationController.getSimulation().setActive(false);
main.simulationView.setUniverse(null);
simulationController = null;
simulationParameter = null;
main.txtRuleNumber.setText("0");
main.txtCells.setText("1");
main.txtIterations.setText("1");
main.transitionsView.hideHighlight();
main.progressBar.setValue(0);
}
public void saveEvent(){
ActivityState previous = activityState;
setActivityState(ActivityState.SAVING_FILE);
JFileChooser fc = new JFileChooser();
fc.setFileSelectionMode(JFileChooser.FILES_ONLY);
fc.setSelectedFile(fc.getCurrentDirectory() );
fc.setDialogTitle(Translator.getInstance().get("msgSaveDialogTitle"));
fc.setMultiSelectionEnabled(false);
fc.setFileFilter(new FileNameExtensionFilter(Translator.getInstance().get("casFileExtension"), "cas"));
int result = fc.showSaveDialog(main.frame);
if(result == JFileChooser.APPROVE_OPTION){
if(this.simulationParameter == null){
try {
createSimulationParameter();
} catch (InvalidSimulationParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SimulationBuilderException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
String fileName = String.valueOf(fc.getSelectedFile());
if(!fileName.endsWith(".cas")){
fileName = fileName + ".cas";
}
String content = gson.toJson(simulationParameter);
FileWriter fw;
try {
fw = new FileWriter(fileName);
fw.write(content);
fw.close();
validator.setNormalStatus("msgSaveSuccess");
setActivityState(previous);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
public void openEvent(){
ButtonModel selected = main.grpInitialCondition.getSelection();
setActivityState(ActivityState.OPENING_FILE);
JFileChooser fc = new JFileChooser();
fc.setFileSelectionMode(JFileChooser.FILES_ONLY);
fc.setSelectedFile(fc.getCurrentDirectory() );
fc.setDialogTitle(Translator.getInstance().get("msgOpenDialogTitle"));
fc.setMultiSelectionEnabled(false);
fc.setFileFilter(new FileNameExtensionFilter(Translator.getInstance().get("casFileExtension"), "cas"));
int result = fc.showOpenDialog(main.frame);
if(result == JFileChooser.APPROVE_OPTION){
BufferedReader br = null;
StringBuilder content = new StringBuilder();
String line = null;
try {
br = new BufferedReader(new FileReader(fc.getSelectedFile()));
while((line = br.readLine()) != null){
content.append(line);
}
if(content.length() > 0){
this.simulationParameter = gson.fromJson(content.toString(), UnidimensionalSimulationParameter.class);
updateVisualParameters();
validator.updateStatus();
if(!validator.isActivityLocked()){
simulationController = null;
main.transitionsView.hideHighlight();
main.progressBar.setValue(0);
executeComplete();
}
} else {
validator.setErrorStatus("errOpenFileInvalid", "");
}
} catch (Exception e) {
e.printStackTrace();
validator.setErrorStatus("errOpenFileGeneric", e.toString());
}
} else {
revertActivityState();
main.grpInitialCondition.setSelected(selected, true);
}
}
private void updateVisualParameters(){
int[] statesParameter = this.simulationParameter.getRuleConfigurationParameter().getStateValues();
int[] statesVisual = new int[statesParameter.length];
for(int i = 0; i < statesParameter.length; i++){
statesVisual[statesVisual.length-1-i] = statesParameter[i];
}
main.transitionsView.setStates(statesVisual);
transitionsEvent();
main.txtCells.setText(String.valueOf(this.simulationParameter.getLimitsParameter().getCells()));
main.txtIterations.setText(String.valueOf(this.simulationParameter.getLimitsParameter().getIterations()));
main.rdbtnUniqueCell.setSelected(false);
main.rdbtnRandom.setSelected(false);
}
public void exportEvent(){
if(main.keyMonitor.isCtrlPressed()){
main.aeo.setVisible(true);
} else {
exportSimulation(1, false, 0, null);
}
}
public void exportSimulation(int cellScale, boolean showGrid, int gridLineThickness, Color gridLineColour){
ActivityState previous = activityState;
setActivityState(ActivityState.EXPORTING_FILE);
JFileChooser fc = new JFileChooser();
fc.setFileSelectionMode(JFileChooser.FILES_ONLY);
fc.setSelectedFile(fc.getCurrentDirectory() );
fc.setDialogTitle(Translator.getInstance().get("msgExportDialogTitle"));
fc.setMultiSelectionEnabled(false);
fc.setFileFilter(new FileNameExtensionFilter(Translator.getInstance().get("pngFileExtension"), "png"));
int result = fc.showSaveDialog(main.frame);
if(result == JFileChooser.APPROVE_OPTION){
String fileName = String.valueOf(fc.getSelectedFile());
if(!fileName.endsWith(".png")){
fileName = fileName + ".png";
}
BufferedImage buffer = SimulationExportUtil.createBufferedImage(simulationController, cellScale, showGrid, gridLineThickness, gridLineColour);
File f = new File(fileName);
try {
ImageIO.write(buffer, "PNG", f);
validator.setNormalStatus("msgExportSuccess");
setActivityState(previous);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
public void languageEvent(){
if(main.langCombo.getSelectedIndex() == 0){
Translator.getInstance().setLanguage(Language.PORTUGUESE_BRAZIL);
} else if (main.langCombo.getSelectedIndex() == 1){
Translator.getInstance().setLanguage(Language.ENGLISH_UNITED_KINGDOM);
}
updateComponentsLanguage();
}
private void updateComponentsLanguage(){
main.pnlRuleType.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlRuleType"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.rdbtnElementary.setText(Translator.getInstance().get("rdbtnElementary"));
main.rdbtnTotalistic.setText(Translator.getInstance().get("rdbtnTotalistic"));
main.pnlRuleConfig.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlRuleConfig"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.lblRuleNumber.setText(Translator.getInstance().get("lblRuleNumber"));
main.pnlLimits.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlLimits"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.lblCells.setText(Translator.getInstance().get("lblCells"));
main.lblIterations.setText(Translator.getInstance().get("lblIterations"));
main.pnlInitialCondition.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlInitialCondition"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.rdbtnUniqueCell.setText(Translator.getInstance().get("rdbtnUniqueCell"));
main.rdbtnRandom.setText(Translator.getInstance().get("rdbtnRandom"));
main.pnlControl.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlControl"), TitledBorder.LEADING, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.btnOpen.setText(Translator.getInstance().get("btnOpen"));
main.btnSave.setText(Translator.getInstance().get("btnSave"));
main.btnExport.setText(Translator.getInstance().get("btnExport"));
main.lblStatus.setText(Translator.getInstance().get(main.getLastStatusKey()));
main.pnlView.setBorder(new TitledBorder(null, Translator.getInstance().get("pnlView"), TitledBorder.LEFT, TitledBorder.TOP, new Font("Lucida Grande", Font.BOLD, 12), Color.BLACK));
main.langCombo.removeAllItems();
Map<Object, Icon> icons = new HashMap<Object, Icon>();
icons.put(Translator.getInstance().get("langCombo0"), new ImageIcon(Main.class.getResource("br.png")));
icons.put(Translator.getInstance().get("langCombo1"), new ImageIcon(Main.class.getResource("en.png")));
Iterator it = icons.keySet().iterator();
main.langCombo.addItem(Translator.getInstance().get("langCombo0"));
main.langCombo.addItem(Translator.getInstance().get("langCombo1"));
main.langCombo.setRenderer(new IconListRenderer(icons));
main.langCombo.setSelectedIndex(Translator.getInstance().getLanguage().getId());
}
public void setActivityState(ActivityState state){
switch(state){
case CONFIGURING_RULE:
main.transitionsView.setMouseEnabled(true);
main.txtRuleNumber.setEnabled(true);
main.txtCells.setEnabled(true);
main.txtIterations.setEnabled(true);
main.btnDiscard.setEnabled(false);
main.btnSimulateComplete.setEnabled(true);
main.btnSimulateIteration.setEnabled(true);
main.btnOpen.setEnabled(true);
main.btnSave.setEnabled(true);
main.btnExport.setEnabled(false);
main.progressBar.setStringPainted(false);
main.langCombo.setEnabled(true);
main.rdbtnUniqueCell.setEnabled(true);
main.rdbtnUniqueCell.setSelected(true);
main.rdbtnRandom.setEnabled(true);
changeActivityState(state);
break;
case EXECUTING_RULE:
main.transitionsView.setMouseEnabled(false);
main.txtRuleNumber.setEnabled(false);
main.txtCells.setEnabled(false);
main.txtIterations.setEnabled(false);
main.btnDiscard.setEnabled(true);
main.btnSimulateComplete.setEnabled(true);
main.btnSimulateIteration.setEnabled(true);
main.btnOpen.setEnabled(false);
main.btnSave.setEnabled(true);
main.btnExport.setEnabled(false);
main.progressBar.setStringPainted(true);
main.langCombo.setEnabled(false);
main.rdbtnUniqueCell.setEnabled(false);
main.rdbtnRandom.setEnabled(false);
changeActivityState(state);
break;
case ANALYSING:
main.transitionsView.setMouseEnabled(false);
main.txtRuleNumber.setEnabled(false);
main.txtCells.setEnabled(false);
main.txtIterations.setEnabled(false);
main.btnDiscard.setEnabled(true);
main.btnSimulateComplete.setEnabled(false);
main.btnSimulateIteration.setEnabled(false);
main.btnOpen.setEnabled(true);
main.btnSave.setEnabled(true);
main.btnExport.setEnabled(true);
main.progressBar.setStringPainted(true);
main.langCombo.setEnabled(false);
main.rdbtnUniqueCell.setEnabled(false);
main.rdbtnRandom.setEnabled(false);
changeActivityState(state);
break;
case EXPORTING_FILE:
changeActivityState(state);
break;
case OPENING_FILE:
main.grpInitialCondition.clearSelection();
changeActivityState(state);
break;
case SAVING_FILE:
changeActivityState(state);
break;
default:
break;
}
}
private void changeActivityState(ActivityState newState){
this.previousActivityState = this.activityState;
this.activityState = newState;
}
private void revertActivityState(){
if(this.previousActivityState != null){
this.activityState = null;
setActivityState(this.previousActivityState);
}
}
public void aEOCellScaleEvent(){
if(validator.isAEOCellScaleValid()){
if(Integer.valueOf(main.aeo.txtAEOCellScale.getText()) > 3) {
if(!main.aeo.rdbtnAEOYes.isEnabled()){
main.aeo.rdbtnAEONo.setEnabled(true);
main.aeo.rdbtnAEOYes.setEnabled(true);
}
if(!main.aeo.rdbtnAEOYes.isSelected()){
main.aeo.rdbtnAEONo.setSelected(true);
} else {
aEOGridYesEvent();
}
} else {
main.aeo.rdbtnAEONo.setEnabled(false);
main.aeo.rdbtnAEOYes.setEnabled(false);
}
}
}
public void aEOGridYesEvent(){
main.aeo.txtAEOGridLinesThickness.setEnabled(true);
main.aeo.txtAEOCellLinesColour.setEnabled(true);
validator.isAEOCellLinesThicknessValid();
validator.isAEOCellColourValid();
}
public void aEOGridNoEvent(){
main.aeo.txtAEOGridLinesThickness.setEnabled(false);
main.aeo.txtAEOGridLinesThickness.setBackground(SystemColor.text);
main.aeo.txtAEOCellLinesColour.setEnabled(false);
main.aeo.txtAEOCellLinesColour.setBackground(SystemColor.text);
aEOCellScaleEvent();
}
public void aEOGridThicknessEvent(){
validator.isAEOCellLinesThicknessValid();
}
public void aEOGridColourEvent(){
validator.isAEOCellColourValid();
}
public void aEOExportEvent(){
if(!validator.isAEOActivityLocked()){
main.aeo.setVisible(false);
main.aeo.txtAEOCellScale.requestFocus();
int scale = Integer.valueOf(main.aeo.txtAEOCellScale.getText());
boolean showGrid = main.aeo.rdbtnAEOYes.isSelected() ? true : false;
int thickness = Integer.valueOf(main.aeo.txtAEOGridLinesThickness.getText());
String hex = main.aeo.txtAEOCellLinesColour.getText().replaceAll("#", "");
int r = Integer.valueOf(hex.substring(0, 2));
int g = Integer.valueOf(hex.substring(2, 4));
int b = Integer.valueOf(hex.substring(4, 6));
int rgb = r;
rgb = (rgb << 8) + g;
rgb = (rgb << 8) + b;
Color gridColour = new Color(rgb);
exportSimulation(scale, showGrid, thickness, gridColour);
}
}
}
|
Fix for 'Cell Scale' value range, for enabling 'Show Grid Lines' option. Issue #56. | cas-ui-desktop/src/main/java/com/ghjansen/cas/ui/desktop/manager/EventManager.java | <ide><path>as-ui-desktop/src/main/java/com/ghjansen/cas/ui/desktop/manager/EventManager.java
<ide>
<ide> public void aEOCellScaleEvent(){
<ide> if(validator.isAEOCellScaleValid()){
<del> if(Integer.valueOf(main.aeo.txtAEOCellScale.getText()) > 3) {
<add> if(Integer.valueOf(main.aeo.txtAEOCellScale.getText()) >= 3) {
<ide> if(!main.aeo.rdbtnAEOYes.isEnabled()){
<ide> main.aeo.rdbtnAEONo.setEnabled(true);
<ide> main.aeo.rdbtnAEOYes.setEnabled(true); |
||
Java | apache-2.0 | 1d6dbc818d43b3e6c965aba68599fd093d6a5bb3 | 0 | sarality/appblocks,sarality/appblocks | package com.sarality.app.config.test;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.util.ArrayList;
import java.util.List;
import com.dothat.app.module.reminder.data.ReminderData;
import com.sarality.app.config.TableIsEmpty;
import com.sarality.app.datastore.db.Table;
import com.sarality.app.view.action.test.BaseUnitTest;
/**
* Tests for {@link TableIsEmpty}.
*
* @author sunayna@ (Sunayna Uberoy)
*/
public class TableIsEmptyTest extends BaseUnitTest {
@SuppressWarnings("unchecked")
private Table<ReminderData> testTable = (Table<ReminderData>) mock(Table.class);
public void testConstructor() {
TableIsEmpty emptyTable = new TableIsEmpty(testTable);
assertNotNull(emptyTable);
}
@SuppressWarnings("unchecked")
public void testGetValue() {
TableIsEmpty emptyTable = new TableIsEmpty(testTable);
List<ReminderData> dataList = new ArrayList<ReminderData>();
when(testTable.query(null)).thenReturn((List<ReminderData>) dataList);
// Check for Empty Table
assertSame(true, emptyTable.getValue());
// Add Entry into list and check for non emptytable
ReminderData data = mock(ReminderData.class);
dataList.add(data);
assertSame(false, emptyTable.getValue());
}
public void testIsEditable() {
TableIsEmpty emptyTable = new TableIsEmpty(testTable);
assertSame(false, emptyTable.isEditable());
}
}
| tests/src/com/sarality/app/config/test/TableIsEmptyTest.java | package com.sarality.app.config.test;
import android.test.ActivityUnitTestCase;
import com.dothat.app.assistant.AssistantApp;
import com.dothat.app.common.data.ServiceProvider;
import com.dothat.app.common.data.ServiceType;
import com.dothat.app.module.reminder.ReminderListActivity;
import com.dothat.app.module.reminder.data.ActivityType;
import com.dothat.app.module.reminder.data.ReminderData;
import com.dothat.app.module.reminder.data.ReminderType;
import com.dothat.app.module.reminder.db.RemindersTable;
import com.sarality.app.config.TableIsEmpty;
import com.sarality.app.datastore.db.Table;
/**
* Tests for {@link TableIsEmpty}.
*
* @author sunayna@ (Sunayna Uberoy)
*/
public class TableIsEmptyTest extends ActivityUnitTestCase<ReminderListActivity> {
public TableIsEmptyTest() {
super(ReminderListActivity.class);
}
public void testConstructor() {
RemindersTable reminderTable = null;
TableIsEmpty emptyTable = new TableIsEmpty(reminderTable);
assertNotNull(emptyTable);
}
public void testGetValue() {
AssistantApp app = new AssistantApp(getInstrumentation().getTargetContext().getApplicationContext());
Table<ReminderData> table = new RemindersTable(app);
TableIsEmpty emptyTable = new TableIsEmpty(table);
assertSame(true, emptyTable.getValue());
// Making sure that the table is not empty
table.open();
ReminderData reminderData = new ReminderData.Builder().setReminderType(ReminderType.PAY_BILL)
.setActivityType(ActivityType.BILL).setServiceType(ServiceType.WATER).setServiceProvider(ServiceProvider.BSES)
.build();
table.create(reminderData);
table.close();
assertSame(false, emptyTable.getValue());
}
public void testIsEditable() {
RemindersTable table = null;
TableIsEmpty emptyTable = new TableIsEmpty(table);
assertSame(false, emptyTable.isEditable());
}
}
| Replaced with mock table
| tests/src/com/sarality/app/config/test/TableIsEmptyTest.java | Replaced with mock table | <ide><path>ests/src/com/sarality/app/config/test/TableIsEmptyTest.java
<ide> package com.sarality.app.config.test;
<ide>
<del>import android.test.ActivityUnitTestCase;
<add>import static org.mockito.Mockito.mock;
<add>import static org.mockito.Mockito.when;
<ide>
<del>import com.dothat.app.assistant.AssistantApp;
<del>import com.dothat.app.common.data.ServiceProvider;
<del>import com.dothat.app.common.data.ServiceType;
<del>import com.dothat.app.module.reminder.ReminderListActivity;
<del>import com.dothat.app.module.reminder.data.ActivityType;
<add>import java.util.ArrayList;
<add>import java.util.List;
<add>
<ide> import com.dothat.app.module.reminder.data.ReminderData;
<del>import com.dothat.app.module.reminder.data.ReminderType;
<del>import com.dothat.app.module.reminder.db.RemindersTable;
<ide> import com.sarality.app.config.TableIsEmpty;
<ide> import com.sarality.app.datastore.db.Table;
<add>import com.sarality.app.view.action.test.BaseUnitTest;
<ide>
<ide> /**
<ide> * Tests for {@link TableIsEmpty}.
<ide> *
<ide> * @author sunayna@ (Sunayna Uberoy)
<ide> */
<del>public class TableIsEmptyTest extends ActivityUnitTestCase<ReminderListActivity> {
<add>public class TableIsEmptyTest extends BaseUnitTest {
<ide>
<del> public TableIsEmptyTest() {
<del> super(ReminderListActivity.class);
<del> }
<add> @SuppressWarnings("unchecked")
<add> private Table<ReminderData> testTable = (Table<ReminderData>) mock(Table.class);
<ide>
<ide> public void testConstructor() {
<del> RemindersTable reminderTable = null;
<del> TableIsEmpty emptyTable = new TableIsEmpty(reminderTable);
<add> TableIsEmpty emptyTable = new TableIsEmpty(testTable);
<ide> assertNotNull(emptyTable);
<ide> }
<ide>
<add> @SuppressWarnings("unchecked")
<ide> public void testGetValue() {
<del> AssistantApp app = new AssistantApp(getInstrumentation().getTargetContext().getApplicationContext());
<add> TableIsEmpty emptyTable = new TableIsEmpty(testTable);
<ide>
<del> Table<ReminderData> table = new RemindersTable(app);
<del> TableIsEmpty emptyTable = new TableIsEmpty(table);
<add> List<ReminderData> dataList = new ArrayList<ReminderData>();
<add> when(testTable.query(null)).thenReturn((List<ReminderData>) dataList);
<add>
<add> // Check for Empty Table
<ide> assertSame(true, emptyTable.getValue());
<ide>
<del> // Making sure that the table is not empty
<del> table.open();
<del> ReminderData reminderData = new ReminderData.Builder().setReminderType(ReminderType.PAY_BILL)
<del> .setActivityType(ActivityType.BILL).setServiceType(ServiceType.WATER).setServiceProvider(ServiceProvider.BSES)
<del> .build();
<del> table.create(reminderData);
<del> table.close();
<del>
<add> // Add Entry into list and check for non emptytable
<add> ReminderData data = mock(ReminderData.class);
<add> dataList.add(data);
<ide> assertSame(false, emptyTable.getValue());
<ide> }
<ide>
<ide> public void testIsEditable() {
<del> RemindersTable table = null;
<del> TableIsEmpty emptyTable = new TableIsEmpty(table);
<add> TableIsEmpty emptyTable = new TableIsEmpty(testTable);
<ide> assertSame(false, emptyTable.isEditable());
<ide> }
<ide> } |
|
Java | mit | ed335cd34b6a1388055bede97d0b7e379b2ea459 | 0 | Breinify/brein-api-library-java | package com.brein.domain.results.temporaldataparts;
import com.brein.util.JsonHelper;
import java.util.Map;
public class BreinWeatherResult {
private static final String DESCRIPTION_KEY = "description";
private static final String TEMPERATURE_KEY = "temperatureC";
private static final String TEMPERATURE_FAHRENHEIT_KEY = "temperatureF";
private static final String PRECIPITATION_KEY = "precipitation";
private static final String PRECIPITATION_TYPE_KEY = PRECIPITATION_KEY + "Type";
private static final String PRECIPITATION_AMOUNT_KEY = PRECIPITATION_KEY + "Amount";
private static final String WIND_STRENGTH_KEY = "windStrength";
private static final String LAST_MEASURED_KEY = "lastMeasured";
private static final String CLOUD_COVER_KEY = "cloudCover";
private static final String MEASURED_LOCATION_KEY = "measuredAt";
private static final String LATITUDE_KEY = "lat";
private static final String LONGITUDE_KEY = "lon";
private static final String PRESSURE_KEY = "pressure";
private static final String HUMIDITY_KEY = "humidity";
private final String description;
private final Double temperature;
private final Double temperatureF;
private final PrecipitationType precipitation;
private final Double precipitationAmount;
private final Double windStrength;
private final Long lastMeasured;
private final Double cloudCover;
private final Double lat;
private final Double lon;
private final Double pressure;
private final Double humidity;
public BreinWeatherResult(final Map<String, Object> result) {
this.description = JsonHelper.getOr(result, DESCRIPTION_KEY, null);
this.temperature = JsonHelper.getOr(result, TEMPERATURE_KEY, null);
this.temperatureF = JsonHelper.getOr(result, TEMPERATURE_FAHRENHEIT_KEY, null);
this.windStrength = JsonHelper.getOr(result, WIND_STRENGTH_KEY, null);
this.lastMeasured = JsonHelper.getOrLong(result, LAST_MEASURED_KEY);
this.cloudCover = JsonHelper.getOr(result, CLOUD_COVER_KEY, null);
this.pressure = JsonHelper.getOr(result, PRESSURE_KEY, null);
this.humidity = JsonHelper.getOr(result, HUMIDITY_KEY, null);
//noinspection unchecked
final Map<String, Object> measuredJson = JsonHelper.getOr(result, MEASURED_LOCATION_KEY, null);
if (measuredJson == null) {
this.lat = null;
this.lon = null;
} else {
this.lat = JsonHelper.getOr(measuredJson, LATITUDE_KEY, null);
this.lon = JsonHelper.getOr(measuredJson, LONGITUDE_KEY, null);
}
final Map<String, Object> preciValue = JsonHelper.getOr(result, PRECIPITATION_KEY, null);
if (preciValue == null) {
this.precipitation = PrecipitationType.UNKNOWN;
this.precipitationAmount = null;
} else {
final String type = JsonHelper.getOr(preciValue, PRECIPITATION_TYPE_KEY, null);
if (type == null) {
this.precipitation = PrecipitationType.UNKNOWN;
} else {
switch (type.toLowerCase()) {
case "rain":
this.precipitation = PrecipitationType.RAIN;
break;
case "snow":
this.precipitation = PrecipitationType.SNOW;
break;
case "hail":
this.precipitation = PrecipitationType.HAIL;
break;
case "sleet":
this.precipitation = PrecipitationType.SLEET;
break;
case "none":
this.precipitation = PrecipitationType.NONE;
break;
default:
this.precipitation = PrecipitationType.UNKNOWN;
}
}
this.precipitationAmount = JsonHelper.getOr(preciValue, PRECIPITATION_AMOUNT_KEY, null);
}
}
/**
* @return A human readable description of the weather
*/
public String getDescription() {
return this.description;
}
public Double getTemperatureCelsius() {
return this.temperature;
}
public Double getTemperatureFahrenheit() {
if (this.temperatureF != null) {
return this.temperatureF;
}
final Double celsius = getTemperatureCelsius();
if (celsius == null) {
return null;
}
return celsius * 9 / 5 + 32;
}
public Double getTemperatureKelvin() {
final Double celsius = getTemperatureCelsius();
if (celsius == null) {
return null;
}
return celsius + 273.15;
}
/**
* @return The type of precipitation, or 'NONE' if there isn't any
*/
public PrecipitationType getPrecipitation() {
return this.precipitation;
}
/**
* @return How many centimeters of precipitation there have been in the last hour
*/
public Double getPrecipitationAmount() {
return this.precipitationAmount;
}
/**
* @return The wind speed, in kilometers/hour
*/
public Double getWindStrength() {
return this.windStrength;
}
/**
* @return When this weather data was collected
*/
public Long getLastMeasured() {
return this.lastMeasured;
}
/**
* @return The percentage of the sky covered in clouds
*/
public Double getCloudCover() {
return this.cloudCover;
}
/**
* @return the pressure
*/
public Double getPressure() {
return this.pressure;
}
/**
* @return The humidity as percentage (0.0 - 100.0)
*/
public Double getHumidity() {
return this.humidity;
}
/**
* @return The approximate location of the weather station the data was collected at
*/
public GeoCoordinates getMeasuredAt() {
if (this.lat == null && this.lon == null) {
return null;
} else {
return new GeoCoordinates(this.lat, this.lon);
}
}
@Override
public String toString() {
return "weather of " + getDescription() + " and a current temperature of " + getTemperatureCelsius() + " with" +
" precipitation of " + getPrecipitation();
}
}
| src/com/brein/domain/results/temporaldataparts/BreinWeatherResult.java | package com.brein.domain.results.temporaldataparts;
import com.brein.util.JsonHelper;
import java.util.Map;
public class BreinWeatherResult {
private static final String DESCRIPTION_KEY = "description";
private static final String TEMPERATURE_KEY = "temperature";
private static final String PRECIPITATION_KEY = "precipitation";
private static final String PRECIPITATION_TYPE_KEY = PRECIPITATION_KEY + "Type";
private static final String PRECIPITATION_AMOUNT_KEY = PRECIPITATION_KEY + "Amount";
private static final String WIND_STRENGTH_KEY = "windStrength";
private static final String LAST_MEASURED_KEY = "lastMeasured";
private static final String CLOUD_COVER_KEY = "cloudCover";
private static final String MEASURED_LOCATION_KEY = "measuredAt";
private static final String LATITUDE_KEY = "lat";
private static final String LONGITUDE_KEY = "lon";
private static final String PRESSURE_KEY = "pressure";
private static final String HUMIDITY_KEY = "humidity";
private final String description;
private final Double temperature;
private final PrecipitationType precipitation;
private final Double precipitationAmount;
private final Double windStrength;
private final Long lastMeasured;
private final Double cloudCover;
private final Double lat;
private final Double lon;
private final Double pressure;
private final Double humidity;
public BreinWeatherResult(final Map<String, Object> result) {
description = JsonHelper.getOr(result, DESCRIPTION_KEY, null);
temperature = JsonHelper.getOr(result, TEMPERATURE_KEY, null);
windStrength = JsonHelper.getOr(result, WIND_STRENGTH_KEY, null);
lastMeasured = JsonHelper.getOrLong(result, LAST_MEASURED_KEY);
cloudCover = JsonHelper.getOr(result, CLOUD_COVER_KEY, null);
pressure = JsonHelper.getOr(result, PRESSURE_KEY, null);
humidity = JsonHelper.getOr(result, HUMIDITY_KEY, null);
//noinspection unchecked
final Map<String, Object> measuredJson = JsonHelper.getOr(result, MEASURED_LOCATION_KEY, null);
if (measuredJson == null) {
lat = null;
lon = null;
} else {
lat = JsonHelper.getOr(measuredJson, LATITUDE_KEY, null);
lon = JsonHelper.getOr(measuredJson, LONGITUDE_KEY, null);
}
final Map<String, Object> preciValue = JsonHelper.getOr(result, PRECIPITATION_KEY, null);
if (preciValue == null) {
this.precipitation = PrecipitationType.UNKNOWN;
precipitationAmount = null;
} else {
final String type = JsonHelper.getOr(preciValue, PRECIPITATION_TYPE_KEY, null);
if (type == null) {
this.precipitation = PrecipitationType.UNKNOWN;
} else {
switch (type.toLowerCase()) {
case "rain":
this.precipitation = PrecipitationType.RAIN;
break;
case "snow":
this.precipitation = PrecipitationType.SNOW;
break;
case "hail":
this.precipitation = PrecipitationType.HAIL;
break;
case "sleet":
this.precipitation = PrecipitationType.SLEET;
break;
case "none":
this.precipitation = PrecipitationType.NONE;
break;
default:
this.precipitation = PrecipitationType.UNKNOWN;
}
}
precipitationAmount = JsonHelper.getOr(preciValue, PRECIPITATION_AMOUNT_KEY, null);
}
}
/**
* @return A human readable description of the weather
*/
public String getDescription() {
return description;
}
public Double getTemperatureCelsius() {
return temperature;
}
public Double getTemperatureFahrenheit() {
final Double celsius = getTemperatureCelsius();
if (celsius == null) {
return null;
}
return celsius * 9 / 5 + 32;
}
public Double getTemperatureKelvin() {
final Double celsius = getTemperatureCelsius();
if (celsius == null) {
return null;
}
return celsius + 273.15;
}
/**
* @return The type of precipitation, or 'NONE' if there isn't any
*/
public PrecipitationType getPrecipitation() {
return precipitation;
}
/**
* @return How many centimeters of precipitation there have been in the last hour
*/
public Double getPrecipitationAmount() {
return precipitationAmount;
}
/**
* @return The wind speed, in kilometers/hour
*/
public Double getWindStrength() {
return windStrength;
}
/**
* @return When this weather data was collected
*/
public Long getLastMeasured() {
return lastMeasured;
}
/**
* @return The percentage of the sky covered in clouds
*/
public Double getCloudCover() {
return cloudCover;
}
/**
* @return the pressure
*/
public Double getPressure() {
return pressure;
}
/**
* @return The humidity as percentage (0.0 - 100.0)
*/
public Double getHumidity() {
return humidity;
}
/**
* @return The approximate location of the weather station the data was collected at
*/
public GeoCoordinates getMeasuredAt() {
if (lat == null && lon == null) {
return null;
} else {
return new GeoCoordinates(lat, lon);
}
}
@Override
public String toString() {
return "weather of " + getDescription() + " and a current temperature of " + getTemperatureCelsius() + " with" +
" precipitation of " + getPrecipitation();
}
}
| fixed for new API values
| src/com/brein/domain/results/temporaldataparts/BreinWeatherResult.java | fixed for new API values | <ide><path>rc/com/brein/domain/results/temporaldataparts/BreinWeatherResult.java
<ide>
<ide> public class BreinWeatherResult {
<ide> private static final String DESCRIPTION_KEY = "description";
<del> private static final String TEMPERATURE_KEY = "temperature";
<add> private static final String TEMPERATURE_KEY = "temperatureC";
<add> private static final String TEMPERATURE_FAHRENHEIT_KEY = "temperatureF";
<ide> private static final String PRECIPITATION_KEY = "precipitation";
<ide> private static final String PRECIPITATION_TYPE_KEY = PRECIPITATION_KEY + "Type";
<ide> private static final String PRECIPITATION_AMOUNT_KEY = PRECIPITATION_KEY + "Amount";
<ide>
<ide> private final String description;
<ide> private final Double temperature;
<add> private final Double temperatureF;
<ide> private final PrecipitationType precipitation;
<ide> private final Double precipitationAmount;
<ide> private final Double windStrength;
<ide> private final Double humidity;
<ide>
<ide> public BreinWeatherResult(final Map<String, Object> result) {
<del> description = JsonHelper.getOr(result, DESCRIPTION_KEY, null);
<del> temperature = JsonHelper.getOr(result, TEMPERATURE_KEY, null);
<del> windStrength = JsonHelper.getOr(result, WIND_STRENGTH_KEY, null);
<del> lastMeasured = JsonHelper.getOrLong(result, LAST_MEASURED_KEY);
<del> cloudCover = JsonHelper.getOr(result, CLOUD_COVER_KEY, null);
<del> pressure = JsonHelper.getOr(result, PRESSURE_KEY, null);
<del> humidity = JsonHelper.getOr(result, HUMIDITY_KEY, null);
<add> this.description = JsonHelper.getOr(result, DESCRIPTION_KEY, null);
<add> this.temperature = JsonHelper.getOr(result, TEMPERATURE_KEY, null);
<add> this.temperatureF = JsonHelper.getOr(result, TEMPERATURE_FAHRENHEIT_KEY, null);
<add> this.windStrength = JsonHelper.getOr(result, WIND_STRENGTH_KEY, null);
<add> this.lastMeasured = JsonHelper.getOrLong(result, LAST_MEASURED_KEY);
<add> this.cloudCover = JsonHelper.getOr(result, CLOUD_COVER_KEY, null);
<add> this.pressure = JsonHelper.getOr(result, PRESSURE_KEY, null);
<add> this.humidity = JsonHelper.getOr(result, HUMIDITY_KEY, null);
<ide>
<ide> //noinspection unchecked
<ide> final Map<String, Object> measuredJson = JsonHelper.getOr(result, MEASURED_LOCATION_KEY, null);
<ide> if (measuredJson == null) {
<del> lat = null;
<del> lon = null;
<add> this.lat = null;
<add> this.lon = null;
<ide> } else {
<del> lat = JsonHelper.getOr(measuredJson, LATITUDE_KEY, null);
<del> lon = JsonHelper.getOr(measuredJson, LONGITUDE_KEY, null);
<add> this.lat = JsonHelper.getOr(measuredJson, LATITUDE_KEY, null);
<add> this.lon = JsonHelper.getOr(measuredJson, LONGITUDE_KEY, null);
<ide> }
<ide>
<ide> final Map<String, Object> preciValue = JsonHelper.getOr(result, PRECIPITATION_KEY, null);
<ide> if (preciValue == null) {
<ide> this.precipitation = PrecipitationType.UNKNOWN;
<del> precipitationAmount = null;
<add> this.precipitationAmount = null;
<ide> } else {
<ide> final String type = JsonHelper.getOr(preciValue, PRECIPITATION_TYPE_KEY, null);
<ide> if (type == null) {
<ide> }
<ide> }
<ide>
<del> precipitationAmount = JsonHelper.getOr(preciValue, PRECIPITATION_AMOUNT_KEY, null);
<add> this.precipitationAmount = JsonHelper.getOr(preciValue, PRECIPITATION_AMOUNT_KEY, null);
<ide> }
<ide> }
<ide>
<ide> * @return A human readable description of the weather
<ide> */
<ide> public String getDescription() {
<del> return description;
<add> return this.description;
<ide> }
<ide>
<ide> public Double getTemperatureCelsius() {
<del> return temperature;
<add> return this.temperature;
<ide> }
<ide>
<ide> public Double getTemperatureFahrenheit() {
<add> if (this.temperatureF != null) {
<add> return this.temperatureF;
<add> }
<add>
<ide> final Double celsius = getTemperatureCelsius();
<ide> if (celsius == null) {
<ide> return null;
<ide> * @return The type of precipitation, or 'NONE' if there isn't any
<ide> */
<ide> public PrecipitationType getPrecipitation() {
<del> return precipitation;
<add> return this.precipitation;
<ide> }
<ide>
<ide> /**
<ide> * @return How many centimeters of precipitation there have been in the last hour
<ide> */
<ide> public Double getPrecipitationAmount() {
<del> return precipitationAmount;
<add> return this.precipitationAmount;
<ide> }
<ide>
<ide> /**
<ide> * @return The wind speed, in kilometers/hour
<ide> */
<ide> public Double getWindStrength() {
<del> return windStrength;
<add> return this.windStrength;
<ide> }
<ide>
<ide> /**
<ide> * @return When this weather data was collected
<ide> */
<ide> public Long getLastMeasured() {
<del> return lastMeasured;
<add> return this.lastMeasured;
<ide> }
<ide>
<ide> /**
<ide> * @return The percentage of the sky covered in clouds
<ide> */
<ide> public Double getCloudCover() {
<del> return cloudCover;
<add> return this.cloudCover;
<ide> }
<ide>
<ide> /**
<ide> * @return the pressure
<ide> */
<ide> public Double getPressure() {
<del> return pressure;
<add> return this.pressure;
<ide> }
<ide>
<ide> /**
<ide> * @return The humidity as percentage (0.0 - 100.0)
<ide> */
<ide> public Double getHumidity() {
<del> return humidity;
<add> return this.humidity;
<ide> }
<ide>
<ide> /**
<ide> * @return The approximate location of the weather station the data was collected at
<ide> */
<ide> public GeoCoordinates getMeasuredAt() {
<del> if (lat == null && lon == null) {
<add> if (this.lat == null && this.lon == null) {
<ide> return null;
<ide> } else {
<del> return new GeoCoordinates(lat, lon);
<add> return new GeoCoordinates(this.lat, this.lon);
<ide> }
<ide> }
<ide> |
|
JavaScript | apache-2.0 | 55d8a945acca205d3ca334c5ea78ec94904390a1 | 0 | Mindsers/configfile | const fs = require('fs')
const path = require('path')
const inquirer = require('inquirer')
const { fileExist, writeFile } = require('./fs.utils')
const { log } = require('./log.utils')
const { gitClone } = require('./git.utils')
const URL_REGEX = /^((?:(https?):\/\/)?((?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9])\.(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9])\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9])\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9]))|(?:(?:(?:\w+\.){1,2}[\w]{2,3})))(?::(\d+))?((?:\/[\w]+)*)(?:\/|(\/[\w]+\.[\w]{3,4})|(\?(?:([\w]+=[\w]+)&)*([\w]+=[\w]+))?|\?(?:(wsdl|wadl))))$/
const PATH_REGEX = /^(?:(?:~|\.{1,2})?\/)+(?:[a-zA-Z\.\-\_]+\/?)*$/
module.exports = exports = configFilename => {
return options => {
const userForceOverwrite = options.force || false
const questions = [
{
name: 'overwrite_file',
message: 'A configuration file already exist. Do you want to continue ?',
type: 'confirm',
when: () => fileExist(configFilename) && !userForceOverwrite
},
{
name: 'repo_url',
message: 'Repository url:',
type: 'input',
validate: url => URL_REGEX.test(url),
when: data => !fileExist(configFilename) || data.overwrite_file || userForceOverwrite
},
{
name: 'folder_path',
message: 'Folder path:',
type: 'input',
validate: path => PATH_REGEX.test(path),
when: data => !fileExist(configFilename) || data.overwrite_file || userForceOverwrite
}
]
inquirer.prompt(questions)
.then(({ repo_url = null, folder_path, overwrite_file = true }) => {
if (!overwrite_file) {
throw new Error('user_stop_init')
}
folder_path = path.resolve(folder_path)
return writeFile(configFilename, JSON.stringify({ repo_url, folder_path }, null, 4))
.then(() => ({ repoUrl: repo_url, folderPath: folder_path }))
})
.then(data => {
const { folderPath } = data
if (!fileExist(folderPath)) {
log({ type: 'info', message: 'Folder does not exist. It will be created.' })
fs.mkdirSync(folderPath)
}
const isDirectory = fs.statSync(folderPath).isDirectory()
if (!isDirectory) {
throw new Error('folder_is_not_directory')
}
const folderIsEmpty = fs.readdirSync(folderPath).length < 1
if (!folderIsEmpty) {
throw new Error('folder_is_not_empty')
}
return data
})
.then(data => {
if (data.repoUrl == null) {
log({ type: 'warn', message: 'Impossible to cloned git repository. Need repository URL.' })
return data
}
return gitClone(data.repoUrl, data.folderPath)
.then(repo => {
log({ type: 'info', message: 'Git repository cloned successuly.' })
return data
})
})
.catch(error => {
switch (error.message) {
case 'folder_is_not_directory':
log({ type: 'error', message: `Path doesn't corresponding to a folder.` })
break
case 'folder_is_not_empty':
log({ type: 'error', message: 'Folder is not empty.' })
break
case 'user_stop_init':
log({ message: 'You stopped the command. Nothing has be made.' })
break
default:
log({ type: 'error', message: 'An error occured.', prefix: ' Fail ' })
}
})
}
}
| lib/init.command.js | const fs = require('fs')
const inquirer = require('inquirer')
const { fileExist, writeFile } = require('./fs.utils')
const { log } = require('./log.utils')
const { gitClone } = require('./git.utils')
const URL_REGEX = /^((?:(https?):\/\/)?((?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9])\.(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9])\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9])\.)(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[0-9][0-9]|[0-9]))|(?:(?:(?:\w+\.){1,2}[\w]{2,3})))(?::(\d+))?((?:\/[\w]+)*)(?:\/|(\/[\w]+\.[\w]{3,4})|(\?(?:([\w]+=[\w]+)&)*([\w]+=[\w]+))?|\?(?:(wsdl|wadl))))$/
const PATH_REGEX = /^(?:(?:~|\.{1,2})?\/)+(?:[a-zA-Z\.\-\_]+\/?)*$/
module.exports = exports = configFilename => {
return options => {
const userForceOverwrite = options.force || false
const questions = [
{
name: 'overwrite_file',
message: 'A configuration file already exist. Do you want to continue ?',
type: 'confirm',
when: () => fileExist(configFilename) && !userForceOverwrite
},
{
name: 'repo_url',
message: 'Repository url:',
type: 'input',
validate: url => URL_REGEX.test(url),
when: data => !fileExist(configFilename) || data.overwrite_file || userForceOverwrite
},
{
name: 'folder_path',
message: 'Folder path:',
type: 'input',
validate: path => PATH_REGEX.test(path),
when: data => !fileExist(configFilename) || data.overwrite_file || userForceOverwrite
}
]
inquirer.prompt(questions)
.then(({ repo_url = null, folder_path, overwrite_file = true }) => {
if (!overwrite_file) {
throw new Error('user_stop_init')
}
return writeFile(configFilename, JSON.stringify({ repo_url, folder_path }, null, 4))
.then(() => ({ repoUrl: repo_url, folderPath: folder_path }))
})
.then(data => {
const { folderPath } = data
if (!fileExist(folderPath)) {
log({ type: 'info', message: 'Folder does not exist. It will be created.' })
fs.mkdirSync(folderPath)
}
const isDirectory = fs.statSync(folderPath).isDirectory()
if (!isDirectory) {
throw new Error('folder_is_not_directory')
}
const folderIsEmpty = fs.readdirSync(folderPath).length < 1
if (!folderIsEmpty) {
throw new Error('folder_is_not_empty')
}
return data
})
.then(data => {
if (data.repoUrl == null) {
log({ type: 'warn', message: 'Impossible to cloned git repository. Need repository URL.' })
return data
}
return gitClone(data.repoUrl, data.folderPath)
.then(repo => {
log({ type: 'info', message: 'Git repository cloned successuly.' })
return data
})
})
.catch(error => {
switch (error.message) {
case 'folder_is_not_directory':
log({ type: 'error', message: `Path doesn't corresponding to a folder.` })
break
case 'folder_is_not_empty':
log({ type: 'error', message: 'Folder is not empty.' })
break
case 'user_stop_init':
log({ message: 'You stopped the command. Nothing has be made.' })
break
default:
log({ type: 'error', message: 'An error occured.', prefix: ' Fail ' })
}
})
}
}
| Store absolute path instead of relative one
| lib/init.command.js | Store absolute path instead of relative one | <ide><path>ib/init.command.js
<ide> const fs = require('fs')
<add>const path = require('path')
<ide> const inquirer = require('inquirer')
<ide>
<ide> const { fileExist, writeFile } = require('./fs.utils')
<ide> if (!overwrite_file) {
<ide> throw new Error('user_stop_init')
<ide> }
<add>
<add> folder_path = path.resolve(folder_path)
<ide>
<ide> return writeFile(configFilename, JSON.stringify({ repo_url, folder_path }, null, 4))
<ide> .then(() => ({ repoUrl: repo_url, folderPath: folder_path })) |
|
Java | apache-2.0 | 14cf3cf2e2fdf91ac89e901f7c46e6bd1def6c14 | 0 | kailash09dabhi/OmRecorder | /**
* Copyright 2017 Kailash Dabhi (Kingbull Technology)
*
* 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 omrecorder;
import android.media.AudioRecord;
import java.io.IOException;
import java.io.OutputStream;
/**
* A PullTransport is a object who pulls the data from {@code AudioSource} and transport it to
* OutputStream
*
* @author Kailash Dabhi
* @date 06-07-2016
*/
public interface PullTransport {
/**
* It starts to pull the {@code AudioSource} and transport it to
* OutputStream
*
* @param outputStream the OutputStream where we want to transport the pulled audio data.
* @throws IOException if there is any problem arise in pulling and transporting
*/
void start(OutputStream outputStream) throws IOException;
//It immediately stop pulling {@code AudioSource}
void stop();
//Returns the source which is used for pulling
AudioSource source();
/**
* Interface definition for a callback to be invoked when a chunk of audio is pulled from {@code
* AudioSource}.
*/
interface OnAudioChunkPulledListener {
/**
* Called when {@code AudioSource} is pulled and returned{@code AudioChunk}.
*/
void onAudioChunkPulled(AudioChunk audioChunk);
}
abstract class AbstractPullTransport implements PullTransport {
final AudioSource audioRecordSource;
final OnAudioChunkPulledListener onAudioChunkPulledListener;
private final UiThread uiThread = new UiThread();
AbstractPullTransport(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener) {
this.audioRecordSource = audioRecordSource;
this.onAudioChunkPulledListener = onAudioChunkPulledListener;
}
@Override public void start(OutputStream outputStream) throws IOException {
startPoolingAndWriting(preparedSourceToBePulled(), audioRecordSource.minimumBufferSize(),
outputStream);
}
void startPoolingAndWriting(AudioRecord audioRecord, int minimumBufferSize,
OutputStream outputStream) throws IOException {
}
AudioRecord preparedSourceToBePulled() {
final AudioRecord audioRecord = audioRecordSource.audioRecorder();
audioRecord.startRecording();
audioRecordSource.isEnableToBePulled(true);
return audioRecord;
}
@Override public void stop() {
audioRecordSource.isEnableToBePulled(false);
audioRecordSource.audioRecorder().stop();
}
public AudioSource source() {
return audioRecordSource;
}
void postSilenceEvent(final Recorder.OnSilenceListener onSilenceListener,
final long silenceTime) {
uiThread.execute(new Runnable() {
@Override public void run() {
onSilenceListener.onSilence(silenceTime);
}
});
}
void postPullEvent(final AudioChunk audioChunk) {
uiThread.execute(new Runnable() {
@Override public void run() {
onAudioChunkPulledListener.onAudioChunkPulled(audioChunk);
}
});
}
}
final class Default extends AbstractPullTransport {
private final WriteAction writeAction;
public Default(AudioSource audioRecordSource, WriteAction writeAction) {
this(audioRecordSource, null, writeAction);
}
public Default(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener, WriteAction writeAction) {
super(audioRecordSource, onAudioChunkPulledListener);
this.writeAction = writeAction;
}
public Default(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener) {
this(audioRecordSource, onAudioChunkPulledListener, new WriteAction.Default());
}
public Default(AudioSource audioRecordSource) {
this(audioRecordSource, null, new WriteAction.Default());
}
@Override void startPoolingAndWriting(AudioRecord audioRecord, int minimumBufferSize,
OutputStream outputStream) throws IOException {
while (audioRecordSource.isEnableToBePulled()) {
AudioChunk audioChunk = new AudioChunk.Bytes(new byte[minimumBufferSize]);
if (AudioRecord.ERROR_INVALID_OPERATION != audioRecord.read(audioChunk.toBytes(), 0,
minimumBufferSize)) {
if (onAudioChunkPulledListener != null) {
postPullEvent(audioChunk);
}
writeAction.execute(audioChunk.toBytes(), outputStream);
}
}
}
}
final class Noise extends AbstractPullTransport {
private final long silenceTimeThreshold;
private final Recorder.OnSilenceListener silenceListener;
private final WriteAction writeAction;
private long firstSilenceMoment = 0;
private int noiseRecordedAfterFirstSilenceThreshold = 0;
public Noise(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener,
Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
this(audioRecordSource, onAudioChunkPulledListener, new WriteAction.Default(),
silenceListener, silenceTimeThreshold);
}
public Noise(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener, WriteAction writeAction,
Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
super(audioRecordSource, onAudioChunkPulledListener);
this.writeAction = writeAction;
this.silenceListener = silenceListener;
this.silenceTimeThreshold = silenceTimeThreshold;
}
public Noise(AudioSource audioRecordSource, WriteAction writeAction,
Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
this(audioRecordSource, null, writeAction, silenceListener, silenceTimeThreshold);
}
public Noise(AudioSource audioRecordSource, Recorder.OnSilenceListener silenceListener,
long silenceTimeThreshold) {
this(audioRecordSource, null, new WriteAction.Default(), silenceListener,
silenceTimeThreshold);
}
public Noise(AudioSource audioRecordSource, Recorder.OnSilenceListener silenceListener) {
this(audioRecordSource, null, new WriteAction.Default(), silenceListener, 200);
}
public Noise(AudioSource audioRecordSource) {
this(audioRecordSource, null, new WriteAction.Default(), null, 200);
}
@Override public void start(OutputStream outputStream) throws IOException {
final AudioRecord audioRecord = audioRecordSource.audioRecorder();
audioRecord.startRecording();
audioRecordSource.isEnableToBePulled(true);
final AudioChunk.Shorts audioChunk =
new AudioChunk.Shorts(new short[audioRecordSource.minimumBufferSize()]);
while (audioRecordSource.isEnableToBePulled()) {
audioChunk.numberOfShortsRead =
audioRecord.read(audioChunk.shorts, 0, audioChunk.shorts.length);
if (AudioRecord.ERROR_INVALID_OPERATION != audioChunk.numberOfShortsRead) {
if (onAudioChunkPulledListener != null) {
postPullEvent(audioChunk);
}
if (audioChunk.peakIndex() > -1) {
writeAction.execute(audioChunk.toBytes(), outputStream);
firstSilenceMoment = 0;
noiseRecordedAfterFirstSilenceThreshold++;
} else {
if (firstSilenceMoment == 0) firstSilenceMoment = System.currentTimeMillis();
final long silenceTime = System.currentTimeMillis() - firstSilenceMoment;
if (firstSilenceMoment != 0 && silenceTime > this.silenceTimeThreshold) {
if (silenceTime > 1000) {
if (noiseRecordedAfterFirstSilenceThreshold >= 3) {
noiseRecordedAfterFirstSilenceThreshold = 0;
if (silenceListener != null) postSilenceEvent(silenceListener, silenceTime);
}
}
} else {
writeAction.execute(audioChunk.toBytes(), outputStream);
}
}
}
}
}
}
}
| om-recorder/src/main/java/omrecorder/PullTransport.java | /**
* Copyright 2017 Kailash Dabhi (Kingbull Technology)
*
* 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 omrecorder;
import android.media.AudioRecord;
import java.io.IOException;
import java.io.OutputStream;
/**
* A PullTransport is a object who pulls the data from {@code AudioSource} and transport it to
* OutputStream
*
* @author Kailash Dabhi
* @date 06-07-2016
*/
public interface PullTransport {
/**
* It starts to pull the {@code AudioSource} and transport it to
* OutputStream
*
* @param outputStream the OutputStream where we want to transport the pulled audio data.
* @throws IOException if there is any problem arise in pulling and transporting
*/
void start(OutputStream outputStream) throws IOException;
//It immediately stop pulling {@code AudioSource}
void stop();
//Returns the source which is used for pulling
AudioSource source();
/**
* Interface definition for a callback to be invoked when a chunk of audio is pulled from {@code
* AudioSource}.
*/
interface OnAudioChunkPulledListener {
/**
* Called when {@code AudioSource} is pulled and returned{@code AudioChunk}.
*/
void onAudioChunkPulled(AudioChunk audioChunk);
}
abstract class AbstractPullTransport implements PullTransport {
final AudioSource audioRecordSource;
final OnAudioChunkPulledListener onAudioChunkPulledListener;
private final UiThread uiThread = new UiThread();
AbstractPullTransport(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener) {
this.audioRecordSource = audioRecordSource;
this.onAudioChunkPulledListener = onAudioChunkPulledListener;
}
@Override public void start(OutputStream outputStream) throws IOException {
startPoolingAndWriting(preparedSourceToBePulled(), audioRecordSource.minimumBufferSize(),
outputStream);
}
void startPoolingAndWriting(AudioRecord audioRecord, int minimumBufferSize,
OutputStream outputStream) throws IOException {
}
@Override public void stop() {
audioRecordSource.isEnableToBePulled(false);
audioRecordSource.audioRecorder().stop();
}
public AudioSource source() {
return audioRecordSource;
}
AudioRecord preparedSourceToBePulled() {
final AudioRecord audioRecord = audioRecordSource.audioRecorder();
audioRecord.startRecording();
audioRecordSource.isEnableToBePulled(true);
return audioRecord;
}
void postSilenceEvent(final Recorder.OnSilenceListener onSilenceListener,
final long silenceTime) {
uiThread.execute(new Runnable() {
@Override public void run() {
onSilenceListener.onSilence(silenceTime);
}
});
}
void postPullEvent(final AudioChunk audioChunk) {
uiThread.execute(new Runnable() {
@Override public void run() {
onAudioChunkPulledListener.onAudioChunkPulled(audioChunk);
}
});
}
}
final class Default extends AbstractPullTransport {
private final WriteAction writeAction;
public Default(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener, WriteAction writeAction) {
super(audioRecordSource, onAudioChunkPulledListener);
this.writeAction = writeAction;
}
public Default(AudioSource audioRecordSource, WriteAction writeAction) {
this(audioRecordSource, null, writeAction);
}
public Default(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener) {
this(audioRecordSource, onAudioChunkPulledListener, new WriteAction.Default());
}
public Default(AudioSource audioRecordSource) {
this(audioRecordSource, null, new WriteAction.Default());
}
@Override void startPoolingAndWriting(AudioRecord audioRecord, int minimumBufferSize,
OutputStream outputStream) throws IOException {
while (audioRecordSource.isEnableToBePulled()) {
AudioChunk audioChunk = new AudioChunk.Bytes(new byte[minimumBufferSize]);
if (AudioRecord.ERROR_INVALID_OPERATION != audioRecord.read(audioChunk.toBytes(), 0,
minimumBufferSize)) {
if (onAudioChunkPulledListener != null) {
postPullEvent(audioChunk);
}
writeAction.execute(audioChunk.toBytes(), outputStream);
}
}
}
}
final class Noise extends AbstractPullTransport {
private final AudioChunk.Shorts audioChunk;
private final long silenceTimeThreshold;
private final Recorder.OnSilenceListener silenceListener;
private final WriteAction writeAction;
private long firstSilenceMoment = 0;
private int noiseRecordedAfterFirstSilenceThreshold = 0;
public Noise(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener, WriteAction writeAction,
Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
super(audioRecordSource, onAudioChunkPulledListener);
this.writeAction = writeAction;
this.silenceListener = silenceListener;
this.silenceTimeThreshold = silenceTimeThreshold;
audioChunk = new AudioChunk.Shorts(new short[audioRecordSource.minimumBufferSize()]);
}
public Noise(AudioSource audioRecordSource,
OnAudioChunkPulledListener onAudioChunkPulledListener,
Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
this(audioRecordSource, onAudioChunkPulledListener, new WriteAction.Default(),
silenceListener, silenceTimeThreshold);
}
public Noise(AudioSource audioRecordSource, WriteAction writeAction,
Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
this(audioRecordSource, null, writeAction, silenceListener, silenceTimeThreshold);
}
public Noise(AudioSource audioRecordSource, Recorder.OnSilenceListener silenceListener,
long silenceTimeThreshold) {
this(audioRecordSource, null, new WriteAction.Default(), silenceListener,
silenceTimeThreshold);
}
public Noise(AudioSource audioRecordSource, Recorder.OnSilenceListener silenceListener) {
this(audioRecordSource, null, new WriteAction.Default(), silenceListener, 200);
}
public Noise(AudioSource audioRecordSource) {
this(audioRecordSource, null, new WriteAction.Default(), null, 200);
}
@Override public void start(OutputStream outputStream) throws IOException {
final AudioRecord audioRecord = audioRecordSource.audioRecorder();
audioRecord.startRecording();
audioRecordSource.isEnableToBePulled(true);
while (audioRecordSource.isEnableToBePulled()) {
audioChunk.numberOfShortsRead =
audioRecord.read(audioChunk.shorts, 0, audioChunk.shorts.length);
if (AudioRecord.ERROR_INVALID_OPERATION != audioChunk.numberOfShortsRead) {
if (onAudioChunkPulledListener != null) {
postPullEvent(audioChunk);
}
if (audioChunk.peakIndex() > -1) {
writeAction.execute(audioChunk.toBytes(), outputStream);
firstSilenceMoment = 0;
noiseRecordedAfterFirstSilenceThreshold++;
} else {
if (firstSilenceMoment == 0) firstSilenceMoment = System.currentTimeMillis();
final long silenceTime = System.currentTimeMillis() - firstSilenceMoment;
if (firstSilenceMoment != 0 && silenceTime > this.silenceTimeThreshold) {
if (silenceTime > 1000) {
if (noiseRecordedAfterFirstSilenceThreshold >= 3) {
noiseRecordedAfterFirstSilenceThreshold = 0;
if (silenceListener != null) postSilenceEvent(silenceListener, silenceTime);
}
}
} else {
writeAction.execute(audioChunk.toBytes(), outputStream);
}
}
}
}
}
}
}
| Convert AudioChunk to local variable
| om-recorder/src/main/java/omrecorder/PullTransport.java | Convert AudioChunk to local variable | <ide><path>m-recorder/src/main/java/omrecorder/PullTransport.java
<ide> * you may not use this file except in compliance with the License.
<ide> * You may obtain a copy of the License at
<ide> *
<del> * http://www.apache.org/licenses/LICENSE-2.0
<add> * http://www.apache.org/licenses/LICENSE-2.0
<ide> *
<ide> * Unless required by applicable law or agreed to in writing, software
<ide> * distributed under the License is distributed on an "AS IS" BASIS,
<ide> * @date 06-07-2016
<ide> */
<ide> public interface PullTransport {
<del>
<ide> /**
<ide> * It starts to pull the {@code AudioSource} and transport it to
<ide> * OutputStream
<ide> OutputStream outputStream) throws IOException {
<ide> }
<ide>
<del> @Override public void stop() {
<del> audioRecordSource.isEnableToBePulled(false);
<del> audioRecordSource.audioRecorder().stop();
<del> }
<del>
<del> public AudioSource source() {
<del> return audioRecordSource;
<del> }
<del>
<ide> AudioRecord preparedSourceToBePulled() {
<ide> final AudioRecord audioRecord = audioRecordSource.audioRecorder();
<ide> audioRecord.startRecording();
<ide> return audioRecord;
<ide> }
<ide>
<add> @Override public void stop() {
<add> audioRecordSource.isEnableToBePulled(false);
<add> audioRecordSource.audioRecorder().stop();
<add> }
<add>
<add> public AudioSource source() {
<add> return audioRecordSource;
<add> }
<add>
<ide> void postSilenceEvent(final Recorder.OnSilenceListener onSilenceListener,
<ide> final long silenceTime) {
<ide> uiThread.execute(new Runnable() {
<ide> }
<ide>
<ide> final class Default extends AbstractPullTransport {
<del>
<ide> private final WriteAction writeAction;
<add>
<add> public Default(AudioSource audioRecordSource, WriteAction writeAction) {
<add> this(audioRecordSource, null, writeAction);
<add> }
<ide>
<ide> public Default(AudioSource audioRecordSource,
<ide> OnAudioChunkPulledListener onAudioChunkPulledListener, WriteAction writeAction) {
<ide> super(audioRecordSource, onAudioChunkPulledListener);
<ide> this.writeAction = writeAction;
<del> }
<del>
<del> public Default(AudioSource audioRecordSource, WriteAction writeAction) {
<del> this(audioRecordSource, null, writeAction);
<ide> }
<ide>
<ide> public Default(AudioSource audioRecordSource,
<ide> }
<ide>
<ide> final class Noise extends AbstractPullTransport {
<del>
<del> private final AudioChunk.Shorts audioChunk;
<ide> private final long silenceTimeThreshold;
<ide> private final Recorder.OnSilenceListener silenceListener;
<ide> private final WriteAction writeAction;
<ide> private long firstSilenceMoment = 0;
<ide> private int noiseRecordedAfterFirstSilenceThreshold = 0;
<add>
<add> public Noise(AudioSource audioRecordSource,
<add> OnAudioChunkPulledListener onAudioChunkPulledListener,
<add> Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
<add> this(audioRecordSource, onAudioChunkPulledListener, new WriteAction.Default(),
<add> silenceListener, silenceTimeThreshold);
<add> }
<ide>
<ide> public Noise(AudioSource audioRecordSource,
<ide> OnAudioChunkPulledListener onAudioChunkPulledListener, WriteAction writeAction,
<ide> this.writeAction = writeAction;
<ide> this.silenceListener = silenceListener;
<ide> this.silenceTimeThreshold = silenceTimeThreshold;
<del> audioChunk = new AudioChunk.Shorts(new short[audioRecordSource.minimumBufferSize()]);
<del> }
<del>
<del> public Noise(AudioSource audioRecordSource,
<del> OnAudioChunkPulledListener onAudioChunkPulledListener,
<del> Recorder.OnSilenceListener silenceListener, long silenceTimeThreshold) {
<del> this(audioRecordSource, onAudioChunkPulledListener, new WriteAction.Default(),
<del> silenceListener, silenceTimeThreshold);
<ide> }
<ide>
<ide> public Noise(AudioSource audioRecordSource, WriteAction writeAction,
<ide> final AudioRecord audioRecord = audioRecordSource.audioRecorder();
<ide> audioRecord.startRecording();
<ide> audioRecordSource.isEnableToBePulled(true);
<add> final AudioChunk.Shorts audioChunk =
<add> new AudioChunk.Shorts(new short[audioRecordSource.minimumBufferSize()]);
<ide> while (audioRecordSource.isEnableToBePulled()) {
<ide> audioChunk.numberOfShortsRead =
<ide> audioRecord.read(audioChunk.shorts, 0, audioChunk.shorts.length);
<ide> noiseRecordedAfterFirstSilenceThreshold++;
<ide> } else {
<ide> if (firstSilenceMoment == 0) firstSilenceMoment = System.currentTimeMillis();
<del>
<ide> final long silenceTime = System.currentTimeMillis() - firstSilenceMoment;
<ide> if (firstSilenceMoment != 0 && silenceTime > this.silenceTimeThreshold) {
<ide> if (silenceTime > 1000) { |
|
Java | apache-2.0 | 1749e13f789abfddaa56f02c54a0d2ac54959828 | 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-2019 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.codeInsight.daemon.impl.analysis;
import com.intellij.codeInsight.ExceptionUtil;
import com.intellij.codeInsight.daemon.JavaErrorBundle;
import com.intellij.codeInsight.daemon.impl.HighlightInfo;
import com.intellij.codeInsight.daemon.impl.HighlightInfoType;
import com.intellij.codeInsight.daemon.impl.quickfix.*;
import com.intellij.codeInsight.intention.IntentionAction;
import com.intellij.codeInsight.intention.QuickFixFactory;
import com.intellij.codeInsight.intention.impl.PriorityIntentionActionWrapper;
import com.intellij.codeInsight.quickfix.UnresolvedReferenceQuickFixProvider;
import com.intellij.codeInspection.LocalQuickFixOnPsiElementAsIntentionAdapter;
import com.intellij.lang.jvm.JvmModifier;
import com.intellij.lang.jvm.actions.JvmElementActionFactories;
import com.intellij.lang.jvm.actions.MemberRequestsKt;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.DefaultLanguageHighlighterColors;
import com.intellij.openapi.editor.colors.EditorColorsUtil;
import com.intellij.openapi.project.IndexNotReadyException;
import com.intellij.openapi.projectRoots.JavaSdkVersion;
import com.intellij.openapi.util.Comparing;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.util.SystemInfo;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.pom.java.LanguageLevel;
import com.intellij.psi.*;
import com.intellij.psi.impl.PsiSuperMethodImplUtil;
import com.intellij.psi.impl.source.resolve.graphInference.InferenceSession;
import com.intellij.psi.infos.CandidateInfo;
import com.intellij.psi.infos.MethodCandidateInfo;
import com.intellij.psi.util.*;
import com.intellij.refactoring.util.RefactoringChangeUtil;
import com.intellij.ui.ColorUtil;
import com.intellij.util.ArrayUtil;
import com.intellij.util.JavaPsiConstructorUtil;
import com.intellij.util.ObjectUtils;
import com.intellij.util.VisibilityUtil;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.containers.MostlySingularMultiMap;
import com.intellij.util.ui.StartupUiUtil;
import com.intellij.util.ui.UIUtil;
import com.intellij.xml.util.XmlStringUtil;
import com.siyeh.ig.psiutils.ExpressionUtils;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.awt.*;
import java.text.MessageFormat;
import java.util.List;
import java.util.*;
import java.util.function.Predicate;
import java.util.stream.Stream;
public class HighlightMethodUtil {
private static final QuickFixFactory QUICK_FIX_FACTORY = QuickFixFactory.getInstance();
private static final Logger LOG = Logger.getInstance(HighlightMethodUtil.class);
private HighlightMethodUtil() { }
@NotNull
static String createClashMethodMessage(@NotNull PsiMethod method1, @NotNull PsiMethod method2, boolean showContainingClasses) {
if (showContainingClasses) {
PsiClass class1 = method1.getContainingClass();
PsiClass class2 = method2.getContainingClass();
if (class1 != null && class2 != null) {
return JavaErrorBundle.message("clash.methods.message.show.classes",
JavaHighlightUtil.formatMethod(method1),
JavaHighlightUtil.formatMethod(method2),
HighlightUtil.formatClass(class1),
HighlightUtil.formatClass(class2));
}
}
return JavaErrorBundle.message("clash.methods.message",
JavaHighlightUtil.formatMethod(method1),
JavaHighlightUtil.formatMethod(method2));
}
static HighlightInfo checkMethodWeakerPrivileges(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo,
@NotNull PsiFile containingFile) {
PsiMethod method = methodSignature.getMethod();
PsiModifierList modifierList = method.getModifierList();
if (modifierList.hasModifierProperty(PsiModifier.PUBLIC)) return null;
int accessLevel = PsiUtil.getAccessLevel(modifierList);
String accessModifier = PsiUtil.getAccessModifier(accessLevel);
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
if (method.hasModifierProperty(PsiModifier.ABSTRACT) && !MethodSignatureUtil.isSuperMethod(superMethod, method)) continue;
if (!PsiUtil.isAccessible(containingFile.getProject(), superMethod, method, null)) continue;
if (!includeRealPositionInfo && MethodSignatureUtil.isSuperMethod(superMethod, method)) continue;
HighlightInfo info = isWeaker(method, modifierList, accessModifier, accessLevel, superMethod, includeRealPositionInfo);
if (info != null) return info;
}
return null;
}
private static HighlightInfo isWeaker(@NotNull PsiMethod method,
@NotNull PsiModifierList modifierList,
@NotNull String accessModifier,
int accessLevel,
@NotNull PsiMethod superMethod,
boolean includeRealPositionInfo) {
int superAccessLevel = PsiUtil.getAccessLevel(superMethod.getModifierList());
if (accessLevel < superAccessLevel) {
String description = JavaErrorBundle.message("weaker.privileges",
createClashMethodMessage(method, superMethod, true),
VisibilityUtil.toPresentableText(accessModifier),
PsiUtil.getAccessModifier(superAccessLevel));
TextRange textRange = TextRange.EMPTY_RANGE;
if (includeRealPositionInfo) {
PsiElement keyword = PsiUtil.findModifierInList(modifierList, accessModifier);
if (keyword != null) {
textRange = keyword.getTextRange();
}
else {
// in case of package-private or some crazy third-party plugin where some access modifier implied even if it's absent
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier != null) {
textRange = identifier.getTextRange();
}
}
}
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
QuickFixAction.registerQuickFixAction(info, null, QUICK_FIX_FACTORY.createChangeModifierFix());
return info;
}
return null;
}
static HighlightInfo checkMethodIncompatibleReturnType(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo) {
return checkMethodIncompatibleReturnType(methodSignature, superMethodSignatures, includeRealPositionInfo, null);
}
static HighlightInfo checkMethodIncompatibleReturnType(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo,
@Nullable TextRange textRange) {
PsiMethod method = methodSignature.getMethod();
PsiType returnType = methodSignature.getSubstitutor().substitute(method.getReturnType());
PsiClass aClass = method.getContainingClass();
if (aClass == null) return null;
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
PsiType declaredReturnType = superMethod.getReturnType();
PsiType superReturnType = declaredReturnType;
if (superMethodSignature.isRaw()) superReturnType = TypeConversionUtil.erasure(declaredReturnType);
if (returnType == null || superReturnType == null || method == superMethod) continue;
PsiClass superClass = superMethod.getContainingClass();
if (superClass == null) continue;
if (textRange == null && includeRealPositionInfo) {
PsiTypeElement typeElement = method.getReturnTypeElement();
if (typeElement != null) {
textRange = typeElement.getTextRange();
}
}
if (textRange == null) {
textRange = TextRange.EMPTY_RANGE;
}
HighlightInfo info = checkSuperMethodSignature(
superMethod, superMethodSignature, superReturnType, method, methodSignature, returnType,
JavaErrorBundle.message("incompatible.return.type"), textRange, PsiUtil.getLanguageLevel(aClass));
if (info != null) return info;
}
return null;
}
private static HighlightInfo checkSuperMethodSignature(@NotNull PsiMethod superMethod,
@NotNull MethodSignatureBackedByPsiMethod superMethodSignature,
@NotNull PsiType superReturnType,
@NotNull PsiMethod method,
@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull PsiType returnType,
@NotNull String detailMessage,
@NotNull TextRange range,
@NotNull LanguageLevel languageLevel) {
final PsiClass superContainingClass = superMethod.getContainingClass();
if (superContainingClass != null &&
CommonClassNames.JAVA_LANG_OBJECT.equals(superContainingClass.getQualifiedName()) &&
!superMethod.hasModifierProperty(PsiModifier.PUBLIC)) {
final PsiClass containingClass = method.getContainingClass();
if (containingClass != null && containingClass.isInterface() && !superContainingClass.isInterface()) {
return null;
}
}
PsiType substitutedSuperReturnType;
final boolean isJdk15 = languageLevel.isAtLeast(LanguageLevel.JDK_1_5);
if (isJdk15 && !superMethodSignature.isRaw() && superMethodSignature.equals(methodSignature)) { //see 8.4.5
PsiSubstitutor unifyingSubstitutor = MethodSignatureUtil.getSuperMethodSignatureSubstitutor(methodSignature,
superMethodSignature);
substitutedSuperReturnType = unifyingSubstitutor == null
? superReturnType
: unifyingSubstitutor.substitute(superReturnType);
}
else {
substitutedSuperReturnType = TypeConversionUtil.erasure(superMethodSignature.getSubstitutor().substitute(superReturnType));
}
if (returnType.equals(substitutedSuperReturnType)) return null;
if (!(returnType instanceof PsiPrimitiveType) && substitutedSuperReturnType.getDeepComponentType() instanceof PsiClassType) {
if (isJdk15 && LambdaUtil.performWithSubstitutedParameterBounds(methodSignature.getTypeParameters(),
methodSignature.getSubstitutor(),
() -> TypeConversionUtil.isAssignable(substitutedSuperReturnType, returnType))) {
return null;
}
}
return createIncompatibleReturnTypeMessage(method, superMethod, substitutedSuperReturnType, returnType, detailMessage, range);
}
private static HighlightInfo createIncompatibleReturnTypeMessage(@NotNull PsiMethod method,
@NotNull PsiMethod superMethod,
@NotNull PsiType substitutedSuperReturnType,
@NotNull PsiType returnType,
@NotNull String detailMessage,
@NotNull TextRange textRange) {
String description = MessageFormat.format("{0}; {1}", createClashMethodMessage(method, superMethod, true), detailMessage);
HighlightInfo errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(
description).create();
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createMethodReturnFix(method, substitutedSuperReturnType, false));
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createSuperMethodReturnFix(superMethod, returnType));
final PsiClass returnClass = PsiUtil.resolveClassInClassTypeOnly(returnType);
if (returnClass != null && substitutedSuperReturnType instanceof PsiClassType) {
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createChangeParameterClassFix(returnClass, (PsiClassType)substitutedSuperReturnType));
}
return errorResult;
}
static HighlightInfo checkMethodOverridesFinal(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures) {
PsiMethod method = methodSignature.getMethod();
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
HighlightInfo info = checkSuperMethodIsFinal(method, superMethod);
if (info != null) return info;
}
return null;
}
private static HighlightInfo checkSuperMethodIsFinal(@NotNull PsiMethod method, @NotNull PsiMethod superMethod) {
// strange things happen when super method is from Object and method from interface
if (superMethod.hasModifierProperty(PsiModifier.FINAL)) {
PsiClass superClass = superMethod.getContainingClass();
String description = JavaErrorBundle.message("final.method.override",
JavaHighlightUtil.formatMethod(method),
JavaHighlightUtil.formatMethod(superMethod),
superClass != null ? HighlightUtil.formatClass(superClass) : "<unknown>");
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
HighlightInfo errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
QuickFixAction.registerQuickFixActions(errorResult, null, JvmElementActionFactories.createModifierActions(superMethod, MemberRequestsKt.modifierRequest(JvmModifier.FINAL, false)));
return errorResult;
}
return null;
}
static HighlightInfo checkMethodIncompatibleThrows(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo,
@NotNull PsiClass analyzedClass) {
PsiMethod method = methodSignature.getMethod();
PsiClass aClass = method.getContainingClass();
if (aClass == null) return null;
PsiSubstitutor superSubstitutor = TypeConversionUtil.getSuperClassSubstitutor(aClass, analyzedClass, PsiSubstitutor.EMPTY);
PsiClassType[] exceptions = method.getThrowsList().getReferencedTypes();
PsiJavaCodeReferenceElement[] referenceElements;
List<PsiElement> exceptionContexts;
if (includeRealPositionInfo) {
exceptionContexts = new ArrayList<>();
referenceElements = method.getThrowsList().getReferenceElements();
}
else {
exceptionContexts = null;
referenceElements = null;
}
List<PsiClassType> checkedExceptions = new ArrayList<>();
for (int i = 0; i < exceptions.length; i++) {
PsiClassType exception = exceptions[i];
if (exception == null) {
LOG.error("throws: " + method.getThrowsList().getText() + "; method: " + method);
}
else if (!ExceptionUtil.isUncheckedException(exception)) {
checkedExceptions.add(exception);
if (includeRealPositionInfo && i < referenceElements.length) {
PsiJavaCodeReferenceElement exceptionRef = referenceElements[i];
exceptionContexts.add(exceptionRef);
}
}
}
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
int index = getExtraExceptionNum(methodSignature, superMethodSignature, checkedExceptions, superSubstitutor);
if (index != -1) {
if (aClass.isInterface()) {
final PsiClass superContainingClass = superMethod.getContainingClass();
if (superContainingClass != null && !superContainingClass.isInterface()) continue;
if (superContainingClass != null && !aClass.isInheritor(superContainingClass, true)) continue;
}
PsiClassType exception = checkedExceptions.get(index);
String description = JavaErrorBundle.message("overridden.method.does.not.throw",
createClashMethodMessage(method, superMethod, true),
JavaHighlightUtil.formatType(exception));
TextRange textRange;
if (includeRealPositionInfo) {
PsiElement exceptionContext = exceptionContexts.get(index);
textRange = exceptionContext.getTextRange();
}
else {
textRange = TextRange.EMPTY_RANGE;
}
HighlightInfo errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
QuickFixAction.registerQuickFixAction(errorResult, new LocalQuickFixOnPsiElementAsIntentionAdapter(QUICK_FIX_FACTORY.createMethodThrowsFix(method, exception, false, false)));
QuickFixAction.registerQuickFixAction(errorResult, new LocalQuickFixOnPsiElementAsIntentionAdapter(QUICK_FIX_FACTORY.createMethodThrowsFix(superMethod, exception, true, true)));
return errorResult;
}
}
return null;
}
// return number of exception which was not declared in super method or -1
private static int getExtraExceptionNum(@NotNull MethodSignature methodSignature,
@NotNull MethodSignatureBackedByPsiMethod superSignature,
@NotNull List<? extends PsiClassType> checkedExceptions,
@NotNull PsiSubstitutor substitutorForDerivedClass) {
PsiMethod superMethod = superSignature.getMethod();
PsiSubstitutor substitutorForMethod = MethodSignatureUtil.getSuperMethodSignatureSubstitutor(methodSignature, superSignature);
for (int i = 0; i < checkedExceptions.size(); i++) {
final PsiClassType checkedEx = checkedExceptions.get(i);
final PsiType substituted = substitutorForMethod == null ? TypeConversionUtil.erasure(checkedEx) : substitutorForMethod.substitute(checkedEx);
PsiType exception = substitutorForDerivedClass.substitute(substituted);
if (!isMethodThrows(superMethod, substitutorForMethod, exception, substitutorForDerivedClass)) {
return i;
}
}
return -1;
}
private static boolean isMethodThrows(@NotNull PsiMethod method,
@Nullable PsiSubstitutor substitutorForMethod,
PsiType exception,
@NotNull PsiSubstitutor substitutorForDerivedClass) {
PsiClassType[] thrownExceptions = method.getThrowsList().getReferencedTypes();
for (PsiClassType thrownException1 : thrownExceptions) {
PsiType thrownException = substitutorForMethod != null ? substitutorForMethod.substitute(thrownException1) : TypeConversionUtil.erasure(thrownException1);
thrownException = substitutorForDerivedClass.substitute(thrownException);
if (TypeConversionUtil.isAssignable(thrownException, exception)) return true;
}
return false;
}
static void checkMethodCall(@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull LanguageLevel languageLevel,
@NotNull JavaSdkVersion javaSdkVersion,
@NotNull PsiFile file,
HighlightInfoHolder holder) {
PsiExpressionList list = methodCall.getArgumentList();
PsiReferenceExpression referenceToMethod = methodCall.getMethodExpression();
JavaResolveResult[] results = referenceToMethod.multiResolve(true);
JavaResolveResult resolveResult = results.length == 1 ? results[0] : JavaResolveResult.EMPTY;
PsiElement resolved = resolveResult.getElement();
boolean isDummy = isDummyConstructorCall(methodCall, resolveHelper, list, referenceToMethod);
if (isDummy) return;
HighlightInfo highlightInfo;
final PsiSubstitutor substitutor = resolveResult.getSubstitutor();
if (resolved instanceof PsiMethod && resolveResult.isValidResult()) {
PsiElement nameElement = referenceToMethod.getReferenceNameElement();
TextRange fixRange = getFixRange(methodCall);
highlightInfo = HighlightUtil.checkUnhandledExceptions(methodCall, nameElement != null ? nameElement.getTextRange() : fixRange);
if (highlightInfo == null && ((PsiMethod)resolved).hasModifierProperty(PsiModifier.STATIC)) {
PsiClass containingClass = ((PsiMethod)resolved).getContainingClass();
if (containingClass != null && containingClass.isInterface()) {
PsiElement element = ObjectUtils.notNull(referenceToMethod.getReferenceNameElement(), referenceToMethod);
highlightInfo = HighlightUtil.checkFeature(element, HighlightingFeature.STATIC_INTERFACE_CALLS, languageLevel, file);
if (highlightInfo == null) {
highlightInfo =
checkStaticInterfaceCallQualifier(referenceToMethod, resolveResult, fixRange, containingClass);
}
}
}
if (highlightInfo == null) {
highlightInfo = GenericsHighlightUtil.checkInferredIntersections(substitutor, fixRange);
}
if (highlightInfo == null) {
highlightInfo = checkVarargParameterErasureToBeAccessible((MethodCandidateInfo)resolveResult, methodCall);
}
if (highlightInfo == null) {
highlightInfo = createIncompatibleTypeHighlightInfo(methodCall, resolveHelper, (MethodCandidateInfo)resolveResult, fixRange);
}
}
else {
PsiMethod resolvedMethod = null;
MethodCandidateInfo candidateInfo = null;
if (resolveResult instanceof MethodCandidateInfo) {
candidateInfo = (MethodCandidateInfo)resolveResult;
resolvedMethod = candidateInfo.getElement();
}
if (!resolveResult.isAccessible() || !resolveResult.isStaticsScopeCorrect()) {
highlightInfo = null;
}
else if (candidateInfo != null && !candidateInfo.isApplicable()) {
if (candidateInfo.isTypeArgumentsApplicable()) {
highlightInfo = createIncompatibleCallHighlightInfo(holder, list, candidateInfo);
if (highlightInfo != null) {
registerMethodCallIntentions(highlightInfo, methodCall, list, resolveHelper);
registerMethodReturnFixAction(highlightInfo, candidateInfo, methodCall);
registerTargetTypeFixesBasedOnApplicabilityInference(methodCall, candidateInfo, resolvedMethod, highlightInfo);
holder.add(highlightInfo);
return;
}
}
else {
PsiReferenceParameterList typeArgumentList = methodCall.getTypeArgumentList();
PsiSubstitutor applicabilitySubstitutor = candidateInfo.getSubstitutor(false);
if (typeArgumentList.getTypeArguments().length == 0 && resolvedMethod.hasTypeParameters()) {
highlightInfo = GenericsHighlightUtil.checkInferredTypeArguments(resolvedMethod, methodCall, applicabilitySubstitutor);
}
else {
highlightInfo = GenericsHighlightUtil.checkParameterizedReferenceTypeArguments(resolved, referenceToMethod, applicabilitySubstitutor, javaSdkVersion);
}
}
}
else {
String description = JavaErrorBundle.message("method.call.expected");
highlightInfo =
HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCall).descriptionAndTooltip(description).create();
if (resolved instanceof PsiClass) {
QuickFixAction.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createInsertNewFix(methodCall, (PsiClass)resolved));
}
else {
TextRange range = getFixRange(methodCall);
registerUsageFixes(methodCall, highlightInfo, range);
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.createStaticImportMethodFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.createQualifyStaticMethodCallFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.addMethodQualifierFix(methodCall));
if (resolved instanceof PsiVariable && languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
PsiMethod method = LambdaUtil.getFunctionalInterfaceMethod(((PsiVariable)resolved).getType());
if (method != null) {
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.createInsertMethodCallFix(methodCall, method));
}
}
}
}
}
if (highlightInfo == null) {
highlightInfo = GenericsHighlightUtil.checkParameterizedReferenceTypeArguments(resolved, referenceToMethod, substitutor, javaSdkVersion);
}
holder.add(highlightInfo);
}
/**
* collect highlightInfos per each wrong argument; fixes would be set for the first one with fixRange: methodCall
* @return highlight info for the first wrong arg expression
*/
private static HighlightInfo createIncompatibleCallHighlightInfo(HighlightInfoHolder holder,
PsiExpressionList list,
@NotNull MethodCandidateInfo candidateInfo) {
PsiMethod resolvedMethod = candidateInfo.getElement();
PsiSubstitutor substitutor = candidateInfo.getSubstitutor();
String methodName = HighlightMessageUtil.getSymbolName(resolvedMethod, substitutor);
PsiClass parent = resolvedMethod.getContainingClass();
String containerName = parent == null ? "" : HighlightMessageUtil.getSymbolName(parent, substitutor);
String argTypes = buildArgTypesList(list);
String description = JavaErrorBundle.message("wrong.method.arguments", methodName, containerName, argTypes);
String toolTip = null;
List<PsiExpression> mismatchedExpressions;
if (parent != null) {
final PsiExpression[] expressions = list.getExpressions();
final PsiParameter[] parameters = resolvedMethod.getParameterList().getParameters();
mismatchedExpressions = mismatchedArgs(expressions, substitutor, parameters, candidateInfo.isVarargs());
if (mismatchedExpressions.size() == 1) {
toolTip = createOneArgMismatchTooltip(candidateInfo, mismatchedExpressions, expressions, parameters);
}
if (toolTip == null) {
toolTip = createMismatchedArgumentsHtmlTooltip(candidateInfo, list);
}
}
else {
mismatchedExpressions = Collections.emptyList();
toolTip = description;
}
if (mismatchedExpressions.size() == list.getExpressions().length || mismatchedExpressions.isEmpty()) {
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(list).description(description).escapedToolTip(toolTip).navigationShift(1).create();
}
else {
HighlightInfo highlightInfo = null;
for (PsiExpression wrongArg : mismatchedExpressions) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(wrongArg)
.description(description)
.escapedToolTip(toolTip).create();
if (highlightInfo == null) {
highlightInfo = info;
}
else {
holder.add(info);
}
}
return highlightInfo;
}
}
private static String createOneArgMismatchTooltip(MethodCandidateInfo candidateInfo,
@NotNull List<? extends PsiExpression> mismatchedExpressions,
PsiExpression[] expressions,
PsiParameter[] parameters) {
final PsiExpression wrongArg = mismatchedExpressions.get(0);
final PsiType argType = wrongArg.getType();
if (argType != null) {
boolean varargs = candidateInfo.getApplicabilityLevel() == MethodCandidateInfo.ApplicabilityLevel.VARARGS;
int idx = ArrayUtil.find(expressions, wrongArg);
PsiType paramType = candidateInfo.getSubstitutor().substitute(PsiTypesUtil.getParameterType(parameters, idx, varargs));
String errorMessage = candidateInfo.getInferenceErrorMessage();
String reason = errorMessage != null ? "<table><tr><td style='padding-left: 4px; padding-top: 10;'>" +
"reason: " + XmlStringUtil.escapeString(errorMessage).replaceAll("\n", "<br/>") +
"</td></tr></table>"
: "";
return HighlightUtil.createIncompatibleTypesTooltip(paramType, argType,
(lRawType, lTypeArguments, rRawType, rTypeArguments) ->
JavaErrorBundle
.message("incompatible.types.html.tooltip", lRawType, lTypeArguments, rRawType, rTypeArguments, reason, "#" + ColorUtil.toHex(UIUtil.getContextHelpForeground())));
}
return null;
}
static HighlightInfo createIncompatibleTypeHighlightInfo(@NotNull PsiCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull MethodCandidateInfo resolveResult,
TextRange fixRange) {
String errorMessage = resolveResult.getInferenceErrorMessage();
if (errorMessage == null) return null;
PsiMethod method = resolveResult.getElement();
HighlightInfo highlightInfo;
PsiType expectedTypeByParent = InferenceSession.getTargetTypeByParent(methodCall);
PsiType actualType = resolveResult.getSubstitutor(false).substitute(method.getReturnType());
if (expectedTypeByParent != null && actualType != null && !expectedTypeByParent.isAssignableFrom(actualType)) {
highlightInfo = HighlightUtil
.createIncompatibleTypeHighlightInfo(expectedTypeByParent, actualType, fixRange, 0, XmlStringUtil.escapeString(errorMessage));
}
else {
highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).descriptionAndTooltip(errorMessage).range(fixRange).create();
}
if (highlightInfo != null && methodCall instanceof PsiMethodCallExpression) {
registerMethodCallIntentions(highlightInfo, (PsiMethodCallExpression)methodCall, ((PsiMethodCallExpression)methodCall).getArgumentList(), resolveHelper);
registerMethodReturnFixAction(highlightInfo, resolveResult, methodCall);
registerTargetTypeFixesBasedOnApplicabilityInference((PsiMethodCallExpression)methodCall, resolveResult, method, highlightInfo);
}
return highlightInfo;
}
private static void registerUsageFixes(@NotNull PsiMethodCallExpression methodCall,
@Nullable HighlightInfo highlightInfo,
@NotNull TextRange range) {
for (IntentionAction action : QUICK_FIX_FACTORY.createCreateMethodFromUsageFixes(methodCall)) {
QuickFixAction.registerQuickFixAction(highlightInfo, range, action);
}
}
private static void registerThisSuperFixes(@NotNull PsiMethodCallExpression methodCall,
@Nullable HighlightInfo highlightInfo,
@NotNull TextRange range) {
for (IntentionAction action : QUICK_FIX_FACTORY.createCreateConstructorFromCallExpressionFixes(methodCall)) {
QuickFixAction.registerQuickFixAction(highlightInfo, range, action);
}
}
private static void registerTargetTypeFixesBasedOnApplicabilityInference(@NotNull PsiMethodCallExpression methodCall,
@NotNull MethodCandidateInfo resolveResult,
@NotNull PsiMethod resolved,
HighlightInfo highlightInfo) {
PsiElement parent = PsiUtil.skipParenthesizedExprUp(methodCall.getParent());
PsiVariable variable = null;
if (parent instanceof PsiVariable) {
variable = (PsiVariable)parent;
}
else if (parent instanceof PsiAssignmentExpression) {
PsiExpression lExpression = ((PsiAssignmentExpression)parent).getLExpression();
if (lExpression instanceof PsiReferenceExpression) {
PsiElement resolve = ((PsiReferenceExpression)lExpression).resolve();
if (resolve instanceof PsiVariable) {
variable = (PsiVariable)resolve;
}
}
}
if (variable != null) {
PsiType rType = methodCall.getType();
if (rType != null && !variable.getType().isAssignableFrom(rType)) {
PsiType expectedTypeByApplicabilityConstraints = resolveResult.getSubstitutor(false).substitute(resolved.getReturnType());
if (expectedTypeByApplicabilityConstraints != null && !variable.getType().isAssignableFrom(expectedTypeByApplicabilityConstraints) &&
PsiTypesUtil.allTypeParametersResolved(variable, expectedTypeByApplicabilityConstraints)) {
HighlightFixUtil.registerChangeVariableTypeFixes(variable, expectedTypeByApplicabilityConstraints, methodCall, highlightInfo);
}
}
}
}
static HighlightInfo checkStaticInterfaceCallQualifier(@NotNull PsiReferenceExpression referenceToMethod,
@NotNull JavaResolveResult resolveResult,
@NotNull TextRange fixRange,
@NotNull PsiClass containingClass) {
String message = checkStaticInterfaceMethodCallQualifier(referenceToMethod, resolveResult.getCurrentFileResolveScope(), containingClass);
if (message != null) {
HighlightInfo highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).descriptionAndTooltip(message).range(fixRange).create();
QuickFixAction
.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createAccessStaticViaInstanceFix(referenceToMethod, resolveResult));
return highlightInfo;
}
return null;
}
/* see also PsiReferenceExpressionImpl.hasValidQualifier() */
private static String checkStaticInterfaceMethodCallQualifier(@NotNull PsiReferenceExpression ref,
@Nullable PsiElement scope,
@NotNull PsiClass containingClass) {
PsiExpression qualifierExpression = ref.getQualifierExpression();
if (qualifierExpression == null && (scope instanceof PsiImportStaticStatement || PsiTreeUtil.isAncestor(containingClass, ref, true))) {
return null;
}
if (qualifierExpression instanceof PsiReferenceExpression) {
PsiElement resolve = ((PsiReferenceExpression)qualifierExpression).resolve();
if (containingClass.getManager().areElementsEquivalent(resolve, containingClass)) {
return null;
}
if (resolve instanceof PsiTypeParameter) {
Set<PsiClass> classes = new HashSet<>();
for (PsiClassType type : ((PsiTypeParameter)resolve).getExtendsListTypes()) {
PsiClass aClass = type.resolve();
if (aClass != null) {
classes.add(aClass);
}
}
if (classes.size() == 1 && classes.contains(containingClass)) {
return null;
}
}
}
return JavaErrorBundle.message("static.interface.method.call.qualifier");
}
private static void registerMethodReturnFixAction(@NotNull HighlightInfo highlightInfo,
@NotNull MethodCandidateInfo candidate,
@NotNull PsiCall methodCall) {
if (methodCall.getParent() instanceof PsiReturnStatement) {
final PsiMethod containerMethod = PsiTreeUtil.getParentOfType(methodCall, PsiMethod.class, true, PsiLambdaExpression.class);
if (containerMethod != null) {
final PsiMethod method = candidate.getElement();
final PsiExpression methodCallCopy =
JavaPsiFacade.getElementFactory(method.getProject()).createExpressionFromText(methodCall.getText(), methodCall);
PsiType methodCallTypeByArgs = methodCallCopy.getType();
//ensure type params are not included
methodCallTypeByArgs = JavaPsiFacade.getElementFactory(method.getProject())
.createRawSubstitutor(method).substitute(methodCallTypeByArgs);
if (methodCallTypeByArgs != null) {
QuickFixAction.registerQuickFixAction(highlightInfo,
getFixRange(methodCall),
QUICK_FIX_FACTORY.createMethodReturnFix(containerMethod, methodCallTypeByArgs, true));
}
}
}
}
@NotNull
private static List<PsiExpression> mismatchedArgs(PsiExpression @NotNull [] expressions,
PsiSubstitutor substitutor,
PsiParameter @NotNull [] parameters,
boolean varargs) {
if ((parameters.length == 0 || !parameters[parameters.length - 1].isVarArgs()) && parameters.length != expressions.length) {
return Collections.emptyList();
}
List<PsiExpression> result = new ArrayList<>();
for (int i = 0; i < Math.max(parameters.length, expressions.length); i++) {
if (!assignmentCompatible(i, parameters, expressions, substitutor, varargs)) {
result.add(i < expressions.length ? expressions[i] : null);
}
}
return result;
}
static boolean isDummyConstructorCall(@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull PsiExpressionList list,
@NotNull PsiReferenceExpression referenceToMethod) {
boolean isDummy = false;
boolean isThisOrSuper = referenceToMethod.getReferenceNameElement() instanceof PsiKeyword;
if (isThisOrSuper) {
// super(..) or this(..)
if (list.isEmpty()) { // implicit ctr call
CandidateInfo[] candidates = resolveHelper.getReferencedMethodCandidates(methodCall, true);
if (candidates.length == 1 && !candidates[0].getElement().isPhysical()) {
isDummy = true;// dummy constructor
}
}
}
return isDummy;
}
static HighlightInfo checkAmbiguousMethodCallIdentifier(@NotNull PsiReferenceExpression referenceToMethod,
JavaResolveResult @NotNull [] resolveResults,
@NotNull PsiExpressionList list,
@Nullable PsiElement element,
@NotNull JavaResolveResult resolveResult,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull LanguageLevel languageLevel,
@NotNull PsiFile file) {
MethodCandidateInfo methodCandidate2 = findCandidates(resolveResults).second;
if (methodCandidate2 != null) return null;
MethodCandidateInfo[] candidates = toMethodCandidates(resolveResults);
HighlightInfoType highlightInfoType = HighlightInfoType.ERROR;
String description;
PsiElement elementToHighlight = ObjectUtils.notNull(referenceToMethod.getReferenceNameElement(), referenceToMethod);
if (element != null && !resolveResult.isAccessible()) {
description = HighlightUtil.accessProblemDescription(referenceToMethod, element, resolveResult);
}
else if (element != null && !resolveResult.isStaticsScopeCorrect()) {
if (element instanceof PsiMethod && ((PsiMethod)element).hasModifierProperty(PsiModifier.STATIC)) {
PsiClass containingClass = ((PsiMethod)element).getContainingClass();
if (containingClass != null && containingClass.isInterface()) {
HighlightInfo info = HighlightUtil.checkFeature(elementToHighlight, HighlightingFeature.STATIC_INTERFACE_CALLS, languageLevel, file);
if (info != null) return info;
info = checkStaticInterfaceCallQualifier(referenceToMethod, resolveResult, elementToHighlight.getTextRange(), containingClass);
if (info != null) return info;
}
}
description = HighlightUtil.staticContextProblemDescription(element);
}
else if (candidates.length == 0) {
PsiClass qualifierClass = RefactoringChangeUtil.getQualifierClass(referenceToMethod);
String qualifier = qualifierClass != null ? qualifierClass.getName() : null;
description = qualifier != null ? JavaErrorBundle
.message("ambiguous.method.call.no.match", referenceToMethod.getReferenceName(), qualifier)
: JavaErrorBundle
.message("cannot.resolve.method", referenceToMethod.getReferenceName() + buildArgTypesList(list));
highlightInfoType = HighlightInfoType.WRONG_REF;
}
else {
return null;
}
String toolTip = XmlStringUtil.escapeString(description);
HighlightInfo info =
HighlightInfo.newHighlightInfo(highlightInfoType).range(elementToHighlight).description(description).escapedToolTip(toolTip).create();
registerMethodCallIntentions(info, methodCall, list, resolveHelper);
if (element != null && !resolveResult.isStaticsScopeCorrect()) {
HighlightFixUtil.registerStaticProblemQuickFixAction(element, info, referenceToMethod);
}
TextRange fixRange = getFixRange(elementToHighlight);
CastMethodArgumentFix.REGISTRAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapObjectWithOptionalOfNullableFix.REGISTAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapWithAdapterMethodCallFix.registerCastActions(candidates, methodCall, info, fixRange);
PermuteArgumentsFix.registerFix(info, methodCall, candidates, fixRange);
WrapExpressionFix.registerWrapAction(candidates, list.getExpressions(), info, fixRange);
registerChangeParameterClassFix(methodCall, list, info);
if (candidates.length == 0) {
UnresolvedReferenceQuickFixProvider.registerReferenceFixes(methodCall.getMethodExpression(), new QuickFixActionRegistrarImpl(info));
}
return info;
}
static HighlightInfo checkAmbiguousMethodCallArguments(@NotNull PsiReferenceExpression referenceToMethod,
JavaResolveResult @NotNull [] resolveResults,
@NotNull PsiExpressionList list,
final PsiElement element,
@NotNull JavaResolveResult resolveResult,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull PsiElement elementToHighlight) {
Pair<MethodCandidateInfo, MethodCandidateInfo> pair = findCandidates(resolveResults);
MethodCandidateInfo methodCandidate1 = pair.first;
MethodCandidateInfo methodCandidate2 = pair.second;
MethodCandidateInfo[] candidates = toMethodCandidates(resolveResults);
String description;
String toolTip;
HighlightInfoType highlightInfoType = HighlightInfoType.ERROR;
if (methodCandidate2 != null) {
PsiMethod element1 = methodCandidate1.getElement();
String m1 = PsiFormatUtil.formatMethod(element1,
methodCandidate1.getSubstitutor(false),
PsiFormatUtilBase.SHOW_CONTAINING_CLASS | PsiFormatUtilBase.SHOW_NAME |
PsiFormatUtilBase.SHOW_PARAMETERS,
PsiFormatUtilBase.SHOW_TYPE);
PsiMethod element2 = methodCandidate2.getElement();
String m2 = PsiFormatUtil.formatMethod(element2,
methodCandidate2.getSubstitutor(false),
PsiFormatUtilBase.SHOW_CONTAINING_CLASS | PsiFormatUtilBase.SHOW_NAME |
PsiFormatUtilBase.SHOW_PARAMETERS,
PsiFormatUtilBase.SHOW_TYPE);
VirtualFile virtualFile1 = PsiUtilCore.getVirtualFile(element1);
VirtualFile virtualFile2 = PsiUtilCore.getVirtualFile(element2);
if (!Comparing.equal(virtualFile1, virtualFile2)) {
if (virtualFile1 != null) m1 += " (In " + virtualFile1.getPresentableUrl() + ")";
if (virtualFile2 != null) m2 += " (In " + virtualFile2.getPresentableUrl() + ")";
}
description = JavaErrorBundle.message("ambiguous.method.call", m1, m2);
toolTip = createAmbiguousMethodHtmlTooltip(new MethodCandidateInfo[]{methodCandidate1, methodCandidate2});
}
else {
if (element != null && !resolveResult.isAccessible()) {
return null;
}
if (element != null && !resolveResult.isStaticsScopeCorrect()) {
return null;
}
String methodName = referenceToMethod.getReferenceName() + buildArgTypesList(list);
description = JavaErrorBundle.message("cannot.resolve.method", methodName);
if (candidates.length == 0) {
return null;
}
toolTip = XmlStringUtil.escapeString(description);
}
HighlightInfo info =
HighlightInfo.newHighlightInfo(highlightInfoType).range(elementToHighlight).description(description).escapedToolTip(toolTip).create();
if (methodCandidate2 == null) {
registerMethodCallIntentions(info, methodCall, list, resolveHelper);
}
if (!resolveResult.isAccessible() && resolveResult.isStaticsScopeCorrect() && methodCandidate2 != null) {
HighlightFixUtil.registerAccessQuickFixAction((PsiJvmMember)element, referenceToMethod, info, resolveResult.getCurrentFileResolveScope());
}
if (element != null && !resolveResult.isStaticsScopeCorrect()) {
HighlightFixUtil.registerStaticProblemQuickFixAction(element, info, referenceToMethod);
}
TextRange fixRange = getFixRange(elementToHighlight);
CastMethodArgumentFix.REGISTRAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapObjectWithOptionalOfNullableFix.REGISTAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapWithAdapterMethodCallFix.registerCastActions(candidates, methodCall, info, fixRange);
PermuteArgumentsFix.registerFix(info, methodCall, candidates, fixRange);
WrapExpressionFix.registerWrapAction(candidates, list.getExpressions(), info, fixRange);
registerChangeParameterClassFix(methodCall, list, info);
return info;
}
@NotNull
private static Pair<MethodCandidateInfo, MethodCandidateInfo> findCandidates(JavaResolveResult @NotNull [] resolveResults) {
MethodCandidateInfo methodCandidate1 = null;
MethodCandidateInfo methodCandidate2 = null;
for (JavaResolveResult result : resolveResults) {
if (!(result instanceof MethodCandidateInfo)) continue;
MethodCandidateInfo candidate = (MethodCandidateInfo)result;
if (candidate.isApplicable() && !candidate.getElement().isConstructor()) {
if (methodCandidate1 == null) {
methodCandidate1 = candidate;
}
else {
methodCandidate2 = candidate;
break;
}
}
}
return Pair.pair(methodCandidate1, methodCandidate2);
}
private static MethodCandidateInfo @NotNull [] toMethodCandidates(JavaResolveResult @NotNull [] resolveResults) {
List<MethodCandidateInfo> candidateList = new ArrayList<>(resolveResults.length);
for (JavaResolveResult result : resolveResults) {
if (!(result instanceof MethodCandidateInfo)) continue;
MethodCandidateInfo candidate = (MethodCandidateInfo)result;
if (candidate.isAccessible()) candidateList.add(candidate);
}
return candidateList.toArray(new MethodCandidateInfo[0]);
}
private static void registerMethodCallIntentions(@Nullable HighlightInfo highlightInfo,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiExpressionList list,
@NotNull PsiResolveHelper resolveHelper) {
TextRange fixRange = getFixRange(methodCall);
final PsiExpression qualifierExpression = methodCall.getMethodExpression().getQualifierExpression();
if (qualifierExpression instanceof PsiReferenceExpression) {
final PsiElement resolve = ((PsiReferenceExpression)qualifierExpression).resolve();
if (resolve instanceof PsiClass &&
((PsiClass)resolve).getContainingClass() != null &&
!((PsiClass)resolve).hasModifierProperty(PsiModifier.STATIC)) {
QuickFixAction.registerQuickFixActions(highlightInfo, null, JvmElementActionFactories.createModifierActions((PsiClass)resolve, MemberRequestsKt.modifierRequest(JvmModifier.STATIC, true)));
}
}
else if (qualifierExpression instanceof PsiSuperExpression && ((PsiSuperExpression)qualifierExpression).getQualifier() == null) {
QualifySuperArgumentFix.registerQuickFixAction((PsiSuperExpression)qualifierExpression, highlightInfo);
}
registerUsageFixes(methodCall, highlightInfo, fixRange);
registerThisSuperFixes(methodCall, highlightInfo, fixRange);
CandidateInfo[] methodCandidates = resolveHelper.getReferencedMethodCandidates(methodCall, false);
CastMethodArgumentFix.REGISTRAR.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
AddTypeArgumentsFix.REGISTRAR.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
WrapObjectWithOptionalOfNullableFix.REGISTAR.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
MethodReturnFixFactory.INSTANCE.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
WrapWithAdapterMethodCallFix.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
registerMethodAccessLevelIntentions(methodCandidates, methodCall, list, highlightInfo);
if (!PermuteArgumentsFix.registerFix(highlightInfo, methodCall, methodCandidates, fixRange)) {
registerChangeMethodSignatureFromUsageIntentions(methodCandidates, list, highlightInfo, fixRange);
}
RemoveRedundantArgumentsFix.registerIntentions(methodCandidates, list, highlightInfo, fixRange);
ConvertDoubleToFloatFix.registerIntentions(methodCandidates, list, highlightInfo, fixRange);
WrapExpressionFix.registerWrapAction(methodCandidates, list.getExpressions(), highlightInfo, fixRange);
registerChangeParameterClassFix(methodCall, list, highlightInfo);
if (methodCandidates.length == 0) {
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createStaticImportMethodFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createQualifyStaticMethodCallFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.addMethodQualifierFix(methodCall));
}
for (IntentionAction action : QUICK_FIX_FACTORY.getVariableTypeFromCallFixes(methodCall, list)) {
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, action);
}
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createReplaceAddAllArrayToCollectionFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createSurroundWithArrayFix(methodCall, null));
QualifyThisArgumentFix.registerQuickFixAction(methodCandidates, methodCall, highlightInfo, fixRange);
PsiType expectedTypeByParent = PsiTypesUtil.getExpectedTypeByParent(methodCall);
if (expectedTypeByParent != null) {
PsiType methodCallType = methodCall.getType();
if (methodCallType != null &&
TypeConversionUtil.areTypesConvertible(methodCallType, expectedTypeByParent) &&
!TypeConversionUtil.isAssignable(expectedTypeByParent, methodCallType)) {
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createAddTypeCastFix(expectedTypeByParent, methodCall));
}
}
CandidateInfo[] candidates = resolveHelper.getReferencedMethodCandidates(methodCall, true);
ChangeStringLiteralToCharInMethodCallFix.registerFixes(candidates, methodCall, highlightInfo);
}
private static void registerMethodAccessLevelIntentions(CandidateInfo @NotNull [] methodCandidates,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiExpressionList exprList,
@Nullable HighlightInfo highlightInfo) {
for (CandidateInfo methodCandidate : methodCandidates) {
PsiMethod method = (PsiMethod)methodCandidate.getElement();
if (!methodCandidate.isAccessible() && PsiUtil.isApplicable(method, methodCandidate.getSubstitutor(), exprList)) {
HighlightFixUtil.registerAccessQuickFixAction(method, methodCall.getMethodExpression(), highlightInfo, methodCandidate.getCurrentFileResolveScope());
}
}
}
@NotNull
private static String createAmbiguousMethodHtmlTooltip(MethodCandidateInfo @NotNull [] methodCandidates) {
return JavaErrorBundle.message("ambiguous.method.html.tooltip",
methodCandidates[0].getElement().getParameterList().getParametersCount() + 2,
createAmbiguousMethodHtmlTooltipMethodRow(methodCandidates[0]),
getContainingClassName(methodCandidates[0]),
createAmbiguousMethodHtmlTooltipMethodRow(methodCandidates[1]),
getContainingClassName(methodCandidates[1]));
}
@NotNull
private static String getContainingClassName(@NotNull MethodCandidateInfo methodCandidate) {
PsiMethod method = methodCandidate.getElement();
PsiClass containingClass = method.getContainingClass();
return containingClass == null ? method.getContainingFile().getName() : HighlightUtil.formatClass(containingClass, false);
}
@Language("HTML")
@NotNull
private static String createAmbiguousMethodHtmlTooltipMethodRow(@NotNull MethodCandidateInfo methodCandidate) {
PsiMethod method = methodCandidate.getElement();
PsiParameter[] parameters = method.getParameterList().getParameters();
PsiSubstitutor substitutor = methodCandidate.getSubstitutor();
StringBuilder ms = new StringBuilder("<td><b>" + method.getName() + "</b></td>");
for (int j = 0; j < parameters.length; j++) {
PsiParameter parameter = parameters[j];
PsiType type = substitutor.substitute(parameter.getType());
ms.append("<td><b>").append(j == 0 ? "(" : "").append(XmlStringUtil.escapeString(type.getPresentableText()))
.append(j == parameters.length - 1 ? ")" : ",").append("</b></td>");
}
if (parameters.length == 0) {
ms.append("<td><b>()</b></td>");
}
return ms.toString();
}
@NotNull
private static String createMismatchedArgumentsHtmlTooltip(@NotNull MethodCandidateInfo info, @NotNull PsiExpressionList list) {
PsiMethod method = info.getElement();
PsiSubstitutor substitutor = info.getSubstitutor();
PsiParameter[] parameters = method.getParameterList().getParameters();
return createMismatchedArgumentsHtmlTooltip(list, info, parameters, substitutor);
}
@Language("HTML")
@NotNull
private static String createMismatchedArgumentsHtmlTooltip(@NotNull PsiExpressionList list,
@Nullable MethodCandidateInfo info,
PsiParameter @NotNull [] parameters,
@NotNull PsiSubstitutor substitutor) {
PsiExpression[] expressions = list.getExpressions();
if ((parameters.length == 0 || !parameters[parameters.length - 1].isVarArgs()) &&
parameters.length != expressions.length) {
return "<html>Expected " + parameters.length + " arguments but found " + expressions.length + "</html>";
}
String greyedColor = ColorUtil.toHtmlColor(UIUtil.getContextHelpForeground());
StringBuilder s = new StringBuilder("<html><body><table>");
s.append("<tr>");
s.append("<td/>");
s.append("<td style='color: ").append(greyedColor).append("; padding-left: 16px; padding-right: 24px;'>Required type</td>");
s.append("<td style='color: ").append(greyedColor).append("; padding-right: 28px;'>Provided</td>");
s.append("</tr>");
String parameterNameStyle = String.format("color: %s; font-size:%dpt; padding:1px 4px 1px 4px;",
greyedColor,
StartupUiUtil.getLabelFont().getSize() - (SystemInfo.isWindows ? 0 : 1));
Color paramBgColor = EditorColorsUtil.getGlobalOrDefaultColorScheme()
.getAttributes(DefaultLanguageHighlighterColors.INLINE_PARAMETER_HINT)
.getBackgroundColor();
if (paramBgColor != null) {
parameterNameStyle += "background-color: " + ColorUtil.toHtmlColor(paramBgColor) + ";";
}
boolean varargAdded = false;
for (int i = 0; i < Math.max(parameters.length, expressions.length); i++) {
boolean varargs = info != null && info.isVarargs();
if (assignmentCompatible(i, parameters, expressions, substitutor, varargs)) continue;
PsiParameter parameter = null;
if (i < parameters.length) {
parameter = parameters[i];
varargAdded = parameter.isVarArgs();
}
else if (!varargAdded) {
parameter = parameters[parameters.length - 1];
varargAdded = true;
}
PsiType parameterType = substitutor.substitute(PsiTypesUtil.getParameterType(parameters, i, varargs));
PsiExpression expression = i < expressions.length ? expressions[i] : null;
boolean showShortType = HighlightUtil.showShortType(parameterType,
expression != null ? expression.getType() : null);
s.append("<tr>");
if (parameter != null) {
s.append("<td><table><tr><td style='").append(parameterNameStyle).append("'>").append(parameter.getName()).append(":</td></tr></table></td>");
s.append("<td style='padding-left: 16px; padding-right: 24px;'>")
.append(HighlightUtil.redIfNotMatch(substitutor.substitute(parameter.getType()), true, showShortType))
.append("</td>");
}
else {
s.append("<td/>");
s.append("<td style='padding-left: 16px; padding-right: 24px;'/>");
}
if (expression != null) {
s.append("<td style='padding-right: 28px;'>")
.append(mismatchedExpressionType(parameterType, expression))
.append("</td>");
}
else {
s.append("<td style='padding-right: 28px;'/>");
}
s.append("</tr>");
}
s.append("</table>");
String errorMessage = info != null ? info.getInferenceErrorMessage() : null;
if (errorMessage != null) {
s.append("<table><tr><td style='padding-left: 4px; padding-top: 10;'>")
.append("reason: ").append(XmlStringUtil.escapeString(errorMessage).replaceAll("\n", "<br/>"))
.append("</td></tr></table>");
}
s.append("</body></html>");
return s.toString();
}
@NotNull
private static String mismatchedExpressionType(PsiType parameterType, @NotNull PsiExpression expression) {
return HighlightUtil.createIncompatibleTypesTooltip(parameterType, expression.getType(), new HighlightUtil.IncompatibleTypesTooltipComposer() {
@NotNull
@Override
public String consume(@NotNull String lRawType,
@NotNull String lTypeArguments,
@NotNull String rRawType,
@NotNull String rTypeArguments) {
return rRawType + rTypeArguments;
}
@Override
public boolean skipTypeArgsColumns() {
return true;
}
});
}
private static boolean assignmentCompatible(int i,
PsiParameter @NotNull [] parameters,
PsiExpression @NotNull [] expressions,
@NotNull PsiSubstitutor substitutor,
boolean varargs) {
PsiExpression expression = i < expressions.length ? expressions[i] : null;
if (expression == null) return true;
PsiType paramType = substitutor.substitute(PsiTypesUtil.getParameterType(parameters, i, varargs));
return paramType != null && TypeConversionUtil.areTypesAssignmentCompatible(paramType, expression);
}
static HighlightInfo checkMethodMustHaveBody(@NotNull PsiMethod method, @Nullable PsiClass aClass) {
HighlightInfo errorResult = null;
if (method.getBody() == null
&& !method.hasModifierProperty(PsiModifier.ABSTRACT)
&& !method.hasModifierProperty(PsiModifier.NATIVE)
&& aClass != null
&& !aClass.isInterface()
&& !PsiUtilCore.hasErrorElementChild(method)) {
int start = method.getModifierList().getTextRange().getStartOffset();
int end = method.getTextRange().getEndOffset();
String description = JavaErrorBundle.message("missing.method.body");
errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(start, end).descriptionAndTooltip(description).create();
if (HighlightUtil.getIncompatibleModifier(PsiModifier.ABSTRACT, method.getModifierList()) == null && !(aClass instanceof PsiAnonymousClass)) {
QuickFixAction.registerQuickFixActions(errorResult, null, JvmElementActionFactories.createModifierActions(method, MemberRequestsKt.modifierRequest(JvmModifier.ABSTRACT, true)));
}
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createAddMethodBodyFix(method));
}
return errorResult;
}
static HighlightInfo checkAbstractMethodInConcreteClass(@NotNull PsiMethod method, @NotNull PsiElement elementToHighlight) {
HighlightInfo errorResult = null;
PsiClass aClass = method.getContainingClass();
if (method.hasModifierProperty(PsiModifier.ABSTRACT)
&& aClass != null
&& !aClass.hasModifierProperty(PsiModifier.ABSTRACT)
&& !aClass.isEnum()
&& !PsiUtilCore.hasErrorElementChild(method)) {
String description = JavaErrorBundle.message("abstract.method.in.non.abstract.class");
errorResult =
HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(elementToHighlight).descriptionAndTooltip(description).create();
if (method.getBody() != null) {
QuickFixAction.registerQuickFixAction(errorResult,
QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.ABSTRACT, false, false));
}
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createAddMethodBodyFix(method));
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createModifierListFix(aClass, PsiModifier.ABSTRACT, true, false));
}
return errorResult;
}
static HighlightInfo checkConstructorName(@NotNull PsiMethod method) {
PsiClass aClass = method.getContainingClass();
if (aClass != null) {
String className = aClass instanceof PsiAnonymousClass ? null : aClass.getName();
if (className == null || !Comparing.strEqual(method.getName(), className)) {
PsiElement element = ObjectUtils.notNull(method.getNameIdentifier(), method);
String description = JavaErrorBundle.message("missing.return.type");
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(element).descriptionAndTooltip(description).create();
if (className != null) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createRenameElementFix(method, className));
}
return info;
}
}
return null;
}
static HighlightInfo checkDuplicateMethod(@NotNull PsiClass aClass,
@NotNull PsiMethod method,
@NotNull MostlySingularMultiMap<MethodSignature, PsiMethod> duplicateMethods) {
if (method instanceof ExternallyDefinedPsiElement) return null;
MethodSignature methodSignature = method.getSignature(PsiSubstitutor.EMPTY);
int methodCount = 1;
List<PsiMethod> methods = (List<PsiMethod>)duplicateMethods.get(methodSignature);
if (methods.size() > 1) {
methodCount++;
}
if (methodCount == 1 && aClass.isEnum() &&
GenericsHighlightUtil.isEnumSyntheticMethod(methodSignature, aClass.getProject())) {
methodCount++;
}
if (methodCount > 1) {
String description = JavaErrorBundle.message("duplicate.method",
JavaHighlightUtil.formatMethod(method),
HighlightUtil.formatClass(aClass));
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).
range(method, textRange.getStartOffset(), textRange.getEndOffset()).
descriptionAndTooltip(description).create();
}
return null;
}
static HighlightInfo checkMethodCanHaveBody(@NotNull PsiMethod method, @NotNull LanguageLevel languageLevel) {
PsiClass aClass = method.getContainingClass();
boolean hasNoBody = method.getBody() == null;
boolean isInterface = aClass != null && aClass.isInterface();
boolean isExtension = method.hasModifierProperty(PsiModifier.DEFAULT);
boolean isStatic = method.hasModifierProperty(PsiModifier.STATIC);
boolean isPrivate = method.hasModifierProperty(PsiModifier.PRIVATE);
final List<IntentionAction> additionalFixes = new ArrayList<>();
String description = null;
if (hasNoBody) {
if (isExtension) {
description = JavaErrorBundle.message("extension.method.should.have.a.body");
}
else if (isInterface) {
if (isStatic && languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
description = "Static methods in interfaces should have a body";
}
else if (isPrivate && languageLevel.isAtLeast(LanguageLevel.JDK_1_9)) {
description = "Private methods in interfaces should have a body";
}
}
if (description != null) {
additionalFixes.add(QUICK_FIX_FACTORY.createAddMethodBodyFix(method));
}
}
else if (isInterface) {
if (!isExtension && !isStatic && !isPrivate) {
description = JavaErrorBundle.message("interface.methods.cannot.have.body");
if (languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
if (Stream.of(method.findDeepestSuperMethods()).map(PsiMethod::getContainingClass)
.filter(Objects::nonNull).map(PsiClass::getQualifiedName).noneMatch(CommonClassNames.JAVA_LANG_OBJECT::equals)) {
IntentionAction makeDefaultFix = QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.DEFAULT, true, false);
additionalFixes.add(PriorityIntentionActionWrapper.highPriority(makeDefaultFix));
additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.STATIC, true, false));
}
}
}
}
else if (isExtension) {
description = JavaErrorBundle.message("extension.method.in.class");
additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.DEFAULT, false, false));
}
else if (method.hasModifierProperty(PsiModifier.ABSTRACT)) {
description = JavaErrorBundle.message("abstract.methods.cannot.have.a.body");
}
else if (method.hasModifierProperty(PsiModifier.NATIVE)) {
description = JavaErrorBundle.message("native.methods.cannot.have.a.body");
}
if (description == null) return null;
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
if (!hasNoBody) {
if (!isExtension) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createDeleteMethodBodyFix(method));
}
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createPushDownMethodFix());
}
if (method.hasModifierProperty(PsiModifier.ABSTRACT) && !isInterface) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.ABSTRACT, false, false));
}
for (IntentionAction intentionAction : additionalFixes) {
QuickFixAction.registerQuickFixAction(info, intentionAction);
}
return info;
}
static HighlightInfo checkConstructorCallProblems(@NotNull PsiMethodCallExpression methodCall) {
if (!JavaPsiConstructorUtil.isConstructorCall(methodCall)) return null;
PsiElement codeBlock = methodCall.getParent().getParent();
if (codeBlock instanceof PsiCodeBlock) {
PsiMethod ctor = ObjectUtils.tryCast(codeBlock.getParent(), PsiMethod.class);
if (ctor != null && ctor.isConstructor()) {
if (JavaPsiRecordUtil.isCompactConstructor(ctor) ||
JavaPsiRecordUtil.isExplicitCanonicalConstructor(ctor)) {
String message = JavaErrorBundle.message("record.constructor.call.in.canonical");
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCall).descriptionAndTooltip(message).create();
}
PsiElement prevSibling = methodCall.getParent().getPrevSibling();
while (true) {
if (prevSibling == null) return null;
if (prevSibling instanceof PsiStatement) break;
prevSibling = prevSibling.getPrevSibling();
}
}
}
PsiReferenceExpression expression = methodCall.getMethodExpression();
String message = JavaErrorBundle.message("constructor.call.must.be.first.statement", expression.getText() + "()");
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCall).descriptionAndTooltip(message).create();
}
static HighlightInfo checkSuperAbstractMethodDirectCall(@NotNull PsiMethodCallExpression methodCallExpression) {
PsiReferenceExpression expression = methodCallExpression.getMethodExpression();
if (!(expression.getQualifierExpression() instanceof PsiSuperExpression)) return null;
PsiMethod method = methodCallExpression.resolveMethod();
if (method != null && method.hasModifierProperty(PsiModifier.ABSTRACT)) {
String message = JavaErrorBundle.message("direct.abstract.method.access", JavaHighlightUtil.formatMethod(method));
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCallExpression).descriptionAndTooltip(message).create();
}
return null;
}
static HighlightInfo checkConstructorCallsBaseClassConstructor(@NotNull PsiMethod constructor,
@Nullable RefCountHolder refCountHolder,
@NotNull PsiResolveHelper resolveHelper) {
if (!constructor.isConstructor()) return null;
PsiClass aClass = constructor.getContainingClass();
if (aClass == null) return null;
if (aClass.isEnum()) return null;
PsiCodeBlock body = constructor.getBody();
if (body == null) return null;
if (JavaPsiConstructorUtil.findThisOrSuperCallInConstructor(constructor) != null) return null;
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(constructor);
PsiClassType[] handledExceptions = constructor.getThrowsList().getReferencedTypes();
HighlightInfo info = HighlightClassUtil.checkBaseClassDefaultConstructorProblem(aClass, refCountHolder, resolveHelper, textRange, handledExceptions);
if (info != null) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createInsertSuperFix(constructor));
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createInsertThisFix(constructor));
PsiClass superClass = aClass.getSuperClass();
if (superClass != null) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createAddDefaultConstructorFix(superClass));
}
}
return info;
}
/**
* @return error if static method overrides instance method or
* instance method overrides static. see JLS 8.4.6.1, 8.4.6.2
*/
static HighlightInfo checkStaticMethodOverride(@NotNull PsiMethod method, @NotNull PsiFile containingFile) {
// constructors are not members and therefor don't override class methods
if (method.isConstructor()) {
return null;
}
PsiClass aClass = method.getContainingClass();
if (aClass == null) return null;
final HierarchicalMethodSignature methodSignature = PsiSuperMethodImplUtil.getHierarchicalMethodSignature(method);
final List<HierarchicalMethodSignature> superSignatures = methodSignature.getSuperSignatures();
if (superSignatures.isEmpty()) {
return null;
}
boolean isStatic = method.hasModifierProperty(PsiModifier.STATIC);
for (HierarchicalMethodSignature signature : superSignatures) {
final PsiMethod superMethod = signature.getMethod();
final PsiClass superClass = superMethod.getContainingClass();
if (superClass == null) continue;
final HighlightInfo highlightInfo = checkStaticMethodOverride(aClass, method, isStatic, superClass, superMethod, containingFile);
if (highlightInfo != null) {
return highlightInfo;
}
}
return null;
}
private static HighlightInfo checkStaticMethodOverride(@NotNull PsiClass aClass,
@NotNull PsiMethod method,
boolean isMethodStatic,
@NotNull PsiClass superClass,
@NotNull PsiMethod superMethod,
@NotNull PsiFile containingFile) {
PsiManager manager = containingFile.getManager();
PsiModifierList superModifierList = superMethod.getModifierList();
PsiModifierList modifierList = method.getModifierList();
if (superModifierList.hasModifierProperty(PsiModifier.PRIVATE)) return null;
if (superModifierList.hasModifierProperty(PsiModifier.PACKAGE_LOCAL)
&& !JavaPsiFacade.getInstance(manager.getProject()).arePackagesTheSame(aClass, superClass)) {
return null;
}
boolean isSuperMethodStatic = superModifierList.hasModifierProperty(PsiModifier.STATIC);
if (isMethodStatic != isSuperMethodStatic) {
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
final String messageKey = isMethodStatic
? "static.method.cannot.override.instance.method"
: "instance.method.cannot.override.static.method";
String description = JavaErrorBundle.message(messageKey,
JavaHighlightUtil.formatMethod(method),
HighlightUtil.formatClass(aClass),
JavaHighlightUtil.formatMethod(superMethod),
HighlightUtil.formatClass(superClass));
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
if (!isSuperMethodStatic || HighlightUtil.getIncompatibleModifier(PsiModifier.STATIC, modifierList) == null) {
QuickFixAction.registerQuickFixAction(info,
QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.STATIC, isSuperMethodStatic, false));
}
if (manager.isInProject(superMethod) &&
(!isMethodStatic || HighlightUtil.getIncompatibleModifier(PsiModifier.STATIC, superModifierList) == null)) {
QuickFixAction.registerQuickFixActions(info, null, JvmElementActionFactories.createModifierActions(superMethod, MemberRequestsKt.modifierRequest(JvmModifier.STATIC, isMethodStatic)));
}
return info;
}
if (isMethodStatic) {
if (superClass.isInterface()) return null;
int accessLevel = PsiUtil.getAccessLevel(modifierList);
String accessModifier = PsiUtil.getAccessModifier(accessLevel);
HighlightInfo info = isWeaker(method, modifierList, accessModifier, accessLevel, superMethod, true);
if (info != null) return info;
info = checkSuperMethodIsFinal(method, superMethod);
if (info != null) return info;
}
return null;
}
private static HighlightInfo checkInterfaceInheritedMethodsReturnTypes(@NotNull List<? extends MethodSignatureBackedByPsiMethod> superMethodSignatures,
@NotNull LanguageLevel languageLevel) {
if (superMethodSignatures.size() < 2) return null;
final MethodSignatureBackedByPsiMethod[] returnTypeSubstitutable = {superMethodSignatures.get(0)};
for (int i = 1; i < superMethodSignatures.size(); i++) {
PsiMethod currentMethod = returnTypeSubstitutable[0].getMethod();
PsiType currentType = returnTypeSubstitutable[0].getSubstitutor().substitute(currentMethod.getReturnType());
MethodSignatureBackedByPsiMethod otherSuperSignature = superMethodSignatures.get(i);
PsiMethod otherSuperMethod = otherSuperSignature.getMethod();
PsiSubstitutor otherSubstitutor = otherSuperSignature.getSubstitutor();
PsiType otherSuperReturnType = otherSubstitutor.substitute(otherSuperMethod.getReturnType());
PsiSubstitutor unifyingSubstitutor = MethodSignatureUtil.getSuperMethodSignatureSubstitutor(returnTypeSubstitutable[0],
otherSuperSignature);
if (unifyingSubstitutor != null) {
otherSuperReturnType = unifyingSubstitutor.substitute(otherSuperReturnType);
currentType = unifyingSubstitutor.substitute(currentType);
}
if (otherSuperReturnType == null || currentType == null || otherSuperReturnType.equals(currentType)) continue;
PsiType otherReturnType = otherSuperReturnType;
PsiType curType = currentType;
final HighlightInfo info =
LambdaUtil.performWithSubstitutedParameterBounds(otherSuperMethod.getTypeParameters(), otherSubstitutor, () -> {
if (languageLevel.isAtLeast(LanguageLevel.JDK_1_5)) {
//http://docs.oracle.com/javase/specs/jls/se7/html/jls-8.html#jls-8.4.8 Example 8.1.5-3
if (!(otherReturnType instanceof PsiPrimitiveType || curType instanceof PsiPrimitiveType)) {
if (otherReturnType.isAssignableFrom(curType)) return null;
if (curType.isAssignableFrom(otherReturnType)) {
returnTypeSubstitutable[0] = otherSuperSignature;
return null;
}
}
if (otherSuperMethod.getTypeParameters().length > 0 && JavaGenericsUtil.isRawToGeneric(otherReturnType, curType)) return null;
}
return createIncompatibleReturnTypeMessage(otherSuperMethod, currentMethod, curType, otherReturnType,
JavaErrorBundle.message("unrelated.overriding.methods.return.types"), TextRange.EMPTY_RANGE);
});
if (info != null) return info;
}
return null;
}
static HighlightInfo checkOverrideEquivalentInheritedMethods(@NotNull PsiClass aClass,
@NotNull PsiFile containingFile,
@NotNull LanguageLevel languageLevel) {
String description = null;
boolean appendImplementMethodFix = true;
final Collection<HierarchicalMethodSignature> visibleSignatures = aClass.getVisibleSignatures();
PsiResolveHelper resolveHelper = JavaPsiFacade.getInstance(aClass.getProject()).getResolveHelper();
Ultimate:
for (HierarchicalMethodSignature signature : visibleSignatures) {
PsiMethod method = signature.getMethod();
if (!resolveHelper.isAccessible(method, aClass, null)) continue;
List<HierarchicalMethodSignature> superSignatures = signature.getSuperSignatures();
boolean allAbstracts = method.hasModifierProperty(PsiModifier.ABSTRACT);
PsiClass containingClass = method.getContainingClass();
if (containingClass == null || aClass.equals(containingClass)) continue; //to be checked at method level
if (aClass.isInterface() && !containingClass.isInterface()) continue;
HighlightInfo highlightInfo;
if (allAbstracts) {
superSignatures = new ArrayList<>(superSignatures);
superSignatures.add(0, signature);
highlightInfo = checkInterfaceInheritedMethodsReturnTypes(superSignatures, languageLevel);
}
else {
highlightInfo = checkMethodIncompatibleReturnType(signature, superSignatures, false);
}
if (highlightInfo != null) description = highlightInfo.getDescription();
if (method.hasModifierProperty(PsiModifier.STATIC)) {
for (HierarchicalMethodSignature superSignature : superSignatures) {
PsiMethod superMethod = superSignature.getMethod();
if (!superMethod.hasModifierProperty(PsiModifier.STATIC)) {
PsiClass superClass = superMethod.getContainingClass();
description = JavaErrorBundle.message("static.method.cannot.override.instance.method",
JavaHighlightUtil.formatMethod(method),
HighlightUtil.formatClass(containingClass),
JavaHighlightUtil.formatMethod(superMethod),
superClass != null ? HighlightUtil.formatClass(superClass) : "<unknown>");
appendImplementMethodFix = false;
break Ultimate;
}
}
continue;
}
if (description == null) {
highlightInfo = checkMethodIncompatibleThrows(signature, superSignatures, false, aClass);
if (highlightInfo != null) description = highlightInfo.getDescription();
}
if (description == null) {
highlightInfo = checkMethodWeakerPrivileges(signature, superSignatures, false, containingFile);
if (highlightInfo != null) description = highlightInfo.getDescription();
}
if (description != null) break;
}
if (description != null) {
// show error info at the class level
TextRange textRange = HighlightNamesUtil.getClassDeclarationTextRange(aClass);
final HighlightInfo highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
if (appendImplementMethodFix) {
QuickFixAction.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createImplementMethodsFix(aClass));
}
return highlightInfo;
}
return null;
}
static HighlightInfo checkConstructorHandleSuperClassExceptions(@NotNull PsiMethod method) {
if (!method.isConstructor()) {
return null;
}
PsiCodeBlock body = method.getBody();
PsiStatement[] statements = body == null ? null : body.getStatements();
if (statements == null) return null;
// if we have unhandled exception inside method body, we could not have been called here,
// so the only problem it can catch here is with super ctr only
Collection<PsiClassType> unhandled = ExceptionUtil.collectUnhandledExceptions(method, method.getContainingClass());
if (unhandled.isEmpty()) return null;
String description = HighlightUtil.getUnhandledExceptionsDescriptor(unhandled);
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
HighlightInfo highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
for (PsiClassType exception : unhandled) {
QuickFixAction.registerQuickFixAction(highlightInfo, new LocalQuickFixOnPsiElementAsIntentionAdapter(QUICK_FIX_FACTORY.createMethodThrowsFix(method, exception, true, false)));
}
return highlightInfo;
}
static HighlightInfo checkRecursiveConstructorInvocation(@NotNull PsiMethod method) {
if (HighlightControlFlowUtil.isRecursivelyCalledConstructor(method)) {
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
String description = JavaErrorBundle.message("recursive.constructor.invocation");
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
}
return null;
}
@NotNull
public static TextRange getFixRange(@NotNull PsiElement element) {
TextRange range = element.getTextRange();
int start = range.getStartOffset();
int end = range.getEndOffset();
PsiElement nextSibling = element.getNextSibling();
if (PsiUtil.isJavaToken(nextSibling, JavaTokenType.SEMICOLON)) {
return new TextRange(start, end + 1);
}
return range;
}
static void checkNewExpression(@NotNull PsiNewExpression expression,
@Nullable PsiType type,
@NotNull HighlightInfoHolder holder,
@NotNull JavaSdkVersion javaSdkVersion) {
if (!(type instanceof PsiClassType)) return;
PsiClassType.ClassResolveResult typeResult = ((PsiClassType)type).resolveGenerics();
PsiClass aClass = typeResult.getElement();
if (aClass == null) return;
if (aClass instanceof PsiAnonymousClass) {
type = ((PsiAnonymousClass)aClass).getBaseClassType();
typeResult = ((PsiClassType)type).resolveGenerics();
aClass = typeResult.getElement();
if (aClass == null) return;
}
PsiJavaCodeReferenceElement classReference = expression.getClassOrAnonymousClassReference();
checkConstructorCall(typeResult, expression, type, classReference, holder, javaSdkVersion);
}
static void checkConstructorCall(@NotNull PsiClassType.ClassResolveResult typeResolveResult,
@NotNull PsiConstructorCall constructorCall,
@NotNull PsiType type,
@Nullable PsiJavaCodeReferenceElement classReference,
@NotNull HighlightInfoHolder holder,
@NotNull JavaSdkVersion javaSdkVersion) {
PsiExpressionList list = constructorCall.getArgumentList();
if (list == null) return;
PsiClass aClass = typeResolveResult.getElement();
if (aClass == null) return;
final PsiResolveHelper resolveHelper = JavaPsiFacade.getInstance(holder.getProject()).getResolveHelper();
PsiClass accessObjectClass = null;
if (constructorCall instanceof PsiNewExpression) {
PsiExpression qualifier = ((PsiNewExpression)constructorCall).getQualifier();
if (qualifier != null) {
accessObjectClass = (PsiClass)PsiUtil.getAccessObjectClass(qualifier).getElement();
}
}
if (classReference != null && !resolveHelper.isAccessible(aClass, constructorCall, accessObjectClass)) {
String description = HighlightUtil.accessProblemDescription(classReference, aClass, typeResolveResult);
PsiElement element = ObjectUtils.notNull(classReference.getReferenceNameElement(), classReference);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(element).descriptionAndTooltip(description).create();
HighlightFixUtil.registerAccessQuickFixAction(aClass, classReference, info, null);
holder.add(info);
return;
}
PsiMethod[] constructors = aClass.getConstructors();
if (constructors.length == 0) {
if (!list.isEmpty()) {
String constructorName = aClass.getName();
String argTypes = buildArgTypesList(list);
String description = JavaErrorBundle.message("wrong.constructor.arguments", constructorName + "()", argTypes);
String tooltip = createMismatchedArgumentsHtmlTooltip(list, null, PsiParameter.EMPTY_ARRAY, PsiSubstitutor.EMPTY);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(list).description(description).escapedToolTip(tooltip).navigationShift(+1).create();
QuickFixAction.registerQuickFixActions(
info, constructorCall.getTextRange(), QUICK_FIX_FACTORY.createCreateConstructorFromUsageFixes(constructorCall)
);
if (classReference != null) {
ConstructorParametersFixer.registerFixActions(classReference, constructorCall, info,getFixRange(list));
}
holder.add(info);
return;
}
if (classReference != null && aClass.hasModifierProperty(PsiModifier.PROTECTED) && callingProtectedConstructorFromDerivedClass(constructorCall, aClass)) {
holder.add(buildAccessProblem(classReference, aClass, typeResolveResult));
} else if (aClass.isInterface() && constructorCall instanceof PsiNewExpression) {
final PsiReferenceParameterList typeArgumentList = ((PsiNewExpression)constructorCall).getTypeArgumentList();
if (typeArgumentList.getTypeArguments().length > 0) {
holder.add(HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(typeArgumentList)
.descriptionAndTooltip("Anonymous class implements interface; cannot have type arguments").create());
}
}
}
else {
PsiElement place = list;
if (constructorCall instanceof PsiNewExpression) {
final PsiAnonymousClass anonymousClass = ((PsiNewExpression)constructorCall).getAnonymousClass();
if (anonymousClass != null) place = anonymousClass;
}
JavaResolveResult[] results = resolveHelper.multiResolveConstructor((PsiClassType)type, list, place);
MethodCandidateInfo result = null;
if (results.length == 1) result = (MethodCandidateInfo)results[0];
PsiMethod constructor = result == null ? null : result.getElement();
boolean applicable = true;
try {
final PsiDiamondType diamondType = constructorCall instanceof PsiNewExpression ? PsiDiamondType.getDiamondType((PsiNewExpression)constructorCall) : null;
final JavaResolveResult staticFactory = diamondType != null ? diamondType.getStaticFactory() : null;
if (staticFactory instanceof MethodCandidateInfo) {
if (((MethodCandidateInfo)staticFactory).isApplicable()) {
result = (MethodCandidateInfo)staticFactory;
if (constructor == null) {
constructor = ((MethodCandidateInfo)staticFactory).getElement();
}
}
else {
applicable = false;
}
}
else {
applicable = result != null && result.isApplicable();
}
}
catch (IndexNotReadyException ignored) {
}
PsiElement infoElement = list.getTextLength() > 0 ? list : constructorCall;
if (constructor == null) {
String name = aClass.getName();
name += buildArgTypesList(list);
String description = JavaErrorBundle.message("cannot.resolve.constructor", name);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(list).descriptionAndTooltip(description).navigationShift(+1).create();
if (info != null) {
WrapExpressionFix.registerWrapAction(results, list.getExpressions(), info, getFixRange(list));
registerFixesOnInvalidConstructorCall(constructorCall, classReference, list, aClass, constructors, results, infoElement, info);
holder.add(info);
}
}
else if (classReference != null &&
(!result.isAccessible() ||
constructor.hasModifierProperty(PsiModifier.PROTECTED) && callingProtectedConstructorFromDerivedClass(constructorCall, aClass))) {
holder.add(buildAccessProblem(classReference, constructor, result));
}
else if (!applicable) {
HighlightInfo info = createIncompatibleCallHighlightInfo(holder, list, result);
if (info != null) {
JavaResolveResult[] methodCandidates = results;
if (constructorCall instanceof PsiNewExpression) {
methodCandidates = resolveHelper.getReferencedMethodCandidates((PsiCallExpression)constructorCall, true);
}
registerFixesOnInvalidConstructorCall(constructorCall, classReference, list, aClass, constructors, methodCandidates, infoElement, info);
registerMethodReturnFixAction(info, result, constructorCall);
holder.add(info);
}
}
else if (constructorCall instanceof PsiNewExpression) {
PsiReferenceParameterList typeArgumentList = ((PsiNewExpression)constructorCall).getTypeArgumentList();
HighlightInfo info = GenericsHighlightUtil.checkReferenceTypeArgumentList(constructor, typeArgumentList, result.getSubstitutor(), false, javaSdkVersion);
if (info != null) {
holder.add(info);
}
}
if (result != null && !holder.hasErrorResults()) {
holder.add(checkVarargParameterErasureToBeAccessible(result, constructorCall));
}
}
}
/**
* If the compile-time declaration is applicable by variable arity invocation,
* then where the last formal parameter type of the invocation type of the method is Fn[],
* it is a compile-time error if the type which is the erasure of Fn is not accessible at the point of invocation.
*/
private static HighlightInfo checkVarargParameterErasureToBeAccessible(@NotNull MethodCandidateInfo info, @NotNull PsiCall place) {
final PsiMethod method = info.getElement();
if (info.isVarargs() || method.isVarArgs() && !PsiUtil.isLanguageLevel8OrHigher(place)) {
final PsiParameter[] parameters = method.getParameterList().getParameters();
final PsiType componentType = ((PsiEllipsisType)parameters[parameters.length - 1].getType()).getComponentType();
final PsiType substitutedTypeErasure = TypeConversionUtil.erasure(info.getSubstitutor().substitute(componentType));
final PsiClass targetClass = PsiUtil.resolveClassInClassTypeOnly(substitutedTypeErasure);
if (targetClass != null && !PsiUtil.isAccessible(targetClass, place, null)) {
final PsiExpressionList argumentList = place.getArgumentList();
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR)
.descriptionAndTooltip("Formal varargs element type " +
PsiFormatUtil.formatClass(targetClass, PsiFormatUtilBase.SHOW_FQ_NAME) +
" is inaccessible here")
.range(argumentList != null ? argumentList : place)
.create();
}
}
return null;
}
private static void registerFixesOnInvalidConstructorCall(@NotNull PsiConstructorCall constructorCall,
@Nullable PsiJavaCodeReferenceElement classReference,
@NotNull PsiExpressionList list,
@NotNull PsiClass aClass,
PsiMethod @NotNull [] constructors,
JavaResolveResult @NotNull [] results,
@NotNull PsiElement infoElement,
@NotNull final HighlightInfo info) {
QuickFixAction.registerQuickFixActions(
info, constructorCall.getTextRange(), QUICK_FIX_FACTORY.createCreateConstructorFromUsageFixes(constructorCall)
);
if (classReference != null) {
ConstructorParametersFixer.registerFixActions(classReference, constructorCall, info, getFixRange(infoElement));
ChangeTypeArgumentsFix.registerIntentions(results, list, info, aClass);
ConvertDoubleToFloatFix.registerIntentions(results, list, info, null);
}
if (!PermuteArgumentsFix.registerFix(info, constructorCall, toMethodCandidates(results), getFixRange(list))) {
registerChangeMethodSignatureFromUsageIntentions(results, list, info, null);
}
registerChangeParameterClassFix(constructorCall, list, info);
QuickFixAction.registerQuickFixAction(info, getFixRange(list), QUICK_FIX_FACTORY.createSurroundWithArrayFix(constructorCall,null));
ChangeStringLiteralToCharInMethodCallFix.registerFixes(constructors, constructorCall, info);
}
private static HighlightInfo buildAccessProblem(@NotNull PsiJavaCodeReferenceElement ref,
@NotNull PsiJvmMember resolved,
@NotNull JavaResolveResult result) {
String description = HighlightUtil.accessProblemDescription(ref, resolved, result);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(ref).descriptionAndTooltip(description).navigationShift(+1).create();
if (result.isStaticsScopeCorrect()) {
HighlightFixUtil.registerAccessQuickFixAction(resolved, ref, info, result.getCurrentFileResolveScope());
}
return info;
}
private static boolean callingProtectedConstructorFromDerivedClass(@NotNull PsiConstructorCall place, @NotNull PsiClass constructorClass) {
// indirect instantiation via anonymous class is ok
if (place instanceof PsiNewExpression && ((PsiNewExpression)place).getAnonymousClass() != null) return false;
PsiElement curElement = place;
PsiClass containingClass = constructorClass.getContainingClass();
while (true) {
PsiClass aClass = PsiTreeUtil.getParentOfType(curElement, PsiClass.class);
if (aClass == null) return false;
curElement = aClass;
if ((aClass.isInheritor(constructorClass, true) || containingClass != null && aClass.isInheritor(containingClass, true))
&& !JavaPsiFacade.getInstance(aClass.getProject()).arePackagesTheSame(aClass, constructorClass)) {
return true;
}
}
}
@NotNull
private static String buildArgTypesList(@NotNull PsiExpressionList list) {
StringBuilder builder = new StringBuilder();
builder.append("(");
PsiExpression[] args = list.getExpressions();
for (int i = 0; i < args.length; i++) {
if (i > 0) builder.append(", ");
PsiType argType = args[i].getType();
builder.append(argType != null ? JavaHighlightUtil.formatType(argType) : "?");
}
builder.append(")");
return builder.toString();
}
private static void registerChangeParameterClassFix(@NotNull PsiCall methodCall,
@NotNull PsiExpressionList list,
@Nullable HighlightInfo highlightInfo) {
final JavaResolveResult result = methodCall.resolveMethodGenerics();
PsiMethod method = (PsiMethod)result.getElement();
final PsiSubstitutor substitutor = result.getSubstitutor();
PsiExpression[] expressions = list.getExpressions();
if (method == null) return;
final PsiParameter[] parameters = method.getParameterList().getParameters();
if (parameters.length != expressions.length) return;
for (int i = 0; i < expressions.length; i++) {
final PsiExpression expression = expressions[i];
final PsiParameter parameter = parameters[i];
final PsiType expressionType = expression.getType();
final PsiType parameterType = substitutor.substitute(parameter.getType());
if (expressionType == null || expressionType instanceof PsiPrimitiveType || TypeConversionUtil.isNullType(expressionType) || expressionType instanceof PsiArrayType) continue;
if (parameterType instanceof PsiPrimitiveType || TypeConversionUtil.isNullType(parameterType) || parameterType instanceof PsiArrayType) continue;
if (parameterType.isAssignableFrom(expressionType)) continue;
PsiClass parameterClass = PsiUtil.resolveClassInType(parameterType);
PsiClass expressionClass = PsiUtil.resolveClassInType(expressionType);
if (parameterClass == null || expressionClass == null) continue;
if (expressionClass instanceof PsiAnonymousClass) continue;
if (parameterClass.isInheritor(expressionClass, true)) continue;
QuickFixAction.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createChangeParameterClassFix(expressionClass, (PsiClassType)parameterType));
}
}
private static void registerChangeMethodSignatureFromUsageIntentions(JavaResolveResult @NotNull [] candidates,
@NotNull PsiExpressionList list,
@Nullable HighlightInfo highlightInfo,
@Nullable TextRange fixRange) {
if (candidates.length == 0) return;
PsiExpression[] expressions = list.getExpressions();
for (JavaResolveResult candidate : candidates) {
registerChangeMethodSignatureFromUsageIntention(expressions, highlightInfo, fixRange, candidate, list);
}
}
private static void registerChangeMethodSignatureFromUsageIntention(PsiExpression @NotNull [] expressions,
@Nullable HighlightInfo highlightInfo,
@Nullable TextRange fixRange,
@NotNull JavaResolveResult candidate,
@NotNull PsiElement context) {
if (!candidate.isStaticsScopeCorrect()) return;
PsiMethod method = (PsiMethod)candidate.getElement();
PsiSubstitutor substitutor = candidate.getSubstitutor();
if (method != null && context.getManager().isInProject(method)) {
IntentionAction fix = QUICK_FIX_FACTORY.createChangeMethodSignatureFromUsageFix(method, expressions, substitutor, context, false, 2);
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, fix);
IntentionAction f2 = QUICK_FIX_FACTORY.createChangeMethodSignatureFromUsageReverseOrderFix(method, expressions, substitutor, context, false, 2);
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, f2);
}
}
static PsiType determineReturnType(@NotNull PsiMethod method) {
PsiManager manager = method.getManager();
PsiReturnStatement[] returnStatements = PsiUtil.findReturnStatements(method);
if (returnStatements.length == 0) return PsiType.VOID;
PsiType expectedType = null;
for (PsiReturnStatement returnStatement : returnStatements) {
ReturnModel returnModel = ReturnModel.create(returnStatement);
if (returnModel == null) return null;
expectedType = lub(expectedType, returnModel.myLeastType, returnModel.myType, method, manager);
}
return expectedType;
}
@NotNull
private static PsiType lub(@Nullable PsiType currentType,
@NotNull PsiType leastValueType,
@NotNull PsiType valueType,
@NotNull PsiMethod method,
@NotNull PsiManager manager) {
if (currentType == null || PsiType.VOID.equals(currentType)) return valueType;
if (currentType == valueType) return currentType;
if (TypeConversionUtil.isPrimitiveAndNotNull(valueType)) {
if (TypeConversionUtil.isPrimitiveAndNotNull(currentType)) {
int r1 = TypeConversionUtil.getTypeRank(currentType);
int r2 = TypeConversionUtil.getTypeRank(leastValueType);
return r1 >= r2 ? currentType : valueType;
}
PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(currentType);
if (valueType.equals(unboxedType)) return currentType;
valueType = ((PsiPrimitiveType)valueType).getBoxedType(method);
}
if (TypeConversionUtil.isPrimitiveAndNotNull(currentType)) {
currentType = ((PsiPrimitiveType)currentType).getBoxedType(method);
}
return Objects.requireNonNull(GenericsUtil.getLeastUpperBound(currentType, valueType, manager));
}
static HighlightInfo checkRecordAccessorDeclaration(PsiMethod method) {
PsiRecordComponent component = JavaPsiRecordUtil.getRecordComponentForAccessor(method);
if (component == null) return null;
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier == null) return null;
PsiType componentType = component.getType();
PsiType methodType = method.getReturnType();
if (methodType == null) return null; // Either constructor or incorrect method, will be reported in another way
if (!componentType.equals(methodType)) {
String message =
JavaErrorBundle.message("record.accessor.wrong.return.type", componentType.getPresentableText(), methodType.getPresentableText());
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
Objects.requireNonNull(method.getReturnTypeElement())).descriptionAndTooltip(message).create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createMethodReturnFix(method, componentType, false));
return info;
}
return checkRecordSpecialMethodDeclaration(method, JavaErrorBundle.message("record.accessor"));
}
@NotNull
static List<HighlightInfo> checkRecordConstructorDeclaration(@NotNull PsiMethod method) {
if (!method.isConstructor()) return Collections.emptyList();
PsiClass aClass = method.getContainingClass();
if (aClass == null) return Collections.emptyList();
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier == null) return Collections.emptyList();
if (!aClass.isRecord()) {
if (JavaPsiRecordUtil.isCompactConstructor(method)) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
identifier).descriptionAndTooltip(JavaErrorBundle.message("compact.constructor.in.regular.class")).create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createAddParameterListFix(method));
return Collections.singletonList(info);
}
return Collections.emptyList();
}
if (JavaPsiRecordUtil.isExplicitCanonicalConstructor(method)) {
PsiParameter[] parameters = method.getParameterList().getParameters();
PsiRecordComponent[] components = aClass.getRecordComponents();
List<HighlightInfo> problems = new ArrayList<>();
assert parameters.length == components.length;
for (int i = 0; i < parameters.length; i++) {
PsiType componentType = components[i].getType();
PsiType parameterType = parameters[i].getType();
String componentName = components[i].getName();
String parameterName = parameters[i].getName();
if (!parameterType.equals(componentType)) {
String message =
JavaErrorBundle.message("record.canonical.constructor.wrong.parameter.type", componentName,
componentType.getPresentableText(), parameterType.getPresentableText());
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
Objects.requireNonNull(parameters[i].getTypeElement())).descriptionAndTooltip(message).create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createMethodParameterTypeFix(method, i, componentType, false));
problems.add(info);
}
if (componentName != null && !parameterName.equals(componentName)) {
String message = JavaErrorBundle.message("record.canonical.constructor.wrong.parameter.name", componentName, parameterName);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
Objects.requireNonNull(parameters[i].getNameIdentifier())).descriptionAndTooltip(message).create();
if (Arrays.stream(parameters).map(PsiParameter::getName).noneMatch(Predicate.isEqual(componentName))) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createRenameElementFix(parameters[i], componentName));
}
problems.add(info);
}
}
ContainerUtil
.addIfNotNull(problems, checkRecordSpecialMethodDeclaration(method, JavaErrorBundle.message("record.canonical.constructor")));
return problems;
} else if (JavaPsiRecordUtil.isCompactConstructor(method)) {
return Collections
.singletonList(checkRecordSpecialMethodDeclaration(method, JavaErrorBundle.message("record.compact.constructor")));
}
else {
// Non-canonical constructor
PsiMethodCallExpression call = JavaPsiConstructorUtil.findThisOrSuperCallInConstructor(method);
if (call == null || JavaPsiConstructorUtil.isSuperConstructorCall(call)) {
String message = JavaErrorBundle.message("record.no.constructor.call.in.non.canonical");
return Collections.singletonList(HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(identifier)
.descriptionAndTooltip(message).create());
}
return Collections.emptyList();
}
}
@Nullable
private static HighlightInfo checkRecordSpecialMethodDeclaration(PsiMethod method, String methodTitle) {
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier == null) return null;
PsiTypeParameterList typeParameterList = method.getTypeParameterList();
if (typeParameterList != null && typeParameterList.getTypeParameters().length > 0) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(typeParameterList)
.descriptionAndTooltip(JavaErrorBundle.message("record.special.method.type.parameters", methodTitle))
.create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createDeleteFix(typeParameterList));
return info;
}
if (!method.hasModifierProperty(PsiModifier.PUBLIC)) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(identifier)
.descriptionAndTooltip(JavaErrorBundle.message("record.special.method.non.public", methodTitle))
.create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.PUBLIC, true, false));
return info;
}
PsiReferenceList throwsList = method.getThrowsList();
if (throwsList.getReferenceElements().length > 0) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(throwsList)
.descriptionAndTooltip(JavaErrorBundle.message("record.special.method.throws", methodTitle))
.create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createDeleteFix(throwsList));
return info;
}
return null;
}
private static class ReturnModel {
final PsiReturnStatement myStatement;
final PsiType myType;
final PsiType myLeastType;
@Contract(pure = true)
private ReturnModel(@NotNull PsiReturnStatement statement, @NotNull PsiType type) {
myStatement = statement;
myType = myLeastType = type;
}
@Contract(pure = true)
private ReturnModel(@NotNull PsiReturnStatement statement, @NotNull PsiType type, @NotNull PsiType leastType) {
myStatement = statement;
myType = type;
myLeastType = leastType;
}
@Nullable
private static ReturnModel create(@NotNull PsiReturnStatement statement) {
PsiExpression value = statement.getReturnValue();
if (value == null) return new ReturnModel(statement, PsiType.VOID);
if (ExpressionUtils.nonStructuralChildren(value).anyMatch(c -> c instanceof PsiFunctionalExpression)) return null;
PsiType type = RefactoringChangeUtil.getTypeByExpression(value);
if (type == null || type instanceof PsiClassType && ((PsiClassType)type).resolve() == null) return null;
return new ReturnModel(statement, type, getLeastValueType(value, type));
}
@NotNull
private static PsiType getLeastValueType(@NotNull PsiExpression returnValue, @NotNull PsiType type) {
if (type instanceof PsiPrimitiveType) {
int rank = TypeConversionUtil.getTypeRank(type);
if (rank < TypeConversionUtil.BYTE_RANK || rank > TypeConversionUtil.INT_RANK) return type;
PsiConstantEvaluationHelper evaluator = JavaPsiFacade.getInstance(returnValue.getProject()).getConstantEvaluationHelper();
Object res = evaluator.computeConstantExpression(returnValue);
if (res instanceof Number) {
long value = ((Number)res).longValue();
if (-128 <= value && value <= 127) return PsiType.BYTE;
if (-32768 <= value && value <= 32767) return PsiType.SHORT;
if (0 <= value && value <= 0xFFFF) return PsiType.CHAR;
}
}
return type;
}
}
} | java/java-analysis-impl/src/com/intellij/codeInsight/daemon/impl/analysis/HighlightMethodUtil.java | // Copyright 2000-2019 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.codeInsight.daemon.impl.analysis;
import com.intellij.codeInsight.ExceptionUtil;
import com.intellij.codeInsight.daemon.JavaErrorBundle;
import com.intellij.codeInsight.daemon.impl.HighlightInfo;
import com.intellij.codeInsight.daemon.impl.HighlightInfoType;
import com.intellij.codeInsight.daemon.impl.quickfix.*;
import com.intellij.codeInsight.intention.IntentionAction;
import com.intellij.codeInsight.intention.QuickFixFactory;
import com.intellij.codeInsight.quickfix.UnresolvedReferenceQuickFixProvider;
import com.intellij.codeInspection.LocalQuickFixOnPsiElementAsIntentionAdapter;
import com.intellij.lang.jvm.JvmModifier;
import com.intellij.lang.jvm.actions.JvmElementActionFactories;
import com.intellij.lang.jvm.actions.MemberRequestsKt;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.DefaultLanguageHighlighterColors;
import com.intellij.openapi.editor.colors.EditorColorsUtil;
import com.intellij.openapi.project.IndexNotReadyException;
import com.intellij.openapi.projectRoots.JavaSdkVersion;
import com.intellij.openapi.util.Comparing;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.util.SystemInfo;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.pom.java.LanguageLevel;
import com.intellij.psi.*;
import com.intellij.psi.impl.PsiSuperMethodImplUtil;
import com.intellij.psi.impl.source.resolve.graphInference.InferenceSession;
import com.intellij.psi.infos.CandidateInfo;
import com.intellij.psi.infos.MethodCandidateInfo;
import com.intellij.psi.util.*;
import com.intellij.refactoring.util.RefactoringChangeUtil;
import com.intellij.ui.ColorUtil;
import com.intellij.util.ArrayUtil;
import com.intellij.util.JavaPsiConstructorUtil;
import com.intellij.util.ObjectUtils;
import com.intellij.util.VisibilityUtil;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.util.containers.MostlySingularMultiMap;
import com.intellij.util.ui.StartupUiUtil;
import com.intellij.util.ui.UIUtil;
import com.intellij.xml.util.XmlStringUtil;
import com.siyeh.ig.psiutils.ExpressionUtils;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.awt.*;
import java.text.MessageFormat;
import java.util.List;
import java.util.*;
import java.util.function.Predicate;
import java.util.stream.Stream;
public class HighlightMethodUtil {
private static final QuickFixFactory QUICK_FIX_FACTORY = QuickFixFactory.getInstance();
private static final Logger LOG = Logger.getInstance(HighlightMethodUtil.class);
private HighlightMethodUtil() { }
@NotNull
static String createClashMethodMessage(@NotNull PsiMethod method1, @NotNull PsiMethod method2, boolean showContainingClasses) {
if (showContainingClasses) {
PsiClass class1 = method1.getContainingClass();
PsiClass class2 = method2.getContainingClass();
if (class1 != null && class2 != null) {
return JavaErrorBundle.message("clash.methods.message.show.classes",
JavaHighlightUtil.formatMethod(method1),
JavaHighlightUtil.formatMethod(method2),
HighlightUtil.formatClass(class1),
HighlightUtil.formatClass(class2));
}
}
return JavaErrorBundle.message("clash.methods.message",
JavaHighlightUtil.formatMethod(method1),
JavaHighlightUtil.formatMethod(method2));
}
static HighlightInfo checkMethodWeakerPrivileges(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo,
@NotNull PsiFile containingFile) {
PsiMethod method = methodSignature.getMethod();
PsiModifierList modifierList = method.getModifierList();
if (modifierList.hasModifierProperty(PsiModifier.PUBLIC)) return null;
int accessLevel = PsiUtil.getAccessLevel(modifierList);
String accessModifier = PsiUtil.getAccessModifier(accessLevel);
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
if (method.hasModifierProperty(PsiModifier.ABSTRACT) && !MethodSignatureUtil.isSuperMethod(superMethod, method)) continue;
if (!PsiUtil.isAccessible(containingFile.getProject(), superMethod, method, null)) continue;
if (!includeRealPositionInfo && MethodSignatureUtil.isSuperMethod(superMethod, method)) continue;
HighlightInfo info = isWeaker(method, modifierList, accessModifier, accessLevel, superMethod, includeRealPositionInfo);
if (info != null) return info;
}
return null;
}
private static HighlightInfo isWeaker(@NotNull PsiMethod method,
@NotNull PsiModifierList modifierList,
@NotNull String accessModifier,
int accessLevel,
@NotNull PsiMethod superMethod,
boolean includeRealPositionInfo) {
int superAccessLevel = PsiUtil.getAccessLevel(superMethod.getModifierList());
if (accessLevel < superAccessLevel) {
String description = JavaErrorBundle.message("weaker.privileges",
createClashMethodMessage(method, superMethod, true),
VisibilityUtil.toPresentableText(accessModifier),
PsiUtil.getAccessModifier(superAccessLevel));
TextRange textRange = TextRange.EMPTY_RANGE;
if (includeRealPositionInfo) {
PsiElement keyword = PsiUtil.findModifierInList(modifierList, accessModifier);
if (keyword != null) {
textRange = keyword.getTextRange();
}
else {
// in case of package-private or some crazy third-party plugin where some access modifier implied even if it's absent
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier != null) {
textRange = identifier.getTextRange();
}
}
}
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
QuickFixAction.registerQuickFixAction(info, null, QUICK_FIX_FACTORY.createChangeModifierFix());
return info;
}
return null;
}
static HighlightInfo checkMethodIncompatibleReturnType(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo) {
return checkMethodIncompatibleReturnType(methodSignature, superMethodSignatures, includeRealPositionInfo, null);
}
static HighlightInfo checkMethodIncompatibleReturnType(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo,
@Nullable TextRange textRange) {
PsiMethod method = methodSignature.getMethod();
PsiType returnType = methodSignature.getSubstitutor().substitute(method.getReturnType());
PsiClass aClass = method.getContainingClass();
if (aClass == null) return null;
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
PsiType declaredReturnType = superMethod.getReturnType();
PsiType superReturnType = declaredReturnType;
if (superMethodSignature.isRaw()) superReturnType = TypeConversionUtil.erasure(declaredReturnType);
if (returnType == null || superReturnType == null || method == superMethod) continue;
PsiClass superClass = superMethod.getContainingClass();
if (superClass == null) continue;
if (textRange == null && includeRealPositionInfo) {
PsiTypeElement typeElement = method.getReturnTypeElement();
if (typeElement != null) {
textRange = typeElement.getTextRange();
}
}
if (textRange == null) {
textRange = TextRange.EMPTY_RANGE;
}
HighlightInfo info = checkSuperMethodSignature(
superMethod, superMethodSignature, superReturnType, method, methodSignature, returnType,
JavaErrorBundle.message("incompatible.return.type"), textRange, PsiUtil.getLanguageLevel(aClass));
if (info != null) return info;
}
return null;
}
private static HighlightInfo checkSuperMethodSignature(@NotNull PsiMethod superMethod,
@NotNull MethodSignatureBackedByPsiMethod superMethodSignature,
@NotNull PsiType superReturnType,
@NotNull PsiMethod method,
@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull PsiType returnType,
@NotNull String detailMessage,
@NotNull TextRange range,
@NotNull LanguageLevel languageLevel) {
final PsiClass superContainingClass = superMethod.getContainingClass();
if (superContainingClass != null &&
CommonClassNames.JAVA_LANG_OBJECT.equals(superContainingClass.getQualifiedName()) &&
!superMethod.hasModifierProperty(PsiModifier.PUBLIC)) {
final PsiClass containingClass = method.getContainingClass();
if (containingClass != null && containingClass.isInterface() && !superContainingClass.isInterface()) {
return null;
}
}
PsiType substitutedSuperReturnType;
final boolean isJdk15 = languageLevel.isAtLeast(LanguageLevel.JDK_1_5);
if (isJdk15 && !superMethodSignature.isRaw() && superMethodSignature.equals(methodSignature)) { //see 8.4.5
PsiSubstitutor unifyingSubstitutor = MethodSignatureUtil.getSuperMethodSignatureSubstitutor(methodSignature,
superMethodSignature);
substitutedSuperReturnType = unifyingSubstitutor == null
? superReturnType
: unifyingSubstitutor.substitute(superReturnType);
}
else {
substitutedSuperReturnType = TypeConversionUtil.erasure(superMethodSignature.getSubstitutor().substitute(superReturnType));
}
if (returnType.equals(substitutedSuperReturnType)) return null;
if (!(returnType instanceof PsiPrimitiveType) && substitutedSuperReturnType.getDeepComponentType() instanceof PsiClassType) {
if (isJdk15 && LambdaUtil.performWithSubstitutedParameterBounds(methodSignature.getTypeParameters(),
methodSignature.getSubstitutor(),
() -> TypeConversionUtil.isAssignable(substitutedSuperReturnType, returnType))) {
return null;
}
}
return createIncompatibleReturnTypeMessage(method, superMethod, substitutedSuperReturnType, returnType, detailMessage, range);
}
private static HighlightInfo createIncompatibleReturnTypeMessage(@NotNull PsiMethod method,
@NotNull PsiMethod superMethod,
@NotNull PsiType substitutedSuperReturnType,
@NotNull PsiType returnType,
@NotNull String detailMessage,
@NotNull TextRange textRange) {
String description = MessageFormat.format("{0}; {1}", createClashMethodMessage(method, superMethod, true), detailMessage);
HighlightInfo errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(
description).create();
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createMethodReturnFix(method, substitutedSuperReturnType, false));
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createSuperMethodReturnFix(superMethod, returnType));
final PsiClass returnClass = PsiUtil.resolveClassInClassTypeOnly(returnType);
if (returnClass != null && substitutedSuperReturnType instanceof PsiClassType) {
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createChangeParameterClassFix(returnClass, (PsiClassType)substitutedSuperReturnType));
}
return errorResult;
}
static HighlightInfo checkMethodOverridesFinal(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures) {
PsiMethod method = methodSignature.getMethod();
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
HighlightInfo info = checkSuperMethodIsFinal(method, superMethod);
if (info != null) return info;
}
return null;
}
private static HighlightInfo checkSuperMethodIsFinal(@NotNull PsiMethod method, @NotNull PsiMethod superMethod) {
// strange things happen when super method is from Object and method from interface
if (superMethod.hasModifierProperty(PsiModifier.FINAL)) {
PsiClass superClass = superMethod.getContainingClass();
String description = JavaErrorBundle.message("final.method.override",
JavaHighlightUtil.formatMethod(method),
JavaHighlightUtil.formatMethod(superMethod),
superClass != null ? HighlightUtil.formatClass(superClass) : "<unknown>");
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
HighlightInfo errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
QuickFixAction.registerQuickFixActions(errorResult, null, JvmElementActionFactories.createModifierActions(superMethod, MemberRequestsKt.modifierRequest(JvmModifier.FINAL, false)));
return errorResult;
}
return null;
}
static HighlightInfo checkMethodIncompatibleThrows(@NotNull MethodSignatureBackedByPsiMethod methodSignature,
@NotNull List<? extends HierarchicalMethodSignature> superMethodSignatures,
boolean includeRealPositionInfo,
@NotNull PsiClass analyzedClass) {
PsiMethod method = methodSignature.getMethod();
PsiClass aClass = method.getContainingClass();
if (aClass == null) return null;
PsiSubstitutor superSubstitutor = TypeConversionUtil.getSuperClassSubstitutor(aClass, analyzedClass, PsiSubstitutor.EMPTY);
PsiClassType[] exceptions = method.getThrowsList().getReferencedTypes();
PsiJavaCodeReferenceElement[] referenceElements;
List<PsiElement> exceptionContexts;
if (includeRealPositionInfo) {
exceptionContexts = new ArrayList<>();
referenceElements = method.getThrowsList().getReferenceElements();
}
else {
exceptionContexts = null;
referenceElements = null;
}
List<PsiClassType> checkedExceptions = new ArrayList<>();
for (int i = 0; i < exceptions.length; i++) {
PsiClassType exception = exceptions[i];
if (exception == null) {
LOG.error("throws: " + method.getThrowsList().getText() + "; method: " + method);
}
else if (!ExceptionUtil.isUncheckedException(exception)) {
checkedExceptions.add(exception);
if (includeRealPositionInfo && i < referenceElements.length) {
PsiJavaCodeReferenceElement exceptionRef = referenceElements[i];
exceptionContexts.add(exceptionRef);
}
}
}
for (MethodSignatureBackedByPsiMethod superMethodSignature : superMethodSignatures) {
PsiMethod superMethod = superMethodSignature.getMethod();
int index = getExtraExceptionNum(methodSignature, superMethodSignature, checkedExceptions, superSubstitutor);
if (index != -1) {
if (aClass.isInterface()) {
final PsiClass superContainingClass = superMethod.getContainingClass();
if (superContainingClass != null && !superContainingClass.isInterface()) continue;
if (superContainingClass != null && !aClass.isInheritor(superContainingClass, true)) continue;
}
PsiClassType exception = checkedExceptions.get(index);
String description = JavaErrorBundle.message("overridden.method.does.not.throw",
createClashMethodMessage(method, superMethod, true),
JavaHighlightUtil.formatType(exception));
TextRange textRange;
if (includeRealPositionInfo) {
PsiElement exceptionContext = exceptionContexts.get(index);
textRange = exceptionContext.getTextRange();
}
else {
textRange = TextRange.EMPTY_RANGE;
}
HighlightInfo errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
QuickFixAction.registerQuickFixAction(errorResult, new LocalQuickFixOnPsiElementAsIntentionAdapter(QUICK_FIX_FACTORY.createMethodThrowsFix(method, exception, false, false)));
QuickFixAction.registerQuickFixAction(errorResult, new LocalQuickFixOnPsiElementAsIntentionAdapter(QUICK_FIX_FACTORY.createMethodThrowsFix(superMethod, exception, true, true)));
return errorResult;
}
}
return null;
}
// return number of exception which was not declared in super method or -1
private static int getExtraExceptionNum(@NotNull MethodSignature methodSignature,
@NotNull MethodSignatureBackedByPsiMethod superSignature,
@NotNull List<? extends PsiClassType> checkedExceptions,
@NotNull PsiSubstitutor substitutorForDerivedClass) {
PsiMethod superMethod = superSignature.getMethod();
PsiSubstitutor substitutorForMethod = MethodSignatureUtil.getSuperMethodSignatureSubstitutor(methodSignature, superSignature);
for (int i = 0; i < checkedExceptions.size(); i++) {
final PsiClassType checkedEx = checkedExceptions.get(i);
final PsiType substituted = substitutorForMethod == null ? TypeConversionUtil.erasure(checkedEx) : substitutorForMethod.substitute(checkedEx);
PsiType exception = substitutorForDerivedClass.substitute(substituted);
if (!isMethodThrows(superMethod, substitutorForMethod, exception, substitutorForDerivedClass)) {
return i;
}
}
return -1;
}
private static boolean isMethodThrows(@NotNull PsiMethod method,
@Nullable PsiSubstitutor substitutorForMethod,
PsiType exception,
@NotNull PsiSubstitutor substitutorForDerivedClass) {
PsiClassType[] thrownExceptions = method.getThrowsList().getReferencedTypes();
for (PsiClassType thrownException1 : thrownExceptions) {
PsiType thrownException = substitutorForMethod != null ? substitutorForMethod.substitute(thrownException1) : TypeConversionUtil.erasure(thrownException1);
thrownException = substitutorForDerivedClass.substitute(thrownException);
if (TypeConversionUtil.isAssignable(thrownException, exception)) return true;
}
return false;
}
static void checkMethodCall(@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull LanguageLevel languageLevel,
@NotNull JavaSdkVersion javaSdkVersion,
@NotNull PsiFile file,
HighlightInfoHolder holder) {
PsiExpressionList list = methodCall.getArgumentList();
PsiReferenceExpression referenceToMethod = methodCall.getMethodExpression();
JavaResolveResult[] results = referenceToMethod.multiResolve(true);
JavaResolveResult resolveResult = results.length == 1 ? results[0] : JavaResolveResult.EMPTY;
PsiElement resolved = resolveResult.getElement();
boolean isDummy = isDummyConstructorCall(methodCall, resolveHelper, list, referenceToMethod);
if (isDummy) return;
HighlightInfo highlightInfo;
final PsiSubstitutor substitutor = resolveResult.getSubstitutor();
if (resolved instanceof PsiMethod && resolveResult.isValidResult()) {
PsiElement nameElement = referenceToMethod.getReferenceNameElement();
TextRange fixRange = getFixRange(methodCall);
highlightInfo = HighlightUtil.checkUnhandledExceptions(methodCall, nameElement != null ? nameElement.getTextRange() : fixRange);
if (highlightInfo == null && ((PsiMethod)resolved).hasModifierProperty(PsiModifier.STATIC)) {
PsiClass containingClass = ((PsiMethod)resolved).getContainingClass();
if (containingClass != null && containingClass.isInterface()) {
PsiElement element = ObjectUtils.notNull(referenceToMethod.getReferenceNameElement(), referenceToMethod);
highlightInfo = HighlightUtil.checkFeature(element, HighlightingFeature.STATIC_INTERFACE_CALLS, languageLevel, file);
if (highlightInfo == null) {
highlightInfo =
checkStaticInterfaceCallQualifier(referenceToMethod, resolveResult, fixRange, containingClass);
}
}
}
if (highlightInfo == null) {
highlightInfo = GenericsHighlightUtil.checkInferredIntersections(substitutor, fixRange);
}
if (highlightInfo == null) {
highlightInfo = checkVarargParameterErasureToBeAccessible((MethodCandidateInfo)resolveResult, methodCall);
}
if (highlightInfo == null) {
highlightInfo = createIncompatibleTypeHighlightInfo(methodCall, resolveHelper, (MethodCandidateInfo)resolveResult, fixRange);
}
}
else {
PsiMethod resolvedMethod = null;
MethodCandidateInfo candidateInfo = null;
if (resolveResult instanceof MethodCandidateInfo) {
candidateInfo = (MethodCandidateInfo)resolveResult;
resolvedMethod = candidateInfo.getElement();
}
if (!resolveResult.isAccessible() || !resolveResult.isStaticsScopeCorrect()) {
highlightInfo = null;
}
else if (candidateInfo != null && !candidateInfo.isApplicable()) {
if (candidateInfo.isTypeArgumentsApplicable()) {
highlightInfo = createIncompatibleCallHighlightInfo(holder, list, candidateInfo);
if (highlightInfo != null) {
registerMethodCallIntentions(highlightInfo, methodCall, list, resolveHelper);
registerMethodReturnFixAction(highlightInfo, candidateInfo, methodCall);
registerTargetTypeFixesBasedOnApplicabilityInference(methodCall, candidateInfo, resolvedMethod, highlightInfo);
holder.add(highlightInfo);
return;
}
}
else {
PsiReferenceParameterList typeArgumentList = methodCall.getTypeArgumentList();
PsiSubstitutor applicabilitySubstitutor = candidateInfo.getSubstitutor(false);
if (typeArgumentList.getTypeArguments().length == 0 && resolvedMethod.hasTypeParameters()) {
highlightInfo = GenericsHighlightUtil.checkInferredTypeArguments(resolvedMethod, methodCall, applicabilitySubstitutor);
}
else {
highlightInfo = GenericsHighlightUtil.checkParameterizedReferenceTypeArguments(resolved, referenceToMethod, applicabilitySubstitutor, javaSdkVersion);
}
}
}
else {
String description = JavaErrorBundle.message("method.call.expected");
highlightInfo =
HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCall).descriptionAndTooltip(description).create();
if (resolved instanceof PsiClass) {
QuickFixAction.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createInsertNewFix(methodCall, (PsiClass)resolved));
}
else {
TextRange range = getFixRange(methodCall);
registerUsageFixes(methodCall, highlightInfo, range);
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.createStaticImportMethodFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.createQualifyStaticMethodCallFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.addMethodQualifierFix(methodCall));
if (resolved instanceof PsiVariable && languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
PsiMethod method = LambdaUtil.getFunctionalInterfaceMethod(((PsiVariable)resolved).getType());
if (method != null) {
QuickFixAction.registerQuickFixAction(highlightInfo, range, QUICK_FIX_FACTORY.createInsertMethodCallFix(methodCall, method));
}
}
}
}
}
if (highlightInfo == null) {
highlightInfo = GenericsHighlightUtil.checkParameterizedReferenceTypeArguments(resolved, referenceToMethod, substitutor, javaSdkVersion);
}
holder.add(highlightInfo);
}
/**
* collect highlightInfos per each wrong argument; fixes would be set for the first one with fixRange: methodCall
* @return highlight info for the first wrong arg expression
*/
private static HighlightInfo createIncompatibleCallHighlightInfo(HighlightInfoHolder holder,
PsiExpressionList list,
@NotNull MethodCandidateInfo candidateInfo) {
PsiMethod resolvedMethod = candidateInfo.getElement();
PsiSubstitutor substitutor = candidateInfo.getSubstitutor();
String methodName = HighlightMessageUtil.getSymbolName(resolvedMethod, substitutor);
PsiClass parent = resolvedMethod.getContainingClass();
String containerName = parent == null ? "" : HighlightMessageUtil.getSymbolName(parent, substitutor);
String argTypes = buildArgTypesList(list);
String description = JavaErrorBundle.message("wrong.method.arguments", methodName, containerName, argTypes);
String toolTip = null;
List<PsiExpression> mismatchedExpressions;
if (parent != null) {
final PsiExpression[] expressions = list.getExpressions();
final PsiParameter[] parameters = resolvedMethod.getParameterList().getParameters();
mismatchedExpressions = mismatchedArgs(expressions, substitutor, parameters, candidateInfo.isVarargs());
if (mismatchedExpressions.size() == 1) {
toolTip = createOneArgMismatchTooltip(candidateInfo, mismatchedExpressions, expressions, parameters);
}
if (toolTip == null) {
toolTip = createMismatchedArgumentsHtmlTooltip(candidateInfo, list);
}
}
else {
mismatchedExpressions = Collections.emptyList();
toolTip = description;
}
if (mismatchedExpressions.size() == list.getExpressions().length || mismatchedExpressions.isEmpty()) {
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(list).description(description).escapedToolTip(toolTip).navigationShift(1).create();
}
else {
HighlightInfo highlightInfo = null;
for (PsiExpression wrongArg : mismatchedExpressions) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(wrongArg)
.description(description)
.escapedToolTip(toolTip).create();
if (highlightInfo == null) {
highlightInfo = info;
}
else {
holder.add(info);
}
}
return highlightInfo;
}
}
private static String createOneArgMismatchTooltip(MethodCandidateInfo candidateInfo,
@NotNull List<? extends PsiExpression> mismatchedExpressions,
PsiExpression[] expressions,
PsiParameter[] parameters) {
final PsiExpression wrongArg = mismatchedExpressions.get(0);
final PsiType argType = wrongArg.getType();
if (argType != null) {
boolean varargs = candidateInfo.getApplicabilityLevel() == MethodCandidateInfo.ApplicabilityLevel.VARARGS;
int idx = ArrayUtil.find(expressions, wrongArg);
PsiType paramType = candidateInfo.getSubstitutor().substitute(PsiTypesUtil.getParameterType(parameters, idx, varargs));
String errorMessage = candidateInfo.getInferenceErrorMessage();
String reason = errorMessage != null ? "<table><tr><td style='padding-left: 4px; padding-top: 10;'>" +
"reason: " + XmlStringUtil.escapeString(errorMessage).replaceAll("\n", "<br/>") +
"</td></tr></table>"
: "";
return HighlightUtil.createIncompatibleTypesTooltip(paramType, argType,
(lRawType, lTypeArguments, rRawType, rTypeArguments) ->
JavaErrorBundle
.message("incompatible.types.html.tooltip", lRawType, lTypeArguments, rRawType, rTypeArguments, reason, "#" + ColorUtil.toHex(UIUtil.getContextHelpForeground())));
}
return null;
}
static HighlightInfo createIncompatibleTypeHighlightInfo(@NotNull PsiCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull MethodCandidateInfo resolveResult,
TextRange fixRange) {
String errorMessage = resolveResult.getInferenceErrorMessage();
if (errorMessage == null) return null;
PsiMethod method = resolveResult.getElement();
HighlightInfo highlightInfo;
PsiType expectedTypeByParent = InferenceSession.getTargetTypeByParent(methodCall);
PsiType actualType = resolveResult.getSubstitutor(false).substitute(method.getReturnType());
if (expectedTypeByParent != null && actualType != null && !expectedTypeByParent.isAssignableFrom(actualType)) {
highlightInfo = HighlightUtil
.createIncompatibleTypeHighlightInfo(expectedTypeByParent, actualType, fixRange, 0, XmlStringUtil.escapeString(errorMessage));
}
else {
highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).descriptionAndTooltip(errorMessage).range(fixRange).create();
}
if (highlightInfo != null && methodCall instanceof PsiMethodCallExpression) {
registerMethodCallIntentions(highlightInfo, (PsiMethodCallExpression)methodCall, ((PsiMethodCallExpression)methodCall).getArgumentList(), resolveHelper);
registerMethodReturnFixAction(highlightInfo, resolveResult, methodCall);
registerTargetTypeFixesBasedOnApplicabilityInference((PsiMethodCallExpression)methodCall, resolveResult, method, highlightInfo);
}
return highlightInfo;
}
private static void registerUsageFixes(@NotNull PsiMethodCallExpression methodCall,
@Nullable HighlightInfo highlightInfo,
@NotNull TextRange range) {
for (IntentionAction action : QUICK_FIX_FACTORY.createCreateMethodFromUsageFixes(methodCall)) {
QuickFixAction.registerQuickFixAction(highlightInfo, range, action);
}
}
private static void registerThisSuperFixes(@NotNull PsiMethodCallExpression methodCall,
@Nullable HighlightInfo highlightInfo,
@NotNull TextRange range) {
for (IntentionAction action : QUICK_FIX_FACTORY.createCreateConstructorFromCallExpressionFixes(methodCall)) {
QuickFixAction.registerQuickFixAction(highlightInfo, range, action);
}
}
private static void registerTargetTypeFixesBasedOnApplicabilityInference(@NotNull PsiMethodCallExpression methodCall,
@NotNull MethodCandidateInfo resolveResult,
@NotNull PsiMethod resolved,
HighlightInfo highlightInfo) {
PsiElement parent = PsiUtil.skipParenthesizedExprUp(methodCall.getParent());
PsiVariable variable = null;
if (parent instanceof PsiVariable) {
variable = (PsiVariable)parent;
}
else if (parent instanceof PsiAssignmentExpression) {
PsiExpression lExpression = ((PsiAssignmentExpression)parent).getLExpression();
if (lExpression instanceof PsiReferenceExpression) {
PsiElement resolve = ((PsiReferenceExpression)lExpression).resolve();
if (resolve instanceof PsiVariable) {
variable = (PsiVariable)resolve;
}
}
}
if (variable != null) {
PsiType rType = methodCall.getType();
if (rType != null && !variable.getType().isAssignableFrom(rType)) {
PsiType expectedTypeByApplicabilityConstraints = resolveResult.getSubstitutor(false).substitute(resolved.getReturnType());
if (expectedTypeByApplicabilityConstraints != null && !variable.getType().isAssignableFrom(expectedTypeByApplicabilityConstraints) &&
PsiTypesUtil.allTypeParametersResolved(variable, expectedTypeByApplicabilityConstraints)) {
HighlightFixUtil.registerChangeVariableTypeFixes(variable, expectedTypeByApplicabilityConstraints, methodCall, highlightInfo);
}
}
}
}
static HighlightInfo checkStaticInterfaceCallQualifier(@NotNull PsiReferenceExpression referenceToMethod,
@NotNull JavaResolveResult resolveResult,
@NotNull TextRange fixRange,
@NotNull PsiClass containingClass) {
String message = checkStaticInterfaceMethodCallQualifier(referenceToMethod, resolveResult.getCurrentFileResolveScope(), containingClass);
if (message != null) {
HighlightInfo highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).descriptionAndTooltip(message).range(fixRange).create();
QuickFixAction
.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createAccessStaticViaInstanceFix(referenceToMethod, resolveResult));
return highlightInfo;
}
return null;
}
/* see also PsiReferenceExpressionImpl.hasValidQualifier() */
private static String checkStaticInterfaceMethodCallQualifier(@NotNull PsiReferenceExpression ref,
@Nullable PsiElement scope,
@NotNull PsiClass containingClass) {
PsiExpression qualifierExpression = ref.getQualifierExpression();
if (qualifierExpression == null && (scope instanceof PsiImportStaticStatement || PsiTreeUtil.isAncestor(containingClass, ref, true))) {
return null;
}
if (qualifierExpression instanceof PsiReferenceExpression) {
PsiElement resolve = ((PsiReferenceExpression)qualifierExpression).resolve();
if (containingClass.getManager().areElementsEquivalent(resolve, containingClass)) {
return null;
}
if (resolve instanceof PsiTypeParameter) {
Set<PsiClass> classes = new HashSet<>();
for (PsiClassType type : ((PsiTypeParameter)resolve).getExtendsListTypes()) {
PsiClass aClass = type.resolve();
if (aClass != null) {
classes.add(aClass);
}
}
if (classes.size() == 1 && classes.contains(containingClass)) {
return null;
}
}
}
return JavaErrorBundle.message("static.interface.method.call.qualifier");
}
private static void registerMethodReturnFixAction(@NotNull HighlightInfo highlightInfo,
@NotNull MethodCandidateInfo candidate,
@NotNull PsiCall methodCall) {
if (methodCall.getParent() instanceof PsiReturnStatement) {
final PsiMethod containerMethod = PsiTreeUtil.getParentOfType(methodCall, PsiMethod.class, true, PsiLambdaExpression.class);
if (containerMethod != null) {
final PsiMethod method = candidate.getElement();
final PsiExpression methodCallCopy =
JavaPsiFacade.getElementFactory(method.getProject()).createExpressionFromText(methodCall.getText(), methodCall);
PsiType methodCallTypeByArgs = methodCallCopy.getType();
//ensure type params are not included
methodCallTypeByArgs = JavaPsiFacade.getElementFactory(method.getProject())
.createRawSubstitutor(method).substitute(methodCallTypeByArgs);
if (methodCallTypeByArgs != null) {
QuickFixAction.registerQuickFixAction(highlightInfo,
getFixRange(methodCall),
QUICK_FIX_FACTORY.createMethodReturnFix(containerMethod, methodCallTypeByArgs, true));
}
}
}
}
@NotNull
private static List<PsiExpression> mismatchedArgs(PsiExpression @NotNull [] expressions,
PsiSubstitutor substitutor,
PsiParameter @NotNull [] parameters,
boolean varargs) {
if ((parameters.length == 0 || !parameters[parameters.length - 1].isVarArgs()) && parameters.length != expressions.length) {
return Collections.emptyList();
}
List<PsiExpression> result = new ArrayList<>();
for (int i = 0; i < Math.max(parameters.length, expressions.length); i++) {
if (!assignmentCompatible(i, parameters, expressions, substitutor, varargs)) {
result.add(i < expressions.length ? expressions[i] : null);
}
}
return result;
}
static boolean isDummyConstructorCall(@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull PsiExpressionList list,
@NotNull PsiReferenceExpression referenceToMethod) {
boolean isDummy = false;
boolean isThisOrSuper = referenceToMethod.getReferenceNameElement() instanceof PsiKeyword;
if (isThisOrSuper) {
// super(..) or this(..)
if (list.isEmpty()) { // implicit ctr call
CandidateInfo[] candidates = resolveHelper.getReferencedMethodCandidates(methodCall, true);
if (candidates.length == 1 && !candidates[0].getElement().isPhysical()) {
isDummy = true;// dummy constructor
}
}
}
return isDummy;
}
static HighlightInfo checkAmbiguousMethodCallIdentifier(@NotNull PsiReferenceExpression referenceToMethod,
JavaResolveResult @NotNull [] resolveResults,
@NotNull PsiExpressionList list,
@Nullable PsiElement element,
@NotNull JavaResolveResult resolveResult,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull LanguageLevel languageLevel,
@NotNull PsiFile file) {
MethodCandidateInfo methodCandidate2 = findCandidates(resolveResults).second;
if (methodCandidate2 != null) return null;
MethodCandidateInfo[] candidates = toMethodCandidates(resolveResults);
HighlightInfoType highlightInfoType = HighlightInfoType.ERROR;
String description;
PsiElement elementToHighlight = ObjectUtils.notNull(referenceToMethod.getReferenceNameElement(), referenceToMethod);
if (element != null && !resolveResult.isAccessible()) {
description = HighlightUtil.accessProblemDescription(referenceToMethod, element, resolveResult);
}
else if (element != null && !resolveResult.isStaticsScopeCorrect()) {
if (element instanceof PsiMethod && ((PsiMethod)element).hasModifierProperty(PsiModifier.STATIC)) {
PsiClass containingClass = ((PsiMethod)element).getContainingClass();
if (containingClass != null && containingClass.isInterface()) {
HighlightInfo info = HighlightUtil.checkFeature(elementToHighlight, HighlightingFeature.STATIC_INTERFACE_CALLS, languageLevel, file);
if (info != null) return info;
info = checkStaticInterfaceCallQualifier(referenceToMethod, resolveResult, elementToHighlight.getTextRange(), containingClass);
if (info != null) return info;
}
}
description = HighlightUtil.staticContextProblemDescription(element);
}
else if (candidates.length == 0) {
PsiClass qualifierClass = RefactoringChangeUtil.getQualifierClass(referenceToMethod);
String qualifier = qualifierClass != null ? qualifierClass.getName() : null;
description = qualifier != null ? JavaErrorBundle
.message("ambiguous.method.call.no.match", referenceToMethod.getReferenceName(), qualifier)
: JavaErrorBundle
.message("cannot.resolve.method", referenceToMethod.getReferenceName() + buildArgTypesList(list));
highlightInfoType = HighlightInfoType.WRONG_REF;
}
else {
return null;
}
String toolTip = XmlStringUtil.escapeString(description);
HighlightInfo info =
HighlightInfo.newHighlightInfo(highlightInfoType).range(elementToHighlight).description(description).escapedToolTip(toolTip).create();
registerMethodCallIntentions(info, methodCall, list, resolveHelper);
if (element != null && !resolveResult.isStaticsScopeCorrect()) {
HighlightFixUtil.registerStaticProblemQuickFixAction(element, info, referenceToMethod);
}
TextRange fixRange = getFixRange(elementToHighlight);
CastMethodArgumentFix.REGISTRAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapObjectWithOptionalOfNullableFix.REGISTAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapWithAdapterMethodCallFix.registerCastActions(candidates, methodCall, info, fixRange);
PermuteArgumentsFix.registerFix(info, methodCall, candidates, fixRange);
WrapExpressionFix.registerWrapAction(candidates, list.getExpressions(), info, fixRange);
registerChangeParameterClassFix(methodCall, list, info);
if (candidates.length == 0) {
UnresolvedReferenceQuickFixProvider.registerReferenceFixes(methodCall.getMethodExpression(), new QuickFixActionRegistrarImpl(info));
}
return info;
}
static HighlightInfo checkAmbiguousMethodCallArguments(@NotNull PsiReferenceExpression referenceToMethod,
JavaResolveResult @NotNull [] resolveResults,
@NotNull PsiExpressionList list,
final PsiElement element,
@NotNull JavaResolveResult resolveResult,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiResolveHelper resolveHelper,
@NotNull PsiElement elementToHighlight) {
Pair<MethodCandidateInfo, MethodCandidateInfo> pair = findCandidates(resolveResults);
MethodCandidateInfo methodCandidate1 = pair.first;
MethodCandidateInfo methodCandidate2 = pair.second;
MethodCandidateInfo[] candidates = toMethodCandidates(resolveResults);
String description;
String toolTip;
HighlightInfoType highlightInfoType = HighlightInfoType.ERROR;
if (methodCandidate2 != null) {
PsiMethod element1 = methodCandidate1.getElement();
String m1 = PsiFormatUtil.formatMethod(element1,
methodCandidate1.getSubstitutor(false),
PsiFormatUtilBase.SHOW_CONTAINING_CLASS | PsiFormatUtilBase.SHOW_NAME |
PsiFormatUtilBase.SHOW_PARAMETERS,
PsiFormatUtilBase.SHOW_TYPE);
PsiMethod element2 = methodCandidate2.getElement();
String m2 = PsiFormatUtil.formatMethod(element2,
methodCandidate2.getSubstitutor(false),
PsiFormatUtilBase.SHOW_CONTAINING_CLASS | PsiFormatUtilBase.SHOW_NAME |
PsiFormatUtilBase.SHOW_PARAMETERS,
PsiFormatUtilBase.SHOW_TYPE);
VirtualFile virtualFile1 = PsiUtilCore.getVirtualFile(element1);
VirtualFile virtualFile2 = PsiUtilCore.getVirtualFile(element2);
if (!Comparing.equal(virtualFile1, virtualFile2)) {
if (virtualFile1 != null) m1 += " (In " + virtualFile1.getPresentableUrl() + ")";
if (virtualFile2 != null) m2 += " (In " + virtualFile2.getPresentableUrl() + ")";
}
description = JavaErrorBundle.message("ambiguous.method.call", m1, m2);
toolTip = createAmbiguousMethodHtmlTooltip(new MethodCandidateInfo[]{methodCandidate1, methodCandidate2});
}
else {
if (element != null && !resolveResult.isAccessible()) {
return null;
}
if (element != null && !resolveResult.isStaticsScopeCorrect()) {
return null;
}
String methodName = referenceToMethod.getReferenceName() + buildArgTypesList(list);
description = JavaErrorBundle.message("cannot.resolve.method", methodName);
if (candidates.length == 0) {
return null;
}
toolTip = XmlStringUtil.escapeString(description);
}
HighlightInfo info =
HighlightInfo.newHighlightInfo(highlightInfoType).range(elementToHighlight).description(description).escapedToolTip(toolTip).create();
if (methodCandidate2 == null) {
registerMethodCallIntentions(info, methodCall, list, resolveHelper);
}
if (!resolveResult.isAccessible() && resolveResult.isStaticsScopeCorrect() && methodCandidate2 != null) {
HighlightFixUtil.registerAccessQuickFixAction((PsiJvmMember)element, referenceToMethod, info, resolveResult.getCurrentFileResolveScope());
}
if (element != null && !resolveResult.isStaticsScopeCorrect()) {
HighlightFixUtil.registerStaticProblemQuickFixAction(element, info, referenceToMethod);
}
TextRange fixRange = getFixRange(elementToHighlight);
CastMethodArgumentFix.REGISTRAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapObjectWithOptionalOfNullableFix.REGISTAR.registerCastActions(candidates, methodCall, info, fixRange);
WrapWithAdapterMethodCallFix.registerCastActions(candidates, methodCall, info, fixRange);
PermuteArgumentsFix.registerFix(info, methodCall, candidates, fixRange);
WrapExpressionFix.registerWrapAction(candidates, list.getExpressions(), info, fixRange);
registerChangeParameterClassFix(methodCall, list, info);
return info;
}
@NotNull
private static Pair<MethodCandidateInfo, MethodCandidateInfo> findCandidates(JavaResolveResult @NotNull [] resolveResults) {
MethodCandidateInfo methodCandidate1 = null;
MethodCandidateInfo methodCandidate2 = null;
for (JavaResolveResult result : resolveResults) {
if (!(result instanceof MethodCandidateInfo)) continue;
MethodCandidateInfo candidate = (MethodCandidateInfo)result;
if (candidate.isApplicable() && !candidate.getElement().isConstructor()) {
if (methodCandidate1 == null) {
methodCandidate1 = candidate;
}
else {
methodCandidate2 = candidate;
break;
}
}
}
return Pair.pair(methodCandidate1, methodCandidate2);
}
private static MethodCandidateInfo @NotNull [] toMethodCandidates(JavaResolveResult @NotNull [] resolveResults) {
List<MethodCandidateInfo> candidateList = new ArrayList<>(resolveResults.length);
for (JavaResolveResult result : resolveResults) {
if (!(result instanceof MethodCandidateInfo)) continue;
MethodCandidateInfo candidate = (MethodCandidateInfo)result;
if (candidate.isAccessible()) candidateList.add(candidate);
}
return candidateList.toArray(new MethodCandidateInfo[0]);
}
private static void registerMethodCallIntentions(@Nullable HighlightInfo highlightInfo,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiExpressionList list,
@NotNull PsiResolveHelper resolveHelper) {
TextRange fixRange = getFixRange(methodCall);
final PsiExpression qualifierExpression = methodCall.getMethodExpression().getQualifierExpression();
if (qualifierExpression instanceof PsiReferenceExpression) {
final PsiElement resolve = ((PsiReferenceExpression)qualifierExpression).resolve();
if (resolve instanceof PsiClass &&
((PsiClass)resolve).getContainingClass() != null &&
!((PsiClass)resolve).hasModifierProperty(PsiModifier.STATIC)) {
QuickFixAction.registerQuickFixActions(highlightInfo, null, JvmElementActionFactories.createModifierActions((PsiClass)resolve, MemberRequestsKt.modifierRequest(JvmModifier.STATIC, true)));
}
}
else if (qualifierExpression instanceof PsiSuperExpression && ((PsiSuperExpression)qualifierExpression).getQualifier() == null) {
QualifySuperArgumentFix.registerQuickFixAction((PsiSuperExpression)qualifierExpression, highlightInfo);
}
registerUsageFixes(methodCall, highlightInfo, fixRange);
registerThisSuperFixes(methodCall, highlightInfo, fixRange);
CandidateInfo[] methodCandidates = resolveHelper.getReferencedMethodCandidates(methodCall, false);
CastMethodArgumentFix.REGISTRAR.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
AddTypeArgumentsFix.REGISTRAR.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
WrapObjectWithOptionalOfNullableFix.REGISTAR.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
MethodReturnFixFactory.INSTANCE.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
WrapWithAdapterMethodCallFix.registerCastActions(methodCandidates, methodCall, highlightInfo, fixRange);
registerMethodAccessLevelIntentions(methodCandidates, methodCall, list, highlightInfo);
if (!PermuteArgumentsFix.registerFix(highlightInfo, methodCall, methodCandidates, fixRange)) {
registerChangeMethodSignatureFromUsageIntentions(methodCandidates, list, highlightInfo, fixRange);
}
RemoveRedundantArgumentsFix.registerIntentions(methodCandidates, list, highlightInfo, fixRange);
ConvertDoubleToFloatFix.registerIntentions(methodCandidates, list, highlightInfo, fixRange);
WrapExpressionFix.registerWrapAction(methodCandidates, list.getExpressions(), highlightInfo, fixRange);
registerChangeParameterClassFix(methodCall, list, highlightInfo);
if (methodCandidates.length == 0) {
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createStaticImportMethodFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createQualifyStaticMethodCallFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.addMethodQualifierFix(methodCall));
}
for (IntentionAction action : QUICK_FIX_FACTORY.getVariableTypeFromCallFixes(methodCall, list)) {
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, action);
}
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createReplaceAddAllArrayToCollectionFix(methodCall));
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createSurroundWithArrayFix(methodCall, null));
QualifyThisArgumentFix.registerQuickFixAction(methodCandidates, methodCall, highlightInfo, fixRange);
PsiType expectedTypeByParent = PsiTypesUtil.getExpectedTypeByParent(methodCall);
if (expectedTypeByParent != null) {
PsiType methodCallType = methodCall.getType();
if (methodCallType != null &&
TypeConversionUtil.areTypesConvertible(methodCallType, expectedTypeByParent) &&
!TypeConversionUtil.isAssignable(expectedTypeByParent, methodCallType)) {
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, QUICK_FIX_FACTORY.createAddTypeCastFix(expectedTypeByParent, methodCall));
}
}
CandidateInfo[] candidates = resolveHelper.getReferencedMethodCandidates(methodCall, true);
ChangeStringLiteralToCharInMethodCallFix.registerFixes(candidates, methodCall, highlightInfo);
}
private static void registerMethodAccessLevelIntentions(CandidateInfo @NotNull [] methodCandidates,
@NotNull PsiMethodCallExpression methodCall,
@NotNull PsiExpressionList exprList,
@Nullable HighlightInfo highlightInfo) {
for (CandidateInfo methodCandidate : methodCandidates) {
PsiMethod method = (PsiMethod)methodCandidate.getElement();
if (!methodCandidate.isAccessible() && PsiUtil.isApplicable(method, methodCandidate.getSubstitutor(), exprList)) {
HighlightFixUtil.registerAccessQuickFixAction(method, methodCall.getMethodExpression(), highlightInfo, methodCandidate.getCurrentFileResolveScope());
}
}
}
@NotNull
private static String createAmbiguousMethodHtmlTooltip(MethodCandidateInfo @NotNull [] methodCandidates) {
return JavaErrorBundle.message("ambiguous.method.html.tooltip",
methodCandidates[0].getElement().getParameterList().getParametersCount() + 2,
createAmbiguousMethodHtmlTooltipMethodRow(methodCandidates[0]),
getContainingClassName(methodCandidates[0]),
createAmbiguousMethodHtmlTooltipMethodRow(methodCandidates[1]),
getContainingClassName(methodCandidates[1]));
}
@NotNull
private static String getContainingClassName(@NotNull MethodCandidateInfo methodCandidate) {
PsiMethod method = methodCandidate.getElement();
PsiClass containingClass = method.getContainingClass();
return containingClass == null ? method.getContainingFile().getName() : HighlightUtil.formatClass(containingClass, false);
}
@Language("HTML")
@NotNull
private static String createAmbiguousMethodHtmlTooltipMethodRow(@NotNull MethodCandidateInfo methodCandidate) {
PsiMethod method = methodCandidate.getElement();
PsiParameter[] parameters = method.getParameterList().getParameters();
PsiSubstitutor substitutor = methodCandidate.getSubstitutor();
StringBuilder ms = new StringBuilder("<td><b>" + method.getName() + "</b></td>");
for (int j = 0; j < parameters.length; j++) {
PsiParameter parameter = parameters[j];
PsiType type = substitutor.substitute(parameter.getType());
ms.append("<td><b>").append(j == 0 ? "(" : "").append(XmlStringUtil.escapeString(type.getPresentableText()))
.append(j == parameters.length - 1 ? ")" : ",").append("</b></td>");
}
if (parameters.length == 0) {
ms.append("<td><b>()</b></td>");
}
return ms.toString();
}
@NotNull
private static String createMismatchedArgumentsHtmlTooltip(@NotNull MethodCandidateInfo info, @NotNull PsiExpressionList list) {
PsiMethod method = info.getElement();
PsiSubstitutor substitutor = info.getSubstitutor();
PsiParameter[] parameters = method.getParameterList().getParameters();
return createMismatchedArgumentsHtmlTooltip(list, info, parameters, substitutor);
}
@Language("HTML")
@NotNull
private static String createMismatchedArgumentsHtmlTooltip(@NotNull PsiExpressionList list,
@Nullable MethodCandidateInfo info,
PsiParameter @NotNull [] parameters,
@NotNull PsiSubstitutor substitutor) {
PsiExpression[] expressions = list.getExpressions();
if ((parameters.length == 0 || !parameters[parameters.length - 1].isVarArgs()) &&
parameters.length != expressions.length) {
return "<html>Expected " + parameters.length + " arguments but found " + expressions.length + "</html>";
}
String greyedColor = ColorUtil.toHtmlColor(UIUtil.getContextHelpForeground());
StringBuilder s = new StringBuilder("<html><body><table>");
s.append("<tr>");
s.append("<td/>");
s.append("<td style='color: ").append(greyedColor).append("; padding-left: 16px; padding-right: 24px;'>Required type</td>");
s.append("<td style='color: ").append(greyedColor).append("; padding-right: 28px;'>Provided</td>");
s.append("</tr>");
String parameterNameStyle = String.format("color: %s; font-size:%dpt; padding:1px 4px 1px 4px;",
greyedColor,
StartupUiUtil.getLabelFont().getSize() - (SystemInfo.isWindows ? 0 : 1));
Color paramBgColor = EditorColorsUtil.getGlobalOrDefaultColorScheme()
.getAttributes(DefaultLanguageHighlighterColors.INLINE_PARAMETER_HINT)
.getBackgroundColor();
if (paramBgColor != null) {
parameterNameStyle += "background-color: " + ColorUtil.toHtmlColor(paramBgColor) + ";";
}
boolean varargAdded = false;
for (int i = 0; i < Math.max(parameters.length, expressions.length); i++) {
boolean varargs = info != null && info.isVarargs();
if (assignmentCompatible(i, parameters, expressions, substitutor, varargs)) continue;
PsiParameter parameter = null;
if (i < parameters.length) {
parameter = parameters[i];
varargAdded = parameter.isVarArgs();
}
else if (!varargAdded) {
parameter = parameters[parameters.length - 1];
varargAdded = true;
}
PsiType parameterType = substitutor.substitute(PsiTypesUtil.getParameterType(parameters, i, varargs));
PsiExpression expression = i < expressions.length ? expressions[i] : null;
boolean showShortType = HighlightUtil.showShortType(parameterType,
expression != null ? expression.getType() : null);
s.append("<tr>");
if (parameter != null) {
s.append("<td><table><tr><td style='").append(parameterNameStyle).append("'>").append(parameter.getName()).append(":</td></tr></table></td>");
s.append("<td style='padding-left: 16px; padding-right: 24px;'>")
.append(HighlightUtil.redIfNotMatch(substitutor.substitute(parameter.getType()), true, showShortType))
.append("</td>");
}
else {
s.append("<td/>");
s.append("<td style='padding-left: 16px; padding-right: 24px;'/>");
}
if (expression != null) {
s.append("<td style='padding-right: 28px;'>")
.append(mismatchedExpressionType(parameterType, expression))
.append("</td>");
}
else {
s.append("<td style='padding-right: 28px;'/>");
}
s.append("</tr>");
}
s.append("</table>");
String errorMessage = info != null ? info.getInferenceErrorMessage() : null;
if (errorMessage != null) {
s.append("<table><tr><td style='padding-left: 4px; padding-top: 10;'>")
.append("reason: ").append(XmlStringUtil.escapeString(errorMessage).replaceAll("\n", "<br/>"))
.append("</td></tr></table>");
}
s.append("</body></html>");
return s.toString();
}
@NotNull
private static String mismatchedExpressionType(PsiType parameterType, @NotNull PsiExpression expression) {
return HighlightUtil.createIncompatibleTypesTooltip(parameterType, expression.getType(), new HighlightUtil.IncompatibleTypesTooltipComposer() {
@NotNull
@Override
public String consume(@NotNull String lRawType,
@NotNull String lTypeArguments,
@NotNull String rRawType,
@NotNull String rTypeArguments) {
return rRawType + rTypeArguments;
}
@Override
public boolean skipTypeArgsColumns() {
return true;
}
});
}
private static boolean assignmentCompatible(int i,
PsiParameter @NotNull [] parameters,
PsiExpression @NotNull [] expressions,
@NotNull PsiSubstitutor substitutor,
boolean varargs) {
PsiExpression expression = i < expressions.length ? expressions[i] : null;
if (expression == null) return true;
PsiType paramType = substitutor.substitute(PsiTypesUtil.getParameterType(parameters, i, varargs));
return paramType != null && TypeConversionUtil.areTypesAssignmentCompatible(paramType, expression);
}
static HighlightInfo checkMethodMustHaveBody(@NotNull PsiMethod method, @Nullable PsiClass aClass) {
HighlightInfo errorResult = null;
if (method.getBody() == null
&& !method.hasModifierProperty(PsiModifier.ABSTRACT)
&& !method.hasModifierProperty(PsiModifier.NATIVE)
&& aClass != null
&& !aClass.isInterface()
&& !PsiUtilCore.hasErrorElementChild(method)) {
int start = method.getModifierList().getTextRange().getStartOffset();
int end = method.getTextRange().getEndOffset();
String description = JavaErrorBundle.message("missing.method.body");
errorResult = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(start, end).descriptionAndTooltip(description).create();
if (HighlightUtil.getIncompatibleModifier(PsiModifier.ABSTRACT, method.getModifierList()) == null && !(aClass instanceof PsiAnonymousClass)) {
QuickFixAction.registerQuickFixActions(errorResult, null, JvmElementActionFactories.createModifierActions(method, MemberRequestsKt.modifierRequest(JvmModifier.ABSTRACT, true)));
}
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createAddMethodBodyFix(method));
}
return errorResult;
}
static HighlightInfo checkAbstractMethodInConcreteClass(@NotNull PsiMethod method, @NotNull PsiElement elementToHighlight) {
HighlightInfo errorResult = null;
PsiClass aClass = method.getContainingClass();
if (method.hasModifierProperty(PsiModifier.ABSTRACT)
&& aClass != null
&& !aClass.hasModifierProperty(PsiModifier.ABSTRACT)
&& !aClass.isEnum()
&& !PsiUtilCore.hasErrorElementChild(method)) {
String description = JavaErrorBundle.message("abstract.method.in.non.abstract.class");
errorResult =
HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(elementToHighlight).descriptionAndTooltip(description).create();
if (method.getBody() != null) {
QuickFixAction.registerQuickFixAction(errorResult,
QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.ABSTRACT, false, false));
}
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createAddMethodBodyFix(method));
QuickFixAction.registerQuickFixAction(errorResult, QUICK_FIX_FACTORY.createModifierListFix(aClass, PsiModifier.ABSTRACT, true, false));
}
return errorResult;
}
static HighlightInfo checkConstructorName(@NotNull PsiMethod method) {
PsiClass aClass = method.getContainingClass();
if (aClass != null) {
String className = aClass instanceof PsiAnonymousClass ? null : aClass.getName();
if (className == null || !Comparing.strEqual(method.getName(), className)) {
PsiElement element = ObjectUtils.notNull(method.getNameIdentifier(), method);
String description = JavaErrorBundle.message("missing.return.type");
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(element).descriptionAndTooltip(description).create();
if (className != null) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createRenameElementFix(method, className));
}
return info;
}
}
return null;
}
static HighlightInfo checkDuplicateMethod(@NotNull PsiClass aClass,
@NotNull PsiMethod method,
@NotNull MostlySingularMultiMap<MethodSignature, PsiMethod> duplicateMethods) {
if (method instanceof ExternallyDefinedPsiElement) return null;
MethodSignature methodSignature = method.getSignature(PsiSubstitutor.EMPTY);
int methodCount = 1;
List<PsiMethod> methods = (List<PsiMethod>)duplicateMethods.get(methodSignature);
if (methods.size() > 1) {
methodCount++;
}
if (methodCount == 1 && aClass.isEnum() &&
GenericsHighlightUtil.isEnumSyntheticMethod(methodSignature, aClass.getProject())) {
methodCount++;
}
if (methodCount > 1) {
String description = JavaErrorBundle.message("duplicate.method",
JavaHighlightUtil.formatMethod(method),
HighlightUtil.formatClass(aClass));
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).
range(method, textRange.getStartOffset(), textRange.getEndOffset()).
descriptionAndTooltip(description).create();
}
return null;
}
static HighlightInfo checkMethodCanHaveBody(@NotNull PsiMethod method, @NotNull LanguageLevel languageLevel) {
PsiClass aClass = method.getContainingClass();
boolean hasNoBody = method.getBody() == null;
boolean isInterface = aClass != null && aClass.isInterface();
boolean isExtension = method.hasModifierProperty(PsiModifier.DEFAULT);
boolean isStatic = method.hasModifierProperty(PsiModifier.STATIC);
boolean isPrivate = method.hasModifierProperty(PsiModifier.PRIVATE);
final List<IntentionAction> additionalFixes = new ArrayList<>();
String description = null;
if (hasNoBody) {
if (isExtension) {
description = JavaErrorBundle.message("extension.method.should.have.a.body");
}
else if (isInterface) {
if (isStatic && languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
description = "Static methods in interfaces should have a body";
}
else if (isPrivate && languageLevel.isAtLeast(LanguageLevel.JDK_1_9)) {
description = "Private methods in interfaces should have a body";
}
}
if (description != null) {
additionalFixes.add(QUICK_FIX_FACTORY.createAddMethodBodyFix(method));
}
}
else if (isInterface) {
if (!isExtension && !isStatic && !isPrivate) {
description = JavaErrorBundle.message("interface.methods.cannot.have.body");
if (languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
if (Stream.of(method.findDeepestSuperMethods()).map(PsiMethod::getContainingClass)
.filter(Objects::nonNull).map(PsiClass::getQualifiedName).noneMatch(CommonClassNames.JAVA_LANG_OBJECT::equals)) {
additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.DEFAULT, true, false));
additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.STATIC, true, false));
}
}
}
}
else if (isExtension) {
description = JavaErrorBundle.message("extension.method.in.class");
additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.DEFAULT, false, false));
}
else if (method.hasModifierProperty(PsiModifier.ABSTRACT)) {
description = JavaErrorBundle.message("abstract.methods.cannot.have.a.body");
}
else if (method.hasModifierProperty(PsiModifier.NATIVE)) {
description = JavaErrorBundle.message("native.methods.cannot.have.a.body");
}
if (description == null) return null;
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
if (!hasNoBody) {
if (!isExtension) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createDeleteMethodBodyFix(method));
}
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createPushDownMethodFix());
}
if (method.hasModifierProperty(PsiModifier.ABSTRACT) && !isInterface) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.ABSTRACT, false, false));
}
for (IntentionAction intentionAction : additionalFixes) {
QuickFixAction.registerQuickFixAction(info, intentionAction);
}
return info;
}
static HighlightInfo checkConstructorCallProblems(@NotNull PsiMethodCallExpression methodCall) {
if (!JavaPsiConstructorUtil.isConstructorCall(methodCall)) return null;
PsiElement codeBlock = methodCall.getParent().getParent();
if (codeBlock instanceof PsiCodeBlock) {
PsiMethod ctor = ObjectUtils.tryCast(codeBlock.getParent(), PsiMethod.class);
if (ctor != null && ctor.isConstructor()) {
if (JavaPsiRecordUtil.isCompactConstructor(ctor) ||
JavaPsiRecordUtil.isExplicitCanonicalConstructor(ctor)) {
String message = JavaErrorBundle.message("record.constructor.call.in.canonical");
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCall).descriptionAndTooltip(message).create();
}
PsiElement prevSibling = methodCall.getParent().getPrevSibling();
while (true) {
if (prevSibling == null) return null;
if (prevSibling instanceof PsiStatement) break;
prevSibling = prevSibling.getPrevSibling();
}
}
}
PsiReferenceExpression expression = methodCall.getMethodExpression();
String message = JavaErrorBundle.message("constructor.call.must.be.first.statement", expression.getText() + "()");
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCall).descriptionAndTooltip(message).create();
}
static HighlightInfo checkSuperAbstractMethodDirectCall(@NotNull PsiMethodCallExpression methodCallExpression) {
PsiReferenceExpression expression = methodCallExpression.getMethodExpression();
if (!(expression.getQualifierExpression() instanceof PsiSuperExpression)) return null;
PsiMethod method = methodCallExpression.resolveMethod();
if (method != null && method.hasModifierProperty(PsiModifier.ABSTRACT)) {
String message = JavaErrorBundle.message("direct.abstract.method.access", JavaHighlightUtil.formatMethod(method));
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(methodCallExpression).descriptionAndTooltip(message).create();
}
return null;
}
static HighlightInfo checkConstructorCallsBaseClassConstructor(@NotNull PsiMethod constructor,
@Nullable RefCountHolder refCountHolder,
@NotNull PsiResolveHelper resolveHelper) {
if (!constructor.isConstructor()) return null;
PsiClass aClass = constructor.getContainingClass();
if (aClass == null) return null;
if (aClass.isEnum()) return null;
PsiCodeBlock body = constructor.getBody();
if (body == null) return null;
if (JavaPsiConstructorUtil.findThisOrSuperCallInConstructor(constructor) != null) return null;
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(constructor);
PsiClassType[] handledExceptions = constructor.getThrowsList().getReferencedTypes();
HighlightInfo info = HighlightClassUtil.checkBaseClassDefaultConstructorProblem(aClass, refCountHolder, resolveHelper, textRange, handledExceptions);
if (info != null) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createInsertSuperFix(constructor));
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createInsertThisFix(constructor));
PsiClass superClass = aClass.getSuperClass();
if (superClass != null) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createAddDefaultConstructorFix(superClass));
}
}
return info;
}
/**
* @return error if static method overrides instance method or
* instance method overrides static. see JLS 8.4.6.1, 8.4.6.2
*/
static HighlightInfo checkStaticMethodOverride(@NotNull PsiMethod method, @NotNull PsiFile containingFile) {
// constructors are not members and therefor don't override class methods
if (method.isConstructor()) {
return null;
}
PsiClass aClass = method.getContainingClass();
if (aClass == null) return null;
final HierarchicalMethodSignature methodSignature = PsiSuperMethodImplUtil.getHierarchicalMethodSignature(method);
final List<HierarchicalMethodSignature> superSignatures = methodSignature.getSuperSignatures();
if (superSignatures.isEmpty()) {
return null;
}
boolean isStatic = method.hasModifierProperty(PsiModifier.STATIC);
for (HierarchicalMethodSignature signature : superSignatures) {
final PsiMethod superMethod = signature.getMethod();
final PsiClass superClass = superMethod.getContainingClass();
if (superClass == null) continue;
final HighlightInfo highlightInfo = checkStaticMethodOverride(aClass, method, isStatic, superClass, superMethod, containingFile);
if (highlightInfo != null) {
return highlightInfo;
}
}
return null;
}
private static HighlightInfo checkStaticMethodOverride(@NotNull PsiClass aClass,
@NotNull PsiMethod method,
boolean isMethodStatic,
@NotNull PsiClass superClass,
@NotNull PsiMethod superMethod,
@NotNull PsiFile containingFile) {
PsiManager manager = containingFile.getManager();
PsiModifierList superModifierList = superMethod.getModifierList();
PsiModifierList modifierList = method.getModifierList();
if (superModifierList.hasModifierProperty(PsiModifier.PRIVATE)) return null;
if (superModifierList.hasModifierProperty(PsiModifier.PACKAGE_LOCAL)
&& !JavaPsiFacade.getInstance(manager.getProject()).arePackagesTheSame(aClass, superClass)) {
return null;
}
boolean isSuperMethodStatic = superModifierList.hasModifierProperty(PsiModifier.STATIC);
if (isMethodStatic != isSuperMethodStatic) {
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
final String messageKey = isMethodStatic
? "static.method.cannot.override.instance.method"
: "instance.method.cannot.override.static.method";
String description = JavaErrorBundle.message(messageKey,
JavaHighlightUtil.formatMethod(method),
HighlightUtil.formatClass(aClass),
JavaHighlightUtil.formatMethod(superMethod),
HighlightUtil.formatClass(superClass));
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
if (!isSuperMethodStatic || HighlightUtil.getIncompatibleModifier(PsiModifier.STATIC, modifierList) == null) {
QuickFixAction.registerQuickFixAction(info,
QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.STATIC, isSuperMethodStatic, false));
}
if (manager.isInProject(superMethod) &&
(!isMethodStatic || HighlightUtil.getIncompatibleModifier(PsiModifier.STATIC, superModifierList) == null)) {
QuickFixAction.registerQuickFixActions(info, null, JvmElementActionFactories.createModifierActions(superMethod, MemberRequestsKt.modifierRequest(JvmModifier.STATIC, isMethodStatic)));
}
return info;
}
if (isMethodStatic) {
if (superClass.isInterface()) return null;
int accessLevel = PsiUtil.getAccessLevel(modifierList);
String accessModifier = PsiUtil.getAccessModifier(accessLevel);
HighlightInfo info = isWeaker(method, modifierList, accessModifier, accessLevel, superMethod, true);
if (info != null) return info;
info = checkSuperMethodIsFinal(method, superMethod);
if (info != null) return info;
}
return null;
}
private static HighlightInfo checkInterfaceInheritedMethodsReturnTypes(@NotNull List<? extends MethodSignatureBackedByPsiMethod> superMethodSignatures,
@NotNull LanguageLevel languageLevel) {
if (superMethodSignatures.size() < 2) return null;
final MethodSignatureBackedByPsiMethod[] returnTypeSubstitutable = {superMethodSignatures.get(0)};
for (int i = 1; i < superMethodSignatures.size(); i++) {
PsiMethod currentMethod = returnTypeSubstitutable[0].getMethod();
PsiType currentType = returnTypeSubstitutable[0].getSubstitutor().substitute(currentMethod.getReturnType());
MethodSignatureBackedByPsiMethod otherSuperSignature = superMethodSignatures.get(i);
PsiMethod otherSuperMethod = otherSuperSignature.getMethod();
PsiSubstitutor otherSubstitutor = otherSuperSignature.getSubstitutor();
PsiType otherSuperReturnType = otherSubstitutor.substitute(otherSuperMethod.getReturnType());
PsiSubstitutor unifyingSubstitutor = MethodSignatureUtil.getSuperMethodSignatureSubstitutor(returnTypeSubstitutable[0],
otherSuperSignature);
if (unifyingSubstitutor != null) {
otherSuperReturnType = unifyingSubstitutor.substitute(otherSuperReturnType);
currentType = unifyingSubstitutor.substitute(currentType);
}
if (otherSuperReturnType == null || currentType == null || otherSuperReturnType.equals(currentType)) continue;
PsiType otherReturnType = otherSuperReturnType;
PsiType curType = currentType;
final HighlightInfo info =
LambdaUtil.performWithSubstitutedParameterBounds(otherSuperMethod.getTypeParameters(), otherSubstitutor, () -> {
if (languageLevel.isAtLeast(LanguageLevel.JDK_1_5)) {
//http://docs.oracle.com/javase/specs/jls/se7/html/jls-8.html#jls-8.4.8 Example 8.1.5-3
if (!(otherReturnType instanceof PsiPrimitiveType || curType instanceof PsiPrimitiveType)) {
if (otherReturnType.isAssignableFrom(curType)) return null;
if (curType.isAssignableFrom(otherReturnType)) {
returnTypeSubstitutable[0] = otherSuperSignature;
return null;
}
}
if (otherSuperMethod.getTypeParameters().length > 0 && JavaGenericsUtil.isRawToGeneric(otherReturnType, curType)) return null;
}
return createIncompatibleReturnTypeMessage(otherSuperMethod, currentMethod, curType, otherReturnType,
JavaErrorBundle.message("unrelated.overriding.methods.return.types"), TextRange.EMPTY_RANGE);
});
if (info != null) return info;
}
return null;
}
static HighlightInfo checkOverrideEquivalentInheritedMethods(@NotNull PsiClass aClass,
@NotNull PsiFile containingFile,
@NotNull LanguageLevel languageLevel) {
String description = null;
boolean appendImplementMethodFix = true;
final Collection<HierarchicalMethodSignature> visibleSignatures = aClass.getVisibleSignatures();
PsiResolveHelper resolveHelper = JavaPsiFacade.getInstance(aClass.getProject()).getResolveHelper();
Ultimate:
for (HierarchicalMethodSignature signature : visibleSignatures) {
PsiMethod method = signature.getMethod();
if (!resolveHelper.isAccessible(method, aClass, null)) continue;
List<HierarchicalMethodSignature> superSignatures = signature.getSuperSignatures();
boolean allAbstracts = method.hasModifierProperty(PsiModifier.ABSTRACT);
PsiClass containingClass = method.getContainingClass();
if (containingClass == null || aClass.equals(containingClass)) continue; //to be checked at method level
if (aClass.isInterface() && !containingClass.isInterface()) continue;
HighlightInfo highlightInfo;
if (allAbstracts) {
superSignatures = new ArrayList<>(superSignatures);
superSignatures.add(0, signature);
highlightInfo = checkInterfaceInheritedMethodsReturnTypes(superSignatures, languageLevel);
}
else {
highlightInfo = checkMethodIncompatibleReturnType(signature, superSignatures, false);
}
if (highlightInfo != null) description = highlightInfo.getDescription();
if (method.hasModifierProperty(PsiModifier.STATIC)) {
for (HierarchicalMethodSignature superSignature : superSignatures) {
PsiMethod superMethod = superSignature.getMethod();
if (!superMethod.hasModifierProperty(PsiModifier.STATIC)) {
PsiClass superClass = superMethod.getContainingClass();
description = JavaErrorBundle.message("static.method.cannot.override.instance.method",
JavaHighlightUtil.formatMethod(method),
HighlightUtil.formatClass(containingClass),
JavaHighlightUtil.formatMethod(superMethod),
superClass != null ? HighlightUtil.formatClass(superClass) : "<unknown>");
appendImplementMethodFix = false;
break Ultimate;
}
}
continue;
}
if (description == null) {
highlightInfo = checkMethodIncompatibleThrows(signature, superSignatures, false, aClass);
if (highlightInfo != null) description = highlightInfo.getDescription();
}
if (description == null) {
highlightInfo = checkMethodWeakerPrivileges(signature, superSignatures, false, containingFile);
if (highlightInfo != null) description = highlightInfo.getDescription();
}
if (description != null) break;
}
if (description != null) {
// show error info at the class level
TextRange textRange = HighlightNamesUtil.getClassDeclarationTextRange(aClass);
final HighlightInfo highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
if (appendImplementMethodFix) {
QuickFixAction.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createImplementMethodsFix(aClass));
}
return highlightInfo;
}
return null;
}
static HighlightInfo checkConstructorHandleSuperClassExceptions(@NotNull PsiMethod method) {
if (!method.isConstructor()) {
return null;
}
PsiCodeBlock body = method.getBody();
PsiStatement[] statements = body == null ? null : body.getStatements();
if (statements == null) return null;
// if we have unhandled exception inside method body, we could not have been called here,
// so the only problem it can catch here is with super ctr only
Collection<PsiClassType> unhandled = ExceptionUtil.collectUnhandledExceptions(method, method.getContainingClass());
if (unhandled.isEmpty()) return null;
String description = HighlightUtil.getUnhandledExceptionsDescriptor(unhandled);
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
HighlightInfo highlightInfo = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
for (PsiClassType exception : unhandled) {
QuickFixAction.registerQuickFixAction(highlightInfo, new LocalQuickFixOnPsiElementAsIntentionAdapter(QUICK_FIX_FACTORY.createMethodThrowsFix(method, exception, true, false)));
}
return highlightInfo;
}
static HighlightInfo checkRecursiveConstructorInvocation(@NotNull PsiMethod method) {
if (HighlightControlFlowUtil.isRecursivelyCalledConstructor(method)) {
TextRange textRange = HighlightNamesUtil.getMethodDeclarationTextRange(method);
String description = JavaErrorBundle.message("recursive.constructor.invocation");
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(textRange).descriptionAndTooltip(description).create();
}
return null;
}
@NotNull
public static TextRange getFixRange(@NotNull PsiElement element) {
TextRange range = element.getTextRange();
int start = range.getStartOffset();
int end = range.getEndOffset();
PsiElement nextSibling = element.getNextSibling();
if (PsiUtil.isJavaToken(nextSibling, JavaTokenType.SEMICOLON)) {
return new TextRange(start, end + 1);
}
return range;
}
static void checkNewExpression(@NotNull PsiNewExpression expression,
@Nullable PsiType type,
@NotNull HighlightInfoHolder holder,
@NotNull JavaSdkVersion javaSdkVersion) {
if (!(type instanceof PsiClassType)) return;
PsiClassType.ClassResolveResult typeResult = ((PsiClassType)type).resolveGenerics();
PsiClass aClass = typeResult.getElement();
if (aClass == null) return;
if (aClass instanceof PsiAnonymousClass) {
type = ((PsiAnonymousClass)aClass).getBaseClassType();
typeResult = ((PsiClassType)type).resolveGenerics();
aClass = typeResult.getElement();
if (aClass == null) return;
}
PsiJavaCodeReferenceElement classReference = expression.getClassOrAnonymousClassReference();
checkConstructorCall(typeResult, expression, type, classReference, holder, javaSdkVersion);
}
static void checkConstructorCall(@NotNull PsiClassType.ClassResolveResult typeResolveResult,
@NotNull PsiConstructorCall constructorCall,
@NotNull PsiType type,
@Nullable PsiJavaCodeReferenceElement classReference,
@NotNull HighlightInfoHolder holder,
@NotNull JavaSdkVersion javaSdkVersion) {
PsiExpressionList list = constructorCall.getArgumentList();
if (list == null) return;
PsiClass aClass = typeResolveResult.getElement();
if (aClass == null) return;
final PsiResolveHelper resolveHelper = JavaPsiFacade.getInstance(holder.getProject()).getResolveHelper();
PsiClass accessObjectClass = null;
if (constructorCall instanceof PsiNewExpression) {
PsiExpression qualifier = ((PsiNewExpression)constructorCall).getQualifier();
if (qualifier != null) {
accessObjectClass = (PsiClass)PsiUtil.getAccessObjectClass(qualifier).getElement();
}
}
if (classReference != null && !resolveHelper.isAccessible(aClass, constructorCall, accessObjectClass)) {
String description = HighlightUtil.accessProblemDescription(classReference, aClass, typeResolveResult);
PsiElement element = ObjectUtils.notNull(classReference.getReferenceNameElement(), classReference);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(element).descriptionAndTooltip(description).create();
HighlightFixUtil.registerAccessQuickFixAction(aClass, classReference, info, null);
holder.add(info);
return;
}
PsiMethod[] constructors = aClass.getConstructors();
if (constructors.length == 0) {
if (!list.isEmpty()) {
String constructorName = aClass.getName();
String argTypes = buildArgTypesList(list);
String description = JavaErrorBundle.message("wrong.constructor.arguments", constructorName + "()", argTypes);
String tooltip = createMismatchedArgumentsHtmlTooltip(list, null, PsiParameter.EMPTY_ARRAY, PsiSubstitutor.EMPTY);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(list).description(description).escapedToolTip(tooltip).navigationShift(+1).create();
QuickFixAction.registerQuickFixActions(
info, constructorCall.getTextRange(), QUICK_FIX_FACTORY.createCreateConstructorFromUsageFixes(constructorCall)
);
if (classReference != null) {
ConstructorParametersFixer.registerFixActions(classReference, constructorCall, info,getFixRange(list));
}
holder.add(info);
return;
}
if (classReference != null && aClass.hasModifierProperty(PsiModifier.PROTECTED) && callingProtectedConstructorFromDerivedClass(constructorCall, aClass)) {
holder.add(buildAccessProblem(classReference, aClass, typeResolveResult));
} else if (aClass.isInterface() && constructorCall instanceof PsiNewExpression) {
final PsiReferenceParameterList typeArgumentList = ((PsiNewExpression)constructorCall).getTypeArgumentList();
if (typeArgumentList.getTypeArguments().length > 0) {
holder.add(HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(typeArgumentList)
.descriptionAndTooltip("Anonymous class implements interface; cannot have type arguments").create());
}
}
}
else {
PsiElement place = list;
if (constructorCall instanceof PsiNewExpression) {
final PsiAnonymousClass anonymousClass = ((PsiNewExpression)constructorCall).getAnonymousClass();
if (anonymousClass != null) place = anonymousClass;
}
JavaResolveResult[] results = resolveHelper.multiResolveConstructor((PsiClassType)type, list, place);
MethodCandidateInfo result = null;
if (results.length == 1) result = (MethodCandidateInfo)results[0];
PsiMethod constructor = result == null ? null : result.getElement();
boolean applicable = true;
try {
final PsiDiamondType diamondType = constructorCall instanceof PsiNewExpression ? PsiDiamondType.getDiamondType((PsiNewExpression)constructorCall) : null;
final JavaResolveResult staticFactory = diamondType != null ? diamondType.getStaticFactory() : null;
if (staticFactory instanceof MethodCandidateInfo) {
if (((MethodCandidateInfo)staticFactory).isApplicable()) {
result = (MethodCandidateInfo)staticFactory;
if (constructor == null) {
constructor = ((MethodCandidateInfo)staticFactory).getElement();
}
}
else {
applicable = false;
}
}
else {
applicable = result != null && result.isApplicable();
}
}
catch (IndexNotReadyException ignored) {
}
PsiElement infoElement = list.getTextLength() > 0 ? list : constructorCall;
if (constructor == null) {
String name = aClass.getName();
name += buildArgTypesList(list);
String description = JavaErrorBundle.message("cannot.resolve.constructor", name);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(list).descriptionAndTooltip(description).navigationShift(+1).create();
if (info != null) {
WrapExpressionFix.registerWrapAction(results, list.getExpressions(), info, getFixRange(list));
registerFixesOnInvalidConstructorCall(constructorCall, classReference, list, aClass, constructors, results, infoElement, info);
holder.add(info);
}
}
else if (classReference != null &&
(!result.isAccessible() ||
constructor.hasModifierProperty(PsiModifier.PROTECTED) && callingProtectedConstructorFromDerivedClass(constructorCall, aClass))) {
holder.add(buildAccessProblem(classReference, constructor, result));
}
else if (!applicable) {
HighlightInfo info = createIncompatibleCallHighlightInfo(holder, list, result);
if (info != null) {
JavaResolveResult[] methodCandidates = results;
if (constructorCall instanceof PsiNewExpression) {
methodCandidates = resolveHelper.getReferencedMethodCandidates((PsiCallExpression)constructorCall, true);
}
registerFixesOnInvalidConstructorCall(constructorCall, classReference, list, aClass, constructors, methodCandidates, infoElement, info);
registerMethodReturnFixAction(info, result, constructorCall);
holder.add(info);
}
}
else if (constructorCall instanceof PsiNewExpression) {
PsiReferenceParameterList typeArgumentList = ((PsiNewExpression)constructorCall).getTypeArgumentList();
HighlightInfo info = GenericsHighlightUtil.checkReferenceTypeArgumentList(constructor, typeArgumentList, result.getSubstitutor(), false, javaSdkVersion);
if (info != null) {
holder.add(info);
}
}
if (result != null && !holder.hasErrorResults()) {
holder.add(checkVarargParameterErasureToBeAccessible(result, constructorCall));
}
}
}
/**
* If the compile-time declaration is applicable by variable arity invocation,
* then where the last formal parameter type of the invocation type of the method is Fn[],
* it is a compile-time error if the type which is the erasure of Fn is not accessible at the point of invocation.
*/
private static HighlightInfo checkVarargParameterErasureToBeAccessible(@NotNull MethodCandidateInfo info, @NotNull PsiCall place) {
final PsiMethod method = info.getElement();
if (info.isVarargs() || method.isVarArgs() && !PsiUtil.isLanguageLevel8OrHigher(place)) {
final PsiParameter[] parameters = method.getParameterList().getParameters();
final PsiType componentType = ((PsiEllipsisType)parameters[parameters.length - 1].getType()).getComponentType();
final PsiType substitutedTypeErasure = TypeConversionUtil.erasure(info.getSubstitutor().substitute(componentType));
final PsiClass targetClass = PsiUtil.resolveClassInClassTypeOnly(substitutedTypeErasure);
if (targetClass != null && !PsiUtil.isAccessible(targetClass, place, null)) {
final PsiExpressionList argumentList = place.getArgumentList();
return HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR)
.descriptionAndTooltip("Formal varargs element type " +
PsiFormatUtil.formatClass(targetClass, PsiFormatUtilBase.SHOW_FQ_NAME) +
" is inaccessible here")
.range(argumentList != null ? argumentList : place)
.create();
}
}
return null;
}
private static void registerFixesOnInvalidConstructorCall(@NotNull PsiConstructorCall constructorCall,
@Nullable PsiJavaCodeReferenceElement classReference,
@NotNull PsiExpressionList list,
@NotNull PsiClass aClass,
PsiMethod @NotNull [] constructors,
JavaResolveResult @NotNull [] results,
@NotNull PsiElement infoElement,
@NotNull final HighlightInfo info) {
QuickFixAction.registerQuickFixActions(
info, constructorCall.getTextRange(), QUICK_FIX_FACTORY.createCreateConstructorFromUsageFixes(constructorCall)
);
if (classReference != null) {
ConstructorParametersFixer.registerFixActions(classReference, constructorCall, info, getFixRange(infoElement));
ChangeTypeArgumentsFix.registerIntentions(results, list, info, aClass);
ConvertDoubleToFloatFix.registerIntentions(results, list, info, null);
}
if (!PermuteArgumentsFix.registerFix(info, constructorCall, toMethodCandidates(results), getFixRange(list))) {
registerChangeMethodSignatureFromUsageIntentions(results, list, info, null);
}
registerChangeParameterClassFix(constructorCall, list, info);
QuickFixAction.registerQuickFixAction(info, getFixRange(list), QUICK_FIX_FACTORY.createSurroundWithArrayFix(constructorCall,null));
ChangeStringLiteralToCharInMethodCallFix.registerFixes(constructors, constructorCall, info);
}
private static HighlightInfo buildAccessProblem(@NotNull PsiJavaCodeReferenceElement ref,
@NotNull PsiJvmMember resolved,
@NotNull JavaResolveResult result) {
String description = HighlightUtil.accessProblemDescription(ref, resolved, result);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(ref).descriptionAndTooltip(description).navigationShift(+1).create();
if (result.isStaticsScopeCorrect()) {
HighlightFixUtil.registerAccessQuickFixAction(resolved, ref, info, result.getCurrentFileResolveScope());
}
return info;
}
private static boolean callingProtectedConstructorFromDerivedClass(@NotNull PsiConstructorCall place, @NotNull PsiClass constructorClass) {
// indirect instantiation via anonymous class is ok
if (place instanceof PsiNewExpression && ((PsiNewExpression)place).getAnonymousClass() != null) return false;
PsiElement curElement = place;
PsiClass containingClass = constructorClass.getContainingClass();
while (true) {
PsiClass aClass = PsiTreeUtil.getParentOfType(curElement, PsiClass.class);
if (aClass == null) return false;
curElement = aClass;
if ((aClass.isInheritor(constructorClass, true) || containingClass != null && aClass.isInheritor(containingClass, true))
&& !JavaPsiFacade.getInstance(aClass.getProject()).arePackagesTheSame(aClass, constructorClass)) {
return true;
}
}
}
@NotNull
private static String buildArgTypesList(@NotNull PsiExpressionList list) {
StringBuilder builder = new StringBuilder();
builder.append("(");
PsiExpression[] args = list.getExpressions();
for (int i = 0; i < args.length; i++) {
if (i > 0) builder.append(", ");
PsiType argType = args[i].getType();
builder.append(argType != null ? JavaHighlightUtil.formatType(argType) : "?");
}
builder.append(")");
return builder.toString();
}
private static void registerChangeParameterClassFix(@NotNull PsiCall methodCall,
@NotNull PsiExpressionList list,
@Nullable HighlightInfo highlightInfo) {
final JavaResolveResult result = methodCall.resolveMethodGenerics();
PsiMethod method = (PsiMethod)result.getElement();
final PsiSubstitutor substitutor = result.getSubstitutor();
PsiExpression[] expressions = list.getExpressions();
if (method == null) return;
final PsiParameter[] parameters = method.getParameterList().getParameters();
if (parameters.length != expressions.length) return;
for (int i = 0; i < expressions.length; i++) {
final PsiExpression expression = expressions[i];
final PsiParameter parameter = parameters[i];
final PsiType expressionType = expression.getType();
final PsiType parameterType = substitutor.substitute(parameter.getType());
if (expressionType == null || expressionType instanceof PsiPrimitiveType || TypeConversionUtil.isNullType(expressionType) || expressionType instanceof PsiArrayType) continue;
if (parameterType instanceof PsiPrimitiveType || TypeConversionUtil.isNullType(parameterType) || parameterType instanceof PsiArrayType) continue;
if (parameterType.isAssignableFrom(expressionType)) continue;
PsiClass parameterClass = PsiUtil.resolveClassInType(parameterType);
PsiClass expressionClass = PsiUtil.resolveClassInType(expressionType);
if (parameterClass == null || expressionClass == null) continue;
if (expressionClass instanceof PsiAnonymousClass) continue;
if (parameterClass.isInheritor(expressionClass, true)) continue;
QuickFixAction.registerQuickFixAction(highlightInfo, QUICK_FIX_FACTORY.createChangeParameterClassFix(expressionClass, (PsiClassType)parameterType));
}
}
private static void registerChangeMethodSignatureFromUsageIntentions(JavaResolveResult @NotNull [] candidates,
@NotNull PsiExpressionList list,
@Nullable HighlightInfo highlightInfo,
@Nullable TextRange fixRange) {
if (candidates.length == 0) return;
PsiExpression[] expressions = list.getExpressions();
for (JavaResolveResult candidate : candidates) {
registerChangeMethodSignatureFromUsageIntention(expressions, highlightInfo, fixRange, candidate, list);
}
}
private static void registerChangeMethodSignatureFromUsageIntention(PsiExpression @NotNull [] expressions,
@Nullable HighlightInfo highlightInfo,
@Nullable TextRange fixRange,
@NotNull JavaResolveResult candidate,
@NotNull PsiElement context) {
if (!candidate.isStaticsScopeCorrect()) return;
PsiMethod method = (PsiMethod)candidate.getElement();
PsiSubstitutor substitutor = candidate.getSubstitutor();
if (method != null && context.getManager().isInProject(method)) {
IntentionAction fix = QUICK_FIX_FACTORY.createChangeMethodSignatureFromUsageFix(method, expressions, substitutor, context, false, 2);
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, fix);
IntentionAction f2 = QUICK_FIX_FACTORY.createChangeMethodSignatureFromUsageReverseOrderFix(method, expressions, substitutor, context, false, 2);
QuickFixAction.registerQuickFixAction(highlightInfo, fixRange, f2);
}
}
static PsiType determineReturnType(@NotNull PsiMethod method) {
PsiManager manager = method.getManager();
PsiReturnStatement[] returnStatements = PsiUtil.findReturnStatements(method);
if (returnStatements.length == 0) return PsiType.VOID;
PsiType expectedType = null;
for (PsiReturnStatement returnStatement : returnStatements) {
ReturnModel returnModel = ReturnModel.create(returnStatement);
if (returnModel == null) return null;
expectedType = lub(expectedType, returnModel.myLeastType, returnModel.myType, method, manager);
}
return expectedType;
}
@NotNull
private static PsiType lub(@Nullable PsiType currentType,
@NotNull PsiType leastValueType,
@NotNull PsiType valueType,
@NotNull PsiMethod method,
@NotNull PsiManager manager) {
if (currentType == null || PsiType.VOID.equals(currentType)) return valueType;
if (currentType == valueType) return currentType;
if (TypeConversionUtil.isPrimitiveAndNotNull(valueType)) {
if (TypeConversionUtil.isPrimitiveAndNotNull(currentType)) {
int r1 = TypeConversionUtil.getTypeRank(currentType);
int r2 = TypeConversionUtil.getTypeRank(leastValueType);
return r1 >= r2 ? currentType : valueType;
}
PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(currentType);
if (valueType.equals(unboxedType)) return currentType;
valueType = ((PsiPrimitiveType)valueType).getBoxedType(method);
}
if (TypeConversionUtil.isPrimitiveAndNotNull(currentType)) {
currentType = ((PsiPrimitiveType)currentType).getBoxedType(method);
}
return Objects.requireNonNull(GenericsUtil.getLeastUpperBound(currentType, valueType, manager));
}
static HighlightInfo checkRecordAccessorDeclaration(PsiMethod method) {
PsiRecordComponent component = JavaPsiRecordUtil.getRecordComponentForAccessor(method);
if (component == null) return null;
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier == null) return null;
PsiType componentType = component.getType();
PsiType methodType = method.getReturnType();
if (methodType == null) return null; // Either constructor or incorrect method, will be reported in another way
if (!componentType.equals(methodType)) {
String message =
JavaErrorBundle.message("record.accessor.wrong.return.type", componentType.getPresentableText(), methodType.getPresentableText());
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
Objects.requireNonNull(method.getReturnTypeElement())).descriptionAndTooltip(message).create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createMethodReturnFix(method, componentType, false));
return info;
}
return checkRecordSpecialMethodDeclaration(method, JavaErrorBundle.message("record.accessor"));
}
@NotNull
static List<HighlightInfo> checkRecordConstructorDeclaration(@NotNull PsiMethod method) {
if (!method.isConstructor()) return Collections.emptyList();
PsiClass aClass = method.getContainingClass();
if (aClass == null) return Collections.emptyList();
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier == null) return Collections.emptyList();
if (!aClass.isRecord()) {
if (JavaPsiRecordUtil.isCompactConstructor(method)) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
identifier).descriptionAndTooltip(JavaErrorBundle.message("compact.constructor.in.regular.class")).create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createAddParameterListFix(method));
return Collections.singletonList(info);
}
return Collections.emptyList();
}
if (JavaPsiRecordUtil.isExplicitCanonicalConstructor(method)) {
PsiParameter[] parameters = method.getParameterList().getParameters();
PsiRecordComponent[] components = aClass.getRecordComponents();
List<HighlightInfo> problems = new ArrayList<>();
assert parameters.length == components.length;
for (int i = 0; i < parameters.length; i++) {
PsiType componentType = components[i].getType();
PsiType parameterType = parameters[i].getType();
String componentName = components[i].getName();
String parameterName = parameters[i].getName();
if (!parameterType.equals(componentType)) {
String message =
JavaErrorBundle.message("record.canonical.constructor.wrong.parameter.type", componentName,
componentType.getPresentableText(), parameterType.getPresentableText());
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
Objects.requireNonNull(parameters[i].getTypeElement())).descriptionAndTooltip(message).create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createMethodParameterTypeFix(method, i, componentType, false));
problems.add(info);
}
if (componentName != null && !parameterName.equals(componentName)) {
String message = JavaErrorBundle.message("record.canonical.constructor.wrong.parameter.name", componentName, parameterName);
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(
Objects.requireNonNull(parameters[i].getNameIdentifier())).descriptionAndTooltip(message).create();
if (Arrays.stream(parameters).map(PsiParameter::getName).noneMatch(Predicate.isEqual(componentName))) {
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createRenameElementFix(parameters[i], componentName));
}
problems.add(info);
}
}
ContainerUtil
.addIfNotNull(problems, checkRecordSpecialMethodDeclaration(method, JavaErrorBundle.message("record.canonical.constructor")));
return problems;
} else if (JavaPsiRecordUtil.isCompactConstructor(method)) {
return Collections
.singletonList(checkRecordSpecialMethodDeclaration(method, JavaErrorBundle.message("record.compact.constructor")));
}
else {
// Non-canonical constructor
PsiMethodCallExpression call = JavaPsiConstructorUtil.findThisOrSuperCallInConstructor(method);
if (call == null || JavaPsiConstructorUtil.isSuperConstructorCall(call)) {
String message = JavaErrorBundle.message("record.no.constructor.call.in.non.canonical");
return Collections.singletonList(HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(identifier)
.descriptionAndTooltip(message).create());
}
return Collections.emptyList();
}
}
@Nullable
private static HighlightInfo checkRecordSpecialMethodDeclaration(PsiMethod method, String methodTitle) {
PsiIdentifier identifier = method.getNameIdentifier();
if (identifier == null) return null;
PsiTypeParameterList typeParameterList = method.getTypeParameterList();
if (typeParameterList != null && typeParameterList.getTypeParameters().length > 0) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(typeParameterList)
.descriptionAndTooltip(JavaErrorBundle.message("record.special.method.type.parameters", methodTitle))
.create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createDeleteFix(typeParameterList));
return info;
}
if (!method.hasModifierProperty(PsiModifier.PUBLIC)) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(identifier)
.descriptionAndTooltip(JavaErrorBundle.message("record.special.method.non.public", methodTitle))
.create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.PUBLIC, true, false));
return info;
}
PsiReferenceList throwsList = method.getThrowsList();
if (throwsList.getReferenceElements().length > 0) {
HighlightInfo info = HighlightInfo.newHighlightInfo(HighlightInfoType.ERROR).range(throwsList)
.descriptionAndTooltip(JavaErrorBundle.message("record.special.method.throws", methodTitle))
.create();
QuickFixAction.registerQuickFixAction(info, QUICK_FIX_FACTORY.createDeleteFix(throwsList));
return info;
}
return null;
}
private static class ReturnModel {
final PsiReturnStatement myStatement;
final PsiType myType;
final PsiType myLeastType;
@Contract(pure = true)
private ReturnModel(@NotNull PsiReturnStatement statement, @NotNull PsiType type) {
myStatement = statement;
myType = myLeastType = type;
}
@Contract(pure = true)
private ReturnModel(@NotNull PsiReturnStatement statement, @NotNull PsiType type, @NotNull PsiType leastType) {
myStatement = statement;
myType = type;
myLeastType = leastType;
}
@Nullable
private static ReturnModel create(@NotNull PsiReturnStatement statement) {
PsiExpression value = statement.getReturnValue();
if (value == null) return new ReturnModel(statement, PsiType.VOID);
if (ExpressionUtils.nonStructuralChildren(value).anyMatch(c -> c instanceof PsiFunctionalExpression)) return null;
PsiType type = RefactoringChangeUtil.getTypeByExpression(value);
if (type == null || type instanceof PsiClassType && ((PsiClassType)type).resolve() == null) return null;
return new ReturnModel(statement, type, getLeastValueType(value, type));
}
@NotNull
private static PsiType getLeastValueType(@NotNull PsiExpression returnValue, @NotNull PsiType type) {
if (type instanceof PsiPrimitiveType) {
int rank = TypeConversionUtil.getTypeRank(type);
if (rank < TypeConversionUtil.BYTE_RANK || rank > TypeConversionUtil.INT_RANK) return type;
PsiConstantEvaluationHelper evaluator = JavaPsiFacade.getInstance(returnValue.getProject()).getConstantEvaluationHelper();
Object res = evaluator.computeConstantExpression(returnValue);
if (res instanceof Number) {
long value = ((Number)res).longValue();
if (-128 <= value && value <= 127) return PsiType.BYTE;
if (-32768 <= value && value <= 32767) return PsiType.SHORT;
if (0 <= value && value <= 0xFFFF) return PsiType.CHAR;
}
}
return type;
}
}
} | HighlightMethodUtil: "Make default" with high priority
GitOrigin-RevId: cc7a7c6e193173b377978f8ab34b86f15b9af7c8 | java/java-analysis-impl/src/com/intellij/codeInsight/daemon/impl/analysis/HighlightMethodUtil.java | HighlightMethodUtil: "Make default" with high priority | <ide><path>ava/java-analysis-impl/src/com/intellij/codeInsight/daemon/impl/analysis/HighlightMethodUtil.java
<ide> import com.intellij.codeInsight.daemon.impl.quickfix.*;
<ide> import com.intellij.codeInsight.intention.IntentionAction;
<ide> import com.intellij.codeInsight.intention.QuickFixFactory;
<add>import com.intellij.codeInsight.intention.impl.PriorityIntentionActionWrapper;
<ide> import com.intellij.codeInsight.quickfix.UnresolvedReferenceQuickFixProvider;
<ide> import com.intellij.codeInspection.LocalQuickFixOnPsiElementAsIntentionAdapter;
<ide> import com.intellij.lang.jvm.JvmModifier;
<ide> if (languageLevel.isAtLeast(LanguageLevel.JDK_1_8)) {
<ide> if (Stream.of(method.findDeepestSuperMethods()).map(PsiMethod::getContainingClass)
<ide> .filter(Objects::nonNull).map(PsiClass::getQualifiedName).noneMatch(CommonClassNames.JAVA_LANG_OBJECT::equals)) {
<del> additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.DEFAULT, true, false));
<add> IntentionAction makeDefaultFix = QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.DEFAULT, true, false);
<add> additionalFixes.add(PriorityIntentionActionWrapper.highPriority(makeDefaultFix));
<ide> additionalFixes.add(QUICK_FIX_FACTORY.createModifierListFix(method, PsiModifier.STATIC, true, false));
<ide> }
<ide> } |
|
Java | bsd-3-clause | 7eae539f0ab79041073e21d233938d320c31e9e7 | 0 | NCIP/cadsr-semantic-tools,NCIP/cadsr-semantic-tools | package gov.nih.nci.ncicb.cadsr.loader.event;
import gov.nih.nci.ncicb.cadsr.domain.*;
import gov.nih.nci.ncicb.cadsr.loader.ElementsLists;
import org.apache.log4j.Logger;
import java.util.*;
import gov.nih.nci.ncicb.cadsr.loader.util.*;
/**
* This class implements UMLHandler specifically to handle UML events and convert them into caDSR objects.<br/> The handler's responsibility is to transform events received into cadsr domain objects, and store those objects in the Elements List.
*
*
* @author <a href="mailto:[email protected]">Christophe Ludet</a>
*/
public class UMLDefaultHandler implements UMLHandler {
private ElementsLists elements;
private Logger logger = Logger.getLogger(UMLDefaultHandler.class.getName());
private List packageList = new ArrayList();
public UMLDefaultHandler(ElementsLists elements) {
this.elements = elements;
}
public void newPackage(NewPackageEvent event) {
logger.debug("Package: " + event.getName());
}
public void newOperation(NewOperationEvent event) {
logger.debug("Operation: " + event.getClassName() + "." +
event.getName());
}
public void newClass(NewClassEvent event) {
logger.debug("Class: " + event.getName());
List concepts = createConcepts(event);
ObjectClass oc = DomainObjectFactory.newObjectClass();
// store concept codes in preferredName
oc.setPreferredName(preferredNameFromConcepts(concepts));
oc.setLongName(event.getName());
if(event.getDescription() != null && event.getDescription().length() > 0)
oc.setPreferredDefinition(event.getDescription());
else
oc.setPreferredDefinition("");
elements.addElement(oc);
ClassificationSchemeItem csi = DomainObjectFactory.newClassificationSchemeItem();
String csiName = null;
String pName = event.getPackageName();
csi.setComments(pName);
if (!packageList.contains(pName)) {
elements.addElement(csi);
packageList.add(pName);
}
// Store package names
AdminComponentClassSchemeClassSchemeItem acCsCsi = DomainObjectFactory.newAdminComponentClassSchemeClassSchemeItem();
ClassSchemeClassSchemeItem csCsi = DomainObjectFactory.newClassSchemeClassSchemeItem();
csCsi.setCsi(csi);
acCsCsi.setCsCsi(csCsi);
List l = new ArrayList();
l.add(acCsCsi);
oc.setAcCsCsis(l);
}
public void newAttribute(NewAttributeEvent event) {
logger.debug("Attribute: " + event.getClassName() + "." +
event.getName());
List concepts = createConcepts(event);
Property prop = DomainObjectFactory.newProperty();
// store concept codes in preferredName
prop.setPreferredName(preferredNameFromConcepts(concepts));
// prop.setPreferredName(event.getName());
prop.setLongName(event.getName());
String propName = event.getName();
String className = event.getClassName();
int ind = className.lastIndexOf(".");
className = className.substring(ind + 1);
DataElementConcept dec = DomainObjectFactory.newDataElementConcept();
dec.setLongName(className + ":" + propName);
dec.setProperty(prop);
logger.debug("DEC LONG_NAME: " + dec.getLongName());
ObjectClass oc = DomainObjectFactory.newObjectClass();
List ocs = elements.getElements(oc.getClass());
for (int i = 0; i < ocs.size(); i++) {
ObjectClass o = (ObjectClass) ocs.get(i);
if (o.getLongName().equals(event.getClassName())) {
oc = o;
}
}
dec.setObjectClass(oc);
DataElement de = DomainObjectFactory.newDataElement();
de.setLongName(dec.getLongName() + event.getType());
de.setPreferredDefinition(event.getDescription());
logger.debug("DE LONG_NAME: " + de.getLongName());
de.setDataElementConcept(dec);
ValueDomain vd = DomainObjectFactory.newValueDomain();
vd.setPreferredName(event.getType());
de.setValueDomain(vd);
if(event.getDescription() != null && event.getDescription().length() > 0) {
prop.setPreferredDefinition(event.getDescription());
dec.setPreferredDefinition(event.getDescription());
de.setPreferredDefinition(event.getDescription());
} else {
prop.setPreferredDefinition("");
dec.setPreferredDefinition("");
de.setPreferredDefinition("Please provide the appropriate definition.");
}
// Add packages to Prop, DE and DEC.
prop.setAcCsCsis(oc.getAcCsCsis());
de.setAcCsCsis(oc.getAcCsCsis());
dec.setAcCsCsis(oc.getAcCsCsis());
elements.addElement(de);
elements.addElement(dec);
elements.addElement(prop);
}
public void newInterface(NewInterfaceEvent event) {
logger.debug("Interface: " + event.getName());
}
public void newStereotype(NewStereotypeEvent event) {
logger.debug("Stereotype: " + event.getName());
}
public void newDataType(NewDataTypeEvent event) {
logger.debug("DataType: " + event.getName());
}
public void newAssociation(NewAssociationEvent event) {
ObjectClassRelationship ocr = DomainObjectFactory.newObjectClassRelationship();
ObjectClass oc = DomainObjectFactory.newObjectClass();
List ocs = elements.getElements(oc.getClass());
logger.debug("direction: " + event.getDirection());
for(Iterator it = ocs.iterator(); it.hasNext(); ) {
ObjectClass o = (ObjectClass) it.next();
if (o.getLongName().equals(event.getAClassName())) {
if (event.getDirection().equals("B")) {
ocr.setSource(o);
ocr.setSourceRole(event.getARole());
ocr.setSourceLowCardinality(event.getALowCardinality());
ocr.setSourceHighCardinality(event.getAHighCardinality());
} else {
ocr.setTarget(o);
ocr.setTargetRole(event.getARole());
ocr.setTargetLowCardinality(event.getALowCardinality());
ocr.setTargetHighCardinality(event.getAHighCardinality());
}
} else if (o.getLongName().equals(event.getBClassName())) {
if (event.getDirection().equals("B")) {
ocr.setTarget(o);
ocr.setTargetRole(event.getBRole());
ocr.setTargetLowCardinality(event.getBLowCardinality());
ocr.setTargetHighCardinality(event.getBHighCardinality());
} else {
ocr.setSource(o);
ocr.setSourceRole(event.getBRole());
ocr.setSourceLowCardinality(event.getBLowCardinality());
ocr.setSourceHighCardinality(event.getBHighCardinality());
}
}
}
if (event.getDirection().equals("AB")) {
ocr.setDirection(ObjectClassRelationship.DIRECTION_BOTH);
} else {
ocr.setDirection(ObjectClassRelationship.DIRECTION_SINGLE);
}
ocr.setLongName(event.getRoleName());
ocr.setType(ObjectClassRelationship.TYPE_HAS);
elements.addElement(ocr);
}
public void newGeneralization(NewGeneralizationEvent event) {
ObjectClassRelationship ocr = DomainObjectFactory.newObjectClassRelationship();
ObjectClass oc = DomainObjectFactory.newObjectClass();
List ocs = elements.getElements(oc.getClass());
for(Iterator it = ocs.iterator(); it.hasNext(); ) {
ObjectClass o = (ObjectClass) it.next();
if (o.getLongName().equals(event.getParentClassName())) {
ocr.setTarget(o);
} else if (o.getLongName().equals(event.getChildClassName())) {
ocr.setSource(o);
}
}
ocr.setType(ObjectClassRelationship.TYPE_IS);
// Inherit all attributes
// Find all DECs:
ObjectClass parentOc = ocr.getTarget(),
childOc = ocr.getSource();
List newElts = new ArrayList();
List des = elements.getElements(DomainObjectFactory.newDataElement().getClass());
if(des != null)
for(Iterator it = des.iterator(); it.hasNext(); ) {
DataElement de = (DataElement)it.next();
DataElementConcept dec = de.getDataElementConcept();
if(dec.getObjectClass() == parentOc) {
// We found property belonging to parent
// Duplicate it for child.
Property newProp = DomainObjectFactory.newProperty();
newProp.setLongName(dec.getProperty().getLongName());
newProp.setPreferredName(dec.getProperty().getPreferredName());
DataElementConcept newDec = DomainObjectFactory.newDataElementConcept();
newDec.setProperty(dec.getProperty());
newDec.setObjectClass(childOc);
newDec.setPreferredDefinition(dec.getPreferredDefinition());
String propName = newDec.getProperty().getLongName();
String className = childOc.getLongName();
int ind = className.lastIndexOf(".");
className = className.substring(ind + 1);
newDec.setLongName(className + ":" + propName);
DataElement newDe = DomainObjectFactory.newDataElement();
newDe.setDataElementConcept(newDec);
newDe.setValueDomain(de.getValueDomain());
newDe.setLongName(newDec.getLongName() + de.getValueDomain().getPreferredName());
newDe.setPreferredDefinition(de.getPreferredDefinition());
newDe.setAcCsCsis(parentOc.getAcCsCsis());
newDec.setAcCsCsis(parentOc.getAcCsCsis());
newProp.setAcCsCsis(parentOc.getAcCsCsis());
newElts.add(newProp);
newElts.add(newDe);
newElts.add(newDec);
}
}
for(Iterator it = newElts.iterator(); it.hasNext();
elements.addElement(it.next()));
elements.addElement(ocr);
logger.debug("Generalization: ");
logger.debug("Source:");
logger.debug("-- " + ocr.getSource().getLongName());
logger.debug("Target: ");
logger.debug("-- " + ocr.getTarget().getLongName());
}
private Concept newConcept(NewConceptEvent event) {
Concept concept = DomainObjectFactory.newConcept();
concept.setPreferredName(event.getConceptCode());
concept.setPreferredDefinition(event.getConceptDefinition());
concept.setDefinitionSource(event.getConceptDefinitionSource());
concept.setLongName(event.getConceptPreferredName());
elements.addElement(concept);
return concept;
}
private List createConcepts(NewConceptualEvent event) {
List concepts = new ArrayList();
List conEvs = event.getConcepts();
for(Iterator it = conEvs.iterator(); it.hasNext(); ) {
NewConceptEvent conEv = (NewConceptEvent)it.next();
concepts.add(newConcept(conEv));
}
return concepts;
}
private String preferredNameFromConcepts(List concepts) {
StringBuffer sb = new StringBuffer();
for(Iterator it = concepts.iterator(); it.hasNext(); ) {
Concept con = (Concept)it.next();
if(sb.length() > 0)
sb.insert(0, "-");
sb.insert(0, con.getPreferredName());
}
return sb.toString();
}
}
| src/gov/nih/nci/ncicb/cadsr/loader/event/UMLDefaultHandler.java | package gov.nih.nci.ncicb.cadsr.loader.event;
import gov.nih.nci.ncicb.cadsr.domain.*;
import gov.nih.nci.ncicb.cadsr.loader.ElementsLists;
import org.apache.log4j.Logger;
import java.util.*;
import gov.nih.nci.ncicb.cadsr.loader.util.*;
/**
* This class implements UMLHandler specifically to handle UML events and convert them into caDSR objects.<br/> The handler's responsibility is to transform events received into cadsr domain objects, and store those objects in the Elements List.
*
*
* @author <a href="mailto:[email protected]">Christophe Ludet</a>
*/
public class UMLDefaultHandler implements UMLHandler {
private ElementsLists elements;
private Logger logger = Logger.getLogger(UMLDefaultHandler.class.getName());
private List packageList = new ArrayList();
public UMLDefaultHandler(ElementsLists elements) {
this.elements = elements;
}
public void newPackage(NewPackageEvent event) {
logger.debug("Package: " + event.getName());
}
public void newOperation(NewOperationEvent event) {
logger.debug("Operation: " + event.getClassName() + "." +
event.getName());
}
public void newClass(NewClassEvent event) {
logger.debug("Class: " + event.getName());
List concepts = createConcepts(event);
ObjectClass oc = DomainObjectFactory.newObjectClass();
// store concept codes in preferredName
oc.setPreferredName(preferredNameFromConcepts(concepts));
oc.setLongName(event.getName());
if(event.getDescription() != null && event.getDescription().length() > 0)
oc.setPreferredDefinition(event.getDescription());
else
oc.setPreferredDefinition("");
elements.addElement(oc);
ClassificationSchemeItem csi = DomainObjectFactory.newClassificationSchemeItem();
String csiName = null;
String pName = event.getPackageName();
csi.setComments(pName);
if (!packageList.contains(pName)) {
elements.addElement(csi);
packageList.add(pName);
}
// Store package names
AdminComponentClassSchemeClassSchemeItem acCsCsi = DomainObjectFactory.newAdminComponentClassSchemeClassSchemeItem();
ClassSchemeClassSchemeItem csCsi = DomainObjectFactory.newClassSchemeClassSchemeItem();
csCsi.setCsi(csi);
acCsCsi.setCsCsi(csCsi);
List l = new ArrayList();
l.add(acCsCsi);
oc.setAcCsCsis(l);
}
public void newAttribute(NewAttributeEvent event) {
logger.debug("Attribute: " + event.getClassName() + "." +
event.getName());
List concepts = createConcepts(event);
Property prop = DomainObjectFactory.newProperty();
// store concept codes in preferredName
prop.setPreferredName(preferredNameFromConcepts(concepts));
// prop.setPreferredName(event.getName());
prop.setLongName(event.getName());
String propName = event.getName();
String className = event.getClassName();
int ind = className.lastIndexOf(".");
className = className.substring(ind + 1);
DataElementConcept dec = DomainObjectFactory.newDataElementConcept();
dec.setLongName(className + ":" + propName);
dec.setProperty(prop);
logger.debug("DEC LONG_NAME: " + dec.getLongName());
ObjectClass oc = DomainObjectFactory.newObjectClass();
List ocs = elements.getElements(oc.getClass());
for (int i = 0; i < ocs.size(); i++) {
ObjectClass o = (ObjectClass) ocs.get(i);
if (o.getLongName().equals(event.getClassName())) {
oc = o;
}
}
dec.setObjectClass(oc);
DataElement de = DomainObjectFactory.newDataElement();
// !! TODO Verify format of type (java.lang.String or String?)
de.setLongName(dec.getLongName() + event.getType());
de.setPreferredDefinition(event.getDescription());
logger.debug("DE LONG_NAME: " + de.getLongName());
de.setDataElementConcept(dec);
ValueDomain vd = DomainObjectFactory.newValueDomain();
vd.setPreferredName(event.getType());
de.setValueDomain(vd);
if(event.getDescription() != null && event.getDescription().length() > 0) {
prop.setPreferredDefinition(event.getDescription());
dec.setPreferredDefinition(event.getDescription());
de.setPreferredDefinition(event.getDescription());
} else {
prop.setPreferredDefinition("");
dec.setPreferredDefinition("");
de.setPreferredDefinition("Please provide the appropriate definition.");
}
// Add packages to Prop, DE and DEC.
prop.setAcCsCsis(oc.getAcCsCsis());
de.setAcCsCsis(oc.getAcCsCsis());
dec.setAcCsCsis(oc.getAcCsCsis());
elements.addElement(de);
elements.addElement(dec);
elements.addElement(prop);
}
public void newInterface(NewInterfaceEvent event) {
logger.debug("Interface: " + event.getName());
}
public void newStereotype(NewStereotypeEvent event) {
logger.debug("Stereotype: " + event.getName());
}
public void newDataType(NewDataTypeEvent event) {
logger.debug("DataType: " + event.getName());
}
public void newAssociation(NewAssociationEvent event) {
ObjectClassRelationship ocr = DomainObjectFactory.newObjectClassRelationship();
ObjectClass oc = DomainObjectFactory.newObjectClass();
List ocs = elements.getElements(oc.getClass());
logger.debug("direction: " + event.getDirection());
for(Iterator it = ocs.iterator(); it.hasNext(); ) {
ObjectClass o = (ObjectClass) it.next();
if (o.getLongName().equals(event.getAClassName())) {
if (event.getDirection().equals("B")) {
ocr.setSource(o);
ocr.setSourceRole(event.getARole());
ocr.setSourceLowCardinality(event.getALowCardinality());
ocr.setSourceHighCardinality(event.getAHighCardinality());
} else {
ocr.setTarget(o);
ocr.setTargetRole(event.getARole());
ocr.setTargetLowCardinality(event.getALowCardinality());
ocr.setTargetHighCardinality(event.getAHighCardinality());
}
} else if (o.getLongName().equals(event.getBClassName())) {
if (event.getDirection().equals("B")) {
ocr.setTarget(o);
ocr.setTargetRole(event.getBRole());
ocr.setTargetLowCardinality(event.getBLowCardinality());
ocr.setTargetHighCardinality(event.getBHighCardinality());
} else {
ocr.setSource(o);
ocr.setSourceRole(event.getBRole());
ocr.setSourceLowCardinality(event.getBLowCardinality());
ocr.setSourceHighCardinality(event.getBHighCardinality());
}
}
}
if (event.getDirection().equals("AB")) {
ocr.setDirection(ObjectClassRelationship.DIRECTION_BOTH);
} else {
ocr.setDirection(ObjectClassRelationship.DIRECTION_SINGLE);
}
ocr.setLongName(event.getRoleName());
ocr.setType(ObjectClassRelationship.TYPE_HAS);
elements.addElement(ocr);
}
public void newGeneralization(NewGeneralizationEvent event) {
ObjectClassRelationship ocr = DomainObjectFactory.newObjectClassRelationship();
ObjectClass oc = DomainObjectFactory.newObjectClass();
List ocs = elements.getElements(oc.getClass());
for(Iterator it = ocs.iterator(); it.hasNext(); ) {
ObjectClass o = (ObjectClass) it.next();
if (o.getLongName().equals(event.getParentClassName())) {
ocr.setTarget(o);
} else if (o.getLongName().equals(event.getChildClassName())) {
ocr.setSource(o);
}
}
ocr.setType(ObjectClassRelationship.TYPE_IS);
// Inherit all attributes
// Find all DECs:
ObjectClass parentOc = ocr.getTarget(),
childOc = ocr.getSource();
List newElts = new ArrayList();
List des = elements.getElements(DomainObjectFactory.newDataElement().getClass());
if(des != null)
for(Iterator it = des.iterator(); it.hasNext(); ) {
DataElement de = (DataElement)it.next();
DataElementConcept dec = de.getDataElementConcept();
if(dec.getObjectClass() == parentOc) {
// We found property belonging to parent
// Duplicate it for child.
Property newProp = DomainObjectFactory.newProperty();
newProp.setLongName(dec.getProperty().getLongName());
newProp.setPreferredName(dec.getProperty().getPreferredName());
DataElementConcept newDec = DomainObjectFactory.newDataElementConcept();
newDec.setProperty(dec.getProperty());
newDec.setObjectClass(childOc);
newDec.setPreferredDefinition(dec.getPreferredDefinition());
String propName = newDec.getProperty().getLongName();
String className = childOc.getLongName();
int ind = className.lastIndexOf(".");
className = className.substring(ind + 1);
newDec.setLongName(className + ":" + propName);
DataElement newDe = DomainObjectFactory.newDataElement();
newDe.setDataElementConcept(dec);
newDe.setValueDomain(de.getValueDomain());
newDe.setLongName(newDec.getLongName() + de.getValueDomain().getPreferredName());
newDe.setPreferredDefinition(de.getPreferredDefinition());
newDe.setAcCsCsis(parentOc.getAcCsCsis());
newDec.setAcCsCsis(parentOc.getAcCsCsis());
newProp.setAcCsCsis(parentOc.getAcCsCsis());
newElts.add(newProp);
newElts.add(newDe);
newElts.add(newDec);
}
}
for(Iterator it = newElts.iterator(); it.hasNext();
elements.addElement(it.next()));
elements.addElement(ocr);
logger.debug("Generalization: ");
logger.debug("Source:");
logger.debug("-- " + ocr.getSource().getLongName());
logger.debug("Target: ");
logger.debug("-- " + ocr.getTarget().getLongName());
}
private Concept newConcept(NewConceptEvent event) {
Concept concept = DomainObjectFactory.newConcept();
concept.setPreferredName(event.getConceptCode());
concept.setPreferredDefinition(event.getConceptDefinition());
concept.setDefinitionSource(event.getConceptDefinitionSource());
concept.setLongName(event.getConceptPreferredName());
elements.addElement(concept);
return concept;
}
private List createConcepts(NewConceptualEvent event) {
List concepts = new ArrayList();
List conEvs = event.getConcepts();
for(Iterator it = conEvs.iterator(); it.hasNext(); ) {
NewConceptEvent conEv = (NewConceptEvent)it.next();
concepts.add(newConcept(conEv));
}
return concepts;
}
private String preferredNameFromConcepts(List concepts) {
StringBuffer sb = new StringBuffer();
for(Iterator it = concepts.iterator(); it.hasNext(); ) {
Concept con = (Concept)it.next();
if(sb.length() > 0)
sb.insert(0, "-");
sb.insert(0, con.getPreferredName());
}
return sb.toString();
}
}
| *** empty log message ***
SVN-Revision: 156
| src/gov/nih/nci/ncicb/cadsr/loader/event/UMLDefaultHandler.java | *** empty log message *** | <ide><path>rc/gov/nih/nci/ncicb/cadsr/loader/event/UMLDefaultHandler.java
<ide>
<ide> DataElement de = DomainObjectFactory.newDataElement();
<ide>
<del> // !! TODO Verify format of type (java.lang.String or String?)
<ide> de.setLongName(dec.getLongName() + event.getType());
<ide> de.setPreferredDefinition(event.getDescription());
<ide>
<ide> className = className.substring(ind + 1);
<ide> newDec.setLongName(className + ":" + propName);
<ide> DataElement newDe = DomainObjectFactory.newDataElement();
<del> newDe.setDataElementConcept(dec);
<add> newDe.setDataElementConcept(newDec);
<ide> newDe.setValueDomain(de.getValueDomain());
<ide> newDe.setLongName(newDec.getLongName() + de.getValueDomain().getPreferredName());
<ide> newDe.setPreferredDefinition(de.getPreferredDefinition()); |
|
Java | apache-2.0 | 9adc081292d4bbecf22ed8f556d9e443f20b586b | 0 | nebulae-pan/RichEditText | package com.pxh.richedittext;
import android.content.Context;
import android.graphics.Bitmap;
import android.graphics.Typeface;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.support.v7.widget.AppCompatEditText;
import android.text.Editable;
import android.text.Html;
import android.text.Spannable;
import android.text.SpannableString;
import android.text.Spanned;
import android.text.style.BulletSpan;
import android.text.style.CharacterStyle;
import android.text.style.DynamicDrawableSpan;
import android.text.style.ImageSpan;
import android.text.style.QuoteSpan;
import android.text.style.StrikethroughSpan;
import android.text.style.StyleSpan;
import android.text.style.URLSpan;
import android.text.style.UnderlineSpan;
import android.util.AttributeSet;
import android.util.DisplayMetrics;
import android.view.WindowManager;
import java.lang.reflect.Field;
import java.util.ArrayList;
public class RichEditText extends AppCompatEditText
{
private Context context;
/**
* use bitmap creator get a bitmap
*/
private BitmapCreator bitmapCreator;
TextSpanState state = new TextSpanState();
public RichEditText(Context context)
{
this(context, null);
}
public RichEditText(final Context context, AttributeSet attrs)
{
super(context, attrs);
this.context = context;
post(new Runnable()
{
@Override
public void run()
{
DisplayMetrics metric = new DisplayMetrics();
WindowManager wm = (WindowManager) context.getSystemService(Context.WINDOW_SERVICE);
wm.getDefaultDisplay().getMetrics(metric);
int maxWidth = RichEditText.this.getMeasuredWidth() - 2;
int maxHeight = metric.heightPixels;
bitmapCreator = new InsertBitmapCreator(maxWidth, maxHeight);
}
});
}
public void insertImage(Uri uri)
{
String path = UriUtils.getValidPath(context, uri);
Bitmap bitmap = bitmapCreator.getBitmapByDiskPath(path);
SpannableString ss = new SpannableString(path);
//construct a Drawable and set Bounds
Drawable mDrawable = new BitmapDrawable(context.getResources(), bitmap);
int width = mDrawable.getIntrinsicWidth();
int height = mDrawable.getIntrinsicHeight();
mDrawable.setBounds(0, 0, width > 0 ? width : 0, height > 0 ? height : 0);
ImageSpan span = new ImageSpan(mDrawable, path, DynamicDrawableSpan.ALIGN_BOTTOM);
ss.setSpan(span, 0, path.length(), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
int start = this.getSelectionStart();
getEditableText().insert(start, ss);//insert the imageSpan
setSelection(start + ss.length()); //set selection start position
}
public void insertUrl(String describe, String url)
{
SpannableString ss = new SpannableString(describe);
ss.setSpan(new URLSpan(url), 0, ss.length(), Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
getEditableText().insert(getSelectionStart(), ss);
}
public void enableBold(boolean isValid)
{
int start = getSelectionStart();
int end = getSelectionEnd();
if (start < end)
setSelectionTextBold(isValid, start, end);
state.enableBold(isValid);
}
public void enableItalic(boolean isValid)
{
int start = getSelectionStart();
int end = getSelectionEnd();
if (start < end)
setSelectionTextBold(isValid, start, end);
state.enableItalic(isValid);
}
public void enableUnderLine(boolean isValid)
{
state.enableUnderLine(isValid);
}
public void enableStrikethrough(boolean isValid)
{
state.enableStrikethrough(isValid);
}
public void enableQuote(boolean isValid)
{
setQuote();
}
public void enableBullet(boolean isValid)
{
setBullet();
}
public boolean isBoldEnable()
{
return state.isBoldEnable();
}
public boolean isUnderLineEnable()
{
return state.isUnderLineEnable();
}
public boolean isItalicEnable()
{
return state.isItalicEnable();
}
public boolean isStrikethroughEnable()
{
return state.isStrikethroughEnable();
}
public void setHtml(final String html)
{
Html.ImageGetter imgGetter = new RichEditorImageGetter(this);
setText(Html.fromHtml(html, imgGetter, null));
}
public String getHtml()
{
return Html.toHtml(getText());
}
public void setSpanChangeListener(TextSpanChangeListener listener)
{
state.setSpanChangeListener(listener);
}
@Override
protected void onSelectionChanged(int selStart, int selEnd)
{
super.onSelectionChanged(selStart, selEnd);
if (state == null) {
return;
}
if (selStart == selEnd) {
changeSpanStateBySelection(selStart);
} else {
changeSpanStateBySelection(selStart, selEnd);
}
}
@Override
protected void onTextChanged(CharSequence text, int start, int lengthBefore, int lengthAfter)
{
if (state == null) {
return;
}
if (state.isBoldEnable()) {
setTextSpan(Typeface.BOLD, start, lengthAfter);
}
if (state.isItalicEnable()) {
setTextSpan(Typeface.ITALIC, start, lengthAfter);
}
if (state.isUnderLineEnable()) {
setTextSpan(new UnderlineSpan(), start, lengthAfter);
}
if (state.isStrikethroughEnable()) {
setTextSpan(new StrikethroughSpan(), start, lengthAfter);
}
}
/**
* when characters input , set the text's span by characterStyle and ParagraphStyle.
* Parameters start and lengthAfter must use the parameter of onTextChanged
*
* @param start the start of character's input
* @param lengthAfter the length of character's input
*/
private void setTextSpan(int style, int start, int lengthAfter)
{
if (start == 0) {
//if start = 0, text must doesn't have spans, use new StyleSpan
setSpan(new StyleSpan(style), start, start + lengthAfter);
} else {
//estimate the character what in front of input whether have span
StyleSpan boldSpan = getStyleSpan(style, getEditableText(), start - 1, start);
if (boldSpan == null) {
setSpan(new StyleSpan(style), start, start + lengthAfter);
} else {
//if have span , change the span's effect scope
changeCharacterStyleEnd(boldSpan, lengthAfter, getEditableText());
}
}
}
private void setTextSpan(CharacterStyle span, int start, int lengthAfter)
{
if (start == 0) {
setSpan(span, start, start + lengthAfter);
} else {
CharacterStyle characterStyleSpan = getCharacterStyleSpan(span.getClass(), start - 1, start);
if (characterStyleSpan == null) {
setSpan(span, start, start + lengthAfter);
} else {
changeCharacterStyleEnd(characterStyleSpan, lengthAfter, getEditableText());
}
}
}
/**
* change Span's state when selection change
*
* @param start the selection start after change
*/
private void changeSpanStateBySelection(int start)
{
state.clearSelection();
StyleSpan[] spans = getEditableText().getSpans(start - 1, start, StyleSpan.class);
for (StyleSpan span : spans) {
if (span.getStyle() == Typeface.BOLD) {
state.enableBold(true);
} else {
state.enableItalic(true);
}
}
UnderlineSpan[] underLineSpans = getEditableText().getSpans(start, start, UnderlineSpan.class);
if (underLineSpans.length != 0) {
state.enableUnderLine(true);
}
StrikethroughSpan[] strikethroughSpan = getEditableText().getSpans(start, start, StrikethroughSpan.class);
if (strikethroughSpan.length != 0) {
state.enableStrikethrough(true);
}
}
private void changeSpanStateBySelection(int start, int end)
{
state.clearSelection();
StyleSpan[] spans = getEditableText().getSpans(start, end, StyleSpan.class);
for (StyleSpan span : spans) {
if (isRangeInSpan(span, start, end)) {
if (span.getStyle() == Typeface.BOLD) {
state.enableBold(true);
} else {
state.enableItalic(true);
}
}
}
UnderlineSpan[] underLineSpans = getEditableText().getSpans(start, start, UnderlineSpan.class);
if (underLineSpans.length != 0 && isRangeInSpan(underLineSpans[0], start, end)) {
state.enableUnderLine(true);
}
StrikethroughSpan[] strikethroughSpan = getEditableText().getSpans(start, start, StrikethroughSpan.class);
if (strikethroughSpan.length != 0 && isRangeInSpan(strikethroughSpan[0], start, end)) {
state.enableStrikethrough(true);
}
}
/**
* estimate range whether in the span's start to end
*
* @param span the span to estimate
* @param start start of the range
* @param end end of the range
* @return if in this bound return true else return false
*/
private boolean isRangeInSpan(Object span, int start, int end)
{
return getEditableText().getSpanStart(span) <= start && getEditableText().getSpanEnd(span) >= end;
}
/**
* estimate span whether in the editText limit by parameters start and end
*
* @param span the span to estimate
* @param start start of the text
* @param end end of the text
* @return if in this bound return true else return false
*/
private boolean isSpanInRange(Object span, int start, int end)
{
return getEditableText().getSpanStart(span) >= start && getEditableText().getSpanEnd(span) <= end;
}
/**
* use reflection to change span effect scope
*
* @param span the span what is extend CharacterStyle
* @param lengthAfter the input character's increment
* @param ss use method EditText.getEditableText()
*/
private void changeCharacterStyleEnd(CharacterStyle span, int lengthAfter, Editable ss)
{
if (lengthAfter == 0)
return;
try {
Class<?> classType = ss.getClass();
Field count = classType.getDeclaredField("mSpanCount");
Field spans = classType.getDeclaredField("mSpans");
Field ends = classType.getDeclaredField("mSpanEnds");
count.setAccessible(true);
spans.setAccessible(true);
ends.setAccessible(true);
int mSpanCount = (int) count.get(ss);
Object[] mSpans = (Object[]) spans.get(ss);
int[] mSpanEnds = (int[]) ends.get(ss);
for (int i = mSpanCount - 1; i >= 0; i--) {
if (mSpans[i] == span) {
mSpanEnds[i] += lengthAfter;
break;
}
}
ends.set(ss, mSpanEnds);
} catch (Exception e) {
e.printStackTrace();
}
}
private void setSelectionTextBold(boolean isBold, int start, int end)
{
setSelectionTextSpan(isBold, Typeface.BOLD, start, end);
}
private void setSelectionTextItalic(boolean isItalic, int start, int end)
{
setSelectionTextSpan(isItalic, Typeface.ITALIC, start, end);
}
private void setSelectionTextSpan(boolean isValid, int style, int start, int end)
{
//merge span
if (isValid) {
StyleSpan[] spans = getStyleSpans(style, start, end);
for (StyleSpan span : spans) {
if (isSpanInRange(span, start, end)) {
getEditableText().removeSpan(span);
}
}
int newStart = start;
int newEnd = end;
StyleSpan before = getStyleSpan(style, getEditableText(), start - 1, start);
if (before != null) {
newStart = getEditableText().getSpanStart(before);
getEditableText().removeSpan(before);
}
StyleSpan after = getStyleSpan(style, getEditableText(), end, end + 1);
if (after != null) {
newEnd = getEditableText().getSpanEnd(after);
getEditableText().removeSpan(after);
}
setSpan(new StyleSpan(style), newStart, newEnd);
} else { // spilt span
StyleSpan span = getStyleSpan(style, getEditableText(), start, end);
int spanStart = getEditableText().getSpanStart(span);
int spanEnd = getEditableText().getSpanEnd(span);
if (spanStart < start) {
setSpan(new StyleSpan(style), spanStart, start);
}
if (spanEnd > end) {
setSpan(new StyleSpan(style), end, spanEnd);
}
getEditableText().removeSpan(span);
}
}
private void setTextSelection(boolean isBold, CharacterStyle cSpan, int start, int end)
{
//merge span
if (isBold) {
CharacterStyle[] spans = getCharacterStyles(cSpan.getClass(), start, end);
for (CharacterStyle span : spans) {
if (isSpanInRange(span, start, end)) {
getEditableText().removeSpan(span);
}
}
int newStart = start;
int newEnd = end;
CharacterStyle before = getCharacterStyleSpan(cSpan.getClass(), start - 1, start);
if (before != null) {
newStart = getEditableText().getSpanStart(before);
getEditableText().removeSpan(before);
}
CharacterStyle after = getCharacterStyleSpan(cSpan.getClass(), end, end + 1);
if (after != null) {
newEnd = getEditableText().getSpanEnd(after);
getEditableText().removeSpan(after);
}
setSpan(cSpan, newStart, newEnd);
} else { // spilt span
CharacterStyle span = getCharacterStyleSpan(cSpan.getClass(), start, end);
int spanStart = getEditableText().getSpanStart(span);
int spanEnd = getEditableText().getSpanEnd(span);
if (spanStart < start) {
setSpan(cSpan, spanStart, start);
}
if (spanEnd > end) {
setSpan(cSpan, end, spanEnd);
}
getEditableText().removeSpan(span);
}
}
private void setQuote()
{
int start = getSelectionStart();
int end = getSelectionEnd();
for (int i = 0; i < getLineCount(); i++) {
int lineStart = getLayout().getLineStart(i);
if (lineStart == start) {
break;
}
if ((lineStart > start) || (lineStart < start && i == (getLineCount() - 1))) {
getEditableText().insert(start, "\n");
setSelection(start + 1, end + 1);
break;
}
}
setSpan(new QuoteSpan(), getSelectionStart(), getSelectionEnd());
}
private void setBullet()
{
int start = getSelectionStart();
int end = getSelectionEnd();
for (int i = 0; i < getLineCount(); i++) {
int lineStart = getLayout().getLineStart(i);
if (lineStart == start) {
break;
}
if ((lineStart > start) || (lineStart < start && i == (getLineCount() - 1))) {
getEditableText().insert(start, "\n");
setSelection(start + 1, end + 1);
break;
}
}
setSpan(new BulletSpan(), getSelectionStart(), getSelectionEnd());
}
/**
* get styleSpan by specified style from the editable text
*
* @param style the specified style
* @param editable the editable text
* @param start start of editable
* @param end end of editable
* @return if there has a StyleSpan which style is specified in start to end,return it,or return null
*/
protected StyleSpan getStyleSpan(int style, Editable editable, int start, int end)
{
StyleSpan[] spans = editable.getSpans(start, end, StyleSpan.class);
for (StyleSpan span : spans) {
if (span.getStyle() == style) {
return span;
}
}
return null;
}
protected StyleSpan[] getStyleSpans(int style, int start, int end)
{
StyleSpan[] spans = getEditableText().getSpans(start, end, StyleSpan.class);
ArrayList<StyleSpan> result = new ArrayList<>();
for (StyleSpan span : spans) {
if (span.getStyle() == style) {
result.add(span);
}
}
return result.toArray(new StyleSpan[result.size()]);
}
protected CharacterStyle getCharacterStyleSpan(Class<? extends CharacterStyle> clazz, int
start, int end)
{
CharacterStyle[] spans = getEditableText().getSpans(start, end, CharacterStyle.class);
for (CharacterStyle span : spans) {
if (span.getClass().equals(clazz)) {
return span;
}
}
return null;
}
protected CharacterStyle[] getCharacterStyles(Class<? extends CharacterStyle> clazz, int start, int end)
{
CharacterStyle[] spans = getEditableText().getSpans(start, end, CharacterStyle.class);
ArrayList<CharacterStyle> result = new ArrayList<>();
for (CharacterStyle span : spans) {
if (span.getClass().equals(clazz)) {
result.add(span);
}
}
return result.toArray(new CharacterStyle[result.size()]);
}
private void setSpan(Object span, int start, int end)
{
getEditableText().setSpan(span, start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
}
public interface TextSpanChangeListener
{
/**
* called when current text span changed
*
* @param type span type
* @param isValid is span Valid
*/
void OnTextSpanChanged(TextSpanState.TextSpan type, boolean isValid);
}
}
| rich_edittext/src/main/java/com/pxh/richedittext/RichEditText.java | package com.pxh.richedittext;
import android.content.Context;
import android.graphics.Bitmap;
import android.graphics.Typeface;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.support.v7.widget.AppCompatEditText;
import android.text.Editable;
import android.text.Html;
import android.text.Spannable;
import android.text.SpannableString;
import android.text.Spanned;
import android.text.style.BulletSpan;
import android.text.style.CharacterStyle;
import android.text.style.DynamicDrawableSpan;
import android.text.style.ImageSpan;
import android.text.style.QuoteSpan;
import android.text.style.StrikethroughSpan;
import android.text.style.StyleSpan;
import android.text.style.URLSpan;
import android.text.style.UnderlineSpan;
import android.util.AttributeSet;
import android.util.DisplayMetrics;
import android.view.WindowManager;
import java.lang.reflect.Field;
import java.util.ArrayList;
public class RichEditText extends AppCompatEditText
{
private Context context;
/**
* use bitmap creator get a bitmap
*/
private BitmapCreator bitmapCreator;
TextSpanState state = new TextSpanState();
public RichEditText(Context context)
{
this(context, null);
}
public RichEditText(final Context context, AttributeSet attrs)
{
super(context, attrs);
this.context = context;
post(new Runnable()
{
@Override
public void run()
{
DisplayMetrics metric = new DisplayMetrics();
WindowManager wm = (WindowManager) context.getSystemService(Context.WINDOW_SERVICE);
wm.getDefaultDisplay().getMetrics(metric);
int maxWidth = RichEditText.this.getMeasuredWidth() - 2;
int maxHeight = metric.heightPixels;
bitmapCreator = new InsertBitmapCreator(maxWidth, maxHeight);
}
});
}
public void insertImage(Uri uri)
{
String path = UriUtils.getValidPath(context, uri);
Bitmap bitmap = bitmapCreator.getBitmapByDiskPath(path);
SpannableString ss = new SpannableString(path);
//construct a Drawable and set Bounds
Drawable mDrawable = new BitmapDrawable(context.getResources(), bitmap);
int width = mDrawable.getIntrinsicWidth();
int height = mDrawable.getIntrinsicHeight();
mDrawable.setBounds(0, 0, width > 0 ? width : 0, height > 0 ? height : 0);
ImageSpan span = new ImageSpan(mDrawable, path, DynamicDrawableSpan.ALIGN_BOTTOM);
ss.setSpan(span, 0, path.length(), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
int start = this.getSelectionStart();
getEditableText().insert(start, ss);//insert the imageSpan
setSelection(start + ss.length()); //set selection start position
}
public void insertUrl(String describe, String url)
{
SpannableString ss = new SpannableString(describe);
ss.setSpan(new URLSpan(url), 0, ss.length(), Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
getEditableText().insert(getSelectionStart(), ss);
}
public void enableBold(boolean isValid)
{
int start = getSelectionStart();
int end = getSelectionEnd();
if (start < end)
setSelectionTextBold(isValid, start, end);
state.enableBold(isValid);
}
public void enableItalic(boolean isValid)
{
state.enableItalic(isValid);
}
public void enableUnderLine(boolean isValid)
{
state.enableUnderLine(isValid);
}
public void enableStrikethrough(boolean isValid)
{
state.enableStrikethrough(isValid);
}
public void enableQuote(boolean isValid)
{
setQuote();
}
public void enableBullet(boolean isValid)
{
setBullet();
}
public boolean isBoldEnable()
{
return state.isBoldEnable();
}
public boolean isUnderLineEnable()
{
return state.isUnderLineEnable();
}
public boolean isItalicEnable()
{
return state.isItalicEnable();
}
public boolean isStrikethroughEnable()
{
return state.isStrikethroughEnable();
}
public void setHtml(final String html)
{
Html.ImageGetter imgGetter = new RichEditorImageGetter(this);
setText(Html.fromHtml(html, imgGetter, null));
}
public String getHtml()
{
return Html.toHtml(getText());
}
public void setSpanChangeListener(TextSpanChangeListener listener)
{
state.setSpanChangeListener(listener);
}
@Override
protected void onSelectionChanged(int selStart, int selEnd)
{
super.onSelectionChanged(selStart, selEnd);
if (state == null) {
return;
}
if (selStart == selEnd) {
changeSpanStateBySelection(selStart);
} else {
changeSpanStateBySelection(selStart, selEnd);
}
}
@Override
protected void onTextChanged(CharSequence text, int start, int lengthBefore, int lengthAfter)
{
if (state == null) {
return;
}
if (state.isBoldEnable()) {
setTextSpan(Typeface.BOLD, start, lengthAfter);
}
if (state.isItalicEnable()) {
setTextSpan(Typeface.ITALIC, start, lengthAfter);
}
if (state.isUnderLineEnable()) {
setTextSpan(new UnderlineSpan(),start,lengthAfter);
}
if (state.isStrikethroughEnable()) {
setTextSpan(new StrikethroughSpan(), start, lengthAfter);
}
}
/**
* when characters input , set the text's span by characterStyle and ParagraphStyle.
* Parameters start and lengthAfter must use the parameter of onTextChanged
*
* @param start the start of character's input
* @param lengthAfter the length of character's input
*/
private void setTextSpan(int style, int start, int lengthAfter)
{
if (start == 0) {
//if start = 0, text must doesn't have spans, use new StyleSpan
setSpan(new StyleSpan(style), start, start + lengthAfter);
} else {
//estimate the character what in front of input whether have span
StyleSpan boldSpan = getStyleSpan(style, getEditableText(), start - 1, start);
if (boldSpan == null) {
setSpan(new StyleSpan(style), start, start + lengthAfter);
} else {
//if have span , change the span's effect scope
changeCharacterStyleEnd(boldSpan, lengthAfter, getEditableText());
}
}
}
private void setTextSpan(CharacterStyle span, int start, int lengthAfter)
{
if (start == 0) {
setSpan(span, start, start + lengthAfter);
} else {
CharacterStyle characterStyleSpan = getCharacterStyleSpan(span.getClass(), start - 1, start);
if (characterStyleSpan == null) {
setSpan(span, start, start + lengthAfter);
} else {
changeCharacterStyleEnd(characterStyleSpan, lengthAfter, getEditableText());
}
}
}
/**
* change Span's state when selection change
*
* @param start the selection start after change
*/
private void changeSpanStateBySelection(int start)
{
state.clearSelection();
StyleSpan[] spans = getEditableText().getSpans(start - 1, start, StyleSpan.class);
for (StyleSpan span : spans) {
if (span.getStyle() == Typeface.BOLD) {
state.enableBold(true);
} else {
state.enableItalic(true);
}
}
UnderlineSpan[] underLineSpans = getEditableText().getSpans(start, start, UnderlineSpan.class);
if (underLineSpans.length != 0) {
state.enableUnderLine(true);
}
StrikethroughSpan[] strikethroughSpan = getEditableText().getSpans(start, start, StrikethroughSpan.class);
if (strikethroughSpan.length != 0) {
state.enableStrikethrough(true);
}
}
private void changeSpanStateBySelection(int start, int end)
{
state.clearSelection();
StyleSpan[] spans = getEditableText().getSpans(start, end, StyleSpan.class);
for (StyleSpan span : spans) {
if (isRangeInSpan(span, start, end)) {
if (span.getStyle() == Typeface.BOLD) {
state.enableBold(true);
} else {
state.enableItalic(true);
}
}
}
UnderlineSpan[] underLineSpans = getEditableText().getSpans(start, start, UnderlineSpan.class);
if (underLineSpans.length != 0 && isRangeInSpan(underLineSpans[0], start, end)) {
state.enableUnderLine(true);
}
StrikethroughSpan[] strikethroughSpan = getEditableText().getSpans(start, start, StrikethroughSpan.class);
if (strikethroughSpan.length != 0 && isRangeInSpan(strikethroughSpan[0], start, end)) {
state.enableStrikethrough(true);
}
}
/**
* estimate range whether in the span's start to end
*
* @param span the span to estimate
* @param start start of the range
* @param end end of the range
* @return if in this bound return true else return false
*/
private boolean isRangeInSpan(Object span, int start, int end)
{
return getEditableText().getSpanStart(span) <= start && getEditableText().getSpanEnd(span) >= end;
}
/**
* estimate span whether in the editText limit by parameters start and end
*
* @param span the span to estimate
* @param start start of the text
* @param end end of the text
* @return if in this bound return true else return false
*/
private boolean isSpanInRange(Object span, int start, int end)
{
return getEditableText().getSpanStart(span) >= start && getEditableText().getSpanEnd(span) <= end;
}
/**
* use reflection to change span effect scope
*
* @param span the span what is extend CharacterStyle
* @param lengthAfter the input character's increment
* @param ss use method EditText.getEditableText()
*/
private void changeCharacterStyleEnd(CharacterStyle span, int lengthAfter, Editable ss)
{
if (lengthAfter == 0)
return;
try {
Class<?> classType = ss.getClass();
Field count = classType.getDeclaredField("mSpanCount");
Field spans = classType.getDeclaredField("mSpans");
Field ends = classType.getDeclaredField("mSpanEnds");
count.setAccessible(true);
spans.setAccessible(true);
ends.setAccessible(true);
int mSpanCount = (int) count.get(ss);
Object[] mSpans = (Object[]) spans.get(ss);
int[] mSpanEnds = (int[]) ends.get(ss);
for (int i = mSpanCount - 1; i >= 0; i--) {
if (mSpans[i] == span) {
mSpanEnds[i] += lengthAfter;
break;
}
}
ends.set(ss, mSpanEnds);
} catch (Exception e) {
e.printStackTrace();
}
}
private void setSelectionTextBold(boolean isBold, int start, int end)
{
setSelectionTextSpan(isBold, Typeface.BOLD, start, end);
}
private void setSelectionTextSpan(boolean isValid, int style, int start, int end)
{
//merge span
if (isValid) {
StyleSpan[] spans = getStyleSpans(style, start, end);
for (StyleSpan span : spans) {
if (isSpanInRange(span, start, end)) {
getEditableText().removeSpan(span);
}
}
int newStart = start;
int newEnd = end;
StyleSpan before = getStyleSpan(style, getEditableText(), start - 1, start);
if (before != null) {
newStart = getEditableText().getSpanStart(before);
getEditableText().removeSpan(before);
}
StyleSpan after = getStyleSpan(style, getEditableText(), end, end + 1);
if (after != null) {
newEnd = getEditableText().getSpanEnd(after);
getEditableText().removeSpan(after);
}
setSpan(new StyleSpan(style), newStart, newEnd);
} else { // spilt span
StyleSpan span = getStyleSpan(style, getEditableText(), start, end);
int spanStart = getEditableText().getSpanStart(span);
int spanEnd = getEditableText().getSpanEnd(span);
if (spanStart < start) {
setSpan(new StyleSpan(style), spanStart, start);
}
if (spanEnd > end) {
setSpan(new StyleSpan(style), end, spanEnd);
}
getEditableText().removeSpan(span);
}
}
/*private void setTextSelection(boolean isBold, Class<? extends CharacterStyle> clazz,int start, int end)
{
//merge span
if (isBold) {
CharacterStyle[] spans = getCharacterStyles(clazz, start, end);
for (CharacterStyle span : spans) {
if (isSpanInRange(span, start, end)) {
getEditableText().removeSpan(span);
}
}
int newStart = start;
int newEnd = end;
CharacterStyle before = getCharacterStyleSpan(clazz, getEditableText(), start - 1, start);
if (before != null) {
newStart = getEditableText().getSpanStart(before);
getEditableText().removeSpan(before);
}
CharacterStyle after = getCharacterStyleSpan(clazz, getEditableText(), end, end + 1);
if (after != null) {
newEnd = getEditableText().getSpanEnd(after);
getEditableText().removeSpan(after);
}
setSpan(new StyleSpan(Typeface.BOLD), newStart, newEnd);
} else { // spilt span
StyleSpan span = getStyleSpan(Typeface.BOLD, getEditableText(), start, end);
int spanStart = getEditableText().getSpanStart(span);
int spanEnd = getEditableText().getSpanEnd(span);
if (spanStart < start) {
setSpan(new StyleSpan(Typeface.BOLD), spanStart, start);
}
if (spanEnd > end) {
setSpan(new StyleSpan(Typeface.BOLD), end, spanEnd);
}
getEditableText().removeSpan(span);
}
}*/
private void setQuote()
{
int start = getSelectionStart();
int end = getSelectionEnd();
for (int i = 0; i < getLineCount(); i++) {
int lineStart = getLayout().getLineStart(i);
if (lineStart == start) {
break;
}
if ((lineStart > start) || (lineStart < start && i == (getLineCount() - 1))) {
getEditableText().insert(start, "\n");
setSelection(start + 1, end + 1);
break;
}
}
setSpan(new QuoteSpan(), getSelectionStart(), getSelectionEnd());
}
private void setBullet()
{
int start = getSelectionStart();
int end = getSelectionEnd();
for (int i = 0; i < getLineCount(); i++) {
int lineStart = getLayout().getLineStart(i);
if (lineStart == start) {
break;
}
if ((lineStart > start) || (lineStart < start && i == (getLineCount() - 1))) {
getEditableText().insert(start, "\n");
setSelection(start + 1, end + 1);
break;
}
}
setSpan(new BulletSpan(), getSelectionStart(), getSelectionEnd());
}
/**
* get styleSpan by specified style from the editable text
*
* @param style the specified style
* @param editable the editable text
* @param start start of editable
* @param end end of editable
* @return if there has a StyleSpan which style is specified in start to end,return it,or return null
*/
protected StyleSpan getStyleSpan(int style, Editable editable, int start, int end)
{
StyleSpan[] spans = editable.getSpans(start, end, StyleSpan.class);
for (StyleSpan span : spans) {
if (span.getStyle() == style) {
return span;
}
}
return null;
}
protected StyleSpan[] getStyleSpans(int style, int start, int end)
{
StyleSpan[] spans = getEditableText().getSpans(start, end, StyleSpan.class);
ArrayList<StyleSpan> result = new ArrayList<>();
for (StyleSpan span : spans) {
if (span.getStyle() == style) {
result.add(span);
}
}
return result.toArray(new StyleSpan[result.size()]);
}
protected CharacterStyle getCharacterStyleSpan(Class<? extends CharacterStyle> clazz, int
start, int end)
{
CharacterStyle[] spans = getEditableText().getSpans(start, end, CharacterStyle.class);
for (CharacterStyle span : spans) {
if (span.getClass().equals(clazz)) {
return span;
}
}
return null;
}
protected CharacterStyle[] getCharacterStyles(Class<? extends CharacterStyle> clazz, int start, int end)
{
CharacterStyle[] spans = getEditableText().getSpans(start, end, CharacterStyle.class);
ArrayList<CharacterStyle> result = new ArrayList<>();
for (CharacterStyle span : spans) {
if (span.getClass().equals(clazz)) {
result.add(span);
}
}
return result.toArray(new CharacterStyle[result.size()]);
}
private void setSpan(Object span, int start, int end)
{
getEditableText().setSpan(span, start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
}
public interface TextSpanChangeListener
{
/**
* called when current text span changed
*
* @param type span type
* @param isValid is span Valid
*/
void OnTextSpanChanged(TextSpanState.TextSpan type, boolean isValid);
}
}
| 6/3 merge span fix bug.
| rich_edittext/src/main/java/com/pxh/richedittext/RichEditText.java | 6/3 merge span fix bug. | <ide><path>ich_edittext/src/main/java/com/pxh/richedittext/RichEditText.java
<ide>
<ide> public void enableItalic(boolean isValid)
<ide> {
<add> int start = getSelectionStart();
<add> int end = getSelectionEnd();
<add> if (start < end)
<add> setSelectionTextBold(isValid, start, end);
<ide> state.enableItalic(isValid);
<ide> }
<ide>
<ide> setTextSpan(Typeface.ITALIC, start, lengthAfter);
<ide> }
<ide> if (state.isUnderLineEnable()) {
<del> setTextSpan(new UnderlineSpan(),start,lengthAfter);
<add> setTextSpan(new UnderlineSpan(), start, lengthAfter);
<ide> }
<ide> if (state.isStrikethroughEnable()) {
<ide> setTextSpan(new StrikethroughSpan(), start, lengthAfter);
<ide> setSelectionTextSpan(isBold, Typeface.BOLD, start, end);
<ide> }
<ide>
<add> private void setSelectionTextItalic(boolean isItalic, int start, int end)
<add> {
<add> setSelectionTextSpan(isItalic, Typeface.ITALIC, start, end);
<add> }
<add>
<ide> private void setSelectionTextSpan(boolean isValid, int style, int start, int end)
<ide> {
<ide> //merge span
<ide> }
<ide> }
<ide>
<del> /*private void setTextSelection(boolean isBold, Class<? extends CharacterStyle> clazz,int start, int end)
<add> private void setTextSelection(boolean isBold, CharacterStyle cSpan, int start, int end)
<ide> {
<ide> //merge span
<ide> if (isBold) {
<del> CharacterStyle[] spans = getCharacterStyles(clazz, start, end);
<add> CharacterStyle[] spans = getCharacterStyles(cSpan.getClass(), start, end);
<ide> for (CharacterStyle span : spans) {
<ide> if (isSpanInRange(span, start, end)) {
<ide> getEditableText().removeSpan(span);
<ide> }
<ide> int newStart = start;
<ide> int newEnd = end;
<del> CharacterStyle before = getCharacterStyleSpan(clazz, getEditableText(), start - 1, start);
<add> CharacterStyle before = getCharacterStyleSpan(cSpan.getClass(), start - 1, start);
<ide> if (before != null) {
<ide> newStart = getEditableText().getSpanStart(before);
<ide> getEditableText().removeSpan(before);
<ide> }
<del> CharacterStyle after = getCharacterStyleSpan(clazz, getEditableText(), end, end + 1);
<add> CharacterStyle after = getCharacterStyleSpan(cSpan.getClass(), end, end + 1);
<ide> if (after != null) {
<ide> newEnd = getEditableText().getSpanEnd(after);
<ide> getEditableText().removeSpan(after);
<ide> }
<del> setSpan(new StyleSpan(Typeface.BOLD), newStart, newEnd);
<add> setSpan(cSpan, newStart, newEnd);
<ide> } else { // spilt span
<del> StyleSpan span = getStyleSpan(Typeface.BOLD, getEditableText(), start, end);
<add> CharacterStyle span = getCharacterStyleSpan(cSpan.getClass(), start, end);
<ide> int spanStart = getEditableText().getSpanStart(span);
<ide> int spanEnd = getEditableText().getSpanEnd(span);
<ide> if (spanStart < start) {
<del> setSpan(new StyleSpan(Typeface.BOLD), spanStart, start);
<add> setSpan(cSpan, spanStart, start);
<ide> }
<ide> if (spanEnd > end) {
<del> setSpan(new StyleSpan(Typeface.BOLD), end, spanEnd);
<add> setSpan(cSpan, end, spanEnd);
<ide> }
<ide> getEditableText().removeSpan(span);
<ide> }
<del> }*/
<add> }
<ide>
<ide> private void setQuote()
<ide> { |
|
Java | apache-2.0 | ba697f1c9a25314c218b2eb2113b2fe97f8a252f | 0 | KylanTraynor/Civilizations,KylanTraynor/Civilizations | package com.kylantraynor.civilizations.territories;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import javax.imageio.ImageIO;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.block.Biome;
import com.kylantraynor.civilizations.Civilizations;
import com.kylantraynor.civilizations.groups.settlements.forts.Fort;
import com.kylantraynor.civilizations.hook.worldborder.WorldBorderHook;
public class InfluenceMap {
private static int oceanLevel = 48;
private static int precision = 128; // (1 px = 128 blocks)
private static Map<Fort, BufferedImage> image = new HashMap<Fort, BufferedImage>();
public static BufferedImage getImage(Fort f){
if(!image.containsKey(f)){
if(WorldBorderHook.isActive()){
if(WorldBorderHook.getWorldRadiusX(f.getLocation().getWorld()) == 0) return null;
image.put(f, new BufferedImage(
WorldBorderHook.getWorldRadiusX(f.getLocation().getWorld()) * 2 / precision,
WorldBorderHook.getWorldRadiusZ(f.getLocation().getWorld()) * 2 / precision,
BufferedImage.TYPE_BYTE_GRAY));
return image.get(f);
} else {
return null;
}
} else {
return image.get(f);
}
}
/**
* Saves the influence Map.
* @param f
*/
public static void saveInfluenceMap(Fort f){
BufferedImage img = getImage(f);
if(img != null){
File file = new File(Civilizations.currentInstance.getDataFolder(), f.getName() + " Influence.jpg");
try {
ImageIO.write(img, "JPEG", file);
} catch (IOException e) {
e.printStackTrace();
}
}
}
public static Fort getInfluentFortAt(Location l){
Fort influent = null;
double influence = 0.0;
for(Fort f : Fort.getAll()){
double finf = getFortInfluenceAt(f, l);
if(influence < finf){
influence = finf;
influent = f;
}
}
return influent;
}
public static double getFortInfluenceAt(Fort f, Location l){
if(!f.getLocation().getWorld().equals(l.getWorld())) return 0.0;
l = l.clone();
l.setY(255);
while(l.getBlock().getType() == Material.AIR || l.getBlock().isLiquid()){
l.setY(l.getY() - 1);
if(l.getY() < oceanLevel - 1) break;
}
if(l.getBlock().getBiome() == Biome.OCEAN || l.getBlock().getBiome() == Biome.DEEP_OCEAN){
if(l.getY() < oceanLevel - 1) return 0.0;
}
double fx = f.getLocation().getX();
double fy = f.getLocation().getY();
double fz = f.getLocation().getZ();
double xzCoeff = Math.sqrt((fx - l.getX()) * (fx - l.getX()) + (fz - l.getZ()) * (fz - l.getZ()));
double yCoeff = fy - l.getY();
double totalCoeff = Math.max(xzCoeff - yCoeff, 0.1);
double result = Math.min(Math.max((f.getInfluence() * 100.0) / totalCoeff, 0.1), 100.0);
BufferedImage img = getImage(f);
if(img != null){
imgSetGrayscaleAtLocation(l, img, result / 100);
}
return result;
}
public static void imgSetGrayscaleAtLocation(Location l, BufferedImage img, double data){
if(!WorldBorderHook.isActive()) return;
if(img == null) return;
if(l == null) return;
int imgX = 0;
int imgY = 0;
int imgMinX = -WorldBorderHook.getWorldRadiusX(l.getWorld());
imgMinX += WorldBorderHook.getWorldCenter(l.getWorld()).getBlockX();
int imgMinZ = -WorldBorderHook.getWorldRadiusZ(l.getWorld());
imgMinZ += WorldBorderHook.getWorldCenter(l.getWorld()).getBlockZ();
imgX = l.getBlockX() - imgMinX;
imgY = l.getBlockZ() - imgMinZ;
imgX /= precision;
imgY /= precision;
Bukkit.getServer().getLogger().log(Level.INFO, "Writing in image at " + imgX + ", " + imgY + ". (" + data + ")");
int r = (int) (255 * data);// red component 0...255
int g = (int) (255 * data);// green component 0...255
int b = (int) (255 * data);// blue component 0...255
int col = (r << 16) | (g << 8) | b;
img.setRGB(imgX, imgY, col);
}
}
| Civilizations/src/main/java/com/kylantraynor/civilizations/territories/InfluenceMap.java | package com.kylantraynor.civilizations.territories;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import javax.imageio.ImageIO;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.block.Biome;
import com.kylantraynor.civilizations.Civilizations;
import com.kylantraynor.civilizations.groups.settlements.forts.Fort;
import com.kylantraynor.civilizations.hook.worldborder.WorldBorderHook;
public class InfluenceMap {
private static int oceanLevel = 48;
private static int precision = 128; // (1 px = 128 blocks)
private static Map<Fort, BufferedImage> image = new HashMap<Fort, BufferedImage>();
public static BufferedImage getImage(Fort f){
if(!image.containsKey(f)){
if(WorldBorderHook.isActive()){
if(WorldBorderHook.getWorldRadiusX(f.getLocation().getWorld()) == 0) return null;
image.put(f, new BufferedImage(
WorldBorderHook.getWorldRadiusX(f.getLocation().getWorld()) * 2 / precision,
WorldBorderHook.getWorldRadiusZ(f.getLocation().getWorld()) * 2 / precision,
BufferedImage.TYPE_BYTE_GRAY));
return image.get(f);
} else {
return null;
}
} else {
return image.get(f);
}
}
/**
* Saves the influence Map.
* @param f
*/
public static void saveInfluenceMap(Fort f){
BufferedImage img = getImage(f);
if(img != null){
File file = new File(Civilizations.currentInstance.getDataFolder(), f.getName() + " Influence.jpg");
try {
ImageIO.write(img, "JPEG", file);
} catch (IOException e) {
e.printStackTrace();
}
}
}
public static Fort getInfluentFortAt(Location l){
Fort influent = null;
double influence = 0.0;
for(Fort f : Fort.getAll()){
double finf = getFortInfluenceAt(f, l);
if(influence < finf){
influence = finf;
influent = f;
}
}
return influent;
}
public static double getFortInfluenceAt(Fort f, Location l){
if(!f.getLocation().getWorld().equals(l.getWorld())) return 0.0;
l = l.clone();
l.setY(255);
while(l.getBlock().getType() == Material.AIR || l.getBlock().isLiquid()){
l.setY(l.getY() - 1);
if(l.getY() < oceanLevel - 1) break;
}
if(l.getBlock().getBiome() == Biome.OCEAN || l.getBlock().getBiome() == Biome.DEEP_OCEAN){
if(l.getY() < oceanLevel - 1) return 0.0;
}
double fx = f.getLocation().getX();
double fy = f.getLocation().getY();
double fz = f.getLocation().getZ();
double xzCoeff = Math.sqrt((fx - l.getX()) * (fx - l.getX()) + (fz - l.getZ()) * (fz - l.getZ()));
double yCoeff = fy - l.getY();
double totalCoeff = Math.max(xzCoeff - yCoeff, 0.1);
double result = Math.min(Math.max((f.getInfluence() * 100.0) / totalCoeff, 0.1), 100.0);
BufferedImage img = getImage(f);
if(img != null){
imgSetPixelAtLocation(l, img, (int)(result * 255 / 100));
}
return result;
}
public static void imgSetPixelAtLocation(Location l, BufferedImage img, int data){
if(!WorldBorderHook.isActive()) return;
if(img == null) return;
if(l == null) return;
int imgX = 0;
int imgY = 0;
int imgMinX = -WorldBorderHook.getWorldRadiusX(l.getWorld());
imgMinX += WorldBorderHook.getWorldCenter(l.getWorld()).getBlockX();
int imgMinZ = -WorldBorderHook.getWorldRadiusZ(l.getWorld());
imgMinZ += WorldBorderHook.getWorldCenter(l.getWorld()).getBlockZ();
imgX = l.getBlockX() - imgMinX;
imgY = l.getBlockZ() - imgMinZ;
imgX /= precision;
imgY /= precision;
Bukkit.getServer().getLogger().log(Level.INFO, "Writing in image at " + imgX + ", " + imgY + ". (" + data + ")");
img.setRGB(imgX, imgY, data);
}
}
| Changed grayscale range. | Civilizations/src/main/java/com/kylantraynor/civilizations/territories/InfluenceMap.java | Changed grayscale range. | <ide><path>ivilizations/src/main/java/com/kylantraynor/civilizations/territories/InfluenceMap.java
<ide> double result = Math.min(Math.max((f.getInfluence() * 100.0) / totalCoeff, 0.1), 100.0);
<ide> BufferedImage img = getImage(f);
<ide> if(img != null){
<del> imgSetPixelAtLocation(l, img, (int)(result * 255 / 100));
<add> imgSetGrayscaleAtLocation(l, img, result / 100);
<ide> }
<ide> return result;
<ide> }
<ide>
<del> public static void imgSetPixelAtLocation(Location l, BufferedImage img, int data){
<add> public static void imgSetGrayscaleAtLocation(Location l, BufferedImage img, double data){
<ide> if(!WorldBorderHook.isActive()) return;
<ide> if(img == null) return;
<ide> if(l == null) return;
<ide>
<ide> Bukkit.getServer().getLogger().log(Level.INFO, "Writing in image at " + imgX + ", " + imgY + ". (" + data + ")");
<ide>
<del> img.setRGB(imgX, imgY, data);
<add> int r = (int) (255 * data);// red component 0...255
<add> int g = (int) (255 * data);// green component 0...255
<add> int b = (int) (255 * data);// blue component 0...255
<add> int col = (r << 16) | (g << 8) | b;
<add>
<add> img.setRGB(imgX, imgY, col);
<ide> }
<ide>
<ide> } |
|
Java | mit | 688d6d512d6b123fd0784d42782ec92cdaa0f830 | 0 | yegor256/cactoos | /*
* The MIT License (MIT)
*
* Copyright (c) 2017-2018 Yegor Bugayenko
*
* 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 NON-INFRINGEMENT. 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 org.cactoos.scalar;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.cactoos.Proc;
import org.cactoos.Scalar;
import org.cactoos.collection.CollectionOf;
import org.cactoos.func.FuncOf;
import org.cactoos.iterable.IterableOf;
import org.cactoos.iterable.Mapped;
import org.cactoos.list.ListOf;
import org.hamcrest.Matcher;
import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.hamcrest.collection.IsIterableContainingInAnyOrder;
import org.junit.Test;
import org.llorllale.cactoos.matchers.MatcherOf;
import org.llorllale.cactoos.matchers.ScalarHasValue;
/**
* Test case for {@link AndInThreads}.
* @since 0.25
* @todo #829:30min Remove the use of the static method
* `Collections.synchronizedList`. Replace by an object-oriented approach.
* Create a class similar to `SyncCollection` but mutable.
* @checkstyle JavadocMethodCheck (500 lines)
* @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
*/
@SuppressWarnings({"PMD.TooManyMethods", "PMD.AvoidDuplicateLiterals"})
public final class AndInThreadsTest {
@Test
public void allTrue() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new True(),
new True(),
new True()
),
new ScalarHasValue<>(true)
);
}
@Test
public void oneFalse() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new True(),
new False(),
new True()
),
new ScalarHasValue<>(false)
);
}
@Test
public void allFalse() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new IterableOf<Scalar<Boolean>>(
new False(),
new False(),
new False()
)
),
new ScalarHasValue<>(false)
);
}
@Test
public void emptyIterator() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(new IterableOf<Scalar<Boolean>>()),
new ScalarHasValue<>(true)
);
}
@Test
public void iteratesList() {
final List<String> list = Collections.synchronizedList(
new ArrayList<String>(2)
);
MatcherAssert.assertThat(
"Can't iterate a list with a procedure",
new AndInThreads(
new Mapped<String, Scalar<Boolean>>(
new FuncOf<>(list::add, () -> true),
new IterableOf<>("hello", "world")
)
),
new ScalarHasValue<>(true)
);
MatcherAssert.assertThat(
list,
new IsIterableContainingInAnyOrder<String>(
new CollectionOf<Matcher<? super String>>(
new MatcherOf<>(
text -> {
return "hello".equals(text);
}
),
new MatcherOf<>(
text -> {
return "world".equals(text);
}
)
)
)
);
}
@Test
public void iteratesEmptyList() {
final List<String> list = Collections.synchronizedList(
new ArrayList<String>(2)
);
MatcherAssert.assertThat(
"Can't iterate a list",
new AndInThreads(
new Mapped<String, Scalar<Boolean>>(
new FuncOf<>(list::add, () -> true), new IterableOf<>()
)
),
new ScalarHasValue<>(
Matchers.allOf(
Matchers.equalTo(true),
new MatcherOf<>(
value -> {
return list.isEmpty();
}
)
)
)
);
}
@Test
public void worksWithProc() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
new AndInThreads(
(Proc<Integer>) list::add,
1, 1
).value();
MatcherAssert.assertThat(
list,
new IsIterableContainingInAnyOrder<Integer>(
new CollectionOf<Matcher<? super Integer>>(
new MatcherOf<>(
value -> {
return value.equals(1);
}
),
new MatcherOf<>(
value -> {
return value.equals(1);
}
)
)
)
);
}
@Test
public void worksWithFunc() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
input -> input > 0,
1, -1, 0
),
new ScalarHasValue<>(false)
);
}
@Test
public void worksWithProcIterable() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
new AndInThreads(
new Proc.NoNulls<Integer>(list::add),
new ListOf<>(1, 2)
).value();
MatcherAssert.assertThat(
list,
new IsIterableContainingInAnyOrder<Integer>(
new CollectionOf<Matcher<? super Integer>>(
new MatcherOf<>(
value -> {
return value.equals(1);
}
),
new MatcherOf<>(
value -> {
return value.equals(2);
}
)
)
)
);
}
@Test
public void worksWithIterableScalarBoolean() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new ListOf<Scalar<Boolean>>(
new Constant<Boolean>(true),
new Constant<Boolean>(true)
)
).value(),
Matchers.equalTo(true)
);
}
@Test
public void worksWithExecServiceProcValues() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
final ExecutorService service = Executors.newSingleThreadExecutor();
new AndInThreads(
service,
new Proc.NoNulls<Integer>(list::add),
1, 2
).value();
MatcherAssert.assertThat(
list,
new IsIterableContainingInAnyOrder<Integer>(
new CollectionOf<Matcher<? super Integer>>(
new MatcherOf<>(
value -> {
return value.equals(1);
}
),
new MatcherOf<>(
value -> {
return value.equals(2);
}
)
)
)
);
}
@Test
public void worksWithExecServiceProcIterable() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
final ExecutorService service = Executors.newSingleThreadExecutor();
new AndInThreads(
service,
new Proc.NoNulls<Integer>(list::add),
new ListOf<>(1, 2)
).value();
MatcherAssert.assertThat(
list,
new IsIterableContainingInAnyOrder<Integer>(
new CollectionOf<Matcher<? super Integer>>(
new MatcherOf<>(
value -> {
return value.equals(1);
}
),
new MatcherOf<>(
value -> {
return value.equals(2);
}
)
)
)
);
}
@Test
public void worksWithExecServiceScalarBooleans() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
Executors.newSingleThreadExecutor(),
new Constant<Boolean>(false),
new Constant<Boolean>(false)
).value(),
Matchers.equalTo(false)
);
}
@Test
public void worksWithExecServiceIterableScalarBoolean() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
Executors.newSingleThreadExecutor(),
new ListOf<Scalar<Boolean>>(
new Constant<Boolean>(true),
new Constant<Boolean>(false)
)
).value(),
Matchers.equalTo(false)
);
}
@Test
public void worksWithEmptyIterableScalarBoolean() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new ListOf<Scalar<Boolean>>()
).value(),
Matchers.equalTo(true)
);
}
}
| src/test/java/org/cactoos/scalar/AndInThreadsTest.java | /*
* The MIT License (MIT)
*
* Copyright (c) 2017-2018 Yegor Bugayenko
*
* 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 NON-INFRINGEMENT. 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 org.cactoos.scalar;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import org.cactoos.Proc;
import org.cactoos.Scalar;
import org.cactoos.func.FuncOf;
import org.cactoos.iterable.IterableOf;
import org.cactoos.iterable.Mapped;
import org.cactoos.list.ListOf;
import org.hamcrest.MatcherAssert;
import org.hamcrest.Matchers;
import org.junit.Test;
import org.llorllale.cactoos.matchers.MatcherOf;
import org.llorllale.cactoos.matchers.ScalarHasValue;
/**
* Test case for {@link AndInThreads}.
* @since 0.25
* @checkstyle JavadocMethodCheck (500 lines)
* @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
*/
@SuppressWarnings({"PMD.TooManyMethods", "PMD.AvoidDuplicateLiterals"})
public final class AndInThreadsTest {
@Test
public void allTrue() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new True(),
new True(),
new True()
),
new ScalarHasValue<>(true)
);
}
@Test
public void oneFalse() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new True(),
new False(),
new True()
),
new ScalarHasValue<>(false)
);
}
@Test
public void allFalse() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new IterableOf<Scalar<Boolean>>(
new False(),
new False(),
new False()
)
),
new ScalarHasValue<>(false)
);
}
@Test
public void emptyIterator() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(new IterableOf<Scalar<Boolean>>()),
new ScalarHasValue<>(true)
);
}
@Test
public void iteratesList() {
final List<String> list = Collections.synchronizedList(
new ArrayList<String>(2)
);
MatcherAssert.assertThat(
"Can't iterate a list with a procedure",
new AndInThreads(
new Mapped<String, Scalar<Boolean>>(
new FuncOf<>(list::add, () -> true),
new IterableOf<>("hello", "world")
)
),
new ScalarHasValue<>(true)
);
MatcherAssert.assertThat(
list,
Matchers.containsInAnyOrder("hello", "world")
);
}
@Test
public void iteratesEmptyList() {
final List<String> list = Collections.synchronizedList(
new ArrayList<String>(2)
);
MatcherAssert.assertThat(
"Can't iterate a list",
new AndInThreads(
new Mapped<String, Scalar<Boolean>>(
new FuncOf<>(list::add, () -> true), new IterableOf<>()
)
),
new ScalarHasValue<>(
Matchers.allOf(
Matchers.equalTo(true),
new MatcherOf<>(
value -> {
return list.isEmpty();
}
)
)
)
);
}
@Test
public void worksWithProc() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
new AndInThreads(
(Proc<Integer>) list::add,
1, 1
).value();
MatcherAssert.assertThat(
list,
Matchers.contains(1, 1)
);
}
@Test
public void worksWithFunc() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
input -> input > 0,
1, -1, 0
),
new ScalarHasValue<>(false)
);
}
@Test
public void worksWithProcIterable() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
new AndInThreads(
new Proc.NoNulls<Integer>(list::add),
new ListOf<>(1, 2)
).value();
MatcherAssert.assertThat(
list,
Matchers.containsInAnyOrder(1, 2)
);
}
@Test
public void worksWithIterableScalarBoolean() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new ListOf<Scalar<Boolean>>(
new Constant<Boolean>(true),
new Constant<Boolean>(true)
)
).value(),
Matchers.equalTo(true)
);
}
@Test
public void worksWithExecServiceProcValues() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
final ExecutorService service = Executors.newSingleThreadExecutor();
new AndInThreads(
service,
new Proc.NoNulls<Integer>(list::add),
1, 2
).value();
MatcherAssert.assertThat(
list,
Matchers.containsInAnyOrder(1, 2)
);
}
@Test
public void worksWithExecServiceProcIterable() throws Exception {
final List<Integer> list = Collections.synchronizedList(
new ArrayList<Integer>(2)
);
final ExecutorService service = Executors.newSingleThreadExecutor();
new AndInThreads(
service,
new Proc.NoNulls<Integer>(list::add),
new ListOf<>(1, 2)
).value();
MatcherAssert.assertThat(
list,
Matchers.containsInAnyOrder(1, 2)
);
}
@Test
public void worksWithExecServiceScalarBooleans() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
Executors.newSingleThreadExecutor(),
new Constant<Boolean>(false),
new Constant<Boolean>(false)
).value(),
Matchers.equalTo(false)
);
}
@Test
public void worksWithExecServiceIterableScalarBoolean() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
Executors.newSingleThreadExecutor(),
new ListOf<Scalar<Boolean>>(
new Constant<Boolean>(true),
new Constant<Boolean>(false)
)
).value(),
Matchers.equalTo(false)
);
}
@Test
public void worksWithEmptyIterableScalarBoolean() throws Exception {
MatcherAssert.assertThat(
new AndInThreads(
new ListOf<Scalar<Boolean>>()
).value(),
Matchers.equalTo(true)
);
}
}
| (#829) Fix PR issues
| src/test/java/org/cactoos/scalar/AndInThreadsTest.java | (#829) Fix PR issues | <ide><path>rc/test/java/org/cactoos/scalar/AndInThreadsTest.java
<ide> import java.util.concurrent.Executors;
<ide> import org.cactoos.Proc;
<ide> import org.cactoos.Scalar;
<add>import org.cactoos.collection.CollectionOf;
<ide> import org.cactoos.func.FuncOf;
<ide> import org.cactoos.iterable.IterableOf;
<ide> import org.cactoos.iterable.Mapped;
<ide> import org.cactoos.list.ListOf;
<add>import org.hamcrest.Matcher;
<ide> import org.hamcrest.MatcherAssert;
<ide> import org.hamcrest.Matchers;
<add>import org.hamcrest.collection.IsIterableContainingInAnyOrder;
<ide> import org.junit.Test;
<ide> import org.llorllale.cactoos.matchers.MatcherOf;
<ide> import org.llorllale.cactoos.matchers.ScalarHasValue;
<ide> /**
<ide> * Test case for {@link AndInThreads}.
<ide> * @since 0.25
<add> * @todo #829:30min Remove the use of the static method
<add> * `Collections.synchronizedList`. Replace by an object-oriented approach.
<add> * Create a class similar to `SyncCollection` but mutable.
<ide> * @checkstyle JavadocMethodCheck (500 lines)
<ide> * @checkstyle ClassDataAbstractionCouplingCheck (500 lines)
<ide> */
<ide> );
<ide> MatcherAssert.assertThat(
<ide> list,
<del> Matchers.containsInAnyOrder("hello", "world")
<add> new IsIterableContainingInAnyOrder<String>(
<add> new CollectionOf<Matcher<? super String>>(
<add> new MatcherOf<>(
<add> text -> {
<add> return "hello".equals(text);
<add> }
<add> ),
<add> new MatcherOf<>(
<add> text -> {
<add> return "world".equals(text);
<add> }
<add> )
<add> )
<add> )
<ide> );
<ide> }
<ide>
<ide> ).value();
<ide> MatcherAssert.assertThat(
<ide> list,
<del> Matchers.contains(1, 1)
<add> new IsIterableContainingInAnyOrder<Integer>(
<add> new CollectionOf<Matcher<? super Integer>>(
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(1);
<add> }
<add> ),
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(1);
<add> }
<add> )
<add> )
<add> )
<ide> );
<ide> }
<ide>
<ide> ).value();
<ide> MatcherAssert.assertThat(
<ide> list,
<del> Matchers.containsInAnyOrder(1, 2)
<add> new IsIterableContainingInAnyOrder<Integer>(
<add> new CollectionOf<Matcher<? super Integer>>(
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(1);
<add> }
<add> ),
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(2);
<add> }
<add> )
<add> )
<add> )
<ide> );
<ide> }
<ide>
<ide> ).value();
<ide> MatcherAssert.assertThat(
<ide> list,
<del> Matchers.containsInAnyOrder(1, 2)
<add> new IsIterableContainingInAnyOrder<Integer>(
<add> new CollectionOf<Matcher<? super Integer>>(
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(1);
<add> }
<add> ),
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(2);
<add> }
<add> )
<add> )
<add> )
<ide> );
<ide> }
<ide>
<ide> ).value();
<ide> MatcherAssert.assertThat(
<ide> list,
<del> Matchers.containsInAnyOrder(1, 2)
<add> new IsIterableContainingInAnyOrder<Integer>(
<add> new CollectionOf<Matcher<? super Integer>>(
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(1);
<add> }
<add> ),
<add> new MatcherOf<>(
<add> value -> {
<add> return value.equals(2);
<add> }
<add> )
<add> )
<add> )
<ide> );
<ide> }
<ide> |
|
Java | apache-2.0 | fa8429e0fed174112815eaff26fffbc511af6056 | 0 | hurzl/dmix,abarisain/dmix,hurzl/dmix,abarisain/dmix,joansmith/dmix,jcnoir/dmix,0359xiaodong/dmix,jcnoir/dmix,joansmith/dmix,0359xiaodong/dmix | MPDroid/src/com/namelessdev/mpdroid/MusicFocusable.java | /*
* Copyright (C) 2010-2014 The MPDroid Project
*
* 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.namelessdev.mpdroid;
/**
* Represents something that can react to audio focus events. We implement this instead of just
* using AudioManager.OnAudioFocusChangeListener because that interface is only available in SDK
* level 8 and above, and we want our application to work on previous SDKs.
*/
public interface MusicFocusable {
/** Signals that audio focus was gained. */
public void onGainedAudioFocus();
/**
* Signals that audio focus was lost.
*
* @param canDuck If true, audio can continue in "ducked" mode (low volume). Otherwise, all
* audio must stop.
*/
public void onLostAudioFocus(boolean canDuck);
}
| MusicFocusable: Remove unused interface.
| MPDroid/src/com/namelessdev/mpdroid/MusicFocusable.java | MusicFocusable: Remove unused interface. | <ide><path>PDroid/src/com/namelessdev/mpdroid/MusicFocusable.java
<del>/*
<del> * Copyright (C) 2010-2014 The MPDroid Project
<del> *
<del> * Licensed under the Apache License, Version 2.0 (the "License");
<del> * you may not use this file except in compliance with the License.
<del> * 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>
<del>package com.namelessdev.mpdroid;
<del>
<del>/**
<del> * Represents something that can react to audio focus events. We implement this instead of just
<del> * using AudioManager.OnAudioFocusChangeListener because that interface is only available in SDK
<del> * level 8 and above, and we want our application to work on previous SDKs.
<del> */
<del>public interface MusicFocusable {
<del> /** Signals that audio focus was gained. */
<del> public void onGainedAudioFocus();
<del>
<del> /**
<del> * Signals that audio focus was lost.
<del> *
<del> * @param canDuck If true, audio can continue in "ducked" mode (low volume). Otherwise, all
<del> * audio must stop.
<del> */
<del> public void onLostAudioFocus(boolean canDuck);
<del>} |
||
Java | mit | 4bbeef9a2662e36e0cd4292243e44ba9c26db508 | 0 | chrislo27/Stray-core | package stray.augment;
import stray.Main;
import stray.entity.EntityPlayer;
import stray.util.ParticlePool;
import stray.world.World;
import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.graphics.Color;
import com.badlogic.gdx.math.MathUtils;
public class FLUDDAugment extends Augment {
public static final float PARTICLE_SPEED = 16f;
private long lastUse = System.currentTimeMillis();
private float lastGravCoeff = 1f;
@Override
public void onActivateStart(World world) {
lastUse = System.currentTimeMillis();
world.getPlayer().veloy = 0;
lastGravCoeff = world.getPlayer().gravityCoefficient;
world.getPlayer().gravityCoefficient = World.tileparty;
}
@Override
public void onActivate(World world) {
EntityPlayer player = world.getPlayer();
for (int i = 0; i < 4; i++) {
createParticle(world, player.x + (player.sizex / 4f), player.y + (player.sizey / 10f)
+ (i * 8));
createParticle(world, player.x + ((player.sizex / 4f) * 3), player.y
+ (player.sizey / 10f) + (i * 8));
}
if(player.health < player.maxhealth){
// 25% regen boost
player.health += (Gdx.graphics.getRawDeltaTime() / 32f);
player.health = MathUtils.clamp(player.health, 0f, player.maxhealth);
}
}
private void createParticle(World world, float x, float y) {
world.particles.add(ParticlePool.obtain().setPosition(x, y).setVelocity(0, PARTICLE_SPEED)
.setTint(getColor()).setTexture("magnetglow").setLifetime(15)
.setDestroyOnBlock(true).setRotation(0.5f, Main.getRandom().nextBoolean())
.setAlpha(1f));
}
@Override
public void onActivateEnd(World world) {
world.getPlayer().gravityCoefficient = lastGravCoeff;
}
@Override
public void onActivateTick(World world) {
}
@Override
public String getName() {
return "augment.name.fludd";
}
@Override
public Color getColor() {
return Augment.reused.set(20 / 255f, 153 / 255f, 219 / 255f, 1);
}
@Override
public long getUseTime() {
return 1500;
}
@Override
public boolean canUse(World world) {
return world.getPlayer().getBlockCollidingDown() == null;
}
}
| src/stray/augment/FLUDDAugment.java | package stray.augment;
import stray.Main;
import stray.entity.EntityPlayer;
import stray.util.ParticlePool;
import stray.world.World;
import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.graphics.Color;
import com.badlogic.gdx.math.MathUtils;
public class FLUDDAugment extends Augment {
public static final float PARTICLE_SPEED = 16f;
private long lastUse = System.currentTimeMillis();
private float lastGravCoeff = 1f;
@Override
public void onActivateStart(World world) {
lastUse = System.currentTimeMillis();
world.getPlayer().veloy = 0;
lastGravCoeff = world.getPlayer().gravityCoefficient;
world.getPlayer().gravityCoefficient = World.tileparty;
}
@Override
public void onActivate(World world) {
EntityPlayer player = world.getPlayer();
for (int i = 0; i < 4; i++) {
createParticle(world, player.x + (player.sizex / 4f), player.y + (player.sizey / 10f)
+ (i * 8));
createParticle(world, player.x + ((player.sizex / 4f) * 3), player.y
+ (player.sizey / 10f) + (i * 8));
}
if(player.health < player.maxhealth){
// 25% regen boost
player.health += (Gdx.graphics.getRawDeltaTime());
player.health = MathUtils.clamp(player.health, 0f, player.maxhealth);
}
}
private void createParticle(World world, float x, float y) {
world.particles.add(ParticlePool.obtain().setPosition(x, y).setVelocity(0, PARTICLE_SPEED)
.setTint(getColor()).setTexture("magnetglow").setLifetime(15)
.setDestroyOnBlock(true).setRotation(0.5f, Main.getRandom().nextBoolean())
.setAlpha(1f));
}
@Override
public void onActivateEnd(World world) {
world.getPlayer().gravityCoefficient = lastGravCoeff;
}
@Override
public void onActivateTick(World world) {
}
@Override
public String getName() {
return "augment.name.fludd";
}
@Override
public Color getColor() {
return Augment.reused.set(20 / 255f, 153 / 255f, 219 / 255f, 1);
}
@Override
public long getUseTime() {
return 1500;
}
@Override
public boolean canUse(World world) {
return world.getPlayer().getBlockCollidingDown() == null;
}
}
| Ugh instead I super OP'd it so fixed now | src/stray/augment/FLUDDAugment.java | Ugh instead I super OP'd it so fixed now | <ide><path>rc/stray/augment/FLUDDAugment.java
<ide>
<ide> if(player.health < player.maxhealth){
<ide> // 25% regen boost
<del> player.health += (Gdx.graphics.getRawDeltaTime());
<add> player.health += (Gdx.graphics.getRawDeltaTime() / 32f);
<ide> player.health = MathUtils.clamp(player.health, 0f, player.maxhealth);
<ide> }
<ide> } |
|
Java | apache-2.0 | error: pathspec 'examples/src/main/java/druid/examples/rabbitmq/RabbitMQProducerMain.java' did not match any file(s) known to git
| ae4132adba0714e8cad2ea4ceeab7eeb4bf700fe | 1 | haoch/druid,taochaoqiang/druid,gianm/druid,praveev/druid,guobingkun/druid,dkhwangbo/druid,druid-io/druid,implydata/druid,liquidm/druid,solimant/druid,lcp0578/druid,michaelschiff/druid,rasahner/druid,skyportsystems/druid,guobingkun/druid,premc/druid,Kleagleguo/druid,b-slim/druid,leventov/druid,calliope7/druid,deltaprojects/druid,nishantmonu51/druid,dclim/druid,gianm/druid,haoch/druid,yaochitc/druid-dev,friedhardware/druid,767326791/druid,nvoron23/druid,lcp0578/druid,redBorder/druid,noddi/druid,anupkumardixit/druid,praveev/druid,monetate/druid,penuel-leo/druid,milimetric/druid,kevintvh/druid,767326791/druid,minewhat/druid,mangeshpardeshiyahoo/druid,rasahner/druid,anupkumardixit/druid,noddi/druid,deltaprojects/druid,winval/druid,Kleagleguo/druid,OttoOps/druid,haoch/druid,KurtYoung/druid,noddi/druid,cocosli/druid,authbox-lib/druid,mrijke/druid,druid-io/druid,anupkumardixit/druid,gianm/druid,fjy/druid,mghosh4/druid,liquidm/druid,knoguchi/druid,praveev/druid,zhihuij/druid,friedhardware/druid,wenjixin/druid,authbox-lib/druid,fjy/druid,minewhat/druid,kevintvh/druid,dkhwangbo/druid,zengzhihai110/druid,elijah513/druid,qix/druid,mangeshpardeshiyahoo/druid,knoguchi/druid,liquidm/druid,leventov/druid,zxs/druid,yaochitc/druid-dev,leventov/druid,redBorder/druid,OttoOps/druid,pombredanne/druid,dclim/druid,implydata/druid,smartpcr/druid,winval/druid,kevintvh/druid,metamx/druid,milimetric/druid,praveev/druid,michaelschiff/druid,fjy/druid,druid-io/druid,implydata/druid,fjy/druid,himanshug/druid,se7entyse7en/druid,andy256/druid,b-slim/druid,lcp0578/druid,KurtYoung/druid,qix/druid,winval/druid,pjain1/druid,redBorder/druid,yaochitc/druid-dev,dclim/druid,solimant/druid,redBorder/druid,tubemogul/druid,milimetric/druid,jon-wei/druid,liquidm/druid,metamx/druid,qix/druid,erikdubbelboer/druid,zhihuij/druid,nishantmonu51/druid,himanshug/druid,skyportsystems/druid,monetate/druid,himanshug/druid,kevintvh/druid,knoguchi/druid,deltaprojects/druid,amikey/druid,premc/druid,Deebs21/druid,haoch/druid,potto007/druid-avro,du00cs/druid,yaochitc/druid-dev,taochaoqiang/druid,authbox-lib/druid,knoguchi/druid,potto007/druid-avro,druid-io/druid,mghosh4/druid,michaelschiff/druid,qix/druid,Fokko/druid,mghosh4/druid,se7entyse7en/druid,minewhat/druid,qix/druid,pdeva/druid,lizhanhui/data_druid,nvoron23/druid,jon-wei/druid,dclim/druid,lizhanhui/data_druid,erikdubbelboer/druid,mrijke/druid,winval/druid,nvoron23/druid,calliope7/druid,Fokko/druid,pdeva/druid,pjain1/druid,optimizely/druid,KurtYoung/druid,anupkumardixit/druid,eshen1991/druid,767326791/druid,optimizely/druid,friedhardware/druid,michaelschiff/druid,smartpcr/druid,skyportsystems/druid,zxs/druid,authbox-lib/druid,mrijke/druid,tubemogul/druid,Deebs21/druid,solimant/druid,zhihuij/druid,kevintvh/druid,deltaprojects/druid,knoguchi/druid,dkhwangbo/druid,monetate/druid,pjain1/druid,dclim/druid,zxs/druid,wenjixin/druid,solimant/druid,nvoron23/druid,authbox-lib/druid,zhiqinghuang/druid,pombredanne/druid,mghosh4/druid,jon-wei/druid,potto007/druid-avro,metamx/druid,jon-wei/druid,andy256/druid,praveev/druid,liquidm/druid,lizhanhui/data_druid,du00cs/druid,Kleagleguo/druid,pdeva/druid,smartpcr/druid,monetate/druid,elijah513/druid,leventov/druid,lizhanhui/data_druid,minewhat/druid,Fokko/druid,dkhwangbo/druid,nvoron23/druid,Fokko/druid,winval/druid,monetate/druid,yaochitc/druid-dev,mangeshpardeshiyahoo/druid,lizhanhui/data_druid,skyportsystems/druid,premc/druid,zhiqinghuang/druid,himanshug/druid,skyportsystems/druid,deltaprojects/druid,b-slim/druid,nishantmonu51/druid,zhiqinghuang/druid,wenjixin/druid,erikdubbelboer/druid,lcp0578/druid,lcp0578/druid,pombredanne/druid,b-slim/druid,OttoOps/druid,monetate/druid,wenjixin/druid,du00cs/druid,monetate/druid,du00cs/druid,penuel-leo/druid,implydata/druid,zhaown/druid,druid-io/druid,gianm/druid,tubemogul/druid,himanshug/druid,friedhardware/druid,premc/druid,rasahner/druid,Fokko/druid,elijah513/druid,jon-wei/druid,pdeva/druid,taochaoqiang/druid,fjy/druid,anupkumardixit/druid,pdeva/druid,potto007/druid-avro,zengzhihai110/druid,calliope7/druid,implydata/druid,eshen1991/druid,penuel-leo/druid,mangeshpardeshiyahoo/druid,zhaown/druid,optimizely/druid,friedhardware/druid,mghosh4/druid,eshen1991/druid,amikey/druid,smartpcr/druid,haoch/druid,pjain1/druid,calliope7/druid,minewhat/druid,potto007/druid-avro,Deebs21/druid,eshen1991/druid,zhaown/druid,zhihuij/druid,cocosli/druid,mghosh4/druid,zxs/druid,se7entyse7en/druid,zhiqinghuang/druid,Deebs21/druid,michaelschiff/druid,cocosli/druid,OttoOps/druid,cocosli/druid,optimizely/druid,leventov/druid,amikey/druid,milimetric/druid,dkhwangbo/druid,cocosli/druid,andy256/druid,metamx/druid,eshen1991/druid,b-slim/druid,Deebs21/druid,mghosh4/druid,nishantmonu51/druid,implydata/druid,michaelschiff/druid,767326791/druid,pombredanne/druid,amikey/druid,Kleagleguo/druid,mangeshpardeshiyahoo/druid,zhaown/druid,jon-wei/druid,zengzhihai110/druid,penuel-leo/druid,metamx/druid,Fokko/druid,taochaoqiang/druid,767326791/druid,premc/druid,smartpcr/druid,calliope7/druid,pombredanne/druid,deltaprojects/druid,KurtYoung/druid,nishantmonu51/druid,elijah513/druid,andy256/druid,guobingkun/druid,mrijke/druid,amikey/druid,redBorder/druid,pjain1/druid,nishantmonu51/druid,deltaprojects/druid,zhihuij/druid,pjain1/druid,gianm/druid,OttoOps/druid,pjain1/druid,rasahner/druid,zengzhihai110/druid,liquidm/druid,Kleagleguo/druid,tubemogul/druid,penuel-leo/druid,se7entyse7en/druid,erikdubbelboer/druid,gianm/druid,zengzhihai110/druid,erikdubbelboer/druid,guobingkun/druid,Fokko/druid,tubemogul/druid,rasahner/druid,guobingkun/druid,zhiqinghuang/druid,noddi/druid,wenjixin/druid,gianm/druid,zxs/druid,michaelschiff/druid,andy256/druid,milimetric/druid,KurtYoung/druid,jon-wei/druid,mrijke/druid,optimizely/druid,noddi/druid,zhaown/druid,du00cs/druid,elijah513/druid,taochaoqiang/druid,se7entyse7en/druid,solimant/druid,nishantmonu51/druid | package druid.examples.rabbitmq;
import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import org.apache.commons.cli.*;
import java.text.SimpleDateFormat;
import java.util.*;
/**
*
*/
public class RabbitMQProducerMain
{
public static void main(String[] args)
throws Exception
{
// We use a List to keep track of option insertion order. See below.
final List<Option> optionList = new ArrayList<Option>();
optionList.add(OptionBuilder.withLongOpt("help")
.withDescription("display this help message")
.create("h"));
optionList.add(OptionBuilder.withLongOpt("hostname")
.hasArg()
.withDescription("the hostname of the AMQP broker [defaults to AMQP library default]")
.create("b"));
optionList.add(OptionBuilder.withLongOpt("port")
.hasArg()
.withDescription("the port of the AMQP broker [defaults to AMQP library default]")
.create("n"));
optionList.add(OptionBuilder.withLongOpt("username")
.hasArg()
.withDescription("username to connect to the AMQP broker [defaults to AMQP library default]")
.create("u"));
optionList.add(OptionBuilder.withLongOpt("password")
.hasArg()
.withDescription("password to connect to the AMQP broker [defaults to AMQP library default]")
.create("p"));
optionList.add(OptionBuilder.withLongOpt("vhost")
.hasArg()
.withDescription("name of virtual host on the AMQP broker [defaults to AMQP library default]")
.create("v"));
optionList.add(OptionBuilder.withLongOpt("exchange")
.isRequired()
.hasArg()
.withDescription("name of the AMQP exchange [required - no default]")
.create("e"));
optionList.add(OptionBuilder.withLongOpt("key")
.hasArg()
.withDescription("the routing key to use when sending messages [default: 'default.routing.key']")
.create("k"));
optionList.add(OptionBuilder.withLongOpt("type")
.hasArg()
.withDescription("the type of exchange to create [default: 'topic']")
.create("t"));
optionList.add(OptionBuilder.withLongOpt("durable")
.withDescription("if set, a durable exchange will be declared [default: not set]")
.create("d"));
optionList.add(OptionBuilder.withLongOpt("autodelete")
.withDescription("if set, an auto-delete exchange will be declared [default: not set]")
.create("a"));
optionList.add(OptionBuilder.withLongOpt("single")
.withDescription("if set, only a single message will be sent [default: not set]")
.create("s"));
optionList.add(OptionBuilder.withLongOpt("start")
.hasArg()
.withDescription("time to use to start sending messages from [default: 2010-01-01T00:00:00]")
.create());
optionList.add(OptionBuilder.withLongOpt("stop")
.hasArg()
.withDescription("time to use to send messages until (format: '2013-07-18T23:45:59') [default: current time]")
.create());
optionList.add(OptionBuilder.withLongOpt("interval")
.hasArg()
.withDescription("the interval to add to the timestamp between messages in seconds [default: 10]")
.create());
optionList.add(OptionBuilder.withLongOpt("delay")
.hasArg()
.withDescription("the delay between sending messages in milliseconds [default: 100]")
.create());
// An extremely silly hack to maintain the above order in the help formatting.
HelpFormatter formatter = new HelpFormatter();
// Add a comparator to the HelpFormatter using the ArrayList above to sort by insertion order.
formatter.setOptionComparator(new Comparator(){
@Override
public int compare(Object o1, Object o2)
{
// I know this isn't fast, but who cares! The list is short.
return optionList.indexOf(o1) - optionList.indexOf(o2);
}
});
// Now we can add all the options to an Options instance. This is dumb!
Options options = new Options();
for (Option option : optionList) {
options.addOption(option);
}
CommandLine cmd = null;
try{
cmd = new BasicParser().parse(options, args);
}
catch(ParseException e){
formatter.printHelp("RabbitMQProducerMain", e.getMessage(), options, null);
System.exit(1);
}
if(cmd.hasOption("h")) {
formatter.printHelp("RabbitMQProducerMain", options);
System.exit(2);
}
ConnectionFactory factory = new ConnectionFactory();
if(cmd.hasOption("b")){
factory.setHost(cmd.getOptionValue("b"));
}
if(cmd.hasOption("u")){
factory.setUsername(cmd.getOptionValue("u"));
}
if(cmd.hasOption("p")){
factory.setPassword(cmd.getOptionValue("p"));
}
if(cmd.hasOption("v")){
factory.setVirtualHost(cmd.getOptionValue("v"));
}
if(cmd.hasOption("n")){
factory.setPort(Integer.parseInt(cmd.getOptionValue("n")));
}
String exchange = cmd.getOptionValue("e");
String routingKey = "default.routing.key";
if(cmd.hasOption("k")){
routingKey = cmd.getOptionValue("k");
}
boolean durable = cmd.hasOption("d");
boolean autoDelete = cmd.hasOption("a");
String type = cmd.getOptionValue("t", "topic");
boolean single = cmd.hasOption("single");
int interval = Integer.parseInt(cmd.getOptionValue("interval", "10"));
int delay = Integer.parseInt(cmd.getOptionValue("delay", "100"));
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
Date stop = sdf.parse(cmd.getOptionValue("stop", sdf.format(new Date())));
Random r = new Random();
Calendar timer = Calendar.getInstance();
timer.setTime(sdf.parse(cmd.getOptionValue("start", "2010-01-01T00:00:00")));
String msg_template = "{\"utcdt\": \"%s\", \"wp\": %d, \"gender\": \"%s\", \"age\": %d}";
Connection connection = factory.newConnection();
Channel channel = connection.createChannel();
channel.exchangeDeclare(exchange, type, durable, autoDelete, null);
do{
int wp = (10 + r.nextInt(90)) * 100;
String gender = r.nextBoolean() ? "male" : "female";
int age = 20 + r.nextInt(70);
String line = String.format(msg_template, sdf.format(timer.getTime()), wp, gender, age);
channel.basicPublish(exchange, routingKey, null, line.getBytes());
System.out.println("Sent message: " + line);
timer.add(Calendar.SECOND, interval);
Thread.sleep(delay);
}while((!single && stop.after(timer.getTime())));
connection.close();
}
} | examples/src/main/java/druid/examples/rabbitmq/RabbitMQProducerMain.java | Adding a test producer application.
| examples/src/main/java/druid/examples/rabbitmq/RabbitMQProducerMain.java | Adding a test producer application. | <ide><path>xamples/src/main/java/druid/examples/rabbitmq/RabbitMQProducerMain.java
<add>package druid.examples.rabbitmq;
<add>
<add>import com.rabbitmq.client.Channel;
<add>import com.rabbitmq.client.Connection;
<add>import com.rabbitmq.client.ConnectionFactory;
<add>import org.apache.commons.cli.*;
<add>
<add>import java.text.SimpleDateFormat;
<add>import java.util.*;
<add>
<add>/**
<add> *
<add> */
<add>public class RabbitMQProducerMain
<add>{
<add> public static void main(String[] args)
<add> throws Exception
<add> {
<add> // We use a List to keep track of option insertion order. See below.
<add> final List<Option> optionList = new ArrayList<Option>();
<add>
<add> optionList.add(OptionBuilder.withLongOpt("help")
<add> .withDescription("display this help message")
<add> .create("h"));
<add> optionList.add(OptionBuilder.withLongOpt("hostname")
<add> .hasArg()
<add> .withDescription("the hostname of the AMQP broker [defaults to AMQP library default]")
<add> .create("b"));
<add> optionList.add(OptionBuilder.withLongOpt("port")
<add> .hasArg()
<add> .withDescription("the port of the AMQP broker [defaults to AMQP library default]")
<add> .create("n"));
<add> optionList.add(OptionBuilder.withLongOpt("username")
<add> .hasArg()
<add> .withDescription("username to connect to the AMQP broker [defaults to AMQP library default]")
<add> .create("u"));
<add> optionList.add(OptionBuilder.withLongOpt("password")
<add> .hasArg()
<add> .withDescription("password to connect to the AMQP broker [defaults to AMQP library default]")
<add> .create("p"));
<add> optionList.add(OptionBuilder.withLongOpt("vhost")
<add> .hasArg()
<add> .withDescription("name of virtual host on the AMQP broker [defaults to AMQP library default]")
<add> .create("v"));
<add> optionList.add(OptionBuilder.withLongOpt("exchange")
<add> .isRequired()
<add> .hasArg()
<add> .withDescription("name of the AMQP exchange [required - no default]")
<add> .create("e"));
<add> optionList.add(OptionBuilder.withLongOpt("key")
<add> .hasArg()
<add> .withDescription("the routing key to use when sending messages [default: 'default.routing.key']")
<add> .create("k"));
<add> optionList.add(OptionBuilder.withLongOpt("type")
<add> .hasArg()
<add> .withDescription("the type of exchange to create [default: 'topic']")
<add> .create("t"));
<add> optionList.add(OptionBuilder.withLongOpt("durable")
<add> .withDescription("if set, a durable exchange will be declared [default: not set]")
<add> .create("d"));
<add> optionList.add(OptionBuilder.withLongOpt("autodelete")
<add> .withDescription("if set, an auto-delete exchange will be declared [default: not set]")
<add> .create("a"));
<add> optionList.add(OptionBuilder.withLongOpt("single")
<add> .withDescription("if set, only a single message will be sent [default: not set]")
<add> .create("s"));
<add> optionList.add(OptionBuilder.withLongOpt("start")
<add> .hasArg()
<add> .withDescription("time to use to start sending messages from [default: 2010-01-01T00:00:00]")
<add> .create());
<add> optionList.add(OptionBuilder.withLongOpt("stop")
<add> .hasArg()
<add> .withDescription("time to use to send messages until (format: '2013-07-18T23:45:59') [default: current time]")
<add> .create());
<add> optionList.add(OptionBuilder.withLongOpt("interval")
<add> .hasArg()
<add> .withDescription("the interval to add to the timestamp between messages in seconds [default: 10]")
<add> .create());
<add> optionList.add(OptionBuilder.withLongOpt("delay")
<add> .hasArg()
<add> .withDescription("the delay between sending messages in milliseconds [default: 100]")
<add> .create());
<add>
<add> // An extremely silly hack to maintain the above order in the help formatting.
<add> HelpFormatter formatter = new HelpFormatter();
<add> // Add a comparator to the HelpFormatter using the ArrayList above to sort by insertion order.
<add> formatter.setOptionComparator(new Comparator(){
<add> @Override
<add> public int compare(Object o1, Object o2)
<add> {
<add> // I know this isn't fast, but who cares! The list is short.
<add> return optionList.indexOf(o1) - optionList.indexOf(o2);
<add> }
<add> });
<add>
<add> // Now we can add all the options to an Options instance. This is dumb!
<add> Options options = new Options();
<add> for (Option option : optionList) {
<add> options.addOption(option);
<add> }
<add>
<add> CommandLine cmd = null;
<add>
<add> try{
<add> cmd = new BasicParser().parse(options, args);
<add>
<add> }
<add> catch(ParseException e){
<add> formatter.printHelp("RabbitMQProducerMain", e.getMessage(), options, null);
<add> System.exit(1);
<add> }
<add>
<add> if(cmd.hasOption("h")) {
<add> formatter.printHelp("RabbitMQProducerMain", options);
<add> System.exit(2);
<add> }
<add>
<add> ConnectionFactory factory = new ConnectionFactory();
<add>
<add> if(cmd.hasOption("b")){
<add> factory.setHost(cmd.getOptionValue("b"));
<add> }
<add> if(cmd.hasOption("u")){
<add> factory.setUsername(cmd.getOptionValue("u"));
<add> }
<add> if(cmd.hasOption("p")){
<add> factory.setPassword(cmd.getOptionValue("p"));
<add> }
<add> if(cmd.hasOption("v")){
<add> factory.setVirtualHost(cmd.getOptionValue("v"));
<add> }
<add> if(cmd.hasOption("n")){
<add> factory.setPort(Integer.parseInt(cmd.getOptionValue("n")));
<add> }
<add>
<add> String exchange = cmd.getOptionValue("e");
<add> String routingKey = "default.routing.key";
<add> if(cmd.hasOption("k")){
<add> routingKey = cmd.getOptionValue("k");
<add> }
<add>
<add> boolean durable = cmd.hasOption("d");
<add> boolean autoDelete = cmd.hasOption("a");
<add> String type = cmd.getOptionValue("t", "topic");
<add> boolean single = cmd.hasOption("single");
<add> int interval = Integer.parseInt(cmd.getOptionValue("interval", "10"));
<add> int delay = Integer.parseInt(cmd.getOptionValue("delay", "100"));
<add>
<add> SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss");
<add> Date stop = sdf.parse(cmd.getOptionValue("stop", sdf.format(new Date())));
<add>
<add> Random r = new Random();
<add> Calendar timer = Calendar.getInstance();
<add> timer.setTime(sdf.parse(cmd.getOptionValue("start", "2010-01-01T00:00:00")));
<add>
<add> String msg_template = "{\"utcdt\": \"%s\", \"wp\": %d, \"gender\": \"%s\", \"age\": %d}";
<add>
<add> Connection connection = factory.newConnection();
<add> Channel channel = connection.createChannel();
<add>
<add> channel.exchangeDeclare(exchange, type, durable, autoDelete, null);
<add>
<add> do{
<add> int wp = (10 + r.nextInt(90)) * 100;
<add> String gender = r.nextBoolean() ? "male" : "female";
<add> int age = 20 + r.nextInt(70);
<add>
<add> String line = String.format(msg_template, sdf.format(timer.getTime()), wp, gender, age);
<add>
<add> channel.basicPublish(exchange, routingKey, null, line.getBytes());
<add>
<add> System.out.println("Sent message: " + line);
<add>
<add> timer.add(Calendar.SECOND, interval);
<add>
<add> Thread.sleep(delay);
<add> }while((!single && stop.after(timer.getTime())));
<add>
<add> connection.close();
<add> }
<add>
<add>} |
|
Java | mit | error: pathspec 'src/java/nxt/http/rpc/GetAccountComments.java' did not match any file(s) known to git
| e2ed5f5ec784ff2396f9bd3f94a6f05accf597af | 1 | fimkrypto/nxt,fimkrypto/nxt,fimkrypto/nxt,fimkrypto/nxt | package nxt.http.rpc;
import nxt.Account;
import nxt.MofoQueries;
import nxt.Transaction;
import nxt.db.DbIterator;
import nxt.http.ParameterException;
import nxt.http.websocket.JSONData;
import nxt.http.websocket.RPCCall;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.JSONStreamAware;
public class GetAccountComments extends RPCCall {
public static RPCCall instance = new GetAccountComments("getAccountComments");
static int COUNT = 10;
public GetAccountComments(String identifier) {
super(identifier);
}
@SuppressWarnings("unchecked")
@Override
public JSONStreamAware call(JSONObject arguments) throws ParameterException {
Account account = ParameterParser.getAccount(arguments);
int timestamp = ParameterParser.getTimestamp(arguments);
JSONArray transactions = new JSONArray();
try (
DbIterator<? extends Transaction> iterator = MofoQueries.getAccountComments(account.getId(), timestamp, COUNT);
) {
while (iterator.hasNext()) {
transactions.add(JSONData.transaction(iterator.next(), false));
}
}
JSONObject response = new JSONObject();
response.put("comments", transactions);
return response;
}
}
| src/java/nxt/http/rpc/GetAccountComments.java | Add websocket API GetAccountComments
| src/java/nxt/http/rpc/GetAccountComments.java | Add websocket API GetAccountComments | <ide><path>rc/java/nxt/http/rpc/GetAccountComments.java
<add>package nxt.http.rpc;
<add>
<add>import nxt.Account;
<add>import nxt.MofoQueries;
<add>import nxt.Transaction;
<add>import nxt.db.DbIterator;
<add>import nxt.http.ParameterException;
<add>import nxt.http.websocket.JSONData;
<add>import nxt.http.websocket.RPCCall;
<add>
<add>import org.json.simple.JSONArray;
<add>import org.json.simple.JSONObject;
<add>import org.json.simple.JSONStreamAware;
<add>
<add>public class GetAccountComments extends RPCCall {
<add>
<add> public static RPCCall instance = new GetAccountComments("getAccountComments");
<add> static int COUNT = 10;
<add>
<add> public GetAccountComments(String identifier) {
<add> super(identifier);
<add> }
<add>
<add> @SuppressWarnings("unchecked")
<add> @Override
<add> public JSONStreamAware call(JSONObject arguments) throws ParameterException {
<add> Account account = ParameterParser.getAccount(arguments);
<add> int timestamp = ParameterParser.getTimestamp(arguments);
<add>
<add> JSONArray transactions = new JSONArray();
<add> try (
<add> DbIterator<? extends Transaction> iterator = MofoQueries.getAccountComments(account.getId(), timestamp, COUNT);
<add> ) {
<add> while (iterator.hasNext()) {
<add> transactions.add(JSONData.transaction(iterator.next(), false));
<add> }
<add> }
<add>
<add> JSONObject response = new JSONObject();
<add> response.put("comments", transactions);
<add> return response;
<add> }
<add>
<add>} |
|
Java | agpl-3.0 | 48b62b576cb81e4b655f06511e9418ade6f6479d | 0 | bhutchinson/kfs,quikkian-ua-devops/kfs,smith750/kfs,ua-eas/kfs-devops-automation-fork,ua-eas/kfs-devops-automation-fork,bhutchinson/kfs,ua-eas/kfs-devops-automation-fork,smith750/kfs,kuali/kfs,quikkian-ua-devops/will-financials,kkronenb/kfs,UniversityOfHawaii/kfs,quikkian-ua-devops/kfs,kuali/kfs,UniversityOfHawaii/kfs,quikkian-ua-devops/will-financials,quikkian-ua-devops/will-financials,kuali/kfs,smith750/kfs,UniversityOfHawaii/kfs,bhutchinson/kfs,UniversityOfHawaii/kfs,ua-eas/kfs,quikkian-ua-devops/will-financials,UniversityOfHawaii/kfs,bhutchinson/kfs,kkronenb/kfs,ua-eas/kfs,kuali/kfs,ua-eas/kfs-devops-automation-fork,ua-eas/kfs,kkronenb/kfs,smith750/kfs,quikkian-ua-devops/kfs,kkronenb/kfs,ua-eas/kfs,quikkian-ua-devops/will-financials,quikkian-ua-devops/kfs,kuali/kfs,ua-eas/kfs,quikkian-ua-devops/kfs,ua-eas/kfs-devops-automation-fork,quikkian-ua-devops/kfs,quikkian-ua-devops/will-financials | /*
* Copyright 2008 The Kuali 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/ecl2.php
*
* 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.kuali.kfs.module.ar.batch;
import java.util.Date;
import org.kuali.kfs.module.ar.batch.service.InvoiceRecurrenceService;
import org.kuali.kfs.sys.batch.AbstractStep;
public class InvoiceRecurrenceStep extends AbstractStep {
private InvoiceRecurrenceService invoiceRecurrenceService;
private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(InvoiceRecurrenceStep.class);
@Override
public boolean execute(String jobName, Date jobRunDate) throws InterruptedException {
boolean result = true;
try {
result = invoiceRecurrenceService.processInvoiceRecurrence();
} catch (Exception e) {
LOG.error("problem during invoiceRecurrenceService.processInvoiceRecurrence()", e);
throw new RuntimeException("problem during invoiceRecurrenceService.processInvoiceRecurrence()", e);
}
return result;
}
public void setInvoiceRecurrenceService(InvoiceRecurrenceService irs) {
invoiceRecurrenceService = irs;
}
}
| work/src/org/kuali/kfs/module/ar/batch/InvoiceRecurrenceStep.java | /*
* Copyright 2008 The Kuali 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/ecl2.php
*
* 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.kuali.kfs.module.ar.batch;
import java.util.Date;
import org.kuali.kfs.module.ar.batch.service.InvoiceRecurrenceService;
import org.kuali.kfs.sys.batch.AbstractStep;
public class InvoiceRecurrenceStep extends AbstractStep {
private InvoiceRecurrenceService invoiceRecurrenceService;
private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(InvoiceRecurrenceStep.class);
@Override
public boolean execute(String jobName, Date jobRunDate) throws InterruptedException {
boolean resultInd = true;
try {
resultInd = invoiceRecurrenceService.processInvoiceRecurrence();
} catch (Exception e) {
LOG.error("problem during invoiceRecurrenceService.processInvoiceRecurrence()", e);
throw new RuntimeException("problem during invoiceRecurrenceService.processInvoiceRecurrence()", e);
}
return resultInd;
}
public void setInvoiceRecurrenceService(InvoiceRecurrenceService irs) {
invoiceRecurrenceService = irs;
}
}
| KFSTI-358,revert variable names
| work/src/org/kuali/kfs/module/ar/batch/InvoiceRecurrenceStep.java | KFSTI-358,revert variable names | <ide><path>ork/src/org/kuali/kfs/module/ar/batch/InvoiceRecurrenceStep.java
<ide>
<ide> @Override
<ide> public boolean execute(String jobName, Date jobRunDate) throws InterruptedException {
<del> boolean resultInd = true;
<add> boolean result = true;
<ide> try {
<del> resultInd = invoiceRecurrenceService.processInvoiceRecurrence();
<add> result = invoiceRecurrenceService.processInvoiceRecurrence();
<ide> } catch (Exception e) {
<ide> LOG.error("problem during invoiceRecurrenceService.processInvoiceRecurrence()", e);
<ide> throw new RuntimeException("problem during invoiceRecurrenceService.processInvoiceRecurrence()", e);
<ide> }
<del> return resultInd;
<add> return result;
<ide> }
<ide>
<ide> public void setInvoiceRecurrenceService(InvoiceRecurrenceService irs) { |
|
Java | mit | 6f4441ca9b50fa659c602d2569ec95d0a3bced2f | 0 | SilentChaos512/SilentGems | package net.silentchaos512.gems.guide;
import java.util.List;
import com.google.common.collect.Lists;
import net.minecraft.client.gui.GuiScreen;
import net.minecraft.init.Blocks;
import net.minecraft.init.Items;
import net.minecraft.item.ItemStack;
import net.minecraft.item.crafting.IRecipe;
import net.minecraft.util.ResourceLocation;
import net.minecraftforge.fml.relauncher.Side;
import net.minecraftforge.fml.relauncher.SideOnly;
import net.minecraftforge.oredict.ShapedOreRecipe;
import net.minecraftforge.oredict.ShapelessOreRecipe;
import net.silentchaos512.gems.SilentGems;
import net.silentchaos512.gems.api.ITool;
import net.silentchaos512.gems.api.lib.EnumMaterialTier;
import net.silentchaos512.gems.block.ModBlocks;
import net.silentchaos512.gems.client.gui.config.GuiConfigSilentGems;
import net.silentchaos512.gems.config.GemsConfig;
import net.silentchaos512.gems.guide.page.PageOreSpawn;
import net.silentchaos512.gems.item.ItemCrafting;
import net.silentchaos512.gems.item.ModItems;
import net.silentchaos512.gems.lib.EnumGem;
import net.silentchaos512.gems.util.ArmorHelper;
import net.silentchaos512.gems.util.ToolHelper;
import net.silentchaos512.lib.guidebook.GuideBook;
import net.silentchaos512.lib.guidebook.IGuidePage;
import net.silentchaos512.lib.guidebook.chapter.GuideChapter;
import net.silentchaos512.lib.guidebook.entry.GuideEntry;
import net.silentchaos512.lib.guidebook.page.PageCrafting;
import net.silentchaos512.lib.guidebook.page.PageFurnace;
import net.silentchaos512.lib.guidebook.page.PagePicture;
import net.silentchaos512.lib.guidebook.page.PageTextOnly;
import net.silentchaos512.lib.util.StackHelper;
public class GuideBookGems extends GuideBook {
public static final String TOOL_OWNER_NAME = "Guide Book";
private GuideEntry entryGettingStarted;
private GuideEntry entryBlocks;
private GuideEntry entryItems;
private GuideEntry entryTools;
private GuideEntry entryRecipes;
public GuideBookGems() {
super(SilentGems.MODID);
this.resourceGui = new ResourceLocation(SilentGems.MODID, "textures/guide/gui_guide.png");
this.resourceGadgets = new ResourceLocation(SilentGems.MODID,
"textures/guide/gui_guide_gadgets.png");
edition = SilentGems.BUILD_NUM;
}
@Override
public void initEntries() {
entryGettingStarted = new GuideEntry(this, "gettingStarted").setImportant();
entryBlocks = new GuideEntry(this, "blocks");
entryItems = new GuideEntry(this, "items");
entryTools = new GuideEntry(this, "tools");
entryRecipes = new GuideEntry(this, "recipes");
}
@SuppressWarnings("unused")
@Override
public void initChapters() {
//@formatter:off
// Getting Started
// Introduction
new GuideChapter(this, "introduction", entryGettingStarted, new ItemStack(ModItems.gem, 1, SilentGems.random.nextInt(32)), 1000,
new PageTextOnly(this, 1),
new PageTextOnly(this, 2),
new PageTextOnly(this, 3)).setSpecial();
// Progression
ItemStack flintPickaxe = ModItems.pickaxe.constructTool(false, new ItemStack(Items.FLINT));
ToolHelper.setOriginalOwner(flintPickaxe, TOOL_OWNER_NAME);
ItemStack flintPickaxeBroken = StackHelper.safeCopy(flintPickaxe);
flintPickaxeBroken.setItemDamage(ToolHelper.getMaxDamage(flintPickaxeBroken));
ItemStack ironTipUpgrade = new ItemStack(ModItems.tipUpgrade);
ItemStack flintPickaxeIronTips = ModItems.tipUpgrade.applyToTool(flintPickaxe, ironTipUpgrade);
ItemStack gravel = new ItemStack(Blocks.GRAVEL);
ItemStack gemPickaxe = ModItems.pickaxe.constructTool(new ItemStack(Items.STICK), EnumGem.RUBY.getItem(), EnumGem.SAPPHIRE.getItem(), EnumGem.RUBY.getItem());
ToolHelper.setOriginalOwner(gemPickaxe, TOOL_OWNER_NAME);
ItemStack diamondTipUpgrade = new ItemStack(ModItems.tipUpgrade, 1, 2);
ItemStack gemPickaxeDiamondTips = ModItems.tipUpgrade.applyToTool(gemPickaxe, diamondTipUpgrade);
ItemStack katana = ModItems.katana.constructTool(true, EnumGem.LEPIDOLITE.getItemSuper(), EnumGem.OPAL.getItemSuper(), EnumGem.BLACK_DIAMOND.getItemSuper());
ToolHelper.setOriginalOwner(katana, TOOL_OWNER_NAME);
new GuideChapter(this, "progression", entryGettingStarted, flintPickaxeIronTips, 100,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapelessOreRecipe(new ItemStack(Items.FLINT), gravel, gravel)),
new PageCrafting(this, 3, new ShapedOreRecipe(flintPickaxe, "fff", " s ", " s ", 'f', Items.FLINT, 's', "stickWood")),
new PageTextOnly(this, 4),
new PageCrafting(this, 5, new ShapelessOreRecipe(flintPickaxe, flintPickaxeBroken, Items.FLINT, Items.FLINT)),
new PageTextOnly(this, 6),
new PageCrafting(this, 7, new ShapelessOreRecipe(flintPickaxeIronTips, flintPickaxe, ironTipUpgrade)),
new PageCrafting(this, 8, new ShapedOreRecipe(gemPickaxe, "rsr", " t ", " t ", 'r', EnumGem.RUBY.getItem(), 's',
EnumGem.SAPPHIRE.getItem(), 't', "stickWood")),
new PageTextOnly(this, 9),
new PageCrafting(this, 10, new ShapelessOreRecipe(gemPickaxeDiamondTips, gemPickaxe, diamondTipUpgrade)),
new PageTextOnly(this, 11),
new PageCrafting(this, 12, new ShapedOreRecipe(katana, "lo", "d ", "r ", 'l', EnumGem.LEPIDOLITE.getItemSuper(), 'o',
EnumGem.OPAL.getItemSuper(), 'd', EnumGem.BLACK_DIAMOND.getItemSuper(), 'r', ModItems.craftingMaterial.toolRodGold)),
new PageTextOnly(this, 13)).setImportant();
// Tools, Armor, and Parts
// Parts
// List<IGuidePage> pagesParts = Lists.newArrayList();
// pagesParts.add(new PageTextOnly(this, 1));
// for (ToolPart part : ToolPartRegistry.getMains()) {
// pagesParts.add(new PageToolPart(this, 0, part));
// }
// new GuideChapter(this, "toolParts", entryTools, EnumGem.getRandom().getItem(), 100,
// pagesParts.toArray(new IGuidePage[pagesParts.size()]));
// Axes
ItemStack toolsEntryRod = SilentGems.random.nextFloat() < 0.67f ? ModItems.craftingMaterial.toolRodGold : ModItems.craftingMaterial.toolRodSilver;
ItemStack chAxeGem = EnumGem.getRandom().getItemSuper();
ItemStack chAxe = makeTool(ModItems.axe, toolsEntryRod, chAxeGem, 3);
new GuideChapter(this, "axe", entryTools, chAxe,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chAxe, "gg", "gr", " r", 'g', chAxeGem, 'r', toolsEntryRod)).setNoText());
// Bows
ItemStack chBowGem = EnumGem.getRandom().getItemSuper();
ItemStack chBow = makeTool(ModItems.bow, toolsEntryRod, chBowGem, 3);
new GuideChapter(this, "bow", entryTools, chBow,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chBow, "rgs", "g s", "rgs", 'g', chBowGem, 'r', toolsEntryRod, 's', ModItems.craftingMaterial.gildedString)));
// Daggers
ItemStack chDaggerGem = EnumGem.getRandom().getItemSuper();
ItemStack chDagger = makeTool(ModItems.dagger, toolsEntryRod, chDaggerGem, 1);
new GuideChapter(this, "dagger", entryTools, chDagger,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chDagger, "g", "r", "f", 'g', chDaggerGem, 'r', toolsEntryRod, 'f', "ingotGold")));
// Hoes
ItemStack chHoeGem = EnumGem.getRandom().getItemSuper();
ItemStack chHoe = makeTool(ModItems.hoe, toolsEntryRod, chHoeGem, 2);
new GuideChapter(this, "hoe", entryTools, chHoe,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chHoe, "gg", " r", " r", 'g', chHoeGem, 'r', toolsEntryRod)).setNoText());
// Katana
ItemStack chKatanaGem = EnumGem.getRandom().getItemSuper();
ItemStack chKatana = makeTool(ModItems.katana, toolsEntryRod, chKatanaGem, 3);
new GuideChapter(this, "katana", entryTools, chKatana,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chKatana, "gg", "g ", "r ", 'g', chKatanaGem, 'r', toolsEntryRod)).setNoText());
// Paxels
ItemStack chPaxelGem = EnumGem.getRandom().getItemSuper();
ItemStack chPaxel = makeTool(ModItems.paxel, toolsEntryRod, chPaxelGem, 6);
new GuideChapter(this, "paxel", entryTools, chPaxel,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chPaxel, "ggg", "grg", "gr ", 'g', chPaxelGem, 'r', toolsEntryRod)).setNoText());
// Pickaxes
ItemStack chPickaxeGem = EnumGem.getRandom().getItemSuper();
ItemStack chPickaxe = makeTool(ModItems.pickaxe, toolsEntryRod, chPickaxeGem, 3);
new GuideChapter(this, "pickaxe", entryTools, chPickaxe,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chPickaxe, "ggg", " r ", " r ", 'g', chPickaxeGem, 'r', toolsEntryRod)).setNoText());
// Scepters
ItemStack chScepterGem = EnumGem.getRandom().getItemSuper();
ItemStack chScepter = makeTool(ModItems.scepter, toolsEntryRod, chScepterGem, 5);
new GuideChapter(this, "scepter", entryTools, chScepter,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chScepter, " g ", "grg", "grg", 'g', chScepterGem, 'r', toolsEntryRod)).setNoText(),
new PageTextOnly(this, 3));
ItemStack chShieldGem = EnumGem.getRandom().getItemSuper();
ItemStack chShield = makeTool(ModItems.shield, toolsEntryRod, chShieldGem, 3);
new GuideChapter(this, "shield", entryTools, chShield,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chShield, "gwg", "wrw", " g ", 'g', chShieldGem, 'r', toolsEntryRod, 'w', "plankWood")).setNoText());
// Shovels
ItemStack chShovelGem = EnumGem.getRandom().getItemSuper();
ItemStack chShovel = makeTool(ModItems.shovel, toolsEntryRod, chShovelGem, 1);
new GuideChapter(this, "shovel", entryTools, chShovel,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chShovel, "g", "r", "r", 'g', chShovelGem, 'r', toolsEntryRod)).setNoText());
// Sickles
ItemStack chSickleGem = EnumGem.getRandom().getItemSuper();
ItemStack chSickle = makeTool(ModItems.sickle, toolsEntryRod, chSickleGem, 3);
new GuideChapter(this, "sickle", entryTools, chSickle,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chSickle, " g", "gg", "r ", 'g', chSickleGem, 'r', toolsEntryRod)).setNoText());
// Swords
ItemStack chSwordGem = EnumGem.getRandom().getItemSuper();
ItemStack chSword = makeTool(ModItems.sword, toolsEntryRod, chSwordGem, 2);
new GuideChapter(this, "sword", entryTools, chSword,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chSword, "g", "g", "r", 'g', chSwordGem, 'r', toolsEntryRod)).setNoText());
// Tomahawks
ItemStack chTomahawkGem = EnumGem.getRandom().getItemSuper();
ItemStack chTomahawk = makeTool(ModItems.tomahawk, toolsEntryRod, chTomahawkGem, 4);
new GuideChapter(this, "tomahawk", entryTools, chTomahawk,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chTomahawk, "ggg", "gr ", " r ", 'g', chTomahawkGem, 'r', toolsEntryRod)).setNoText());
// Armor
ItemStack chHelmetGem = EnumGem.getRandom().getItemSuper();
ItemStack chHelmet = ModItems.gemHelmet.constructArmor(chHelmetGem, chHelmetGem, chHelmetGem, chHelmetGem);
ItemStack chHelmetFrame = ModItems.armorFrame.getFrameForArmorPiece(ModItems.gemHelmet, EnumMaterialTier.SUPER);
ArmorHelper.setOriginalOwner(chHelmet, TOOL_OWNER_NAME);
new GuideChapter(this, "armor", entryTools, chHelmet, -10,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, ModItems.craftingMaterial.recipeLatticeMundane).setNoText(),
new PageCrafting(this, 3, ModItems.craftingMaterial.recipeLatticeRegular).setNoText(),
new PageCrafting(this, 4, ModItems.craftingMaterial.recipeLatticeSuper).setNoText(),
new PageCrafting(this, 5, new ShapedOreRecipe(chHelmetFrame, "lll", "l l", 'l', ModItems.craftingMaterial.armorLatticeSuper)),
new PageCrafting(this, 6, new ShapedOreRecipe(chHelmet, " g ", "gfg", " g ", 'g', chHelmetGem, 'f', chHelmetFrame)));
// Blocks
// Ores
new GuideChapter(this, "ores", entryBlocks, new ItemStack(ModBlocks.gemOre, 1, SilentGems.random.nextInt(16)), 10,
new PageTextOnly(this, 1),
new PageOreSpawn(this, 2, GemsConfig.WORLD_GEN_GEMS),
new PageOreSpawn(this, 3, GemsConfig.WORLD_GEN_GEMS_DARK),
new PageOreSpawn(this, 4, GemsConfig.WORLD_GEN_CHAOS),
new PageFurnace(this, 5, ModItems.craftingMaterial.chaosEssence),
new PageOreSpawn(this, 6, GemsConfig.WORLD_GEN_ENDER),
new PageFurnace(this, 7, ModItems.craftingMaterial.enderEssence)).setImportant();
// Chaos Altar
new GuideChapter(this, "chaosAltar", entryBlocks, new ItemStack(ModBlocks.chaosAltar),
new PageCrafting(this, 1, ModBlocks.chaosAltar.recipe),
new PageTextOnly(this, 2),
new PageTextOnly(this, 3),
new PageTextOnly(this, 4));
// Chaos Flower Pot
new GuideChapter(this, "chaosFlowerPot", entryBlocks, new ItemStack(ModBlocks.chaosFlowerPot),
new PageCrafting(this, 1, ModBlocks.chaosFlowerPot.recipe),
new PageTextOnly(this, 2));
// Chaos Node
new GuideChapter(this, "chaosNode", entryBlocks, new ItemStack(ModBlocks.chaosNode),
new PagePicture(this, 1, new ResourceLocation(SilentGems.MODID, "textures/guide/chaosnode.png"), 125),
new PageTextOnly(this, 2));
// Fluffy Blocks
new GuideChapter(this, "fluffyBlocks", entryBlocks, new ItemStack(ModBlocks.fluffyBlock),
new PageCrafting(this, 1, new ShapedOreRecipe(new ItemStack(ModBlocks.fluffyBlock), "ff", "ff", 'f', ModItems.craftingMaterial.fluffyFabric)),
new PageTextOnly(this, 2));
// Glow Rose
new GuideChapter(this, "glowRose", entryBlocks, new ItemStack(ModBlocks.glowRose),
new PageTextOnly(this, 1));
// Material Grader
new GuideChapter(this, "materialGrader", entryBlocks, new ItemStack(ModBlocks.materialGrader),
new PageTextOnly(this, 1));
// Decorative Gem Blocks
new GuideChapter(this, "gemDecoBlocks", entryBlocks, new ItemStack(ModBlocks.gemBrickCoated, 1, SilentGems.random.nextInt(16)), -10,
new PageTextOnly(this, 1));
// Items
// Crafting Materials
List<IGuidePage> pages = Lists.newArrayList();
pages.add(new PageTextOnly(this, 1));
for (String str : ItemCrafting.SORTED_NAMES) {
ItemStack stack = ModItems.craftingMaterial.getStack(str);
IRecipe recipe = ModItems.craftingMaterial.guideRecipeMap.get(stack.getItemDamage());
if (recipe != null)
pages.add(new PageCrafting(this, 100 + stack.getItemDamage(), recipe));
else
pages.add(new PageTextOnly(this, 100 + stack.getItemDamage()));
}
new GuideChapter(this, "craftingMaterial", entryItems, ModItems.craftingMaterial.chaosEssence,
pages.toArray(new IGuidePage[pages.size()]));
// Fluffy Puffs
new GuideChapter(this, "fluffyPuff", entryItems, new ItemStack(ModItems.fluffyPuff),
new PageTextOnly(this, 1));
// Gems
EnumGem chGem = EnumGem.getRandom();
ItemStack craftedShards = StackHelper.setCount(StackHelper.safeCopy(chGem.getShard()), 9);
new GuideChapter(this, "gem", entryItems, chGem.getItem(),
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapelessOreRecipe(craftedShards, chGem.getItem())),
new PageCrafting(this, 3, new ShapedOreRecipe(chGem.getItemSuper(), "cgc", "cdc", "cgc", 'c', ModItems.craftingMaterial.chaosEssence, 'g', chGem.getItem(), 'd', "dustGlowstone")));
// @formatter:on
}
public static final String[] QUOTES = { //@formatter:off
"The flowers probably won't kill you.",
"Try the donuts!",
"May contain unintended &cR&6a&ei&an&9b&do&5w&0s!".replaceAll("&", "\u00a7"),
"Shake well and refrigerate after opening.",
"Drowning in [slightly fewer] JSON files...",
"Download only from CurseForge!",
"Rabbit poop coffee!",
"Now works on Minecraft 1.10.2! Because other modders are SOOO slow to update...",
"It stares into your soul.",
"Pot now included... flower pot, that is.",
"Did you know Chaos Gems are finally back?",
"Also try Extra Parts!",
"Your wish has been granted!",
};//@formatter:on
@Override
public String[] getQuotes() {
return QUOTES;
}
@SideOnly(Side.CLIENT)
@Override
public GuiScreen getConfigScreen(GuiScreen parent) {
return new GuiConfigSilentGems(parent);
}
@SideOnly(Side.CLIENT)
@Override
public GuiScreen getAchievementScreen(GuiScreen parent) {
// TODO Auto-generated method stub
return null;
}
private ItemStack makeTool(ITool tool, ItemStack rod, ItemStack gem, int gemCount) {
ItemStack[] array = new ItemStack[gemCount];
for (int i = 0; i < array.length; ++i)
array[i] = gem;
ItemStack ret = tool.constructTool(rod, array);
ToolHelper.setOriginalOwner(ret, TOOL_OWNER_NAME);
return ret;
}
}
| common/net/silentchaos512/gems/guide/GuideBookGems.java | package net.silentchaos512.gems.guide;
import java.util.List;
import com.google.common.collect.Lists;
import net.minecraft.client.gui.GuiScreen;
import net.minecraft.init.Blocks;
import net.minecraft.init.Items;
import net.minecraft.item.ItemStack;
import net.minecraft.item.crafting.CraftingManager;
import net.minecraft.item.crafting.IRecipe;
import net.minecraft.util.ResourceLocation;
import net.minecraftforge.oredict.ShapedOreRecipe;
import net.minecraftforge.oredict.ShapelessOreRecipe;
import net.silentchaos512.gems.SilentGems;
import net.silentchaos512.gems.api.ITool;
import net.silentchaos512.gems.api.lib.EnumMaterialTier;
import net.silentchaos512.gems.block.ModBlocks;
import net.silentchaos512.gems.client.gui.config.GuiConfigSilentGems;
import net.silentchaos512.gems.config.GemsConfig;
import net.silentchaos512.gems.guide.page.PageOreSpawn;
import net.silentchaos512.gems.item.ItemCrafting;
import net.silentchaos512.gems.item.ModItems;
import net.silentchaos512.gems.lib.EnumGem;
import net.silentchaos512.gems.util.ArmorHelper;
import net.silentchaos512.gems.util.ToolHelper;
import net.silentchaos512.lib.guidebook.GuideBook;
import net.silentchaos512.lib.guidebook.IGuidePage;
import net.silentchaos512.lib.guidebook.chapter.GuideChapter;
import net.silentchaos512.lib.guidebook.entry.GuideEntry;
import net.silentchaos512.lib.guidebook.page.PageCrafting;
import net.silentchaos512.lib.guidebook.page.PageFurnace;
import net.silentchaos512.lib.guidebook.page.PagePicture;
import net.silentchaos512.lib.guidebook.page.PageTextOnly;
import net.silentchaos512.lib.util.StackHelper;
public class GuideBookGems extends GuideBook {
public static final String TOOL_OWNER_NAME = "Guide Book";
private GuideEntry entryGettingStarted;
private GuideEntry entryBlocks;
private GuideEntry entryItems;
private GuideEntry entryTools;
private GuideEntry entryRecipes;
public GuideBookGems() {
super(SilentGems.MODID);
this.resourceGui = new ResourceLocation(SilentGems.MODID, "textures/guide/gui_guide.png");
this.resourceGadgets = new ResourceLocation(SilentGems.MODID,
"textures/guide/gui_guide_gadgets.png");
edition = SilentGems.BUILD_NUM;
}
@Override
public void initEntries() {
entryGettingStarted = new GuideEntry(this, "gettingStarted").setImportant();
entryBlocks = new GuideEntry(this, "blocks");
entryItems = new GuideEntry(this, "items");
entryTools = new GuideEntry(this, "tools");
entryRecipes = new GuideEntry(this, "recipes");
}
@SuppressWarnings("unused")
@Override
public void initChapters() {
//@formatter:off
// Getting Started
// Introduction
new GuideChapter(this, "introduction", entryGettingStarted, new ItemStack(ModItems.gem, 1, SilentGems.random.nextInt(32)), 1000,
new PageTextOnly(this, 1),
new PageTextOnly(this, 2),
new PageTextOnly(this, 3)).setSpecial();
// Progression
ItemStack flintPickaxe = ModItems.pickaxe.constructTool(false, new ItemStack(Items.FLINT));
ToolHelper.setOriginalOwner(flintPickaxe, TOOL_OWNER_NAME);
ItemStack flintPickaxeBroken = StackHelper.safeCopy(flintPickaxe);
flintPickaxeBroken.setItemDamage(ToolHelper.getMaxDamage(flintPickaxeBroken));
ItemStack ironTipUpgrade = new ItemStack(ModItems.tipUpgrade);
ItemStack flintPickaxeIronTips = ModItems.tipUpgrade.applyToTool(flintPickaxe, ironTipUpgrade);
ItemStack gravel = new ItemStack(Blocks.GRAVEL);
ItemStack gemPickaxe = ModItems.pickaxe.constructTool(new ItemStack(Items.STICK), EnumGem.RUBY.getItem(), EnumGem.SAPPHIRE.getItem(), EnumGem.RUBY.getItem());
ToolHelper.setOriginalOwner(gemPickaxe, TOOL_OWNER_NAME);
ItemStack diamondTipUpgrade = new ItemStack(ModItems.tipUpgrade, 1, 2);
ItemStack gemPickaxeDiamondTips = ModItems.tipUpgrade.applyToTool(gemPickaxe, diamondTipUpgrade);
ItemStack katana = ModItems.katana.constructTool(true, EnumGem.LEPIDOLITE.getItemSuper(), EnumGem.OPAL.getItemSuper(), EnumGem.BLACK_DIAMOND.getItemSuper());
ToolHelper.setOriginalOwner(katana, TOOL_OWNER_NAME);
new GuideChapter(this, "progression", entryGettingStarted, flintPickaxeIronTips, 100,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapelessOreRecipe(new ItemStack(Items.FLINT), gravel, gravel)),
new PageCrafting(this, 3, new ShapedOreRecipe(flintPickaxe, "fff", " s ", " s ", 'f', Items.FLINT, 's', "stickWood")),
new PageTextOnly(this, 4),
new PageCrafting(this, 5, new ShapelessOreRecipe(flintPickaxe, flintPickaxeBroken, Items.FLINT, Items.FLINT)),
new PageTextOnly(this, 6),
new PageCrafting(this, 7, new ShapelessOreRecipe(flintPickaxeIronTips, flintPickaxe, ironTipUpgrade)),
new PageCrafting(this, 8, new ShapedOreRecipe(gemPickaxe, "rsr", " t ", " t ", 'r', EnumGem.RUBY.getItem(), 's',
EnumGem.SAPPHIRE.getItem(), 't', "stickWood")),
new PageTextOnly(this, 9),
new PageCrafting(this, 10, new ShapelessOreRecipe(gemPickaxeDiamondTips, gemPickaxe, diamondTipUpgrade)),
new PageTextOnly(this, 11),
new PageCrafting(this, 12, new ShapedOreRecipe(katana, "lo", "d ", "r ", 'l', EnumGem.LEPIDOLITE.getItemSuper(), 'o',
EnumGem.OPAL.getItemSuper(), 'd', EnumGem.BLACK_DIAMOND.getItemSuper(), 'r', ModItems.craftingMaterial.toolRodGold)),
new PageTextOnly(this, 13)).setImportant();
// Tools, Armor, and Parts
// Parts
// List<IGuidePage> pagesParts = Lists.newArrayList();
// pagesParts.add(new PageTextOnly(this, 1));
// for (ToolPart part : ToolPartRegistry.getMains()) {
// pagesParts.add(new PageToolPart(this, 0, part));
// }
// new GuideChapter(this, "toolParts", entryTools, EnumGem.getRandom().getItem(), 100,
// pagesParts.toArray(new IGuidePage[pagesParts.size()]));
// Axes
ItemStack toolsEntryRod = SilentGems.random.nextFloat() < 0.67f ? ModItems.craftingMaterial.toolRodGold : ModItems.craftingMaterial.toolRodSilver;
ItemStack chAxeGem = EnumGem.getRandom().getItemSuper();
ItemStack chAxe = makeTool(ModItems.axe, toolsEntryRod, chAxeGem, 3);
new GuideChapter(this, "axe", entryTools, chAxe,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chAxe, "gg", "gr", " r", 'g', chAxeGem, 'r', toolsEntryRod)).setNoText());
// Bows
ItemStack chBowGem = EnumGem.getRandom().getItemSuper();
ItemStack chBow = makeTool(ModItems.bow, toolsEntryRod, chBowGem, 3);
new GuideChapter(this, "bow", entryTools, chBow,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chBow, "rgs", "g s", "rgs", 'g', chBowGem, 'r', toolsEntryRod, 's', ModItems.craftingMaterial.gildedString)));
// Daggers
ItemStack chDaggerGem = EnumGem.getRandom().getItemSuper();
ItemStack chDagger = makeTool(ModItems.dagger, toolsEntryRod, chDaggerGem, 1);
new GuideChapter(this, "dagger", entryTools, chDagger,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chDagger, "g", "r", "f", 'g', chDaggerGem, 'r', toolsEntryRod, 'f', "ingotGold")));
// Hoes
ItemStack chHoeGem = EnumGem.getRandom().getItemSuper();
ItemStack chHoe = makeTool(ModItems.hoe, toolsEntryRod, chHoeGem, 2);
new GuideChapter(this, "hoe", entryTools, chHoe,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chHoe, "gg", " r", " r", 'g', chHoeGem, 'r', toolsEntryRod)).setNoText());
// Katana
ItemStack chKatanaGem = EnumGem.getRandom().getItemSuper();
ItemStack chKatana = makeTool(ModItems.katana, toolsEntryRod, chKatanaGem, 3);
new GuideChapter(this, "katana", entryTools, chKatana,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chKatana, "gg", "g ", "r ", 'g', chKatanaGem, 'r', toolsEntryRod)).setNoText());
// Paxels
ItemStack chPaxelGem = EnumGem.getRandom().getItemSuper();
ItemStack chPaxel = makeTool(ModItems.paxel, toolsEntryRod, chPaxelGem, 6);
new GuideChapter(this, "paxel", entryTools, chPaxel,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chPaxel, "ggg", "grg", "gr ", 'g', chPaxelGem, 'r', toolsEntryRod)).setNoText());
// Pickaxes
ItemStack chPickaxeGem = EnumGem.getRandom().getItemSuper();
ItemStack chPickaxe = makeTool(ModItems.pickaxe, toolsEntryRod, chPickaxeGem, 3);
new GuideChapter(this, "pickaxe", entryTools, chPickaxe,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chPickaxe, "ggg", " r ", " r ", 'g', chPickaxeGem, 'r', toolsEntryRod)).setNoText());
// Scepters
ItemStack chScepterGem = EnumGem.getRandom().getItemSuper();
ItemStack chScepter = makeTool(ModItems.scepter, toolsEntryRod, chScepterGem, 5);
new GuideChapter(this, "scepter", entryTools, chScepter,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chScepter, " g ", "grg", "grg", 'g', chScepterGem, 'r', toolsEntryRod)).setNoText(),
new PageTextOnly(this, 3));
ItemStack chShieldGem = EnumGem.getRandom().getItemSuper();
ItemStack chShield = makeTool(ModItems.shield, toolsEntryRod, chShieldGem, 3);
new GuideChapter(this, "shield", entryTools, chShield,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chShield, "gwg", "wrw", " g ", 'g', chShieldGem, 'r', toolsEntryRod, 'w', "plankWood")).setNoText());
// Shovels
ItemStack chShovelGem = EnumGem.getRandom().getItemSuper();
ItemStack chShovel = makeTool(ModItems.shovel, toolsEntryRod, chShovelGem, 1);
new GuideChapter(this, "shovel", entryTools, chShovel,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chShovel, "g", "r", "r", 'g', chShovelGem, 'r', toolsEntryRod)).setNoText());
// Sickles
ItemStack chSickleGem = EnumGem.getRandom().getItemSuper();
ItemStack chSickle = makeTool(ModItems.sickle, toolsEntryRod, chSickleGem, 3);
new GuideChapter(this, "sickle", entryTools, chSickle,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chSickle, " g", "gg", "r ", 'g', chSickleGem, 'r', toolsEntryRod)).setNoText());
// Swords
ItemStack chSwordGem = EnumGem.getRandom().getItemSuper();
ItemStack chSword = makeTool(ModItems.sword, toolsEntryRod, chSwordGem, 2);
new GuideChapter(this, "sword", entryTools, chSword,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chSword, "g", "g", "r", 'g', chSwordGem, 'r', toolsEntryRod)).setNoText());
// Tomahawks
ItemStack chTomahawkGem = EnumGem.getRandom().getItemSuper();
ItemStack chTomahawk = makeTool(ModItems.tomahawk, toolsEntryRod, chTomahawkGem, 4);
new GuideChapter(this, "tomahawk", entryTools, chTomahawk,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapedOreRecipe(chTomahawk, "ggg", "gr ", " r ", 'g', chTomahawkGem, 'r', toolsEntryRod)).setNoText());
// Armor
ItemStack chHelmetGem = EnumGem.getRandom().getItemSuper();
ItemStack chHelmet = ModItems.gemHelmet.constructArmor(chHelmetGem, chHelmetGem, chHelmetGem, chHelmetGem);
ItemStack chHelmetFrame = ModItems.armorFrame.getFrameForArmorPiece(ModItems.gemHelmet, EnumMaterialTier.SUPER);
ArmorHelper.setOriginalOwner(chHelmet, TOOL_OWNER_NAME);
new GuideChapter(this, "armor", entryTools, chHelmet, -10,
new PageTextOnly(this, 1),
new PageCrafting(this, 2, ModItems.craftingMaterial.recipeLatticeMundane).setNoText(),
new PageCrafting(this, 3, ModItems.craftingMaterial.recipeLatticeRegular).setNoText(),
new PageCrafting(this, 4, ModItems.craftingMaterial.recipeLatticeSuper).setNoText(),
new PageCrafting(this, 5, new ShapedOreRecipe(chHelmetFrame, "lll", "l l", 'l', ModItems.craftingMaterial.armorLatticeSuper)),
new PageCrafting(this, 6, new ShapedOreRecipe(chHelmet, " g ", "gfg", " g ", 'g', chHelmetGem, 'f', chHelmetFrame)));
// Blocks
// Ores
new GuideChapter(this, "ores", entryBlocks, new ItemStack(ModBlocks.gemOre, 1, SilentGems.random.nextInt(16)), 10,
new PageTextOnly(this, 1),
new PageOreSpawn(this, 2, GemsConfig.WORLD_GEN_GEMS),
new PageOreSpawn(this, 3, GemsConfig.WORLD_GEN_GEMS_DARK),
new PageOreSpawn(this, 4, GemsConfig.WORLD_GEN_CHAOS),
new PageFurnace(this, 5, ModItems.craftingMaterial.chaosEssence),
new PageOreSpawn(this, 6, GemsConfig.WORLD_GEN_ENDER),
new PageFurnace(this, 7, ModItems.craftingMaterial.enderEssence)).setImportant();
// Chaos Altar
new GuideChapter(this, "chaosAltar", entryBlocks, new ItemStack(ModBlocks.chaosAltar),
new PageCrafting(this, 1, ModBlocks.chaosAltar.recipe),
new PageTextOnly(this, 2),
new PageTextOnly(this, 3),
new PageTextOnly(this, 4));
// Chaos Flower Pot
new GuideChapter(this, "chaosFlowerPot", entryBlocks, new ItemStack(ModBlocks.chaosFlowerPot),
new PageCrafting(this, 1, ModBlocks.chaosFlowerPot.recipe),
new PageTextOnly(this, 2));
// Chaos Node
new GuideChapter(this, "chaosNode", entryBlocks, new ItemStack(ModBlocks.chaosNode),
new PagePicture(this, 1, new ResourceLocation(SilentGems.MODID, "textures/guide/chaosnode.png"), 125),
new PageTextOnly(this, 2));
// Fluffy Blocks
new GuideChapter(this, "fluffyBlocks", entryBlocks, new ItemStack(ModBlocks.fluffyBlock),
new PageCrafting(this, 1, new ShapedOreRecipe(new ItemStack(ModBlocks.fluffyBlock), "ff", "ff", 'f', ModItems.craftingMaterial.fluffyFabric)),
new PageTextOnly(this, 2));
// Glow Rose
new GuideChapter(this, "glowRose", entryBlocks, new ItemStack(ModBlocks.glowRose),
new PageTextOnly(this, 1));
// Material Grader
new GuideChapter(this, "materialGrader", entryBlocks, new ItemStack(ModBlocks.materialGrader),
new PageTextOnly(this, 1));
// Decorative Gem Blocks
new GuideChapter(this, "gemDecoBlocks", entryBlocks, new ItemStack(ModBlocks.gemBrickCoated, 1, SilentGems.random.nextInt(16)), -10,
new PageTextOnly(this, 1));
// Items
// Crafting Materials
List<IGuidePage> pages = Lists.newArrayList();
pages.add(new PageTextOnly(this, 1));
for (String str : ItemCrafting.SORTED_NAMES) {
ItemStack stack = ModItems.craftingMaterial.getStack(str);
IRecipe recipe = ModItems.craftingMaterial.guideRecipeMap.get(stack.getItemDamage());
if (recipe != null)
pages.add(new PageCrafting(this, 100 + stack.getItemDamage(), recipe));
else
pages.add(new PageTextOnly(this, 100 + stack.getItemDamage()));
}
new GuideChapter(this, "craftingMaterial", entryItems, ModItems.craftingMaterial.chaosEssence,
pages.toArray(new IGuidePage[pages.size()]));
// Fluffy Puffs
new GuideChapter(this, "fluffyPuff", entryItems, new ItemStack(ModItems.fluffyPuff),
new PageTextOnly(this, 1));
// Gems
EnumGem chGem = EnumGem.getRandom();
ItemStack craftedShards = StackHelper.setCount(StackHelper.safeCopy(chGem.getShard()), 9);
new GuideChapter(this, "gem", entryItems, chGem.getItem(),
new PageTextOnly(this, 1),
new PageCrafting(this, 2, new ShapelessOreRecipe(craftedShards, chGem.getItem())),
new PageCrafting(this, 3, new ShapedOreRecipe(chGem.getItemSuper(), "cgc", "cdc", "cgc", 'c', ModItems.craftingMaterial.chaosEssence, 'g', chGem.getItem(), 'd', "dustGlowstone")));
// @formatter:on
}
public static final String[] QUOTES = { //@formatter:off
"The flowers probably won't kill you.",
"Try the donuts!",
"May contain unintended &cR&6a&ei&an&9b&do&5w&0s!".replaceAll("&", "\u00a7"),
"Shake well and refrigerate after opening.",
"Drowning in [slightly fewer] JSON files...",
"Download only from CurseForge!",
"Rabbit poop coffee!",
"Now works on Minecraft 1.10.2! Because other modders are SOOO slow to update...",
"It stares into your soul.",
"Pot now included... flower pot, that is.",
"Did you know Chaos Gems are finally back?",
"Also try Extra Parts!",
"Your wish has been granted!",
};//@formatter:on
@Override
public String[] getQuotes() {
return QUOTES;
}
@Override
public GuiScreen getConfigScreen(GuiScreen parent) {
return new GuiConfigSilentGems(parent);
}
@Override
public GuiScreen getAchievementScreen(GuiScreen parent) {
// TODO Auto-generated method stub
return null;
}
private ItemStack makeTool(ITool tool, ItemStack rod, ItemStack gem, int gemCount) {
ItemStack[] array = new ItemStack[gemCount];
for (int i = 0; i < array.length; ++i)
array[i] = gem;
ItemStack ret = tool.constructTool(rod, array);
ToolHelper.setOriginalOwner(ret, TOOL_OWNER_NAME);
return ret;
}
}
| Fix server crash (guide book, closes #145)
| common/net/silentchaos512/gems/guide/GuideBookGems.java | Fix server crash (guide book, closes #145) | <ide><path>ommon/net/silentchaos512/gems/guide/GuideBookGems.java
<ide> import net.minecraft.init.Blocks;
<ide> import net.minecraft.init.Items;
<ide> import net.minecraft.item.ItemStack;
<del>import net.minecraft.item.crafting.CraftingManager;
<ide> import net.minecraft.item.crafting.IRecipe;
<ide> import net.minecraft.util.ResourceLocation;
<add>import net.minecraftforge.fml.relauncher.Side;
<add>import net.minecraftforge.fml.relauncher.SideOnly;
<ide> import net.minecraftforge.oredict.ShapedOreRecipe;
<ide> import net.minecraftforge.oredict.ShapelessOreRecipe;
<ide> import net.silentchaos512.gems.SilentGems;
<ide> return QUOTES;
<ide> }
<ide>
<add> @SideOnly(Side.CLIENT)
<ide> @Override
<ide> public GuiScreen getConfigScreen(GuiScreen parent) {
<ide>
<ide> return new GuiConfigSilentGems(parent);
<ide> }
<ide>
<add> @SideOnly(Side.CLIENT)
<ide> @Override
<ide> public GuiScreen getAchievementScreen(GuiScreen parent) {
<ide> |
|
Java | apache-2.0 | 866bdb0bd17be171acd08a5038c427b3533e6458 | 0 | JetBrains/teamcity-nuget-support,JetBrains/teamcity-nuget-support,JetBrains/teamcity-nuget-support,JetBrains/teamcity-nuget-support | /*
* Copyright 2000-2015 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 jetbrains.buildServer.nuget.server.toolRegistry.impl.impl;
import com.intellij.openapi.diagnostic.Logger;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetInstalledTool;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetServerToolProvider;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetTool;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetToolManager;
import jetbrains.buildServer.nuget.server.toolRegistry.impl.InstalledTool;
import jetbrains.buildServer.nuget.server.toolRegistry.impl.NuGetToolsSettings;
import jetbrains.buildServer.serverSide.SProject;
import jetbrains.buildServer.tools.*;
import jetbrains.buildServer.tools.available.AvailableToolsState;
import jetbrains.buildServer.tools.available.DownloadableToolVersion;
import jetbrains.buildServer.tools.available.FetchAvailableToolsResult;
import jetbrains.buildServer.tools.available.FetchToolsPolicy;
import jetbrains.buildServer.tools.installed.ToolsRegistry;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.File;
import java.util.*;
import static jetbrains.buildServer.nuget.common.PackagesConstants.NUGET_TOOL_REL_PATH;
/**
* Created by Eugene Petrenko ([email protected])
* Date: 11.08.11 1:07
*/
public class NuGetToolManagerImpl implements NuGetToolManager {
private static final Logger LOG = Logger.getInstance(NuGetToolManagerImpl.class.getName());
private final AvailableToolsState myAvailableTools;
private final ToolsRegistry myInstalledTools;
private final DefaultToolVersions myDefaultToolVersions;
private final NuGetToolsSettings mySettings;
public NuGetToolManagerImpl(@NotNull final AvailableToolsState availableTools,
@NotNull final ToolsRegistry installedTools,
@NotNull final DefaultToolVersions defaultToolVersions,
@NotNull final NuGetToolsSettings settings) {
myAvailableTools = availableTools;
myInstalledTools = installedTools;
myDefaultToolVersions = defaultToolVersions;
mySettings = settings;
}
@NotNull
public Collection<? extends NuGetInstalledTool> getInstalledTools() {
// final String defaultToolId = getDefaultToolId();
// final Collection<? extends NuGetInstalledTool> tools = myInstalledTools.getTools(NuGetServerToolProvider.NUGET_TOOL_TYPE);
// if (defaultToolId == null || StringUtil.isEmptyOrSpaces(defaultToolId)) {
// return tools;
// }
//
// final List<NuGetInstalledTool> toolsCopy = new ArrayList<NuGetInstalledTool>();
// for (NuGetInstalledTool tool : tools) {
// if (tool.getId().equals(defaultToolId)) {
// toolsCopy.add(new DefaultTool(tool));
// } else {
// toolsCopy.add(tool);
// }
// }
// return toolsCopy;
return Collections.emptyList();
}
@NotNull
public FetchAvailableToolsResult getAvailableTools(@NotNull FetchToolsPolicy policy) {
final Set<String> installed = new HashSet<String>();
for (NuGetInstalledTool tool : getInstalledTools()) {
installed.add(tool.getVersion());
}
final FetchAvailableToolsResult fetchAvailableToolsResult = myAvailableTools.getAvailable(policy);
final Collection<DownloadableToolVersion> available = new ArrayList<DownloadableToolVersion>(fetchAvailableToolsResult.getFetchedTools());
final Iterator<DownloadableToolVersion> it = available.iterator();
while (it.hasNext()) {
ToolVersion next = it.next();
if (installed.contains(next.getVersion())) {
it.remove();
}
}
return FetchAvailableToolsResult.create(available, fetchAvailableToolsResult.getErrors());
}
@Nullable
public DownloadableNuGetTool findAvailableToolById(String toolId) {
return new DownloadableNuGetTool(myAvailableTools.findTool(toolId));
}
@NotNull
public NuGetTool installTool(@NotNull String toolId, @NotNull String toolFileName, @NotNull File toolFile) throws ToolException {
// myInstaller.installNuGet(toolFileName, toolFile);
// myWatcher.checkNow();
return getInstalledTool(toolId);
}
public void removeTool(@NotNull String toolId) {
try {
myInstalledTools.removeTool(toolId);
} catch (ToolException e) {
LOG.error(e);
}
}
@Nullable
public File getNuGetPath(@Nullable final String toolRef, @NotNull final SProject scope) {
if (!ToolVersionReference.isToolReference(toolRef)) {
return new File(toolRef);
}
ToolVersion toolVersion;
if(ToolVersionReference.isDefaultVersionReference(toolRef)){
toolVersion = myDefaultToolVersions.getDefaultVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, scope);
if(toolVersion == null) return null;
} else {
toolVersion = new SimpleToolVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, ToolVersionReference.getToolVersionOfType(NuGetServerToolProvider.NUGET_TOOL_TYPE.getType(), toolRef));
}
final File unpackedContentLocation = myInstalledTools.getUnpackedContentLocation(toolVersion);
if(unpackedContentLocation == null){
LOG.debug(String.format("Failed to locate unpacked %s on server", toolVersion));
return null;
}
return new File(unpackedContentLocation, NUGET_TOOL_REL_PATH);
}
@Nullable
@Override
public String getNuGetVersion(@Nullable final String toolRef, @NotNull final SProject scope) {
if (!ToolVersionReference.isToolReference(toolRef)) {
return null;
}
ToolVersion toolVersion;
if(ToolVersionReference.isDefaultVersionReference(toolRef)){
toolVersion = myDefaultToolVersions.getDefaultVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, scope);
} else {
toolVersion = new SimpleToolVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, ToolVersionReference.getToolVersionOfType(NuGetServerToolProvider.NUGET_TOOL_TYPE.getType(), toolRef));
}
if(toolVersion == null) return null;
return toolVersion.getVersion();
}
@Nullable
public NuGetInstalledTool getDefaultTool() {
// InstalledTool tool = myInstalledTools.findTool(getDefaultToolId());
// if (tool == null) return null;
// return new DefaultTool(tool);
return null;
}
public void setDefaultTool(@NotNull final String toolId) {
mySettings.setDefaultTool(toolId);
}
@Nullable
public String getDefaultToolId() {
return mySettings.getDefaultToolId();
}
@NotNull
private InstalledTool getInstalledTool(@NotNull final String toolId) throws ToolException {
//final InstalledTool tool = myInstalledTools.findTool(toolId);
// if (tool == null) {
// throw new ToolException("Failed to find installed tool by id " + toolId);
// }
// return tool;
return null;
}
}
| nuget-server/src/jetbrains/buildServer/nuget/server/toolRegistry/impl/impl/NuGetToolManagerImpl.java | /*
* Copyright 2000-2015 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 jetbrains.buildServer.nuget.server.toolRegistry.impl.impl;
import com.intellij.openapi.diagnostic.Logger;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetInstalledTool;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetServerToolProvider;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetTool;
import jetbrains.buildServer.nuget.server.toolRegistry.NuGetToolManager;
import jetbrains.buildServer.nuget.server.toolRegistry.impl.InstalledTool;
import jetbrains.buildServer.nuget.server.toolRegistry.impl.NuGetToolsSettings;
import jetbrains.buildServer.serverSide.SProject;
import jetbrains.buildServer.tools.*;
import jetbrains.buildServer.tools.available.AvailableToolsState;
import jetbrains.buildServer.tools.available.DownloadableToolVersion;
import jetbrains.buildServer.tools.available.FetchAvailableToolsResult;
import jetbrains.buildServer.tools.available.FetchToolsPolicy;
import jetbrains.buildServer.tools.installed.ToolsRegistry;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.File;
import java.util.*;
import static jetbrains.buildServer.nuget.common.PackagesConstants.NUGET_TOOL_REL_PATH;
/**
* Created by Eugene Petrenko ([email protected])
* Date: 11.08.11 1:07
*/
public class NuGetToolManagerImpl implements NuGetToolManager {
private static final Logger LOG = Logger.getInstance(NuGetToolManagerImpl.class.getName());
private final AvailableToolsState myAvailableTools;
private final ToolsRegistry myInstalledTools;
private final DefaultToolVersions myDefaultToolVersions;
private final NuGetToolsSettings mySettings;
public NuGetToolManagerImpl(@NotNull final AvailableToolsState availableTools,
@NotNull final ToolsRegistry installedTools,
@NotNull final DefaultToolVersions defaultToolVersions,
@NotNull final NuGetToolsSettings settings) {
myAvailableTools = availableTools;
myInstalledTools = installedTools;
myDefaultToolVersions = defaultToolVersions;
mySettings = settings;
}
@NotNull
public Collection<? extends NuGetInstalledTool> getInstalledTools() {
// final String defaultToolId = getDefaultToolId();
// final Collection<? extends NuGetInstalledTool> tools = myInstalledTools.getTools(NuGetServerToolProvider.NUGET_TOOL_TYPE);
// if (defaultToolId == null || StringUtil.isEmptyOrSpaces(defaultToolId)) {
// return tools;
// }
//
// final List<NuGetInstalledTool> toolsCopy = new ArrayList<NuGetInstalledTool>();
// for (NuGetInstalledTool tool : tools) {
// if (tool.getId().equals(defaultToolId)) {
// toolsCopy.add(new DefaultTool(tool));
// } else {
// toolsCopy.add(tool);
// }
// }
// return toolsCopy;
return Collections.emptyList();
}
@NotNull
public FetchAvailableToolsResult getAvailableTools(@NotNull FetchToolsPolicy policy) {
final Set<String> installed = new HashSet<String>();
for (NuGetInstalledTool tool : getInstalledTools()) {
installed.add(tool.getVersion());
}
final FetchAvailableToolsResult fetchAvailableToolsResult = myAvailableTools.getAvailable(policy);
final Collection<DownloadableToolVersion> available = new ArrayList<DownloadableToolVersion>(fetchAvailableToolsResult.getFetchedTools());
final Iterator<DownloadableToolVersion> it = available.iterator();
while (it.hasNext()) {
ToolVersion next = it.next();
if (installed.contains(next.getVersion())) {
it.remove();
}
}
return FetchAvailableToolsResult.create(available, fetchAvailableToolsResult.getErrors());
}
@Nullable
public DownloadableNuGetTool findAvailableToolById(String toolId) {
return new DownloadableNuGetTool(myAvailableTools.findTool(toolId));
}
@NotNull
public NuGetTool installTool(@NotNull String toolId, @NotNull String toolFileName, @NotNull File toolFile) throws ToolException {
// myInstaller.installNuGet(toolFileName, toolFile);
// myWatcher.checkNow();
return getInstalledTool(toolId);
}
public void removeTool(@NotNull String toolId) {
try {
myInstalledTools.removeTool(null);
} catch (ToolException e) {
LOG.error(e);
}
}
@Nullable
public File getNuGetPath(@Nullable final String toolRef, @NotNull final SProject scope) {
if (!ToolVersionReference.isToolReference(toolRef)) {
return new File(toolRef);
}
ToolVersion toolVersion;
if(ToolVersionReference.isDefaultVersionReference(toolRef)){
toolVersion = myDefaultToolVersions.getDefaultVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, scope);
if(toolVersion == null) return null;
} else {
toolVersion = new SimpleToolVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, ToolVersionReference.getToolVersionOfType(NuGetServerToolProvider.NUGET_TOOL_TYPE.getType(), toolRef));
}
final File unpackedContentLocation = myInstalledTools.getUnpackedContentLocation(toolVersion);
if(unpackedContentLocation == null){
LOG.debug(String.format("Failed to locate unpacked %s on server", toolVersion));
return null;
}
return new File(unpackedContentLocation, NUGET_TOOL_REL_PATH);
}
@Nullable
@Override
public String getNuGetVersion(@Nullable final String toolRef, @NotNull final SProject scope) {
if (!ToolVersionReference.isToolReference(toolRef)) {
return null;
}
ToolVersion toolVersion;
if(ToolVersionReference.isDefaultVersionReference(toolRef)){
toolVersion = myDefaultToolVersions.getDefaultVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, scope);
} else {
toolVersion = new SimpleToolVersion(NuGetServerToolProvider.NUGET_TOOL_TYPE, ToolVersionReference.getToolVersionOfType(NuGetServerToolProvider.NUGET_TOOL_TYPE.getType(), toolRef));
}
if(toolVersion == null) return null;
return toolVersion.getVersion();
}
@Nullable
public NuGetInstalledTool getDefaultTool() {
// InstalledTool tool = myInstalledTools.findTool(getDefaultToolId());
// if (tool == null) return null;
// return new DefaultTool(tool);
return null;
}
public void setDefaultTool(@NotNull final String toolId) {
mySettings.setDefaultTool(toolId);
}
@Nullable
public String getDefaultToolId() {
return mySettings.getDefaultToolId();
}
@NotNull
private InstalledTool getInstalledTool(@NotNull final String toolId) throws ToolException {
//final InstalledTool tool = myInstalledTools.findTool(toolId);
// if (tool == null) {
// throw new ToolException("Failed to find installed tool by id " + toolId);
// }
// return tool;
return null;
}
}
| sync with api changes
| nuget-server/src/jetbrains/buildServer/nuget/server/toolRegistry/impl/impl/NuGetToolManagerImpl.java | sync with api changes | <ide><path>uget-server/src/jetbrains/buildServer/nuget/server/toolRegistry/impl/impl/NuGetToolManagerImpl.java
<ide>
<ide> public void removeTool(@NotNull String toolId) {
<ide> try {
<del> myInstalledTools.removeTool(null);
<add> myInstalledTools.removeTool(toolId);
<ide> } catch (ToolException e) {
<ide> LOG.error(e);
<ide> } |
|
Java | apache-2.0 | 94499fc7e6d2f31b1bdaf11c3fd8e3bf40bf311b | 0 | zqian/sakai,lorenamgUMU/sakai,liubo404/sakai,conder/sakai,kingmook/sakai,zqian/sakai,surya-janani/sakai,duke-compsci290-spring2016/sakai,udayg/sakai,rodriguezdevera/sakai,whumph/sakai,bkirschn/sakai,zqian/sakai,ouit0408/sakai,surya-janani/sakai,willkara/sakai,OpenCollabZA/sakai,liubo404/sakai,Fudan-University/sakai,udayg/sakai,ktakacs/sakai,OpenCollabZA/sakai,introp-software/sakai,kwedoff1/sakai,lorenamgUMU/sakai,introp-software/sakai,willkara/sakai,ouit0408/sakai,wfuedu/sakai,ouit0408/sakai,whumph/sakai,pushyamig/sakai,whumph/sakai,clhedrick/sakai,frasese/sakai,duke-compsci290-spring2016/sakai,kingmook/sakai,hackbuteer59/sakai,kwedoff1/sakai,puramshetty/sakai,kingmook/sakai,lorenamgUMU/sakai,buckett/sakai-gitflow,ktakacs/sakai,duke-compsci290-spring2016/sakai,joserabal/sakai,lorenamgUMU/sakai,willkara/sakai,joserabal/sakai,colczr/sakai,ouit0408/sakai,udayg/sakai,Fudan-University/sakai,tl-its-umich-edu/sakai,rodriguezdevera/sakai,noondaysun/sakai,bzhouduke123/sakai,noondaysun/sakai,frasese/sakai,duke-compsci290-spring2016/sakai,OpenCollabZA/sakai,puramshetty/sakai,ouit0408/sakai,ouit0408/sakai,udayg/sakai,conder/sakai,tl-its-umich-edu/sakai,frasese/sakai,tl-its-umich-edu/sakai,rodriguezdevera/sakai,rodriguezdevera/sakai,noondaysun/sakai,zqian/sakai,rodriguezdevera/sakai,willkara/sakai,colczr/sakai,wfuedu/sakai,buckett/sakai-gitflow,frasese/sakai,joserabal/sakai,introp-software/sakai,bkirschn/sakai,bzhouduke123/sakai,kwedoff1/sakai,clhedrick/sakai,tl-its-umich-edu/sakai,hackbuteer59/sakai,colczr/sakai,joserabal/sakai,puramshetty/sakai,kwedoff1/sakai,ktakacs/sakai,udayg/sakai,liubo404/sakai,willkara/sakai,noondaysun/sakai,kingmook/sakai,willkara/sakai,wfuedu/sakai,buckett/sakai-gitflow,surya-janani/sakai,bzhouduke123/sakai,surya-janani/sakai,duke-compsci290-spring2016/sakai,tl-its-umich-edu/sakai,clhedrick/sakai,tl-its-umich-edu/sakai,introp-software/sakai,zqian/sakai,conder/sakai,bzhouduke123/sakai,puramshetty/sakai,bzhouduke123/sakai,lorenamgUMU/sakai,wfuedu/sakai,hackbuteer59/sakai,clhedrick/sakai,wfuedu/sakai,whumph/sakai,joserabal/sakai,liubo404/sakai,duke-compsci290-spring2016/sakai,OpenCollabZA/sakai,bzhouduke123/sakai,Fudan-University/sakai,surya-janani/sakai,colczr/sakai,buckett/sakai-gitflow,frasese/sakai,colczr/sakai,bkirschn/sakai,hackbuteer59/sakai,conder/sakai,conder/sakai,wfuedu/sakai,willkara/sakai,buckett/sakai-gitflow,bzhouduke123/sakai,frasese/sakai,wfuedu/sakai,colczr/sakai,liubo404/sakai,zqian/sakai,colczr/sakai,kwedoff1/sakai,frasese/sakai,duke-compsci290-spring2016/sakai,lorenamgUMU/sakai,noondaysun/sakai,pushyamig/sakai,bkirschn/sakai,rodriguezdevera/sakai,ktakacs/sakai,wfuedu/sakai,colczr/sakai,Fudan-University/sakai,joserabal/sakai,OpenCollabZA/sakai,puramshetty/sakai,surya-janani/sakai,clhedrick/sakai,kwedoff1/sakai,tl-its-umich-edu/sakai,OpenCollabZA/sakai,whumph/sakai,lorenamgUMU/sakai,liubo404/sakai,introp-software/sakai,liubo404/sakai,udayg/sakai,whumph/sakai,conder/sakai,surya-janani/sakai,liubo404/sakai,bkirschn/sakai,introp-software/sakai,surya-janani/sakai,ktakacs/sakai,puramshetty/sakai,buckett/sakai-gitflow,introp-software/sakai,clhedrick/sakai,rodriguezdevera/sakai,bzhouduke123/sakai,hackbuteer59/sakai,ouit0408/sakai,puramshetty/sakai,joserabal/sakai,lorenamgUMU/sakai,kwedoff1/sakai,whumph/sakai,kingmook/sakai,introp-software/sakai,ktakacs/sakai,Fudan-University/sakai,frasese/sakai,Fudan-University/sakai,pushyamig/sakai,OpenCollabZA/sakai,whumph/sakai,willkara/sakai,tl-its-umich-edu/sakai,ktakacs/sakai,hackbuteer59/sakai,pushyamig/sakai,bkirschn/sakai,kingmook/sakai,kwedoff1/sakai,Fudan-University/sakai,conder/sakai,noondaysun/sakai,bkirschn/sakai,zqian/sakai,udayg/sakai,puramshetty/sakai,conder/sakai,kingmook/sakai,noondaysun/sakai,hackbuteer59/sakai,pushyamig/sakai,buckett/sakai-gitflow,pushyamig/sakai,pushyamig/sakai,ktakacs/sakai,buckett/sakai-gitflow,Fudan-University/sakai,noondaysun/sakai,OpenCollabZA/sakai,joserabal/sakai,duke-compsci290-spring2016/sakai,bkirschn/sakai,ouit0408/sakai,hackbuteer59/sakai,clhedrick/sakai,clhedrick/sakai,pushyamig/sakai,rodriguezdevera/sakai,udayg/sakai,kingmook/sakai,zqian/sakai | /**********************************************************************************
* $URL$
* $Id$
***********************************************************************************
*
* Copyright (c) 2003, 2004, 2005, 2006, 2007 The Sakai Foundation.
*
* Licensed under the Educational Community License, Version 1.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/ecl1.php
*
* 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.handlers;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.exception.IdUnusedException;
import org.sakaiproject.exception.PermissionException;
import org.sakaiproject.portal.api.Portal;
import org.sakaiproject.portal.api.PortalHandlerException;
import org.sakaiproject.portal.api.PortalRenderContext;
import org.sakaiproject.portal.api.StoredState;
import org.sakaiproject.portal.util.PortalSiteHelper;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SitePage;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.site.cover.SiteService;
import org.sakaiproject.tool.api.Session;
import org.sakaiproject.tool.api.ToolException;
/**
*
* @author ieb
* @since Sakai 2.4
* @version $Rev$
*
*/
public class PageHandler extends BasePortalHandler
{
private static final String INCLUDE_PAGE = "include-page";
private static final Log log = LogFactory.getLog(PageHandler.class);
protected PortalSiteHelper siteHelper = new PortalSiteHelper();
public PageHandler()
{
urlFragment = "page";
}
@Override
public int doPost(String[] parts, HttpServletRequest req, HttpServletResponse res,
Session session) throws PortalHandlerException
{
return doGet(parts, req, res, session);
}
@Override
public int doGet(String[] parts, HttpServletRequest req, HttpServletResponse res,
Session session) throws PortalHandlerException
{
if ((parts.length == 3) && (parts[1].equals("page")))
{
try
{
// Resolve the placements of the form
// /portal/page/sakai.resources?sakai.site=~csev
String pagePlacement = portal.getPlacement(req, res, session, parts[2],
true);
if (pagePlacement == null)
{
return ABORT;
}
parts[2] = pagePlacement;
doPage(req, res, session, parts[2], req.getContextPath()
+ req.getServletPath());
return END;
}
catch (Exception ex)
{
throw new PortalHandlerException(ex);
}
}
else
{
return NEXT;
}
}
public void doPage(HttpServletRequest req, HttpServletResponse res, Session session,
String pageId, String toolContextPath) throws ToolException, IOException
{
// find the page from some site
SitePage page = SiteService.findPage(pageId);
if (page == null)
{
portal.doError(req, res, session, Portal.ERROR_WORKSITE);
return;
}
// permission check - visit the site
Site site = null;
try
{
site = SiteService.getSiteVisit(page.getSiteId());
}
catch (IdUnusedException e)
{
portal.doError(req, res, session, Portal.ERROR_WORKSITE);
return;
}
catch (PermissionException e)
{
// if not logged in, give them a chance
if (session.getUserId() == null)
{
StoredState ss = portalService.newStoredState("", "");
ss.setRequest(req);
ss.setToolContextPath(toolContextPath);
portalService.setStoredState(ss);
portal.doLogin(req, res, session, req.getPathInfo(), false);
}
else
{
portal.doError(req, res, session, Portal.ERROR_WORKSITE);
}
return;
}
// form a context sensitive title
String title = ServerConfigurationService.getString("ui.service") + " : "
+ site.getTitle() + " : " + page.getTitle();
String siteType = portal.calcSiteType(site.getId());
// start the response
PortalRenderContext rcontext = portal.startPageContext(siteType, title, page
.getSkin(), req);
includePage(rcontext, res, req, page, toolContextPath, "contentFull");
portal.sendResponse(rcontext, res, "page", null);
StoredState ss = portalService.getStoredState();
if (ss != null && toolContextPath.equals(ss.getToolContextPath()))
{
// This request is the destination of the request
portalService.setStoredState(null);
}
}
public void includePage(PortalRenderContext rcontext, HttpServletResponse res,
HttpServletRequest req, SitePage page, String toolContextPath,
String wrapperClass) throws IOException
{
if (rcontext.uses(INCLUDE_PAGE))
{
// divs to wrap the tools
rcontext.put("pageWrapperClass", wrapperClass);
rcontext
.put("pageColumnLayout",
(page.getLayout() == SitePage.LAYOUT_DOUBLE_COL) ? "col1of2"
: "col1");
Site site = null;
try
{
site = SiteService.getSite(page.getSiteId());
}
catch (Exception ignoreMe)
{
// Non fatal - just assume null
if (log.isTraceEnabled())
log.trace("includePage unable to find site for page " + page.getId());
}
{
List<Map> toolList = new ArrayList<Map>();
List tools = page.getTools(0);
for (Iterator i = tools.iterator(); i.hasNext();)
{
ToolConfiguration placement = (ToolConfiguration) i.next();
if (site != null)
{
boolean thisTool = siteHelper.allowTool(site, placement);
// System.out.println(" Allow Tool Display -" +
// placement.getTitle() + " retval = " + thisTool);
if (!thisTool) continue; // Skip this tool if not
// allowed
}
Map m = portal.includeTool(res, req, placement);
if (m != null)
{
toolList.add(m);
}
}
rcontext.put("pageColumn0Tools", toolList);
}
rcontext.put("pageTwoColumn", Boolean
.valueOf(page.getLayout() == SitePage.LAYOUT_DOUBLE_COL));
// do the second column if needed
if (page.getLayout() == SitePage.LAYOUT_DOUBLE_COL)
{
List<Map> toolList = new ArrayList<Map>();
List tools = page.getTools(1);
for (Iterator i = tools.iterator(); i.hasNext();)
{
ToolConfiguration placement = (ToolConfiguration) i.next();
Map m = portal.includeTool(res, req, placement);
if (m != null)
{
toolList.add(m);
}
}
rcontext.put("pageColumn1Tools", toolList);
}
//Add footer variables to page template context- SAK-10312
String copyright = ServerConfigurationService
.getString("bottom.copyrighttext");
String service = ServerConfigurationService.getString("ui.service", "Sakai");
String serviceVersion = ServerConfigurationService.getString(
"version.service", "?");
String sakaiVersion = ServerConfigurationService.getString("version.sakai",
"?");
String server = ServerConfigurationService.getServerId();
rcontext.put("bottomNavService", service);
rcontext.put("bottomNavCopyright", copyright);
rcontext.put("bottomNavServiceVersion", serviceVersion);
rcontext.put("bottomNavSakaiVersion", sakaiVersion);
rcontext.put("bottomNavServer", server);
}
}
}
| portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/PageHandler.java | /**********************************************************************************
* $URL$
* $Id$
***********************************************************************************
*
* Copyright (c) 2003, 2004, 2005, 2006, 2007 The Sakai Foundation.
*
* Licensed under the Educational Community License, Version 1.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/ecl1.php
*
* 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.handlers;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.exception.IdUnusedException;
import org.sakaiproject.exception.PermissionException;
import org.sakaiproject.portal.api.Portal;
import org.sakaiproject.portal.api.PortalHandlerException;
import org.sakaiproject.portal.api.PortalRenderContext;
import org.sakaiproject.portal.api.StoredState;
import org.sakaiproject.portal.util.PortalSiteHelper;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SitePage;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.site.cover.SiteService;
import org.sakaiproject.tool.api.Session;
import org.sakaiproject.tool.api.ToolException;
/**
*
* @author ieb
* @since Sakai 2.4
* @version $Rev$
*
*/
public class PageHandler extends BasePortalHandler
{
private static final String INCLUDE_PAGE = "include-page";
private static final Log log = LogFactory.getLog(PageHandler.class);
protected PortalSiteHelper siteHelper = new PortalSiteHelper();
public PageHandler()
{
urlFragment = "page";
}
@Override
public int doPost(String[] parts, HttpServletRequest req, HttpServletResponse res,
Session session) throws PortalHandlerException
{
return doGet(parts, req, res, session);
}
@Override
public int doGet(String[] parts, HttpServletRequest req, HttpServletResponse res,
Session session) throws PortalHandlerException
{
if ((parts.length == 3) && (parts[1].equals("page")))
{
try
{
// Resolve the placements of the form
// /portal/page/sakai.resources?sakai.site=~csev
String pagePlacement = portal.getPlacement(req, res, session, parts[2],
true);
if (pagePlacement == null)
{
return ABORT;
}
parts[2] = pagePlacement;
doPage(req, res, session, parts[2], req.getContextPath()
+ req.getServletPath());
return END;
}
catch (Exception ex)
{
throw new PortalHandlerException(ex);
}
}
else
{
return NEXT;
}
}
public void doPage(HttpServletRequest req, HttpServletResponse res, Session session,
String pageId, String toolContextPath) throws ToolException, IOException
{
// find the page from some site
SitePage page = SiteService.findPage(pageId);
if (page == null)
{
portal.doError(req, res, session, Portal.ERROR_WORKSITE);
return;
}
// permission check - visit the site
Site site = null;
try
{
site = SiteService.getSiteVisit(page.getSiteId());
}
catch (IdUnusedException e)
{
portal.doError(req, res, session, Portal.ERROR_WORKSITE);
return;
}
catch (PermissionException e)
{
// if not logged in, give them a chance
if (session.getUserId() == null)
{
StoredState ss = portalService.newStoredState("", "");
ss.setRequest(req);
ss.setToolContextPath(toolContextPath);
portalService.setStoredState(ss);
portal.doLogin(req, res, session, req.getPathInfo(), false);
}
else
{
portal.doError(req, res, session, Portal.ERROR_WORKSITE);
}
return;
}
// form a context sensitive title
String title = ServerConfigurationService.getString("ui.service") + " : "
+ site.getTitle() + " : " + page.getTitle();
String siteType = portal.calcSiteType(site.getId());
// start the response
PortalRenderContext rcontext = portal.startPageContext(siteType, title, page
.getSkin(), req);
includePage(rcontext, res, req, page, toolContextPath, "contentFull");
portal.sendResponse(rcontext, res, "page", null);
StoredState ss = portalService.getStoredState();
if (ss != null && toolContextPath.equals(ss.getToolContextPath()))
{
// This request is the destination of the request
portalService.setStoredState(null);
}
}
public void includePage(PortalRenderContext rcontext, HttpServletResponse res,
HttpServletRequest req, SitePage page, String toolContextPath,
String wrapperClass) throws IOException
{
if (rcontext.uses(INCLUDE_PAGE))
{
// divs to wrap the tools
rcontext.put("pageWrapperClass", wrapperClass);
rcontext
.put("pageColumnLayout",
(page.getLayout() == SitePage.LAYOUT_DOUBLE_COL) ? "col1of2"
: "col1");
Site site = null;
try
{
site = SiteService.getSite(page.getSiteId());
}
catch (Exception ignoreMe)
{
// Non fatal - just assume null
if (log.isTraceEnabled())
log.trace("includePage unable to find site for page " + page.getId());
}
{
List<Map> toolList = new ArrayList<Map>();
List tools = page.getTools(0);
for (Iterator i = tools.iterator(); i.hasNext();)
{
ToolConfiguration placement = (ToolConfiguration) i.next();
if (site != null)
{
boolean thisTool = siteHelper.allowTool(site, placement);
// System.out.println(" Allow Tool Display -" +
// placement.getTitle() + " retval = " + thisTool);
if (!thisTool) continue; // Skip this tool if not
// allowed
}
Map m = portal.includeTool(res, req, placement);
if (m != null)
{
toolList.add(m);
}
}
rcontext.put("pageColumn0Tools", toolList);
}
rcontext.put("pageTwoColumn", Boolean
.valueOf(page.getLayout() == SitePage.LAYOUT_DOUBLE_COL));
// do the second column if needed
if (page.getLayout() == SitePage.LAYOUT_DOUBLE_COL)
{
List<Map> toolList = new ArrayList<Map>();
List tools = page.getTools(1);
for (Iterator i = tools.iterator(); i.hasNext();)
{
ToolConfiguration placement = (ToolConfiguration) i.next();
Map m = portal.includeTool(res, req, placement);
if (m != null)
{
toolList.add(m);
}
}
rcontext.put("pageColumn1Tools", toolList);
}
}
}
}
| SAK-10312 fix footer variables in web content pop up
git-svn-id: 14ad73a4fc9ccb6b14c5a9bdb407111d9f04bc7b@31376 66ffb92e-73f9-0310-93c1-f5514f145a0a
| portal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/PageHandler.java | SAK-10312 fix footer variables in web content pop up | <ide><path>ortal/portal-impl/impl/src/java/org/sakaiproject/portal/charon/handlers/PageHandler.java
<ide> }
<ide> rcontext.put("pageColumn1Tools", toolList);
<ide> }
<add>
<add> //Add footer variables to page template context- SAK-10312
<add>
<add> String copyright = ServerConfigurationService
<add> .getString("bottom.copyrighttext");
<add> String service = ServerConfigurationService.getString("ui.service", "Sakai");
<add> String serviceVersion = ServerConfigurationService.getString(
<add> "version.service", "?");
<add> String sakaiVersion = ServerConfigurationService.getString("version.sakai",
<add> "?");
<add> String server = ServerConfigurationService.getServerId();
<add>
<add>
<add> rcontext.put("bottomNavService", service);
<add> rcontext.put("bottomNavCopyright", copyright);
<add> rcontext.put("bottomNavServiceVersion", serviceVersion);
<add> rcontext.put("bottomNavSakaiVersion", sakaiVersion);
<add> rcontext.put("bottomNavServer", server);
<add>
<add>
<ide> }
<ide> }
<ide> |
|
Java | apache-2.0 | error: pathspec 'java/javaapi/src/main/java/io/joynr/proxy/MessageIdCallback.java' did not match any file(s) known to git
| 8b870886c69ac1f18a4775f9ac5927b6665ccdb9 | 1 | bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr,bmwcarit/joynr | /*-
* #%L
* %%
* Copyright (C) 2011 - 2018 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%
*/
package io.joynr.proxy;
import java.util.function.Consumer;
public interface MessageIdCallback extends Consumer<String> {
}
| java/javaapi/src/main/java/io/joynr/proxy/MessageIdCallback.java | [Java] add new message ID callback interface for stateless async
Change-Id: Ia998c7371075513d00482504cc9fd1a30e72ec6d
| java/javaapi/src/main/java/io/joynr/proxy/MessageIdCallback.java | [Java] add new message ID callback interface for stateless async | <ide><path>ava/javaapi/src/main/java/io/joynr/proxy/MessageIdCallback.java
<add>/*-
<add> * #%L
<add> * %%
<add> * Copyright (C) 2011 - 2018 BMW Car IT GmbH
<add> * %%
<add> * Licensed under the Apache License, Version 2.0 (the "License");
<add> * you may not use this file except in compliance with the License.
<add> * You may obtain a copy of the License at
<add> *
<add> * http://www.apache.org/licenses/LICENSE-2.0
<add> *
<add> * Unless required by applicable law or agreed to in writing, software
<add> * distributed under the License is distributed on an "AS IS" BASIS,
<add> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<add> * See the License for the specific language governing permissions and
<add> * limitations under the License.
<add> * #L%
<add> */
<add>package io.joynr.proxy;
<add>
<add>import java.util.function.Consumer;
<add>
<add>public interface MessageIdCallback extends Consumer<String> {
<add>} |
|
Java | apache-2.0 | 9147fbad899003e578e0ffdfd1e1ff822d8b968e | 0 | kironapublic/vaadin,Legioth/vaadin,jdahlstrom/vaadin.react,udayinfy/vaadin,Darsstar/framework,oalles/vaadin,magi42/vaadin,mstahv/framework,Legioth/vaadin,magi42/vaadin,udayinfy/vaadin,jdahlstrom/vaadin.react,Peppe/vaadin,oalles/vaadin,peterl1084/framework,shahrzadmn/vaadin,synes/vaadin,jdahlstrom/vaadin.react,Legioth/vaadin,udayinfy/vaadin,udayinfy/vaadin,kironapublic/vaadin,kironapublic/vaadin,Peppe/vaadin,peterl1084/framework,kironapublic/vaadin,oalles/vaadin,asashour/framework,Darsstar/framework,shahrzadmn/vaadin,magi42/vaadin,Darsstar/framework,asashour/framework,oalles/vaadin,mstahv/framework,peterl1084/framework,Legioth/vaadin,Peppe/vaadin,jdahlstrom/vaadin.react,kironapublic/vaadin,asashour/framework,oalles/vaadin,mstahv/framework,udayinfy/vaadin,sitexa/vaadin,asashour/framework,magi42/vaadin,Peppe/vaadin,Darsstar/framework,sitexa/vaadin,Peppe/vaadin,Legioth/vaadin,synes/vaadin,synes/vaadin,Darsstar/framework,asashour/framework,sitexa/vaadin,shahrzadmn/vaadin,sitexa/vaadin,peterl1084/framework,sitexa/vaadin,shahrzadmn/vaadin,magi42/vaadin,shahrzadmn/vaadin,mstahv/framework,peterl1084/framework,synes/vaadin,synes/vaadin,mstahv/framework,jdahlstrom/vaadin.react | /*
* Copyright 2000-2014 Vaadin 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.vaadin.client.connectors;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.logging.Logger;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.dom.client.NativeEvent;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.ComponentConnector;
import com.vaadin.client.ConnectorHierarchyChangeEvent;
import com.vaadin.client.DeferredWorker;
import com.vaadin.client.MouseEventDetailsBuilder;
import com.vaadin.client.ServerConnector;
import com.vaadin.client.annotations.OnStateChange;
import com.vaadin.client.communication.StateChangeEvent;
import com.vaadin.client.connectors.RpcDataSourceConnector.DetailsListener;
import com.vaadin.client.connectors.RpcDataSourceConnector.RpcDataSource;
import com.vaadin.client.data.DataSource.RowHandle;
import com.vaadin.client.renderers.Renderer;
import com.vaadin.client.ui.AbstractFieldConnector;
import com.vaadin.client.ui.AbstractHasComponentsConnector;
import com.vaadin.client.ui.SimpleManagedLayout;
import com.vaadin.client.widget.grid.CellReference;
import com.vaadin.client.widget.grid.CellStyleGenerator;
import com.vaadin.client.widget.grid.DetailsGenerator;
import com.vaadin.client.widget.grid.EditorHandler;
import com.vaadin.client.widget.grid.RowReference;
import com.vaadin.client.widget.grid.RowStyleGenerator;
import com.vaadin.client.widget.grid.events.BodyClickHandler;
import com.vaadin.client.widget.grid.events.BodyDoubleClickHandler;
import com.vaadin.client.widget.grid.events.ColumnReorderEvent;
import com.vaadin.client.widget.grid.events.ColumnReorderHandler;
import com.vaadin.client.widget.grid.events.ColumnVisibilityChangeEvent;
import com.vaadin.client.widget.grid.events.ColumnVisibilityChangeHandler;
import com.vaadin.client.widget.grid.events.GridClickEvent;
import com.vaadin.client.widget.grid.events.GridDoubleClickEvent;
import com.vaadin.client.widget.grid.events.SelectAllEvent;
import com.vaadin.client.widget.grid.events.SelectAllHandler;
import com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel;
import com.vaadin.client.widget.grid.selection.SelectionEvent;
import com.vaadin.client.widget.grid.selection.SelectionHandler;
import com.vaadin.client.widget.grid.selection.SelectionModel;
import com.vaadin.client.widget.grid.selection.SelectionModelMulti;
import com.vaadin.client.widget.grid.selection.SelectionModelNone;
import com.vaadin.client.widget.grid.selection.SelectionModelSingle;
import com.vaadin.client.widget.grid.sort.SortEvent;
import com.vaadin.client.widget.grid.sort.SortHandler;
import com.vaadin.client.widget.grid.sort.SortOrder;
import com.vaadin.client.widgets.Grid;
import com.vaadin.client.widgets.Grid.Column;
import com.vaadin.client.widgets.Grid.FooterCell;
import com.vaadin.client.widgets.Grid.FooterRow;
import com.vaadin.client.widgets.Grid.HeaderCell;
import com.vaadin.client.widgets.Grid.HeaderRow;
import com.vaadin.shared.data.sort.SortDirection;
import com.vaadin.shared.ui.Connect;
import com.vaadin.shared.ui.grid.EditorClientRpc;
import com.vaadin.shared.ui.grid.EditorServerRpc;
import com.vaadin.shared.ui.grid.GridClientRpc;
import com.vaadin.shared.ui.grid.GridColumnState;
import com.vaadin.shared.ui.grid.GridConstants;
import com.vaadin.shared.ui.grid.GridServerRpc;
import com.vaadin.shared.ui.grid.GridState;
import com.vaadin.shared.ui.grid.GridState.SharedSelectionMode;
import com.vaadin.shared.ui.grid.GridStaticSectionState;
import com.vaadin.shared.ui.grid.GridStaticSectionState.CellState;
import com.vaadin.shared.ui.grid.GridStaticSectionState.RowState;
import com.vaadin.shared.ui.grid.ScrollDestination;
import elemental.json.JsonObject;
import elemental.json.JsonValue;
/**
* Connects the client side {@link Grid} widget with the server side
* {@link com.vaadin.ui.components.grid.Grid} component.
* <p>
* The Grid is typed to JSONObject. The structure of the JSONObject is described
* at {@link com.vaadin.shared.data.DataProviderRpc#setRowData(int, List)
* DataProviderRpc.setRowData(int, List)}.
*
* @since 7.4
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.Grid.class)
public class GridConnector extends AbstractHasComponentsConnector implements
SimpleManagedLayout, DeferredWorker {
private static final class CustomCellStyleGenerator implements
CellStyleGenerator<JsonObject> {
@Override
public String getStyle(CellReference<JsonObject> cellReference) {
JsonObject row = cellReference.getRow();
if (!row.hasKey(GridState.JSONKEY_CELLSTYLES)) {
return null;
}
Column<?, JsonObject> column = cellReference.getColumn();
if (!(column instanceof CustomGridColumn)) {
// Selection checkbox column
return null;
}
CustomGridColumn c = (CustomGridColumn) column;
JsonObject cellStylesObject = row
.getObject(GridState.JSONKEY_CELLSTYLES);
assert cellStylesObject != null;
if (cellStylesObject.hasKey(c.id)) {
return cellStylesObject.getString(c.id);
} else {
return null;
}
}
}
private static final class CustomRowStyleGenerator implements
RowStyleGenerator<JsonObject> {
@Override
public String getStyle(RowReference<JsonObject> rowReference) {
JsonObject row = rowReference.getRow();
if (row.hasKey(GridState.JSONKEY_ROWSTYLE)) {
return row.getString(GridState.JSONKEY_ROWSTYLE);
} else {
return null;
}
}
}
/**
* Custom implementation of the custom grid column using a JSONObject to
* represent the cell value and String as a column type.
*/
private class CustomGridColumn extends Grid.Column<Object, JsonObject> {
private final String id;
private AbstractRendererConnector<Object> rendererConnector;
private AbstractFieldConnector editorConnector;
public CustomGridColumn(String id,
AbstractRendererConnector<Object> rendererConnector) {
super(rendererConnector.getRenderer());
this.rendererConnector = rendererConnector;
this.id = id;
}
/**
* Sets a new renderer for this column object
*
* @param rendererConnector
* a renderer connector object
*/
public void setRenderer(
AbstractRendererConnector<Object> rendererConnector) {
setRenderer(rendererConnector.getRenderer());
this.rendererConnector = rendererConnector;
}
@Override
public Object getValue(final JsonObject obj) {
final JsonObject rowData = obj.getObject(GridState.JSONKEY_DATA);
if (rowData.hasKey(id)) {
final JsonValue columnValue = rowData.get(id);
return rendererConnector.decode(columnValue);
}
return null;
}
private AbstractFieldConnector getEditorConnector() {
return editorConnector;
}
private void setEditorConnector(AbstractFieldConnector editorConnector) {
this.editorConnector = editorConnector;
}
}
/*
* An editor handler using Vaadin RPC to manage the editor state.
*/
private class CustomEditorHandler implements EditorHandler<JsonObject> {
private EditorServerRpc rpc = getRpcProxy(EditorServerRpc.class);
private EditorRequest<JsonObject> currentRequest = null;
private boolean serverInitiated = false;
public CustomEditorHandler() {
registerRpc(EditorClientRpc.class, new EditorClientRpc() {
@Override
public void bind(final int rowIndex) {
// call this finally to avoid issues with editing on init
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
GridConnector.this.getWidget().editRow(rowIndex);
}
});
}
@Override
public void cancel(int rowIndex) {
serverInitiated = true;
GridConnector.this.getWidget().cancelEditor();
}
@Override
public void confirmBind(final boolean bindSucceeded) {
endRequest(bindSucceeded, null, null);
}
@Override
public void confirmSave(boolean saveSucceeded,
String errorMessage, List<String> errorColumnsIds) {
endRequest(saveSucceeded, errorMessage, errorColumnsIds);
}
});
}
@Override
public void bind(EditorRequest<JsonObject> request) {
startRequest(request);
rpc.bind(request.getRowIndex());
}
@Override
public void save(EditorRequest<JsonObject> request) {
startRequest(request);
rpc.save(request.getRowIndex());
}
@Override
public void cancel(EditorRequest<JsonObject> request) {
if (!handleServerInitiated(request)) {
// No startRequest as we don't get (or need)
// a confirmation from the server
rpc.cancel(request.getRowIndex());
}
}
@Override
public Widget getWidget(Grid.Column<?, JsonObject> column) {
assert column != null;
if (column instanceof CustomGridColumn) {
AbstractFieldConnector c = ((CustomGridColumn) column)
.getEditorConnector();
return c != null ? c.getWidget() : null;
} else {
throw new IllegalStateException("Unexpected column type: "
+ column.getClass().getName());
}
}
/**
* Used to handle the case where the editor calls us because it was
* invoked by the server via RPC and not by the client. In that case,
* the request can be simply synchronously completed.
*
* @param request
* the request object
* @return true if the request was originally triggered by the server,
* false otherwise
*/
private boolean handleServerInitiated(EditorRequest<?> request) {
assert request != null : "Cannot handle null request";
assert currentRequest == null : "Earlier request not yet finished";
if (serverInitiated) {
serverInitiated = false;
request.success();
return true;
} else {
return false;
}
}
private void startRequest(EditorRequest<JsonObject> request) {
assert currentRequest == null : "Earlier request not yet finished";
currentRequest = request;
}
private void endRequest(boolean succeeded, String errorMessage,
List<String> errorColumnsIds) {
assert currentRequest != null : "Current request was null";
/*
* Clear current request first to ensure the state is valid if
* another request is made in the callback.
*/
EditorRequest<JsonObject> request = currentRequest;
currentRequest = null;
if (succeeded) {
request.success();
} else {
Collection<Column<?, JsonObject>> errorColumns;
if (errorColumnsIds != null) {
errorColumns = new ArrayList<Grid.Column<?, JsonObject>>();
for (String colId : errorColumnsIds) {
errorColumns.add(columnIdToColumn.get(colId));
}
} else {
errorColumns = null;
}
request.failure(errorMessage, errorColumns);
}
}
}
private class ItemClickHandler implements BodyClickHandler,
BodyDoubleClickHandler {
@Override
public void onClick(GridClickEvent event) {
if (hasEventListener(GridConstants.ITEM_CLICK_EVENT_ID)) {
fireItemClick(event.getTargetCell(), event.getNativeEvent());
}
}
@Override
public void onDoubleClick(GridDoubleClickEvent event) {
if (hasEventListener(GridConstants.ITEM_CLICK_EVENT_ID)) {
fireItemClick(event.getTargetCell(), event.getNativeEvent());
}
}
private void fireItemClick(CellReference<?> cell, NativeEvent mouseEvent) {
String rowKey = getRowKey((JsonObject) cell.getRow());
String columnId = getColumnId(cell.getColumn());
getRpcProxy(GridServerRpc.class)
.itemClick(
rowKey,
columnId,
MouseEventDetailsBuilder
.buildMouseEventDetails(mouseEvent));
}
}
private ColumnReorderHandler<JsonObject> columnReorderHandler = new ColumnReorderHandler<JsonObject>() {
@Override
public void onColumnReorder(ColumnReorderEvent<JsonObject> event) {
if (!columnsUpdatedFromState) {
List<Column<?, JsonObject>> columns = getWidget().getColumns();
final List<String> newColumnOrder = new ArrayList<String>();
for (Column<?, JsonObject> column : columns) {
if (column instanceof CustomGridColumn) {
newColumnOrder.add(((CustomGridColumn) column).id);
} // the other case would be the multi selection column
}
getRpcProxy(GridServerRpc.class).columnsReordered(
newColumnOrder, columnOrder);
columnOrder = newColumnOrder;
getState().columnOrder = newColumnOrder;
}
}
};
private ColumnVisibilityChangeHandler<JsonObject> columnVisibilityChangeHandler = new ColumnVisibilityChangeHandler<JsonObject>() {
@Override
public void onVisibilityChange(
ColumnVisibilityChangeEvent<JsonObject> event) {
if (!columnsUpdatedFromState) {
Column<?, JsonObject> column = event.getColumn();
if (column instanceof CustomGridColumn) {
getRpcProxy(GridServerRpc.class).columnVisibilityChanged(
((CustomGridColumn) column).id, column.isHidden(),
event.isUserOriginated());
for (GridColumnState state : getState().columns) {
if (state.id.equals(((CustomGridColumn) column).id)) {
state.hidden = event.isHidden();
break;
}
}
} else {
getLogger().warning(
"Visibility changed for a unknown column type in Grid: "
+ column.toString() + ", type "
+ column.getClass());
}
}
}
};
private class CustomDetailsGenerator implements DetailsGenerator {
private final Map<String, ComponentConnector> idToDetailsMap = new HashMap<String, ComponentConnector>();
private final Map<String, Integer> idToRowIndex = new HashMap<String, Integer>();
@Override
public Widget getDetails(int rowIndex) {
JsonObject row = getWidget().getDataSource().getRow(rowIndex);
if (!row.hasKey(GridState.JSONKEY_DETAILS_VISIBLE)
|| row.getString(GridState.JSONKEY_DETAILS_VISIBLE)
.isEmpty()) {
return null;
}
String id = row.getString(GridState.JSONKEY_DETAILS_VISIBLE);
ComponentConnector componentConnector = idToDetailsMap.get(id);
idToRowIndex.put(id, rowIndex);
return componentConnector.getWidget();
}
public void updateConnectorHierarchy(List<ServerConnector> children) {
Set<String> connectorIds = new HashSet<String>();
for (ServerConnector child : children) {
if (child instanceof ComponentConnector) {
connectorIds.add(child.getConnectorId());
idToDetailsMap.put(child.getConnectorId(),
(ComponentConnector) child);
}
}
Set<String> removedDetails = new HashSet<String>();
for (Entry<String, ComponentConnector> entry : idToDetailsMap
.entrySet()) {
ComponentConnector connector = entry.getValue();
String id = connector.getConnectorId();
if (!connectorIds.contains(id)) {
removedDetails.add(entry.getKey());
if (idToRowIndex.containsKey(id)) {
getWidget().setDetailsVisible(idToRowIndex.get(id),
false);
}
}
}
for (String id : removedDetails) {
idToDetailsMap.remove(id);
idToRowIndex.remove(id);
}
}
}
/**
* Class for handling scrolling issues with open details.
*
* @since 7.5.2
*/
private class LazyDetailsScroller implements DeferredWorker {
/* Timer value tested to work in our test cluster with slow IE8s. */
private static final int DISABLE_LAZY_SCROLL_TIMEOUT = 1500;
/*
* Cancels details opening scroll after timeout. Avoids any unexpected
* scrolls via details opening.
*/
private Timer disableScroller = new Timer() {
@Override
public void run() {
targetRow = -1;
}
};
private Integer targetRow = -1;
private ScrollDestination destination = null;
public void scrollToRow(Integer row, ScrollDestination dest) {
targetRow = row;
destination = dest;
disableScroller.schedule(DISABLE_LAZY_SCROLL_TIMEOUT);
}
/**
* Inform LazyDetailsScroller that a details row has opened on a row.
*
* @param rowIndex
* index of row with details now open
*/
public void detailsOpened(int rowIndex) {
if (targetRow == rowIndex) {
getWidget().scrollToRow(targetRow, destination);
disableScroller.run();
}
}
@Override
public boolean isWorkPending() {
return disableScroller.isRunning();
}
}
/**
* Maps a generated column id to a grid column instance
*/
private Map<String, CustomGridColumn> columnIdToColumn = new HashMap<String, CustomGridColumn>();
private AbstractRowHandleSelectionModel<JsonObject> selectionModel;
private Set<String> selectedKeys = new LinkedHashSet<String>();
private List<String> columnOrder = new ArrayList<String>();
/**
* {@link #selectionUpdatedFromState} is set to true when
* {@link #updateSelectionFromState()} makes changes to selection. This flag
* tells the {@code internalSelectionChangeHandler} to not send same data
* straight back to server. Said listener sets it back to false when
* handling that event.
*/
private boolean selectionUpdatedFromState;
/**
* {@link #columnsUpdatedFromState} is set to true when
* {@link #updateColumnOrderFromState(List)} is updating the column order
* for the widget. This flag tells the {@link #columnReorderHandler} to not
* send same data straight back to server. After updates, listener sets the
* value back to false.
*/
private boolean columnsUpdatedFromState;
private RpcDataSource dataSource;
private SelectionHandler<JsonObject> internalSelectionChangeHandler = new SelectionHandler<JsonObject>() {
@Override
public void onSelect(SelectionEvent<JsonObject> event) {
if (event.isBatchedSelection()) {
return;
}
if (!selectionUpdatedFromState) {
for (JsonObject row : event.getRemoved()) {
selectedKeys.remove(dataSource.getRowKey(row));
}
for (JsonObject row : event.getAdded()) {
selectedKeys.add(dataSource.getRowKey(row));
}
getRpcProxy(GridServerRpc.class).select(
new ArrayList<String>(selectedKeys));
} else {
selectionUpdatedFromState = false;
}
}
};
private ItemClickHandler itemClickHandler = new ItemClickHandler();
private String lastKnownTheme = null;
private final CustomDetailsGenerator customDetailsGenerator = new CustomDetailsGenerator();
private final DetailsListener detailsListener = new DetailsListener() {
@Override
public void reapplyDetailsVisibility(final int rowIndex,
final JsonObject row) {
if (hasDetailsOpen(row)) {
// Command for opening details row.
ScheduledCommand openDetails = new ScheduledCommand() {
@Override
public void execute() {
// Re-apply to force redraw.
getWidget().setDetailsVisible(rowIndex, false);
getWidget().setDetailsVisible(rowIndex, true);
lazyDetailsScroller.detailsOpened(rowIndex);
}
};
if (initialChange) {
Scheduler.get().scheduleDeferred(openDetails);
} else {
Scheduler.get().scheduleFinally(openDetails);
}
} else {
getWidget().setDetailsVisible(rowIndex, false);
}
}
private boolean hasDetailsOpen(JsonObject row) {
return row.hasKey(GridState.JSONKEY_DETAILS_VISIBLE)
&& row.getString(GridState.JSONKEY_DETAILS_VISIBLE) != null;
}
};
private final LazyDetailsScroller lazyDetailsScroller = new LazyDetailsScroller();
/*
* Initially details need to behave a bit differently to allow some
* escalator magic.
*/
private boolean initialChange;
@Override
@SuppressWarnings("unchecked")
public Grid<JsonObject> getWidget() {
return (Grid<JsonObject>) super.getWidget();
}
@Override
public GridState getState() {
return (GridState) super.getState();
}
@Override
protected void init() {
super.init();
// All scroll RPC calls are executed finally to avoid issues on init
registerRpc(GridClientRpc.class, new GridClientRpc() {
@Override
public void scrollToStart() {
/*
* no need for lazyDetailsScrollAdjuster, because the start is
* always 0, won't change a bit.
*/
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
getWidget().scrollToStart();
}
});
}
@Override
public void scrollToEnd() {
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
getWidget().scrollToEnd();
// Scrolls further if details opens.
lazyDetailsScroller.scrollToRow(dataSource.size() - 1,
ScrollDestination.END);
}
});
}
@Override
public void scrollToRow(final int row,
final ScrollDestination destination) {
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
getWidget().scrollToRow(row, destination);
// Scrolls a bit further if details opens.
lazyDetailsScroller.scrollToRow(row, destination);
}
});
}
@Override
public void recalculateColumnWidths() {
getWidget().recalculateColumnWidths();
}
});
getWidget().addSelectionHandler(internalSelectionChangeHandler);
/* Item click events */
getWidget().addBodyClickHandler(itemClickHandler);
getWidget().addBodyDoubleClickHandler(itemClickHandler);
getWidget().addSortHandler(new SortHandler<JsonObject>() {
@Override
public void sort(SortEvent<JsonObject> event) {
List<SortOrder> order = event.getOrder();
String[] columnIds = new String[order.size()];
SortDirection[] directions = new SortDirection[order.size()];
for (int i = 0; i < order.size(); i++) {
SortOrder sortOrder = order.get(i);
CustomGridColumn column = (CustomGridColumn) sortOrder
.getColumn();
columnIds[i] = column.id;
directions[i] = sortOrder.getDirection();
}
if (!Arrays.equals(columnIds, getState().sortColumns)
|| !Arrays.equals(directions, getState().sortDirs)) {
// Report back to server if changed
getRpcProxy(GridServerRpc.class).sort(columnIds,
directions, event.isUserOriginated());
}
}
});
getWidget().addSelectAllHandler(new SelectAllHandler<JsonObject>() {
@Override
public void onSelectAll(SelectAllEvent<JsonObject> event) {
getRpcProxy(GridServerRpc.class).selectAll();
}
});
getWidget().setEditorHandler(new CustomEditorHandler());
getWidget().addColumnReorderHandler(columnReorderHandler);
getWidget().addColumnVisibilityChangeHandler(
columnVisibilityChangeHandler);
getWidget().setDetailsGenerator(customDetailsGenerator);
getLayoutManager().registerDependency(this, getWidget().getElement());
layout();
}
@Override
public void onStateChanged(final StateChangeEvent stateChangeEvent) {
super.onStateChanged(stateChangeEvent);
initialChange = stateChangeEvent.isInitialStateChange();
// Column updates
if (stateChangeEvent.hasPropertyChanged("columns")) {
// Remove old columns
purgeRemovedColumns();
// Add new columns
for (GridColumnState state : getState().columns) {
if (!columnIdToColumn.containsKey(state.id)) {
addColumnFromStateChangeEvent(state);
}
updateColumnFromStateChangeEvent(state);
}
}
if (stateChangeEvent.hasPropertyChanged("columnOrder")) {
if (orderNeedsUpdate(getState().columnOrder)) {
updateColumnOrderFromState(getState().columnOrder);
}
}
// Header and footer
if (stateChangeEvent.hasPropertyChanged("header")) {
updateHeaderFromState(getState().header);
}
if (stateChangeEvent.hasPropertyChanged("footer")) {
updateFooterFromState(getState().footer);
}
// Selection
if (stateChangeEvent.hasPropertyChanged("selectionMode")) {
onSelectionModeChange();
updateSelectDeselectAllowed();
} else if (stateChangeEvent
.hasPropertyChanged("singleSelectDeselectAllowed")) {
updateSelectDeselectAllowed();
}
if (stateChangeEvent.hasPropertyChanged("selectedKeys")) {
updateSelectionFromState();
}
// Sorting
if (stateChangeEvent.hasPropertyChanged("sortColumns")
|| stateChangeEvent.hasPropertyChanged("sortDirs")) {
onSortStateChange();
}
// Editor
if (stateChangeEvent.hasPropertyChanged("editorEnabled")) {
getWidget().setEditorEnabled(getState().editorEnabled);
}
// Frozen columns
if (stateChangeEvent.hasPropertyChanged("frozenColumnCount")) {
getWidget().setFrozenColumnCount(getState().frozenColumnCount);
}
// Theme features
String activeTheme = getConnection().getUIConnector().getActiveTheme();
if (lastKnownTheme == null) {
lastKnownTheme = activeTheme;
} else if (!lastKnownTheme.equals(activeTheme)) {
getWidget().resetSizesFromDom();
lastKnownTheme = activeTheme;
}
}
private void updateSelectDeselectAllowed() {
SelectionModel<JsonObject> model = getWidget().getSelectionModel();
if (model instanceof SelectionModel.Single<?>) {
((SelectionModel.Single<?>) model)
.setDeselectAllowed(getState().singleSelectDeselectAllowed);
}
}
private void updateColumnOrderFromState(List<String> stateColumnOrder) {
CustomGridColumn[] columns = new CustomGridColumn[stateColumnOrder
.size()];
int i = 0;
for (String id : stateColumnOrder) {
columns[i] = columnIdToColumn.get(id);
i++;
}
columnsUpdatedFromState = true;
getWidget().setColumnOrder(columns);
columnsUpdatedFromState = false;
columnOrder = stateColumnOrder;
}
private boolean orderNeedsUpdate(List<String> stateColumnOrder) {
if (stateColumnOrder.size() == columnOrder.size()) {
for (int i = 0; i < columnOrder.size(); ++i) {
if (!stateColumnOrder.get(i).equals(columnOrder.get(i))) {
return true;
}
}
return false;
}
return true;
}
private void updateHeaderFromState(GridStaticSectionState state) {
getWidget().setHeaderVisible(state.visible);
while (getWidget().getHeaderRowCount() > 0) {
getWidget().removeHeaderRow(0);
}
for (RowState rowState : state.rows) {
HeaderRow row = getWidget().appendHeaderRow();
if (rowState.defaultRow) {
getWidget().setDefaultHeaderRow(row);
}
for (CellState cellState : rowState.cells) {
CustomGridColumn column = columnIdToColumn
.get(cellState.columnId);
updateHeaderCellFromState(row.getCell(column), cellState);
}
for (Set<String> group : rowState.cellGroups.keySet()) {
Grid.Column<?, ?>[] columns = new Grid.Column<?, ?>[group
.size()];
CellState cellState = rowState.cellGroups.get(group);
int i = 0;
for (String columnId : group) {
columns[i] = columnIdToColumn.get(columnId);
i++;
}
// Set state to be the same as first in group.
updateHeaderCellFromState(row.join(columns), cellState);
}
row.setStyleName(rowState.styleName);
}
}
private void updateHeaderCellFromState(HeaderCell cell, CellState cellState) {
switch (cellState.type) {
case TEXT:
cell.setText(cellState.text);
break;
case HTML:
cell.setHtml(cellState.html);
break;
case WIDGET:
ComponentConnector connector = (ComponentConnector) cellState.connector;
cell.setWidget(connector.getWidget());
break;
default:
throw new IllegalStateException("unexpected cell type: "
+ cellState.type);
}
cell.setStyleName(cellState.styleName);
}
private void updateFooterFromState(GridStaticSectionState state) {
getWidget().setFooterVisible(state.visible);
while (getWidget().getFooterRowCount() > 0) {
getWidget().removeFooterRow(0);
}
for (RowState rowState : state.rows) {
FooterRow row = getWidget().appendFooterRow();
for (CellState cellState : rowState.cells) {
CustomGridColumn column = columnIdToColumn
.get(cellState.columnId);
updateFooterCellFromState(row.getCell(column), cellState);
}
for (Set<String> group : rowState.cellGroups.keySet()) {
Grid.Column<?, ?>[] columns = new Grid.Column<?, ?>[group
.size()];
CellState cellState = rowState.cellGroups.get(group);
int i = 0;
for (String columnId : group) {
columns[i] = columnIdToColumn.get(columnId);
i++;
}
// Set state to be the same as first in group.
updateFooterCellFromState(row.join(columns), cellState);
}
row.setStyleName(rowState.styleName);
}
}
private void updateFooterCellFromState(FooterCell cell, CellState cellState) {
switch (cellState.type) {
case TEXT:
cell.setText(cellState.text);
break;
case HTML:
cell.setHtml(cellState.html);
break;
case WIDGET:
ComponentConnector connector = (ComponentConnector) cellState.connector;
cell.setWidget(connector.getWidget());
break;
default:
throw new IllegalStateException("unexpected cell type: "
+ cellState.type);
}
cell.setStyleName(cellState.styleName);
}
/**
* Updates a column from a state change event.
*
* @param columnIndex
* The index of the column to update
*/
private void updateColumnFromStateChangeEvent(GridColumnState columnState) {
CustomGridColumn column = columnIdToColumn.get(columnState.id);
columnsUpdatedFromState = true;
updateColumnFromState(column, columnState);
columnsUpdatedFromState = false;
}
/**
* Adds a new column to the grid widget from a state change event
*
* @param columnIndex
* The index of the column, according to how it
*/
private void addColumnFromStateChangeEvent(GridColumnState state) {
@SuppressWarnings("unchecked")
CustomGridColumn column = new CustomGridColumn(state.id,
((AbstractRendererConnector<Object>) state.rendererConnector));
columnIdToColumn.put(state.id, column);
/*
* Add column to grid. Reordering is handled as a separate problem.
*/
getWidget().addColumn(column);
columnOrder.add(state.id);
}
/**
* If we have a selection column renderer, we need to offset the index by
* one when referring to the column index in the widget.
*/
private int getWidgetColumnIndex(final int columnIndex) {
Renderer<Boolean> selectionColumnRenderer = getWidget()
.getSelectionModel().getSelectionColumnRenderer();
int widgetColumnIndex = columnIndex;
if (selectionColumnRenderer != null) {
widgetColumnIndex++;
}
return widgetColumnIndex;
}
/**
* Updates the column values from a state
*
* @param column
* The column to update
* @param state
* The state to get the data from
*/
@SuppressWarnings("unchecked")
private static void updateColumnFromState(CustomGridColumn column,
GridColumnState state) {
column.setWidth(state.width);
column.setMinimumWidth(state.minWidth);
column.setMaximumWidth(state.maxWidth);
column.setExpandRatio(state.expandRatio);
assert state.rendererConnector instanceof AbstractRendererConnector : "GridColumnState.rendererConnector is invalid (not subclass of AbstractRendererConnector)";
column.setRenderer((AbstractRendererConnector<Object>) state.rendererConnector);
column.setSortable(state.sortable);
column.setHeaderCaption(state.headerCaption);
column.setHidden(state.hidden);
column.setHidable(state.hidable);
column.setHidingToggleCaption(state.hidingToggleCaption);
column.setEditable(state.editable);
column.setEditorConnector((AbstractFieldConnector) state.editorConnector);
}
/**
* Removes any orphan columns that has been removed from the state from the
* grid
*/
private void purgeRemovedColumns() {
// Get columns still registered in the state
Set<String> columnsInState = new HashSet<String>();
for (GridColumnState columnState : getState().columns) {
columnsInState.add(columnState.id);
}
// Remove column no longer in state
Iterator<String> columnIdIterator = columnIdToColumn.keySet()
.iterator();
while (columnIdIterator.hasNext()) {
String id = columnIdIterator.next();
if (!columnsInState.contains(id)) {
CustomGridColumn column = columnIdToColumn.get(id);
columnIdIterator.remove();
getWidget().removeColumn(column);
columnOrder.remove(id);
}
}
}
public void setDataSource(RpcDataSource dataSource) {
this.dataSource = dataSource;
getWidget().setDataSource(this.dataSource);
}
private void onSelectionModeChange() {
SharedSelectionMode mode = getState().selectionMode;
if (mode == null) {
getLogger().fine("ignored mode change");
return;
}
AbstractRowHandleSelectionModel<JsonObject> model = createSelectionModel(mode);
if (selectionModel == null
|| !model.getClass().equals(selectionModel.getClass())) {
selectionModel = model;
getWidget().setSelectionModel(model);
selectedKeys.clear();
}
}
@OnStateChange("hasCellStyleGenerator")
private void onCellStyleGeneratorChange() {
if (getState().hasCellStyleGenerator) {
getWidget().setCellStyleGenerator(new CustomCellStyleGenerator());
} else {
getWidget().setCellStyleGenerator(null);
}
}
@OnStateChange("hasRowStyleGenerator")
private void onRowStyleGeneratorChange() {
if (getState().hasRowStyleGenerator) {
getWidget().setRowStyleGenerator(new CustomRowStyleGenerator());
} else {
getWidget().setRowStyleGenerator(null);
}
}
private void updateSelectionFromState() {
boolean changed = false;
List<String> stateKeys = getState().selectedKeys;
// find new deselections
for (String key : selectedKeys) {
if (!stateKeys.contains(key)) {
changed = true;
deselectByHandle(dataSource.getHandleByKey(key));
}
}
// find new selections
for (String key : stateKeys) {
if (!selectedKeys.contains(key)) {
changed = true;
selectByHandle(dataSource.getHandleByKey(key));
}
}
/*
* A defensive copy in case the collection in the state is mutated
* instead of re-assigned.
*/
selectedKeys = new LinkedHashSet<String>(stateKeys);
/*
* We need to fire this event so that Grid is able to re-render the
* selection changes (if applicable).
*/
if (changed) {
// At least for now there's no way to send the selected and/or
// deselected row data. Some data is only stored as keys
selectionUpdatedFromState = true;
getWidget().fireEvent(
new SelectionEvent<JsonObject>(getWidget(),
(List<JsonObject>) null, null, false));
}
}
private void onSortStateChange() {
List<SortOrder> sortOrder = new ArrayList<SortOrder>();
String[] sortColumns = getState().sortColumns;
SortDirection[] sortDirs = getState().sortDirs;
for (int i = 0; i < sortColumns.length; i++) {
sortOrder.add(new SortOrder(columnIdToColumn.get(sortColumns[i]),
sortDirs[i]));
}
getWidget().setSortOrder(sortOrder);
}
private Logger getLogger() {
return Logger.getLogger(getClass().getName());
}
@SuppressWarnings("static-method")
private AbstractRowHandleSelectionModel<JsonObject> createSelectionModel(
SharedSelectionMode mode) {
switch (mode) {
case SINGLE:
return new SelectionModelSingle<JsonObject>();
case MULTI:
return new SelectionModelMulti<JsonObject>();
case NONE:
return new SelectionModelNone<JsonObject>();
default:
throw new IllegalStateException("unexpected mode value: " + mode);
}
}
/**
* A workaround method for accessing the protected method
* {@code AbstractRowHandleSelectionModel.selectByHandle}
*/
private native void selectByHandle(RowHandle<JsonObject> handle)
/*-{
var model = [email protected]::selectionModel;
model.@com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel::selectByHandle(*)(handle);
}-*/;
/**
* A workaround method for accessing the protected method
* {@code AbstractRowHandleSelectionModel.deselectByHandle}
*/
private native void deselectByHandle(RowHandle<JsonObject> handle)
/*-{
var model = [email protected]::selectionModel;
model.@com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel::deselectByHandle(*)(handle);
}-*/;
/**
* Gets the row key for a row object.
*
* @param row
* the row object
* @return the key for the given row
*/
public String getRowKey(JsonObject row) {
final Object key = dataSource.getRowKey(row);
assert key instanceof String : "Internal key was not a String but a "
+ key.getClass().getSimpleName() + " (" + key + ")";
return (String) key;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.client.HasComponentsConnector#updateCaption(com.vaadin.client
* .ComponentConnector)
*/
@Override
public void updateCaption(ComponentConnector connector) {
// TODO Auto-generated method stub
}
@Override
public void onConnectorHierarchyChange(
ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent) {
customDetailsGenerator.updateConnectorHierarchy(getChildren());
}
public String getColumnId(Grid.Column<?, ?> column) {
if (column instanceof CustomGridColumn) {
return ((CustomGridColumn) column).id;
}
return null;
}
@Override
public void layout() {
getWidget().onResize();
}
@Override
public boolean isWorkPending() {
return lazyDetailsScroller.isWorkPending();
}
/**
* Gets the listener used by this connector for tracking when row detail
* visibility changes.
*
* @since 7.5.0
* @return the used details listener
*/
public DetailsListener getDetailsListener() {
return detailsListener;
}
}
| client/src/com/vaadin/client/connectors/GridConnector.java | /*
* Copyright 2000-2014 Vaadin 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.vaadin.client.connectors;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.logging.Logger;
import com.google.gwt.core.client.Scheduler;
import com.google.gwt.core.client.Scheduler.ScheduledCommand;
import com.google.gwt.dom.client.NativeEvent;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.ui.Widget;
import com.vaadin.client.ComponentConnector;
import com.vaadin.client.ConnectorHierarchyChangeEvent;
import com.vaadin.client.DeferredWorker;
import com.vaadin.client.MouseEventDetailsBuilder;
import com.vaadin.client.ServerConnector;
import com.vaadin.client.annotations.OnStateChange;
import com.vaadin.client.communication.StateChangeEvent;
import com.vaadin.client.connectors.RpcDataSourceConnector.DetailsListener;
import com.vaadin.client.connectors.RpcDataSourceConnector.RpcDataSource;
import com.vaadin.client.data.DataSource.RowHandle;
import com.vaadin.client.renderers.Renderer;
import com.vaadin.client.ui.AbstractFieldConnector;
import com.vaadin.client.ui.AbstractHasComponentsConnector;
import com.vaadin.client.ui.SimpleManagedLayout;
import com.vaadin.client.widget.grid.CellReference;
import com.vaadin.client.widget.grid.CellStyleGenerator;
import com.vaadin.client.widget.grid.DetailsGenerator;
import com.vaadin.client.widget.grid.EditorHandler;
import com.vaadin.client.widget.grid.RowReference;
import com.vaadin.client.widget.grid.RowStyleGenerator;
import com.vaadin.client.widget.grid.events.BodyClickHandler;
import com.vaadin.client.widget.grid.events.BodyDoubleClickHandler;
import com.vaadin.client.widget.grid.events.ColumnReorderEvent;
import com.vaadin.client.widget.grid.events.ColumnReorderHandler;
import com.vaadin.client.widget.grid.events.ColumnVisibilityChangeEvent;
import com.vaadin.client.widget.grid.events.ColumnVisibilityChangeHandler;
import com.vaadin.client.widget.grid.events.GridClickEvent;
import com.vaadin.client.widget.grid.events.GridDoubleClickEvent;
import com.vaadin.client.widget.grid.events.SelectAllEvent;
import com.vaadin.client.widget.grid.events.SelectAllHandler;
import com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel;
import com.vaadin.client.widget.grid.selection.SelectionEvent;
import com.vaadin.client.widget.grid.selection.SelectionHandler;
import com.vaadin.client.widget.grid.selection.SelectionModel;
import com.vaadin.client.widget.grid.selection.SelectionModelMulti;
import com.vaadin.client.widget.grid.selection.SelectionModelNone;
import com.vaadin.client.widget.grid.selection.SelectionModelSingle;
import com.vaadin.client.widget.grid.sort.SortEvent;
import com.vaadin.client.widget.grid.sort.SortHandler;
import com.vaadin.client.widget.grid.sort.SortOrder;
import com.vaadin.client.widgets.Grid;
import com.vaadin.client.widgets.Grid.Column;
import com.vaadin.client.widgets.Grid.FooterCell;
import com.vaadin.client.widgets.Grid.FooterRow;
import com.vaadin.client.widgets.Grid.HeaderCell;
import com.vaadin.client.widgets.Grid.HeaderRow;
import com.vaadin.shared.data.sort.SortDirection;
import com.vaadin.shared.ui.Connect;
import com.vaadin.shared.ui.grid.EditorClientRpc;
import com.vaadin.shared.ui.grid.EditorServerRpc;
import com.vaadin.shared.ui.grid.GridClientRpc;
import com.vaadin.shared.ui.grid.GridColumnState;
import com.vaadin.shared.ui.grid.GridConstants;
import com.vaadin.shared.ui.grid.GridServerRpc;
import com.vaadin.shared.ui.grid.GridState;
import com.vaadin.shared.ui.grid.GridState.SharedSelectionMode;
import com.vaadin.shared.ui.grid.GridStaticSectionState;
import com.vaadin.shared.ui.grid.GridStaticSectionState.CellState;
import com.vaadin.shared.ui.grid.GridStaticSectionState.RowState;
import com.vaadin.shared.ui.grid.ScrollDestination;
import elemental.json.JsonObject;
import elemental.json.JsonValue;
/**
* Connects the client side {@link Grid} widget with the server side
* {@link com.vaadin.ui.components.grid.Grid} component.
* <p>
* The Grid is typed to JSONObject. The structure of the JSONObject is described
* at {@link com.vaadin.shared.data.DataProviderRpc#setRowData(int, List)
* DataProviderRpc.setRowData(int, List)}.
*
* @since 7.4
* @author Vaadin Ltd
*/
@Connect(com.vaadin.ui.Grid.class)
public class GridConnector extends AbstractHasComponentsConnector implements
SimpleManagedLayout, DeferredWorker {
private static final class CustomCellStyleGenerator implements
CellStyleGenerator<JsonObject> {
@Override
public String getStyle(CellReference<JsonObject> cellReference) {
JsonObject row = cellReference.getRow();
if (!row.hasKey(GridState.JSONKEY_CELLSTYLES)) {
return null;
}
Column<?, JsonObject> column = cellReference.getColumn();
if (!(column instanceof CustomGridColumn)) {
// Selection checkbox column
return null;
}
CustomGridColumn c = (CustomGridColumn) column;
JsonObject cellStylesObject = row
.getObject(GridState.JSONKEY_CELLSTYLES);
assert cellStylesObject != null;
if (cellStylesObject.hasKey(c.id)) {
return cellStylesObject.getString(c.id);
} else {
return null;
}
}
}
private static final class CustomRowStyleGenerator implements
RowStyleGenerator<JsonObject> {
@Override
public String getStyle(RowReference<JsonObject> rowReference) {
JsonObject row = rowReference.getRow();
if (row.hasKey(GridState.JSONKEY_ROWSTYLE)) {
return row.getString(GridState.JSONKEY_ROWSTYLE);
} else {
return null;
}
}
}
/**
* Custom implementation of the custom grid column using a JSONObject to
* represent the cell value and String as a column type.
*/
private class CustomGridColumn extends Grid.Column<Object, JsonObject> {
private final String id;
private AbstractRendererConnector<Object> rendererConnector;
private AbstractFieldConnector editorConnector;
public CustomGridColumn(String id,
AbstractRendererConnector<Object> rendererConnector) {
super(rendererConnector.getRenderer());
this.rendererConnector = rendererConnector;
this.id = id;
}
/**
* Sets a new renderer for this column object
*
* @param rendererConnector
* a renderer connector object
*/
public void setRenderer(
AbstractRendererConnector<Object> rendererConnector) {
setRenderer(rendererConnector.getRenderer());
this.rendererConnector = rendererConnector;
}
@Override
public Object getValue(final JsonObject obj) {
final JsonObject rowData = obj.getObject(GridState.JSONKEY_DATA);
if (rowData.hasKey(id)) {
final JsonValue columnValue = rowData.get(id);
return rendererConnector.decode(columnValue);
}
return null;
}
private AbstractFieldConnector getEditorConnector() {
return editorConnector;
}
private void setEditorConnector(AbstractFieldConnector editorConnector) {
this.editorConnector = editorConnector;
}
}
/*
* An editor handler using Vaadin RPC to manage the editor state.
*/
private class CustomEditorHandler implements EditorHandler<JsonObject> {
private EditorServerRpc rpc = getRpcProxy(EditorServerRpc.class);
private EditorRequest<JsonObject> currentRequest = null;
private boolean serverInitiated = false;
public CustomEditorHandler() {
registerRpc(EditorClientRpc.class, new EditorClientRpc() {
@Override
public void bind(final int rowIndex) {
// call this finally to avoid issues with editing on init
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
GridConnector.this.getWidget().editRow(rowIndex);
}
});
}
@Override
public void cancel(int rowIndex) {
serverInitiated = true;
GridConnector.this.getWidget().cancelEditor();
}
@Override
public void confirmBind(final boolean bindSucceeded) {
endRequest(bindSucceeded, null, null);
}
@Override
public void confirmSave(boolean saveSucceeded,
String errorMessage, List<String> errorColumnsIds) {
endRequest(saveSucceeded, errorMessage, errorColumnsIds);
}
});
}
@Override
public void bind(EditorRequest<JsonObject> request) {
startRequest(request);
rpc.bind(request.getRowIndex());
}
@Override
public void save(EditorRequest<JsonObject> request) {
startRequest(request);
rpc.save(request.getRowIndex());
}
@Override
public void cancel(EditorRequest<JsonObject> request) {
if (!handleServerInitiated(request)) {
// No startRequest as we don't get (or need)
// a confirmation from the server
rpc.cancel(request.getRowIndex());
}
}
@Override
public Widget getWidget(Grid.Column<?, JsonObject> column) {
assert column != null;
if (column instanceof CustomGridColumn) {
AbstractFieldConnector c = ((CustomGridColumn) column)
.getEditorConnector();
return c != null ? c.getWidget() : null;
} else {
throw new IllegalStateException("Unexpected column type: "
+ column.getClass().getName());
}
}
/**
* Used to handle the case where the editor calls us because it was
* invoked by the server via RPC and not by the client. In that case,
* the request can be simply synchronously completed.
*
* @param request
* the request object
* @return true if the request was originally triggered by the server,
* false otherwise
*/
private boolean handleServerInitiated(EditorRequest<?> request) {
assert request != null : "Cannot handle null request";
assert currentRequest == null : "Earlier request not yet finished";
if (serverInitiated) {
serverInitiated = false;
request.success();
return true;
} else {
return false;
}
}
private void startRequest(EditorRequest<JsonObject> request) {
assert currentRequest == null : "Earlier request not yet finished";
currentRequest = request;
}
private void endRequest(boolean succeeded, String errorMessage,
List<String> errorColumnsIds) {
assert currentRequest != null : "Current request was null";
/*
* Clear current request first to ensure the state is valid if
* another request is made in the callback.
*/
EditorRequest<JsonObject> request = currentRequest;
currentRequest = null;
if (succeeded) {
request.success();
} else {
Collection<Column<?, JsonObject>> errorColumns;
if (errorColumnsIds != null) {
errorColumns = new ArrayList<Grid.Column<?, JsonObject>>();
for (String colId : errorColumnsIds) {
errorColumns.add(columnIdToColumn.get(colId));
}
} else {
errorColumns = null;
}
request.failure(errorMessage, errorColumns);
}
}
}
private class ItemClickHandler implements BodyClickHandler,
BodyDoubleClickHandler {
@Override
public void onClick(GridClickEvent event) {
if (hasEventListener(GridConstants.ITEM_CLICK_EVENT_ID)) {
fireItemClick(event.getTargetCell(), event.getNativeEvent());
}
}
@Override
public void onDoubleClick(GridDoubleClickEvent event) {
if (hasEventListener(GridConstants.ITEM_CLICK_EVENT_ID)) {
fireItemClick(event.getTargetCell(), event.getNativeEvent());
}
}
private void fireItemClick(CellReference<?> cell, NativeEvent mouseEvent) {
String rowKey = getRowKey((JsonObject) cell.getRow());
String columnId = getColumnId(cell.getColumn());
getRpcProxy(GridServerRpc.class)
.itemClick(
rowKey,
columnId,
MouseEventDetailsBuilder
.buildMouseEventDetails(mouseEvent));
}
}
private ColumnReorderHandler<JsonObject> columnReorderHandler = new ColumnReorderHandler<JsonObject>() {
@Override
public void onColumnReorder(ColumnReorderEvent<JsonObject> event) {
if (!columnsUpdatedFromState) {
List<Column<?, JsonObject>> columns = getWidget().getColumns();
final List<String> newColumnOrder = new ArrayList<String>();
for (Column<?, JsonObject> column : columns) {
if (column instanceof CustomGridColumn) {
newColumnOrder.add(((CustomGridColumn) column).id);
} // the other case would be the multi selection column
}
getRpcProxy(GridServerRpc.class).columnsReordered(
newColumnOrder, columnOrder);
columnOrder = newColumnOrder;
getState().columnOrder = newColumnOrder;
}
}
};
private ColumnVisibilityChangeHandler<JsonObject> columnVisibilityChangeHandler = new ColumnVisibilityChangeHandler<JsonObject>() {
@Override
public void onVisibilityChange(
ColumnVisibilityChangeEvent<JsonObject> event) {
if (!columnsUpdatedFromState) {
Column<?, JsonObject> column = event.getColumn();
if (column instanceof CustomGridColumn) {
getRpcProxy(GridServerRpc.class).columnVisibilityChanged(
((CustomGridColumn) column).id, column.isHidden(),
event.isUserOriginated());
for (GridColumnState state : getState().columns) {
if (state.id.equals(((CustomGridColumn) column).id)) {
state.hidden = event.isHidden();
break;
}
}
} else {
getLogger().warning(
"Visibility changed for a unknown column type in Grid: "
+ column.toString() + ", type "
+ column.getClass());
}
}
}
};
private class CustomDetailsGenerator implements DetailsGenerator {
private final Map<String, ComponentConnector> idToDetailsMap = new HashMap<String, ComponentConnector>();
private final Map<String, Integer> idToRowIndex = new HashMap<String, Integer>();
@Override
public Widget getDetails(int rowIndex) {
JsonObject row = getWidget().getDataSource().getRow(rowIndex);
if (!row.hasKey(GridState.JSONKEY_DETAILS_VISIBLE)
|| row.getString(GridState.JSONKEY_DETAILS_VISIBLE)
.isEmpty()) {
return null;
}
String id = row.getString(GridState.JSONKEY_DETAILS_VISIBLE);
ComponentConnector componentConnector = idToDetailsMap.get(id);
idToRowIndex.put(id, rowIndex);
return componentConnector.getWidget();
}
public void updateConnectorHierarchy(List<ServerConnector> children) {
Set<String> connectorIds = new HashSet<String>();
for (ServerConnector child : children) {
if (child instanceof ComponentConnector) {
connectorIds.add(child.getConnectorId());
idToDetailsMap.put(child.getConnectorId(),
(ComponentConnector) child);
}
}
Set<String> removedDetails = new HashSet<String>();
for (Entry<String, ComponentConnector> entry : idToDetailsMap
.entrySet()) {
ComponentConnector connector = entry.getValue();
String id = connector.getConnectorId();
if (!connectorIds.contains(id)) {
removedDetails.add(entry.getKey());
if (idToRowIndex.containsKey(id)) {
getWidget().setDetailsVisible(idToRowIndex.get(id),
false);
}
}
}
for (String id : removedDetails) {
idToDetailsMap.remove(id);
idToRowIndex.remove(id);
}
}
}
/**
* Class for handling scrolling issues with open details.
*
* @since
* @author Vaadin Ltd
*/
private class LazyDetailsScroller implements DeferredWorker {
/* Timer value tested to work in our test cluster with slow IE8s. */
private static final int DISABLE_LAZY_SCROLL_TIMEOUT = 1500;
/*
* Cancels details opening scroll after timeout. Avoids any unexpected
* scrolls via details opening.
*/
private Timer disableScroller = new Timer() {
@Override
public void run() {
targetRow = -1;
}
};
private Integer targetRow = -1;
private ScrollDestination destination = null;
public void scrollToRow(Integer row, ScrollDestination dest) {
targetRow = row;
destination = dest;
disableScroller.schedule(DISABLE_LAZY_SCROLL_TIMEOUT);
}
/**
* Inform LazyDetailsScroller that a details row has opened on a row.
*
* @since
* @param rowIndex
* index of row with details now open
*/
public void detailsOpened(int rowIndex) {
if (targetRow == rowIndex) {
getWidget().scrollToRow(targetRow, destination);
disableScroller.run();
}
}
@Override
public boolean isWorkPending() {
return disableScroller.isRunning();
}
}
/**
* Maps a generated column id to a grid column instance
*/
private Map<String, CustomGridColumn> columnIdToColumn = new HashMap<String, CustomGridColumn>();
private AbstractRowHandleSelectionModel<JsonObject> selectionModel;
private Set<String> selectedKeys = new LinkedHashSet<String>();
private List<String> columnOrder = new ArrayList<String>();
/**
* {@link #selectionUpdatedFromState} is set to true when
* {@link #updateSelectionFromState()} makes changes to selection. This flag
* tells the {@code internalSelectionChangeHandler} to not send same data
* straight back to server. Said listener sets it back to false when
* handling that event.
*/
private boolean selectionUpdatedFromState;
/**
* {@link #columnsUpdatedFromState} is set to true when
* {@link #updateColumnOrderFromState(List)} is updating the column order
* for the widget. This flag tells the {@link #columnReorderHandler} to not
* send same data straight back to server. After updates, listener sets the
* value back to false.
*/
private boolean columnsUpdatedFromState;
private RpcDataSource dataSource;
private SelectionHandler<JsonObject> internalSelectionChangeHandler = new SelectionHandler<JsonObject>() {
@Override
public void onSelect(SelectionEvent<JsonObject> event) {
if (event.isBatchedSelection()) {
return;
}
if (!selectionUpdatedFromState) {
for (JsonObject row : event.getRemoved()) {
selectedKeys.remove(dataSource.getRowKey(row));
}
for (JsonObject row : event.getAdded()) {
selectedKeys.add(dataSource.getRowKey(row));
}
getRpcProxy(GridServerRpc.class).select(
new ArrayList<String>(selectedKeys));
} else {
selectionUpdatedFromState = false;
}
}
};
private ItemClickHandler itemClickHandler = new ItemClickHandler();
private String lastKnownTheme = null;
private final CustomDetailsGenerator customDetailsGenerator = new CustomDetailsGenerator();
private final DetailsListener detailsListener = new DetailsListener() {
@Override
public void reapplyDetailsVisibility(final int rowIndex,
final JsonObject row) {
if (hasDetailsOpen(row)) {
// Command for opening details row.
ScheduledCommand openDetails = new ScheduledCommand() {
@Override
public void execute() {
// Re-apply to force redraw.
getWidget().setDetailsVisible(rowIndex, false);
getWidget().setDetailsVisible(rowIndex, true);
lazyDetailsScroller.detailsOpened(rowIndex);
}
};
if (initialChange) {
Scheduler.get().scheduleDeferred(openDetails);
} else {
Scheduler.get().scheduleFinally(openDetails);
}
} else {
getWidget().setDetailsVisible(rowIndex, false);
}
}
private boolean hasDetailsOpen(JsonObject row) {
return row.hasKey(GridState.JSONKEY_DETAILS_VISIBLE)
&& row.getString(GridState.JSONKEY_DETAILS_VISIBLE) != null;
}
};
private final LazyDetailsScroller lazyDetailsScroller = new LazyDetailsScroller();
/*
* Initially details need to behave a bit differently to allow some
* escalator magic.
*/
private boolean initialChange;
@Override
@SuppressWarnings("unchecked")
public Grid<JsonObject> getWidget() {
return (Grid<JsonObject>) super.getWidget();
}
@Override
public GridState getState() {
return (GridState) super.getState();
}
@Override
protected void init() {
super.init();
// All scroll RPC calls are executed finally to avoid issues on init
registerRpc(GridClientRpc.class, new GridClientRpc() {
@Override
public void scrollToStart() {
/*
* no need for lazyDetailsScrollAdjuster, because the start is
* always 0, won't change a bit.
*/
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
getWidget().scrollToStart();
}
});
}
@Override
public void scrollToEnd() {
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
getWidget().scrollToEnd();
// Scrolls further if details opens.
lazyDetailsScroller.scrollToRow(dataSource.size() - 1,
ScrollDestination.END);
}
});
}
@Override
public void scrollToRow(final int row,
final ScrollDestination destination) {
Scheduler.get().scheduleFinally(new ScheduledCommand() {
@Override
public void execute() {
getWidget().scrollToRow(row, destination);
// Scrolls a bit further if details opens.
lazyDetailsScroller.scrollToRow(row, destination);
}
});
}
@Override
public void recalculateColumnWidths() {
getWidget().recalculateColumnWidths();
}
});
getWidget().addSelectionHandler(internalSelectionChangeHandler);
/* Item click events */
getWidget().addBodyClickHandler(itemClickHandler);
getWidget().addBodyDoubleClickHandler(itemClickHandler);
getWidget().addSortHandler(new SortHandler<JsonObject>() {
@Override
public void sort(SortEvent<JsonObject> event) {
List<SortOrder> order = event.getOrder();
String[] columnIds = new String[order.size()];
SortDirection[] directions = new SortDirection[order.size()];
for (int i = 0; i < order.size(); i++) {
SortOrder sortOrder = order.get(i);
CustomGridColumn column = (CustomGridColumn) sortOrder
.getColumn();
columnIds[i] = column.id;
directions[i] = sortOrder.getDirection();
}
if (!Arrays.equals(columnIds, getState().sortColumns)
|| !Arrays.equals(directions, getState().sortDirs)) {
// Report back to server if changed
getRpcProxy(GridServerRpc.class).sort(columnIds,
directions, event.isUserOriginated());
}
}
});
getWidget().addSelectAllHandler(new SelectAllHandler<JsonObject>() {
@Override
public void onSelectAll(SelectAllEvent<JsonObject> event) {
getRpcProxy(GridServerRpc.class).selectAll();
}
});
getWidget().setEditorHandler(new CustomEditorHandler());
getWidget().addColumnReorderHandler(columnReorderHandler);
getWidget().addColumnVisibilityChangeHandler(
columnVisibilityChangeHandler);
getWidget().setDetailsGenerator(customDetailsGenerator);
getLayoutManager().registerDependency(this, getWidget().getElement());
layout();
}
@Override
public void onStateChanged(final StateChangeEvent stateChangeEvent) {
super.onStateChanged(stateChangeEvent);
initialChange = stateChangeEvent.isInitialStateChange();
// Column updates
if (stateChangeEvent.hasPropertyChanged("columns")) {
// Remove old columns
purgeRemovedColumns();
// Add new columns
for (GridColumnState state : getState().columns) {
if (!columnIdToColumn.containsKey(state.id)) {
addColumnFromStateChangeEvent(state);
}
updateColumnFromStateChangeEvent(state);
}
}
if (stateChangeEvent.hasPropertyChanged("columnOrder")) {
if (orderNeedsUpdate(getState().columnOrder)) {
updateColumnOrderFromState(getState().columnOrder);
}
}
// Header and footer
if (stateChangeEvent.hasPropertyChanged("header")) {
updateHeaderFromState(getState().header);
}
if (stateChangeEvent.hasPropertyChanged("footer")) {
updateFooterFromState(getState().footer);
}
// Selection
if (stateChangeEvent.hasPropertyChanged("selectionMode")) {
onSelectionModeChange();
updateSelectDeselectAllowed();
} else if (stateChangeEvent
.hasPropertyChanged("singleSelectDeselectAllowed")) {
updateSelectDeselectAllowed();
}
if (stateChangeEvent.hasPropertyChanged("selectedKeys")) {
updateSelectionFromState();
}
// Sorting
if (stateChangeEvent.hasPropertyChanged("sortColumns")
|| stateChangeEvent.hasPropertyChanged("sortDirs")) {
onSortStateChange();
}
// Editor
if (stateChangeEvent.hasPropertyChanged("editorEnabled")) {
getWidget().setEditorEnabled(getState().editorEnabled);
}
// Frozen columns
if (stateChangeEvent.hasPropertyChanged("frozenColumnCount")) {
getWidget().setFrozenColumnCount(getState().frozenColumnCount);
}
// Theme features
String activeTheme = getConnection().getUIConnector().getActiveTheme();
if (lastKnownTheme == null) {
lastKnownTheme = activeTheme;
} else if (!lastKnownTheme.equals(activeTheme)) {
getWidget().resetSizesFromDom();
lastKnownTheme = activeTheme;
}
}
private void updateSelectDeselectAllowed() {
SelectionModel<JsonObject> model = getWidget().getSelectionModel();
if (model instanceof SelectionModel.Single<?>) {
((SelectionModel.Single<?>) model)
.setDeselectAllowed(getState().singleSelectDeselectAllowed);
}
}
private void updateColumnOrderFromState(List<String> stateColumnOrder) {
CustomGridColumn[] columns = new CustomGridColumn[stateColumnOrder
.size()];
int i = 0;
for (String id : stateColumnOrder) {
columns[i] = columnIdToColumn.get(id);
i++;
}
columnsUpdatedFromState = true;
getWidget().setColumnOrder(columns);
columnsUpdatedFromState = false;
columnOrder = stateColumnOrder;
}
private boolean orderNeedsUpdate(List<String> stateColumnOrder) {
if (stateColumnOrder.size() == columnOrder.size()) {
for (int i = 0; i < columnOrder.size(); ++i) {
if (!stateColumnOrder.get(i).equals(columnOrder.get(i))) {
return true;
}
}
return false;
}
return true;
}
private void updateHeaderFromState(GridStaticSectionState state) {
getWidget().setHeaderVisible(state.visible);
while (getWidget().getHeaderRowCount() > 0) {
getWidget().removeHeaderRow(0);
}
for (RowState rowState : state.rows) {
HeaderRow row = getWidget().appendHeaderRow();
if (rowState.defaultRow) {
getWidget().setDefaultHeaderRow(row);
}
for (CellState cellState : rowState.cells) {
CustomGridColumn column = columnIdToColumn
.get(cellState.columnId);
updateHeaderCellFromState(row.getCell(column), cellState);
}
for (Set<String> group : rowState.cellGroups.keySet()) {
Grid.Column<?, ?>[] columns = new Grid.Column<?, ?>[group
.size()];
CellState cellState = rowState.cellGroups.get(group);
int i = 0;
for (String columnId : group) {
columns[i] = columnIdToColumn.get(columnId);
i++;
}
// Set state to be the same as first in group.
updateHeaderCellFromState(row.join(columns), cellState);
}
row.setStyleName(rowState.styleName);
}
}
private void updateHeaderCellFromState(HeaderCell cell, CellState cellState) {
switch (cellState.type) {
case TEXT:
cell.setText(cellState.text);
break;
case HTML:
cell.setHtml(cellState.html);
break;
case WIDGET:
ComponentConnector connector = (ComponentConnector) cellState.connector;
cell.setWidget(connector.getWidget());
break;
default:
throw new IllegalStateException("unexpected cell type: "
+ cellState.type);
}
cell.setStyleName(cellState.styleName);
}
private void updateFooterFromState(GridStaticSectionState state) {
getWidget().setFooterVisible(state.visible);
while (getWidget().getFooterRowCount() > 0) {
getWidget().removeFooterRow(0);
}
for (RowState rowState : state.rows) {
FooterRow row = getWidget().appendFooterRow();
for (CellState cellState : rowState.cells) {
CustomGridColumn column = columnIdToColumn
.get(cellState.columnId);
updateFooterCellFromState(row.getCell(column), cellState);
}
for (Set<String> group : rowState.cellGroups.keySet()) {
Grid.Column<?, ?>[] columns = new Grid.Column<?, ?>[group
.size()];
CellState cellState = rowState.cellGroups.get(group);
int i = 0;
for (String columnId : group) {
columns[i] = columnIdToColumn.get(columnId);
i++;
}
// Set state to be the same as first in group.
updateFooterCellFromState(row.join(columns), cellState);
}
row.setStyleName(rowState.styleName);
}
}
private void updateFooterCellFromState(FooterCell cell, CellState cellState) {
switch (cellState.type) {
case TEXT:
cell.setText(cellState.text);
break;
case HTML:
cell.setHtml(cellState.html);
break;
case WIDGET:
ComponentConnector connector = (ComponentConnector) cellState.connector;
cell.setWidget(connector.getWidget());
break;
default:
throw new IllegalStateException("unexpected cell type: "
+ cellState.type);
}
cell.setStyleName(cellState.styleName);
}
/**
* Updates a column from a state change event.
*
* @param columnIndex
* The index of the column to update
*/
private void updateColumnFromStateChangeEvent(GridColumnState columnState) {
CustomGridColumn column = columnIdToColumn.get(columnState.id);
columnsUpdatedFromState = true;
updateColumnFromState(column, columnState);
columnsUpdatedFromState = false;
}
/**
* Adds a new column to the grid widget from a state change event
*
* @param columnIndex
* The index of the column, according to how it
*/
private void addColumnFromStateChangeEvent(GridColumnState state) {
@SuppressWarnings("unchecked")
CustomGridColumn column = new CustomGridColumn(state.id,
((AbstractRendererConnector<Object>) state.rendererConnector));
columnIdToColumn.put(state.id, column);
/*
* Add column to grid. Reordering is handled as a separate problem.
*/
getWidget().addColumn(column);
columnOrder.add(state.id);
}
/**
* If we have a selection column renderer, we need to offset the index by
* one when referring to the column index in the widget.
*/
private int getWidgetColumnIndex(final int columnIndex) {
Renderer<Boolean> selectionColumnRenderer = getWidget()
.getSelectionModel().getSelectionColumnRenderer();
int widgetColumnIndex = columnIndex;
if (selectionColumnRenderer != null) {
widgetColumnIndex++;
}
return widgetColumnIndex;
}
/**
* Updates the column values from a state
*
* @param column
* The column to update
* @param state
* The state to get the data from
*/
@SuppressWarnings("unchecked")
private static void updateColumnFromState(CustomGridColumn column,
GridColumnState state) {
column.setWidth(state.width);
column.setMinimumWidth(state.minWidth);
column.setMaximumWidth(state.maxWidth);
column.setExpandRatio(state.expandRatio);
assert state.rendererConnector instanceof AbstractRendererConnector : "GridColumnState.rendererConnector is invalid (not subclass of AbstractRendererConnector)";
column.setRenderer((AbstractRendererConnector<Object>) state.rendererConnector);
column.setSortable(state.sortable);
column.setHeaderCaption(state.headerCaption);
column.setHidden(state.hidden);
column.setHidable(state.hidable);
column.setHidingToggleCaption(state.hidingToggleCaption);
column.setEditable(state.editable);
column.setEditorConnector((AbstractFieldConnector) state.editorConnector);
}
/**
* Removes any orphan columns that has been removed from the state from the
* grid
*/
private void purgeRemovedColumns() {
// Get columns still registered in the state
Set<String> columnsInState = new HashSet<String>();
for (GridColumnState columnState : getState().columns) {
columnsInState.add(columnState.id);
}
// Remove column no longer in state
Iterator<String> columnIdIterator = columnIdToColumn.keySet()
.iterator();
while (columnIdIterator.hasNext()) {
String id = columnIdIterator.next();
if (!columnsInState.contains(id)) {
CustomGridColumn column = columnIdToColumn.get(id);
columnIdIterator.remove();
getWidget().removeColumn(column);
columnOrder.remove(id);
}
}
}
public void setDataSource(RpcDataSource dataSource) {
this.dataSource = dataSource;
getWidget().setDataSource(this.dataSource);
}
private void onSelectionModeChange() {
SharedSelectionMode mode = getState().selectionMode;
if (mode == null) {
getLogger().fine("ignored mode change");
return;
}
AbstractRowHandleSelectionModel<JsonObject> model = createSelectionModel(mode);
if (selectionModel == null
|| !model.getClass().equals(selectionModel.getClass())) {
selectionModel = model;
getWidget().setSelectionModel(model);
selectedKeys.clear();
}
}
@OnStateChange("hasCellStyleGenerator")
private void onCellStyleGeneratorChange() {
if (getState().hasCellStyleGenerator) {
getWidget().setCellStyleGenerator(new CustomCellStyleGenerator());
} else {
getWidget().setCellStyleGenerator(null);
}
}
@OnStateChange("hasRowStyleGenerator")
private void onRowStyleGeneratorChange() {
if (getState().hasRowStyleGenerator) {
getWidget().setRowStyleGenerator(new CustomRowStyleGenerator());
} else {
getWidget().setRowStyleGenerator(null);
}
}
private void updateSelectionFromState() {
boolean changed = false;
List<String> stateKeys = getState().selectedKeys;
// find new deselections
for (String key : selectedKeys) {
if (!stateKeys.contains(key)) {
changed = true;
deselectByHandle(dataSource.getHandleByKey(key));
}
}
// find new selections
for (String key : stateKeys) {
if (!selectedKeys.contains(key)) {
changed = true;
selectByHandle(dataSource.getHandleByKey(key));
}
}
/*
* A defensive copy in case the collection in the state is mutated
* instead of re-assigned.
*/
selectedKeys = new LinkedHashSet<String>(stateKeys);
/*
* We need to fire this event so that Grid is able to re-render the
* selection changes (if applicable).
*/
if (changed) {
// At least for now there's no way to send the selected and/or
// deselected row data. Some data is only stored as keys
selectionUpdatedFromState = true;
getWidget().fireEvent(
new SelectionEvent<JsonObject>(getWidget(),
(List<JsonObject>) null, null, false));
}
}
private void onSortStateChange() {
List<SortOrder> sortOrder = new ArrayList<SortOrder>();
String[] sortColumns = getState().sortColumns;
SortDirection[] sortDirs = getState().sortDirs;
for (int i = 0; i < sortColumns.length; i++) {
sortOrder.add(new SortOrder(columnIdToColumn.get(sortColumns[i]),
sortDirs[i]));
}
getWidget().setSortOrder(sortOrder);
}
private Logger getLogger() {
return Logger.getLogger(getClass().getName());
}
@SuppressWarnings("static-method")
private AbstractRowHandleSelectionModel<JsonObject> createSelectionModel(
SharedSelectionMode mode) {
switch (mode) {
case SINGLE:
return new SelectionModelSingle<JsonObject>();
case MULTI:
return new SelectionModelMulti<JsonObject>();
case NONE:
return new SelectionModelNone<JsonObject>();
default:
throw new IllegalStateException("unexpected mode value: " + mode);
}
}
/**
* A workaround method for accessing the protected method
* {@code AbstractRowHandleSelectionModel.selectByHandle}
*/
private native void selectByHandle(RowHandle<JsonObject> handle)
/*-{
var model = [email protected]::selectionModel;
model.@com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel::selectByHandle(*)(handle);
}-*/;
/**
* A workaround method for accessing the protected method
* {@code AbstractRowHandleSelectionModel.deselectByHandle}
*/
private native void deselectByHandle(RowHandle<JsonObject> handle)
/*-{
var model = [email protected]::selectionModel;
model.@com.vaadin.client.widget.grid.selection.AbstractRowHandleSelectionModel::deselectByHandle(*)(handle);
}-*/;
/**
* Gets the row key for a row object.
*
* @param row
* the row object
* @return the key for the given row
*/
public String getRowKey(JsonObject row) {
final Object key = dataSource.getRowKey(row);
assert key instanceof String : "Internal key was not a String but a "
+ key.getClass().getSimpleName() + " (" + key + ")";
return (String) key;
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.client.HasComponentsConnector#updateCaption(com.vaadin.client
* .ComponentConnector)
*/
@Override
public void updateCaption(ComponentConnector connector) {
// TODO Auto-generated method stub
}
@Override
public void onConnectorHierarchyChange(
ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent) {
customDetailsGenerator.updateConnectorHierarchy(getChildren());
}
public String getColumnId(Grid.Column<?, ?> column) {
if (column instanceof CustomGridColumn) {
return ((CustomGridColumn) column).id;
}
return null;
}
@Override
public void layout() {
getWidget().onResize();
}
@Override
public boolean isWorkPending() {
return lazyDetailsScroller.isWorkPending();
}
/**
* Gets the listener used by this connector for tracking when row detail
* visibility changes.
*
* @since 7.5.0
* @return the used details listener
*/
public DetailsListener getDetailsListener() {
return detailsListener;
}
}
| Fix empty @since
Change-Id: Ie060beaa9eca3b098d7e07116d64580c6a198ee8
| client/src/com/vaadin/client/connectors/GridConnector.java | Fix empty @since | <ide><path>lient/src/com/vaadin/client/connectors/GridConnector.java
<ide> /**
<ide> * Class for handling scrolling issues with open details.
<ide> *
<del> * @since
<del> * @author Vaadin Ltd
<add> * @since 7.5.2
<ide> */
<ide> private class LazyDetailsScroller implements DeferredWorker {
<ide>
<ide> /**
<ide> * Inform LazyDetailsScroller that a details row has opened on a row.
<ide> *
<del> * @since
<ide> * @param rowIndex
<ide> * index of row with details now open
<ide> */ |
|
Java | bsd-3-clause | aa12186378491c7bc08e3b2c9c674d67c212cb0f | 0 | yegor256/rexsl,krzyk/rexsl,krzyk/rexsl,yegor256/rexsl | /**
* Copyright (c) 2011-2012, ReXSL.com
* 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 ReXSL.com 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 HOLDER 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 com.rexsl.core;
import com.sun.jersey.api.core.PackagesResourceConfig;
import com.sun.jersey.spi.container.servlet.ServletContainer;
import com.ymock.util.Logger;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.logging.Handler;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.servlet.FilterConfig;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang.StringUtils;
/**
* The only and the main servlet from ReXSL framework.
*
* <p>You don't need to instantiate this class directly. It is instantiated
* by servlet container according to configuration from {@code web.xml}.
* Should be used in {@code web.xml} (together with {@link XsltFilter})
* like that:
*
* <pre>
* <servlet>
* <servlet-name>RestfulServlet</servlet-name>
* <servlet-class>com.rexsl.core.RestfulServlet</servlet-class>
* <init-param>
* <param-name>com.rexsl.PACKAGES</param-name>
* <param-value>com.rexsl.foo</param-value>
* </init-param>
* </servlet>
* <servlet-mapping>
* <servlet-name>RestfulServlet</servlet-name>
* <url-pattern>/*</url-pattern>
* </servlet-mapping>
* </pre>
*
* <p>{@code com.rexsl.PACKAGES} init parameter should contain comma-separated
* list of packages where JAX-RS annotated resources are located and should be
* discovered. If this parameter is not set a runtime exception will be thrown
* and the servlet won't be initialized. The same will happen if the parameter
* contains incorrect data. We will consider a package is valid if and only if
* it abides to the Java package naming conventions.
*
*
* @author Yegor Bugayenko ([email protected])
* @version $Id$
* @see <a href="http://www.rexsl.com">Introduction to ReXSL</a>
* @see <a href="http://www.oracle.com/technetwork/java/javaee/servlet/index.html">Java Servlet Technology</a>
* @see <a href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-6.html#jls-6.1">jls-6.1</a>
* @see <a href="http://www.oracle.com/technetwork/java/codeconventions-135099.html">Java naming conventions</a>
* @see <a href="http://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html">Naming a package</a>
* @since 0.2
*/
public final class RestfulServlet extends HttpServlet {
/**
* Comma.
*/
private static final String COMMA = ",";
/**
* Name of servlet param.
*/
private static final String PACKAGES = "com.rexsl.PACKAGES";
/**
* Jersey servlet.
*/
private final transient ServletContainer jersey = new ServletContainer();
/**
* {@inheritDoc}
* @checkstyle RedundantThrows (3 lines)
*/
@Override
public void init(final ServletConfig config) throws ServletException {
final List<String> packages = new ArrayList<String>();
packages.add(this.getClass().getPackage().getName());
final String param = config.getInitParameter(this.PACKAGES);
if (param == null) {
throw new IllegalArgumentException(
Logger.format(
"'%s' servlet parameter is mandatory",
this.PACKAGES
)
);
}
for (String pkg : StringUtils.split(param, this.COMMA)) {
if (packages.contains(pkg)) {
continue;
}
final Pattern ptrn = Pattern.compile(
"^([a-z_]{1}[a-z0-9_]*(\\.[a-z_]{1}[a-z0-9_]*)*)$"
);
final Matcher match = ptrn.matcher(pkg);
if (!match.matches()) {
throw new IllegalArgumentException(
Logger.format(
// @checkstyle LineLength (1 line)
"'%s' servlet parameter contains non-valid data: %s",
this.PACKAGES,
pkg
)
);
}
packages.add(pkg);
Logger.info(
this,
"#init(): '%s' package added (%d total)",
pkg,
packages.size()
);
}
final Properties props = new Properties();
props.setProperty(
PackagesResourceConfig.PROPERTY_PACKAGES,
StringUtils.join(packages, this.COMMA)
);
this.reconfigureJUL();
final FilterConfig cfg = new ServletConfigWrapper(config, props);
this.jersey.init(cfg);
Logger.info(
this,
"#init(%s): servlet initialized with Jersey JAX-RS implementation",
config.getClass().getName()
);
}
/**
* {@inheritDoc}
* @checkstyle ThrowsCount (6 lines)
* @checkstyle RedundantThrows (5 lines)
*/
@Override
protected void service(final HttpServletRequest request,
final HttpServletResponse response)
throws ServletException, IOException {
final long start = System.nanoTime();
this.jersey.service(request, response);
final long nano = System.nanoTime() - start;
Logger.debug(
this,
"#service(%s): by Jersey in %[nano]s",
request.getRequestURI(),
nano
);
// @checkstyle MagicNumber (1 line)
response.addHeader("Rexsl-Millis", Long.toString(nano / 1000));
}
/**
* Initialize JUL-to-SLF4J bridge.
* @see #init(ServletConfig)
*/
private void reconfigureJUL() {
final java.util.logging.Logger rootLogger =
java.util.logging.LogManager.getLogManager().getLogger("");
final Handler[] handlers = rootLogger.getHandlers();
for (Handler handler : handlers) {
rootLogger.removeHandler(handler);
}
org.slf4j.bridge.SLF4JBridgeHandler.install();
Logger.debug(this, "#julToSlf4j(): JUL forwarded to SLF4j");
}
}
| rexsl/rexsl-core/src/main/java/com/rexsl/core/RestfulServlet.java | /**
* Copyright (c) 2011-2012, ReXSL.com
* 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 ReXSL.com 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 HOLDER 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 com.rexsl.core;
import com.sun.jersey.api.core.PackagesResourceConfig;
import com.sun.jersey.spi.container.servlet.ServletContainer;
import com.ymock.util.Logger;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.logging.Handler;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.servlet.FilterConfig;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang.StringUtils;
/**
* The only and the main servlet from ReXSL framework.
*
* <p>You don't need to instantiate this class directly. It is instantiated
* by servlet container according to configuration from {@code web.xml}.
* Should be used in {@code web.xml} (together with {@link XsltFilter})
* like that:
*
* <pre>
* <servlet>
* <servlet-name>RestfulServlet</servlet-name>
* <servlet-class>com.rexsl.core.RestfulServlet</servlet-class>
* <init-param>
* <param-name>com.rexsl.PACKAGES</param-name>
* <param-value>com.rexsl.foo</param-value>
* </init-param>
* </servlet>
* <servlet-mapping>
* <servlet-name>RestfulServlet</servlet-name>
* <url-pattern>/*</url-pattern>
* </servlet-mapping>
* </pre>
*
* <p>{@code com.rexsl.PACKAGES} init parameter should contain comma-separated
* list of packages where JAX-RS annotated resources are located and should be
* discovered. If this parameter is not set a runtime exception will be thrown
* and the servlet won't be initialized. The same will happen if the parameter
* contains incorrect data. We will consider a package is valid if and only if
* it abides to the Java package naming conventions.
*
*
* @author Yegor Bugayenko ([email protected])
* @version $Id$
* @see <a href="http://www.rexsl.com">Introduction to ReXSL</a>
* @see <a href="http://www.oracle.com/technetwork/java/javaee/servlet/index.html">Java Servlet Technology</a>
* @see <a href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-6.html#jls-6.1">jls-6.1</a>
* @see <a href="http://www.oracle.com/technetwork/java/codeconventions-135099.html">Java naming conventions</a>
* @see <a href="http://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html">Naming a package</a>
* @since 0.2
*/
public final class RestfulServlet extends HttpServlet {
/**
* Comma.
*/
private static final String COMMA = ",";
/**
* Name of servlet param.
*/
private static final String PACKAGES = "com.rexsl.PACKAGES";
/**
* Jersey servlet.
*/
private final transient ServletContainer jersey = new ServletContainer();
/**
* {@inheritDoc}
* @checkstyle RedundantThrows (3 lines)
*/
@Override
public void init(final ServletConfig config) throws ServletException {
final List<String> packages = new ArrayList<String>();
packages.add(this.getClass().getPackage().getName());
final String param = config.getInitParameter(this.PACKAGES);
if (param == null) {
throw new IllegalArgumentException(
Logger.format(
"'%s' servlet parameter is mandatory",
this.PACKAGES
)
);
}
for (String pkg : StringUtils.split(param, this.COMMA)) {
if (packages.contains(pkg)) {
continue;
}
final Pattern ptrn = Pattern.compile(
"^([a-z_]{1}[a-z0-9_]*(\\.[a-z_]{1}[a-z0-9_]*)*)$"
);
final Matcher match = ptrn.matcher(pkg);
if (!match.matches()) {
throw new IllegalArgumentException(
Logger.format(
// @checkstyle LineLength (1 line)
"'%s' servlet parameter contains non-valid data: %s",
this.PACKAGES,
pkg
)
);
}
packages.add(pkg);
Logger.info(
this,
"#init(): '%s' package added (%d total)",
pkg,
packages.size()
);
}
final Properties props = new Properties();
props.setProperty(
PackagesResourceConfig.PROPERTY_PACKAGES,
StringUtils.join(packages, this.COMMA)
);
this.reconfigureJUL();
final FilterConfig cfg = new ServletConfigWrapper(config, props);
this.jersey.init(cfg);
Logger.info(
this,
"#init(%s): servlet initialized with Jersey JAX-RS implementation",
config.getClass().getName()
);
}
/**
* {@inheritDoc}
* @checkstyle ThrowsCount (6 lines)
* @checkstyle RedundantThrows (5 lines)
*/
@Override
protected void service(final HttpServletRequest request,
final HttpServletResponse response)
throws ServletException, IOException {
final long start = System.nanoTime();
this.jersey.service(request, response);
Logger.debug(
this,
"#service(%s): by Jersey in %[nano]s",
request.getRequestURI(),
System.nanoTime() - start
);
}
/**
* Initialize JUL-to-SLF4J bridge.
* @see #init(ServletConfig)
*/
private void reconfigureJUL() {
final java.util.logging.Logger rootLogger =
java.util.logging.LogManager.getLogManager().getLogger("");
final Handler[] handlers = rootLogger.getHandlers();
for (Handler handler : handlers) {
rootLogger.removeHandler(handler);
}
org.slf4j.bridge.SLF4JBridgeHandler.install();
Logger.debug(this, "#julToSlf4j(): JUL forwarded to SLF4j");
}
}
| refs #305 - done
| rexsl/rexsl-core/src/main/java/com/rexsl/core/RestfulServlet.java | refs #305 - done | <ide><path>exsl/rexsl-core/src/main/java/com/rexsl/core/RestfulServlet.java
<ide> throws ServletException, IOException {
<ide> final long start = System.nanoTime();
<ide> this.jersey.service(request, response);
<add> final long nano = System.nanoTime() - start;
<ide> Logger.debug(
<ide> this,
<ide> "#service(%s): by Jersey in %[nano]s",
<ide> request.getRequestURI(),
<del> System.nanoTime() - start
<add> nano
<ide> );
<add> // @checkstyle MagicNumber (1 line)
<add> response.addHeader("Rexsl-Millis", Long.toString(nano / 1000));
<ide> }
<ide>
<ide> /** |
|
Java | mpl-2.0 | 553b6b320c07f0c37e7a707e673989a7896d0555 | 0 | msteinhoff/hello-world | bf00b5b3-cb8e-11e5-a88c-00264a111016 | src/main/java/HelloWorld.java | bef55c07-cb8e-11e5-a7e1-00264a111016 | more bug fix | src/main/java/HelloWorld.java | more bug fix | <ide><path>rc/main/java/HelloWorld.java
<del>bef55c07-cb8e-11e5-a7e1-00264a111016
<add>bf00b5b3-cb8e-11e5-a88c-00264a111016 |
|
Java | apache-2.0 | 594cd585faf2d67adfeb04b15e87269cf9dbb329 | 0 | lsmaira/gradle,blindpirate/gradle,gradle/gradle,gstevey/gradle,gradle/gradle,blindpirate/gradle,gradle/gradle,robinverduijn/gradle,gstevey/gradle,blindpirate/gradle,robinverduijn/gradle,lsmaira/gradle,lsmaira/gradle,gstevey/gradle,gstevey/gradle,gradle/gradle,gstevey/gradle,gradle/gradle,lsmaira/gradle,gradle/gradle,lsmaira/gradle,robinverduijn/gradle,robinverduijn/gradle,robinverduijn/gradle,blindpirate/gradle,lsmaira/gradle,lsmaira/gradle,gradle/gradle,lsmaira/gradle,blindpirate/gradle,gradle/gradle,blindpirate/gradle,robinverduijn/gradle,gstevey/gradle,gradle/gradle,blindpirate/gradle,gradle/gradle,gstevey/gradle,robinverduijn/gradle,robinverduijn/gradle,robinverduijn/gradle,gstevey/gradle,lsmaira/gradle,gstevey/gradle,blindpirate/gradle,robinverduijn/gradle,robinverduijn/gradle,blindpirate/gradle,blindpirate/gradle,lsmaira/gradle | /*
* Copyright 2011 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.gradle.api.internal.artifacts.ivyservice.resolveengine;
import org.apache.ivy.core.module.descriptor.ExcludeRule;
import org.apache.ivy.core.module.id.ArtifactId;
import org.apache.ivy.core.module.id.ModuleId;
import org.apache.ivy.plugins.matcher.ExactPatternMatcher;
import org.apache.ivy.plugins.matcher.MatcherHelper;
import org.apache.ivy.plugins.matcher.PatternMatcher;
import java.util.*;
import static org.gradle.api.internal.artifacts.ivyservice.IvyUtil.createModuleId;
/**
* Manages sets of exclude rules, allowing union and intersection operations on the rules.
*
* <p>This class attempts to reduce execution time, by flattening union and intersection specs, at the cost of more analysis at construction time. This is taken advantage of by {@link
* org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.DependencyGraphBuilder}, on the assumption that there are many more edges in the dependency graph than there are exclude rules (ie we evaluate the rules much more often that we construct them).
* </p>
*
* <p>Also, this class attempts to be quite accurate in determining if 2 specs will match exactly the same set of modules. {@link org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.DependencyGraphBuilder} uses this to avoid traversing the
* dependency graph of a particular version that has already been traversed when a new incoming edge is added (eg a newly discovered dependency) and when an incoming edge is removed (eg a conflict
* evicts a version that depends on the given version). </p>
*/
public abstract class ModuleVersionSpec {
private static final AcceptAllSpec ALL_SPEC = new AcceptAllSpec();
public static ModuleVersionSpec forExcludes(ExcludeRule... excludeRules) {
return forExcludes(Arrays.asList(excludeRules));
}
/**
* Returns a spec that accepts only those module versions that do not match any of the
*/
public static ModuleVersionSpec forExcludes(Collection<ExcludeRule> excludeRules) {
if (excludeRules.isEmpty()) {
return ALL_SPEC;
}
return new ExcludeRuleBackedSpec(excludeRules);
}
/**
* Returns a spec that accepts the union of those module versions that are accepted by this spec and the given spec.
*/
public ModuleVersionSpec union(ModuleVersionSpec other) {
if (other == this) {
return this;
}
if (other == ALL_SPEC) {
return other;
}
if (this == ALL_SPEC) {
return this;
}
List<ModuleVersionSpec> specs = new ArrayList<ModuleVersionSpec>();
unpackUnion(specs);
other.unpackUnion(specs);
for (int i = 0; i < specs.size();) {
ModuleVersionSpec spec = specs.get(i);
ModuleVersionSpec merged = null;
for (int j = i + 1; j < specs.size(); j++) {
merged = spec.doUnion(specs.get(j));
if (merged != null) {
specs.remove(j);
break;
}
}
if (merged != null) {
specs.set(i, merged);
} else {
i++;
}
}
if (specs.size() == 1) {
return specs.get(0);
}
return new UnionSpec(specs);
}
protected void unpackUnion(Collection<ModuleVersionSpec> specs) {
specs.add(this);
}
protected ModuleVersionSpec doUnion(ModuleVersionSpec other) {
return null;
}
public abstract boolean acceptModule(ModuleId module);
public abstract boolean acceptArtifact(ArtifactId artifact);
/**
* Determines if this spec accepts the same set of modules as the given spec.
*
* @return true if the specs accept the same set of modules. Returns false if they may not, or if it is unknown.
*/
public final boolean acceptsSameModulesAs(ModuleVersionSpec other) {
if (other == this) {
return true;
}
if (!other.getClass().equals(getClass())) {
return false;
}
return doAcceptsSameModulesAs(other);
}
/**
* Only called when this and the other spec have the same class.
*/
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
return false;
}
/**
* Returns a spec that accepts the intersection of those module versions that are accepted by this spec and the given spec.
*/
public ModuleVersionSpec intersect(ModuleVersionSpec other) {
if (other == this) {
return this;
}
if (other == ALL_SPEC) {
return this;
}
if (this == ALL_SPEC) {
return other;
}
return doIntersection(other);
}
protected ModuleVersionSpec doIntersection(ModuleVersionSpec other) {
return new IntersectSpec(this, other);
}
private static class AcceptAllSpec extends ModuleVersionSpec {
@Override
public String toString() {
return "{accept-all}";
}
public boolean acceptModule(ModuleId element) {
return true;
}
public boolean acceptArtifact(ArtifactId artifact) {
return true;
}
}
private static abstract class CompositeSpec extends ModuleVersionSpec {
abstract Collection<ModuleVersionSpec> getSpecs();
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append("{");
builder.append(getClass().getSimpleName());
for (ModuleVersionSpec spec : getSpecs()) {
builder.append(' ');
builder.append(spec);
}
builder.append("}");
return builder.toString();
}
@Override
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
CompositeSpec spec = (CompositeSpec) other;
return implies(spec) && spec.implies(this);
}
/**
* Returns true if for every spec in this spec, there is a corresponding spec in the given spec that acceptsSameModulesAs().
*/
protected boolean implies(CompositeSpec spec) {
for (ModuleVersionSpec thisSpec : getSpecs()) {
boolean found = false;
for (ModuleVersionSpec otherSpec : spec.getSpecs()) {
if (thisSpec.acceptsSameModulesAs(otherSpec)) {
found = true;
break;
}
}
if (!found) {
return false;
}
}
return true;
}
}
static class ExcludeRuleBackedSpec extends CompositeSpec {
private final Set<ModuleVersionSpec> excludeSpecs = new HashSet<ModuleVersionSpec>();
private ExcludeRuleBackedSpec(Iterable<ExcludeRule> excludeRules) {
for (ExcludeRule rule : excludeRules) {
if (!(rule.getMatcher() instanceof ExactPatternMatcher)) {
excludeSpecs.add(new ExcludeRuleSpec(rule));
continue;
}
ModuleId moduleId = rule.getId().getModuleId();
boolean wildcardGroup = PatternMatcher.ANY_EXPRESSION.equals(moduleId.getOrganisation());
boolean wildcardModule = PatternMatcher.ANY_EXPRESSION.equals(moduleId.getName());
if (wildcardGroup && wildcardModule) {
excludeSpecs.add(new ExcludeRuleSpec(rule));
} else if (wildcardGroup) {
excludeSpecs.add(new ModuleNameSpec(moduleId.getName()));
} else if (wildcardModule) {
excludeSpecs.add(new GroupNameSpec(moduleId.getOrganisation()));
} else {
excludeSpecs.add(new ModuleIdSpec(moduleId));
}
}
}
public ExcludeRuleBackedSpec(Collection<ModuleVersionSpec> specs) {
this.excludeSpecs.addAll(specs);
}
@Override
Collection<ModuleVersionSpec> getSpecs() {
return excludeSpecs;
}
public boolean acceptModule(ModuleId element) {
for (ModuleVersionSpec excludeSpec : excludeSpecs) {
if (!excludeSpec.acceptModule(element)) {
return false;
}
}
return true;
}
public boolean acceptArtifact(ArtifactId artifact) {
for (ModuleVersionSpec excludeSpec : excludeSpecs) {
if (!excludeSpec.acceptArtifact(artifact)) {
return false;
}
}
return true;
}
@Override
protected ModuleVersionSpec doUnion(ModuleVersionSpec other) {
if (!(other instanceof ExcludeRuleBackedSpec)) {
return super.doUnion(other);
}
ExcludeRuleBackedSpec excludeRuleBackedSpec = (ExcludeRuleBackedSpec) other;
if (excludeSpecs.equals(excludeRuleBackedSpec.excludeSpecs)) {
return this;
}
// Can only merge exact match rules, so don't try if this or the other spec contains any other type of rule
for (ModuleVersionSpec excludeSpec : excludeSpecs) {
if (excludeSpec instanceof ExcludeRuleSpec) {
return super.doUnion(other);
}
}
for (ModuleVersionSpec excludeSpec : excludeRuleBackedSpec.excludeSpecs) {
if (excludeSpec instanceof ExcludeRuleSpec) {
return super.doUnion(other);
}
}
// Calculate the intersection of the rules
List<ModuleVersionSpec> merged = new ArrayList<ModuleVersionSpec>();
for (ModuleVersionSpec thisSpec : excludeSpecs) {
for (ModuleVersionSpec otherSpec : excludeRuleBackedSpec.excludeSpecs) {
intersect(thisSpec, otherSpec, merged);
}
}
if (merged.isEmpty()) {
return ALL_SPEC;
}
return new ExcludeRuleBackedSpec(merged);
}
private void intersect(ModuleVersionSpec spec1, ModuleVersionSpec spec2, List<ModuleVersionSpec> merged) {
if (spec1 instanceof GroupNameSpec) {
intersect((GroupNameSpec) spec1, spec2, merged);
} else if (spec2 instanceof GroupNameSpec) {
intersect((GroupNameSpec) spec2, spec1, merged);
} else if (spec1 instanceof ModuleNameSpec) {
intersect((ModuleNameSpec) spec1, spec2, merged);
} else if (spec2 instanceof ModuleNameSpec) {
intersect((ModuleNameSpec) spec2, spec1, merged);
} else if ((spec1 instanceof ModuleIdSpec) && (spec2 instanceof ModuleIdSpec)) {
ModuleIdSpec moduleSpec1 = (ModuleIdSpec) spec1;
ModuleIdSpec moduleSpec2 = (ModuleIdSpec) spec2;
if (moduleSpec1.moduleId.equals(moduleSpec2.moduleId)) {
merged.add(moduleSpec1);
}
} else {
throw new UnsupportedOperationException();
}
}
private void intersect(GroupNameSpec spec1, ModuleVersionSpec spec2, List<ModuleVersionSpec> merged) {
if (spec2 instanceof GroupNameSpec) {
GroupNameSpec groupNameSpec = (GroupNameSpec) spec2;
if (spec1.group.equals(groupNameSpec.group)) {
merged.add(spec1);
}
} else if (spec2 instanceof ModuleNameSpec) {
ModuleNameSpec moduleNameSpec = (ModuleNameSpec) spec2;
merged.add(new ModuleIdSpec(createModuleId(spec1.group, moduleNameSpec.module)));
} else if (spec2 instanceof ModuleIdSpec) {
ModuleIdSpec moduleIdSpec = (ModuleIdSpec) spec2;
if (moduleIdSpec.moduleId.getOrganisation().equals(spec1.group)) {
merged.add(spec2);
}
} else {
throw new UnsupportedOperationException();
}
}
private void intersect(ModuleNameSpec spec1, ModuleVersionSpec spec2, List<ModuleVersionSpec> merged) {
if (spec2 instanceof ModuleNameSpec) {
ModuleNameSpec moduleNameSpec = (ModuleNameSpec) spec2;
if (spec1.module.equals(moduleNameSpec.module)) {
merged.add(spec1);
}
} else if (spec2 instanceof ModuleIdSpec) {
ModuleIdSpec moduleIdSpec = (ModuleIdSpec) spec2;
if (moduleIdSpec.moduleId.getName().equals(spec1.module)) {
merged.add(spec2);
}
} else {
throw new UnsupportedOperationException();
}
}
@Override
protected ModuleVersionSpec doIntersection(ModuleVersionSpec other) {
if (!(other instanceof ExcludeRuleBackedSpec)) {
return super.doIntersection(other);
}
ExcludeRuleBackedSpec otherExcludeRuleSpec = (ExcludeRuleBackedSpec) other;
Set<ModuleVersionSpec> allSpecs = new HashSet<ModuleVersionSpec>();
allSpecs.addAll(excludeSpecs);
allSpecs.addAll(otherExcludeRuleSpec.excludeSpecs);
return new ExcludeRuleBackedSpec(allSpecs);
}
}
static class UnionSpec extends CompositeSpec {
private final List<ModuleVersionSpec> specs;
public UnionSpec(List<ModuleVersionSpec> specs) {
this.specs = specs;
}
@Override
Collection<ModuleVersionSpec> getSpecs() {
return specs;
}
@Override
protected void unpackUnion(Collection<ModuleVersionSpec> specs) {
specs.addAll(this.specs);
}
public boolean acceptModule(ModuleId element) {
for (ModuleVersionSpec spec : specs) {
if (spec.acceptModule(element)) {
return true;
}
}
return false;
}
public boolean acceptArtifact(ArtifactId artifact) {
for (ModuleVersionSpec spec : specs) {
if (spec.acceptArtifact(artifact)) {
return true;
}
}
return false;
}
}
private static class IntersectSpec extends CompositeSpec {
private final List<ModuleVersionSpec> specs;
private IntersectSpec(ModuleVersionSpec... specs) {
this.specs = Arrays.asList(specs);
}
@Override
Collection<ModuleVersionSpec> getSpecs() {
return specs;
}
public boolean acceptModule(ModuleId element) {
for (ModuleVersionSpec spec : specs) {
if (!spec.acceptModule(element)) {
return false;
}
}
return true;
}
public boolean acceptArtifact(ArtifactId artifact) {
for (ModuleVersionSpec spec : specs) {
if (!spec.acceptArtifact(artifact)) {
return false;
}
}
return true;
}
}
private static class ModuleIdSpec extends ModuleVersionSpec {
private final ModuleId moduleId;
private ModuleIdSpec(ModuleId moduleId) {
this.moduleId = moduleId;
}
@Override
public String toString() {
return String.format("{module-id %s}", moduleId);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
ModuleIdSpec other = (ModuleIdSpec) o;
return moduleId.equals(other.moduleId);
}
@Override
public int hashCode() {
return moduleId.hashCode();
}
@Override
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
ModuleIdSpec moduleIdSpec = (ModuleIdSpec) other;
return moduleId.equals(moduleIdSpec.moduleId);
}
public boolean acceptModule(ModuleId element) {
return !element.equals(moduleId);
}
public boolean acceptArtifact(ArtifactId artifact) {
return acceptModule(artifact.getModuleId());
}
}
private static class ModuleNameSpec extends ModuleVersionSpec {
private final String module;
private ModuleNameSpec(String module) {
this.module = module;
}
@Override
public String toString() {
return String.format("{module %s}", module);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
ModuleNameSpec other = (ModuleNameSpec) o;
return module.equals(other.module);
}
@Override
public int hashCode() {
return module.hashCode();
}
@Override
public boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
ModuleNameSpec moduleNameSpec = (ModuleNameSpec) other;
return module.equals(moduleNameSpec.module);
}
public boolean acceptModule(ModuleId element) {
return !element.getName().equals(module);
}
public boolean acceptArtifact(ArtifactId artifact) {
return acceptModule(artifact.getModuleId());
}
}
private static class GroupNameSpec extends ModuleVersionSpec {
private final String group;
private GroupNameSpec(String group) {
this.group = group;
}
@Override
public String toString() {
return String.format("{group %s}", group);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
GroupNameSpec other = (GroupNameSpec) o;
return group.equals(other.group);
}
@Override
public int hashCode() {
return group.hashCode();
}
@Override
public boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
GroupNameSpec groupNameSpec = (GroupNameSpec) other;
return group.equals(groupNameSpec.group);
}
public boolean acceptModule(ModuleId element) {
return !element.getOrganisation().equals(group);
}
public boolean acceptArtifact(ArtifactId artifact) {
return acceptModule(artifact.getModuleId());
}
}
private static class ExcludeRuleSpec extends ModuleVersionSpec {
private final ExcludeRule rule;
private ExcludeRuleSpec(ExcludeRule rule) {
this.rule = rule;
}
@Override
public String toString() {
return String.format("{exclude-rule %s}", rule);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
ExcludeRuleSpec other = (ExcludeRuleSpec) o;
// Can't use equals(), as DefaultExcludeRule.equals() does not consider the pattern matcher
return rule == other.rule;
}
@Override
public int hashCode() {
return rule.hashCode();
}
@Override
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
ExcludeRuleSpec excludeRuleSpec = (ExcludeRuleSpec) other;
// Can't use equals(), as DefaultExcludeRule.equals() does not consider the pattern matcher
return rule == excludeRuleSpec.rule;
}
public boolean acceptModule(ModuleId element) {
ArtifactId artifactId = rule.getId();
boolean matchesRule = MatcherHelper.matches(rule.getMatcher(), artifactId.getModuleId(), element);
return !(matchesRule
&& matchesAnyExpression(artifactId.getName())
&& matchesAnyExpression(artifactId.getType())
&& matchesAnyExpression(artifactId.getExt()));
}
private boolean matchesAnyExpression(String attribute) {
return PatternMatcher.ANY_EXPRESSION.equals(attribute);
}
public boolean acceptArtifact(ArtifactId artifact) {
return !MatcherHelper.matches(rule.getMatcher(), rule.getId(), artifact);
}
}
}
| subprojects/dependency-management/src/main/java/org/gradle/api/internal/artifacts/ivyservice/resolveengine/ModuleVersionSpec.java | /*
* Copyright 2011 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.gradle.api.internal.artifacts.ivyservice.resolveengine;
import org.apache.ivy.core.module.descriptor.ExcludeRule;
import org.apache.ivy.core.module.id.ArtifactId;
import org.apache.ivy.core.module.id.ModuleId;
import org.apache.ivy.plugins.matcher.ExactPatternMatcher;
import org.apache.ivy.plugins.matcher.MatcherHelper;
import org.apache.ivy.plugins.matcher.PatternMatcher;
import java.util.*;
import static org.gradle.api.internal.artifacts.ivyservice.IvyUtil.createModuleId;
/**
* Manages sets of exclude rules, allowing union and intersection operations on the rules.
*
* <p>This class attempts to reduce execution time, by flattening union and intersection specs, at the cost of more analysis at construction time. This is taken advantage of by {@link
* org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.DependencyGraphBuilder}, on the assumption that there are many more edges in the dependency graph than there are exclude rules (ie we evaluate the rules much more often that we construct them).
* </p>
*
* <p>Also, this class attempts to be quite accurate in determining if 2 specs will match exactly the same set of modules. {@link org.gradle.api.internal.artifacts.ivyservice.resolveengine.graph.DependencyGraphBuilder} uses this to avoid traversing the
* dependency graph of a particular version that has already been traversed when a new incoming edge is added (eg a newly discovered dependency) and when an incoming edge is removed (eg a conflict
* evicts a version that depends on the given version). </p>
*/
public abstract class ModuleVersionSpec {
private static final AcceptAllSpec ALL_SPEC = new AcceptAllSpec();
public static ModuleVersionSpec forExcludes(ExcludeRule... excludeRules) {
return forExcludes(Arrays.asList(excludeRules));
}
/**
* Returns a spec that accepts only those module versions that do not match any of the
*/
public static ModuleVersionSpec forExcludes(Collection<ExcludeRule> excludeRules) {
if (excludeRules.isEmpty()) {
return ALL_SPEC;
}
return new ExcludeRuleBackedSpec(excludeRules);
}
/**
* Returns a spec that accepts the union of those module versions that are accepted by this spec and the given spec.
*/
public ModuleVersionSpec union(ModuleVersionSpec other) {
if (other == this) {
return this;
}
if (other == ALL_SPEC) {
return other;
}
if (this == ALL_SPEC) {
return this;
}
List<ModuleVersionSpec> specs = new ArrayList<ModuleVersionSpec>();
unpackUnion(specs);
other.unpackUnion(specs);
for (int i = 0; i < specs.size();) {
ModuleVersionSpec spec = specs.get(i);
ModuleVersionSpec merged = null;
for (int j = i + 1; j < specs.size(); j++) {
merged = spec.doUnion(specs.get(j));
if (merged != null) {
specs.remove(j);
break;
}
}
if (merged != null) {
specs.set(i, merged);
} else {
i++;
}
}
if (specs.size() == 1) {
return specs.get(0);
}
return new UnionSpec(specs);
}
protected void unpackUnion(Collection<ModuleVersionSpec> specs) {
specs.add(this);
}
protected ModuleVersionSpec doUnion(ModuleVersionSpec other) {
return null;
}
public abstract boolean acceptModule(ModuleId module);
public abstract boolean acceptArtifact(ArtifactId artifact);
/**
* Determines if this spec accepts the same set of modules as the given spec.
*
* @return true if the specs accept the same set of modules. Returns false if they may not, or if it is unknown.
*/
public final boolean acceptsSameModulesAs(ModuleVersionSpec other) {
if (other == this) {
return true;
}
if (!other.getClass().equals(getClass())) {
return false;
}
return doAcceptsSameModulesAs((ModuleVersionSpec) other);
}
/**
* Only called when this and the other spec have the same class.
*/
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
return false;
}
/**
* Returns a spec that accepts the intersection of those module versions that are accepted by this spec and the given spec.
*/
public ModuleVersionSpec intersect(ModuleVersionSpec other) {
if (other == this) {
return this;
}
if (other == ALL_SPEC) {
return this;
}
if (this == ALL_SPEC) {
return other;
}
return doIntersection((ModuleVersionSpec) other);
}
protected ModuleVersionSpec doIntersection(ModuleVersionSpec other) {
return new IntersectSpec(this, other);
}
private static class AcceptAllSpec extends ModuleVersionSpec {
@Override
public String toString() {
return "{accept-all}";
}
public boolean acceptModule(ModuleId element) {
return true;
}
public boolean acceptArtifact(ArtifactId artifact) {
return true;
}
}
private static abstract class CompositeSpec extends ModuleVersionSpec {
abstract Collection<ModuleVersionSpec> getSpecs();
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append("{");
builder.append(getClass().getSimpleName());
for (ModuleVersionSpec spec : getSpecs()) {
builder.append(' ');
builder.append(spec);
}
builder.append("}");
return builder.toString();
}
@Override
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
CompositeSpec spec = (CompositeSpec) other;
return implies(spec) && spec.implies(this);
}
/**
* Returns true if for every spec in this spec, there is a corresponding spec in the given spec that acceptsSameModulesAs().
*/
protected boolean implies(CompositeSpec spec) {
for (ModuleVersionSpec thisSpec : getSpecs()) {
boolean found = false;
for (ModuleVersionSpec otherSpec : spec.getSpecs()) {
if (thisSpec.acceptsSameModulesAs(otherSpec)) {
found = true;
break;
}
}
if (!found) {
return false;
}
}
return true;
}
}
static class ExcludeRuleBackedSpec extends CompositeSpec {
private final Set<ModuleVersionSpec> excludeSpecs = new HashSet<ModuleVersionSpec>();
private ExcludeRuleBackedSpec(Iterable<ExcludeRule> excludeRules) {
for (ExcludeRule rule : excludeRules) {
if (!(rule.getMatcher() instanceof ExactPatternMatcher)) {
excludeSpecs.add(new ExcludeRuleSpec(rule));
continue;
}
ModuleId moduleId = rule.getId().getModuleId();
boolean wildcardGroup = PatternMatcher.ANY_EXPRESSION.equals(moduleId.getOrganisation());
boolean wildcardModule = PatternMatcher.ANY_EXPRESSION.equals(moduleId.getName());
if (wildcardGroup && wildcardModule) {
excludeSpecs.add(new ExcludeRuleSpec(rule));
} else if (wildcardGroup) {
excludeSpecs.add(new ModuleNameSpec(moduleId.getName()));
} else if (wildcardModule) {
excludeSpecs.add(new GroupNameSpec(moduleId.getOrganisation()));
} else {
excludeSpecs.add(new ModuleIdSpec(moduleId));
}
}
}
public ExcludeRuleBackedSpec(Collection<ModuleVersionSpec> specs) {
this.excludeSpecs.addAll(specs);
}
@Override
Collection<ModuleVersionSpec> getSpecs() {
return excludeSpecs;
}
public boolean acceptModule(ModuleId element) {
for (ModuleVersionSpec excludeSpec : excludeSpecs) {
if (!excludeSpec.acceptModule(element)) {
return false;
}
}
return true;
}
public boolean acceptArtifact(ArtifactId artifact) {
for (ModuleVersionSpec excludeSpec : excludeSpecs) {
if (!excludeSpec.acceptArtifact(artifact)) {
return false;
}
}
return true;
}
@Override
protected ModuleVersionSpec doUnion(ModuleVersionSpec other) {
if (!(other instanceof ExcludeRuleBackedSpec)) {
return super.doUnion(other);
}
ExcludeRuleBackedSpec excludeRuleBackedSpec = (ExcludeRuleBackedSpec) other;
if (excludeSpecs.equals(excludeRuleBackedSpec.excludeSpecs)) {
return this;
}
// Can only merge exact match rules, so don't try if this or the other spec contains any other type of rule
for (ModuleVersionSpec excludeSpec : excludeSpecs) {
if (excludeSpec instanceof ExcludeRuleSpec) {
return super.doUnion(other);
}
}
for (ModuleVersionSpec excludeSpec : excludeRuleBackedSpec.excludeSpecs) {
if (excludeSpec instanceof ExcludeRuleSpec) {
return super.doUnion(other);
}
}
// Calculate the intersection of the rules
List<ModuleVersionSpec> merged = new ArrayList<ModuleVersionSpec>();
for (ModuleVersionSpec thisSpec : excludeSpecs) {
for (ModuleVersionSpec otherSpec : excludeRuleBackedSpec.excludeSpecs) {
intersect(thisSpec, otherSpec, merged);
}
}
if (merged.isEmpty()) {
return ALL_SPEC;
}
return new ExcludeRuleBackedSpec(merged);
}
private void intersect(ModuleVersionSpec spec1, ModuleVersionSpec spec2, List<ModuleVersionSpec> merged) {
if (spec1 instanceof GroupNameSpec) {
intersect((GroupNameSpec) spec1, spec2, merged);
} else if (spec2 instanceof GroupNameSpec) {
intersect((GroupNameSpec) spec2, spec1, merged);
} else if (spec1 instanceof ModuleNameSpec) {
intersect((ModuleNameSpec) spec1, spec2, merged);
} else if (spec2 instanceof ModuleNameSpec) {
intersect((ModuleNameSpec) spec2, spec1, merged);
} else if ((spec1 instanceof ModuleIdSpec) && (spec2 instanceof ModuleIdSpec)) {
ModuleIdSpec moduleSpec1 = (ModuleIdSpec) spec1;
ModuleIdSpec moduleSpec2 = (ModuleIdSpec) spec2;
if (moduleSpec1.moduleId.equals(moduleSpec2.moduleId)) {
merged.add(moduleSpec1);
}
} else {
throw new UnsupportedOperationException();
}
}
private void intersect(GroupNameSpec spec1, ModuleVersionSpec spec2, List<ModuleVersionSpec> merged) {
if (spec2 instanceof GroupNameSpec) {
GroupNameSpec groupNameSpec = (GroupNameSpec) spec2;
if (spec1.group.equals(groupNameSpec.group)) {
merged.add(spec1);
}
} else if (spec2 instanceof ModuleNameSpec) {
ModuleNameSpec moduleNameSpec = (ModuleNameSpec) spec2;
merged.add(new ModuleIdSpec(createModuleId(spec1.group, moduleNameSpec.module)));
} else if (spec2 instanceof ModuleIdSpec) {
ModuleIdSpec moduleIdSpec = (ModuleIdSpec) spec2;
if (moduleIdSpec.moduleId.getOrganisation().equals(spec1.group)) {
merged.add(spec2);
}
} else {
throw new UnsupportedOperationException();
}
}
private void intersect(ModuleNameSpec spec1, ModuleVersionSpec spec2, List<ModuleVersionSpec> merged) {
if (spec2 instanceof ModuleNameSpec) {
ModuleNameSpec moduleNameSpec = (ModuleNameSpec) spec2;
if (spec1.module.equals(moduleNameSpec.module)) {
merged.add(spec1);
}
} else if (spec2 instanceof ModuleIdSpec) {
ModuleIdSpec moduleIdSpec = (ModuleIdSpec) spec2;
if (moduleIdSpec.moduleId.getName().equals(spec1.module)) {
merged.add(spec2);
}
} else {
throw new UnsupportedOperationException();
}
}
@Override
protected ModuleVersionSpec doIntersection(ModuleVersionSpec other) {
if (!(other instanceof ExcludeRuleBackedSpec)) {
return super.doIntersection(other);
}
ExcludeRuleBackedSpec otherExcludeRuleSpec = (ExcludeRuleBackedSpec) other;
Set<ModuleVersionSpec> allSpecs = new HashSet<ModuleVersionSpec>();
allSpecs.addAll(excludeSpecs);
allSpecs.addAll(otherExcludeRuleSpec.excludeSpecs);
return new ExcludeRuleBackedSpec(allSpecs);
}
}
static class UnionSpec extends CompositeSpec {
private final List<ModuleVersionSpec> specs;
public UnionSpec(List<ModuleVersionSpec> specs) {
this.specs = specs;
}
@Override
Collection<ModuleVersionSpec> getSpecs() {
return specs;
}
@Override
protected void unpackUnion(Collection<ModuleVersionSpec> specs) {
specs.addAll(this.specs);
}
public boolean acceptModule(ModuleId element) {
for (ModuleVersionSpec spec : specs) {
if (spec.acceptModule(element)) {
return true;
}
}
return false;
}
public boolean acceptArtifact(ArtifactId artifact) {
for (ModuleVersionSpec spec : specs) {
if (spec.acceptArtifact(artifact)) {
return true;
}
}
return false;
}
}
private static class IntersectSpec extends CompositeSpec {
private final List<ModuleVersionSpec> specs;
private IntersectSpec(ModuleVersionSpec... specs) {
this.specs = Arrays.asList(specs);
}
@Override
Collection<ModuleVersionSpec> getSpecs() {
return specs;
}
public boolean acceptModule(ModuleId element) {
for (ModuleVersionSpec spec : specs) {
if (!spec.acceptModule(element)) {
return false;
}
}
return true;
}
public boolean acceptArtifact(ArtifactId artifact) {
for (ModuleVersionSpec spec : specs) {
if (!spec.acceptArtifact(artifact)) {
return false;
}
}
return true;
}
}
private static class ModuleIdSpec extends ModuleVersionSpec {
private final ModuleId moduleId;
private ModuleIdSpec(ModuleId moduleId) {
this.moduleId = moduleId;
}
@Override
public String toString() {
return String.format("{module-id %s}", moduleId);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
ModuleIdSpec other = (ModuleIdSpec) o;
return moduleId.equals(other.moduleId);
}
@Override
public int hashCode() {
return moduleId.hashCode();
}
@Override
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
ModuleIdSpec moduleIdSpec = (ModuleIdSpec) other;
return moduleId.equals(moduleIdSpec.moduleId);
}
public boolean acceptModule(ModuleId element) {
return !element.equals(moduleId);
}
public boolean acceptArtifact(ArtifactId artifact) {
return acceptModule(artifact.getModuleId());
}
}
private static class ModuleNameSpec extends ModuleVersionSpec {
private final String module;
private ModuleNameSpec(String module) {
this.module = module;
}
@Override
public String toString() {
return String.format("{module %s}", module);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
ModuleNameSpec other = (ModuleNameSpec) o;
return module.equals(other.module);
}
@Override
public int hashCode() {
return module.hashCode();
}
@Override
public boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
ModuleNameSpec moduleNameSpec = (ModuleNameSpec) other;
return module.equals(moduleNameSpec.module);
}
public boolean acceptModule(ModuleId element) {
return !element.getName().equals(module);
}
public boolean acceptArtifact(ArtifactId artifact) {
return acceptModule(artifact.getModuleId());
}
}
private static class GroupNameSpec extends ModuleVersionSpec {
private final String group;
private GroupNameSpec(String group) {
this.group = group;
}
@Override
public String toString() {
return String.format("{group %s}", group);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
GroupNameSpec other = (GroupNameSpec) o;
return group.equals(other.group);
}
@Override
public int hashCode() {
return group.hashCode();
}
@Override
public boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
GroupNameSpec groupNameSpec = (GroupNameSpec) other;
return group.equals(groupNameSpec.group);
}
public boolean acceptModule(ModuleId element) {
return !element.getOrganisation().equals(group);
}
public boolean acceptArtifact(ArtifactId artifact) {
return acceptModule(artifact.getModuleId());
}
}
private static class ExcludeRuleSpec extends ModuleVersionSpec {
private final ExcludeRule rule;
private ExcludeRuleSpec(ExcludeRule rule) {
this.rule = rule;
}
@Override
public String toString() {
return String.format("{exclude-rule %s}", rule);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (o == null || o.getClass() != getClass()) {
return false;
}
ExcludeRuleSpec other = (ExcludeRuleSpec) o;
// Can't use equals(), as DefaultExcludeRule.equals() does not consider the pattern matcher
return rule == other.rule;
}
@Override
public int hashCode() {
return rule.hashCode();
}
@Override
protected boolean doAcceptsSameModulesAs(ModuleVersionSpec other) {
ExcludeRuleSpec excludeRuleSpec = (ExcludeRuleSpec) other;
// Can't use equals(), as DefaultExcludeRule.equals() does not consider the pattern matcher
return rule == excludeRuleSpec.rule;
}
public boolean acceptModule(ModuleId element) {
ArtifactId artifactId = rule.getId();
boolean matchesRule = MatcherHelper.matches(rule.getMatcher(), artifactId.getModuleId(), element);
return !(matchesRule
&& matchesAnyExpression(artifactId.getName())
&& matchesAnyExpression(artifactId.getType())
&& matchesAnyExpression(artifactId.getExt()));
}
private boolean matchesAnyExpression(String attribute) {
return PatternMatcher.ANY_EXPRESSION.equals(attribute);
}
public boolean acceptArtifact(ArtifactId artifact) {
return !MatcherHelper.matches(rule.getMatcher(), rule.getId(), artifact);
}
}
}
| Remove redundant casts | subprojects/dependency-management/src/main/java/org/gradle/api/internal/artifacts/ivyservice/resolveengine/ModuleVersionSpec.java | Remove redundant casts | <ide><path>ubprojects/dependency-management/src/main/java/org/gradle/api/internal/artifacts/ivyservice/resolveengine/ModuleVersionSpec.java
<ide> if (!other.getClass().equals(getClass())) {
<ide> return false;
<ide> }
<del> return doAcceptsSameModulesAs((ModuleVersionSpec) other);
<add> return doAcceptsSameModulesAs(other);
<ide> }
<ide>
<ide> /**
<ide> if (this == ALL_SPEC) {
<ide> return other;
<ide> }
<del> return doIntersection((ModuleVersionSpec) other);
<add> return doIntersection(other);
<ide> }
<ide>
<ide> protected ModuleVersionSpec doIntersection(ModuleVersionSpec other) { |
|
Java | epl-1.0 | e20d24e3a0f09ff921c12c9ed05ad1cc98931ab5 | 0 | seddikouiss/pivo4j,mysticfall/pivot4j,mysticfall/pivot4j,mysticfall/pivot4j,seddikouiss/pivo4j,seddikouiss/pivo4j | /*
* ====================================================================
* This software is subject to the terms of the Common Public License
* Agreement, available at the following URL:
* http://www.opensource.org/licenses/cpl.html .
* You must accept the terms of that agreement to use this software.
* ====================================================================
*/
package com.eyeq.pivot4j.transform.impl;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.olap4j.Axis;
import org.olap4j.CellSet;
import org.olap4j.CellSetAxis;
import org.olap4j.OlapException;
import org.olap4j.Position;
import org.olap4j.metadata.Hierarchy;
import org.olap4j.metadata.Level;
import org.olap4j.metadata.Member;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.eyeq.pivot4j.PivotException;
import com.eyeq.pivot4j.mdx.Exp;
import com.eyeq.pivot4j.mdx.FunCall;
import com.eyeq.pivot4j.mdx.Syntax;
import com.eyeq.pivot4j.mdx.metadata.MemberExp;
import com.eyeq.pivot4j.query.Quax;
import com.eyeq.pivot4j.query.QueryAdapter;
import com.eyeq.pivot4j.transform.AbstractTransform;
import com.eyeq.pivot4j.transform.PlaceHierarchiesOnAxes;
import com.eyeq.pivot4j.transform.PlaceLevelsOnAxes;
import com.eyeq.pivot4j.transform.PlaceMembersOnAxes;
import com.eyeq.pivot4j.util.OlapUtils;
public class PlaceLevelsOnAxesImpl extends AbstractTransform implements
PlaceLevelsOnAxes {
protected Logger logger = LoggerFactory.getLogger(getClass());
/**
* @param queryAdapter
*/
public PlaceLevelsOnAxesImpl(QueryAdapter queryAdapter) {
super(queryAdapter);
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#placeLevels(org.olap4j.Axis,
* java.util.List)
*/
@Override
public void placeLevels(Axis axis, List<Level> levels) {
try {
QueryAdapter adapter = getQueryAdapter();
Quax quax = adapter.getQuaxes().get(axis.axisOrdinal());
List<Hierarchy> hierarchies = new ArrayList<Hierarchy>(
levels.size());
Map<Hierarchy, List<Member>> memberMap = new HashMap<Hierarchy, List<Member>>(
hierarchies.size());
for (Level level : levels) {
Hierarchy hierarchy = level.getHierarchy();
List<Member> members = level.getMembers();
for (Member member : members) {
if (!hierarchies.contains(hierarchy)) {
hierarchies.add(hierarchy);
}
List<Member> selection = memberMap.get(hierarchy);
if (selection == null) {
selection = new ArrayList<Member>(members.size());
memberMap.put(hierarchy, selection);
}
if (!selection.contains(member)) {
selection.add(member);
}
}
}
List<Exp> expressions = new ArrayList<Exp>(hierarchies.size());
for (Hierarchy hierarchy : hierarchies) {
List<Member> selection = memberMap.get(hierarchy);
List<Exp> sets = new ArrayList<Exp>(selection.size());
if (selection.size() == 1) {
expressions.add(new MemberExp(selection.get(0)));
} else {
for (Member member : selection) {
sets.add(new MemberExp(member));
}
expressions.add(new FunCall("{}", Syntax.Braces, sets));
}
}
// generate the crossjoins
quax.regeneratePosTree(expressions, true);
if (logger.isInfoEnabled()) {
logger.info("setQueryAxis axis=" + quax.getOrdinal()
+ " nDimension=" + hierarchies.size());
logger.info("Expression for Axis=" + quax.toString());
}
} catch (OlapException e) {
throw new PivotException(e);
}
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#addLevel(org.olap4j.Axis,
* org.olap4j.metadata.Level, int)
*/
@Override
public void addLevel(Axis axis, Level level, int position) {
PlaceHierarchiesOnAxes hierarchyTransform = getQueryAdapter()
.getModel().getTransform(PlaceHierarchiesOnAxes.class);
List<Hierarchy> hierarchies = hierarchyTransform
.findVisibleHierarchies(axis);
PlaceMembersOnAxes membersTransform = getQueryAdapter().getModel()
.getTransform(PlaceMembersOnAxes.class);
Hierarchy hierarchy = level.getHierarchy();
if (hierarchies.contains(hierarchy)) {
try {
membersTransform.addMembers(hierarchy, level.getMembers());
} catch (OlapException e) {
throw new PivotException(e);
}
} else {
hierarchies = new ArrayList<Hierarchy>(hierarchies);
if (position < 0 || position >= hierarchies.size()) {
hierarchies.add(hierarchy);
} else {
hierarchies.add(position, hierarchy);
}
List<Member> selection = new ArrayList<Member>();
for (Hierarchy hier : hierarchies) {
selection.addAll(membersTransform.findVisibleMembers(hier));
if (OlapUtils.equals(hier, hierarchy)) {
List<Member> members;
try {
members = level.getMembers();
} catch (OlapException e) {
throw new PivotException(e);
}
for (Member member : members) {
if (!selection.contains(member)) {
selection.add(member);
}
}
}
}
membersTransform.placeMembers(axis, selection);
}
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#removeLevel(org.olap4j.Axis,
* org.olap4j.metadata.Level)
*/
@Override
public void removeLevel(Axis axis, Level level) {
PlaceMembersOnAxes transform = getQueryAdapter().getModel()
.getTransform(PlaceMembersOnAxes.class);
List<Member> members = transform.findVisibleMembers(level
.getHierarchy());
List<Member> membersToRemove = new LinkedList<Member>();
for (Member member : members) {
if (OlapUtils.equals(level, member.getLevel())) {
membersToRemove.add(member);
}
}
for (Member member : membersToRemove) {
members.remove(member);
}
transform.placeMembers(level.getHierarchy(), members);
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#findVisibleLevels(org.olap4j
* .Axis)
*/
@Override
public List<Level> findVisibleLevels(Axis axis) {
List<Level> visibleLevels = new ArrayList<Level>();
QueryAdapter adapter = getQueryAdapter();
CellSet cellSet = adapter.getModel().getCellSet();
// locate the appropriate result axis
int iQuax = axis.axisOrdinal();
if (adapter.isAxesSwapped()) {
iQuax = (iQuax + 1) % 2;
}
CellSetAxis cellAxis = cellSet.getAxes().get(iQuax);
List<Position> positions = cellAxis.getPositions();
if (positions.isEmpty()) {
return Collections.emptyList();
}
int size = positions.get(0).getMembers().size();
for (int i = 0; i < size; i++) {
for (Position position : positions) {
Member member = position.getMembers().get(i);
if (!visibleLevels.contains(member.getLevel())) {
visibleLevels.add(member.getLevel());
}
}
}
return visibleLevels;
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#findVisibleLevels(org.olap4j
* .metadata.Hierarchy)
*/
@Override
public List<Level> findVisibleLevels(Hierarchy hierarchy) {
PlaceMembersOnAxes transform = getQueryAdapter().getModel()
.getTransform(PlaceMembersOnAxes.class);
List<Member> members = transform.findVisibleMembers(hierarchy);
List<Level> visibleLevels = new ArrayList<Level>(members.size());
for (Member member : members) {
if (!visibleLevels.contains(member.getLevel())) {
visibleLevels.add(member.getLevel());
}
}
return visibleLevels;
}
}
| pivot4j-core/src/main/java/com/eyeq/pivot4j/transform/impl/PlaceLevelsOnAxesImpl.java | /*
* ====================================================================
* This software is subject to the terms of the Common Public License
* Agreement, available at the following URL:
* http://www.opensource.org/licenses/cpl.html .
* You must accept the terms of that agreement to use this software.
* ====================================================================
*/
package com.eyeq.pivot4j.transform.impl;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.olap4j.Axis;
import org.olap4j.CellSet;
import org.olap4j.CellSetAxis;
import org.olap4j.OlapException;
import org.olap4j.Position;
import org.olap4j.metadata.Hierarchy;
import org.olap4j.metadata.Level;
import org.olap4j.metadata.Member;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.eyeq.pivot4j.PivotException;
import com.eyeq.pivot4j.mdx.Exp;
import com.eyeq.pivot4j.mdx.FunCall;
import com.eyeq.pivot4j.mdx.Syntax;
import com.eyeq.pivot4j.mdx.metadata.MemberExp;
import com.eyeq.pivot4j.query.Quax;
import com.eyeq.pivot4j.query.QueryAdapter;
import com.eyeq.pivot4j.transform.AbstractTransform;
import com.eyeq.pivot4j.transform.PlaceHierarchiesOnAxes;
import com.eyeq.pivot4j.transform.PlaceLevelsOnAxes;
import com.eyeq.pivot4j.transform.PlaceMembersOnAxes;
import com.eyeq.pivot4j.util.OlapUtils;
public class PlaceLevelsOnAxesImpl extends AbstractTransform implements
PlaceLevelsOnAxes {
protected Logger logger = LoggerFactory.getLogger(getClass());
/**
* @param queryAdapter
*/
public PlaceLevelsOnAxesImpl(QueryAdapter queryAdapter) {
super(queryAdapter);
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#placeLevels(org.olap4j.Axis,
* java.util.List)
*/
@Override
public void placeLevels(Axis axis, List<Level> levels) {
try {
QueryAdapter adapter = getQueryAdapter();
Quax quax = adapter.getQuaxes().get(axis.axisOrdinal());
List<Hierarchy> hierarchies = new ArrayList<Hierarchy>(
levels.size());
Map<Hierarchy, List<Member>> memberMap = new HashMap<Hierarchy, List<Member>>(
hierarchies.size());
for (Level level : levels) {
Hierarchy hierarchy = level.getHierarchy();
List<Member> members = level.getMembers();
for (Member member : members) {
if (!hierarchies.contains(hierarchy)) {
hierarchies.add(hierarchy);
}
List<Member> selection = memberMap.get(hierarchy);
if (selection == null) {
selection = new ArrayList<Member>(members.size());
memberMap.put(hierarchy, selection);
}
if (!selection.contains(member)) {
selection.add(member);
}
}
}
List<Exp> expressions = new ArrayList<Exp>(hierarchies.size());
for (Hierarchy hierarchy : hierarchies) {
List<Member> selection = memberMap.get(hierarchy);
List<Exp> sets = new ArrayList<Exp>(selection.size());
if (selection.size() == 1) {
expressions.add(new MemberExp(selection.get(0)));
} else {
for (Member member : selection) {
sets.add(new MemberExp(member));
}
expressions.add(new FunCall("{}", Syntax.Braces, sets));
}
}
// generate the crossjoins
quax.regeneratePosTree(expressions, true);
if (logger.isInfoEnabled()) {
logger.info("setQueryAxis axis=" + quax.getOrdinal()
+ " nDimension=" + hierarchies.size());
logger.info("Expression for Axis=" + quax.toString());
}
} catch (OlapException e) {
throw new PivotException(e);
}
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#addLevel(org.olap4j.Axis,
* org.olap4j.metadata.Level, int)
*/
@Override
public void addLevel(Axis axis, Level level, int position) {
PlaceHierarchiesOnAxes hierarchyTransform = getQueryAdapter()
.getModel().getTransform(PlaceHierarchiesOnAxes.class);
List<Hierarchy> hierarchies = hierarchyTransform
.findVisibleHierarchies(axis);
PlaceMembersOnAxes membersTransform = getQueryAdapter().getModel()
.getTransform(PlaceMembersOnAxes.class);
Hierarchy hierarchy = level.getHierarchy();
if (hierarchies.contains(hierarchy)) {
try {
membersTransform.addMembers(hierarchy, level.getMembers());
} catch (OlapException e) {
throw new PivotException(e);
}
} else {
hierarchies = new ArrayList<Hierarchy>(hierarchies);
if (position < 0 || position >= hierarchies.size()) {
hierarchies.add(hierarchy);
} else {
hierarchies.add(position, hierarchy);
}
List<Member> selection = new ArrayList<Member>();
for (Hierarchy hier : hierarchies) {
selection.addAll(membersTransform.findVisibleMembers(hier));
if (OlapUtils.equals(hier, hierarchy)) {
List<Member> members;
try {
members = level.getMembers();
} catch (OlapException e) {
throw new PivotException(e);
}
for (Member member : members) {
if (!selection.contains(member)) {
selection.add(member);
}
}
}
}
membersTransform.placeMembers(axis, selection);
}
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#removeLevel(org.olap4j.Axis,
* org.olap4j.metadata.Level)
*/
@Override
public void removeLevel(Axis axis, Level level) {
PlaceMembersOnAxes transform = getQueryAdapter().getModel()
.getTransform(PlaceMembersOnAxes.class);
List<Member> members = transform.findVisibleMembers(level
.getHierarchy());
List<Member> membersToRemove = new LinkedList<Member>();
for (Member member : members) {
if (OlapUtils.equals(level, member.getLevel())) {
membersToRemove.add(member);
}
}
for (Member member : membersToRemove) {
System.out.println("### " + member);
members.remove(member);
}
transform.placeMembers(level.getHierarchy(), members);
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#findVisibleLevels(org.olap4j
* .Axis)
*/
@Override
public List<Level> findVisibleLevels(Axis axis) {
List<Level> visibleLevels = new ArrayList<Level>();
QueryAdapter adapter = getQueryAdapter();
CellSet cellSet = adapter.getModel().getCellSet();
// locate the appropriate result axis
int iQuax = axis.axisOrdinal();
if (adapter.isAxesSwapped()) {
iQuax = (iQuax + 1) % 2;
}
CellSetAxis cellAxis = cellSet.getAxes().get(iQuax);
List<Position> positions = cellAxis.getPositions();
if (positions.isEmpty()) {
return Collections.emptyList();
}
int size = positions.get(0).getMembers().size();
for (int i = 0; i < size; i++) {
for (Position position : positions) {
Member member = position.getMembers().get(i);
if (!visibleLevels.contains(member.getLevel())) {
visibleLevels.add(member.getLevel());
}
}
}
return visibleLevels;
}
/**
* @see com.eyeq.pivot4j.transform.PlaceLevelsOnAxes#findVisibleLevels(org.olap4j
* .metadata.Hierarchy)
*/
@Override
public List<Level> findVisibleLevels(Hierarchy hierarchy) {
PlaceMembersOnAxes transform = getQueryAdapter().getModel()
.getTransform(PlaceMembersOnAxes.class);
List<Member> members = transform.findVisibleMembers(hierarchy);
List<Level> visibleLevels = new ArrayList<Level>(members.size());
for (Member member : members) {
if (!visibleLevels.contains(member.getLevel())) {
visibleLevels.add(member.getLevel());
}
}
return visibleLevels;
}
}
| Remove temporary println() call. | pivot4j-core/src/main/java/com/eyeq/pivot4j/transform/impl/PlaceLevelsOnAxesImpl.java | Remove temporary println() call. | <ide><path>ivot4j-core/src/main/java/com/eyeq/pivot4j/transform/impl/PlaceLevelsOnAxesImpl.java
<ide> }
<ide>
<ide> for (Member member : membersToRemove) {
<del> System.out.println("### " + member);
<ide> members.remove(member);
<ide> }
<ide> |
|
Java | apache-2.0 | fe7a463a1b5a24c22c7542e29557eb42765f93ef | 0 | dimone-kun/cuba,dimone-kun/cuba,dimone-kun/cuba,cuba-platform/cuba,cuba-platform/cuba,cuba-platform/cuba | /*
* Copyright (c) 2008-2014 Haulmont. All rights reserved.
* Use is subject to license terms, see http://www.cuba-platform.com/license for details.
*/
package com.haulmont.cuba.core.sys.persistence;
import javax.annotation.Nullable;
import java.util.HashMap;
import java.util.Map;
/**
* @author krivopustov
* @version $Id$
*/
@SuppressWarnings("UnusedDeclaration")
public class HsqlDbmsFeatures implements DbmsFeatures {
@Override
public Map<String, String> getJpaParameters() {
HashMap<String, String> params = new HashMap<>();
params.put("eclipselink.target-database", "org.eclipse.persistence.platform.database.HSQLPlatform");
return params;
}
@Override
public String getIdColumn() {
return "ID";
}
@Override
public String getDeleteTsColumn() {
return "DELETE_TS";
}
@Override
public String getTimeStampType() {
return "timestamp";
}
@Nullable
@Override
public String getUuidTypeClassName() {
return null;
}
@Nullable
@Override
public String getTransactionTimeoutStatement() {
return null;
}
@Override
public String getUniqueConstraintViolationPattern() {
return "integrity constraint violation: unique constraint or index violation: ([^\\s]+)";
}
@Override
public boolean isNullsLastSorting() {
return false;
}
}
| modules/core/src/com/haulmont/cuba/core/sys/persistence/HsqlDbmsFeatures.java | /*
* Copyright (c) 2008-2014 Haulmont. All rights reserved.
* Use is subject to license terms, see http://www.cuba-platform.com/license for details.
*/
package com.haulmont.cuba.core.sys.persistence;
import javax.annotation.Nullable;
import java.util.HashMap;
import java.util.Map;
/**
* @author krivopustov
* @version $Id$
*/
@SuppressWarnings("UnusedDeclaration")
public class HsqlDbmsFeatures implements DbmsFeatures {
@Override
public Map<String, String> getJpaParameters() {
HashMap<String, String> params = new HashMap<>();
params.put("eclipselink.target-database", "org.eclipse.persistence.platform.database.HSQLPlatform");
return params;
}
@Override
public String getIdColumn() {
return "ID";
}
@Override
public String getDeleteTsColumn() {
return "DELETE_TS";
}
@Override
public String getTimeStampType() {
return "timestamp";
}
@Nullable
@Override
public String getUuidTypeClassName() {
return null;
}
@Nullable
@Override
public String getTransactionTimeoutStatement() {
return null;
}
@Override
public String getUniqueConstraintViolationPattern() {
return "integrity constraint violation: unique constraint or index violation; ([^\\s]+)";
}
@Override
public boolean isNullsLastSorting() {
return false;
}
}
| PL-6675 UniqueConstraintViolationHandler does not work on HSQL
(cherry picked from commit 567a0f3)
| modules/core/src/com/haulmont/cuba/core/sys/persistence/HsqlDbmsFeatures.java | PL-6675 UniqueConstraintViolationHandler does not work on HSQL (cherry picked from commit 567a0f3) | <ide><path>odules/core/src/com/haulmont/cuba/core/sys/persistence/HsqlDbmsFeatures.java
<ide>
<ide> @Override
<ide> public String getUniqueConstraintViolationPattern() {
<del> return "integrity constraint violation: unique constraint or index violation; ([^\\s]+)";
<add> return "integrity constraint violation: unique constraint or index violation: ([^\\s]+)";
<ide> }
<ide>
<ide> @Override |
|
JavaScript | mit | c24228c354370cc8280f1597f7d7e1fbdc07c9bb | 0 | EtachGu/STAVis,EtachGu/STAVis | import React, { Component, PropTypes } from 'react';
import ReactDOM from 'react-dom';
import { connect } from 'react-redux';
import Helmet from 'react-helmet';
import { createStructuredSelector } from 'reselect';
// components
import MapDiv from './components/map';
import STMapDiv from './components/statisticMap';
// styles
import styles from './styles.css';
// select
import {
selectTrajectory,
selectControlsGeomType,
selectControlsMapType
} from './selectors';
class MapView extends Component {
constructor(props) {
super(props);
}
shouldComponentUpdate(nextProps, nextState) {
if (this.props.mapType !== nextProps.mapType || this.props.geomType !== nextProps.geomType) {
return true;
}
if (this.props.trajectories !== nextProps.trajectories) {
return true;
}
return false;
}
initialMap() {
const opacity = 0.6;
const map = new ol.Map({
renderer:('webgl'),
layers: [
new ol.layer.Tile({
// source: new ol.source.ImageWMS({
// url:'http://demo.opengeo.org/geoserver/wms',
// params:{'LAYERS':'ne:ne'},
// serverType:'geoserver'})
//
title:'OSM',
visible: true,
source: new ol.source.OSM({opaque:'false'}),
opacity:opacity
}),
new ol.layer.Tile({
// source: new ol.source.MapQuest({layer: 'sat'})
// source: new ol.source.OSM({opaque:'false'})
// source: new ol.source.Raster()
// source: new ol.source.ImageWMS({
// url:'http://demo.opengeo.org/geoserver/wms',
// params:{'LAYERS':'ne:ne'},
// serverType:'geoserver'})
//source: new ol.source.CartDB()
title:'toner-hybrid',
visible: false,
source: new ol.source.Stamen({
//layer: 'terrain-background'
// layer: 'terrain'
layer: 'toner-hybrid'
}),
// source: new ol.source.MapQuest({layer: 'osm'}),
opacity:opacity
// : {
// extension: 'png',
// opaque: false
// },
// 'terrain-lines': {
// extension: 'png',
// opaque: false
// },
// 'toner-background': {
// extension: 'png',
// opaque: true
// },
// 'toner': {
// extension: 'png',
// opaque: true
// },
// 'toner-hybrid': {
// extension: 'png',
// opaque: false
// },
// 'toner-labels': {
// extension: 'png',
// opaque: false
// },
// 'toner-lines': {
// extension: 'png',
// opaque: false
// },
// 'toner-lite': {
// extension: 'png',
// opaque: true
// },
// 'watercolor': {
// extension: 'jpg',
// opaque: true
// }
}),
// // 导入GeoJson文件数据
// new ol.layer.Vector({
// source: new ol.source.Vector({
// url: '../data2.geojson',
// format: new ol.format.GeoJSON()
// })
// // 设置点的格式"MultiPoint",
// // style:
// })
new ol.layer.Tile({
title:'MapQuest osm',
visible: false,
source: new ol.source.MapQuest({layer: 'osm'}),
opacity:opacity
}),
new ol.layer.Tile({
//
// source: new ol.source.OSM({opaque:'false'})
// source: new ol.source.Raster()
// source: new ol.source.ImageWMS({
// url:'http://demo.opengeo.org/geoserver/wms',
// params:{'LAYERS':'ne:ne'},
// serverType:'geoserver'})
//source: new ol.source.CartDB()
title:'MapQuest sat',
visible: false,
source: new ol.source.MapQuest({layer: 'sat'}),
opacity:opacity
}),
new ol.layer.Tile({
title:'ImageWMS',
visible: false,
source: new ol.source.ImageWMS({
url:'http://demo.opengeo.org/geoserver/wms',
params:{'LAYERS':'ne:ne'},
serverType:'geoserver'}),
opacity:opacity
})
],
target: 'map',
// controls: ol.control.defaults({
// attributionOptions: /** @type {olx.control.AttributionOptions} */ ({
// collapsible: false
// })
// }),
// 比例尺
controls: ol.control.defaults().extend([
new ol.control.ScaleLine()
]),
view: new ol.View({
center: ol.proj.transform([114.34500, 30.59389], 'EPSG:4326', 'EPSG:3857'),
zoom:4,
minZoom: 2
})
});
}
render() {
const mapData = this.props.trajectories.data;
const mapType = this.props.mapType;
const geomType = this.props.geomType;
let mapEChartsSeriesType;
switch (geomType) {
// case 1: mapDiv = (<STMapDiv className={styles.mapdiv} mapData={mapData} mapType={mapType} geomType={geomType}/>); break;
// case 2: mapDiv = (<MapDiv className={styles.mapdiv} mapData={mapData} mapType={mapType} geomType={geomType}/>); break;
case 1: mapEChartsSeriesType = 'scatter'; break;
case 2: mapEChartsSeriesType = 'lines'; break;
default: break;
}
const mapDiv = (<MapDiv className={styles.mapdiv} mapData={mapData} mapType={mapType} geomType={mapEChartsSeriesType}/>);
return (
<div>
{mapDiv}
</div>
);
}
}
MapView.propTypes = {
ij: React.PropTypes.any,
trajectories: React.PropTypes.object,
geomType: React.PropTypes.number,
mapType: React.PropTypes.number
};
// 任何时候，只要 Redux store 发生改变，mapStateToProps 函数就会被调用。
const mapStateToProps = createStructuredSelector({
trajectories:selectTrajectory,
geomType: selectControlsGeomType,
mapType: selectControlsMapType
});
// 如果你省略这个 mapDispatchToProps 参数，默认情况下，dispatch 会注入到你的组件 props 中。
export function mapDispatchToProps(dispatch) {
return {
changeRoute: (url) => dispatch(push(url)),
};
}
// react-redux 的使用方式
// connect([mapStateToProps], [mapDispatchToProps], [mergeProps], [options])
// 连接 React 组件与 Redux store。
export default connect(mapStateToProps, mapDispatchToProps)(MapView); | app/modules/TrajVA/components/MapView/index.js | import React, { Component, PropTypes } from 'react';
import ReactDOM from 'react-dom';
import { connect } from 'react-redux';
import Helmet from 'react-helmet';
import { createStructuredSelector } from 'reselect';
// components
import MapDiv from './components/map';
import STMapDiv from './components/statisticMap';
// styles
import styles from './styles.css';
// select
import {
selectTrajectory,
selectControls,
selectControlsGeomType,
selectControlsMapType
} from './selectors';
class MapView extends Component {
constructor(props) {
super(props);
}
shouldComponentUpdate(nextProps, nextState) {
if (this.props.mapType !== nextProps.mapType || this.props.geomType !== nextProps.geomType) {
return true;
}
if (this.props.trajectories !== nextProps.trajectories) {
return true;
}
return false;
}
initialMap() {
const opacity = 0.6;
const map = new ol.Map({
renderer:('webgl'),
layers: [
new ol.layer.Tile({
// source: new ol.source.ImageWMS({
// url:'http://demo.opengeo.org/geoserver/wms',
// params:{'LAYERS':'ne:ne'},
// serverType:'geoserver'})
//
title:'OSM',
visible: true,
source: new ol.source.OSM({opaque:'false'}),
opacity:opacity
}),
new ol.layer.Tile({
// source: new ol.source.MapQuest({layer: 'sat'})
// source: new ol.source.OSM({opaque:'false'})
// source: new ol.source.Raster()
// source: new ol.source.ImageWMS({
// url:'http://demo.opengeo.org/geoserver/wms',
// params:{'LAYERS':'ne:ne'},
// serverType:'geoserver'})
//source: new ol.source.CartDB()
title:'toner-hybrid',
visible: false,
source: new ol.source.Stamen({
//layer: 'terrain-background'
// layer: 'terrain'
layer: 'toner-hybrid'
}),
// source: new ol.source.MapQuest({layer: 'osm'}),
opacity:opacity
// : {
// extension: 'png',
// opaque: false
// },
// 'terrain-lines': {
// extension: 'png',
// opaque: false
// },
// 'toner-background': {
// extension: 'png',
// opaque: true
// },
// 'toner': {
// extension: 'png',
// opaque: true
// },
// 'toner-hybrid': {
// extension: 'png',
// opaque: false
// },
// 'toner-labels': {
// extension: 'png',
// opaque: false
// },
// 'toner-lines': {
// extension: 'png',
// opaque: false
// },
// 'toner-lite': {
// extension: 'png',
// opaque: true
// },
// 'watercolor': {
// extension: 'jpg',
// opaque: true
// }
}),
// // 导入GeoJson文件数据
// new ol.layer.Vector({
// source: new ol.source.Vector({
// url: '../data2.geojson',
// format: new ol.format.GeoJSON()
// })
// // 设置点的格式"MultiPoint",
// // style:
// })
new ol.layer.Tile({
title:'MapQuest osm',
visible: false,
source: new ol.source.MapQuest({layer: 'osm'}),
opacity:opacity
}),
new ol.layer.Tile({
//
// source: new ol.source.OSM({opaque:'false'})
// source: new ol.source.Raster()
// source: new ol.source.ImageWMS({
// url:'http://demo.opengeo.org/geoserver/wms',
// params:{'LAYERS':'ne:ne'},
// serverType:'geoserver'})
//source: new ol.source.CartDB()
title:'MapQuest sat',
visible: false,
source: new ol.source.MapQuest({layer: 'sat'}),
opacity:opacity
}),
new ol.layer.Tile({
title:'ImageWMS',
visible: false,
source: new ol.source.ImageWMS({
url:'http://demo.opengeo.org/geoserver/wms',
params:{'LAYERS':'ne:ne'},
serverType:'geoserver'}),
opacity:opacity
})
],
target: 'map',
// controls: ol.control.defaults({
// attributionOptions: /** @type {olx.control.AttributionOptions} */ ({
// collapsible: false
// })
// }),
// 比例尺
controls: ol.control.defaults().extend([
new ol.control.ScaleLine()
]),
view: new ol.View({
center: ol.proj.transform([114.34500, 30.59389], 'EPSG:4326', 'EPSG:3857'),
zoom:4,
minZoom: 2
})
});
}
render() {
const mapData = this.props.trajectories.data;
const mapType = this.props.mapType;
const geomType = this.props.geomType;
let mapEChartsSeriesType;
switch (geomType) {
// case 1: mapDiv = (<STMapDiv className={styles.mapdiv} mapData={mapData} mapType={mapType} geomType={geomType}/>); break;
// case 2: mapDiv = (<MapDiv className={styles.mapdiv} mapData={mapData} mapType={mapType} geomType={geomType}/>); break;
case 1: mapEChartsSeriesType = 'scatter'; break;
case 2: mapEChartsSeriesType = 'lines'; break;
default: break;
}
const mapDiv = (<MapDiv className={styles.mapdiv} mapData={mapData} mapType={mapType} geomType={mapEChartsSeriesType}/>);
return (
<div>
{mapDiv}
</div>
);
}
}
MapView.propTypes = {
ij: React.PropTypes.any,
trajectories: React.PropTypes.object,
controlsState: React.PropTypes.object,
geomType: React.PropTypes.number,
mapType: React.PropTypes.number
};
// 任何时候，只要 Redux store 发生改变，mapStateToProps 函数就会被调用。
const mapStateToProps = createStructuredSelector({
trajectories:selectTrajectory,
controlsState: selectControls,
geomType: selectControlsGeomType,
mapType: selectControlsMapType
});
// 如果你省略这个 mapDispatchToProps 参数，默认情况下，dispatch 会注入到你的组件 props 中。
export function mapDispatchToProps(dispatch) {
return {
changeRoute: (url) => dispatch(push(url)),
};
}
// react-redux 的使用方式
// connect([mapStateToProps], [mapDispatchToProps], [mergeProps], [options])
// 连接 React 组件与 Redux store。
export default connect(mapStateToProps, mapDispatchToProps)(MapView); | remove control selector
| app/modules/TrajVA/components/MapView/index.js | remove control selector | <ide><path>pp/modules/TrajVA/components/MapView/index.js
<ide> // select
<ide> import {
<ide> selectTrajectory,
<del> selectControls,
<ide> selectControlsGeomType,
<ide> selectControlsMapType
<ide> } from './selectors';
<ide> MapView.propTypes = {
<ide> ij: React.PropTypes.any,
<ide> trajectories: React.PropTypes.object,
<del> controlsState: React.PropTypes.object,
<ide> geomType: React.PropTypes.number,
<ide> mapType: React.PropTypes.number
<ide> };
<ide> // 任何时候，只要 Redux store 发生改变，mapStateToProps 函数就会被调用。
<ide> const mapStateToProps = createStructuredSelector({
<ide> trajectories:selectTrajectory,
<del> controlsState: selectControls,
<ide> geomType: selectControlsGeomType,
<ide> mapType: selectControlsMapType
<ide> }); |
|
Java | apache-2.0 | 20c85f56e0aac8554cf50862c4a537f969903b5d | 0 | hmusavi/jpo-ode,hmusavi/jpo-ode,hmusavi/jpo-ode,hmusavi/jpo-ode,hmusavi/jpo-ode | package us.dot.its.jpo.ode.plugin.j2735.builders;
import com.fasterxml.jackson.databind.JsonNode;
import us.dot.its.jpo.ode.plugin.j2735.J2735VehicleSize;
public class VehicleSizeBuilder {
private static final Integer WIDTH_LOWER_BOUND = 0;
private static final Integer WIDTH_UPPER_BOUND = 1023;
private static final Integer LENGTH_LOWER_BOUND = 0;
private static final Integer LENGTH_UPPER_BOUND = 4095;
public static J2735VehicleSize genericVehicleSizeBuilder(JsonNode vehicleSize) {
int size = vehicleSize.get("width").intValue();
if (size < WIDTH_LOWER_BOUND || size > WIDTH_UPPER_BOUND) {
throw new IllegalArgumentException("Vehicle width out of bounds [0..1023]");
}
int length = vehicleSize.get("length").intValue();
if (length < LENGTH_LOWER_BOUND || length > LENGTH_UPPER_BOUND) {
throw new IllegalArgumentException("Vehicle length out of bounds [0..4095]");
}
J2735VehicleSize genericVehicleSize = new J2735VehicleSize();
if (length != 0) {
genericVehicleSize.setLength(length);
} else {
genericVehicleSize.setLength(null);
}
int width = vehicleSize.get("width").intValue();
if (width != 0) {
genericVehicleSize.setWidth(width);
} else {
genericVehicleSize.setWidth(null);
}
return genericVehicleSize;
}
}
| jpo-ode-plugins/src/main/java/us/dot/its/jpo/ode/plugin/j2735/builders/VehicleSizeBuilder.java | package us.dot.its.jpo.ode.plugin.j2735.builders;
import com.fasterxml.jackson.databind.JsonNode;
import us.dot.its.jpo.ode.plugin.j2735.J2735VehicleSize;
public class VehicleSizeBuilder {
private static final Integer WIDTH_LOWER_BOUND = 0;
private static final Integer WIDTH_UPPER_BOUND = 1023;
private static final Integer LENGTH_LOWER_BOUND = 0;
private static final Integer LENGTH_UPPER_BOUND = 4095;
public VehicleSizeBuilder(JsonNode size) {
if (size.width.intValue() < WIDTH_LOWER_BOUND || size.width.intValue() > WIDTH_UPPER_BOUND) {
throw new IllegalArgumentException("Vehicle width out of bounds [0..1023]");
}
if (size.length.intValue() < LENGTH_LOWER_BOUND || size.length.intValue() > LENGTH_UPPER_BOUND) {
throw new IllegalArgumentException("Vehicle length out of bounds [0..4095]");
}
this.genericVehicleSize = new J2735VehicleSize();
if (size.length.intValue() != 0) {
this.genericVehicleSize.setLength(size.length.intValue());
} else {
this.genericVehicleSize.setLength(null);
}
if (size.width.intValue() != 0) {
this.genericVehicleSize.setWidth(size.width.intValue());
} else {
this.genericVehicleSize.setWidth(null);
}
}
}
| ODE-559 made it like the others.
| jpo-ode-plugins/src/main/java/us/dot/its/jpo/ode/plugin/j2735/builders/VehicleSizeBuilder.java | ODE-559 made it like the others. | <ide><path>po-ode-plugins/src/main/java/us/dot/its/jpo/ode/plugin/j2735/builders/VehicleSizeBuilder.java
<ide>
<ide> public class VehicleSizeBuilder {
<ide>
<del> private static final Integer WIDTH_LOWER_BOUND = 0;
<del> private static final Integer WIDTH_UPPER_BOUND = 1023;
<del> private static final Integer LENGTH_LOWER_BOUND = 0;
<del> private static final Integer LENGTH_UPPER_BOUND = 4095;
<add> private static final Integer WIDTH_LOWER_BOUND = 0;
<add> private static final Integer WIDTH_UPPER_BOUND = 1023;
<add> private static final Integer LENGTH_LOWER_BOUND = 0;
<add> private static final Integer LENGTH_UPPER_BOUND = 4095;
<ide>
<del> public VehicleSizeBuilder(JsonNode size) {
<del> if (size.width.intValue() < WIDTH_LOWER_BOUND || size.width.intValue() > WIDTH_UPPER_BOUND) {
<add> public static J2735VehicleSize genericVehicleSizeBuilder(JsonNode vehicleSize) {
<add> int size = vehicleSize.get("width").intValue();
<add>
<add> if (size < WIDTH_LOWER_BOUND || size > WIDTH_UPPER_BOUND) {
<ide> throw new IllegalArgumentException("Vehicle width out of bounds [0..1023]");
<ide> }
<ide>
<del> if (size.length.intValue() < LENGTH_LOWER_BOUND || size.length.intValue() > LENGTH_UPPER_BOUND) {
<add> int length = vehicleSize.get("length").intValue();
<add> if (length < LENGTH_LOWER_BOUND || length > LENGTH_UPPER_BOUND) {
<ide> throw new IllegalArgumentException("Vehicle length out of bounds [0..4095]");
<ide> }
<ide>
<del> this.genericVehicleSize = new J2735VehicleSize();
<add> J2735VehicleSize genericVehicleSize = new J2735VehicleSize();
<ide>
<del> if (size.length.intValue() != 0) {
<del> this.genericVehicleSize.setLength(size.length.intValue());
<add> if (length != 0) {
<add> genericVehicleSize.setLength(length);
<ide> } else {
<del> this.genericVehicleSize.setLength(null);
<add> genericVehicleSize.setLength(null);
<ide> }
<del> if (size.width.intValue() != 0) {
<del> this.genericVehicleSize.setWidth(size.width.intValue());
<add>
<add> int width = vehicleSize.get("width").intValue();
<add> if (width != 0) {
<add> genericVehicleSize.setWidth(width);
<ide> } else {
<del> this.genericVehicleSize.setWidth(null);
<add> genericVehicleSize.setWidth(null);
<ide> }
<add>
<add> return genericVehicleSize;
<ide> }
<ide>
<ide> } |
|
Java | lgpl-2.1 | 1678b8422762de06b4200558c3195c41825eb6bc | 0 | threerings/narya,threerings/narya,threerings/narya,threerings/narya,threerings/narya | //
// $Id: CharacterSprite.java,v 1.26 2002/04/15 23:07:14 mdb Exp $
package com.threerings.cast;
import com.threerings.media.sprite.MultiFrameImage;
import com.threerings.media.sprite.Path;
import com.threerings.media.sprite.ImageSprite;
/**
* A character sprite is a sprite that animates itself while walking
* about in a scene.
*/
public class CharacterSprite extends ImageSprite
implements StandardActions
{
/**
* Initializes this character sprite with the specified character
* descriptor and character manager. It will obtain animation data
* from the supplied character manager.
*/
public void init (CharacterDescriptor descrip, CharacterManager charmgr)
{
// keep track of this stuff
_descrip = descrip;
_charmgr = charmgr;
// assign an arbitrary starting orientation
_orient = NORTH;
}
/**
* Reconfigures this sprite to use the specified character descriptor.
*/
public void setCharacterDescriptor (CharacterDescriptor descrip)
{
// keep the new descriptor
_descrip = descrip;
// reset our action which will reload our frames
setActionSequence(_action);
}
/**
* Specifies the action to use when the sprite is at rest. The default
* is <code>STANDING</code>.
*/
public void setRestingAction (String action)
{
_restingAction = action;
}
/**
* Returns the action to be used when the sprite is at rest. Derived
* classes may wish to override this method and vary the action based
* on external parameters (or randomly).
*/
public String getRestingAction ()
{
return _restingAction;
}
/**
* Specifies the action to use when the sprite is following a path.
* The default is <code>WALKING</code>.
*/
public void setFollowingPathAction (String action)
{
_followingPathAction = action;
}
/**
* Returns the action to be used when the sprite is following a path.
* Derived classes may wish to override this method and vary the
* action based on external parameters (or randomly).
*/
public String getFollowingPathAction ()
{
return _followingPathAction;
}
/**
* Sets the action sequence used when rendering the character, from
* the set of available sequences.
*/
public void setActionSequence (String action)
{
// keep track of our current action in case someone swaps out our
// character description
_action = action;
// get a reference to the action sequence so that we can obtain
// our animation frames and configure our frames per second
ActionSequence actseq = _charmgr.getActionSequence(action);
if (actseq == null) {
String errmsg = "No such action '" + action + "'.";
throw new IllegalArgumentException(errmsg);
}
try {
// obtain our animation frames for this action sequence
_frames = _charmgr.getActionFrames(_descrip, action);
// update the sprite render attributes
setOrigin(actseq.origin.x, actseq.origin.y);
setFrameRate(actseq.framesPerSecond);
setFrames(_frames[_orient]);
} catch (NoSuchComponentException nsce) {
Log.warning("Character sprite references non-existent " +
"component [sprite=" + this + ", err=" + nsce + "].");
}
}
// documentation inherited
public void setOrientation (int orient)
{
super.setOrientation(orient);
// sanity check
if (orient < 0 || orient >= _frames.length) {
String errmsg = "Invalid orientation requested " +
"[orient=" + orient +
", fcount=" + ((_frames == null) ? -1 : _frames.length) + "]";
throw new IllegalArgumentException(errmsg);
}
// update the sprite frames to reflect the direction
if (_frames != null) {
setFrames(_frames[orient]);
}
}
/**
* Sets the origin coordinates representing the "base" of the
* sprite, which in most cases corresponds to the center of the
* bottom of the sprite image.
*/
public void setOrigin (int x, int y)
{
_xorigin = x;
_yorigin = y;
updateRenderOffset();
updateRenderOrigin();
}
// documentation inherited
protected void updateRenderOffset ()
{
super.updateRenderOffset();
if (_frame != null) {
// our location is based on the character origin coordinates
_rxoff = -_xorigin;
_ryoff = -_yorigin;
}
}
// documentation inherited
public void cancelMove ()
{
super.cancelMove();
halt();
}
// documentation inherited
protected void pathBeginning ()
{
super.pathBeginning();
// enable walking animation
setActionSequence(getFollowingPathAction());
setAnimationMode(TIME_BASED);
}
// documentation inherited
protected void pathCompleted ()
{
super.pathCompleted();
halt();
}
/**
* Updates the sprite animation frame to reflect the cessation of
* movement and disables any further animation.
*/
protected void halt ()
{
// disable animation
setAnimationMode(NO_ANIMATION);
// come to a halt looking settled and at peace
setActionSequence(getRestingAction());
}
/** The action to use when at rest. */
protected String _restingAction = STANDING;
/** The action to use when following a path. */
protected String _followingPathAction = WALKING;
/** A reference to the descriptor for the character that we're
* visualizing. */
protected CharacterDescriptor _descrip;
/** A reference to the character manager that created us. */
protected CharacterManager _charmgr;
/** The action we are currently displaying. */
protected String _action;
/** The animation frames for the active action sequence in each
* orientation. */
protected MultiFrameImage[] _frames;
/** The origin of the sprite. */
protected int _xorigin, _yorigin;
}
| src/java/com/threerings/cast/CharacterSprite.java | //
// $Id: CharacterSprite.java,v 1.25 2002/03/16 03:15:04 shaper Exp $
package com.threerings.cast;
import com.threerings.media.sprite.MultiFrameImage;
import com.threerings.media.sprite.Path;
import com.threerings.media.sprite.ImageSprite;
/**
* A character sprite is a sprite that animates itself while walking
* about in a scene.
*/
public class CharacterSprite extends ImageSprite
implements StandardActions
{
/**
* Initializes this character sprite with the specified character
* descriptor and character manager. It will obtain animation data
* from the supplied character manager.
*/
public void init (CharacterDescriptor descrip, CharacterManager charmgr)
{
// keep track of this stuff
_descrip = descrip;
_charmgr = charmgr;
// assign an arbitrary starting orientation
_orient = NORTH;
}
/**
* Reconfigures this sprite to use the specified character descriptor.
*/
public void setCharacterDescriptor (CharacterDescriptor descrip)
{
// keep the new descriptor
_descrip = descrip;
// reset our action which will reload our frames
setActionSequence(_action);
}
/**
* Specifies the action to use when the sprite is at rest. The default
* is <code>STANDING</code>.
*/
public void setRestingAction (String action)
{
_restingAction = action;
}
/**
* Returns the action to be used when the sprite is at rest. Derived
* classes may wish to override this method and vary the action based
* on external parameters (or randomly).
*/
public String getRestingAction ()
{
return _restingAction;
}
/**
* Specifies the action to use when the sprite is following a path.
* The default is <code>WALKING</code>.
*/
public void setFollowingPathAction (String action)
{
_followingPathAction = action;
}
/**
* Returns the action to be used when the sprite is following a path.
* Derived classes may wish to override this method and vary the
* action based on external parameters (or randomly).
*/
public String getFollowingPathAction ()
{
return _followingPathAction;
}
/**
* Sets the action sequence used when rendering the character, from
* the set of available sequences.
*/
public void setActionSequence (String action)
{
// keep track of our current action in case someone swaps out our
// character description
_action = action;
// get a reference to the action sequence so that we can obtain
// our animation frames and configure our frames per second
ActionSequence actseq = _charmgr.getActionSequence(action);
if (actseq == null) {
String errmsg = "No such action '" + action + "'.";
throw new IllegalArgumentException(errmsg);
}
try {
// obtain our animation frames for this action sequence
_frames = _charmgr.getActionFrames(_descrip, action);
// update the sprite render attributes
setOrigin(actseq.origin.x, actseq.origin.y);
setFrameRate(actseq.framesPerSecond);
setFrames(_frames[_orient]);
} catch (NoSuchComponentException nsce) {
Log.warning("Character sprite references non-existent " +
"component [sprite=" + this + ", err=" + nsce + "].");
}
}
// documentation inherited
public void setOrientation (int orient)
{
super.setOrientation(orient);
// update the sprite frames to reflect the direction
if (_frames != null) {
setFrames(_frames[orient]);
}
}
/**
* Sets the origin coordinates representing the "base" of the
* sprite, which in most cases corresponds to the center of the
* bottom of the sprite image.
*/
public void setOrigin (int x, int y)
{
_xorigin = x;
_yorigin = y;
updateRenderOffset();
updateRenderOrigin();
}
// documentation inherited
protected void updateRenderOffset ()
{
super.updateRenderOffset();
if (_frame != null) {
// our location is based on the character origin coordinates
_rxoff = -_xorigin;
_ryoff = -_yorigin;
}
}
// documentation inherited
public void cancelMove ()
{
super.cancelMove();
halt();
}
// documentation inherited
protected void pathBeginning ()
{
super.pathBeginning();
// enable walking animation
setActionSequence(getFollowingPathAction());
setAnimationMode(TIME_BASED);
}
// documentation inherited
protected void pathCompleted ()
{
super.pathCompleted();
halt();
}
/**
* Updates the sprite animation frame to reflect the cessation of
* movement and disables any further animation.
*/
protected void halt ()
{
// disable animation
setAnimationMode(NO_ANIMATION);
// come to a halt looking settled and at peace
setActionSequence(getRestingAction());
}
/** The action to use when at rest. */
protected String _restingAction = STANDING;
/** The action to use when following a path. */
protected String _followingPathAction = WALKING;
/** A reference to the descriptor for the character that we're
* visualizing. */
protected CharacterDescriptor _descrip;
/** A reference to the character manager that created us. */
protected CharacterManager _charmgr;
/** The action we are currently displaying. */
protected String _action;
/** The animation frames for the active action sequence in each
* orientation. */
protected MultiFrameImage[] _frames;
/** The origin of the sprite. */
protected int _xorigin, _yorigin;
}
| Sanity check our orientation in setOrientation() and complain sensically
if it's bogus (rather than NPEing).
git-svn-id: a1a4b28b82a3276cc491891159dd9963a0a72fae@1251 542714f4-19e9-0310-aa3c-eee0fc999fb1
| src/java/com/threerings/cast/CharacterSprite.java | Sanity check our orientation in setOrientation() and complain sensically if it's bogus (rather than NPEing). | <ide><path>rc/java/com/threerings/cast/CharacterSprite.java
<ide> //
<del>// $Id: CharacterSprite.java,v 1.25 2002/03/16 03:15:04 shaper Exp $
<add>// $Id: CharacterSprite.java,v 1.26 2002/04/15 23:07:14 mdb Exp $
<ide>
<ide> package com.threerings.cast;
<ide>
<ide> {
<ide> super.setOrientation(orient);
<ide>
<add> // sanity check
<add> if (orient < 0 || orient >= _frames.length) {
<add> String errmsg = "Invalid orientation requested " +
<add> "[orient=" + orient +
<add> ", fcount=" + ((_frames == null) ? -1 : _frames.length) + "]";
<add> throw new IllegalArgumentException(errmsg);
<add> }
<add>
<ide> // update the sprite frames to reflect the direction
<ide> if (_frames != null) {
<ide> setFrames(_frames[orient]); |
|
Java | apache-2.0 | 865299d7cf49ed0bf1e2897afe251cafd0c547a9 | 0 | zentol/flink,wwjiang007/flink,xccui/flink,wwjiang007/flink,lincoln-lil/flink,lincoln-lil/flink,godfreyhe/flink,xccui/flink,apache/flink,gyfora/flink,zjureel/flink,gyfora/flink,lincoln-lil/flink,gyfora/flink,zjureel/flink,lincoln-lil/flink,gyfora/flink,zjureel/flink,apache/flink,wwjiang007/flink,apache/flink,apache/flink,apache/flink,wwjiang007/flink,apache/flink,gyfora/flink,gyfora/flink,zjureel/flink,zentol/flink,godfreyhe/flink,wwjiang007/flink,wwjiang007/flink,xccui/flink,zjureel/flink,lincoln-lil/flink,godfreyhe/flink,godfreyhe/flink,godfreyhe/flink,zentol/flink,zjureel/flink,zentol/flink,xccui/flink,zjureel/flink,godfreyhe/flink,wwjiang007/flink,xccui/flink,godfreyhe/flink,xccui/flink,apache/flink,lincoln-lil/flink,zentol/flink,gyfora/flink,zentol/flink,xccui/flink,lincoln-lil/flink,zentol/flink | /*
* 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.flink.runtime.metrics;
import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.api.common.time.Time;
import org.apache.flink.configuration.MetricOptions;
import org.apache.flink.metrics.Metric;
import org.apache.flink.metrics.MetricGroup;
import org.apache.flink.metrics.View;
import org.apache.flink.metrics.reporter.MetricReporter;
import org.apache.flink.metrics.reporter.Scheduled;
import org.apache.flink.runtime.clusterframework.types.ResourceID;
import org.apache.flink.runtime.metrics.dump.MetricQueryService;
import org.apache.flink.runtime.metrics.groups.AbstractMetricGroup;
import org.apache.flink.runtime.metrics.groups.FrontMetricGroup;
import org.apache.flink.runtime.metrics.groups.ReporterScopedSettings;
import org.apache.flink.runtime.metrics.scope.ScopeFormats;
import org.apache.flink.runtime.rpc.RpcService;
import org.apache.flink.runtime.webmonitor.retriever.MetricQueryServiceGateway;
import org.apache.flink.util.ExceptionUtils;
import org.apache.flink.util.ExecutorUtils;
import org.apache.flink.util.FlinkException;
import org.apache.flink.util.Preconditions;
import org.apache.flink.util.TimeUtils;
import org.apache.flink.util.concurrent.ExecutorThreadFactory;
import org.apache.flink.util.concurrent.FutureUtils;
import org.apache.flink.util.function.QuadConsumer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.TimerTask;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
/**
* A MetricRegistry keeps track of all registered {@link Metric Metrics}. It serves as the
* connection between {@link MetricGroup MetricGroups} and {@link MetricReporter MetricReporters}.
*/
public class MetricRegistryImpl implements MetricRegistry {
private static final Logger LOG = LoggerFactory.getLogger(MetricRegistryImpl.class);
private final Object lock = new Object();
private final List<ReporterAndSettings> reporters;
private final ScheduledExecutorService executor;
private final ScopeFormats scopeFormats;
private final char globalDelimiter;
private final CompletableFuture<Void> terminationFuture;
private final long maximumFramesize;
@Nullable private MetricQueryService queryService;
@Nullable private RpcService metricQueryServiceRpcService;
private ViewUpdater viewUpdater;
private boolean isShutdown;
public MetricRegistryImpl(MetricRegistryConfiguration config) {
this(config, Collections.emptyList());
}
/** Creates a new MetricRegistry and starts the configured reporter. */
public MetricRegistryImpl(
MetricRegistryConfiguration config, Collection<ReporterSetup> reporterConfigurations) {
this(
config,
reporterConfigurations,
Executors.newSingleThreadScheduledExecutor(
new ExecutorThreadFactory("Flink-MetricRegistry")));
}
@VisibleForTesting
MetricRegistryImpl(
MetricRegistryConfiguration config,
Collection<ReporterSetup> reporterConfigurations,
ScheduledExecutorService scheduledExecutor) {
this.maximumFramesize = config.getQueryServiceMessageSizeLimit();
this.scopeFormats = config.getScopeFormats();
this.globalDelimiter = config.getDelimiter();
this.terminationFuture = new CompletableFuture<>();
this.isShutdown = false;
// second, instantiate any custom configured reporters
this.reporters = new ArrayList<>(4);
this.executor = scheduledExecutor;
this.queryService = null;
this.metricQueryServiceRpcService = null;
if (reporterConfigurations.isEmpty()) {
// no reporters defined
// by default, don't report anything
LOG.info("No metrics reporter configured, no metrics will be exposed/reported.");
} else {
for (ReporterSetup reporterSetup : reporterConfigurations) {
final String namedReporter = reporterSetup.getName();
try {
final MetricReporter reporterInstance = reporterSetup.getReporter();
final String className = reporterInstance.getClass().getName();
if (reporterInstance instanceof Scheduled) {
final Duration period = getConfiguredIntervalOrDefault(reporterSetup);
LOG.info(
"Periodically reporting metrics in intervals of {} for reporter {} of type {}.",
TimeUtils.formatWithHighestUnit(period),
namedReporter,
className);
executor.scheduleWithFixedDelay(
new MetricRegistryImpl.ReporterTask((Scheduled) reporterInstance),
period.toMillis(),
period.toMillis(),
TimeUnit.MILLISECONDS);
} else {
LOG.info(
"Reporting metrics for reporter {} of type {}.",
namedReporter,
className);
}
String delimiterForReporter =
reporterSetup.getDelimiter().orElse(String.valueOf(globalDelimiter));
if (delimiterForReporter.length() != 1) {
LOG.warn(
"Failed to parse delimiter '{}' for reporter '{}', using global delimiter '{}'.",
delimiterForReporter,
namedReporter,
globalDelimiter);
delimiterForReporter = String.valueOf(globalDelimiter);
}
reporters.add(
new ReporterAndSettings(
reporterInstance,
new ReporterScopedSettings(
reporters.size(),
delimiterForReporter.charAt(0),
reporterSetup.getExcludedVariables(),
reporterSetup.getAdditionalVariables())));
} catch (Throwable t) {
LOG.error(
"Could not instantiate metrics reporter {}. Metrics might not be exposed/reported.",
namedReporter,
t);
}
}
}
}
private static Duration getConfiguredIntervalOrDefault(ReporterSetup reporterSetup) {
final Optional<String> configuredPeriod = reporterSetup.getIntervalSettings();
Duration period = MetricOptions.REPORTER_INTERVAL.defaultValue();
if (configuredPeriod.isPresent()) {
try {
period = TimeUtils.parseDuration(configuredPeriod.get());
} catch (Exception e) {
LOG.error(
"Cannot parse report interval from config: "
+ configuredPeriod
+ " - please use values like '10 SECONDS' or '500 MILLISECONDS'. "
+ "Using default reporting interval.");
}
}
return period;
}
/**
* Initializes the MetricQueryService.
*
* @param rpcService RpcService to create the MetricQueryService on
* @param resourceID resource ID used to disambiguate the actor name
*/
public void startQueryService(RpcService rpcService, ResourceID resourceID) {
synchronized (lock) {
Preconditions.checkState(
!isShutdown(), "The metric registry has already been shut down.");
try {
metricQueryServiceRpcService = rpcService;
queryService =
MetricQueryService.createMetricQueryService(
rpcService, resourceID, maximumFramesize);
queryService.start();
} catch (Exception e) {
LOG.warn(
"Could not start MetricDumpActor. No metrics will be submitted to the WebInterface.",
e);
}
}
}
/**
* Returns the rpc service that the {@link MetricQueryService} runs in.
*
* @return rpc service of hte MetricQueryService
*/
@Nullable
public RpcService getMetricQueryServiceRpcService() {
return metricQueryServiceRpcService;
}
/**
* Returns the address under which the {@link MetricQueryService} is reachable.
*
* @return address of the metric query service
*/
@Override
@Nullable
public String getMetricQueryServiceGatewayRpcAddress() {
if (queryService != null) {
return queryService.getSelfGateway(MetricQueryServiceGateway.class).getAddress();
} else {
return null;
}
}
@VisibleForTesting
@Nullable
MetricQueryServiceGateway getMetricQueryServiceGateway() {
if (queryService != null) {
return queryService.getSelfGateway(MetricQueryServiceGateway.class);
} else {
return null;
}
}
@Override
public char getDelimiter() {
return this.globalDelimiter;
}
@VisibleForTesting
char getDelimiter(int reporterIndex) {
try {
return reporters.get(reporterIndex).getSettings().getDelimiter();
} catch (IndexOutOfBoundsException e) {
LOG.warn(
"Delimiter for reporter index {} not found, returning global delimiter.",
reporterIndex);
return this.globalDelimiter;
}
}
@Override
public int getNumberReporters() {
return reporters.size();
}
@VisibleForTesting
public List<MetricReporter> getReporters() {
return reporters.stream()
.map(ReporterAndSettings::getReporter)
.collect(Collectors.toList());
}
/**
* Returns whether this registry has been shutdown.
*
* @return true, if this registry was shutdown, otherwise false
*/
public boolean isShutdown() {
synchronized (lock) {
return isShutdown;
}
}
/**
* Shuts down this registry and the associated {@link MetricReporter}.
*
* <p>NOTE: This operation is asynchronous and returns a future which is completed once the
* shutdown operation has been completed.
*
* @return Future which is completed once the {@link MetricRegistryImpl} is shut down.
*/
public CompletableFuture<Void> shutdown() {
synchronized (lock) {
if (isShutdown) {
return terminationFuture;
} else {
isShutdown = true;
final Collection<CompletableFuture<Void>> terminationFutures = new ArrayList<>(3);
final Time gracePeriod = Time.seconds(1L);
if (metricQueryServiceRpcService != null) {
final CompletableFuture<Void> metricQueryServiceRpcServiceTerminationFuture =
metricQueryServiceRpcService.stopService();
terminationFutures.add(metricQueryServiceRpcServiceTerminationFuture);
}
Throwable throwable = null;
for (ReporterAndSettings reporterAndSettings : reporters) {
try {
reporterAndSettings.getReporter().close();
} catch (Throwable t) {
throwable = ExceptionUtils.firstOrSuppressed(t, throwable);
}
}
reporters.clear();
if (throwable != null) {
terminationFutures.add(
FutureUtils.completedExceptionally(
new FlinkException(
"Could not shut down the metric reporters properly.",
throwable)));
}
final CompletableFuture<Void> executorShutdownFuture =
ExecutorUtils.nonBlockingShutdown(
gracePeriod.toMilliseconds(), TimeUnit.MILLISECONDS, executor);
terminationFutures.add(executorShutdownFuture);
FutureUtils.completeAll(terminationFutures)
.whenComplete(
(Void ignored, Throwable error) -> {
if (error != null) {
terminationFuture.completeExceptionally(error);
} else {
terminationFuture.complete(null);
}
});
return terminationFuture;
}
}
}
@Override
public ScopeFormats getScopeFormats() {
return scopeFormats;
}
// ------------------------------------------------------------------------
// Metrics (de)registration
// ------------------------------------------------------------------------
@Override
public void register(Metric metric, String metricName, AbstractMetricGroup group) {
synchronized (lock) {
if (isShutdown()) {
LOG.warn(
"Cannot register metric, because the MetricRegistry has already been shut down.");
} else {
if (reporters != null) {
forAllReporters(MetricReporter::notifyOfAddedMetric, metric, metricName, group);
}
try {
if (queryService != null) {
queryService.addMetric(metricName, metric, group);
}
} catch (Exception e) {
LOG.warn("Error while registering metric: {}.", metricName, e);
}
try {
if (metric instanceof View) {
if (viewUpdater == null) {
viewUpdater = new ViewUpdater(executor);
}
viewUpdater.notifyOfAddedView((View) metric);
}
} catch (Exception e) {
LOG.warn("Error while registering metric: {}.", metricName, e);
}
}
}
}
@Override
public void unregister(Metric metric, String metricName, AbstractMetricGroup group) {
synchronized (lock) {
if (isShutdown()) {
LOG.warn(
"Cannot unregister metric, because the MetricRegistry has already been shut down.");
} else {
if (reporters != null) {
forAllReporters(
MetricReporter::notifyOfRemovedMetric, metric, metricName, group);
}
try {
if (queryService != null) {
queryService.removeMetric(metric);
}
} catch (Exception e) {
LOG.warn("Error while unregistering metric: {}.", metricName, e);
}
try {
if (metric instanceof View) {
if (viewUpdater != null) {
viewUpdater.notifyOfRemovedView((View) metric);
}
}
} catch (Exception e) {
LOG.warn("Error while unregistering metric: {}", metricName, e);
}
}
}
}
@GuardedBy("lock")
private void forAllReporters(
QuadConsumer<MetricReporter, Metric, String, MetricGroup> operation,
Metric metric,
String metricName,
AbstractMetricGroup group) {
for (int i = 0; i < reporters.size(); i++) {
try {
ReporterAndSettings reporterAndSettings = reporters.get(i);
if (reporterAndSettings != null) {
FrontMetricGroup front =
new FrontMetricGroup<AbstractMetricGroup<?>>(
reporterAndSettings.getSettings(), group);
operation.accept(reporterAndSettings.getReporter(), metric, metricName, front);
}
} catch (Exception e) {
LOG.warn("Error while handling metric: {}.", metricName, e);
}
}
}
// ------------------------------------------------------------------------
@VisibleForTesting
@Nullable
MetricQueryService getQueryService() {
return queryService;
}
// ------------------------------------------------------------------------
/**
* This task is explicitly a static class, so that it does not hold any references to the
* enclosing MetricsRegistry instance.
*
* <p>This is a subtle difference, but very important: With this static class, the enclosing
* class instance may become garbage-collectible, whereas with an anonymous inner class, the
* timer thread (which is a GC root) will hold a reference via the timer task and its enclosing
* instance pointer. Making the MetricsRegistry garbage collectible makes the java.util.Timer
* garbage collectible, which acts as a fail-safe to stop the timer thread and prevents resource
* leaks.
*/
private static final class ReporterTask extends TimerTask {
private final Scheduled reporter;
private ReporterTask(Scheduled reporter) {
this.reporter = reporter;
}
@Override
public void run() {
try {
reporter.report();
} catch (Throwable t) {
LOG.warn("Error while reporting metrics", t);
}
}
}
private static class ReporterAndSettings {
private final MetricReporter reporter;
private final ReporterScopedSettings settings;
private ReporterAndSettings(MetricReporter reporter, ReporterScopedSettings settings) {
this.reporter = Preconditions.checkNotNull(reporter);
this.settings = Preconditions.checkNotNull(settings);
}
public MetricReporter getReporter() {
return reporter;
}
public ReporterScopedSettings getSettings() {
return settings;
}
}
}
| flink-runtime/src/main/java/org/apache/flink/runtime/metrics/MetricRegistryImpl.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.flink.runtime.metrics;
import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.api.common.time.Time;
import org.apache.flink.configuration.MetricOptions;
import org.apache.flink.metrics.Metric;
import org.apache.flink.metrics.MetricGroup;
import org.apache.flink.metrics.View;
import org.apache.flink.metrics.reporter.MetricReporter;
import org.apache.flink.metrics.reporter.Scheduled;
import org.apache.flink.runtime.clusterframework.types.ResourceID;
import org.apache.flink.runtime.metrics.dump.MetricQueryService;
import org.apache.flink.runtime.metrics.groups.AbstractMetricGroup;
import org.apache.flink.runtime.metrics.groups.FrontMetricGroup;
import org.apache.flink.runtime.metrics.groups.ReporterScopedSettings;
import org.apache.flink.runtime.metrics.scope.ScopeFormats;
import org.apache.flink.runtime.rpc.RpcService;
import org.apache.flink.runtime.webmonitor.retriever.MetricQueryServiceGateway;
import org.apache.flink.util.ExceptionUtils;
import org.apache.flink.util.ExecutorUtils;
import org.apache.flink.util.FlinkException;
import org.apache.flink.util.Preconditions;
import org.apache.flink.util.TimeUtils;
import org.apache.flink.util.concurrent.ExecutorThreadFactory;
import org.apache.flink.util.concurrent.FutureUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nullable;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.TimerTask;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
/**
* A MetricRegistry keeps track of all registered {@link Metric Metrics}. It serves as the
* connection between {@link MetricGroup MetricGroups} and {@link MetricReporter MetricReporters}.
*/
public class MetricRegistryImpl implements MetricRegistry {
private static final Logger LOG = LoggerFactory.getLogger(MetricRegistryImpl.class);
private final Object lock = new Object();
private final List<ReporterAndSettings> reporters;
private final ScheduledExecutorService executor;
private final ScopeFormats scopeFormats;
private final char globalDelimiter;
private final CompletableFuture<Void> terminationFuture;
private final long maximumFramesize;
@Nullable private MetricQueryService queryService;
@Nullable private RpcService metricQueryServiceRpcService;
private ViewUpdater viewUpdater;
private boolean isShutdown;
public MetricRegistryImpl(MetricRegistryConfiguration config) {
this(config, Collections.emptyList());
}
/** Creates a new MetricRegistry and starts the configured reporter. */
public MetricRegistryImpl(
MetricRegistryConfiguration config, Collection<ReporterSetup> reporterConfigurations) {
this(
config,
reporterConfigurations,
Executors.newSingleThreadScheduledExecutor(
new ExecutorThreadFactory("Flink-MetricRegistry")));
}
@VisibleForTesting
MetricRegistryImpl(
MetricRegistryConfiguration config,
Collection<ReporterSetup> reporterConfigurations,
ScheduledExecutorService scheduledExecutor) {
this.maximumFramesize = config.getQueryServiceMessageSizeLimit();
this.scopeFormats = config.getScopeFormats();
this.globalDelimiter = config.getDelimiter();
this.terminationFuture = new CompletableFuture<>();
this.isShutdown = false;
// second, instantiate any custom configured reporters
this.reporters = new ArrayList<>(4);
this.executor = scheduledExecutor;
this.queryService = null;
this.metricQueryServiceRpcService = null;
if (reporterConfigurations.isEmpty()) {
// no reporters defined
// by default, don't report anything
LOG.info("No metrics reporter configured, no metrics will be exposed/reported.");
} else {
for (ReporterSetup reporterSetup : reporterConfigurations) {
final String namedReporter = reporterSetup.getName();
try {
final MetricReporter reporterInstance = reporterSetup.getReporter();
final String className = reporterInstance.getClass().getName();
if (reporterInstance instanceof Scheduled) {
final Duration period = getConfiguredIntervalOrDefault(reporterSetup);
LOG.info(
"Periodically reporting metrics in intervals of {} for reporter {} of type {}.",
TimeUtils.formatWithHighestUnit(period),
namedReporter,
className);
executor.scheduleWithFixedDelay(
new MetricRegistryImpl.ReporterTask((Scheduled) reporterInstance),
period.toMillis(),
period.toMillis(),
TimeUnit.MILLISECONDS);
} else {
LOG.info(
"Reporting metrics for reporter {} of type {}.",
namedReporter,
className);
}
String delimiterForReporter =
reporterSetup.getDelimiter().orElse(String.valueOf(globalDelimiter));
if (delimiterForReporter.length() != 1) {
LOG.warn(
"Failed to parse delimiter '{}' for reporter '{}', using global delimiter '{}'.",
delimiterForReporter,
namedReporter,
globalDelimiter);
delimiterForReporter = String.valueOf(globalDelimiter);
}
reporters.add(
new ReporterAndSettings(
reporterInstance,
new ReporterScopedSettings(
reporters.size(),
delimiterForReporter.charAt(0),
reporterSetup.getExcludedVariables(),
reporterSetup.getAdditionalVariables())));
} catch (Throwable t) {
LOG.error(
"Could not instantiate metrics reporter {}. Metrics might not be exposed/reported.",
namedReporter,
t);
}
}
}
}
private static Duration getConfiguredIntervalOrDefault(ReporterSetup reporterSetup) {
final Optional<String> configuredPeriod = reporterSetup.getIntervalSettings();
Duration period = MetricOptions.REPORTER_INTERVAL.defaultValue();
if (configuredPeriod.isPresent()) {
try {
period = TimeUtils.parseDuration(configuredPeriod.get());
} catch (Exception e) {
LOG.error(
"Cannot parse report interval from config: "
+ configuredPeriod
+ " - please use values like '10 SECONDS' or '500 MILLISECONDS'. "
+ "Using default reporting interval.");
}
}
return period;
}
/**
* Initializes the MetricQueryService.
*
* @param rpcService RpcService to create the MetricQueryService on
* @param resourceID resource ID used to disambiguate the actor name
*/
public void startQueryService(RpcService rpcService, ResourceID resourceID) {
synchronized (lock) {
Preconditions.checkState(
!isShutdown(), "The metric registry has already been shut down.");
try {
metricQueryServiceRpcService = rpcService;
queryService =
MetricQueryService.createMetricQueryService(
rpcService, resourceID, maximumFramesize);
queryService.start();
} catch (Exception e) {
LOG.warn(
"Could not start MetricDumpActor. No metrics will be submitted to the WebInterface.",
e);
}
}
}
/**
* Returns the rpc service that the {@link MetricQueryService} runs in.
*
* @return rpc service of hte MetricQueryService
*/
@Nullable
public RpcService getMetricQueryServiceRpcService() {
return metricQueryServiceRpcService;
}
/**
* Returns the address under which the {@link MetricQueryService} is reachable.
*
* @return address of the metric query service
*/
@Override
@Nullable
public String getMetricQueryServiceGatewayRpcAddress() {
if (queryService != null) {
return queryService.getSelfGateway(MetricQueryServiceGateway.class).getAddress();
} else {
return null;
}
}
@VisibleForTesting
@Nullable
MetricQueryServiceGateway getMetricQueryServiceGateway() {
if (queryService != null) {
return queryService.getSelfGateway(MetricQueryServiceGateway.class);
} else {
return null;
}
}
@Override
public char getDelimiter() {
return this.globalDelimiter;
}
@VisibleForTesting
char getDelimiter(int reporterIndex) {
try {
return reporters.get(reporterIndex).getSettings().getDelimiter();
} catch (IndexOutOfBoundsException e) {
LOG.warn(
"Delimiter for reporter index {} not found, returning global delimiter.",
reporterIndex);
return this.globalDelimiter;
}
}
@Override
public int getNumberReporters() {
return reporters.size();
}
@VisibleForTesting
public List<MetricReporter> getReporters() {
return reporters.stream()
.map(ReporterAndSettings::getReporter)
.collect(Collectors.toList());
}
/**
* Returns whether this registry has been shutdown.
*
* @return true, if this registry was shutdown, otherwise false
*/
public boolean isShutdown() {
synchronized (lock) {
return isShutdown;
}
}
/**
* Shuts down this registry and the associated {@link MetricReporter}.
*
* <p>NOTE: This operation is asynchronous and returns a future which is completed once the
* shutdown operation has been completed.
*
* @return Future which is completed once the {@link MetricRegistryImpl} is shut down.
*/
public CompletableFuture<Void> shutdown() {
synchronized (lock) {
if (isShutdown) {
return terminationFuture;
} else {
isShutdown = true;
final Collection<CompletableFuture<Void>> terminationFutures = new ArrayList<>(3);
final Time gracePeriod = Time.seconds(1L);
if (metricQueryServiceRpcService != null) {
final CompletableFuture<Void> metricQueryServiceRpcServiceTerminationFuture =
metricQueryServiceRpcService.stopService();
terminationFutures.add(metricQueryServiceRpcServiceTerminationFuture);
}
Throwable throwable = null;
for (ReporterAndSettings reporterAndSettings : reporters) {
try {
reporterAndSettings.getReporter().close();
} catch (Throwable t) {
throwable = ExceptionUtils.firstOrSuppressed(t, throwable);
}
}
reporters.clear();
if (throwable != null) {
terminationFutures.add(
FutureUtils.completedExceptionally(
new FlinkException(
"Could not shut down the metric reporters properly.",
throwable)));
}
final CompletableFuture<Void> executorShutdownFuture =
ExecutorUtils.nonBlockingShutdown(
gracePeriod.toMilliseconds(), TimeUnit.MILLISECONDS, executor);
terminationFutures.add(executorShutdownFuture);
FutureUtils.completeAll(terminationFutures)
.whenComplete(
(Void ignored, Throwable error) -> {
if (error != null) {
terminationFuture.completeExceptionally(error);
} else {
terminationFuture.complete(null);
}
});
return terminationFuture;
}
}
}
@Override
public ScopeFormats getScopeFormats() {
return scopeFormats;
}
// ------------------------------------------------------------------------
// Metrics (de)registration
// ------------------------------------------------------------------------
@Override
public void register(Metric metric, String metricName, AbstractMetricGroup group) {
synchronized (lock) {
if (isShutdown()) {
LOG.warn(
"Cannot register metric, because the MetricRegistry has already been shut down.");
} else {
if (reporters != null) {
for (int i = 0; i < reporters.size(); i++) {
ReporterAndSettings reporterAndSettings = reporters.get(i);
try {
if (reporterAndSettings != null) {
FrontMetricGroup front =
new FrontMetricGroup<AbstractMetricGroup<?>>(
reporterAndSettings.getSettings(), group);
reporterAndSettings
.getReporter()
.notifyOfAddedMetric(metric, metricName, front);
}
} catch (Exception e) {
LOG.warn("Error while registering metric: {}.", metricName, e);
}
}
}
try {
if (queryService != null) {
queryService.addMetric(metricName, metric, group);
}
} catch (Exception e) {
LOG.warn("Error while registering metric: {}.", metricName, e);
}
try {
if (metric instanceof View) {
if (viewUpdater == null) {
viewUpdater = new ViewUpdater(executor);
}
viewUpdater.notifyOfAddedView((View) metric);
}
} catch (Exception e) {
LOG.warn("Error while registering metric: {}.", metricName, e);
}
}
}
}
@Override
public void unregister(Metric metric, String metricName, AbstractMetricGroup group) {
synchronized (lock) {
if (isShutdown()) {
LOG.warn(
"Cannot unregister metric, because the MetricRegistry has already been shut down.");
} else {
if (reporters != null) {
for (int i = 0; i < reporters.size(); i++) {
try {
ReporterAndSettings reporterAndSettings = reporters.get(i);
if (reporterAndSettings != null) {
FrontMetricGroup front =
new FrontMetricGroup<AbstractMetricGroup<?>>(
reporterAndSettings.getSettings(), group);
reporterAndSettings
.getReporter()
.notifyOfRemovedMetric(metric, metricName, front);
}
} catch (Exception e) {
LOG.warn("Error while unregistering metric: {}.", metricName, e);
}
}
}
try {
if (queryService != null) {
queryService.removeMetric(metric);
}
} catch (Exception e) {
LOG.warn("Error while unregistering metric: {}.", metricName, e);
}
try {
if (metric instanceof View) {
if (viewUpdater != null) {
viewUpdater.notifyOfRemovedView((View) metric);
}
}
} catch (Exception e) {
LOG.warn("Error while unregistering metric: {}", metricName, e);
}
}
}
}
// ------------------------------------------------------------------------
@VisibleForTesting
@Nullable
MetricQueryService getQueryService() {
return queryService;
}
// ------------------------------------------------------------------------
/**
* This task is explicitly a static class, so that it does not hold any references to the
* enclosing MetricsRegistry instance.
*
* <p>This is a subtle difference, but very important: With this static class, the enclosing
* class instance may become garbage-collectible, whereas with an anonymous inner class, the
* timer thread (which is a GC root) will hold a reference via the timer task and its enclosing
* instance pointer. Making the MetricsRegistry garbage collectible makes the java.util.Timer
* garbage collectible, which acts as a fail-safe to stop the timer thread and prevents resource
* leaks.
*/
private static final class ReporterTask extends TimerTask {
private final Scheduled reporter;
private ReporterTask(Scheduled reporter) {
this.reporter = reporter;
}
@Override
public void run() {
try {
reporter.report();
} catch (Throwable t) {
LOG.warn("Error while reporting metrics", t);
}
}
}
private static class ReporterAndSettings {
private final MetricReporter reporter;
private final ReporterScopedSettings settings;
private ReporterAndSettings(MetricReporter reporter, ReporterScopedSettings settings) {
this.reporter = Preconditions.checkNotNull(reporter);
this.settings = Preconditions.checkNotNull(settings);
}
public MetricReporter getReporter() {
return reporter;
}
public ReporterScopedSettings getSettings() {
return settings;
}
}
}
| [FLINK-26849][metrics] Deduplicate metric (un)registration logic
| flink-runtime/src/main/java/org/apache/flink/runtime/metrics/MetricRegistryImpl.java | [FLINK-26849][metrics] Deduplicate metric (un)registration logic | <ide><path>link-runtime/src/main/java/org/apache/flink/runtime/metrics/MetricRegistryImpl.java
<ide> import org.apache.flink.util.TimeUtils;
<ide> import org.apache.flink.util.concurrent.ExecutorThreadFactory;
<ide> import org.apache.flink.util.concurrent.FutureUtils;
<add>import org.apache.flink.util.function.QuadConsumer;
<ide>
<ide> import org.slf4j.Logger;
<ide> import org.slf4j.LoggerFactory;
<ide>
<ide> import javax.annotation.Nullable;
<add>import javax.annotation.concurrent.GuardedBy;
<ide>
<ide> import java.time.Duration;
<ide> import java.util.ArrayList;
<ide> "Cannot register metric, because the MetricRegistry has already been shut down.");
<ide> } else {
<ide> if (reporters != null) {
<del> for (int i = 0; i < reporters.size(); i++) {
<del> ReporterAndSettings reporterAndSettings = reporters.get(i);
<del> try {
<del> if (reporterAndSettings != null) {
<del> FrontMetricGroup front =
<del> new FrontMetricGroup<AbstractMetricGroup<?>>(
<del> reporterAndSettings.getSettings(), group);
<del> reporterAndSettings
<del> .getReporter()
<del> .notifyOfAddedMetric(metric, metricName, front);
<del> }
<del> } catch (Exception e) {
<del> LOG.warn("Error while registering metric: {}.", metricName, e);
<del> }
<del> }
<add> forAllReporters(MetricReporter::notifyOfAddedMetric, metric, metricName, group);
<ide> }
<ide> try {
<ide> if (queryService != null) {
<ide> "Cannot unregister metric, because the MetricRegistry has already been shut down.");
<ide> } else {
<ide> if (reporters != null) {
<del> for (int i = 0; i < reporters.size(); i++) {
<del> try {
<del> ReporterAndSettings reporterAndSettings = reporters.get(i);
<del> if (reporterAndSettings != null) {
<del> FrontMetricGroup front =
<del> new FrontMetricGroup<AbstractMetricGroup<?>>(
<del> reporterAndSettings.getSettings(), group);
<del> reporterAndSettings
<del> .getReporter()
<del> .notifyOfRemovedMetric(metric, metricName, front);
<del> }
<del> } catch (Exception e) {
<del> LOG.warn("Error while unregistering metric: {}.", metricName, e);
<del> }
<del> }
<add> forAllReporters(
<add> MetricReporter::notifyOfRemovedMetric, metric, metricName, group);
<ide> }
<ide> try {
<ide> if (queryService != null) {
<ide> } catch (Exception e) {
<ide> LOG.warn("Error while unregistering metric: {}", metricName, e);
<ide> }
<add> }
<add> }
<add> }
<add>
<add> @GuardedBy("lock")
<add> private void forAllReporters(
<add> QuadConsumer<MetricReporter, Metric, String, MetricGroup> operation,
<add> Metric metric,
<add> String metricName,
<add> AbstractMetricGroup group) {
<add> for (int i = 0; i < reporters.size(); i++) {
<add> try {
<add> ReporterAndSettings reporterAndSettings = reporters.get(i);
<add> if (reporterAndSettings != null) {
<add> FrontMetricGroup front =
<add> new FrontMetricGroup<AbstractMetricGroup<?>>(
<add> reporterAndSettings.getSettings(), group);
<add>
<add> operation.accept(reporterAndSettings.getReporter(), metric, metricName, front);
<add> }
<add> } catch (Exception e) {
<add> LOG.warn("Error while handling metric: {}.", metricName, e);
<ide> }
<ide> }
<ide> } |
|
Java | apache-2.0 | 52338782104bd7c4ba6f8573ac26be98f5422eed | 0 | quarkusio/quarkus,quarkusio/quarkus,quarkusio/quarkus,quarkusio/quarkus,quarkusio/quarkus | package io.quarkus.vertx.http;
import java.util.function.Consumer;
import javax.enterprise.event.Observes;
import javax.inject.Singleton;
import org.hamcrest.Matchers;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.StringAsset;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import io.quarkus.builder.BuildChainBuilder;
import io.quarkus.builder.BuildContext;
import io.quarkus.builder.BuildStep;
import io.quarkus.test.QuarkusUnitTest;
import io.quarkus.vertx.http.deployment.RouteBuildItem;
import io.restassured.RestAssured;
import io.vertx.core.Handler;
import io.vertx.ext.web.RoutingContext;
public class NonApplicationAndRootPathTest {
private static final String APP_PROPS = "" +
"quarkus.http.root-path=/api\n";
@RegisterExtension
static final QuarkusUnitTest config = new QuarkusUnitTest()
.setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
.addAsResource(new StringAsset(APP_PROPS), "application.properties")
.addClasses(MyObserver.class))
.addBuildChainCustomizer(buildCustomizer());
static Consumer<BuildChainBuilder> buildCustomizer() {
return new Consumer<BuildChainBuilder>() {
@Override
public void accept(BuildChainBuilder builder) {
builder.addBuildStep(new BuildStep() {
@Override
public void execute(BuildContext context) {
context.produce(new RouteBuildItem.Builder()
.route("/non-app")
.handler(new MyHandler())
.blockingRoute()
.nonApplicationRoute()
.build());
}
}).produces(RouteBuildItem.class)
.build();
}
};
}
public static class MyHandler implements Handler<RoutingContext> {
@Override
public void handle(RoutingContext routingContext) {
routingContext.response()
.setStatusCode(200)
.end(routingContext.request().path());
}
}
@Test
public void testNonApplicationEndpointOnRootPathWithRedirect() {
// Note RestAssured knows the path prefix is /api
RestAssured.given().get("/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
}
@Test
public void testNonApplicationEndpointDirect() {
// Note RestAssured knows the path prefix is /api
RestAssured.given().get("/q/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
}
@Singleton
static class MyObserver {
void test(@Observes String event) {
//Do Nothing
}
}
}
| extensions/vertx-http/deployment/src/test/java/io/quarkus/vertx/http/NonApplicationAndRootPathTest.java | package io.quarkus.vertx.http;
import java.util.function.Consumer;
import javax.enterprise.event.Observes;
import javax.inject.Singleton;
import org.hamcrest.Matchers;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.StringAsset;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import io.quarkus.builder.BuildChainBuilder;
import io.quarkus.builder.BuildContext;
import io.quarkus.builder.BuildStep;
import io.quarkus.test.QuarkusUnitTest;
import io.quarkus.vertx.http.deployment.RouteBuildItem;
import io.restassured.RestAssured;
import io.vertx.core.Handler;
import io.vertx.ext.web.RoutingContext;
public class NonApplicationAndRootPathTest {
private static final String APP_PROPS = "" +
"quarkus.http.root-path=/api\n";
@RegisterExtension
static final QuarkusUnitTest config = new QuarkusUnitTest()
.setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
.addAsResource(new StringAsset(APP_PROPS), "application.properties")
.addClasses(MyObserver.class))
.addBuildChainCustomizer(buildCustomizer());
static Consumer<BuildChainBuilder> buildCustomizer() {
return new Consumer<BuildChainBuilder>() {
@Override
public void accept(BuildChainBuilder builder) {
builder.addBuildStep(new BuildStep() {
@Override
public void execute(BuildContext context) {
context.produce(new RouteBuildItem.Builder()
.route("/non-app")
.handler(new MyHandler())
.blockingRoute()
.nonApplicationRoute()
.build());
}
}).produces(RouteBuildItem.class)
.build();
}
};
}
public static class MyHandler implements Handler<RoutingContext> {
@Override
public void handle(RoutingContext routingContext) {
routingContext.response()
.setStatusCode(200)
.end(routingContext.request().path());
}
}
@Test
public void testNonApplicationEndpointOnRootPathWithRedirect() {
RestAssured.given().get("/api/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
}
@Test
public void testNonApplicationEndpointDirect() {
RestAssured.given().get("/api/q/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
}
@Singleton
static class MyObserver {
void test(@Observes String event) {
//Do Nothing
}
}
}
| Fix the test.
- I didn't realize RestAssured gets the path prefix!
| extensions/vertx-http/deployment/src/test/java/io/quarkus/vertx/http/NonApplicationAndRootPathTest.java | Fix the test. | <ide><path>xtensions/vertx-http/deployment/src/test/java/io/quarkus/vertx/http/NonApplicationAndRootPathTest.java
<ide>
<ide> @Test
<ide> public void testNonApplicationEndpointOnRootPathWithRedirect() {
<del> RestAssured.given().get("/api/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
<add> // Note RestAssured knows the path prefix is /api
<add> RestAssured.given().get("/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
<ide> }
<ide>
<ide> @Test
<ide> public void testNonApplicationEndpointDirect() {
<del> RestAssured.given().get("/api/q/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
<add> // Note RestAssured knows the path prefix is /api
<add> RestAssured.given().get("/q/non-app").then().statusCode(200).body(Matchers.equalTo("/api/q/non-app"));
<ide> }
<ide>
<ide> @Singleton |
|
Java | apache-2.0 | c6b2076d8794f8b24a85c54111372b9200bb120a | 0 | rholder/fast-tag | // Copyright 2003-2008. Mark Watson ([email protected]). All rights reserved.
// This software is released under the LGPL (www.fsf.org)
// For an alternative non-GPL license: contact the author
// THIS SOFTWARE COMES WITH NO WARRANTY
package com.knowledgebooks.nlp.fasttag;
import java.io.*;
import java.util.*;
/**
* <p/>
* Copyright 2002-2007 by Mark Watson. All rights reserved.
* <p/>
*/
public class FastTag {
private static final Map<String, String[]> lexicon = buildLexicon();
/**
*
* @param word
* @return true if the input word is in the lexicon, otherwise return false
*/
public static boolean wordInLexicon(String word) {
String[] ss = lexicon.get(word);
if (ss != null)
return true;
// 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
if (ss == null)
ss = lexicon.get(word.toLowerCase());
if (ss != null)
return true;
return false;
}
/**
*
* @param words
* list of strings to tag with parts of speech
* @return list of strings for part of speech tokens
*/
public static List<String> tag(List<String> words) {
List<String> ret = new ArrayList<String>(words.size());
for (int i = 0, size = words.size(); i < size; i++) {
String[] ss = (String[]) lexicon.get(words.get(i));
// 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
if (ss == null)
ss = lexicon.get(words.get(i).toLowerCase());
if (ss == null && words.get(i).length() == 1)
ret.add(words.get(i) + "^");
else if (ss == null)
ret.add("NN");
else
ret.add(ss[0]);
}
/**
* Apply transformational rules
**/
for (int i = 0; i < words.size(); i++) {
String word = ret.get(i);
// rule 1: DT, {VBD | VBP} --> DT, NN
if (i > 0 && ret.get(i - 1).equals("DT")) {
if (word.equals("VBD") || word.equals("VBP") || word.equals("VB")) {
ret.set(i, "NN");
}
}
// rule 2: convert a noun to a number (CD) if "." appears in the word
if (word.startsWith("N")) {
if (words.get(i).indexOf(".") > -1) {
ret.set(i, "CD");
}
try {
Float.parseFloat(words.get(i));
ret.set(i, "CD");
} catch (Exception e) { // ignore: exception OK: this just means
// that the string could not parse as a
// number
}
}
// rule 3: convert a noun to a past participle if words.get(i) ends with "ed"
if (ret.get(i).startsWith("N") && words.get(i).endsWith("ed"))
ret.set(i, "VBN");
// rule 4: convert any type to adverb if it ends in "ly";
if (words.get(i).endsWith("ly"))
ret.set(i, "RB");
// rule 5: convert a common noun (NN or NNS) to a adjective if it ends with "al"
if (ret.get(i).startsWith("NN") && words.get(i).endsWith("al"))
ret.set(i, "JJ");
// rule 6: convert a noun to a verb if the preceeding work is "would"
if (i > 0 && ret.get(i).startsWith("NN")
&& words.get(i - 1).equalsIgnoreCase("would"))
ret.set(i, "VB");
// rule 7: if a word has been categorized as a common noun and it ends with "s",
// then set its type to plural common noun (NNS)
if (ret.get(i).equals("NN") && words.get(i).endsWith("s"))
ret.set(i, "NNS");
// rule 8: convert a common noun to a present participle verb (i.e., a gerand)
if (ret.get(i).startsWith("NN") && words.get(i).endsWith("ing"))
ret.set(i, "VBG");
}
return ret;
}
/**
* Simple main test program
*
* @param args
* string to tokenize and tag
*/
public static void main(String[] args) {
if (args.length == 0) {
System.out.println("Usage: argument is a string like \"The ball rolled down the street.\"\n\nSample run:\n");
List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList("The ball rolled down the street.");
List<String> tags = tag(words);
for (int i = 0; i < words.size(); i++)
System.out.println(words.get(i) + "/" + tags.get(i));
} else {
List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList(args[0]);
List<String> tags = tag(words);
for (int i = 0; i < words.size(); i++)
System.out.println(words.get(i) + "/" + tags.get(i));
}
}
private static Map<String, String[]> buildLexicon() {
Map<String, String[]> lexicon = new HashMap<String, String[]>();
try {
InputStream ins = FastTag.class.getClassLoader().getResourceAsStream("lexicon.txt");
if (ins == null) {
ins = new FileInputStream("data/lexicon.txt");
}
Scanner scanner = new Scanner(ins);
scanner.useDelimiter(System.getProperty("line.separator"));
while (scanner.hasNext()) {
String line = scanner.next();
int count = 0;
for (int i = 0, size = line.length(); i < size; i++) {
if (line.charAt(i) == ' ') {
count++;
}
}
if (count == 0) {
continue;
}
String[] ss = new String[count];
Scanner lineScanner = new Scanner(line);
lineScanner.useDelimiter(" ");
String word = lineScanner.next();
count = 0;
while (lineScanner.hasNext()) {
ss[count++] = lineScanner.next();
}
lineScanner.close();
lexicon.put(word, ss);
}
scanner.close();
} catch (Exception e) {
e.printStackTrace();
}
return Collections.unmodifiableMap(lexicon);
}
}
| src/com/knowledgebooks/nlp/fasttag/FastTag.java | // Copyright 2003-2008. Mark Watson ([email protected]). All rights reserved.
// This software is released under the LGPL (www.fsf.org)
// For an alternative non-GPL license: contact the author
// THIS SOFTWARE COMES WITH NO WARRANTY
package com.knowledgebooks.nlp.fasttag;
import java.io.*;
import java.util.*;
/**
* <p/>
* Copyright 2002-2007 by Mark Watson. All rights reserved.
* <p/>
*/
public class FastTag {
private static Hashtable<String, String[]> lexicon = new Hashtable<String, String[]>();
static {
//System.out.println("Starting to load FastTag data...");
try {
//System.out.println("Starting kbs.fasttag.FastTag static initialization...");
InputStream ins = FastTag.class.getClassLoader().getResourceAsStream("lexicon.txt");
if (ins == null) {
ins = new FileInputStream("data/lexicon.txt");
}
if (ins == null) {
System.out.println("Failed to open 'lexicon.txt'");
System.exit(1);
} else {
Scanner scanner =
new Scanner(ins);
scanner.useDelimiter
(System.getProperty("line.separator"));
while (scanner.hasNext()) {
parseLine(scanner.next());
}
scanner.close();
}
} catch (Exception e) {
e.printStackTrace();
}
}
/**
*
*/
public FastTag() {
}
/**
*
* @param word
* @return true if the input word is in the lexicon, otherwise return false
*/
public boolean wordInLexicon(String word) {
String[] ss = lexicon.get(word);
if (ss != null) return true;
// 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
if (ss == null)
ss = lexicon.get(word.toLowerCase());
if (ss != null) return true;
return false;
}
/**
*
* @param words list of strings to tag with parts of speech
* @return list of strings for part of speech tokens
*/
public List<String> tag(List<String> words) {
List<String> ret = new ArrayList<String>(words.size());
for (int i = 0, size = words.size(); i < size; i++) {
String[] ss = (String[]) lexicon.get(words.get(i));
// 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
if (ss == null)
ss = lexicon.get(words.get(i).toLowerCase());
if (ss == null && words.get(i).length() == 1)
ret.add(words.get(i) + "^");
else if (ss == null)
ret.add("NN");
else
ret.add(ss[0]);
}
/**
* Apply transformational rules
**/
for (int i = 0; i < words.size(); i++) {
String word = ret.get(i);
// rule 1: DT, {VBD | VBP} --> DT, NN
if (i > 0 && ret.get(i - 1).equals("DT")) {
if (word.equals("VBD")
|| word.equals("VBP")
|| word.equals("VB")) {
ret.set(i, "NN");
}
}
// rule 2: convert a noun to a number (CD) if "." appears in the word
if (word.startsWith("N")) {
if (words.get(i).indexOf(".") > -1) {
ret.set(i, "CD");
}
try {
Float.parseFloat(words.get(i));
ret.set(i, "CD");
} catch (Exception e) { // ignore: exception OK: this just means that the string could not parse as a number
}
}
// rule 3: convert a noun to a past participle if words.get(i) ends with "ed"
if (ret.get(i).startsWith("N") && words.get(i).endsWith("ed"))
ret.set(i,"VBN");
// rule 4: convert any type to adverb if it ends in "ly";
if (words.get(i).endsWith("ly"))
ret.set(i, "RB");
// rule 5: convert a common noun (NN or NNS) to a adjective if it ends with "al"
if (ret.get(i).startsWith("NN") && words.get(i).endsWith("al"))
ret.set(i, "JJ");
// rule 6: convert a noun to a verb if the preceeding work is "would"
if (i > 0
&& ret.get(i).startsWith("NN")
&& words.get(i - 1).equalsIgnoreCase("would"))
ret.set(i, "VB");
// rule 7: if a word has been categorized as a common noun and it ends with "s",
// then set its type to plural common noun (NNS)
if (ret.get(i).equals("NN") && words.get(i).endsWith("s"))
ret.set(i, "NNS");
// rule 8: convert a common noun to a present participle verb (i.e., a gerand)
if (ret.get(i).startsWith("NN") && words.get(i).endsWith("ing"))
ret.set(i, "VBG");
}
return ret;
}
/**
* Simple main test program
*
* @param args string to tokenize and tag
*/
public static void main(String[] args) {
if (args.length == 0) {
System.out.println("Usage: argument is a string like \"The ball rolled down the street.\"\n\nSample run:\n");
List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList("The ball rolled down the street.");
List<String> tags = (new FastTag()).tag(words);
for (int i = 0; i < words.size(); i++) System.out.println(words.get(i) + "/" + tags.get(i));
} else {
List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList(args[0]);
List<String> tags = (new FastTag()).tag(words);
for (int i = 0; i < words.size(); i++) System.out.println(words.get(i) + "/" + tags.get(i));
}
}
private static void parseLine(String line) {
int count = 0;
for (int i=0, size=line.length(); i<size; i++) if (line.charAt(i)==' ') count++;
if (count==0) return;
String[] ss = new String[count];
Scanner lineScanner = new Scanner(line);
lineScanner.useDelimiter(" ");
String word = lineScanner.next(); count=0;
while (lineScanner.hasNext()) {
ss[count++] = lineScanner.next();
}
lexicon.put(word, ss);
}
}
| Modifying for thread safety.
Replaced static block with more descriptive static method.
Replaced Hashtable of lexicon with a unmodifiable HashMap to ensure
safe access. Also making it final.
Changing tag and WordInLexicon methods to static.
| src/com/knowledgebooks/nlp/fasttag/FastTag.java | Modifying for thread safety. | <ide><path>rc/com/knowledgebooks/nlp/fasttag/FastTag.java
<ide> // For an alternative non-GPL license: contact the author
<ide> // THIS SOFTWARE COMES WITH NO WARRANTY
<ide>
<del>
<ide> package com.knowledgebooks.nlp.fasttag;
<ide>
<ide> import java.io.*;
<ide> import java.util.*;
<del>
<ide>
<ide> /**
<ide> * <p/>
<ide> */
<ide> public class FastTag {
<ide>
<del> private static Hashtable<String, String[]> lexicon = new Hashtable<String, String[]>();
<add> private static final Map<String, String[]> lexicon = buildLexicon();
<ide>
<del> static {
<del> //System.out.println("Starting to load FastTag data...");
<del> try {
<del> //System.out.println("Starting kbs.fasttag.FastTag static initialization...");
<del> InputStream ins = FastTag.class.getClassLoader().getResourceAsStream("lexicon.txt");
<del> if (ins == null) {
<del> ins = new FileInputStream("data/lexicon.txt");
<del> }
<del> if (ins == null) {
<del> System.out.println("Failed to open 'lexicon.txt'");
<del> System.exit(1);
<del> } else {
<del> Scanner scanner =
<del> new Scanner(ins);
<del> scanner.useDelimiter
<del> (System.getProperty("line.separator"));
<del> while (scanner.hasNext()) {
<del> parseLine(scanner.next());
<del> }
<del> scanner.close();
<del> }
<del> } catch (Exception e) {
<del> e.printStackTrace();
<del> }
<del> }
<add> /**
<add> *
<add> * @param word
<add> * @return true if the input word is in the lexicon, otherwise return false
<add> */
<add> public static boolean wordInLexicon(String word) {
<add> String[] ss = lexicon.get(word);
<add> if (ss != null)
<add> return true;
<add> // 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
<add> if (ss == null)
<add> ss = lexicon.get(word.toLowerCase());
<add> if (ss != null)
<add> return true;
<add> return false;
<add> }
<ide>
<add> /**
<add> *
<add> * @param words
<add> * list of strings to tag with parts of speech
<add> * @return list of strings for part of speech tokens
<add> */
<add> public static List<String> tag(List<String> words) {
<add> List<String> ret = new ArrayList<String>(words.size());
<add> for (int i = 0, size = words.size(); i < size; i++) {
<add> String[] ss = (String[]) lexicon.get(words.get(i));
<add> // 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
<add> if (ss == null)
<add> ss = lexicon.get(words.get(i).toLowerCase());
<add> if (ss == null && words.get(i).length() == 1)
<add> ret.add(words.get(i) + "^");
<add> else if (ss == null)
<add> ret.add("NN");
<add> else
<add> ret.add(ss[0]);
<add> }
<add> /**
<add> * Apply transformational rules
<add> **/
<add> for (int i = 0; i < words.size(); i++) {
<add> String word = ret.get(i);
<add> // rule 1: DT, {VBD | VBP} --> DT, NN
<add> if (i > 0 && ret.get(i - 1).equals("DT")) {
<add> if (word.equals("VBD") || word.equals("VBP") || word.equals("VB")) {
<add> ret.set(i, "NN");
<add> }
<add> }
<add> // rule 2: convert a noun to a number (CD) if "." appears in the word
<add> if (word.startsWith("N")) {
<add> if (words.get(i).indexOf(".") > -1) {
<add> ret.set(i, "CD");
<add> }
<add> try {
<add> Float.parseFloat(words.get(i));
<add> ret.set(i, "CD");
<add> } catch (Exception e) { // ignore: exception OK: this just means
<add> // that the string could not parse as a
<add> // number
<add> }
<add> }
<add> // rule 3: convert a noun to a past participle if words.get(i) ends with "ed"
<add> if (ret.get(i).startsWith("N") && words.get(i).endsWith("ed"))
<add> ret.set(i, "VBN");
<add> // rule 4: convert any type to adverb if it ends in "ly";
<add> if (words.get(i).endsWith("ly"))
<add> ret.set(i, "RB");
<add> // rule 5: convert a common noun (NN or NNS) to a adjective if it ends with "al"
<add> if (ret.get(i).startsWith("NN") && words.get(i).endsWith("al"))
<add> ret.set(i, "JJ");
<add> // rule 6: convert a noun to a verb if the preceeding work is "would"
<add> if (i > 0 && ret.get(i).startsWith("NN")
<add> && words.get(i - 1).equalsIgnoreCase("would"))
<add> ret.set(i, "VB");
<add> // rule 7: if a word has been categorized as a common noun and it ends with "s",
<add> // then set its type to plural common noun (NNS)
<add> if (ret.get(i).equals("NN") && words.get(i).endsWith("s"))
<add> ret.set(i, "NNS");
<add> // rule 8: convert a common noun to a present participle verb (i.e., a gerand)
<add> if (ret.get(i).startsWith("NN") && words.get(i).endsWith("ing"))
<add> ret.set(i, "VBG");
<add> }
<add> return ret;
<add> }
<ide>
<del> /**
<del> *
<del> */
<del> public FastTag() {
<del> }
<add> /**
<add> * Simple main test program
<add> *
<add> * @param args
<add> * string to tokenize and tag
<add> */
<add> public static void main(String[] args) {
<add> if (args.length == 0) {
<add> System.out.println("Usage: argument is a string like \"The ball rolled down the street.\"\n\nSample run:\n");
<add> List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList("The ball rolled down the street.");
<add> List<String> tags = tag(words);
<add> for (int i = 0; i < words.size(); i++)
<add> System.out.println(words.get(i) + "/" + tags.get(i));
<add> } else {
<add> List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList(args[0]);
<add> List<String> tags = tag(words);
<add> for (int i = 0; i < words.size(); i++)
<add> System.out.println(words.get(i) + "/" + tags.get(i));
<add> }
<add> }
<ide>
<del> /**
<del> *
<del> * @param word
<del> * @return true if the input word is in the lexicon, otherwise return false
<del> */
<del> public boolean wordInLexicon(String word) {
<del> String[] ss = lexicon.get(word);
<del> if (ss != null) return true;
<del> // 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
<del> if (ss == null)
<del> ss = lexicon.get(word.toLowerCase());
<del> if (ss != null) return true;
<del> return false;
<del> }
<del>
<del> /**
<del> *
<del> * @param words list of strings to tag with parts of speech
<del> * @return list of strings for part of speech tokens
<del> */
<del> public List<String> tag(List<String> words) {
<del> List<String> ret = new ArrayList<String>(words.size());
<del> for (int i = 0, size = words.size(); i < size; i++) {
<del> String[] ss = (String[]) lexicon.get(words.get(i));
<del> // 1/22/2002 mod (from Lisp code): if not in hash, try lower case:
<del> if (ss == null)
<del> ss = lexicon.get(words.get(i).toLowerCase());
<del> if (ss == null && words.get(i).length() == 1)
<del> ret.add(words.get(i) + "^");
<del> else if (ss == null)
<del> ret.add("NN");
<del> else
<del> ret.add(ss[0]);
<del> }
<del> /**
<del> * Apply transformational rules
<del> **/
<del> for (int i = 0; i < words.size(); i++) {
<del> String word = ret.get(i);
<del> // rule 1: DT, {VBD | VBP} --> DT, NN
<del> if (i > 0 && ret.get(i - 1).equals("DT")) {
<del> if (word.equals("VBD")
<del> || word.equals("VBP")
<del> || word.equals("VB")) {
<del> ret.set(i, "NN");
<del> }
<del> }
<del> // rule 2: convert a noun to a number (CD) if "." appears in the word
<del> if (word.startsWith("N")) {
<del> if (words.get(i).indexOf(".") > -1) {
<del> ret.set(i, "CD");
<del> }
<del> try {
<del> Float.parseFloat(words.get(i));
<del> ret.set(i, "CD");
<del> } catch (Exception e) { // ignore: exception OK: this just means that the string could not parse as a number
<del> }
<del> }
<del> // rule 3: convert a noun to a past participle if words.get(i) ends with "ed"
<del> if (ret.get(i).startsWith("N") && words.get(i).endsWith("ed"))
<del> ret.set(i,"VBN");
<del> // rule 4: convert any type to adverb if it ends in "ly";
<del> if (words.get(i).endsWith("ly"))
<del> ret.set(i, "RB");
<del> // rule 5: convert a common noun (NN or NNS) to a adjective if it ends with "al"
<del> if (ret.get(i).startsWith("NN") && words.get(i).endsWith("al"))
<del> ret.set(i, "JJ");
<del> // rule 6: convert a noun to a verb if the preceeding work is "would"
<del> if (i > 0
<del> && ret.get(i).startsWith("NN")
<del> && words.get(i - 1).equalsIgnoreCase("would"))
<del> ret.set(i, "VB");
<del> // rule 7: if a word has been categorized as a common noun and it ends with "s",
<del> // then set its type to plural common noun (NNS)
<del> if (ret.get(i).equals("NN") && words.get(i).endsWith("s"))
<del> ret.set(i, "NNS");
<del> // rule 8: convert a common noun to a present participle verb (i.e., a gerand)
<del> if (ret.get(i).startsWith("NN") && words.get(i).endsWith("ing"))
<del> ret.set(i, "VBG");
<del> }
<del> return ret;
<del> }
<del>
<del> /**
<del> * Simple main test program
<del> *
<del> * @param args string to tokenize and tag
<del> */
<del> public static void main(String[] args) {
<del> if (args.length == 0) {
<del> System.out.println("Usage: argument is a string like \"The ball rolled down the street.\"\n\nSample run:\n");
<del> List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList("The ball rolled down the street.");
<del> List<String> tags = (new FastTag()).tag(words);
<del> for (int i = 0; i < words.size(); i++) System.out.println(words.get(i) + "/" + tags.get(i));
<del> } else {
<del> List<String> words = com.knowledgebooks.nlp.util.Tokenizer.wordsToList(args[0]);
<del> List<String> tags = (new FastTag()).tag(words);
<del> for (int i = 0; i < words.size(); i++) System.out.println(words.get(i) + "/" + tags.get(i));
<del> }
<del> }
<del>
<del> private static void parseLine(String line) {
<del> int count = 0;
<del> for (int i=0, size=line.length(); i<size; i++) if (line.charAt(i)==' ') count++;
<del> if (count==0) return;
<del> String[] ss = new String[count];
<del> Scanner lineScanner = new Scanner(line);
<del> lineScanner.useDelimiter(" ");
<del> String word = lineScanner.next(); count=0;
<del> while (lineScanner.hasNext()) {
<del> ss[count++] = lineScanner.next();
<del> }
<del> lexicon.put(word, ss);
<del> }
<add> private static Map<String, String[]> buildLexicon() {
<add> Map<String, String[]> lexicon = new HashMap<String, String[]>();
<add> try {
<add> InputStream ins = FastTag.class.getClassLoader().getResourceAsStream("lexicon.txt");
<add> if (ins == null) {
<add> ins = new FileInputStream("data/lexicon.txt");
<add> }
<add> Scanner scanner = new Scanner(ins);
<add> scanner.useDelimiter(System.getProperty("line.separator"));
<add> while (scanner.hasNext()) {
<add> String line = scanner.next();
<add> int count = 0;
<add> for (int i = 0, size = line.length(); i < size; i++) {
<add> if (line.charAt(i) == ' ') {
<add> count++;
<add> }
<add> }
<add> if (count == 0) {
<add> continue;
<add> }
<add> String[] ss = new String[count];
<add> Scanner lineScanner = new Scanner(line);
<add> lineScanner.useDelimiter(" ");
<add> String word = lineScanner.next();
<add> count = 0;
<add> while (lineScanner.hasNext()) {
<add> ss[count++] = lineScanner.next();
<add> }
<add> lineScanner.close();
<add> lexicon.put(word, ss);
<add> }
<add> scanner.close();
<add> } catch (Exception e) {
<add> e.printStackTrace();
<add> }
<add> return Collections.unmodifiableMap(lexicon);
<add> }
<ide>
<ide> } |
|
Java | mit | b6314e6b8401cefeab7181caaadfb86cee01b474 | 0 | ufabdyop/coralapiserver,ufabdyop/coralapiserver,ufabdyop/coralapiserver,ufabdyop/coralapiserver,ufabdyop/coralapiserver | package edu.utah.nanofab.coralapiserver.resources.operations;
import edu.utah.nanofab.coralapiserver.core.DisableWithRundataRequest;
import java.util.HashMap;
public class DisableWithRundataOperationPost extends ResourceOperation {
@Override
public void performOperationImpl() throws Exception {
DisableWithRundataRequest disableRequest = (DisableWithRundataRequest)(this.postedObject.get());
System.out.println("Disabling beginning for " + disableRequest.getItem());
//String id = this.api.disable(user.getUsername(), disableRequest.getItem());
String id = this.api.disableWithRundata(user.getUsername(),
disableRequest.getItem(),
disableRequest.getRundataId());
HashMap<String, String> result = new HashMap<String, String>();
result.put("id", id);
result.put("success", "true");
this.setReturnValue(result);
}
@Override
public String errorMessage() {
return "Error while trying to disable" ;
}
}
| src/main/java/edu/utah/nanofab/coralapiserver/resources/operations/DisableWithRundataOperationPost.java | package edu.utah.nanofab.coralapiserver.resources.operations;
import edu.utah.nanofab.coralapiserver.core.DisableWithRundataRequest;
import java.util.HashMap;
public class DisableWithRundataOperationPost extends ResourceOperation {
@Override
public void performOperationImpl() throws Exception {
DisableWithRundataRequest disableRequest = (DisableWithRundataRequest)(this.postedObject.get());
System.out.println("Disabling beginning for " + disableRequest.getItem());
//String id = this.api.disable(user.getUsername(), disableRequest.getItem());
String id = this.api.disableWithRundata(user.getUsername(),
disableRequest.getItem(),
disableRequest.getRundataId());
HashMap<String, String> result = new HashMap<String, String>();
result.put("id", id);
this.setReturnValue(result);
}
@Override
public String errorMessage() {
return "Error while trying to disable" ;
}
}
| add success flag
| src/main/java/edu/utah/nanofab/coralapiserver/resources/operations/DisableWithRundataOperationPost.java | add success flag | <ide><path>rc/main/java/edu/utah/nanofab/coralapiserver/resources/operations/DisableWithRundataOperationPost.java
<ide>
<ide> HashMap<String, String> result = new HashMap<String, String>();
<ide> result.put("id", id);
<add> result.put("success", "true");
<add>
<ide> this.setReturnValue(result);
<ide> }
<ide> |
|
Java | epl-1.0 | 2be0d6707cca200dc0a0fd883be375c76188357d | 0 | Wire82/org.openhab.binding.heos,Wire82/org.openhab.binding.heos | /**
* Copyright (c) 2014-2017 by the respective copyright holders.
* 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 org.openhab.binding.heos.resources;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
/**
* The {@link HeosGroup} represents the group within the
* HEOS network
*
* @author Johannes Einig - Initial contribution
*/
public class HeosGroup extends HeosMediaObject {
private final String[] supportedGroupInfo = { "name", "gip", "leader" };
private final String[] supportedGroupStates = { "state", "level", "mute" };
private HashMap<String, String> groupInfo;
private HashMap<String, String> groupState;
private List<HashMap<String, String>> playerList;
private List<String> groupMemberPidList;
private List<String> groupMemberPidListSorted;
// Group Infos Variables
private String name;
private String gid;
private String leader;
private String nameHash;
private String groupMembersHash;
private String groupUIDHash;
private boolean online;
// Group State Variables
private String state;
private String level;
private String mute;
private final static String PID = "pid";
private final static String GID = "gid";
private final static String NAME = "name";
private final static String LEADER = "leader";
private final static String STATE = "state";
private final static String LEVEL = "level";
private final static String MUTE = "mute";
public HeosGroup() {
initGroup();
}
public void updateGroupInfo(HashMap<String, String> values) {
groupInfo = values;
for (String key : values.keySet()) {
if (key.equals(NAME)) {
name = values.get(key);
if (values.get(key) != null) {
nameHash = Integer.toUnsignedString(values.get(key).hashCode());
} else {
nameHash = "";
}
}
if (key.equals(LEADER)) {
leader = values.get(key);
}
if (key.equals(GID)) {
gid = values.get(key);
}
}
}
public void updateGroupState(HashMap<String, String> values) {
groupState = values;
for (String key : values.keySet()) {
if (key.equals(STATE)) {
state = values.get(key);
}
if (key.equals(LEVEL)) {
level = values.get(key);
}
if (key.equals(MUTE)) {
mute = values.get(key);
}
}
}
/**
* Updates the group members.
*
* Generates the {@code groupMembersHash} from the group member PIDs
*
* @param playerList The List of the Player (player as: HashMap<String,String>)
*/
public void updateGroupPlayers(List<HashMap<String, String>> playerList) {
this.playerList = playerList;
groupMemberPidList = new ArrayList<String>(playerList.size());
for (int i = 0; i < this.playerList.size(); i++) {
HashMap<String, String> player = playerList.get(i);
groupMemberPidList.add(player.get(PID));
}
// Generating a dedicated sorted and un-sorted list for different purposes
groupMemberPidListSorted = new ArrayList<String>(playerList.size());
groupMemberPidListSorted.addAll(groupMemberPidList);
// Collections.reverse(groupMemberPidList); // List has to be reversed so that leader is at the beginning
Collections.sort(groupMemberPidListSorted);
groupMembersHash = Integer.toUnsignedString(groupMemberPidListSorted.hashCode());
}
public String generateGroupUID() {
List<String> groupUIDHashList = new ArrayList<String>();
groupUIDHashList.add(name);
groupUIDHashList.add(gid);
groupUIDHashList.add(leader);
groupUIDHashList.add(groupMembersHash);
groupUIDHash = Integer.toUnsignedString(groupUIDHashList.hashCode());
return groupUIDHash;
}
private void initGroup() {
groupInfo = new HashMap<>(8);
groupState = new HashMap<>(5);
playerList = new ArrayList<>(5);
for (String key : supportedGroupInfo) {
groupInfo.put(key, null);
}
for (String key : supportedGroupStates) {
groupState.put(key, null);
}
updateGroupInfo(groupInfo);
updateGroupState(groupState);
}
public HashMap<String, String> getGroupInfo() {
return groupInfo;
}
public void setGroupInfo(HashMap<String, String> groupInfo) {
this.groupInfo = groupInfo;
}
public HashMap<String, String> getGroupState() {
return groupState;
}
public void setGroupState(HashMap<String, String> groupState) {
this.groupState = groupState;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
groupInfo.put("name", name);
}
public String getGid() {
return gid;
}
public void setGid(String gid) {
this.gid = gid;
groupInfo.put("gid", gid);
}
public String getLeader() {
return leader;
}
public void setLeader(String leader) {
this.leader = leader;
groupInfo.put("leader", leader);
}
public String getState() {
return state;
}
public void setState(String state) {
this.state = state;
groupInfo.put("state", state);
}
public String getLevel() {
return level;
}
public void setLevel(String level) {
this.level = level;
groupInfo.put("level", level);
}
public String getMute() {
return mute;
}
public void setMute(String mute) {
this.mute = mute;
groupInfo.put("mute", mute);
}
public String[] getSupportedGroupInfo() {
return supportedGroupInfo;
}
public String[] getSupportedGroupStates() {
return supportedGroupStates;
}
public String getNameHash() {
return nameHash;
}
public String getGroupMemberHash() {
return groupMembersHash;
}
public boolean isOnline() {
return online;
}
public void setOnline(boolean online) {
this.online = online;
}
public String getGroupUIDHash() {
return groupUIDHash;
}
public List<String> getGroupMemberPidList() {
return groupMemberPidList;
}
}
| src/main/java/org/openhab/binding/heos/resources/HeosGroup.java | /**
* Copyright (c) 2014-2017 by the respective copyright holders.
* 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 org.openhab.binding.heos.resources;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
/**
* The {@link HeosGroup} represents the group within the
* HEOS network
*
* @author Johannes Einig - Initial contribution
*/
public class HeosGroup extends HeosMediaObject {
private final String[] supportedGroupInfo = { "name", "gip", "leader" };
private final String[] supportedGroupStates = { "state", "level", "mute" };
private HashMap<String, String> groupInfo;
private HashMap<String, String> groupState;
private List<HashMap<String, String>> playerList;
private List<String> groupMemberPidList;
private List<String> groupMemberPidListSorted;
// Group Infos Variables
private String name;
private String gid;
private String leader;
private String nameHash;
private String groupMembersHash;
private String groupUIDHash;
private boolean online;
// Group State Variables
private String state;
private String level;
private String mute;
private final static String PID = "pid";
private final static String GID = "gid";
private final static String NAME = "name";
private final static String LEADER = "leader";
private final static String STATE = "state";
private final static String LEVEL = "level";
private final static String MUTE = "mute";
public HeosGroup() {
initGroup();
}
public void updateGroupInfo(HashMap<String, String> values) {
groupInfo = values;
for (String key : values.keySet()) {
if (key.equals(NAME)) {
name = values.get(key);
if (values.get(key) != null) {
nameHash = Integer.toUnsignedString(values.get(key).hashCode());
} else {
nameHash = "";
}
}
if (key.equals(LEADER)) {
leader = values.get(key);
}
if (key.equals(GID)) {
gid = values.get(key);
}
}
}
public void updateGroupState(HashMap<String, String> values) {
groupState = values;
for (String key : values.keySet()) {
if (key.equals(STATE)) {
state = values.get(key);
}
if (key.equals(LEVEL)) {
level = values.get(key);
}
if (key.equals(MUTE)) {
mute = values.get(key);
}
}
}
/**
* Updates the group members.
*
* Generates the {@code groupMembersHash} from the group member PIDs
*
* @param playerList The List of the Player (player as: HashMap<String,String>)
*/
public void updateGroupPlayers(List<HashMap<String, String>> playerList) {
this.playerList = playerList;
groupMemberPidList = new ArrayList<String>(playerList.size());
for (int i = 0; i < this.playerList.size(); i++) {
HashMap<String, String> player = playerList.get(i);
groupMemberPidList.add(player.get(PID));
}
// Generating a dedicated sorted and un-sorted list for different purposes
groupMemberPidListSorted = new ArrayList<String>(playerList.size());
groupMemberPidListSorted.addAll(groupMemberPidList);
Collections.reverse(groupMemberPidList); // List has to be reversed so that leader is at the beginning
Collections.sort(groupMemberPidListSorted);
groupMembersHash = Integer.toUnsignedString(groupMemberPidListSorted.hashCode());
}
public String generateGroupUID() {
List<String> groupUIDHashList = new ArrayList<String>();
groupUIDHashList.add(name);
groupUIDHashList.add(gid);
groupUIDHashList.add(leader);
groupUIDHashList.add(groupMembersHash);
groupUIDHash = Integer.toUnsignedString(groupUIDHashList.hashCode());
return groupUIDHash;
}
private void initGroup() {
groupInfo = new HashMap<>(8);
groupState = new HashMap<>(5);
playerList = new ArrayList<>(5);
for (String key : supportedGroupInfo) {
groupInfo.put(key, null);
}
for (String key : supportedGroupStates) {
groupState.put(key, null);
}
updateGroupInfo(groupInfo);
updateGroupState(groupState);
}
public HashMap<String, String> getGroupInfo() {
return groupInfo;
}
public void setGroupInfo(HashMap<String, String> groupInfo) {
this.groupInfo = groupInfo;
}
public HashMap<String, String> getGroupState() {
return groupState;
}
public void setGroupState(HashMap<String, String> groupState) {
this.groupState = groupState;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
groupInfo.put("name", name);
}
public String getGid() {
return gid;
}
public void setGid(String gid) {
this.gid = gid;
groupInfo.put("gid", gid);
}
public String getLeader() {
return leader;
}
public void setLeader(String leader) {
this.leader = leader;
groupInfo.put("leader", leader);
}
public String getState() {
return state;
}
public void setState(String state) {
this.state = state;
groupInfo.put("state", state);
}
public String getLevel() {
return level;
}
public void setLevel(String level) {
this.level = level;
groupInfo.put("level", level);
}
public String getMute() {
return mute;
}
public void setMute(String mute) {
this.mute = mute;
groupInfo.put("mute", mute);
}
public String[] getSupportedGroupInfo() {
return supportedGroupInfo;
}
public String[] getSupportedGroupStates() {
return supportedGroupStates;
}
public String getNameHash() {
return nameHash;
}
public String getGroupMemberHash() {
return groupMembersHash;
}
public boolean isOnline() {
return online;
}
public void setOnline(boolean online) {
this.online = online;
}
public String getGroupUIDHash() {
return groupUIDHash;
}
public List<String> getGroupMemberPidList() {
return groupMemberPidList;
}
}
| deactivated group member PID List reverse function | src/main/java/org/openhab/binding/heos/resources/HeosGroup.java | deactivated group member PID List reverse function | <ide><path>rc/main/java/org/openhab/binding/heos/resources/HeosGroup.java
<ide> // Generating a dedicated sorted and un-sorted list for different purposes
<ide> groupMemberPidListSorted = new ArrayList<String>(playerList.size());
<ide> groupMemberPidListSorted.addAll(groupMemberPidList);
<del> Collections.reverse(groupMemberPidList); // List has to be reversed so that leader is at the beginning
<add> // Collections.reverse(groupMemberPidList); // List has to be reversed so that leader is at the beginning
<ide> Collections.sort(groupMemberPidListSorted);
<ide> groupMembersHash = Integer.toUnsignedString(groupMemberPidListSorted.hashCode());
<ide> |
|
Java | apache-2.0 | bcb2f8118751846fef373d32cd62b375b0de0a5e | 0 | janstey/fuse-1,migue/fabric8,cunningt/fuse,rajdavies/fabric8,mwringe/fabric8,sobkowiak/fuse,tadayosi/fuse,chirino/fabric8,ffang/fuse-1,mwringe/fabric8,jimmidyson/fabric8,jludvice/fabric8,gashcrumb/fabric8,dhirajsb/fabric8,jimmidyson/fabric8,dhirajsb/fuse,rmarting/fuse,aslakknutsen/fabric8,hekonsek/fabric8,opensourceconsultant/fuse,opensourceconsultant/fuse,janstey/fabric8,punkhorn/fabric8,EricWittmann/fabric8,jonathanchristison/fabric8,zmhassan/fabric8,joelschuster/fuse,jonathanchristison/fabric8,joelschuster/fuse,KurtStam/fabric8,dhirajsb/fuse,chirino/fuse,jimmidyson/fabric8,rhuss/fabric8,hekonsek/fabric8,rajdavies/fabric8,PhilHardwick/fabric8,mwringe/fabric8,rhuss/fabric8,chirino/fabric8v2,hekonsek/fabric8,christian-posta/fabric8,zmhassan/fabric8,aslakknutsen/fabric8,jimmidyson/fabric8,rnc/fabric8,zmhassan/fabric8,janstey/fabric8,dejanb/fuse,janstey/fabric8,PhilHardwick/fabric8,migue/fabric8,cunningt/fuse,punkhorn/fuse,hekonsek/fabric8,chirino/fabric8,rmarting/fuse,migue/fabric8,rhuss/fabric8,jonathanchristison/fabric8,chirino/fabric8v2,sobkowiak/fabric8,rnc/fabric8,ffang/fuse-1,janstey/fuse-1,PhilHardwick/fabric8,jludvice/fabric8,EricWittmann/fabric8,sobkowiak/fabric8,dejanb/fuse,chirino/fabric8v2,migue/fabric8,gashcrumb/fabric8,punkhorn/fuse,ffang/fuse-1,rajdavies/fabric8,punkhorn/fabric8,janstey/fuse-1,KurtStam/fabric8,sobkowiak/fabric8,EricWittmann/fabric8,christian-posta/fabric8,KurtStam/fabric8,tadayosi/fuse,joelschuster/fuse,sobkowiak/fabric8,gashcrumb/fabric8,EricWittmann/fabric8,punkhorn/fabric8,jludvice/fabric8,christian-posta/fabric8,mwringe/fabric8,zmhassan/fabric8,KurtStam/fabric8,jboss-fuse/fuse,avano/fabric8,jboss-fuse/fuse,chirino/fabric8,rnc/fabric8,gashcrumb/fabric8,jonathanchristison/fabric8,avano/fabric8,rmarting/fuse,hekonsek/fabric8,dhirajsb/fabric8,dhirajsb/fabric8,chirino/fabric8v2,PhilHardwick/fabric8,rnc/fabric8,avano/fabric8,aslakknutsen/fabric8,chirino/fabric8,avano/fabric8,jboss-fuse/fuse,dhirajsb/fabric8,rnc/fabric8,dejanb/fuse,rajdavies/fabric8,jludvice/fabric8,jimmidyson/fabric8,punkhorn/fabric8,christian-posta/fabric8,rhuss/fabric8,chirino/fuse,sobkowiak/fuse,opensourceconsultant/fuse | /**
* Copyright (C) FuseSource, Inc.
* http://fusesource.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 org.fusesource.fabric.service;
import static org.apache.felix.scr.annotations.ReferenceCardinality.OPTIONAL_MULTIPLE;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.exists;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.getChildren;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.getSubstitutedData;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.getSubstitutedPath;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.curator.framework.CuratorFramework;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferencePolicy;
import org.apache.felix.scr.annotations.Service;
import org.codehaus.jackson.map.DeserializationConfig;
import org.codehaus.jackson.map.ObjectMapper;
import org.fusesource.fabric.api.Container;
import org.fusesource.fabric.api.Constants;
import org.fusesource.fabric.api.ContainerAutoScaler;
import org.fusesource.fabric.api.ContainerAutoScalerFactory;
import org.fusesource.fabric.api.Containers;
import org.fusesource.fabric.api.ContainerProvider;
import org.fusesource.fabric.api.CreateContainerBasicMetadata;
import org.fusesource.fabric.api.CreateContainerBasicOptions;
import org.fusesource.fabric.api.CreateContainerMetadata;
import org.fusesource.fabric.api.CreateContainerOptions;
import org.fusesource.fabric.api.CreationStateListener;
import org.fusesource.fabric.api.DataStore;
import org.fusesource.fabric.api.FabricException;
import org.fusesource.fabric.api.FabricRequirements;
import org.fusesource.fabric.api.FabricService;
import org.fusesource.fabric.api.FabricStatus;
import org.fusesource.fabric.api.NullCreationStateListener;
import org.fusesource.fabric.api.PatchService;
import org.fusesource.fabric.api.PortService;
import org.fusesource.fabric.api.Profile;
import org.fusesource.fabric.api.ProfileRequirements;
import org.fusesource.fabric.api.RuntimeProperties;
import org.fusesource.fabric.api.Version;
import org.fusesource.fabric.api.jcip.ThreadSafe;
import org.fusesource.fabric.api.scr.AbstractComponent;
import org.fusesource.fabric.api.scr.ValidatingReference;
import org.fusesource.fabric.internal.ContainerImpl;
import org.fusesource.fabric.internal.VersionImpl;
import org.fusesource.fabric.utils.DataStoreUtils;
import org.fusesource.fabric.utils.SystemProperties;
import org.fusesource.fabric.zookeeper.ZkPath;
import org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils;
import org.osgi.framework.BundleContext;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Strings;
import java.util.Collection;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
/**
* FabricService
* |_ ConfigurationAdmin
* |_ CuratorFramework (@see ManagedCuratorFramework)
* | |_ ACLProvider (@see CuratorACLManager)
* |_ DataStore (@see CachingGitDataStore)
* |_ CuratorFramework --^
* |_ DataStoreRegistrationHandler (@see DataStoreTemplateRegistry)
* |_ GitService (@see FabricGitServiceImpl)
* |_ PlaceholderResolver (optional,multiple)
* |_ ContainerProvider (optional,multiple) (@see ChildContainerProvider)
* | |_ FabricService --^
* |_ PortService (@see ZookeeperPortService)
* |_ CuratorFramework --^
*/
@ThreadSafe
@Component(name = "org.fusesource.fabric.service", description = "Fabric Service")
@Service(FabricService.class)
public final class FabricServiceImpl extends AbstractComponent implements FabricService {
public static final String REQUIREMENTS_JSON_PATH = "/fabric/configs/org.fusesource.fabric.requirements.json";
public static final String JVM_OPTIONS_PATH = "/fabric/configs/org.fusesource.fabric.containers.jvmOptions";
private static final Logger LOGGER = LoggerFactory.getLogger(FabricServiceImpl.class);
@Reference(referenceInterface = ConfigurationAdmin.class)
private final ValidatingReference<ConfigurationAdmin> configAdmin = new ValidatingReference<ConfigurationAdmin>();
@Reference(referenceInterface = RuntimeProperties.class)
private final ValidatingReference<RuntimeProperties> runtimeProperties = new ValidatingReference<RuntimeProperties>();
@Reference(referenceInterface = CuratorFramework.class)
private final ValidatingReference<CuratorFramework> curator = new ValidatingReference<CuratorFramework>();
@Reference(referenceInterface = DataStore.class)
private final ValidatingReference<DataStore> dataStore = new ValidatingReference<DataStore>();
@Reference(referenceInterface = PortService.class)
private final ValidatingReference<PortService> portService = new ValidatingReference<PortService>();
@Reference(referenceInterface = ContainerProvider.class, bind = "bindProvider", unbind = "unbindProvider", cardinality = OPTIONAL_MULTIPLE, policy = ReferencePolicy.DYNAMIC)
private final Map<String, ContainerProvider> providers = new ConcurrentHashMap<String, ContainerProvider>();
private String defaultRepo = FabricService.DEFAULT_REPO_URI;
private BundleContext bundleContext;
@Activate
void activate(BundleContext bundleContext) {
this.bundleContext = bundleContext;
activateComponent();
}
@Deactivate
void deactivate() {
deactivateComponent();
}
// FIXME public access on the impl
public CuratorFramework getCurator() {
assertValid();
return curator.get();
}
@Override
public DataStore getDataStore() {
return dataStore.get();
}
public String getDefaultRepo() {
synchronized (this) {
return defaultRepo;
}
}
public void setDefaultRepo(String defaultRepo) {
synchronized (this) {
this.defaultRepo = defaultRepo;
}
}
@Override
public PortService getPortService() {
assertValid();
return portService.get();
}
@Override
public Container getCurrentContainer() {
assertValid();
String name = getCurrentContainerName();
return getContainer(name);
}
@Override
public String getEnvironment() {
assertValid();
return runtimeProperties.get().getProperty(SystemProperties.FABRIC_ENVIRONMENT);
}
@Override
public String getCurrentContainerName() {
assertValid();
return runtimeProperties.get().getProperty(SystemProperties.KARAF_NAME);
}
@Override
public void trackConfiguration(Runnable callback) {
assertValid();
getDataStore().trackConfiguration(callback);
}
@Override
public void untrackConfiguration(Runnable callback) {
assertValid();
getDataStore().untrackConfiguration(callback);
}
@Override
public Container[] getContainers() {
assertValid();
Map<String, Container> containers = new HashMap<String, Container>();
List<String> containerIds = getDataStore().getContainers();
for (String containerId : containerIds) {
String parentId = getDataStore().getContainerParent(containerId);
if (parentId.isEmpty()) {
if (!containers.containsKey(containerId)) {
Container container = new ContainerImpl(null, containerId, this);
containers.put(containerId, container);
}
} else {
Container parent = containers.get(parentId);
if (parent == null) {
parent = new ContainerImpl(null, parentId, this);
containers.put(parentId, parent);
}
Container container = new ContainerImpl(parent, containerId, this);
containers.put(containerId, container);
}
}
return containers.values().toArray(new Container[containers.size()]);
}
@Override
public Container getContainer(String name) {
assertValid();
if (getDataStore().hasContainer(name)) {
Container parent = null;
String parentId = getDataStore().getContainerParent(name);
if (parentId != null && !parentId.isEmpty()) {
parent = getContainer(parentId);
}
return new ContainerImpl(parent, name, this);
}
throw new FabricException("Container '" + name + "' does not exist");
}
@Override
public void startContainer(String containerId) {
startContainer(containerId, false);
}
public void startContainer(String containerId, boolean force) {
assertValid();
Container container = getContainer(containerId);
if (container != null) {
startContainer(container, force);
}
}
public void startContainer(Container container) {
startContainer(container, false);
}
public void startContainer(Container container, boolean force) {
assertValid();
LOGGER.info("Starting container {}", container.getId());
ContainerProvider provider = getProvider(container);
if (force || !container.isAlive()) {
provider.start(container);
}
}
@Override
public void stopContainer(String containerId) {
stopContainer(containerId, false);
}
public void stopContainer(String containerId, boolean force) {
assertValid();
Container container = getContainer(containerId);
if (container != null) {
stopContainer(container, force);
}
}
public void stopContainer(Container container) {
stopContainer(container, false);
}
public void stopContainer(Container container, boolean force) {
assertValid();
LOGGER.info("Stopping container {}", container.getId());
ContainerProvider provider = getProvider(container);
if (force || container.isAlive()) {
provider.stop(container);
}
}
@Override
public void destroyContainer(String containerId) {
destroyContainer(containerId, false);
}
public void destroyContainer(String containerId, boolean force) {
assertValid();
Container container = getContainer(containerId);
if (container != null) {
destroyContainer(container, force);
}
}
@Override
public void destroyContainer(Container container) {
destroyContainer(container, false);
}
public void destroyContainer(Container container, boolean force) {
assertValid();
String containerId = container.getId();
LOGGER.info("Destroying container {}", containerId);
ContainerProvider provider = getProvider(container, true);
if (provider == null && !force) {
// Should throw an exception
getProvider(container);
}
if (provider != null) {
if(container.isAlive()){
provider.stop(container);
}
provider.destroy(container);
}
try {
portService.get().unregisterPort(container);
getDataStore().deleteContainer(container.getId());
} catch (Exception e) {
LOGGER.warn("Failed to cleanup container {} entries due to: {}. This will be ignored.", containerId, e.getMessage());
}
}
private ContainerProvider getProvider(Container container) {
return getProvider(container, false);
}
private ContainerProvider getProvider(Container container, boolean returnNull) {
CreateContainerMetadata metadata = container.getMetadata();
String type = metadata != null ? metadata.getCreateOptions().getProviderType() : null;
if (type == null) {
if (returnNull) {
return null;
}
throw new UnsupportedOperationException("Container " + container.getId() + " has not been created using Fabric");
}
ContainerProvider provider = getProvider(type);
if (provider == null) {
if (returnNull) {
return null;
}
throw new UnsupportedOperationException("Container provider " + type + " not supported");
}
return provider;
}
@Override
public CreateContainerMetadata[] createContainers(CreateContainerOptions options) {
return createContainers(options, null);
}
@Override
public CreateContainerMetadata[] createContainers(CreateContainerOptions options, CreationStateListener listener) {
assertValid();
try {
final ContainerProvider provider = getProvider(options.getProviderType());
if (provider == null) {
throw new FabricException("Unable to find a container provider supporting '" + options.getProviderType() + "'");
}
String originalName = options.getName();
if (originalName == null || originalName.length() == 0) {
throw new FabricException("A name must be specified when creating containers");
}
if (listener == null) {
listener = new NullCreationStateListener();
}
ObjectMapper mapper = new ObjectMapper();
mapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
Map optionsMap = mapper.readValue(mapper.writeValueAsString(options), Map.class);
String versionId = options.getVersion() != null ? options.getVersion() : getDataStore().getDefaultVersion();
Set<String> profileIds = options.getProfiles();
if (profileIds == null || profileIds.isEmpty()) {
profileIds = new LinkedHashSet<String>();
profileIds.add("default");
}
optionsMap.put("version", versionId);
optionsMap.put("profiles", profileIds);
optionsMap.put("number", 0);
final List<CreateContainerMetadata> metadatas = new CopyOnWriteArrayList<CreateContainerMetadata>();
int orgNumber = options.getNumber();
int number = Math.max(orgNumber, 1);
final CountDownLatch latch = new CountDownLatch(number);
for (int i = 1; i <= number; i++) {
String containerName;
if (orgNumber >= 1) {
containerName = originalName + i;
} else {
containerName = originalName;
}
optionsMap.put("name", containerName);
//Check if datastore configuration has been specified and fallback to current container settings.
if (!hasValidDataStoreProperties(optionsMap)) {
optionsMap.put("dataStoreProperties", getDataStore().getDataStoreProperties());
}
Class cl = options.getClass().getClassLoader().loadClass(options.getClass().getName() + "$Builder");
CreateContainerBasicOptions.Builder builder = (CreateContainerBasicOptions.Builder) mapper.readValue(mapper.writeValueAsString(optionsMap), cl);
final CreateContainerOptions containerOptions = builder.build();
final CreationStateListener containerListener = listener;
new Thread("Creating container " + containerName) {
public void run() {
try {
getDataStore().createContainerConfig(containerOptions);
CreateContainerMetadata metadata = provider.create(containerOptions, containerListener);
if (metadata.isSuccess()) {
Container parent = containerOptions.getParent() != null ? getContainer(containerOptions.getParent()) : null;
//An ensemble server can be created without an existing ensemble.
//In this case container config will be created by the newly created container.
//TODO: We need to make sure that this entries are somehow added even to ensemble servers.
if (!containerOptions.isEnsembleServer()) {
getDataStore().createContainerConfig(metadata);
}
ContainerImpl container = new ContainerImpl(parent, metadata.getContainerName(), FabricServiceImpl.this);
metadata.setContainer(container);
container.setMetadata(metadata);
LOGGER.info("The container " + metadata.getContainerName() + " has been successfully created");
} else {
LOGGER.info("The creation of the container " + metadata.getContainerName() + " has failed", metadata.getFailure());
}
metadatas.add(metadata);
} catch (Throwable t) {
CreateContainerBasicMetadata metadata = new CreateContainerBasicMetadata();
metadata.setCreateOptions(containerOptions);
metadata.setFailure(t);
metadatas.add(metadata);
getDataStore().deleteContainer(containerOptions.getName());
} finally {
latch.countDown();
}
}
}.start();
}
if (!latch.await(15, TimeUnit.MINUTES)) {
throw new FabricException("Timeout waiting for container creation");
}
return metadatas.toArray(new CreateContainerMetadata[metadatas.size()]);
} catch (Exception e) {
LOGGER.error("Failed to create containers " + e, e);
throw FabricException.launderThrowable(e);
}
}
@Override
public Set<Class<? extends CreateContainerBasicOptions>> getSupportedCreateContainerOptionTypes() {
assertValid();
Set<Class<? extends CreateContainerBasicOptions>> optionTypes = new HashSet<Class<? extends CreateContainerBasicOptions>>();
for (Map.Entry<String, ContainerProvider> entry : providers.entrySet()) {
optionTypes.add(entry.getValue().getOptionsType());
}
return optionTypes;
}
@Override
public Set<Class<? extends CreateContainerBasicMetadata>> getSupportedCreateContainerMetadataTypes() {
assertValid();
Set<Class<? extends CreateContainerBasicMetadata>> metadataTypes = new HashSet<Class<? extends CreateContainerBasicMetadata>>();
for (Map.Entry<String, ContainerProvider> entry : providers.entrySet()) {
metadataTypes.add(entry.getValue().getMetadataType());
}
return metadataTypes;
}
@Override
public ContainerProvider getProvider(final String scheme) {
return providers.get(scheme);
}
// FIXME public access on the impl
public Map<String, ContainerProvider> getProviders() {
assertValid();
return Collections.unmodifiableMap(providers);
}
@Override
public URI getMavenRepoURI() {
assertValid();
URI uri = URI.create(getDefaultRepo());
try {
if (exists(curator.get(), ZkPath.MAVEN_PROXY.getPath("download")) != null) {
List<String> children = getChildren(curator.get(), ZkPath.MAVEN_PROXY.getPath("download"));
if (children != null && !children.isEmpty()) {
Collections.sort(children);
}
String mavenRepo = getSubstitutedPath(curator.get(), ZkPath.MAVEN_PROXY.getPath("download") + "/" + children.get(0));
if (mavenRepo != null && !mavenRepo.endsWith("/")) {
mavenRepo += "/";
}
uri = new URI(mavenRepo);
}
} catch (Exception e) {
//On exception just return uri.
}
return uri;
}
@Override
public List<URI> getMavenRepoURIs() {
assertValid();
try {
List<URI> uris = new ArrayList<URI>();
if (exists(curator.get(), ZkPath.MAVEN_PROXY.getPath("download")) != null) {
List<String> children = getChildren(curator.get(), ZkPath.MAVEN_PROXY.getPath("download"));
if (children != null && !children.isEmpty()) {
Collections.sort(children);
}
if (children != null) {
for (String child : children) {
String mavenRepo = getSubstitutedPath(curator.get(), ZkPath.MAVEN_PROXY.getPath("download") + "/" + child);
if (mavenRepo != null && !mavenRepo.endsWith("/")) {
mavenRepo += "/";
}
uris.add(new URI(mavenRepo));
}
}
}
return uris;
} catch (Exception e) {
throw FabricException.launderThrowable(e);
}
}
@Override
public URI getMavenRepoUploadURI() {
assertValid();
URI uri = URI.create(getDefaultRepo());
try {
if (exists(curator.get(), ZkPath.MAVEN_PROXY.getPath("upload")) != null) {
List<String> children = getChildren(curator.get(), ZkPath.MAVEN_PROXY.getPath("upload"));
if (children != null && !children.isEmpty()) {
Collections.sort(children);
}
String mavenRepo = getSubstitutedPath(curator.get(), ZkPath.MAVEN_PROXY.getPath("upload") + "/" + children.get(0));
if (mavenRepo != null && !mavenRepo.endsWith("/")) {
mavenRepo += "/";
}
uri = new URI(mavenRepo);
}
} catch (Exception e) {
//On exception just return uri.
}
return uri;
}
public String containerWebAppURL(String webAppId, String name) {
assertValid();
// lets try both the webapps and servlets area
String answer = containerWebAppUrl(ZkPath.WEBAPPS_CLUSTER.getPath(webAppId), name);
if (answer == null) {
answer = containerWebAppUrl(ZkPath.SERVLETS_CLUSTER.getPath(webAppId), name);
}
return answer;
}
private String containerWebAppUrl(String versionsPath, String name) {
try {
if (exists(curator.get(), versionsPath) != null) {
List<String> children = getChildren(curator.get(), versionsPath);
if (children != null && !children.isEmpty()) {
for (String child : children) {
if (Strings.isNullOrEmpty(name)) {
// lets just use the first container we find
String parentPath = versionsPath + "/" + child;
List<String> grandChildren = getChildren(curator.get(), parentPath);
if (!grandChildren.isEmpty()) {
String containerPath = parentPath + "/" + grandChildren.get(0);
String answer = getWebUrl(containerPath);
if (!Strings.isNullOrEmpty(answer)) {
return answer;
}
}
} else {
String childPath = versionsPath + "/" + child;
String containerPath = childPath + "/" + name;
String answer = getWebUrl(containerPath);
if (Strings.isNullOrEmpty(answer)) {
// lets recurse into a child folder just in case
// or in the case of servlet paths where there may be extra levels of depth
answer = containerWebAppUrl(childPath, name);
}
if (!Strings.isNullOrEmpty(answer)) {
return answer;
}
}
}
}
}
} catch (Exception e) {
LOGGER.error("Failed to find container Jolokia URL " + e, e);
}
return null;
}
private String getWebUrl(String containerPath) throws Exception {
if (curator.get().checkExists().forPath(containerPath) != null) {
byte[] bytes = ZkPath.loadURL(curator.get(), containerPath);
String text = new String(bytes);
// NOTE this is a bit naughty, we should probably be doing
// Jackson parsing here; but we only need 1 String and
// this avoids the jackson runtime dependency - its just a bit brittle
// only finding http endpoints and all
String prefix = "\"services\":[\"";
int idx = text.indexOf(prefix);
String answer = text;
if (idx > 0) {
int startIndex = idx + prefix.length();
int endIdx = text.indexOf("\"]", startIndex);
if (endIdx > 0) {
answer = text.substring(startIndex, endIdx);
if (answer.length() > 0) {
// lets expand any variables
answer = ZooKeeperUtils.getSubstitutedData(curator.get(), answer);
return answer;
}
}
}
}
return null;
}
private static boolean hasValidDataStoreProperties(Map options) {
if (!options.containsKey("dataStoreProperties")) {
return false;
}
Object props = options.get("dataStoreProperties");
if (props instanceof Map) {
return !((Map) props).isEmpty();
} else {
return false;
}
}
// FIXME public access on the impl
public void registerProvider(String scheme, ContainerProvider provider) {
assertValid();
providers.put(scheme, provider);
}
// FIXME public access on the impl
public void registerProvider(ContainerProvider provider, Map<String, Object> properties) {
assertValid();
String scheme = (String) properties.get(org.fusesource.fabric.utils.Constants.PROTOCOL);
registerProvider(scheme, provider);
}
// FIXME public access on the impl
public void unregisterProvider(String scheme) {
assertValid();
providers.remove(scheme);
}
// FIXME public access on the impl
public void unregisterProvider(ContainerProvider provider, Map<String, Object> properties) {
assertValid();
String scheme = (String) properties.get(org.fusesource.fabric.utils.Constants.PROTOCOL);
unregisterProvider(scheme);
}
@Override
public String getZookeeperUrl() {
assertValid();
return getZookeeperInfo("zookeeper.url");
}
@Override
public String getZookeeperPassword() {
assertValid();
return getZookeeperInfo("zookeeper.password");
}
// FIXME public access on the impl
public String getZookeeperInfo(String name) {
assertValid();
String zooKeeperUrl = null;
//We are looking directly for at the zookeeper for the url, since container might not even be mananaged.
//Also this is required for the integration with the IDE.
try {
if (curator.get().getZookeeperClient().isConnected()) {
Version defaultVersion = getDefaultVersion();
if (defaultVersion != null) {
Profile profile = defaultVersion.getProfile("default");
if (profile != null) {
Map<String, String> zookeeperConfig = profile.getConfiguration(Constants.ZOOKEEPER_CLIENT_PID);
if (zookeeperConfig != null) {
zooKeeperUrl = getSubstitutedData(curator.get(), zookeeperConfig.get(name));
}
}
}
}
} catch (Exception e) {
//Ignore it.
}
if (zooKeeperUrl == null) {
try {
Configuration config = configAdmin.get().getConfiguration(Constants.ZOOKEEPER_CLIENT_PID, null);
zooKeeperUrl = (String) config.getProperties().get(name);
} catch (Exception e) {
//Ignore it.
}
}
return zooKeeperUrl;
}
@Override
public Version getDefaultVersion() {
assertValid();
return new VersionImpl(getDataStore().getDefaultVersion(), this);
}
@Override
public void setDefaultVersion(Version version) {
assertValid();
setDefaultVersion(version.getId());
}
public void setDefaultVersion(String versionId) {
assertValid();
getDataStore().setDefaultVersion(versionId);
}
@Override
public Version createVersion(String version) {
assertValid();
getDataStore().createVersion(version);
return new VersionImpl(version, this);
}
@Override
public Version createVersion(Version parent, String toVersion) {
assertValid();
return createVersion(parent.getId(), toVersion);
}
// FIXME public access on the impl
public Version createVersion(String parentVersionId, String toVersion) {
assertValid();
getDataStore().createVersion(parentVersionId, toVersion);
return new VersionImpl(toVersion, this);
}
// FIXME public access on the impl
public void deleteVersion(String version) {
assertValid();
getVersion(version).delete();
}
@Override
public Version[] getVersions() {
assertValid();
List<Version> versions = new ArrayList<Version>();
List<String> children = getDataStore().getVersions();
for (String child : children) {
versions.add(new VersionImpl(child, this));
}
Collections.sort(versions);
return versions.toArray(new Version[versions.size()]);
}
@Override
public Version getVersion(String name) {
assertValid();
if (getDataStore().hasVersion(name)) {
return new VersionImpl(name, this);
}
throw new FabricException("Version '" + name + "' does not exist");
}
@Override
public Profile[] getProfiles(String version) {
assertValid();
return getVersion(version).getProfiles();
}
@Override
public Profile getProfile(String version, String name) {
assertValid();
return getVersion(version).getProfile(name);
}
@Override
public Profile createProfile(String version, String name) {
assertValid();
return getVersion(version).createProfile(name);
}
@Override
public void deleteProfile(Profile profile) {
assertValid();
deleteProfile(profile.getVersion(), profile.getId());
}
private void deleteProfile(String versionId, String profileId) {
getDataStore().deleteProfile(versionId, profileId);
}
@Override
public void setRequirements(FabricRequirements requirements) throws IOException {
assertValid();
getDataStore().setRequirements(requirements);
}
@Override
public FabricRequirements getRequirements() {
assertValid();
FabricRequirements requirements = getDataStore().getRequirements();
Version defaultVersion = getDefaultVersion();
if (defaultVersion != null) {
requirements.setVersion(defaultVersion.getId());
}
return requirements;
}
@Override
public FabricStatus getFabricStatus() {
assertValid();
return new FabricStatus(this);
}
@Override
public PatchService getPatchService() {
assertValid();
return new PatchServiceImpl(runtimeProperties.get(), this, configAdmin.get(), bundleContext);
}
@Override
public String getDefaultJvmOptions() {
assertValid();
return getDataStore().getDefaultJvmOptions();
}
@Override
public void setDefaultJvmOptions(String jvmOptions) {
assertValid();
getDataStore().setDefaultJvmOptions(jvmOptions);
}
@Override
public String getConfigurationValue(String versionId, String profileId, String pid, String key) {
assertValid();
Version v = getVersion(versionId);
if (v == null)
throw new FabricException("No version found: " + versionId);
Profile pr = v.getProfile(profileId);
if (pr == null)
throw new FabricException("No profile found: " + profileId);
Map<String, byte[]> configs = pr.getFileConfigurations();
byte[] b = configs.get(pid);
Properties p = null;
try {
if (b != null) {
p = DataStoreUtils.toProperties(b);
} else {
p = new Properties();
}
} catch (Throwable t) {
throw new FabricException(t);
}
return p.getProperty(key);
}
@Override
public void setConfigurationValue(String versionId, String profileId, String pid, String key, String value) {
assertValid();
Version v = getVersion(versionId);
if (v == null)
throw new FabricException("No version found: " + versionId);
Profile pr = v.getProfile(profileId);
if (pr == null)
throw new FabricException("No profile found: " + profileId);
Map<String, byte[]> configs = pr.getFileConfigurations();
byte[] b = configs.get(pid);
Properties p = null;
try {
if (b != null) {
p = DataStoreUtils.toProperties(b);
} else {
p = new Properties();
}
p.setProperty(key, value);
b = DataStoreUtils.toBytes(p);
configs.put(pid, b);
pr.setFileConfigurations(configs);
} catch (Throwable t) {
throw new FabricException(t);
}
}
@Override
public boolean scaleProfile(String profile, int numberOfInstances) throws IOException {
if (numberOfInstances == 0) {
throw new IllegalArgumentException("numberOfInstances should be greater or less than zero");
}
FabricRequirements requirements = getRequirements();
ProfileRequirements profileRequirements = requirements.getOrCreateProfileRequirement(profile);
Integer minimumInstances = profileRequirements.getMinimumInstances();
List<Container> containers = Containers.containersForProfile(getContainers(), profile);
int containerCount = containers.size();
int newCount = containerCount + numberOfInstances;
if (newCount < 0) {
newCount = 0;
}
boolean update = minimumInstances == null || newCount != minimumInstances;
if (update) {
profileRequirements.setMinimumInstances(newCount);
setRequirements(requirements);
}
return update;
}
@Override
public ContainerAutoScaler createContainerAutoScaler() {
Collection<ContainerProvider> providerCollection = getProviders().values();
for (ContainerProvider containerProvider : providerCollection) {
if (containerProvider instanceof ContainerAutoScalerFactory) {
ContainerAutoScalerFactory provider = (ContainerAutoScalerFactory) containerProvider;
ContainerAutoScaler answer = provider.createAutoScaler();
if (answer != null) {
return answer;
}
}
}
return null;
}
void bindConfigAdmin(ConfigurationAdmin service) {
this.configAdmin.bind(service);
}
void unbindConfigAdmin(ConfigurationAdmin service) {
this.configAdmin.unbind(service);
}
void bindRuntimeProperties(RuntimeProperties service) {
this.runtimeProperties.bind(service);
}
void unbindRuntimeProperties(RuntimeProperties service) {
this.runtimeProperties.unbind(service);
}
void bindCurator(CuratorFramework curator) {
this.curator.bind(curator);
}
void unbindCurator(CuratorFramework curator) {
this.curator.unbind(curator);
}
void bindDataStore(DataStore dataStore) {
this.dataStore.bind(dataStore);
}
void unbindDataStore(DataStore dataStore) {
this.dataStore.unbind(dataStore);
}
void bindPortService(PortService portService) {
this.portService.bind(portService);
}
void unbindPortService(PortService portService) {
this.portService.unbind(portService);
}
void bindProvider(ContainerProvider provider) {
providers.put(provider.getScheme(), provider);
}
void unbindProvider(ContainerProvider provider) {
providers.remove(provider.getScheme());
}
}
| fabric/fabric-core/src/main/java/org/fusesource/fabric/service/FabricServiceImpl.java | /**
* Copyright (C) FuseSource, Inc.
* http://fusesource.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 org.fusesource.fabric.service;
import static org.apache.felix.scr.annotations.ReferenceCardinality.OPTIONAL_MULTIPLE;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.exists;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.getChildren;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.getSubstitutedData;
import static org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils.getSubstitutedPath;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.curator.framework.CuratorFramework;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferencePolicy;
import org.apache.felix.scr.annotations.Service;
import org.codehaus.jackson.map.DeserializationConfig;
import org.codehaus.jackson.map.ObjectMapper;
import org.fusesource.fabric.api.Container;
import org.fusesource.fabric.api.Constants;
import org.fusesource.fabric.api.ContainerAutoScaler;
import org.fusesource.fabric.api.ContainerAutoScalerFactory;
import org.fusesource.fabric.api.Containers;
import org.fusesource.fabric.api.ContainerProvider;
import org.fusesource.fabric.api.CreateContainerBasicMetadata;
import org.fusesource.fabric.api.CreateContainerBasicOptions;
import org.fusesource.fabric.api.CreateContainerMetadata;
import org.fusesource.fabric.api.CreateContainerOptions;
import org.fusesource.fabric.api.CreationStateListener;
import org.fusesource.fabric.api.DataStore;
import org.fusesource.fabric.api.FabricException;
import org.fusesource.fabric.api.FabricRequirements;
import org.fusesource.fabric.api.FabricService;
import org.fusesource.fabric.api.FabricStatus;
import org.fusesource.fabric.api.NullCreationStateListener;
import org.fusesource.fabric.api.PatchService;
import org.fusesource.fabric.api.PortService;
import org.fusesource.fabric.api.Profile;
import org.fusesource.fabric.api.ProfileRequirements;
import org.fusesource.fabric.api.RuntimeProperties;
import org.fusesource.fabric.api.Version;
import org.fusesource.fabric.api.jcip.ThreadSafe;
import org.fusesource.fabric.api.scr.AbstractComponent;
import org.fusesource.fabric.api.scr.ValidatingReference;
import org.fusesource.fabric.internal.ContainerImpl;
import org.fusesource.fabric.internal.VersionImpl;
import org.fusesource.fabric.utils.DataStoreUtils;
import org.fusesource.fabric.utils.SystemProperties;
import org.fusesource.fabric.zookeeper.ZkPath;
import org.fusesource.fabric.zookeeper.utils.ZooKeeperUtils;
import org.osgi.framework.BundleContext;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Strings;
import java.util.Collection;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
/**
* FabricService
* |_ ConfigurationAdmin
* |_ CuratorFramework (@see ManagedCuratorFramework)
* | |_ ACLProvider (@see CuratorACLManager)
* |_ DataStore (@see CachingGitDataStore)
* |_ CuratorFramework --^
* |_ DataStoreRegistrationHandler (@see DataStoreTemplateRegistry)
* |_ GitService (@see FabricGitServiceImpl)
* |_ PlaceholderResolver (optional,multiple)
* |_ ContainerProvider (optional,multiple) (@see ChildContainerProvider)
* | |_ FabricService --^
* |_ PortService (@see ZookeeperPortService)
* |_ CuratorFramework --^
*/
@ThreadSafe
@Component(name = "org.fusesource.fabric.service", description = "Fabric Service")
@Service(FabricService.class)
public final class FabricServiceImpl extends AbstractComponent implements FabricService {
public static final String REQUIREMENTS_JSON_PATH = "/fabric/configs/org.fusesource.fabric.requirements.json";
public static final String JVM_OPTIONS_PATH = "/fabric/configs/org.fusesource.fabric.containers.jvmOptions";
private static final Logger LOGGER = LoggerFactory.getLogger(FabricServiceImpl.class);
@Reference(referenceInterface = ConfigurationAdmin.class)
private final ValidatingReference<ConfigurationAdmin> configAdmin = new ValidatingReference<ConfigurationAdmin>();
@Reference(referenceInterface = RuntimeProperties.class)
private final ValidatingReference<RuntimeProperties> runtimeProperties = new ValidatingReference<RuntimeProperties>();
@Reference(referenceInterface = CuratorFramework.class)
private final ValidatingReference<CuratorFramework> curator = new ValidatingReference<CuratorFramework>();
@Reference(referenceInterface = DataStore.class)
private final ValidatingReference<DataStore> dataStore = new ValidatingReference<DataStore>();
@Reference(referenceInterface = PortService.class)
private final ValidatingReference<PortService> portService = new ValidatingReference<PortService>();
@Reference(referenceInterface = ContainerProvider.class, bind = "bindProvider", unbind = "unbindProvider", cardinality = OPTIONAL_MULTIPLE, policy = ReferencePolicy.DYNAMIC)
private final Map<String, ContainerProvider> providers = new ConcurrentHashMap<String, ContainerProvider>();
private String defaultRepo = FabricService.DEFAULT_REPO_URI;
private BundleContext bundleContext;
@Activate
void activate(BundleContext bundleContext) {
this.bundleContext = bundleContext;
activateComponent();
}
@Deactivate
void deactivate() {
deactivateComponent();
}
// FIXME public access on the impl
public CuratorFramework getCurator() {
assertValid();
return curator.get();
}
@Override
public DataStore getDataStore() {
return dataStore.get();
}
public String getDefaultRepo() {
synchronized (this) {
return defaultRepo;
}
}
public void setDefaultRepo(String defaultRepo) {
synchronized (this) {
this.defaultRepo = defaultRepo;
}
}
@Override
public PortService getPortService() {
assertValid();
return portService.get();
}
@Override
public Container getCurrentContainer() {
assertValid();
String name = getCurrentContainerName();
return getContainer(name);
}
@Override
public String getEnvironment() {
assertValid();
return runtimeProperties.get().getProperty(SystemProperties.FABRIC_ENVIRONMENT);
}
@Override
public String getCurrentContainerName() {
assertValid();
return runtimeProperties.get().getProperty(SystemProperties.KARAF_NAME);
}
@Override
public void trackConfiguration(Runnable callback) {
assertValid();
getDataStore().trackConfiguration(callback);
}
@Override
public void untrackConfiguration(Runnable callback) {
assertValid();
getDataStore().untrackConfiguration(callback);
}
@Override
public Container[] getContainers() {
assertValid();
Map<String, Container> containers = new HashMap<String, Container>();
List<String> containerIds = getDataStore().getContainers();
for (String containerId : containerIds) {
String parentId = getDataStore().getContainerParent(containerId);
if (parentId.isEmpty()) {
if (!containers.containsKey(containerId)) {
Container container = new ContainerImpl(null, containerId, this);
containers.put(containerId, container);
}
} else {
Container parent = containers.get(parentId);
if (parent == null) {
parent = new ContainerImpl(null, parentId, this);
containers.put(parentId, parent);
}
Container container = new ContainerImpl(parent, containerId, this);
containers.put(containerId, container);
}
}
return containers.values().toArray(new Container[containers.size()]);
}
@Override
public Container getContainer(String name) {
assertValid();
if (getDataStore().hasContainer(name)) {
Container parent = null;
String parentId = getDataStore().getContainerParent(name);
if (parentId != null && !parentId.isEmpty()) {
parent = getContainer(parentId);
}
return new ContainerImpl(parent, name, this);
}
throw new FabricException("Container '" + name + "' does not exist");
}
@Override
public void startContainer(String containerId) {
startContainer(containerId, false);
}
public void startContainer(String containerId, boolean force) {
assertValid();
Container container = getContainer(containerId);
if (container != null) {
startContainer(container, force);
}
}
public void startContainer(Container container) {
startContainer(container, false);
}
public void startContainer(Container container, boolean force) {
assertValid();
LOGGER.info("Starting container {}", container.getId());
ContainerProvider provider = getProvider(container);
if (force || !container.isAlive()) {
provider.start(container);
}
}
@Override
public void stopContainer(String containerId) {
stopContainer(containerId, false);
}
public void stopContainer(String containerId, boolean force) {
assertValid();
Container container = getContainer(containerId);
if (container != null) {
stopContainer(container, force);
}
}
public void stopContainer(Container container) {
stopContainer(container, false);
}
public void stopContainer(Container container, boolean force) {
assertValid();
LOGGER.info("Stopping container {}", container.getId());
ContainerProvider provider = getProvider(container);
if (force || container.isAlive()) {
provider.stop(container);
}
}
@Override
public void destroyContainer(String containerId) {
destroyContainer(containerId, false);
}
public void destroyContainer(String containerId, boolean force) {
assertValid();
Container container = getContainer(containerId);
if (container != null) {
destroyContainer(container, force);
}
}
@Override
public void destroyContainer(Container container) {
destroyContainer(container, false);
}
public void destroyContainer(Container container, boolean force) {
assertValid();
String containerId = container.getId();
LOGGER.info("Destroying container {}", containerId);
ContainerProvider provider = getProvider(container, true);
if (provider == null && !force) {
// Should throw an exception
getProvider(container);
}
if (provider != null) {
provider.stop(container);
provider.destroy(container);
}
try {
portService.get().unregisterPort(container);
getDataStore().deleteContainer(container.getId());
} catch (Exception e) {
LOGGER.warn("Failed to cleanup container {} entries due to: {}. This will be ignored.", containerId, e.getMessage());
}
}
private ContainerProvider getProvider(Container container) {
return getProvider(container, false);
}
private ContainerProvider getProvider(Container container, boolean returnNull) {
CreateContainerMetadata metadata = container.getMetadata();
String type = metadata != null ? metadata.getCreateOptions().getProviderType() : null;
if (type == null) {
if (returnNull) {
return null;
}
throw new UnsupportedOperationException("Container " + container.getId() + " has not been created using Fabric");
}
ContainerProvider provider = getProvider(type);
if (provider == null) {
if (returnNull) {
return null;
}
throw new UnsupportedOperationException("Container provider " + type + " not supported");
}
return provider;
}
@Override
public CreateContainerMetadata[] createContainers(CreateContainerOptions options) {
return createContainers(options, null);
}
@Override
public CreateContainerMetadata[] createContainers(CreateContainerOptions options, CreationStateListener listener) {
assertValid();
try {
final ContainerProvider provider = getProvider(options.getProviderType());
if (provider == null) {
throw new FabricException("Unable to find a container provider supporting '" + options.getProviderType() + "'");
}
String originalName = options.getName();
if (originalName == null || originalName.length() == 0) {
throw new FabricException("A name must be specified when creating containers");
}
if (listener == null) {
listener = new NullCreationStateListener();
}
ObjectMapper mapper = new ObjectMapper();
mapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
Map optionsMap = mapper.readValue(mapper.writeValueAsString(options), Map.class);
String versionId = options.getVersion() != null ? options.getVersion() : getDataStore().getDefaultVersion();
Set<String> profileIds = options.getProfiles();
if (profileIds == null || profileIds.isEmpty()) {
profileIds = new LinkedHashSet<String>();
profileIds.add("default");
}
optionsMap.put("version", versionId);
optionsMap.put("profiles", profileIds);
optionsMap.put("number", 0);
final List<CreateContainerMetadata> metadatas = new CopyOnWriteArrayList<CreateContainerMetadata>();
int orgNumber = options.getNumber();
int number = Math.max(orgNumber, 1);
final CountDownLatch latch = new CountDownLatch(number);
for (int i = 1; i <= number; i++) {
String containerName;
if (orgNumber >= 1) {
containerName = originalName + i;
} else {
containerName = originalName;
}
optionsMap.put("name", containerName);
//Check if datastore configuration has been specified and fallback to current container settings.
if (!hasValidDataStoreProperties(optionsMap)) {
optionsMap.put("dataStoreProperties", getDataStore().getDataStoreProperties());
}
Class cl = options.getClass().getClassLoader().loadClass(options.getClass().getName() + "$Builder");
CreateContainerBasicOptions.Builder builder = (CreateContainerBasicOptions.Builder) mapper.readValue(mapper.writeValueAsString(optionsMap), cl);
final CreateContainerOptions containerOptions = builder.build();
final CreationStateListener containerListener = listener;
new Thread("Creating container " + containerName) {
public void run() {
try {
getDataStore().createContainerConfig(containerOptions);
CreateContainerMetadata metadata = provider.create(containerOptions, containerListener);
if (metadata.isSuccess()) {
Container parent = containerOptions.getParent() != null ? getContainer(containerOptions.getParent()) : null;
//An ensemble server can be created without an existing ensemble.
//In this case container config will be created by the newly created container.
//TODO: We need to make sure that this entries are somehow added even to ensemble servers.
if (!containerOptions.isEnsembleServer()) {
getDataStore().createContainerConfig(metadata);
}
ContainerImpl container = new ContainerImpl(parent, metadata.getContainerName(), FabricServiceImpl.this);
metadata.setContainer(container);
container.setMetadata(metadata);
LOGGER.info("The container " + metadata.getContainerName() + " has been successfully created");
} else {
LOGGER.info("The creation of the container " + metadata.getContainerName() + " has failed", metadata.getFailure());
}
metadatas.add(metadata);
} catch (Throwable t) {
CreateContainerBasicMetadata metadata = new CreateContainerBasicMetadata();
metadata.setCreateOptions(containerOptions);
metadata.setFailure(t);
metadatas.add(metadata);
getDataStore().deleteContainer(containerOptions.getName());
} finally {
latch.countDown();
}
}
}.start();
}
if (!latch.await(15, TimeUnit.MINUTES)) {
throw new FabricException("Timeout waiting for container creation");
}
return metadatas.toArray(new CreateContainerMetadata[metadatas.size()]);
} catch (Exception e) {
LOGGER.error("Failed to create containers " + e, e);
throw FabricException.launderThrowable(e);
}
}
@Override
public Set<Class<? extends CreateContainerBasicOptions>> getSupportedCreateContainerOptionTypes() {
assertValid();
Set<Class<? extends CreateContainerBasicOptions>> optionTypes = new HashSet<Class<? extends CreateContainerBasicOptions>>();
for (Map.Entry<String, ContainerProvider> entry : providers.entrySet()) {
optionTypes.add(entry.getValue().getOptionsType());
}
return optionTypes;
}
@Override
public Set<Class<? extends CreateContainerBasicMetadata>> getSupportedCreateContainerMetadataTypes() {
assertValid();
Set<Class<? extends CreateContainerBasicMetadata>> metadataTypes = new HashSet<Class<? extends CreateContainerBasicMetadata>>();
for (Map.Entry<String, ContainerProvider> entry : providers.entrySet()) {
metadataTypes.add(entry.getValue().getMetadataType());
}
return metadataTypes;
}
@Override
public ContainerProvider getProvider(final String scheme) {
return providers.get(scheme);
}
// FIXME public access on the impl
public Map<String, ContainerProvider> getProviders() {
assertValid();
return Collections.unmodifiableMap(providers);
}
@Override
public URI getMavenRepoURI() {
assertValid();
URI uri = URI.create(getDefaultRepo());
try {
if (exists(curator.get(), ZkPath.MAVEN_PROXY.getPath("download")) != null) {
List<String> children = getChildren(curator.get(), ZkPath.MAVEN_PROXY.getPath("download"));
if (children != null && !children.isEmpty()) {
Collections.sort(children);
}
String mavenRepo = getSubstitutedPath(curator.get(), ZkPath.MAVEN_PROXY.getPath("download") + "/" + children.get(0));
if (mavenRepo != null && !mavenRepo.endsWith("/")) {
mavenRepo += "/";
}
uri = new URI(mavenRepo);
}
} catch (Exception e) {
//On exception just return uri.
}
return uri;
}
@Override
public List<URI> getMavenRepoURIs() {
assertValid();
try {
List<URI> uris = new ArrayList<URI>();
if (exists(curator.get(), ZkPath.MAVEN_PROXY.getPath("download")) != null) {
List<String> children = getChildren(curator.get(), ZkPath.MAVEN_PROXY.getPath("download"));
if (children != null && !children.isEmpty()) {
Collections.sort(children);
}
if (children != null) {
for (String child : children) {
String mavenRepo = getSubstitutedPath(curator.get(), ZkPath.MAVEN_PROXY.getPath("download") + "/" + child);
if (mavenRepo != null && !mavenRepo.endsWith("/")) {
mavenRepo += "/";
}
uris.add(new URI(mavenRepo));
}
}
}
return uris;
} catch (Exception e) {
throw FabricException.launderThrowable(e);
}
}
@Override
public URI getMavenRepoUploadURI() {
assertValid();
URI uri = URI.create(getDefaultRepo());
try {
if (exists(curator.get(), ZkPath.MAVEN_PROXY.getPath("upload")) != null) {
List<String> children = getChildren(curator.get(), ZkPath.MAVEN_PROXY.getPath("upload"));
if (children != null && !children.isEmpty()) {
Collections.sort(children);
}
String mavenRepo = getSubstitutedPath(curator.get(), ZkPath.MAVEN_PROXY.getPath("upload") + "/" + children.get(0));
if (mavenRepo != null && !mavenRepo.endsWith("/")) {
mavenRepo += "/";
}
uri = new URI(mavenRepo);
}
} catch (Exception e) {
//On exception just return uri.
}
return uri;
}
public String containerWebAppURL(String webAppId, String name) {
assertValid();
// lets try both the webapps and servlets area
String answer = containerWebAppUrl(ZkPath.WEBAPPS_CLUSTER.getPath(webAppId), name);
if (answer == null) {
answer = containerWebAppUrl(ZkPath.SERVLETS_CLUSTER.getPath(webAppId), name);
}
return answer;
}
private String containerWebAppUrl(String versionsPath, String name) {
try {
if (exists(curator.get(), versionsPath) != null) {
List<String> children = getChildren(curator.get(), versionsPath);
if (children != null && !children.isEmpty()) {
for (String child : children) {
if (Strings.isNullOrEmpty(name)) {
// lets just use the first container we find
String parentPath = versionsPath + "/" + child;
List<String> grandChildren = getChildren(curator.get(), parentPath);
if (!grandChildren.isEmpty()) {
String containerPath = parentPath + "/" + grandChildren.get(0);
String answer = getWebUrl(containerPath);
if (!Strings.isNullOrEmpty(answer)) {
return answer;
}
}
} else {
String childPath = versionsPath + "/" + child;
String containerPath = childPath + "/" + name;
String answer = getWebUrl(containerPath);
if (Strings.isNullOrEmpty(answer)) {
// lets recurse into a child folder just in case
// or in the case of servlet paths where there may be extra levels of depth
answer = containerWebAppUrl(childPath, name);
}
if (!Strings.isNullOrEmpty(answer)) {
return answer;
}
}
}
}
}
} catch (Exception e) {
LOGGER.error("Failed to find container Jolokia URL " + e, e);
}
return null;
}
private String getWebUrl(String containerPath) throws Exception {
if (curator.get().checkExists().forPath(containerPath) != null) {
byte[] bytes = ZkPath.loadURL(curator.get(), containerPath);
String text = new String(bytes);
// NOTE this is a bit naughty, we should probably be doing
// Jackson parsing here; but we only need 1 String and
// this avoids the jackson runtime dependency - its just a bit brittle
// only finding http endpoints and all
String prefix = "\"services\":[\"";
int idx = text.indexOf(prefix);
String answer = text;
if (idx > 0) {
int startIndex = idx + prefix.length();
int endIdx = text.indexOf("\"]", startIndex);
if (endIdx > 0) {
answer = text.substring(startIndex, endIdx);
if (answer.length() > 0) {
// lets expand any variables
answer = ZooKeeperUtils.getSubstitutedData(curator.get(), answer);
return answer;
}
}
}
}
return null;
}
private static boolean hasValidDataStoreProperties(Map options) {
if (!options.containsKey("dataStoreProperties")) {
return false;
}
Object props = options.get("dataStoreProperties");
if (props instanceof Map) {
return !((Map) props).isEmpty();
} else {
return false;
}
}
// FIXME public access on the impl
public void registerProvider(String scheme, ContainerProvider provider) {
assertValid();
providers.put(scheme, provider);
}
// FIXME public access on the impl
public void registerProvider(ContainerProvider provider, Map<String, Object> properties) {
assertValid();
String scheme = (String) properties.get(org.fusesource.fabric.utils.Constants.PROTOCOL);
registerProvider(scheme, provider);
}
// FIXME public access on the impl
public void unregisterProvider(String scheme) {
assertValid();
providers.remove(scheme);
}
// FIXME public access on the impl
public void unregisterProvider(ContainerProvider provider, Map<String, Object> properties) {
assertValid();
String scheme = (String) properties.get(org.fusesource.fabric.utils.Constants.PROTOCOL);
unregisterProvider(scheme);
}
@Override
public String getZookeeperUrl() {
assertValid();
return getZookeeperInfo("zookeeper.url");
}
@Override
public String getZookeeperPassword() {
assertValid();
return getZookeeperInfo("zookeeper.password");
}
// FIXME public access on the impl
public String getZookeeperInfo(String name) {
assertValid();
String zooKeeperUrl = null;
//We are looking directly for at the zookeeper for the url, since container might not even be mananaged.
//Also this is required for the integration with the IDE.
try {
if (curator.get().getZookeeperClient().isConnected()) {
Version defaultVersion = getDefaultVersion();
if (defaultVersion != null) {
Profile profile = defaultVersion.getProfile("default");
if (profile != null) {
Map<String, String> zookeeperConfig = profile.getConfiguration(Constants.ZOOKEEPER_CLIENT_PID);
if (zookeeperConfig != null) {
zooKeeperUrl = getSubstitutedData(curator.get(), zookeeperConfig.get(name));
}
}
}
}
} catch (Exception e) {
//Ignore it.
}
if (zooKeeperUrl == null) {
try {
Configuration config = configAdmin.get().getConfiguration(Constants.ZOOKEEPER_CLIENT_PID, null);
zooKeeperUrl = (String) config.getProperties().get(name);
} catch (Exception e) {
//Ignore it.
}
}
return zooKeeperUrl;
}
@Override
public Version getDefaultVersion() {
assertValid();
return new VersionImpl(getDataStore().getDefaultVersion(), this);
}
@Override
public void setDefaultVersion(Version version) {
assertValid();
setDefaultVersion(version.getId());
}
public void setDefaultVersion(String versionId) {
assertValid();
getDataStore().setDefaultVersion(versionId);
}
@Override
public Version createVersion(String version) {
assertValid();
getDataStore().createVersion(version);
return new VersionImpl(version, this);
}
@Override
public Version createVersion(Version parent, String toVersion) {
assertValid();
return createVersion(parent.getId(), toVersion);
}
// FIXME public access on the impl
public Version createVersion(String parentVersionId, String toVersion) {
assertValid();
getDataStore().createVersion(parentVersionId, toVersion);
return new VersionImpl(toVersion, this);
}
// FIXME public access on the impl
public void deleteVersion(String version) {
assertValid();
getVersion(version).delete();
}
@Override
public Version[] getVersions() {
assertValid();
List<Version> versions = new ArrayList<Version>();
List<String> children = getDataStore().getVersions();
for (String child : children) {
versions.add(new VersionImpl(child, this));
}
Collections.sort(versions);
return versions.toArray(new Version[versions.size()]);
}
@Override
public Version getVersion(String name) {
assertValid();
if (getDataStore().hasVersion(name)) {
return new VersionImpl(name, this);
}
throw new FabricException("Version '" + name + "' does not exist");
}
@Override
public Profile[] getProfiles(String version) {
assertValid();
return getVersion(version).getProfiles();
}
@Override
public Profile getProfile(String version, String name) {
assertValid();
return getVersion(version).getProfile(name);
}
@Override
public Profile createProfile(String version, String name) {
assertValid();
return getVersion(version).createProfile(name);
}
@Override
public void deleteProfile(Profile profile) {
assertValid();
deleteProfile(profile.getVersion(), profile.getId());
}
private void deleteProfile(String versionId, String profileId) {
getDataStore().deleteProfile(versionId, profileId);
}
@Override
public void setRequirements(FabricRequirements requirements) throws IOException {
assertValid();
getDataStore().setRequirements(requirements);
}
@Override
public FabricRequirements getRequirements() {
assertValid();
FabricRequirements requirements = getDataStore().getRequirements();
Version defaultVersion = getDefaultVersion();
if (defaultVersion != null) {
requirements.setVersion(defaultVersion.getId());
}
return requirements;
}
@Override
public FabricStatus getFabricStatus() {
assertValid();
return new FabricStatus(this);
}
@Override
public PatchService getPatchService() {
assertValid();
return new PatchServiceImpl(runtimeProperties.get(), this, configAdmin.get(), bundleContext);
}
@Override
public String getDefaultJvmOptions() {
assertValid();
return getDataStore().getDefaultJvmOptions();
}
@Override
public void setDefaultJvmOptions(String jvmOptions) {
assertValid();
getDataStore().setDefaultJvmOptions(jvmOptions);
}
@Override
public String getConfigurationValue(String versionId, String profileId, String pid, String key) {
assertValid();
Version v = getVersion(versionId);
if (v == null)
throw new FabricException("No version found: " + versionId);
Profile pr = v.getProfile(profileId);
if (pr == null)
throw new FabricException("No profile found: " + profileId);
Map<String, byte[]> configs = pr.getFileConfigurations();
byte[] b = configs.get(pid);
Properties p = null;
try {
if (b != null) {
p = DataStoreUtils.toProperties(b);
} else {
p = new Properties();
}
} catch (Throwable t) {
throw new FabricException(t);
}
return p.getProperty(key);
}
@Override
public void setConfigurationValue(String versionId, String profileId, String pid, String key, String value) {
assertValid();
Version v = getVersion(versionId);
if (v == null)
throw new FabricException("No version found: " + versionId);
Profile pr = v.getProfile(profileId);
if (pr == null)
throw new FabricException("No profile found: " + profileId);
Map<String, byte[]> configs = pr.getFileConfigurations();
byte[] b = configs.get(pid);
Properties p = null;
try {
if (b != null) {
p = DataStoreUtils.toProperties(b);
} else {
p = new Properties();
}
p.setProperty(key, value);
b = DataStoreUtils.toBytes(p);
configs.put(pid, b);
pr.setFileConfigurations(configs);
} catch (Throwable t) {
throw new FabricException(t);
}
}
@Override
public boolean scaleProfile(String profile, int numberOfInstances) throws IOException {
if (numberOfInstances == 0) {
throw new IllegalArgumentException("numberOfInstances should be greater or less than zero");
}
FabricRequirements requirements = getRequirements();
ProfileRequirements profileRequirements = requirements.getOrCreateProfileRequirement(profile);
Integer minimumInstances = profileRequirements.getMinimumInstances();
List<Container> containers = Containers.containersForProfile(getContainers(), profile);
int containerCount = containers.size();
int newCount = containerCount + numberOfInstances;
if (newCount < 0) {
newCount = 0;
}
boolean update = minimumInstances == null || newCount != minimumInstances;
if (update) {
profileRequirements.setMinimumInstances(newCount);
setRequirements(requirements);
}
return update;
}
@Override
public ContainerAutoScaler createContainerAutoScaler() {
Collection<ContainerProvider> providerCollection = getProviders().values();
for (ContainerProvider containerProvider : providerCollection) {
if (containerProvider instanceof ContainerAutoScalerFactory) {
ContainerAutoScalerFactory provider = (ContainerAutoScalerFactory) containerProvider;
ContainerAutoScaler answer = provider.createAutoScaler();
if (answer != null) {
return answer;
}
}
}
return null;
}
void bindConfigAdmin(ConfigurationAdmin service) {
this.configAdmin.bind(service);
}
void unbindConfigAdmin(ConfigurationAdmin service) {
this.configAdmin.unbind(service);
}
void bindRuntimeProperties(RuntimeProperties service) {
this.runtimeProperties.bind(service);
}
void unbindRuntimeProperties(RuntimeProperties service) {
this.runtimeProperties.unbind(service);
}
void bindCurator(CuratorFramework curator) {
this.curator.bind(curator);
}
void unbindCurator(CuratorFramework curator) {
this.curator.unbind(curator);
}
void bindDataStore(DataStore dataStore) {
this.dataStore.bind(dataStore);
}
void unbindDataStore(DataStore dataStore) {
this.dataStore.unbind(dataStore);
}
void bindPortService(PortService portService) {
this.portService.bind(portService);
}
void unbindPortService(PortService portService) {
this.portService.unbind(portService);
}
void bindProvider(ContainerProvider provider) {
providers.put(provider.getScheme(), provider);
}
void unbindProvider(ContainerProvider provider) {
providers.remove(provider.getScheme());
}
}
| https://github.com/jboss-fuse/fuse/issues/318 --cannot delete a child container unless it's running
| fabric/fabric-core/src/main/java/org/fusesource/fabric/service/FabricServiceImpl.java | https://github.com/jboss-fuse/fuse/issues/318 --cannot delete a child container unless it's running | <ide><path>abric/fabric-core/src/main/java/org/fusesource/fabric/service/FabricServiceImpl.java
<ide> getProvider(container);
<ide> }
<ide> if (provider != null) {
<del> provider.stop(container);
<add> if(container.isAlive()){
<add> provider.stop(container);
<add> }
<ide> provider.destroy(container);
<ide> }
<ide> try { |
|
Java | mit | 435436d5d13b91857f6016584c133f195653d228 | 0 | GluuFederation/oxAuth,GluuFederation/oxAuth,GluuFederation/oxAuth,GluuFederation/oxAuth,GluuFederation/oxAuth | /*
* oxAuth is available under the MIT License (2008). See http://opensource.org/licenses/MIT for full text.
*
* Copyright (c) 2014, Gluu
*/
package org.gluu.oxauth.model.common;
import org.gluu.oxauth.model.authorize.JwtAuthorizationRequest;
import org.gluu.oxauth.model.authorize.ScopeChecker;
import org.gluu.oxauth.model.configuration.AppConfiguration;
import org.gluu.oxauth.model.ldap.TokenLdap;
import org.gluu.oxauth.model.registration.Client;
import org.gluu.oxauth.model.util.CertUtils;
import org.gluu.oxauth.util.TokenHashUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.inject.Inject;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
/**
* @author Yuriy Zabrovarnyy
* @author Javier Rojas Blum
* @author Yuriy Movchan
* @version November 28, 2018
*/
public abstract class AbstractAuthorizationGrant implements IAuthorizationGrant {
private static final Logger log = LoggerFactory.getLogger(AbstractAuthorizationGrant.class);
@Inject
protected AppConfiguration appConfiguration;
@Inject
protected ScopeChecker scopeChecker;
private User user;
private AuthorizationGrantType authorizationGrantType;
private Client client;
private Set<String> scopes;
private String grantId;
private JwtAuthorizationRequest jwtAuthorizationRequest;
private Date authenticationTime;
private TokenLdap tokenLdap;
private AccessToken longLivedAccessToken;
private IdToken idToken;
private AuthorizationCode authorizationCode;
private String tokenBindingHash;
private String x5cs256;
private String nonce;
private String codeChallenge;
private String codeChallengeMethod;
private String claims;
private String acrValues;
private String sessionDn;
protected final ConcurrentMap<String, AccessToken> accessTokens = new ConcurrentHashMap<String, AccessToken>();
protected final ConcurrentMap<String, RefreshToken> refreshTokens = new ConcurrentHashMap<String, RefreshToken>();
public AbstractAuthorizationGrant() {
}
protected AbstractAuthorizationGrant(User user, AuthorizationGrantType authorizationGrantType, Client client,
Date authenticationTime) {
init(user, authorizationGrantType, client, authenticationTime);
}
protected void init(User user, AuthorizationGrantType authorizationGrantType, Client client,
Date authenticationTime) {
this.authenticationTime = authenticationTime != null ? new Date(authenticationTime.getTime()) : null;
this.user = user;
this.authorizationGrantType = authorizationGrantType;
this.client = client;
this.scopes = new CopyOnWriteArraySet<String>();
this.grantId = UUID.randomUUID().toString();
}
@Override
public synchronized String getGrantId() {
return grantId;
}
@Override
public synchronized void setGrantId(String p_grantId) {
grantId = p_grantId;
}
/**
* Returns the {@link AuthorizationCode}.
*
* @return The authorization code.
*/
@Override
public AuthorizationCode getAuthorizationCode() {
return authorizationCode;
}
/**
* Sets the {@link AuthorizationCode}.
*
* @param authorizationCode The authorization code.
*/
@Override
public void setAuthorizationCode(AuthorizationCode authorizationCode) {
this.authorizationCode = authorizationCode;
}
public String getTokenBindingHash() {
return tokenBindingHash;
}
public void setTokenBindingHash(String tokenBindingHash) {
this.tokenBindingHash = tokenBindingHash;
}
public String getX5cs256() {
return x5cs256;
}
public void setX5cs256(String x5cs256) {
this.x5cs256 = x5cs256;
}
@Override
public String getNonce() {
return nonce;
}
@Override
public void setNonce(String nonce) {
this.nonce = nonce;
}
public String getCodeChallenge() {
return codeChallenge;
}
public void setCodeChallenge(String codeChallenge) {
this.codeChallenge = codeChallenge;
}
public String getCodeChallengeMethod() {
return codeChallengeMethod;
}
public void setCodeChallengeMethod(String codeChallengeMethod) {
this.codeChallengeMethod = codeChallengeMethod;
}
public String getClaims() {
return claims;
}
public void setClaims(String claims) {
this.claims = claims;
}
/**
* Returns a list with all the issued refresh tokens codes.
*
* @return List with all the issued refresh tokens codes.
*/
@Override
public Set<String> getRefreshTokensCodes() {
return refreshTokens.keySet();
}
/**
* Returns a list with all the issued access tokens codes.
*
* @return List with all the issued access tokens codes.
*/
@Override
public Set<String> getAccessTokensCodes() {
return accessTokens.keySet();
}
/**
* Returns a list with all the issued access tokens.
*
* @return List with all the issued access tokens.
*/
@Override
public List<AccessToken> getAccessTokens() {
return new ArrayList<AccessToken>(accessTokens.values());
}
@Override
public void setScopes(Collection<String> scopes) {
this.scopes.clear();
this.scopes.addAll(scopes);
}
@Override
public AccessToken getLongLivedAccessToken() {
return longLivedAccessToken;
}
@Override
public void setLongLivedAccessToken(AccessToken longLivedAccessToken) {
this.longLivedAccessToken = longLivedAccessToken;
}
@Override
public IdToken getIdToken() {
return idToken;
}
@Override
public void setIdToken(IdToken idToken) {
this.idToken = idToken;
}
@Override
public TokenLdap getTokenLdap() {
return tokenLdap;
}
@Override
public void setTokenLdap(TokenLdap p_tokenLdap) {
this.tokenLdap = p_tokenLdap;
}
/**
* Returns the resource owner's.
*
* @return The resource owner's.
*/
@Override
public User getUser() {
return user;
}
public String getAcrValues() {
return acrValues;
}
public void setAcrValues(String acrValues) {
this.acrValues = acrValues;
}
public String getSessionDn() {
return sessionDn;
}
public void setSessionDn(String sessionDn) {
this.sessionDn = sessionDn;
}
/**
* Checks the scopes policy configured according to the type of the
* authorization grant to limit the issued token scopes.
*
* @param requestedScopes A space-delimited list of values in which the order of values
* does not matter.
* @return A space-delimited list of scopes
*/
@Override
public String checkScopesPolicy(String requestedScopes) {
this.scopes.clear();
Set<String> grantedScopes = scopeChecker.checkScopesPolicy(client, requestedScopes);
this.scopes.addAll(grantedScopes);
final StringBuilder grantedScopesSb = new StringBuilder();
for (String scope : scopes) {
grantedScopesSb.append(" ").append(scope);
}
final String grantedScopesSt = grantedScopesSb.toString().trim();
return grantedScopesSt;
}
@Override
public AccessToken createAccessToken(String certAsPem, ExecutionContext executionContext) {
int lifetime = appConfiguration.getAccessTokenLifetime();
// oxAuth #830 Client-specific access token expiration
if (client != null && client.getAccessTokenLifetime() != null && client.getAccessTokenLifetime() > 0) {
lifetime = client.getAccessTokenLifetime();
}
AccessToken accessToken = new AccessToken(lifetime);
accessToken.setAuthMode(getAcrValues());
accessToken.setSessionDn(getSessionDn());
accessToken.setX5ts256(CertUtils.confirmationMethodHashS256(certAsPem));
return accessToken;
}
@Override
public RefreshToken createRefreshToken() {
int lifetime = appConfiguration.getRefreshTokenLifetime();
if (client.getRefreshTokenLifetime() != null && client.getRefreshTokenLifetime() > 0) {
lifetime = client.getRefreshTokenLifetime();
}
RefreshToken refreshToken = new RefreshToken(lifetime);
refreshToken.setAuthMode(getAcrValues());
refreshToken.setSessionDn(getSessionDn());
return refreshToken;
}
@Override
public String getUserId() {
if (user == null) {
return null;
}
return user.getUserId();
}
@Override
public String getUserDn() {
if (user == null) {
return null;
}
return user.getDn();
}
/**
* Returns the {@link AuthorizationGrantType}.
*
* @return The authorization grant type.
*/
@Override
public AuthorizationGrantType getAuthorizationGrantType() {
return authorizationGrantType;
}
/**
* Returns the {@link org.gluu.oxauth.model.registration.Client}. An
* application making protected resource requests on behalf of the resource
* owner and with its authorization.
*
* @return The client.
*/
@Override
public Client getClient() {
return client;
}
@Override
public String getClientId() {
if (client == null) {
return null;
}
return client.getClientId();
}
@Override
public String getClientDn() {
if (client == null) {
return null;
}
return client.getDn();
}
@Override
public Date getAuthenticationTime() {
return authenticationTime;
}
public void setAuthenticationTime(Date authenticationTime) {
this.authenticationTime = authenticationTime;
}
/**
* Returns a list of the scopes granted to the client.
*
* @return List of the scopes granted to the client.
*/
@Override
public Set<String> getScopes() {
return scopes;
}
@Override
public JwtAuthorizationRequest getJwtAuthorizationRequest() {
return jwtAuthorizationRequest;
}
@Override
public void setJwtAuthorizationRequest(JwtAuthorizationRequest p_jwtAuthorizationRequest) {
jwtAuthorizationRequest = p_jwtAuthorizationRequest;
}
@Override
public void setAccessTokens(List<AccessToken> accessTokens) {
put(this.accessTokens, accessTokens);
}
private static <T extends AbstractToken> void put(ConcurrentMap<String, T> p_map, List<T> p_list) {
p_map.clear();
if (p_list != null && !p_list.isEmpty()) {
for (T t : p_list) {
p_map.put(t.getCode(), t);
}
}
}
/**
* Returns a list with all the issued refresh tokens.
*
* @return List with all the issued refresh tokens.
*/
@Override
public List<RefreshToken> getRefreshTokens() {
return new ArrayList<RefreshToken>(refreshTokens.values());
}
@Override
public void setRefreshTokens(List<RefreshToken> refreshTokens) {
put(this.refreshTokens, refreshTokens);
}
/**
* Gets the refresh token instance from the refresh token list given its
* code.
*
* @param refreshTokenCode The code of the refresh token.
* @return The refresh token instance or <code>null</code> if not found.
*/
@Override
public RefreshToken getRefreshToken(String refreshTokenCode) {
if (log.isTraceEnabled()) {
log.trace("Looking for the refresh token: " + refreshTokenCode + " for an authorization grant of type: "
+ getAuthorizationGrantType());
}
return refreshTokens.get(TokenHashUtil.hash(refreshTokenCode));
}
/**
* Gets the access token instance from the id token list or the access token
* list given its code.
*
* @param tokenCode The code of the access token.
* @return The access token instance or <code>null</code> if not found.
*/
@Override
public AbstractToken getAccessToken(String tokenCode) {
String hashedTokenCode = TokenHashUtil.hash(tokenCode);
final IdToken idToken = getIdToken();
if (idToken != null) {
if (idToken.getCode().equals(hashedTokenCode)) {
return idToken;
}
}
final AccessToken longLivedAccessToken = getLongLivedAccessToken();
if (longLivedAccessToken != null) {
if (longLivedAccessToken.getCode().equals(hashedTokenCode)) {
return longLivedAccessToken;
}
}
return accessTokens.get(hashedTokenCode);
}
@Override
public String toString() {
return "AbstractAuthorizationGrant{" + "user=" + user + ", authorizationCode=" + authorizationCode + ", client="
+ client + ", grantId='" + grantId + '\'' + ", nonce='" + nonce + '\'' + ", acrValues='" + acrValues
+ '\'' + ", sessionDn='" + sessionDn + '\'' + ", codeChallenge='" + codeChallenge + '\''
+ ", codeChallengeMethod='" + codeChallengeMethod + '\'' + ", authenticationTime=" + authenticationTime
+ ", scopes=" + scopes + ", authorizationGrantType=" + authorizationGrantType + ", tokenBindingHash=" + tokenBindingHash
+ ", x5cs256=" + x5cs256 + ", claims=" + claims + '}';
}
} | Server/src/main/java/org/gluu/oxauth/model/common/AbstractAuthorizationGrant.java | /*
* oxAuth is available under the MIT License (2008). See http://opensource.org/licenses/MIT for full text.
*
* Copyright (c) 2014, Gluu
*/
package org.gluu.oxauth.model.common;
import org.gluu.oxauth.model.authorize.JwtAuthorizationRequest;
import org.gluu.oxauth.model.authorize.ScopeChecker;
import org.gluu.oxauth.model.configuration.AppConfiguration;
import org.gluu.oxauth.model.ldap.TokenLdap;
import org.gluu.oxauth.model.registration.Client;
import org.gluu.oxauth.model.util.CertUtils;
import org.gluu.oxauth.util.TokenHashUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.inject.Inject;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
/**
* @author Yuriy Zabrovarnyy
* @author Javier Rojas Blum
* @author Yuriy Movchan
* @version November 28, 2018
*/
public abstract class AbstractAuthorizationGrant implements IAuthorizationGrant {
private static final Logger log = LoggerFactory.getLogger(AbstractAuthorizationGrant.class);
@Inject
protected AppConfiguration appConfiguration;
@Inject
protected ScopeChecker scopeChecker;
private User user;
private AuthorizationGrantType authorizationGrantType;
private Client client;
private Set<String> scopes;
private String grantId;
private JwtAuthorizationRequest jwtAuthorizationRequest;
private Date authenticationTime;
private TokenLdap tokenLdap;
private AccessToken longLivedAccessToken;
private IdToken idToken;
private AuthorizationCode authorizationCode;
private String tokenBindingHash;
private String x5cs256;
private String nonce;
private String codeChallenge;
private String codeChallengeMethod;
private String claims;
private String acrValues;
private String sessionDn;
protected final ConcurrentMap<String, AccessToken> accessTokens = new ConcurrentHashMap<String, AccessToken>();
protected final ConcurrentMap<String, RefreshToken> refreshTokens = new ConcurrentHashMap<String, RefreshToken>();
public AbstractAuthorizationGrant() {
}
protected AbstractAuthorizationGrant(User user, AuthorizationGrantType authorizationGrantType, Client client,
Date authenticationTime) {
init(user, authorizationGrantType, client, authenticationTime);
}
protected void init(User user, AuthorizationGrantType authorizationGrantType, Client client,
Date authenticationTime) {
this.authenticationTime = authenticationTime != null ? new Date(authenticationTime.getTime()) : null;
this.user = user;
this.authorizationGrantType = authorizationGrantType;
this.client = client;
this.scopes = new CopyOnWriteArraySet<String>();
this.grantId = UUID.randomUUID().toString();
}
@Override
public synchronized String getGrantId() {
return grantId;
}
@Override
public synchronized void setGrantId(String p_grantId) {
grantId = p_grantId;
}
/**
* Returns the {@link AuthorizationCode}.
*
* @return The authorization code.
*/
@Override
public AuthorizationCode getAuthorizationCode() {
return authorizationCode;
}
/**
* Sets the {@link AuthorizationCode}.
*
* @param authorizationCode The authorization code.
*/
@Override
public void setAuthorizationCode(AuthorizationCode authorizationCode) {
this.authorizationCode = authorizationCode;
}
public String getTokenBindingHash() {
return tokenBindingHash;
}
public void setTokenBindingHash(String tokenBindingHash) {
this.tokenBindingHash = tokenBindingHash;
}
public String getX5cs256() {
return x5cs256;
}
public void setX5cs256(String x5cs256) {
this.x5cs256 = x5cs256;
}
@Override
public String getNonce() {
return nonce;
}
@Override
public void setNonce(String nonce) {
this.nonce = nonce;
}
public String getCodeChallenge() {
return codeChallenge;
}
public void setCodeChallenge(String codeChallenge) {
this.codeChallenge = codeChallenge;
}
public String getCodeChallengeMethod() {
return codeChallengeMethod;
}
public void setCodeChallengeMethod(String codeChallengeMethod) {
this.codeChallengeMethod = codeChallengeMethod;
}
public String getClaims() {
return claims;
}
public void setClaims(String claims) {
this.claims = claims;
}
/**
* Returns a list with all the issued refresh tokens codes.
*
* @return List with all the issued refresh tokens codes.
*/
@Override
public Set<String> getRefreshTokensCodes() {
return refreshTokens.keySet();
}
/**
* Returns a list with all the issued access tokens codes.
*
* @return List with all the issued access tokens codes.
*/
@Override
public Set<String> getAccessTokensCodes() {
return accessTokens.keySet();
}
/**
* Returns a list with all the issued access tokens.
*
* @return List with all the issued access tokens.
*/
@Override
public List<AccessToken> getAccessTokens() {
return new ArrayList<AccessToken>(accessTokens.values());
}
@Override
public void setScopes(Collection<String> scopes) {
this.scopes.clear();
this.scopes.addAll(scopes);
}
@Override
public AccessToken getLongLivedAccessToken() {
return longLivedAccessToken;
}
@Override
public void setLongLivedAccessToken(AccessToken longLivedAccessToken) {
this.longLivedAccessToken = longLivedAccessToken;
}
@Override
public IdToken getIdToken() {
return idToken;
}
@Override
public void setIdToken(IdToken idToken) {
this.idToken = idToken;
}
@Override
public TokenLdap getTokenLdap() {
return tokenLdap;
}
@Override
public void setTokenLdap(TokenLdap p_tokenLdap) {
this.tokenLdap = p_tokenLdap;
}
/**
* Returns the resource owner's.
*
* @return The resource owner's.
*/
@Override
public User getUser() {
return user;
}
public String getAcrValues() {
return acrValues;
}
public void setAcrValues(String acrValues) {
this.acrValues = acrValues;
}
public String getSessionDn() {
return sessionDn;
}
public void setSessionDn(String sessionDn) {
this.sessionDn = sessionDn;
}
/**
* Checks the scopes policy configured according to the type of the
* authorization grant to limit the issued token scopes.
*
* @param requestedScopes A space-delimited list of values in which the order of values
* does not matter.
* @return A space-delimited list of scopes
*/
@Override
public String checkScopesPolicy(String requestedScopes) {
this.scopes.clear();
Set<String> grantedScopes = scopeChecker.checkScopesPolicy(client, requestedScopes);
this.scopes.addAll(grantedScopes);
final StringBuilder grantedScopesSb = new StringBuilder();
for (String scope : scopes) {
grantedScopesSb.append(" ").append(scope);
}
final String grantedScopesSt = grantedScopesSb.toString().trim();
return grantedScopesSt;
}
@Override
public AccessToken createAccessToken(String certAsPem, ExecutionContext executionContext) {
int lifetime = appConfiguration.getAccessTokenLifetime();
// oxAuth #830 Client-specific access token expiration
if (client != null && client.getAccessTokenLifetime() != null && client.getAccessTokenLifetime() > 0) {
lifetime = client.getAccessTokenLifetime();
}
AccessToken accessToken = new AccessToken(lifetime);
accessToken.setAuthMode(getAcrValues());
accessToken.setSessionDn(getSessionDn());
accessToken.setX5ts256(CertUtils.confirmationMethodHashS256(certAsPem));
return accessToken;
}
@Override
public RefreshToken createRefreshToken() {
int lifetime = appConfiguration.getRefreshTokenLifetime();
if (client.getRefreshTokenLifetime() != null && client.getRefreshTokenLifetime() > 0) {
lifetime = client.getRefreshTokenLifetime();
}
RefreshToken refreshToken = new RefreshToken(lifetime);
refreshToken.setAuthMode(getAcrValues());
refreshToken.setSessionDn(getSessionDn());
return refreshToken;
}
@Override
public String getUserId() {
if (user == null) {
return null;
}
return user.getUserId();
}
@Override
public String getUserDn() {
if (user == null) {
return null;
}
return user.getDn();
}
/**
* Returns the {@link AuthorizationGrantType}.
*
* @return The authorization grant type.
*/
@Override
public AuthorizationGrantType getAuthorizationGrantType() {
return authorizationGrantType;
}
/**
* Returns the {@link org.gluu.oxauth.model.registration.Client}. An
* application making protected resource requests on behalf of the resource
* owner and with its authorization.
*
* @return The client.
*/
@Override
public Client getClient() {
return client;
}
@Override
public String getClientId() {
if (client == null) {
return null;
}
return client.getClientId();
}
@Override
public String getClientDn() {
if (client == null) {
return null;
}
return client.getDn();
}
@Override
public Date getAuthenticationTime() {
return authenticationTime;
}
public void setAuthenticationTime(Date authenticationTime) {
this.authenticationTime = authenticationTime;
}
/**
* Returns a list of the scopes granted to the client.
*
* @return List of the scopes granted to the client.
*/
@Override
public Set<String> getScopes() {
return scopes;
}
@Override
public JwtAuthorizationRequest getJwtAuthorizationRequest() {
return jwtAuthorizationRequest;
}
@Override
public void setJwtAuthorizationRequest(JwtAuthorizationRequest p_jwtAuthorizationRequest) {
jwtAuthorizationRequest = p_jwtAuthorizationRequest;
}
@Override
public void setAccessTokens(List<AccessToken> accessTokens) {
put(this.accessTokens, accessTokens);
}
private static <T extends AbstractToken> void put(ConcurrentMap<String, T> p_map, List<T> p_list) {
p_map.clear();
if (p_list != null && !p_list.isEmpty()) {
for (T t : p_list) {
p_map.put(t.getCode(), t);
}
}
}
/**
* Returns a list with all the issued refresh tokens.
*
* @return List with all the issued refresh tokens.
*/
@Override
public List<RefreshToken> getRefreshTokens() {
return new ArrayList<RefreshToken>(refreshTokens.values());
}
@Override
public void setRefreshTokens(List<RefreshToken> refreshTokens) {
put(this.refreshTokens, refreshTokens);
}
/**
* Gets the refresh token instance from the refresh token list given its
* code.
*
* @param refreshTokenCode The code of the refresh token.
* @return The refresh token instance or <code>null</code> if not found.
*/
@Override
public RefreshToken getRefreshToken(String refreshTokenCode) {
if (log.isTraceEnabled()) {
log.trace("Looking for the refresh token: " + refreshTokenCode + " for an authorization grant of type: "
+ getAuthorizationGrantType());
}
return refreshTokens.get(refreshTokenCode);
}
/**
* Gets the access token instance from the id token list or the access token
* list given its code.
*
* @param tokenCode The code of the access token.
* @return The access token instance or <code>null</code> if not found.
*/
@Override
public AbstractToken getAccessToken(String tokenCode) {
String hashedTokenCode = TokenHashUtil.hash(tokenCode);
final IdToken idToken = getIdToken();
if (idToken != null) {
if (idToken.getCode().equals(hashedTokenCode)) {
return idToken;
}
}
final AccessToken longLivedAccessToken = getLongLivedAccessToken();
if (longLivedAccessToken != null) {
if (longLivedAccessToken.getCode().equals(hashedTokenCode)) {
return longLivedAccessToken;
}
}
return accessTokens.get(hashedTokenCode);
}
@Override
public String toString() {
return "AbstractAuthorizationGrant{" + "user=" + user + ", authorizationCode=" + authorizationCode + ", client="
+ client + ", grantId='" + grantId + '\'' + ", nonce='" + nonce + '\'' + ", acrValues='" + acrValues
+ '\'' + ", sessionDn='" + sessionDn + '\'' + ", codeChallenge='" + codeChallenge + '\''
+ ", codeChallengeMethod='" + codeChallengeMethod + '\'' + ", authenticationTime=" + authenticationTime
+ ", scopes=" + scopes + ", authorizationGrantType=" + authorizationGrantType + ", tokenBindingHash=" + tokenBindingHash
+ ", x5cs256=" + x5cs256 + ", claims=" + claims + '}';
}
} | Fixed refresh token fetching
https://github.com/GluuFederation/oxAuth/issues/1449
| Server/src/main/java/org/gluu/oxauth/model/common/AbstractAuthorizationGrant.java | Fixed refresh token fetching | <ide><path>erver/src/main/java/org/gluu/oxauth/model/common/AbstractAuthorizationGrant.java
<ide> log.trace("Looking for the refresh token: " + refreshTokenCode + " for an authorization grant of type: "
<ide> + getAuthorizationGrantType());
<ide> }
<del>
<del> return refreshTokens.get(refreshTokenCode);
<add> return refreshTokens.get(TokenHashUtil.hash(refreshTokenCode));
<ide> }
<ide>
<ide> /** |
|
Java | apache-2.0 | a394d36c80adba8f2c66ab2e563cef0b84df5582 | 0 | Talend/data-prep,Talend/data-prep,Talend/data-prep | package org.talend.dataprep.dataset;
import static com.jayway.restassured.RestAssured.given;
import static com.jayway.restassured.RestAssured.when;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.core.IsEqual.equalTo;
import static org.junit.Assert.assertThat;
import static uk.co.datumedge.hamcrest.json.SameJSONAs.sameJSONAs;
import java.io.IOException;
import java.util.Iterator;
import java.util.concurrent.TimeUnit;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.junit.*;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.IntegrationTest;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.talend.dataprep.api.dataset.DataSetMetadata;
import org.talend.dataprep.dataset.service.analysis.SynchronousDataSetAnalyzer;
import org.talend.dataprep.dataset.store.metadata.DataSetMetadataRepository;
import com.jayway.restassured.RestAssured;
/**
* This test ensures the data set service behaves as stated in <a
* href="https://jira.talendforge.org/browse/TDP-157">https://jira.talendforge.org/browse/TDP-157</a>.
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
@IntegrationTest
public class DataSetImportTest {
@Value("${local.server.port}")
public int port;
@Autowired
DataSetMetadataRepository dataSetMetadataRepository;
private String dataSetId;
@BeforeClass
public static void enter() {
// Set pause in analysis
System.setProperty("DataSetImportTest.PausedAnalyzer", "1"); //$NON-NLS-1$ //$NON-NLS-2$
}
@AfterClass
public static void leave() {
// Set pause in analysis
System.setProperty("DataSetImportTest.PausedAnalyzer", "0"); //$NON-NLS-1$ //$NON-NLS-2$
}
@Before
public void setUp() {
RestAssured.port = port;
}
@After
public void tearDown() throws Exception {
dataSetMetadataRepository.clear();
}
/**
* Test 'importing' status: the data set should remain in 'importing' state as long as create operation isn't
* completed.
*/
public void testImportStatus() throws Exception {
// Create a data set (asynchronously)
Runnable creation = () -> {
try {
dataSetId = given().body(IOUtils.toString(DataSetImportTest.class.getResourceAsStream("tagada.csv")))
.queryParam("Content-Type", "text/csv").when().post("/datasets").asString();
} catch (IOException e) {
throw new RuntimeException(e);
}
};
Thread creationThread = new Thread(creation);
creationThread.start();
// Wait for creation of data set object
while (!dataSetMetadataRepository.list().iterator().hasNext()) {
TimeUnit.MILLISECONDS.sleep(20);
}
// Data set should show as importing
final Iterable<DataSetMetadata> list = dataSetMetadataRepository.list();
final Iterator<DataSetMetadata> iterator = list.iterator();
assertThat(iterator.hasNext(), is(true));
final DataSetMetadata next = iterator.next();
assertThat(next.getLifecycle().importing(), is(true));
// Asserts when import is done
// Wait until creation is done (i.e. end of thread since creation is a blocking operation).
creationThread.join();
assertThat(dataSetId, notNullValue());
final DataSetMetadata metadata = dataSetMetadataRepository.get(dataSetId);
assertThat(metadata.getLifecycle().importing(), is(false));
assertThat(metadata.getLifecycle().schemaAnalyzed(), is(true));
// TDP-283: Quality analysis should be synchronous
assertThat(metadata.getLifecycle().qualityAnalyzed(), is(true));
}
/**
* Test 'importing' status with list operation: data set in 'importing' mode should not appear in results of the
* list operation.
*/
public void testListImported() throws Exception {
assertThat(dataSetMetadataRepository.size(), is(0));
// Create a data set (asynchronously)
Runnable creation = () -> {
try {
dataSetId = given().body(IOUtils.toString(DataSetImportTest.class.getResourceAsStream("tagada.csv")))
.queryParam("Content-Type", "text/csv").when().post("/datasets").asString();
} catch (IOException e) {
throw new RuntimeException(e);
}
};
Thread creationThread = new Thread(creation);
creationThread.start();
// Wait for creation of data set object
while (!dataSetMetadataRepository.list().iterator().hasNext()) {
TimeUnit.MILLISECONDS.sleep(20);
}
// Find data set being imported...
final Iterable<DataSetMetadata> list = dataSetMetadataRepository.list();
final Iterator<DataSetMetadata> iterator = list.iterator();
assertThat(iterator.hasNext(), is(true));
final DataSetMetadata next = iterator.next();
assertThat(next.getLifecycle().importing(), is(true));
// ... list operation should *not* return data set being imported...
when().get("/datasets").then().statusCode(HttpStatus.OK.value()).body(equalTo("[]"));
// Assert the new data set is returned when creation completes.
// Wait until creation is done (i.e. end of thread since creation is a blocking operation).
creationThread.join();
assertThat(dataSetId, notNullValue());
final DataSetMetadata metadata = dataSetMetadataRepository.get(dataSetId);
assertThat(dataSetMetadataRepository.size(), is(1));
String expected = "[{\"id\":\"" + metadata.getId() + "\"}]";
when().get("/datasets").then().statusCode(HttpStatus.OK.value())
.body(sameJSONAs(expected).allowingAnyArrayOrdering().allowingExtraUnexpectedFields());
}
/**
* Test 'importing' status with get: user is not allowed to get data set content when it's still being imported. In
* real life situation, this kind of event is rather unlikely since the UUID of the data set is only returned once
* the creation completes (no access before this).
*/
public void testCannotOpenDataSetBeingImported() throws Exception {
// Create a data set (asynchronously)
Runnable creation = () -> {
try {
dataSetId = given().body(IOUtils.toString(DataSetImportTest.class.getResourceAsStream("tagada.csv")))
.queryParam("Content-Type", "text/csv").when().post("/datasets").asString();
} catch (IOException e) {
throw new RuntimeException(e);
}
};
Thread creationThread = new Thread(creation);
creationThread.start();
// Wait for creation of data set object
while (dataSetMetadataRepository.size() == 0) {
TimeUnit.MILLISECONDS.sleep(50);
}
// Find data set being imported...
final Iterable<DataSetMetadata> list = dataSetMetadataRepository.list();
final Iterator<DataSetMetadata> iterator = list.iterator();
assertThat(iterator.hasNext(), is(true));
final DataSetMetadata next = iterator.next();
assertThat(next.getLifecycle().importing(), is(true));
// ... get operation should *not* return data set being imported but report an error ...
int statusCode = when().get("/datasets/{id}/content", next.getId()).getStatusCode();
assertThat(statusCode, is(400));
// Assert the new data set is returned when creation completes.
// Wait until creation is done (i.e. end of thread since creation is a blocking operation).
creationThread.join();
assertThat(dataSetId, notNullValue());
final DataSetMetadata metadata = dataSetMetadataRepository.get(dataSetId);
statusCode = when().get("/datasets/{id}/content", metadata.getId()).getStatusCode();
assertThat(statusCode, is(200));
}
/**
* A special (for tests) implementation of {@link SynchronousDataSetAnalyzer} that allows test code to intentionally
* slow down import process for test purposes.
*/
@Component
public static class PausedAnalyzer implements SynchronousDataSetAnalyzer {
private static final Logger LOGGER = LoggerFactory.getLogger(PausedAnalyzer.class);
@Override
public int order() {
return Integer.MAX_VALUE - 1;
}
@Override
public void analyze(String dataSetId) {
if (StringUtils.isEmpty(dataSetId)) {
throw new IllegalArgumentException("Data set id cannot be null or empty.");
}
try {
String timeToPause = System.getProperty("DataSetImportTest.PausedAnalyzer");
if (!StringUtils.isEmpty(timeToPause)) {
LOGGER.info("Pausing import (for {} second(s))...", timeToPause);
TimeUnit.SECONDS.sleep(Integer.parseInt(timeToPause));
LOGGER.info("Pause done.");
} else {
LOGGER.info("No pause.");
}
} catch (InterruptedException e) {
throw new RuntimeException("Unable to pause import.", e);
}
}
}
}
| dataprep-dataset/src/test/java/org/talend/dataprep/dataset/DataSetImportTest.java | package org.talend.dataprep.dataset;
import static com.jayway.restassured.RestAssured.given;
import static com.jayway.restassured.RestAssured.when;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.core.IsEqual.equalTo;
import static org.junit.Assert.assertThat;
import static uk.co.datumedge.hamcrest.json.SameJSONAs.sameJSONAs;
import java.io.IOException;
import java.util.Iterator;
import java.util.concurrent.TimeUnit;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.junit.*;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.IntegrationTest;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.talend.dataprep.api.dataset.DataSetMetadata;
import org.talend.dataprep.dataset.service.analysis.SynchronousDataSetAnalyzer;
import org.talend.dataprep.dataset.store.metadata.DataSetMetadataRepository;
import com.jayway.restassured.RestAssured;
/**
* This test ensures the data set service behaves as stated in <a
* href="https://jira.talendforge.org/browse/TDP-157">https://jira.talendforge.org/browse/TDP-157</a>.
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
@IntegrationTest
public class DataSetImportTest {
@Value("${local.server.port}")
public int port;
@Autowired
DataSetMetadataRepository dataSetMetadataRepository;
private String dataSetId;
@BeforeClass
public static void enter() {
// Set pause in analysis
System.setProperty("DataSetImportTest.PausedAnalyzer", "1"); //$NON-NLS-1$ //$NON-NLS-2$
}
@AfterClass
public static void leave() {
// Set pause in analysis
System.setProperty("DataSetImportTest.PausedAnalyzer", "0"); //$NON-NLS-1$ //$NON-NLS-2$
}
@Before
public void setUp() {
RestAssured.port = port;
}
@After
public void tearDown() throws Exception {
dataSetMetadataRepository.clear();
}
/**
* Test 'importing' status: the data set should remain in 'importing' state as long as create operation isn't
* completed.
*/
@Test
public void testImportStatus() throws Exception {
// Create a data set (asynchronously)
Runnable creation = () -> {
try {
dataSetId = given().body(IOUtils.toString(DataSetImportTest.class.getResourceAsStream("tagada.csv")))
.queryParam("Content-Type", "text/csv").when().post("/datasets").asString();
} catch (IOException e) {
throw new RuntimeException(e);
}
};
Thread creationThread = new Thread(creation);
creationThread.start();
// Wait for creation of data set object
while (!dataSetMetadataRepository.list().iterator().hasNext()) {
TimeUnit.MILLISECONDS.sleep(20);
}
// Data set should show as importing
final Iterable<DataSetMetadata> list = dataSetMetadataRepository.list();
final Iterator<DataSetMetadata> iterator = list.iterator();
assertThat(iterator.hasNext(), is(true));
final DataSetMetadata next = iterator.next();
assertThat(next.getLifecycle().importing(), is(true));
// Asserts when import is done
// Wait until creation is done (i.e. end of thread since creation is a blocking operation).
creationThread.join();
assertThat(dataSetId, notNullValue());
final DataSetMetadata metadata = dataSetMetadataRepository.get(dataSetId);
assertThat(metadata.getLifecycle().importing(), is(false));
assertThat(metadata.getLifecycle().schemaAnalyzed(), is(true));
// TDP-283: Quality analysis should be synchronous
assertThat(metadata.getLifecycle().qualityAnalyzed(), is(true));
}
/**
* Test 'importing' status with list operation: data set in 'importing' mode should not appear in results of the
* list operation.
*/
@Test
public void testListImported() throws Exception {
assertThat(dataSetMetadataRepository.size(), is(0));
// Create a data set (asynchronously)
Runnable creation = () -> {
try {
dataSetId = given().body(IOUtils.toString(DataSetImportTest.class.getResourceAsStream("tagada.csv")))
.queryParam("Content-Type", "text/csv").when().post("/datasets").asString();
} catch (IOException e) {
throw new RuntimeException(e);
}
};
Thread creationThread = new Thread(creation);
creationThread.start();
// Wait for creation of data set object
while (!dataSetMetadataRepository.list().iterator().hasNext()) {
TimeUnit.MILLISECONDS.sleep(20);
}
// Find data set being imported...
final Iterable<DataSetMetadata> list = dataSetMetadataRepository.list();
final Iterator<DataSetMetadata> iterator = list.iterator();
assertThat(iterator.hasNext(), is(true));
final DataSetMetadata next = iterator.next();
assertThat(next.getLifecycle().importing(), is(true));
// ... list operation should *not* return data set being imported...
when().get("/datasets").then().statusCode(HttpStatus.OK.value()).body(equalTo("[]"));
// Assert the new data set is returned when creation completes.
// Wait until creation is done (i.e. end of thread since creation is a blocking operation).
creationThread.join();
assertThat(dataSetId, notNullValue());
final DataSetMetadata metadata = dataSetMetadataRepository.get(dataSetId);
assertThat(dataSetMetadataRepository.size(), is(1));
String expected = "[{\"id\":\"" + metadata.getId() + "\"}]";
when().get("/datasets").then().statusCode(HttpStatus.OK.value())
.body(sameJSONAs(expected).allowingAnyArrayOrdering().allowingExtraUnexpectedFields());
}
/**
* Test 'importing' status with get: user is not allowed to get data set content when it's still being imported. In
* real life situation, this kind of event is rather unlikely since the UUID of the data set is only returned once
* the creation completes (no access before this).
*/
public void testCannotOpenDataSetBeingImported() throws Exception {
// Create a data set (asynchronously)
Runnable creation = () -> {
try {
dataSetId = given().body(IOUtils.toString(DataSetImportTest.class.getResourceAsStream("tagada.csv")))
.queryParam("Content-Type", "text/csv").when().post("/datasets").asString();
} catch (IOException e) {
throw new RuntimeException(e);
}
};
Thread creationThread = new Thread(creation);
creationThread.start();
// Wait for creation of data set object
while (dataSetMetadataRepository.size() == 0) {
TimeUnit.MILLISECONDS.sleep(50);
}
// Find data set being imported...
final Iterable<DataSetMetadata> list = dataSetMetadataRepository.list();
final Iterator<DataSetMetadata> iterator = list.iterator();
assertThat(iterator.hasNext(), is(true));
final DataSetMetadata next = iterator.next();
assertThat(next.getLifecycle().importing(), is(true));
// ... get operation should *not* return data set being imported but report an error ...
int statusCode = when().get("/datasets/{id}/content", next.getId()).getStatusCode();
assertThat(statusCode, is(400));
// Assert the new data set is returned when creation completes.
// Wait until creation is done (i.e. end of thread since creation is a blocking operation).
creationThread.join();
assertThat(dataSetId, notNullValue());
final DataSetMetadata metadata = dataSetMetadataRepository.get(dataSetId);
statusCode = when().get("/datasets/{id}/content", metadata.getId()).getStatusCode();
assertThat(statusCode, is(200));
}
/**
* A special (for tests) implementation of {@link SynchronousDataSetAnalyzer} that allows test code to intentionally
* slow down import process for test purposes.
*/
@Component
public static class PausedAnalyzer implements SynchronousDataSetAnalyzer {
private static final Logger LOGGER = LoggerFactory.getLogger(PausedAnalyzer.class);
@Override
public int order() {
return Integer.MAX_VALUE - 1;
}
@Override
public void analyze(String dataSetId) {
if (StringUtils.isEmpty(dataSetId)) {
throw new IllegalArgumentException("Data set id cannot be null or empty.");
}
try {
String timeToPause = System.getProperty("DataSetImportTest.PausedAnalyzer");
if (!StringUtils.isEmpty(timeToPause)) {
LOGGER.info("Pausing import (for {} second(s))...", timeToPause);
TimeUnit.SECONDS.sleep(Integer.parseInt(timeToPause));
LOGGER.info("Pause done.");
} else {
LOGGER.info("No pause.");
}
} catch (InterruptedException e) {
throw new RuntimeException("Unable to pause import.", e);
}
}
}
}
| TDP-880: temporary deactivate 2 others junit that cause build instable
| dataprep-dataset/src/test/java/org/talend/dataprep/dataset/DataSetImportTest.java | TDP-880: temporary deactivate 2 others junit that cause build instable | <ide><path>ataprep-dataset/src/test/java/org/talend/dataprep/dataset/DataSetImportTest.java
<ide> * Test 'importing' status: the data set should remain in 'importing' state as long as create operation isn't
<ide> * completed.
<ide> */
<del> @Test
<ide> public void testImportStatus() throws Exception {
<ide> // Create a data set (asynchronously)
<ide> Runnable creation = () -> {
<ide> * Test 'importing' status with list operation: data set in 'importing' mode should not appear in results of the
<ide> * list operation.
<ide> */
<del> @Test
<ide> public void testListImported() throws Exception {
<ide> assertThat(dataSetMetadataRepository.size(), is(0));
<ide> // Create a data set (asynchronously) |
|
JavaScript | agpl-3.0 | 16477bd15b610631ff0abf581294930c39265974 | 0 | xwiki-labs/cryptpad,xwiki-labs/cryptpad,xwiki-labs/cryptpad | define([
'jquery',
'/common/toolbar3.js',
'json.sortify',
'/common/common-util.js',
'/common/common-hash.js',
'/common/common-ui-elements.js',
'/common/common-interface.js',
'/common/common-constants.js',
'/common/common-feedback.js',
'/bower_components/nthen/index.js',
'/common/sframe-common.js',
'/common/common-realtime.js',
'/common/hyperscript.js',
'/common/proxy-manager.js',
'/customize/application_config.js',
'/bower_components/chainpad-listmap/chainpad-listmap.js',
'/customize/messages.js',
'css!/bower_components/bootstrap/dist/css/bootstrap.min.css',
'css!/bower_components/components-font-awesome/css/font-awesome.min.css',
'less!/drive/app-drive.less',
], function (
$,
Toolbar,
JSONSortify,
Util,
Hash,
UIElements,
UI,
Constants,
Feedback,
nThen,
SFCommon,
CommonRealtime,
h,
ProxyManager,
AppConfig,
Listmap,
Messages)
{
var APP = window.APP = {
editable: false,
mobile: function () { return $('body').width() <= 600; }, // Menu and content area are not inline-block anymore for mobiles
isMac: navigator.platform === "MacIntel",
};
var stringify = function (obj) {
return JSONSortify(obj);
};
var E_OVER_LIMIT = 'E_OVER_LIMIT';
var ROOT = "root";
var ROOT_NAME = Messages.fm_rootName;
var SEARCH = "search";
var SEARCH_NAME = Messages.fm_searchName;
var TRASH = "trash";
var TRASH_NAME = Messages.fm_trashName;
var FILES_DATA = Constants.storageKey;
var FILES_DATA_NAME = Messages.fm_filesDataName;
var TEMPLATE = "template";
var TEMPLATE_NAME = Messages.fm_templateName;
var RECENT = "recent";
var RECENT_NAME = Messages.fm_recentPadsName;
var OWNED = "owned";
var OWNED_NAME = Messages.fm_ownedPadsName;
var TAGS = "tags";
var TAGS_NAME = Messages.fm_tagsName;
var SHARED_FOLDER = 'sf';
var SHARED_FOLDER_NAME = Messages.fm_sharedFolderName;
// Icons
var faFolder = 'cptools-folder';
var faFolderOpen = 'cptools-folder-open';
var faSharedFolder = 'cptools-shared-folder';
var faSharedFolderOpen = 'cptools-shared-folder-open';
var faShared = 'fa-shhare-alt';
var faReadOnly = 'fa-eye';
var faRename = 'fa-pencil';
var faTrash = 'fa-trash';
var faDelete = 'fa-eraser';
var faProperties = 'fa-database';
var faTags = 'fa-hashtag';
var faEmpty = 'fa-trash-o';
var faRestore = 'fa-repeat';
var faShowParent = 'fa-location-arrow';
var faDownload = 'cptools-file';
var $folderIcon = $('<span>', {
"class": faFolder + " cptools cp-app-drive-icon-folder cp-app-drive-content-icon"
});
//var $folderIcon = $('<img>', {src: "/customize/images/icons/folder.svg", "class": "folder icon"});
var $folderEmptyIcon = $folderIcon.clone();
var $folderOpenedIcon = $('<span>', {"class": faFolderOpen + " cptools cp-app-drive-icon-folder"});
//var $folderOpenedIcon = $('<img>', {src: "/customize/images/icons/folderOpen.svg", "class": "folder icon"});
var $folderOpenedEmptyIcon = $folderOpenedIcon.clone();
var $sharedFolderIcon = $('<span>', {"class": faSharedFolder + " cptools cp-app-drive-icon-folder"});
var $sharedFolderOpenedIcon = $('<span>', {"class": faSharedFolderOpen + " cptools cp-app-drive-icon-folder"});
//var $upIcon = $('<span>', {"class": "fa fa-arrow-circle-up"});
var $unsortedIcon = $('<span>', {"class": "fa fa-files-o"});
var $templateIcon = $('<span>', {"class": "cptools cptools-template"});
var $recentIcon = $('<span>', {"class": "fa fa-clock-o"});
var $trashIcon = $('<span>', {"class": "fa " + faTrash});
var $trashEmptyIcon = $('<span>', {"class": "fa fa-trash-o"});
//var $collapseIcon = $('<span>', {"class": "fa fa-minus-square-o cp-app-drive-icon-expcol"});
var $expandIcon = $('<span>', {"class": "fa fa-plus-square-o cp-app-drive-icon-expcol"});
var $emptyTrashIcon = $('<button>', {"class": "fa fa-ban"});
var $listIcon = $('<button>', {"class": "fa fa-list"});
var $gridIcon = $('<button>', {"class": "fa fa-th-large"});
var $sortAscIcon = $('<span>', {"class": "fa fa-angle-up sortasc"});
var $sortDescIcon = $('<span>', {"class": "fa fa-angle-down sortdesc"});
var $closeIcon = $('<span>', {"class": "fa fa-window-close"});
//var $backupIcon = $('<span>', {"class": "fa fa-life-ring"});
var $searchIcon = $('<span>', {"class": "fa fa-search cp-app-drive-tree-search-icon"});
var $addIcon = $('<span>', {"class": "fa fa-plus"});
var $renamedIcon = $('<span>', {"class": "fa fa-flag"});
var $readonlyIcon = $('<span>', {"class": "fa " + faReadOnly});
var $ownedIcon = $('<span>', {"class": "fa fa-id-card-o"});
var $sharedIcon = $('<span>', {"class": "fa " + faShared});
var $ownerIcon = $('<span>', {"class": "fa fa-id-card"});
var $tagsIcon = $('<span>', {"class": "fa " + faTags});
var $passwordIcon = $('<span>', {"class": "fa fa-lock"});
var $expirableIcon = $('<span>', {"class": "fa fa-clock-o"});
var LS_LAST = "app-drive-lastOpened";
var LS_OPENED = "app-drive-openedFolders";
var LS_VIEWMODE = "app-drive-viewMode";
var LS_SEARCHCURSOR = "app-drive-searchCursor";
var FOLDER_CONTENT_ID = "cp-app-drive-content-folder";
var config = {};
var DEBUG = config.DEBUG = false;
var debug = config.debug = DEBUG ? function () {
console.log.apply(console, arguments);
} : function () { return; };
var logError = config.logError = function () {
console.error.apply(console, arguments);
};
var log = config.log = UI.log;
var localStore = window.cryptpadStore;
APP.store = {};
var getLastOpenedFolder = function () {
var path;
try {
path = APP.store[LS_LAST] ? JSON.parse(APP.store[LS_LAST]) : [ROOT];
} catch (e) {
path = [ROOT];
}
return path;
};
var setLastOpenedFolder = function (path) {
if (path[0] === SEARCH) { return; }
APP.store[LS_LAST] = JSON.stringify(path);
localStore.put(LS_LAST, JSON.stringify(path));
};
var wasFolderOpened = function (path) {
var stored = JSON.parse(APP.store[LS_OPENED] || '[]');
return stored.indexOf(JSON.stringify(path)) !== -1;
};
var setFolderOpened = function (path, opened) {
var s = JSON.stringify(path);
var stored = JSON.parse(APP.store[LS_OPENED] || '[]');
if (opened && stored.indexOf(s) === -1) {
stored.push(s);
}
if (!opened) {
var idx = stored.indexOf(s);
if (idx !== -1) {
stored.splice(idx, 1);
}
}
APP.store[LS_OPENED] = JSON.stringify(stored);
localStore.put(LS_OPENED, JSON.stringify(stored));
};
var getViewModeClass = function () {
var mode = APP.store[LS_VIEWMODE];
if (mode === 'list') { return 'cp-app-drive-content-list'; }
return 'cp-app-drive-content-grid';
};
var getViewMode = function () {
return APP.store[LS_VIEWMODE] || 'grid';
};
var setViewMode = function (mode) {
if (typeof(mode) !== "string") {
logError("Incorrect view mode: ", mode);
return;
}
APP.store[LS_VIEWMODE] = mode;
localStore.put(LS_VIEWMODE, mode);
};
var setSearchCursor = function () {
var $input = $('#cp-app-drive-tree-search-input');
APP.store[LS_SEARCHCURSOR] = $input[0].selectionStart;
localStore.put(LS_SEARCHCURSOR, $input[0].selectionStart);
};
var getSearchCursor = function () {
return APP.store[LS_SEARCHCURSOR] || 0;
};
var setEditable = function (state) {
APP.editable = state;
if (!state) {
APP.$content.addClass('cp-app-drive-readonly');
$('[draggable="true"]').attr('draggable', false);
}
else {
APP.$content.removeClass('cp-app-drive-readonly');
$('[draggable="false"]').attr('draggable', true);
}
};
var history = {
isHistoryMode: false,
};
var copyObjectValue = function (objRef, objToCopy) {
for (var k in objRef) { delete objRef[k]; }
$.extend(true, objRef, objToCopy);
};
var updateSharedFolders = function (sframeChan, manager, drive, folders, cb) {
if (!drive || !drive.sharedFolders) {
return void cb();
}
var oldIds = Object.keys(folders);
nThen(function (waitFor) {
Object.keys(drive.sharedFolders).forEach(function (fId) {
sframeChan.query('Q_DRIVE_GETOBJECT', {
sharedFolder: fId
}, waitFor(function (err, newObj) {
folders[fId] = folders[fId] || {};
copyObjectValue(folders[fId], newObj);
if (manager && oldIds.indexOf(fId) === -1) {
manager.addProxy(fId, folders[fId]);
}
}));
});
}).nThen(function () {
cb();
});
};
var updateObject = function (sframeChan, obj, cb) {
sframeChan.query('Q_DRIVE_GETOBJECT', null, function (err, newObj) {
copyObjectValue(obj, newObj);
if (!APP.loggedIn && APP.newSharedFolder) {
obj.drive.sharedFolders = obj.drive.sharedFolders || {};
obj.drive.sharedFolders[APP.newSharedFolder] = {};
}
cb();
});
};
var createContextMenu = function () {
var menu = h('div.cp-contextmenu.dropdown.cp-unselectable', [
h('ul.dropdown-menu', {
'role': 'menu',
'aria-labelledby': 'dropdownMenu',
'style': 'display:block;position:static;margin-bottom:5px;'
}, [
h('li', h('a.cp-app-drive-context-open.dropdown-item', {
'tabindex': '-1',
'data-icon': faFolderOpen,
}, Messages.fc_open)),
h('li', h('a.cp-app-drive-context-openro.dropdown-item', {
'tabindex': '-1',
'data-icon': faReadOnly,
}, Messages.fc_open_ro)),
h('li', h('a.cp-app-drive-context-download.dropdown-item', {
'tabindex': '-1',
'data-icon': faDownload,
}, Messages.download_mt_button)),
h('li', h('a.cp-app-drive-context-share.dropdown-item', {
'tabindex': '-1',
'data-icon': 'fa-shhare-alt',
}, Messages.shareButton)),
h('li', h('a.cp-app-drive-context-openparent.dropdown-item', {
'tabindex': '-1',
'data-icon': faShowParent,
}, Messages.fm_openParent)),
h('li', h('a.cp-app-drive-context-newfolder.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faFolder,
}, Messages.fc_newfolder)),
h('li', h('a.cp-app-drive-context-newsharedfolder.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faSharedFolder,
}, Messages.fc_newsharedfolder)),
h('li', h('a.cp-app-drive-context-hashtag.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faTags,
}, Messages.fc_hashtag)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.pad,
'data-type': 'pad'
}, Messages.button_newpad)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.code,
'data-type': 'code'
}, Messages.button_newcode)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.slide,
'data-type': 'slide'
}, Messages.button_newslide)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.poll,
'data-type': 'poll'
}, Messages.button_newpoll)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.whiteboard,
'data-type': 'whiteboard'
}, Messages.button_newwhiteboard)),
h('li', h('a.cp-app-drive-context-empty.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faEmpty,
}, Messages.fc_empty)),
h('li', h('a.cp-app-drive-context-restore.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faRestore,
}, Messages.fc_restore)),
h('li', h('a.cp-app-drive-context-rename.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faRename,
}, Messages.fc_rename)),
h('li', h('a.cp-app-drive-context-delete.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faTrash,
}, Messages.fc_delete)),
h('li', h('a.cp-app-drive-context-deleteowned.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faDelete,
}, Messages.fc_delete_owned)),
h('li', h('a.cp-app-drive-context-remove.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faDelete,
}, Messages.fc_remove)),
h('li', h('a.cp-app-drive-context-removesf.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faDelete,
}, Messages.fc_remove_sharedfolder)),
h('li', h('a.cp-app-drive-context-properties.dropdown-item', {
'tabindex': '-1',
'data-icon': faProperties,
}, Messages.fc_prop)),
])
]);
return $(menu);
};
var andThen = function (common, proxy, folders) {
var files = proxy.drive;
var metadataMgr = common.getMetadataMgr();
var sframeChan = common.getSframeChannel();
var priv = metadataMgr.getPrivateData();
var user = metadataMgr.getUserData();
var edPublic = priv.edPublic;
APP.origin = priv.origin;
config.loggedIn = APP.loggedIn;
config.sframeChan = sframeChan;
APP.hideDuplicateOwned = Util.find(priv, ['settings', 'drive', 'hideDuplicate']);
var manager = ProxyManager.createInner(files, sframeChan, edPublic, config);
Object.keys(folders).forEach(function (id) {
var f = folders[id];
manager.addProxy(id, f);
});
var $tree = APP.$tree = $("#cp-app-drive-tree");
var $content = APP.$content = $("#cp-app-drive-content");
var $appContainer = $(".cp-app-drive-container");
var $driveToolbar = $("#cp-app-drive-toolbar");
var $contextMenu = createContextMenu().appendTo($appContainer);
var $contentContextMenu = $("#cp-app-drive-context-content");
var $defaultContextMenu = $("#cp-app-drive-context-default");
var $trashTreeContextMenu = $("#cp-app-drive-context-trashtree");
var $trashContextMenu = $("#cp-app-drive-context-trash");
$tree.on('drop dragover', function (e) {
e.preventDefault();
e.stopPropagation();
});
$driveToolbar.on('drop dragover', function (e) {
e.preventDefault();
e.stopPropagation();
});
// TOOLBAR
/* add a "change username" button */
if (!APP.readOnly) {
APP.$displayName.text(user.name || Messages.anonymous);
}
// FILE MANAGER
var currentPath = APP.currentPath = getLastOpenedFolder();
if (APP.newSharedFolder) {
var newSFPaths = manager.findFile(APP.newSharedFolder);
if (newSFPaths.length) {
currentPath = newSFPaths[0];
}
}
// Categories dislayed in the menu
var displayedCategories = [ROOT, TRASH, SEARCH, RECENT];
// PCS enabled: display owned pads
if (AppConfig.displayCreationScreen) { displayedCategories.push(OWNED); }
// Templates enabled: display template category
if (AppConfig.enableTemplates) { displayedCategories.push(TEMPLATE); }
// Tags used: display Tags category
if (Object.keys(manager.getTagsList()).length) { displayedCategories.push(TAGS); }
var virtualCategories = [SEARCH, RECENT, OWNED, TAGS, SHARED_FOLDER];
if (!APP.loggedIn) {
$tree.hide();
if (APP.newSharedFolder) {
// ANON_SHARED_FOLDER
displayedCategories = [SHARED_FOLDER];
currentPath = [SHARED_FOLDER, ROOT];
} else {
displayedCategories = [FILES_DATA];
currentPath = [FILES_DATA];
if (Object.keys(files.root).length && !proxy.anonymousAlert) {
var msg = common.fixLinks($('<div>').html(Messages.fm_alert_anonymous));
UI.alert(msg);
proxy.anonymousAlert = true;
}
}
}
if (!APP.readOnly) {
setEditable(true);
}
var appStatus = {
isReady: true,
_onReady: [],
onReady: function (handler) {
if (appStatus.isReady) {
handler();
return;
}
appStatus._onReady.push(handler);
},
ready: function (state) {
appStatus.isReady = state;
if (state) {
appStatus._onReady.forEach(function (h) {
h();
});
appStatus._onReady = [];
}
}
};
var findDataHolder = function ($el) {
return $el.is('.cp-app-drive-element-row') ? $el : $el.closest('.cp-app-drive-element-row');
};
// Selection
var sel = {};
var removeSelected = function (keepObj) {
$('.cp-app-drive-element-selected').removeClass("cp-app-drive-element-selected");
var $container = $driveToolbar.find('#cp-app-drive-toolbar-contextbuttons');
if (!$container.length) { return; }
$container.html('');
if (!keepObj) {
delete sel.startSelected;
delete sel.endSelected;
delete sel.oldSelection;
}
};
sel.refresh = 200;
sel.$selectBox = $('<div>', {'class': 'cp-app-drive-content-select-box'}).appendTo($content);
var checkSelected = function () {
if (!sel.down) { return; }
var pos = sel.pos;
var l = $content[0].querySelectorAll('.cp-app-drive-element:not(.cp-app-drive-element-selected):not(.cp-app-drive-element-header)');
var p, el;
var offset = getViewMode() === "grid" ? 10 : 0;
for (var i = 0; i < l.length; i++) {
el = l[i];
p = $(el).position();
p.top += offset + $content.scrollTop();
p.left += offset;
p.bottom = p.top + $(el).outerHeight();
p.right = p.left + $(el).outerWidth();
if (p.right < pos.left || p.left > pos.right
|| p.top > pos.bottom || p.bottom < pos.top) {
$(el).removeClass('cp-app-drive-element-selected-tmp');
} else {
$(el).addClass('cp-app-drive-element-selected-tmp');
}
}
};
$content.on('mousedown', function (e) {
if (currentPath[0] === SEARCH) { return; }
if (e.which !== 1) { return; }
$content.focus();
sel.down = true;
if (!e.ctrlKey) { removeSelected(); }
var rect = e.currentTarget.getBoundingClientRect();
sel.startX = e.clientX - rect.left;
sel.startY = e.clientY - rect.top + $content.scrollTop();
sel.$selectBox.show().css({
left: sel.startX + 'px',
top: sel.startY + 'px',
width: '0px',
height: '0px'
});
APP.hideMenu(e);
if (sel.move) { return; }
sel.move = function (ev) {
var rectMove = ev.currentTarget.getBoundingClientRect(),
offX = ev.clientX - rectMove.left,
offY = ev.clientY - rectMove.top + $content.scrollTop();
var left = sel.startX,
top = sel.startY;
var width = offX - sel.startX;
if (width < 0) {
left = Math.max(0, offX);
var diffX = left-offX;
width = Math.abs(width) - diffX;
}
var height = offY - sel.startY;
if (height < 0) {
top = Math.max(0, offY);
var diffY = top-offY;
height = Math.abs(height) - diffY;
}
sel.$selectBox.css({
width: width + 'px',
left: left + 'px',
height: height + 'px',
top: top + 'px'
});
sel.pos = {
top: top,
left: left,
bottom: top + height,
right: left + width
};
var diffT = sel.update ? +new Date() - sel.update : sel.refresh;
if (diffT < sel.refresh) {
if (!sel.to) {
sel.to = window.setTimeout(function () {
sel.update = +new Date();
checkSelected();
sel.to = undefined;
}, (sel.refresh - diffT));
}
return;
}
sel.update = +new Date();
checkSelected();
};
$content.mousemove(sel.move);
});
$(window).on('mouseup', function (e) {
if (!sel.down) { return; }
if (e.which !== 1) { return; }
sel.down = false;
sel.$selectBox.hide();
$content.off('mousemove', sel.move);
delete sel.move;
$content.find('.cp-app-drive-element-selected-tmp')
.removeClass('cp-app-drive-element-selected-tmp')
.addClass('cp-app-drive-element-selected');
e.stopPropagation();
});
// Arrow keys to modify the selection
$(window).keydown(function (e) {
var $searchBar = $tree.find('#cp-app-drive-tree-search-input');
if (document.activeElement && document.activeElement.nodeName === 'INPUT') { return; }
if ($searchBar.is(':focus') && $searchBar.val()) { return; }
var $elements = $content.find('.cp-app-drive-element:not(.cp-app-drive-element-header)');
var ev = {};
if (e.ctrlKey) { ev.ctrlKey = true; }
if (e.shiftKey) { ev.shiftKey = true; }
// Enter
if (e.which === 13) {
var $allSelected = $content.find('.cp-app-drive-element.cp-app-drive-element-selected');
if ($allSelected.length === 1) {
// Open the folder or the file
$allSelected.dblclick();
return;
}
// If more than one, open only the files
var $select = $content.find('.cp-app-drive-element-file.cp-app-drive-element-selected');
$select.each(function (idx, el) {
$(el).dblclick();
});
return;
}
// Ctrl+A select all
if (e.which === 65 && (e.ctrlKey || (e.metaKey && APP.isMac))) {
$content.find('.cp-app-drive-element:not(.cp-app-drive-element-selected)')
.addClass('cp-app-drive-element-selected');
return;
}
// [Left, Up, Right, Down]
if ([37, 38, 39, 40].indexOf(e.which) === -1) { return; }
e.preventDefault();
var click = function (el) {
if (!el) { return; }
APP.onElementClick(ev, $(el));
};
var $selection = $content.find('.cp-app-drive-element.cp-app-drive-element-selected');
if ($selection.length === 0) { return void click($elements.first()[0]); }
var lastIndex = typeof sel.endSelected === "number" ? sel.endSelected :
typeof sel.startSelected === "number" ? sel.startSelected :
$elements.index($selection.last()[0]);
var length = $elements.length;
if (length === 0) { return; }
// List mode
if (getViewMode() === "list") {
if (e.which === 40) { click($elements.get(Math.min(lastIndex+1, length -1))); }
if (e.which === 38) { click($elements.get(Math.max(lastIndex-1, 0))); }
return;
}
// Icon mode
// Get the vertical and horizontal position of lastIndex
// Filter all the elements to get those in the same line/column
var pos = $($elements.get(0)).position();
var $line = $elements.filter(function (idx, el) {
return $(el).position().top === pos.top;
});
var cols = $line.length;
var lines = Math.ceil(length/cols);
var lastPos = {
l : Math.floor(lastIndex/cols),
c : lastIndex - Math.floor(lastIndex/cols)*cols
};
if (e.which === 37) {
if (lastPos.c === 0) { return; }
click($elements.get(Math.max(lastIndex-1, 0)));
return;
}
if (e.which === 38) {
if (lastPos.l === 0) { return; }
click($elements.get(Math.max(lastIndex-cols, 0)));
return;
}
if (e.which === 39) {
if (lastPos.c === cols-1) { return; }
click($elements.get(Math.min(lastIndex+1, length-1)));
return;
}
if (e.which === 40) {
if (lastPos.l === lines-1) { return; }
click($elements.get(Math.min(lastIndex+cols, length-1)));
return;
}
});
var removeInput = function (cancel) {
if (!cancel && $('.cp-app-drive-element-row > input').length === 1) {
var $input = $('.cp-app-drive-element-row > input');
manager.rename($input.data('path'), $input.val(), APP.refresh);
}
$('.cp-app-drive-element-row > input').remove();
$('.cp-app-drive-element-row > span:hidden').removeAttr('style');
};
var compareDays = function (date1, date2) {
var day1 = Date.UTC(date1.getFullYear(), date1.getMonth(), date1.getDate());
var day2 = Date.UTC(date2.getFullYear(), date2.getMonth(), date2.getDate());
var ms = Math.abs(day1-day2);
return Math.floor(ms/1000/60/60/24);
};
var getDate = function (sDate) {
if (!sDate) { return ''; }
var ret = sDate.toString();
try {
var date = new Date(sDate);
var today = new Date();
var diff = compareDays(date, today);
if (diff === 0) {
ret = date.toLocaleTimeString();
} else {
ret = date.toLocaleDateString();
}
} catch (e) {
console.error("Unable to format that string to a date with .toLocaleString", sDate, e);
}
return ret;
};
var openFile = function (el, href) {
if (!href) {
var data = manager.getFileData(el);
if (!data || (!data.href && !data.roHref)) {
return void logError("Missing data for the file", el, data);
}
href = data.href || data.roHref;
}
window.open(APP.origin + href);
};
var refresh = APP.refresh = function () {
APP.displayDirectory(currentPath);
};
var getFileNameExtension = function (name) {
var matched = /\.[^\. ]+$/.exec(name);
if (matched && matched.length) { return matched[matched.length -1]; }
return '';
};
// Replace a file/folder name by an input to change its value
var displayRenameInput = function ($element, path) {
// NOTE: setTimeout(f, 0) otherwise the "rename" button in the toolbar is not working
window.setTimeout(function () {
if (!APP.editable) { return; }
if (!path || path.length < 2) {
logError("Renaming a top level element (root, trash or filesData) is forbidden.");
return;
}
removeInput();
removeSelected();
var $name = $element.find('.cp-app-drive-element-name');
if (!$name.length) {
$name = $element.find('> .cp-app-drive-element');
}
$name.hide();
var el = manager.find(path);
var name = manager.isFile(el) ? manager.getTitle(el) : path[path.length - 1];
if (manager.isSharedFolder(el)) {
name = manager.getSharedFolderData(el).title;
}
var $input = $('<input>', {
placeholder: name,
value: name
}).data('path', path);
// Stop propagation on keydown to avoid issues with arrow keys
$input.on('keydown', function (e) { e.stopPropagation(); });
$input.on('keyup', function (e) {
e.stopPropagation();
if (e.which === 13) {
removeInput(true);
manager.rename(path, $input.val(), refresh);
return;
}
if (e.which === 27) {
removeInput(true);
}
}).on('keypress', function (e) { e.stopPropagation(); });
//$element.parent().append($input);
$name.after($input);
$input.focus();
var extension = getFileNameExtension(name);
var input = $input[0];
input.selectionStart = 0;
input.selectionEnd = name.length - extension.length;
// We don't want to open the file/folder when clicking on the input
$input.on('click dblclick', function (e) {
removeSelected();
e.stopPropagation();
});
// Remove the browser ability to drag text from the input to avoid
// triggering our drag/drop event handlers
$input.on('dragstart dragleave drag drop', function (e) {
e.preventDefault();
e.stopPropagation();
});
// Make the parent element non-draggable when selecting text in the field
// since it would remove the input
$input.on('mousedown', function (e) {
e.stopPropagation();
$input.parents('.cp-app-drive-element-row').attr("draggable", false);
});
$input.on('mouseup', function (e) {
e.stopPropagation();
$input.parents('.cp-app-drive-element-row').attr("draggable", true);
});
},0);
};
var filterContextMenu = function (type, paths) {
if (!paths || paths.length === 0) { logError('no paths'); }
$contextMenu.find('li').hide();
var show = [];
var filter;
if (type === "content") {
// Return true in filter to hide
filter = function ($el, className) {
if (className === 'newfolder') { return; }
if (className === 'newsharedfolder') {
// Hide the new shared folder menu if we're already in a shared folder
return manager.isInSharedFolder(currentPath) || APP.disableSF;
}
return AppConfig.availablePadTypes.indexOf($el.attr('data-type')) === -1;
};
} else {
// In case of multiple selection, we must hide the option if at least one element
// is not compatible
var containsFolder = false;
var hide = [];
paths.forEach(function (p) {
var path = p.path;
var $element = p.element;
if (path.length === 1) {
// Can't rename or delete root elements
hide.push('delete');
hide.push('rename');
}
if (!$element.is('.cp-app-drive-element-owned')) {
hide.push('deleteowned');
}
if ($element.is('.cp-app-drive-element-notrash')) {
// We can't delete elements in virtual categories
hide.push('delete');
} else {
// We can only open parent in virtual categories
hide.push('openparent');
}
if (!$element.is('.cp-border-color-file')) {
hide.push('download');
}
if ($element.is('.cp-app-drive-element-file')) {
// No folder in files
hide.push('newfolder');
if ($element.is('.cp-app-drive-element-readonly')) {
hide.push('open'); // Remove open 'edit' mode
} else if ($element.is('.cp-app-drive-element-noreadonly')) {
hide.push('openro'); // Remove open 'view' mode
}
} else if ($element.is('.cp-app-drive-element-sharedf')) {
if (containsFolder) {
// More than 1 folder selected: cannot create a new subfolder
hide.push('newfolder');
}
containsFolder = true;
hide.push('openro');
hide.push('hashtag');
hide.push('delete');
//hide.push('deleteowned');
} else { // it's a folder
if (containsFolder) {
// More than 1 folder selected: cannot create a new subfolder
hide.push('newfolder');
}
containsFolder = true;
hide.push('openro');
hide.push('properties');
hide.push('share');
hide.push('hashtag');
}
// If we're in the trash, hide restore and properties for non-root elements
if (type === "trash" && path && path.length > 4) {
hide.push('restore');
hide.push('properties');
}
// If we're not in the trash nor in a shared folder, hide "remove"
if (!manager.isInSharedFolder(path)
&& !$element.is('.cp-app-drive-element-sharedf')) {
hide.push('removesf');
} else if (type === "tree") {
hide.push('delete');
// Don't hide the deleteowned link if the element is a shared folder and
// it is owned
if (manager.isInSharedFolder(path) ||
!$element.is('.cp-app-drive-element-owned')) {
hide.push('deleteowned');
} else {
// This is a shared folder and it is owned
hide.push('removesf');
}
}
});
if (paths.length > 1) {
hide.push('restore');
hide.push('properties');
hide.push('rename');
hide.push('openparent');
hide.push('hashtag');
hide.push('download');
}
if (containsFolder && paths.length > 1) {
// Cannot open multiple folders
hide.push('open');
}
filter = function ($el, className) {
if (hide.indexOf(className) !== -1) { return true; }
};
}
switch(type) {
case 'content':
show = ['newfolder', 'newsharedfolder', 'newdoc'];
break;
case 'tree':
show = ['open', 'openro', 'download', 'share', 'rename', 'delete', 'deleteowned', 'removesf',
'newfolder', 'properties', 'hashtag'];
break;
case 'default':
show = ['open', 'openro', 'share', 'openparent', 'delete', 'deleteowned', 'properties', 'hashtag'];
break;
case 'trashtree': {
show = ['empty'];
break;
}
case 'trash': {
show = ['remove', 'restore', 'properties'];
}
}
var filtered = [];
show.forEach(function (className) {
var $el = $contextMenu.find('.cp-app-drive-context-' + className);
if (!APP.editable && $el.is('.cp-app-drive-context-editable')) { return; }
if (filter($el, className)) { return; }
$el.parent('li').show();
filtered.push('.cp-app-drive-context-' + className);
});
return filtered;
};
var getSelectedPaths = function ($element) {
var paths = [];
if ($('.cp-app-drive-element-selected').length > 1) {
var $selected = $('.cp-app-drive-element-selected');
$selected.each(function (idx, elmt) {
var ePath = $(elmt).data('path');
if (ePath) {
paths.push({
path: ePath,
element: $(elmt)
});
}
});
}
if (!paths.length) {
var path = $element.data('path');
if (!path) { return false; }
paths.push({
path: path,
element: $element
});
}
return paths;
};
var updateContextButton = function () {
if (manager.isPathIn(currentPath, [TRASH])) {
$driveToolbar.find('cp-app-drive-toolbar-emptytrash').show();
} else {
$driveToolbar.find('cp-app-drive-toolbar-emptytrash').hide();
}
var $li = $content.find('.cp-app-drive-element-selected');
if ($li.length === 0) {
$li = findDataHolder($tree.find('.cp-app-drive-element-active'));
}
var $button = $driveToolbar.find('#cp-app-drive-toolbar-context-mobile');
if ($button.length) { // mobile
if ($li.length !== 1
|| !$._data($li[0], 'events').contextmenu
|| $._data($li[0], 'events').contextmenu.length === 0) {
$button.hide();
return;
}
$button.show();
$button.css({
background: '#000'
});
window.setTimeout(function () {
$button.css({
background: ''
});
}, 500);
return;
}
// Non mobile
var $container = $driveToolbar.find('#cp-app-drive-toolbar-contextbuttons');
if (!$container.length) { return; }
$container.html('');
var $element = $li.length === 1 ? $li : $($li[0]);
var paths = getSelectedPaths($element);
var menuType = $element.data('context');
if (!menuType) { return; }
//var actions = [];
var toShow = filterContextMenu(menuType, paths);
var $actions = $contextMenu.find('a');
$contextMenu.data('paths', paths);
$actions = $actions.filter(function (i, el) {
return toShow.some(function (className) { return $(el).is(className); });
});
$actions.each(function (i, el) {
var $a = $('<button>', {'class': 'cp-app-drive-element'});
if ($(el).attr('data-icon')) {
var font = $(el).attr('data-icon').indexOf('cptools') === 0 ? 'cptools' : 'fa';
$a.addClass(font).addClass($(el).attr('data-icon'));
$a.attr('title', $(el).text());
} else {
$a.text($(el).text());
}
$container.append($a);
$a.click(function() { $(el).click(); });
});
};
var scrollTo = function ($element) {
// Current scroll position
var st = $content.scrollTop();
// Block height
var h = $content.height();
// Current top position of the element relative to the scroll position
var pos = Math.round($element.offset().top - $content.position().top);
// Element height
var eh = $element.outerHeight();
// New scroll value
var v = st + pos + eh - h;
// If the element is completely visile, don't change the scroll position
if (pos+eh <= h && pos >= 0) { return; }
$content.scrollTop(v);
};
// Add the "selected" class to the "li" corresponding to the clicked element
var onElementClick = APP.onElementClick = function (e, $element) {
// If "Ctrl" is pressed, do not remove the current selection
removeInput();
$element = findDataHolder($element);
// If we're selecting a new element with the left click, hide the menu
if (e) { APP.hideMenu(); }
// Remove the selection if we don't hold ctrl key or if we are right-clicking
if (!e || !e.ctrlKey) {
removeSelected(e && e.shiftKey);
}
if (!$element.length) {
log(Messages.fm_selectError);
return;
}
scrollTo($element);
// Add the selected class to the clicked / right-clicked element
// Remove the class if it already has it
// If ctrlKey, add to the selection
// If shiftKey, select a range of elements
var $elements = $content.find('.cp-app-drive-element:not(.cp-app-drive-element-header)');
var $selection = $elements.filter('.cp-app-drive-element-selected');
if (typeof sel.startSelected !== "number" || !e || (e.ctrlKey && !e.shiftKey)) {
sel.startSelected = $elements.index($element[0]);
sel.oldSelection = [];
$selection.each(function (idx, el) {
sel.oldSelection.push(el);
});
delete sel.endSelected;
}
if (e && e.shiftKey) {
var end = $elements.index($element[0]);
sel.endSelected = end;
var $el;
removeSelected(true);
sel.oldSelection.forEach(function (el) {
if (!$(el).hasClass("cp-app-drive-element-selected")) {
$(el).addClass("cp-app-drive-element-selected");
}
});
for (var i = Math.min(sel.startSelected, sel.endSelected);
i <= Math.max(sel.startSelected, sel.endSelected);
i++) {
$el = $($elements.get(i));
if (!$el.hasClass("cp-app-drive-element-selected")) {
$el.addClass("cp-app-drive-element-selected");
}
}
} else {
if (!$element.hasClass("cp-app-drive-element-selected")) {
$element.addClass("cp-app-drive-element-selected");
} else {
$element.removeClass("cp-app-drive-element-selected");
}
}
updateContextButton();
};
var displayMenu = function (e) {
var $menu = $contextMenu;
$menu.css({ display: "block" });
if (APP.mobile()) { return; }
var h = $menu.outerHeight();
var w = $menu.outerWidth();
var wH = window.innerHeight;
var wW = window.innerWidth;
if (h > wH) {
$menu.css({
top: '0px',
bottom: ''
});
} else if (e.pageY + h <= wH) {
$menu.css({
top: e.pageY+'px',
bottom: ''
});
} else {
$menu.css({
bottom: '0px',
top: ''
});
}
if(w > wW) {
$menu.css({
left: '0px',
right: ''
});
} else if (e.pageX + w <= wW) {
$menu.css({
left: e.pageX+'px',
right: ''
});
} else {
$menu.css({
left: '',
right: '0px',
});
}
};
// Open the selected context menu on the closest "li" element
var openContextMenu = function (type) {
return function (e) {
APP.hideMenu();
e.stopPropagation();
var paths;
if (type === 'content') {
paths = [{path: $(e.target).closest('#' + FOLDER_CONTENT_ID).data('path')}];
if (!paths) { return; }
removeSelected();
} else {
var $element = findDataHolder($(e.target));
if (type === 'trash' && !$element.data('path')) { return; }
if (!$element.length) {
logError("Unable to locate the .element tag", e.target);
log(Messages.fm_contextMenuError);
return false;
}
if (!$element.hasClass('cp-app-drive-element-selected')) {
onElementClick(undefined, $element);
}
paths = getSelectedPaths($element);
}
$contextMenu.attr('data-menu-type', type);
filterContextMenu(type, paths);
displayMenu(e);
if ($contextMenu.find('li:visible').length === 0) {
debug("No visible element in the context menu. Abort.");
$contextMenu.hide();
return true;
}
$contextMenu.data('paths', paths);
return false;
};
};
var getElementName = function (path) {
var file = manager.find(path);
if (!file) { return; }
if (manager.isSharedFolder(file)) {
return manager.getSharedFolderData(file).title;
}
return manager.getTitle(file);
};
// moveElements is able to move several paths to a new location
var moveElements = function (paths, newPath, copy, cb) {
if (!APP.editable) { return; }
// Cancel drag&drop from TRASH to TRASH
if (manager.isPathIn(newPath, [TRASH]) && paths.length && paths[0][0] === TRASH) {
return;
}
manager.move(paths, newPath, cb, copy);
};
// Delete paths from the drive and/or shared folders (without moving them to the trash)
var deletePaths = function (paths, pathsList) {
pathsList = pathsList || [];
if (paths) {
paths.forEach(function (p) { pathsList.push(p.path); });
}
var hasOwned = pathsList.some(function (p) {
// NOTE: Owned pads in shared folders won't be removed from the server
// so we don't have to check, we can use the default message
if (manager.isInSharedFolder(p)) { return false; }
var el = manager.find(p);
var data = manager.isSharedFolder(el) ? manager.getSharedFolderData(el)
: manager.getFileData(el);
return data.owners && data.owners.indexOf(edPublic) !== -1;
});
var msg = Messages._getKey("fm_removeSeveralPermanentlyDialog", [pathsList.length]);
if (pathsList.length === 1) {
msg = hasOwned ? Messages.fm_deleteOwnedPad : Messages.fm_removePermanentlyDialog;
} else if (hasOwned) {
msg = msg + '<br><em>' + Messages.fm_removePermanentlyNote + '</em>';
}
UI.confirm(msg, function(res) {
$(window).focus();
if (!res) { return; }
manager.delete(pathsList, refresh);
}, null, true);
};
// Drag & drop:
// The data transferred is a stringified JSON containing the path of the dragged element
var onDrag = function (ev, path) {
var paths = [];
var $element = findDataHolder($(ev.target));
if ($element.hasClass('cp-app-drive-element-selected')) {
var $selected = $('.cp-app-drive-element-selected');
$selected.each(function (idx, elmt) {
var ePath = $(elmt).data('path');
if (ePath) {
var val = manager.find(ePath);
if (!val) { return; } // Error? A ".selected" element is not in the object
paths.push({
path: ePath,
value: {
name: getElementName(ePath),
el: val
}
});
}
});
} else {
removeSelected();
$element.addClass('cp-app-drive-element-selected');
var val = manager.find(path);
if (!val) { return; } // The element is not in the object
paths = [{
path: path,
value: {
name: getElementName(path),
el: val
}
}];
}
var data = {
'path': paths
};
ev.dataTransfer.setData("text", stringify(data));
};
var findDropPath = function (target) {
var $target = $(target);
var $el = findDataHolder($target);
var newPath = $el.data('path');
var dropEl = newPath && manager.find(newPath);
if (newPath && manager.isSharedFolder(dropEl)) {
newPath.push(manager.user.userObject.ROOT);
} else if ((!newPath || manager.isFile(dropEl))
&& $target.parents('#cp-app-drive-content')) {
newPath = currentPath;
}
return newPath;
};
var onFileDrop = APP.onFileDrop = function (file, e) {
var ev = {
target: e.target,
path: findDropPath(e.target)
};
APP.FM.onFileDrop(file, ev);
};
var onDrop = function (ev) {
ev.preventDefault();
$('.cp-app-drive-element-droppable').removeClass('cp-app-drive-element-droppable');
var data = ev.dataTransfer.getData("text");
// Don't use the normal drop handler for file upload
var fileDrop = ev.dataTransfer.files;
if (fileDrop.length) { return void onFileDrop(fileDrop, ev); }
var oldPaths = JSON.parse(data).path;
if (!oldPaths) { return; }
// A moved element should be removed from its previous location
var movedPaths = [];
var sharedF = false;
oldPaths.forEach(function (p) {
movedPaths.push(p.path);
if (!sharedF && manager.isInSharedFolder(p.path)) {
sharedF = true;
}
});
var newPath = findDropPath(ev.target);
if (!newPath) { return; }
if (sharedF && manager.isPathIn(newPath, [TRASH])) {
return void deletePaths(null, movedPaths);
}
var copy = false;
if (manager.isPathIn(newPath, [TRASH])) {
// Filter the selection to remove shared folders.
// Shared folders can't be moved to the trash!
var filteredPaths = movedPaths.filter(function (p) {
var el = manager.find(p);
return !manager.isSharedFolder(el);
});
if (!filteredPaths.length) {
// We only have shared folder, delete them
return void deletePaths(null, movedPaths);
}
movedPaths = filteredPaths;
} else if (ev.ctrlKey || (ev.metaKey && APP.isMac)) {
copy = true;
}
if (movedPaths && movedPaths.length) {
moveElements(movedPaths, newPath, copy, refresh);
}
};
var addDragAndDropHandlers = function ($element, path, isFolder, droppable) {
if (!APP.editable) { return; }
// "dragenter" is fired for an element and all its children
// "dragleave" may be fired when entering a child
// --> we use pointer-events: none in CSS, but we still need a counter to avoid some issues
// --> We store the number of enter/leave and the element entered and we remove the
// highlighting only when we have left everything
var counter = 0;
$element.on('dragstart', function (e) {
e.stopPropagation();
counter = 0;
onDrag(e.originalEvent, path);
});
$element.on('mousedown', function (e) {
e.stopPropagation();
});
// Add drop handlers if we are not in the trash and if the element is a folder
if (!droppable || !isFolder) { return; }
$element.on('dragover', function (e) {
e.preventDefault();
});
$element.on('drop', function (e) {
e.preventDefault();
e.stopPropagation();
onDrop(e.originalEvent);
});
$element.on('dragenter', function (e) {
e.preventDefault();
e.stopPropagation();
counter++;
$element.addClass('cp-app-drive-element-droppable');
});
$element.on('dragleave', function (e) {
e.preventDefault();
e.stopPropagation();
counter--;
if (counter <= 0) {
counter = 0;
$element.removeClass('cp-app-drive-element-droppable');
}
});
};
addDragAndDropHandlers($content, null, true, true);
// In list mode, display metadata from the filesData object
var _addOwnership = function ($span, $state, data) {
if (data.owners && data.owners.indexOf(edPublic) !== -1) {
var $owned = $ownedIcon.clone().appendTo($state);
$owned.attr('title', Messages.fm_padIsOwned);
$span.addClass('cp-app-drive-element-owned');
} else if (data.owners && data.owners.length) {
var $owner = $ownerIcon.clone().appendTo($state);
$owner.attr('title', Messages.fm_padIsOwnedOther);
}
};
var addFileData = function (element, $span) {
if (!manager.isFile(element)) { return; }
var data = manager.getFileData(element);
var href = data.href || data.roHref;
if (!data) { return void logError("No data for the file", element); }
var hrefData = Hash.parsePadUrl(href);
if (hrefData.type) {
$span.addClass('cp-border-color-'+hrefData.type);
}
var $state = $('<span>', {'class': 'cp-app-drive-element-state'});
if (hrefData.hashData && hrefData.hashData.mode === 'view') {
var $ro = $readonlyIcon.clone().appendTo($state);
$ro.attr('title', Messages.readonly);
}
if (data.filename && data.filename !== data.title) {
var $renamed = $renamedIcon.clone().appendTo($state);
$renamed.attr('title', Messages._getKey('fm_renamedPad', [data.title]));
}
if (hrefData.hashData && hrefData.hashData.password) {
var $password = $passwordIcon.clone().appendTo($state);
$password.attr('title', Messages.fm_passwordProtected || '');
}
if (data.expire) {
var $expire = $expirableIcon.clone().appendTo($state);
$expire.attr('title', Messages._getKey('fm_expirablePad', [new Date(data.expire).toLocaleString()]));
}
_addOwnership($span, $state, data);
var name = manager.getTitle(element);
// The element with the class '.name' is underlined when the 'li' is hovered
var $name = $('<span>', {'class': 'cp-app-drive-element-name'}).text(name);
$span.append($name);
$span.append($state);
$span.attr('title', name);
var type = Messages.type[hrefData.type] || hrefData.type;
common.displayThumbnail(href || data.roHref, data.channel, data.password, $span, function ($thumb) {
// Called only if the thumbnail exists
// Remove the .hide() added by displayThumnail() because it hides the icon in
// list mode too
$span.find('.cp-icon').removeAttr('style').addClass('cp-app-drive-element-list');
$thumb.addClass('cp-app-drive-element-grid')
.addClass('cp-app-drive-element-thumbnail');
});
var $type = $('<span>', {
'class': 'cp-app-drive-element-type cp-app-drive-element-list'
}).text(type);
var $adate = $('<span>', {
'class': 'cp-app-drive-element-atime cp-app-drive-element-list'
}).text(getDate(data.atime));
var $cdate = $('<span>', {
'class': 'cp-app-drive-element-ctime cp-app-drive-element-list'
}).text(getDate(data.ctime));
$span.append($type).append($adate).append($cdate);
};
var addFolderData = function (element, key, $span) {
if (!element || !manager.isFolder(element)) { return; }
// The element with the class '.name' is underlined when the 'li' is hovered
var $state = $('<span>', {'class': 'cp-app-drive-element-state'});
if (manager.isSharedFolder(element)) {
var data = manager.getSharedFolderData(element);
key = data && data.title ? data.title : key;
element = manager.folders[element].proxy[manager.user.userObject.ROOT];
$span.addClass('cp-app-drive-element-sharedf');
_addOwnership($span, $state, data);
var $shared = $sharedIcon.clone().appendTo($state);
$shared.attr('title', Messages.fm_canBeShared);
}
var sf = manager.hasSubfolder(element);
var files = manager.hasFile(element);
var $name = $('<span>', {'class': 'cp-app-drive-element-name'}).text(key);
var $subfolders = $('<span>', {
'class': 'cp-app-drive-element-folders cp-app-drive-element-list'
}).text(sf);
var $files = $('<span>', {
'class': 'cp-app-drive-element-files cp-app-drive-element-list'
}).text(files);
$span.attr('title', key);
$span.append($name).append($state).append($subfolders).append($files);
};
// This is duplicated in cryptpad-common, it should be unified
var getFileIcon = function (id) {
var data = manager.getFileData(id);
return UI.getFileIcon(data);
};
var getIcon = UI.getIcon;
// Create the "li" element corresponding to the file/folder located in "path"
var createElement = function (path, elPath, root, isFolder) {
// Forbid drag&drop inside the trash
var isTrash = path[0] === TRASH;
var newPath = path.slice();
var key;
var element;
if (isTrash && Array.isArray(elPath)) {
key = elPath[0];
elPath.forEach(function (k) { newPath.push(k); });
element = manager.find(newPath);
} else {
key = elPath;
newPath.push(key);
element = root[key];
}
var isSharedFolder = manager.isSharedFolder(element);
var $icon = !isFolder ? getFileIcon(element) : undefined;
var ro = manager.isReadOnlyFile(element);
// ro undefined means it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ?' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var liClass = 'cp-app-drive-element-file cp-app-drive-element' + roClass;
if (isSharedFolder) {
liClass = 'cp-app-drive-element-folder cp-app-drive-element';
$icon = $sharedFolderIcon.clone();
} else if (isFolder) {
liClass = 'cp-app-drive-element-folder cp-app-drive-element';
$icon = manager.isFolderEmpty(root[key]) ? $folderEmptyIcon.clone() : $folderIcon.clone();
}
var $element = $('<li>', {
draggable: true,
'class': 'cp-app-drive-element-row'
});
if (!isFolder && Array.isArray(APP.selectedFiles)) {
var idx = APP.selectedFiles.indexOf(element);
if (idx !== -1) {
$element.addClass('cp-app-drive-element-selected');
APP.selectedFiles.splice(idx, 1);
}
}
$element.prepend($icon).dblclick(function () {
if (isFolder) {
APP.displayDirectory(newPath);
return;
}
if (isTrash) { return; }
openFile(root[key]);
});
if (isFolder) {
addFolderData(element, key, $element);
} else {
addFileData(element, $element);
}
$element.addClass(liClass);
$element.data('path', newPath);
addDragAndDropHandlers($element, newPath, isFolder, !isTrash);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element, newPath);
});
if (!isTrash) {
$element.contextmenu(openContextMenu('tree'));
$element.data('context', 'tree');
} else {
$element.contextmenu(openContextMenu('trash'));
$element.data('context', 'trash');
}
var isNewFolder = APP.newFolder && manager.comparePath(newPath, APP.newFolder);
if (isNewFolder) {
appStatus.onReady(function () {
window.setTimeout(function () { displayRenameInput($element, newPath); }, 0);
});
delete APP.newFolder;
}
return $element;
};
// Display the full path in the title when displaying a directory from the trash
/*
var getTrashTitle = function (path) {
if (!path[0] || path[0] !== TRASH) { return; }
var title = TRASH_NAME;
for (var i=1; i<path.length; i++) {
if (i === 3 && path[i] === 'element') {}
else if (i === 2 && parseInt(path[i]) === path[i]) {
if (path[i] !== 0) {
title += " [" + path[i] + "]";
}
} else {
title += " / " + path[i];
}
}
return title;
}; */
var getPrettyName = function (name) {
var pName;
switch (name) {
case ROOT: pName = ROOT_NAME; break;
case TRASH: pName = TRASH_NAME; break;
case TEMPLATE: pName = TEMPLATE_NAME; break;
case FILES_DATA: pName = FILES_DATA_NAME; break;
case SEARCH: pName = SEARCH_NAME; break;
case RECENT: pName = RECENT_NAME; break;
case OWNED: pName = OWNED_NAME; break;
case TAGS: pName = TAGS_NAME; break;
case SHARED_FOLDER: pName = SHARED_FOLDER_NAME; break;
default: pName = name;
}
return pName;
};
var drivePathOverflowing = function () {
var $container = $(".cp-app-drive-path");
if ($container.length) {
$container.css("overflow", "hidden");
var overflown = $container[0].scrollWidth > $container[0].clientWidth;
$container.css("overflow", "");
return overflown;
}
};
var collapseDrivePath = function () {
var $container = $(".cp-app-drive-path-inner");
var $spanCollapse = $(".cp-app-drive-path-collapse");
$spanCollapse.css("display", "none");
var $pathElements = $container.find(".cp-app-drive-path-element");
$pathElements.not($spanCollapse).css("display", "");
if (currentPath.length > 1 && drivePathOverflowing()) {
var collapseLevel = 0;
var removeOverflowElement = function () {
if (drivePathOverflowing()) {
if ($pathElements.length <= 3) {
return false;
}
collapseLevel++;
if ($($pathElements.get(-2)).is(".cp-app-drive-path-separator")) {
$($pathElements.get(-2)).css("display", "none");
$pathElements = $pathElements.not($pathElements.get(-2));
}
$($pathElements.get(-2)).css("display", "none");
$pathElements = $pathElements.not($pathElements.get(-2));
return true;
}
};
currentPath.every(removeOverflowElement);
$spanCollapse.css("display", "");
removeOverflowElement();
var tipPath = currentPath.slice(0, collapseLevel);
tipPath[0] = getPrettyName(tipPath[0]);
$spanCollapse.attr("title", tipPath.join(" / "));
$spanCollapse[0].onclick = function () {
APP.displayDirectory(getLastOpenedFolder().slice(0, collapseLevel));
};
}
};
window.addEventListener("resize", collapseDrivePath);
var treeResizeObserver = new MutationObserver(collapseDrivePath);
treeResizeObserver.observe($("#cp-app-drive-tree")[0], {"attributes": true});
var toolbarButtonAdditionObserver = new MutationObserver(collapseDrivePath);
$(function () { toolbarButtonAdditionObserver.observe($("#cp-app-drive-toolbar")[0], {"childList": true, "subtree": true}); });
// Create the title block with the "parent folder" button
var createTitle = function ($container, path, noStyle) {
if (!path || path.length === 0) { return; }
var isTrash = manager.isPathIn(path, [TRASH]);
if (APP.mobile() && !noStyle) { // noStyle means title in search result
return $container;
}
var isVirtual = virtualCategories.indexOf(path[0]) !== -1;
var el = isVirtual ? undefined : manager.find(path);
path = path[0] === SEARCH ? path.slice(0,1) : path;
var $inner = $('<div>', {'class': 'cp-app-drive-path-inner'});
$container.prepend($inner);
var skipNext = false; // When encountering a shared folder, skip a key in the path
path.forEach(function (p, idx) {
if (skipNext) { skipNext = false; return; }
if (isTrash && [2,3].indexOf(idx) !== -1) { return; }
var name = p;
var currentEl = isVirtual ? undefined : manager.find(path.slice(0, idx+1));
if (p === SHARED_FOLDER || (currentEl && manager.isSharedFolder(currentEl))) {
name = manager.getSharedFolderData(currentEl || APP.newSharedFolder).title;
skipNext = true;
}
var $span = $('<span>', {'class': 'cp-app-drive-path-element'});
if (idx < path.length - 1) {
if (!noStyle) {
$span.addClass('cp-app-drive-path-clickable');
$span.click(function () {
var sliceEnd = idx + 1;
if (isTrash && idx === 1) { sliceEnd = 4; } // Make sure we don't show the index or 'element' and 'path'
APP.displayDirectory(path.slice(0, sliceEnd));
});
}
} else if (idx > 0 && manager.isFile(el)) {
name = getElementName(path);
}
if (idx === 0) { name = p === SHARED_FOLDER ? name : getPrettyName(p); }
else {
var $span2 = $('<span>', {
'class': 'cp-app-drive-path-element cp-app-drive-path-separator'
}).text(' / ');
$inner.prepend($span2);
}
$span.text(name).prependTo($inner);
});
var $spanCollapse = $('<span>', {
'class': 'cp-app-drive-path-element cp-app-drive-path-collapse'
}).text(' ... ');
$inner.append($spanCollapse);
collapseDrivePath();
};
var createInfoBox = function (path) {
var $box = $('<div>', {'class': 'cp-app-drive-content-info-box'});
var msg;
switch (path[0]) {
case ROOT:
msg = Messages.fm_info_root;
break;
case TEMPLATE:
msg = Messages.fm_info_template;
break;
case TRASH:
msg = Messages.fm_info_trash;
break;
case FILES_DATA:
msg = Messages.fm_info_allFiles;
break;
case RECENT:
msg = Messages.fm_info_recent;
break;
case OWNED:
msg = Messages.fm_info_owned;
break;
case TAGS:
break;
default:
msg = undefined;
}
if (!APP.loggedIn) {
msg = APP.newSharedFolder ? Messages.fm_info_sharedFolder : Messages.fm_info_anonymous;
return $(common.fixLinks($box.html(msg)));
}
if (!msg || APP.store['hide-info-' + path[0]] === '1') {
$box.hide();
} else {
$box.text(msg);
var $close = $closeIcon.clone().css({
'cursor': 'pointer',
'margin-left': '10px',
title: Messages.fm_closeInfoBox
}).on('click', function () {
$box.hide();
APP.store['hide-info-' + path[0]] = '1';
localStore.put('hide-info-' + path[0], '1');
});
$box.prepend($close);
}
return $box;
};
// Create the button allowing the user to switch from list to icons modes
var createViewModeButton = function ($container) {
var $listButton = $listIcon.clone();
var $gridButton = $gridIcon.clone();
$listButton.click(function () {
$gridButton.removeClass('cp-app-drive-toolbar-active');
$listButton.addClass('cp-app-drive-toolbar-active');
setViewMode('list');
$('#' + FOLDER_CONTENT_ID).removeClass('cp-app-drive-content-grid');
$('#' + FOLDER_CONTENT_ID).addClass('cp-app-drive-content-list');
Feedback.send('DRIVE_LIST_MODE');
});
$gridButton.click(function () {
$listButton.removeClass('cp-app-drive-toolbar-active');
$gridButton.addClass('cp-app-drive-toolbar-active');
setViewMode('grid');
$('#' + FOLDER_CONTENT_ID).addClass('cp-app-drive-content-grid');
$('#' + FOLDER_CONTENT_ID).removeClass('cp-app-drive-content-list');
Feedback.send('DRIVE_GRID_MODE');
});
if (getViewMode() === 'list') {
$listButton.addClass('cp-app-drive-toolbar-active');
} else {
$gridButton.addClass('cp-app-drive-toolbar-active');
}
$listButton.attr('title', Messages.fm_viewListButton);
$gridButton.attr('title', Messages.fm_viewGridButton);
$container.append($listButton).append($gridButton);
};
var createEmptyTrashButton = function ($container) {
var $button = $emptyTrashIcon.clone();
$button.addClass('cp-app-drive-toolbar-emptytrash');
$button.attr('title', Messages.fc_empty);
$button.click(function () {
UI.confirm(Messages.fm_emptyTrashDialog, function(res) {
if (!res) { return; }
manager.emptyTrash(refresh);
});
});
$container.append($button);
};
// Get the upload options
var addSharedFolderModal = function (cb) {
var createHelper = function (href, text) {
var q = h('a.fa.fa-question-circle', {
style: 'text-decoration: none !important;',
title: text,
href: APP.origin + href,
target: "_blank",
'data-tippy-placement': "right"
});
return q;
};
// Ask for name, password and owner
var content = h('div', [
h('h4', Messages.sharedFolders_create),
h('label', {for: 'cp-app-drive-sf-name'}, Messages.sharedFolders_create_name),
h('input#cp-app-drive-sf-name', {type: 'text', placeholder: Messages.fm_newFolder}),
h('label', {for: 'cp-app-drive-sf-password'}, Messages.sharedFolders_create_password),
UI.passwordInput({id: 'cp-app-drive-sf-password'}),
h('span', {
style: 'display:flex;align-items:center;justify-content:space-between'
}, [
UI.createCheckbox('cp-app-drive-sf-owned', Messages.sharedFolders_create_owned, true),
createHelper('/faq.html#keywords-owned', Messages.creation_owned1) // TODO
]),
]);
$(content).find('#cp-app-drive-sf-name').keydown(function (e) {
if (e.which === 13) {
UI.findOKButton().click();
}
});
UI.confirm(content, function (yes) {
if (!yes) { return void cb(); }
// Get the values
var newName = $(content).find('#cp-app-drive-sf-name').val();
var password = $(content).find('#cp-app-drive-sf-password').val() || undefined;
var owned = $(content).find('#cp-app-drive-sf-owned').is(':checked');
cb({
name: newName,
password: password,
owned: owned
});
});
};
var getNewPadTypes = function () {
var arr = [];
AppConfig.availablePadTypes.forEach(function (type) {
if (type === 'drive') { return; }
if (type === 'contacts') { return; }
if (type === 'todo') { return; }
if (type === 'file') { return; }
if (!APP.loggedIn && AppConfig.registeredOnlyTypes &&
AppConfig.registeredOnlyTypes.indexOf(type) !== -1) {
return;
}
arr.push(type);
});
return arr;
};
var addNewPadHandlers = function ($block, isInRoot) {
// Handlers
if (isInRoot) {
var onCreated = function (err, info) {
if (err) {
if (err === E_OVER_LIMIT) {
return void UI.alert(Messages.pinLimitDrive, null, true);
}
return void UI.alert(Messages.fm_error_cantPin);
}
APP.newFolder = info.newPath;
refresh();
};
$block.find('a.cp-app-drive-new-folder, li.cp-app-drive-new-folder')
.click(function () {
manager.addFolder(currentPath, null, onCreated);
});
if (!APP.disableSF && !manager.isInSharedFolder(currentPath)) {
$block.find('a.cp-app-drive-new-shared-folder, li.cp-app-drive-new-shared-folder')
.click(function () {
addSharedFolderModal(function (obj) {
if (!obj) { return; }
manager.addSharedFolder(currentPath, obj, refresh);
});
});
}
$block.find('a.cp-app-drive-new-upload, li.cp-app-drive-new-upload')
.click(function () {
var $input = $('<input>', {
'type': 'file',
'style': 'display: none;',
'multiple': 'multiple'
}).on('change', function (e) {
var files = Util.slice(e.target.files);
files.forEach(function (file) {
var ev = {
target: $content[0],
path: findDropPath($content[0])
};
APP.FM.handleFile(file, ev);
});
});
$input.click();
});
}
$block.find('a.cp-app-drive-new-doc, li.cp-app-drive-new-doc')
.click(function () {
var type = $(this).attr('data-type') || 'pad';
var path = manager.isPathIn(currentPath, [TRASH]) ? '' : currentPath;
common.sessionStorage.put(Constants.newPadPathKey, path, function () {
common.openURL('/' + type + '/');
});
});
};
var createNewButton = function (isInRoot, $container) {
if (!APP.editable) { return; }
if (!APP.loggedIn) { return; } // Anonymous users can use the + menu in the toolbar
if (!manager.isPathIn(currentPath, [ROOT, 'hrefArray'])) { return; }
// Create dropdown
var options = [];
if (isInRoot) {
options.push({
tag: 'a',
attributes: {'class': 'cp-app-drive-new-folder'},
content: $('<div>').append($folderIcon.clone()).html() + Messages.fm_folder
});
if (!APP.disableSF && !manager.isInSharedFolder(currentPath)) {
options.push({
tag: 'a',
attributes: {'class': 'cp-app-drive-new-shared-folder'},
content: $('<div>').append($sharedFolderIcon.clone()).html() + Messages.fm_sharedFolder
});
}
options.push({tag: 'hr'});
options.push({
tag: 'a',
attributes: {'class': 'cp-app-drive-new-upload'},
content: $('<div>').append(getIcon('fileupload')).html() + Messages.uploadButton
});
options.push({tag: 'hr'});
}
getNewPadTypes().forEach(function (type) {
var attributes = {
'class': 'cp-app-drive-new-doc',
'data-type': type,
'href': '#'
};
options.push({
tag: 'a',
attributes: attributes,
content: $('<div>').append(getIcon(type)).html() + Messages.type[type]
});
});
var $plusIcon = $('<div>').append($('<span>', {'class': 'fa fa-plus'}));
var dropdownConfig = {
text: $plusIcon.html() + '<span>'+Messages.fm_newButton+'</span>',
options: options,
feedback: 'DRIVE_NEWPAD_LOCALFOLDER',
common: common
};
var $block = UIElements.createDropdown(dropdownConfig);
// Custom style:
$block.find('button').addClass('cp-app-drive-toolbar-new');
$block.find('button').attr('title', Messages.fm_newButtonTitle);
addNewPadHandlers($block, isInRoot);
$container.append($block);
};
var createShareButton = function (id, $container) {
var $shareBlock = $('<button>', {
'class': 'cp-toolbar-share-button',
title: Messages.shareButton
});
$sharedIcon.clone().appendTo($shareBlock);
$('<span>').text(Messages.shareButton).appendTo($shareBlock);
var data = manager.getSharedFolderData(id);
var parsed = Hash.parsePadUrl(data.href);
if (!parsed || !parsed.hash) { return void console.error("Invalid href: "+data.href); }
var modal = UIElements.createSFShareModal({
origin: APP.origin,
pathname: "/drive/",
hashes: {
editHash: parsed.hash
}
});
$shareBlock.click(function () {
UI.openCustomModal(modal);
});
$container.append($shareBlock);
};
var SORT_FOLDER_DESC = 'sortFoldersDesc';
var SORT_FILE_BY = 'sortFilesBy';
var SORT_FILE_DESC = 'sortFilesDesc';
var getSortFileDesc = function () {
return APP.store[SORT_FILE_DESC]+"" === "true";
};
var getSortFolderDesc = function () {
return APP.store[SORT_FOLDER_DESC]+"" === "true";
};
var onSortByClick = function () {
var $span = $(this);
var value;
if ($span.hasClass('cp-app-drive-sort-foldername')) {
value = getSortFolderDesc();
APP.store[SORT_FOLDER_DESC] = value ? false : true;
localStore.put(SORT_FOLDER_DESC, value ? false : true);
refresh();
return;
}
value = APP.store[SORT_FILE_BY];
var descValue = getSortFileDesc();
if ($span.hasClass('cp-app-drive-sort-filename')) {
if (value === '') {
descValue = descValue ? false : true;
} else {
descValue = false;
value = '';
}
} else {
['cp-app-drive-element-title', 'cp-app-drive-element-type',
'cp-app-drive-element-atime', 'cp-app-drive-element-ctime'].some(function (c) {
if ($span.hasClass(c)) {
var nValue = c.replace(/cp-app-drive-element-/, '');
if (value === nValue) { descValue = descValue ? false : true; }
else {
// atime and ctime should be ordered in a desc order at the first click
value = nValue;
descValue = value !== 'title';
}
return true;
}
});
}
APP.store[SORT_FILE_BY] = value;
APP.store[SORT_FILE_DESC] = descValue;
localStore.put(SORT_FILE_BY, value);
localStore.put(SORT_FILE_DESC, descValue);
refresh();
};
var addFolderSortIcon = function ($list) {
var $icon = $sortAscIcon.clone();
if (getSortFolderDesc()) {
$icon = $sortDescIcon.clone();
}
if (typeof(APP.store[SORT_FOLDER_DESC]) !== "undefined") {
$list.find('.cp-app-drive-sort-foldername').addClass('cp-app-drive-sort-active').prepend($icon);
}
};
var getFolderListHeader = function () {
var $fohElement = $('<li>', {
'class': 'cp-app-drive-element-header cp-app-drive-element-list'
});
//var $fohElement = $('<span>', {'class': 'element'}).appendTo($folderHeader);
var $fhIcon = $('<span>', {'class': 'cp-app-drive-content-icon'});
var $name = $('<span>', {
'class': 'cp-app-drive-element-name cp-app-drive-sort-foldername ' +
'cp-app-drive-sort-clickable'
}).text(Messages.fm_folderName).click(onSortByClick);
var $state = $('<span>', {'class': 'cp-app-drive-element-state'});
var $subfolders = $('<span>', {
'class': 'cp-app-drive-element-folders cp-app-drive-element-list'
}).text(Messages.fm_numberOfFolders);
var $files = $('<span>', {
'class': 'cp-app-drive-element-files cp-app-drive-element-list'
}).text(Messages.fm_numberOfFiles);
$fohElement.append($fhIcon).append($name).append($state)
.append($subfolders).append($files);
addFolderSortIcon($fohElement);
return $fohElement;
};
var addFileSortIcon = function ($list) {
var $icon = $sortAscIcon.clone();
if (getSortFileDesc()) {
$icon = $sortDescIcon.clone();
}
var classSorted;
if (APP.store[SORT_FILE_BY] === '') { classSorted = 'cp-app-drive-sort-filename'; }
else if (APP.store[SORT_FILE_BY]) { classSorted = 'cp-app-drive-element-' + APP.store[SORT_FILE_BY]; }
if (classSorted) {
$list.find('.' + classSorted).addClass('cp-app-drive-sort-active').prepend($icon);
}
};
var getFileListHeader = function () {
var $fihElement = $('<li>', {
'class': 'cp-app-drive-element-header cp-app-drive-element-list'
});
//var $fihElement = $('<span>', {'class': 'element'}).appendTo($fileHeader);
var $fhIcon = $('<span>', {'class': 'cp-app-drive-content-icon'});
var $fhName = $('<span>', {
'class': 'cp-app-drive-element-name cp-app-drive-sort-filename ' +
'cp-app-drive-sort-clickable'
}).text(Messages.fm_fileName).click(onSortByClick);
var $fhState = $('<span>', {'class': 'cp-app-drive-element-state'});
var $fhType = $('<span>', {
'class': 'cp-app-drive-element-type cp-app-drive-sort-clickable'
}).text(Messages.fm_type).click(onSortByClick);
var $fhAdate = $('<span>', {
'class': 'cp-app-drive-element-atime cp-app-drive-sort-clickable'
}).text(Messages.fm_lastAccess).click(onSortByClick);
var $fhCdate = $('<span>', {
'class': 'cp-app-drive-element-ctime cp-app-drive-sort-clickable'
}).text(Messages.fm_creation).click(onSortByClick);
// If displayTitle is false, it means the "name" is the title, so do not display the "name" header
$fihElement.append($fhIcon).append($fhName).append($fhState).append($fhType);
$fihElement.append($fhAdate).append($fhCdate);
addFileSortIcon($fihElement);
return $fihElement;
};
var sortElements = function (folder, path, oldkeys, prop, asc, useId) {
var root = path && manager.find(path);
if (path[0] === SHARED_FOLDER) {
path = path.slice(1);
root = Util.find(folders[APP.newSharedFolder], path);
}
var test = folder ? manager.isFolder : manager.isFile;
var keys = oldkeys.filter(function (e) {
return useId ? test(e) : (path && test(root[e]));
});
if (keys.length < 2) { return keys; }
var mult = asc ? 1 : -1;
var getProp = function (el, prop) {
if (folder && root[el] && manager.isSharedFolder(root[el])) {
var title = manager.getSharedFolderData(root[el]).title || el;
return title.toLowerCase();
} else if (folder) {
return el.toLowerCase();
}
var id = useId ? el : root[el];
var data = manager.getFileData(id);
if (!data) { return ''; }
if (prop === 'type') {
var hrefData = Hash.parsePadUrl(data.href || data.roHref);
return hrefData.type;
}
if (prop === 'atime' || prop === 'ctime') {
return new Date(data[prop]);
}
return (manager.getTitle(id) || "").toLowerCase();
};
keys.sort(function(a, b) {
if (getProp(a, prop) < getProp(b, prop)) { return mult * -1; }
if (getProp(a, prop) > getProp(b, prop)) { return mult * 1; }
return 0;
});
return keys;
};
var sortTrashElements = function (folder, oldkeys, prop, asc) {
var test = folder ? manager.isFolder : manager.isFile;
var keys = oldkeys.filter(function (e) {
return test(e.element);
});
if (keys.length < 2) { return keys; }
var mult = asc ? 1 : -1;
var getProp = function (el, prop) {
if (prop && !folder) {
var element = el.element;
var e = manager.getFileData(element);
if (!e) {
e = {
href : el,
title : Messages.fm_noname,
atime : 0,
ctime : 0
};
}
if (prop === 'type') {
var hrefData = Hash.parsePadUrl(e.href || e.roHref);
return hrefData.type;
}
if (prop === 'atime' || prop === 'ctime') {
return new Date(e[prop]);
}
}
return (el.name || "").toLowerCase();
};
keys.sort(function(a, b) {
if (getProp(a, prop) < getProp(b, prop)) { return mult * -1; }
if (getProp(a, prop) > getProp(b, prop)) { return mult * 1; }
return 0;
});
return keys;
};
// Create the ghost icon to add pads/folders
var createNewPadIcons = function ($block, isInRoot) {
var $container = $('<div>');
if (isInRoot) {
// Folder
var $element1 = $('<li>', {
'class': 'cp-app-drive-new-folder cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend($folderIcon.clone()).appendTo($container);
$element1.append($('<span>', { 'class': 'cp-app-drive-new-name' })
.text(Messages.fm_folder));
// Shared Folder
if (!APP.disableSF && !manager.isInSharedFolder(currentPath)) {
var $element3 = $('<li>', {
'class': 'cp-app-drive-new-shared-folder cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend($sharedFolderIcon.clone()).appendTo($container);
$element3.append($('<span>', { 'class': 'cp-app-drive-new-name' })
.text(Messages.fm_sharedFolder));
}
// File
var $element2 = $('<li>', {
'class': 'cp-app-drive-new-upload cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend(getIcon('fileupload')).appendTo($container);
$element2.append($('<span>', {'class': 'cp-app-drive-new-name'})
.text(Messages.uploadButton));
}
// Pads
getNewPadTypes().forEach(function (type) {
var $element = $('<li>', {
'class': 'cp-app-drive-new-doc cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend(getIcon(type)).appendTo($container);
$element.append($('<span>', {'class': 'cp-app-drive-new-name'})
.text(Messages.type[type]));
$element.attr('data-type', type);
});
$container.find('.cp-app-drive-element-row').click(function () {
$block.hide();
});
return $container;
};
var createGhostIcon = function ($list) {
var isInRoot = currentPath[0] === ROOT;
var $element = $('<li>', {
'class': 'cp-app-drive-element-row cp-app-drive-element-grid cp-app-drive-new-ghost'
}).prepend($addIcon.clone()).appendTo($list);
$element.append($('<span>', {'class': 'cp-app-drive-element-name'})
.text(Messages.fm_newFile));
$element.attr('title', Messages.fm_newFile);
$element.click(function () {
var $modal = UIElements.createModal({
id: 'cp-app-drive-new-ghost-dialog',
$body: $('body')
});
var $title = $('<h3>').text(Messages.fm_newFile);
var $description = $('<p>').text(Messages.fm_newButtonTitle);
$modal.find('.cp-modal').append($title);
$modal.find('.cp-modal').append($description);
var $content = createNewPadIcons($modal, isInRoot);
$modal.find('.cp-modal').append($content);
window.setTimeout(function () { $modal.show(); });
addNewPadHandlers($modal, isInRoot);
});
};
// Drive content toolbar
var createToolbar = function () {
var $toolbar = $driveToolbar;
$toolbar.html('');
$('<div>', {'class': 'cp-app-drive-toolbar-leftside'}).appendTo($toolbar);
$('<div>', {'class': 'cp-app-drive-path cp-unselectable'}).appendTo($toolbar);
$('<div>', {'class': 'cp-app-drive-toolbar-filler'}).appendTo($toolbar);
var $rightside = $('<div>', {'class': 'cp-app-drive-toolbar-rightside'})
.appendTo($toolbar);
if (APP.loggedIn || !APP.newSharedFolder) {
// ANON_SHARED_FOLDER
var $hist = common.createButton('history', true, {histConfig: APP.histConfig});
$rightside.append($hist);
}
if (APP.$burnThisDrive) {
$rightside.append(APP.$burnThisDrive);
}
return $toolbar;
};
// Unsorted element are represented by "href" in an array: they don't have a filename
// and they don't hav a hierarchical structure (folder/subfolders)
var displayHrefArray = function ($container, rootName, draggable) {
var unsorted = files[rootName];
if (unsorted.length) {
var $fileHeader = getFileListHeader(false);
$container.append($fileHeader);
}
var keys = unsorted;
var sortBy = APP.store[SORT_FILE_BY];
sortBy = sortBy === "" ? sortBy = 'name' : sortBy;
var sortedFiles = sortElements(false, [rootName], keys, sortBy, !getSortFileDesc(), true);
sortedFiles.forEach(function (id) {
var file = manager.getFileData(id);
if (!file) {
//debug("Unsorted or template returns an element not present in filesData: ", href);
file = { title: Messages.fm_noname };
//return;
}
var idx = files[rootName].indexOf(id);
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined mens it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-file cp-app-drive-element-row' + roClass,
draggable: draggable
});
if (Array.isArray(APP.selectedFiles)) {
var sidx = APP.selectedFiles.indexOf(id);
if (sidx !== -1) {
$element.addClass('cp-app-drive-element-selected');
APP.selectedFiles.splice(sidx, 1);
}
}
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
var path = [rootName, idx];
$element.data('path', path);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element, path);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
if (draggable) {
addDragAndDropHandlers($element, path, false, false);
}
$container.append($element);
});
createGhostIcon($container);
};
var displayAllFiles = function ($container) {
if (AppConfig.disableAnonymousStore && !APP.loggedIn) {
$container.append(Messages.anonymousStoreDisabled);
return;
}
var allfiles = files[FILES_DATA];
if (allfiles.length === 0) { return; }
var $fileHeader = getFileListHeader(false);
$container.append($fileHeader);
var keys = manager.getFiles([FILES_DATA]);
var sortedFiles = sortElements(false, [FILES_DATA], keys, APP.store[SORT_FILE_BY], !getSortFileDesc(), true);
sortedFiles.forEach(function (id) {
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined maens it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-row' + roClass
});
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
$element.data('path', [FILES_DATA, id]);
$element.data('element', id);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
$container.append($element);
});
createGhostIcon($container);
};
var displayTrashRoot = function ($list, $folderHeader, $fileHeader) {
var filesList = [];
var root = files[TRASH];
// Elements in the trash are JS arrays (several elements can have the same name)
Object.keys(root).forEach(function (key) {
if (!Array.isArray(root[key])) {
logError("Trash element has a wrong type", root[key]);
return;
}
root[key].forEach(function (el, idx) {
if (!manager.isFile(el.element) && !manager.isFolder(el.element)) { return; }
var spath = [key, idx, 'element'];
filesList.push({
element: el.element,
spath: spath,
name: key
});
});
});
var sortedFolders = sortTrashElements(true, filesList, null, !getSortFolderDesc());
var sortedFiles = sortTrashElements(false, filesList, APP.store[SORT_FILE_BY], !getSortFileDesc());
if (manager.hasSubfolder(root, true)) { $list.append($folderHeader); }
sortedFolders.forEach(function (f) {
var $element = createElement([TRASH], f.spath, root, true);
$list.append($element);
});
if (manager.hasFile(root, true)) { $list.append($fileHeader); }
sortedFiles.forEach(function (f) {
var $element = createElement([TRASH], f.spath, root, false);
$list.append($element);
});
};
var displaySearch = function ($list, value) {
var filesList = manager.search(value);
filesList.forEach(function (r) {
r.paths.forEach(function (path) {
if (!r.inSharedFolder &&
APP.hideDuplicateOwned && manager.isDuplicateOwned(path)) { return; }
var href = r.data.href;
var parsed = Hash.parsePadUrl(href);
var $table = $('<table>');
var $icon = $('<td>', {'rowspan': '3', 'class': 'cp-app-drive-search-icon'})
.append(getFileIcon(r.id));
var $title = $('<td>', {
'class': 'cp-app-drive-search-col1 cp-app-drive-search-title'
}).text(r.data.title)
.click(function () {
openFile(null, r.data.href);
});
var $typeName = $('<td>', {'class': 'cp-app-drive-search-label2'})
.text(Messages.fm_type);
var $type = $('<td>', {'class': 'cp-app-drive-search-col2'})
.text(Messages.type[parsed.type] || parsed.type);
var $atimeName = $('<td>', {'class': 'cp-app-drive-search-label2'})
.text(Messages.fm_lastAccess);
var $atime = $('<td>', {'class': 'cp-app-drive-search-col2'})
.text(new Date(r.data.atime).toLocaleString());
var $ctimeName = $('<td>', {'class': 'cp-app-drive-search-label2'})
.text(Messages.fm_creation);
var $ctime = $('<td>', {'class': 'cp-app-drive-search-col2'})
.text(new Date(r.data.ctime).toLocaleString());
if (manager.isPathIn(path, ['hrefArray'])) {
path.pop();
path.push(r.data.title);
}
var $path = $('<td>', {
'class': 'cp-app-drive-search-col1 cp-app-drive-search-path'
});
createTitle($path, path, true);
var parentPath = path.slice();
var $a;
if (parentPath) {
$a = $('<a>').text(Messages.fm_openParent).click(function (e) {
e.preventDefault();
if (manager.isInTrashRoot(parentPath)) { parentPath = [TRASH]; }
else { parentPath.pop(); }
APP.selectedFiles = [r.id];
APP.displayDirectory(parentPath);
});
}
var $openDir = $('<td>', {'class': 'cp-app-drive-search-opendir'}).append($a);
$('<a>').text(Messages.fc_prop).click(function () {
APP.getProperties(r.id, function (e, $prop) {
if (e) { return void logError(e); }
UI.alert($prop[0], undefined, true);
});
}).appendTo($openDir);
// rows 1-3
$('<tr>').append($icon).append($title).append($typeName).append($type).appendTo($table);
$('<tr>').append($path).append($atimeName).append($atime).appendTo($table);
$('<tr>').append($openDir).append($ctimeName).append($ctime).appendTo($table);
$('<li>', {'class':'cp-app-drive-search-result'}).append($table).appendTo($list);
});
});
};
var displayRecent = function ($list) {
var filesList = manager.getRecentPads();
var limit = 20;
var now = new Date();
var last1 = new Date(now);
last1.setDate(last1.getDate()-1);
var last7 = new Date(now);
last7.setDate(last7.getDate()-7);
var last28 = new Date(now);
last28.setDate(last28.getDate()-28);
var header7, header28, headerOld;
var i = 0;
var channels = [];
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_active1Day)));
filesList.some(function (arr) {
var id = arr[0];
var file = arr[1];
if (!file || !file.atime) { return; }
if (file.atime <= last28 && i >= limit) {
return true;
}
var paths = manager.findFile(id);
if (!paths.length) { return; }
var path = paths[0];
if (manager.isPathIn(path, [TRASH])) { return; }
if (channels.indexOf(file.channel) !== -1) { return; }
channels.push(file.channel);
if (!header7 && file.atime < last1) {
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_active7Days)));
header7 = true;
}
if (!header28 && file.atime < last7) {
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_active28Days)));
header28 = true;
}
if (!headerOld && file.atime < last28) {
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_activeOld)));
headerOld = true;
}
// Display the pad
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined means it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-notrash cp-app-drive-element-file cp-app-drive-element-row' + roClass,
});
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
$element.data('path', path);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element, path);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
/*if (draggable) {
addDragAndDropHandlers($element, path, false, false);
}*/
$list.append($element);
i++;
});
};
// Owned pads category
var displayOwned = function ($container) {
var list = manager.getOwnedPads();
if (list.length === 0) { return; }
var $fileHeader = getFileListHeader(false);
$container.append($fileHeader);
var sortedFiles = sortElements(false, false, list, APP.store[SORT_FILE_BY], !getSortFileDesc(), true);
sortedFiles.forEach(function (id) {
var paths = manager.findFile(id);
if (!paths.length) { return; }
var path = paths[0];
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined maens it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-notrash ' +
'cp-app-drive-element-file cp-app-drive-element-row' + roClass
});
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
$element.data('path', path);
$element.data('element', id);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
$container.append($element);
});
};
// Tags category
var displayTags = function ($container) {
var list = manager.getTagsList();
if (Object.keys(list).length === 0) { return; }
var sortedTags = Object.keys(list);
sortedTags.sort(function (a, b) {
return list[b] - list[a];
});
var lines = [
h('tr', [
h('th', Messages.fm_tags_name),
h('th', Messages.fm_tags_used)
])
];
sortedTags.forEach(function (tag) {
var tagLink = h('a', { href: '#' }, '#' + tag);
$(tagLink).click(function () {
if (displayedCategories.indexOf(SEARCH) !== -1) {
APP.Search.$input.val('#' + tag).keyup();
}
});
lines.push(h('tr', [
h('td', tagLink),
h('td.cp-app-drive-tags-used', list[tag])
]));
});
$(h('li.cp-app-drive-tags-list', h('table', lines))).appendTo($container);
};
// ANON_SHARED_FOLDER
// Display a shared folder for anon users (read-only)
var displaySharedFolder = function ($list) {
if (currentPath.length === 1) {
currentPath.push(ROOT);
}
var fId = APP.newSharedFolder;
var data = folders[fId];
var $folderHeader = getFolderListHeader();
var $fileHeader = getFileListHeader(true);
var path = currentPath.slice(1);
var root = Util.find(data, path);
if (manager.hasSubfolder(root)) { $list.append($folderHeader); }
// display sub directories
var keys = Object.keys(root);
var sortedFolders = sortElements(true, currentPath, keys, null, !getSortFolderDesc());
var sortedFiles = sortElements(false, currentPath, keys, APP.store[SORT_FILE_BY], !getSortFileDesc());
sortedFolders.forEach(function (key) {
if (manager.isFile(root[key])) { return; }
var $element = createElement(currentPath, key, root, true);
$element.appendTo($list);
});
if (manager.hasFile(root)) { $list.append($fileHeader); }
// display files
sortedFiles.forEach(function (key) {
if (manager.isFolder(root[key])) { return; }
var $element = createElement(currentPath, key, root, false);
if (!$element) { return; }
$element.appendTo($list);
});
};
// Display the selected directory into the content part (rightside)
// NOTE: Elements in the trash are not using the same storage structure as the others
var _displayDirectory = function (path, force) {
APP.hideMenu();
if (!APP.editable) { debug("Read-only mode"); }
if (!appStatus.isReady && !force) { return; }
// Only Trash and Root are available in not-owned files manager
if (!path || displayedCategories.indexOf(path[0]) === -1) {
log(Messages.fm_categoryError);
currentPath = [ROOT];
_displayDirectory(currentPath);
return;
}
appStatus.ready(false);
currentPath = path;
var s = $content.scrollTop() || 0;
$content.html("");
sel.$selectBox = $('<div>', {'class': 'cp-app-drive-content-select-box'})
.appendTo($content);
if (!path || path.length === 0) {
path = [ROOT];
}
var isInRoot = manager.isPathIn(path, [ROOT]);
var inTrash = manager.isPathIn(path, [TRASH]);
var isTrashRoot = manager.comparePath(path, [TRASH]);
var isTemplate = manager.comparePath(path, [TEMPLATE]);
var isAllFiles = manager.comparePath(path, [FILES_DATA]);
var isVirtual = virtualCategories.indexOf(path[0]) !== -1;
var isSearch = path[0] === SEARCH;
var isTags = path[0] === TAGS;
// ANON_SHARED_FOLDER
var isSharedFolder = path[0] === SHARED_FOLDER && APP.newSharedFolder;
var root = isVirtual ? undefined : manager.find(path);
if (manager.isSharedFolder(root)) {
// ANON_SHARED_FOLDER
path.push(manager.user.userObject.ROOT);
root = manager.find(path);
if (!root) { return; }
}
if (!isVirtual && typeof(root) === "undefined") {
log(Messages.fm_unknownFolderError);
debug("Unable to locate the selected directory: ", path);
var parentPath = path.slice();
parentPath.pop();
_displayDirectory(parentPath, true);
return;
}
if (!isSearch) { delete APP.Search.oldLocation; }
APP.resetTree();
if (displayedCategories.indexOf(SEARCH) !== -1 && $tree.find('#cp-app-drive-tree-search-input').length) {
// in history mode we want to focus the version number input
if (!history.isHistoryMode && !APP.mobile()) {
var st = $tree.scrollTop() || 0;
$tree.find('#cp-app-drive-tree-search-input').focus();
$tree.scrollTop(st);
}
$tree.find('#cp-app-drive-tree-search-input')[0].selectionStart = getSearchCursor();
$tree.find('#cp-app-drive-tree-search-input')[0].selectionEnd = getSearchCursor();
}
setLastOpenedFolder(path);
var $toolbar = createToolbar(path);
var $info = createInfoBox(path);
var $dirContent = $('<div>', {id: FOLDER_CONTENT_ID});
$dirContent.data('path', path);
if (!isSearch && !isTags) {
var mode = getViewMode();
if (mode) {
$dirContent.addClass(getViewModeClass());
}
createViewModeButton($toolbar.find('.cp-app-drive-toolbar-rightside'));
}
if (inTrash) {
createEmptyTrashButton($toolbar.find('.cp-app-drive-toolbar-rightside'));
}
var $list = $('<ul>').appendTo($dirContent);
// NewButton can be undefined if we're in read only mode
createNewButton(isInRoot, $toolbar.find('.cp-app-drive-toolbar-leftside'));
var sfId = manager.isInSharedFolder(currentPath);
if (sfId) {
var sfData = manager.getSharedFolderData(sfId);
var parsed = Hash.parsePadUrl(sfData.href);
sframeChan.event('EV_DRIVE_SET_HASH', parsed.hash || '');
createShareButton(sfId, $toolbar.find('.cp-app-drive-toolbar-leftside'));
} else {
sframeChan.event('EV_DRIVE_SET_HASH', '');
}
createTitle($toolbar.find('.cp-app-drive-path'), path);
if (APP.mobile()) {
var $context = $('<button>', {
id: 'cp-app-drive-toolbar-context-mobile'
});
$context.append($('<span>', {'class': 'fa fa-caret-down'}));
$context.appendTo($toolbar.find('.cp-app-drive-toolbar-rightside'));
$context.click(function (e) {
e.preventDefault();
e.stopPropagation();
var $li = $content.find('.cp-app-drive-element-selected');
if ($li.length !== 1) {
$li = findDataHolder($tree.find('.cp-app-drive-element-active'));
}
// Close if already opened
if ($('.cp-contextmenu:visible').length) {
APP.hideMenu();
return;
}
// Open the menu
$('.cp-contextmenu').css({
top: ($context.offset().top + 32) + 'px',
right: '0px',
left: ''
});
$li.contextmenu();
});
} else {
var $contextButtons = $('<span>', {'id' : 'cp-app-drive-toolbar-contextbuttons'});
$contextButtons.appendTo($toolbar.find('.cp-app-drive-toolbar-rightside'));
}
updateContextButton();
var $folderHeader = getFolderListHeader();
var $fileHeader = getFileListHeader(true);
if (isTemplate) {
displayHrefArray($list, path[0], true);
} else if (isAllFiles) {
displayAllFiles($list);
} else if (isTrashRoot) {
displayTrashRoot($list, $folderHeader, $fileHeader);
} else if (isSearch) {
displaySearch($list, path[1]);
} else if (path[0] === RECENT) {
displayRecent($list);
} else if (path[0] === OWNED) {
displayOwned($list);
} else if (isTags) {
displayTags($list);
} else if (isSharedFolder) {
// ANON_SHARED_FOLDER
displaySharedFolder($list);
} else {
$dirContent.contextmenu(openContextMenu('content'));
if (manager.hasSubfolder(root)) { $list.append($folderHeader); }
// display sub directories
var keys = Object.keys(root);
var sortedFolders = sortElements(true, path, keys, null, !getSortFolderDesc());
var sortedFiles = sortElements(false, path, keys, APP.store[SORT_FILE_BY], !getSortFileDesc());
sortedFolders.forEach(function (key) {
if (manager.isFile(root[key])) { return; }
var $element = createElement(path, key, root, true);
$element.appendTo($list);
});
if (manager.hasFile(root)) { $list.append($fileHeader); }
// display files
sortedFiles.forEach(function (key) {
if (manager.isFolder(root[key])) { return; }
var p = path.slice();
p.push(key);
if (APP.hideDuplicateOwned && manager.isDuplicateOwned(p)) { return; }
var $element = createElement(path, key, root, false);
if (!$element) { return; }
$element.appendTo($list);
});
if (!inTrash) { createGhostIcon($list); }
}
$content.append($info).append($dirContent);
/*var $truncated = $('<span>', {'class': 'cp-app-drive-element-truncated'}).text('...');
$content.find('.cp-app-drive-element').each(function (idx, el) {
var $name = $(el).find('.cp-app-drive-element-name');
if ($name.length === 0) { return; }
if ($name[0].scrollHeight > $name[0].clientHeight) {
var $tr = $truncated.clone();
$tr.attr('title', $name.text());
$(el).append($tr);
}
});*/
var $sel = $content.find('.cp-app-drive-element-selected');
if ($sel.length) {
$sel[0].scrollIntoView();
} else {
$content.scrollTop(s);
}
appStatus.ready(true);
};
var displayDirectory = APP.displayDirectory = function (path, force) {
if (history.isHistoryMode) {
return void _displayDirectory(path, force);
}
updateObject(sframeChan, proxy, function () {
copyObjectValue(files, proxy.drive);
updateSharedFolders(sframeChan, manager, files, folders, function () {
_displayDirectory(path, force);
});
});
};
var createTreeElement = function (name, $icon, path, draggable, droppable, collapsable, active, isSharedFolder) {
var $name = $('<span>', { 'class': 'cp-app-drive-element' }).text(name);
var $collapse;
if (collapsable) {
$collapse = $expandIcon.clone();
}
var $elementRow = $('<span>', {'class': 'cp-app-drive-element-row'}).append($collapse).append($icon).append($name).click(function (e) {
e.stopPropagation();
APP.displayDirectory(path);
});
var $element = $('<li>').append($elementRow);
if (draggable) { $elementRow.attr('draggable', true); }
if (collapsable) {
$element.addClass('cp-app-drive-element-collapsed');
$collapse.click(function(e) {
e.stopPropagation();
if ($element.hasClass('cp-app-drive-element-collapsed')) {
// It is closed, open it
$element.removeClass('cp-app-drive-element-collapsed');
setFolderOpened(path, true);
$collapse.removeClass('fa-plus-square-o');
$collapse.addClass('fa-minus-square-o');
} else {
// Collapse the folder
$element.addClass('cp-app-drive-element-collapsed');
setFolderOpened(path, false);
$collapse.removeClass('fa-minus-square-o');
$collapse.addClass('fa-plus-square-o');
// Change the current opened folder if it was collapsed
if (manager.isSubpath(currentPath, path)) {
displayDirectory(path);
}
}
});
if (wasFolderOpened(path) ||
(manager.isSubpath(currentPath, path) && path.length < currentPath.length)) {
$collapse.click();
}
}
var dataPath = isSharedFolder ? path.slice(0, -1) : path;
$elementRow.data('path', dataPath);
addDragAndDropHandlers($elementRow, dataPath, true, droppable);
if (active) {
$elementRow.addClass('cp-app-drive-element-active cp-leftside-active');
}
return $element;
};
var createTree = function ($container, path) {
var root = manager.find(path);
// don't try to display what doesn't exist
if (!root) { return; }
// Display the root element in the tree
var displayingRoot = manager.comparePath([ROOT], path);
if (displayingRoot) {
var isRootOpened = manager.comparePath([ROOT], currentPath);
var $rootIcon = manager.isFolderEmpty(files[ROOT]) ?
(isRootOpened ? $folderOpenedEmptyIcon : $folderEmptyIcon) :
(isRootOpened ? $folderOpenedIcon : $folderIcon);
var $rootElement = createTreeElement(ROOT_NAME, $rootIcon.clone(), [ROOT], false, true, true, isRootOpened);
if (!manager.hasSubfolder(root)) {
$rootElement.find('.cp-app-drive-icon-expcol').css('visibility', 'hidden');
}
$rootElement.addClass('cp-app-drive-tree-root');
$rootElement.find('>.cp-app-drive-element-row')
.contextmenu(openContextMenu('tree'));
$('<ul>', {'class': 'cp-app-drive-tree-docs'})
.append($rootElement).appendTo($container);
$container = $rootElement;
} else if (manager.isFolderEmpty(root)) { return; }
// Display root content
var $list = $('<ul>').appendTo($container);
var keys = Object.keys(root).sort(function (a, b) {
var newA = manager.isSharedFolder(root[a]) ?
manager.getSharedFolderData(root[a]).title : a;
var newB = manager.isSharedFolder(root[b]) ?
manager.getSharedFolderData(root[b]).title : b;
return newA < newB ? -1 :
(newA === newB ? 0 : 1);
});
keys.forEach(function (key) {
// Do not display files in the menu
if (!manager.isFolder(root[key])) { return; }
var newPath = path.slice();
newPath.push(key);
var isSharedFolder = manager.isSharedFolder(root[key]);
var $icon, isCurrentFolder, subfolder;
if (isSharedFolder) {
var fId = root[key];
// Fix path
newPath.push(manager.user.userObject.ROOT);
isCurrentFolder = manager.comparePath(newPath, currentPath);
// Subfolders?
var newRoot = manager.folders[fId].proxy[manager.user.userObject.ROOT];
subfolder = manager.hasSubfolder(newRoot);
// Fix name
key = manager.getSharedFolderData(fId).title;
// Fix icon
$icon = isCurrentFolder ? $sharedFolderOpenedIcon : $sharedFolderIcon;
} else {
var isEmpty = manager.isFolderEmpty(root[key]);
subfolder = manager.hasSubfolder(root[key]);
isCurrentFolder = manager.comparePath(newPath, currentPath);
$icon = isEmpty ?
(isCurrentFolder ? $folderOpenedEmptyIcon : $folderEmptyIcon) :
(isCurrentFolder ? $folderOpenedIcon : $folderIcon);
}
var $element = createTreeElement(key, $icon.clone(), newPath, true, true, subfolder, isCurrentFolder, isSharedFolder);
$element.appendTo($list);
$element.find('>.cp-app-drive-element-row').contextmenu(openContextMenu('tree'));
if (isSharedFolder) {
$element.find('>.cp-app-drive-element-row')
.addClass('cp-app-drive-element-sharedf');
}
createTree($element, newPath);
});
};
var createTrash = function ($container, path) {
var $icon = manager.isFolderEmpty(files[TRASH]) ? $trashEmptyIcon.clone() : $trashIcon.clone();
var isOpened = manager.comparePath(path, currentPath);
var $trashElement = createTreeElement(TRASH_NAME, $icon, [TRASH], false, true, false, isOpened);
$trashElement.addClass('cp-app-drive-tree-root');
$trashElement.find('>.cp-app-drive-element-row')
.contextmenu(openContextMenu('trashtree'));
var $trashList = $('<ul>', { 'class': 'cp-app-drive-tree-category' })
.append($trashElement);
$container.append($trashList);
};
var search = APP.Search = {};
var createSearch = function ($container) {
var isInSearch = currentPath[0] === SEARCH;
var $div = $('<div>', {'id': 'cp-app-drive-tree-search', 'class': 'cp-unselectable'});
var $input = APP.Search.$input = $('<input>', {
id: 'cp-app-drive-tree-search-input',
type: 'text',
draggable: false,
tabindex: 1,
placeholder: Messages.fm_searchPlaceholder
}).keyup(function (e) {
if (search.to) { window.clearTimeout(search.to); }
if ([38, 39, 40, 41].indexOf(e.which) !== -1) {
if (!$input.val()) {
$input.blur();
$content.focus();
return;
} else {
e.stopPropagation();
}
}
var isInSearchTmp = currentPath[0] === SEARCH;
if ($input.val().trim() === "") {
setSearchCursor(0);
if (search.oldLocation && search.oldLocation.length) { displayDirectory(search.oldLocation); }
return;
}
if (e.which === 13) {
if (!isInSearchTmp) { search.oldLocation = currentPath.slice(); }
var newLocation = [SEARCH, $input.val()];
setSearchCursor();
if (!manager.comparePath(newLocation, currentPath.slice())) { displayDirectory(newLocation); }
return;
}
if (e.which === 27) {
$input.val('');
setSearchCursor(0);
if (search.oldLocation && search.oldLocation.length) { displayDirectory(search.oldLocation); }
else { displayDirectory([ROOT]); }
return;
}
if ($input.val()) {
if (!$input.hasClass('cp-app-drive-search-active')) {
$input.addClass('cp-app-drive-search-active');
}
} else {
$input.removeClass('cp-app-drive-search-active');
}
if (APP.mobile()) { return; }
search.to = window.setTimeout(function () {
if (!isInSearchTmp) { search.oldLocation = currentPath.slice(); }
var newLocation = [SEARCH, $input.val()];
setSearchCursor();
if (!manager.comparePath(newLocation, currentPath.slice())) { displayDirectory(newLocation); }
}, 500);
}).appendTo($div);
var cancel = h('span.fa.fa-times.cp-app-drive-search-cancel', {title:Messages.cancel});
cancel.addEventListener('click', function () {
$input.val('');
setSearchCursor(0);
if (search.oldLocation && search.oldLocation.length) { displayDirectory(search.oldLocation); }
});
$div.append(cancel);
$searchIcon.clone().appendTo($div);
if (isInSearch) {
$input.val(currentPath[1] || '');
if ($input.val()) { $input.addClass('cp-app-drive-search-active'); }
}
$container.append($div);
};
var categories = {};
categories[FILES_DATA] = {
name: FILES_DATA_NAME,
$icon: $unsortedIcon
};
categories[TEMPLATE] = {
name: TEMPLATE_NAME,
droppable: true,
$icon: $templateIcon
};
categories[RECENT] = {
name: RECENT_NAME,
$icon: $recentIcon
};
categories[OWNED] = {
name: OWNED_NAME,
$icon: $ownedIcon
};
categories[TAGS] = {
name: TAGS_NAME,
$icon: $tagsIcon
};
var createCategory = function ($container, cat) {
var options = categories[cat];
var $icon = options.$icon.clone();
var isOpened = manager.comparePath([cat], currentPath);
var $element = createTreeElement(options.name, $icon, [cat], options.draggable, options.droppable, false, isOpened);
$element.addClass('cp-app-drive-tree-root');
var $list = $('<ul>', { 'class': 'cp-app-drive-tree-category' }).append($element);
$container.append($list);
};
APP.resetTree = function () {
var $categories = $tree.find('.cp-app-drive-tree-categories-container');
var s = $categories.scrollTop() || 0;
$tree.html('');
if (displayedCategories.indexOf(SEARCH) !== -1) { createSearch($tree); }
var $div = $('<div>', {'class': 'cp-app-drive-tree-categories-container'})
.appendTo($tree);
if (displayedCategories.indexOf(TAGS) !== -1) { createCategory($div, TAGS); }
if (displayedCategories.indexOf(RECENT) !== -1) { createCategory($div, RECENT); }
if (displayedCategories.indexOf(OWNED) !== -1) { createCategory($div, OWNED); }
if (displayedCategories.indexOf(ROOT) !== -1) { createTree($div, [ROOT]); }
if (displayedCategories.indexOf(TEMPLATE) !== -1) { createCategory($div, TEMPLATE); }
if (displayedCategories.indexOf(FILES_DATA) !== -1) { createCategory($div, FILES_DATA); }
if (displayedCategories.indexOf(TRASH) !== -1) { createTrash($div, [TRASH]); }
$tree.append(APP.$limit);
$categories = $tree.find('.cp-app-drive-tree-categories-container');
$categories.scrollTop(s);
};
APP.hideMenu = function (e) {
$contextMenu.hide();
$trashTreeContextMenu.hide();
$trashContextMenu.hide();
$contentContextMenu.hide();
$defaultContextMenu.hide();
if (!e || !$(e.target).parents('.cp-dropdown')) {
$('.cp-dropdown-content').hide();
}
};
var stringifyPath = function (path) {
if (!Array.isArray(path)) { return; }
var $div = $('<div>');
var i = 0;
var space = 10;
path.forEach(function (s) {
if (i === 0) { s = getPrettyName(s); }
$div.append($('<span>', {'style': 'margin: 0 0 0 ' + i * space + 'px;'}).text(s));
$div.append($('<br>'));
i++;
});
return $div.html();
};
// Disable middle click in the context menu to avoid opening /drive/inner.html# in new tabs
$(window).click(function (e) {
if (!e.target || !$(e.target).parents('.cp-dropdown-content').length) { return; }
if (e.which !== 1) {
e.stopPropagation();
return false;
}
});
var getProperties = APP.getProperties = function (el, cb) {
if (!manager.isFile(el) && !manager.isSharedFolder(el)) {
return void cb('NOT_FILE');
}
//var ro = manager.isReadOnlyFile(el);
var base = APP.origin;
var data;
if (manager.isSharedFolder(el)) {
data = JSON.parse(JSON.stringify(manager.getSharedFolderData(el)));
} else {
data = JSON.parse(JSON.stringify(manager.getFileData(el)));
}
if (!data || !(data.href || data.roHref)) { return void cb('INVALID_FILE'); }
if (data.href) {
data.href = base + data.href;
}
if (data.roHref) {
data.roHref = base + data.roHref;
}
if (manager.isSharedFolder(el)) {
delete data.roHref;
//data.noPassword = true;
data.noEditPassword = true;
data.noExpiration = true;
}
UIElements.getProperties(common, data, cb);
};
if (!APP.loggedIn) {
$contextMenu.find('.cp-app-drive-context-delete').text(Messages.fc_remove)
.attr('data-icon', 'fa-eraser');
}
var deleteOwnedPaths = function (paths, pathsList) {
pathsList = pathsList || [];
if (paths) {
paths.forEach(function (p) { pathsList.push(p.path); });
}
var msgD = pathsList.length === 1 ? Messages.fm_deleteOwnedPad :
Messages.fm_deleteOwnedPads;
UI.confirm(msgD, function(res) {
$(window).focus();
if (!res) { return; }
manager.delete(pathsList, refresh);
});
};
$contextMenu.on("click", "a", function(e) {
e.stopPropagation();
var paths = $contextMenu.data('paths');
var pathsList = [];
var type = $contextMenu.attr('data-menu-type');
var el, data;
if (paths.length === 0) {
log(Messages.fm_forbidden);
debug("Context menu on a forbidden or unexisting element. ", paths);
return;
}
if ($(this).hasClass("cp-app-drive-context-rename")) {
if (paths.length !== 1) { return; }
displayRenameInput(paths[0].element, paths[0].path);
}
else if($(this).hasClass("cp-app-drive-context-delete")) {
if (!APP.loggedIn) {
return void deletePaths(paths);
}
paths.forEach(function (p) { pathsList.push(p.path); });
moveElements(pathsList, [TRASH], false, refresh);
}
else if ($(this).hasClass('cp-app-drive-context-deleteowned')) {
deleteOwnedPaths(paths);
}
else if ($(this).hasClass('cp-app-drive-context-open')) {
paths.forEach(function (p) {
var $element = p.element;
$element.click();
$element.dblclick();
});
}
else if ($(this).hasClass('cp-app-drive-context-openro')) {
paths.forEach(function (p) {
var el = manager.find(p.path);
if (paths[0].path[0] === SHARED_FOLDER && APP.newSharedFolder) {
// ANON_SHARED_FOLDER
el = manager.find(paths[0].path.slice(1), APP.newSharedFolder);
}
var href;
if (manager.isPathIn(p.path, [FILES_DATA])) {
href = el.roHref;
} else {
if (!el || manager.isFolder(el)) { return; }
var data = manager.getFileData(el);
href = data.roHref;
}
openFile(null, href);
});
}
else if ($(this).hasClass('cp-app-drive-context-download')) {
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
if (!manager.isFile(el)) { return; }
data = manager.getFileData(el);
APP.FM.downloadFile(data, function (err, obj) {
console.log(err, obj);
console.log('DONE');
});
}
else if ($(this).hasClass('cp-app-drive-context-share')) {
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
var parsed, modal;
if (manager.isSharedFolder(el)) {
data = manager.getSharedFolderData(el);
parsed = Hash.parsePadUrl(data.href);
modal = UIElements.createSFShareModal({
origin: APP.origin,
pathname: "/drive/",
hashes: {
editHash: parsed.hash
}
});
} else {
data = manager.getFileData(el);
parsed = Hash.parsePadUrl(data.href);
var roParsed = Hash.parsePadUrl(data.roHref);
var padType = parsed.type || roParsed.type;
var padData = {
origin: APP.origin,
pathname: "/" + padType + "/",
hashes: {
editHash: parsed.hash,
viewHash: roParsed.hash,
fileHash: parsed.hash
},
fileData: {
hash: parsed.hash,
password: data.password
},
common: common
};
modal = padType === 'file' ? UIElements.createFileShareModal(padData)
: UIElements.createShareModal(padData);
modal = UI.dialog.tabs(modal);
}
UI.openCustomModal(modal);
}
else if ($(this).hasClass('cp-app-drive-context-newfolder')) {
if (paths.length !== 1) { return; }
var onFolderCreated = function (err, info) {
if (err) { return void logError(err); }
APP.newFolder = info.newPath;
APP.displayDirectory(paths[0].path);
};
el = manager.find(paths[0].path);
if (manager.isSharedFolder(el)) {
paths[0].path.push(ROOT);
}
manager.addFolder(paths[0].path, null, onFolderCreated);
}
else if ($(this).hasClass('cp-app-drive-context-newsharedfolder')) {
if (paths.length !== 1) { return; }
addSharedFolderModal(function (obj) {
if (!obj) { return; }
manager.addSharedFolder(paths[0].path, obj, refresh);
});
}
else if ($(this).hasClass("cp-app-drive-context-newdoc")) {
var ntype = $(this).data('type') || 'pad';
var path2 = manager.isPathIn(currentPath, [TRASH]) ? '' : currentPath;
common.sessionStorage.put(Constants.newPadPathKey, path2, function () {
common.openURL('/' + ntype + '/');
});
}
else if ($(this).hasClass("cp-app-drive-context-properties")) {
if (type === 'trash') {
var pPath = paths[0].path;
if (paths.length !== 1 || pPath.length !== 4) { return; }
var element = manager.find(pPath.slice(0,3)); // element containing the oldpath
var sPath = stringifyPath(element.path);
UI.alert('<strong>' + Messages.fm_originalPath + "</strong>:<br>" + sPath, undefined, true);
return;
}
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
if (paths[0].path[0] === SHARED_FOLDER && APP.newSharedFolder) {
// ANON_SHARED_FOLDER
el = manager.find(paths[0].path.slice(1), APP.newSharedFolder);
}
getProperties(el, function (e, $prop) {
if (e) { return void logError(e); }
UI.alert($prop[0], undefined, true);
});
}
else if ($(this).hasClass("cp-app-drive-context-hashtag")) {
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
data = manager.getFileData(el);
if (!data) { return void console.error("Expected to find a file"); }
var href = data.href || data.roHref;
common.updateTags(href);
}
else if ($(this).hasClass("cp-app-drive-context-empty")) {
if (paths.length !== 1 || !paths[0].element
|| !manager.comparePath(paths[0].path, [TRASH])) {
log(Messages.fm_forbidden);
return;
}
UI.confirm(Messages.fm_emptyTrashDialog, function(res) {
if (!res) { return; }
manager.emptyTrash(refresh);
});
}
else if ($(this).hasClass("cp-app-drive-context-remove")) {
return void deletePaths(paths);
}
else if ($(this).hasClass("cp-app-drive-context-removesf")) {
return void deletePaths(paths);
}
else if ($(this).hasClass("cp-app-drive-context-restore")) {
if (paths.length !== 1) { return; }
var restorePath = paths[0].path;
var restoreName = paths[0].path[paths[0].path.length - 1];
if (restorePath.length === 4) {
var rEl = manager.find(restorePath);
if (manager.isFile(rEl)) {
restoreName = manager.getTitle(rEl);
} else {
restoreName = restorePath[1];
}
}
UI.confirm(Messages._getKey("fm_restoreDialog", [restoreName]), function(res) {
if (!res) { return; }
manager.restore(restorePath, refresh);
});
}
else if ($(this).hasClass("cp-app-drive-context-openparent")) {
if (paths.length !== 1) { return; }
var parentPath = paths[0].path.slice();
if (manager.isInTrashRoot(parentPath)) { parentPath = [TRASH]; }
else { parentPath.pop(); }
el = manager.find(paths[0].path);
APP.selectedFiles = [el];
APP.displayDirectory(parentPath);
}
APP.hideMenu();
});
// Chrome considers the double-click means "select all" in the window
$content.on('mousedown', function (e) {
$content.focus();
e.preventDefault();
});
$appContainer.on('mouseup', function (e) {
//if (sel.down) { return; }
if (e.which !== 1) { return ; }
APP.hideMenu(e);
//removeSelected(e);
});
$appContainer.on('click', function (e) {
if (e.which !== 1) { return ; }
removeInput();
});
$appContainer.on('drag drop', function (e) {
removeInput();
APP.hideMenu(e);
});
$appContainer.on('mouseup drop', function () {
$('.cp-app-drive-element-droppable').removeClass('cp-app-drive-element-droppable');
});
$appContainer.on('keydown', function (e) {
// "Del"
if (e.which === 46) {
if (manager.isPathIn(currentPath, [FILES_DATA]) && APP.loggedIn) {
return; // We can't remove elements directly from filesData
}
var $selected = $('.cp-app-drive-element-selected');
if (!$selected.length) { return; }
var paths = [];
var isTrash = manager.isPathIn(currentPath, [TRASH]);
$selected.each(function (idx, elmt) {
if (!$(elmt).data('path')) { return; }
paths.push($(elmt).data('path'));
});
if (!paths.length) { return; }
// Remove shared folders from the selection (they can't be moved to the trash)
// unless the selection is only shared folders
var paths2 = paths.filter(function (p) {
var el = manager.find(p);
return !manager.isSharedFolder(el);
});
// If we are in the trash or anon pad or if we are holding the "shift" key,
// delete permanently
// Or if we are in a shared folder
// Or if the selection is only shared folders
if (!APP.loggedIn || isTrash || manager.isInSharedFolder(currentPath)
|| e.shiftKey || !paths2.length) {
deletePaths(null, paths);
return;
}
// else move to trash
moveElements(paths2, [TRASH], false, refresh);
return;
}
});
var isCharacterKey = function (e) {
return e.which === "undefined" /* IE */ ||
(e.which > 0 && e.which !== 13 && e.which !== 27 && !e.ctrlKey && !e.altKey);
};
$appContainer.on('keypress', function (e) {
var $searchBar = $tree.find('#cp-app-drive-tree-search-input');
if ($searchBar.is(':focus')) { return; }
if (isCharacterKey(e)) {
$searchBar.focus();
e.preventDefault();
return;
}
});
$appContainer.contextmenu(function () {
APP.hideMenu();
return false;
});
var onRefresh = {
refresh: function() {
if (onRefresh.to) {
window.clearTimeout(onRefresh.to);
}
onRefresh.to = window.setTimeout(refresh, 500);
}
};
sframeChan.on('EV_DRIVE_CHANGE', function (data) {
if (history.isHistoryMode) { return; }
var path = data.path.slice();
var originalPath = data.path.slice();
if (!APP.loggedIn && APP.newSharedFolder && data.id === APP.newSharedFolder) {
// ANON_SHARED_FOLDER
return void onRefresh.refresh();
}
// Fix the path if this is about a shared folder
if (data.id && manager.folders[data.id]) {
var uoPath = manager.getUserObjectPath(manager.folders[data.id].userObject);
if (uoPath) {
Array.prototype.unshift.apply(path, uoPath);
path.unshift('drive');
}
}
if (path[0] !== 'drive') { return false; }
path = path.slice(1);
if (originalPath[0] === 'drive') { originalPath = originalPath.slice(1); }
var cPath = currentPath.slice();
if (originalPath.length && originalPath[0] === FILES_DATA) {
onRefresh.refresh();
} else if ((manager.isPathIn(cPath, ['hrefArray', TRASH]) && cPath[0] === path[0]) ||
(path.length >= cPath.length && manager.isSubpath(path, cPath))) {
// Reload after a few ms to make sure all the change events have been received
onRefresh.refresh();
} else {
APP.resetTree();
}
return false;
});
sframeChan.on('EV_DRIVE_REMOVE', function (data) {
if (history.isHistoryMode) { return; }
var path = data.path.slice();
if (!APP.loggedIn && APP.newSharedFolder && data.id === APP.newSharedFolder) {
// ANON_SHARED_FOLDER
return void onRefresh.refresh();
}
// Fix the path if this is about a shared folder
if (data.id && manager.folders[data.id]) {
var uoPath = manager.getUserObjectPath(manager.folders[data.id].userObject);
if (uoPath) {
Array.prototype.unshift.apply(path, uoPath);
path.unshift('drive');
}
}
if (path[0] !== 'drive') { return false; }
path = path.slice(1);
var cPath = currentPath.slice();
if ((manager.isPathIn(cPath, ['hrefArray', TRASH]) && cPath[0] === path[0]) ||
(path.length >= cPath.length && manager.isSubpath(path, cPath))) {
// Reload after a few to make sure all the change events have been received
onRefresh.refresh();
} else {
APP.resetTree();
}
return false;
});
history.onEnterHistory = function (obj) {
copyObjectValue(files, obj.drive);
appStatus.isReady = true;
refresh();
};
history.onLeaveHistory = function () {
copyObjectValue(files, proxy.drive);
refresh();
};
var fmConfig = {
noHandlers: true,
onUploaded: function () {
refresh();
},
body: $('body')
};
APP.FM = common.createFileManager(fmConfig);
refresh();
UI.removeLoadingScreen();
sframeChan.query('Q_DRIVE_GETDELETED', null, function (err, data) {
var ids = manager.findChannels(data);
var titles = [];
ids.forEach(function (id) {
var title = manager.getTitle(id);
titles.push(title);
var paths = manager.findFile(id);
manager.delete(paths, refresh);
});
if (!titles.length) { return; }
UI.log(Messages._getKey('fm_deletedPads', [titles.join(', ')]));
});
};
var setHistory = function (bool, update) {
history.isHistoryMode = bool;
setEditable(!bool);
if (!bool && update) {
history.onLeaveHistory();
}
};
var main = function () {
var common;
var proxy = {};
var folders = {};
var readOnly;
nThen(function (waitFor) {
$(waitFor(function () {
UI.addLoadingScreen();
}));
window.cryptpadStore.getAll(waitFor(function (val) {
APP.store = JSON.parse(JSON.stringify(val));
}));
SFCommon.create(waitFor(function (c) { APP.common = common = c; }));
}).nThen(function (waitFor) {
var privReady = Util.once(waitFor());
var metadataMgr = common.getMetadataMgr();
if (JSON.stringify(metadataMgr.getPrivateData()) !== '{}') {
privReady();
return;
}
metadataMgr.onChange(function () {
if (typeof(metadataMgr.getPrivateData().readOnly) === 'boolean') {
readOnly = APP.readOnly = metadataMgr.getPrivateData().readOnly;
privReady();
}
});
}).nThen(function (waitFor) {
APP.loggedIn = common.isLoggedIn();
APP.SFCommon = common;
if (!APP.loggedIn) { Feedback.send('ANONYMOUS_DRIVE'); }
APP.$body = $('body');
APP.$bar = $('#cp-toolbar');
common.setTabTitle(Messages.type.drive);
/*var listmapConfig = {
data: {},
common: common,
logging: false
};*/
var metadataMgr = common.getMetadataMgr();
var privateData = metadataMgr.getPrivateData();
if (privateData.newSharedFolder) {
APP.newSharedFolder = privateData.newSharedFolder;
}
var sframeChan = common.getSframeChannel();
updateObject(sframeChan, proxy, waitFor(function () {
updateSharedFolders(sframeChan, null, proxy.drive, folders, waitFor());
}));
}).nThen(function () {
var sframeChan = common.getSframeChannel();
var metadataMgr = common.getMetadataMgr();
var privateData = metadataMgr.getPrivateData();
APP.disableSF = !privateData.enableSF && AppConfig.disableSharedFolders;
if (APP.newSharedFolder && !APP.loggedIn) {
readOnly = APP.readOnly = true;
var data = folders[APP.newSharedFolder];
if (data) {
sframeChan.query('Q_SET_PAD_TITLE_IN_DRIVE', {
title: data.metadata && data.metadata.title,
}, function () {});
}
}
// ANON_SHARED_FOLDER
var pageTitle = (!APP.loggedIn && APP.newSharedFolder) ? SHARED_FOLDER_NAME : Messages.type.drive;
var configTb = {
displayed: ['useradmin', 'pageTitle', 'newpad', 'limit', 'notifications'],
pageTitle: pageTitle,
metadataMgr: metadataMgr,
readOnly: privateData.readOnly,
sfCommon: common,
$container: APP.$bar
};
var toolbar = APP.toolbar = Toolbar.create(configTb);
var $rightside = toolbar.$rightside;
$rightside.html(''); // Remove the drawer if we don't use it to hide the toolbar
APP.$displayName = APP.$bar.find('.' + Toolbar.constants.username);
/* add the usage */
if (APP.loggedIn) {
common.createUsageBar(function (err, $limitContainer) {
if (err) { return void logError(err); }
APP.$limit = $limitContainer;
}, true);
}
/* add a history button */
APP.histConfig = {
onLocal: function () {
UI.addLoadingScreen({ loadingText: Messages.fm_restoreDrive });
proxy.drive = history.currentObj.drive;
sframeChan.query("Q_DRIVE_RESTORE", history.currentObj.drive, function () {
UI.removeLoadingScreen();
}, {
timeout: 5 * 60 * 1000
});
},
onRemote: function () {},
setHistory: setHistory,
applyVal: function (val) {
var obj = JSON.parse(val || '{}');
history.currentObj = obj;
history.onEnterHistory(obj);
},
$toolbar: APP.$bar,
};
// Add a "Burn this drive" button
if (!APP.loggedIn) {
APP.$burnThisDrive = common.createButton(null, true).click(function () {
UI.confirm(Messages.fm_burnThisDrive, function (yes) {
if (!yes) { return; }
common.getSframeChannel().event('EV_BURN_ANON_DRIVE');
}, null, true);
}).attr('title', Messages.fm_burnThisDriveButton)
.removeClass('fa-question')
.addClass('fa-ban');
}
metadataMgr.onChange(function () {
var name = metadataMgr.getUserData().name || Messages.anonymous;
APP.$displayName.text(name);
});
$('body').css('display', '');
APP.files = proxy;
if (!proxy.drive || typeof(proxy.drive) !== 'object') {
throw new Error("Corrupted drive");
}
andThen(common, proxy, folders);
var onDisconnect = APP.onDisconnect = function (noAlert) {
setEditable(false);
if (APP.refresh) { APP.refresh(); }
APP.toolbar.failed();
if (!noAlert) { UI.alert(Messages.common_connectionLost, undefined, true); }
};
var onReconnect = function (info) {
setEditable(true);
if (APP.refresh) { APP.refresh(); }
APP.toolbar.reconnecting(info.myId);
UI.findOKButton().click();
};
sframeChan.on('EV_DRIVE_LOG', function (msg) {
UI.log(msg);
});
sframeChan.on('EV_NETWORK_DISCONNECT', function () {
onDisconnect();
});
sframeChan.on('EV_NETWORK_RECONNECT', function (data) {
// data.myId;
onReconnect(data);
});
common.onLogout(function () { setEditable(false); });
});
};
main();
});
| www/drive/inner.js | define([
'jquery',
'/common/toolbar3.js',
'json.sortify',
'/common/common-util.js',
'/common/common-hash.js',
'/common/common-ui-elements.js',
'/common/common-interface.js',
'/common/common-constants.js',
'/common/common-feedback.js',
'/bower_components/nthen/index.js',
'/common/sframe-common.js',
'/common/common-realtime.js',
'/common/hyperscript.js',
'/common/proxy-manager.js',
'/customize/application_config.js',
'/bower_components/chainpad-listmap/chainpad-listmap.js',
'/customize/messages.js',
'css!/bower_components/bootstrap/dist/css/bootstrap.min.css',
'css!/bower_components/components-font-awesome/css/font-awesome.min.css',
'less!/drive/app-drive.less',
], function (
$,
Toolbar,
JSONSortify,
Util,
Hash,
UIElements,
UI,
Constants,
Feedback,
nThen,
SFCommon,
CommonRealtime,
h,
ProxyManager,
AppConfig,
Listmap,
Messages)
{
var APP = window.APP = {
editable: false,
mobile: function () { return $('body').width() <= 600; }, // Menu and content area are not inline-block anymore for mobiles
isMac: navigator.platform === "MacIntel",
};
var stringify = function (obj) {
return JSONSortify(obj);
};
var E_OVER_LIMIT = 'E_OVER_LIMIT';
var ROOT = "root";
var ROOT_NAME = Messages.fm_rootName;
var SEARCH = "search";
var SEARCH_NAME = Messages.fm_searchName;
var TRASH = "trash";
var TRASH_NAME = Messages.fm_trashName;
var FILES_DATA = Constants.storageKey;
var FILES_DATA_NAME = Messages.fm_filesDataName;
var TEMPLATE = "template";
var TEMPLATE_NAME = Messages.fm_templateName;
var RECENT = "recent";
var RECENT_NAME = Messages.fm_recentPadsName;
var OWNED = "owned";
var OWNED_NAME = Messages.fm_ownedPadsName;
var TAGS = "tags";
var TAGS_NAME = Messages.fm_tagsName;
var SHARED_FOLDER = 'sf';
var SHARED_FOLDER_NAME = Messages.fm_sharedFolderName;
// Icons
var faFolder = 'cptools-folder';
var faFolderOpen = 'cptools-folder-open';
var faSharedFolder = 'cptools-shared-folder';
var faSharedFolderOpen = 'cptools-shared-folder-open';
var faShared = 'fa-shhare-alt';
var faReadOnly = 'fa-eye';
var faRename = 'fa-pencil';
var faTrash = 'fa-trash';
var faDelete = 'fa-eraser';
var faProperties = 'fa-database';
var faTags = 'fa-hashtag';
var faEmpty = 'fa-trash-o';
var faRestore = 'fa-repeat';
var faShowParent = 'fa-location-arrow';
var faDownload = 'cptools-file';
var $folderIcon = $('<span>', {
"class": faFolder + " cptools cp-app-drive-icon-folder cp-app-drive-content-icon"
});
//var $folderIcon = $('<img>', {src: "/customize/images/icons/folder.svg", "class": "folder icon"});
var $folderEmptyIcon = $folderIcon.clone();
var $folderOpenedIcon = $('<span>', {"class": faFolderOpen + " cptools cp-app-drive-icon-folder"});
//var $folderOpenedIcon = $('<img>', {src: "/customize/images/icons/folderOpen.svg", "class": "folder icon"});
var $folderOpenedEmptyIcon = $folderOpenedIcon.clone();
var $sharedFolderIcon = $('<span>', {"class": faSharedFolder + " cptools cp-app-drive-icon-folder"});
var $sharedFolderOpenedIcon = $('<span>', {"class": faSharedFolderOpen + " cptools cp-app-drive-icon-folder"});
//var $upIcon = $('<span>', {"class": "fa fa-arrow-circle-up"});
var $unsortedIcon = $('<span>', {"class": "fa fa-files-o"});
var $templateIcon = $('<span>', {"class": "cptools cptools-template"});
var $recentIcon = $('<span>', {"class": "fa fa-clock-o"});
var $trashIcon = $('<span>', {"class": "fa " + faTrash});
var $trashEmptyIcon = $('<span>', {"class": "fa fa-trash-o"});
//var $collapseIcon = $('<span>', {"class": "fa fa-minus-square-o cp-app-drive-icon-expcol"});
var $expandIcon = $('<span>', {"class": "fa fa-plus-square-o cp-app-drive-icon-expcol"});
var $emptyTrashIcon = $('<button>', {"class": "fa fa-ban"});
var $listIcon = $('<button>', {"class": "fa fa-list"});
var $gridIcon = $('<button>', {"class": "fa fa-th-large"});
var $sortAscIcon = $('<span>', {"class": "fa fa-angle-up sortasc"});
var $sortDescIcon = $('<span>', {"class": "fa fa-angle-down sortdesc"});
var $closeIcon = $('<span>', {"class": "fa fa-window-close"});
//var $backupIcon = $('<span>', {"class": "fa fa-life-ring"});
var $searchIcon = $('<span>', {"class": "fa fa-search cp-app-drive-tree-search-icon"});
var $addIcon = $('<span>', {"class": "fa fa-plus"});
var $renamedIcon = $('<span>', {"class": "fa fa-flag"});
var $readonlyIcon = $('<span>', {"class": "fa " + faReadOnly});
var $ownedIcon = $('<span>', {"class": "fa fa-id-card-o"});
var $sharedIcon = $('<span>', {"class": "fa " + faShared});
var $ownerIcon = $('<span>', {"class": "fa fa-id-card"});
var $tagsIcon = $('<span>', {"class": "fa " + faTags});
var $passwordIcon = $('<span>', {"class": "fa fa-lock"});
var $expirableIcon = $('<span>', {"class": "fa fa-clock-o"});
var LS_LAST = "app-drive-lastOpened";
var LS_OPENED = "app-drive-openedFolders";
var LS_VIEWMODE = "app-drive-viewMode";
var LS_SEARCHCURSOR = "app-drive-searchCursor";
var FOLDER_CONTENT_ID = "cp-app-drive-content-folder";
var config = {};
var DEBUG = config.DEBUG = false;
var debug = config.debug = DEBUG ? function () {
console.log.apply(console, arguments);
} : function () { return; };
var logError = config.logError = function () {
console.error.apply(console, arguments);
};
var log = config.log = UI.log;
var localStore = window.cryptpadStore;
APP.store = {};
var getLastOpenedFolder = function () {
var path;
try {
path = APP.store[LS_LAST] ? JSON.parse(APP.store[LS_LAST]) : [ROOT];
} catch (e) {
path = [ROOT];
}
return path;
};
var setLastOpenedFolder = function (path) {
if (path[0] === SEARCH) { return; }
APP.store[LS_LAST] = JSON.stringify(path);
localStore.put(LS_LAST, JSON.stringify(path));
};
var wasFolderOpened = function (path) {
var stored = JSON.parse(APP.store[LS_OPENED] || '[]');
return stored.indexOf(JSON.stringify(path)) !== -1;
};
var setFolderOpened = function (path, opened) {
var s = JSON.stringify(path);
var stored = JSON.parse(APP.store[LS_OPENED] || '[]');
if (opened && stored.indexOf(s) === -1) {
stored.push(s);
}
if (!opened) {
var idx = stored.indexOf(s);
if (idx !== -1) {
stored.splice(idx, 1);
}
}
APP.store[LS_OPENED] = JSON.stringify(stored);
localStore.put(LS_OPENED, JSON.stringify(stored));
};
var getViewModeClass = function () {
var mode = APP.store[LS_VIEWMODE];
if (mode === 'list') { return 'cp-app-drive-content-list'; }
return 'cp-app-drive-content-grid';
};
var getViewMode = function () {
return APP.store[LS_VIEWMODE] || 'grid';
};
var setViewMode = function (mode) {
if (typeof(mode) !== "string") {
logError("Incorrect view mode: ", mode);
return;
}
APP.store[LS_VIEWMODE] = mode;
localStore.put(LS_VIEWMODE, mode);
};
var setSearchCursor = function () {
var $input = $('#cp-app-drive-tree-search-input');
APP.store[LS_SEARCHCURSOR] = $input[0].selectionStart;
localStore.put(LS_SEARCHCURSOR, $input[0].selectionStart);
};
var getSearchCursor = function () {
return APP.store[LS_SEARCHCURSOR] || 0;
};
var setEditable = function (state) {
APP.editable = state;
if (!state) {
APP.$content.addClass('cp-app-drive-readonly');
$('[draggable="true"]').attr('draggable', false);
}
else {
APP.$content.removeClass('cp-app-drive-readonly');
$('[draggable="false"]').attr('draggable', true);
}
};
var history = {
isHistoryMode: false,
};
var copyObjectValue = function (objRef, objToCopy) {
for (var k in objRef) { delete objRef[k]; }
$.extend(true, objRef, objToCopy);
};
var updateSharedFolders = function (sframeChan, manager, drive, folders, cb) {
if (!drive || !drive.sharedFolders) {
return void cb();
}
var oldIds = Object.keys(folders);
nThen(function (waitFor) {
Object.keys(drive.sharedFolders).forEach(function (fId) {
sframeChan.query('Q_DRIVE_GETOBJECT', {
sharedFolder: fId
}, waitFor(function (err, newObj) {
folders[fId] = folders[fId] || {};
copyObjectValue(folders[fId], newObj);
if (manager && oldIds.indexOf(fId) === -1) {
manager.addProxy(fId, folders[fId]);
}
}));
});
}).nThen(function () {
cb();
});
};
var updateObject = function (sframeChan, obj, cb) {
sframeChan.query('Q_DRIVE_GETOBJECT', null, function (err, newObj) {
copyObjectValue(obj, newObj);
if (!APP.loggedIn && APP.newSharedFolder) {
obj.drive.sharedFolders = obj.drive.sharedFolders || {};
obj.drive.sharedFolders[APP.newSharedFolder] = {};
}
cb();
});
};
var createContextMenu = function () {
var menu = h('div.cp-contextmenu.dropdown.cp-unselectable', [
h('ul.dropdown-menu', {
'role': 'menu',
'aria-labelledby': 'dropdownMenu',
'style': 'display:block;position:static;margin-bottom:5px;'
}, [
h('li', h('a.cp-app-drive-context-open.dropdown-item', {
'tabindex': '-1',
'data-icon': faFolderOpen,
}, Messages.fc_open)),
h('li', h('a.cp-app-drive-context-openro.dropdown-item', {
'tabindex': '-1',
'data-icon': faReadOnly,
}, Messages.fc_open_ro)),
h('li', h('a.cp-app-drive-context-download.dropdown-item', {
'tabindex': '-1',
'data-icon': faDownload,
}, Messages.download_mt_button)),
h('li', h('a.cp-app-drive-context-share.dropdown-item', {
'tabindex': '-1',
'data-icon': 'fa-shhare-alt',
}, Messages.shareButton)),
h('li', h('a.cp-app-drive-context-openparent.dropdown-item', {
'tabindex': '-1',
'data-icon': faShowParent,
}, Messages.fm_openParent)),
h('li', h('a.cp-app-drive-context-newfolder.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faFolder,
}, Messages.fc_newfolder)),
h('li', h('a.cp-app-drive-context-newsharedfolder.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faSharedFolder,
}, Messages.fc_newsharedfolder)),
h('li', h('a.cp-app-drive-context-hashtag.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faTags,
}, Messages.fc_hashtag)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.pad,
'data-type': 'pad'
}, Messages.button_newpad)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.code,
'data-type': 'code'
}, Messages.button_newcode)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.slide,
'data-type': 'slide'
}, Messages.button_newslide)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.poll,
'data-type': 'poll'
}, Messages.button_newpoll)),
h('li', h('a.cp-app-drive-context-newdoc.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': AppConfig.applicationsIcon.whiteboard,
'data-type': 'whiteboard'
}, Messages.button_newwhiteboard)),
h('li', h('a.cp-app-drive-context-empty.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faEmpty,
}, Messages.fc_empty)),
h('li', h('a.cp-app-drive-context-restore.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faRestore,
}, Messages.fc_restore)),
h('li', h('a.cp-app-drive-context-rename.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faRename,
}, Messages.fc_rename)),
h('li', h('a.cp-app-drive-context-delete.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faTrash,
}, Messages.fc_delete)),
h('li', h('a.cp-app-drive-context-deleteowned.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faDelete,
}, Messages.fc_delete_owned)),
h('li', h('a.cp-app-drive-context-remove.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faDelete,
}, Messages.fc_remove)),
h('li', h('a.cp-app-drive-context-removesf.dropdown-item.cp-app-drive-context-editable', {
'tabindex': '-1',
'data-icon': faDelete,
}, Messages.fc_remove_sharedfolder)),
h('li', h('a.cp-app-drive-context-properties.dropdown-item', {
'tabindex': '-1',
'data-icon': faProperties,
}, Messages.fc_prop)),
])
]);
return $(menu);
};
var andThen = function (common, proxy, folders) {
var files = proxy.drive;
var metadataMgr = common.getMetadataMgr();
var sframeChan = common.getSframeChannel();
var priv = metadataMgr.getPrivateData();
var user = metadataMgr.getUserData();
var edPublic = priv.edPublic;
APP.origin = priv.origin;
config.loggedIn = APP.loggedIn;
config.sframeChan = sframeChan;
APP.hideDuplicateOwned = Util.find(priv, ['settings', 'drive', 'hideDuplicate']);
var manager = ProxyManager.createInner(files, sframeChan, edPublic, config);
Object.keys(folders).forEach(function (id) {
var f = folders[id];
manager.addProxy(id, f);
});
var $tree = APP.$tree = $("#cp-app-drive-tree");
var $content = APP.$content = $("#cp-app-drive-content");
var $appContainer = $(".cp-app-drive-container");
var $driveToolbar = $("#cp-app-drive-toolbar");
var $contextMenu = createContextMenu().appendTo($appContainer);
var $contentContextMenu = $("#cp-app-drive-context-content");
var $defaultContextMenu = $("#cp-app-drive-context-default");
var $trashTreeContextMenu = $("#cp-app-drive-context-trashtree");
var $trashContextMenu = $("#cp-app-drive-context-trash");
$tree.on('drop dragover', function (e) {
e.preventDefault();
e.stopPropagation();
});
$driveToolbar.on('drop dragover', function (e) {
e.preventDefault();
e.stopPropagation();
});
// TOOLBAR
/* add a "change username" button */
if (!APP.readOnly) {
APP.$displayName.text(user.name || Messages.anonymous);
}
// FILE MANAGER
var currentPath = APP.currentPath = getLastOpenedFolder();
if (APP.newSharedFolder) {
var newSFPaths = manager.findFile(APP.newSharedFolder);
if (newSFPaths.length) {
currentPath = newSFPaths[0];
}
}
// Categories dislayed in the menu
var displayedCategories = [ROOT, TRASH, SEARCH, RECENT];
// PCS enabled: display owned pads
if (AppConfig.displayCreationScreen) { displayedCategories.push(OWNED); }
// Templates enabled: display template category
if (AppConfig.enableTemplates) { displayedCategories.push(TEMPLATE); }
// Tags used: display Tags category
if (Object.keys(manager.getTagsList()).length) { displayedCategories.push(TAGS); }
var virtualCategories = [SEARCH, RECENT, OWNED, TAGS, SHARED_FOLDER];
if (!APP.loggedIn) {
$tree.hide();
if (APP.newSharedFolder) {
// ANON_SHARED_FOLDER
displayedCategories = [SHARED_FOLDER];
currentPath = [SHARED_FOLDER, ROOT];
} else {
displayedCategories = [FILES_DATA];
currentPath = [FILES_DATA];
if (Object.keys(files.root).length && !proxy.anonymousAlert) {
var msg = common.fixLinks($('<div>').html(Messages.fm_alert_anonymous));
UI.alert(msg);
proxy.anonymousAlert = true;
}
}
}
if (!APP.readOnly) {
setEditable(true);
}
var appStatus = {
isReady: true,
_onReady: [],
onReady: function (handler) {
if (appStatus.isReady) {
handler();
return;
}
appStatus._onReady.push(handler);
},
ready: function (state) {
appStatus.isReady = state;
if (state) {
appStatus._onReady.forEach(function (h) {
h();
});
appStatus._onReady = [];
}
}
};
var findDataHolder = function ($el) {
return $el.is('.cp-app-drive-element-row') ? $el : $el.closest('.cp-app-drive-element-row');
};
// Selection
var sel = {};
var removeSelected = function (keepObj) {
$('.cp-app-drive-element-selected').removeClass("cp-app-drive-element-selected");
var $container = $driveToolbar.find('#cp-app-drive-toolbar-contextbuttons');
if (!$container.length) { return; }
$container.html('');
if (!keepObj) {
delete sel.startSelected;
delete sel.endSelected;
delete sel.oldSelection;
}
};
sel.refresh = 200;
sel.$selectBox = $('<div>', {'class': 'cp-app-drive-content-select-box'}).appendTo($content);
var checkSelected = function () {
if (!sel.down) { return; }
var pos = sel.pos;
var l = $content[0].querySelectorAll('.cp-app-drive-element:not(.cp-app-drive-element-selected):not(.cp-app-drive-element-header)');
var p, el;
var offset = getViewMode() === "grid" ? 10 : 0;
for (var i = 0; i < l.length; i++) {
el = l[i];
p = $(el).position();
p.top += offset + $content.scrollTop();
p.left += offset;
p.bottom = p.top + $(el).outerHeight();
p.right = p.left + $(el).outerWidth();
if (p.right < pos.left || p.left > pos.right
|| p.top > pos.bottom || p.bottom < pos.top) {
$(el).removeClass('cp-app-drive-element-selected-tmp');
} else {
$(el).addClass('cp-app-drive-element-selected-tmp');
}
}
};
$content.on('mousedown', function (e) {
if (currentPath[0] === SEARCH) { return; }
if (e.which !== 1) { return; }
$content.focus();
sel.down = true;
if (!e.ctrlKey) { removeSelected(); }
var rect = e.currentTarget.getBoundingClientRect();
sel.startX = e.clientX - rect.left;
sel.startY = e.clientY - rect.top + $content.scrollTop();
sel.$selectBox.show().css({
left: sel.startX + 'px',
top: sel.startY + 'px',
width: '0px',
height: '0px'
});
APP.hideMenu(e);
if (sel.move) { return; }
sel.move = function (ev) {
var rectMove = ev.currentTarget.getBoundingClientRect(),
offX = ev.clientX - rectMove.left,
offY = ev.clientY - rectMove.top + $content.scrollTop();
var left = sel.startX,
top = sel.startY;
var width = offX - sel.startX;
if (width < 0) {
left = Math.max(0, offX);
var diffX = left-offX;
width = Math.abs(width) - diffX;
}
var height = offY - sel.startY;
if (height < 0) {
top = Math.max(0, offY);
var diffY = top-offY;
height = Math.abs(height) - diffY;
}
sel.$selectBox.css({
width: width + 'px',
left: left + 'px',
height: height + 'px',
top: top + 'px'
});
sel.pos = {
top: top,
left: left,
bottom: top + height,
right: left + width
};
var diffT = sel.update ? +new Date() - sel.update : sel.refresh;
if (diffT < sel.refresh) {
if (!sel.to) {
sel.to = window.setTimeout(function () {
sel.update = +new Date();
checkSelected();
sel.to = undefined;
}, (sel.refresh - diffT));
}
return;
}
sel.update = +new Date();
checkSelected();
};
$content.mousemove(sel.move);
});
$(window).on('mouseup', function (e) {
if (!sel.down) { return; }
if (e.which !== 1) { return; }
sel.down = false;
sel.$selectBox.hide();
$content.off('mousemove', sel.move);
delete sel.move;
$content.find('.cp-app-drive-element-selected-tmp')
.removeClass('cp-app-drive-element-selected-tmp')
.addClass('cp-app-drive-element-selected');
e.stopPropagation();
});
// Arrow keys to modify the selection
$(window).keydown(function (e) {
var $searchBar = $tree.find('#cp-app-drive-tree-search-input');
if (document.activeElement && document.activeElement.nodeName === 'INPUT') { return; }
if ($searchBar.is(':focus') && $searchBar.val()) { return; }
var $elements = $content.find('.cp-app-drive-element:not(.cp-app-drive-element-header)');
var ev = {};
if (e.ctrlKey) { ev.ctrlKey = true; }
if (e.shiftKey) { ev.shiftKey = true; }
// Enter
if (e.which === 13) {
var $allSelected = $content.find('.cp-app-drive-element.cp-app-drive-element-selected');
if ($allSelected.length === 1) {
// Open the folder or the file
$allSelected.dblclick();
return;
}
// If more than one, open only the files
var $select = $content.find('.cp-app-drive-element-file.cp-app-drive-element-selected');
$select.each(function (idx, el) {
$(el).dblclick();
});
return;
}
// Ctrl+A select all
if (e.which === 65 && (e.ctrlKey || (e.metaKey && APP.isMac))) {
$content.find('.cp-app-drive-element:not(.cp-app-drive-element-selected)')
.addClass('cp-app-drive-element-selected');
return;
}
// [Left, Up, Right, Down]
if ([37, 38, 39, 40].indexOf(e.which) === -1) { return; }
e.preventDefault();
var click = function (el) {
if (!el) { return; }
APP.onElementClick(ev, $(el));
};
var $selection = $content.find('.cp-app-drive-element.cp-app-drive-element-selected');
if ($selection.length === 0) { return void click($elements.first()[0]); }
var lastIndex = typeof sel.endSelected === "number" ? sel.endSelected :
typeof sel.startSelected === "number" ? sel.startSelected :
$elements.index($selection.last()[0]);
var length = $elements.length;
if (length === 0) { return; }
// List mode
if (getViewMode() === "list") {
if (e.which === 40) { click($elements.get(Math.min(lastIndex+1, length -1))); }
if (e.which === 38) { click($elements.get(Math.max(lastIndex-1, 0))); }
return;
}
// Icon mode
// Get the vertical and horizontal position of lastIndex
// Filter all the elements to get those in the same line/column
var pos = $($elements.get(0)).position();
var $line = $elements.filter(function (idx, el) {
return $(el).position().top === pos.top;
});
var cols = $line.length;
var lines = Math.ceil(length/cols);
var lastPos = {
l : Math.floor(lastIndex/cols),
c : lastIndex - Math.floor(lastIndex/cols)*cols
};
if (e.which === 37) {
if (lastPos.c === 0) { return; }
click($elements.get(Math.max(lastIndex-1, 0)));
return;
}
if (e.which === 38) {
if (lastPos.l === 0) { return; }
click($elements.get(Math.max(lastIndex-cols, 0)));
return;
}
if (e.which === 39) {
if (lastPos.c === cols-1) { return; }
click($elements.get(Math.min(lastIndex+1, length-1)));
return;
}
if (e.which === 40) {
if (lastPos.l === lines-1) { return; }
click($elements.get(Math.min(lastIndex+cols, length-1)));
return;
}
});
var removeInput = function (cancel) {
if (!cancel && $('.cp-app-drive-element-row > input').length === 1) {
var $input = $('.cp-app-drive-element-row > input');
manager.rename($input.data('path'), $input.val(), APP.refresh);
}
$('.cp-app-drive-element-row > input').remove();
$('.cp-app-drive-element-row > span:hidden').removeAttr('style');
};
var compareDays = function (date1, date2) {
var day1 = Date.UTC(date1.getFullYear(), date1.getMonth(), date1.getDate());
var day2 = Date.UTC(date2.getFullYear(), date2.getMonth(), date2.getDate());
var ms = Math.abs(day1-day2);
return Math.floor(ms/1000/60/60/24);
};
var getDate = function (sDate) {
if (!sDate) { return ''; }
var ret = sDate.toString();
try {
var date = new Date(sDate);
var today = new Date();
var diff = compareDays(date, today);
if (diff === 0) {
ret = date.toLocaleTimeString();
} else {
ret = date.toLocaleDateString();
}
} catch (e) {
console.error("Unable to format that string to a date with .toLocaleString", sDate, e);
}
return ret;
};
var openFile = function (el, href) {
if (!href) {
var data = manager.getFileData(el);
if (!data || (!data.href && !data.roHref)) {
return void logError("Missing data for the file", el, data);
}
href = data.href || data.roHref;
}
window.open(APP.origin + href);
};
var refresh = APP.refresh = function () {
APP.displayDirectory(currentPath);
};
var getFileNameExtension = function (name) {
var matched = /\.[^\. ]+$/.exec(name);
if (matched && matched.length) { return matched[matched.length -1]; }
return '';
};
// Replace a file/folder name by an input to change its value
var displayRenameInput = function ($element, path) {
// NOTE: setTimeout(f, 0) otherwise the "rename" button in the toolbar is not working
window.setTimeout(function () {
if (!APP.editable) { return; }
if (!path || path.length < 2) {
logError("Renaming a top level element (root, trash or filesData) is forbidden.");
return;
}
removeInput();
removeSelected();
var $name = $element.find('.cp-app-drive-element-name');
if (!$name.length) {
$name = $element.find('> .cp-app-drive-element');
}
$name.hide();
var el = manager.find(path);
var name = manager.isFile(el) ? manager.getTitle(el) : path[path.length - 1];
if (manager.isSharedFolder(el)) {
name = manager.getSharedFolderData(el).title;
}
var $input = $('<input>', {
placeholder: name,
value: name
}).data('path', path);
// Stop propagation on keydown to avoid issues with arrow keys
$input.on('keydown', function (e) { e.stopPropagation(); });
$input.on('keyup', function (e) {
e.stopPropagation();
if (e.which === 13) {
removeInput(true);
manager.rename(path, $input.val(), refresh);
return;
}
if (e.which === 27) {
removeInput(true);
}
}).on('keypress', function (e) { e.stopPropagation(); });
//$element.parent().append($input);
$name.after($input);
$input.focus();
var extension = getFileNameExtension(name);
var input = $input[0];
input.selectionStart = 0;
input.selectionEnd = name.length - extension.length;
// We don't want to open the file/folder when clicking on the input
$input.on('click dblclick', function (e) {
removeSelected();
e.stopPropagation();
});
// Remove the browser ability to drag text from the input to avoid
// triggering our drag/drop event handlers
$input.on('dragstart dragleave drag drop', function (e) {
e.preventDefault();
e.stopPropagation();
});
// Make the parent element non-draggable when selecting text in the field
// since it would remove the input
$input.on('mousedown', function (e) {
e.stopPropagation();
$input.parents('.cp-app-drive-element-row').attr("draggable", false);
});
$input.on('mouseup', function (e) {
e.stopPropagation();
$input.parents('.cp-app-drive-element-row').attr("draggable", true);
});
},0);
};
var filterContextMenu = function (type, paths) {
if (!paths || paths.length === 0) { logError('no paths'); }
$contextMenu.find('li').hide();
var show = [];
var filter;
if (type === "content") {
// Return true in filter to hide
filter = function ($el, className) {
if (className === 'newfolder') { return; }
if (className === 'newsharedfolder') {
// Hide the new shared folder menu if we're already in a shared folder
return manager.isInSharedFolder(currentPath) || APP.disableSF;
}
return AppConfig.availablePadTypes.indexOf($el.attr('data-type')) === -1;
};
} else {
// In case of multiple selection, we must hide the option if at least one element
// is not compatible
var containsFolder = false;
var hide = [];
paths.forEach(function (p) {
var path = p.path;
var $element = p.element;
if (path.length === 1) {
// Can't rename or delete root elements
hide.push('delete');
hide.push('rename');
}
if (!$element.is('.cp-app-drive-element-owned')) {
hide.push('deleteowned');
}
if ($element.is('.cp-app-drive-element-notrash')) {
// We can't delete elements in virtual categories
hide.push('delete');
} else {
// We can only open parent in virtual categories
hide.push('openparent');
}
if (!$element.is('.cp-border-color-file')) {
hide.push('download');
}
if ($element.is('.cp-app-drive-element-file')) {
// No folder in files
hide.push('newfolder');
if ($element.is('.cp-app-drive-element-readonly')) {
hide.push('open'); // Remove open 'edit' mode
} else if ($element.is('.cp-app-drive-element-noreadonly')) {
hide.push('openro'); // Remove open 'view' mode
}
} else if ($element.is('.cp-app-drive-element-sharedf')) {
if (containsFolder) {
// More than 1 folder selected: cannot create a new subfolder
hide.push('newfolder');
}
containsFolder = true;
hide.push('openro');
hide.push('hashtag');
hide.push('delete');
//hide.push('deleteowned');
} else { // it's a folder
if (containsFolder) {
// More than 1 folder selected: cannot create a new subfolder
hide.push('newfolder');
}
containsFolder = true;
hide.push('openro');
hide.push('properties');
hide.push('share');
hide.push('hashtag');
}
// If we're in the trash, hide restore and properties for non-root elements
if (type === "trash" && path && path.length > 4) {
hide.push('restore');
hide.push('properties');
}
// If we're not in the trash nor in a shared folder, hide "remove"
if (!manager.isInSharedFolder(path)
&& !$element.is('.cp-app-drive-element-sharedf')) {
hide.push('removesf');
} else if (type === "tree") {
hide.push('delete');
// Don't hide the deleteowned link if the element is a shared folder and
// it is owned
if (manager.isInSharedFolder(path) ||
!$element.is('.cp-app-drive-element-owned')) {
hide.push('deleteowned');
} else {
// This is a shared folder and it is owned
hide.push('removesf');
}
}
});
if (paths.length > 1) {
hide.push('restore');
hide.push('properties');
hide.push('rename');
hide.push('openparent');
hide.push('hashtag');
hide.push('download');
}
if (containsFolder && paths.length > 1) {
// Cannot open multiple folders
hide.push('open');
}
filter = function ($el, className) {
if (hide.indexOf(className) !== -1) { return true; }
};
}
switch(type) {
case 'content':
show = ['newfolder', 'newsharedfolder', 'newdoc'];
break;
case 'tree':
show = ['open', 'openro', 'download', 'share', 'rename', 'delete', 'deleteowned', 'removesf',
'newfolder', 'properties', 'hashtag'];
break;
case 'default':
show = ['open', 'openro', 'share', 'openparent', 'delete', 'deleteowned', 'properties', 'hashtag'];
break;
case 'trashtree': {
show = ['empty'];
break;
}
case 'trash': {
show = ['remove', 'restore', 'properties'];
}
}
var filtered = [];
show.forEach(function (className) {
var $el = $contextMenu.find('.cp-app-drive-context-' + className);
if (!APP.editable && $el.is('.cp-app-drive-context-editable')) { return; }
if (filter($el, className)) { return; }
$el.parent('li').show();
filtered.push('.cp-app-drive-context-' + className);
});
return filtered;
};
var getSelectedPaths = function ($element) {
var paths = [];
if ($('.cp-app-drive-element-selected').length > 1) {
var $selected = $('.cp-app-drive-element-selected');
$selected.each(function (idx, elmt) {
var ePath = $(elmt).data('path');
if (ePath) {
paths.push({
path: ePath,
element: $(elmt)
});
}
});
}
if (!paths.length) {
var path = $element.data('path');
if (!path) { return false; }
paths.push({
path: path,
element: $element
});
}
return paths;
};
var updateContextButton = function () {
if (manager.isPathIn(currentPath, [TRASH])) {
$driveToolbar.find('cp-app-drive-toolbar-emptytrash').show();
} else {
$driveToolbar.find('cp-app-drive-toolbar-emptytrash').hide();
}
var $li = $content.find('.cp-app-drive-element-selected');
if ($li.length === 0) {
$li = findDataHolder($tree.find('.cp-app-drive-element-active'));
}
var $button = $driveToolbar.find('#cp-app-drive-toolbar-context-mobile');
if ($button.length) { // mobile
if ($li.length !== 1
|| !$._data($li[0], 'events').contextmenu
|| $._data($li[0], 'events').contextmenu.length === 0) {
$button.hide();
return;
}
$button.show();
$button.css({
background: '#000'
});
window.setTimeout(function () {
$button.css({
background: ''
});
}, 500);
return;
}
// Non mobile
var $container = $driveToolbar.find('#cp-app-drive-toolbar-contextbuttons');
if (!$container.length) { return; }
$container.html('');
var $element = $li.length === 1 ? $li : $($li[0]);
var paths = getSelectedPaths($element);
var menuType = $element.data('context');
if (!menuType) { return; }
//var actions = [];
var toShow = filterContextMenu(menuType, paths);
var $actions = $contextMenu.find('a');
$contextMenu.data('paths', paths);
$actions = $actions.filter(function (i, el) {
return toShow.some(function (className) { return $(el).is(className); });
});
$actions.each(function (i, el) {
var $a = $('<button>', {'class': 'cp-app-drive-element'});
if ($(el).attr('data-icon')) {
var font = $(el).attr('data-icon').indexOf('cptools') === 0 ? 'cptools' : 'fa';
$a.addClass(font).addClass($(el).attr('data-icon'));
$a.attr('title', $(el).text());
} else {
$a.text($(el).text());
}
$container.append($a);
$a.click(function() { $(el).click(); });
});
};
var scrollTo = function ($element) {
// Current scroll position
var st = $content.scrollTop();
// Block height
var h = $content.height();
// Current top position of the element relative to the scroll position
var pos = Math.round($element.offset().top - $content.position().top);
// Element height
var eh = $element.outerHeight();
// New scroll value
var v = st + pos + eh - h;
// If the element is completely visile, don't change the scroll position
if (pos+eh <= h && pos >= 0) { return; }
$content.scrollTop(v);
};
// Add the "selected" class to the "li" corresponding to the clicked element
var onElementClick = APP.onElementClick = function (e, $element) {
// If "Ctrl" is pressed, do not remove the current selection
removeInput();
$element = findDataHolder($element);
// If we're selecting a new element with the left click, hide the menu
if (e) { APP.hideMenu(); }
// Remove the selection if we don't hold ctrl key or if we are right-clicking
if (!e || !e.ctrlKey) {
removeSelected(e && e.shiftKey);
}
if (!$element.length) {
log(Messages.fm_selectError);
return;
}
scrollTo($element);
// Add the selected class to the clicked / right-clicked element
// Remove the class if it already has it
// If ctrlKey, add to the selection
// If shiftKey, select a range of elements
var $elements = $content.find('.cp-app-drive-element:not(.cp-app-drive-element-header)');
var $selection = $elements.filter('.cp-app-drive-element-selected');
if (typeof sel.startSelected !== "number" || !e || (e.ctrlKey && !e.shiftKey)) {
sel.startSelected = $elements.index($element[0]);
sel.oldSelection = [];
$selection.each(function (idx, el) {
sel.oldSelection.push(el);
});
delete sel.endSelected;
}
if (e && e.shiftKey) {
var end = $elements.index($element[0]);
sel.endSelected = end;
var $el;
removeSelected(true);
sel.oldSelection.forEach(function (el) {
if (!$(el).hasClass("cp-app-drive-element-selected")) {
$(el).addClass("cp-app-drive-element-selected");
}
});
for (var i = Math.min(sel.startSelected, sel.endSelected);
i <= Math.max(sel.startSelected, sel.endSelected);
i++) {
$el = $($elements.get(i));
if (!$el.hasClass("cp-app-drive-element-selected")) {
$el.addClass("cp-app-drive-element-selected");
}
}
} else {
if (!$element.hasClass("cp-app-drive-element-selected")) {
$element.addClass("cp-app-drive-element-selected");
} else {
$element.removeClass("cp-app-drive-element-selected");
}
}
updateContextButton();
};
var displayMenu = function (e) {
var $menu = $contextMenu;
$menu.css({ display: "block" });
if (APP.mobile()) { return; }
var h = $menu.outerHeight();
var w = $menu.outerWidth();
var wH = window.innerHeight;
var wW = window.innerWidth;
if (h > wH) {
$menu.css({
top: '0px',
bottom: ''
});
} else if (e.pageY + h <= wH) {
$menu.css({
top: e.pageY+'px',
bottom: ''
});
} else {
$menu.css({
bottom: '0px',
top: ''
});
}
if(w > wW) {
$menu.css({
left: '0px',
right: ''
});
} else if (e.pageX + w <= wW) {
$menu.css({
left: e.pageX+'px',
right: ''
});
} else {
$menu.css({
left: '',
right: '0px',
});
}
};
// Open the selected context menu on the closest "li" element
var openContextMenu = function (type) {
return function (e) {
APP.hideMenu();
e.stopPropagation();
var paths;
if (type === 'content') {
paths = [{path: $(e.target).closest('#' + FOLDER_CONTENT_ID).data('path')}];
if (!paths) { return; }
removeSelected();
} else {
var $element = findDataHolder($(e.target));
if (type === 'trash' && !$element.data('path')) { return; }
if (!$element.length) {
logError("Unable to locate the .element tag", e.target);
log(Messages.fm_contextMenuError);
return false;
}
if (!$element.hasClass('cp-app-drive-element-selected')) {
onElementClick(undefined, $element);
}
paths = getSelectedPaths($element);
}
$contextMenu.attr('data-menu-type', type);
filterContextMenu(type, paths);
displayMenu(e);
if ($contextMenu.find('li:visible').length === 0) {
debug("No visible element in the context menu. Abort.");
$contextMenu.hide();
return true;
}
$contextMenu.data('paths', paths);
return false;
};
};
var getElementName = function (path) {
var file = manager.find(path);
if (!file) { return; }
if (manager.isSharedFolder(file)) {
return manager.getSharedFolderData(file).title;
}
return manager.getTitle(file);
};
// moveElements is able to move several paths to a new location
var moveElements = function (paths, newPath, copy, cb) {
if (!APP.editable) { return; }
// Cancel drag&drop from TRASH to TRASH
if (manager.isPathIn(newPath, [TRASH]) && paths.length && paths[0][0] === TRASH) {
return;
}
manager.move(paths, newPath, cb, copy);
};
// Delete paths from the drive and/or shared folders (without moving them to the trash)
var deletePaths = function (paths, pathsList) {
pathsList = pathsList || [];
if (paths) {
paths.forEach(function (p) { pathsList.push(p.path); });
}
var hasOwned = pathsList.some(function (p) {
// NOTE: Owned pads in shared folders won't be removed from the server
// so we don't have to check, we can use the default message
if (manager.isInSharedFolder(p)) { return false; }
var el = manager.find(p);
var data = manager.isSharedFolder(el) ? manager.getSharedFolderData(el)
: manager.getFileData(el);
return data.owners && data.owners.indexOf(edPublic) !== -1;
});
var msg = Messages._getKey("fm_removeSeveralPermanentlyDialog", [pathsList.length]);
if (pathsList.length === 1) {
msg = hasOwned ? Messages.fm_deleteOwnedPad : Messages.fm_removePermanentlyDialog;
} else if (hasOwned) {
msg = msg + '<br><em>' + Messages.fm_removePermanentlyNote + '</em>';
}
UI.confirm(msg, function(res) {
$(window).focus();
if (!res) { return; }
manager.delete(pathsList, refresh);
}, null, true);
};
// Drag & drop:
// The data transferred is a stringified JSON containing the path of the dragged element
var onDrag = function (ev, path) {
var paths = [];
var $element = findDataHolder($(ev.target));
if ($element.hasClass('cp-app-drive-element-selected')) {
var $selected = $('.cp-app-drive-element-selected');
$selected.each(function (idx, elmt) {
var ePath = $(elmt).data('path');
if (ePath) {
var val = manager.find(ePath);
if (!val) { return; } // Error? A ".selected" element is not in the object
paths.push({
path: ePath,
value: {
name: getElementName(ePath),
el: val
}
});
}
});
} else {
removeSelected();
$element.addClass('cp-app-drive-element-selected');
var val = manager.find(path);
if (!val) { return; } // The element is not in the object
paths = [{
path: path,
value: {
name: getElementName(path),
el: val
}
}];
}
var data = {
'path': paths
};
ev.dataTransfer.setData("text", stringify(data));
};
var findDropPath = function (target) {
var $target = $(target);
var $el = findDataHolder($target);
var newPath = $el.data('path');
var dropEl = newPath && manager.find(newPath);
if (newPath && manager.isSharedFolder(dropEl)) {
newPath.push(manager.user.userObject.ROOT);
} else if ((!newPath || manager.isFile(dropEl))
&& $target.parents('#cp-app-drive-content')) {
newPath = currentPath;
}
return newPath;
};
var onFileDrop = APP.onFileDrop = function (file, e) {
var ev = {
target: e.target,
path: findDropPath(e.target)
};
APP.FM.onFileDrop(file, ev);
};
var onDrop = function (ev) {
ev.preventDefault();
$('.cp-app-drive-element-droppable').removeClass('cp-app-drive-element-droppable');
var data = ev.dataTransfer.getData("text");
// Don't use the normal drop handler for file upload
var fileDrop = ev.dataTransfer.files;
if (fileDrop.length) { return void onFileDrop(fileDrop, ev); }
var oldPaths = JSON.parse(data).path;
if (!oldPaths) { return; }
// A moved element should be removed from its previous location
var movedPaths = [];
var sharedF = false;
oldPaths.forEach(function (p) {
movedPaths.push(p.path);
if (!sharedF && manager.isInSharedFolder(p.path)) {
sharedF = true;
}
});
var newPath = findDropPath(ev.target);
if (!newPath) { return; }
if (sharedF && manager.isPathIn(newPath, [TRASH])) {
return void deletePaths(null, movedPaths);
}
var copy = false;
if (manager.isPathIn(newPath, [TRASH])) {
// Filter the selection to remove shared folders.
// Shared folders can't be moved to the trash!
var filteredPaths = movedPaths.filter(function (p) {
var el = manager.find(p);
return !manager.isSharedFolder(el);
});
if (!filteredPaths.length) {
// We only have shared folder, delete them
return void deletePaths(null, movedPaths);
}
movedPaths = filteredPaths;
} else if (ev.ctrlKey || (ev.metaKey && APP.isMac)) {
copy = true;
}
if (movedPaths && movedPaths.length) {
moveElements(movedPaths, newPath, copy, refresh);
}
};
var addDragAndDropHandlers = function ($element, path, isFolder, droppable) {
if (!APP.editable) { return; }
// "dragenter" is fired for an element and all its children
// "dragleave" may be fired when entering a child
// --> we use pointer-events: none in CSS, but we still need a counter to avoid some issues
// --> We store the number of enter/leave and the element entered and we remove the
// highlighting only when we have left everything
var counter = 0;
$element.on('dragstart', function (e) {
e.stopPropagation();
counter = 0;
onDrag(e.originalEvent, path);
});
$element.on('mousedown', function (e) {
e.stopPropagation();
});
// Add drop handlers if we are not in the trash and if the element is a folder
if (!droppable || !isFolder) { return; }
$element.on('dragover', function (e) {
e.preventDefault();
});
$element.on('drop', function (e) {
e.preventDefault();
e.stopPropagation();
onDrop(e.originalEvent);
});
$element.on('dragenter', function (e) {
e.preventDefault();
e.stopPropagation();
counter++;
$element.addClass('cp-app-drive-element-droppable');
});
$element.on('dragleave', function (e) {
e.preventDefault();
e.stopPropagation();
counter--;
if (counter <= 0) {
counter = 0;
$element.removeClass('cp-app-drive-element-droppable');
}
});
};
addDragAndDropHandlers($content, null, true, true);
// In list mode, display metadata from the filesData object
var _addOwnership = function ($span, $state, data) {
if (data.owners && data.owners.indexOf(edPublic) !== -1) {
var $owned = $ownedIcon.clone().appendTo($state);
$owned.attr('title', Messages.fm_padIsOwned);
$span.addClass('cp-app-drive-element-owned');
} else if (data.owners && data.owners.length) {
var $owner = $ownerIcon.clone().appendTo($state);
$owner.attr('title', Messages.fm_padIsOwnedOther);
}
};
var addFileData = function (element, $span) {
if (!manager.isFile(element)) { return; }
var data = manager.getFileData(element);
var href = data.href || data.roHref;
if (!data) { return void logError("No data for the file", element); }
var hrefData = Hash.parsePadUrl(href);
if (hrefData.type) {
$span.addClass('cp-border-color-'+hrefData.type);
}
var $state = $('<span>', {'class': 'cp-app-drive-element-state'});
if (hrefData.hashData && hrefData.hashData.mode === 'view') {
var $ro = $readonlyIcon.clone().appendTo($state);
$ro.attr('title', Messages.readonly);
}
if (data.filename && data.filename !== data.title) {
var $renamed = $renamedIcon.clone().appendTo($state);
$renamed.attr('title', Messages._getKey('fm_renamedPad', [data.title]));
}
if (hrefData.hashData && hrefData.hashData.password) {
var $password = $passwordIcon.clone().appendTo($state);
$password.attr('title', Messages.fm_passwordProtected || '');
}
if (data.expire) {
var $expire = $expirableIcon.clone().appendTo($state);
$expire.attr('title', Messages._getKey('fm_expirablePad', [new Date(data.expire).toLocaleString()]));
}
_addOwnership($span, $state, data);
var name = manager.getTitle(element);
// The element with the class '.name' is underlined when the 'li' is hovered
var $name = $('<span>', {'class': 'cp-app-drive-element-name'}).text(name);
$span.append($name);
$span.append($state);
$span.attr('title', name);
var type = Messages.type[hrefData.type] || hrefData.type;
common.displayThumbnail(href || data.roHref, data.channel, data.password, $span, function ($thumb) {
// Called only if the thumbnail exists
// Remove the .hide() added by displayThumnail() because it hides the icon in
// list mode too
$span.find('.cp-icon').removeAttr('style').addClass('cp-app-drive-element-list');
$thumb.addClass('cp-app-drive-element-grid')
.addClass('cp-app-drive-element-thumbnail');
});
var $type = $('<span>', {
'class': 'cp-app-drive-element-type cp-app-drive-element-list'
}).text(type);
var $adate = $('<span>', {
'class': 'cp-app-drive-element-atime cp-app-drive-element-list'
}).text(getDate(data.atime));
var $cdate = $('<span>', {
'class': 'cp-app-drive-element-ctime cp-app-drive-element-list'
}).text(getDate(data.ctime));
$span.append($type).append($adate).append($cdate);
};
var addFolderData = function (element, key, $span) {
if (!element || !manager.isFolder(element)) { return; }
// The element with the class '.name' is underlined when the 'li' is hovered
var $state = $('<span>', {'class': 'cp-app-drive-element-state'});
if (manager.isSharedFolder(element)) {
var data = manager.getSharedFolderData(element);
key = data && data.title ? data.title : key;
element = manager.folders[element].proxy[manager.user.userObject.ROOT];
$span.addClass('cp-app-drive-element-sharedf');
_addOwnership($span, $state, data);
var $shared = $sharedIcon.clone().appendTo($state);
$shared.attr('title', Messages.fm_canBeShared);
}
var sf = manager.hasSubfolder(element);
var files = manager.hasFile(element);
var $name = $('<span>', {'class': 'cp-app-drive-element-name'}).text(key);
var $subfolders = $('<span>', {
'class': 'cp-app-drive-element-folders cp-app-drive-element-list'
}).text(sf);
var $files = $('<span>', {
'class': 'cp-app-drive-element-files cp-app-drive-element-list'
}).text(files);
$span.attr('title', key);
$span.append($name).append($state).append($subfolders).append($files);
};
// This is duplicated in cryptpad-common, it should be unified
var getFileIcon = function (id) {
var data = manager.getFileData(id);
return UI.getFileIcon(data);
};
var getIcon = UI.getIcon;
// Create the "li" element corresponding to the file/folder located in "path"
var createElement = function (path, elPath, root, isFolder) {
// Forbid drag&drop inside the trash
var isTrash = path[0] === TRASH;
var newPath = path.slice();
var key;
var element;
if (isTrash && Array.isArray(elPath)) {
key = elPath[0];
elPath.forEach(function (k) { newPath.push(k); });
element = manager.find(newPath);
} else {
key = elPath;
newPath.push(key);
element = root[key];
}
var isSharedFolder = manager.isSharedFolder(element);
var $icon = !isFolder ? getFileIcon(element) : undefined;
var ro = manager.isReadOnlyFile(element);
// ro undefined means it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ?' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var liClass = 'cp-app-drive-element-file cp-app-drive-element' + roClass;
if (isSharedFolder) {
liClass = 'cp-app-drive-element-folder cp-app-drive-element';
$icon = $sharedFolderIcon.clone();
} else if (isFolder) {
liClass = 'cp-app-drive-element-folder cp-app-drive-element';
$icon = manager.isFolderEmpty(root[key]) ? $folderEmptyIcon.clone() : $folderIcon.clone();
}
var $element = $('<li>', {
draggable: true,
'class': 'cp-app-drive-element-row'
});
if (!isFolder && Array.isArray(APP.selectedFiles)) {
var idx = APP.selectedFiles.indexOf(element);
if (idx !== -1) {
$element.addClass('cp-app-drive-element-selected');
APP.selectedFiles.splice(idx, 1);
}
}
$element.prepend($icon).dblclick(function () {
if (isFolder) {
APP.displayDirectory(newPath);
return;
}
if (isTrash) { return; }
openFile(root[key]);
});
if (isFolder) {
addFolderData(element, key, $element);
} else {
addFileData(element, $element);
}
$element.addClass(liClass);
$element.data('path', newPath);
addDragAndDropHandlers($element, newPath, isFolder, !isTrash);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element, newPath);
});
if (!isTrash) {
$element.contextmenu(openContextMenu('tree'));
$element.data('context', 'tree');
} else {
$element.contextmenu(openContextMenu('trash'));
$element.data('context', 'trash');
}
var isNewFolder = APP.newFolder && manager.comparePath(newPath, APP.newFolder);
if (isNewFolder) {
appStatus.onReady(function () {
window.setTimeout(function () { displayRenameInput($element, newPath); }, 0);
});
delete APP.newFolder;
}
return $element;
};
// Display the full path in the title when displaying a directory from the trash
/*
var getTrashTitle = function (path) {
if (!path[0] || path[0] !== TRASH) { return; }
var title = TRASH_NAME;
for (var i=1; i<path.length; i++) {
if (i === 3 && path[i] === 'element') {}
else if (i === 2 && parseInt(path[i]) === path[i]) {
if (path[i] !== 0) {
title += " [" + path[i] + "]";
}
} else {
title += " / " + path[i];
}
}
return title;
}; */
var drivePathOverflowing = function () {
var $container = $(".cp-app-drive-path");
if ($container.length) {
$container.css("overflow", "hidden");
var overflown = $container[0].scrollWidth > $container[0].clientWidth;
$container.css("overflow", "");
return overflown;
}
};
var collapseDrivePath = function () {
var $container = $(".cp-app-drive-path-inner");
var $spanCollapse = $(".cp-app-drive-path-collapse");
$spanCollapse.css("display", "none");
var $pathElements = $container.find(".cp-app-drive-path-element");
$pathElements.not($spanCollapse).css("display", "");
if (drivePathOverflowing()) {
var collapseLevel = 0;
var removeOverflowElement = function () {
if (drivePathOverflowing()) {
if ($pathElements.length === 3) {
return false;
}
collapseLevel++;
if ($($pathElements.get(-2)).is(".cp-app-drive-path-separator")) {
$($pathElements.get(-2)).css("display", "none");
$pathElements = $pathElements.not($pathElements.get(-2));
}
$($pathElements.get(-2)).css("display", "none");
$pathElements = $pathElements.not($pathElements.get(-2));
return true;
}
};
while (removeOverflowElement()) {}
$spanCollapse.css("display", "");
removeOverflowElement();
$spanCollapse.attr("title", getLastOpenedFolder().slice(0, collapseLevel).join(" / ").replace("root", ROOT_NAME));
$spanCollapse[0].onclick = function () {
APP.displayDirectory(getLastOpenedFolder().slice(0, collapseLevel));
};
}
};
window.addEventListener("resize", collapseDrivePath);
var treeResizeObserver = new MutationObserver(collapseDrivePath);
treeResizeObserver.observe($("#cp-app-drive-tree")[0], {"attributes": true});
var toolbarButtonAdditionObserver = new MutationObserver(collapseDrivePath);
$(function () { toolbarButtonAdditionObserver.observe($("#cp-app-drive-toolbar")[0], {"childList": true, "subtree": true}); });
var getPrettyName = function (name) {
var pName;
switch (name) {
case ROOT: pName = ROOT_NAME; break;
case TRASH: pName = TRASH_NAME; break;
case TEMPLATE: pName = TEMPLATE_NAME; break;
case FILES_DATA: pName = FILES_DATA_NAME; break;
case SEARCH: pName = SEARCH_NAME; break;
case RECENT: pName = RECENT_NAME; break;
case OWNED: pName = OWNED_NAME; break;
case TAGS: pName = TAGS_NAME; break;
case SHARED_FOLDER: pName = SHARED_FOLDER_NAME; break;
default: pName = name;
}
return pName;
};
// Create the title block with the "parent folder" button
var createTitle = function ($container, path, noStyle) {
if (!path || path.length === 0) { return; }
var isTrash = manager.isPathIn(path, [TRASH]);
if (APP.mobile() && !noStyle) { // noStyle means title in search result
return $container;
}
var isVirtual = virtualCategories.indexOf(path[0]) !== -1;
var el = isVirtual ? undefined : manager.find(path);
path = path[0] === SEARCH ? path.slice(0,1) : path;
var $inner = $('<div>', {'class': 'cp-app-drive-path-inner'});
$container.prepend($inner);
var skipNext = false; // When encountering a shared folder, skip a key in the path
path.forEach(function (p, idx) {
if (skipNext) { skipNext = false; return; }
if (isTrash && [2,3].indexOf(idx) !== -1) { return; }
var name = p;
var currentEl = isVirtual ? undefined : manager.find(path.slice(0, idx+1));
if (p === SHARED_FOLDER || (currentEl && manager.isSharedFolder(currentEl))) {
name = manager.getSharedFolderData(currentEl || APP.newSharedFolder).title;
skipNext = true;
}
var $span = $('<span>', {'class': 'cp-app-drive-path-element'});
if (idx < path.length - 1) {
if (!noStyle) {
$span.addClass('cp-app-drive-path-clickable');
$span.click(function () {
var sliceEnd = idx + 1;
if (isTrash && idx === 1) { sliceEnd = 4; } // Make sure we don't show the index or 'element' and 'path'
APP.displayDirectory(path.slice(0, sliceEnd));
});
}
} else if (idx > 0 && manager.isFile(el)) {
name = getElementName(path);
}
if (idx === 0) { name = p === SHARED_FOLDER ? name : getPrettyName(p); }
else {
var $span2 = $('<span>', {
'class': 'cp-app-drive-path-element cp-app-drive-path-separator'
}).text(' / ');
$inner.prepend($span2);
}
$span.text(name).prependTo($inner);
});
var $spanCollapse = $('<span>', {
'class': 'cp-app-drive-path-element cp-app-drive-path-collapse'
}).text(' ... ');
$inner.append($spanCollapse);
collapseDrivePath();
};
var createInfoBox = function (path) {
var $box = $('<div>', {'class': 'cp-app-drive-content-info-box'});
var msg;
switch (path[0]) {
case ROOT:
msg = Messages.fm_info_root;
break;
case TEMPLATE:
msg = Messages.fm_info_template;
break;
case TRASH:
msg = Messages.fm_info_trash;
break;
case FILES_DATA:
msg = Messages.fm_info_allFiles;
break;
case RECENT:
msg = Messages.fm_info_recent;
break;
case OWNED:
msg = Messages.fm_info_owned;
break;
case TAGS:
break;
default:
msg = undefined;
}
if (!APP.loggedIn) {
msg = APP.newSharedFolder ? Messages.fm_info_sharedFolder : Messages.fm_info_anonymous;
return $(common.fixLinks($box.html(msg)));
}
if (!msg || APP.store['hide-info-' + path[0]] === '1') {
$box.hide();
} else {
$box.text(msg);
var $close = $closeIcon.clone().css({
'cursor': 'pointer',
'margin-left': '10px',
title: Messages.fm_closeInfoBox
}).on('click', function () {
$box.hide();
APP.store['hide-info-' + path[0]] = '1';
localStore.put('hide-info-' + path[0], '1');
});
$box.prepend($close);
}
return $box;
};
// Create the button allowing the user to switch from list to icons modes
var createViewModeButton = function ($container) {
var $listButton = $listIcon.clone();
var $gridButton = $gridIcon.clone();
$listButton.click(function () {
$gridButton.removeClass('cp-app-drive-toolbar-active');
$listButton.addClass('cp-app-drive-toolbar-active');
setViewMode('list');
$('#' + FOLDER_CONTENT_ID).removeClass('cp-app-drive-content-grid');
$('#' + FOLDER_CONTENT_ID).addClass('cp-app-drive-content-list');
Feedback.send('DRIVE_LIST_MODE');
});
$gridButton.click(function () {
$listButton.removeClass('cp-app-drive-toolbar-active');
$gridButton.addClass('cp-app-drive-toolbar-active');
setViewMode('grid');
$('#' + FOLDER_CONTENT_ID).addClass('cp-app-drive-content-grid');
$('#' + FOLDER_CONTENT_ID).removeClass('cp-app-drive-content-list');
Feedback.send('DRIVE_GRID_MODE');
});
if (getViewMode() === 'list') {
$listButton.addClass('cp-app-drive-toolbar-active');
} else {
$gridButton.addClass('cp-app-drive-toolbar-active');
}
$listButton.attr('title', Messages.fm_viewListButton);
$gridButton.attr('title', Messages.fm_viewGridButton);
$container.append($listButton).append($gridButton);
};
var createEmptyTrashButton = function ($container) {
var $button = $emptyTrashIcon.clone();
$button.addClass('cp-app-drive-toolbar-emptytrash');
$button.attr('title', Messages.fc_empty);
$button.click(function () {
UI.confirm(Messages.fm_emptyTrashDialog, function(res) {
if (!res) { return; }
manager.emptyTrash(refresh);
});
});
$container.append($button);
};
// Get the upload options
var addSharedFolderModal = function (cb) {
var createHelper = function (href, text) {
var q = h('a.fa.fa-question-circle', {
style: 'text-decoration: none !important;',
title: text,
href: APP.origin + href,
target: "_blank",
'data-tippy-placement': "right"
});
return q;
};
// Ask for name, password and owner
var content = h('div', [
h('h4', Messages.sharedFolders_create),
h('label', {for: 'cp-app-drive-sf-name'}, Messages.sharedFolders_create_name),
h('input#cp-app-drive-sf-name', {type: 'text', placeholder: Messages.fm_newFolder}),
h('label', {for: 'cp-app-drive-sf-password'}, Messages.sharedFolders_create_password),
UI.passwordInput({id: 'cp-app-drive-sf-password'}),
h('span', {
style: 'display:flex;align-items:center;justify-content:space-between'
}, [
UI.createCheckbox('cp-app-drive-sf-owned', Messages.sharedFolders_create_owned, true),
createHelper('/faq.html#keywords-owned', Messages.creation_owned1) // TODO
]),
]);
$(content).find('#cp-app-drive-sf-name').keydown(function (e) {
if (e.which === 13) {
UI.findOKButton().click();
}
});
UI.confirm(content, function (yes) {
if (!yes) { return void cb(); }
// Get the values
var newName = $(content).find('#cp-app-drive-sf-name').val();
var password = $(content).find('#cp-app-drive-sf-password').val() || undefined;
var owned = $(content).find('#cp-app-drive-sf-owned').is(':checked');
cb({
name: newName,
password: password,
owned: owned
});
});
};
var getNewPadTypes = function () {
var arr = [];
AppConfig.availablePadTypes.forEach(function (type) {
if (type === 'drive') { return; }
if (type === 'contacts') { return; }
if (type === 'todo') { return; }
if (type === 'file') { return; }
if (!APP.loggedIn && AppConfig.registeredOnlyTypes &&
AppConfig.registeredOnlyTypes.indexOf(type) !== -1) {
return;
}
arr.push(type);
});
return arr;
};
var addNewPadHandlers = function ($block, isInRoot) {
// Handlers
if (isInRoot) {
var onCreated = function (err, info) {
if (err) {
if (err === E_OVER_LIMIT) {
return void UI.alert(Messages.pinLimitDrive, null, true);
}
return void UI.alert(Messages.fm_error_cantPin);
}
APP.newFolder = info.newPath;
refresh();
};
$block.find('a.cp-app-drive-new-folder, li.cp-app-drive-new-folder')
.click(function () {
manager.addFolder(currentPath, null, onCreated);
});
if (!APP.disableSF && !manager.isInSharedFolder(currentPath)) {
$block.find('a.cp-app-drive-new-shared-folder, li.cp-app-drive-new-shared-folder')
.click(function () {
addSharedFolderModal(function (obj) {
if (!obj) { return; }
manager.addSharedFolder(currentPath, obj, refresh);
});
});
}
$block.find('a.cp-app-drive-new-upload, li.cp-app-drive-new-upload')
.click(function () {
var $input = $('<input>', {
'type': 'file',
'style': 'display: none;',
'multiple': 'multiple'
}).on('change', function (e) {
var files = Util.slice(e.target.files);
files.forEach(function (file) {
var ev = {
target: $content[0],
path: findDropPath($content[0])
};
APP.FM.handleFile(file, ev);
});
});
$input.click();
});
}
$block.find('a.cp-app-drive-new-doc, li.cp-app-drive-new-doc')
.click(function () {
var type = $(this).attr('data-type') || 'pad';
var path = manager.isPathIn(currentPath, [TRASH]) ? '' : currentPath;
common.sessionStorage.put(Constants.newPadPathKey, path, function () {
common.openURL('/' + type + '/');
});
});
};
var createNewButton = function (isInRoot, $container) {
if (!APP.editable) { return; }
if (!APP.loggedIn) { return; } // Anonymous users can use the + menu in the toolbar
if (!manager.isPathIn(currentPath, [ROOT, 'hrefArray'])) { return; }
// Create dropdown
var options = [];
if (isInRoot) {
options.push({
tag: 'a',
attributes: {'class': 'cp-app-drive-new-folder'},
content: $('<div>').append($folderIcon.clone()).html() + Messages.fm_folder
});
if (!APP.disableSF && !manager.isInSharedFolder(currentPath)) {
options.push({
tag: 'a',
attributes: {'class': 'cp-app-drive-new-shared-folder'},
content: $('<div>').append($sharedFolderIcon.clone()).html() + Messages.fm_sharedFolder
});
}
options.push({tag: 'hr'});
options.push({
tag: 'a',
attributes: {'class': 'cp-app-drive-new-upload'},
content: $('<div>').append(getIcon('fileupload')).html() + Messages.uploadButton
});
options.push({tag: 'hr'});
}
getNewPadTypes().forEach(function (type) {
var attributes = {
'class': 'cp-app-drive-new-doc',
'data-type': type,
'href': '#'
};
options.push({
tag: 'a',
attributes: attributes,
content: $('<div>').append(getIcon(type)).html() + Messages.type[type]
});
});
var $plusIcon = $('<div>').append($('<span>', {'class': 'fa fa-plus'}));
var dropdownConfig = {
text: $plusIcon.html() + '<span>'+Messages.fm_newButton+'</span>',
options: options,
feedback: 'DRIVE_NEWPAD_LOCALFOLDER',
common: common
};
var $block = UIElements.createDropdown(dropdownConfig);
// Custom style:
$block.find('button').addClass('cp-app-drive-toolbar-new');
$block.find('button').attr('title', Messages.fm_newButtonTitle);
addNewPadHandlers($block, isInRoot);
$container.append($block);
};
var createShareButton = function (id, $container) {
var $shareBlock = $('<button>', {
'class': 'cp-toolbar-share-button',
title: Messages.shareButton
});
$sharedIcon.clone().appendTo($shareBlock);
$('<span>').text(Messages.shareButton).appendTo($shareBlock);
var data = manager.getSharedFolderData(id);
var parsed = Hash.parsePadUrl(data.href);
if (!parsed || !parsed.hash) { return void console.error("Invalid href: "+data.href); }
var modal = UIElements.createSFShareModal({
origin: APP.origin,
pathname: "/drive/",
hashes: {
editHash: parsed.hash
}
});
$shareBlock.click(function () {
UI.openCustomModal(modal);
});
$container.append($shareBlock);
};
var SORT_FOLDER_DESC = 'sortFoldersDesc';
var SORT_FILE_BY = 'sortFilesBy';
var SORT_FILE_DESC = 'sortFilesDesc';
var getSortFileDesc = function () {
return APP.store[SORT_FILE_DESC]+"" === "true";
};
var getSortFolderDesc = function () {
return APP.store[SORT_FOLDER_DESC]+"" === "true";
};
var onSortByClick = function () {
var $span = $(this);
var value;
if ($span.hasClass('cp-app-drive-sort-foldername')) {
value = getSortFolderDesc();
APP.store[SORT_FOLDER_DESC] = value ? false : true;
localStore.put(SORT_FOLDER_DESC, value ? false : true);
refresh();
return;
}
value = APP.store[SORT_FILE_BY];
var descValue = getSortFileDesc();
if ($span.hasClass('cp-app-drive-sort-filename')) {
if (value === '') {
descValue = descValue ? false : true;
} else {
descValue = false;
value = '';
}
} else {
['cp-app-drive-element-title', 'cp-app-drive-element-type',
'cp-app-drive-element-atime', 'cp-app-drive-element-ctime'].some(function (c) {
if ($span.hasClass(c)) {
var nValue = c.replace(/cp-app-drive-element-/, '');
if (value === nValue) { descValue = descValue ? false : true; }
else {
// atime and ctime should be ordered in a desc order at the first click
value = nValue;
descValue = value !== 'title';
}
return true;
}
});
}
APP.store[SORT_FILE_BY] = value;
APP.store[SORT_FILE_DESC] = descValue;
localStore.put(SORT_FILE_BY, value);
localStore.put(SORT_FILE_DESC, descValue);
refresh();
};
var addFolderSortIcon = function ($list) {
var $icon = $sortAscIcon.clone();
if (getSortFolderDesc()) {
$icon = $sortDescIcon.clone();
}
if (typeof(APP.store[SORT_FOLDER_DESC]) !== "undefined") {
$list.find('.cp-app-drive-sort-foldername').addClass('cp-app-drive-sort-active').prepend($icon);
}
};
var getFolderListHeader = function () {
var $fohElement = $('<li>', {
'class': 'cp-app-drive-element-header cp-app-drive-element-list'
});
//var $fohElement = $('<span>', {'class': 'element'}).appendTo($folderHeader);
var $fhIcon = $('<span>', {'class': 'cp-app-drive-content-icon'});
var $name = $('<span>', {
'class': 'cp-app-drive-element-name cp-app-drive-sort-foldername ' +
'cp-app-drive-sort-clickable'
}).text(Messages.fm_folderName).click(onSortByClick);
var $state = $('<span>', {'class': 'cp-app-drive-element-state'});
var $subfolders = $('<span>', {
'class': 'cp-app-drive-element-folders cp-app-drive-element-list'
}).text(Messages.fm_numberOfFolders);
var $files = $('<span>', {
'class': 'cp-app-drive-element-files cp-app-drive-element-list'
}).text(Messages.fm_numberOfFiles);
$fohElement.append($fhIcon).append($name).append($state)
.append($subfolders).append($files);
addFolderSortIcon($fohElement);
return $fohElement;
};
var addFileSortIcon = function ($list) {
var $icon = $sortAscIcon.clone();
if (getSortFileDesc()) {
$icon = $sortDescIcon.clone();
}
var classSorted;
if (APP.store[SORT_FILE_BY] === '') { classSorted = 'cp-app-drive-sort-filename'; }
else if (APP.store[SORT_FILE_BY]) { classSorted = 'cp-app-drive-element-' + APP.store[SORT_FILE_BY]; }
if (classSorted) {
$list.find('.' + classSorted).addClass('cp-app-drive-sort-active').prepend($icon);
}
};
var getFileListHeader = function () {
var $fihElement = $('<li>', {
'class': 'cp-app-drive-element-header cp-app-drive-element-list'
});
//var $fihElement = $('<span>', {'class': 'element'}).appendTo($fileHeader);
var $fhIcon = $('<span>', {'class': 'cp-app-drive-content-icon'});
var $fhName = $('<span>', {
'class': 'cp-app-drive-element-name cp-app-drive-sort-filename ' +
'cp-app-drive-sort-clickable'
}).text(Messages.fm_fileName).click(onSortByClick);
var $fhState = $('<span>', {'class': 'cp-app-drive-element-state'});
var $fhType = $('<span>', {
'class': 'cp-app-drive-element-type cp-app-drive-sort-clickable'
}).text(Messages.fm_type).click(onSortByClick);
var $fhAdate = $('<span>', {
'class': 'cp-app-drive-element-atime cp-app-drive-sort-clickable'
}).text(Messages.fm_lastAccess).click(onSortByClick);
var $fhCdate = $('<span>', {
'class': 'cp-app-drive-element-ctime cp-app-drive-sort-clickable'
}).text(Messages.fm_creation).click(onSortByClick);
// If displayTitle is false, it means the "name" is the title, so do not display the "name" header
$fihElement.append($fhIcon).append($fhName).append($fhState).append($fhType);
$fihElement.append($fhAdate).append($fhCdate);
addFileSortIcon($fihElement);
return $fihElement;
};
var sortElements = function (folder, path, oldkeys, prop, asc, useId) {
var root = path && manager.find(path);
if (path[0] === SHARED_FOLDER) {
path = path.slice(1);
root = Util.find(folders[APP.newSharedFolder], path);
}
var test = folder ? manager.isFolder : manager.isFile;
var keys = oldkeys.filter(function (e) {
return useId ? test(e) : (path && test(root[e]));
});
if (keys.length < 2) { return keys; }
var mult = asc ? 1 : -1;
var getProp = function (el, prop) {
if (folder && root[el] && manager.isSharedFolder(root[el])) {
var title = manager.getSharedFolderData(root[el]).title || el;
return title.toLowerCase();
} else if (folder) {
return el.toLowerCase();
}
var id = useId ? el : root[el];
var data = manager.getFileData(id);
if (!data) { return ''; }
if (prop === 'type') {
var hrefData = Hash.parsePadUrl(data.href || data.roHref);
return hrefData.type;
}
if (prop === 'atime' || prop === 'ctime') {
return new Date(data[prop]);
}
return (manager.getTitle(id) || "").toLowerCase();
};
keys.sort(function(a, b) {
if (getProp(a, prop) < getProp(b, prop)) { return mult * -1; }
if (getProp(a, prop) > getProp(b, prop)) { return mult * 1; }
return 0;
});
return keys;
};
var sortTrashElements = function (folder, oldkeys, prop, asc) {
var test = folder ? manager.isFolder : manager.isFile;
var keys = oldkeys.filter(function (e) {
return test(e.element);
});
if (keys.length < 2) { return keys; }
var mult = asc ? 1 : -1;
var getProp = function (el, prop) {
if (prop && !folder) {
var element = el.element;
var e = manager.getFileData(element);
if (!e) {
e = {
href : el,
title : Messages.fm_noname,
atime : 0,
ctime : 0
};
}
if (prop === 'type') {
var hrefData = Hash.parsePadUrl(e.href || e.roHref);
return hrefData.type;
}
if (prop === 'atime' || prop === 'ctime') {
return new Date(e[prop]);
}
}
return (el.name || "").toLowerCase();
};
keys.sort(function(a, b) {
if (getProp(a, prop) < getProp(b, prop)) { return mult * -1; }
if (getProp(a, prop) > getProp(b, prop)) { return mult * 1; }
return 0;
});
return keys;
};
// Create the ghost icon to add pads/folders
var createNewPadIcons = function ($block, isInRoot) {
var $container = $('<div>');
if (isInRoot) {
// Folder
var $element1 = $('<li>', {
'class': 'cp-app-drive-new-folder cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend($folderIcon.clone()).appendTo($container);
$element1.append($('<span>', { 'class': 'cp-app-drive-new-name' })
.text(Messages.fm_folder));
// Shared Folder
if (!APP.disableSF && !manager.isInSharedFolder(currentPath)) {
var $element3 = $('<li>', {
'class': 'cp-app-drive-new-shared-folder cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend($sharedFolderIcon.clone()).appendTo($container);
$element3.append($('<span>', { 'class': 'cp-app-drive-new-name' })
.text(Messages.fm_sharedFolder));
}
// File
var $element2 = $('<li>', {
'class': 'cp-app-drive-new-upload cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend(getIcon('fileupload')).appendTo($container);
$element2.append($('<span>', {'class': 'cp-app-drive-new-name'})
.text(Messages.uploadButton));
}
// Pads
getNewPadTypes().forEach(function (type) {
var $element = $('<li>', {
'class': 'cp-app-drive-new-doc cp-app-drive-element-row ' +
'cp-app-drive-element-grid'
}).prepend(getIcon(type)).appendTo($container);
$element.append($('<span>', {'class': 'cp-app-drive-new-name'})
.text(Messages.type[type]));
$element.attr('data-type', type);
});
$container.find('.cp-app-drive-element-row').click(function () {
$block.hide();
});
return $container;
};
var createGhostIcon = function ($list) {
var isInRoot = currentPath[0] === ROOT;
var $element = $('<li>', {
'class': 'cp-app-drive-element-row cp-app-drive-element-grid cp-app-drive-new-ghost'
}).prepend($addIcon.clone()).appendTo($list);
$element.append($('<span>', {'class': 'cp-app-drive-element-name'})
.text(Messages.fm_newFile));
$element.attr('title', Messages.fm_newFile);
$element.click(function () {
var $modal = UIElements.createModal({
id: 'cp-app-drive-new-ghost-dialog',
$body: $('body')
});
var $title = $('<h3>').text(Messages.fm_newFile);
var $description = $('<p>').text(Messages.fm_newButtonTitle);
$modal.find('.cp-modal').append($title);
$modal.find('.cp-modal').append($description);
var $content = createNewPadIcons($modal, isInRoot);
$modal.find('.cp-modal').append($content);
window.setTimeout(function () { $modal.show(); });
addNewPadHandlers($modal, isInRoot);
});
};
// Drive content toolbar
var createToolbar = function () {
var $toolbar = $driveToolbar;
$toolbar.html('');
$('<div>', {'class': 'cp-app-drive-toolbar-leftside'}).appendTo($toolbar);
$('<div>', {'class': 'cp-app-drive-path cp-unselectable'}).appendTo($toolbar);
$('<div>', {'class': 'cp-app-drive-toolbar-filler'}).appendTo($toolbar);
var $rightside = $('<div>', {'class': 'cp-app-drive-toolbar-rightside'})
.appendTo($toolbar);
if (APP.loggedIn || !APP.newSharedFolder) {
// ANON_SHARED_FOLDER
var $hist = common.createButton('history', true, {histConfig: APP.histConfig});
$rightside.append($hist);
}
if (APP.$burnThisDrive) {
$rightside.append(APP.$burnThisDrive);
}
return $toolbar;
};
// Unsorted element are represented by "href" in an array: they don't have a filename
// and they don't hav a hierarchical structure (folder/subfolders)
var displayHrefArray = function ($container, rootName, draggable) {
var unsorted = files[rootName];
if (unsorted.length) {
var $fileHeader = getFileListHeader(false);
$container.append($fileHeader);
}
var keys = unsorted;
var sortBy = APP.store[SORT_FILE_BY];
sortBy = sortBy === "" ? sortBy = 'name' : sortBy;
var sortedFiles = sortElements(false, [rootName], keys, sortBy, !getSortFileDesc(), true);
sortedFiles.forEach(function (id) {
var file = manager.getFileData(id);
if (!file) {
//debug("Unsorted or template returns an element not present in filesData: ", href);
file = { title: Messages.fm_noname };
//return;
}
var idx = files[rootName].indexOf(id);
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined mens it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-file cp-app-drive-element-row' + roClass,
draggable: draggable
});
if (Array.isArray(APP.selectedFiles)) {
var sidx = APP.selectedFiles.indexOf(id);
if (sidx !== -1) {
$element.addClass('cp-app-drive-element-selected');
APP.selectedFiles.splice(sidx, 1);
}
}
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
var path = [rootName, idx];
$element.data('path', path);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element, path);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
if (draggable) {
addDragAndDropHandlers($element, path, false, false);
}
$container.append($element);
});
createGhostIcon($container);
};
var displayAllFiles = function ($container) {
if (AppConfig.disableAnonymousStore && !APP.loggedIn) {
$container.append(Messages.anonymousStoreDisabled);
return;
}
var allfiles = files[FILES_DATA];
if (allfiles.length === 0) { return; }
var $fileHeader = getFileListHeader(false);
$container.append($fileHeader);
var keys = manager.getFiles([FILES_DATA]);
var sortedFiles = sortElements(false, [FILES_DATA], keys, APP.store[SORT_FILE_BY], !getSortFileDesc(), true);
sortedFiles.forEach(function (id) {
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined maens it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-row' + roClass
});
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
$element.data('path', [FILES_DATA, id]);
$element.data('element', id);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
$container.append($element);
});
createGhostIcon($container);
};
var displayTrashRoot = function ($list, $folderHeader, $fileHeader) {
var filesList = [];
var root = files[TRASH];
// Elements in the trash are JS arrays (several elements can have the same name)
Object.keys(root).forEach(function (key) {
if (!Array.isArray(root[key])) {
logError("Trash element has a wrong type", root[key]);
return;
}
root[key].forEach(function (el, idx) {
if (!manager.isFile(el.element) && !manager.isFolder(el.element)) { return; }
var spath = [key, idx, 'element'];
filesList.push({
element: el.element,
spath: spath,
name: key
});
});
});
var sortedFolders = sortTrashElements(true, filesList, null, !getSortFolderDesc());
var sortedFiles = sortTrashElements(false, filesList, APP.store[SORT_FILE_BY], !getSortFileDesc());
if (manager.hasSubfolder(root, true)) { $list.append($folderHeader); }
sortedFolders.forEach(function (f) {
var $element = createElement([TRASH], f.spath, root, true);
$list.append($element);
});
if (manager.hasFile(root, true)) { $list.append($fileHeader); }
sortedFiles.forEach(function (f) {
var $element = createElement([TRASH], f.spath, root, false);
$list.append($element);
});
};
var displaySearch = function ($list, value) {
var filesList = manager.search(value);
filesList.forEach(function (r) {
r.paths.forEach(function (path) {
if (!r.inSharedFolder &&
APP.hideDuplicateOwned && manager.isDuplicateOwned(path)) { return; }
var href = r.data.href;
var parsed = Hash.parsePadUrl(href);
var $table = $('<table>');
var $icon = $('<td>', {'rowspan': '3', 'class': 'cp-app-drive-search-icon'})
.append(getFileIcon(r.id));
var $title = $('<td>', {
'class': 'cp-app-drive-search-col1 cp-app-drive-search-title'
}).text(r.data.title)
.click(function () {
openFile(null, r.data.href);
});
var $typeName = $('<td>', {'class': 'cp-app-drive-search-label2'})
.text(Messages.fm_type);
var $type = $('<td>', {'class': 'cp-app-drive-search-col2'})
.text(Messages.type[parsed.type] || parsed.type);
var $atimeName = $('<td>', {'class': 'cp-app-drive-search-label2'})
.text(Messages.fm_lastAccess);
var $atime = $('<td>', {'class': 'cp-app-drive-search-col2'})
.text(new Date(r.data.atime).toLocaleString());
var $ctimeName = $('<td>', {'class': 'cp-app-drive-search-label2'})
.text(Messages.fm_creation);
var $ctime = $('<td>', {'class': 'cp-app-drive-search-col2'})
.text(new Date(r.data.ctime).toLocaleString());
if (manager.isPathIn(path, ['hrefArray'])) {
path.pop();
path.push(r.data.title);
}
var $path = $('<td>', {
'class': 'cp-app-drive-search-col1 cp-app-drive-search-path'
});
createTitle($path, path, true);
var parentPath = path.slice();
var $a;
if (parentPath) {
$a = $('<a>').text(Messages.fm_openParent).click(function (e) {
e.preventDefault();
if (manager.isInTrashRoot(parentPath)) { parentPath = [TRASH]; }
else { parentPath.pop(); }
APP.selectedFiles = [r.id];
APP.displayDirectory(parentPath);
});
}
var $openDir = $('<td>', {'class': 'cp-app-drive-search-opendir'}).append($a);
$('<a>').text(Messages.fc_prop).click(function () {
APP.getProperties(r.id, function (e, $prop) {
if (e) { return void logError(e); }
UI.alert($prop[0], undefined, true);
});
}).appendTo($openDir);
// rows 1-3
$('<tr>').append($icon).append($title).append($typeName).append($type).appendTo($table);
$('<tr>').append($path).append($atimeName).append($atime).appendTo($table);
$('<tr>').append($openDir).append($ctimeName).append($ctime).appendTo($table);
$('<li>', {'class':'cp-app-drive-search-result'}).append($table).appendTo($list);
});
});
};
var displayRecent = function ($list) {
var filesList = manager.getRecentPads();
var limit = 20;
var now = new Date();
var last1 = new Date(now);
last1.setDate(last1.getDate()-1);
var last7 = new Date(now);
last7.setDate(last7.getDate()-7);
var last28 = new Date(now);
last28.setDate(last28.getDate()-28);
var header7, header28, headerOld;
var i = 0;
var channels = [];
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_active1Day)));
filesList.some(function (arr) {
var id = arr[0];
var file = arr[1];
if (!file || !file.atime) { return; }
if (file.atime <= last28 && i >= limit) {
return true;
}
var paths = manager.findFile(id);
if (!paths.length) { return; }
var path = paths[0];
if (manager.isPathIn(path, [TRASH])) { return; }
if (channels.indexOf(file.channel) !== -1) { return; }
channels.push(file.channel);
if (!header7 && file.atime < last1) {
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_active7Days)));
header7 = true;
}
if (!header28 && file.atime < last7) {
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_active28Days)));
header28 = true;
}
if (!headerOld && file.atime < last28) {
$list.append(h('li.cp-app-drive-element-separator', h('span', Messages.drive_activeOld)));
headerOld = true;
}
// Display the pad
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined means it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-notrash cp-app-drive-element-file cp-app-drive-element-row' + roClass,
});
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
$element.data('path', path);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element, path);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
/*if (draggable) {
addDragAndDropHandlers($element, path, false, false);
}*/
$list.append($element);
i++;
});
};
// Owned pads category
var displayOwned = function ($container) {
var list = manager.getOwnedPads();
if (list.length === 0) { return; }
var $fileHeader = getFileListHeader(false);
$container.append($fileHeader);
var sortedFiles = sortElements(false, false, list, APP.store[SORT_FILE_BY], !getSortFileDesc(), true);
sortedFiles.forEach(function (id) {
var paths = manager.findFile(id);
if (!paths.length) { return; }
var path = paths[0];
var $icon = getFileIcon(id);
var ro = manager.isReadOnlyFile(id);
// ro undefined maens it's an old hash which doesn't support read-only
var roClass = typeof(ro) === 'undefined' ? ' cp-app-drive-element-noreadonly' :
ro ? ' cp-app-drive-element-readonly' : '';
var $element = $('<li>', {
'class': 'cp-app-drive-element cp-app-drive-element-notrash ' +
'cp-app-drive-element-file cp-app-drive-element-row' + roClass
});
$element.prepend($icon).dblclick(function () {
openFile(id);
});
addFileData(id, $element);
$element.data('path', path);
$element.data('element', id);
$element.click(function(e) {
e.stopPropagation();
onElementClick(e, $element);
});
$element.contextmenu(openContextMenu('default'));
$element.data('context', 'default');
$container.append($element);
});
};
// Tags category
var displayTags = function ($container) {
var list = manager.getTagsList();
if (Object.keys(list).length === 0) { return; }
var sortedTags = Object.keys(list);
sortedTags.sort(function (a, b) {
return list[b] - list[a];
});
var lines = [
h('tr', [
h('th', Messages.fm_tags_name),
h('th', Messages.fm_tags_used)
])
];
sortedTags.forEach(function (tag) {
var tagLink = h('a', { href: '#' }, '#' + tag);
$(tagLink).click(function () {
if (displayedCategories.indexOf(SEARCH) !== -1) {
APP.Search.$input.val('#' + tag).keyup();
}
});
lines.push(h('tr', [
h('td', tagLink),
h('td.cp-app-drive-tags-used', list[tag])
]));
});
$(h('li.cp-app-drive-tags-list', h('table', lines))).appendTo($container);
};
// ANON_SHARED_FOLDER
// Display a shared folder for anon users (read-only)
var displaySharedFolder = function ($list) {
if (currentPath.length === 1) {
currentPath.push(ROOT);
}
var fId = APP.newSharedFolder;
var data = folders[fId];
var $folderHeader = getFolderListHeader();
var $fileHeader = getFileListHeader(true);
var path = currentPath.slice(1);
var root = Util.find(data, path);
if (manager.hasSubfolder(root)) { $list.append($folderHeader); }
// display sub directories
var keys = Object.keys(root);
var sortedFolders = sortElements(true, currentPath, keys, null, !getSortFolderDesc());
var sortedFiles = sortElements(false, currentPath, keys, APP.store[SORT_FILE_BY], !getSortFileDesc());
sortedFolders.forEach(function (key) {
if (manager.isFile(root[key])) { return; }
var $element = createElement(currentPath, key, root, true);
$element.appendTo($list);
});
if (manager.hasFile(root)) { $list.append($fileHeader); }
// display files
sortedFiles.forEach(function (key) {
if (manager.isFolder(root[key])) { return; }
var $element = createElement(currentPath, key, root, false);
if (!$element) { return; }
$element.appendTo($list);
});
};
// Display the selected directory into the content part (rightside)
// NOTE: Elements in the trash are not using the same storage structure as the others
var _displayDirectory = function (path, force) {
APP.hideMenu();
if (!APP.editable) { debug("Read-only mode"); }
if (!appStatus.isReady && !force) { return; }
// Only Trash and Root are available in not-owned files manager
if (!path || displayedCategories.indexOf(path[0]) === -1) {
log(Messages.fm_categoryError);
currentPath = [ROOT];
_displayDirectory(currentPath);
return;
}
appStatus.ready(false);
currentPath = path;
var s = $content.scrollTop() || 0;
$content.html("");
sel.$selectBox = $('<div>', {'class': 'cp-app-drive-content-select-box'})
.appendTo($content);
if (!path || path.length === 0) {
path = [ROOT];
}
var isInRoot = manager.isPathIn(path, [ROOT]);
var inTrash = manager.isPathIn(path, [TRASH]);
var isTrashRoot = manager.comparePath(path, [TRASH]);
var isTemplate = manager.comparePath(path, [TEMPLATE]);
var isAllFiles = manager.comparePath(path, [FILES_DATA]);
var isVirtual = virtualCategories.indexOf(path[0]) !== -1;
var isSearch = path[0] === SEARCH;
var isTags = path[0] === TAGS;
// ANON_SHARED_FOLDER
var isSharedFolder = path[0] === SHARED_FOLDER && APP.newSharedFolder;
var root = isVirtual ? undefined : manager.find(path);
if (manager.isSharedFolder(root)) {
// ANON_SHARED_FOLDER
path.push(manager.user.userObject.ROOT);
root = manager.find(path);
if (!root) { return; }
}
if (!isVirtual && typeof(root) === "undefined") {
log(Messages.fm_unknownFolderError);
debug("Unable to locate the selected directory: ", path);
var parentPath = path.slice();
parentPath.pop();
_displayDirectory(parentPath, true);
return;
}
if (!isSearch) { delete APP.Search.oldLocation; }
APP.resetTree();
if (displayedCategories.indexOf(SEARCH) !== -1 && $tree.find('#cp-app-drive-tree-search-input').length) {
// in history mode we want to focus the version number input
if (!history.isHistoryMode && !APP.mobile()) {
var st = $tree.scrollTop() || 0;
$tree.find('#cp-app-drive-tree-search-input').focus();
$tree.scrollTop(st);
}
$tree.find('#cp-app-drive-tree-search-input')[0].selectionStart = getSearchCursor();
$tree.find('#cp-app-drive-tree-search-input')[0].selectionEnd = getSearchCursor();
}
setLastOpenedFolder(path);
var $toolbar = createToolbar(path);
var $info = createInfoBox(path);
var $dirContent = $('<div>', {id: FOLDER_CONTENT_ID});
$dirContent.data('path', path);
if (!isSearch && !isTags) {
var mode = getViewMode();
if (mode) {
$dirContent.addClass(getViewModeClass());
}
createViewModeButton($toolbar.find('.cp-app-drive-toolbar-rightside'));
}
if (inTrash) {
createEmptyTrashButton($toolbar.find('.cp-app-drive-toolbar-rightside'));
}
var $list = $('<ul>').appendTo($dirContent);
// NewButton can be undefined if we're in read only mode
createNewButton(isInRoot, $toolbar.find('.cp-app-drive-toolbar-leftside'));
var sfId = manager.isInSharedFolder(currentPath);
if (sfId) {
var sfData = manager.getSharedFolderData(sfId);
var parsed = Hash.parsePadUrl(sfData.href);
sframeChan.event('EV_DRIVE_SET_HASH', parsed.hash || '');
createShareButton(sfId, $toolbar.find('.cp-app-drive-toolbar-leftside'));
} else {
sframeChan.event('EV_DRIVE_SET_HASH', '');
}
createTitle($toolbar.find('.cp-app-drive-path'), path);
if (APP.mobile()) {
var $context = $('<button>', {
id: 'cp-app-drive-toolbar-context-mobile'
});
$context.append($('<span>', {'class': 'fa fa-caret-down'}));
$context.appendTo($toolbar.find('.cp-app-drive-toolbar-rightside'));
$context.click(function (e) {
e.preventDefault();
e.stopPropagation();
var $li = $content.find('.cp-app-drive-element-selected');
if ($li.length !== 1) {
$li = findDataHolder($tree.find('.cp-app-drive-element-active'));
}
// Close if already opened
if ($('.cp-contextmenu:visible').length) {
APP.hideMenu();
return;
}
// Open the menu
$('.cp-contextmenu').css({
top: ($context.offset().top + 32) + 'px',
right: '0px',
left: ''
});
$li.contextmenu();
});
} else {
var $contextButtons = $('<span>', {'id' : 'cp-app-drive-toolbar-contextbuttons'});
$contextButtons.appendTo($toolbar.find('.cp-app-drive-toolbar-rightside'));
}
updateContextButton();
var $folderHeader = getFolderListHeader();
var $fileHeader = getFileListHeader(true);
if (isTemplate) {
displayHrefArray($list, path[0], true);
} else if (isAllFiles) {
displayAllFiles($list);
} else if (isTrashRoot) {
displayTrashRoot($list, $folderHeader, $fileHeader);
} else if (isSearch) {
displaySearch($list, path[1]);
} else if (path[0] === RECENT) {
displayRecent($list);
} else if (path[0] === OWNED) {
displayOwned($list);
} else if (isTags) {
displayTags($list);
} else if (isSharedFolder) {
// ANON_SHARED_FOLDER
displaySharedFolder($list);
} else {
$dirContent.contextmenu(openContextMenu('content'));
if (manager.hasSubfolder(root)) { $list.append($folderHeader); }
// display sub directories
var keys = Object.keys(root);
var sortedFolders = sortElements(true, path, keys, null, !getSortFolderDesc());
var sortedFiles = sortElements(false, path, keys, APP.store[SORT_FILE_BY], !getSortFileDesc());
sortedFolders.forEach(function (key) {
if (manager.isFile(root[key])) { return; }
var $element = createElement(path, key, root, true);
$element.appendTo($list);
});
if (manager.hasFile(root)) { $list.append($fileHeader); }
// display files
sortedFiles.forEach(function (key) {
if (manager.isFolder(root[key])) { return; }
var p = path.slice();
p.push(key);
if (APP.hideDuplicateOwned && manager.isDuplicateOwned(p)) { return; }
var $element = createElement(path, key, root, false);
if (!$element) { return; }
$element.appendTo($list);
});
if (!inTrash) { createGhostIcon($list); }
}
$content.append($info).append($dirContent);
/*var $truncated = $('<span>', {'class': 'cp-app-drive-element-truncated'}).text('...');
$content.find('.cp-app-drive-element').each(function (idx, el) {
var $name = $(el).find('.cp-app-drive-element-name');
if ($name.length === 0) { return; }
if ($name[0].scrollHeight > $name[0].clientHeight) {
var $tr = $truncated.clone();
$tr.attr('title', $name.text());
$(el).append($tr);
}
});*/
var $sel = $content.find('.cp-app-drive-element-selected');
if ($sel.length) {
$sel[0].scrollIntoView();
} else {
$content.scrollTop(s);
}
appStatus.ready(true);
};
var displayDirectory = APP.displayDirectory = function (path, force) {
if (history.isHistoryMode) {
return void _displayDirectory(path, force);
}
updateObject(sframeChan, proxy, function () {
copyObjectValue(files, proxy.drive);
updateSharedFolders(sframeChan, manager, files, folders, function () {
_displayDirectory(path, force);
});
});
};
var createTreeElement = function (name, $icon, path, draggable, droppable, collapsable, active, isSharedFolder) {
var $name = $('<span>', { 'class': 'cp-app-drive-element' }).text(name);
var $collapse;
if (collapsable) {
$collapse = $expandIcon.clone();
}
var $elementRow = $('<span>', {'class': 'cp-app-drive-element-row'}).append($collapse).append($icon).append($name).click(function (e) {
e.stopPropagation();
APP.displayDirectory(path);
});
var $element = $('<li>').append($elementRow);
if (draggable) { $elementRow.attr('draggable', true); }
if (collapsable) {
$element.addClass('cp-app-drive-element-collapsed');
$collapse.click(function(e) {
e.stopPropagation();
if ($element.hasClass('cp-app-drive-element-collapsed')) {
// It is closed, open it
$element.removeClass('cp-app-drive-element-collapsed');
setFolderOpened(path, true);
$collapse.removeClass('fa-plus-square-o');
$collapse.addClass('fa-minus-square-o');
} else {
// Collapse the folder
$element.addClass('cp-app-drive-element-collapsed');
setFolderOpened(path, false);
$collapse.removeClass('fa-minus-square-o');
$collapse.addClass('fa-plus-square-o');
// Change the current opened folder if it was collapsed
if (manager.isSubpath(currentPath, path)) {
displayDirectory(path);
}
}
});
if (wasFolderOpened(path) ||
(manager.isSubpath(currentPath, path) && path.length < currentPath.length)) {
$collapse.click();
}
}
var dataPath = isSharedFolder ? path.slice(0, -1) : path;
$elementRow.data('path', dataPath);
addDragAndDropHandlers($elementRow, dataPath, true, droppable);
if (active) {
$elementRow.addClass('cp-app-drive-element-active cp-leftside-active');
}
return $element;
};
var createTree = function ($container, path) {
var root = manager.find(path);
// don't try to display what doesn't exist
if (!root) { return; }
// Display the root element in the tree
var displayingRoot = manager.comparePath([ROOT], path);
if (displayingRoot) {
var isRootOpened = manager.comparePath([ROOT], currentPath);
var $rootIcon = manager.isFolderEmpty(files[ROOT]) ?
(isRootOpened ? $folderOpenedEmptyIcon : $folderEmptyIcon) :
(isRootOpened ? $folderOpenedIcon : $folderIcon);
var $rootElement = createTreeElement(ROOT_NAME, $rootIcon.clone(), [ROOT], false, true, true, isRootOpened);
if (!manager.hasSubfolder(root)) {
$rootElement.find('.cp-app-drive-icon-expcol').css('visibility', 'hidden');
}
$rootElement.addClass('cp-app-drive-tree-root');
$rootElement.find('>.cp-app-drive-element-row')
.contextmenu(openContextMenu('tree'));
$('<ul>', {'class': 'cp-app-drive-tree-docs'})
.append($rootElement).appendTo($container);
$container = $rootElement;
} else if (manager.isFolderEmpty(root)) { return; }
// Display root content
var $list = $('<ul>').appendTo($container);
var keys = Object.keys(root).sort(function (a, b) {
var newA = manager.isSharedFolder(root[a]) ?
manager.getSharedFolderData(root[a]).title : a;
var newB = manager.isSharedFolder(root[b]) ?
manager.getSharedFolderData(root[b]).title : b;
return newA < newB ? -1 :
(newA === newB ? 0 : 1);
});
keys.forEach(function (key) {
// Do not display files in the menu
if (!manager.isFolder(root[key])) { return; }
var newPath = path.slice();
newPath.push(key);
var isSharedFolder = manager.isSharedFolder(root[key]);
var $icon, isCurrentFolder, subfolder;
if (isSharedFolder) {
var fId = root[key];
// Fix path
newPath.push(manager.user.userObject.ROOT);
isCurrentFolder = manager.comparePath(newPath, currentPath);
// Subfolders?
var newRoot = manager.folders[fId].proxy[manager.user.userObject.ROOT];
subfolder = manager.hasSubfolder(newRoot);
// Fix name
key = manager.getSharedFolderData(fId).title;
// Fix icon
$icon = isCurrentFolder ? $sharedFolderOpenedIcon : $sharedFolderIcon;
} else {
var isEmpty = manager.isFolderEmpty(root[key]);
subfolder = manager.hasSubfolder(root[key]);
isCurrentFolder = manager.comparePath(newPath, currentPath);
$icon = isEmpty ?
(isCurrentFolder ? $folderOpenedEmptyIcon : $folderEmptyIcon) :
(isCurrentFolder ? $folderOpenedIcon : $folderIcon);
}
var $element = createTreeElement(key, $icon.clone(), newPath, true, true, subfolder, isCurrentFolder, isSharedFolder);
$element.appendTo($list);
$element.find('>.cp-app-drive-element-row').contextmenu(openContextMenu('tree'));
if (isSharedFolder) {
$element.find('>.cp-app-drive-element-row')
.addClass('cp-app-drive-element-sharedf');
}
createTree($element, newPath);
});
};
var createTrash = function ($container, path) {
var $icon = manager.isFolderEmpty(files[TRASH]) ? $trashEmptyIcon.clone() : $trashIcon.clone();
var isOpened = manager.comparePath(path, currentPath);
var $trashElement = createTreeElement(TRASH_NAME, $icon, [TRASH], false, true, false, isOpened);
$trashElement.addClass('cp-app-drive-tree-root');
$trashElement.find('>.cp-app-drive-element-row')
.contextmenu(openContextMenu('trashtree'));
var $trashList = $('<ul>', { 'class': 'cp-app-drive-tree-category' })
.append($trashElement);
$container.append($trashList);
};
var search = APP.Search = {};
var createSearch = function ($container) {
var isInSearch = currentPath[0] === SEARCH;
var $div = $('<div>', {'id': 'cp-app-drive-tree-search', 'class': 'cp-unselectable'});
var $input = APP.Search.$input = $('<input>', {
id: 'cp-app-drive-tree-search-input',
type: 'text',
draggable: false,
tabindex: 1,
placeholder: Messages.fm_searchPlaceholder
}).keyup(function (e) {
if (search.to) { window.clearTimeout(search.to); }
if ([38, 39, 40, 41].indexOf(e.which) !== -1) {
if (!$input.val()) {
$input.blur();
$content.focus();
return;
} else {
e.stopPropagation();
}
}
var isInSearchTmp = currentPath[0] === SEARCH;
if ($input.val().trim() === "") {
setSearchCursor(0);
if (search.oldLocation && search.oldLocation.length) { displayDirectory(search.oldLocation); }
return;
}
if (e.which === 13) {
if (!isInSearchTmp) { search.oldLocation = currentPath.slice(); }
var newLocation = [SEARCH, $input.val()];
setSearchCursor();
if (!manager.comparePath(newLocation, currentPath.slice())) { displayDirectory(newLocation); }
return;
}
if (e.which === 27) {
$input.val('');
setSearchCursor(0);
if (search.oldLocation && search.oldLocation.length) { displayDirectory(search.oldLocation); }
else { displayDirectory([ROOT]); }
return;
}
if ($input.val()) {
if (!$input.hasClass('cp-app-drive-search-active')) {
$input.addClass('cp-app-drive-search-active');
}
} else {
$input.removeClass('cp-app-drive-search-active');
}
if (APP.mobile()) { return; }
search.to = window.setTimeout(function () {
if (!isInSearchTmp) { search.oldLocation = currentPath.slice(); }
var newLocation = [SEARCH, $input.val()];
setSearchCursor();
if (!manager.comparePath(newLocation, currentPath.slice())) { displayDirectory(newLocation); }
}, 500);
}).appendTo($div);
var cancel = h('span.fa.fa-times.cp-app-drive-search-cancel', {title:Messages.cancel});
cancel.addEventListener('click', function () {
$input.val('');
setSearchCursor(0);
if (search.oldLocation && search.oldLocation.length) { displayDirectory(search.oldLocation); }
});
$div.append(cancel);
$searchIcon.clone().appendTo($div);
if (isInSearch) {
$input.val(currentPath[1] || '');
if ($input.val()) { $input.addClass('cp-app-drive-search-active'); }
}
$container.append($div);
};
var categories = {};
categories[FILES_DATA] = {
name: FILES_DATA_NAME,
$icon: $unsortedIcon
};
categories[TEMPLATE] = {
name: TEMPLATE_NAME,
droppable: true,
$icon: $templateIcon
};
categories[RECENT] = {
name: RECENT_NAME,
$icon: $recentIcon
};
categories[OWNED] = {
name: OWNED_NAME,
$icon: $ownedIcon
};
categories[TAGS] = {
name: TAGS_NAME,
$icon: $tagsIcon
};
var createCategory = function ($container, cat) {
var options = categories[cat];
var $icon = options.$icon.clone();
var isOpened = manager.comparePath([cat], currentPath);
var $element = createTreeElement(options.name, $icon, [cat], options.draggable, options.droppable, false, isOpened);
$element.addClass('cp-app-drive-tree-root');
var $list = $('<ul>', { 'class': 'cp-app-drive-tree-category' }).append($element);
$container.append($list);
};
APP.resetTree = function () {
var $categories = $tree.find('.cp-app-drive-tree-categories-container');
var s = $categories.scrollTop() || 0;
$tree.html('');
if (displayedCategories.indexOf(SEARCH) !== -1) { createSearch($tree); }
var $div = $('<div>', {'class': 'cp-app-drive-tree-categories-container'})
.appendTo($tree);
if (displayedCategories.indexOf(TAGS) !== -1) { createCategory($div, TAGS); }
if (displayedCategories.indexOf(RECENT) !== -1) { createCategory($div, RECENT); }
if (displayedCategories.indexOf(OWNED) !== -1) { createCategory($div, OWNED); }
if (displayedCategories.indexOf(ROOT) !== -1) { createTree($div, [ROOT]); }
if (displayedCategories.indexOf(TEMPLATE) !== -1) { createCategory($div, TEMPLATE); }
if (displayedCategories.indexOf(FILES_DATA) !== -1) { createCategory($div, FILES_DATA); }
if (displayedCategories.indexOf(TRASH) !== -1) { createTrash($div, [TRASH]); }
$tree.append(APP.$limit);
$categories = $tree.find('.cp-app-drive-tree-categories-container');
$categories.scrollTop(s);
};
APP.hideMenu = function (e) {
$contextMenu.hide();
$trashTreeContextMenu.hide();
$trashContextMenu.hide();
$contentContextMenu.hide();
$defaultContextMenu.hide();
if (!e || !$(e.target).parents('.cp-dropdown')) {
$('.cp-dropdown-content').hide();
}
};
var stringifyPath = function (path) {
if (!Array.isArray(path)) { return; }
var $div = $('<div>');
var i = 0;
var space = 10;
path.forEach(function (s) {
if (i === 0) { s = getPrettyName(s); }
$div.append($('<span>', {'style': 'margin: 0 0 0 ' + i * space + 'px;'}).text(s));
$div.append($('<br>'));
i++;
});
return $div.html();
};
// Disable middle click in the context menu to avoid opening /drive/inner.html# in new tabs
$(window).click(function (e) {
if (!e.target || !$(e.target).parents('.cp-dropdown-content').length) { return; }
if (e.which !== 1) {
e.stopPropagation();
return false;
}
});
var getProperties = APP.getProperties = function (el, cb) {
if (!manager.isFile(el) && !manager.isSharedFolder(el)) {
return void cb('NOT_FILE');
}
//var ro = manager.isReadOnlyFile(el);
var base = APP.origin;
var data;
if (manager.isSharedFolder(el)) {
data = JSON.parse(JSON.stringify(manager.getSharedFolderData(el)));
} else {
data = JSON.parse(JSON.stringify(manager.getFileData(el)));
}
if (!data || !(data.href || data.roHref)) { return void cb('INVALID_FILE'); }
if (data.href) {
data.href = base + data.href;
}
if (data.roHref) {
data.roHref = base + data.roHref;
}
if (manager.isSharedFolder(el)) {
delete data.roHref;
//data.noPassword = true;
data.noEditPassword = true;
data.noExpiration = true;
}
UIElements.getProperties(common, data, cb);
};
if (!APP.loggedIn) {
$contextMenu.find('.cp-app-drive-context-delete').text(Messages.fc_remove)
.attr('data-icon', 'fa-eraser');
}
var deleteOwnedPaths = function (paths, pathsList) {
pathsList = pathsList || [];
if (paths) {
paths.forEach(function (p) { pathsList.push(p.path); });
}
var msgD = pathsList.length === 1 ? Messages.fm_deleteOwnedPad :
Messages.fm_deleteOwnedPads;
UI.confirm(msgD, function(res) {
$(window).focus();
if (!res) { return; }
manager.delete(pathsList, refresh);
});
};
$contextMenu.on("click", "a", function(e) {
e.stopPropagation();
var paths = $contextMenu.data('paths');
var pathsList = [];
var type = $contextMenu.attr('data-menu-type');
var el, data;
if (paths.length === 0) {
log(Messages.fm_forbidden);
debug("Context menu on a forbidden or unexisting element. ", paths);
return;
}
if ($(this).hasClass("cp-app-drive-context-rename")) {
if (paths.length !== 1) { return; }
displayRenameInput(paths[0].element, paths[0].path);
}
else if($(this).hasClass("cp-app-drive-context-delete")) {
if (!APP.loggedIn) {
return void deletePaths(paths);
}
paths.forEach(function (p) { pathsList.push(p.path); });
moveElements(pathsList, [TRASH], false, refresh);
}
else if ($(this).hasClass('cp-app-drive-context-deleteowned')) {
deleteOwnedPaths(paths);
}
else if ($(this).hasClass('cp-app-drive-context-open')) {
paths.forEach(function (p) {
var $element = p.element;
$element.click();
$element.dblclick();
});
}
else if ($(this).hasClass('cp-app-drive-context-openro')) {
paths.forEach(function (p) {
var el = manager.find(p.path);
if (paths[0].path[0] === SHARED_FOLDER && APP.newSharedFolder) {
// ANON_SHARED_FOLDER
el = manager.find(paths[0].path.slice(1), APP.newSharedFolder);
}
var href;
if (manager.isPathIn(p.path, [FILES_DATA])) {
href = el.roHref;
} else {
if (!el || manager.isFolder(el)) { return; }
var data = manager.getFileData(el);
href = data.roHref;
}
openFile(null, href);
});
}
else if ($(this).hasClass('cp-app-drive-context-download')) {
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
if (!manager.isFile(el)) { return; }
data = manager.getFileData(el);
APP.FM.downloadFile(data, function (err, obj) {
console.log(err, obj);
console.log('DONE');
});
}
else if ($(this).hasClass('cp-app-drive-context-share')) {
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
var parsed, modal;
if (manager.isSharedFolder(el)) {
data = manager.getSharedFolderData(el);
parsed = Hash.parsePadUrl(data.href);
modal = UIElements.createSFShareModal({
origin: APP.origin,
pathname: "/drive/",
hashes: {
editHash: parsed.hash
}
});
} else {
data = manager.getFileData(el);
parsed = Hash.parsePadUrl(data.href);
var roParsed = Hash.parsePadUrl(data.roHref);
var padType = parsed.type || roParsed.type;
var padData = {
origin: APP.origin,
pathname: "/" + padType + "/",
hashes: {
editHash: parsed.hash,
viewHash: roParsed.hash,
fileHash: parsed.hash
},
fileData: {
hash: parsed.hash,
password: data.password
},
common: common
};
modal = padType === 'file' ? UIElements.createFileShareModal(padData)
: UIElements.createShareModal(padData);
modal = UI.dialog.tabs(modal);
}
UI.openCustomModal(modal);
}
else if ($(this).hasClass('cp-app-drive-context-newfolder')) {
if (paths.length !== 1) { return; }
var onFolderCreated = function (err, info) {
if (err) { return void logError(err); }
APP.newFolder = info.newPath;
APP.displayDirectory(paths[0].path);
};
el = manager.find(paths[0].path);
if (manager.isSharedFolder(el)) {
paths[0].path.push(ROOT);
}
manager.addFolder(paths[0].path, null, onFolderCreated);
}
else if ($(this).hasClass('cp-app-drive-context-newsharedfolder')) {
if (paths.length !== 1) { return; }
addSharedFolderModal(function (obj) {
if (!obj) { return; }
manager.addSharedFolder(paths[0].path, obj, refresh);
});
}
else if ($(this).hasClass("cp-app-drive-context-newdoc")) {
var ntype = $(this).data('type') || 'pad';
var path2 = manager.isPathIn(currentPath, [TRASH]) ? '' : currentPath;
common.sessionStorage.put(Constants.newPadPathKey, path2, function () {
common.openURL('/' + ntype + '/');
});
}
else if ($(this).hasClass("cp-app-drive-context-properties")) {
if (type === 'trash') {
var pPath = paths[0].path;
if (paths.length !== 1 || pPath.length !== 4) { return; }
var element = manager.find(pPath.slice(0,3)); // element containing the oldpath
var sPath = stringifyPath(element.path);
UI.alert('<strong>' + Messages.fm_originalPath + "</strong>:<br>" + sPath, undefined, true);
return;
}
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
if (paths[0].path[0] === SHARED_FOLDER && APP.newSharedFolder) {
// ANON_SHARED_FOLDER
el = manager.find(paths[0].path.slice(1), APP.newSharedFolder);
}
getProperties(el, function (e, $prop) {
if (e) { return void logError(e); }
UI.alert($prop[0], undefined, true);
});
}
else if ($(this).hasClass("cp-app-drive-context-hashtag")) {
if (paths.length !== 1) { return; }
el = manager.find(paths[0].path);
data = manager.getFileData(el);
if (!data) { return void console.error("Expected to find a file"); }
var href = data.href || data.roHref;
common.updateTags(href);
}
else if ($(this).hasClass("cp-app-drive-context-empty")) {
if (paths.length !== 1 || !paths[0].element
|| !manager.comparePath(paths[0].path, [TRASH])) {
log(Messages.fm_forbidden);
return;
}
UI.confirm(Messages.fm_emptyTrashDialog, function(res) {
if (!res) { return; }
manager.emptyTrash(refresh);
});
}
else if ($(this).hasClass("cp-app-drive-context-remove")) {
return void deletePaths(paths);
}
else if ($(this).hasClass("cp-app-drive-context-removesf")) {
return void deletePaths(paths);
}
else if ($(this).hasClass("cp-app-drive-context-restore")) {
if (paths.length !== 1) { return; }
var restorePath = paths[0].path;
var restoreName = paths[0].path[paths[0].path.length - 1];
if (restorePath.length === 4) {
var rEl = manager.find(restorePath);
if (manager.isFile(rEl)) {
restoreName = manager.getTitle(rEl);
} else {
restoreName = restorePath[1];
}
}
UI.confirm(Messages._getKey("fm_restoreDialog", [restoreName]), function(res) {
if (!res) { return; }
manager.restore(restorePath, refresh);
});
}
else if ($(this).hasClass("cp-app-drive-context-openparent")) {
if (paths.length !== 1) { return; }
var parentPath = paths[0].path.slice();
if (manager.isInTrashRoot(parentPath)) { parentPath = [TRASH]; }
else { parentPath.pop(); }
el = manager.find(paths[0].path);
APP.selectedFiles = [el];
APP.displayDirectory(parentPath);
}
APP.hideMenu();
});
// Chrome considers the double-click means "select all" in the window
$content.on('mousedown', function (e) {
$content.focus();
e.preventDefault();
});
$appContainer.on('mouseup', function (e) {
//if (sel.down) { return; }
if (e.which !== 1) { return ; }
APP.hideMenu(e);
//removeSelected(e);
});
$appContainer.on('click', function (e) {
if (e.which !== 1) { return ; }
removeInput();
});
$appContainer.on('drag drop', function (e) {
removeInput();
APP.hideMenu(e);
});
$appContainer.on('mouseup drop', function () {
$('.cp-app-drive-element-droppable').removeClass('cp-app-drive-element-droppable');
});
$appContainer.on('keydown', function (e) {
// "Del"
if (e.which === 46) {
if (manager.isPathIn(currentPath, [FILES_DATA]) && APP.loggedIn) {
return; // We can't remove elements directly from filesData
}
var $selected = $('.cp-app-drive-element-selected');
if (!$selected.length) { return; }
var paths = [];
var isTrash = manager.isPathIn(currentPath, [TRASH]);
$selected.each(function (idx, elmt) {
if (!$(elmt).data('path')) { return; }
paths.push($(elmt).data('path'));
});
if (!paths.length) { return; }
// Remove shared folders from the selection (they can't be moved to the trash)
// unless the selection is only shared folders
var paths2 = paths.filter(function (p) {
var el = manager.find(p);
return !manager.isSharedFolder(el);
});
// If we are in the trash or anon pad or if we are holding the "shift" key,
// delete permanently
// Or if we are in a shared folder
// Or if the selection is only shared folders
if (!APP.loggedIn || isTrash || manager.isInSharedFolder(currentPath)
|| e.shiftKey || !paths2.length) {
deletePaths(null, paths);
return;
}
// else move to trash
moveElements(paths2, [TRASH], false, refresh);
return;
}
});
var isCharacterKey = function (e) {
return e.which === "undefined" /* IE */ ||
(e.which > 0 && e.which !== 13 && e.which !== 27 && !e.ctrlKey && !e.altKey);
};
$appContainer.on('keypress', function (e) {
var $searchBar = $tree.find('#cp-app-drive-tree-search-input');
if ($searchBar.is(':focus')) { return; }
if (isCharacterKey(e)) {
$searchBar.focus();
e.preventDefault();
return;
}
});
$appContainer.contextmenu(function () {
APP.hideMenu();
return false;
});
var onRefresh = {
refresh: function() {
if (onRefresh.to) {
window.clearTimeout(onRefresh.to);
}
onRefresh.to = window.setTimeout(refresh, 500);
}
};
sframeChan.on('EV_DRIVE_CHANGE', function (data) {
if (history.isHistoryMode) { return; }
var path = data.path.slice();
var originalPath = data.path.slice();
if (!APP.loggedIn && APP.newSharedFolder && data.id === APP.newSharedFolder) {
// ANON_SHARED_FOLDER
return void onRefresh.refresh();
}
// Fix the path if this is about a shared folder
if (data.id && manager.folders[data.id]) {
var uoPath = manager.getUserObjectPath(manager.folders[data.id].userObject);
if (uoPath) {
Array.prototype.unshift.apply(path, uoPath);
path.unshift('drive');
}
}
if (path[0] !== 'drive') { return false; }
path = path.slice(1);
if (originalPath[0] === 'drive') { originalPath = originalPath.slice(1); }
var cPath = currentPath.slice();
if (originalPath.length && originalPath[0] === FILES_DATA) {
onRefresh.refresh();
} else if ((manager.isPathIn(cPath, ['hrefArray', TRASH]) && cPath[0] === path[0]) ||
(path.length >= cPath.length && manager.isSubpath(path, cPath))) {
// Reload after a few ms to make sure all the change events have been received
onRefresh.refresh();
} else {
APP.resetTree();
}
return false;
});
sframeChan.on('EV_DRIVE_REMOVE', function (data) {
if (history.isHistoryMode) { return; }
var path = data.path.slice();
if (!APP.loggedIn && APP.newSharedFolder && data.id === APP.newSharedFolder) {
// ANON_SHARED_FOLDER
return void onRefresh.refresh();
}
// Fix the path if this is about a shared folder
if (data.id && manager.folders[data.id]) {
var uoPath = manager.getUserObjectPath(manager.folders[data.id].userObject);
if (uoPath) {
Array.prototype.unshift.apply(path, uoPath);
path.unshift('drive');
}
}
if (path[0] !== 'drive') { return false; }
path = path.slice(1);
var cPath = currentPath.slice();
if ((manager.isPathIn(cPath, ['hrefArray', TRASH]) && cPath[0] === path[0]) ||
(path.length >= cPath.length && manager.isSubpath(path, cPath))) {
// Reload after a few to make sure all the change events have been received
onRefresh.refresh();
} else {
APP.resetTree();
}
return false;
});
history.onEnterHistory = function (obj) {
copyObjectValue(files, obj.drive);
appStatus.isReady = true;
refresh();
};
history.onLeaveHistory = function () {
copyObjectValue(files, proxy.drive);
refresh();
};
var fmConfig = {
noHandlers: true,
onUploaded: function () {
refresh();
},
body: $('body')
};
APP.FM = common.createFileManager(fmConfig);
refresh();
UI.removeLoadingScreen();
sframeChan.query('Q_DRIVE_GETDELETED', null, function (err, data) {
var ids = manager.findChannels(data);
var titles = [];
ids.forEach(function (id) {
var title = manager.getTitle(id);
titles.push(title);
var paths = manager.findFile(id);
manager.delete(paths, refresh);
});
if (!titles.length) { return; }
UI.log(Messages._getKey('fm_deletedPads', [titles.join(', ')]));
});
};
var setHistory = function (bool, update) {
history.isHistoryMode = bool;
setEditable(!bool);
if (!bool && update) {
history.onLeaveHistory();
}
};
var main = function () {
var common;
var proxy = {};
var folders = {};
var readOnly;
nThen(function (waitFor) {
$(waitFor(function () {
UI.addLoadingScreen();
}));
window.cryptpadStore.getAll(waitFor(function (val) {
APP.store = JSON.parse(JSON.stringify(val));
}));
SFCommon.create(waitFor(function (c) { APP.common = common = c; }));
}).nThen(function (waitFor) {
var privReady = Util.once(waitFor());
var metadataMgr = common.getMetadataMgr();
if (JSON.stringify(metadataMgr.getPrivateData()) !== '{}') {
privReady();
return;
}
metadataMgr.onChange(function () {
if (typeof(metadataMgr.getPrivateData().readOnly) === 'boolean') {
readOnly = APP.readOnly = metadataMgr.getPrivateData().readOnly;
privReady();
}
});
}).nThen(function (waitFor) {
APP.loggedIn = common.isLoggedIn();
APP.SFCommon = common;
if (!APP.loggedIn) { Feedback.send('ANONYMOUS_DRIVE'); }
APP.$body = $('body');
APP.$bar = $('#cp-toolbar');
common.setTabTitle(Messages.type.drive);
/*var listmapConfig = {
data: {},
common: common,
logging: false
};*/
var metadataMgr = common.getMetadataMgr();
var privateData = metadataMgr.getPrivateData();
if (privateData.newSharedFolder) {
APP.newSharedFolder = privateData.newSharedFolder;
}
var sframeChan = common.getSframeChannel();
updateObject(sframeChan, proxy, waitFor(function () {
updateSharedFolders(sframeChan, null, proxy.drive, folders, waitFor());
}));
}).nThen(function () {
var sframeChan = common.getSframeChannel();
var metadataMgr = common.getMetadataMgr();
var privateData = metadataMgr.getPrivateData();
APP.disableSF = !privateData.enableSF && AppConfig.disableSharedFolders;
if (APP.newSharedFolder && !APP.loggedIn) {
readOnly = APP.readOnly = true;
var data = folders[APP.newSharedFolder];
if (data) {
sframeChan.query('Q_SET_PAD_TITLE_IN_DRIVE', {
title: data.metadata && data.metadata.title,
}, function () {});
}
}
// ANON_SHARED_FOLDER
var pageTitle = (!APP.loggedIn && APP.newSharedFolder) ? SHARED_FOLDER_NAME : Messages.type.drive;
var configTb = {
displayed: ['useradmin', 'pageTitle', 'newpad', 'limit', 'notifications'],
pageTitle: pageTitle,
metadataMgr: metadataMgr,
readOnly: privateData.readOnly,
sfCommon: common,
$container: APP.$bar
};
var toolbar = APP.toolbar = Toolbar.create(configTb);
var $rightside = toolbar.$rightside;
$rightside.html(''); // Remove the drawer if we don't use it to hide the toolbar
APP.$displayName = APP.$bar.find('.' + Toolbar.constants.username);
/* add the usage */
if (APP.loggedIn) {
common.createUsageBar(function (err, $limitContainer) {
if (err) { return void logError(err); }
APP.$limit = $limitContainer;
}, true);
}
/* add a history button */
APP.histConfig = {
onLocal: function () {
UI.addLoadingScreen({ loadingText: Messages.fm_restoreDrive });
proxy.drive = history.currentObj.drive;
sframeChan.query("Q_DRIVE_RESTORE", history.currentObj.drive, function () {
UI.removeLoadingScreen();
}, {
timeout: 5 * 60 * 1000
});
},
onRemote: function () {},
setHistory: setHistory,
applyVal: function (val) {
var obj = JSON.parse(val || '{}');
history.currentObj = obj;
history.onEnterHistory(obj);
},
$toolbar: APP.$bar,
};
// Add a "Burn this drive" button
if (!APP.loggedIn) {
APP.$burnThisDrive = common.createButton(null, true).click(function () {
UI.confirm(Messages.fm_burnThisDrive, function (yes) {
if (!yes) { return; }
common.getSframeChannel().event('EV_BURN_ANON_DRIVE');
}, null, true);
}).attr('title', Messages.fm_burnThisDriveButton)
.removeClass('fa-question')
.addClass('fa-ban');
}
metadataMgr.onChange(function () {
var name = metadataMgr.getUserData().name || Messages.anonymous;
APP.$displayName.text(name);
});
$('body').css('display', '');
APP.files = proxy;
if (!proxy.drive || typeof(proxy.drive) !== 'object') {
throw new Error("Corrupted drive");
}
andThen(common, proxy, folders);
var onDisconnect = APP.onDisconnect = function (noAlert) {
setEditable(false);
if (APP.refresh) { APP.refresh(); }
APP.toolbar.failed();
if (!noAlert) { UI.alert(Messages.common_connectionLost, undefined, true); }
};
var onReconnect = function (info) {
setEditable(true);
if (APP.refresh) { APP.refresh(); }
APP.toolbar.reconnecting(info.myId);
UI.findOKButton().click();
};
sframeChan.on('EV_DRIVE_LOG', function (msg) {
UI.log(msg);
});
sframeChan.on('EV_NETWORK_DISCONNECT', function () {
onDisconnect();
});
sframeChan.on('EV_NETWORK_RECONNECT', function (data) {
// data.myId;
onReconnect(data);
});
common.onLogout(function () { setEditable(false); });
});
};
main();
});
| Fix toolbar collapse in drive
| www/drive/inner.js | Fix toolbar collapse in drive | <ide><path>ww/drive/inner.js
<ide> }
<ide> return title;
<ide> }; */
<del>
<del> var drivePathOverflowing = function () {
<del> var $container = $(".cp-app-drive-path");
<del> if ($container.length) {
<del> $container.css("overflow", "hidden");
<del> var overflown = $container[0].scrollWidth > $container[0].clientWidth;
<del> $container.css("overflow", "");
<del> return overflown;
<del> }
<del> };
<del>
<del> var collapseDrivePath = function () {
<del> var $container = $(".cp-app-drive-path-inner");
<del> var $spanCollapse = $(".cp-app-drive-path-collapse");
<del> $spanCollapse.css("display", "none");
<del>
<del> var $pathElements = $container.find(".cp-app-drive-path-element");
<del> $pathElements.not($spanCollapse).css("display", "");
<del>
<del> if (drivePathOverflowing()) {
<del> var collapseLevel = 0;
<del> var removeOverflowElement = function () {
<del> if (drivePathOverflowing()) {
<del> if ($pathElements.length === 3) {
<del> return false;
<del> }
<del> collapseLevel++;
<del> if ($($pathElements.get(-2)).is(".cp-app-drive-path-separator")) {
<del> $($pathElements.get(-2)).css("display", "none");
<del> $pathElements = $pathElements.not($pathElements.get(-2));
<del> }
<del> $($pathElements.get(-2)).css("display", "none");
<del> $pathElements = $pathElements.not($pathElements.get(-2));
<del> return true;
<del> }
<del> };
<del>
<del> while (removeOverflowElement()) {}
<del> $spanCollapse.css("display", "");
<del> removeOverflowElement();
<del>
<del> $spanCollapse.attr("title", getLastOpenedFolder().slice(0, collapseLevel).join(" / ").replace("root", ROOT_NAME));
<del> $spanCollapse[0].onclick = function () {
<del> APP.displayDirectory(getLastOpenedFolder().slice(0, collapseLevel));
<del> };
<del> }
<del> };
<del>
<del> window.addEventListener("resize", collapseDrivePath);
<del> var treeResizeObserver = new MutationObserver(collapseDrivePath);
<del> treeResizeObserver.observe($("#cp-app-drive-tree")[0], {"attributes": true});
<del> var toolbarButtonAdditionObserver = new MutationObserver(collapseDrivePath);
<del> $(function () { toolbarButtonAdditionObserver.observe($("#cp-app-drive-toolbar")[0], {"childList": true, "subtree": true}); });
<ide>
<ide>
<ide> var getPrettyName = function (name) {
<ide> }
<ide> return pName;
<ide> };
<add>
<add>
<add> var drivePathOverflowing = function () {
<add> var $container = $(".cp-app-drive-path");
<add> if ($container.length) {
<add> $container.css("overflow", "hidden");
<add> var overflown = $container[0].scrollWidth > $container[0].clientWidth;
<add> $container.css("overflow", "");
<add> return overflown;
<add> }
<add> };
<add>
<add> var collapseDrivePath = function () {
<add> var $container = $(".cp-app-drive-path-inner");
<add> var $spanCollapse = $(".cp-app-drive-path-collapse");
<add> $spanCollapse.css("display", "none");
<add>
<add> var $pathElements = $container.find(".cp-app-drive-path-element");
<add> $pathElements.not($spanCollapse).css("display", "");
<add>
<add> if (currentPath.length > 1 && drivePathOverflowing()) {
<add> var collapseLevel = 0;
<add> var removeOverflowElement = function () {
<add> if (drivePathOverflowing()) {
<add> if ($pathElements.length <= 3) {
<add> return false;
<add> }
<add> collapseLevel++;
<add> if ($($pathElements.get(-2)).is(".cp-app-drive-path-separator")) {
<add> $($pathElements.get(-2)).css("display", "none");
<add> $pathElements = $pathElements.not($pathElements.get(-2));
<add> }
<add> $($pathElements.get(-2)).css("display", "none");
<add> $pathElements = $pathElements.not($pathElements.get(-2));
<add> return true;
<add> }
<add> };
<add>
<add> currentPath.every(removeOverflowElement);
<add> $spanCollapse.css("display", "");
<add> removeOverflowElement();
<add>
<add> var tipPath = currentPath.slice(0, collapseLevel);
<add> tipPath[0] = getPrettyName(tipPath[0]);
<add> $spanCollapse.attr("title", tipPath.join(" / "));
<add> $spanCollapse[0].onclick = function () {
<add> APP.displayDirectory(getLastOpenedFolder().slice(0, collapseLevel));
<add> };
<add> }
<add> };
<add>
<add> window.addEventListener("resize", collapseDrivePath);
<add> var treeResizeObserver = new MutationObserver(collapseDrivePath);
<add> treeResizeObserver.observe($("#cp-app-drive-tree")[0], {"attributes": true});
<add> var toolbarButtonAdditionObserver = new MutationObserver(collapseDrivePath);
<add> $(function () { toolbarButtonAdditionObserver.observe($("#cp-app-drive-toolbar")[0], {"childList": true, "subtree": true}); });
<add>
<ide>
<ide> // Create the title block with the "parent folder" button
<ide> var createTitle = function ($container, path, noStyle) { |
|
JavaScript | mit | 9d1780cd28439abcd4218a8257e7ed58691cef38 | 0 | jay-depot/turnpike,jay-depot/turnpike | var connect = require('express');
var GlobalConfig = require('./../../config');
/**
* @in turnpike.server.middleware
* @namespace
*/
var SessionWrapper = {};
SessionWrapper.csrf = function() { return function (req, res, next) { next(); }; };
SessionWrapper.csrf.state = false;
/**
* By default, sessions, and therefore CSRF, are off.
* This can be handy for things like, say, UI-less REST services that are using OAuth instead.
* This method enables them.
*/
SessionWrapper.enable = function() {
SessionWrapper.status = true;
};
//And it's almost as simple to change the storage engine.
//Since we like DRY code, setting a storage engine also enables sessions.
SessionWrapper.setSessionStorage = function(engine) {
if (engine) {
SessionWrapper.enable();
SessionWrapper.engine = engine;
//In almost every case, if you're using sesssions, you want CSRF protection too.
SessionWrapper.useCsrf(true);
}
};
//But, If you know what you're doing, it's easy to turn CSRF protection off again.
SessionWrapper.useCsrf = function(state) {
if (state) {
SessionWrapper.csrf = require('csurf');
SessionWrapper.csrf.state = true;
}
else {
SessionWrapper.csrf = function() { return function (req, res, next) { next(); }; };
SessionWrapper.csrf.state = false;
}
};
//This method is pure plumbing. It wraps Express' sessions so this module can handle them.
SessionWrapper.turnpikeSession = function() {
var settings = { secret: GlobalConfig.session_secret };
var engine = function(req, res, next) {console.log('no session engine');next();};
var session = require('express-session');
var express_session;
if (SessionWrapper.status) {
if (SessionWrapper.engine) {
settings.store = SessionWrapper.engine;
}
settings.secret = GlobalConfig.session_secret;
settings.resave = true;
settings.saveUninitialized = false;
express_session = session(settings);
engine = function (req, res, next) {
express_session(req, res, function() {
console.log(req);
req.session.messages = req.session.messages || [];
//UI Messages:
req.session.setMessage = function(message, callback) {
/*
* message should be an object with the following properties:
* text: A String equal to the HTML formatted text of the message itself.
* type: a String equal to one of
* success
* info
* warn
* error
*/
req.session.messages.push(message);
console.log('saved session messages', session.messages);
req.session.save(callback);
};
req.session.getMessages = function(cb) {
/*
* Returns an array containing all messages set against the session.
* This method clears all of the set messages. If you don't intend
* to display them, you should probably set them again, or access
* them some other way.
*/
var messages = req.session.messages;
req.session.messages = [];
req.session.save(function(err){
console.log('retrieved session messages', session.messages);
cb(err, messages);
});
};
next(false, req, res);
});
};
}
return engine;
};
module.exports = SessionWrapper;
| lib/server/middleware/SessionWrapper.js | var connect = require('express');
var GlobalConfig = require('./../../config');
/**
* @in turnpike.server.middleware
* @namespace
*/
var SessionWrapper = {};
SessionWrapper.csrf = function() { return function (req, res, next) { next(); }; };
SessionWrapper.csrf.state = false;
/**
* By default, sessions, and therefore CSRF, are off.
* This can be handy for things like, say, UI-less REST services that are using OAuth instead.
* This method enables them.
*/
SessionWrapper.enable = function() {
SessionWrapper.status = true;
};
//And it's almost as simple to change the storage engine.
//Since we like DRY code, setting a storage engine also enables sessions.
SessionWrapper.setSessionStorage = function(engine) {
if (engine) {
SessionWrapper.enable();
SessionWrapper.engine = engine;
//In almost every case, if you're using sesssions, you want CSRF protection too.
SessionWrapper.useCsrf(true);
}
};
//But, If you know what you're doing, it's easy to turn CSRF protection off again.
SessionWrapper.useCsrf = function(state) {
if (state) {
SessionWrapper.csrf = require('csurf');
SessionWrapper.csrf.state = true;
}
else {
SessionWrapper.csrf = function() { return function (req, res, next) { next(); }; };
SessionWrapper.csrf.state = false;
}
};
//This method is pure plumbing. It wraps Express' sessions so this module can handle them.
SessionWrapper.turnpikeSession = function() {
var settings = { secret: GlobalConfig.session_secret };
var engine = function(req, res, next) {console.log('no session engine');next();};
var session = require('express-session');
var express_session;
if (SessionWrapper.status) {
if (SessionWrapper.engine) {
settings.store = SessionWrapper.engine;
}
settings.secret = GlobalConfig.session_secret;
express_session = session(settings);
engine = function (req, res, next) {
express_session(req, res, function() {
console.log(req);
req.session.messages = req.session.messages || [];
//UI Messages:
req.session.setMessage = function(message, callback) {
/*
* message should be an object with the following properties:
* text: A String equal to the HTML formatted text of the message itself.
* type: a String equal to one of
* success
* info
* warn
* error
*/
req.session.messages.push(message);
console.log('saved session messages', session.messages);
req.session.save(callback);
};
req.session.getMessages = function(cb) {
/*
* Returns an array containing all messages set against the session.
* This method clears all of the set messages. If you don't intend
* to display them, you should probably set them again, or access
* them some other way.
*/
var messages = req.session.messages;
req.session.messages = [];
req.session.save(function(err){
console.log('retrieved session messages', session.messages);
cb(err, messages);
});
};
next(false, req, res);
});
};
}
return engine;
};
module.exports = SessionWrapper;
| Fix some deprecation warnings from express-session when sessions are enabled
| lib/server/middleware/SessionWrapper.js | Fix some deprecation warnings from express-session when sessions are enabled | <ide><path>ib/server/middleware/SessionWrapper.js
<ide> settings.store = SessionWrapper.engine;
<ide> }
<ide> settings.secret = GlobalConfig.session_secret;
<add> settings.resave = true;
<add> settings.saveUninitialized = false;
<ide> express_session = session(settings);
<ide>
<ide> engine = function (req, res, next) { |
|
Java | apache-2.0 | 779508ef61feec261be62b81bf7db8f94669a4d3 | 0 | pwoodworth/intellij-community,slisson/intellij-community,ibinti/intellij-community,FHannes/intellij-community,idea4bsd/idea4bsd,muntasirsyed/intellij-community,SerCeMan/intellij-community,asedunov/intellij-community,ibinti/intellij-community,signed/intellij-community,supersven/intellij-community,michaelgallacher/intellij-community,samthor/intellij-community,fengbaicanhe/intellij-community,orekyuu/intellij-community,FHannes/intellij-community,da1z/intellij-community,salguarnieri/intellij-community,adedayo/intellij-community,slisson/intellij-community,lucafavatella/intellij-community,slisson/intellij-community,Lekanich/intellij-community,signed/intellij-community,da1z/intellij-community,ryano144/intellij-community,dslomov/intellij-community,supersven/intellij-community,mglukhikh/intellij-community,TangHao1987/intellij-community,ftomassetti/intellij-community,akosyakov/intellij-community,idea4bsd/idea4bsd,vvv1559/intellij-community,diorcety/intellij-community,apixandru/intellij-community,michaelgallacher/intellij-community,idea4bsd/idea4bsd,clumsy/intellij-community,MichaelNedzelsky/intellij-community,ivan-fedorov/intellij-community,amith01994/intellij-community,ThiagoGarciaAlves/intellij-community,caot/intellij-community,Lekanich/intellij-community,apixandru/intellij-community,alphafoobar/intellij-community,clumsy/intellij-community,vladmm/intellij-community,ahb0327/intellij-community,da1z/intellij-community,allotria/intellij-community,wreckJ/intellij-community,robovm/robovm-studio,vvv1559/intellij-community,alphafoobar/intellij-community,supersven/intellij-community,supersven/intellij-community,vladmm/intellij-community,Lekanich/intellij-community,allotria/intellij-community,ol-loginov/intellij-community,kool79/intellij-community,ftomassetti/intellij-community,mglukhikh/intellij-community,wreckJ/intellij-community,fengbaicanhe/intellij-community,akosyakov/intellij-community,allotria/intellij-community,ryano144/intellij-community,ftomassetti/intellij-community,Distrotech/intellij-community,mglukhikh/intellij-community,fnouama/intellij-community,supersven/intellij-community,dslomov/intellij-community,diorcety/intellij-community,MER-GROUP/intellij-community,ryano144/intellij-community,ThiagoGarciaAlves/intellij-community,holmes/intellij-community,Distrotech/intellij-community,asedunov/intellij-community,mglukhikh/intellij-community,akosyakov/intellij-community,ThiagoGarciaAlves/intellij-community,petteyg/intellij-community,gnuhub/intellij-community,izonder/intellij-community,mglukhikh/intellij-community,mglukhikh/intellij-community,clumsy/intellij-community,vvv1559/intellij-community,ftomassetti/intellij-community,signed/intellij-community,gnuhub/intellij-community,ftomassetti/intellij-community,da1z/intellij-community,ftomassetti/intellij-community,tmpgit/intellij-community,ivan-fedorov/intellij-community,kool79/intellij-community,ryano144/intellij-community,wreckJ/intellij-community,supersven/intellij-community,xfournet/intellij-community,dslomov/intellij-community,alphafoobar/intellij-community,jagguli/intellij-community,holmes/intellij-community,slisson/intellij-community,apixandru/intellij-community,kool79/intellij-community,caot/intellij-community,petteyg/intellij-community,signed/intellij-community,FHannes/intellij-community,robovm/robovm-studio,xfournet/intellij-community,jagguli/intellij-community,ol-loginov/intellij-community,pwoodworth/intellij-community,idea4bsd/idea4bsd,tmpgit/intellij-community,ivan-fedorov/intellij-community,tmpgit/intellij-community,allotria/intellij-community,izonder/intellij-community,vladmm/intellij-community,slisson/intellij-community,ryano144/intellij-community,slisson/intellij-community,pwoodworth/intellij-community,suncycheng/intellij-community,izonder/intellij-community,petteyg/intellij-community,gnuhub/intellij-community,slisson/intellij-community,vladmm/intellij-community,MER-GROUP/intellij-community,youdonghai/intellij-community,fnouama/intellij-community,xfournet/intellij-community,fnouama/intellij-community,SerCeMan/intellij-community,signed/intellij-community,youdonghai/intellij-community,dslomov/intellij-community,MER-GROUP/intellij-community,akosyakov/intellij-community,michaelgallacher/intellij-community,ivan-fedorov/intellij-community,xfournet/intellij-community,idea4bsd/idea4bsd,muntasirsyed/intellij-community,allotria/intellij-community,Distrotech/intellij-community,MER-GROUP/intellij-community,amith01994/intellij-community,hurricup/intellij-community,lucafavatella/intellij-community,jagguli/intellij-community,samthor/intellij-community,ol-loginov/intellij-community,diorcety/intellij-community,muntasirsyed/intellij-community,holmes/intellij-community,fengbaicanhe/intellij-community,semonte/intellij-community,holmes/intellij-community,vladmm/intellij-community,signed/intellij-community,jagguli/intellij-community,wreckJ/intellij-community,vladmm/intellij-community,fitermay/intellij-community,vladmm/intellij-community,apixandru/intellij-community,ryano144/intellij-community,Distrotech/intellij-community,MER-GROUP/intellij-community,ThiagoGarciaAlves/intellij-community,caot/intellij-community,Distrotech/intellij-community,semonte/intellij-community,adedayo/intellij-community,nicolargo/intellij-community,robovm/robovm-studio,ThiagoGarciaAlves/intellij-community,gnuhub/intellij-community,wreckJ/intellij-community,vladmm/intellij-community,kool79/intellij-community,xfournet/intellij-community,retomerz/intellij-community,kool79/intellij-community,muntasirsyed/intellij-community,fitermay/intellij-community,lucafavatella/intellij-community,allotria/intellij-community,clumsy/intellij-community,ivan-fedorov/intellij-community,akosyakov/intellij-community,Lekanich/intellij-community,samthor/intellij-community,youdonghai/intellij-community,ivan-fedorov/intellij-community,caot/intellij-community,idea4bsd/idea4bsd,Distrotech/intellij-community,retomerz/intellij-community,Lekanich/intellij-community,SerCeMan/intellij-community,fnouama/intellij-community,slisson/intellij-community,tmpgit/intellij-community,retomerz/intellij-community,akosyakov/intellij-community,wreckJ/intellij-community,lucafavatella/intellij-community,idea4bsd/idea4bsd,muntasirsyed/intellij-community,clumsy/intellij-community,jagguli/intellij-community,TangHao1987/intellij-community,izonder/intellij-community,tmpgit/intellij-community,caot/intellij-community,idea4bsd/idea4bsd,wreckJ/intellij-community,ryano144/intellij-community,diorcety/intellij-community,robovm/robovm-studio,ibinti/intellij-community,adedayo/intellij-community,pwoodworth/intellij-community,nicolargo/intellij-community,blademainer/intellij-community,ibinti/intellij-community,xfournet/intellij-community,nicolargo/intellij-community,salguarnieri/intellij-community,fengbaicanhe/intellij-community,izonder/intellij-community,tmpgit/intellij-community,allotria/intellij-community,asedunov/intellij-community,orekyuu/intellij-community,robovm/robovm-studio,jagguli/intellij-community,asedunov/intellij-community,Lekanich/intellij-community,fnouama/intellij-community,Distrotech/intellij-community,ahb0327/intellij-community,TangHao1987/intellij-community,gnuhub/intellij-community,ThiagoGarciaAlves/intellij-community,caot/intellij-community,allotria/intellij-community,MichaelNedzelsky/intellij-community,petteyg/intellij-community,supersven/intellij-community,ThiagoGarciaAlves/intellij-community,fitermay/intellij-community,orekyuu/intellij-community,retomerz/intellij-community,allotria/intellij-community,apixandru/intellij-community,akosyakov/intellij-community,asedunov/intellij-community,youdonghai/intellij-community,hurricup/intellij-community,slisson/intellij-community,fitermay/intellij-community,kdwink/intellij-community,da1z/intellij-community,orekyuu/intellij-community,idea4bsd/idea4bsd,vladmm/intellij-community,fengbaicanhe/intellij-community,ibinti/intellij-community,jagguli/intellij-community,orekyuu/intellij-community,diorcety/intellij-community,apixandru/intellij-community,suncycheng/intellij-community,michaelgallacher/intellij-community,fitermay/intellij-community,kdwink/intellij-community,SerCeMan/intellij-community,muntasirsyed/intellij-community,ftomassetti/intellij-community,holmes/intellij-community,TangHao1987/intellij-community,gnuhub/intellij-community,Lekanich/intellij-community,MER-GROUP/intellij-community,supersven/intellij-community,FHannes/intellij-community,orekyuu/intellij-community,fitermay/intellij-community,amith01994/intellij-community,TangHao1987/intellij-community,suncycheng/intellij-community,youdonghai/intellij-community,MichaelNedzelsky/intellij-community,wreckJ/intellij-community,fitermay/intellij-community,ThiagoGarciaAlves/intellij-community,michaelgallacher/intellij-community,SerCeMan/intellij-community,da1z/intellij-community,ol-loginov/intellij-community,adedayo/intellij-community,ftomassetti/intellij-community,ftomassetti/intellij-community,orekyuu/intellij-community,Distrotech/intellij-community,fnouama/intellij-community,fengbaicanhe/intellij-community,vvv1559/intellij-community,wreckJ/intellij-community,pwoodworth/intellij-community,salguarnieri/intellij-community,FHannes/intellij-community,blademainer/intellij-community,youdonghai/intellij-community,pwoodworth/intellij-community,salguarnieri/intellij-community,semonte/intellij-community,lucafavatella/intellij-community,fnouama/intellij-community,supersven/intellij-community,izonder/intellij-community,samthor/intellij-community,wreckJ/intellij-community,alphafoobar/intellij-community,lucafavatella/intellij-community,ahb0327/intellij-community,ahb0327/intellij-community,FHannes/intellij-community,alphafoobar/intellij-community,da1z/intellij-community,ol-loginov/intellij-community,da1z/intellij-community,MichaelNedzelsky/intellij-community,michaelgallacher/intellij-community,MER-GROUP/intellij-community,alphafoobar/intellij-community,signed/intellij-community,ivan-fedorov/intellij-community,ibinti/intellij-community,jagguli/intellij-community,Lekanich/intellij-community,holmes/intellij-community,gnuhub/intellij-community,allotria/intellij-community,apixandru/intellij-community,vvv1559/intellij-community,SerCeMan/intellij-community,ryano144/intellij-community,ahb0327/intellij-community,robovm/robovm-studio,jagguli/intellij-community,lucafavatella/intellij-community,TangHao1987/intellij-community,amith01994/intellij-community,mglukhikh/intellij-community,tmpgit/intellij-community,akosyakov/intellij-community,vladmm/intellij-community,vvv1559/intellij-community,kdwink/intellij-community,asedunov/intellij-community,FHannes/intellij-community,amith01994/intellij-community,youdonghai/intellij-community,vladmm/intellij-community,ftomassetti/intellij-community,hurricup/intellij-community,amith01994/intellij-community,nicolargo/intellij-community,wreckJ/intellij-community,FHannes/intellij-community,asedunov/intellij-community,salguarnieri/intellij-community,ftomassetti/intellij-community,nicolargo/intellij-community,nicolargo/intellij-community,semonte/intellij-community,michaelgallacher/intellij-community,TangHao1987/intellij-community,ryano144/intellij-community,SerCeMan/intellij-community,retomerz/intellij-community,lucafavatella/intellij-community,vvv1559/intellij-community,holmes/intellij-community,MichaelNedzelsky/intellij-community,youdonghai/intellij-community,adedayo/intellij-community,xfournet/intellij-community,akosyakov/intellij-community,hurricup/intellij-community,signed/intellij-community,salguarnieri/intellij-community,samthor/intellij-community,caot/intellij-community,ThiagoGarciaAlves/intellij-community,hurricup/intellij-community,pwoodworth/intellij-community,muntasirsyed/intellij-community,vladmm/intellij-community,fitermay/intellij-community,ol-loginov/intellij-community,TangHao1987/intellij-community,alphafoobar/intellij-community,nicolargo/intellij-community,nicolargo/intellij-community,vvv1559/intellij-community,michaelgallacher/intellij-community,fnouama/intellij-community,clumsy/intellij-community,fitermay/intellij-community,semonte/intellij-community,ol-loginov/intellij-community,fengbaicanhe/intellij-community,ibinti/intellij-community,lucafavatella/intellij-community,robovm/robovm-studio,slisson/intellij-community,semonte/intellij-community,samthor/intellij-community,ol-loginov/intellij-community,slisson/intellij-community,xfournet/intellij-community,suncycheng/intellij-community,diorcety/intellij-community,diorcety/intellij-community,hurricup/intellij-community,jagguli/intellij-community,fitermay/intellij-community,allotria/intellij-community,kdwink/intellij-community,TangHao1987/intellij-community,apixandru/intellij-community,adedayo/intellij-community,kool79/intellij-community,adedayo/intellij-community,MichaelNedzelsky/intellij-community,xfournet/intellij-community,retomerz/intellij-community,nicolargo/intellij-community,retomerz/intellij-community,ol-loginov/intellij-community,youdonghai/intellij-community,michaelgallacher/intellij-community,hurricup/intellij-community,kool79/intellij-community,pwoodworth/intellij-community,diorcety/intellij-community,youdonghai/intellij-community,orekyuu/intellij-community,muntasirsyed/intellij-community,MER-GROUP/intellij-community,SerCeMan/intellij-community,SerCeMan/intellij-community,izonder/intellij-community,asedunov/intellij-community,youdonghai/intellij-community,suncycheng/intellij-community,robovm/robovm-studio,clumsy/intellij-community,ThiagoGarciaAlves/intellij-community,suncycheng/intellij-community,pwoodworth/intellij-community,pwoodworth/intellij-community,MichaelNedzelsky/intellij-community,kool79/intellij-community,dslomov/intellij-community,kool79/intellij-community,MER-GROUP/intellij-community,idea4bsd/idea4bsd,pwoodworth/intellij-community,apixandru/intellij-community,petteyg/intellij-community,caot/intellij-community,da1z/intellij-community,FHannes/intellij-community,FHannes/intellij-community,salguarnieri/intellij-community,SerCeMan/intellij-community,ryano144/intellij-community,FHannes/intellij-community,mglukhikh/intellij-community,holmes/intellij-community,TangHao1987/intellij-community,suncycheng/intellij-community,allotria/intellij-community,michaelgallacher/intellij-community,akosyakov/intellij-community,kdwink/intellij-community,asedunov/intellij-community,kdwink/intellij-community,fnouama/intellij-community,salguarnieri/intellij-community,alphafoobar/intellij-community,blademainer/intellij-community,clumsy/intellij-community,pwoodworth/intellij-community,orekyuu/intellij-community,tmpgit/intellij-community,ibinti/intellij-community,kdwink/intellij-community,michaelgallacher/intellij-community,gnuhub/intellij-community,nicolargo/intellij-community,Lekanich/intellij-community,alphafoobar/intellij-community,kdwink/intellij-community,ibinti/intellij-community,diorcety/intellij-community,dslomov/intellij-community,gnuhub/intellij-community,blademainer/intellij-community,kdwink/intellij-community,dslomov/intellij-community,Distrotech/intellij-community,semonte/intellij-community,fnouama/intellij-community,samthor/intellij-community,MichaelNedzelsky/intellij-community,retomerz/intellij-community,robovm/robovm-studio,signed/intellij-community,vvv1559/intellij-community,suncycheng/intellij-community,gnuhub/intellij-community,izonder/intellij-community,salguarnieri/intellij-community,robovm/robovm-studio,MichaelNedzelsky/intellij-community,semonte/intellij-community,xfournet/intellij-community,tmpgit/intellij-community,ivan-fedorov/intellij-community,da1z/intellij-community,muntasirsyed/intellij-community,alphafoobar/intellij-community,tmpgit/intellij-community,suncycheng/intellij-community,hurricup/intellij-community,da1z/intellij-community,dslomov/intellij-community,izonder/intellij-community,supersven/intellij-community,FHannes/intellij-community,izonder/intellij-community,caot/intellij-community,fitermay/intellij-community,ibinti/intellij-community,semonte/intellij-community,ryano144/intellij-community,mglukhikh/intellij-community,ftomassetti/intellij-community,ahb0327/intellij-community,petteyg/intellij-community,gnuhub/intellij-community,lucafavatella/intellij-community,blademainer/intellij-community,semonte/intellij-community,vvv1559/intellij-community,fengbaicanhe/intellij-community,idea4bsd/idea4bsd,fengbaicanhe/intellij-community,lucafavatella/intellij-community,kdwink/intellij-community,vvv1559/intellij-community,ibinti/intellij-community,caot/intellij-community,hurricup/intellij-community,salguarnieri/intellij-community,fitermay/intellij-community,amith01994/intellij-community,dslomov/intellij-community,da1z/intellij-community,idea4bsd/idea4bsd,hurricup/intellij-community,ahb0327/intellij-community,MER-GROUP/intellij-community,ahb0327/intellij-community,hurricup/intellij-community,FHannes/intellij-community,apixandru/intellij-community,tmpgit/intellij-community,blademainer/intellij-community,ahb0327/intellij-community,retomerz/intellij-community,youdonghai/intellij-community,supersven/intellij-community,clumsy/intellij-community,izonder/intellij-community,adedayo/intellij-community,petteyg/intellij-community,diorcety/intellij-community,fnouama/intellij-community,adedayo/intellij-community,ivan-fedorov/intellij-community,ivan-fedorov/intellij-community,dslomov/intellij-community,ahb0327/intellij-community,Distrotech/intellij-community,ivan-fedorov/intellij-community,akosyakov/intellij-community,blademainer/intellij-community,tmpgit/intellij-community,petteyg/intellij-community,ThiagoGarciaAlves/intellij-community,michaelgallacher/intellij-community,adedayo/intellij-community,samthor/intellij-community,salguarnieri/intellij-community,lucafavatella/intellij-community,retomerz/intellij-community,semonte/intellij-community,mglukhikh/intellij-community,muntasirsyed/intellij-community,hurricup/intellij-community,petteyg/intellij-community,Lekanich/intellij-community,MichaelNedzelsky/intellij-community,fengbaicanhe/intellij-community,blademainer/intellij-community,dslomov/intellij-community,SerCeMan/intellij-community,xfournet/intellij-community,retomerz/intellij-community,orekyuu/intellij-community,petteyg/intellij-community,youdonghai/intellij-community,fitermay/intellij-community,samthor/intellij-community,kool79/intellij-community,suncycheng/intellij-community,muntasirsyed/intellij-community,signed/intellij-community,suncycheng/intellij-community,robovm/robovm-studio,Distrotech/intellij-community,robovm/robovm-studio,ol-loginov/intellij-community,apixandru/intellij-community,clumsy/intellij-community,amith01994/intellij-community,retomerz/intellij-community,diorcety/intellij-community,MichaelNedzelsky/intellij-community,kool79/intellij-community,izonder/intellij-community,petteyg/intellij-community,nicolargo/intellij-community,samthor/intellij-community,asedunov/intellij-community,supersven/intellij-community,ibinti/intellij-community,vvv1559/intellij-community,fengbaicanhe/intellij-community,signed/intellij-community,adedayo/intellij-community,ahb0327/intellij-community,jagguli/intellij-community,asedunov/intellij-community,suncycheng/intellij-community,amith01994/intellij-community,diorcety/intellij-community,blademainer/intellij-community,asedunov/intellij-community,slisson/intellij-community,mglukhikh/intellij-community,SerCeMan/intellij-community,MER-GROUP/intellij-community,TangHao1987/intellij-community,dslomov/intellij-community,samthor/intellij-community,adedayo/intellij-community,clumsy/intellij-community,asedunov/intellij-community,blademainer/intellij-community,semonte/intellij-community,TangHao1987/intellij-community,jagguli/intellij-community,samthor/intellij-community,ryano144/intellij-community,kdwink/intellij-community,kdwink/intellij-community,amith01994/intellij-community,semonte/intellij-community,retomerz/intellij-community,hurricup/intellij-community,muntasirsyed/intellij-community,ol-loginov/intellij-community,apixandru/intellij-community,Distrotech/intellij-community,holmes/intellij-community,wreckJ/intellij-community,nicolargo/intellij-community,signed/intellij-community,ibinti/intellij-community,MER-GROUP/intellij-community,clumsy/intellij-community,holmes/intellij-community,caot/intellij-community,fnouama/intellij-community,lucafavatella/intellij-community,amith01994/intellij-community,mglukhikh/intellij-community,xfournet/intellij-community,blademainer/intellij-community,ol-loginov/intellij-community,ThiagoGarciaAlves/intellij-community,xfournet/intellij-community,vvv1559/intellij-community,akosyakov/intellij-community,idea4bsd/idea4bsd,amith01994/intellij-community,alphafoobar/intellij-community,signed/intellij-community,Lekanich/intellij-community,mglukhikh/intellij-community,ivan-fedorov/intellij-community,da1z/intellij-community,gnuhub/intellij-community,kool79/intellij-community,MichaelNedzelsky/intellij-community,blademainer/intellij-community,alphafoobar/intellij-community,caot/intellij-community,orekyuu/intellij-community,holmes/intellij-community,Lekanich/intellij-community,holmes/intellij-community,apixandru/intellij-community,fengbaicanhe/intellij-community,salguarnieri/intellij-community,orekyuu/intellij-community,allotria/intellij-community,apixandru/intellij-community,ahb0327/intellij-community,petteyg/intellij-community | /*
* Copyright 2000-2009 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 com.intellij.debugger.engine;
import com.intellij.debugger.NoDataException;
import com.intellij.debugger.PositionManager;
import com.intellij.debugger.SourcePosition;
import com.intellij.debugger.engine.evaluation.EvaluationContext;
import com.intellij.debugger.jdi.StackFrameProxyImpl;
import com.intellij.debugger.requests.ClassPrepareRequestor;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.util.ThreeState;
import com.intellij.xdebugger.frame.XStackFrame;
import com.sun.jdi.Location;
import com.sun.jdi.ReferenceType;
import com.sun.jdi.request.ClassPrepareRequest;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class CompoundPositionManager extends PositionManagerEx {
private static final Logger LOG = Logger.getInstance(CompoundPositionManager.class);
private final ArrayList<PositionManager> myPositionManagers = new ArrayList<PositionManager>();
@SuppressWarnings("UnusedDeclaration")
public CompoundPositionManager() {
}
public CompoundPositionManager(PositionManager manager) {
appendPositionManager(manager);
}
public void appendPositionManager(PositionManager manager) {
myPositionManagers.remove(manager);
myPositionManagers.add(0, manager);
}
@Override
public SourcePosition getSourcePosition(Location location) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.getSourcePosition(location);
}
catch (NoDataException ignored) {
}
catch (Exception e) {
LOG.error(e);
}
}
return null;
}
@Override
@NotNull
public List<ReferenceType> getAllClasses(@NotNull SourcePosition classPosition) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.getAllClasses(classPosition);
}
catch (NoDataException ignored) {
}
catch (Exception e) {
LOG.error(e);
}
}
return Collections.emptyList();
}
@Override
@NotNull
public List<Location> locationsOfLine(@NotNull ReferenceType type, @NotNull SourcePosition position) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.locationsOfLine(type, position);
}
catch (NoDataException ignored) {
}
catch (Exception e) {
LOG.error(e);
}
}
return Collections.emptyList();
}
@Override
public ClassPrepareRequest createPrepareRequest(@NotNull ClassPrepareRequestor requestor, @NotNull SourcePosition position) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.createPrepareRequest(requestor, position);
}
catch (NoDataException ignored) {
}
catch (Exception e) {
LOG.error(e);
}
}
return null;
}
@Nullable
@Override
public XStackFrame createStackFrame(@NotNull StackFrameProxyImpl frame, @NotNull DebugProcessImpl debugProcess, @NotNull Location location) {
for (PositionManager positionManager : myPositionManagers) {
if (positionManager instanceof PositionManagerEx) {
try {
XStackFrame xStackFrame = ((PositionManagerEx)positionManager).createStackFrame(frame, debugProcess, location);
if (xStackFrame != null) {
return xStackFrame;
}
}
catch (Throwable e) {
LOG.error(e);
}
}
}
return null;
}
@Override
public ThreeState evaluateCondition(@NotNull EvaluationContext context,
@NotNull StackFrameProxyImpl frame,
@NotNull Location location,
@NotNull String expression) {
for (PositionManager positionManager : myPositionManagers) {
if (positionManager instanceof PositionManagerEx) {
try {
ThreeState result = ((PositionManagerEx)positionManager).evaluateCondition(context, frame, location, expression);
if (result != ThreeState.UNSURE) {
return result;
}
}
catch (Throwable e) {
LOG.error(e);
}
}
}
return ThreeState.UNSURE;
}
}
| java/debugger/impl/src/com/intellij/debugger/engine/CompoundPositionManager.java | /*
* Copyright 2000-2009 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 com.intellij.debugger.engine;
import com.intellij.debugger.NoDataException;
import com.intellij.debugger.PositionManager;
import com.intellij.debugger.SourcePosition;
import com.intellij.debugger.engine.evaluation.EvaluationContext;
import com.intellij.debugger.jdi.StackFrameProxyImpl;
import com.intellij.debugger.requests.ClassPrepareRequestor;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.util.ThreeState;
import com.intellij.xdebugger.frame.XStackFrame;
import com.sun.jdi.Location;
import com.sun.jdi.ReferenceType;
import com.sun.jdi.request.ClassPrepareRequest;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class CompoundPositionManager extends PositionManagerEx {
private static final Logger LOG = Logger.getInstance(CompoundPositionManager.class);
private final ArrayList<PositionManager> myPositionManagers = new ArrayList<PositionManager>();
@SuppressWarnings("UnusedDeclaration")
public CompoundPositionManager() {
}
public CompoundPositionManager(PositionManager manager) {
appendPositionManager(manager);
}
public void appendPositionManager(PositionManager manager) {
myPositionManagers.remove(manager);
myPositionManagers.add(0, manager);
}
@Override
public SourcePosition getSourcePosition(Location location) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.getSourcePosition(location);
}
catch (NoDataException ignored) {
}
}
return null;
}
@Override
@NotNull
public List<ReferenceType> getAllClasses(SourcePosition classPosition) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.getAllClasses(classPosition);
}
catch (NoDataException ignored) {
}
}
return Collections.emptyList();
}
@Override
@NotNull
public List<Location> locationsOfLine(ReferenceType type, SourcePosition position) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.locationsOfLine(type, position);
}
catch (NoDataException ignored) {
}
}
return Collections.emptyList();
}
@Override
public ClassPrepareRequest createPrepareRequest(ClassPrepareRequestor requestor, SourcePosition position) {
for (PositionManager positionManager : myPositionManagers) {
try {
return positionManager.createPrepareRequest(requestor, position);
}
catch (NoDataException ignored) {
}
}
return null;
}
@Nullable
@Override
public XStackFrame createStackFrame(@NotNull StackFrameProxyImpl frame, @NotNull DebugProcessImpl debugProcess, @NotNull Location location) {
for (PositionManager positionManager : myPositionManagers) {
if (positionManager instanceof PositionManagerEx) {
try {
XStackFrame xStackFrame = ((PositionManagerEx)positionManager).createStackFrame(frame, debugProcess, location);
if (xStackFrame != null) {
return xStackFrame;
}
}
catch (Throwable e) {
LOG.error(e);
}
}
}
return null;
}
@Override
public ThreeState evaluateCondition(@NotNull EvaluationContext context,
@NotNull StackFrameProxyImpl frame,
@NotNull Location location,
@NotNull String expression) {
for (PositionManager positionManager : myPositionManagers) {
if (positionManager instanceof PositionManagerEx) {
try {
ThreeState result = ((PositionManagerEx)positionManager).evaluateCondition(context, frame, location, expression);
if (result != ThreeState.UNSURE) {
return result;
}
}
catch (Throwable e) {
LOG.error(e);
}
}
}
return ThreeState.UNSURE;
}
}
| do not stop in case of exceptions in position managers impls
| java/debugger/impl/src/com/intellij/debugger/engine/CompoundPositionManager.java | do not stop in case of exceptions in position managers impls | <ide><path>ava/debugger/impl/src/com/intellij/debugger/engine/CompoundPositionManager.java
<ide> }
<ide> catch (NoDataException ignored) {
<ide> }
<add> catch (Exception e) {
<add> LOG.error(e);
<add> }
<ide> }
<ide> return null;
<ide> }
<ide>
<ide> @Override
<ide> @NotNull
<del> public List<ReferenceType> getAllClasses(SourcePosition classPosition) {
<add> public List<ReferenceType> getAllClasses(@NotNull SourcePosition classPosition) {
<ide> for (PositionManager positionManager : myPositionManagers) {
<ide> try {
<ide> return positionManager.getAllClasses(classPosition);
<ide> }
<ide> catch (NoDataException ignored) {
<add> }
<add> catch (Exception e) {
<add> LOG.error(e);
<ide> }
<ide> }
<ide> return Collections.emptyList();
<ide>
<ide> @Override
<ide> @NotNull
<del> public List<Location> locationsOfLine(ReferenceType type, SourcePosition position) {
<add> public List<Location> locationsOfLine(@NotNull ReferenceType type, @NotNull SourcePosition position) {
<ide> for (PositionManager positionManager : myPositionManagers) {
<ide> try {
<ide> return positionManager.locationsOfLine(type, position);
<ide> }
<ide> catch (NoDataException ignored) {
<ide> }
<add> catch (Exception e) {
<add> LOG.error(e);
<add> }
<ide> }
<ide> return Collections.emptyList();
<ide> }
<ide>
<ide> @Override
<del> public ClassPrepareRequest createPrepareRequest(ClassPrepareRequestor requestor, SourcePosition position) {
<add> public ClassPrepareRequest createPrepareRequest(@NotNull ClassPrepareRequestor requestor, @NotNull SourcePosition position) {
<ide> for (PositionManager positionManager : myPositionManagers) {
<ide> try {
<ide> return positionManager.createPrepareRequest(requestor, position);
<ide> }
<ide> catch (NoDataException ignored) {
<add> }
<add> catch (Exception e) {
<add> LOG.error(e);
<ide> }
<ide> }
<ide> |
|
JavaScript | mit | 783e486c620d49f88e9f0b91acf543ec4383d10b | 0 | mxenabled/mx-react-components | const React = require('react');
const PropTypes = require('prop-types');
const Radium = require('radium');
const Icon = require('./Icon');
const SimpleSelect = require('./SimpleSelect');
const StyleConstants = require('../constants/Style');
class Tabs extends React.Component {
static propTypes = {
activeTabStyles: PropTypes.object,
alignment: PropTypes.oneOf(['left', 'center']),
brandColor: PropTypes.string,
onTabSelect: PropTypes.func.isRequired,
selectedTab: PropTypes.number,
showBottomBorder: PropTypes.bool,
tabs: PropTypes.array.isRequired,
useTabsInMobile: PropTypes.bool
};
static defaultProps = {
alignment: 'left',
brandColor: StyleConstants.Colors.PRIMARY,
showBottomBorder: true,
useTabsInMobile: false
};
state = {
selectedTab: this.props.selectedTab || 0,
showMenu: false
};
componentWillReceiveProps (nextProps) {
if (nextProps.selectedTab !== this.state.selectedTab) {
this.setState({
selectedTab: nextProps.selectedTab
});
}
}
_toggleMenu = () => {
this.setState({
showMenu: !this.state.showMenu
});
};
_handleTabClick = (selectedTab) => {
this.props.onTabSelect(selectedTab);
this._toggleMenu();
this.setState({
selectedTab
});
};
_isLargeOrMediumWindowSize = () => {
const windowSize = StyleConstants.getWindowSize();
return windowSize === 'medium' || windowSize === 'large';
};
_renderTabMenu = () => {
const selectedTabName = this.props.tabs[this.state.selectedTab];
const styles = this.styles();
const tabItems = this._buildTabItems();
return (
<div onClick={this._toggleMenu} style={styles.menuWrapper} >
{selectedTabName}
<Icon
size={20}
style={{ fill: this.props.brandColor }}
type={!this.state.showMenu ? 'caret-down' : 'caret-up' }
/>
{this.state.showMenu ? (
<SimpleSelect
hoverColor={this.props.brandColor}
items={tabItems}
onScrimClick={this._toggleMenu}
showItems={this.state.showMenu}
/>
) : null}
</div>
);
};
_buildTabItems = () => {
const tabItems = [];
this.props.tabs.map((tab, index) => {
tabItems.push({
onClick: () => {
this._handleTabClick(index);
},
text: tab
});
});
return tabItems;
};
render () {
const styles = this.styles();
const useTabs = this._isLargeOrMediumWindowSize() || this.props.useTabsInMobile;
const componentStyles = Object.assign({}, styles.component, (useTabs && styles.tabsContainer), this.props.style);
return (
<div style={componentStyles}>
{useTabs ? this.props.tabs.map((tab, index) =>
<Tab
isActive={this.state.selectedTab === index}
key={tab}
onClick={this._handleTabClick.bind(null, index)}
styles={{ activeTab: this.props.activeTabStyles }}
>
{tab}
</Tab>
) : this._renderTabMenu()}
</div>
);
}
styles = () => {
return {
// Block styles
component: {
display: 'block',
width: '100%'
},
menuWrapper: {
alignItems: 'center',
boxSizing: 'border-box',
color: this.props.brandColor,
lineHeight: '20px',
fontSize: StyleConstants.FontSizes.MEDIUM,
fontStyle: StyleConstants.Fonts.SEMIBOLD
},
tabsContainer: {
display: 'flex',
justifyContent: this.props.alignment === 'left' ? 'flex-start' : 'center',
borderBottom: this.props.showBottomBorder ? '1px solid ' + StyleConstants.Colors.FOG : 'none',
width: '100%'
}
};
};
}
class TabWithoutRadium extends React.Component {
static propTypes = {
activeTabStyles: PropTypes.object,
brandColor: PropTypes.string,
isActive: PropTypes.bool,
onClick: PropTypes.func,
styles: PropTypes.object
}
static defaultProps = {
brandColor: StyleConstants.Colors.PRIMARY,
isActive: false,
onClick: () => {},
styles: {}
}
render () {
const styles = this.styles();
let style = Object.assign({}, styles.tab, this.props.styles.tab);
if (this.props.isActive)
style = Object.assign({}, style, styles.activeTab, this.props.styles.activeTab);
return (
<span onClick={this.props.onClick} style={style}>
{this.props.children}
</span>
);
}
styles = () => {
return {
tab: {
boxSizing: 'border-box',
color: StyleConstants.Colors.ASH,
cursor: 'pointer',
display: 'inline-block',
fontSize: StyleConstants.FontSizes.MEDIUM,
fontStyle: StyleConstants.Fonts.SEMIBOLD,
padding: StyleConstants.Spacing.MEDIUM,
':hover': {
color: StyleConstants.Colors.CHARCOAL
}
},
activeTab: Object.assign({
cursor: 'default',
color: this.props.brandColor,
borderBottom: '2px solid ' + this.props.brandColor,
':hover': {
color: this.props.brandColor
}
}, this.props.activeTabStyles)
};
}
}
const Tab = Radium(TabWithoutRadium);
module.exports = Tabs;
| src/components/Tabs.js | const React = require('react');
const PropTypes = require('prop-types');
const Radium = require('radium');
const Icon = require('./Icon');
const SimpleSelect = require('./SimpleSelect');
const StyleConstants = require('../constants/Style');
class Tabs extends React.Component {
static propTypes = {
activeTabStyles: PropTypes.object,
alignment: PropTypes.oneOf(['left', 'center']),
brandColor: PropTypes.string,
onTabSelect: PropTypes.func.isRequired,
selectedTab: PropTypes.number,
showBottomBorder: PropTypes.bool,
tabs: PropTypes.array.isRequired,
useTabsInMobile: PropTypes.bool
};
static defaultProps = {
alignment: 'left',
brandColor: StyleConstants.Colors.PRIMARY,
showBottomBorder: true,
useTabsInMobile: false
};
state = {
selectedTab: this.props.selectedTab || 0,
showMenu: false
};
componentWillReceiveProps (nextProps) {
if (nextProps.selectedTab !== this.state.selectedTab) {
this.setState({
selectedTab: nextProps.selectedTab
});
}
}
_toggleMenu = () => {
this.setState({
showMenu: !this.state.showMenu
});
};
_handleTabClick = (selectedTab) => {
this.props.onTabSelect(selectedTab);
this._toggleMenu();
this.setState({
selectedTab
});
};
_isLargeOrMediumWindowSize = () => {
const windowSize = StyleConstants.getWindowSize();
return windowSize === 'medium' || windowSize === 'large';
};
_renderTabs = () => {
const styles = this.styles();
const selectedTabStyle = Object.assign({}, styles.activeTab, this.props.activeTabStyles);
return this.props.tabs.map((tab, index) => {
const _index = index;
return (
<span
key={_index}
onClick={this._handleTabClick.bind(null, _index)}
style={[styles.tab, this.state.selectedTab === _index && selectedTabStyle]}
>
{tab}
</span>
);
});
};
_renderTabMenu = () => {
const selectedTabName = this.props.tabs[this.state.selectedTab];
const styles = this.styles();
const tabItems = this._buildTabItems();
return (
<div onClick={this._toggleMenu} style={styles.menuWrapper} >
{selectedTabName}
<Icon
size={20}
style={{ fill: this.props.brandColor }}
type={!this.state.showMenu ? 'caret-down' : 'caret-up' }
/>
{this.state.showMenu ? (
<SimpleSelect
hoverColor={this.props.brandColor}
items={tabItems}
onScrimClick={this._toggleMenu}
showItems={this.state.showMenu}
/>
) : null}
</div>
);
};
_buildTabItems = () => {
const tabItems = [];
this.props.tabs.map((tab, index) => {
tabItems.push({
onClick: () => {
this._handleTabClick(index);
},
text: tab
});
});
return tabItems;
};
render () {
const styles = this.styles();
const useTabs = this._isLargeOrMediumWindowSize() || this.props.useTabsInMobile;
const tabsStyles = Object.assign({}, styles.component, (useTabs && styles.tabsContainer), this.props.style);
return (
<div style={tabsStyles}>
{useTabs ? this._renderTabs() : this._renderTabMenu()}
</div>
);
}
styles = () => {
return {
// Block styles
component: {
display: 'block',
width: '100%'
},
buttonStyles: {
backgroundColor: 'transparent'
},
tab: {
boxSizing: 'border-box',
color: StyleConstants.Colors.ASH,
cursor: 'pointer',
display: 'inline-block',
fontSize: StyleConstants.FontSizes.MEDIUM,
fontStyle: StyleConstants.Fonts.SEMIBOLD,
padding: StyleConstants.Spacing.MEDIUM,
':hover': {
color: StyleConstants.Colors.CHARCOAL
}
},
activeTab: {
cursor: 'default',
color: this.props.brandColor,
borderBottom: '2px solid ' + this.props.brandColor,
':hover': {
color: this.props.brandColor
}
},
menuWrapper: {
alignItems: 'center',
boxSizing: 'border-box',
color: this.props.brandColor,
lineHeight: '20px',
fontSize: StyleConstants.FontSizes.MEDIUM,
fontStyle: StyleConstants.Fonts.SEMIBOLD
},
tabsContainer: {
display: 'flex',
justifyContent: this.props.alignment === 'left' ? 'flex-start' : 'center',
borderBottom: this.props.showBottomBorder ? '1px solid ' + StyleConstants.Colors.FOG : 'none',
width: '100%'
}
};
};
}
module.exports = Radium(Tabs);
| Refactor Tabs to use a Tab component
| src/components/Tabs.js | Refactor Tabs to use a Tab component | <ide><path>rc/components/Tabs.js
<ide> const windowSize = StyleConstants.getWindowSize();
<ide>
<ide> return windowSize === 'medium' || windowSize === 'large';
<del> };
<del>
<del> _renderTabs = () => {
<del> const styles = this.styles();
<del> const selectedTabStyle = Object.assign({}, styles.activeTab, this.props.activeTabStyles);
<del>
<del> return this.props.tabs.map((tab, index) => {
<del> const _index = index;
<del>
<del> return (
<del> <span
<del> key={_index}
<del> onClick={this._handleTabClick.bind(null, _index)}
<del> style={[styles.tab, this.state.selectedTab === _index && selectedTabStyle]}
<del> >
<del> {tab}
<del> </span>
<del> );
<del> });
<ide> };
<ide>
<ide> _renderTabMenu = () => {
<ide> render () {
<ide> const styles = this.styles();
<ide> const useTabs = this._isLargeOrMediumWindowSize() || this.props.useTabsInMobile;
<del> const tabsStyles = Object.assign({}, styles.component, (useTabs && styles.tabsContainer), this.props.style);
<add> const componentStyles = Object.assign({}, styles.component, (useTabs && styles.tabsContainer), this.props.style);
<ide>
<ide> return (
<del> <div style={tabsStyles}>
<del> {useTabs ? this._renderTabs() : this._renderTabMenu()}
<add> <div style={componentStyles}>
<add> {useTabs ? this.props.tabs.map((tab, index) =>
<add> <Tab
<add> isActive={this.state.selectedTab === index}
<add> key={tab}
<add> onClick={this._handleTabClick.bind(null, index)}
<add> styles={{ activeTab: this.props.activeTabStyles }}
<add> >
<add> {tab}
<add> </Tab>
<add> ) : this._renderTabMenu()}
<ide> </div>
<ide> );
<ide> }
<ide> component: {
<ide> display: 'block',
<ide> width: '100%'
<del> },
<del> buttonStyles: {
<del> backgroundColor: 'transparent'
<del> },
<del> tab: {
<del> boxSizing: 'border-box',
<del> color: StyleConstants.Colors.ASH,
<del> cursor: 'pointer',
<del> display: 'inline-block',
<del> fontSize: StyleConstants.FontSizes.MEDIUM,
<del> fontStyle: StyleConstants.Fonts.SEMIBOLD,
<del> padding: StyleConstants.Spacing.MEDIUM,
<del>
<del> ':hover': {
<del> color: StyleConstants.Colors.CHARCOAL
<del> }
<del> },
<del> activeTab: {
<del> cursor: 'default',
<del> color: this.props.brandColor,
<del> borderBottom: '2px solid ' + this.props.brandColor,
<del>
<del> ':hover': {
<del> color: this.props.brandColor
<del> }
<ide> },
<ide> menuWrapper: {
<ide> alignItems: 'center',
<ide> };
<ide> }
<ide>
<del>module.exports = Radium(Tabs);
<add>class TabWithoutRadium extends React.Component {
<add> static propTypes = {
<add> activeTabStyles: PropTypes.object,
<add> brandColor: PropTypes.string,
<add> isActive: PropTypes.bool,
<add> onClick: PropTypes.func,
<add> styles: PropTypes.object
<add> }
<add>
<add> static defaultProps = {
<add> brandColor: StyleConstants.Colors.PRIMARY,
<add> isActive: false,
<add> onClick: () => {},
<add> styles: {}
<add> }
<add>
<add> render () {
<add> const styles = this.styles();
<add> let style = Object.assign({}, styles.tab, this.props.styles.tab);
<add>
<add> if (this.props.isActive)
<add> style = Object.assign({}, style, styles.activeTab, this.props.styles.activeTab);
<add>
<add> return (
<add> <span onClick={this.props.onClick} style={style}>
<add> {this.props.children}
<add> </span>
<add> );
<add> }
<add>
<add> styles = () => {
<add> return {
<add> tab: {
<add> boxSizing: 'border-box',
<add> color: StyleConstants.Colors.ASH,
<add> cursor: 'pointer',
<add> display: 'inline-block',
<add> fontSize: StyleConstants.FontSizes.MEDIUM,
<add> fontStyle: StyleConstants.Fonts.SEMIBOLD,
<add> padding: StyleConstants.Spacing.MEDIUM,
<add>
<add> ':hover': {
<add> color: StyleConstants.Colors.CHARCOAL
<add> }
<add> },
<add> activeTab: Object.assign({
<add> cursor: 'default',
<add> color: this.props.brandColor,
<add> borderBottom: '2px solid ' + this.props.brandColor,
<add>
<add> ':hover': {
<add> color: this.props.brandColor
<add> }
<add> }, this.props.activeTabStyles)
<add> };
<add> }
<add>}
<add>
<add>const Tab = Radium(TabWithoutRadium);
<add>
<add>module.exports = Tabs; |
|
JavaScript | mit | 3f51aacece35c28ee1398509281321440e3796a1 | 0 | GerHobbelt/SlickGrid,GerHobbelt/SlickGrid,GerHobbelt/SlickGrid | (function ($) {
// register namespace
$.extend(true, window, {
"Slick": {
"Preloader": Preloader
}
});
function Preloader(container) {
var
_self = this,
_grid;
function init(grid) {
_grid = grid;
return this;
}
function destroy() { }
function getPreloader(toPosition){
var $t = $(container);
if (!this.$p){
this.$p = $('<div class="cyc-grid-preloader"><img src="images/preloader-hbar.gif"/></div>').appendTo(document.body);
}
if (toPosition){
var pos = $t.offset(), height = $t.height(), width = $t.width();
this.$p
.css("position", "absolute")
.css("top", pos.top + height/2 - this.$p.height()/2 )
.css("left", pos.left + width/2 - this.$p.width()/2 );
}
return this.$p;
}
function show(){
getPreloader(true).show();
return this;
}
function hide(){
getPreloader().fadeOut();
return this;
}
// loader handling (remotemodel)
// =============================
var isDataLoading = [];
function onLoaderDataLoading(){
isDataLoading.push(true);
show();
}
function onLoaderDataLoaded(e, args) {
isDataLoading.pop();
if (!isDataLoading.length) hide();
}
function onLoaderDataLoadError(e, args){
isDataLoading.pop();
if (!isDataLoading.length) hide();
}
function onLoaderDataLoadAbort(e, args){
isDataLoading.pop();
if (!isDataLoading.length) hide();
}
function registerLoader(loader){
loader.onDataLoading.subscribe(onLoaderDataLoading);
loader.onDataLoaded.subscribe(onLoaderDataLoaded);
loader.onDataLoadError.subscribe(onLoaderDataLoadError);
loader.onDataLoadAbort.subscribe(onLoaderDataLoadAbort);
}
function unregisterLoader(loader){
loader.onDataLoading.unsubscribe(onLoaderDataLoading);
loader.onDataLoaded.unsubscribe(onLoaderDataLoaded);
loader.onDataLoadError.unsubscribe(onLoaderDataLoadError);
loader.onDataLoadAbort.unsubscribe(onLoaderDataLoadAbort);
}
$.extend(this, {
"init": init,
"destroy": destroy,
"show": show,
"hide": hide,
"registerLoader": registerLoader,
"unregisterLoader": unregisterLoader
});
}
})(jQuery); | plugins/slick.preloader.js | (function ($) {
// register namespace
$.extend(true, window, {
"Slick": {
"Preloader": Preloader
}
});
function Preloader(container) {
var
_self = this,
_grid;
function init(grid) {
_grid = grid;
}
function destroy() { }
function getPreloader(toPosition){
var $t = $(container);
if (!this.$p){
this.$p = $('<div class="cyc-grid-preloader"><img src="images/preloader-hbar.gif"/></div>').appendTo(document.body);
}
if (toPosition){
var pos = $t.offset(), height = $t.height(), width = $t.width();
this.$p
.css("position", "absolute")
.css("top", pos.top + height/2 - this.$p.height()/2 )
.css("left", pos.left + width/2 - this.$p.width()/2 );
}
return this.$p;
}
function show(){
getPreloader(true).show();
}
function hide(){
getPreloader().fadeOut();
}
// loader handling (remotemodel)
// =============================
var isDataLoading = [];
function onLoaderDataLoading(){
isDataLoading.push(true);
show();
}
function onLoaderDataLoaded(e, args) {
isDataLoading.pop();
if (!isDataLoading.length) hide();
}
function onLoaderDataLoadError(e, args){
isDataLoading.pop();
if (!isDataLoading.length) hide();
}
function onLoaderDataLoadAbort(e, args){
isDataLoading.pop();
if (!isDataLoading.length) hide();
}
function registerLoader(loader){
loader.onDataLoading.subscribe(onLoaderDataLoading);
loader.onDataLoaded.subscribe(onLoaderDataLoaded);
loader.onDataLoadError.subscribe(onLoaderDataLoadError);
loader.onDataLoadAbort.subscribe(onLoaderDataLoadAbort);
}
function unregisterLoader(loader){
loader.onDataLoading.unsubscribe(onLoaderDataLoading);
loader.onDataLoaded.unsubscribe(onLoaderDataLoaded);
loader.onDataLoadError.unsubscribe(onLoaderDataLoadError);
loader.onDataLoadAbort.unsubscribe(onLoaderDataLoadAbort);
}
$.extend(this, {
"init": init,
"destroy": destroy,
"show": show,
"hide": hide,
"registerLoader": registerLoader,
"unregisterLoader": unregisterLoader
});
}
})(jQuery); | preloader changes
| plugins/slick.preloader.js | preloader changes | <ide><path>lugins/slick.preloader.js
<ide>
<ide> function init(grid) {
<ide> _grid = grid;
<add> return this;
<ide> }
<ide>
<ide> function destroy() { }
<ide>
<ide> function show(){
<ide> getPreloader(true).show();
<add> return this;
<ide> }
<ide>
<ide> function hide(){
<ide> getPreloader().fadeOut();
<add> return this;
<ide> }
<ide>
<ide> |
|
Java | apache-2.0 | b3e9181ec46360c69d3f2160794f48c53dbbf148 | 0 | hivemq/hivemq-spi | /*
* Copyright 2014 dc-square 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.
*/
package com.hivemq.spi.services;
import com.google.common.base.Optional;
import com.hivemq.spi.message.RetainedMessage;
import java.util.Set;
/**
* The retained message store allows the management of retained messages from within plugins
*
* @author Lukas Brandl
* @since 1.5
*/
public interface RetainedMessageStore {
/**
* @return all retained messages which are currently stored
*/
Set<RetainedMessage> getRetainedMessages();
/**
* @param topic a topic
* @return retained message for the specific topic, otherwise an {@link com.google.common.base.Optional}
* instance with an empty reference
*/
Optional<RetainedMessage> getRetainedMessage(String topic);
/**
* Removes the retained message from given topic. <code>null</code> values are ignored.
* If there isn't any retained message on the topic yet, nothing will happen.
*
* @param topic from which the message should be removed
*/
void remove(String topic);
/**
* Removes a given retained message. <code>null</code> values are ignored.
* If the given retained message doesn't exist, nothing will happen.
*
* @param retainedMessage which should be removed
*/
void remove(RetainedMessage retainedMessage);
/**
* Removes all retained messages from the message store.
*/
void clear();
/**
* This method adds or replaces a retained message
*
* @param retainedMessage which should be added or replaced
*/
void addOrReplace(RetainedMessage retainedMessage);
/**
* Checks if the retained message is present in the retained message store.
* Only the topic is of a retained message is considered for this check, QoS and message are ignored.
*
* @param retainedMessage to check if it's already in the message store
* @return true if there's already a message on the topic of the given retained message
*/
boolean contains(RetainedMessage retainedMessage);
/**
* @return the number of all retained messages
*/
int size();
}
| src/main/java/com/hivemq/spi/services/RetainedMessageStore.java | /*
* Copyright 2014 dc-square 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.
*/
package com.hivemq.spi.services;
import com.google.common.base.Optional;
import com.hivemq.spi.message.RetainedMessage;
import java.util.Set;
/**
* The retained message store allows the management of retained messages from within plugins
*
* @author Lukas Brandl
* @since 1.5
*/
interface RetainedMessageStore {
/**
* @return all retained messages which are currently stored
*/
Set<RetainedMessage> getRetainedMessages();
/**
* @param topic a topic
* @return retained message for the specific topic, otherwise an {@link com.google.common.base.Optional}
* instance with an empty reference
*/
Optional<RetainedMessage> getRetainedMessage(String topic);
/**
* Removes the retained message from given topic. <code>null</code> values are ignored.
* If there isn't any retained message on the topic yet, nothing will happen.
*
* @param topic from which the message should be removed
*/
void remove(String topic);
/**
* Removes a given retained message. <code>null</code> values are ignored.
* If the given retained message doesn't exist, nothing will happen.
*
* @param retainedMessage which should be removed
*/
void remove(RetainedMessage retainedMessage);
/**
* Removes all retained messages from the message store.
*/
void clear();
/**
* This method adds or replaces a retained message
*
* @param retainedMessage which should be added or replaced
*/
void addOrReplace(RetainedMessage retainedMessage);
/**
* Checks if the retained message is present in the retained message store.
* Only the topic is of a retained message is considered for this check, QoS and message are ignored.
*
* @param retainedMessage to check if it's already in the message store
* @return true if there's already a message on the topic of the given retained message
*/
boolean contains(RetainedMessage retainedMessage);
/**
* @return the number of all retained messages
*/
int size();
}
| fixed interface for retained message store
| src/main/java/com/hivemq/spi/services/RetainedMessageStore.java | fixed interface for retained message store | <ide><path>rc/main/java/com/hivemq/spi/services/RetainedMessageStore.java
<ide> * @author Lukas Brandl
<ide> * @since 1.5
<ide> */
<del>interface RetainedMessageStore {
<add>public interface RetainedMessageStore {
<ide>
<ide> /**
<ide> * @return all retained messages which are currently stored |
|
Java | apache-2.0 | 76eefbb3bf237f62ed3ad5f6ac2418c9a5612961 | 0 | apache/pdfbox,kalaspuffar/pdfbox,kalaspuffar/pdfbox,apache/pdfbox | /*****************************************************************************
*
* 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.pdfbox.preflight.parser;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_ARRAY_TOO_LONG;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_CROSS_REF;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_HEXA_STRING_EVEN_NUMBER;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_HEXA_STRING_INVALID;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_HEXA_STRING_TOO_LONG;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_INVALID_OFFSET;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_MISSING_OFFSET;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_NAME_TOO_LONG;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_NUMERIC_RANGE;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_OBJ_DELIMITER;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_STREAM_DELIMITER;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_TOO_MANY_ENTRIES;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_TRAILER_EOF;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_ARRAY_ELEMENTS;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_DICT_ENTRIES;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_NAME_SIZE;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_NEGATIVE_FLOAT;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_POSITIVE_FLOAT;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_STRING_LENGTH;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.activation.DataSource;
import javax.activation.FileDataSource;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSDocument;
import org.apache.pdfbox.cos.COSFloat;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSNull;
import org.apache.pdfbox.cos.COSNumber;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.cos.COSString;
import org.apache.pdfbox.io.IOUtils;
import org.apache.pdfbox.pdfparser.BaseParser;
import org.apache.pdfbox.pdfparser.NonSequentialPDFParser;
import org.apache.pdfbox.pdfparser.PDFObjectStreamParser;
import org.apache.pdfbox.pdfparser.PDFParser;
import org.apache.pdfbox.pdfparser.XrefTrailerResolver.XRefType;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.persistence.util.COSObjectKey;
import org.apache.pdfbox.preflight.Format;
import org.apache.pdfbox.preflight.PreflightConfiguration;
import org.apache.pdfbox.preflight.PreflightConstants;
import org.apache.pdfbox.preflight.PreflightContext;
import org.apache.pdfbox.preflight.PreflightDocument;
import org.apache.pdfbox.preflight.ValidationResult;
import org.apache.pdfbox.preflight.ValidationResult.ValidationError;
import org.apache.pdfbox.preflight.exception.SyntaxValidationException;
public class PreflightParser extends NonSequentialPDFParser
{
/**
* Define a one byte encoding that hasn't specific encoding in UTF-8 charset. Avoid unexpected error when the
* encoding is Cp5816
*/
public static final Charset encoding = Charset.forName("ISO-8859-1");
protected DataSource originalDocument;
protected ValidationResult validationResult;
protected PreflightDocument preflightDocument;
protected PreflightContext ctx;
public PreflightParser(File file) throws IOException
{
super(file);
this.setLenient(false);
this.originalDocument = new FileDataSource(file);
}
public PreflightParser(String filename) throws IOException
{
this(new File(filename));
}
public PreflightParser(DataSource input) throws IOException
{
super(input.getInputStream());
this.setLenient(false);
this.originalDocument = input;
}
/**
* Create an instance of ValidationResult with a ValidationError(UNKNOWN_ERROR)
*
* @return the ValidationError instance.
*/
protected static ValidationResult createUnknownErrorResult()
{
ValidationError error = new ValidationError(PreflightConstants.ERROR_UNKOWN_ERROR);
ValidationResult result = new ValidationResult(error);
return result;
}
/**
* Add the error to the ValidationResult. If the validationResult is null, an instance is created using the
* isWarning boolean of the ValidationError to know if the ValidationResult must be flagged as Valid.
*
* @param error
*/
protected void addValidationError(ValidationError error)
{
if (this.validationResult == null)
{
this.validationResult = new ValidationResult(error.isWarning());
}
this.validationResult.addError(error);
}
protected void addValidationErrors(List<ValidationError> errors)
{
for (ValidationError error : errors)
{
addValidationError(error);
}
}
@Override
public void parse() throws IOException
{
parse(Format.PDF_A1B);
}
/**
* Parse the given file and check if it is a confirming file according to the given format.
*
* @param format
* format that the document should follow (default {@link Format#PDF_A1B})
* @throws IOException
*/
public void parse(Format format) throws IOException
{
parse(format, null);
}
/**
* Parse the given file and check if it is a confirming file according to the given format.
*
* @param format
* format that the document should follow (default {@link Format#PDF_A1B})
* @param config
* Configuration bean that will be used by the PreflightDocument. If null the format is used to determine
* the default configuration.
* @throws IOException
*/
public void parse(Format format, PreflightConfiguration config) throws IOException
{
checkPdfHeader();
try
{
super.parse();
}
catch (IOException e)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_COMMON, e.getMessage()));
throw new SyntaxValidationException(e, this.validationResult);
}
Format formatToUse = (format == null ? Format.PDF_A1B : format);
createPdfADocument(formatToUse, config);
createContext();
}
protected void createPdfADocument(Format format, PreflightConfiguration config) throws IOException
{
COSDocument cosDocument = getDocument();
this.preflightDocument = new PreflightDocument(cosDocument, format, config);
}
/**
* Create a validation context. This context is set to the PreflightDocument.
*/
protected void createContext()
{
this.ctx = new PreflightContext(this.originalDocument);
ctx.setDocument(preflightDocument);
preflightDocument.setContext(ctx);
ctx.setXrefTableResolver(xrefTrailerResolver);
}
@Override
public PDDocument getPDDocument() throws IOException
{
preflightDocument.setResult(validationResult);
// Add XMP MetaData
return preflightDocument;
}
public PreflightDocument getPreflightDocument() throws IOException
{
return (PreflightDocument) getPDDocument();
}
// --------------------------------------------------------
// - Below All methods that adds controls on the PDF syntax
// --------------------------------------------------------
@Override
/**
* Fill the CosDocument with some object that isn't set by the NonSequentialParser
*/
protected void initialParse() throws IOException
{
super.initialParse();
// fill xref table
document.addXRefTable(xrefTrailerResolver.getXrefTable());
// For each ObjectKey, we check if the object has been loaded
// useful for linearized PDFs
Map<COSObjectKey, Long> xrefTable = document.getXrefTable();
for (Entry<COSObjectKey, Long> entry : xrefTable.entrySet())
{
COSObject co = document.getObjectFromPool(entry.getKey());
if (co.getObject() == null)
{
// object isn't loaded - parse the object to load its content
parseObjectDynamically(co, true);
}
}
}
/**
* Check that the PDF header match rules of the PDF/A specification. First line (offset 0) must be a comment with
* the PDF version (version 1.0 isn't conform to the PDF/A specification) Second line is a comment with at least 4
* bytes greater than 0x80
*/
protected void checkPdfHeader()
{
BufferedReader reader = null;
try
{
reader = new BufferedReader(new InputStreamReader(new FileInputStream(getPdfFile()), encoding));
String firstLine = reader.readLine();
if (firstLine == null || !firstLine.matches("%PDF-1\\.[1-9]"))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"First line must match %PDF-1.\\d"));
}
String secondLine = reader.readLine();
if (secondLine != null)
{
byte[] secondLineAsBytes = secondLine.getBytes(encoding.name());
if (secondLineAsBytes.length >= 5)
{
for (int i = 0; i < secondLineAsBytes.length; ++i)
{
byte b = secondLineAsBytes[i];
if (i == 0 && ((char) b != '%'))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Second line must contains at least 4 bytes greater than 127"));
break;
}
else if (i > 0 && ((b & 0xFF) < 0x80))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Second line must contains at least 4 bytes greater than 127"));
break;
}
}
}
else
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Second line must contains at least 4 bytes greater than 127"));
}
}
}
catch (IOException e)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Unable to read the PDF file : " + e.getMessage(), e));
}
finally
{
IOUtils.closeQuietly(reader);
}
}
/**
* Same method than the {@linkplain PDFParser#parseXrefTable(long)} with additional controls : - EOL mandatory after
* the 'xref' keyword - Cross reference subsection header uses single white space as separator - and so on
*/
@Override
protected boolean parseXrefTable(long startByteOffset) throws IOException
{
if (pdfSource.peek() != 'x')
{
return false;
}
String xref = readString();
if (!xref.equals("xref"))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"xref must be followed by a EOL character"));
return false;
}
if (!nextIsEOL())
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"xref must be followed by EOL"));
}
// signal start of new XRef
xrefTrailerResolver.nextXrefObj(startByteOffset,XRefType.TABLE);
/*
* Xref tables can have multiple sections. Each starts with a starting object id and a count.
*/
while (true)
{
// just after the xref<EOL> there are an integer
long currObjID; // first obj id
long count; // the number of objects in the xref table
long offset = pdfSource.getOffset();
String line = readLine();
Pattern pattern = Pattern.compile("(\\d+)\\s(\\d+)(\\s*)");
Matcher matcher = pattern.matcher(line);
if (matcher.matches())
{
currObjID = Integer.parseInt(matcher.group(1));
count = Integer.parseInt(matcher.group(2));
}
else
{
addValidationError(new ValidationError(ERROR_SYNTAX_CROSS_REF,
"Cross reference subsection header is invalid"));
// reset pdfSource cursor to read xref information
pdfSource.seek(offset);
currObjID = readObjectNumber(); // first obj id
count = readLong(); // the number of objects in the xref table
}
skipSpaces();
for (int i = 0; i < count; i++)
{
if (pdfSource.isEOF() || isEndOfName((char) pdfSource.peek()))
{
break;
}
if (pdfSource.peek() == 't')
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"Expected xref line but 't' found"));
break;
}
// Ignore table contents
String currentLine = readLine();
String[] splitString = currentLine.split(" ");
if (splitString.length < 3)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"invalid xref line: " + currentLine));
break;
}
/*
* This supports the corrupt table as reported in PDFBOX-474 (XXXX XXX XX n)
*/
if (splitString[splitString.length - 1].equals("n"))
{
try
{
long currOffset = Long.parseLong(splitString[0]);
int currGenID = Integer.parseInt(splitString[1]);
COSObjectKey objKey = new COSObjectKey(currObjID, currGenID);
xrefTrailerResolver.setXRef(objKey, currOffset);
}
catch (NumberFormatException e)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"offset or genid can't be read as number " + e.getMessage(), e));
}
}
else if (!splitString[2].equals("f"))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"Corrupt XRefTable Entry - ObjID:" + currObjID));
}
currObjID++;
skipSpaces();
}
skipSpaces();
char c = (char) pdfSource.peek();
if (c < '0' || c > '9')
{
break;
}
}
return true;
}
/**
* Wraps the {@link NonSequentialPDFParser#parseCOSStream} to check rules on 'stream' and 'endstream' keywords.
* {@link #checkStreamKeyWord()} and {@link #checkEndstreamKeyWord()}
*/
@Override
protected COSStream parseCOSStream(COSDictionary dic) throws IOException
{
checkStreamKeyWord();
COSStream result = super.parseCOSStream(dic);
checkEndstreamKeyWord();
return result;
}
/**
* 'stream' must be followed by <CR><LF> or only <LF>
*
* @throws IOException
*/
protected void checkStreamKeyWord() throws IOException
{
String streamV = readString();
if (!streamV.equals("stream"))
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'stream' keyword but found '" + streamV + "' at offset "+pdfSource.getOffset()));
}
int nextChar = pdfSource.read();
if (!((nextChar == 13 && pdfSource.peek() == 10) || nextChar == 10))
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'EOL' after the stream keyword at offset "+pdfSource.getOffset()));
}
// set the offset before stream
pdfSource.seek(pdfSource.getOffset() - 7);
}
/**
* 'endstream' must be preceded by an EOL
*
* @throws IOException
*/
protected void checkEndstreamKeyWord() throws IOException
{
pdfSource.seek(pdfSource.getOffset() - 10);
if (!nextIsEOL())
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'EOL' before the endstream keyword at offset "+pdfSource.getOffset()+" but found '"+pdfSource.peek()+"'"));
}
String endstreamV = readString();
if (!endstreamV.equals("endstream"))
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'endstream' keyword at offset "+pdfSource.getOffset()+" but found '" + endstreamV + "'"));
}
}
protected boolean nextIsEOL() throws IOException
{
boolean succeed = false;
int nextChar = pdfSource.read();
if (nextChar == 13 && pdfSource.peek() == 10)
{
pdfSource.read();
succeed = true;
}
else if (nextChar == 13 || nextChar == 10)
{
succeed = true;
}
return succeed;
}
/**
* @return true if the next character is a space. (The character is consumed)
* @throws IOException
*/
protected boolean nextIsSpace() throws IOException
{
return ' ' == pdfSource.read();
}
@Override
/**
* Call {@link BaseParser#parseCOSArray()} and check the number of element in the array
*/
protected COSArray parseCOSArray() throws IOException
{
COSArray result = super.parseCOSArray();
if (result != null && result.size() > MAX_ARRAY_ELEMENTS)
{
addValidationError(new ValidationError(ERROR_SYNTAX_ARRAY_TOO_LONG, "Array too long : " + result.size()));
}
return result;
}
@Override
/**
* Call {@link BaseParser#parseCOSName()} and check the length of the name
*/
protected COSName parseCOSName() throws IOException
{
COSName result = super.parseCOSName();
if (result != null && result.getName().getBytes().length > MAX_NAME_SIZE)
{
addValidationError(new ValidationError(ERROR_SYNTAX_NAME_TOO_LONG, "Name too long"));
}
return result;
}
/**
* Check that the hexa string contains only an even number of Hexadecimal characters. Once it is done, reset the
* offset at the beginning of the string and call {@link BaseParser#parseCOSString()}
* @deprecated Not needed anymore. Use {@link #parseCOSString()} instead. PDFBOX-1437
*/
@Override
@Deprecated
protected COSString parseCOSString(boolean isDictionary) throws IOException
{
return parseCOSString();
}
/**
* Check that the hexa string contains only an even number of Hexadecimal characters. Once it is done, reset the
* offset at the beginning of the string and call {@link BaseParser#parseCOSString()}
*/
@Override
protected COSString parseCOSString() throws IOException
{
// offset reminder
long offset = pdfSource.getOffset();
char nextChar = (char) pdfSource.read();
int count = 0;
if (nextChar == '<')
{
do
{
nextChar = (char) pdfSource.read();
if (nextChar != '>')
{
if (Character.digit(nextChar, 16) >= 0)
{
count++;
}
else
{
addValidationError(new ValidationError(ERROR_SYNTAX_HEXA_STRING_INVALID,
"Hexa String must have only Hexadecimal Characters (found '" + nextChar + "') at offset " + pdfSource.getOffset()));
break;
}
}
} while (nextChar != '>');
}
if (count % 2 != 0)
{
addValidationError(new ValidationError(ERROR_SYNTAX_HEXA_STRING_EVEN_NUMBER,
"Hexa string shall contain even number of non white space char at offset " + pdfSource.getOffset()));
}
// reset the offset to parse the COSString
pdfSource.seek(offset);
COSString result = super.parseCOSString();
if (result.getString().length() > MAX_STRING_LENGTH)
{
addValidationError(new ValidationError(ERROR_SYNTAX_HEXA_STRING_TOO_LONG, "Hexa string is too long at offset "+pdfSource.getOffset()));
}
return result;
}
/**
* Call {@link BaseParser#parseDirObject()} check limit range for Float, Integer and number of Dictionary entries.
*/
@Override
protected COSBase parseDirObject() throws IOException
{
COSBase result = super.parseDirObject();
if (result instanceof COSNumber)
{
COSNumber number = (COSNumber) result;
if (number instanceof COSFloat)
{
Double real = number.doubleValue();
if (real > MAX_POSITIVE_FLOAT || real < MAX_NEGATIVE_FLOAT)
{
addValidationError(new ValidationError(ERROR_SYNTAX_NUMERIC_RANGE,
"Float is too long or too small: " + real+" at offset "+pdfSource.getOffset()));
}
}
else
{
long numAsLong = number.longValue();
if (numAsLong > Integer.MAX_VALUE || numAsLong < Integer.MIN_VALUE)
{
addValidationError(new ValidationError(ERROR_SYNTAX_NUMERIC_RANGE,
"Numeric is too long or too small: " + numAsLong+" at offset "+pdfSource.getOffset()));
}
}
}
if (result instanceof COSDictionary)
{
COSDictionary dic = (COSDictionary) result;
if (dic.size() > MAX_DICT_ENTRIES)
{
addValidationError(new ValidationError(ERROR_SYNTAX_TOO_MANY_ENTRIES, "Too Many Entries In Dictionary at offset "+pdfSource.getOffset()));
}
}
return result;
}
@Override
protected COSBase parseObjectDynamically(int objNr, int objGenNr, boolean requireExistingNotCompressedObj)
throws IOException
{
// ---- create object key and get object (container) from pool
final COSObjectKey objKey = new COSObjectKey(objNr, objGenNr);
final COSObject pdfObject = document.getObjectFromPool(objKey);
if (pdfObject.getObject() == null)
{
// not previously parsed
// ---- read offset or object stream object number from xref table
Long offsetOrObjstmObNr = xrefTrailerResolver.getXrefTable().get(objKey);
// sanity test to circumvent loops with broken documents
if (requireExistingNotCompressedObj && ((offsetOrObjstmObNr == null)))
{
addValidationError(new ValidationError(ERROR_SYNTAX_MISSING_OFFSET,
"Object must be defined and must not be compressed object: " + objKey.getNumber() + ":"
+ objKey.getGeneration()));
throw new SyntaxValidationException("Object must be defined and must not be compressed object: "
+ objKey.getNumber() + ":" + objKey.getGeneration(), validationResult);
}
if (offsetOrObjstmObNr == null)
{
// not defined object -> NULL object (Spec. 1.7, chap. 3.2.9)
pdfObject.setObject(COSNull.NULL);
}
else if (offsetOrObjstmObNr == 0)
{
addValidationError(new ValidationError(ERROR_SYNTAX_INVALID_OFFSET, "Object {" + objKey.getNumber()
+ ":" + objKey.getGeneration() + "} has an offset of 0"));
}
else if (offsetOrObjstmObNr > 0)
{
// offset of indirect object in file
// ---- go to object start
setPdfSource(offsetOrObjstmObNr);
// ---- we must have an indirect object
long readObjNr;
int readObjGen;
long offset = pdfSource.getOffset();
String line = readLine();
Pattern pattern = Pattern.compile("(\\d+)\\s(\\d+)\\sobj");
Matcher matcher = pattern.matcher(line);
if (matcher.matches())
{
readObjNr = Integer.parseInt(matcher.group(1));
readObjGen = Integer.parseInt(matcher.group(2));
}
else
{
addValidationError(new ValidationError(ERROR_SYNTAX_OBJ_DELIMITER, "Single space expected [offset="+offset+"; key="+offsetOrObjstmObNr.toString()+"; line="+line+"; object="+pdfObject.toString()+"]"));
// reset pdfSource cursor to read object information
pdfSource.seek(offset);
readObjNr = readObjectNumber();
readObjGen = readGenerationNumber();
skipSpaces(); // skip spaces between Object Generation number and the 'obj' keyword
for (char c : OBJ_MARKER)
{
if (pdfSource.read() != c)
{
addValidationError(new ValidationError(ERROR_SYNTAX_OBJ_DELIMITER, "Expected pattern '"
+ new String(OBJ_MARKER) + " but missed at character '" + c + "'"));
throw new SyntaxValidationException("Expected pattern '" + new String(OBJ_MARKER)
+ " but missed at character '" + c + "'", validationResult);
}
}
}
// ---- consistency check
if ((readObjNr != objKey.getNumber()) || (readObjGen != objKey.getGeneration()))
{
throw new IOException("XREF for " + objKey.getNumber() + ":" + objKey.getGeneration()
+ " points to wrong object: " + readObjNr + ":" + readObjGen);
}
skipSpaces();
COSBase pb = parseDirObject();
skipSpaces();
long endObjectOffset = pdfSource.getOffset();
String endObjectKey = readString();
if (endObjectKey.equals("stream"))
{
pdfSource.seek(endObjectOffset);
if (pb instanceof COSDictionary)
{
COSStream stream = parseCOSStream((COSDictionary) pb);
if (securityHandler != null)
{
securityHandler.decryptStream(stream, objNr, objGenNr);
}
pb = stream;
}
else
{
// this is not legal
// the combination of a dict and the stream/endstream forms a complete stream object
throw new IOException("Stream not preceded by dictionary (offset: " + offsetOrObjstmObNr + ").");
}
skipSpaces();
endObjectOffset = pdfSource.getOffset();
endObjectKey = readString();
// we have case with a second 'endstream' before endobj
if (!endObjectKey.startsWith("endobj"))
{
if (endObjectKey.startsWith("endstream"))
{
endObjectKey = endObjectKey.substring(9).trim();
if (endObjectKey.length() == 0)
{
// no other characters in extra endstream line
endObjectKey = readString(); // read next line
}
}
}
}
else if (securityHandler != null)
{
decrypt(pb, objNr, objGenNr);
}
pdfObject.setObject(pb);
if (!endObjectKey.startsWith("endobj"))
{
throw new IOException("Object (" + readObjNr + ":" + readObjGen + ") at offset "
+ offsetOrObjstmObNr + " does not end with 'endobj'.");
}
else
{
offset = pdfSource.getOffset();
pdfSource.seek(endObjectOffset - 1);
if (!nextIsEOL())
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_OBJ_DELIMITER,
"EOL expected before the 'endobj' keyword at offset "+pdfSource.getOffset()));
}
pdfSource.seek(offset);
}
if (!nextIsEOL())
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_OBJ_DELIMITER,
"EOL expected after the 'endobj' keyword at offset "+pdfSource.getOffset()));
}
releasePdfSourceInputStream();
}
else
{
// xref value is object nr of object stream containing object to be parsed;
// since our object was not found it means object stream was not parsed so far
final int objstmObjNr = (int) (-offsetOrObjstmObNr);
final COSBase objstmBaseObj = parseObjectDynamically(objstmObjNr, 0, true);
if (objstmBaseObj instanceof COSStream)
{
// parse object stream
PDFObjectStreamParser parser = new PDFObjectStreamParser((COSStream) objstmBaseObj, document,
forceParsing);
parser.parse();
// get set of object numbers referenced for this object stream
final Set<Long> refObjNrs = xrefTrailerResolver.getContainedObjectNumbers(objstmObjNr);
// register all objects which are referenced to be contained in object stream
for (COSObject next : parser.getObjects())
{
COSObjectKey stmObjKey = new COSObjectKey(next);
if (refObjNrs.contains(stmObjKey.getNumber()))
{
COSObject stmObj = document.getObjectFromPool(stmObjKey);
stmObj.setObject(next.getObject());
}
}
}
}
}
return pdfObject.getObject();
}
@Override
protected int lastIndexOf(final char[] pattern, final byte[] buf, final int endOff)
{
int offset = super.lastIndexOf(pattern, buf, endOff);
if (offset > 0 && Arrays.equals(pattern, EOF_MARKER))
{
// this is the offset of the last %%EOF sequence.
// nothing should be present after this sequence.
int tmpOffset = offset + pattern.length;
if (tmpOffset != buf.length)
{
// EOL is authorized
if ((buf.length - tmpOffset) > 2
|| (buf.length - tmpOffset == 2 && (buf[tmpOffset] != 13 || buf[tmpOffset + 1] != 10))
|| (buf.length - tmpOffset == 1 && buf[tmpOffset] != 10))
{
addValidationError(new ValidationError(ERROR_SYNTAX_TRAILER_EOF,
"File contains data after the last %%EOF sequence at offset " + pdfSource.getOffset()));
}
}
}
return offset;
}
}
| preflight/src/main/java/org/apache/pdfbox/preflight/parser/PreflightParser.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.pdfbox.preflight.parser;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_ARRAY_TOO_LONG;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_CROSS_REF;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_HEXA_STRING_EVEN_NUMBER;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_HEXA_STRING_INVALID;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_HEXA_STRING_TOO_LONG;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_INVALID_OFFSET;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_MISSING_OFFSET;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_NAME_TOO_LONG;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_NUMERIC_RANGE;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_OBJ_DELIMITER;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_STREAM_DELIMITER;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_TOO_MANY_ENTRIES;
import static org.apache.pdfbox.preflight.PreflightConstants.ERROR_SYNTAX_TRAILER_EOF;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_ARRAY_ELEMENTS;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_DICT_ENTRIES;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_NAME_SIZE;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_NEGATIVE_FLOAT;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_POSITIVE_FLOAT;
import static org.apache.pdfbox.preflight.PreflightConstants.MAX_STRING_LENGTH;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.activation.DataSource;
import javax.activation.FileDataSource;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSDocument;
import org.apache.pdfbox.cos.COSFloat;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSNull;
import org.apache.pdfbox.cos.COSNumber;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.cos.COSString;
import org.apache.pdfbox.io.IOUtils;
import org.apache.pdfbox.pdfparser.BaseParser;
import org.apache.pdfbox.pdfparser.NonSequentialPDFParser;
import org.apache.pdfbox.pdfparser.PDFObjectStreamParser;
import org.apache.pdfbox.pdfparser.PDFParser;
import org.apache.pdfbox.pdfparser.XrefTrailerResolver.XRefType;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.persistence.util.COSObjectKey;
import org.apache.pdfbox.preflight.Format;
import org.apache.pdfbox.preflight.PreflightConfiguration;
import org.apache.pdfbox.preflight.PreflightConstants;
import org.apache.pdfbox.preflight.PreflightContext;
import org.apache.pdfbox.preflight.PreflightDocument;
import org.apache.pdfbox.preflight.ValidationResult;
import org.apache.pdfbox.preflight.ValidationResult.ValidationError;
import org.apache.pdfbox.preflight.exception.SyntaxValidationException;
public class PreflightParser extends NonSequentialPDFParser
{
/**
* Define a one byte encoding that hasn't specific encoding in UTF-8 charset. Avoid unexpected error when the
* encoding is Cp5816
*/
public static final Charset encoding = Charset.forName("ISO-8859-1");
protected DataSource originalDocument;
protected ValidationResult validationResult;
protected PreflightDocument preflightDocument;
protected PreflightContext ctx;
public PreflightParser(File file) throws IOException
{
super(file);
this.setLenient(false);
this.originalDocument = new FileDataSource(file);
}
public PreflightParser(String filename) throws IOException
{
this(new File(filename));
}
public PreflightParser(DataSource input) throws IOException
{
super(input.getInputStream());
this.setLenient(false);
this.originalDocument = input;
}
/**
* Create an instance of ValidationResult with a ValidationError(UNKNOWN_ERROR)
*
* @return the ValidationError instance.
*/
protected static ValidationResult createUnknownErrorResult()
{
ValidationError error = new ValidationError(PreflightConstants.ERROR_UNKOWN_ERROR);
ValidationResult result = new ValidationResult(error);
return result;
}
/**
* Add the error to the ValidationResult. If the validationResult is null, an instance is created using the
* isWarning boolean of the ValidationError to know if the ValidationResult must be flagged as Valid.
*
* @param error
*/
protected void addValidationError(ValidationError error)
{
if (this.validationResult == null)
{
this.validationResult = new ValidationResult(error.isWarning());
}
this.validationResult.addError(error);
}
protected void addValidationErrors(List<ValidationError> errors)
{
for (ValidationError error : errors)
{
addValidationError(error);
}
}
@Override
public void parse() throws IOException
{
parse(Format.PDF_A1B);
}
/**
* Parse the given file and check if it is a confirming file according to the given format.
*
* @param format
* format that the document should follow (default {@link Format#PDF_A1B})
* @throws IOException
*/
public void parse(Format format) throws IOException
{
parse(format, null);
}
/**
* Parse the given file and check if it is a confirming file according to the given format.
*
* @param format
* format that the document should follow (default {@link Format#PDF_A1B})
* @param config
* Configuration bean that will be used by the PreflightDocument. If null the format is used to determine
* the default configuration.
* @throws IOException
*/
public void parse(Format format, PreflightConfiguration config) throws IOException
{
checkPdfHeader();
try
{
super.parse();
}
catch (IOException e)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_COMMON, e.getMessage()));
throw new SyntaxValidationException(e, this.validationResult);
}
Format formatToUse = (format == null ? Format.PDF_A1B : format);
createPdfADocument(formatToUse, config);
createContext();
}
protected void createPdfADocument(Format format, PreflightConfiguration config) throws IOException
{
COSDocument cosDocument = getDocument();
this.preflightDocument = new PreflightDocument(cosDocument, format, config);
}
/**
* Create a validation context. This context is set to the PreflightDocument.
*/
protected void createContext()
{
this.ctx = new PreflightContext(this.originalDocument);
ctx.setDocument(preflightDocument);
preflightDocument.setContext(ctx);
ctx.setXrefTableResolver(xrefTrailerResolver);
}
@Override
public PDDocument getPDDocument() throws IOException
{
preflightDocument.setResult(validationResult);
// Add XMP MetaData
return preflightDocument;
}
public PreflightDocument getPreflightDocument() throws IOException
{
return (PreflightDocument) getPDDocument();
}
// --------------------------------------------------------
// - Below All methods that adds controls on the PDF syntax
// --------------------------------------------------------
@Override
/**
* Fill the CosDocument with some object that isn't set by the NonSequentialParser
*/
protected void initialParse() throws IOException
{
super.initialParse();
// fill xref table
document.addXRefTable(xrefTrailerResolver.getXrefTable());
// For each ObjectKey, we check if the object has been loaded
// useful for linearized PDFs
Map<COSObjectKey, Long> xrefTable = document.getXrefTable();
for (Entry<COSObjectKey, Long> entry : xrefTable.entrySet())
{
COSObject co = document.getObjectFromPool(entry.getKey());
if (co.getObject() == null)
{
// object isn't loaded - parse the object to load its content
parseObjectDynamically(co, true);
}
}
}
/**
* Check that the PDF header match rules of the PDF/A specification. First line (offset 0) must be a comment with
* the PDF version (version 1.0 isn't conform to the PDF/A specification) Second line is a comment with at least 4
* bytes greater than 0x80
*/
protected void checkPdfHeader()
{
BufferedReader reader = null;
try
{
reader = new BufferedReader(new InputStreamReader(new FileInputStream(getPdfFile()), encoding));
String firstLine = reader.readLine();
if (firstLine == null || !firstLine.matches("%PDF-1\\.[1-9]"))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"First line must match %PDF-1.\\d"));
}
String secondLine = reader.readLine();
if (secondLine != null)
{
byte[] secondLineAsBytes = secondLine.getBytes(encoding.name());
if (secondLineAsBytes.length >= 5)
{
for (int i = 0; i < secondLineAsBytes.length; ++i)
{
byte b = secondLineAsBytes[i];
if (i == 0 && ((char) b != '%'))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Second line must contains at least 4 bytes greater than 127"));
break;
}
else if (i > 0 && ((b & 0xFF) < 0x80))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Second line must contains at least 4 bytes greater than 127"));
break;
}
}
}
else
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Second line must contains at least 4 bytes greater than 127"));
}
}
}
catch (IOException e)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_HEADER,
"Unable to read the PDF file : " + e.getMessage(), e));
}
finally
{
IOUtils.closeQuietly(reader);
}
}
/**
* Same method than the {@linkplain PDFParser#parseXrefTable(long)} with additional controls : - EOL mandatory after
* the 'xref' keyword - Cross reference subsection header uses single white space as separator - and so on
*/
@Override
protected boolean parseXrefTable(long startByteOffset) throws IOException
{
if (pdfSource.peek() != 'x')
{
return false;
}
String xref = readString();
if (!xref.equals("xref"))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"xref must be followed by a EOL character"));
return false;
}
if (!nextIsEOL())
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"xref must be followed by EOL"));
}
// signal start of new XRef
xrefTrailerResolver.nextXrefObj(startByteOffset,XRefType.TABLE);
/*
* Xref tables can have multiple sections. Each starts with a starting object id and a count.
*/
while (true)
{
// just after the xref<EOL> there are an integer
long currObjID; // first obj id
long count; // the number of objects in the xref table
long offset = pdfSource.getOffset();
String line = readLine();
Pattern pattern = Pattern.compile("(\\d+)\\s(\\d+)(\\s*)");
Matcher matcher = pattern.matcher(line);
if (matcher.matches())
{
currObjID = Integer.parseInt(matcher.group(1));
count = Integer.parseInt(matcher.group(2));
}
else
{
addValidationError(new ValidationError(ERROR_SYNTAX_CROSS_REF,
"Cross reference subsection header is invalid"));
// reset pdfSource cursor to read xref information
pdfSource.seek(offset);
currObjID = readObjectNumber(); // first obj id
count = readLong(); // the number of objects in the xref table
}
skipSpaces();
for (int i = 0; i < count; i++)
{
if (pdfSource.isEOF() || isEndOfName((char) pdfSource.peek()))
{
break;
}
if (pdfSource.peek() == 't')
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"Expected xref line but 't' found"));
break;
}
// Ignore table contents
String currentLine = readLine();
String[] splitString = currentLine.split(" ");
if (splitString.length < 3)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"invalid xref line: " + currentLine));
break;
}
/*
* This supports the corrupt table as reported in PDFBOX-474 (XXXX XXX XX n)
*/
if (splitString[splitString.length - 1].equals("n"))
{
try
{
long currOffset = Long.parseLong(splitString[0]);
int currGenID = Integer.parseInt(splitString[1]);
COSObjectKey objKey = new COSObjectKey(currObjID, currGenID);
xrefTrailerResolver.setXRef(objKey, currOffset);
}
catch (NumberFormatException e)
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"offset or genid can't be read as number " + e.getMessage(), e));
}
}
else if (!splitString[2].equals("f"))
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_CROSS_REF,
"Corrupt XRefTable Entry - ObjID:" + currObjID));
}
currObjID++;
skipSpaces();
}
skipSpaces();
char c = (char) pdfSource.peek();
if (c < '0' || c > '9')
{
break;
}
}
return true;
}
/**
* Wraps the {@link NonSequentialPDFParser#parseCOSStream} to check rules on 'stream' and 'endstream' keywords.
* {@link #checkStreamKeyWord()} and {@link #checkEndstreamKeyWord()}
*/
@Override
protected COSStream parseCOSStream(COSDictionary dic) throws IOException
{
checkStreamKeyWord();
COSStream result = super.parseCOSStream(dic);
checkEndstreamKeyWord();
return result;
}
/**
* 'stream' must be followed by <CR><LF> or only <LF>
*
* @throws IOException
*/
protected void checkStreamKeyWord() throws IOException
{
String streamV = readString();
if (!streamV.equals("stream"))
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'stream' keyword but found '" + streamV + "' at offset "+pdfSource.getOffset()));
}
int nextChar = pdfSource.read();
if (!((nextChar == 13 && pdfSource.peek() == 10) || nextChar == 10))
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'EOL' after the stream keyword at offset "+pdfSource.getOffset()));
}
// set the offset before stream
pdfSource.seek(pdfSource.getOffset() - 7);
}
/**
* 'endstream' must be preceded by an EOL
*
* @throws IOException
*/
protected void checkEndstreamKeyWord() throws IOException
{
pdfSource.seek(pdfSource.getOffset() - 10);
if (!nextIsEOL())
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'EOL' before the endstream keyword at offset "+pdfSource.getOffset()+" but found '"+pdfSource.peek()+"'"));
}
String endstreamV = readString();
if (!endstreamV.equals("endstream"))
{
addValidationError(new ValidationError(ERROR_SYNTAX_STREAM_DELIMITER,
"Expected 'endstream' keyword at offset "+pdfSource.getOffset()+" but found '" + endstreamV + "'"));
}
}
protected boolean nextIsEOL() throws IOException
{
boolean succeed = false;
int nextChar = pdfSource.read();
if (nextChar == 13 && pdfSource.peek() == 10)
{
pdfSource.read();
succeed = true;
}
else if (nextChar == 13 || nextChar == 10)
{
succeed = true;
}
return succeed;
}
/**
* @return true if the next character is a space. (The character is consumed)
* @throws IOException
*/
protected boolean nextIsSpace() throws IOException
{
return ' ' == pdfSource.read();
}
@Override
/**
* Call {@link BaseParser#parseCOSArray()} and check the number of element in the array
*/
protected COSArray parseCOSArray() throws IOException
{
COSArray result = super.parseCOSArray();
if (result != null && result.size() > MAX_ARRAY_ELEMENTS)
{
addValidationError(new ValidationError(ERROR_SYNTAX_ARRAY_TOO_LONG, "Array too long : " + result.size()));
}
return result;
}
@Override
/**
* Call {@link BaseParser#parseCOSName()} and check the length of the name
*/
protected COSName parseCOSName() throws IOException
{
COSName result = super.parseCOSName();
if (result != null && result.getName().getBytes().length > MAX_NAME_SIZE)
{
addValidationError(new ValidationError(ERROR_SYNTAX_NAME_TOO_LONG, "Name too long"));
}
return result;
}
/**
* Check that the hexa string contains only an even number of Hexadecimal characters. Once it is done, reset the
* offset at the beginning of the string and call {@link BaseParser#parseCOSString()}
* @deprecated Not needed anymore. Use {@link #parseCOSString()} instead. PDFBOX-1437
*/
@Override
@Deprecated
protected COSString parseCOSString(boolean isDictionary) throws IOException
{
return parseCOSString();
}
/**
* Check that the hexa string contains only an even number of Hexadecimal characters. Once it is done, reset the
* offset at the beginning of the string and call {@link BaseParser#parseCOSString()}
*/
@Override
protected COSString parseCOSString() throws IOException
{
// offset reminder
long offset = pdfSource.getOffset();
char nextChar = (char) pdfSource.read();
int count = 0;
if (nextChar == '<')
{
do
{
nextChar = (char) pdfSource.read();
if (nextChar != '>')
{
if (Character.digit(nextChar, 16) >= 0)
{
count++;
}
else
{
addValidationError(new ValidationError(ERROR_SYNTAX_HEXA_STRING_INVALID,
"Hexa String must have only Hexadecimal Characters (found '" + nextChar + "') at offset " + pdfSource.getOffset()));
break;
}
}
} while (nextChar != '>');
}
if (count % 2 != 0)
{
addValidationError(new ValidationError(ERROR_SYNTAX_HEXA_STRING_EVEN_NUMBER,
"Hexa string shall contain even number of non white space char at offset " + pdfSource.getOffset()));
}
// reset the offset to parse the COSString
pdfSource.seek(offset);
COSString result = super.parseCOSString();
if (result.getString().length() > MAX_STRING_LENGTH)
{
addValidationError(new ValidationError(ERROR_SYNTAX_HEXA_STRING_TOO_LONG, "Hexa string is too long at offset "+pdfSource.getOffset()));
}
return result;
}
/**
* Call {@link BaseParser#parseDirObject()} check limit range for Float, Integer and number of Dictionary entries.
*/
@Override
protected COSBase parseDirObject() throws IOException
{
COSBase result = super.parseDirObject();
if (result instanceof COSNumber)
{
COSNumber number = (COSNumber) result;
if (number instanceof COSFloat)
{
Double real = number.doubleValue();
if (real > MAX_POSITIVE_FLOAT || real < MAX_NEGATIVE_FLOAT)
{
addValidationError(new ValidationError(ERROR_SYNTAX_NUMERIC_RANGE,
"Float is too long or too small: " + real+" at offset "+pdfSource.getOffset()));
}
}
else
{
long numAsLong = number.longValue();
if (numAsLong > Integer.MAX_VALUE || numAsLong < Integer.MIN_VALUE)
{
addValidationError(new ValidationError(ERROR_SYNTAX_NUMERIC_RANGE,
"Numeric is too long or too small: " + numAsLong+" at offset "+pdfSource.getOffset()));
}
}
}
if (result instanceof COSDictionary)
{
COSDictionary dic = (COSDictionary) result;
if (dic.size() > MAX_DICT_ENTRIES)
{
addValidationError(new ValidationError(ERROR_SYNTAX_TOO_MANY_ENTRIES, "Too Many Entries In Dictionary at offset "+pdfSource.getOffset()));
}
}
return result;
}
@Override
protected COSBase parseObjectDynamically(int objNr, int objGenNr, boolean requireExistingNotCompressedObj)
throws IOException
{
// ---- create object key and get object (container) from pool
final COSObjectKey objKey = new COSObjectKey(objNr, objGenNr);
final COSObject pdfObject = document.getObjectFromPool(objKey);
if (pdfObject.getObject() == null)
{
// not previously parsed
// ---- read offset or object stream object number from xref table
Long offsetOrObjstmObNr = xrefTrailerResolver.getXrefTable().get(objKey);
// sanity test to circumvent loops with broken documents
if (requireExistingNotCompressedObj && ((offsetOrObjstmObNr == null)))
{
addValidationError(new ValidationError(ERROR_SYNTAX_MISSING_OFFSET,
"Object must be defined and must not be compressed object: " + objKey.getNumber() + ":"
+ objKey.getGeneration()));
throw new SyntaxValidationException("Object must be defined and must not be compressed object: "
+ objKey.getNumber() + ":" + objKey.getGeneration(), validationResult);
}
if (offsetOrObjstmObNr == null)
{
// not defined object -> NULL object (Spec. 1.7, chap. 3.2.9)
pdfObject.setObject(COSNull.NULL);
}
else if (offsetOrObjstmObNr == 0)
{
addValidationError(new ValidationError(ERROR_SYNTAX_INVALID_OFFSET, "Object {" + objKey.getNumber()
+ ":" + objKey.getGeneration() + "} has an offset of 0"));
}
else if (offsetOrObjstmObNr > 0)
{
// offset of indirect object in file
// ---- go to object start
setPdfSource(offsetOrObjstmObNr);
// ---- we must have an indirect object
long readObjNr;
int readObjGen;
long offset = pdfSource.getOffset();
String line = readLine();
Pattern pattern = Pattern.compile("(\\d+)\\s(\\d+)\\sobj");
Matcher matcher = pattern.matcher(line);
if (matcher.matches())
{
readObjNr = Integer.parseInt(matcher.group(1));
readObjGen = Integer.parseInt(matcher.group(2));
}
else
{
addValidationError(new ValidationError(ERROR_SYNTAX_OBJ_DELIMITER, "Single space expected [offset="+offset+"; key="+offsetOrObjstmObNr.toString()+"; line="+line+"; object="+pdfObject.toString()+"]"));
// reset pdfSource cursor to read object information
pdfSource.seek(offset);
readObjNr = readObjectNumber();
readObjGen = readGenerationNumber();
skipSpaces(); // skip spaces between Object Generation number and the 'obj' keyword
for (char c : OBJ_MARKER)
{
if (pdfSource.read() != c)
{
addValidationError(new ValidationError(ERROR_SYNTAX_OBJ_DELIMITER, "Expected pattern '"
+ new String(OBJ_MARKER) + " but missed at character '" + c + "'"));
throw new SyntaxValidationException("Expected pattern '" + new String(OBJ_MARKER)
+ " but missed at character '" + c + "'", validationResult);
}
}
}
// ---- consistency check
if ((readObjNr != objKey.getNumber()) || (readObjGen != objKey.getGeneration()))
{
throw new IOException("XREF for " + objKey.getNumber() + ":" + objKey.getGeneration()
+ " points to wrong object: " + readObjNr + ":" + readObjGen);
}
skipSpaces();
COSBase pb = parseDirObject();
skipSpaces();
long endObjectOffset = pdfSource.getOffset();
String endObjectKey = readString();
if (endObjectKey.equals("stream"))
{
pdfSource.seek(endObjectOffset);
if (pb instanceof COSDictionary)
{
COSStream stream = parseCOSStream((COSDictionary) pb);
if (securityHandler != null)
{
securityHandler.decryptStream(stream, objNr, objGenNr);
}
pb = stream;
}
else
{
// this is not legal
// the combination of a dict and the stream/endstream forms a complete stream object
throw new IOException("Stream not preceded by dictionary (offset: " + offsetOrObjstmObNr + ").");
}
skipSpaces();
endObjectOffset = pdfSource.getOffset();
endObjectKey = readString();
// we have case with a second 'endstream' before endobj
if (!endObjectKey.startsWith("endobj"))
{
if (endObjectKey.startsWith("endstream"))
{
endObjectKey = endObjectKey.substring(9).trim();
if (endObjectKey.length() == 0)
{
// no other characters in extra endstream line
endObjectKey = readString(); // read next line
}
}
}
}
else if (securityHandler != null)
{
// decrypt
if (pb instanceof COSString)
{
decryptString((COSString) pb, objNr, objGenNr);
}
else if (pb instanceof COSDictionary)
{
decryptDictionary((COSDictionary) pb, objNr, objGenNr);
}
else if (pb instanceof COSArray)
{
final COSArray array = (COSArray) pb;
for (int aIdx = 0, len = array.size(); aIdx < len; aIdx++)
{
if (array.get(aIdx) instanceof COSString)
{
decryptString((COSString) array.get(aIdx), objNr, objGenNr);
}
}
}
}
pdfObject.setObject(pb);
if (!endObjectKey.startsWith("endobj"))
{
throw new IOException("Object (" + readObjNr + ":" + readObjGen + ") at offset "
+ offsetOrObjstmObNr + " does not end with 'endobj'.");
}
else
{
offset = pdfSource.getOffset();
pdfSource.seek(endObjectOffset - 1);
if (!nextIsEOL())
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_OBJ_DELIMITER,
"EOL expected before the 'endobj' keyword at offset "+pdfSource.getOffset()));
}
pdfSource.seek(offset);
}
if (!nextIsEOL())
{
addValidationError(new ValidationError(PreflightConstants.ERROR_SYNTAX_OBJ_DELIMITER,
"EOL expected after the 'endobj' keyword at offset "+pdfSource.getOffset()));
}
releasePdfSourceInputStream();
}
else
{
// xref value is object nr of object stream containing object to be parsed;
// since our object was not found it means object stream was not parsed so far
final int objstmObjNr = (int) (-offsetOrObjstmObNr);
final COSBase objstmBaseObj = parseObjectDynamically(objstmObjNr, 0, true);
if (objstmBaseObj instanceof COSStream)
{
// parse object stream
PDFObjectStreamParser parser = new PDFObjectStreamParser((COSStream) objstmBaseObj, document,
forceParsing);
parser.parse();
// get set of object numbers referenced for this object stream
final Set<Long> refObjNrs = xrefTrailerResolver.getContainedObjectNumbers(objstmObjNr);
// register all objects which are referenced to be contained in object stream
for (COSObject next : parser.getObjects())
{
COSObjectKey stmObjKey = new COSObjectKey(next);
if (refObjNrs.contains(stmObjKey.getNumber()))
{
COSObject stmObj = document.getObjectFromPool(stmObjKey);
stmObj.setObject(next.getObject());
}
}
}
}
}
return pdfObject.getObject();
}
@Override
protected int lastIndexOf(final char[] pattern, final byte[] buf, final int endOff)
{
int offset = super.lastIndexOf(pattern, buf, endOff);
if (offset > 0 && Arrays.equals(pattern, EOF_MARKER))
{
// this is the offset of the last %%EOF sequence.
// nothing should be present after this sequence.
int tmpOffset = offset + pattern.length;
if (tmpOffset != buf.length)
{
// EOL is authorized
if ((buf.length - tmpOffset) > 2
|| (buf.length - tmpOffset == 2 && (buf[tmpOffset] != 13 || buf[tmpOffset + 1] != 10))
|| (buf.length - tmpOffset == 1 && buf[tmpOffset] != 10))
{
addValidationError(new ValidationError(ERROR_SYNTAX_TRAILER_EOF,
"File contains data after the last %%EOF sequence at offset " + pdfSource.getOffset()));
}
}
}
return offset;
}
}
| PDFBOX-2533: DRY refactoring of decryption code that is used in PreflightParser and in NonSequentialParser
git-svn-id: c3ad59981690829a43dc34c293c4e2cd04bcd994@1642809 13f79535-47bb-0310-9956-ffa450edef68
| preflight/src/main/java/org/apache/pdfbox/preflight/parser/PreflightParser.java | PDFBOX-2533: DRY refactoring of decryption code that is used in PreflightParser and in NonSequentialParser | <ide><path>reflight/src/main/java/org/apache/pdfbox/preflight/parser/PreflightParser.java
<ide> }
<ide> else if (securityHandler != null)
<ide> {
<del> // decrypt
<del> if (pb instanceof COSString)
<del> {
<del> decryptString((COSString) pb, objNr, objGenNr);
<del> }
<del> else if (pb instanceof COSDictionary)
<del> {
<del> decryptDictionary((COSDictionary) pb, objNr, objGenNr);
<del> }
<del> else if (pb instanceof COSArray)
<del> {
<del> final COSArray array = (COSArray) pb;
<del> for (int aIdx = 0, len = array.size(); aIdx < len; aIdx++)
<del> {
<del> if (array.get(aIdx) instanceof COSString)
<del> {
<del> decryptString((COSString) array.get(aIdx), objNr, objGenNr);
<del> }
<del> }
<del> }
<add> decrypt(pb, objNr, objGenNr);
<ide> }
<ide>
<ide> pdfObject.setObject(pb); |
|
Java | lgpl-2.1 | e9dc3fd6427abc3d1c16803244b573b5dc451959 | 0 | maxbiostat/beast-mcmc,maxbiostat/beast-mcmc,maxbiostat/beast-mcmc,adamallo/beast-mcmc,codeaudit/beast-mcmc,beast-dev/beast-mcmc,codeaudit/beast-mcmc,codeaudit/beast-mcmc,4ment/beast-mcmc,adamallo/beast-mcmc,maxbiostat/beast-mcmc,adamallo/beast-mcmc,4ment/beast-mcmc,beast-dev/beast-mcmc,4ment/beast-mcmc,4ment/beast-mcmc,beast-dev/beast-mcmc,codeaudit/beast-mcmc,adamallo/beast-mcmc,beast-dev/beast-mcmc,4ment/beast-mcmc,beast-dev/beast-mcmc,adamallo/beast-mcmc,maxbiostat/beast-mcmc,codeaudit/beast-mcmc,maxbiostat/beast-mcmc,beast-dev/beast-mcmc,adamallo/beast-mcmc,codeaudit/beast-mcmc,4ment/beast-mcmc | /*
* TreeIntervals.java
*
* Copyright (C) 2002-2006 Alexei Drummond and Andrew Rambaut
*
* 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.evolution.coalescent;
import dr.evolution.tree.NodeRef;
import dr.evolution.tree.Tree;
import dr.util.HeapSort;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Extracts the intervals from a tree.
*
* @version $Id: TreeIntervals.java,v 1.9 2005/05/24 20:25:56 rambaut Exp $
*
* @author Andrew Rambaut
* @author Alexei Drummond
*/
public class TreeIntervals implements IntervalList {
/**
* Parameterless constructor.
*/
public TreeIntervals() { }
public TreeIntervals(Tree tree) { setTree(tree); }
/**
* Sets the tree for which intervals are obtained
*/
public void setTree(Tree tree)
{
this.tree = tree;
intervalsKnown = false;
}
/**
* Specifies that the intervals are unknown (i.e., the tree has changed).
*/
public void setIntervalsUnknown()
{
intervalsKnown = false;
}
/**
* Sets the limit for which adjacent events are merged.
* @param multifurcationLimit A value of 0 means merge addition of leafs (terminal nodes) when possible but
* return each coalescense as a separate event.
*
*/
public void setMultifurcationLimit(double multifurcationLimit)
{
this.multifurcationLimit = multifurcationLimit;
intervalsKnown = false;
}
public int getSampleCount() {
return tree.getExternalNodeCount();
}
/**
* get number of intervals
*/
public int getIntervalCount()
{
if (!intervalsKnown) {
calculateIntervals();
}
return intervalCount;
}
/**
* Gets an interval.
*/
public double getInterval(int i) {
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
return intervals[i];
}
/**
* Returns the number of uncoalesced lineages within this interval.
* Required for s-coalescents, where new lineages are added as
* earlier samples are come across.
*/
public int getLineageCount(int i) {
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
return lineageCounts[i];
}
/**
* @param interval
* @return a list of the noderefs representing the lineages in the ith interval.
*/
public final List getLineages(int interval) {
if (lineages[interval] == null) {
List<Object> lines = new ArrayList<Object>();
for (int i = 0; i <= interval; i++) {
if (lineagesAdded[i] != null) lines.addAll(lineagesAdded[i]);
if (lineagesRemoved[i] != null) lines.removeAll(lineagesRemoved[i]);
}
lineages[interval] = Collections.unmodifiableList(lines);
}
return lineages[interval];
}
/**
* Returns the number coalescent events in an interval
*/
public int getCoalescentEvents(int i)
{
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
if (i < intervalCount-1)
{
return lineageCounts[i]-lineageCounts[i+1];
}
else
{
return lineageCounts[i]-1;
}
}
/**
* Returns the type of interval observed.
*/
public IntervalType getIntervalType(int i)
{
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
int numEvents = getCoalescentEvents(i);
if (numEvents > 0) return IntervalType.COALESCENT;
else if (numEvents < 0) return IntervalType.SAMPLE;
else return IntervalType.NOTHING;
}
public NodeRef getCoalescentNode(int interval) {
if (getIntervalType(interval) == IntervalType.COALESCENT) {
if (lineagesRemoved[interval] != null) {
if (lineagesRemoved[interval].size() == 1) {
return lineagesRemoved[interval].get(0);
} else throw new IllegalArgumentException("multiple lineages lost over this interval!");
} else throw new IllegalArgumentException("Inconsistent: no intervals lost over this interval!");
} else throw new IllegalArgumentException("Interval " + interval + " is not a coalescent interval.");
}
/**
* get the total height of the genealogy represented by these
* intervals.
*/
public double getTotalDuration() {
if (!intervalsKnown) {
calculateIntervals();
}
double height=0.0;
for (int j=0; j < intervalCount; j++) {
height += intervals[j];
}
return height;
}
/**
* Checks whether this set of coalescent intervals is fully resolved
* (i.e. whether is has exactly one coalescent event in each
* subsequent interval)
*/
public boolean isBinaryCoalescent()
{
if (!intervalsKnown) {
calculateIntervals();
}
for (int i = 0; i < intervalCount; i++) {
if (getCoalescentEvents(i) > 0) {
if (getCoalescentEvents(i) != 1) return false;
}
}
return true;
}
/**
* Checks whether this set of coalescent intervals coalescent only
* (i.e. whether is has exactly one or more coalescent event in each
* subsequent interval)
*/
public boolean isCoalescentOnly()
{
if (!intervalsKnown) {
calculateIntervals();
}
for (int i = 0; i < intervalCount; i++)
{
if (getCoalescentEvents(i) < 1) return false;
}
return true;
}
/**
* Recalculates all the intervals for the given tree.
*/
private void calculateIntervals() {
int nodeCount = tree.getNodeCount();
double[] times = new double[nodeCount];
int[] childCounts = new int[nodeCount];
collectTimes(tree, times, childCounts);
int[] indices = new int[nodeCount];
HeapSort.sort(times, indices);
if (intervals == null || intervals.length != nodeCount) {
intervals = new double[nodeCount];
lineageCounts = new int[nodeCount];
lineagesAdded = new List[nodeCount];
lineagesRemoved = new List[nodeCount];
lineages = new List[nodeCount];
}
// start is the time of the first tip
double start = times[indices[0]];
int numLines = 0;
int nodeNo = 0;
intervalCount = 0;
while (nodeNo < nodeCount) {
int lineagesRemoved = 0;
int lineagesAdded = 0;
double finish = times[indices[nodeNo]];
double next;
do {
final int childIndex = indices[nodeNo];
final int childCount = childCounts[childIndex];
// dont use nodeNo from here on in do loop
nodeNo += 1;
if (childCount == 0) {
addLineage(intervalCount, tree.getNode(childIndex));
lineagesAdded += 1;
} else {
lineagesRemoved += (childCount - 1);
// record removed lineages
final NodeRef parent = tree.getNode(childIndex);
//assert childCounts[indices[nodeNo]] == tree.getChildCount(parent);
//for (int j = 0; j < lineagesRemoved + 1; j++) {
for (int j = 0; j < childCount; j++) {
NodeRef child = tree.getChild(parent, j);
removeLineage(intervalCount, child);
}
// record added lineages
addLineage(intervalCount, parent);
// no mix of removed lineages when 0 th
if( multifurcationLimit == 0.0 ) {
break;
}
}
if (nodeNo < nodeCount) {
next = times[indices[nodeNo]];
} else break;
} while (Math.abs(next - finish) <= multifurcationLimit);
if (lineagesAdded > 0) {
if (intervalCount > 0 || ((finish - start) > multifurcationLimit)) {
intervals[intervalCount] = finish - start;
lineageCounts[intervalCount] = numLines;
intervalCount += 1;
}
start = finish;
}
// add sample event
numLines += lineagesAdded;
if (lineagesRemoved > 0) {
intervals[intervalCount] = finish - start;
lineageCounts[intervalCount] = numLines;
intervalCount += 1;
start = finish;
}
// coalescent event
numLines -= lineagesRemoved;
}
intervalsKnown = true;
}
private void addLineage(int interval, NodeRef node) {
if (lineagesAdded[interval] == null) lineagesAdded[interval] = new ArrayList<NodeRef>();
lineagesAdded[interval].add(node);
}
private void removeLineage(int interval, NodeRef node) {
if (lineagesRemoved[interval] == null) lineagesRemoved[interval] = new ArrayList<NodeRef>();
lineagesRemoved[interval].add(node);
}
/**
* @return the delta parameter of Pybus et al (Node spread statistic)
*/
public double getDelta() {
return IntervalList.Utils.getDelta(this);
}
/**
* extract coalescent times and tip information into array times from tree.
*/
private static void collectTimes(Tree tree, double[] times, int[] childCounts) {
for (int i = 0; i < tree.getNodeCount(); i++) {
NodeRef node = tree.getNode(i);
times[i] = tree.getNodeHeight(node);
childCounts[i] = tree.getChildCount(node);
}
}
/**
* Return the units that this tree is expressed in.
*/
public final Type getUnits() {
return tree.getUnits();
}
/**
* Sets the units that this tree is expressed in.
*/
public final void setUnits(Type units) {
throw new IllegalArgumentException("Can't set interval's units");
}
/** The tree. */
private Tree tree = null;
/** The widths of the intervals. */
private double[] intervals;
/** The number of uncoalesced lineages within a particular interval. */
private int[] lineageCounts;
/**
* The lineages in each interval (stored by node ref).
*/
private List<NodeRef>[] lineagesAdded;
private List<NodeRef>[] lineagesRemoved;
private List[] lineages;
private int intervalCount = 0;
/** are the intervals known? */
private boolean intervalsKnown = false;
private double multifurcationLimit = -1.0;
} | src/dr/evolution/coalescent/TreeIntervals.java | /*
* TreeIntervals.java
*
* Copyright (C) 2002-2006 Alexei Drummond and Andrew Rambaut
*
* 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.evolution.coalescent;
import dr.evolution.tree.NodeRef;
import dr.evolution.tree.Tree;
import dr.util.HeapSort;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* Extracts the intervals from a tree.
*
* @version $Id: TreeIntervals.java,v 1.9 2005/05/24 20:25:56 rambaut Exp $
*
* @author Andrew Rambaut
* @author Alexei Drummond
*/
public class TreeIntervals implements IntervalList {
/**
* Parameterless constructor.
*/
public TreeIntervals() { }
public TreeIntervals(Tree tree) { setTree(tree); }
/**
* Sets the tree for which intervals are obtained
*/
public void setTree(Tree tree)
{
this.tree = tree;
intervalsKnown = false;
}
/**
* Specifies that the intervals are unknown (i.e., the tree has changed).
*/
public void setIntervalsUnknown()
{
intervalsKnown = false;
}
/**
* Sets the limit for which adjacent intervals are merged
*/
public void setMultifurcationLimit(double multifurcationLimit)
{
this.multifurcationLimit = multifurcationLimit;
intervalsKnown = false;
}
public int getSampleCount() {
return tree.getExternalNodeCount();
}
/**
* get number of intervals
*/
public int getIntervalCount()
{
if (!intervalsKnown) {
calculateIntervals();
}
return intervalCount;
}
/**
* Gets an interval.
*/
public double getInterval(int i) {
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
return intervals[i];
}
/**
* Returns the number of uncoalesced lineages within this interval.
* Required for s-coalescents, where new lineages are added as
* earlier samples are come across.
*/
public int getLineageCount(int i) {
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
return lineageCounts[i];
}
/**
* @param interval
* @return a list of the noderefs representing the lineages in the ith interval.
*/
public final List getLineages(int interval) {
if (lineages[interval] == null) {
List<Object> lines = new ArrayList<Object>();
for (int i = 0; i <= interval; i++) {
if (lineagesAdded[i] != null) lines.addAll(lineagesAdded[i]);
if (lineagesRemoved[i] != null) lines.removeAll(lineagesRemoved[i]);
}
lineages[interval] = Collections.unmodifiableList(lines);
}
return lineages[interval];
}
/**
* Returns the number coalescent events in an interval
*/
public int getCoalescentEvents(int i)
{
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
if (i < intervalCount-1)
{
return lineageCounts[i]-lineageCounts[i+1];
}
else
{
return lineageCounts[i]-1;
}
}
/**
* Returns the type of interval observed.
*/
public IntervalType getIntervalType(int i)
{
if (!intervalsKnown) {
calculateIntervals();
}
if (i >= intervalCount) throw new IllegalArgumentException();
int numEvents = getCoalescentEvents(i);
if (numEvents > 0) return IntervalType.COALESCENT;
else if (numEvents < 0) return IntervalType.SAMPLE;
else return IntervalType.NOTHING;
}
public NodeRef getCoalescentNode(int interval) {
if (getIntervalType(interval) == IntervalType.COALESCENT) {
if (lineagesRemoved[interval] != null) {
if (lineagesRemoved[interval].size() == 1) {
return lineagesRemoved[interval].get(0);
} else throw new IllegalArgumentException("multiple lineages lost over this interval!");
} else throw new IllegalArgumentException("Inconsistent: no intervals lost over this interval!");
} else throw new IllegalArgumentException("Interval " + interval + " is not a coalescent interval.");
}
/**
* get the total height of the genealogy represented by these
* intervals.
*/
public double getTotalDuration() {
if (!intervalsKnown) {
calculateIntervals();
}
double height=0.0;
for (int j=0; j < intervalCount; j++) {
height += intervals[j];
}
return height;
}
/**
* Checks whether this set of coalescent intervals is fully resolved
* (i.e. whether is has exactly one coalescent event in each
* subsequent interval)
*/
public boolean isBinaryCoalescent()
{
if (!intervalsKnown) {
calculateIntervals();
}
for (int i = 0; i < intervalCount; i++) {
if (getCoalescentEvents(i) > 0) {
if (getCoalescentEvents(i) != 1) return false;
}
}
return true;
}
/**
* Checks whether this set of coalescent intervals coalescent only
* (i.e. whether is has exactly one or more coalescent event in each
* subsequent interval)
*/
public boolean isCoalescentOnly()
{
if (!intervalsKnown) {
calculateIntervals();
}
for (int i = 0; i < intervalCount; i++)
{
if (getCoalescentEvents(i) < 1) return false;
}
return true;
}
/**
* Recalculates all the intervals for the given tree.
*/
private void calculateIntervals() {
int nodeCount = tree.getNodeCount();
double[] times = new double[nodeCount];
int[] childCounts = new int[nodeCount];
collectTimes(tree, times, childCounts);
int[] indices = new int[nodeCount];
HeapSort.sort(times, indices);
if (intervals == null || intervals.length != nodeCount) {
intervals = new double[nodeCount];
lineageCounts = new int[nodeCount];
lineagesAdded = new List[nodeCount];
lineagesRemoved = new List[nodeCount];
lineages = new List[nodeCount];
}
// start is the time of the first tip
double start = times[indices[0]];
int numLines = 0;
int i = 0;
intervalCount = 0;
while (i < nodeCount) {
int lineagesRemoved = 0;
int lineagesAdded = 0;
double finish = times[indices[i]];
double next = finish;
do {
if (childCounts[indices[i]] == 0) {
addLineage(intervalCount, tree.getNode(indices[i]));
lineagesAdded += 1;
} else {
lineagesRemoved += (childCounts[indices[i]] - 1);
// record removed lineages
NodeRef parent = tree.getNode(indices[i]);
for (int j = 0; j < lineagesRemoved + 1; j++) {
NodeRef child = tree.getChild(parent, j);
removeLineage(intervalCount, child);
}
// record added lineages
addLineage(intervalCount, parent);
}
i += 1;
if (i < nodeCount) {
next = times[indices[i]];
} else break;
} while (Math.abs(next - finish) <= multifurcationLimit);
if (lineagesAdded > 0) {
if (intervalCount > 0 || ((finish - start) > multifurcationLimit)) {
intervals[intervalCount] = finish - start;
lineageCounts[intervalCount] = numLines;
intervalCount += 1;
}
start = finish;
}
// add sample event
numLines += lineagesAdded;
if (lineagesRemoved > 0) {
intervals[intervalCount] = finish - start;
lineageCounts[intervalCount] = numLines;
intervalCount += 1;
start = finish;
}
// coalescent event
numLines -= lineagesRemoved;
}
intervalsKnown = true;
}
private void addLineage(int interval, NodeRef node) {
if (lineagesAdded[interval] == null) lineagesAdded[interval] = new ArrayList<NodeRef>();
lineagesAdded[interval].add(node);
}
private void removeLineage(int interval, NodeRef node) {
if (lineagesRemoved[interval] == null) lineagesRemoved[interval] = new ArrayList<NodeRef>();
lineagesRemoved[interval].add(node);
}
/**
* @return the delta parameter of Pybus et al (Node spread statistic)
*/
public double getDelta() {
return IntervalList.Utils.getDelta(this);
}
/**
* extract coalescent times and tip information into array times from tree.
*/
private static void collectTimes(Tree tree, double[] times, int[] childCounts) {
for (int i = 0; i < tree.getNodeCount(); i++) {
NodeRef node = tree.getNode(i);
times[i] = tree.getNodeHeight(node);
childCounts[i] = tree.getChildCount(node);
}
}
/**
* Return the units that this tree is expressed in.
*/
public final Type getUnits() {
return tree.getUnits();
}
/**
* Sets the units that this tree is expressed in.
*/
public final void setUnits(Type units) {
throw new IllegalArgumentException("Can't set interval's units");
}
/** The tree. */
private Tree tree = null;
/** The widths of the intervals. */
private double[] intervals;
/** The number of uncoalesced lineages within a particular interval. */
private int[] lineageCounts;
/**
* The lineages in each interval (stored by node ref).
*/
private List<NodeRef>[] lineagesAdded;
private List<NodeRef>[] lineagesRemoved;
private List[] lineages;
private int intervalCount = 0;
/** are the intervals known? */
private boolean intervalsKnown = false;
private double multifurcationLimit = -1.0;
} | fix a bug which caused a crash when two coalecsent events are merged. Also add functionality for obtaining every coalecsent event as a separate event. | src/dr/evolution/coalescent/TreeIntervals.java | fix a bug which caused a crash when two coalecsent events are merged. Also add functionality for obtaining every coalecsent event as a separate event. | <ide><path>rc/dr/evolution/coalescent/TreeIntervals.java
<ide> intervalsKnown = false;
<ide> }
<ide>
<del> /**
<del> * Sets the limit for which adjacent intervals are merged
<del> */
<del> public void setMultifurcationLimit(double multifurcationLimit)
<add> /**
<add> * Sets the limit for which adjacent events are merged.
<add> * @param multifurcationLimit A value of 0 means merge addition of leafs (terminal nodes) when possible but
<add> * return each coalescense as a separate event.
<add> *
<add> */
<add> public void setMultifurcationLimit(double multifurcationLimit)
<ide> {
<ide> this.multifurcationLimit = multifurcationLimit;
<ide> intervalsKnown = false;
<ide> // start is the time of the first tip
<ide> double start = times[indices[0]];
<ide> int numLines = 0;
<del> int i = 0;
<add> int nodeNo = 0;
<ide> intervalCount = 0;
<del> while (i < nodeCount) {
<add> while (nodeNo < nodeCount) {
<ide>
<ide> int lineagesRemoved = 0;
<ide> int lineagesAdded = 0;
<ide>
<del> double finish = times[indices[i]];
<del> double next = finish;
<add> double finish = times[indices[nodeNo]];
<add> double next;
<ide>
<ide> do {
<del> if (childCounts[indices[i]] == 0) {
<del> addLineage(intervalCount, tree.getNode(indices[i]));
<add> final int childIndex = indices[nodeNo];
<add> final int childCount = childCounts[childIndex];
<add> // dont use nodeNo from here on in do loop
<add> nodeNo += 1;
<add> if (childCount == 0) {
<add> addLineage(intervalCount, tree.getNode(childIndex));
<ide> lineagesAdded += 1;
<ide> } else {
<del> lineagesRemoved += (childCounts[indices[i]] - 1);
<add> lineagesRemoved += (childCount - 1);
<ide>
<ide> // record removed lineages
<del> NodeRef parent = tree.getNode(indices[i]);
<del> for (int j = 0; j < lineagesRemoved + 1; j++) {
<add> final NodeRef parent = tree.getNode(childIndex);
<add> //assert childCounts[indices[nodeNo]] == tree.getChildCount(parent);
<add> //for (int j = 0; j < lineagesRemoved + 1; j++) {
<add> for (int j = 0; j < childCount; j++) {
<ide> NodeRef child = tree.getChild(parent, j);
<ide> removeLineage(intervalCount, child);
<ide> }
<ide>
<ide> // record added lineages
<ide> addLineage(intervalCount, parent);
<add> // no mix of removed lineages when 0 th
<add> if( multifurcationLimit == 0.0 ) {
<add> break;
<add> }
<ide> }
<del> i += 1;
<del> if (i < nodeCount) {
<del> next = times[indices[i]];
<add>
<add> if (nodeNo < nodeCount) {
<add> next = times[indices[nodeNo]];
<ide> } else break;
<ide> } while (Math.abs(next - finish) <= multifurcationLimit);
<ide> |
|
Java | apache-2.0 | 7ef0026ad214503d6495c01ab645dbec758d9c64 | 0 | gquintana/liquibase,Vampire/liquibase,lazaronixon/liquibase,hbogaards/liquibase,instantdelay/liquibase,AlisonSouza/liquibase,dyk/liquibase,mattbertolini/liquibase,mwaylabs/liquibase,ArloL/liquibase,fbiville/liquibase,dbmanul/dbmanul,Willem1987/liquibase,mwaylabs/liquibase,evigeant/liquibase,balazs-zsoldos/liquibase,CoderPaulK/liquibase,mbreslow/liquibase,CoderPaulK/liquibase,mortegac/liquibase,cbotiza/liquibase,iherasymenko/liquibase,dprguard2000/liquibase,FreshGrade/liquibase,adriens/liquibase,rkrzewski/liquibase,syncron/liquibase,Willem1987/liquibase,dbmanul/dbmanul,FreshGrade/liquibase,fbiville/liquibase,maberle/liquibase,mbreslow/liquibase,jimmycd/liquibase,jimmycd/liquibase,OpenCST/liquibase,OculusVR/shanghai-liquibase,maberle/liquibase,maberle/liquibase,adriens/liquibase,pellcorp/liquibase,Willem1987/liquibase,FreshGrade/liquibase,klopfdreh/liquibase,fbiville/liquibase,OculusVR/shanghai-liquibase,maberle/liquibase,tjardo83/liquibase,ZEPowerGroup/liquibase,C0mmi3/liquibase,foxel/liquibase,Datical/liquibase,mbreslow/liquibase,pellcorp/liquibase,OpenCST/liquibase,balazs-zsoldos/liquibase,dbmanul/dbmanul,iherasymenko/liquibase,balazs-zsoldos/liquibase,vbekiaris/liquibase,NSIT/liquibase,evigeant/liquibase,NSIT/liquibase,C0mmi3/liquibase,gquintana/liquibase,foxel/liquibase,CoderPaulK/liquibase,dbmanul/dbmanul,Vampire/liquibase,gquintana/liquibase,Datical/liquibase,evigeant/liquibase,talklittle/liquibase,russ-p/liquibase,talklittle/liquibase,lazaronixon/liquibase,EVODelavega/liquibase,AlisonSouza/liquibase,evigeant/liquibase,dprguard2000/liquibase,foxel/liquibase,Vampire/liquibase,lazaronixon/liquibase,mwaylabs/liquibase,mortegac/liquibase,mattbertolini/liquibase,vfpfafrf/liquibase,vast-engineering/liquibase,ivaylo5ev/liquibase,danielkec/liquibase,mbreslow/liquibase,AlisonSouza/liquibase,mortegac/liquibase,OculusVR/shanghai-liquibase,danielkec/liquibase,talklittle/liquibase,jimmycd/liquibase,fossamagna/liquibase,gquintana/liquibase,OpenCST/liquibase,rkrzewski/liquibase,tjardo83/liquibase,dyk/liquibase,lazaronixon/liquibase,instantdelay/liquibase,russ-p/liquibase,dyk/liquibase,foxel/liquibase,hbogaards/liquibase,tjardo83/liquibase,iherasymenko/liquibase,NSIT/liquibase,EVODelavega/liquibase,EVODelavega/liquibase,fossamagna/liquibase,russ-p/liquibase,cleiter/liquibase,cbotiza/liquibase,cbotiza/liquibase,fbiville/liquibase,instantdelay/liquibase,russ-p/liquibase,balazs-zsoldos/liquibase,adriens/liquibase,OculusVR/shanghai-liquibase,Datical/liquibase,dprguard2000/liquibase,mattbertolini/liquibase,pellcorp/liquibase,danielkec/liquibase,vfpfafrf/liquibase,dyk/liquibase,vast-engineering/liquibase,liquibase/liquibase,klopfdreh/liquibase,syncron/liquibase,AlisonSouza/liquibase,hbogaards/liquibase,Willem1987/liquibase,ivaylo5ev/liquibase,jimmycd/liquibase,instantdelay/liquibase,talklittle/liquibase,liquibase/liquibase,CoderPaulK/liquibase,liquibase/liquibase,vbekiaris/liquibase,syncron/liquibase,fossamagna/liquibase,klopfdreh/liquibase,pellcorp/liquibase,ArloL/liquibase,FreshGrade/liquibase,mattbertolini/liquibase,rkrzewski/liquibase,vfpfafrf/liquibase,iherasymenko/liquibase,danielkec/liquibase,ZEPowerGroup/liquibase,mwaylabs/liquibase,vfpfafrf/liquibase,cleiter/liquibase,cbotiza/liquibase,cleiter/liquibase,dprguard2000/liquibase,ArloL/liquibase,vast-engineering/liquibase,cleiter/liquibase,ZEPowerGroup/liquibase,vbekiaris/liquibase,C0mmi3/liquibase,Datical/liquibase,klopfdreh/liquibase,vast-engineering/liquibase,C0mmi3/liquibase,tjardo83/liquibase,hbogaards/liquibase,OpenCST/liquibase,NSIT/liquibase,EVODelavega/liquibase,mortegac/liquibase,syncron/liquibase,vbekiaris/liquibase | package liquibase.parser.xml;
import liquibase.ChangeSet;
import liquibase.DatabaseChangeLog;
import liquibase.FileOpener;
import liquibase.database.sql.visitor.SqlVisitorFactory;
import liquibase.database.sql.visitor.SqlVisitor;
import liquibase.change.*;
import liquibase.change.custom.CustomChangeWrapper;
import liquibase.exception.CustomChangeException;
import liquibase.exception.LiquibaseException;
import liquibase.exception.MigrationFailedException;
import liquibase.log.LogFactory;
import liquibase.parser.ChangeLogParser;
import liquibase.parser.ExpressionExpander;
import liquibase.preconditions.*;
import liquibase.util.ObjectUtil;
import liquibase.util.StringUtils;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import java.lang.reflect.InvocationTargetException;
import java.util.*;
import java.util.regex.Pattern;
import java.util.regex.Matcher;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.io.File;
import java.io.InputStream;
import java.io.FilenameFilter;
import java.net.URL;
import java.net.URI;
class XMLChangeLogHandler extends DefaultHandler {
private static final char LIQUIBASE_FILE_SEPARATOR = '/';
protected Logger log;
private DatabaseChangeLog databaseChangeLog;
private Change change;
private StringBuffer text;
private Preconditions rootPrecondition;
private Stack<PreconditionLogic> preconditionLogicStack = new Stack<PreconditionLogic>();
private ChangeSet changeSet;
private String paramName;
private FileOpener fileOpener;
private Precondition currentPrecondition;
private Map<String, Object> changeLogParameters = new HashMap<String, Object>();
private boolean inRollback = false;
private boolean inModifySql = false;
private Collection modifySqlDbmsList;
protected XMLChangeLogHandler(String physicalChangeLogLocation, FileOpener fileOpener, Map<String, Object> properties) {
log = LogFactory.getLogger();
this.fileOpener = fileOpener;
databaseChangeLog = new DatabaseChangeLog(physicalChangeLogLocation);
databaseChangeLog.setPhysicalFilePath(physicalChangeLogLocation);
for (Map.Entry entry : System.getProperties().entrySet()) {
changeLogParameters.put(entry.getKey().toString(), entry.getValue());
}
for (Map.Entry entry : properties.entrySet()) {
changeLogParameters.put(entry.getKey().toString(), entry.getValue());
}
}
public DatabaseChangeLog getDatabaseChangeLog() {
return databaseChangeLog;
}
public void startElement(String uri, String localName, String qName, Attributes baseAttributes) throws SAXException {
Attributes atts = new ExpandingAttributes(baseAttributes);
try {
if ("comment".equals(qName)) {
text = new StringBuffer();
} else if ("validCheckSum".equals(qName)) {
text = new StringBuffer();
} else if ("databaseChangeLog".equals(qName)) {
String version = uri.substring(uri.lastIndexOf("/") + 1);
if (!version.equals(XMLChangeLogParser.getSchemaVersion())) {
log.warning(databaseChangeLog.getPhysicalFilePath() + " is using schema version " + version + " rather than version " + XMLChangeLogParser.getSchemaVersion());
}
databaseChangeLog.setLogicalFilePath(atts.getValue("logicalFilePath"));
} else if ("include".equals(qName)) {
String fileName = atts.getValue("file");
boolean isRelativeToChangelogFile = Boolean.parseBoolean(atts.getValue("relativeToChangelogFile"));
handleIncludedChangeLog(fileName, isRelativeToChangelogFile, databaseChangeLog.getPhysicalFilePath());
} else if ("includeAll".equals(qName)) {
String pathName = atts.getValue("path");
Enumeration<URL> resources = fileOpener.getResources(pathName);
while (resources.hasMoreElements()) {
URL dirUrl = resources.nextElement();
if (dirUrl.getAuthority() != null) {
continue;
}
File dir = new File(new URI(dirUrl.toExternalForm()));
if (!dir.exists()) {
throw new SAXException("includeAll path " + pathName + " could not be found. Tried in " + dir.toString());
}
File[] files = dir.listFiles(new FilenameFilter() {
public boolean accept(File dir, String name) {
return name.endsWith(".xml") || name.endsWith(".sql");
}
});
for (File file : files) {
handleIncludedChangeLog(pathName + file.getName(), false, databaseChangeLog.getPhysicalFilePath());
}
}
} else if (changeSet == null && "changeSet".equals(qName)) {
boolean alwaysRun = false;
boolean runOnChange = false;
if ("true".equalsIgnoreCase(atts.getValue("runAlways"))) {
alwaysRun = true;
}
if ("true".equalsIgnoreCase(atts.getValue("runOnChange"))) {
runOnChange = true;
}
changeSet = new ChangeSet(atts.getValue("id"),
atts.getValue("author"),
alwaysRun,
runOnChange,
databaseChangeLog.getFilePath(),
databaseChangeLog.getPhysicalFilePath(),
atts.getValue("context"),
atts.getValue("dbms"),
Boolean.valueOf(atts.getValue("runInTransaction")));
if (StringUtils.trimToNull(atts.getValue("failOnError")) != null) {
changeSet.setFailOnError(Boolean.parseBoolean(atts.getValue("failOnError")));
}
} else if (changeSet != null && "rollback".equals(qName)) {
text = new StringBuffer();
String id = atts.getValue("changeSetId");
if (id != null) {
String path = atts.getValue("changeSetPath");
if (path == null) {
path = databaseChangeLog.getFilePath();
}
String author = atts.getValue("changeSetAuthor");
ChangeSet changeSet = databaseChangeLog.getChangeSet(path, author, id);
if (changeSet == null) {
throw new SAXException("Could not find changeSet to use for rollback: " + path + ":" + author + ":" + id);
} else {
for (Change change : changeSet.getChanges()) {
this.changeSet.addRollbackChange(change);
}
}
}
inRollback = true;
} else if ("preConditions".equals(qName)) {
rootPrecondition = new Preconditions();
rootPrecondition.setOnFail(StringUtils.trimToNull(atts.getValue("onFail")));
rootPrecondition.setOnError(StringUtils.trimToNull(atts.getValue("onError")));
preconditionLogicStack.push(rootPrecondition);
} else if (currentPrecondition != null && currentPrecondition instanceof CustomPreconditionWrapper && qName.equals("param")) {
((CustomPreconditionWrapper) currentPrecondition).setParam(atts.getValue("name"), atts.getValue("value"));
} else if (rootPrecondition != null) {
currentPrecondition = PreconditionFactory.getInstance().create(qName);
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(currentPrecondition, attributeName, attributeValue);
}
preconditionLogicStack.peek().addNestedPrecondition(currentPrecondition);
if (currentPrecondition instanceof PreconditionLogic) {
preconditionLogicStack.push(((PreconditionLogic) currentPrecondition));
}
if ("sqlCheck".equals(qName)) {
text = new StringBuffer();
}
} else if ("modifySql".equals(qName)) {
inModifySql = true;
if (StringUtils.trimToNull(atts.getValue("dbms")) != null) {
modifySqlDbmsList = StringUtils.splitAndTrim(atts.getValue("dbms"), ",");
}
} else if (inModifySql) {
SqlVisitor sqlVisitor = SqlVisitorFactory.getInstance().create(qName);
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(sqlVisitor, attributeName, attributeValue);
}
sqlVisitor.setApplicableDbms(modifySqlDbmsList);
changeSet.addSqlVisitor(sqlVisitor);
} else if (changeSet != null && change == null) {
change = ChangeFactory.getInstance().create(qName);
change.setChangeSet(changeSet);
text = new StringBuffer();
if (change == null) {
throw new MigrationFailedException(changeSet, "Unknown change: " + qName);
}
change.setFileOpener(fileOpener);
if (change instanceof CustomChangeWrapper) {
((CustomChangeWrapper) change).setClassLoader(fileOpener.toClassLoader());
}
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(change, attributeName, attributeValue);
}
change.setUp();
} else if (change != null && "column".equals(qName)) {
ColumnConfig column;
if (change instanceof LoadDataChange) {
column = new LoadDataColumnConfig();
} else {
column = new ColumnConfig();
}
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(column, attributeName, attributeValue);
}
if (change instanceof ChangeWithColumns) {
((ChangeWithColumns) change).addColumn(column);
} else {
throw new RuntimeException("Unexpected column tag for " + change.getClass().getName());
}
} else if (change != null && "constraints".equals(qName)) {
ConstraintsConfig constraints = new ConstraintsConfig();
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(constraints, attributeName, attributeValue);
}
ColumnConfig lastColumn;
if (change instanceof AddColumnChange) {
lastColumn = ((AddColumnChange) change).getLastColumn();
} else if (change instanceof CreateTableChange) {
lastColumn = ((CreateTableChange) change).getColumns().get(((CreateTableChange) change).getColumns().size() - 1);
} else if (change instanceof ModifyColumnChange) {
lastColumn = ((ModifyColumnChange) change).getColumns().get(((ModifyColumnChange) change).getColumns().size() - 1);
} else {
throw new RuntimeException("Unexpected change: " + change.getClass().getName());
}
lastColumn.setConstraints(constraints);
} else if ("param".equals(qName)) {
if (change instanceof CustomChangeWrapper) {
if (atts.getValue("value") == null) {
paramName = atts.getValue("name");
text = new StringBuffer();
} else {
((CustomChangeWrapper) change).setParam(atts
.getValue("name"), atts.getValue("value"));
}
} else {
throw new MigrationFailedException(changeSet,
"'param' unexpected in " + qName);
}
} else if ("where".equals(qName)) {
text = new StringBuffer();
} else if ("property".equals(qName)) {
if (StringUtils.trimToNull(atts.getValue("file")) == null) {
this.setParameterValue(atts.getValue("name"), atts.getValue("value"));
} else {
Properties props = new Properties();
InputStream propertiesStream = fileOpener.getResourceAsStream(atts.getValue("file"));
if (propertiesStream == null) {
log.info("Could not open properties file " + atts.getValue("file"));
} else {
props.load(propertiesStream);
for (Map.Entry entry : props.entrySet()) {
this.setParameterValue(entry.getKey().toString(), entry.getValue().toString());
}
}
}
} else if (change instanceof ExecuteShellCommandChange && "arg".equals(qName)) {
((ExecuteShellCommandChange) change).addArg(atts.getValue("value"));
} else {
throw new MigrationFailedException(changeSet, "Unexpected tag: " + qName);
}
} catch (Exception e) {
log.log(Level.SEVERE, "Error thrown as a SAXException: " + e.getMessage(), e);
e.printStackTrace();
throw new SAXException(e);
}
}
protected void handleIncludedChangeLog(String fileName, boolean isRelativePath, String relativeBaseFileName) throws LiquibaseException {
if (isRelativePath) {
String path = searchPath(relativeBaseFileName);
fileName = new StringBuilder(path).append(fileName).toString();
}
DatabaseChangeLog changeLog = new ChangeLogParser(changeLogParameters).parse(fileName, fileOpener);
AndPrecondition preconditions = changeLog.getPreconditions();
if (preconditions != null) {
databaseChangeLog.getPreconditions().addNestedPrecondition(preconditions);
}
for (ChangeSet changeSet : changeLog.getChangeSets()) {
databaseChangeLog.addChangeSet(changeSet);
}
}
private String searchPath(String relativeBaseFileName) {
if (relativeBaseFileName == null) {
return null;
}
int lastSeparatePosition = relativeBaseFileName.lastIndexOf(LIQUIBASE_FILE_SEPARATOR);
if (lastSeparatePosition >= 0) {
return relativeBaseFileName.substring(0, lastSeparatePosition + 1);
}
return relativeBaseFileName;
}
private void setProperty(Object object, String attributeName, String attributeValue) throws IllegalAccessException, InvocationTargetException, CustomChangeException {
ExpressionExpander expressionExpander = new ExpressionExpander(changeLogParameters);
if (object instanceof CustomChangeWrapper) {
if (attributeName.equals("class")) {
((CustomChangeWrapper) object).setClass(expressionExpander.expandExpressions(attributeValue));
} else {
((CustomChangeWrapper) object).setParam(attributeName, expressionExpander.expandExpressions(attributeValue));
}
} else {
ObjectUtil.setProperty(object, attributeName, expressionExpander.expandExpressions(attributeValue));
}
}
public void endElement(String uri, String localName, String qName) throws SAXException {
String textString = null;
if (text != null && text.length() > 0) {
textString = new ExpressionExpander(changeLogParameters).expandExpressions(StringUtils.trimToNull(text.toString()));
}
try {
if (rootPrecondition != null) {
if ("preConditions".equals(qName)) {
if (changeSet == null) {
databaseChangeLog.setPreconditions(rootPrecondition);
handlePreCondition(rootPrecondition);
} else {
changeSet.setPreconditions(rootPrecondition);
}
rootPrecondition = null;
} else if ("and".equals(qName)) {
preconditionLogicStack.pop();
currentPrecondition = null;
} else if ("or".equals(qName)) {
preconditionLogicStack.pop();
currentPrecondition = null;
} else if ("not".equals(qName)) {
preconditionLogicStack.pop();
currentPrecondition = null;
} else if (qName.equals("sqlCheck")) {
((SqlPrecondition) currentPrecondition).setSql(textString);
currentPrecondition = null;
} else if (qName.equals("customPrecondition")) {
((CustomPreconditionWrapper) currentPrecondition).setClassLoader(fileOpener.toClassLoader());
}
} else if (changeSet != null && "rollback".equals(qName)) {
changeSet.addRollBackSQL(textString);
inRollback = false;
} else if (change != null && change instanceof RawSQLChange && "comment".equals(qName)) {
((RawSQLChange) change).setComments(textString);
text = new StringBuffer();
} else if (change != null && "where".equals(qName)) {
if (change instanceof UpdateDataChange) {
((UpdateDataChange) change).setWhereClause(textString);
} else if (change instanceof DeleteDataChange) {
((DeleteDataChange) change).setWhereClause(textString);
} else {
throw new RuntimeException("Unexpected change type: " + change.getClass().getName());
}
text = new StringBuffer();
} else if (change != null && change instanceof CreateProcedureChange && "comment".equals(qName)) {
((CreateProcedureChange) change).setComments(textString);
text = new StringBuffer();
} else if (change != null && change instanceof CustomChangeWrapper
&& paramName != null && "param".equals(qName)) {
((CustomChangeWrapper) change).setParam(paramName, textString);
text = new StringBuffer();
paramName = null;
} else if (changeSet != null && "comment".equals(qName)) {
changeSet.setComments(textString);
text = new StringBuffer();
} else if (changeSet != null && "changeSet".equals(qName)) {
handleChangeSet(changeSet);
changeSet = null;
} else if (change != null && qName.equals("column") && textString != null) {
if (change instanceof InsertDataChange) {
List<ColumnConfig> columns = ((InsertDataChange) change).getColumns();
columns.get(columns.size() - 1).setValue(textString);
} else if (change instanceof UpdateDataChange) {
List<ColumnConfig> columns = ((UpdateDataChange) change).getColumns();
columns.get(columns.size() - 1).setValue(textString);
} else {
throw new RuntimeException("Unexpected column with text: "+textString);
}
this.text = new StringBuffer();
} else if (change != null && qName.equals(change.getTagName())) {
if (textString != null) {
if (change instanceof RawSQLChange) {
((RawSQLChange) change).setSql(textString);
} else if (change instanceof CreateProcedureChange) {
((CreateProcedureChange) change).setProcedureBody(textString);
} else if (change instanceof CreateViewChange) {
((CreateViewChange) change).setSelectQuery(textString);
} else if (change instanceof StopChange) {
((StopChange) change).setMessage(textString);
} else {
throw new RuntimeException("Unexpected text in " + change.getTagName());
}
}
text = null;
if (inRollback) {
changeSet.addRollbackChange(change);
} else {
changeSet.addChange(change);
}
change = null;
} else if (changeSet != null && "validCheckSum".equals(qName)) {
changeSet.addValidCheckSum(text.toString());
text = null;
} else if ("modifySql".equals(qName)) {
inModifySql = false;
modifySqlDbmsList = null;
}
} catch (Exception e) {
log.log(Level.SEVERE, "Error thrown as a SAXException: " + e.getMessage(), e);
throw new SAXException(databaseChangeLog.getPhysicalFilePath() + ": " + e.getMessage(), e);
}
}
protected void handlePreCondition(@SuppressWarnings("unused") Precondition precondition) {
databaseChangeLog.setPreconditions(rootPrecondition);
}
protected void handleChangeSet(ChangeSet changeSet) {
databaseChangeLog.addChangeSet(changeSet);
}
public void characters(char ch[], int start, int length) throws SAXException {
if (text != null) {
text.append(new String(ch, start, length));
}
}
public Object getParameterValue(String paramter) {
return changeLogParameters.get(paramter);
}
public void setParameterValue(String paramter, Object value) {
if (!changeLogParameters.containsKey(paramter)) {
changeLogParameters.put(paramter, value);
}
}
/**
* Wrapper for Attributes that expands the value as needed
*/
private class ExpandingAttributes implements Attributes {
private Attributes attributes;
private ExpandingAttributes(Attributes attributes) {
this.attributes = attributes;
}
public int getLength() {
return attributes.getLength();
}
public String getURI(int index) {
return attributes.getURI(index);
}
public String getLocalName(int index) {
return attributes.getLocalName(index);
}
public String getQName(int index) {
return attributes.getQName(index);
}
public String getType(int index) {
return attributes.getType(index);
}
public String getValue(int index) {
return attributes.getValue(index);
}
public int getIndex(String uri, String localName) {
return attributes.getIndex(uri, localName);
}
public int getIndex(String qName) {
return attributes.getIndex(qName);
}
public String getType(String uri, String localName) {
return attributes.getType(uri, localName);
}
public String getType(String qName) {
return attributes.getType(qName);
}
public String getValue(String uri, String localName) {
return new ExpressionExpander(changeLogParameters).expandExpressions(attributes.getValue(uri, localName));
}
public String getValue(String qName) {
return new ExpressionExpander(changeLogParameters).expandExpressions(attributes.getValue(qName));
}
}
}
| core/src/java/liquibase/parser/xml/XMLChangeLogHandler.java | package liquibase.parser.xml;
import liquibase.ChangeSet;
import liquibase.DatabaseChangeLog;
import liquibase.FileOpener;
import liquibase.database.sql.visitor.SqlVisitorFactory;
import liquibase.database.sql.visitor.SqlVisitor;
import liquibase.change.*;
import liquibase.change.custom.CustomChangeWrapper;
import liquibase.exception.CustomChangeException;
import liquibase.exception.LiquibaseException;
import liquibase.exception.MigrationFailedException;
import liquibase.log.LogFactory;
import liquibase.parser.ChangeLogParser;
import liquibase.parser.ExpressionExpander;
import liquibase.preconditions.*;
import liquibase.util.ObjectUtil;
import liquibase.util.StringUtils;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import java.lang.reflect.InvocationTargetException;
import java.util.*;
import java.util.regex.Pattern;
import java.util.regex.Matcher;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.io.File;
import java.io.InputStream;
import java.io.FilenameFilter;
import java.net.URL;
import java.net.URI;
class XMLChangeLogHandler extends DefaultHandler {
private static final char LIQUIBASE_FILE_SEPARATOR = '/';
protected Logger log;
private DatabaseChangeLog databaseChangeLog;
private Change change;
private StringBuffer text;
private Preconditions rootPrecondition;
private Stack<PreconditionLogic> preconditionLogicStack = new Stack<PreconditionLogic>();
private ChangeSet changeSet;
private String paramName;
private FileOpener fileOpener;
private Precondition currentPrecondition;
private Map<String, Object> changeLogParameters = new HashMap<String, Object>();
private boolean inRollback = false;
private boolean inModifySql = false;
private Collection modifySqlDbmsList;
protected XMLChangeLogHandler(String physicalChangeLogLocation, FileOpener fileOpener, Map<String, Object> properties) {
log = LogFactory.getLogger();
this.fileOpener = fileOpener;
databaseChangeLog = new DatabaseChangeLog(physicalChangeLogLocation);
databaseChangeLog.setPhysicalFilePath(physicalChangeLogLocation);
for (Map.Entry entry : System.getProperties().entrySet()) {
changeLogParameters.put(entry.getKey().toString(), entry.getValue());
}
for (Map.Entry entry : properties.entrySet()) {
changeLogParameters.put(entry.getKey().toString(), entry.getValue());
}
}
public DatabaseChangeLog getDatabaseChangeLog() {
return databaseChangeLog;
}
public void startElement(String uri, String localName, String qName, Attributes baseAttributes) throws SAXException {
Attributes atts = new ExpandingAttributes(baseAttributes);
try {
if ("comment".equals(qName)) {
text = new StringBuffer();
} else if ("validCheckSum".equals(qName)) {
text = new StringBuffer();
} else if ("databaseChangeLog".equals(qName)) {
String version = uri.substring(uri.lastIndexOf("/") + 1);
if (!version.equals(XMLChangeLogParser.getSchemaVersion())) {
log.warning(databaseChangeLog.getPhysicalFilePath() + " is using schema version " + version + " rather than version " + XMLChangeLogParser.getSchemaVersion());
}
databaseChangeLog.setLogicalFilePath(atts.getValue("logicalFilePath"));
} else if ("include".equals(qName)) {
String fileName = atts.getValue("file");
boolean isRelativeToChangelogFile = Boolean.parseBoolean(atts.getValue("relativeToChangelogFile"));
handleIncludedChangeLog(fileName, isRelativeToChangelogFile, databaseChangeLog.getPhysicalFilePath());
} else if ("includeAll".equals(qName)) {
String pathName = atts.getValue("path");
Enumeration<URL> resources = fileOpener.getResources(pathName);
while (resources.hasMoreElements()) {
URL dirUrl = resources.nextElement();
File dir = new File(new URI(dirUrl.toExternalForm()));
if (!dir.exists()) {
throw new SAXException("includeAll path " + pathName + " could not be found. Tried in " + dir.toString());
}
File[] files = dir.listFiles(new FilenameFilter() {
public boolean accept(File dir, String name) {
return name.endsWith(".xml") || name.endsWith(".sql");
}
});
for (File file : files) {
handleIncludedChangeLog(pathName + file.getName(), false, databaseChangeLog.getPhysicalFilePath());
}
}
} else if (changeSet == null && "changeSet".equals(qName)) {
boolean alwaysRun = false;
boolean runOnChange = false;
if ("true".equalsIgnoreCase(atts.getValue("runAlways"))) {
alwaysRun = true;
}
if ("true".equalsIgnoreCase(atts.getValue("runOnChange"))) {
runOnChange = true;
}
changeSet = new ChangeSet(atts.getValue("id"),
atts.getValue("author"),
alwaysRun,
runOnChange,
databaseChangeLog.getFilePath(),
databaseChangeLog.getPhysicalFilePath(),
atts.getValue("context"),
atts.getValue("dbms"),
Boolean.valueOf(atts.getValue("runInTransaction")));
if (StringUtils.trimToNull(atts.getValue("failOnError")) != null) {
changeSet.setFailOnError(Boolean.parseBoolean(atts.getValue("failOnError")));
}
} else if (changeSet != null && "rollback".equals(qName)) {
text = new StringBuffer();
String id = atts.getValue("changeSetId");
if (id != null) {
String path = atts.getValue("changeSetPath");
if (path == null) {
path = databaseChangeLog.getFilePath();
}
String author = atts.getValue("changeSetAuthor");
ChangeSet changeSet = databaseChangeLog.getChangeSet(path, author, id);
if (changeSet == null) {
throw new SAXException("Could not find changeSet to use for rollback: " + path + ":" + author + ":" + id);
} else {
for (Change change : changeSet.getChanges()) {
this.changeSet.addRollbackChange(change);
}
}
}
inRollback = true;
} else if ("preConditions".equals(qName)) {
rootPrecondition = new Preconditions();
rootPrecondition.setOnFail(StringUtils.trimToNull(atts.getValue("onFail")));
rootPrecondition.setOnError(StringUtils.trimToNull(atts.getValue("onError")));
preconditionLogicStack.push(rootPrecondition);
} else if (currentPrecondition != null && currentPrecondition instanceof CustomPreconditionWrapper && qName.equals("param")) {
((CustomPreconditionWrapper) currentPrecondition).setParam(atts.getValue("name"), atts.getValue("value"));
} else if (rootPrecondition != null) {
currentPrecondition = PreconditionFactory.getInstance().create(qName);
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(currentPrecondition, attributeName, attributeValue);
}
preconditionLogicStack.peek().addNestedPrecondition(currentPrecondition);
if (currentPrecondition instanceof PreconditionLogic) {
preconditionLogicStack.push(((PreconditionLogic) currentPrecondition));
}
if ("sqlCheck".equals(qName)) {
text = new StringBuffer();
}
} else if ("modifySql".equals(qName)) {
inModifySql = true;
if (StringUtils.trimToNull(atts.getValue("dbms")) != null) {
modifySqlDbmsList = StringUtils.splitAndTrim(atts.getValue("dbms"), ",");
}
} else if (inModifySql) {
SqlVisitor sqlVisitor = SqlVisitorFactory.getInstance().create(qName);
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(sqlVisitor, attributeName, attributeValue);
}
sqlVisitor.setApplicableDbms(modifySqlDbmsList);
changeSet.addSqlVisitor(sqlVisitor);
} else if (changeSet != null && change == null) {
change = ChangeFactory.getInstance().create(qName);
change.setChangeSet(changeSet);
text = new StringBuffer();
if (change == null) {
throw new MigrationFailedException(changeSet, "Unknown change: " + qName);
}
change.setFileOpener(fileOpener);
if (change instanceof CustomChangeWrapper) {
((CustomChangeWrapper) change).setClassLoader(fileOpener.toClassLoader());
}
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(change, attributeName, attributeValue);
}
change.setUp();
} else if (change != null && "column".equals(qName)) {
ColumnConfig column;
if (change instanceof LoadDataChange) {
column = new LoadDataColumnConfig();
} else {
column = new ColumnConfig();
}
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(column, attributeName, attributeValue);
}
if (change instanceof ChangeWithColumns) {
((ChangeWithColumns) change).addColumn(column);
} else {
throw new RuntimeException("Unexpected column tag for " + change.getClass().getName());
}
} else if (change != null && "constraints".equals(qName)) {
ConstraintsConfig constraints = new ConstraintsConfig();
for (int i = 0; i < atts.getLength(); i++) {
String attributeName = atts.getQName(i);
String attributeValue = atts.getValue(i);
setProperty(constraints, attributeName, attributeValue);
}
ColumnConfig lastColumn;
if (change instanceof AddColumnChange) {
lastColumn = ((AddColumnChange) change).getLastColumn();
} else if (change instanceof CreateTableChange) {
lastColumn = ((CreateTableChange) change).getColumns().get(((CreateTableChange) change).getColumns().size() - 1);
} else if (change instanceof ModifyColumnChange) {
lastColumn = ((ModifyColumnChange) change).getColumns().get(((ModifyColumnChange) change).getColumns().size() - 1);
} else {
throw new RuntimeException("Unexpected change: " + change.getClass().getName());
}
lastColumn.setConstraints(constraints);
} else if ("param".equals(qName)) {
if (change instanceof CustomChangeWrapper) {
if (atts.getValue("value") == null) {
paramName = atts.getValue("name");
text = new StringBuffer();
} else {
((CustomChangeWrapper) change).setParam(atts
.getValue("name"), atts.getValue("value"));
}
} else {
throw new MigrationFailedException(changeSet,
"'param' unexpected in " + qName);
}
} else if ("where".equals(qName)) {
text = new StringBuffer();
} else if ("property".equals(qName)) {
if (StringUtils.trimToNull(atts.getValue("file")) == null) {
this.setParameterValue(atts.getValue("name"), atts.getValue("value"));
} else {
Properties props = new Properties();
InputStream propertiesStream = fileOpener.getResourceAsStream(atts.getValue("file"));
if (propertiesStream == null) {
log.info("Could not open properties file " + atts.getValue("file"));
} else {
props.load(propertiesStream);
for (Map.Entry entry : props.entrySet()) {
this.setParameterValue(entry.getKey().toString(), entry.getValue().toString());
}
}
}
} else if (change instanceof ExecuteShellCommandChange && "arg".equals(qName)) {
((ExecuteShellCommandChange) change).addArg(atts.getValue("value"));
} else {
throw new MigrationFailedException(changeSet, "Unexpected tag: " + qName);
}
} catch (Exception e) {
log.log(Level.SEVERE, "Error thrown as a SAXException: " + e.getMessage(), e);
e.printStackTrace();
throw new SAXException(e);
}
}
protected void handleIncludedChangeLog(String fileName, boolean isRelativePath, String relativeBaseFileName) throws LiquibaseException {
if (isRelativePath) {
String path = searchPath(relativeBaseFileName);
fileName = new StringBuilder(path).append(fileName).toString();
}
DatabaseChangeLog changeLog = new ChangeLogParser(changeLogParameters).parse(fileName, fileOpener);
AndPrecondition preconditions = changeLog.getPreconditions();
if (preconditions != null) {
databaseChangeLog.getPreconditions().addNestedPrecondition(preconditions);
}
for (ChangeSet changeSet : changeLog.getChangeSets()) {
databaseChangeLog.addChangeSet(changeSet);
}
}
private String searchPath(String relativeBaseFileName) {
if (relativeBaseFileName == null) {
return null;
}
int lastSeparatePosition = relativeBaseFileName.lastIndexOf(LIQUIBASE_FILE_SEPARATOR);
if (lastSeparatePosition >= 0) {
return relativeBaseFileName.substring(0, lastSeparatePosition + 1);
}
return relativeBaseFileName;
}
private void setProperty(Object object, String attributeName, String attributeValue) throws IllegalAccessException, InvocationTargetException, CustomChangeException {
ExpressionExpander expressionExpander = new ExpressionExpander(changeLogParameters);
if (object instanceof CustomChangeWrapper) {
if (attributeName.equals("class")) {
((CustomChangeWrapper) object).setClass(expressionExpander.expandExpressions(attributeValue));
} else {
((CustomChangeWrapper) object).setParam(attributeName, expressionExpander.expandExpressions(attributeValue));
}
} else {
ObjectUtil.setProperty(object, attributeName, expressionExpander.expandExpressions(attributeValue));
}
}
public void endElement(String uri, String localName, String qName) throws SAXException {
String textString = null;
if (text != null && text.length() > 0) {
textString = new ExpressionExpander(changeLogParameters).expandExpressions(StringUtils.trimToNull(text.toString()));
}
try {
if (rootPrecondition != null) {
if ("preConditions".equals(qName)) {
if (changeSet == null) {
databaseChangeLog.setPreconditions(rootPrecondition);
handlePreCondition(rootPrecondition);
} else {
changeSet.setPreconditions(rootPrecondition);
}
rootPrecondition = null;
} else if ("and".equals(qName)) {
preconditionLogicStack.pop();
currentPrecondition = null;
} else if ("or".equals(qName)) {
preconditionLogicStack.pop();
currentPrecondition = null;
} else if ("not".equals(qName)) {
preconditionLogicStack.pop();
currentPrecondition = null;
} else if (qName.equals("sqlCheck")) {
((SqlPrecondition) currentPrecondition).setSql(textString);
currentPrecondition = null;
} else if (qName.equals("customPrecondition")) {
((CustomPreconditionWrapper) currentPrecondition).setClassLoader(fileOpener.toClassLoader());
}
} else if (changeSet != null && "rollback".equals(qName)) {
changeSet.addRollBackSQL(textString);
inRollback = false;
} else if (change != null && change instanceof RawSQLChange && "comment".equals(qName)) {
((RawSQLChange) change).setComments(textString);
text = new StringBuffer();
} else if (change != null && "where".equals(qName)) {
if (change instanceof UpdateDataChange) {
((UpdateDataChange) change).setWhereClause(textString);
} else if (change instanceof DeleteDataChange) {
((DeleteDataChange) change).setWhereClause(textString);
} else {
throw new RuntimeException("Unexpected change type: " + change.getClass().getName());
}
text = new StringBuffer();
} else if (change != null && change instanceof CreateProcedureChange && "comment".equals(qName)) {
((CreateProcedureChange) change).setComments(textString);
text = new StringBuffer();
} else if (change != null && change instanceof CustomChangeWrapper
&& paramName != null && "param".equals(qName)) {
((CustomChangeWrapper) change).setParam(paramName, textString);
text = new StringBuffer();
paramName = null;
} else if (changeSet != null && "comment".equals(qName)) {
changeSet.setComments(textString);
text = new StringBuffer();
} else if (changeSet != null && "changeSet".equals(qName)) {
handleChangeSet(changeSet);
changeSet = null;
} else if (change != null && qName.equals("column") && textString != null) {
if (change instanceof InsertDataChange) {
List<ColumnConfig> columns = ((InsertDataChange) change).getColumns();
columns.get(columns.size() - 1).setValue(textString);
} else if (change instanceof UpdateDataChange) {
List<ColumnConfig> columns = ((UpdateDataChange) change).getColumns();
columns.get(columns.size() - 1).setValue(textString);
} else {
throw new RuntimeException("Unexpected column with text: "+textString);
}
this.text = new StringBuffer();
} else if (change != null && qName.equals(change.getTagName())) {
if (textString != null) {
if (change instanceof RawSQLChange) {
((RawSQLChange) change).setSql(textString);
} else if (change instanceof CreateProcedureChange) {
((CreateProcedureChange) change).setProcedureBody(textString);
} else if (change instanceof CreateViewChange) {
((CreateViewChange) change).setSelectQuery(textString);
} else if (change instanceof StopChange) {
((StopChange) change).setMessage(textString);
} else {
throw new RuntimeException("Unexpected text in " + change.getTagName());
}
}
text = null;
if (inRollback) {
changeSet.addRollbackChange(change);
} else {
changeSet.addChange(change);
}
change = null;
} else if (changeSet != null && "validCheckSum".equals(qName)) {
changeSet.addValidCheckSum(text.toString());
text = null;
} else if ("modifySql".equals(qName)) {
inModifySql = false;
modifySqlDbmsList = null;
}
} catch (Exception e) {
log.log(Level.SEVERE, "Error thrown as a SAXException: " + e.getMessage(), e);
throw new SAXException(databaseChangeLog.getPhysicalFilePath() + ": " + e.getMessage(), e);
}
}
protected void handlePreCondition(@SuppressWarnings("unused") Precondition precondition) {
databaseChangeLog.setPreconditions(rootPrecondition);
}
protected void handleChangeSet(ChangeSet changeSet) {
databaseChangeLog.addChangeSet(changeSet);
}
public void characters(char ch[], int start, int length) throws SAXException {
if (text != null) {
text.append(new String(ch, start, length));
}
}
public Object getParameterValue(String paramter) {
return changeLogParameters.get(paramter);
}
public void setParameterValue(String paramter, Object value) {
if (!changeLogParameters.containsKey(paramter)) {
changeLogParameters.put(paramter, value);
}
}
/**
* Wrapper for Attributes that expands the value as needed
*/
private class ExpandingAttributes implements Attributes {
private Attributes attributes;
private ExpandingAttributes(Attributes attributes) {
this.attributes = attributes;
}
public int getLength() {
return attributes.getLength();
}
public String getURI(int index) {
return attributes.getURI(index);
}
public String getLocalName(int index) {
return attributes.getLocalName(index);
}
public String getQName(int index) {
return attributes.getQName(index);
}
public String getType(int index) {
return attributes.getType(index);
}
public String getValue(int index) {
return attributes.getValue(index);
}
public int getIndex(String uri, String localName) {
return attributes.getIndex(uri, localName);
}
public int getIndex(String qName) {
return attributes.getIndex(qName);
}
public String getType(String uri, String localName) {
return attributes.getType(uri, localName);
}
public String getType(String qName) {
return attributes.getType(qName);
}
public String getValue(String uri, String localName) {
return new ExpressionExpander(changeLogParameters).expandExpressions(attributes.getValue(uri, localName));
}
public String getValue(String qName) {
return new ExpressionExpander(changeLogParameters).expandExpressions(attributes.getValue(qName));
}
}
}
| ignore urls with an authority component
git-svn-id: a91d99a4c51940524e539abe295d6ea473345dd2@827 e6edf6fb-f266-4316-afb4-e53d95876a76
| core/src/java/liquibase/parser/xml/XMLChangeLogHandler.java | ignore urls with an authority component | <ide><path>ore/src/java/liquibase/parser/xml/XMLChangeLogHandler.java
<ide> Enumeration<URL> resources = fileOpener.getResources(pathName);
<ide> while (resources.hasMoreElements()) {
<ide> URL dirUrl = resources.nextElement();
<add> if (dirUrl.getAuthority() != null) {
<add> continue;
<add> }
<ide> File dir = new File(new URI(dirUrl.toExternalForm()));
<ide> if (!dir.exists()) {
<ide> throw new SAXException("includeAll path " + pathName + " could not be found. Tried in " + dir.toString()); |
|
Java | apache-2.0 | f3da173fe75fa61274ad90fecc7b0a1cd0de48e9 | 0 | kidaa/ninja-rythm,kidaa/ninja-rythm,ninjaframework/ninja-rythm,ninjaframework/ninja-rythm,kidaa/ninja-rythm | package ninja.rythm.util;
import ninja.Result;
import ninja.Route;
/**
* Helper methods for Rythm engines
*
* @author Sojin
*/
public class RythmHelper {
public String getRythmTemplateForResult(Route route,
Result result,
String suffix) {
if (result.getTemplate() == null) {
Class<?> controller = route.getControllerClass();
// and the final path of the controller will be something like:
// /some/package/submoduleName/ControllerName/templateName.ftl.html
return String.format("/%s/%s%s", controller.getSimpleName(), route
.getControllerMethod().getName(), suffix);
} else {
return result.getTemplate();
}
}
} | ninja-rythm-module/src/main/java/ninja/rythm/util/RythmHelper.java | package ninja.rythm.util;
import ninja.Result;
import ninja.Route;
import ninja.utils.NinjaConstant;
/**
* Helper methods for Rythm engines
*
* @author Sojin
*/
public class RythmHelper {
public String getRythmTemplateForResult(Route route,
Result result,
String suffix) {
if (result.getTemplate() == null) {
Class<?> controller = route.getControllerClass();
// and the final path of the controller will be something like:
// /some/package/submoduleName/ControllerName/templateName.ftl.html
return String.format("/%s/%s%s", controller.getSimpleName(), route
.getControllerMethod().getName(), suffix);
} else {
return result.getTemplate();
}
}
} | Removed ninjaConstant dependency | ninja-rythm-module/src/main/java/ninja/rythm/util/RythmHelper.java | Removed ninjaConstant dependency | <ide><path>inja-rythm-module/src/main/java/ninja/rythm/util/RythmHelper.java
<ide>
<ide> import ninja.Result;
<ide> import ninja.Route;
<del>import ninja.utils.NinjaConstant;
<ide>
<ide> /**
<ide> * Helper methods for Rythm engines |
|
Java | apache-2.0 | fdf74a49a481ed484a7da7086254f30d2387c49f | 0 | tedk/Dash,RR7-Software/dashclock,suiyuchen/dashclock,goodev/dashclock,kennydude/dashclock,mypapit/dashclock,vinay129/dashclock,MustafaKamel100/dashclock,SyncedSynapse/yadashclock,romannurik/dashclock,bineanzhou/dashclock,vinay129/dashclock,biddyweb/dashclock,BautistaJesus/dashclock,sumanthh/dashclock,RR7-Software/dashclock,ifengtech/dashclock,biddyweb/dashclock,anuprakash/dashclock,kaixinsoft/dashclock,sumanthh/dashclock,suiyuchen/dashclock,RR7-Software/dashclock,martyborya/dashclock,bibekSahoo/dashclock,rafattouqir/dashclock,MustafaKamel100/dashclock,BreankingBad/dashclock,martyborya/dashclock,suiyuchen/dashclock,BreankingBad/dashclock,akariv/dashclock,anuprakash/dashclock,romannurik/dashclock,amithub/Screen-Lock-DashLock,google-code-export/dashclock,akariv/dashclock,mypapit/dashclock,amithub/Screen-Lock-DashLock,rafattouqir/dashclock,bineanzhou/dashclock,amithub/Screen-Lock-DashLock,bibekSahoo/dashclock,rafattouqir/dashclock,vinay129/dashclock,SyncedSynapse/yadashclock,suiyuchen/dashclock,bibekSahoo/dashclock,tasomaniac/dashclock,amithub/Screen-Lock-DashLock,sumanthh/dashclock,bineanzhou/dashclock,biddyweb/dashclock,biddyweb/dashclock,anuprakash/dashclock,BautistaJesus/dashclock,rafattouqir/dashclock,anuprakash/dashclock,akariv/dashclock,RR7-Software/dashclock,BautistaJesus/dashclock,google-code-export/dashclock,tasomaniac/dashclock,jruesga/dashclock,kaixinsoft/dashclock,google-code-export/dashclock,ifengtech/dashclock,BreankingBad/dashclock,BautistaJesus/dashclock,kennydude/dashclock,martyborya/dashclock,tasomaniac/dashclock,tedk/Dash,vinay129/dashclock,mypapit/dashclock,jruesga/dashclock,zhaog/dashclock,romannurik/dashclock,BreankingBad/dashclock,SyncedSynapse/yadashclock,goodev/dashclock,akariv/dashclock,goodev/dashclock,goodev/dashclock,MustafaKamel100/dashclock,tedk/Dash,jruesga/dashclock,kaixinsoft/dashclock,sumanthh/dashclock,kaixinsoft/dashclock,ifengtech/dashclock,bibekSahoo/dashclock,zhaog/dashclock,tasomaniac/dashclock,romannurik/dashclock,MustafaKamel100/dashclock,mypapit/dashclock,kennydude/dashclock,zhaog/dashclock,jruesga/dashclock,zhaog/dashclock,martyborya/dashclock,ifengtech/dashclock,SyncedSynapse/yadashclock,bineanzhou/dashclock,google-code-export/dashclock,tedk/Dash | /*
* Copyright 2013 Google Inc.
*
* 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.google.android.apps.dashclock;
import android.content.BroadcastReceiver;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.support.v4.content.WakefulBroadcastReceiver;
import android.text.TextUtils;
import java.util.List;
import static com.google.android.apps.dashclock.LogUtils.LOGD;
/**
* Broadcast receiver used to watch for changes to installed packages on the device. This triggers
* a cleanup of extensions (in case one was uninstalled), or a data update request to an extension
* if it was updated (its package was replaced).
*/
public class ExtensionPackageChangeReceiver extends WakefulBroadcastReceiver {
private static final String TAG = LogUtils.makeLogTag(ExtensionPackageChangeReceiver.class);
@Override
public void onReceive(Context context, Intent intent) {
ExtensionManager extensionManager = ExtensionManager.getInstance(context);
if (extensionManager.cleanupExtensions()) {
LOGD(TAG, "Extension cleanup performed and action taken.");
Intent widgetUpdateIntent = new Intent(context, DashClockService.class);
widgetUpdateIntent.setAction(DashClockService.ACTION_UPDATE_WIDGETS);
startWakefulService(context, widgetUpdateIntent);
}
// If this is a replacement or change in the package, update all active extensions from
// this package.
String action = intent.getAction();
if (Intent.ACTION_PACKAGE_CHANGED.equals(action)
|| Intent.ACTION_PACKAGE_REPLACED.equals(action)) {
String packageName = intent.getData().getSchemeSpecificPart();
if (TextUtils.isEmpty(packageName)) {
return;
}
List<ComponentName> activeExtensions = extensionManager.getActiveExtensionNames();
for (ComponentName cn : activeExtensions) {
if (packageName.equals(cn.getPackageName())) {
LOGD(TAG, "Package for extension " + cn + " changed; asking it for an update.");
Intent extensionUpdateIntent = new Intent(context, DashClockService.class);
extensionUpdateIntent.setAction(DashClockService.ACTION_UPDATE_EXTENSIONS);
// TODO: UPDATE_REASON_PACKAGE_CHANGED
extensionUpdateIntent.putExtra(DashClockService.EXTRA_COMPONENT_NAME,
cn.flattenToShortString());
startWakefulService(context, extensionUpdateIntent);
}
}
}
}
}
| main/src/main/java/com/google/android/apps/dashclock/ExtensionPackageChangeReceiver.java | /*
* Copyright 2013 Google Inc.
*
* 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.google.android.apps.dashclock;
import android.content.BroadcastReceiver;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.text.TextUtils;
import java.util.List;
import static com.google.android.apps.dashclock.LogUtils.LOGD;
/**
* Broadcast receiver used to watch for changes to installed packages on the device. This triggers
* a cleanup of extensions (in case one was uninstalled), or a data update request to an extension
* if it was updated (its package was replaced).
*/
public class ExtensionPackageChangeReceiver extends BroadcastReceiver {
private static final String TAG = LogUtils.makeLogTag(ExtensionPackageChangeReceiver.class);
@Override
public void onReceive(Context context, Intent intent) {
ExtensionManager extensionManager = ExtensionManager.getInstance(context);
if (extensionManager.cleanupExtensions()) {
LOGD(TAG, "Extension cleanup performed and action taken.");
Intent widgetUpdateIntent = new Intent(context, DashClockService.class);
widgetUpdateIntent.setAction(DashClockService.ACTION_UPDATE_WIDGETS);
context.startService(widgetUpdateIntent);
}
// If this is a replacement or change in the package, update all active extensions from
// this package.
String action = intent.getAction();
if (Intent.ACTION_PACKAGE_CHANGED.equals(action)
|| Intent.ACTION_PACKAGE_REPLACED.equals(action)) {
String packageName = intent.getData().getSchemeSpecificPart();
if (TextUtils.isEmpty(packageName)) {
return;
}
List<ComponentName> activeExtensions = extensionManager.getActiveExtensionNames();
for (ComponentName cn : activeExtensions) {
if (packageName.equals(cn.getPackageName())) {
Intent extensionUpdateIntent = new Intent(context, DashClockService.class);
extensionUpdateIntent.setAction(DashClockService.ACTION_UPDATE_EXTENSIONS);
// TODO: UPDATE_REASON_PACKAGE_CHANGED
extensionUpdateIntent.putExtra(DashClockService.EXTRA_COMPONENT_NAME,
cn.flattenToShortString());
context.startService(extensionUpdateIntent);
}
}
}
}
}
| Switch to wakeful broadcast receiver for package change receiver
| main/src/main/java/com/google/android/apps/dashclock/ExtensionPackageChangeReceiver.java | Switch to wakeful broadcast receiver for package change receiver | <ide><path>ain/src/main/java/com/google/android/apps/dashclock/ExtensionPackageChangeReceiver.java
<ide> import android.content.ComponentName;
<ide> import android.content.Context;
<ide> import android.content.Intent;
<add>import android.support.v4.content.WakefulBroadcastReceiver;
<ide> import android.text.TextUtils;
<ide>
<ide> import java.util.List;
<ide> * a cleanup of extensions (in case one was uninstalled), or a data update request to an extension
<ide> * if it was updated (its package was replaced).
<ide> */
<del>public class ExtensionPackageChangeReceiver extends BroadcastReceiver {
<add>public class ExtensionPackageChangeReceiver extends WakefulBroadcastReceiver {
<ide> private static final String TAG = LogUtils.makeLogTag(ExtensionPackageChangeReceiver.class);
<ide>
<ide> @Override
<ide>
<ide> Intent widgetUpdateIntent = new Intent(context, DashClockService.class);
<ide> widgetUpdateIntent.setAction(DashClockService.ACTION_UPDATE_WIDGETS);
<del> context.startService(widgetUpdateIntent);
<add> startWakefulService(context, widgetUpdateIntent);
<ide> }
<ide>
<ide> // If this is a replacement or change in the package, update all active extensions from
<ide> List<ComponentName> activeExtensions = extensionManager.getActiveExtensionNames();
<ide> for (ComponentName cn : activeExtensions) {
<ide> if (packageName.equals(cn.getPackageName())) {
<add> LOGD(TAG, "Package for extension " + cn + " changed; asking it for an update.");
<ide> Intent extensionUpdateIntent = new Intent(context, DashClockService.class);
<ide> extensionUpdateIntent.setAction(DashClockService.ACTION_UPDATE_EXTENSIONS);
<ide> // TODO: UPDATE_REASON_PACKAGE_CHANGED
<ide> extensionUpdateIntent.putExtra(DashClockService.EXTRA_COMPONENT_NAME,
<ide> cn.flattenToShortString());
<del> context.startService(extensionUpdateIntent);
<add> startWakefulService(context, extensionUpdateIntent);
<ide> }
<ide> }
<ide> } |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.