addurl --file youtube-dl reversion fix

addurl: Fix reversion in 7.20190322 that made --file not be honored when
youtube-dl was used to download media.

8758f9c561 was on the right track, but missed that | otherwise prevented
the code it added from being used.

Also, refactored out a common function.

This commit was sponsored by Graham Spencer on Patreon.

CHANGELOG

@@ -7,6 +7,8 @@ git-annex (8.20200815) UNRELEASED; urgency=medium
   * Display warning when external special remote does not start up
     properly, or is not usable.
   * stack.yaml: Updated to lts-16.10.
+  * addurl: Fix reversion in 7.20190322 that made --file not be honored
+    when youtube-dl was used to download media.
 
  -- Joey Hess <id@joeyh.name>  Fri, 14 Aug 2020 14:57:45 -0400
 

Command/AddUrl.hs

@@ -304,8 +304,6 @@ downloadWeb addunlockedmatcher o url urlinfo file =
 	urlkey = addSizeUrlKey urlinfo $ Backend.URL.fromUrl url Nothing
 	downloader f p = Url.withUrlOptions $ downloadUrl urlkey p [url] f
 	go Nothing = return Nothing
-	-- If we downloaded a html file, try to use youtube-dl to
-	-- extract embedded media.
 	go (Just tmp) = ifM (pure (not (rawOption o)) <&&> liftIO (isHtml <$> readFile tmp))
 		( tryyoutubedl tmp
 		, normalfinish tmp
@@ -314,20 +312,14 @@ downloadWeb addunlockedmatcher o url urlinfo file =
 		showDestinationFile file
 		createWorkTreeDirectory (parentDir file)
 		Just <$> finishDownloadWith addunlockedmatcher tmp webUUID url file
-	tryyoutubedl tmp
+	-- Ask youtube-dl what filename it will download first, 
-		-- Ask youtube-dl what filename it will download
+	-- so it's only used when the file contains embedded media.
-		-- first, and check if that is already an annexed file,
+	tryyoutubedl tmp = youtubeDlFileNameHtmlOnly url >>= \case
-		-- to avoid unnecessary work in that case.
+		Right mediafile -> 
-		| otherwise = youtubeDlFileNameHtmlOnly url >>= \case
+			let f = youtubeDlDestFile o file mediafile
-			Right dest -> ifAnnexed (toRawFilePath dest)
+			in ifAnnexed (toRawFilePath f)
-				(alreadyannexed dest)
+				(alreadyannexed f)
-				(dl dest)
+				(dl f)
-			Left _ -> normalfinish tmp
-		-- Ask youtube-dl what filename it will download
-		-- fist, so it's only used when the file contains embedded
-		-- media.
-		| isJust (fileOption o) = youtubeDlFileNameHtmlOnly url >>= \case
-			Right _ -> dl file
 		Left _ -> normalfinish tmp
 	  where
 		dl dest = withTmpWorkDir mediakey $ \workdir -> do
@@ -467,13 +459,16 @@ nodownloadWeb addunlockedmatcher o url urlinfo file
 		let key = Backend.URL.fromUrl url (Url.urlSize urlinfo)
 		nodownloadWeb' addunlockedmatcher url key file
 	usemedia mediafile = do
-		let dest = if isJust (fileOption o)
+		let dest = youtubeDlDestFile o file mediafile
-			then file
-			else takeFileName mediafile
 		let mediaurl = setDownloader url YoutubeDownloader
 		let mediakey = Backend.URL.fromUrl mediaurl Nothing
 		nodownloadWeb' addunlockedmatcher mediaurl mediakey dest
 
+youtubeDlDestFile :: DownloadOptions -> FilePath -> FilePath -> FilePath
+youtubeDlDestFile o destfile mediafile
+	| isJust (fileOption o) = destfile
+	| otherwise = takeFileName mediafile
+
 nodownloadWeb' :: AddUnlockedMatcher -> URLString -> Key -> FilePath -> Annex (Maybe Key)
 nodownloadWeb' addunlockedmatcher url key file = checkCanAdd file $ do
 	showDestinationFile file

doc/bugs/addurl_--file_only_works_with_youtube-dl_with_--fast_or_--relaxed.mdwn

@@ -50,3 +50,5 @@ I only recently started using the web special remote stuff, and really like it;
 ### Have you had any luck using git-annex before?
 
 Yes, I've used it for several years for all sorts of things, and it just gets better and better.
+
+> [[fixed|done]] --[[Joey]]