|
1 /* |
|
2 * Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the License "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Methods used to translated CFolderItems back into opml files. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #include "OpmlWriter.h" |
|
20 |
|
21 #include <EscapeUtils.h> |
|
22 |
|
23 _LIT(KTempDirName, "c:\\system\\temp\\"); |
|
24 |
|
25 // Private conts. |
|
26 _LIT8(KUtf8, "utf8"); |
|
27 _LIT8(KOpml, "opml"); |
|
28 _LIT8(KVersion, "version"); |
|
29 _LIT8(K1, "1.0"); |
|
30 |
|
31 _LIT8(KHead, "head"); |
|
32 _LIT8(KTitle, "title"); |
|
33 _LIT8(KTitleValue, "S60 Feeds Client - Feed Subscriptions"); |
|
34 |
|
35 _LIT8(KBody, "body"); |
|
36 _LIT8(KOutline, "outline"); |
|
37 _LIT8(KText, "text"); |
|
38 _LIT8(KXmlUrl, "xmlUrl"); |
|
39 _LIT8(KType, "type"); |
|
40 _LIT16(KTypeValue, "rss"); |
|
41 |
|
42 const TInt KMaxFolderItemTitleLength = 256; |
|
43 const TInt KMaxFolderItemURLLength = 256; |
|
44 |
|
45 |
|
46 // ----------------------------------------------------------------------------- |
|
47 // OpmlWriter::WriteFolderItemL |
|
48 // |
|
49 // Writes the FolderItem and all of its child to the given file. |
|
50 // ----------------------------------------------------------------------------- |
|
51 // |
|
52 void OpmlWriter::WriteFolderItemL(xmlTextWriterPtr aWriter, TInt aFolderItemId, CFeedsDatabase &aFeedsDatabase) |
|
53 { |
|
54 TInt rc; |
|
55 TBool isFolder; |
|
56 HBufC* FolderItemTitle = HBufC::NewLC(KMaxFolderItemTitleLength); |
|
57 HBufC* FolderItemURL = HBufC::NewLC(KMaxFolderItemURLLength); |
|
58 |
|
59 aFeedsDatabase.FolderItemInfoL(aFolderItemId, isFolder, FolderItemTitle, FolderItemURL); |
|
60 |
|
61 // Write out a single entry. |
|
62 if(!isFolder) |
|
63 { |
|
64 // Open the opml element. |
|
65 rc = xmlTextWriterStartElement(aWriter, BAD_CAST(KOutline().Ptr())); |
|
66 if (rc < 0) |
|
67 { |
|
68 User::Leave(KErrCorrupt); |
|
69 } |
|
70 |
|
71 // Write out the text attribute. |
|
72 if (FolderItemTitle->Length() != 0) |
|
73 { |
|
74 WriteAttributeL(aWriter, KText(), *FolderItemTitle); |
|
75 } |
|
76 |
|
77 // Write out the XmlUrl attribute. |
|
78 if (FolderItemURL->Length() != 0) |
|
79 { |
|
80 WriteAttributeL(aWriter, KXmlUrl(), *FolderItemURL); |
|
81 } |
|
82 |
|
83 WriteAttributeL(aWriter, KType(), KTypeValue()); |
|
84 |
|
85 // Close the outline element. |
|
86 rc = xmlTextWriterEndElement(aWriter); |
|
87 if (rc < 0) |
|
88 { |
|
89 User::Leave(KErrCorrupt); |
|
90 } |
|
91 } |
|
92 // Otherwise write it and its children. |
|
93 else |
|
94 { |
|
95 |
|
96 rc = xmlTextWriterStartElement(aWriter, BAD_CAST(KOutline().Ptr())); |
|
97 if (rc < 0) |
|
98 { |
|
99 User::Leave(KErrCorrupt); |
|
100 } |
|
101 |
|
102 // Write out the text attribute. |
|
103 if (FolderItemTitle->Length() != 0) |
|
104 { |
|
105 WriteAttributeL(aWriter, KText(), *FolderItemTitle); |
|
106 } |
|
107 |
|
108 RArray<TInt> Children; |
|
109 CleanupClosePushL(Children); |
|
110 |
|
111 aFeedsDatabase.FolderItemGetChildrenL(aFolderItemId, Children); |
|
112 |
|
113 // Write out each child. |
|
114 for (TInt i = 0; i < Children.Count(); i++) |
|
115 { |
|
116 WriteFolderItemL(aWriter, Children[i], aFeedsDatabase); |
|
117 } |
|
118 |
|
119 CleanupStack::PopAndDestroy(/*Children*/); |
|
120 |
|
121 rc = xmlTextWriterEndElement(aWriter); |
|
122 if (rc < 0) |
|
123 { |
|
124 User::Leave(KErrCorrupt); |
|
125 } |
|
126 } |
|
127 |
|
128 CleanupStack::PopAndDestroy(/*FolderItemURL*/); |
|
129 CleanupStack::PopAndDestroy(/*FolderItemTitle*/); |
|
130 } |
|
131 |
|
132 |
|
133 // ----------------------------------------------------------------------------- |
|
134 // OpmlWriter::WriteAttributeL |
|
135 // |
|
136 // Writes out a attribute. |
|
137 // ----------------------------------------------------------------------------- |
|
138 // |
|
139 void OpmlWriter::WriteAttributeL(xmlTextWriterPtr aWriter, const TDesC8& aName, |
|
140 const TDesC& aValue) |
|
141 { |
|
142 TInt rc; |
|
143 HBufC8* utf8 = NULL; |
|
144 HBufC8* utf8Zero = NULL; |
|
145 |
|
146 // Convert it to utf8. |
|
147 utf8 = EscapeUtils::ConvertFromUnicodeToUtf8L(aValue); |
|
148 CleanupStack::PushL(utf8); |
|
149 utf8Zero = HBufC8::NewL(utf8->Length() + 1); |
|
150 utf8Zero->Des().Copy(*utf8); |
|
151 utf8Zero->Des().ZeroTerminate(); |
|
152 CleanupStack::PushL(utf8Zero); |
|
153 |
|
154 // Add the attribute. |
|
155 rc = xmlTextWriterWriteAttribute(aWriter, BAD_CAST(aName.Ptr()), utf8Zero->Ptr()); |
|
156 |
|
157 CleanupStack::PopAndDestroy(utf8Zero); |
|
158 CleanupStack::PopAndDestroy(utf8); |
|
159 if (rc < 0) |
|
160 { |
|
161 User::Leave(KErrCorrupt); |
|
162 } |
|
163 } |
|
164 |
|
165 |
|
166 // ----------------------------------------------------------------------------- |
|
167 // OpmlWriter::ExportL |
|
168 // |
|
169 // Export all specified folders (by FolderItemIDs) to an OPML file |
|
170 // ----------------------------------------------------------------------------- |
|
171 // |
|
172 void OpmlWriter::ExportL(RArray<TInt> &aFolderItemIDs, const TDesC& aExportFileName) |
|
173 { |
|
174 |
|
175 RFs rfs; |
|
176 RFile OPMLFile; |
|
177 TInt rc; |
|
178 xmlTextWriterPtr writer = NULL; |
|
179 xmlBufferPtr buf = NULL; |
|
180 |
|
181 if(aFolderItemIDs.Count()<=0 || aExportFileName.Length()<=0) |
|
182 { |
|
183 User::Leave(KErrCorrupt); |
|
184 } |
|
185 |
|
186 // Create a new XML buffer, to which the XML document will be |
|
187 // written. |
|
188 buf = xmlBufferCreate(); |
|
189 User::LeaveIfNull(buf); |
|
190 CleanupLibXml2::PushL(buf); |
|
191 |
|
192 // Create a new XmlWriter for memory. |
|
193 writer = xmlNewTextWriterMemory(buf, 0); |
|
194 User::LeaveIfNull(writer); |
|
195 CleanupLibXml2::PushL(writer); |
|
196 |
|
197 xmlTextWriterSetIndent(writer, 4); |
|
198 |
|
199 // Start the document. |
|
200 rc = xmlTextWriterStartDocument(writer, NULL, (const char*) KUtf8().Ptr(), NULL); |
|
201 if (rc < 0) |
|
202 { |
|
203 User::Leave(KErrCorrupt); |
|
204 } |
|
205 |
|
206 // Open the opml element with its version. |
|
207 rc = xmlTextWriterStartElement(writer, BAD_CAST(KOpml().Ptr())); |
|
208 if (rc < 0) |
|
209 { |
|
210 User::Leave(KErrCorrupt); |
|
211 } |
|
212 |
|
213 rc = xmlTextWriterWriteAttribute(writer, BAD_CAST(KVersion().Ptr()), BAD_CAST(K1().Ptr())); |
|
214 if (rc < 0) |
|
215 { |
|
216 User::Leave(KErrCorrupt); |
|
217 } |
|
218 |
|
219 rc = xmlTextWriterStartElement(writer, BAD_CAST(KHead().Ptr())); |
|
220 if (rc < 0) |
|
221 { |
|
222 User::Leave(KErrCorrupt); |
|
223 } |
|
224 |
|
225 rc = xmlTextWriterStartElement(writer, BAD_CAST(KTitle().Ptr())); |
|
226 if (rc < 0) |
|
227 { |
|
228 User::Leave(KErrCorrupt); |
|
229 } |
|
230 |
|
231 rc = xmlTextWriterWriteFormatRaw(writer, "%s", KTitleValue().Ptr()); |
|
232 if (rc < 0) |
|
233 { |
|
234 User::Leave(KErrCorrupt); |
|
235 } |
|
236 |
|
237 rc = xmlTextWriterEndElement(writer); |
|
238 if (rc < 0) |
|
239 { |
|
240 User::Leave(KErrCorrupt); |
|
241 } |
|
242 |
|
243 |
|
244 rc = xmlTextWriterEndElement(writer); |
|
245 if (rc < 0) |
|
246 { |
|
247 User::Leave(KErrCorrupt); |
|
248 } |
|
249 |
|
250 // Open the body element. |
|
251 rc = xmlTextWriterStartElement(writer, BAD_CAST(KBody().Ptr())); |
|
252 if (rc < 0) |
|
253 { |
|
254 User::Leave(KErrCorrupt); |
|
255 } |
|
256 |
|
257 TBool created; |
|
258 CFeedsDatabase *FeedsDatabase = CFeedsDatabase::NewL(NULL,created); |
|
259 CleanupStack::PushL(FeedsDatabase); |
|
260 |
|
261 // Write out the folder. |
|
262 for(TInt i=0; i<aFolderItemIDs.Count(); i++) |
|
263 { |
|
264 WriteFolderItemL(writer, aFolderItemIDs[i], *FeedsDatabase); |
|
265 } |
|
266 |
|
267 CleanupStack::PopAndDestroy(/*FeedsDatabase*/); |
|
268 // Close the body element. |
|
269 rc = xmlTextWriterEndElement(writer); |
|
270 if (rc < 0) |
|
271 { |
|
272 User::Leave(KErrCorrupt); |
|
273 } |
|
274 |
|
275 // Close the opml element. |
|
276 rc = xmlTextWriterEndElement(writer); |
|
277 if (rc < 0) |
|
278 { |
|
279 User::Leave(KErrCorrupt); |
|
280 } |
|
281 |
|
282 (void) xmlTextWriterFlush(writer); |
|
283 |
|
284 // Write the buffer to the file. |
|
285 TPtrC8 ptr(buf->content, buf->use); |
|
286 |
|
287 TBuf<KMaxFileName> path(KTempDirName); |
|
288 path.Append(aExportFileName.Mid(0, Min(aExportFileName.Length(), (KMaxFileName - path.Length())))); |
|
289 |
|
290 User::LeaveIfError(rfs.Connect()); |
|
291 CleanupClosePushL(rfs); |
|
292 |
|
293 User::LeaveIfError(OPMLFile.Replace(rfs, path, EFileShareExclusive|EFileWrite)); |
|
294 |
|
295 CleanupClosePushL(OPMLFile); |
|
296 |
|
297 OPMLFile.Write(ptr); |
|
298 |
|
299 // Clean up. |
|
300 CleanupStack::PopAndDestroy(/*OPMLFile*/); |
|
301 CleanupStack::PopAndDestroy(/*rfs*/); |
|
302 |
|
303 CleanupStack::PopAndDestroy(/*writer*/); |
|
304 CleanupStack::PopAndDestroy(/*buf*/); |
|
305 |
|
306 } |