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 import org.apache.poi.util.StringUtil; 60 61 /** 62 * Title: Write Access Record<P> 63 * Description: Stores the username of that who owns the spreadsheet generator 64 * (on unix the user's login, on Windoze its the name you typed when 65 * you installed the thing)<P> 66 * REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 67 * @author Andrew C. Oliver (acoliver at apache dot org) 68 * @version 2.0-pre 69 */ 70 71 public class WriteAccessRecord 72 extends Record 73 { 74 public final static short sid = 0x5c; 75 private String field_1_username; 76 77 public WriteAccessRecord() 78 { 79 } 80 81 /** 82 * Constructs a WriteAccess record and sets its fields appropriately. 83 * 84 * @param id id must be 0x5c or an exception will be throw upon validation 85 * @param size the size of the data area of the record 86 * @param data data of the record (should not contain sid/len) 87 */ 88 89 public WriteAccessRecord(short id, short size, byte [] data) 90 { 91 super(id, size, data); 92 } 93 94 /** 95 * Constructs a WriteAccess record and sets its fields appropriately. 96 * 97 * @param id id must be 0x5c or an exception will be throw upon validation 98 * @param size the size of the data area of the record 99 * @param data data of the record (should not contain sid/len) 100 * @param offset of the record data 101 */ 102 103 public WriteAccessRecord(short id, short size, byte [] data, int offset) 104 { 105 super(id, size, data, offset); 106 } 107 108 protected void validateSid(short id) 109 { 110 if (id != sid) 111 { 112 throw new RecordFormatException("NOT A WRITEACCESS RECORD"); 113 } 114 } 115 116 protected void fillFields(byte [] data, short size, int offset) 117 { 118 field_1_username = new String(data, 3 + offset, data.length - 4); 119 } 120 121 /** 122 * set the username for the user that created the report. HSSF uses the logged in user. 123 * @param username of the user who is logged in (probably "tomcat" or "apache") 124 */ 125 126 public void setUsername(String username) 127 { 128 field_1_username = username; 129 } 130 131 /** 132 * get the username for the user that created the report. HSSF uses the logged in user. On 133 * natively created M$ Excel sheet this would be the name you typed in when you installed it 134 * in most cases. 135 * @return username of the user who is logged in (probably "tomcat" or "apache") 136 */ 137 138 public String getUsername() 139 { 140 return field_1_username; 141 } 142 143 public String toString() 144 { 145 StringBuffer buffer = new StringBuffer(); 146 147 buffer.append("[WRITEACCESS]\n"); 148 buffer.append(" .name = ") 149 .append(field_1_username.toString()).append("\n"); 150 buffer.append("[/WRITEACCESS]\n"); 151 return buffer.toString(); 152 } 153 154 public int serialize(int offset, byte [] data) 155 { 156 String username = getUsername(); 157 StringBuffer temp = new StringBuffer(0x70 - (0x3)); 158 159 temp.append(username); 160 while (temp.length() < 0x70 - 0x3) 161 { 162 temp.append( 163 " "); // (70 = fixed lenght -3 = the overhead bits of unicode string) 164 } 165 username = temp.toString(); 166 UnicodeString str = new UnicodeString(); 167 168 str.setString(username); 169 str.setOptionFlags(( byte ) 0x0); 170 str.setCharCount(( short ) 0x4); 171 byte[] stringbytes = str.serialize(); 172 173 LittleEndian.putShort(data, 0 + offset, sid); 174 LittleEndian.putShort(data, 2 + offset, 175 ( short ) (stringbytes 176 .length)); // 112 bytes (115 total) 177 System.arraycopy(stringbytes, 0, data, 4 + offset, 178 stringbytes.length); 179 return getRecordSize(); 180 } 181 182 public int getRecordSize() 183 { 184 return 116; 185 } 186 187 public short getSid() 188 { 189 return this.sid; 190 } 191 } 192