/usr/share/octave/packages/io-2.0.2/odsopen.m is in octave-io 2.0.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 | ## Copyright (C) 2009,2010,2011,2012,2013,2014 Philip Nienhuis
##
## 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 2 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 Octave; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} @var{ods} = odsopen (@var{filename})
## @deftypefnx {Function File} @var{ods} = odsopen (@var{filename}, @var{readwrite})
## @deftypefnx {Function File} @var{ods} = odsopen (@var{filename}, @var{readwrite}, @var{reqintf})
## Get a pointer to an OpenOffice_org spreadsheet in the form of return
## argument @var{ods}.
##
## Calling odsopen without specifying a return argument is fairly useless!
##
## Octave links to external software for read/write support of spreadsheets;
## these links are "interfaces". For just reading ODS 1.2 and Gnumeric XML
## no external SW is required, yet this "interface" is called 'OCT'.
## To make this function work at all for write support, you need a Java JRE
## or JDK plus one or more of (ODFtoolkit (version 0.7.5 or 0.8.6 - 0.8.8) &
## xercesImpl v.2.9.1), jOpenDocument, or OpenOffice.org (or clones) installed
## on your computer + proper javaclasspath set. These interfaces are referred
## to as OTK, JOD, and UNO resp., and are preferred in that order by default
## (depending on their presence; the OCT interface has lowest priority).
## The relevant Java class libs for spreadsheet I/O had best be added to the
## javaclasspath by utility function chk_spreadsheet_support().
##
## @var{filename} must be a valid .ods OpenOffice.org file name including
## .ods suffix. If @var{filename} does not contain any directory path,
## the file is saved in the current directory.
## For UNO bridge, filenames need to be in the form "file:///<path_to_file>/filename";
## a URL will also work. If a plain file name is given (absolute or relative),
## odsopen() will transform it into proper form.
##
## @var{readwrite} must be set to true or numerical 1 if writing to spreadsheet
## is desired immediately after calling odsopen(). It merely serves proper
## handling of file errors (e.g., "file not found" or "new file created").
##
## Optional input argument @var{reqintf} can be used to override the ODS
## interface automatically selected by odsopen. Currently implemented interfaces
## are 'OTK' (Java/ODF Toolkit), 'JOD' (Java/jOpenDocument), 'UNO'
## (Java/OpenOffice.org UNO bridge), and 'OCT' (native Octave, only reading).
## In most situations this parameter is unneeded as odsopen automatically
## selects the most useful interface present ("default interface").
## Depending on file type, odsopen.m can invoke other detected interfaces than
## the default one.
##
## Beware:
## The UNO interface is still experimental. While in itself reliable, it may
## have undesired side effects on Open-/LibreOffice windows outside Octave.
##
## Examples:
##
## @example
## ods = odsopen ('test1.ods');
## (get a pointer for reading from spreadsheet test1.ods)
##
## ods = odsopen ('test2.ods', [], 'JOD');
## (as above, indicate test2.ods will be read from; in this case using
## the jOpenDocument interface is requested)
## @end example
##
## @seealso {odsclose, odsread, oct2ods, ods2oct, odsfinfo, chk_spreadsheet_support}
##
## @end deftypefn
## Author: Philip Nienhuis <prnienhuis at users.sf.net>
## Created: 2009-12-13
## Updates:
## 2009-12-30 ....<forgot what is was >
## 2010-01-17 Make sure proper dimensions are checked in parsed javaclasspath
## 2010-01-24 Added warning when trying to create a new spreadsheet using
## jOpenDocument
## 2010-03-01 Removed check for rt.jar in javaclasspath
## 2010-03-04 Slight texinfo adaptation (reqd. odfdom version = 0.7.5)
## 2010-03-14 Updated help text (section on readwrite)
## 2010-06-01 Added check for jOpenDocument version + suitable warning
## 2010-06-02 Added ";" to supress debug stuff around lines 115
## '' Moved JOD version check to subfunc getodsinterfaces
## '' Fiddled ods.changed flag when creating a spreadsheet to avoid
## unnamed 1st sheets
## 2010-08-23 Added version field "odfvsn" to ods file ptr, set in
## getodsinterfaces() (odfdom)
## '' Moved JOD version check to this func from subfunc
## getodsinterfaces()
## '' Full support for odfdom 0.8.6 (in subfunc)
## 2010-08-27 Improved help text
## 2010-10-27 Improved tracking of file changes tru ods.changed
## 2010-11-12 Small changes to help text
## '' Added try-catch to file open sections to create fallback to other
## interface
## 2011-05-06 Experimental UNO support
## 2011-05-18 Creating new spreadsheet docs in UNO now works
## 2011-06-06 Tamed down interface verbosity on first startup
## '' Multiple requested interfaces now possible
## 2011-09-03 Reset chkintf if no ods support found to allow full interface
## rediscovery (otherwise javaclasspath additions will never be
## picked up)
## 2012-01-26 Fixed "seealso" help string
## 2012-02-26 Added ";" to suppress echo of filename f UNO
## 2012-06-06 Made interface checking routine less verbose when same requested
## interface was used consecutively
## 2012-09-03 (in UNO section) replace canonicalize_file_name on non-Windows to
## make_absolute_filename (see bug #36677)
## '' (in UNO section) web adresses need only two consecutive slashes
## 2012-10-07 Moved subfunc getodsinterfaces to ./private
## 2012-10-12 Moved all interface-specific file open stanzas to separate
## ./private funcs
## 2012-10-24 Style fixes
## '' Removed fall-back options for .sxc. Other than .xls this can be
## inferred from file suffix
## 2012-12-18 Improved error messages
## 2013-02-24 Temporarily disabled UNO
## 2013-06-18 Re-enabled UNO
## 2013-09-09 Native Octave interface ("OCT") for reading
## 2013-09-23 Check and catch write requests for OCT interface
## '' Relax check for lowercase filename extension
## 2013-09-29 Initially set OCT interface to not detected
## 2013-11-04 Revert above
## 2013-11-08 Better filetype / file extension detection (bug #40490)
## '' Removed stray ';'
## 2013-11-12 Fix syntax error + missing initialization in file ext switch stmt
## 2013-12-01 Updated texinfo header
## 2013-12-18 Style fixes
## 2013-12-27 Use one variable for processed file types
## 2014-01-01 Add warning that UNO will write ODS f. unsupported file extensions
## '' Copyright string update
function [ ods ] = odsopen (filename, rw=0, reqinterface=[])
persistent odsinterfaces; persistent chkintf; persistent lastintf;
if (isempty (chkintf))
odsinterfaces = struct ( "OTK", [], "JOD", [], "UNO", [] , "OCT", 1);
chkintf = 1;
endif
if (isempty (lastintf));
lastintf = "---";
endif
odsintf_cnt = 1;
if (nargout < 1)
usage ("ODS = odsopen (ODSfile, [Rw]). But no return argument specified!");
endif
if (! isempty (reqinterface))
if (! (ischar (reqinterface) || iscell (reqinterface)))
usage ("odsopen.m: arg # 3 (interface) not recognized");
endif
## Turn arg3 into cell array if needed
if (! iscell (reqinterface))
reqinterface = {reqinterface};
endif
## Check if previously used interface matches a requested interface
if (isempty (regexpi (reqinterface, lastintf, "once"){1}))
## New interface requested. OCT is always supported but it must be
## possible to disable it
odsinterfaces.OTK = 0; odsinterfaces.JOD = 0; odsinterfaces.UNO = 0;
odsinterfaces.OCT = 0;
for ii=1:numel (reqinterface)
reqintf = toupper (reqinterface {ii});
## Try to invoke requested interface(s) for this call. Check if it
## is supported anyway by emptying the corresponding var.
if (strcmpi (reqintf, "OTK"))
odsinterfaces.OTK = [];
elseif (strcmpi (reqintf, "JOD"))
odsinterfaces.JOD = [];
elseif (strcmpi (reqintf, "UNO"))
odsinterfaces.UNO = [];
elseif (strcmpi (reqintf, "OCT"))
odsinterfaces.OCT = [];
else
usage (sprintf (["odsopen.m: unknown .ods interface \"%s\" requested.\n" ...
"Only OTK, JOD, UNO and OCT supported\n"], reqinterface{}));
endif
endfor
printf ("Checking requested interface(s):\n");
odsinterfaces = getodsinterfaces (odsinterfaces);
## Well, is/are the requested interface(s) supported on the system?
for ii=1:numel (reqinterface)
if (! odsinterfaces.(toupper (reqinterface{ii})))
## No it aint
printf ("%s is not supported.\n", toupper (reqinterface{ii}));
else
++odsintf_cnt;
endif
endfor
## Reset interface check indicator if no requested support found
if (! odsintf_cnt)
chkintf = [];
ods = [];
return
endif
endif
endif
## Var rw is really used to avoid creating files when wanting to read, or
## not finding not-yet-existing files when wanting to write a new one.
## Be sure it's either 0 or 1 initially
if (rw)
if (odsintf_cnt == 1 && odsinterfaces.OCT)
## Check if OCT is only interface and writing is requested
error ("OCT interface doesn't support writing files");
endif
rw = 1;
endif
## Check if ODS file exists. Set open mode based on rw argument
if (rw)
fmode = "r+b";
else
fmode = "rb";
endif
fid = fopen (filename, fmode);
if (fid < 0)
if (! rw) ## Read mode requested but file doesn't exist
err_str = sprintf ("odsopen.m: file %s not found\n", filename);
error (err_str)
else
## For writing we need more info:
fid = fopen (filename, "rb");
## Check if it can be opened for reading
if (fid < 0) ## Not found => create it
printf ("Creating file %s\n", filename);
rw = 3;
else ## Found but not writable = error
fclose (fid); ## Do not forget to close the handle neatly
error (sprintf ("odsopen.m: write mode requested but file %s is not writable\n",...
filename))
endif
endif
else
## Close file anyway to avoid Java errors
fclose (fid);
endif
## Check for the various ODS interfaces. No problem if they've already
## been checked, getodsinterfaces (far below) just returns immediately then.
[odsinterfaces] = getodsinterfaces (odsinterfaces);
## Supported interfaces determined; now check ODS file type.
ftype = 0;
[~, ~, ext] = fileparts (filename);
switch ext
case ".ods" ## ODS 1.2
ftype = 3;
case ".sxc" ## jOpenDocument (JOD) can read from .sxc files,
ftype = 4; ## but only if odfvsn = 2
case ".gnumeric" ## Zipped XML / gnumeric
ftype = 5;
otherwise
endswitch
ods = struct ("xtype", [],
"app", [],
"filename", [],
"workbook", [],
"changed", 0,
"limits", [],
"odfvsn", []);
## Preferred interface = OTK (ODS toolkit & xerces), so it comes first.
## Keep track of which interface is selected. Can be used (later) for
## fallback to other interface
odssupport = 0;
if (odsinterfaces.OTK && ! odssupport && ftype == 3)
[ ods, odssupport, lastintf ] = ...
__OTK_spsh_open__ (ods, rw, filename, odssupport);
endif
if (odsinterfaces.JOD && ! odssupport && (ftype == 3 || ftype == 4))
[ ods, odssupport, lastintf ] = ...
__JOD_spsh_open__ (ods, rw, filename, odssupport);
endif
if (odsinterfaces.OCT && ! odssupport && ...
(ftype == 2 || ftype == 3 || ftype == 5))
[ ods, odssupport, lastintf ] = ...
__OCT_spsh_open__ (ods, rw, filename, odssupport, ftype);
endif
if (odsinterfaces.UNO && ! odssupport && ftype < 5)
## Warn for LO / OOo stubbornness
if (ftype == 0 || ftype == 5 || ftype == 6)
warning ("UNO interface will write ODS format for unsupported file extensions")
endif
[ ods, odssupport, lastintf ] = ...
__UNO_spsh_open__ (ods, rw, filename, odssupport);
endif
## if
## <other interfaces here>
if (! odssupport)
## Below message follows after getodsinterfaces
printf ("None.\n");
warning ("odsopen.m: no support for OpenOffice.org .ods I/O");
ods = [];
chkintf = [];
else
# From here on rw is tracked via ods.changed in the various lower
# level r/w routines and it is only used to determine if an informative
# message is to be given when saving a newly created ods file.
ods.changed = rw;
# ods.changed = 0 (existing/only read from), 1 (existing/data added), 2 (new,
# data added) or 3 (pristine, no data added).
# Until something was written to existing files we keep status "unchanged".
if (ods.changed == 1);
ods.changed = 0;
endif
endif
endfunction
|