builder-git: Add a property to disable explicitly fetching LFS

The previous commit will attempt to fetch LFS by default for Git
sources even if LFS is not configured (but available).

This allows to disable that behaviour on a per source basis
since repos may have huge LFS assets which may be undesirable to fetch.

But if LFS is available and smudge filters are active, a
`git checkout` will automatically fetch LFS objects by default even
with `disable-lfs: true`. To skip that `GIT_LFS_SKIP_SMUDGE=1` can be
set in the environment.

Author: bbhtt

data/flatpak-manifest.schema.json

@@ -840,6 +840,10 @@
         "disable-submodules": {
           "description": "Don't checkout the git submodules when cloning the repository.",
           "type": "boolean"
+        },
+        "disable-lfs": {
+          "description": "Don't explicitly fetch or checkout LFS git objects.",
+          "type": "boolean"
         }
       },
       "patternProperties": {

doc/flatpak-manifest.xml

@@ -772,6 +772,10 @@
                         <term><option>disable-submodules</option> (boolean)</term>
                         <listitem><para>Don't checkout the git submodules when cloning the repository.</para></listitem>
                     </varlistentry>
+                    <varlistentry>
+                        <term><option>disable-lfs</option> (boolean)</term>
+                        <listitem><para>Don't explicitly fetch or checkout LFS git objects.</para></listitem>
+                    </varlistentry>
                 </variablelist>
             </refsect3>
             <refsect3>

src/builder-git.c

@@ -202,13 +202,17 @@ git_lfs_is_available (void)
 
 static gboolean
 builder_git_run_lfs (GFile       *dir,
+                     FlatpakGitMirrorFlags flags,
                      GError     **error,
                      const char  *subcommand,
                      ...)
 {
   va_list args;
   gboolean ok;
 
+  if (flags & FLATPAK_GIT_MIRROR_FLAGS_DISABLE_LFS)
+    return TRUE;
+
   if (!git_lfs_is_available ())
     return TRUE;
 
@@ -656,7 +660,7 @@ builder_git_mirror_repo (const char     *repo_location,
             return FALSE;
 
           g_print ("Fetching LFS assets\n");
-          if (!builder_git_run_lfs (mirror_dir, error,
+          if (!builder_git_run_lfs (mirror_dir, flags, error,
                                     "fetch", "--all", NULL))
             return FALSE;
 
@@ -690,7 +694,7 @@ builder_git_mirror_repo (const char     *repo_location,
             return FALSE;
 
           g_print ("Fetching LFS assets\n");
-          if (!builder_git_run_lfs (mirror_dir, error,
+          if (!builder_git_run_lfs (mirror_dir, flags, error,
                                     "fetch", "--all", NULL))
             return FALSE;
         }
@@ -795,7 +799,7 @@ builder_git_shallow_mirror_ref (const char     *repo_location,
             "fetch", "--depth", "1", "origin", full_ref_colon_full_ref, NULL))
     return FALSE;
 
-  if (!builder_git_run_lfs (mirror_dir, error,
+  if (!builder_git_run_lfs (mirror_dir, flags, error,
                             "fetch", "origin", full_ref, NULL))
     return FALSE;
 
@@ -949,14 +953,16 @@ builder_git_checkout (const char     *repo_location,
             "config", "--bool", "core.bare", "false", NULL))
     return FALSE;
 
-  if (!builder_git_run_lfs (dest, error, "install", NULL))
+  if (!builder_git_run_lfs (dest, mirror_flags, error,
+                            "install", NULL))
     return FALSE;
 
   if (!git (dest, NULL, 0, error,
             "checkout", branch, NULL))
     return FALSE;
 
-  if (!builder_git_run_lfs (dest, error, "checkout", NULL))
+  if (!builder_git_run_lfs (dest, mirror_flags, error,
+                            "checkout", NULL))
     return FALSE;
 
 

src/builder-git.h

@@ -31,6 +31,7 @@ typedef enum {
   FLATPAK_GIT_MIRROR_FLAGS_DISABLE_FSCK = 1 << 2,
   FLATPAK_GIT_MIRROR_FLAGS_DISABLE_SHALLOW = 1 << 3,
   FLATPAK_GIT_MIRROR_FLAGS_WILL_FETCH_FROM = 1 << 4,
+  FLATPAK_GIT_MIRROR_FLAGS_DISABLE_LFS = 1 << 5,
 } FlatpakGitMirrorFlags;
 
 gboolean builder_git_mirror_repo        (const char      *repo_location,

src/builder-source-git.c

@@ -48,6 +48,7 @@ struct BuilderSourceGit
   gboolean      disable_fsckobjects;
   gboolean      disable_shallow_clone;
   gboolean      disable_submodules;
+  gboolean      disable_lfs;
 };
 
 typedef struct
@@ -67,6 +68,7 @@ enum {
   PROP_DISABLE_FSCKOBJECTS,
   PROP_DISABLE_SHALLOW_CLONE,
   PROP_DISABLE_SUBMODULES,
+  PROP_DISABLE_LFS,
   LAST_PROP
 };
 
@@ -128,6 +130,10 @@ builder_source_git_get_property (GObject    *object,
       g_value_set_boolean (value, self->disable_submodules);
       break;
 
+    case PROP_DISABLE_LFS:
+      g_value_set_boolean (value, self->disable_lfs);
+      break;
+
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
     }
@@ -180,6 +186,10 @@ builder_source_git_set_property (GObject      *object,
       self->disable_submodules = g_value_get_boolean (value);
       break;
 
+    case PROP_DISABLE_LFS:
+      self->disable_lfs = g_value_get_boolean (value);
+      break;
+
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
     }
@@ -255,6 +265,8 @@ builder_source_git_download (BuilderSource  *source,
 
   if (!self->disable_submodules)
     flags |= FLATPAK_GIT_MIRROR_FLAGS_MIRROR_SUBMODULES;
+  if (self->disable_lfs)
+    flags |= FLATPAK_GIT_MIRROR_FLAGS_DISABLE_LFS;
   if (update_vcs)
     flags |= FLATPAK_GIT_MIRROR_FLAGS_UPDATE;
   if (self->disable_fsckobjects)
@@ -303,6 +315,9 @@ builder_source_git_extract (BuilderSource  *source,
   if (!self->disable_submodules)
     mirror_flags |= FLATPAK_GIT_MIRROR_FLAGS_MIRROR_SUBMODULES;
 
+  if (self->disable_lfs)
+    mirror_flags |= FLATPAK_GIT_MIRROR_FLAGS_DISABLE_LFS;
+
   if (!builder_git_checkout (location, get_branch (self, location),
                              dest, context, mirror_flags, error))
     return FALSE;
@@ -336,6 +351,9 @@ builder_source_git_bundle (BuilderSource  *source,
   if (!self->disable_submodules)
     flags |= FLATPAK_GIT_MIRROR_FLAGS_MIRROR_SUBMODULES;
 
+  if (self->disable_lfs)
+    flags |= FLATPAK_GIT_MIRROR_FLAGS_DISABLE_LFS;
+
   if (!builder_git_shallow_mirror_ref (location,
                                        flatpak_file_get_path_cached (mirror_dir),
                                        flags,
@@ -481,6 +499,14 @@ builder_source_git_class_init (BuilderSourceGitClass *klass)
                                                          "",
                                                          FALSE,
                                                          G_PARAM_READWRITE));
+
+  g_object_class_install_property (object_class,
+                                   PROP_DISABLE_LFS,
+                                   g_param_spec_boolean ("disable-lfs",
+                                                         "",
+                                                         "",
+                                                         FALSE,
+                                                         G_PARAM_READWRITE));
 }
 
 static void