Java tutorial
/* * SparkBit * * Copyright 2011-2014 multibit.org * Copyright 2014 Coin Sciences Ltd * * Licensed under the MIT license (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://opensource.org/licenses/mit-license.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.multibit.file; import com.google.bitcoin.core.BlockChain; import com.google.bitcoin.core.ECKey; import com.google.bitcoin.core.Wallet; import com.google.bitcoin.crypto.KeyCrypterException; import org.sparkbit.ApplicationDataDirectoryLocator; import org.multibit.controller.Controller; import org.multibit.controller.bitcoin.BitcoinController; import org.multibit.message.Message; import org.multibit.message.MessageManager; import org.multibit.model.bitcoin.BitcoinModel; import org.multibit.model.bitcoin.WalletData; import org.multibit.model.bitcoin.WalletInfoData; import org.multibit.model.core.CoreModel; import org.multibit.network.MultiBitService; import org.multibit.store.MultiBitWalletProtobufSerializer; import org.multibit.store.MultiBitWalletVersion; import org.multibit.store.WalletVersionException; import org.multibit.utils.DateUtils; import org.multibit.viewsystem.View; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.*; import java.nio.channels.FileChannel; import java.util.*; import java.net.URL; import org.tukaani.xz.*; import java.nio.file.Files; import java.nio.file.StandardCopyOption; import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.RandomStringUtils; import java.nio.file.Paths; import org.apache.commons.io.FileUtils; /** * Class consolidating the File IO in MultiBit for wallets and wallet infos. * * @author jim * */ public class FileHandler { private static Logger log = LoggerFactory.getLogger(FileHandler.class); public static final String USER_PROPERTIES_FILE_NAME = "sparkbit.properties"; public static final String USER_PROPERTIES_HEADER_TEXT = "sparkbit"; private final Controller controller; private final BitcoinController bitcoinController; private static final int MAX_FILE_SIZE = 1024 * 1024 * 1024; // Dont read files greater than 1 gigabyte. private MultiBitWalletProtobufSerializer walletProtobufSerializer; // Nonsense bytes to fill up deleted files - these have no meaning. private static byte[] NONSENSE_BYTES = new byte[] { (byte) 0xF0, (byte) 0xA6, (byte) 0x55, (byte) 0xAA, (byte) 0x33, (byte) 0x77, (byte) 0x33, (byte) 0x37, (byte) 0x12, (byte) 0x34, (byte) 0x56, (byte) 0x78, (byte) 0xC2, (byte) 0xB3, (byte) 0xA4, (byte) 0x9A, (byte) 0x30, (byte) 0x7F, (byte) 0xE5, (byte) 0x5A, (byte) 0x23, (byte) 0x47, (byte) 0x13, (byte) 0x17, (byte) 0x15, (byte) 0x32, (byte) 0x5C, (byte) 0x77, (byte) 0xC9, (byte) 0x73, (byte) 0x04, (byte) 0x2D, (byte) 0x40, (byte) 0x0F, (byte) 0xA5, (byte) 0xA6, (byte) 0x43, (byte) 0x77, (byte) 0x33, (byte) 0x3B, (byte) 0x62, (byte) 0x34, (byte) 0xB6, (byte) 0x72, (byte) 0x32, (byte) 0xB3, (byte) 0xA4, (byte) 0x4B, (byte) 0x80, (byte) 0x7F, (byte) 0xC5, (byte) 0x43, (byte) 0x23, (byte) 0x47, (byte) 0x13, (byte) 0xB7, (byte) 0xA5, (byte) 0x32, (byte) 0xDC, (byte) 0x79, (byte) 0x19, (byte) 0xB1, (byte) 0x03, (byte) 0x9D }; private static int BULKING_UP_FACTOR = 16; private static byte[] SECURE_DELETE_FILL_BYTES = new byte[NONSENSE_BYTES.length * BULKING_UP_FACTOR]; static { // Make some SECURE_DELETE_FILL_BYTES bytes = x BULKING_UP_FACTOR the // NONSENSE just to save write time. for (int i = 0; i < BULKING_UP_FACTOR; i++) { System.arraycopy(NONSENSE_BYTES, 0, SECURE_DELETE_FILL_BYTES, NONSENSE_BYTES.length * i, NONSENSE_BYTES.length); } } public FileHandler(BitcoinController bitcoinController) { this.bitcoinController = bitcoinController; this.controller = this.bitcoinController; walletProtobufSerializer = new MultiBitWalletProtobufSerializer(); } /** * Load up a WalletData from a specified wallet file. * If the main wallet cannot be loaded, the most recent backup is tried, * followed by the next recent. * * @param walletFile * @return WalletData - the walletData for the created wallet * @throws WalletLoadException * @throws WalletVersionException */ public WalletData loadFromFile(File walletFile) throws WalletLoadException, WalletVersionException { if (walletFile == null) { return null; } String walletFilenameToUseInModel = walletFile.getAbsolutePath(); try { // See if the wallet is serialized or protobuf. WalletInfoData walletInfo; if (isWalletSerialised(walletFile)) { // Serialised wallets are no longer supported. throw new WalletLoadException("Could not load wallet '" + walletFilenameToUseInModel + "'. Serialized wallets are no longer supported."); } else { walletInfo = new WalletInfoData(walletFilenameToUseInModel, null, MultiBitWalletVersion.PROTOBUF_ENCRYPTED); } // If the wallet file is missing or empty but the backup file exists // load that instead. This indicates that the write was interrupted // (e.g. power loss). boolean useBackupWallets = (!walletFile.exists() || walletFile.length() == 0); boolean walletWasLoadedSuccessfully = false; Collection<String> errorMessages = new ArrayList<String>(); Wallet wallet = null; // Try the main wallet first unless it is obviously broken. if (!useBackupWallets) { FileInputStream fileInputStream = new FileInputStream(walletFile); InputStream stream = null; try { stream = new BufferedInputStream(fileInputStream); wallet = Wallet.loadFromFileStream(stream); walletWasLoadedSuccessfully = true; } catch (WalletVersionException wve) { // We want this exception to propagate out. throw wve; } catch (Exception e) { e.printStackTrace(); String description = e.getClass().getCanonicalName() + " " + e.getMessage(); log.error(description); errorMessages.add(description); } finally { if (stream != null) { stream.close(); } fileInputStream.close(); } } if (!walletWasLoadedSuccessfully) { // If the main wallet was not loaded successfully, work out the best backup // wallets to try and load them. useBackupWallets = true; Collection<String> backupWalletsToTry = BackupManager.INSTANCE .calculateBestWalletBackups(walletFile, walletInfo); Iterator<String> iterator = backupWalletsToTry.iterator(); while (!walletWasLoadedSuccessfully && iterator.hasNext()) { String walletToTry = iterator.next(); FileInputStream fileInputStream = new FileInputStream(new File(walletToTry)); InputStream stream = null; try { stream = new BufferedInputStream(fileInputStream); wallet = Wallet.loadFromFileStream(stream); walletWasLoadedSuccessfully = true; // Mention to user that backup is being used. // Report failure to user. MessageManager.INSTANCE.addMessage(new Message(bitcoinController.getLocaliser().getString( "fileHandler.walletCannotLoadUsingBackup", new String[] { walletFilenameToUseInModel, walletToTry }))); } catch (Exception e) { e.printStackTrace(); String description = e.getClass().getCanonicalName() + " " + e.getMessage(); log.error(description); errorMessages.add(description); } finally { if (stream != null) { stream.close(); } fileInputStream.close(); } } } WalletData perWalletModelData = null; if (walletWasLoadedSuccessfully) { if (walletInfo != null) { // If wallet description is only in the wallet, copy it to // the wallet info // (perhaps the user deleted/ did not copy the info file). String walletDescriptionInInfo = walletInfo.getProperty(WalletInfoData.DESCRIPTION_PROPERTY); if ((walletDescriptionInInfo == null || walletDescriptionInInfo.length() == 0) && wallet.getDescription() != null) { walletInfo.put(WalletInfoData.DESCRIPTION_PROPERTY, wallet.getDescription()); } // Check that only receiving addresses that appear in a key // appear in the wallet info. walletInfo.checkAllReceivingAddressesAppearInWallet(wallet); // Make sure the version type in the info file matches what was actually loaded. // (A backup with a different encryption type might have been used). walletInfo.setWalletVersion(wallet.getVersion()); } // Ensure that the directories for the backups of the private // keys, rolling backups and regular backups exist. BackupManager.INSTANCE.createBackupDirectories(walletFile); // Add the new wallet into the model. wallet.setNetworkParameters(bitcoinController.getModel().getNetworkParameters()); perWalletModelData = bitcoinController.getModel().addWallet(this.bitcoinController, wallet, walletFilenameToUseInModel); perWalletModelData.setWalletInfo(walletInfo); // If the backup files were used save them immediately and don't // delete any rolling backups. if (useBackupWallets) { // Wipe the wallet backup property so that the rolling // backup file will not be overwritten walletInfo.put(BitcoinModel.WALLET_BACKUP_FILE, ""); // Save the wallet immediately just to be on the safe side. savePerWalletModelData(perWalletModelData, true); } synchronized (walletInfo) { rememberFileSizesAndLastModified(new File(walletFilenameToUseInModel), walletInfo); perWalletModelData.setDirty(false); } } else { // No wallet was loaded successfully. // Wipe the rolling backup property to ensure that file wont be deleted. if (walletInfo != null) { walletInfo.put(BitcoinModel.WALLET_BACKUP_FILE, ""); } // Report failure to user. String messageText = bitcoinController.getLocaliser().getString( "fileHandler.unableToLoadWalletOrBackups", new String[] { walletFilenameToUseInModel }); if (!errorMessages.isEmpty()) { StringBuilder errorMessagesAsString = new StringBuilder(); for (String errorText : errorMessages) { if (errorMessagesAsString.length() > 0) { errorMessagesAsString.append("\n"); } errorMessagesAsString.append(errorText); } messageText = messageText + "\n" + bitcoinController.getLocaliser().getString( "deleteWalletConfirmDialog.walletDeleteError2", new String[] { errorMessagesAsString.toString() }); } MessageManager.INSTANCE.addMessage(new Message(messageText)); } return perWalletModelData; } catch (WalletVersionException wve) { // We want this to propagate out. throw wve; } catch (Exception e) { e.printStackTrace(); log.error(e.getClass().getCanonicalName() + " " + e.getMessage()); throw new WalletLoadException(e.getClass().getCanonicalName() + " " + e.getMessage(), e); } } private boolean isWalletSerialised(File walletFile) { boolean isWalletSerialised = false; InputStream stream = null; try { // Determine what kind of wallet stream this is: Java Serialization // or protobuf format. stream = new BufferedInputStream(new FileInputStream(walletFile)); isWalletSerialised = stream.read() == 0xac && stream.read() == 0xed; } catch (FileNotFoundException e) { log.error(e.getClass().getCanonicalName() + " " + e.getMessage()); } catch (IOException e) { log.error(e.getClass().getCanonicalName() + " " + e.getMessage()); } finally { if (stream != null) { try { stream.close(); } catch (IOException e) { log.error(e.getClass().getCanonicalName() + " " + e.getMessage()); } } } return isWalletSerialised; } /** * Save the perWalletModelData to file. * * @param perWalletModelData * @param forceWrite * force the write of the perWalletModelData */ public void savePerWalletModelData(WalletData perWalletModelData, boolean forceWrite) { if (perWalletModelData == null || perWalletModelData.getWalletFilename() == null) { return; } File walletFile = new File(perWalletModelData.getWalletFilename()); WalletInfoData walletInfo = perWalletModelData.getWalletInfo(); if (walletInfo != null) { synchronized (walletInfo) { // Save the perWalletModelData if it is dirty or if forceWrite is true. if (perWalletModelData.isDirty() || forceWrite) { // Check dates and sizes of files. boolean filesHaveChanged = haveFilesChanged(perWalletModelData); if (!filesHaveChanged || forceWrite) { // Normal write of data. String walletInfoFilename = WalletInfoData .createWalletInfoFilename(perWalletModelData.getWalletFilename()); saveWalletAndWalletInfo(perWalletModelData, perWalletModelData.getWalletFilename(), walletInfoFilename); rememberFileSizesAndLastModified(walletFile, walletInfo); // The perWalletModelData is no longer dirty. perWalletModelData.setDirty(false); } else { // Write to backup files. BackupManager.INSTANCE.backupPerWalletModelData(this, perWalletModelData); } } } } return; } /** * Simply save the wallet and wallet info files. * Used for backup writes. * * @param perWalletModelData * @param walletFilename * @param walletInfoFilename */ public void saveWalletAndWalletInfoSimple(WalletData perWalletModelData, String walletFilename, String walletInfoFilename) { File walletFile = new File(walletFilename); WalletInfoData walletInfo = perWalletModelData.getWalletInfo(); FileOutputStream fileOutputStream = null; // Save the wallet file try { if (perWalletModelData.getWallet() != null) { // Wallet description is currently stored in the wallet info // file but is now available on the wallet itself. // Store the description from the wallet info in the wallet - in // the future the wallet value will be primary // and wallet infos can be deprecated. // TODO - migrate completely to use wallet description and then // deprecate value in info file. if (walletInfo != null) { String walletDescriptionInInfoFile = walletInfo .getProperty(WalletInfoData.DESCRIPTION_PROPERTY); if (walletDescriptionInInfoFile != null) { perWalletModelData.getWallet().setDescription(walletDescriptionInInfoFile); } } log.debug("Saving wallet file '" + walletFile.getAbsolutePath() + "' ..."); if (MultiBitWalletVersion.SERIALIZED == walletInfo.getWalletVersion()) { throw new WalletSaveException("Cannot save wallet '" + walletFile.getAbsolutePath() + "'. Serialized wallets are no longer supported."); } else { // See if there are any encrypted private keys - if there // are the wallet will be saved // as encrypted and the version set to PROTOBUF_ENCRYPTED. boolean walletIsActuallyEncrypted = false; Wallet wallet = perWalletModelData.getWallet(); // Check all the keys individually. for (ECKey key : wallet.getKeychain()) { if (key.isEncrypted()) { walletIsActuallyEncrypted = true; break; } } if (walletIsActuallyEncrypted) { walletInfo.setWalletVersion(MultiBitWalletVersion.PROTOBUF_ENCRYPTED); } if (MultiBitWalletVersion.PROTOBUF == walletInfo.getWalletVersion()) { // Save as a Wallet message. perWalletModelData.getWallet().saveToFile(walletFile); } else if (MultiBitWalletVersion.PROTOBUF_ENCRYPTED == walletInfo.getWalletVersion()) { fileOutputStream = new FileOutputStream(walletFile); // Save as a Wallet message with a mandatory extension // to prevent loading by older versions of multibit. walletProtobufSerializer.writeWallet(perWalletModelData.getWallet(), fileOutputStream); } else { throw new WalletVersionException( "Cannot save wallet '" + perWalletModelData.getWalletFilename() + "'. Its wallet version is '" + walletInfo.getWalletVersion().toString() + "' but this version of MultiBit does not understand that format."); } } log.debug("... done saving wallet file."); } } catch (IOException ioe) { throw new WalletSaveException("Cannot save wallet '" + perWalletModelData.getWalletFilename(), ioe); } finally { if (fileOutputStream != null) { try { fileOutputStream.flush(); fileOutputStream.close(); } catch (IOException e) { throw new WalletSaveException("Cannot save wallet '" + perWalletModelData.getWalletFilename(), e); } } } // Write wallet info. walletInfo.writeToFile(walletInfoFilename, walletInfo.getWalletVersion()); } /** * To protect the wallet data, the write is in steps: 1) Create a backup * file called <wallet file name>-<yyyymmddhhmmss>.wallet and copy the * original wallet to that 2) Write the new wallet to the walletFilename 3) * Delete the old backup file 4) Make the backup file in step 1) the new * backup file * **/ private void saveWalletAndWalletInfo(WalletData perWalletModelData, String walletFilename, String walletInfoFilename) { File walletFile = new File(walletFilename); WalletInfoData walletInfo = perWalletModelData.getWalletInfo(); FileOutputStream fileOutputStream = null; // Save the wallet file try { if (perWalletModelData.getWallet() != null) { // Wallet description is currently stored in the wallet info // file but is now available on the wallet itself. // Store the description from the wallet info in the wallet - in // the future the wallet value will be primary // and wallet infos can be deprecated. // TODO - migrate completely to use wallet description and then // deprecate value in info file. if (walletInfo != null) { String walletDescriptionInInfoFile = walletInfo .getProperty(WalletInfoData.DESCRIPTION_PROPERTY); if (walletDescriptionInInfoFile != null) { perWalletModelData.getWallet().setDescription(walletDescriptionInInfoFile); } } String oldBackupFilename = perWalletModelData.getWalletInfo() .getProperty(BitcoinModel.WALLET_BACKUP_FILE); File oldBackupFile = null; String newBackupFilename = null; if (null != oldBackupFilename && !"".equals(oldBackupFilename)) { oldBackupFile = new File(oldBackupFilename); } if (walletInfo != null && (MultiBitWalletVersion.PROTOBUF == walletInfo.getWalletVersion() || MultiBitWalletVersion.PROTOBUF_ENCRYPTED == walletInfo.getWalletVersion())) { newBackupFilename = copyExistingWalletToBackupAndDeleteOriginal(walletFile); } log.debug("Saving wallet file '" + walletFile.getAbsolutePath() + "' ..."); if (walletInfo != null && MultiBitWalletVersion.SERIALIZED == walletInfo.getWalletVersion()) { throw new WalletSaveException("Cannot save wallet '" + walletFile.getAbsolutePath() + "'. Serialized wallets are no longer supported."); } else { // See if there are any encrypted private keys - if there // are the wallet will be saved // as encrypted and the version set to PROTOBUF_ENCRYPTED. boolean walletIsActuallyEncrypted = false; Wallet wallet = perWalletModelData.getWallet(); // Check all the keys individually. for (ECKey key : wallet.getKeychain()) { if (key.isEncrypted()) { walletIsActuallyEncrypted = true; break; } } if (walletIsActuallyEncrypted) { walletInfo.setWalletVersion(MultiBitWalletVersion.PROTOBUF_ENCRYPTED); } if (MultiBitWalletVersion.PROTOBUF == walletInfo.getWalletVersion()) { // Save as a Wallet message. perWalletModelData.getWallet().saveToFile(walletFile); } else if (MultiBitWalletVersion.PROTOBUF_ENCRYPTED == walletInfo.getWalletVersion()) { fileOutputStream = new FileOutputStream(walletFile); // Save as a Wallet message with a mandatory extension // to prevent loading by older versions of multibit. walletProtobufSerializer.writeWallet(perWalletModelData.getWallet(), fileOutputStream); } else { throw new WalletVersionException( "Cannot save wallet '" + perWalletModelData.getWalletFilename() + "'. Its wallet version is '" + walletInfo.getWalletVersion().toString() + "' but this version of MultiBit does not understand that format."); } } log.debug("... done saving wallet file. Wallet file size is " + walletFile.length() + " bytes."); if (MultiBitWalletVersion.PROTOBUF == walletInfo.getWalletVersion() || MultiBitWalletVersion.PROTOBUF_ENCRYPTED == walletInfo.getWalletVersion()) { perWalletModelData.getWalletInfo().put(BitcoinModel.WALLET_BACKUP_FILE, newBackupFilename); // Delete the oldBackupFile unless the user has manually // opened it. boolean userHasOpenedBackupFile = false; List<WalletData> perWalletModelDataList = this.bitcoinController.getModel() .getPerWalletModelDataList(); if (perWalletModelDataList != null) { for (WalletData perWalletModelDataLoop : perWalletModelDataList) { if ((oldBackupFilename != null && oldBackupFilename.equals(perWalletModelDataLoop.getWalletFilename())) || (newBackupFilename != null && newBackupFilename .equals(perWalletModelDataLoop.getWalletFilename()))) { userHasOpenedBackupFile = true; break; } } } if (!userHasOpenedBackupFile) { secureDelete(oldBackupFile); } } } } catch (IOException ioe) { throw new WalletSaveException("Cannot save wallet '" + perWalletModelData.getWalletFilename(), ioe); } finally { if (fileOutputStream != null) { try { fileOutputStream.flush(); fileOutputStream.close(); } catch (IOException e) { throw new WalletSaveException("Cannot save wallet '" + perWalletModelData.getWalletFilename(), e); } } } // Write wallet info. walletInfo.writeToFile(walletInfoFilename, walletInfo.getWalletVersion()); } /** * Backup the private keys of the active wallet to a file with name <wallet-name>-data/key-backup/<wallet * name>-yyyymmddhhmmss.key * * TODO This might be better on the BackupManager * * @param passwordToUse * @return File to which keys were backed up, or null if they were not. * @throws KeyCrypterException */ public File backupPrivateKeys(CharSequence passwordToUse) throws IOException, KeyCrypterException { File privateKeysBackupFile = null; // Only encrypted files are backed up, and they must have a non blank password. if (passwordToUse != null && passwordToUse.length() > 0) { if (controller.getModel() != null && this.bitcoinController.getModel().getActiveWalletWalletInfo() != null && this.bitcoinController.getModel().getActiveWalletWalletInfo() .getWalletVersion() == MultiBitWalletVersion.PROTOBUF_ENCRYPTED) { // Save a backup copy of the private keys, encrypted with the passwordToUse. PrivateKeysHandler privateKeysHandler = new PrivateKeysHandler( this.bitcoinController.getModel().getNetworkParameters()); String privateKeysBackupFilename = BackupManager.INSTANCE.createBackupFilename( new File(this.bitcoinController.getModel().getActiveWalletFilename()), BackupManager.PRIVATE_KEY_BACKUP_DIRECTORY_NAME, false, false, BitcoinModel.PRIVATE_KEY_FILE_EXTENSION); privateKeysBackupFile = new File(privateKeysBackupFilename); BlockChain blockChain = null; if (this.bitcoinController.getMultiBitService() != null) { blockChain = this.bitcoinController.getMultiBitService().getChain(); } privateKeysHandler.exportPrivateKeys(privateKeysBackupFile, this.bitcoinController.getModel().getActiveWallet(), blockChain, true, passwordToUse, passwordToUse); } else { log.debug("Wallet '" + this.bitcoinController.getModel().getActiveWalletFilename() + "' private keys not backed up as not PROTOBUF_ENCRYPTED"); } } else { log.debug("Wallet '" + this.bitcoinController.getModel().getActiveWalletFilename() + "' private keys not backed up password was blank or of zero length"); } return privateKeysBackupFile; } /** * Copy an existing wallet to a backup file and delete the original. * Used in rolling backups * * @param walletFile * @return * @throws IOException */ private String copyExistingWalletToBackupAndDeleteOriginal(File walletFile) throws IOException { String newWalletBackupFilename = BackupManager.INSTANCE.createBackupFilename(walletFile, BackupManager.ROLLING_WALLET_BACKUP_DIRECTORY_NAME, false, false, BitcoinModel.WALLET_FILE_EXTENSION); File newWalletBackupFile = new File(newWalletBackupFilename); if (walletFile != null && walletFile.exists()) { FileHandler.copyFile(walletFile, newWalletBackupFile); if (walletFile.length() != newWalletBackupFile.length()) { throw new IOException("Failed to copy the existing wallet from '" + walletFile.getAbsolutePath() + "' to '" + newWalletBackupFilename + "'"); } if (!walletFile.getAbsolutePath().equals(newWalletBackupFile.getAbsolutePath())) { secureDelete(walletFile); } } return newWalletBackupFilename; } /** * Secure delete the wallet and the wallet info file. * * @param perWalletModelData */ public void deleteWalletAndWalletInfo(WalletData perWalletModelData) { if (perWalletModelData == null) { return; } File walletFile = new File(perWalletModelData.getWalletFilename()); WalletInfoData walletInfo = perWalletModelData.getWalletInfo(); String walletInfoFilenameAsString = WalletInfoData .createWalletInfoFilename(perWalletModelData.getWalletFilename()); File walletInfoFile = new File(walletInfoFilenameAsString); synchronized (walletInfo) { // See if either of the files are readonly - abort. if (!walletFile.canWrite() || !walletInfoFile.canWrite()) { throw new DeleteWalletException( controller.getLocaliser().getString("deleteWalletException.walletWasReadonly")); } // Delete the wallet info file first, then the wallet. try { FileHandler.secureDelete(walletInfoFile); FileHandler.secureDelete(walletFile); walletInfo.setDeleted(true); } catch (IOException ioe) { log.error(ioe.getClass().getCanonicalName() + " " + ioe.getMessage()); throw new DeleteWalletException( controller.getLocaliser().getString("deleteWalletException.genericCouldNotDelete", new String[] { perWalletModelData.getWalletFilename() })); } } // If the wallet was deleted, delete the model data. if (walletInfo.isDeleted()) { this.bitcoinController.getModel().remove(perWalletModelData); } return; } public boolean haveFilesChanged(WalletData perWalletModelData) { if (perWalletModelData == null || perWalletModelData.getWalletFilename() == null) { return false; } boolean haveFilesChanged = false; String walletInfoFilename = WalletInfoData.createWalletInfoFilename(perWalletModelData.getWalletFilename()); File walletInfoFile = new File(walletInfoFilename); File walletFile = new File(perWalletModelData.getWalletFilename()); WalletInfoData walletInfo = perWalletModelData.getWalletInfo(); if (walletInfo != null) { synchronized (walletInfo) { String walletFileSize = "" + walletFile.length(); String walletFileLastModified = "" + walletFile.lastModified(); String walletInfoFileSize = "" + walletInfoFile.length(); String walletInfoFileLastModified = "" + walletInfoFile.lastModified(); if (!walletFileSize.equals(walletInfo.getProperty(BitcoinModel.WALLET_FILE_SIZE))) { haveFilesChanged = true; } if (!walletFileLastModified .equals(walletInfo.getProperty(BitcoinModel.WALLET_FILE_LAST_MODIFIED))) { haveFilesChanged = true; } if (!walletInfoFileSize.equals(walletInfo.getProperty(BitcoinModel.WALLET_INFO_FILE_SIZE))) { haveFilesChanged = true; } if (haveFilesChanged) { log.debug("Result of check of whether files have changed for wallet filename " + perWalletModelData.getWalletFilename() + " was " + haveFilesChanged + "."); log.debug(BitcoinModel.WALLET_FILE_SIZE + " " + walletFileSize + " ," + BitcoinModel.WALLET_FILE_LAST_MODIFIED + " " + walletFileLastModified + " ," + BitcoinModel.WALLET_INFO_FILE_SIZE + " " + walletInfoFileSize + " ," + BitcoinModel.WALLET_INFO_FILE_LAST_MODIFIED + " " + walletInfoFileLastModified); } } } return haveFilesChanged; } /** * Keep a record of the wallet and wallet info files sizes and date last * modified. * * @param walletFile * The wallet file * @param walletInfo * The wallet info */ private void rememberFileSizesAndLastModified(File walletFile, WalletInfoData walletInfo) { // Get the files' last modified data and sizes and store them in the // wallet properties. if (walletFile == null || walletInfo == null) { return; } long walletFileSize = walletFile.length(); long walletFileLastModified = walletFile.lastModified(); String walletFilename = walletFile.getAbsolutePath(); String walletInfoFilename = WalletInfoData.createWalletInfoFilename(walletFilename); File walletInfoFile = new File(walletInfoFilename); long walletInfoFileSize = walletInfoFile.length(); long walletInfoFileLastModified = walletInfoFile.lastModified(); walletInfo.put(BitcoinModel.WALLET_FILE_SIZE, "" + walletFileSize); walletInfo.put(BitcoinModel.WALLET_FILE_LAST_MODIFIED, "" + walletFileLastModified); walletInfo.put(BitcoinModel.WALLET_INFO_FILE_SIZE, "" + walletInfoFileSize); walletInfo.put(BitcoinModel.WALLET_INFO_FILE_LAST_MODIFIED, "" + walletInfoFileLastModified); log.debug("rememberFileSizesAndLastModified: Wallet filename " + walletFilename + " , " + BitcoinModel.WALLET_FILE_SIZE + " " + walletFileSize + " ," + BitcoinModel.WALLET_FILE_LAST_MODIFIED + " " + walletFileLastModified + " ," + BitcoinModel.WALLET_INFO_FILE_SIZE + " " + walletInfoFileSize + " ," + BitcoinModel.WALLET_INFO_FILE_LAST_MODIFIED + " " + walletInfoFileLastModified); } public static void writeUserPreferences(BitcoinController bitcoinController) { final Controller controller = bitcoinController; // Save all the wallets' filenames in the user preferences. if (bitcoinController.getModel().getPerWalletModelDataList() != null) { List<WalletData> perWalletModelDataList = bitcoinController.getModel().getPerWalletModelDataList(); List<String> orderList = new ArrayList<String>(); List<String> earlyList = new ArrayList<String>(); List<String> protobuf3List = new ArrayList<String>(); for (WalletData perWalletModelData : perWalletModelDataList) { // Check if this is the initial empty WalletData if ("".equals(perWalletModelData.getWalletFilename()) || perWalletModelData.getWalletFilename() == null || perWalletModelData.getWalletInfo() == null) { continue; } // Do not save deleted wallets if (perWalletModelData.getWalletInfo().isDeleted()) { log.debug("Not writing out info about wallet '" + perWalletModelData.getWalletFilename() + "' as it has been deleted"); continue; } if (!orderList.contains(perWalletModelData.getWalletFilename())) { orderList.add(perWalletModelData.getWalletFilename()); } if (perWalletModelData.getWalletInfo() .getWalletVersion() == MultiBitWalletVersion.PROTOBUF_ENCRYPTED) { if (!protobuf3List.contains(perWalletModelData.getWalletFilename())) { protobuf3List.add(perWalletModelData.getWalletFilename()); } } else if (perWalletModelData.getWalletInfo().getWalletVersion() == null || perWalletModelData.getWalletInfo().getWalletVersion() == MultiBitWalletVersion.SERIALIZED || perWalletModelData.getWalletInfo() .getWalletVersion() == MultiBitWalletVersion.PROTOBUF) { if (!earlyList.contains(perWalletModelData.getWalletFilename())) { earlyList.add(perWalletModelData.getWalletFilename()); } } } int orderCount = 1; for (String walletFilename : orderList) { controller.getModel().setUserPreference(BitcoinModel.WALLET_ORDER_PREFIX + orderCount, walletFilename); orderCount++; } controller.getModel().setUserPreference(BitcoinModel.WALLET_ORDER_TOTAL, "" + orderList.size()); int earlyCount = 1; for (String walletFilename : earlyList) { controller.getModel().setUserPreference(BitcoinModel.EARLY_WALLET_FILENAME_PREFIX + earlyCount, walletFilename); earlyCount++; } controller.getModel().setUserPreference(BitcoinModel.NUMBER_OF_EARLY_WALLETS, "" + earlyList.size()); int protobuf3Count = 1; for (String walletFilename : protobuf3List) { controller.getModel().setUserPreference( BitcoinModel.PROTOBUF3_WALLET_FILENAME_PREFIX + protobuf3Count, walletFilename); protobuf3Count++; } controller.getModel().setUserPreference(BitcoinModel.NUMBER_OF_PROTOBUF3_WALLETS, "" + protobuf3List.size()); controller.getModel().setUserPreference(BitcoinModel.ACTIVE_WALLET_FILENAME, bitcoinController.getModel().getActiveWalletFilename()); } Properties userPreferences = controller.getModel().getAllUserPreferences(); // If the view is marked as also requiring a backwards compatible // numeric field write that. @SuppressWarnings("deprecation") int currentViewNumericFormat = View.toOldViewNumeric(controller.getCurrentView()); if (currentViewNumericFormat != 0) { userPreferences.put(CoreModel.SELECTED_VIEW, "" + currentViewNumericFormat); } else { // Make sure the old numeric value for a view is not in the user // properties. userPreferences.remove(CoreModel.SELECTED_VIEW); } // Write the user preference properties. OutputStream outputStream = null; try { String userPropertiesFilename; if ("".equals(controller.getApplicationDataDirectoryLocator().getApplicationDataDirectory())) { userPropertiesFilename = USER_PROPERTIES_FILE_NAME; } else { userPropertiesFilename = controller.getApplicationDataDirectoryLocator() .getApplicationDataDirectory() + File.separator + USER_PROPERTIES_FILE_NAME; } outputStream = new FileOutputStream(userPropertiesFilename); BufferedOutputStream bufferedOutputStream = new BufferedOutputStream(outputStream); OutputStreamWriter outputStreamWriter = new OutputStreamWriter(bufferedOutputStream, "UTF8"); userPreferences.store(outputStreamWriter, USER_PROPERTIES_HEADER_TEXT); } catch (FileNotFoundException e) { log.error(e.getMessage(), e); } catch (IOException e) { log.error(e.getMessage(), e); } finally { if (outputStream != null) { try { outputStream.flush(); outputStream.close(); } catch (IOException e) { log.error(e.getClass().getCanonicalName() + " " + e.getMessage()); } finally { outputStream = null; } } } } public static Properties loadUserPreferences(ApplicationDataDirectoryLocator applicationDataDirectoryLocator) { Properties userPreferences = new Properties(); try { String userPropertiesFilename; if ("".equals(applicationDataDirectoryLocator.getApplicationDataDirectory())) { userPropertiesFilename = USER_PROPERTIES_FILE_NAME; } else { userPropertiesFilename = applicationDataDirectoryLocator.getApplicationDataDirectory() + File.separator + USER_PROPERTIES_FILE_NAME; } InputStream inputStream = new FileInputStream(userPropertiesFilename); InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "UTF8"); userPreferences.load(inputStreamReader); } catch (FileNotFoundException e) { // Ok - may not have been created yet. } catch (IOException e) { // Ok may not be written yet. } return userPreferences; } /* Load jsonrpc.config file */ public static final String JSON_RPC_CONFIG_FILE_NAME = "jsonrpc.properties"; public static Properties loadJSONRPCConfig(ApplicationDataDirectoryLocator applicationDataDirectoryLocator) { Properties userPreferences = new Properties(); try { String userPropertiesFilename; if ("".equals(applicationDataDirectoryLocator.getApplicationDataDirectory())) { userPropertiesFilename = JSON_RPC_CONFIG_FILE_NAME; } else { userPropertiesFilename = applicationDataDirectoryLocator.getApplicationDataDirectory() + File.separator + JSON_RPC_CONFIG_FILE_NAME; } InputStream inputStream = new FileInputStream(userPropertiesFilename); InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "UTF8"); userPreferences.load(inputStreamReader); } catch (FileNotFoundException e) { // Ok - may not have been created yet. } catch (IOException e) { // Ok may not be written yet. } return userPreferences; } /* Decompress sparkbit.fbhchain.xz to user data folder. The decompressed file length is 10254368 at block height 320449 on sep 13. The first 10,000,000 bytes are zero'ed, so upto height 312500 on july 26. This helps compression and also no assets were issued before that date. @return boolean true or false if operation successful */ public boolean copyFullBlockHashChainResource(String destinationFilename) throws IOException { if (destinationFilename == null) { return false; } // if destination already exists, do nothing File destinationFile = new File(destinationFilename); if (destinationFile.exists()) { return false; } InputStream link = getClass().getResourceAsStream( "/" + MultiBitService.getFilePrefix() + MultiBitService.COMPRESSED_FULL_BLOCK_HASH_CHAIN_SUFFIX); log.info("Copying and decompresing bundled fbhchain to '" + destinationFilename + "'"); FileInputStream fin = null; FileOutputStream out = null; XZInputStream xzIn = null; int decompressedLength = 0; try { // BufferedInputStream in = new BufferedInputStream(link); out = new FileOutputStream(destinationFilename); xzIn = new XZInputStream(link); final byte[] buffer = new byte[4096]; int n = 0; while (-1 != (n = xzIn.read(buffer))) { out.write(buffer, 0, n); decompressedLength += n; } } catch (IOException e) { log.error("Error decompresing sparkbit.fbhchain.xz : " + e); throw (e); } finally { if (out != null) { out.close(); } if (xzIn != null) { xzIn.close(); } if (fin != null) { fin.close(); } if (link != null) { link.close(); } } // Check all the data was copied. long sourceLength = decompressedLength; long destinationLength = destinationFile.length(); if (sourceLength != destinationLength) { String errorText = "fbhchain was not copied to user's application data directory correctly.\nThe decompressed bundled fbhchain is of length " + sourceLength + "\nbut the destination fbhchain '" + destinationFilename + "' is of length " + destinationLength; log.error(errorText); throw new IOException(errorText); } return true; } /* Convenience method to return path to the checkpoints file installed as part of application. @return null if something went wrong */ // public String getPathOfCheckpointsFromInstallationDirectory() { // String filePrefix = MultiBitService.getFilePrefix(); // String checkpointsFilename = filePrefix + MultiBitService.CHECKPOINTS_SUFFIX; // String sourceCheckpointsFilename = null; // URL checkpointURL = null; // try { // checkpointURL = getClass().getResource("/" + checkpointsFilename); // if (checkpointURL != null) { // sourceCheckpointsFilename = checkpointURL.toURI().getPath(); // } //// log.debug("sourceCheckpointsFilename = " + sourceCheckpointsFilename); // } catch (java.net.URISyntaxException e) { // log.error("Error getting file path for: " + checkpointURL); // } // return sourceCheckpointsFilename; // } /* Return the length of the checkpoints resource */ public int getCheckpointsResourceLength() throws IOException { InputStream link = getClass() .getResourceAsStream("/" + MultiBitService.getFilePrefix() + MultiBitService.CHECKPOINTS_SUFFIX); //sparkbit.checkpoints"); int bytesAvailable = link.available(); link.close(); return bytesAvailable; } /* Return the length of the fbhchain resource */ // public int getFullBlockHashChainResourceLength() throws IOException { // InputStream link = getClass().getResourceAsStream("/" + MultiBitService.getFilePrefix() + MultiBitService.COMPRESSED_FULL_BLOCK_HASH_CHAIN_SUFFIX); //sparkbit.checkpoints"); // XZInputStream xzIn = new XZInputStream(link); // int bytesAvailable = xzIn.available(); // xzIn.close(); // link.close(); // return bytesAvailable; // } public boolean isLauncedFromJWrapper() { boolean result = false; try { Class.forName("jwrapper.jwutils.JWSystem"); // it exists on the classpath result = true; } catch (ClassNotFoundException e) { // it does not exist on the classpath } return result; } /* Install the packaged keystore_localhost_sample.jks to the user's application data directory. If the file already exists, do nothing */ public void installJSONRPCSampleKeystore(String targetFilename) throws IOException { if (targetFilename == null) return; File targetFile = new File(targetFilename); if (targetFile.exists()) return; InputStream is = getClass().getResourceAsStream("/keystore_localhost_sample.jks"); try { long n = Files.copy(is, Paths.get(targetFilename)); } catch (Exception e) { log.error("installJSONRPCSampleKeystore error = " + e); } finally { is.close(); } } /* Install the packaged jsonrpc.properties to the user's application data directory. If the file already exists, do nothing. @param targetFilename full path of where to make the copy @param autogenRPCPassword of true, replaces the default password with an auto generated one */ public void installJSONRPCProperties(String targetFilename, boolean autogenRPCPassword) throws IOException { if (targetFilename == null) return; File targetFile = new File(targetFilename); if (targetFile.exists()) return; InputStream is = getClass().getResourceAsStream("/jsonrpc.properties"); try { String s = IOUtils.toString(is, "UTF-8"); String pwd = RandomStringUtils.randomAlphanumeric(30); s = s.replace("rpcpassword=password", "rpcpassword=" + pwd); // Files.write(Paths.get(targetFilename), s.getBytes()); // If launched from JWrapper, set the recommended cipher to TLS_RSA_.* // so that JSON-RPC works "out of the box". if (isLauncedFromJWrapper()) { s = s.replace("rpcsslciphers=TLS_ECDHE_RSA_.*", "rpcsslciphers=TLS_RSA_.*"); } // If in headless mode, set headless to true boolean isHeadless = Boolean.TRUE.toString().equals(System.getProperty("java.awt.headless")); if (isHeadless) { s = s.replace("#headless=true", "headless=true"); } FileUtils.writeStringToFile(targetFile, s, "UTF-8"); log.info("Installed " + targetFilename); } catch (Exception e) { log.error("copyJSONRPCProperties error = " + e); } finally { is.close(); } } /** * To support multiple users on the same machine, the checkpoints file is * copied to the user's application data directory when SparkBit is first used. * * Thus each user has their own copy of the blockchain. */ public void copyCheckpointsResource(String destinationCheckpointsFilename) throws IOException { if (destinationCheckpointsFilename == null) { return; } File destinationCheckpoints = new File(destinationCheckpointsFilename); log.info("Copying bundled sparkbit.checkpoints to '" + destinationCheckpointsFilename + "'"); InputStream link = getClass() .getResourceAsStream("/" + MultiBitService.getFilePrefix() + MultiBitService.CHECKPOINTS_SUFFIX); //sparkbit.checkpoints"); int bytesAvailable = link.available(); long bytesCopied = Files.copy(link, destinationCheckpoints.getAbsoluteFile().toPath(), StandardCopyOption.REPLACE_EXISTING); link.close(); // Check all the data was copied. long destinationLength = destinationCheckpoints.length(); if (bytesAvailable != destinationLength) { String errorText = "Checkpoints were not copied to user's application data directory correctly.\nThe source checkpoints is of length " + bytesAvailable + "\nbut the destination checkpoints '" + destinationCheckpointsFilename + "' is of length " + destinationLength; log.error(errorText); throw new FileHandlerException(errorText); } } @Deprecated public void copyBlockChainFromInstallationDirectory(String destinationBlockChainFilename, boolean alwaysOverWrite) throws IOException { if (destinationBlockChainFilename == null) { return; } // See if the block chain in the user's application data directory // exists. File destinationBlockchain = new File(destinationBlockChainFilename); if (!destinationBlockchain.exists() || alwaysOverWrite) { // Work out the source blockchain (put into the program installation // directory by the installer). File directory = new File("."); String currentWorkingDirectory = directory.getCanonicalPath(); String filePrefix = MultiBitService.getFilePrefix(); String blockchainFilename = filePrefix + MultiBitService.BLOCKCHAIN_SUFFIX; String sourceBlockchainFilename = currentWorkingDirectory + File.separator + blockchainFilename; File sourceBlockchain = new File(sourceBlockchainFilename); if (sourceBlockchain.exists() && !destinationBlockChainFilename.equals(sourceBlockchainFilename)) { // It should exist since installer puts them in. log.info("Copying blockchain from '" + sourceBlockchainFilename + "' to '" + destinationBlockChainFilename + "'"); if (alwaysOverWrite) { // Delete the existing destinationBlockchain if it exists. if (destinationBlockchain.exists()) { destinationBlockchain.delete(); } } long startTime = (DateUtils.nowUtc()).getMillis(); copyFile(sourceBlockchain, destinationBlockchain); long stopTime = (DateUtils.nowUtc()).getMillis(); log.info("Time taken to copy blockchain was " + (stopTime - startTime) + " ms."); // Check all the data was copied. long sourceLength = sourceBlockchain.length(); long destinationLength = destinationBlockchain.length(); if (sourceLength != destinationLength) { String errorText = "Blockchain was not copied to user's application data directory correctly.\nThe source blockchain '" + sourceBlockchainFilename + "' is of length " + sourceLength + "\nbut the destination blockchain '" + destinationBlockChainFilename + "' is of length " + destinationLength; log.error(errorText); throw new FileHandlerException(errorText); } } } } public static void copyFile(File sourceFile, File destinationFile) throws IOException { if (!destinationFile.exists()) { destinationFile.createNewFile(); } FileInputStream fileInputStream = null; FileOutputStream fileOutputStream = null; FileChannel source = null; FileChannel destination = null; try { fileInputStream = new FileInputStream(sourceFile); source = fileInputStream.getChannel(); fileOutputStream = new FileOutputStream(destinationFile); destination = fileOutputStream.getChannel(); long transfered = 0; long bytes = source.size(); while (transfered < bytes) { transfered += destination.transferFrom(source, 0, source.size()); destination.position(transfered); } } finally { if (source != null) { source.close(); source = null; } else if (fileInputStream != null) { fileInputStream.close(); fileInputStream = null; } if (destination != null) { destination.close(); destination = null; } else if (fileOutputStream != null) { fileOutputStream.flush(); fileOutputStream.close(); } } } public static void writeFile(byte[] sourceBytes, File destinationFile) throws IOException { if (!destinationFile.exists()) { destinationFile.createNewFile(); } FileOutputStream fileOutputStream = null; try { fileOutputStream = new FileOutputStream(destinationFile); fileOutputStream.write(sourceBytes); } finally { if (fileOutputStream != null) { fileOutputStream.flush(); fileOutputStream.close(); } } } public static File createTempDirectory(String filePrefix) throws IOException { final File temp; temp = File.createTempFile(filePrefix, Long.toString(System.currentTimeMillis())); if (!(temp.delete())) { throw new IOException("Could not delete temp file: " + temp.getAbsolutePath()); } if (!(temp.mkdir())) { throw new IOException("Could not create temp directory: " + temp.getAbsolutePath()); } temp.deleteOnExit(); return temp; } /** * Delete a file with an overwrite of all of the data. * * Set bit patterns are used rather than random numbers to avoid a * futex_wait_queue_me error on Linux systems (related to /dev/random usage) * * @param file * @throws IOException */ public static void secureDelete(File file) throws IOException { log.debug("Start of secureDelete"); RandomAccessFile raf = null; if (file != null && file.exists()) { try { // Prep for file delete as this can be fiddly on windows. // Make sure it is writable and any references to it are garbage // collected and finalized. file.setWritable(true); System.gc(); long length = file.length(); raf = new RandomAccessFile(file, "rws"); raf.seek(0); raf.getFilePointer(); int pos = 0; while (pos < length) { raf.write(SECURE_DELETE_FILL_BYTES); pos += SECURE_DELETE_FILL_BYTES.length; } } finally { if (raf != null) { raf.close(); raf = null; } } boolean deleteSuccess = file.delete(); log.debug("Result of delete of file '" + file.getAbsolutePath() + "' was " + deleteSuccess); } log.debug("End of secureDelete"); } public static byte[] read(File file) throws IOException { if (file == null) { throw new IllegalArgumentException("File must be provided"); } if (file.length() > MAX_FILE_SIZE) { throw new IOException("File '" + file.getAbsolutePath() + "' is too large to input"); } byte[] buffer = new byte[(int) file.length()]; InputStream ios = null; try { ios = new FileInputStream(file); if (ios.read(buffer) == -1) { throw new IOException("EOF reached while trying to read the whole file"); } } finally { try { if (ios != null) { ios.close(); } } catch (IOException e) { log.error(e.getClass().getName() + " " + e.getMessage()); } } return buffer; } }