Added detection of lowest ipynb containing dir as project directory in zips

Author: Heliozoa

plugins/python3/Cargo.toml

@@ -20,6 +20,7 @@ serde_json = "1"
 sha2 = "0.9"
 thiserror = "1"
 walkdir = "2"
+zip = "0.5"
 
 [dev-dependencies]
 simple_logger = "1"

plugins/python3/src/plugin.rs

@@ -9,7 +9,7 @@ use rand::Rng;
 use sha2::Sha256;
 use std::collections::{HashMap, HashSet};
 use std::env;
-use std::io::BufReader;
+use std::io::{BufReader, Read, Seek};
 use std::path::{Path, PathBuf};
 use std::time::Duration;
 use tmc_langs_framework::{
@@ -23,6 +23,7 @@ use tmc_langs_util::{
     parse_util,
 };
 use walkdir::WalkDir;
+use zip::ZipArchive;
 
 pub struct Python3Plugin {}
 
@@ -406,6 +407,52 @@ impl LanguagePlugin for Python3Plugin {
             },
         )(i)
     }
+
+    fn find_project_dir_in_zip<R: Read + Seek>(
+        zip_archive: &mut ZipArchive<R>,
+    ) -> Result<PathBuf, TmcError> {
+        let mut lowest_ipynb_dir = None::<PathBuf>;
+
+        for i in 0..zip_archive.len() {
+            // zips don't necessarily contain entries for intermediate directories,
+            // so we need to check every path for src
+            let file = zip_archive.by_index(i)?;
+            let file_path = Path::new(file.name());
+
+            if file_path.components().any(|c| c.as_os_str() == "src") {
+                let path: PathBuf = file_path
+                    .components()
+                    .take_while(|c| c.as_os_str() != "src")
+                    .collect();
+
+                if path.components().any(|p| p.as_os_str() == "__MACOSX") {
+                    continue;
+                }
+                return Ok(path);
+            }
+
+            if file_path
+                .extension()
+                .map(|ext| ext == "ipynb")
+                .unwrap_or_default()
+            {
+                let parent = file_path.parent().unwrap_or(Path::new("./"));
+                if let Some(lowest_ipynb_dir) = lowest_ipynb_dir.as_mut() {
+                    if lowest_ipynb_dir.components().count() > parent.components().count() {
+                        *lowest_ipynb_dir = parent.to_path_buf();
+                    }
+                } else {
+                    lowest_ipynb_dir = Some(parent.to_path_buf());
+                }
+            }
+        }
+
+        if let Some(lowest_ipynb_dir) = lowest_ipynb_dir {
+            Ok(lowest_ipynb_dir)
+        } else {
+            Err(TmcError::NoProjectDirInZip)
+        }
+    }
 }
 
 #[cfg(test)]

tmc-langs-plugins/src/tmc_zip.rs

@@ -175,6 +175,8 @@ where
 
 // TODO: make more robust, use language plugins?
 fn find_project_dir<R: Read + Seek>(zip_archive: &mut ZipArchive<R>) -> Result<PathBuf, TmcError> {
+    let mut lowest_ipynb_dir = None::<PathBuf>;
+
     for i in 0..zip_archive.len() {
         let file = zip_archive.by_index(i)?;
         let file_path = Path::new(file.name());
@@ -209,8 +211,27 @@ fn find_project_dir<R: Read + Seek>(zip_archive: &mut ZipArchive<R>) -> Result<P
             log::debug!("found project dir {}", parent.display());
             return Ok(parent.to_path_buf());
         }
+
+        if file_path
+            .extension()
+            .map(|ext| ext == "ipynb")
+            .unwrap_or_default()
+        {
+            let parent = file_path.parent().unwrap_or(Path::new("./"));
+            if let Some(lowest_ipynb_dir) = lowest_ipynb_dir.as_mut() {
+                if lowest_ipynb_dir.components().count() > parent.components().count() {
+                    *lowest_ipynb_dir = parent.to_path_buf();
+                }
+            } else {
+                lowest_ipynb_dir = Some(parent.to_path_buf());
+            }
+        }
+    }
+    if let Some(lowest_ipynb_dir) = lowest_ipynb_dir {
+        Ok(lowest_ipynb_dir)
+    } else {
+        Err(TmcError::NoProjectDirInZip)
     }
-    Err(TmcError::NoProjectDirInZip)
 }
 
 fn contains_tmcnosubmit(entry: &DirEntry) -> bool {