From 3729eaea50b9d397b76a2db3f71683f1c28c0c60 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Wed, 27 Jan 2021 14:58:27 +0100 Subject: [PATCH 01/17] Fix path --- static/swagger-ui/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/swagger-ui/index.html b/static/swagger-ui/index.html index 0ef6266..1ac3b5d 100644 --- a/static/swagger-ui/index.html +++ b/static/swagger-ui/index.html @@ -39,7 +39,7 @@ window.onload = function() { // Begin Swagger UI call region const ui = SwaggerUIBundle({ - url: "http://127.0.0.1:3000/swagger.json", + url: "/swagger.json", dom_id: '#swagger-ui', deepLinking: true, presets: [ From 301343e3a225a6066cd299b25c199806f16ae36c Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Fri, 5 Feb 2021 11:31:03 +0100 Subject: [PATCH 02/17] Remove warnings --- Handler/ShowChallenge.hs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index 470e865..9e00cf5 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -816,23 +816,23 @@ getAddUserR = do Nothing -> return $ Bool False getChallengeAllSubmissionsJsonR :: Text -> Handler Value -getChallengeAllSubmissionsJsonR name = do - v <- fetchAllSubmissionsView name +getChallengeAllSubmissionsJsonR challengeName = do + v <- fetchAllSubmissionsView challengeName return $ toJSON v getChallengeMySubmissionsJsonR :: Text -> Handler Value -getChallengeMySubmissionsJsonR name = do - v <- fetchMySubmissionsView name +getChallengeMySubmissionsJsonR challengeName = do + v <- fetchMySubmissionsView challengeName return $ toJSON v fetchAllSubmissionsView :: Text -> Handler SubmissionsView -fetchAllSubmissionsView name = do - fetchChallengeSubmissionsView (const True) name +fetchAllSubmissionsView challengeName = do + fetchChallengeSubmissionsView (const True) challengeName fetchMySubmissionsView :: Text -> Handler SubmissionsView -fetchMySubmissionsView name = do +fetchMySubmissionsView challengeName = do Entity userId _ <- requireAuthPossiblyByToken - fetchChallengeSubmissionsView (\(Entity _ submission) -> (submissionSubmitter submission == userId)) name + fetchChallengeSubmissionsView (\(Entity _ submission) -> (submissionSubmitter submission == userId)) challengeName convertTagInfoToView :: (Entity Import.Tag, Entity SubmissionTag) -> TagView convertTagInfoToView tagInfo = From 98325e47b62c726c499d265abebca1b505ac8435 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Fri, 5 Feb 2021 14:44:46 +0100 Subject: [PATCH 03/17] More swagger --- Handler/ShowChallenge.hs | 104 +++++++++++++++++++++++++++++++++++++++ Handler/Swagger.hs | 2 +- Handler/Tables.hs | 23 +++++++-- 3 files changed, 125 insertions(+), 4 deletions(-) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index 9e00cf5..67f79d9 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -815,6 +815,39 @@ getAddUserR = do return $ Bool True Nothing -> return $ Bool False +declareAllSubmissionsApi :: String -> String -> Declare (Definitions Schema) Swagger +declareAllSubmissionsApi q d = do + -- param schemas + let challengeNameSchema = toParamSchema (Proxy :: Proxy String) + + allSubmissionsResponse <- declareResponse (Proxy :: Proxy SubmissionsView) + + return $ mempty + & paths .~ + fromList [ ("/api/" ++ q ++ "/{challengeName}", + mempty & DS.get ?~ (mempty + & parameters .~ [ Inline $ mempty + & name .~ "challengeName" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamPath + & paramSchema .~ challengeNameSchema) ] + & produces ?~ MimeList ["application/json"] + & description ?~ "d" + & at 200 ?~ Inline allSubmissionsResponse)) + ] + + +allSubmissionsApi :: Swagger +allSubmissionsApi = spec & definitions .~ defs + where + (defs, spec) = runDeclare (declareAllSubmissionsApi "challenge-all-submissions" "Returns all submissions for a challenge") mempty + +mySubmissionsApi :: Swagger +mySubmissionsApi = spec & definitions .~ defs + where + (defs, spec) = runDeclare (declareAllSubmissionsApi "challenge-my-submissions" "Returns all submissions for a challenge for the user") mempty + getChallengeAllSubmissionsJsonR :: Text -> Handler Value getChallengeAllSubmissionsJsonR challengeName = do v <- fetchAllSubmissionsView challengeName @@ -918,6 +951,21 @@ instance ToJSON EvaluationView where , "test" .= evaluationViewTest e ] +instance ToSchema EvaluationView where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + doubleSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy Double) + testRefSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy TestReference) + return $ NamedSchema (Just "Evaluation") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("score", stringSchema) + , ("full-score", doubleSchema) + , ("test", testRefSchema) + ] + & required .~ [ "score", "full-score", "test" ] + + data TagView = TagView { tagViewName :: Text, tagViewDescription :: Maybe Text, @@ -930,6 +978,20 @@ instance ToJSON TagView where , "accepted" .= tagViewAccepted t ] +instance ToSchema TagView where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + boolSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy Bool) + return $ NamedSchema (Just "Tag") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("name", stringSchema) + , ("description", stringSchema) + , ("accepted", boolSchema) + ] + & required .~ [ "name", "description" ] + + data SubmissionView = SubmissionView { submissionViewId :: Int64, submissionViewVariantId :: Int64, @@ -965,6 +1027,36 @@ instance ToJSON SubmissionView where , "isPublic" .= submissionViewIsPublic s ] +instance ToSchema SubmissionView where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + boolSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy Bool) + intSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy Int) + intsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [Int]) + tagsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [TagView]) + evalsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [EvaluationView]) + return $ NamedSchema (Just "SubmissionView") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("id", intSchema) + , ("variant", intSchema) + , ("rank", intSchema) + , ("submitter", stringSchema) + , ("when", stringSchema) + , ("version", intsSchema) + , ("description", stringSchema) + , ("tags", tagsSchema) + , ("hash", stringSchema) + , ("evaluations", evalsSchema) + , ("isOwner", boolSchema) + , ("isReevaluable", boolSchema) + , ("isVisible", boolSchema) + , ("isPublic", boolSchema) + ] + & required .~ [ "id", "variant", "rank", "submitter", "when", "version", + "description", "tags", "hash", "evaluations", + "isOwner", "isReevaluable", "isVisible", "isPublic" ] + data SubmissionsView = SubmissionsView { submissionsViewSubmissions :: [SubmissionView], submissionsViewTests :: [TestReference] @@ -976,6 +1068,18 @@ instance ToJSON SubmissionsView where "submissions" .= submissionsViewSubmissions ss ] +instance ToSchema SubmissionsView where + declareNamedSchema _ = do + submissionViewsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [SubmissionView]) + testRefsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [TestReference]) + return $ NamedSchema (Just "Tag") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("tests", submissionViewsSchema) + , ("submissions", testRefsSchema) + ] + & required .~ [ "tests", "submission" ] + getChallengeSubmissions :: ((Entity Submission) -> Bool) -> Text -> Handler Html getChallengeSubmissions condition name = do Entity challengeId challenge <- runDB $ getBy404 $ UniqueName name diff --git a/Handler/Swagger.hs b/Handler/Swagger.hs index 5d8ee01..fa75447 100644 --- a/Handler/Swagger.hs +++ b/Handler/Swagger.hs @@ -12,7 +12,7 @@ getSwaggerR :: Handler Value getSwaggerR = return $ toJSON apiDescription apiDescription :: Swagger -apiDescription = generalApi <> listChallengesApi <> leaderboardApi +apiDescription = generalApi <> listChallengesApi <> leaderboardApi <> allSubmissionsApi <> mySubmissionsApi generalApi :: Swagger generalApi = (mempty :: Swagger) diff --git a/Handler/Tables.hs b/Handler/Tables.hs index 893fc66..74193f8 100644 --- a/Handler/Tables.hs +++ b/Handler/Tables.hs @@ -29,6 +29,13 @@ import GEval.EvaluationScheme import GEval.ParseParams (parseParamsFromFilePath, OutputFileParsed(..)) +import Data.Swagger hiding (get) +import qualified Data.Swagger as DS +import Data.Swagger.Declare +import Data.Proxy as DPR +import Control.Lens hiding ((.=), (^.)) +import Data.HashMap.Strict.InsOrd (fromList) + data TestReference = TestReference Text Text deriving (Show, Eq, Ord) @@ -38,6 +45,16 @@ instance ToJSON TestReference where "metric" .= metric ] +instance ToSchema TestReference where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + return $ NamedSchema (Just "TestReference") $ mempty + & type_ .~ SwaggerObject + & properties .~ + Data.HashMap.Strict.InsOrd.fromList [ ("name", stringSchema) + , ("metric", stringSchema) + ] + & required .~ [ "name", "metric" ] getTestReference :: Entity Test -> TestReference getTestReference (Entity _ test) = TestReference (Data.Text.pack $ show $ testMetric test) (testName test) @@ -51,7 +68,7 @@ data LeaderboardEntry = LeaderboardEntry { leaderboardBestVariantId :: VariantId, leaderboardEvaluationMap :: Map TestReference Evaluation, leaderboardNumberOfSubmissions :: Int, - leaderboardTags :: [(Entity Tag, Entity SubmissionTag)], + leaderboardTags :: [(Entity Import.Tag, Entity SubmissionTag)], leaderboardParams :: [Parameter], leaderboardVersion :: (Int, Int, Int) } @@ -61,7 +78,7 @@ data TableEntry = TableEntry { tableEntryVariant :: Entity Variant, tableEntrySubmitter :: Entity User, tableEntryMapping :: Map TestReference Evaluation, - tableEntryTagsInfo :: [(Entity Tag, Entity SubmissionTag)], + tableEntryTagsInfo :: [(Entity Import.Tag, Entity SubmissionTag)], tableEntryParams :: [Entity Parameter], tableEntryRank :: Int, tableEntryVersion :: (Int, Int, Int) } @@ -456,7 +473,7 @@ getScore testId variantId = do data BasicSubmissionInfo = BasicSubmissionInfo { basicSubmissionInfoUser :: User, - basicSubmissionInfoTagEnts :: [(Entity Tag, Entity SubmissionTag)], + basicSubmissionInfoTagEnts :: [(Entity Import.Tag, Entity SubmissionTag)], basicSubmissionInfoVersion :: Version } getBasicSubmissionInfo :: (MonadIO m, PersistQueryRead backend, From 07be72d0cc07f134e352a9a0f65a4e641fb82a2b Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 8 Feb 2021 12:27:44 +0100 Subject: [PATCH 04/17] API for returning Challenge README --- Foundation.hs | 1 + Handler/ShowChallenge.hs | 48 +++++++++++++++++++++++++++++++++------- Handler/Swagger.hs | 7 +++++- config/routes | 3 ++- 4 files changed, 49 insertions(+), 10 deletions(-) diff --git a/Foundation.hs b/Foundation.hs index dcae53b..c991de8 100644 --- a/Foundation.hs +++ b/Foundation.hs @@ -174,6 +174,7 @@ instance Yesod App where isAuthorized AddUserR _ = return Authorized isAuthorized UserInfoR _ = return Authorized isAuthorized (ChallengeSubmissionJsonR _) _ = return Authorized + isAuthorized (ChallengeReadmeInMarkdownR _) _ = regularAuthorization isAuthorized (ChallengeGraphDataR _) _ = regularAuthorization isAuthorized (ChallengeDiscussionR _) _ = regularAuthorization diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index 67f79d9..00beb09 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -187,19 +187,51 @@ hasMetricsOfSecondPriority challengeId = do getChallengeReadmeR :: Text -> Handler Html -getChallengeReadmeR name = do - (Entity _ challenge) <- runDB $ getBy404 $ UniqueName name - readme <- challengeReadme name +getChallengeReadmeR challengeName = do + (Entity _ challenge) <- runDB $ getBy404 $ UniqueName challengeName + readme <- challengeReadme challengeName challengeLayout False challenge $ toWidget readme -challengeReadme :: Text -> HandlerFor App Html -challengeReadme name = do - (Entity _ challenge) <- runDB $ getBy404 $ UniqueName name +challengeReadmeInMarkdownApi :: Swagger +challengeReadmeInMarkdownApi = spec & definitions .~ defs + where + (defs, spec) = runDeclare declareChallengeReadmeInMarkdownSwagger mempty + +declareChallengeReadmeInMarkdownSwagger :: Declare (Definitions Schema) Swagger +declareChallengeReadmeInMarkdownSwagger = do + -- param schemas + let challengeNameSchema = toParamSchema (Proxy :: Proxy String) + + return $ mempty + & paths .~ + fromList [ ("/api/challenge-readme/{challengeName}/markdown", + mempty & DS.get ?~ (mempty + & parameters .~ [ Inline $ mempty + & name .~ "challengeName" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamPath + & paramSchema .~ challengeNameSchema) ] + & produces ?~ MimeList ["application/text"] + & description ?~ "Returns the challenge README in Markdown")) + ] + +getChallengeReadmeInMarkdownR :: Text -> Handler TL.Text +getChallengeReadmeInMarkdownR challengeName = doChallengeReadmeContents challengeName + +challengeReadme :: Text -> Handler Html +challengeReadme challengeName = do + theContents <- doChallengeReadmeContents challengeName + return $ markdown def theContents + +doChallengeReadmeContents :: Text -> Handler TL.Text +doChallengeReadmeContents challengeName = do + (Entity _ challenge) <- runDB $ getBy404 $ UniqueName challengeName let repoId = challengePublicRepo challenge repoDir <- getRepoDir repoId let readmeFilePath = repoDir readmeFile theContents <- liftIO $ System.IO.readFile readmeFilePath - return $ markdown def $ TL.pack theContents + return $ TL.pack theContents showChallengeWidget :: Maybe (Entity User) -> Entity Challenge @@ -833,7 +865,7 @@ declareAllSubmissionsApi q d = do & in_ .~ ParamPath & paramSchema .~ challengeNameSchema) ] & produces ?~ MimeList ["application/json"] - & description ?~ "d" + & description ?~ T.pack d & at 200 ?~ Inline allSubmissionsResponse)) ] diff --git a/Handler/Swagger.hs b/Handler/Swagger.hs index fa75447..7db76d1 100644 --- a/Handler/Swagger.hs +++ b/Handler/Swagger.hs @@ -12,7 +12,12 @@ getSwaggerR :: Handler Value getSwaggerR = return $ toJSON apiDescription apiDescription :: Swagger -apiDescription = generalApi <> listChallengesApi <> leaderboardApi <> allSubmissionsApi <> mySubmissionsApi +apiDescription = generalApi + <> listChallengesApi + <> leaderboardApi + <> allSubmissionsApi + <> mySubmissionsApi + <> challengeReadmeInMarkdownApi generalApi :: Swagger generalApi = (mempty :: Swagger) diff --git a/config/routes b/config/routes index a186c71..c55a0cf 100644 --- a/config/routes +++ b/config/routes @@ -18,8 +18,9 @@ /api/user-info UserInfoR GET /api/add-user AddUserR GET /api/challenge-submission/#Text ChallengeSubmissionJsonR POST -/list-archived-challenges ListArchivedChallengesR GET +/api/challenge-readme/#Text/markdown ChallengeReadmeInMarkdownR GET /challenge-image/#ChallengeId ChallengeImageR GET +/list-archived-challenges ListArchivedChallengesR GET /challenge/#Text ShowChallengeR GET /challenge-readme/#Text ChallengeReadmeR GET From 25761dbcf6e37c097c2b654f4a09ba007a29e726 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 8 Feb 2021 18:12:02 +0100 Subject: [PATCH 05/17] Fix some warnings --- Handler/ShowChallenge.hs | 116 ++++++++++++++++++------------------- templates/challenge.hamlet | 2 +- 2 files changed, 59 insertions(+), 59 deletions(-) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index 00beb09..c74cfd2 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -125,11 +125,11 @@ leaderboardApi = spec & definitions .~ defs getLeaderboardJsonR :: Text -> Handler Value -getLeaderboardJsonR name = do +getLeaderboardJsonR challengeName = do app <- getYesod let leaderboardStyle = appLeaderboardStyle $ appSettings app - Entity challengeId _ <- runDB $ getBy404 $ UniqueName name + Entity challengeId _ <- runDB $ getBy404 $ UniqueName challengeName (leaderboard, (_, tests)) <- getLeaderboardEntries 1 leaderboardStyle challengeId return $ array $ map (leaderboardEntryJson tests) leaderboard @@ -142,11 +142,11 @@ leaderboardEntryJson tests entry = object [ "score" .= (formatTruncatedScore (getTestFormattingOpts t) $ extractScoreFromLeaderboardEntry (getTestReference e) entry)]) tests] getShowChallengeR :: Text -> Handler Html -getShowChallengeR name = do +getShowChallengeR challengeName = do app <- getYesod let leaderboardStyle = appLeaderboardStyle $ appSettings app - challengeEnt@(Entity challengeId challenge) <- runDB $ getBy404 $ UniqueName name + challengeEnt@(Entity challengeId challenge) <- runDB $ getBy404 $ UniqueName challengeName Just repo <- runDB $ get $ challengePublicRepo challenge (leaderboard, (entries, tests)) <- getLeaderboardEntries 1 leaderboardStyle challengeId @@ -264,16 +264,16 @@ showChallengeWidget mUserEnt getRepoLink :: Repo -> Maybe Text getRepoLink repo - | sitePrefix `isPrefixOf` url = Just $ (browsableGitRepo bareRepoName) ++ "/" ++ (repoBranch repo) + | sitePrefix `isPrefixOf` theUrl = Just $ (browsableGitRepo bareRepoName) ++ "/" ++ (repoBranch repo) | otherwise = Nothing where sitePrefix = "git://gonito.net/" :: Text sitePrefixLen = length sitePrefix - url = repoUrl repo - bareRepoName = drop sitePrefixLen url + theUrl = repoUrl repo + bareRepoName = drop sitePrefixLen theUrl getChallengeHowToR :: Text -> Handler Html -getChallengeHowToR name = do - (Entity _ challenge) <- runDB $ getBy404 $ UniqueName name +getChallengeHowToR challengeName = do + (Entity _ challenge) <- runDB $ getBy404 $ UniqueName challengeName maybeUser <- maybeAuth app <- getYesod @@ -350,8 +350,8 @@ archiveForm :: ChallengeId -> Form ChallengeId archiveForm challengeId = renderBootstrap3 BootstrapBasicForm $ areq hiddenField "" (Just challengeId) getChallengeSubmissionR :: Text -> Handler Html -getChallengeSubmissionR name = do - (Entity _ challenge) <- runDB $ getBy404 $ UniqueName name +getChallengeSubmissionR challengeName = do + (Entity _ challenge) <- runDB $ getBy404 $ UniqueName challengeName maybeUser <- maybeAuth Just repo <- runDB $ get $ challengePublicRepo challenge @@ -360,16 +360,16 @@ getChallengeSubmissionR name = do let repoHost = appRepoHost $ appSettings app let defaultUrl = fromMaybe (defaultRepo scheme repoHost challenge repo maybeUser) - ((<> name) <$> (join $ userAltRepoScheme <$> entityVal <$> maybeUser)) + ((<> challengeName) <$> (join $ userAltRepoScheme <$> entityVal <$> maybeUser)) (formWidget, formEnctype) <- generateFormPost $ submissionForm (Just defaultUrl) (defaultBranch scheme) (repoGitAnnexRemote repo) challengeLayout True challenge $ challengeSubmissionWidget formWidget formEnctype challenge postChallengeSubmissionJsonR :: Text -> Handler Value -postChallengeSubmissionJsonR name = do +postChallengeSubmissionJsonR challengeName = do Entity userId _ <- requireAuthPossiblyByToken - (Entity challengeId _) <- runDB $ getBy404 $ UniqueName name + (Entity challengeId _) <- runDB $ getBy404 $ UniqueName challengeName ((result, _), _) <- runFormPost $ submissionForm Nothing Nothing Nothing let submissionData' = case result of FormSuccess res -> Just res @@ -379,10 +379,10 @@ postChallengeSubmissionJsonR name = do runViewProgressAsynchronously $ doCreateSubmission userId challengeId submissionData postChallengeSubmissionR :: Text -> Handler TypedContent -postChallengeSubmissionR name = do +postChallengeSubmissionR challengeName = do userId <- requireAuthId - (Entity challengeId _) <- runDB $ getBy404 $ UniqueName name + (Entity challengeId _) <- runDB $ getBy404 $ UniqueName challengeName ((result, _), _) <- runFormPost $ submissionForm Nothing Nothing Nothing let submissionData' = case result of FormSuccess res -> Just res @@ -408,19 +408,19 @@ postTriggerLocallyR = do postTriggerRemotelyR :: Handler TypedContent postTriggerRemotelyR = do (Just challengeName) <- lookupPostParam "challenge" - (Just url) <- lookupPostParam "url" + (Just theUrl) <- lookupPostParam "url" (Just token) <- lookupPostParam "token" mBranch <- lookupPostParam "branch" mGitAnnexRemote <- lookupPostParam "git-annex-remote" - doTrigger token challengeName url mBranch mGitAnnexRemote + doTrigger token challengeName theUrl mBranch mGitAnnexRemote postTriggerRemotelySimpleR :: Text -> Text -> Text -> Text -> Handler TypedContent -postTriggerRemotelySimpleR token challengeName url branch = - doTrigger token challengeName (decodeSlash url) (Just branch) Nothing +postTriggerRemotelySimpleR token challengeName theUrl branch = + doTrigger token challengeName (decodeSlash theUrl) (Just branch) Nothing getTriggerRemotelySimpleR :: Text -> Text -> Text -> Text -> Handler TypedContent -getTriggerRemotelySimpleR token challengeName url branch = - doTrigger token challengeName (decodeSlash url) (Just branch) Nothing +getTriggerRemotelySimpleR token challengeName theUrl branch = + doTrigger token challengeName (decodeSlash theUrl) (Just branch) Nothing data GitServerPayload = GitServerPayload { gitServerPayloadRef :: Text, @@ -447,20 +447,20 @@ postTriggerByWebhookR token challengeName = do then do let branch = T.replace refPrefix "" ref - let url = fromMaybe (fromJust $ gitServerPayloadGitSshUrl payload) + let theUrl = fromMaybe (fromJust $ gitServerPayloadGitSshUrl payload) (gitServerPayloadSshUrl payload) - doTrigger token challengeName url (Just branch) Nothing + doTrigger token challengeName theUrl (Just branch) Nothing else error $ "unexpected ref `" ++ (T.unpack ref) ++ "`" doTrigger :: Text -> Text -> Text -> Maybe Text -> Maybe Text -> Handler TypedContent -doTrigger token challengeName url mBranch mGitAnnexRemote = do +doTrigger token challengeName theUrl mBranch mGitAnnexRemote = do [Entity userId _] <- runDB $ selectList [UserTriggerToken ==. Just token] [] - trigger userId challengeName url mBranch mGitAnnexRemote + trigger userId challengeName theUrl mBranch mGitAnnexRemote trigger :: UserId -> Text -> Text -> Maybe Text -> Maybe Text -> Handler TypedContent -trigger userId challengeName url mBranch mGitAnnexRemote = do +trigger userId challengeName theUrl mBranch mGitAnnexRemote = do let branch = fromMaybe "master" mBranch mChallengeEnt <- runDB $ getBy $ UniqueName challengeName @@ -468,7 +468,7 @@ trigger userId challengeName url mBranch mGitAnnexRemote = do challengeSubmissionDataDescription = Nothing, challengeSubmissionDataTags = Nothing, challengeSubmissionDataRepo = RepoSpec { - repoSpecUrl=url, + repoSpecUrl=theUrl, repoSpecBranch=branch, repoSpecGitAnnexRemote=mGitAnnexRemote} } @@ -485,8 +485,8 @@ isBefore moment (Just deadline) = moment <= deadline -- the submission repo, just by looking at the metadata) willClone :: Challenge -> ChallengeSubmissionData -> Bool willClone challenge submissionData = - (challengeName challenge) `isInfixOf` url && branch /= dontPeek && not (dontPeek `isInfixOf` url) - where url = repoSpecUrl $ challengeSubmissionDataRepo submissionData + (challengeName challenge) `isInfixOf` theUrl && branch /= dontPeek && not (dontPeek `isInfixOf` theUrl) + where theUrl = repoSpecUrl $ challengeSubmissionDataRepo submissionData branch = repoSpecBranch $ challengeSubmissionDataRepo submissionData dontPeek = "dont-peek" @@ -496,10 +496,10 @@ doCreateSubmission :: UserId -> Key Challenge -> ChallengeSubmissionData -> Chan doCreateSubmission userId challengeId challengeSubmissionData chan = do challenge <- runDB $ get404 challengeId - version <- runDB $ getBy404 $ UniqueVersionByCommit $ challengeVersion challenge + theVersion <- runDB $ getBy404 $ UniqueVersionByCommit $ challengeVersion challenge theNow <- liftIO getCurrentTime - if theNow `isBefore` (versionDeadline $ entityVal version) + if theNow `isBefore` (versionDeadline $ entityVal theVersion) then do let wanted = willClone challenge challengeSubmissionData @@ -536,7 +536,7 @@ doCreateSubmission' _ userId challengeId challengeSubmissionData chan = do TheHigherTheBetter -> E.desc TheLowerTheBetter -> E.asc - bestResultSoFar <- runDB $ E.select $ E.from $ \(evaluation, submission, variant, out, test, version) -> do + bestResultSoFar <- runDB $ E.select $ E.from $ \(evaluation, submission, variant, out, test, theVersion) -> do E.where_ (submission ^. SubmissionChallenge E.==. E.val challengeId E.&&. submission ^. SubmissionIsHidden E.==. E.val False E.&&. variant ^. VariantSubmission E.==. submission ^. SubmissionId @@ -548,10 +548,10 @@ doCreateSubmission' _ userId challengeId challengeSubmissionData chan = do E.&&. test ^. TestName E.==. E.val (testName mainTest) E.&&. test ^. TestMetric E.==. E.val (testMetric mainTest) E.&&. test ^. TestActive - E.&&. (evaluation ^. EvaluationVersion E.==. E.just (version ^. VersionCommit) + E.&&. (evaluation ^. EvaluationVersion E.==. E.just (theVersion ^. VersionCommit) E.||. E.isNothing (evaluation ^. EvaluationVersion)) - E.&&. version ^. VersionCommit E.==. test ^. TestCommit - E.&&. version ^. VersionMajor E.>=. E.val submittedMajorVersion) + E.&&. theVersion ^. VersionCommit E.==. test ^. TestCommit + E.&&. theVersion ^. VersionMajor E.>=. E.val submittedMajorVersion) E.orderBy [orderDirection (evaluation ^. EvaluationScore)] E.limit 1 return evaluation @@ -703,7 +703,7 @@ getScoreForOut mainTestId out = do Nothing -> Nothing getSubmission :: UserId -> Key Repo -> SHA1 -> Key Challenge -> Text -> Channel -> Handler (Key Submission) -getSubmission userId repoId commit challengeId description chan = do +getSubmission userId repoId commit challengeId subDescription chan = do challenge <- runDB $ get404 challengeId maybeSubmission <- runDB $ getBy $ UniqueSubmissionRepoCommitChallenge repoId commit challengeId case maybeSubmission of @@ -717,7 +717,7 @@ getSubmission userId repoId commit challengeId description chan = do submissionRepo=repoId, submissionCommit=commit, submissionChallenge=challengeId, - submissionDescription=description, + submissionDescription=subDescription, submissionStamp=time, submissionSubmitter=userId, submissionIsPublic=False, @@ -788,7 +788,7 @@ authorizationTokenAuth = do let token = BS.filter (/= 32) token' einfo <- liftIO $ JWT.decode [jwk] (Just (JWT.JwsEncoding JWA.RS256)) token return $ case einfo of - Right (JWT.Jws (_, info)) -> decode $ fromStrict info + Right (JWT.Jws (_, infos)) -> decode $ fromStrict infos _ -> Nothing | otherwise -> return Nothing Nothing -> return Nothing @@ -797,8 +797,8 @@ maybeAuthPossiblyByToken :: Handler (Maybe (Entity User)) maybeAuthPossiblyByToken = do mInfo <- authorizationTokenAuth case mInfo of - Just info -> do - x <- runDB $ getBy $ UniqueUser $ jwtAuthInfoIdent info + Just infos -> do + x <- runDB $ getBy $ UniqueUser $ jwtAuthInfoIdent infos case x of Just entUser -> return $ Just entUser Nothing -> maybeAuth @@ -809,8 +809,8 @@ requireAuthPossiblyByToken :: Handler (Entity User) requireAuthPossiblyByToken = do mInfo <- authorizationTokenAuth case mInfo of - Just info -> do - x <- runDB $ getBy $ UniqueUser $ jwtAuthInfoIdent info + Just infos -> do + x <- runDB $ getBy $ UniqueUser $ jwtAuthInfoIdent infos case x of Just entUser -> return entUser Nothing -> requireAuth @@ -825,8 +825,8 @@ getAddUserR :: Handler Value getAddUserR = do mInfo <- authorizationTokenAuth case mInfo of - Just info -> do - let ident = jwtAuthInfoIdent info + Just infos -> do + let ident = jwtAuthInfoIdent infos x <- runDB $ getBy $ UniqueUser ident case x of Just _ -> return $ Bool False @@ -908,7 +908,7 @@ convertTagInfoToView tagInfo = } convertEvaluationToView :: Map TestReference Evaluation -> Entity Test -> Maybe EvaluationView -convertEvaluationToView mapping entTest = +convertEvaluationToView theMapping entTest = case join $ evaluationScore <$> mEvaluation of Just s -> Just $ EvaluationView { @@ -917,7 +917,7 @@ convertEvaluationToView mapping entTest = evaluationViewTest = testRef } Nothing -> Nothing - where mEvaluation = Map.lookup testRef mapping + where mEvaluation = Map.lookup testRef theMapping formattingOps = getTestFormattingOpts $ entityVal entTest testRef = getTestReference entTest @@ -948,8 +948,8 @@ convertTableEntryToView tests entry = do where submission = entityVal $ tableEntrySubmission entry fetchChallengeSubmissionsView :: ((Entity Submission) -> Bool) -> Text -> Handler SubmissionsView -fetchChallengeSubmissionsView condition name = do - Entity challengeId _ <- runDB $ getBy404 $ UniqueName name +fetchChallengeSubmissionsView condition challengeName = do + Entity challengeId _ <- runDB $ getBy404 $ UniqueName challengeName (evaluationMaps, tests') <- runDB $ getChallengeSubmissionInfos 1 condition (const True) id challengeId let tests = sortBy testComparator tests' @@ -963,12 +963,12 @@ fetchChallengeSubmissionsView condition name = do -- TODO switch to fetchChallengeSubmissionSview getChallengeMySubmissionsR :: Text -> Handler Html -getChallengeMySubmissionsR name = do +getChallengeMySubmissionsR challengeName = do userId <- requireAuthId - getChallengeSubmissions (\(Entity _ submission) -> (submissionSubmitter submission == userId)) name + getChallengeSubmissions (\(Entity _ submission) -> (submissionSubmitter submission == userId)) challengeName getChallengeAllSubmissionsR :: Text -> Handler Html -getChallengeAllSubmissionsR name = getChallengeSubmissions (\_ -> True) name +getChallengeAllSubmissionsR challengeName = getChallengeSubmissions (\_ -> True) challengeName data EvaluationView = EvaluationView { evaluationViewScore :: Text, @@ -1113,8 +1113,8 @@ instance ToSchema SubmissionsView where & required .~ [ "tests", "submission" ] getChallengeSubmissions :: ((Entity Submission) -> Bool) -> Text -> Handler Html -getChallengeSubmissions condition name = do - Entity challengeId challenge <- runDB $ getBy404 $ UniqueName name +getChallengeSubmissions condition challengeName = do + Entity challengeId challenge <- runDB $ getBy404 $ UniqueName challengeName (evaluationMaps, tests') <- runDB $ getChallengeSubmissionInfos 1 condition (const True) id challengeId let tests = sortBy testComparator tests' mauth <- maybeAuth @@ -1204,10 +1204,10 @@ $.getJSON("@{ChallengeParamGraphDataR (challengeName challenge) testId param}", challengeLayout :: Bool -> Challenge -> WidgetFor App () -> HandlerFor App Html challengeLayout withHeader challenge widget = do tagsAvailableAsJSON <- runDB $ getAvailableTagsAsJSON - version <- runDB $ getBy404 $ UniqueVersionByCommit $ challengeVersion challenge - let versionFormatted = formatVersion ((versionMajor $ entityVal version), - (versionMinor $ entityVal version), - (versionPatch $ entityVal version)) + theVersion <- runDB $ getBy404 $ UniqueVersionByCommit $ challengeVersion challenge + let versionFormatted = formatVersion ((versionMajor $ entityVal theVersion), + (versionMinor $ entityVal theVersion), + (versionPatch $ entityVal theVersion)) maybeUser <- maybeAuth bc <- widgetToPageContent widget defaultLayout $ do diff --git a/templates/challenge.hamlet b/templates/challenge.hamlet index d975ec2..0b70467 100644 --- a/templates/challenge.hamlet +++ b/templates/challenge.hamlet @@ -16,7 +16,7 @@ $if withHeader

#{challengeTitle challenge}

#{challengeDescription challenge} [ver. #{versionFormatted}] - $maybe deadline <- versionDeadline $ entityVal version + $maybe deadline <- versionDeadline $ entityVal theVersion

Deadline: #{show deadline} $nothing ^{pageBody bc} From fb29ba81140962d04f5020fc7d5c9fb7b4f5195c Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 8 Feb 2021 20:52:12 +0100 Subject: [PATCH 06/17] Add info about the image --- Handler/ListChallenges.hs | 12 +++++++++--- config/routes | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/Handler/ListChallenges.hs b/Handler/ListChallenges.hs index 429d759..72d0c78 100644 --- a/Handler/ListChallenges.hs +++ b/Handler/ListChallenges.hs @@ -8,10 +8,8 @@ import Import hiding (get, fromList, Proxy) import Data.HashMap.Strict.InsOrd (fromList) import Data.Proxy -import Data.Aeson import Control.Lens hiding ((.=)) import Data.Swagger -import Data.Swagger.Lens import Data.Swagger.Declare mainCondition :: [Filter Challenge] @@ -44,13 +42,20 @@ getListChallengesJsonR = generalListChallengesJson mainCondition getListArchivedChallengesR :: Handler Html getListArchivedChallengesR = generalListChallenges [ChallengeArchived ==. Just True] +imageUrl :: Entity Challenge -> Maybe (Route App) +imageUrl (Entity challengeId challenge) = + case challengeImage challenge of + Just _ -> Just $ ChallengeImageR challengeId + Nothing -> Nothing + instance ToJSON (Entity Challenge) where - toJSON (Entity _ ch) = object + toJSON chEnt@(Entity _ ch) = object [ "name" .= challengeName ch , "title" .= challengeTitle ch , "description" .= challengeDescription ch , "starred" .= challengeStarred ch , "archived" .= challengeArchived ch + , "imageUrl" .= (("/" <>) <$> intercalate "/" <$> fst <$> renderRoute <$> imageUrl chEnt) ] instance ToSchema (Entity Challenge) where @@ -65,6 +70,7 @@ instance ToSchema (Entity Challenge) where , ("description", stringSchema) , ("starred", booleanSchema) , ("archived", booleanSchema) + , ("imageUrl", stringSchema) ] & required .~ [ "name", "title", "description", "starred", "archived" ] diff --git a/config/routes b/config/routes index c55a0cf..1ff9f76 100644 --- a/config/routes +++ b/config/routes @@ -19,7 +19,7 @@ /api/add-user AddUserR GET /api/challenge-submission/#Text ChallengeSubmissionJsonR POST /api/challenge-readme/#Text/markdown ChallengeReadmeInMarkdownR GET -/challenge-image/#ChallengeId ChallengeImageR GET +/api/challenge-image/#ChallengeId ChallengeImageR GET /list-archived-challenges ListArchivedChallengesR GET /challenge/#Text ShowChallengeR GET From 4c7f7add98437f4a09795314b7ed0caf0efdf844 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 11:32:51 +0100 Subject: [PATCH 07/17] Fix trivial mistake in Swagger documentation --- Handler/ShowChallenge.hs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index c74cfd2..0d8171f 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -1107,8 +1107,8 @@ instance ToSchema SubmissionsView where return $ NamedSchema (Just "Tag") $ mempty & type_ .~ SwaggerObject & properties .~ - fromList [ ("tests", submissionViewsSchema) - , ("submissions", testRefsSchema) + fromList [ ("submissions", submissionViewsSchema) + , ("tests", testRefsSchema) ] & required .~ [ "tests", "submission" ] From 106e076bc8a008063d7bde6fd922b227f38244ce Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 12:51:24 +0100 Subject: [PATCH 08/17] Add endpoint for querying by hash --- Foundation.hs | 2 + Handler/Query.hs | 148 +++++++++++++++++++++++++++++++++++++- Handler/SubmissionView.hs | 35 ++++++++- config/routes | 1 + 4 files changed, 182 insertions(+), 4 deletions(-) diff --git a/Foundation.hs b/Foundation.hs index c991de8..3d69250 100644 --- a/Foundation.hs +++ b/Foundation.hs @@ -1,3 +1,4 @@ + {-# LANGUAGE InstanceSigs #-} module Foundation where @@ -175,6 +176,7 @@ instance Yesod App where isAuthorized UserInfoR _ = return Authorized isAuthorized (ChallengeSubmissionJsonR _) _ = return Authorized isAuthorized (ChallengeReadmeInMarkdownR _) _ = regularAuthorization + isAuthorized (QueryJsonR _) _ = return Authorized isAuthorized (ChallengeGraphDataR _) _ = regularAuthorization isAuthorized (ChallengeDiscussionR _) _ = regularAuthorization diff --git a/Handler/Query.hs b/Handler/Query.hs index d87f43c..59d717e 100644 --- a/Handler/Query.hs +++ b/Handler/Query.hs @@ -2,7 +2,7 @@ module Handler.Query where -import Import +import Import hiding (fromList, Proxy) import Handler.SubmissionView import Handler.Shared @@ -43,6 +43,90 @@ import System.Directory (makeAbsolute) import Data.SplitIntoCrossTabs +import Data.Swagger hiding (get) +import qualified Data.Swagger as DS + +import Data.Swagger.Declare +import Control.Lens hiding ((.=), (^.), (<.>)) +import Data.Proxy as DPR +import Data.HashMap.Strict.InsOrd (fromList) + +import Handler.ShowChallenge + + +data VariantView = VariantView { + variantViewId :: Int64, + variantViewName :: Text, + variantViewEvaluations :: [EvaluationView], + variantViewParams :: [Parameter] +} + +instance ToJSON Parameter where + toJSON entry = object + [ "name" .= parameterName entry, + "value" .= parameterValue entry + ] + +instance ToSchema Parameter where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + return $ NamedSchema (Just "SubmissionInfo") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("name", stringSchema), + ("value", stringSchema) + ] + & required .~ [ "name", "value" ] + +instance ToJSON VariantView where + toJSON entry = object + [ "id" .= variantViewId entry, + "name" .= variantViewName entry, + "evaluations" .= variantViewEvaluations entry, + "params" .= variantViewParams entry + ] + +instance ToSchema VariantView where + declareNamedSchema _ = do + intSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [Int64]) + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [String]) + evaluationsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [EvaluationView]) + paramsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [Parameter]) + return $ NamedSchema (Just "SubmissionInfo") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("id", intSchema), + ("name", stringSchema), + ("evaluations", evaluationsSchema), + ("params", paramsSchema) + ] + & required .~ [ "evaluations" ] + +data QueryResultView = QueryResultView { + queryResultViewSubmissionInfo :: FullSubmissionInfo, + queryResultViewVariants :: [VariantView] +} + +instance ToJSON QueryResultView where + toJSON entry = object + [ "submissionInfo" .= queryResultViewSubmissionInfo entry, + "variants" .= queryResultViewVariants entry + ] + +instance ToSchema QueryResultView where + declareNamedSchema _ = do + submissionInfoSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy FullSubmissionInfo) + variantViewsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [VariantView]) + return $ NamedSchema (Just "SubmissionInfo") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("submissionInfo", submissionInfoSchema), + ("variants", variantViewsSchema) + ] + & required .~ [ "submissionInfo", "variants" ] + + + rawCommitQuery :: (MonadIO m, RawSql a) => Text -> ReaderT SqlBackend m [a] rawCommitQuery sha1Prefix = rawSql "SELECT ?? FROM submission WHERE cast(commit as text) like ?" [PersistText $ "\\\\x" ++ sha1Prefix ++ "%"] @@ -191,6 +275,68 @@ processQuery query = do setTitle "query results" $(widgetFile "query-results") +toQueryResultView :: FullSubmissionInfo -> Handler QueryResultView +toQueryResultView fsi = do + let submissionId = fsiSubmissionId fsi + let submission = fsiSubmission fsi + (tableEntries, tests) <- runDB + $ getChallengeSubmissionInfos 2 + (\s -> entityKey s == submissionId) + (const True) + id + (submissionChallenge submission) + + + let evaluations = map (\entry -> + VariantView { + variantViewId = fromSqlKey $ entityKey $ tableEntryVariant entry, + variantViewName = variantName $ entityVal $ tableEntryVariant entry, + variantViewEvaluations = catMaybes $ Import.map (convertEvaluationToView $ tableEntryMapping entry) tests, + variantViewParams = Import.map entityVal $ tableEntryParams entry + + }) tableEntries + + return $ QueryResultView { + queryResultViewSubmissionInfo = fsi, + queryResultViewVariants = evaluations } + +getQueryJsonR :: Text -> Handler Value +getQueryJsonR query = do + submissions' <- findSubmissions query + let submissions = map fst submissions' + + qrvs <- mapM toQueryResultView submissions + return $ array qrvs + +declareQuerySwagger :: Declare (Definitions Schema) Swagger +declareQuerySwagger = do + -- param schemas + let querySchema = toParamSchema (Proxy :: Proxy String) + + queryResponse <- declareResponse (Proxy :: Proxy [QueryResultView]) + + return $ mempty + & paths .~ + fromList [ ("/api/query/{query}", + mempty & DS.get ?~ (mempty + & parameters .~ [ Inline $ mempty + & name .~ "query" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamPath + & paramSchema .~ querySchema) ] + & produces ?~ MimeList ["application/json"] + & description ?~ "For a SHA1 hash prefix returns all the submissions matching" + & at 200 ?~ Inline queryResponse)) + ] + + +queryApi :: Swagger +queryApi = spec & definitions .~ defs + where + (defs, spec) = runDeclare declareLeaderboardSwagger mempty + + priorityLimitForViewVariant :: Int priorityLimitForViewVariant = 4 diff --git a/Handler/SubmissionView.hs b/Handler/SubmissionView.hs index bfcc5da..b6388b7 100644 --- a/Handler/SubmissionView.hs +++ b/Handler/SubmissionView.hs @@ -1,10 +1,18 @@ module Handler.SubmissionView where -import Import +import Import hiding (fromList) import qualified Database.Esqueleto as E import Database.Esqueleto ((^.)) +import Handler.Shared +import PersistSHA1 + +import Data.Swagger hiding (get) +import Control.Lens hiding ((.=), (^.)) +import Data.Proxy as DPR +import Data.HashMap.Strict.InsOrd (fromList) + data FullSubmissionInfo = FullSubmissionInfo { fsiSubmissionId :: SubmissionId, fsiSubmission :: Submission, @@ -13,10 +21,31 @@ data FullSubmissionInfo = FullSubmissionInfo { fsiChallenge :: Challenge, fsiChallengeRepo :: Repo, fsiScheme :: RepoScheme, - fsiTags :: [(Entity Tag, Entity SubmissionTag)], + fsiTags :: [(Entity Import.Tag, Entity SubmissionTag)], fsiExternalLinks :: [Entity ExternalLink], fsiSuperSubmissions :: [FullSubmissionInfo] } +instance ToJSON FullSubmissionInfo where + toJSON entry = object + [ "hash" .= (fromSHA1ToText $ submissionCommit $ fsiSubmission entry), + "submitter" .= (formatSubmitter $ fsiUser entry), + "challenge" .= (challengeName $ fsiChallenge entry) + ] + +instance ToSchema FullSubmissionInfo where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + return $ NamedSchema (Just "SubmissionInfo") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("hash", stringSchema) + , ("submitter", stringSchema) + , ("challenge", stringSchema) + ] + & required .~ [ "hash", "submitter", "challenge" ] + + + getFullInfo :: Entity Submission -> Handler FullSubmissionInfo getFullInfo (Entity submissionId submission) = do repo <- runDB $ get404 $ submissionRepo submission @@ -50,7 +79,7 @@ getFullInfo (Entity submissionId submission) = do fsiExternalLinks = links, fsiSuperSubmissions = superSubmissionFsis } -getTags :: (BaseBackend backend ~ SqlBackend, MonadIO m, PersistQueryRead backend) => Key Submission -> ReaderT backend m [(Entity Tag, Entity SubmissionTag)] +getTags :: (BaseBackend backend ~ SqlBackend, MonadIO m, PersistQueryRead backend) => Key Submission -> ReaderT backend m [(Entity Import.Tag, Entity SubmissionTag)] getTags submissionId = do sts <- selectList [SubmissionTagSubmission ==. submissionId] [] let tagIds = Import.map (submissionTagTag . entityVal) sts diff --git a/config/routes b/config/routes index 1ff9f76..05d7fca 100644 --- a/config/routes +++ b/config/routes @@ -20,6 +20,7 @@ /api/challenge-submission/#Text ChallengeSubmissionJsonR POST /api/challenge-readme/#Text/markdown ChallengeReadmeInMarkdownR GET /api/challenge-image/#ChallengeId ChallengeImageR GET +/api/query/#Text QueryJsonR GET /list-archived-challenges ListArchivedChallengesR GET /challenge/#Text ShowChallengeR GET From 64a5bd52bec84fbbe8a096bc6b91183aa06d932a Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 13:48:58 +0100 Subject: [PATCH 09/17] Fix Swagger --- Handler/Query.hs | 8 ++++---- Handler/Swagger.hs | 2 ++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Handler/Query.hs b/Handler/Query.hs index 59d717e..9c18383 100644 --- a/Handler/Query.hs +++ b/Handler/Query.hs @@ -70,7 +70,7 @@ instance ToJSON Parameter where instance ToSchema Parameter where declareNamedSchema _ = do stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) - return $ NamedSchema (Just "SubmissionInfo") $ mempty + return $ NamedSchema (Just "Parameter") $ mempty & type_ .~ SwaggerObject & properties .~ fromList [ ("name", stringSchema), @@ -92,7 +92,7 @@ instance ToSchema VariantView where stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [String]) evaluationsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [EvaluationView]) paramsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [Parameter]) - return $ NamedSchema (Just "SubmissionInfo") $ mempty + return $ NamedSchema (Just "Variant") $ mempty & type_ .~ SwaggerObject & properties .~ fromList [ ("id", intSchema), @@ -117,7 +117,7 @@ instance ToSchema QueryResultView where declareNamedSchema _ = do submissionInfoSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy FullSubmissionInfo) variantViewsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [VariantView]) - return $ NamedSchema (Just "SubmissionInfo") $ mempty + return $ NamedSchema (Just "QueryResult") $ mempty & type_ .~ SwaggerObject & properties .~ fromList [ ("submissionInfo", submissionInfoSchema), @@ -334,7 +334,7 @@ declareQuerySwagger = do queryApi :: Swagger queryApi = spec & definitions .~ defs where - (defs, spec) = runDeclare declareLeaderboardSwagger mempty + (defs, spec) = runDeclare declareQuerySwagger mempty priorityLimitForViewVariant :: Int diff --git a/Handler/Swagger.hs b/Handler/Swagger.hs index 7db76d1..104a703 100644 --- a/Handler/Swagger.hs +++ b/Handler/Swagger.hs @@ -5,6 +5,7 @@ import Import import Data.Swagger import Handler.ListChallenges import Handler.ShowChallenge +import Handler.Query import Control.Lens hiding ((.=)) @@ -18,6 +19,7 @@ apiDescription = generalApi <> allSubmissionsApi <> mySubmissionsApi <> challengeReadmeInMarkdownApi + <> queryApi generalApi :: Swagger generalApi = (mempty :: Swagger) From 9a681701e59f48847570be021c928005af044ac9 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 14:44:19 +0100 Subject: [PATCH 10/17] Add hash to leaderboard entries --- Handler/ShowChallenge.hs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index 0d8171f..f6317fd 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -76,6 +76,7 @@ instance ToJSON LeaderboardEntry where (leaderboardBestVariant entry) (leaderboardParams entry) , "times" .= leaderboardNumberOfSubmissions entry + , "hash" .= (fromSHA1ToText $ submissionCommit $ leaderboardBestSubmission entry) ] instance ToSchema LeaderboardEntry where @@ -90,8 +91,9 @@ instance ToSchema LeaderboardEntry where , ("version", stringSchema) , ("description", stringSchema) , ("times", intSchema) + , ("hash", stringSchema) ] - & required .~ [ "submitter", "when", "version", "description", "times" ] + & required .~ [ "submitter", "when", "version", "description", "times", "hash" ] declareLeaderboardSwagger :: Declare (Definitions Schema) Swagger From bb28d2c590815213cee1020b72ef285872084a6a Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 18:27:10 +0100 Subject: [PATCH 11/17] Add challenge-info endpoint --- Foundation.hs | 1 + Handler/ListChallenges.hs | 20 +++++++++++++++++++- config/routes | 1 + 3 files changed, 21 insertions(+), 1 deletion(-) diff --git a/Foundation.hs b/Foundation.hs index 3d69250..eb96f1d 100644 --- a/Foundation.hs +++ b/Foundation.hs @@ -154,6 +154,7 @@ instance Yesod App where isAuthorized (QueryResultsR _) _ = regularAuthorization isAuthorized ListChallengesR _ = regularAuthorization isAuthorized ListChallengesJsonR _ = regularAuthorization + isAuthorized (ChallengeInfoJsonR _) _ = regularAuthorization isAuthorized (LeaderboardJsonR _) _ = regularAuthorization isAuthorized (ViewVariantR _ ) _ = regularAuthorization isAuthorized (ViewVariantTestR _ _) _ = regularAuthorization diff --git a/Handler/ListChallenges.hs b/Handler/ListChallenges.hs index 72d0c78..a795eb0 100644 --- a/Handler/ListChallenges.hs +++ b/Handler/ListChallenges.hs @@ -22,13 +22,26 @@ declareListChallengesSwagger :: Declare (Definitions Schema) Swagger declareListChallengesSwagger = do -- param schemas listChallengesResponse <- declareResponse (Proxy :: Proxy [Entity Challenge]) + challengeInfoResponse <- declareResponse (Proxy :: Proxy (Entity Challenge)) + let challengeNameSchema = toParamSchema (Proxy :: Proxy String) return $ mempty & paths .~ [ ("/api/list-challenges", mempty & get ?~ (mempty & produces ?~ MimeList ["application/json"] & description ?~ "Returns the list of all challenges" - & at 200 ?~ Inline listChallengesResponse)) + & at 200 ?~ Inline listChallengesResponse)), + ("/api/challenge-info/{challengeName}", + mempty & get ?~ (mempty + & parameters .~ [ Inline $ mempty + & name .~ "challengeName" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamPath + & paramSchema .~ challengeNameSchema) ] + & produces ?~ MimeList ["application/json"] + & description ?~ "Returns metadata for a specific challenge" + & at 200 ?~ Inline challengeInfoResponse)) ] listChallengesApi :: Swagger @@ -93,6 +106,11 @@ getChallenges filterExpr = runDB $ selectList filterExpr [Desc ChallengeStarred, listChallengesCore :: [Entity Challenge] -> Widget listChallengesCore challenges = $(widgetFile "list-challenges-core") +getChallengeInfoJsonR :: Text -> Handler Value +getChallengeInfoJsonR challengeName = do + entCh <- runDB $ getBy404 $ UniqueName challengeName + return $ toJSON entCh + getChallengeImageR :: ChallengeId -> Handler Html getChallengeImageR challengeId = do challenge <- runDB $ get404 challengeId diff --git a/config/routes b/config/routes index 05d7fca..3753dd0 100644 --- a/config/routes +++ b/config/routes @@ -21,6 +21,7 @@ /api/challenge-readme/#Text/markdown ChallengeReadmeInMarkdownR GET /api/challenge-image/#ChallengeId ChallengeImageR GET /api/query/#Text QueryJsonR GET +/api/challenge-info/#Text ChallengeInfoJsonR GET /list-archived-challenges ListArchivedChallengesR GET /challenge/#Text ShowChallengeR GET From 3a5db1cc539fb3816001dd3fae1f64d066c962ed Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 20:41:09 +0100 Subject: [PATCH 12/17] Modify leaderboard end-point to be more similar to other end-points --- Handler/ShowChallenge.hs | 91 ++++++++++++++++++++++++++++------------ 1 file changed, 65 insertions(+), 26 deletions(-) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index f6317fd..2444acc 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -8,6 +8,8 @@ import Text.Markdown import qualified Data.Text as T +import qualified Data.HashMap.Strict as HMS + import qualified Yesod.Table as Table import Handler.Extract @@ -79,29 +81,12 @@ instance ToJSON LeaderboardEntry where , "hash" .= (fromSHA1ToText $ submissionCommit $ leaderboardBestSubmission entry) ] -instance ToSchema LeaderboardEntry where - declareNamedSchema _ = do - stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) - intSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy Int) - return $ NamedSchema (Just "LeaderboardEntry") $ mempty - & type_ .~ SwaggerObject - & properties .~ - fromList [ ("submitter", stringSchema) - , ("when", stringSchema) - , ("version", stringSchema) - , ("description", stringSchema) - , ("times", intSchema) - , ("hash", stringSchema) - ] - & required .~ [ "submitter", "when", "version", "description", "times", "hash" ] - - declareLeaderboardSwagger :: Declare (Definitions Schema) Swagger declareLeaderboardSwagger = do -- param schemas let challengeNameSchema = toParamSchema (Proxy :: Proxy String) - leaderboardResponse <- declareResponse (Proxy :: Proxy [LeaderboardEntry]) + leaderboardResponse <- declareResponse (Proxy :: Proxy LeaderboardView) return $ mempty & paths .~ @@ -124,7 +109,28 @@ leaderboardApi = spec & definitions .~ defs where (defs, spec) = runDeclare declareLeaderboardSwagger mempty +data LeaderboardView = LeaderboardView { + leaderboardViewTests :: [Entity Test], + leaderboardViewEntries :: [LeaderboardEntryView] +} +instance ToJSON LeaderboardView where + toJSON v = object + [ "tests" .= (map getTestReference $ leaderboardViewTests v) + , "entries" .= leaderboardViewEntries v + ] + +instance ToSchema LeaderboardView where + declareNamedSchema _ = do + testsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [TestReference]) + entriesSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [LeaderboardEntryView]) + return $ NamedSchema (Just "Leaderboard") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("tests", testsSchema) + , ("entries", entriesSchema) + ] + & required .~ [ "tests", "entries" ] getLeaderboardJsonR :: Text -> Handler Value getLeaderboardJsonR challengeName = do @@ -133,15 +139,48 @@ getLeaderboardJsonR challengeName = do Entity challengeId _ <- runDB $ getBy404 $ UniqueName challengeName (leaderboard, (_, tests)) <- getLeaderboardEntries 1 leaderboardStyle challengeId - return $ array $ map (leaderboardEntryJson tests) leaderboard + return $ toJSON $ LeaderboardView { + leaderboardViewTests = tests, + leaderboardViewEntries = map (toLeaderboardEntryView tests) leaderboard } -leaderboardEntryJson :: (ToJSON (f Value), Functor f) => f (Entity Test) -> LeaderboardEntry -> Value -leaderboardEntryJson tests entry = object [ - "metadata" .= entry, - "metrics" .= - map (\e@(Entity _ t) -> object [ - "metric" .= testName t, - "score" .= (formatTruncatedScore (getTestFormattingOpts t) $ extractScoreFromLeaderboardEntry (getTestReference e) entry)]) tests] +data LeaderboardEntryView = LeaderboardEntryView { + leaderboardEntryViewEntry :: LeaderboardEntry, + leaderboardEntryViewEvaluations :: [EvaluationView] +} + +addJsonKey :: Text -> Value -> Value -> Value +addJsonKey key val (Object xs) = Object $ HMS.insert key val xs +addJsonKey _ _ xs = xs + +instance ToJSON LeaderboardEntryView where + toJSON v = addJsonKey "evaluations" + (toJSON $ leaderboardEntryViewEvaluations v) + (toJSON $ leaderboardEntryViewEntry v) + +instance ToSchema LeaderboardEntryView where + declareNamedSchema _ = do + stringSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy String) + intSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy Int) + evaluationsSchema <- declareSchemaRef (DPR.Proxy :: DPR.Proxy [EvaluationView]) + return $ NamedSchema (Just "LeaderboardEntry") $ mempty + & type_ .~ SwaggerObject + & properties .~ + fromList [ ("submitter", stringSchema) + , ("when", stringSchema) + , ("version", stringSchema) + , ("description", stringSchema) + , ("times", intSchema) + , ("hash", stringSchema) + , ("evaluations", evaluationsSchema) + ] + & required .~ [ "submitter", "when", "version", "description", "times", "hash", "evaluations" ] + +toLeaderboardEntryView :: [(Entity Test)] -> LeaderboardEntry -> LeaderboardEntryView +toLeaderboardEntryView tests entry = LeaderboardEntryView { + leaderboardEntryViewEntry = entry, + leaderboardEntryViewEvaluations = catMaybes $ + map (convertEvaluationToView (leaderboardEvaluationMap entry)) tests + } getShowChallengeR :: Text -> Handler Html getShowChallengeR challengeName = do From 1114dd21ef5d05a983738bf41b04276145fb97a5 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 20:45:45 +0100 Subject: [PATCH 13/17] Bump up version --- CHANGELOG.md | 3 +++ Handler/Swagger.hs | 3 ++- gonito.cabal | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f924ff0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +Start CHANGELOG diff --git a/Handler/Swagger.hs b/Handler/Swagger.hs index 104a703..f45e8ed 100644 --- a/Handler/Swagger.hs +++ b/Handler/Swagger.hs @@ -24,4 +24,5 @@ apiDescription = generalApi generalApi :: Swagger generalApi = (mempty :: Swagger) & info .~ (mempty & - title .~ "Gonito API") + title .~ "Gonito API" & + version .~ "1.0.0") diff --git a/gonito.cabal b/gonito.cabal index 2c5e11f..27e3965 100644 --- a/gonito.cabal +++ b/gonito.cabal @@ -1,5 +1,5 @@ name: gonito -version: 0.1.1 +version: 1.0.0 cabal-version: >= 1.8 build-type: Simple homepage: http://gonito.net From fb7598170501b269eff5986fde746bde7683c6ff Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 20:48:26 +0100 Subject: [PATCH 14/17] Switch the license from AGPL to GPL All the contributors constented to this decision. --- README.md | 2 +- agpl-3.0.txt | 661 -------------------------------------- gonito.cabal | 4 +- templates/homepage.hamlet | 2 +- 4 files changed, 4 insertions(+), 665 deletions(-) delete mode 100644 agpl-3.0.txt diff --git a/README.md b/README.md index 60483a9..2ba21e5 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ neither affiliated with nor endorsed by [Kaggle](https://www.kaggle.com)). What's so special about Gonito: - * free & open-source (AGPL), you can use it your own, in your + * free & open-source (GPL), you can use it your own, in your company, at your university, etc. * git-based (challenges and solutions are submitted only with git). diff --git a/agpl-3.0.txt b/agpl-3.0.txt deleted file mode 100644 index dba13ed..0000000 --- a/agpl-3.0.txt +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/gonito.cabal b/gonito.cabal index 27e3965..08dfdc2 100644 --- a/gonito.cabal +++ b/gonito.cabal @@ -3,8 +3,8 @@ version: 1.0.0 cabal-version: >= 1.8 build-type: Simple homepage: http://gonito.net -license: AGPL-3 -license-file: agpl-3.0.txt +license: GPL-3 +license-file: gpl-3.0.txt author: Filip Graliński maintainer: filipg@amu.edu.pl diff --git a/templates/homepage.hamlet b/templates/homepage.hamlet index d412861..2629adc 100644 --- a/templates/homepage.hamlet +++ b/templates/homepage.hamlet @@ -10,7 +10,7 @@

What's so special about Gonito:
    -
  • free & open-source (AGPL), you can use it your own, in your company, at your university, etc. (git repo: git://gonito.net/gonito), +
  • free & open-source (GPL), you can use it your own, in your company, at your university, etc. (git repo: git://gonito.net/gonito),
  • git-based (challenges and solutions are submitted only with git),
  • geval — a companion stand-alone tool for evaluation (git://gonito.net/geval),
  • special features for organizing classes in machine learning. From 6686e9f8458bb9183036b7c20574cfa8231393dd Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 21:34:54 +0100 Subject: [PATCH 15/17] Add GPL license file --- gpl-3.0.txt | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 gpl-3.0.txt diff --git a/gpl-3.0.txt b/gpl-3.0.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/gpl-3.0.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 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 this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From fea7dabbd4241496a38acb34ff746a38e39fa0f7 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 21:35:09 +0100 Subject: [PATCH 16/17] Describe submission API in Swagger --- Handler/ShowChallenge.hs | 66 ++++++++++++++++++++++++++++++++++++++++ Handler/Swagger.hs | 1 + 2 files changed, 67 insertions(+) diff --git a/Handler/ShowChallenge.hs b/Handler/ShowChallenge.hs index 2444acc..f0b51b8 100644 --- a/Handler/ShowChallenge.hs +++ b/Handler/ShowChallenge.hs @@ -406,6 +406,72 @@ getChallengeSubmissionR challengeName = do (formWidget, formEnctype) <- generateFormPost $ submissionForm (Just defaultUrl) (defaultBranch scheme) (repoGitAnnexRemote repo) challengeLayout True challenge $ challengeSubmissionWidget formWidget formEnctype challenge + +declareChallengeSubmissionSwagger :: Declare (Definitions Schema) Swagger +declareChallengeSubmissionSwagger = do + -- param schemas + let challengeNameSchema = toParamSchema (Proxy :: Proxy String) + let stringSchema = toParamSchema (Proxy :: Proxy String) + + challengeSubmissionResponse <- declareResponse (Proxy :: Proxy Int) + + return $ mempty + & paths .~ + fromList [ ("/api/challenge-submission/{challengeName}", + mempty & DS.post ?~ (mempty + & parameters .~ [ Inline $ mempty + & name .~ "challengeName" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamPath + & paramSchema .~ challengeNameSchema), + Inline $ mempty + & name .~ "f1" + & description .~ Just "submission description" + & required ?~ False + & schema .~ ParamOther (mempty + & in_ .~ ParamFormData + & paramSchema .~ stringSchema), + Inline $ mempty + & name .~ "f2" + & description .~ Just "submission tags" + & required ?~ False + & schema .~ ParamOther (mempty + & in_ .~ ParamFormData + & paramSchema .~ stringSchema), + Inline $ mempty + & name .~ "f3" + & description .~ Just "repo URL" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamFormData + & paramSchema .~ stringSchema), + Inline $ mempty + & name .~ "f4" + & description .~ Just "repo branch" + & required ?~ True + & schema .~ ParamOther (mempty + & in_ .~ ParamFormData + & paramSchema .~ stringSchema), + + Inline $ mempty + & name .~ "f5" + & description .~ Just "git-annex remote specification" + & required ?~ False + & schema .~ ParamOther (mempty + & in_ .~ ParamFormData + & paramSchema .~ stringSchema)] + & produces ?~ MimeList ["application/json"] + & description ?~ "Initiates a submission based on a given repo URL/branch. Returns an asynchrous job ID." + & at 200 ?~ Inline challengeSubmissionResponse)) + ] + +challengeSubmissionApi :: Swagger +challengeSubmissionApi = spec & definitions .~ defs + where + (defs, spec) = runDeclare declareChallengeSubmissionSwagger mempty + + postChallengeSubmissionJsonR :: Text -> Handler Value postChallengeSubmissionJsonR challengeName = do Entity userId _ <- requireAuthPossiblyByToken diff --git a/Handler/Swagger.hs b/Handler/Swagger.hs index f45e8ed..5f20f1d 100644 --- a/Handler/Swagger.hs +++ b/Handler/Swagger.hs @@ -20,6 +20,7 @@ apiDescription = generalApi <> mySubmissionsApi <> challengeReadmeInMarkdownApi <> queryApi + <> challengeSubmissionApi generalApi :: Swagger generalApi = (mempty :: Swagger) From 3705eb1e74eaf2c092192e93522e92b965b17c66 Mon Sep 17 00:00:00 2001 From: Filip Gralinski Date: Mon, 15 Feb 2021 21:39:06 +0100 Subject: [PATCH 17/17] Add rank for variants --- Handler/Query.hs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Handler/Query.hs b/Handler/Query.hs index 9c18383..e1dc389 100644 --- a/Handler/Query.hs +++ b/Handler/Query.hs @@ -57,6 +57,7 @@ import Handler.ShowChallenge data VariantView = VariantView { variantViewId :: Int64, variantViewName :: Text, + variantViewRank :: Int, variantViewEvaluations :: [EvaluationView], variantViewParams :: [Parameter] } @@ -82,6 +83,7 @@ instance ToJSON VariantView where toJSON entry = object [ "id" .= variantViewId entry, "name" .= variantViewName entry, + "rank" .= variantViewRank entry, "evaluations" .= variantViewEvaluations entry, "params" .= variantViewParams entry ] @@ -97,6 +99,7 @@ instance ToSchema VariantView where & properties .~ fromList [ ("id", intSchema), ("name", stringSchema), + ("rank", intSchema), ("evaluations", evaluationsSchema), ("params", paramsSchema) ] @@ -291,6 +294,7 @@ toQueryResultView fsi = do VariantView { variantViewId = fromSqlKey $ entityKey $ tableEntryVariant entry, variantViewName = variantName $ entityVal $ tableEntryVariant entry, + variantViewRank = tableEntryRank entry, variantViewEvaluations = catMaybes $ Import.map (convertEvaluationToView $ tableEntryMapping entry) tests, variantViewParams = Import.map entityVal $ tableEntryParams entry