1 /*
2  * Copyright (C) 2010 Google Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef FileWriter_h
32 #define FileWriter_h
33 
34 #if ENABLE(FILE_SYSTEM)
35 
36 #include "ActiveDOMObject.h"
37 #include "EventTarget.h"
38 #include "FileWriterBase.h"
39 #include "ScriptExecutionContext.h"
40 #include <wtf/PassRefPtr.h>
41 #include <wtf/RefPtr.h>
42 
43 namespace WebCore {
44 
45 class ScriptExecutionContext;
46 
47 class FileWriter : public FileWriterBase, public ActiveDOMObject, public EventTarget, public AsyncFileWriterClient {
48 public:
create(ScriptExecutionContext * context)49     static PassRefPtr<FileWriter> create(ScriptExecutionContext* context)
50     {
51         return adoptRef(new FileWriter(context));
52     }
53 
54     enum ReadyState {
55         INIT = 0,
56         WRITING = 1,
57         DONE = 2
58     };
59 
60     void write(Blob*, ExceptionCode&);
61     void seek(long long position, ExceptionCode&);
62     void truncate(long long length, ExceptionCode&);
63     void abort(ExceptionCode&);
readyState()64     ReadyState readyState() const { return m_readyState; }
error()65     FileError* error() const { return m_error.get(); }
66 
67     // AsyncFileWriterClient
68     void didWrite(long long bytes, bool complete);
69     void didTruncate();
70     void didFail(FileError::ErrorCode);
71 
72     // ActiveDOMObject
73     virtual bool canSuspend() const;
74     virtual bool hasPendingActivity() const;
75     virtual void stop();
76 
77     // EventTarget
toFileWriter()78     virtual FileWriter* toFileWriter() { return this; }
scriptExecutionContext()79     virtual ScriptExecutionContext* scriptExecutionContext() const { return ActiveDOMObject::scriptExecutionContext(); }
80 
81     using RefCounted<FileWriterBase>::ref;
82     using RefCounted<FileWriterBase>::deref;
83 
84     DEFINE_ATTRIBUTE_EVENT_LISTENER(writestart);
85     DEFINE_ATTRIBUTE_EVENT_LISTENER(progress);
86     DEFINE_ATTRIBUTE_EVENT_LISTENER(write);
87     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
88     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
89     DEFINE_ATTRIBUTE_EVENT_LISTENER(writeend);
90 
91 private:
92     FileWriter(ScriptExecutionContext*);
93 
94     virtual ~FileWriter();
95 
96     // EventTarget
refEventTarget()97     virtual void refEventTarget() { ref(); }
derefEventTarget()98     virtual void derefEventTarget() { deref(); }
eventTargetData()99     virtual EventTargetData* eventTargetData() { return &m_eventTargetData; }
ensureEventTargetData()100     virtual EventTargetData* ensureEventTargetData() { return &m_eventTargetData; }
101 
102     void fireEvent(const AtomicString& type);
103 
104     void setError(FileError::ErrorCode, ExceptionCode&);
105 
106     void signalCompletion(FileError::ErrorCode);
107 
108     class FileWriterCompletionEventTask : public ScriptExecutionContext::Task {
109     public:
create(PassRefPtr<FileWriter> fileWriter,FileError::ErrorCode code)110         static PassOwnPtr<FileWriterCompletionEventTask> create(PassRefPtr<FileWriter> fileWriter, FileError::ErrorCode code)
111         {
112             return adoptPtr(new FileWriterCompletionEventTask(fileWriter, code));
113         }
114 
115 
performTask(ScriptExecutionContext *)116         virtual void performTask(ScriptExecutionContext*)
117         {
118             m_fileWriter->signalCompletion(m_code);
119         }
120     private:
FileWriterCompletionEventTask(PassRefPtr<FileWriter> fileWriter,FileError::ErrorCode code)121         FileWriterCompletionEventTask(PassRefPtr<FileWriter> fileWriter, FileError::ErrorCode code)
122             : m_fileWriter(fileWriter)
123             , m_code(code)
124         {
125         }
126 
127         RefPtr<FileWriter> m_fileWriter;
128         FileError::ErrorCode m_code;
129     };
130 
131     RefPtr<FileError> m_error;
132     EventTargetData m_eventTargetData;
133     ReadyState m_readyState;
134     bool m_startedWriting;
135     long long m_bytesWritten;
136     long long m_bytesToWrite;
137     long long m_truncateLength;
138     RefPtr<Blob> m_blobBeingWritten;
139 };
140 
141 } // namespace WebCore
142 
143 #endif // ENABLE(FILE_SYSTEM)
144 
145 #endif // FileWriter_h
146