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
327
|
module CPM.Package.HTML
where
import Char ( isSpace )
import Directory ( doesDirectoryExist, doesFileExist )
import FilePath ( (</>), replaceExtension )
import IOExts ( readCompleteFile )
import List ( find, intersperse, isPrefixOf, splitOn )
import Time ( CalendarTime, calendarTimeToString, getLocalTime )
import HTML.Base
import HTML.Styles.Bootstrap4
import Text.CSV ( readCSV )
import CPM.Package
import CPM.Package.Helpers ( renderPackageInfo )
import CPM.Manage.Config ( cpmDocURL, kics2URL, pakcsURL )
packageToHTML :: [[Package]] -> [Package] -> Package -> IO String
packageToHTML allpkgversions newestpkgs pkg = do
hasapidir <- doesDirectoryExist apiDir
hasaindex <- doesFileExist $ apiDir </> indexhtml
hasreadme <- doesFileExist readmefile
hasreadmei <- doesFileExist readmeifile
readmei <- if hasreadmei then readFile readmeifile else return ""
mbtested <- getTestResults pkgid
let apilinks = (if hasaindex then [ehref (cpmDocURL ++ pkgid </> indexhtml)
[htxt "API documentation"]]
else []) ++
(if hasapidir
then maybe []
(\mref -> [href mref [htxt "Manual (PDF)"]])
(manualURL pkg)
else [])
infomenu = (if hasreadme
then [ehref ("../" ++ readmefile) [htxt "README"]]
else []) ++
[ehref (pkgid ++ ".txt") [htxt "Package specification"]] ++
apilinks
mbdocurl = if hasapidir then Just (cpmDocURL ++ pkgid) else Nothing
sidenav =
[ulistWithClass "list-group" "list-group-item"
(map (\ (t,c) -> (h5 [htxt t] : c))
(packageInfoAsHTML allpkgversions newestpkgs pkg mbdocurl ++
[("Further infos:",
[ulistWithClass "nav flex-column" "nav-item"
(map addNavLink infomenu)])]))] ++
(maybe [] (\s -> [blockstyle "badge badge-success" [htxt s]]) mbtested)
let pkgdesc = (if hasreadmei then [HtmlText readmei] else []) ++
[hrule,
h2 [htxt "Download"],
dlist (map (\ (l,hs) -> ([htxt (l++": ")],hs))
(pkgtarref ++ showPkgSource pkg))]
cpmPackagePage pname sidenav (map addNavLink apilinks) pkgdesc
where
addNavLink h = [h `addClass` "nav-link"]
pname = name pkg
pkgid = packageId pkg
apiDir = "DOC" </> pkgid
indexhtml = "index.html"
readmefile = apiDir </> "README.html"
readmeifile = apiDir </> "README_I.html"
pkgtar = pkgid ++ ".tar.gz"
pkgtarref = [("Checkout with CPM",
[kbdInput [htxt $ "cypm checkout " ++ pname ++ " " ++
showVersion (version pkg)]]),
("Package source",
[ehref (".." </> "PACKAGES" </> pkgtar) [htxt pkgtar],
htxt " [", href (pkgid ++ "-src.html") [htxt "browse"],
htxt "]"])]
getTestResults :: String -> IO (Maybe String)
getTestResults pkgid = do
let testfile = "TEST" </> pkgid ++ ".csv"
hastests <- doesFileExist testfile
if hastests
then do
tinfos <- readCompleteFile testfile >>= return . readCSV
case tinfos of
[_, (_:ct:rc:_)] | rc == "0" -> return $ Just $
"Succesfully tested at " ++ ct
_ -> return Nothing
else return Nothing
manualURL :: Package -> Maybe String
manualURL pkg = case documentation pkg of
Nothing -> Nothing
Just (PackageDocumentation _ docmain _) ->
Just (cpmDocURL ++ packageId pkg </> replaceExtension docmain ".pdf")
packageInfoAsHTML :: [[Package]] -> [Package] -> Package -> Maybe String
-> [(String,[HtmlExp])]
packageInfoAsHTML allpkgversions newestpkgs pkg mbdocurl =
[ ("Synopsis", [ htxt (synopsis pkg) ]) ] ++
cats ++
[ ("Versions", hitems $ map (showPkgVersion pkg) pkgversions)
, ("Dependencies", hitems $ map dep2html $ dependencies pkg)
, ("Author", auth) ] ++
maintnr ++
compilers ++
expmods ++
executable ++
showParaField description "Description" ++
showLicense ++
showParaField copyright "Copyright" ++
showUrlField homepage "Homepage" ++
showUrlField repository "Repository" ++
showUrlField bugReports "Bug reports"
where
pkgversions = maybe []
(map version)
(find (\pg -> not (null pg) && name (head pg) == name pkg)
allpkgversions)
auth = vitems $ map (htxt . strip) (concatMap (splitOn ",") $ author pkg)
maintnr = case maintainer pkg of
[] -> []
xs -> [("Maintainer", vitems $ map htxt (concatMap (splitOn ",") xs))]
cats =
let cats = category pkg
in if null cats
then []
else [("Categor" ++ if length cats == 1 then "y" else "ies",
hitems $
map (\c -> hrefPrimBadge ("../indexc.html#" ++ c) [htxt c])
cats)]
dep2html dep@(Dependency dp vcs) =
maybe (htxt $ showDependency dep)
(\np -> hrefPrimBadge (packageId np ++ ".html")
[htxt dp, nbsp,
showConstraintBadge (showVersionConstraints vcs)])
(find (\p -> name p == dp) newestpkgs)
compilers =
if null (compilerCompatibility pkg)
then []
else [("Compiler requirements",
hitems $ map showCompilerReq $ compilerCompatibility pkg)]
expmods =
if null (exportedModules pkg)
then []
else [("Exported modules",
hitems $
map (\m -> code [maybe (htxt m)
(\u -> ehrefPrimBadge (u </> m ++ ".html")
[htxt m])
mbdocurl])
(exportedModules pkg))]
executable =
maybe []
(\ (PackageExecutable n _ _) ->
[("Executable installed by package", [kbdInput [htxt n]])])
(executableSpec pkg)
showLicense =
let lkind = case license pkg of
Nothing -> []
Just s -> [htxt s]
lfile = case licenseFile pkg of
Nothing -> []
Just f -> [ehref (".." </> "PACKAGES" </> packageId pkg </> f)
[htxt "License file"]]
in [("License", intersperse (htxt " / ") (lkind ++ lfile))]
showUrlField fgetter fname = case fgetter pkg of
Nothing -> []
Just s -> [(fname, [showURL s])]
showParaField fgetter fname = case fgetter pkg of
Nothing -> []
Just s -> [(fname, [htxt s])]
hitems :: [HtmlExp] -> [HtmlExp]
hitems = intersperse (htxt " ")
vitems :: [HtmlExp] -> [HtmlExp]
vitems = intersperse breakline
showPkgVersion :: Package -> Version -> HtmlExp
showPkgVersion pkg v =
(if version pkg == v then hrefPrimBadge else hrefScndBadge)
(name pkg ++ "-" ++ vers ++ ".html") [htxt vers]
where
vers = showVersion v
showPkgSource :: Package -> [(String,[HtmlExp])]
showPkgSource pkg = case source pkg of
Just (Git url _) -> [("Source repository", [showURL url])]
Just (Http url ) -> [("Source", [showURL url])]
_ -> []
showCompilerReq :: CompilerCompatibility -> HtmlExp
showCompilerReq (CompilerCompatibility cc vcs)
| cc == "pakcs"
= ehrefSuccBadge pakcsURL
[htxt cc, nbsp, showConstraintBadge (showVersionConstraints vcs)]
| cc == "kics2"
= ehrefWarnBadge kics2URL
[htxt cc, nbsp, showConstraintBadge (showVersionConstraints vcs)]
| otherwise
= textstyle "badge badge-secondary" (cc ++ " " ++ showVersionConstraints vcs)
showConstraintBadge :: String -> HtmlExp
showConstraintBadge = textstyle "badge badge-light"
showURL :: String -> HtmlExp
showURL s | "http" `isPrefixOf` s = ehref s [htxt s]
| otherwise = htxt s
cpmPackagePage :: String -> [HtmlExp] -> [[HtmlExp]] -> [HtmlExp] -> IO String
cpmPackagePage title sidenav apilinks maindoc = do
let htmltitle = [h1 [smallMutedText "Curry Package ", htxt title]]
time <- getLocalTime
let btbase = "../bt4"
return $ showHtmlPage $
bootstrapPage (favIcon btbase) (cssIncludes btbase) (jsIncludes btbase)
title homeBrand
(leftTopMenu True (-1)) (apilinks ++ rightTopMenu) 4 sidenav
htmltitle maindoc (curryDocFooter time)
smallMutedText :: String -> HtmlExp
smallMutedText s = HtmlStruct "small" [("class","text-muted")] [htxt s]
curryHomeURL :: String
curryHomeURL = "http://www.curry-lang.org"
cpmHomeURL :: String
cpmHomeURL = "http://www.curry-lang.org/tools/cpm"
favIcon :: String -> String
favIcon btdir = btdir </> "img" </> "favicon.ico"
cssIncludes :: String -> [String]
cssIncludes btdir =
map (\n -> btdir </> "css" </> n ++ ".css") ["bootstrap.min","cpm"]
jsIncludes :: String -> [String]
jsIncludes btdir =
["https://code.jquery.com/jquery-3.4.1.slim.min.js",
btdir </> "js/bootstrap.bundle.min.js"]
homeBrand :: (String,[HtmlExp])
homeBrand = (cpmHomeURL, [htxt "Curry Package Repository"])
leftTopMenu :: Bool -> Int -> [[HtmlExp]]
inpkg actindex =
[ [mhref 0 "index.html" "Packages"]
, [mhref 1 "indexv.html" "Versions"]
, [mhref 2 "indexc.html" "Categories"]
]
where
mhref i url txt = (if i == actindex then hrefNavActive else hrefNav)
(if inpkg then ".." </> url else url) [htxt txt]
rightTopMenu :: [[HtmlExp]]
=
[ [ehrefNav curryHomeURL [htxt "Curry Homepage"]]
]
curryDocFooter :: CalendarTime -> [HtmlExp]
time =
[italic [htxt "Generated by cpm-manage at ",
htxt (calendarTimeToString time)]]
borderedTable :: [[[HtmlExp]]] -> HtmlExp
borderedTable rows =
table rows `addClass` "table table-bordered table-hover"
borderedHeadedTable :: [[HtmlExp]] -> [[[HtmlExp]]] -> HtmlExp
borderedHeadedTable headrow rows =
headedTable headrow rows `addClass` "table table-bordered table-hover"
headedTable :: [[HtmlExp]] -> [[[HtmlExp]]] -> HtmlExp
headedTable headrow items =
HtmlStruct "table" []
[HtmlStruct "thead" [("class","thead-light")] [toRow "th" headrow],
HtmlStruct "tbody" [] (map (toRow "td") items)]
where
toRow ti row = HtmlStruct "tr" [] (map (\item -> HtmlStruct ti [] item) row)
strip :: String -> String
strip = reverse . dropWhile isSpace . reverse . dropWhile isSpace
|