1 2 /* ==================================================================== 3 * The Apache Software License, Version 1.1 4 * 5 * Copyright (c) 2002 The Apache Software Foundation. All rights 6 * reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in 17 * the documentation and/or other materials provided with the 18 * distribution. 19 * 20 * 3. The end-user documentation included with the redistribution, 21 * if any, must include the following acknowledgment: 22 * "This product includes software developed by the 23 * Apache Software Foundation (http://www.apache.org/)." 24 * Alternately, this acknowledgment may appear in the software itself, 25 * if and wherever such third-party acknowledgments normally appear. 26 * 27 * 4. The names "Apache" and "Apache Software Foundation" and 28 * "Apache POI" must not be used to endorse or promote products 29 * derived from this software without prior written permission. For 30 * written permission, please contact apache@apache.org. 31 * 32 * 5. Products derived from this software may not be called "Apache", 33 * "Apache POI", nor may "Apache" appear in their name, without 34 * prior written permission of the Apache Software Foundation. 35 * 36 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 37 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 38 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 39 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 43 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 44 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 45 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 46 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 47 * SUCH DAMAGE. 48 * ==================================================================== 49 * 50 * This software consists of voluntary contributions made by many 51 * individuals on behalf of the Apache Software Foundation. For more 52 * information on the Apache Software Foundation, please see 53 * <http://www.apache.org/>. 54 */ 55 56 package org.apache.poi.hssf.record; 57 58 import org.apache.poi.util.LittleEndian; 59 60 /** 61 * Title: Protect Record<P> 62 * Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)<P> 63 * (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it) <P> 64 * (after all terrorists will all use US-legal encrypton right??)<P> 65 * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 66 * @author Andrew C. Oliver (acoliver at apache dot org) 67 * @version 2.0-pre 68 */ 69 70 public class ProtectRecord 71 extends Record 72 { 73 public final static short sid = 0x12; 74 private short field_1_protect; 75 76 public ProtectRecord() 77 { 78 } 79 80 /** 81 * Constructs a Protect record and sets its fields appropriately. 82 * 83 * @param id id must be 0x12 or an exception will be throw upon validation 84 * @param size size the size of the data area of the record 85 * @param data data of the record (should not contain sid/len) 86 */ 87 88 public ProtectRecord(short id, short size, byte [] data) 89 { 90 super(id, size, data); 91 } 92 93 /** 94 * Constructs a Protect record and sets its fields appropriately. 95 * 96 * @param id id must be 0x12 or an exception will be throw upon validation 97 * @param size size the size of the data area of the record 98 * @param data data of the record (should not contain sid/len) 99 * @param offset of the data 100 */ 101 102 public ProtectRecord(short id, short size, byte [] data, int offset) 103 { 104 super(id, size, data, offset); 105 } 106 107 protected void validateSid(short id) 108 { 109 if (id != sid) 110 { 111 throw new RecordFormatException("NOT A PROTECT RECORD"); 112 } 113 } 114 115 protected void fillFields(byte [] data, short size, int offset) 116 { 117 field_1_protect = LittleEndian.getShort(data, 0 + offset); 118 } 119 120 /** 121 * set whether the sheet is protected or not 122 * @param protect whether to protect the sheet or not 123 */ 124 125 public void setProtect(boolean protect) 126 { 127 if (protect) 128 { 129 field_1_protect = 1; 130 } 131 else 132 { 133 field_1_protect = 0; 134 } 135 } 136 137 /** 138 * get whether the sheet is protected or not 139 * @return whether to protect the sheet or not 140 */ 141 142 public short getProtect() 143 { 144 return field_1_protect; 145 } 146 147 public String toString() 148 { 149 StringBuffer buffer = new StringBuffer(); 150 151 buffer.append("[PROTECT]\n"); 152 buffer.append(" .protected = ") 153 .append(Integer.toHexString(getProtect())).append("\n"); 154 buffer.append("[/PROTECT]\n"); 155 return buffer.toString(); 156 } 157 158 public int serialize(int offset, byte [] data) 159 { 160 LittleEndian.putShort(data, 0 + offset, sid); 161 LittleEndian.putShort(data, 2 + offset, 162 (( short ) 0x02)); // 2 bytes (6 total) 163 LittleEndian.putShort(data, 4 + offset, getProtect()); 164 return getRecordSize(); 165 } 166 167 public int getRecordSize() 168 { 169 return 6; 170 } 171 172 public short getSid() 173 { 174 return this.sid; 175 } 176 } 177